1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 # define LISP_INLINE INLINE
40 /* The ubiquitous max and min macros. */
43 #define max(a, b) ((a) > (b) ? (a) : (b))
44 #define min(a, b) ((a) < (b) ? (a) : (b))
46 /* EMACS_INT - signed integer wide enough to hold an Emacs value
47 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
48 pI - printf length modifier for EMACS_INT
49 EMACS_UINT - unsigned variant of EMACS_INT */
51 # if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
52 typedef long long int EMACS_INT
;
53 typedef unsigned long long int EMACS_UINT
;
54 # define EMACS_INT_MAX LLONG_MAX
56 # elif INT_MAX < LONG_MAX
57 typedef long int EMACS_INT
;
58 typedef unsigned long int EMACS_UINT
;
59 # define EMACS_INT_MAX LONG_MAX
62 typedef int EMACS_INT
;
63 typedef unsigned int EMACS_UINT
;
64 # define EMACS_INT_MAX INT_MAX
69 /* Number of bits in some machine integer types. */
72 BITS_PER_CHAR
= CHAR_BIT
,
73 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
74 BITS_PER_INT
= CHAR_BIT
* sizeof (int),
75 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
76 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
79 /* printmax_t and uprintmax_t are types for printing large integers.
80 These are the widest integers that are supported for printing.
81 pMd etc. are conversions for printing them.
82 On C99 hosts, there's no problem, as even the widest integers work.
83 Fall back on EMACS_INT on pre-C99 hosts. */
85 typedef intmax_t printmax_t
;
86 typedef uintmax_t uprintmax_t
;
90 typedef EMACS_INT printmax_t
;
91 typedef EMACS_UINT uprintmax_t
;
96 /* Use pD to format ptrdiff_t values, which suffice for indexes into
97 buffers and strings. Emacs never allocates objects larger than
98 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
99 In C99, pD can always be "t"; configure it here for the sake of
100 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
101 #if PTRDIFF_MAX == INT_MAX
103 #elif PTRDIFF_MAX == LONG_MAX
105 #elif PTRDIFF_MAX == LLONG_MAX
111 /* Extra internal type checking? */
113 /* Define an Emacs version of 'assert (COND)', since some
114 system-defined 'assert's are flaky. COND should be free of side
115 effects; it may or may not be evaluated. */
116 #ifndef ENABLE_CHECKING
117 # define eassert(X) ((void) (0 && (X))) /* Check that X compiles. */
118 #else /* ENABLE_CHECKING */
120 extern _Noreturn
void die (const char *, const char *, int);
122 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
123 it to 1 using a debugger to temporarily disable aborting on
124 detected internal inconsistencies or error conditions.
126 In some cases, a good compiler may be able to optimize away the
127 eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
128 STRINGP (x), but a particular use of XSTRING is invoked only after
129 testing that STRINGP (x) is true, making the test redundant. */
130 extern bool suppress_checking EXTERNALLY_VISIBLE
;
132 # define eassert(cond) \
133 (suppress_checking || (cond) \
135 : die (# cond, __FILE__, __LINE__))
136 #endif /* ENABLE_CHECKING */
138 /* Use the configure flag --enable-check-lisp-object-type to make
139 Lisp_Object use a struct type instead of the default int. The flag
140 causes CHECK_LISP_OBJECT_TYPE to be defined. */
142 /***** Select the tagging scheme. *****/
143 /* The following option controls the tagging scheme:
144 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
145 always 0, and we can thus use them to hold tag bits, without
146 restricting our addressing space.
148 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
149 restricting our possible address range.
151 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
152 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
153 on the few static Lisp_Objects used: all the defsubr as well
154 as the two special buffers buffer_defaults and buffer_local_symbols. */
158 /* Number of bits in a Lisp_Object tag. This can be used in #if,
159 and for GDB's sake also as a regular symbol. */
164 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
165 integer constant, for MSVC. */
166 #define GCALIGNMENT 8
168 /* Number of bits in a Lisp_Object value, not counting the tag. */
169 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
171 /* Number of bits in a Lisp fixnum tag. */
172 INTTYPEBITS
= GCTYPEBITS
- 1,
174 /* Number of bits in a Lisp fixnum value, not counting the tag. */
175 FIXNUM_BITS
= VALBITS
+ 1
178 #if GCALIGNMENT != 1 << GCTYPEBITS
179 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
182 /* The maximum value that can be stored in a EMACS_INT, assuming all
183 bits other than the type bits contribute to a nonnegative signed value.
184 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
185 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
187 /* Unless otherwise specified, use USE_LSB_TAG on systems where: */
189 /* 1. We know malloc returns a multiple of 8. */
190 # if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
191 || defined DARWIN_OS || defined __sun)
192 /* 2. We can specify multiple-of-8 alignment on static variables. */
194 /* 3. Pointers-as-ints exceed VAL_MAX.
195 On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
196 a. unnecessary, because the top bits of an EMACS_INT are unused, and
197 b. slower, because it typically requires extra masking.
198 So, default USE_LSB_TAG to 1 only on hosts where it might be useful. */
199 # if VAL_MAX < UINTPTR_MAX
200 # define USE_LSB_TAG 1
207 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 1 };
208 # define USE_LSB_TAG 1
210 enum enum_USE_LSB_TAG
{ USE_LSB_TAG
= 0 };
211 # define USE_LSB_TAG 0
215 # define alignas(alignment) /* empty */
217 # error "USE_LSB_TAG requires alignas"
222 /* Some operations are so commonly executed that they are implemented
223 as macros, not functions, because otherwise runtime performance would
224 suffer too much when compiling with GCC without optimization.
225 There's no need to inline everything, just the operations that
226 would otherwise cause a serious performance problem.
228 For each such operation OP, define a macro lisp_h_OP that contains
229 the operation's implementation. That way, OP can be implemented
230 via a macro definition like this:
232 #define OP(x) lisp_h_OP (x)
234 and/or via a function definition like this:
236 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
238 which macro-expands to this:
240 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
242 without worrying about the implementations diverging, since
243 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
244 are intended to be private to this include file, and should not be
247 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
248 functions, once most developers have access to GCC 4.8 or later and
249 can use "gcc -Og" to debug. Maybe in the year 2016. See
252 Commentary for these macros can be found near their corresponding
255 #if CHECK_LISP_OBJECT_TYPE
256 # define lisp_h_XLI(o) ((o).i)
257 # define lisp_h_XIL(i) ((Lisp_Object) { i })
259 # define lisp_h_XLI(o) (o)
260 # define lisp_h_XIL(i) (i)
262 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
263 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
264 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
265 #define lisp_h_CHECK_TYPE(ok, Qxxxp, x) \
266 ((ok) ? (void) 0 : (void) wrong_type_argument (Qxxxp, x))
267 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
268 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
269 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
270 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
271 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
272 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
273 #define lisp_h_NILP(x) EQ (x, Qnil)
274 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
275 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
276 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
277 #define lisp_h_SYMBOL_VAL(sym) \
278 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
279 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
280 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
281 #define lisp_h_XCAR(c) XCONS (c)->car
282 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
283 #define lisp_h_XCONS(a) \
284 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
285 #define lisp_h_XHASH(a) XUINT (a)
286 #define lisp_h_XPNTR(a) \
287 ((void *) (intptr_t) ((XLI (a) & VALMASK) | DATA_SEG_BITS))
288 #define lisp_h_XSYMBOL(a) \
289 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
290 #ifndef GC_CHECK_CONS_LIST
291 # define lisp_h_check_cons_list() ((void) 0)
294 # define lisp_h_make_number(n) XIL ((EMACS_INT) (n) << INTTYPEBITS)
295 # define lisp_h_XFASTINT(a) XINT (a)
296 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
297 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
298 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
301 /* When compiling via gcc -O0, define the key operations as macros, as
302 Emacs is too slow otherwise. To disable this optimization, compile
303 with -DINLINING=0. */
304 #if (defined __NO_INLINE__ \
305 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
306 && ! (defined INLINING && ! INLINING))
307 # define XLI(o) lisp_h_XLI (o)
308 # define XIL(i) lisp_h_XIL (i)
309 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
310 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
311 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
312 # define CHECK_TYPE(ok, Qxxxp, x) lisp_h_CHECK_TYPE (ok, Qxxxp, x)
313 # define CONSP(x) lisp_h_CONSP (x)
314 # define EQ(x, y) lisp_h_EQ (x, y)
315 # define FLOATP(x) lisp_h_FLOATP (x)
316 # define INTEGERP(x) lisp_h_INTEGERP (x)
317 # define MARKERP(x) lisp_h_MARKERP (x)
318 # define MISCP(x) lisp_h_MISCP (x)
319 # define NILP(x) lisp_h_NILP (x)
320 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
321 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
322 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
323 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
324 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
325 # define XCAR(c) lisp_h_XCAR (c)
326 # define XCDR(c) lisp_h_XCDR (c)
327 # define XCONS(a) lisp_h_XCONS (a)
328 # define XHASH(a) lisp_h_XHASH (a)
329 # define XPNTR(a) lisp_h_XPNTR (a)
330 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
331 # ifndef GC_CHECK_CONS_LIST
332 # define check_cons_list() lisp_h_check_cons_list ()
335 # define make_number(n) lisp_h_make_number (n)
336 # define XFASTINT(a) lisp_h_XFASTINT (a)
337 # define XINT(a) lisp_h_XINT (a)
338 # define XTYPE(a) lisp_h_XTYPE (a)
339 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
343 /* Define NAME as a lisp.h inline function that returns TYPE and has
344 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
345 ARGS should be parenthesized. Implement the function by calling
347 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
348 LISP_INLINE type (name) argdecls { return lisp_h_##name args; }
350 /* like LISP_MACRO_DEFUN, except NAME returns void. */
351 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
352 LISP_INLINE void (name) argdecls { lisp_h_##name args; }
355 /* Define the fundamental Lisp data structures. */
357 /* This is the set of Lisp data types. If you want to define a new
358 data type, read the comments after Lisp_Fwd_Type definition
361 /* Lisp integers use 2 tags, to give them one extra bit, thus
362 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
363 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
364 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
366 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
367 MSVC doesn't support them, and xlc complains vociferously about them. */
368 #if defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__
369 #define ENUM_BF(TYPE) unsigned int
371 #define ENUM_BF(TYPE) enum TYPE
377 /* Integer. XINT (obj) is the integer value. */
379 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
381 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
384 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
385 whose first member indicates the subtype. */
388 /* String. XSTRING (object) points to a struct Lisp_String.
389 The length of the string, and its contents, are stored therein. */
390 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
392 /* Vector of Lisp objects, or something resembling it.
393 XVECTOR (object) points to a struct Lisp_Vector, which contains
394 the size and contents. The size field also contains the type
395 information, if it's not a real vector object. */
398 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
404 /* This is the set of data types that share a common structure.
405 The first member of the structure is a type code from this set.
406 The enum values are arbitrary, but we'll use large numbers to make it
407 more likely that we'll spot the error if a random word in memory is
408 mistakenly interpreted as a Lisp_Misc. */
411 Lisp_Misc_Free
= 0x5eab,
414 Lisp_Misc_Save_Value
,
415 /* Currently floats are not a misc type,
416 but let's define this in case we want to change that. */
418 /* This is not a type code. It is for range checking. */
422 /* These are the types of forwarding objects used in the value slot
423 of symbols for special built-in variables whose value is stored in
427 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
428 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
429 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
430 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
431 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
434 /* If you want to define a new Lisp data type, here are some
435 instructions. See the thread at
436 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
439 First, there are already a couple of Lisp types that can be used if
440 your new type does not need to be exposed to Lisp programs nor
441 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
442 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
443 is suitable for temporarily stashing away pointers and integers in
444 a Lisp object. The latter is useful for vector-like Lisp objects
445 that need to be used as part of other objects, but which are never
446 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
449 These two types don't look pretty when printed, so they are
450 unsuitable for Lisp objects that can be exposed to users.
452 To define a new data type, add one more Lisp_Misc subtype or one
453 more pseudovector subtype. Pseudovectors are more suitable for
454 objects with several slots that need to support fast random access,
455 while Lisp_Misc types are for everything else. A pseudovector object
456 provides one or more slots for Lisp objects, followed by struct
457 members that are accessible only from C. A Lisp_Misc object is a
458 wrapper for a C struct that can contain anything you like.
460 Explicit freeing is discouraged for Lisp objects in general. But if
461 you really need to exploit this, use Lisp_Misc (check free_misc in
462 alloc.c to see why). There is no way to free a vectorlike object.
464 To add a new pseudovector type, extend the pvec_type enumeration;
465 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
467 For a Lisp_Misc, you will also need to add your entry to union
468 Lisp_Misc (but make sure the first word has the same structure as
469 the others, starting with a 16-bit member of the Lisp_Misc_Type
470 enumeration and a 1-bit GC markbit) and make sure the overall size
471 of the union is not increased by your addition.
473 For a new pseudovector, it's highly desirable to limit the size
474 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
475 Otherwise you will need to change sweep_vectors (also in alloc.c).
477 Then you will need to add switch branches in print.c (in
478 print_object, to print your object, and possibly also in
479 print_preprocess) and to alloc.c, to mark your object (in
480 mark_object) and to free it (in gc_sweep). The latter is also the
481 right place to call any code specific to your data type that needs
482 to run when the object is recycled -- e.g., free any additional
483 resources allocated for it that are not Lisp objects. You can even
484 make a pointer to the function that frees the resources a slot in
485 your object -- this way, the same object could be used to represent
486 several disparate C structures. */
488 #ifdef CHECK_LISP_OBJECT_TYPE
490 typedef struct { EMACS_INT i
; } Lisp_Object
;
492 #define LISP_INITIALLY_ZERO {0}
494 #undef CHECK_LISP_OBJECT_TYPE
495 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
496 #else /* CHECK_LISP_OBJECT_TYPE */
498 /* If a struct type is not wanted, define Lisp_Object as just a number. */
500 typedef EMACS_INT Lisp_Object
;
501 #define LISP_INITIALLY_ZERO 0
502 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
503 #endif /* CHECK_LISP_OBJECT_TYPE */
505 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
506 At the machine level, these operations are no-ops. */
507 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
508 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
510 /* In the size word of a vector, this bit means the vector has been marked. */
512 static ptrdiff_t const ARRAY_MARK_FLAG
513 #define ARRAY_MARK_FLAG PTRDIFF_MIN
516 /* In the size word of a struct Lisp_Vector, this bit means it's really
517 some other vector-like object. */
518 static ptrdiff_t const PSEUDOVECTOR_FLAG
519 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
522 /* In a pseudovector, the size field actually contains a word with one
523 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
524 with PVEC_TYPE_MASK to indicate the actual type. */
536 PVEC_WINDOW_CONFIGURATION
,
544 /* These should be last, check internal_equal to see why. */
548 PVEC_FONT
/* Should be last because it's used for range checking. */
551 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
552 which were stored in a Lisp_Object. */
553 #ifndef DATA_SEG_BITS
554 # define DATA_SEG_BITS 0
556 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
561 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
563 /* For convenience, we also store the number of elements in these bits.
564 Note that this size is not necessarily the memory-footprint size, but
565 only the number of Lisp_Object fields (that need to be traced by GC).
566 The distinction is used, e.g., by Lisp_Process, which places extra
567 non-Lisp_Object fields at the end of the structure. */
568 PSEUDOVECTOR_SIZE_BITS
= 12,
569 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
571 /* To calculate the memory footprint of the pseudovector, it's useful
572 to store the size of non-Lisp area in word_size units here. */
573 PSEUDOVECTOR_REST_BITS
= 12,
574 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
575 << PSEUDOVECTOR_SIZE_BITS
),
577 /* Used to extract pseudovector subtype information. */
578 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
579 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
581 /* Number of bits to put in each character in the internal representation
582 of bool vectors. This should not vary across implementations. */
583 BOOL_VECTOR_BITS_PER_CHAR
= 8
586 /* These functions extract various sorts of values from a Lisp_Object.
587 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
588 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
590 static EMACS_INT
const VALMASK
591 #define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
594 /* Largest and smallest representable fixnum values. These are the C
595 values. They are macros for use in static initializers. */
596 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
597 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
599 /* Extract the pointer hidden within A. */
600 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
604 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
605 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
606 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
607 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
608 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
610 #else /* ! USE_LSB_TAG */
612 /* Although compiled only if ! USE_LSB_TAG, the following functions
613 also work when USE_LSB_TAG; this is to aid future maintenance when
614 the lisp_h_* macros are eventually removed. */
616 /* Make a Lisp integer representing the value of the low order
618 LISP_INLINE Lisp_Object
619 make_number (EMACS_INT n
)
621 return XIL (USE_LSB_TAG
? n
<< INTTYPEBITS
: n
& INTMASK
);
624 /* Extract A's value as a signed integer. */
625 LISP_INLINE EMACS_INT
628 EMACS_INT i
= XLI (a
);
629 return (USE_LSB_TAG
? i
: i
<< INTTYPEBITS
) >> INTTYPEBITS
;
632 /* Like XINT (A), but may be faster. A must be nonnegative.
633 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
634 integers have zero-bits in their tags. */
635 LISP_INLINE EMACS_INT
636 XFASTINT (Lisp_Object a
)
638 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
643 /* Extract A's type. */
644 LISP_INLINE
enum Lisp_Type
645 XTYPE (Lisp_Object a
)
647 EMACS_UINT i
= XLI (a
);
648 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
651 /* Extract A's pointer value, assuming A's type is TYPE. */
653 XUNTAG (Lisp_Object a
, int type
)
657 intptr_t i
= XLI (a
) - type
;
663 #endif /* ! USE_LSB_TAG */
665 /* Extract A's value as an unsigned integer. */
666 LISP_INLINE EMACS_UINT
667 XUINT (Lisp_Object a
)
669 EMACS_UINT i
= XLI (a
);
670 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
673 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
674 right now, but XUINT should only be applied to objects we know are
676 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
678 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
679 LISP_INLINE Lisp_Object
680 make_natnum (EMACS_INT n
)
682 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
683 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
686 /* Return true if X and Y are the same object. */
687 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
689 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
690 written this way so that it also works if I is of unsigned
691 type or if I is a NaN. */
693 #define FIXNUM_OVERFLOW_P(i) \
694 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
696 LISP_INLINE
ptrdiff_t
697 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
699 return num
< lower
? lower
: num
<= upper
? num
: upper
;
702 /* Forward declarations. */
704 /* Defined in this file. */
706 LISP_INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
707 LISP_INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
708 LISP_INLINE
bool BUFFERP (Lisp_Object
);
709 LISP_INLINE
bool CHAR_TABLE_P (Lisp_Object
);
710 LISP_INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
711 LISP_INLINE
bool (CONSP
) (Lisp_Object
);
712 LISP_INLINE
bool (FLOATP
) (Lisp_Object
);
713 LISP_INLINE
bool functionp (Lisp_Object
);
714 LISP_INLINE
bool (INTEGERP
) (Lisp_Object
);
715 LISP_INLINE
bool (MARKERP
) (Lisp_Object
);
716 LISP_INLINE
bool (MISCP
) (Lisp_Object
);
717 LISP_INLINE
bool (NILP
) (Lisp_Object
);
718 LISP_INLINE
bool OVERLAYP (Lisp_Object
);
719 LISP_INLINE
bool PROCESSP (Lisp_Object
);
720 LISP_INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
721 LISP_INLINE
bool SAVE_VALUEP (Lisp_Object
);
722 LISP_INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
724 LISP_INLINE
bool STRINGP (Lisp_Object
);
725 LISP_INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
726 LISP_INLINE
bool SUBRP (Lisp_Object
);
727 LISP_INLINE
bool (SYMBOLP
) (Lisp_Object
);
728 LISP_INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
729 LISP_INLINE
bool WINDOWP (Lisp_Object
);
730 LISP_INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
732 /* Defined in chartab.c. */
733 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
734 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
735 extern int char_table_translate (Lisp_Object
, int);
737 /* Defined in data.c. */
738 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
739 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
740 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qvectorp
;
741 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
742 extern Lisp_Object Qwindow
;
743 extern Lisp_Object
Ffboundp (Lisp_Object
);
744 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
746 /* Defined in emacs.c. */
747 extern bool initialized
;
749 /* Defined in eval.c. */
750 extern Lisp_Object Qautoload
;
752 /* Defined in floatfns.c. */
753 extern double extract_float (Lisp_Object
);
755 /* Defined in process.c. */
756 extern Lisp_Object Qprocessp
;
758 /* Defined in window.c. */
759 extern Lisp_Object Qwindowp
;
761 /* Defined in xdisp.c. */
762 extern Lisp_Object Qimage
;
765 /* Extract a value or address from a Lisp_Object. */
767 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
769 LISP_INLINE
struct Lisp_Vector
*
770 XVECTOR (Lisp_Object a
)
772 eassert (VECTORLIKEP (a
));
773 return XUNTAG (a
, Lisp_Vectorlike
);
776 LISP_INLINE
struct Lisp_String
*
777 XSTRING (Lisp_Object a
)
779 eassert (STRINGP (a
));
780 return XUNTAG (a
, Lisp_String
);
783 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
785 LISP_INLINE
struct Lisp_Float
*
786 XFLOAT (Lisp_Object a
)
788 eassert (FLOATP (a
));
789 return XUNTAG (a
, Lisp_Float
);
792 /* Pseudovector types. */
794 LISP_INLINE
struct Lisp_Process
*
795 XPROCESS (Lisp_Object a
)
797 eassert (PROCESSP (a
));
798 return XUNTAG (a
, Lisp_Vectorlike
);
801 LISP_INLINE
struct window
*
802 XWINDOW (Lisp_Object a
)
804 eassert (WINDOWP (a
));
805 return XUNTAG (a
, Lisp_Vectorlike
);
808 LISP_INLINE
struct terminal
*
809 XTERMINAL (Lisp_Object a
)
811 return XUNTAG (a
, Lisp_Vectorlike
);
814 LISP_INLINE
struct Lisp_Subr
*
815 XSUBR (Lisp_Object a
)
818 return XUNTAG (a
, Lisp_Vectorlike
);
821 LISP_INLINE
struct buffer
*
822 XBUFFER (Lisp_Object a
)
824 eassert (BUFFERP (a
));
825 return XUNTAG (a
, Lisp_Vectorlike
);
828 LISP_INLINE
struct Lisp_Char_Table
*
829 XCHAR_TABLE (Lisp_Object a
)
831 eassert (CHAR_TABLE_P (a
));
832 return XUNTAG (a
, Lisp_Vectorlike
);
835 LISP_INLINE
struct Lisp_Sub_Char_Table
*
836 XSUB_CHAR_TABLE (Lisp_Object a
)
838 eassert (SUB_CHAR_TABLE_P (a
));
839 return XUNTAG (a
, Lisp_Vectorlike
);
842 LISP_INLINE
struct Lisp_Bool_Vector
*
843 XBOOL_VECTOR (Lisp_Object a
)
845 eassert (BOOL_VECTOR_P (a
));
846 return XUNTAG (a
, Lisp_Vectorlike
);
849 /* Construct a Lisp_Object from a value or address. */
851 LISP_INLINE Lisp_Object
852 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
854 EMACS_UINT utype
= type
;
855 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
856 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
857 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
861 LISP_INLINE Lisp_Object
862 make_lisp_proc (struct Lisp_Process
*p
)
864 return make_lisp_ptr (p
, Lisp_Vectorlike
);
867 #define XSETINT(a, b) ((a) = make_number (b))
868 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
869 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
870 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
871 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
872 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
873 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
877 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
878 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
880 /* Pseudovector types. */
882 #define XSETPVECTYPE(v, code) \
883 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
884 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
885 ((v)->header.size = (PSEUDOVECTOR_FLAG \
886 | ((code) << PSEUDOVECTOR_AREA_BITS) \
887 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
890 /* The cast to struct vectorlike_header * avoids aliasing issues. */
891 #define XSETPSEUDOVECTOR(a, b, code) \
892 XSETTYPED_PSEUDOVECTOR (a, b, \
893 (((struct vectorlike_header *) \
894 XUNTAG (a, Lisp_Vectorlike)) \
897 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
898 (XSETVECTOR (a, b), \
899 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
900 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
902 #define XSETWINDOW_CONFIGURATION(a, b) \
903 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
904 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
905 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
906 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
907 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
908 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
909 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
910 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
911 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
912 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
916 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
919 /* Deprecated and will be removed soon. */
921 #define INTERNAL_FIELD(field) field ## _
923 /* See the macros in intervals.h. */
925 typedef struct interval
*INTERVAL
;
929 /* Car of this cons cell. */
934 /* Cdr of this cons cell. */
937 /* Used to chain conses on a free list. */
938 struct Lisp_Cons
*chain
;
942 /* Take the car or cdr of something known to be a cons cell. */
943 /* The _addr functions shouldn't be used outside of the minimal set
944 of code that has to know what a cons cell looks like. Other code not
945 part of the basic lisp implementation should assume that the car and cdr
946 fields are not accessible. (What if we want to switch to
947 a copying collector someday? Cached cons cell field addresses may be
948 invalidated at arbitrary points.) */
949 LISP_INLINE Lisp_Object
*
950 xcar_addr (Lisp_Object c
)
952 return &XCONS (c
)->car
;
954 LISP_INLINE Lisp_Object
*
955 xcdr_addr (Lisp_Object c
)
957 return &XCONS (c
)->u
.cdr
;
960 /* Use these from normal code. */
961 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
962 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
964 /* Use these to set the fields of a cons cell.
966 Note that both arguments may refer to the same object, so 'n'
967 should not be read after 'c' is first modified. */
969 XSETCAR (Lisp_Object c
, Lisp_Object n
)
974 XSETCDR (Lisp_Object c
, Lisp_Object n
)
979 /* Take the car or cdr of something whose type is not known. */
980 LISP_INLINE Lisp_Object
983 return (CONSP (c
) ? XCAR (c
)
985 : wrong_type_argument (Qlistp
, c
));
987 LISP_INLINE Lisp_Object
990 return (CONSP (c
) ? XCDR (c
)
992 : wrong_type_argument (Qlistp
, c
));
995 /* Take the car or cdr of something whose type is not known. */
996 LISP_INLINE Lisp_Object
997 CAR_SAFE (Lisp_Object c
)
999 return CONSP (c
) ? XCAR (c
) : Qnil
;
1001 LISP_INLINE Lisp_Object
1002 CDR_SAFE (Lisp_Object c
)
1004 return CONSP (c
) ? XCDR (c
) : Qnil
;
1007 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1012 ptrdiff_t size_byte
;
1013 INTERVAL intervals
; /* Text properties in this string. */
1014 unsigned char *data
;
1017 /* True if STR is a multibyte string. */
1019 STRING_MULTIBYTE (Lisp_Object str
)
1021 return 0 <= XSTRING (str
)->size_byte
;
1024 /* An upper bound on the number of bytes in a Lisp string, not
1025 counting the terminating null. This a tight enough bound to
1026 prevent integer overflow errors that would otherwise occur during
1027 string size calculations. A string cannot contain more bytes than
1028 a fixnum can represent, nor can it be so long that C pointer
1029 arithmetic stops working on the string plus its terminating null.
1030 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1031 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1032 would expose alloc.c internal details that we'd rather keep
1035 This is a macro for use in static initializers. The cast to
1036 ptrdiff_t ensures that the macro is signed. */
1037 #define STRING_BYTES_BOUND \
1038 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1040 /* Mark STR as a unibyte string. */
1041 #define STRING_SET_UNIBYTE(STR) \
1042 do { if (EQ (STR, empty_multibyte_string)) \
1043 (STR) = empty_unibyte_string; \
1044 else XSTRING (STR)->size_byte = -1; } while (0)
1046 /* Mark STR as a multibyte string. Assure that STR contains only
1047 ASCII characters in advance. */
1048 #define STRING_SET_MULTIBYTE(STR) \
1049 do { if (EQ (STR, empty_unibyte_string)) \
1050 (STR) = empty_multibyte_string; \
1051 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
1053 /* Convenience functions for dealing with Lisp strings. */
1055 LISP_INLINE
unsigned char *
1056 SDATA (Lisp_Object string
)
1058 return XSTRING (string
)->data
;
1061 SSDATA (Lisp_Object string
)
1063 /* Avoid "differ in sign" warnings. */
1064 return (char *) SDATA (string
);
1066 LISP_INLINE
unsigned char
1067 SREF (Lisp_Object string
, ptrdiff_t index
)
1069 return SDATA (string
)[index
];
1072 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1074 SDATA (string
)[index
] = new;
1076 LISP_INLINE
ptrdiff_t
1077 SCHARS (Lisp_Object string
)
1079 return XSTRING (string
)->size
;
1082 #ifdef GC_CHECK_STRING_BYTES
1083 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1085 LISP_INLINE
ptrdiff_t
1086 STRING_BYTES (struct Lisp_String
*s
)
1088 #ifdef GC_CHECK_STRING_BYTES
1089 return string_bytes (s
);
1091 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1095 LISP_INLINE
ptrdiff_t
1096 SBYTES (Lisp_Object string
)
1098 return STRING_BYTES (XSTRING (string
));
1101 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1103 XSTRING (string
)->size
= newsize
;
1106 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1109 memcpy (SDATA (string
) + index
, new, count
);
1112 /* Header of vector-like objects. This documents the layout constraints on
1113 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1114 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1115 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1116 because when two such pointers potentially alias, a compiler won't
1117 incorrectly reorder loads and stores to their size fields. See
1118 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
1119 struct vectorlike_header
1121 /* The only field contains various pieces of information:
1122 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1123 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1124 vector (0) or a pseudovector (1).
1125 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1126 of slots) of the vector.
1127 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1128 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1129 - b) number of Lisp_Objects slots at the beginning of the object
1130 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1132 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1133 measured in word_size units. Rest fields may also include
1134 Lisp_Objects, but these objects usually needs some special treatment
1136 There are some exceptions. For PVEC_FREE, b) is always zero. For
1137 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1138 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1139 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1143 /* Regular vector is just a header plus array of Lisp_Objects. */
1147 struct vectorlike_header header
;
1148 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1151 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1153 struct Lisp_Bool_Vector
1155 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1156 just the subtype information. */
1157 struct vectorlike_header header
;
1158 /* This is the size in bits. */
1160 /* This contains the actual bits, packed into bytes. */
1161 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1164 /* Some handy constants for calculating sizes
1165 and offsets, mostly of vectorlike objects. */
1169 header_size
= offsetof (struct Lisp_Vector
, contents
),
1170 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1171 word_size
= sizeof (Lisp_Object
)
1174 /* Conveniences for dealing with Lisp arrays. */
1176 LISP_INLINE Lisp_Object
1177 AREF (Lisp_Object array
, ptrdiff_t idx
)
1179 return XVECTOR (array
)->contents
[idx
];
1182 LISP_INLINE Lisp_Object
*
1183 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1185 return & XVECTOR (array
)->contents
[idx
];
1188 LISP_INLINE
ptrdiff_t
1189 ASIZE (Lisp_Object array
)
1191 return XVECTOR (array
)->header
.size
;
1195 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1197 eassert (0 <= idx
&& idx
< ASIZE (array
));
1198 XVECTOR (array
)->contents
[idx
] = val
;
1202 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1204 /* Like ASET, but also can be used in the garbage collector:
1205 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1206 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1207 XVECTOR (array
)->contents
[idx
] = val
;
1210 /* If a struct is made to look like a vector, this macro returns the length
1211 of the shortest vector that would hold that struct. */
1213 #define VECSIZE(type) \
1214 ((sizeof (type) - header_size + word_size - 1) / word_size)
1216 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1217 at the end and we need to compute the number of Lisp_Object fields (the
1218 ones that the GC needs to trace). */
1220 #define PSEUDOVECSIZE(type, nonlispfield) \
1221 ((offsetof (type, nonlispfield) - header_size) / word_size)
1223 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1224 should be integer expressions. This is not the same as
1225 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1226 returns 1. For efficiency, prefer plain unsigned comparison if A
1227 and B's sizes both fit (after integer promotion). */
1228 #define UNSIGNED_CMP(a, op, b) \
1229 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1230 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1231 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1233 /* Nonzero iff C is an ASCII character. */
1234 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1236 /* A char-table is a kind of vectorlike, with contents are like a
1237 vector but with a few other slots. For some purposes, it makes
1238 sense to handle a char-table with type struct Lisp_Vector. An
1239 element of a char table can be any Lisp objects, but if it is a sub
1240 char-table, we treat it a table that contains information of a
1241 specific range of characters. A sub char-table has the same
1242 structure as a vector. A sub char table appears only in an element
1243 of a char-table, and there's no way to access it directly from
1244 Emacs Lisp program. */
1246 enum CHARTAB_SIZE_BITS
1248 CHARTAB_SIZE_BITS_0
= 6,
1249 CHARTAB_SIZE_BITS_1
= 4,
1250 CHARTAB_SIZE_BITS_2
= 5,
1251 CHARTAB_SIZE_BITS_3
= 7
1254 extern const int chartab_size
[4];
1256 struct Lisp_Char_Table
1258 /* HEADER.SIZE is the vector's size field, which also holds the
1259 pseudovector type information. It holds the size, too.
1260 The size counts the defalt, parent, purpose, ascii,
1261 contents, and extras slots. */
1262 struct vectorlike_header header
;
1264 /* This holds a default value,
1265 which is used whenever the value for a specific character is nil. */
1268 /* This points to another char table, which we inherit from when the
1269 value for a specific character is nil. The `defalt' slot takes
1270 precedence over this. */
1273 /* This is a symbol which says what kind of use this char-table is
1275 Lisp_Object purpose
;
1277 /* The bottom sub char-table for characters of the range 0..127. It
1278 is nil if none of ASCII character has a specific value. */
1281 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1283 /* These hold additional data. It is a vector. */
1284 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1287 struct Lisp_Sub_Char_Table
1289 /* HEADER.SIZE is the vector's size field, which also holds the
1290 pseudovector type information. It holds the size, too. */
1291 struct vectorlike_header header
;
1293 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1294 char-table of depth 1 contains 16 elements, and each element
1295 covers 4096 (128*32) characters. A sub char-table of depth 2
1296 contains 32 elements, and each element covers 128 characters. A
1297 sub char-table of depth 3 contains 128 elements, and each element
1298 is for one character. */
1301 /* Minimum character covered by the sub char-table. */
1302 Lisp_Object min_char
;
1304 /* Use set_sub_char_table_contents to set this. */
1305 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1308 LISP_INLINE Lisp_Object
1309 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1311 struct Lisp_Char_Table
*tbl
= NULL
;
1315 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1316 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1317 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1321 while (NILP (val
) && ! NILP (tbl
->parent
));
1326 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1327 characters. Do not check validity of CT. */
1328 LISP_INLINE Lisp_Object
1329 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1331 return (ASCII_CHAR_P (idx
)
1332 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1333 : char_table_ref (ct
, idx
));
1336 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1337 8-bit European characters. Do not check validity of CT. */
1339 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1341 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1342 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1344 char_table_set (ct
, idx
, val
);
1347 /* This structure describes a built-in function.
1348 It is generated by the DEFUN macro only.
1349 defsubr makes it into a Lisp object. */
1353 struct vectorlike_header header
;
1355 Lisp_Object (*a0
) (void);
1356 Lisp_Object (*a1
) (Lisp_Object
);
1357 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1358 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1359 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1360 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1361 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1362 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1363 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1364 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1365 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1367 short min_args
, max_args
;
1368 const char *symbol_name
;
1369 const char *intspec
;
1373 /* This is the number of slots that every char table must have. This
1374 counts the ordinary slots and the top, defalt, parent, and purpose
1376 enum CHAR_TABLE_STANDARD_SLOTS
1378 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1381 /* Return the number of "extra" slots in the char table CT. */
1384 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1386 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1387 - CHAR_TABLE_STANDARD_SLOTS
);
1391 /***********************************************************************
1393 ***********************************************************************/
1395 /* Interned state of a symbol. */
1397 enum symbol_interned
1399 SYMBOL_UNINTERNED
= 0,
1400 SYMBOL_INTERNED
= 1,
1401 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1404 enum symbol_redirect
1406 SYMBOL_PLAINVAL
= 4,
1407 SYMBOL_VARALIAS
= 1,
1408 SYMBOL_LOCALIZED
= 2,
1409 SYMBOL_FORWARDED
= 3
1414 unsigned gcmarkbit
: 1;
1416 /* Indicates where the value can be found:
1417 0 : it's a plain var, the value is in the `value' field.
1418 1 : it's a varalias, the value is really in the `alias' symbol.
1419 2 : it's a localized var, the value is in the `blv' object.
1420 3 : it's a forwarding variable, the value is in `forward'. */
1421 ENUM_BF (symbol_redirect
) redirect
: 3;
1423 /* Non-zero means symbol is constant, i.e. changing its value
1424 should signal an error. If the value is 3, then the var
1425 can be changed, but only by `defconst'. */
1426 unsigned constant
: 2;
1428 /* Interned state of the symbol. This is an enumerator from
1429 enum symbol_interned. */
1430 unsigned interned
: 2;
1432 /* Non-zero means that this variable has been explicitly declared
1433 special (with `defvar' etc), and shouldn't be lexically bound. */
1434 unsigned declared_special
: 1;
1436 /* The symbol's name, as a Lisp string. */
1439 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1440 union is used depends on the `redirect' field above. */
1443 struct Lisp_Symbol
*alias
;
1444 struct Lisp_Buffer_Local_Value
*blv
;
1445 union Lisp_Fwd
*fwd
;
1448 /* Function value of the symbol or Qnil if not fboundp. */
1449 Lisp_Object function
;
1451 /* The symbol's property list. */
1454 /* Next symbol in obarray bucket, if the symbol is interned. */
1455 struct Lisp_Symbol
*next
;
1458 /* Value is name of symbol. */
1460 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1462 LISP_INLINE
struct Lisp_Symbol
*
1463 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1465 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1466 return sym
->val
.alias
;
1468 LISP_INLINE
struct Lisp_Buffer_Local_Value
*
1469 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1471 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1472 return sym
->val
.blv
;
1474 LISP_INLINE
union Lisp_Fwd
*
1475 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1477 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1478 return sym
->val
.fwd
;
1481 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1482 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1485 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1487 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1491 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1493 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1497 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1499 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1503 LISP_INLINE Lisp_Object
1504 SYMBOL_NAME (Lisp_Object sym
)
1506 return XSYMBOL (sym
)->name
;
1509 /* Value is true if SYM is an interned symbol. */
1512 SYMBOL_INTERNED_P (Lisp_Object sym
)
1514 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1517 /* Value is true if SYM is interned in initial_obarray. */
1520 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1522 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1525 /* Value is non-zero if symbol is considered a constant, i.e. its
1526 value cannot be changed (there is an exception for keyword symbols,
1527 whose value can be set to the keyword symbol itself). */
1529 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1531 #define DEFSYM(sym, name) \
1532 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1535 /***********************************************************************
1537 ***********************************************************************/
1539 /* The structure of a Lisp hash table. */
1541 struct hash_table_test
1543 /* Name of the function used to compare keys. */
1546 /* User-supplied hash function, or nil. */
1547 Lisp_Object user_hash_function
;
1549 /* User-supplied key comparison function, or nil. */
1550 Lisp_Object user_cmp_function
;
1552 /* C function to compare two keys. */
1553 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1555 /* C function to compute hash code. */
1556 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1559 struct Lisp_Hash_Table
1561 /* This is for Lisp; the hash table code does not refer to it. */
1562 struct vectorlike_header header
;
1564 /* Nil if table is non-weak. Otherwise a symbol describing the
1565 weakness of the table. */
1568 /* When the table is resized, and this is an integer, compute the
1569 new size by adding this to the old size. If a float, compute the
1570 new size by multiplying the old size with this factor. */
1571 Lisp_Object rehash_size
;
1573 /* Resize hash table when number of entries/ table size is >= this
1575 Lisp_Object rehash_threshold
;
1577 /* Vector of hash codes.. If hash[I] is nil, this means that that
1578 entry I is unused. */
1581 /* Vector used to chain entries. If entry I is free, next[I] is the
1582 entry number of the next free item. If entry I is non-free,
1583 next[I] is the index of the next entry in the collision chain. */
1586 /* Index of first free entry in free list. */
1587 Lisp_Object next_free
;
1589 /* Bucket vector. A non-nil entry is the index of the first item in
1590 a collision chain. This vector's size can be larger than the
1591 hash table size to reduce collisions. */
1594 /* Only the fields above are traced normally by the GC. The ones below
1595 `count' are special and are either ignored by the GC or traced in
1596 a special way (e.g. because of weakness). */
1598 /* Number of key/value entries in the table. */
1601 /* Vector of keys and values. The key of item I is found at index
1602 2 * I, the value is found at index 2 * I + 1.
1603 This is gc_marked specially if the table is weak. */
1604 Lisp_Object key_and_value
;
1606 /* The comparison and hash functions. */
1607 struct hash_table_test test
;
1609 /* Next weak hash table if this is a weak hash table. The head
1610 of the list is in weak_hash_tables. */
1611 struct Lisp_Hash_Table
*next_weak
;
1615 LISP_INLINE
struct Lisp_Hash_Table
*
1616 XHASH_TABLE (Lisp_Object a
)
1618 return XUNTAG (a
, Lisp_Vectorlike
);
1621 #define XSET_HASH_TABLE(VAR, PTR) \
1622 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1625 HASH_TABLE_P (Lisp_Object a
)
1627 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1630 /* Value is the key part of entry IDX in hash table H. */
1631 LISP_INLINE Lisp_Object
1632 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1634 return AREF (h
->key_and_value
, 2 * idx
);
1637 /* Value is the value part of entry IDX in hash table H. */
1638 LISP_INLINE Lisp_Object
1639 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1641 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1644 /* Value is the index of the next entry following the one at IDX
1646 LISP_INLINE Lisp_Object
1647 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1649 return AREF (h
->next
, idx
);
1652 /* Value is the hash code computed for entry IDX in hash table H. */
1653 LISP_INLINE Lisp_Object
1654 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1656 return AREF (h
->hash
, idx
);
1659 /* Value is the index of the element in hash table H that is the
1660 start of the collision list at index IDX in the index vector of H. */
1661 LISP_INLINE Lisp_Object
1662 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1664 return AREF (h
->index
, idx
);
1667 /* Value is the size of hash table H. */
1668 LISP_INLINE
ptrdiff_t
1669 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1671 return ASIZE (h
->next
);
1674 /* Default size for hash tables if not specified. */
1676 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1678 /* Default threshold specifying when to resize a hash table. The
1679 value gives the ratio of current entries in the hash table and the
1680 size of the hash table. */
1682 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1684 /* Default factor by which to increase the size of a hash table. */
1686 static double const DEFAULT_REHASH_SIZE
= 1.5;
1688 /* Combine two integers X and Y for hashing. The result might not fit
1689 into a Lisp integer. */
1691 LISP_INLINE EMACS_UINT
1692 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1694 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1697 /* Hash X, returning a value that fits into a fixnum. */
1699 LISP_INLINE EMACS_UINT
1700 SXHASH_REDUCE (EMACS_UINT x
)
1702 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1705 /* These structures are used for various misc types. */
1707 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1709 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1710 unsigned gcmarkbit
: 1;
1716 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1717 unsigned gcmarkbit
: 1;
1719 /* This flag is temporarily used in the functions
1720 decode/encode_coding_object to record that the marker position
1721 must be adjusted after the conversion. */
1722 unsigned int need_adjustment
: 1;
1723 /* 1 means normal insertion at the marker's position
1724 leaves the marker after the inserted text. */
1725 unsigned int insertion_type
: 1;
1726 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1727 Note: a chain of markers can contain markers pointing into different
1728 buffers (the chain is per buffer_text rather than per buffer, so it's
1729 shared between indirect buffers). */
1730 /* This is used for (other than NULL-checking):
1732 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1733 - unchain_marker: to find the list from which to unchain.
1734 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1736 struct buffer
*buffer
;
1738 /* The remaining fields are meaningless in a marker that
1739 does not point anywhere. */
1741 /* For markers that point somewhere,
1742 this is used to chain of all the markers in a given buffer. */
1743 /* We could remove it and use an array in buffer_text instead.
1744 That would also allow to preserve it ordered. */
1745 struct Lisp_Marker
*next
;
1746 /* This is the char position where the marker points. */
1748 /* This is the byte position.
1749 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1750 used to implement the functionality of markers, but rather to (ab)use
1751 markers as a cache for char<->byte mappings). */
1755 /* START and END are markers in the overlay's buffer, and
1756 PLIST is the overlay's property list. */
1758 /* An overlay's real data content is:
1760 - buffer (really there are two buffer pointers, one per marker,
1761 and both points to the same buffer)
1762 - insertion type of both ends (per-marker fields)
1763 - start & start byte (of start marker)
1764 - end & end byte (of end marker)
1765 - next (singly linked list of overlays)
1766 - next fields of start and end markers (singly linked list of markers).
1767 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1770 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1771 unsigned gcmarkbit
: 1;
1773 struct Lisp_Overlay
*next
;
1779 /* Types of data which may be saved in a Lisp_Save_Value. */
1790 /* Number of bits needed to store one of the above values. */
1791 enum { SAVE_SLOT_BITS
= 3 };
1793 /* Number of slots in a save value where save_type is nonzero. */
1794 enum { SAVE_VALUE_SLOTS
= 4 };
1796 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1798 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1802 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1803 SAVE_TYPE_INT_INT_INT
1804 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1805 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1806 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1807 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1808 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1809 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1810 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1811 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1812 SAVE_TYPE_FUNCPTR_PTR_OBJ
1813 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1815 /* This has an extra bit indicating it's raw memory. */
1816 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1819 /* Special object used to hold a different values for later use.
1821 This is mostly used to package C integers and pointers to call
1822 record_unwind_protect when two or more values need to be saved.
1826 struct my_data *md = get_my_data ();
1827 ptrdiff_t mi = get_my_integer ();
1828 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1831 Lisp_Object my_unwind (Lisp_Object arg)
1833 struct my_data *md = XSAVE_POINTER (arg, 0);
1834 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1838 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1839 saved objects and raise eassert if type of the saved object doesn't match
1840 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1841 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1842 slot 0 is a pointer. */
1844 typedef void (*voidfuncptr
) (void);
1846 struct Lisp_Save_Value
1848 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1849 unsigned gcmarkbit
: 1;
1850 int spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
1852 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1853 V's data entries are determined by V->save_type. E.g., if
1854 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1855 V->data[1] is an integer, and V's other data entries are unused.
1857 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1858 a memory area containing V->data[1].integer potential Lisp_Objects. */
1859 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1862 voidfuncptr funcpointer
;
1865 } data
[SAVE_VALUE_SLOTS
];
1868 /* Return the type of V's Nth saved value. */
1870 save_type (struct Lisp_Save_Value
*v
, int n
)
1872 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1873 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1876 /* Get and set the Nth saved pointer. */
1879 XSAVE_POINTER (Lisp_Object obj
, int n
)
1881 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1882 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1885 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1887 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1888 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1890 LISP_INLINE voidfuncptr
1891 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1893 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1894 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1897 /* Likewise for the saved integer. */
1899 LISP_INLINE
ptrdiff_t
1900 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1902 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1903 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1906 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1908 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1909 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1912 /* Extract Nth saved object. */
1914 LISP_INLINE Lisp_Object
1915 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1917 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1918 return XSAVE_VALUE (obj
)->data
[n
].object
;
1921 /* A miscellaneous object, when it's on the free list. */
1924 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1925 unsigned gcmarkbit
: 1;
1927 union Lisp_Misc
*chain
;
1930 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1931 It uses one of these struct subtypes to get the type field. */
1935 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1936 struct Lisp_Free u_free
;
1937 struct Lisp_Marker u_marker
;
1938 struct Lisp_Overlay u_overlay
;
1939 struct Lisp_Save_Value u_save_value
;
1942 LISP_INLINE
union Lisp_Misc
*
1943 XMISC (Lisp_Object a
)
1945 return XUNTAG (a
, Lisp_Misc
);
1948 LISP_INLINE
struct Lisp_Misc_Any
*
1949 XMISCANY (Lisp_Object a
)
1951 eassert (MISCP (a
));
1952 return & XMISC (a
)->u_any
;
1955 LISP_INLINE
enum Lisp_Misc_Type
1956 XMISCTYPE (Lisp_Object a
)
1958 return XMISCANY (a
)->type
;
1961 LISP_INLINE
struct Lisp_Marker
*
1962 XMARKER (Lisp_Object a
)
1964 eassert (MARKERP (a
));
1965 return & XMISC (a
)->u_marker
;
1968 LISP_INLINE
struct Lisp_Overlay
*
1969 XOVERLAY (Lisp_Object a
)
1971 eassert (OVERLAYP (a
));
1972 return & XMISC (a
)->u_overlay
;
1975 LISP_INLINE
struct Lisp_Save_Value
*
1976 XSAVE_VALUE (Lisp_Object a
)
1978 eassert (SAVE_VALUEP (a
));
1979 return & XMISC (a
)->u_save_value
;
1982 /* Forwarding pointer to an int variable.
1983 This is allowed only in the value cell of a symbol,
1984 and it means that the symbol's value really lives in the
1985 specified int variable. */
1988 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1992 /* Boolean forwarding pointer to an int variable.
1993 This is like Lisp_Intfwd except that the ostensible
1994 "value" of the symbol is t if the int variable is nonzero,
1995 nil if it is zero. */
1998 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2002 /* Forwarding pointer to a Lisp_Object variable.
2003 This is allowed only in the value cell of a symbol,
2004 and it means that the symbol's value really lives in the
2005 specified variable. */
2008 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2009 Lisp_Object
*objvar
;
2012 /* Like Lisp_Objfwd except that value lives in a slot in the
2013 current buffer. Value is byte index of slot within buffer. */
2014 struct Lisp_Buffer_Objfwd
2016 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2018 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2019 Lisp_Object predicate
;
2022 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2023 the symbol has buffer-local or frame-local bindings. (Exception:
2024 some buffer-local variables are built-in, with their values stored
2025 in the buffer structure itself. They are handled differently,
2026 using struct Lisp_Buffer_Objfwd.)
2028 The `realvalue' slot holds the variable's current value, or a
2029 forwarding pointer to where that value is kept. This value is the
2030 one that corresponds to the loaded binding. To read or set the
2031 variable, you must first make sure the right binding is loaded;
2032 then you can access the value in (or through) `realvalue'.
2034 `buffer' and `frame' are the buffer and frame for which the loaded
2035 binding was found. If those have changed, to make sure the right
2036 binding is loaded it is necessary to find which binding goes with
2037 the current buffer and selected frame, then load it. To load it,
2038 first unload the previous binding, then copy the value of the new
2039 binding into `realvalue' (or through it). Also update
2040 LOADED-BINDING to point to the newly loaded binding.
2042 `local_if_set' indicates that merely setting the variable creates a
2043 local binding for the current buffer. Otherwise the latter, setting
2044 the variable does not do that; only make-local-variable does that. */
2046 struct Lisp_Buffer_Local_Value
2048 /* 1 means that merely setting the variable creates a local
2049 binding for the current buffer. */
2050 unsigned int local_if_set
: 1;
2051 /* 1 means this variable can have frame-local bindings, otherwise, it is
2052 can have buffer-local bindings. The two cannot be combined. */
2053 unsigned int frame_local
: 1;
2054 /* 1 means that the binding now loaded was found.
2055 Presumably equivalent to (defcell!=valcell). */
2056 unsigned int found
: 1;
2057 /* If non-NULL, a forwarding to the C var where it should also be set. */
2058 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2059 /* The buffer or frame for which the loaded binding was found. */
2061 /* A cons cell that holds the default value. It has the form
2062 (SYMBOL . DEFAULT-VALUE). */
2063 Lisp_Object defcell
;
2064 /* The cons cell from `where's parameter alist.
2065 It always has the form (SYMBOL . VALUE)
2066 Note that if `forward' is non-nil, VALUE may be out of date.
2067 Also if the currently loaded binding is the default binding, then
2068 this is `eq'ual to defcell. */
2069 Lisp_Object valcell
;
2072 /* Like Lisp_Objfwd except that value lives in a slot in the
2074 struct Lisp_Kboard_Objfwd
2076 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2082 struct Lisp_Intfwd u_intfwd
;
2083 struct Lisp_Boolfwd u_boolfwd
;
2084 struct Lisp_Objfwd u_objfwd
;
2085 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2086 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2089 LISP_INLINE
enum Lisp_Fwd_Type
2090 XFWDTYPE (union Lisp_Fwd
*a
)
2092 return a
->u_intfwd
.type
;
2095 LISP_INLINE
struct Lisp_Buffer_Objfwd
*
2096 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2098 eassert (BUFFER_OBJFWDP (a
));
2099 return &a
->u_buffer_objfwd
;
2102 /* Lisp floating point type. */
2108 struct Lisp_Float
*chain
;
2113 XFLOAT_DATA (Lisp_Object f
)
2115 return XFLOAT (f
)->u
.data
;
2118 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2119 representations, have infinities and NaNs, and do not trap on
2120 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2121 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2122 wanted here, but is not quite right because Emacs does not require
2123 all the features of C11 Annex F (and does not require C11 at all,
2124 for that matter). */
2128 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2129 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2132 /* A character, declared with the following typedef, is a member
2133 of some character set associated with the current buffer. */
2134 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2136 typedef unsigned char UCHAR
;
2139 /* Meanings of slots in a Lisp_Compiled: */
2143 COMPILED_ARGLIST
= 0,
2144 COMPILED_BYTECODE
= 1,
2145 COMPILED_CONSTANTS
= 2,
2146 COMPILED_STACK_DEPTH
= 3,
2147 COMPILED_DOC_STRING
= 4,
2148 COMPILED_INTERACTIVE
= 5
2151 /* Flag bits in a character. These also get used in termhooks.h.
2152 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2153 (MUlti-Lingual Emacs) might need 22 bits for the character value
2154 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2157 CHAR_ALT
= 0x0400000,
2158 CHAR_SUPER
= 0x0800000,
2159 CHAR_HYPER
= 0x1000000,
2160 CHAR_SHIFT
= 0x2000000,
2161 CHAR_CTL
= 0x4000000,
2162 CHAR_META
= 0x8000000,
2164 CHAR_MODIFIER_MASK
=
2165 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2167 /* Actually, the current Emacs uses 22 bits for the character value
2172 /* Structure to hold mouse highlight data. This is here because other
2173 header files need it for defining struct x_output etc. */
2175 /* These variables describe the range of text currently shown in its
2176 mouse-face, together with the window they apply to. As long as
2177 the mouse stays within this range, we need not redraw anything on
2178 its account. Rows and columns are glyph matrix positions in
2179 MOUSE_FACE_WINDOW. */
2180 int mouse_face_beg_row
, mouse_face_beg_col
;
2181 int mouse_face_beg_x
, mouse_face_beg_y
;
2182 int mouse_face_end_row
, mouse_face_end_col
;
2183 int mouse_face_end_x
, mouse_face_end_y
;
2184 Lisp_Object mouse_face_window
;
2185 int mouse_face_face_id
;
2186 Lisp_Object mouse_face_overlay
;
2188 /* FRAME and X, Y position of mouse when last checked for
2189 highlighting. X and Y can be negative or out of range for the frame. */
2190 struct frame
*mouse_face_mouse_frame
;
2191 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2193 /* Nonzero if part of the text currently shown in
2194 its mouse-face is beyond the window end. */
2195 unsigned mouse_face_past_end
: 1;
2197 /* Nonzero means defer mouse-motion highlighting. */
2198 unsigned mouse_face_defer
: 1;
2200 /* Nonzero means that the mouse highlight should not be shown. */
2201 unsigned mouse_face_hidden
: 1;
2204 /* Data type checking. */
2206 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2209 NUMBERP (Lisp_Object x
)
2211 return INTEGERP (x
) || FLOATP (x
);
2214 NATNUMP (Lisp_Object x
)
2216 return INTEGERP (x
) && 0 <= XINT (x
);
2220 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2222 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2225 #define TYPE_RANGED_INTEGERP(type, x) \
2227 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2228 && XINT (x) <= TYPE_MAXIMUM (type))
2230 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2231 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2232 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2233 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2234 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2235 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2236 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2239 STRINGP (Lisp_Object x
)
2241 return XTYPE (x
) == Lisp_String
;
2244 VECTORP (Lisp_Object x
)
2246 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2249 OVERLAYP (Lisp_Object x
)
2251 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2254 SAVE_VALUEP (Lisp_Object x
)
2256 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2260 AUTOLOADP (Lisp_Object x
)
2262 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2266 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2268 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2272 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2274 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2275 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2278 /* True if A is a pseudovector whose code is CODE. */
2280 PSEUDOVECTORP (Lisp_Object a
, int code
)
2282 if (! VECTORLIKEP (a
))
2286 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2287 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2288 return PSEUDOVECTOR_TYPEP (h
, code
);
2293 /* Test for specific pseudovector types. */
2296 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2298 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2302 PROCESSP (Lisp_Object a
)
2304 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2308 WINDOWP (Lisp_Object a
)
2310 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2314 TERMINALP (Lisp_Object a
)
2316 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2320 SUBRP (Lisp_Object a
)
2322 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2326 COMPILEDP (Lisp_Object a
)
2328 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2332 BUFFERP (Lisp_Object a
)
2334 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2338 CHAR_TABLE_P (Lisp_Object a
)
2340 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2344 SUB_CHAR_TABLE_P (Lisp_Object a
)
2346 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2350 BOOL_VECTOR_P (Lisp_Object a
)
2352 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2356 FRAMEP (Lisp_Object a
)
2358 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2361 /* Test for image (image . spec) */
2363 IMAGEP (Lisp_Object x
)
2365 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2370 ARRAYP (Lisp_Object x
)
2372 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2376 CHECK_LIST (Lisp_Object x
)
2378 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2381 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2382 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2383 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2386 CHECK_STRING (Lisp_Object x
)
2388 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2391 CHECK_STRING_CAR (Lisp_Object x
)
2393 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2396 CHECK_CONS (Lisp_Object x
)
2398 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2401 CHECK_VECTOR (Lisp_Object x
)
2403 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2406 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2408 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2411 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2413 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2416 CHECK_BUFFER (Lisp_Object x
)
2418 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2421 CHECK_WINDOW (Lisp_Object x
)
2423 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2426 CHECK_PROCESS (Lisp_Object x
)
2428 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2431 CHECK_NATNUM (Lisp_Object x
)
2433 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2436 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2439 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2440 args_out_of_range_3 \
2442 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2443 ? MOST_NEGATIVE_FIXNUM \
2445 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2447 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2449 if (TYPE_SIGNED (type)) \
2450 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2452 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2455 #define CHECK_NUMBER_COERCE_MARKER(x) \
2456 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
2457 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
2460 XFLOATINT (Lisp_Object n
)
2462 return extract_float (n
);
2466 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2468 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2471 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2472 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
2473 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
2475 /* Since we can't assign directly to the CAR or CDR fields of a cons
2476 cell, use these when checking that those fields contain numbers. */
2478 CHECK_NUMBER_CAR (Lisp_Object x
)
2480 Lisp_Object tmp
= XCAR (x
);
2486 CHECK_NUMBER_CDR (Lisp_Object x
)
2488 Lisp_Object tmp
= XCDR (x
);
2493 /* Define a built-in function for calling from Lisp.
2494 `lname' should be the name to give the function in Lisp,
2495 as a null-terminated C string.
2496 `fnname' should be the name of the function in C.
2497 By convention, it starts with F.
2498 `sname' should be the name for the C constant structure
2499 that records information on this function for internal use.
2500 By convention, it should be the same as `fnname' but with S instead of F.
2501 It's too bad that C macros can't compute this from `fnname'.
2502 `minargs' should be a number, the minimum number of arguments allowed.
2503 `maxargs' should be a number, the maximum number of arguments allowed,
2504 or else MANY or UNEVALLED.
2505 MANY means pass a vector of evaluated arguments,
2506 in the form of an integer number-of-arguments
2507 followed by the address of a vector of Lisp_Objects
2508 which contains the argument values.
2509 UNEVALLED means pass the list of unevaluated arguments
2510 `intspec' says how interactive arguments are to be fetched.
2511 If the string starts with a `(', `intspec' is evaluated and the resulting
2512 list is the list of arguments.
2513 If it's a string that doesn't start with `(', the value should follow
2514 the one of the doc string for `interactive'.
2515 A null string means call interactively with no arguments.
2516 `doc' is documentation for the user. */
2518 /* This version of DEFUN declares a function prototype with the right
2519 arguments, so we can catch errors with maxargs at compile-time. */
2521 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2522 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2523 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2524 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2525 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2526 { (Lisp_Object (__cdecl *)(void))fnname }, \
2527 minargs, maxargs, lname, intspec, 0}; \
2529 #else /* not _MSC_VER */
2530 # if __STDC_VERSION__ < 199901
2531 # define DEFUN_FUNCTION_INIT(fnname, maxargs) (Lisp_Object (*) (void)) fnname
2533 # define DEFUN_FUNCTION_INIT(fnname, maxargs) .a ## maxargs = fnname
2535 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2536 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2537 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2538 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2539 { DEFUN_FUNCTION_INIT (fnname, maxargs) }, \
2540 minargs, maxargs, lname, intspec, 0}; \
2544 /* Note that the weird token-substitution semantics of ANSI C makes
2545 this work for MANY and UNEVALLED. */
2546 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2547 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2548 #define DEFUN_ARGS_0 (void)
2549 #define DEFUN_ARGS_1 (Lisp_Object)
2550 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2551 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2552 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2553 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2555 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2556 Lisp_Object, Lisp_Object)
2557 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2558 Lisp_Object, Lisp_Object, Lisp_Object)
2559 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2560 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2562 /* True if OBJ is a Lisp function. */
2564 FUNCTIONP (Lisp_Object obj
)
2566 return functionp (obj
);
2570 is how we define the symbol for function `name' at start-up time. */
2571 extern void defsubr (struct Lisp_Subr
*);
2579 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2580 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2581 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2582 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2583 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2585 /* Macros we use to define forwarded Lisp variables.
2586 These are used in the syms_of_FILENAME functions.
2588 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2589 lisp variable is actually a field in `struct emacs_globals'. The
2590 field's name begins with "f_", which is a convention enforced by
2591 these macros. Each such global has a corresponding #define in
2592 globals.h; the plain name should be used in the code.
2594 E.g., the global "cons_cells_consed" is declared as "int
2595 f_cons_cells_consed" in globals.h, but there is a define:
2597 #define cons_cells_consed globals.f_cons_cells_consed
2599 All C code uses the `cons_cells_consed' name. This is all done
2600 this way to support indirection for multi-threaded Emacs. */
2602 #define DEFVAR_LISP(lname, vname, doc) \
2604 static struct Lisp_Objfwd o_fwd; \
2605 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2607 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2609 static struct Lisp_Objfwd o_fwd; \
2610 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2612 #define DEFVAR_BOOL(lname, vname, doc) \
2614 static struct Lisp_Boolfwd b_fwd; \
2615 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2617 #define DEFVAR_INT(lname, vname, doc) \
2619 static struct Lisp_Intfwd i_fwd; \
2620 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2623 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2625 static struct Lisp_Objfwd o_fwd; \
2626 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2629 #define DEFVAR_KBOARD(lname, vname, doc) \
2631 static struct Lisp_Kboard_Objfwd ko_fwd; \
2632 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2635 /* Save and restore the instruction and environment pointers,
2636 without affecting the signal mask. */
2639 typedef jmp_buf sys_jmp_buf
;
2640 # define sys_setjmp(j) _setjmp (j)
2641 # define sys_longjmp(j, v) _longjmp (j, v)
2642 #elif defined HAVE_SIGSETJMP
2643 typedef sigjmp_buf sys_jmp_buf
;
2644 # define sys_setjmp(j) sigsetjmp (j, 0)
2645 # define sys_longjmp(j, v) siglongjmp (j, v)
2647 /* A platform that uses neither _longjmp nor siglongjmp; assume
2648 longjmp does not affect the sigmask. */
2649 typedef jmp_buf sys_jmp_buf
;
2650 # define sys_setjmp(j) setjmp (j)
2651 # define sys_longjmp(j, v) longjmp (j, v)
2655 /* Elisp uses several stacks:
2657 - the bytecode stack: used internally by the bytecode interpreter.
2658 Allocated from the C stack.
2659 - The specpdl stack: keeps track of active unwind-protect and
2660 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2662 - The catch stack: keeps track of active catch tags.
2663 Allocated on the C stack. This is where the setmp data is kept.
2664 - The handler stack: keeps track of active condition-case handlers.
2665 Allocated on the C stack. Every entry there also uses an entry in
2668 /* Structure for recording Lisp call stack for backtrace purposes. */
2670 /* The special binding stack holds the outer values of variables while
2671 they are bound by a function application or a let form, stores the
2672 code to be executed for unwind-protect forms.
2674 If func is non-zero, undoing this binding applies func to old_value;
2675 This implements record_unwind_protect.
2677 Otherwise, the element is a variable binding.
2679 If the symbol field is a symbol, it is an ordinary variable binding.
2681 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2682 which means having bound a local value while CURRENT-BUFFER was active.
2683 If WHERE is nil this means we saw the default value when binding SYMBOL.
2684 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2685 value. Other values of WHERE mean an internal error.
2687 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2688 used all over the place, needs to be fast, and needs to know the size of
2689 union specbinding. But only eval.c should access it. */
2692 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2693 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2694 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2695 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2696 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2697 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2698 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2699 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2700 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2705 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2707 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2708 void (*func
) (Lisp_Object
);
2712 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2713 void (*func
) (void *);
2717 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2722 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2723 void (*func
) (void);
2726 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2727 /* `where' is not used in the case of SPECPDL_LET. */
2728 Lisp_Object symbol
, old_value
, where
;
2731 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2732 bool debug_on_exit
: 1;
2733 Lisp_Object function
;
2739 extern union specbinding
*specpdl
;
2740 extern union specbinding
*specpdl_ptr
;
2741 extern ptrdiff_t specpdl_size
;
2743 LISP_INLINE
ptrdiff_t
2744 SPECPDL_INDEX (void)
2746 return specpdl_ptr
- specpdl
;
2749 /* Everything needed to describe an active condition case.
2751 Members are volatile if their values need to survive _longjmp when
2752 a 'struct handler' is a local variable. */
2755 /* The handler clauses and variable from the condition-case form. */
2756 /* For a handler set up in Lisp code, this is always a list.
2757 For an internal handler set up by internal_condition_case*,
2758 this can instead be the symbol t or `error'.
2759 t: handle all conditions.
2760 error: handle all conditions, and errors can run the debugger
2761 or display a backtrace. */
2762 Lisp_Object handler
;
2764 Lisp_Object
volatile var
;
2766 /* Fsignal stores here the condition-case clause that applies,
2767 and Fcondition_case thus knows which clause to run. */
2768 Lisp_Object
volatile chosen_clause
;
2770 /* Used to effect the longjump out to the handler. */
2771 struct catchtag
*tag
;
2773 /* The next enclosing handler. */
2774 struct handler
*next
;
2777 /* This structure helps implement the `catch' and `throw' control
2778 structure. A struct catchtag contains all the information needed
2779 to restore the state of the interpreter after a non-local jump.
2781 Handlers for error conditions (represented by `struct handler'
2782 structures) just point to a catch tag to do the cleanup required
2785 catchtag structures are chained together in the C calling stack;
2786 the `next' member points to the next outer catchtag.
2788 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2789 member is TAG, and then unbinds to it. The `val' member is used to
2790 hold VAL while the stack is unwound; `val' is returned as the value
2793 All the other members are concerned with restoring the interpreter
2796 Members are volatile if their values need to survive _longjmp when
2797 a 'struct catchtag' is a local variable. */
2801 Lisp_Object
volatile val
;
2802 struct catchtag
*volatile next
;
2803 #if 1 /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but they're defined later. */
2804 struct gcpro
*gcpro
;
2807 struct handler
*handlerlist
;
2808 EMACS_INT lisp_eval_depth
;
2809 ptrdiff_t volatile pdlcount
;
2810 int poll_suppress_count
;
2811 int interrupt_input_blocked
;
2812 struct byte_stack
*byte_stack
;
2815 extern Lisp_Object memory_signal_data
;
2817 /* An address near the bottom of the stack.
2818 Tells GC how to save a copy of the stack. */
2819 extern char *stack_bottom
;
2821 /* Check quit-flag and quit if it is non-nil.
2822 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2823 So the program needs to do QUIT at times when it is safe to quit.
2824 Every loop that might run for a long time or might not exit
2825 ought to do QUIT at least once, at a safe place.
2826 Unless that is impossible, of course.
2827 But it is very desirable to avoid creating loops where QUIT is impossible.
2829 Exception: if you set immediate_quit to nonzero,
2830 then the handler that responds to the C-g does the quit itself.
2831 This is a good thing to do around a loop that has no side effects
2832 and (in particular) cannot call arbitrary Lisp code.
2834 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2835 a request to exit Emacs when it is safe to do. */
2837 extern void process_pending_signals (void);
2838 extern bool volatile pending_signals
;
2840 extern void process_quit_flag (void);
2843 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2844 process_quit_flag (); \
2845 else if (pending_signals) \
2846 process_pending_signals (); \
2850 /* Nonzero if ought to quit now. */
2852 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2854 extern Lisp_Object Vascii_downcase_table
;
2855 extern Lisp_Object Vascii_canon_table
;
2857 /* Structure for recording stack slots that need marking. */
2859 /* This is a chain of structures, each of which points at a Lisp_Object
2860 variable whose value should be marked in garbage collection.
2861 Normally every link of the chain is an automatic variable of a function,
2862 and its `val' points to some argument or local variable of the function.
2863 On exit to the function, the chain is set back to the value it had on entry.
2864 This way, no link remains in the chain when the stack frame containing the
2867 Every function that can call Feval must protect in this fashion all
2868 Lisp_Object variables whose contents will be used again. */
2870 extern struct gcpro
*gcprolist
;
2876 /* Address of first protected variable. */
2877 volatile Lisp_Object
*var
;
2879 /* Number of consecutive protected variables. */
2887 /* Values of GC_MARK_STACK during compilation:
2889 0 Use GCPRO as before
2890 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2891 2 Mark the stack, and check that everything GCPRO'd is
2893 3 Mark using GCPRO's, mark stack last, and count how many
2894 dead objects are kept alive.
2896 Formerly, method 0 was used. Currently, method 1 is used unless
2897 otherwise specified by hand when building, e.g.,
2898 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
2899 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
2901 #define GC_USE_GCPROS_AS_BEFORE 0
2902 #define GC_MAKE_GCPROS_NOOPS 1
2903 #define GC_MARK_STACK_CHECK_GCPROS 2
2904 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2906 #ifndef GC_MARK_STACK
2907 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2910 /* Whether we do the stack marking manually. */
2911 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2912 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2915 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2917 /* Do something silly with gcproN vars just so gcc shuts up. */
2918 /* You get warnings from MIPSPro... */
2920 #define GCPRO1(varname) ((void) gcpro1)
2921 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2922 #define GCPRO3(varname1, varname2, varname3) \
2923 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2924 #define GCPRO4(varname1, varname2, varname3, varname4) \
2925 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2926 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2927 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2928 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2929 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2931 #define UNGCPRO ((void) 0)
2933 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2937 #define GCPRO1(varname) \
2938 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2939 gcprolist = &gcpro1; }
2941 #define GCPRO2(varname1, varname2) \
2942 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2943 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2944 gcprolist = &gcpro2; }
2946 #define GCPRO3(varname1, varname2, varname3) \
2947 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2948 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2949 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2950 gcprolist = &gcpro3; }
2952 #define GCPRO4(varname1, varname2, varname3, varname4) \
2953 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2954 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2955 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2956 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2957 gcprolist = &gcpro4; }
2959 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2960 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2961 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2962 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2963 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2964 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2965 gcprolist = &gcpro5; }
2967 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2968 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2969 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2970 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2971 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2972 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2973 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2974 gcprolist = &gcpro6; }
2976 #define UNGCPRO (gcprolist = gcpro1.next)
2980 extern int gcpro_level
;
2982 #define GCPRO1(varname) \
2983 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2984 gcpro1.level = gcpro_level++; \
2985 gcprolist = &gcpro1; }
2987 #define GCPRO2(varname1, varname2) \
2988 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2989 gcpro1.level = gcpro_level; \
2990 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2991 gcpro2.level = gcpro_level++; \
2992 gcprolist = &gcpro2; }
2994 #define GCPRO3(varname1, varname2, varname3) \
2995 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2996 gcpro1.level = gcpro_level; \
2997 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2998 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2999 gcpro3.level = gcpro_level++; \
3000 gcprolist = &gcpro3; }
3002 #define GCPRO4(varname1, varname2, varname3, varname4) \
3003 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3004 gcpro1.level = gcpro_level; \
3005 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3006 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3007 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3008 gcpro4.level = gcpro_level++; \
3009 gcprolist = &gcpro4; }
3011 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3012 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3013 gcpro1.level = gcpro_level; \
3014 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3015 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3016 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3017 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3018 gcpro5.level = gcpro_level++; \
3019 gcprolist = &gcpro5; }
3021 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3022 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3023 gcpro1.level = gcpro_level; \
3024 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3025 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3026 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3027 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3028 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3029 gcpro6.level = gcpro_level++; \
3030 gcprolist = &gcpro6; }
3033 ((--gcpro_level != gcpro1.level) \
3034 ? (emacs_abort (), 0) \
3035 : ((gcprolist = gcpro1.next), 0))
3037 #endif /* DEBUG_GCPRO */
3038 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3041 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3042 #define RETURN_UNGCPRO(expr) \
3045 Lisp_Object ret_ungc_val; \
3046 ret_ungc_val = (expr); \
3048 return ret_ungc_val; \
3052 /* Call staticpro (&var) to protect static variable `var'. */
3054 void staticpro (Lisp_Object
*);
3056 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3057 meaning as in the DEFUN macro, and is used to construct a prototype. */
3058 /* We can use the same trick as in the DEFUN macro to generate the
3059 appropriate prototype. */
3060 #define EXFUN(fnname, maxargs) \
3061 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3063 #include "globals.h"
3065 /* Forward declarations for prototypes. */
3069 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3072 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3074 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3075 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3078 /* Functions to modify hash tables. */
3081 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3083 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3087 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3089 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3092 /* Use these functions to set Lisp_Object
3093 or pointer slots of struct Lisp_Symbol. */
3096 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3098 XSYMBOL (sym
)->function
= function
;
3102 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3104 XSYMBOL (sym
)->plist
= plist
;
3108 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3110 XSYMBOL (sym
)->next
= next
;
3113 /* Buffer-local (also frame-local) variable access functions. */
3116 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3118 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3122 /* Set overlay's property list. */
3125 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3127 XOVERLAY (overlay
)->plist
= plist
;
3130 /* Get text properties of S. */
3132 LISP_INLINE INTERVAL
3133 string_intervals (Lisp_Object s
)
3135 return XSTRING (s
)->intervals
;
3138 /* Set text properties of S to I. */
3141 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3143 XSTRING (s
)->intervals
= i
;
3146 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3147 of setting slots directly. */
3150 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3152 XCHAR_TABLE (table
)->defalt
= val
;
3155 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3157 XCHAR_TABLE (table
)->purpose
= val
;
3160 /* Set different slots in (sub)character tables. */
3163 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3165 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3166 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3170 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3172 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3173 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3177 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3179 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3182 /* Defined in data.c. */
3183 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3184 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3185 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3186 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3187 extern Lisp_Object Qinvalid_read_syntax
;
3188 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3189 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3190 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3191 extern Lisp_Object Qtext_read_only
;
3192 extern Lisp_Object Qinteractive_form
;
3193 extern Lisp_Object Qcircular_list
;
3194 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3195 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3196 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3197 extern Lisp_Object Qbuffer_or_string_p
;
3198 extern Lisp_Object Qfboundp
;
3199 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3201 extern Lisp_Object Qcdr
;
3203 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3205 extern Lisp_Object Qfloatp
;
3206 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3208 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3210 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3212 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3214 /* Defined in data.c. */
3215 extern Lisp_Object
indirect_function (Lisp_Object
);
3216 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3218 /* Convert the integer I to an Emacs representation, either the integer
3219 itself, or a cons of two or three integers, or if all else fails a float.
3220 I should not have side effects. */
3221 #define INTEGER_TO_CONS(i) \
3222 (! FIXNUM_OVERFLOW_P (i) \
3224 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3225 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3226 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3227 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3228 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3229 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3230 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3231 ? Fcons (make_number ((i) >> 16 >> 24), \
3232 Fcons (make_number ((i) >> 16 & 0xffffff), \
3233 make_number ((i) & 0xffff))) \
3236 /* Convert the Emacs representation CONS back to an integer of type
3237 TYPE, storing the result the variable VAR. Signal an error if CONS
3238 is not a valid representation or is out of range for TYPE. */
3239 #define CONS_TO_INTEGER(cons, type, var) \
3240 (TYPE_SIGNED (type) \
3241 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3242 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3243 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3244 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3246 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3247 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3248 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3250 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3251 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3252 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3253 extern void syms_of_data (void);
3254 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3256 /* Defined in cmds.c */
3257 extern void syms_of_cmds (void);
3258 extern void keys_of_cmds (void);
3260 /* Defined in coding.c. */
3261 extern Lisp_Object Qcharset
;
3262 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3263 ptrdiff_t, bool, bool, Lisp_Object
);
3264 extern void init_coding (void);
3265 extern void init_coding_once (void);
3266 extern void syms_of_coding (void);
3268 /* Defined in character.c. */
3269 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3270 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3271 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3272 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3273 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3274 extern void syms_of_character (void);
3276 /* Defined in charset.c. */
3277 extern void init_charset (void);
3278 extern void init_charset_once (void);
3279 extern void syms_of_charset (void);
3280 /* Structure forward declarations. */
3283 /* Defined in composite.c. */
3284 extern void syms_of_composite (void);
3286 /* Defined in syntax.c. */
3287 extern void init_syntax_once (void);
3288 extern void syms_of_syntax (void);
3290 /* Defined in fns.c. */
3291 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3292 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3293 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3294 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3295 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3296 extern void sweep_weak_hash_tables (void);
3297 extern Lisp_Object Qcursor_in_echo_area
;
3298 extern Lisp_Object Qstring_lessp
;
3299 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3300 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3301 EMACS_UINT
sxhash (Lisp_Object
, int);
3302 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3303 Lisp_Object
, Lisp_Object
);
3304 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3305 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3307 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3309 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3310 ptrdiff_t, ptrdiff_t);
3311 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3312 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3313 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3314 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3315 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3316 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3317 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3318 extern void clear_string_char_byte_cache (void);
3319 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3320 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3321 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3322 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3323 extern void syms_of_fns (void);
3325 /* Defined in floatfns.c. */
3326 extern double extract_float (Lisp_Object
);
3327 extern void syms_of_floatfns (void);
3328 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3330 /* Defined in fringe.c. */
3331 extern void syms_of_fringe (void);
3332 extern void init_fringe (void);
3333 #ifdef HAVE_WINDOW_SYSTEM
3334 extern void mark_fringe_data (void);
3335 extern void init_fringe_once (void);
3336 #endif /* HAVE_WINDOW_SYSTEM */
3338 /* Defined in image.c. */
3339 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3340 extern Lisp_Object QCconversion
;
3341 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3342 extern void reset_image_types (void);
3343 extern void syms_of_image (void);
3345 /* Defined in insdel.c. */
3346 extern Lisp_Object Qinhibit_modification_hooks
;
3347 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3348 extern _Noreturn
void buffer_overflow (void);
3349 extern void make_gap (ptrdiff_t);
3350 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3351 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3352 ptrdiff_t, bool, bool);
3353 extern int count_combining_before (const unsigned char *,
3354 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3355 extern int count_combining_after (const unsigned char *,
3356 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3357 extern void insert (const char *, ptrdiff_t);
3358 extern void insert_and_inherit (const char *, ptrdiff_t);
3359 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3361 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3362 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3363 ptrdiff_t, ptrdiff_t, bool);
3364 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3365 extern void insert_char (int);
3366 extern void insert_string (const char *);
3367 extern void insert_before_markers (const char *, ptrdiff_t);
3368 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3369 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3370 ptrdiff_t, ptrdiff_t,
3372 extern void del_range (ptrdiff_t, ptrdiff_t);
3373 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3374 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3375 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3376 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3377 ptrdiff_t, ptrdiff_t, bool);
3378 extern void modify_text (ptrdiff_t, ptrdiff_t);
3379 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3380 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3381 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3382 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3383 ptrdiff_t, ptrdiff_t);
3384 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3385 ptrdiff_t, ptrdiff_t);
3386 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3387 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3388 const char *, ptrdiff_t, ptrdiff_t, bool);
3389 extern void syms_of_insdel (void);
3391 /* Defined in dispnew.c. */
3392 #if (defined PROFILING \
3393 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3394 _Noreturn
void __executable_start (void);
3396 extern Lisp_Object selected_frame
;
3397 extern Lisp_Object Vwindow_system
;
3398 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3399 extern void init_display (void);
3400 extern void syms_of_display (void);
3402 /* Defined in xdisp.c. */
3403 extern Lisp_Object Qinhibit_point_motion_hooks
;
3404 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3405 extern Lisp_Object Qmenu_bar_update_hook
;
3406 extern Lisp_Object Qwindow_scroll_functions
;
3407 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3408 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3409 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3410 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3411 extern Lisp_Object Qleft_margin
, Qright_margin
;
3412 extern Lisp_Object Qglyphless_char
;
3413 extern Lisp_Object QCdata
, QCfile
;
3414 extern Lisp_Object QCmap
;
3415 extern Lisp_Object Qrisky_local_variable
;
3416 extern struct frame
*last_glyphless_glyph_frame
;
3417 extern int last_glyphless_glyph_face_id
;
3418 extern int last_glyphless_glyph_merged_face_id
;
3419 extern int noninteractive_need_newline
;
3420 extern Lisp_Object echo_area_buffer
[2];
3421 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3422 extern void check_message_stack (void);
3423 extern void setup_echo_area_for_printing (int);
3424 extern bool push_message (void);
3425 extern void pop_message_unwind (void);
3426 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3427 extern void restore_message (void);
3428 extern Lisp_Object
current_message (void);
3429 extern void clear_message (int, int);
3430 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3431 extern void message1 (const char *);
3432 extern void message1_nolog (const char *);
3433 extern void message3 (Lisp_Object
);
3434 extern void message3_nolog (Lisp_Object
);
3435 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3436 extern void message_with_string (const char *, Lisp_Object
, int);
3437 extern void message_log_maybe_newline (void);
3438 extern void update_echo_area (void);
3439 extern void truncate_echo_area (ptrdiff_t);
3440 extern void redisplay (void);
3441 extern void redisplay_preserve_echo_area (int);
3442 extern void prepare_menu_bars (void);
3444 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3445 extern void syms_of_xdisp (void);
3446 extern void init_xdisp (void);
3447 extern Lisp_Object
safe_eval (Lisp_Object
);
3448 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3449 int *, int *, int *, int *, int *);
3451 /* Defined in xsettings.c. */
3452 extern void syms_of_xsettings (void);
3454 /* Defined in vm-limit.c. */
3455 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3457 /* Defined in alloc.c. */
3458 extern void check_pure_size (void);
3459 extern void free_misc (Lisp_Object
);
3460 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3461 extern void malloc_warning (const char *);
3462 extern _Noreturn
void memory_full (size_t);
3463 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3464 extern bool survives_gc_p (Lisp_Object
);
3465 extern void mark_object (Lisp_Object
);
3466 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3467 extern void refill_memory_reserve (void);
3469 extern const char *pending_malloc_warning
;
3470 extern Lisp_Object zero_vector
;
3471 extern Lisp_Object
*stack_base
;
3472 extern EMACS_INT consing_since_gc
;
3473 extern EMACS_INT gc_relative_threshold
;
3474 extern EMACS_INT memory_full_cons_threshold
;
3475 extern Lisp_Object
list1 (Lisp_Object
);
3476 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3477 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3478 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3479 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3481 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3482 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3484 /* Build a frequently used 2/3/4-integer lists. */
3486 LISP_INLINE Lisp_Object
3487 list2i (EMACS_INT x
, EMACS_INT y
)
3489 return list2 (make_number (x
), make_number (y
));
3492 LISP_INLINE Lisp_Object
3493 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3495 return list3 (make_number (x
), make_number (y
), make_number (w
));
3498 LISP_INLINE Lisp_Object
3499 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3501 return list4 (make_number (x
), make_number (y
),
3502 make_number (w
), make_number (h
));
3505 extern _Noreturn
void string_overflow (void);
3506 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3507 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3508 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3509 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3511 /* Make unibyte string from C string when the length isn't known. */
3513 LISP_INLINE Lisp_Object
3514 build_unibyte_string (const char *str
)
3516 return make_unibyte_string (str
, strlen (str
));
3519 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3520 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
3521 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3522 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3523 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3524 extern Lisp_Object
make_specified_string (const char *,
3525 ptrdiff_t, ptrdiff_t, bool);
3526 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3527 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3529 /* Make a string allocated in pure space, use STR as string data. */
3531 LISP_INLINE Lisp_Object
3532 build_pure_c_string (const char *str
)
3534 return make_pure_c_string (str
, strlen (str
));
3537 /* Make a string from the data at STR, treating it as multibyte if the
3540 LISP_INLINE Lisp_Object
3541 build_string (const char *str
)
3543 return make_string (str
, strlen (str
));
3546 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3547 extern void make_byte_code (struct Lisp_Vector
*);
3548 extern Lisp_Object Qautomatic_gc
;
3549 extern Lisp_Object Qchar_table_extra_slots
;
3550 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3552 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3553 be sure that GC cannot happen until the vector is completely
3554 initialized. E.g. the following code is likely to crash:
3556 v = make_uninit_vector (3);
3558 ASET (v, 1, Ffunction_can_gc ());
3559 ASET (v, 2, obj1); */
3561 LISP_INLINE Lisp_Object
3562 make_uninit_vector (ptrdiff_t size
)
3565 struct Lisp_Vector
*p
;
3567 p
= allocate_vector (size
);
3572 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3573 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3575 allocate_pseudovector \
3576 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3577 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3578 extern struct window
*allocate_window (void);
3579 extern struct frame
*allocate_frame (void);
3580 extern struct Lisp_Process
*allocate_process (void);
3581 extern struct terminal
*allocate_terminal (void);
3582 extern bool gc_in_progress
;
3583 extern bool abort_on_gc
;
3584 extern Lisp_Object
make_float (double);
3585 extern void display_malloc_warning (void);
3586 extern ptrdiff_t inhibit_garbage_collection (void);
3587 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3588 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3589 Lisp_Object
, Lisp_Object
);
3590 extern Lisp_Object
make_save_ptr (void *);
3591 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3592 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3593 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3595 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3596 extern void free_save_value (Lisp_Object
);
3597 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3598 extern void free_marker (Lisp_Object
);
3599 extern void free_cons (struct Lisp_Cons
*);
3600 extern void init_alloc_once (void);
3601 extern void init_alloc (void);
3602 extern void syms_of_alloc (void);
3603 extern struct buffer
* allocate_buffer (void);
3604 extern int valid_lisp_object_p (Lisp_Object
);
3605 #ifdef GC_CHECK_CONS_LIST
3606 extern void check_cons_list (void);
3608 LISP_INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3612 /* Defined in ralloc.c. */
3613 extern void *r_alloc (void **, size_t);
3614 extern void r_alloc_free (void **);
3615 extern void *r_re_alloc (void **, size_t);
3616 extern void r_alloc_reset_variable (void **, void **);
3617 extern void r_alloc_inhibit_buffer_relocation (int);
3620 /* Defined in chartab.c. */
3621 extern Lisp_Object
copy_char_table (Lisp_Object
);
3622 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3623 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3625 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3626 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3627 extern int char_table_translate (Lisp_Object
, int);
3628 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3630 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3631 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3632 Lisp_Object
, Lisp_Object
,
3633 Lisp_Object
, struct charset
*,
3634 unsigned, unsigned);
3635 extern Lisp_Object
uniprop_table (Lisp_Object
);
3636 extern void syms_of_chartab (void);
3638 /* Defined in print.c. */
3639 extern Lisp_Object Vprin1_to_string_buffer
;
3640 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3641 extern Lisp_Object Qstandard_output
;
3642 extern Lisp_Object Qexternal_debugging_output
;
3643 extern void temp_output_buffer_setup (const char *);
3644 extern int print_level
;
3645 extern Lisp_Object Qprint_escape_newlines
;
3646 extern void write_string (const char *, int);
3647 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3649 extern Lisp_Object internal_with_output_to_temp_buffer
3650 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3651 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3652 extern int float_to_string (char *, double);
3653 extern void init_print_once (void);
3654 extern void syms_of_print (void);
3656 /* Defined in doprnt.c. */
3657 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3659 extern ptrdiff_t esprintf (char *, char const *, ...)
3660 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3661 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3663 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3664 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3665 char const *, va_list)
3666 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3668 /* Defined in lread.c. */
3669 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3670 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3671 extern Lisp_Object Qlexical_binding
;
3672 extern Lisp_Object
check_obarray (Lisp_Object
);
3673 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3674 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3675 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3677 LOADHIST_ATTACH (Lisp_Object x
)
3680 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3682 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3683 Lisp_Object
*, Lisp_Object
);
3684 extern Lisp_Object
string_to_number (char const *, int, bool);
3685 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3687 extern void dir_warning (const char *, Lisp_Object
);
3688 extern void init_obarray (void);
3689 extern void init_lread (void);
3690 extern void syms_of_lread (void);
3692 LISP_INLINE Lisp_Object
3693 intern (const char *str
)
3695 return intern_1 (str
, strlen (str
));
3698 LISP_INLINE Lisp_Object
3699 intern_c_string (const char *str
)
3701 return intern_c_string_1 (str
, strlen (str
));
3704 /* Defined in eval.c. */
3705 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3706 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3707 extern Lisp_Object Qand_rest
;
3708 extern Lisp_Object Vautoload_queue
;
3709 extern Lisp_Object Vsignaling_function
;
3710 extern Lisp_Object inhibit_lisp_code
;
3712 extern struct catchtag
*catchlist
;
3713 extern struct handler
*handlerlist
;
3715 /* To run a normal hook, use the appropriate function from the list below.
3716 The calling convention:
3718 if (!NILP (Vrun_hooks))
3719 call1 (Vrun_hooks, Qmy_funny_hook);
3721 should no longer be used. */
3722 extern Lisp_Object Vrun_hooks
;
3723 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3724 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3725 Lisp_Object (*funcall
)
3726 (ptrdiff_t nargs
, Lisp_Object
*args
));
3727 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3728 extern _Noreturn
void xsignal0 (Lisp_Object
);
3729 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3730 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3731 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3733 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3734 extern Lisp_Object
eval_sub (Lisp_Object form
);
3735 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3736 extern Lisp_Object
call0 (Lisp_Object
);
3737 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3738 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3739 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3740 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3741 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3742 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3743 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3744 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3745 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3746 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3747 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3748 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3749 extern Lisp_Object internal_condition_case_n
3750 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3751 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3752 extern void specbind (Lisp_Object
, Lisp_Object
);
3753 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3754 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3755 extern void record_unwind_protect_int (void (*) (int), int);
3756 extern void record_unwind_protect_void (void (*) (void));
3757 extern void record_unwind_protect_nothing (void);
3758 extern void clear_unwind_protect (ptrdiff_t);
3759 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3760 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3761 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3762 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3763 extern _Noreturn
void verror (const char *, va_list)
3764 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3765 extern void un_autoload (Lisp_Object
);
3766 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3767 extern void init_eval_once (void);
3768 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3769 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3770 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3771 extern void init_eval (void);
3772 extern void syms_of_eval (void);
3773 extern void unwind_body (Lisp_Object
);
3774 extern void record_in_backtrace (Lisp_Object function
,
3775 Lisp_Object
*args
, ptrdiff_t nargs
);
3776 extern void mark_specpdl (void);
3777 extern void get_backtrace (Lisp_Object array
);
3778 Lisp_Object
backtrace_top_function (void);
3779 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3780 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3783 /* Defined in editfns.c. */
3784 extern Lisp_Object Qfield
;
3785 extern void insert1 (Lisp_Object
);
3786 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3787 extern Lisp_Object
save_excursion_save (void);
3788 extern Lisp_Object
save_restriction_save (void);
3789 extern void save_excursion_restore (Lisp_Object
);
3790 extern void save_restriction_restore (Lisp_Object
);
3791 extern _Noreturn
void time_overflow (void);
3792 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3793 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3795 extern void init_editfns (void);
3796 extern void syms_of_editfns (void);
3797 extern void set_time_zone_rule (const char *);
3799 /* Defined in buffer.c. */
3800 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3801 extern _Noreturn
void nsberror (Lisp_Object
);
3802 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3803 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3804 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3805 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3806 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3807 extern bool overlay_touches_p (ptrdiff_t);
3808 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3809 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3810 extern void init_buffer_once (void);
3811 extern void init_buffer (void);
3812 extern void syms_of_buffer (void);
3813 extern void keys_of_buffer (void);
3815 /* Defined in marker.c. */
3817 extern ptrdiff_t marker_position (Lisp_Object
);
3818 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3819 extern void clear_charpos_cache (struct buffer
*);
3820 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3821 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3822 extern void unchain_marker (struct Lisp_Marker
*marker
);
3823 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3824 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3825 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3826 ptrdiff_t, ptrdiff_t);
3827 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3828 extern void syms_of_marker (void);
3830 /* Defined in fileio.c. */
3832 extern Lisp_Object Qfile_error
;
3833 extern Lisp_Object Qfile_notify_error
;
3834 extern Lisp_Object Qfile_exists_p
;
3835 extern Lisp_Object Qfile_directory_p
;
3836 extern Lisp_Object Qinsert_file_contents
;
3837 extern Lisp_Object Qfile_name_history
;
3838 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3839 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3840 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3842 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3843 extern void close_file_unwind (int);
3844 extern void fclose_unwind (void *);
3845 extern void restore_point_unwind (Lisp_Object
);
3846 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3847 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3848 extern bool internal_delete_file (Lisp_Object
);
3849 extern Lisp_Object
emacs_readlinkat (int, const char *);
3850 extern bool file_directory_p (const char *);
3851 extern bool file_accessible_directory_p (const char *);
3852 extern void init_fileio (void);
3853 extern void syms_of_fileio (void);
3854 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3855 extern Lisp_Object Qdelete_file
;
3856 extern bool check_existing (const char *);
3858 /* Defined in search.c. */
3859 extern void shrink_regexp_cache (void);
3860 extern void restore_search_regs (void);
3861 extern void record_unwind_save_match_data (void);
3862 struct re_registers
;
3863 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3864 struct re_registers
*,
3865 Lisp_Object
, bool, bool);
3866 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3867 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3869 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3870 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3871 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3872 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3873 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3874 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3876 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3877 ptrdiff_t, ptrdiff_t *);
3878 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3879 ptrdiff_t, ptrdiff_t *);
3880 extern void syms_of_search (void);
3881 extern void clear_regexp_cache (void);
3883 /* Defined in minibuf.c. */
3885 extern Lisp_Object Qcompletion_ignore_case
;
3886 extern Lisp_Object Vminibuffer_list
;
3887 extern Lisp_Object last_minibuf_string
;
3888 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3889 extern void init_minibuf_once (void);
3890 extern void syms_of_minibuf (void);
3892 /* Defined in callint.c. */
3894 extern Lisp_Object Qminus
, Qplus
;
3895 extern Lisp_Object Qwhen
;
3896 extern Lisp_Object Qmouse_leave_buffer_hook
;
3897 extern void syms_of_callint (void);
3899 /* Defined in casefiddle.c. */
3901 extern Lisp_Object Qidentity
;
3902 extern void syms_of_casefiddle (void);
3903 extern void keys_of_casefiddle (void);
3905 /* Defined in casetab.c. */
3907 extern void init_casetab_once (void);
3908 extern void syms_of_casetab (void);
3910 /* Defined in keyboard.c. */
3912 extern Lisp_Object echo_message_buffer
;
3913 extern struct kboard
*echo_kboard
;
3914 extern void cancel_echoing (void);
3915 extern Lisp_Object Qdisabled
, QCfilter
;
3916 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3917 extern Lisp_Object Qtop
;
3918 extern Lisp_Object last_undo_boundary
;
3919 extern bool input_pending
;
3920 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3921 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3922 extern void discard_mouse_events (void);
3924 void handle_input_available_signal (int);
3926 extern Lisp_Object pending_funcalls
;
3927 extern bool detect_input_pending (void);
3928 extern bool detect_input_pending_ignore_squeezables (void);
3929 extern bool detect_input_pending_run_timers (bool);
3930 extern void safe_run_hooks (Lisp_Object
);
3931 extern void cmd_error_internal (Lisp_Object
, const char *);
3932 extern Lisp_Object
command_loop_1 (void);
3933 extern Lisp_Object
recursive_edit_1 (void);
3934 extern void record_auto_save (void);
3935 extern void force_auto_save_soon (void);
3936 extern void init_keyboard (void);
3937 extern void syms_of_keyboard (void);
3938 extern void keys_of_keyboard (void);
3940 /* Defined in indent.c. */
3941 extern ptrdiff_t current_column (void);
3942 extern void invalidate_current_column (void);
3943 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3944 extern void syms_of_indent (void);
3946 /* Defined in frame.c. */
3947 extern Lisp_Object Qonly
, Qnone
;
3948 extern Lisp_Object Qvisible
;
3949 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3950 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3951 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3952 #if HAVE_NS || defined WINDOWSNT
3953 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3955 extern void frames_discard_buffer (Lisp_Object
);
3956 extern void syms_of_frame (void);
3958 /* Defined in emacs.c. */
3959 extern char **initial_argv
;
3960 extern int initial_argc
;
3961 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3962 extern bool display_arg
;
3964 extern Lisp_Object
decode_env_path (const char *, const char *);
3965 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3966 extern Lisp_Object Qfile_name_handler_alist
;
3967 extern _Noreturn
void terminate_due_to_signal (int, int);
3968 extern Lisp_Object Qkill_emacs
;
3970 extern Lisp_Object Vlibrary_cache
;
3973 void fixup_locale (void);
3974 void synchronize_system_messages_locale (void);
3975 void synchronize_system_time_locale (void);
3977 LISP_INLINE
void fixup_locale (void) {}
3978 LISP_INLINE
void synchronize_system_messages_locale (void) {}
3979 LISP_INLINE
void synchronize_system_time_locale (void) {}
3981 extern void shut_down_emacs (int, Lisp_Object
);
3983 /* True means don't do interactive redisplay and don't change tty modes. */
3984 extern bool noninteractive
;
3986 /* True means remove site-lisp directories from load-path. */
3987 extern bool no_site_lisp
;
3989 /* Pipe used to send exit notification to the daemon parent at
3991 extern int daemon_pipe
[2];
3992 #define IS_DAEMON (daemon_pipe[1] != 0)
3994 /* True if handling a fatal error already. */
3995 extern bool fatal_error_in_progress
;
3997 /* True means don't do use window-system-specific display code. */
3998 extern bool inhibit_window_system
;
3999 /* True means that a filter or a sentinel is running. */
4000 extern bool running_asynch_code
;
4002 /* Defined in process.c. */
4003 extern Lisp_Object QCtype
, Qlocal
;
4004 extern Lisp_Object Qprocessp
;
4005 extern void kill_buffer_processes (Lisp_Object
);
4006 extern bool wait_reading_process_output (intmax_t, int, int, bool,
4008 struct Lisp_Process
*,
4010 /* Max value for the first argument of wait_reading_process_output. */
4011 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4012 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4013 The bug merely causes a bogus warning, but the warning is annoying. */
4014 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4016 # define WAIT_READING_MAX INTMAX_MAX
4018 extern void add_keyboard_wait_descriptor (int);
4019 extern void delete_keyboard_wait_descriptor (int);
4021 extern void add_gpm_wait_descriptor (int);
4022 extern void delete_gpm_wait_descriptor (int);
4024 extern void init_process_emacs (void);
4025 extern void syms_of_process (void);
4026 extern void setup_process_coding_systems (Lisp_Object
);
4028 /* Defined in callproc.c. */
4032 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4033 extern void init_callproc_1 (void);
4034 extern void init_callproc (void);
4035 extern void set_initial_environment (void);
4036 extern void syms_of_callproc (void);
4038 /* Defined in doc.c. */
4039 extern Lisp_Object Qfunction_documentation
;
4040 extern Lisp_Object
read_doc_string (Lisp_Object
);
4041 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4042 extern void syms_of_doc (void);
4043 extern int read_bytecode_char (bool);
4045 /* Defined in bytecode.c. */
4046 extern void syms_of_bytecode (void);
4047 extern struct byte_stack
*byte_stack_list
;
4049 extern void mark_byte_stack (void);
4051 extern void unmark_byte_stack (void);
4052 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4053 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4055 /* Defined in macros.c. */
4056 extern void init_macros (void);
4057 extern void syms_of_macros (void);
4059 /* Defined in undo.c. */
4060 extern Lisp_Object Qapply
;
4061 extern Lisp_Object Qinhibit_read_only
;
4062 extern void truncate_undo_list (struct buffer
*);
4063 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
4064 extern void record_insert (ptrdiff_t, ptrdiff_t);
4065 extern void record_delete (ptrdiff_t, Lisp_Object
);
4066 extern void record_first_change (void);
4067 extern void record_change (ptrdiff_t, ptrdiff_t);
4068 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4069 Lisp_Object
, Lisp_Object
,
4071 extern void syms_of_undo (void);
4072 /* Defined in textprop.c. */
4073 extern Lisp_Object Qfont
, Qmouse_face
;
4074 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4075 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4076 extern Lisp_Object Qminibuffer_prompt
;
4078 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4080 /* Defined in menu.c. */
4081 extern void syms_of_menu (void);
4083 /* Defined in xmenu.c. */
4084 extern void syms_of_xmenu (void);
4086 /* Defined in termchar.h. */
4087 struct tty_display_info
;
4089 /* Defined in termhooks.h. */
4092 /* Defined in sysdep.c. */
4093 #ifndef HAVE_GET_CURRENT_DIR_NAME
4094 extern char *get_current_dir_name (void);
4096 extern void stuff_char (char c
);
4097 extern void init_foreground_group (void);
4098 extern void init_sigio (int);
4099 extern void sys_subshell (void);
4100 extern void sys_suspend (void);
4101 extern void discard_tty_input (void);
4102 extern void block_tty_out_signal (void);
4103 extern void unblock_tty_out_signal (void);
4104 extern void init_sys_modes (struct tty_display_info
*);
4105 extern void reset_sys_modes (struct tty_display_info
*);
4106 extern void init_all_sys_modes (void);
4107 extern void reset_all_sys_modes (void);
4108 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
4109 extern void child_setup_tty (int);
4110 extern void setup_pty (int);
4111 extern int set_window_size (int, int, int);
4112 extern EMACS_INT
get_random (void);
4113 extern void seed_random (void *, ptrdiff_t);
4114 extern void init_random (void);
4115 extern void emacs_backtrace (int);
4116 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4117 extern int emacs_open (const char *, int, int);
4118 extern int emacs_pipe (int[2]);
4119 extern int emacs_close (int);
4120 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
4121 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
4122 extern ptrdiff_t emacs_write_sig (int, char const *, ptrdiff_t);
4123 extern void emacs_perror (char const *);
4125 extern void unlock_all_files (void);
4126 extern void lock_file (Lisp_Object
);
4127 extern void unlock_file (Lisp_Object
);
4128 extern void unlock_buffer (struct buffer
*);
4129 extern void syms_of_filelock (void);
4131 /* Defined in sound.c. */
4132 extern void syms_of_sound (void);
4134 /* Defined in category.c. */
4135 extern void init_category_once (void);
4136 extern Lisp_Object
char_category_set (int);
4137 extern void syms_of_category (void);
4139 /* Defined in ccl.c. */
4140 extern void syms_of_ccl (void);
4142 /* Defined in dired.c. */
4143 extern void syms_of_dired (void);
4144 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4145 Lisp_Object
, Lisp_Object
,
4148 /* Defined in term.c. */
4149 extern int *char_ins_del_vector
;
4150 extern void syms_of_term (void);
4151 extern _Noreturn
void fatal (const char *msgid
, ...)
4152 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4154 /* Defined in terminal.c. */
4155 extern void syms_of_terminal (void);
4157 /* Defined in font.c. */
4158 extern void syms_of_font (void);
4159 extern void init_font (void);
4161 #ifdef HAVE_WINDOW_SYSTEM
4162 /* Defined in fontset.c. */
4163 extern void syms_of_fontset (void);
4165 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4166 extern Lisp_Object Qfont_param
;
4169 /* Defined in gfilenotify.c */
4170 #ifdef HAVE_GFILENOTIFY
4171 extern void globals_of_gfilenotify (void);
4172 extern void syms_of_gfilenotify (void);
4175 /* Defined in inotify.c */
4177 extern void syms_of_inotify (void);
4180 #ifdef HAVE_W32NOTIFY
4181 /* Defined on w32notify.c. */
4182 extern void syms_of_w32notify (void);
4185 /* Defined in xfaces.c. */
4186 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4187 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4188 extern Lisp_Object Qmode_line_inactive
;
4189 extern Lisp_Object Qface
;
4190 extern Lisp_Object Qnormal
;
4191 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4192 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4193 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4194 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4195 extern Lisp_Object Qoblique
, Qitalic
;
4196 extern Lisp_Object Vface_alternative_font_family_alist
;
4197 extern Lisp_Object Vface_alternative_font_registry_alist
;
4198 extern void syms_of_xfaces (void);
4200 #ifdef HAVE_X_WINDOWS
4201 /* Defined in xfns.c. */
4202 extern void syms_of_xfns (void);
4204 /* Defined in xsmfns.c. */
4205 extern void syms_of_xsmfns (void);
4207 /* Defined in xselect.c. */
4208 extern void syms_of_xselect (void);
4210 /* Defined in xterm.c. */
4211 extern void syms_of_xterm (void);
4212 #endif /* HAVE_X_WINDOWS */
4214 #ifdef HAVE_WINDOW_SYSTEM
4215 /* Defined in xterm.c, nsterm.m, w32term.c. */
4216 extern char *x_get_keysym_name (int);
4217 #endif /* HAVE_WINDOW_SYSTEM */
4220 /* Defined in xml.c. */
4221 extern void syms_of_xml (void);
4222 extern void xml_cleanup_parser (void);
4226 /* Defined in decompress.c. */
4227 extern void syms_of_decompress (void);
4231 /* Defined in dbusbind.c. */
4232 void syms_of_dbusbind (void);
4236 /* Defined in profiler.c. */
4237 extern bool profiler_memory_running
;
4238 extern void malloc_probe (size_t);
4239 extern void syms_of_profiler (void);
4243 /* Defined in msdos.c, w32.c. */
4244 extern char *emacs_root_dir (void);
4247 /* True means Emacs has already been initialized.
4248 Used during startup to detect startup of dumped Emacs. */
4249 extern bool initialized
;
4251 /* True means ^G can quit instantly. */
4252 extern bool immediate_quit
;
4254 extern void *xmalloc (size_t);
4255 extern void *xzalloc (size_t);
4256 extern void *xrealloc (void *, size_t);
4257 extern void xfree (void *);
4258 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
4259 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
4260 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4262 extern char *xstrdup (const char *);
4263 extern void xputenv (const char *);
4265 extern char *egetenv (const char *);
4267 /* Set up the name of the machine we're running on. */
4268 extern void init_system_name (void);
4270 /* Return the absolute value of X. X should be a signed integer
4271 expression without side effects, and X's absolute value should not
4272 exceed the maximum for its promoted type. This is called 'eabs'
4273 because 'abs' is reserved by the C standard. */
4274 #define eabs(x) ((x) < 0 ? -(x) : (x))
4276 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4279 #define make_fixnum_or_float(val) \
4280 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4282 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4283 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4285 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4287 extern void *record_xmalloc (size_t);
4289 #define USE_SAFE_ALLOCA \
4290 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
4292 /* SAFE_ALLOCA allocates a simple buffer. */
4294 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4296 : (sa_must_free = 1, record_xmalloc (size)))
4298 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4299 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4300 positive. The code is tuned for MULTIPLIER being a constant. */
4302 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4304 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4305 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4308 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4310 record_unwind_protect_ptr (xfree, buf); \
4314 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4316 #define SAFE_FREE() \
4318 if (sa_must_free) { \
4320 unbind_to (sa_count, Qnil); \
4325 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4327 #define SAFE_ALLOCA_LISP(buf, nelt) \
4329 if ((nelt) < MAX_ALLOCA / word_size) \
4330 buf = alloca ((nelt) * word_size); \
4331 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4334 buf = xmalloc ((nelt) * word_size); \
4335 arg_ = make_save_memory (buf, nelt); \
4337 record_unwind_protect (free_save_value, arg_); \
4340 memory_full (SIZE_MAX); \
4344 /* Check whether it's time for GC, and run it if so. */
4349 if ((consing_since_gc
> gc_cons_threshold
4350 && consing_since_gc
> gc_relative_threshold
)
4351 || (!NILP (Vmemory_full
)
4352 && consing_since_gc
> memory_full_cons_threshold
))
4353 Fgarbage_collect ();
4357 functionp (Lisp_Object object
)
4359 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4361 object
= Findirect_function (object
, Qt
);
4363 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4365 /* Autoloaded symbols are functions, except if they load
4366 macros or keymaps. */
4368 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4369 object
= XCDR (object
);
4371 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4376 return XSUBR (object
)->max_args
!= UNEVALLED
;
4377 else if (COMPILEDP (object
))
4379 else if (CONSP (object
))
4381 Lisp_Object car
= XCAR (object
);
4382 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4390 #endif /* EMACS_LISP_H */