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. MSVC doesn't support enums in bitfields,
367 and xlc complains vociferously about them. */
368 #if 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 (see the existing uses of make_save_value and
445 XSAVE_VALUE). The latter is useful for vector-like Lisp objects
446 that need to be used as part of other objects, but which are never
447 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
450 These two types don't look pretty when printed, so they are
451 unsuitable for Lisp objects that can be exposed to users.
453 To define a new data type, add one more Lisp_Misc subtype or one
454 more pseudovector subtype. Pseudovectors are more suitable for
455 objects with several slots that need to support fast random access,
456 while Lisp_Misc types are for everything else. A pseudovector object
457 provides one or more slots for Lisp objects, followed by struct
458 members that are accessible only from C. A Lisp_Misc object is a
459 wrapper for a C struct that can contain anything you like.
461 Explicit freeing is discouraged for Lisp objects in general. But if
462 you really need to exploit this, use Lisp_Misc (check free_misc in
463 alloc.c to see why). There is no way to free a vectorlike object.
465 To add a new pseudovector type, extend the pvec_type enumeration;
466 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
468 For a Lisp_Misc, you will also need to add your entry to union
469 Lisp_Misc (but make sure the first word has the same structure as
470 the others, starting with a 16-bit member of the Lisp_Misc_Type
471 enumeration and a 1-bit GC markbit) and make sure the overall size
472 of the union is not increased by your addition.
474 For a new pseudovector, it's highly desirable to limit the size
475 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
476 Otherwise you will need to change sweep_vectors (also in alloc.c).
478 Then you will need to add switch branches in print.c (in
479 print_object, to print your object, and possibly also in
480 print_preprocess) and to alloc.c, to mark your object (in
481 mark_object) and to free it (in gc_sweep). The latter is also the
482 right place to call any code specific to your data type that needs
483 to run when the object is recycled -- e.g., free any additional
484 resources allocated for it that are not Lisp objects. You can even
485 make a pointer to the function that frees the resources a slot in
486 your object -- this way, the same object could be used to represent
487 several disparate C structures. */
489 #ifdef CHECK_LISP_OBJECT_TYPE
491 typedef struct { EMACS_INT i
; } Lisp_Object
;
493 #define LISP_INITIALLY_ZERO {0}
495 #undef CHECK_LISP_OBJECT_TYPE
496 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 1 };
497 #else /* CHECK_LISP_OBJECT_TYPE */
499 /* If a struct type is not wanted, define Lisp_Object as just a number. */
501 typedef EMACS_INT Lisp_Object
;
502 #define LISP_INITIALLY_ZERO 0
503 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= 0 };
504 #endif /* CHECK_LISP_OBJECT_TYPE */
506 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
507 At the machine level, these operations are no-ops. */
508 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
509 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
511 /* In the size word of a vector, this bit means the vector has been marked. */
513 static ptrdiff_t const ARRAY_MARK_FLAG
514 #define ARRAY_MARK_FLAG PTRDIFF_MIN
517 /* In the size word of a struct Lisp_Vector, this bit means it's really
518 some other vector-like object. */
519 static ptrdiff_t const PSEUDOVECTOR_FLAG
520 #define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
523 /* In a pseudovector, the size field actually contains a word with one
524 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
525 with PVEC_TYPE_MASK to indicate the actual type. */
537 PVEC_WINDOW_CONFIGURATION
,
540 /* These should be last, check internal_equal to see why. */
544 PVEC_FONT
/* Should be last because it's used for range checking. */
547 /* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
548 which were stored in a Lisp_Object. */
549 #ifndef DATA_SEG_BITS
550 # define DATA_SEG_BITS 0
552 enum { gdb_DATA_SEG_BITS
= DATA_SEG_BITS
};
557 DATA_SEG_BITS
= gdb_DATA_SEG_BITS
,
559 /* For convenience, we also store the number of elements in these bits.
560 Note that this size is not necessarily the memory-footprint size, but
561 only the number of Lisp_Object fields (that need to be traced by GC).
562 The distinction is used, e.g., by Lisp_Process, which places extra
563 non-Lisp_Object fields at the end of the structure. */
564 PSEUDOVECTOR_SIZE_BITS
= 12,
565 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
567 /* To calculate the memory footprint of the pseudovector, it's useful
568 to store the size of non-Lisp area in word_size units here. */
569 PSEUDOVECTOR_REST_BITS
= 12,
570 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
571 << PSEUDOVECTOR_SIZE_BITS
),
573 /* Used to extract pseudovector subtype information. */
574 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
575 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
,
577 /* Number of bits to put in each character in the internal representation
578 of bool vectors. This should not vary across implementations. */
579 BOOL_VECTOR_BITS_PER_CHAR
= 8
582 /* These functions extract various sorts of values from a Lisp_Object.
583 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
584 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
586 static EMACS_INT
const VALMASK
587 #define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
590 /* Largest and smallest representable fixnum values. These are the C
591 values. They are macros for use in static initializers. */
592 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
593 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
595 /* Extract the pointer hidden within A. */
596 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
600 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
601 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
602 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
603 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
604 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
606 #else /* ! USE_LSB_TAG */
608 /* Although compiled only if ! USE_LSB_TAG, the following functions
609 also work when USE_LSB_TAG; this is to aid future maintenance when
610 the lisp_h_* macros are eventually removed. */
612 /* Make a Lisp integer representing the value of the low order
614 LISP_INLINE Lisp_Object
615 make_number (EMACS_INT n
)
617 return XIL (USE_LSB_TAG
? n
<< INTTYPEBITS
: n
& INTMASK
);
620 /* Extract A's value as a signed integer. */
621 LISP_INLINE EMACS_INT
624 EMACS_INT i
= XLI (a
);
625 return (USE_LSB_TAG
? i
: i
<< INTTYPEBITS
) >> INTTYPEBITS
;
628 /* Like XINT (A), but may be faster. A must be nonnegative.
629 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
630 integers have zero-bits in their tags. */
631 LISP_INLINE EMACS_INT
632 XFASTINT (Lisp_Object a
)
634 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
639 /* Extract A's type. */
640 LISP_INLINE
enum Lisp_Type
641 XTYPE (Lisp_Object a
)
643 EMACS_UINT i
= XLI (a
);
644 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
647 /* Extract A's pointer value, assuming A's type is TYPE. */
649 XUNTAG (Lisp_Object a
, int type
)
653 intptr_t i
= XLI (a
) - type
;
659 #endif /* ! USE_LSB_TAG */
661 /* Extract A's value as an unsigned integer. */
662 LISP_INLINE EMACS_UINT
663 XUINT (Lisp_Object a
)
665 EMACS_UINT i
= XLI (a
);
666 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
669 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
670 right now, but XUINT should only be applied to objects we know are
672 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
674 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
675 LISP_INLINE Lisp_Object
676 make_natnum (EMACS_INT n
)
678 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
679 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
682 /* Return true if X and Y are the same object. */
683 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
685 /* Value is non-zero if I doesn't fit into a Lisp fixnum. It is
686 written this way so that it also works if I is of unsigned
687 type or if I is a NaN. */
689 #define FIXNUM_OVERFLOW_P(i) \
690 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
692 LISP_INLINE
ptrdiff_t
693 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
695 return num
< lower
? lower
: num
<= upper
? num
: upper
;
698 /* Forward declarations. */
700 /* Defined in this file. */
702 LISP_INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
703 LISP_INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
704 LISP_INLINE
bool BUFFERP (Lisp_Object
);
705 LISP_INLINE
bool CHAR_TABLE_P (Lisp_Object
);
706 LISP_INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
707 LISP_INLINE
bool (CONSP
) (Lisp_Object
);
708 LISP_INLINE
bool (FLOATP
) (Lisp_Object
);
709 LISP_INLINE
bool functionp (Lisp_Object
);
710 LISP_INLINE
bool (INTEGERP
) (Lisp_Object
);
711 LISP_INLINE
bool (MARKERP
) (Lisp_Object
);
712 LISP_INLINE
bool (MISCP
) (Lisp_Object
);
713 LISP_INLINE
bool (NILP
) (Lisp_Object
);
714 LISP_INLINE
bool OVERLAYP (Lisp_Object
);
715 LISP_INLINE
bool PROCESSP (Lisp_Object
);
716 LISP_INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
717 LISP_INLINE
bool SAVE_VALUEP (Lisp_Object
);
718 LISP_INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
720 LISP_INLINE
bool STRINGP (Lisp_Object
);
721 LISP_INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
722 LISP_INLINE
bool SUBRP (Lisp_Object
);
723 LISP_INLINE
bool (SYMBOLP
) (Lisp_Object
);
724 LISP_INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
725 LISP_INLINE
bool WINDOWP (Lisp_Object
);
726 LISP_INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
728 /* Defined in chartab.c. */
729 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
730 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
731 extern int char_table_translate (Lisp_Object
, int);
733 /* Defined in data.c. */
734 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
735 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
736 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qvectorp
;
737 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
738 extern Lisp_Object
Ffboundp (Lisp_Object
);
739 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
741 /* Defined in emacs.c. */
742 extern bool initialized
;
744 /* Defined in eval.c. */
745 extern Lisp_Object Qautoload
;
747 /* Defined in floatfns.c. */
748 extern double extract_float (Lisp_Object
);
750 /* Defined in process.c. */
751 extern Lisp_Object Qprocessp
;
753 /* Defined in window.c. */
754 extern Lisp_Object Qwindowp
;
756 /* Defined in xdisp.c. */
757 extern Lisp_Object Qimage
;
760 /* Extract a value or address from a Lisp_Object. */
762 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
764 LISP_INLINE
struct Lisp_Vector
*
765 XVECTOR (Lisp_Object a
)
767 eassert (VECTORLIKEP (a
));
768 return XUNTAG (a
, Lisp_Vectorlike
);
771 LISP_INLINE
struct Lisp_String
*
772 XSTRING (Lisp_Object a
)
774 eassert (STRINGP (a
));
775 return XUNTAG (a
, Lisp_String
);
778 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
780 LISP_INLINE
struct Lisp_Float
*
781 XFLOAT (Lisp_Object a
)
783 eassert (FLOATP (a
));
784 return XUNTAG (a
, Lisp_Float
);
787 /* Pseudovector types. */
789 LISP_INLINE
struct Lisp_Process
*
790 XPROCESS (Lisp_Object a
)
792 eassert (PROCESSP (a
));
793 return XUNTAG (a
, Lisp_Vectorlike
);
796 LISP_INLINE
struct window
*
797 XWINDOW (Lisp_Object a
)
799 eassert (WINDOWP (a
));
800 return XUNTAG (a
, Lisp_Vectorlike
);
803 LISP_INLINE
struct terminal
*
804 XTERMINAL (Lisp_Object a
)
806 return XUNTAG (a
, Lisp_Vectorlike
);
809 LISP_INLINE
struct Lisp_Subr
*
810 XSUBR (Lisp_Object a
)
813 return XUNTAG (a
, Lisp_Vectorlike
);
816 LISP_INLINE
struct buffer
*
817 XBUFFER (Lisp_Object a
)
819 eassert (BUFFERP (a
));
820 return XUNTAG (a
, Lisp_Vectorlike
);
823 LISP_INLINE
struct Lisp_Char_Table
*
824 XCHAR_TABLE (Lisp_Object a
)
826 eassert (CHAR_TABLE_P (a
));
827 return XUNTAG (a
, Lisp_Vectorlike
);
830 LISP_INLINE
struct Lisp_Sub_Char_Table
*
831 XSUB_CHAR_TABLE (Lisp_Object a
)
833 eassert (SUB_CHAR_TABLE_P (a
));
834 return XUNTAG (a
, Lisp_Vectorlike
);
837 LISP_INLINE
struct Lisp_Bool_Vector
*
838 XBOOL_VECTOR (Lisp_Object a
)
840 eassert (BOOL_VECTOR_P (a
));
841 return XUNTAG (a
, Lisp_Vectorlike
);
844 /* Construct a Lisp_Object from a value or address. */
846 LISP_INLINE Lisp_Object
847 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
849 EMACS_UINT utype
= type
;
850 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
851 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
852 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
856 LISP_INLINE Lisp_Object
857 make_lisp_proc (struct Lisp_Process
*p
)
859 return make_lisp_ptr (p
, Lisp_Vectorlike
);
862 #define XSETINT(a, b) ((a) = make_number (b))
863 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
864 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
865 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
866 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
867 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
868 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
872 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
873 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
875 /* Pseudovector types. */
877 #define XSETPVECTYPE(v, code) \
878 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
879 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
880 ((v)->header.size = (PSEUDOVECTOR_FLAG \
881 | ((code) << PSEUDOVECTOR_AREA_BITS) \
882 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
885 /* The cast to struct vectorlike_header * avoids aliasing issues. */
886 #define XSETPSEUDOVECTOR(a, b, code) \
887 XSETTYPED_PSEUDOVECTOR (a, b, \
888 (((struct vectorlike_header *) \
889 XUNTAG (a, Lisp_Vectorlike)) \
892 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
893 (XSETVECTOR (a, b), \
894 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
895 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
897 #define XSETWINDOW_CONFIGURATION(a, b) \
898 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
899 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
900 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
901 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
902 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
903 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
904 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
905 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
906 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
907 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
911 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
, (int ok
, Lisp_Object Qxxxp
, Lisp_Object x
),
914 /* Deprecated and will be removed soon. */
916 #define INTERNAL_FIELD(field) field ## _
918 /* See the macros in intervals.h. */
920 typedef struct interval
*INTERVAL
;
924 /* Car of this cons cell. */
929 /* Cdr of this cons cell. */
932 /* Used to chain conses on a free list. */
933 struct Lisp_Cons
*chain
;
937 /* Take the car or cdr of something known to be a cons cell. */
938 /* The _addr functions shouldn't be used outside of the minimal set
939 of code that has to know what a cons cell looks like. Other code not
940 part of the basic lisp implementation should assume that the car and cdr
941 fields are not accessible. (What if we want to switch to
942 a copying collector someday? Cached cons cell field addresses may be
943 invalidated at arbitrary points.) */
944 LISP_INLINE Lisp_Object
*
945 xcar_addr (Lisp_Object c
)
947 return &XCONS (c
)->car
;
949 LISP_INLINE Lisp_Object
*
950 xcdr_addr (Lisp_Object c
)
952 return &XCONS (c
)->u
.cdr
;
955 /* Use these from normal code. */
956 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
957 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
959 /* Use these to set the fields of a cons cell.
961 Note that both arguments may refer to the same object, so 'n'
962 should not be read after 'c' is first modified. */
964 XSETCAR (Lisp_Object c
, Lisp_Object n
)
969 XSETCDR (Lisp_Object c
, Lisp_Object n
)
974 /* Take the car or cdr of something whose type is not known. */
975 LISP_INLINE Lisp_Object
978 return (CONSP (c
) ? XCAR (c
)
980 : wrong_type_argument (Qlistp
, c
));
982 LISP_INLINE Lisp_Object
985 return (CONSP (c
) ? XCDR (c
)
987 : wrong_type_argument (Qlistp
, c
));
990 /* Take the car or cdr of something whose type is not known. */
991 LISP_INLINE Lisp_Object
992 CAR_SAFE (Lisp_Object c
)
994 return CONSP (c
) ? XCAR (c
) : Qnil
;
996 LISP_INLINE Lisp_Object
997 CDR_SAFE (Lisp_Object c
)
999 return CONSP (c
) ? XCDR (c
) : Qnil
;
1002 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1007 ptrdiff_t size_byte
;
1008 INTERVAL intervals
; /* Text properties in this string. */
1009 unsigned char *data
;
1012 /* True if STR is a multibyte string. */
1014 STRING_MULTIBYTE (Lisp_Object str
)
1016 return 0 <= XSTRING (str
)->size_byte
;
1019 /* An upper bound on the number of bytes in a Lisp string, not
1020 counting the terminating null. This a tight enough bound to
1021 prevent integer overflow errors that would otherwise occur during
1022 string size calculations. A string cannot contain more bytes than
1023 a fixnum can represent, nor can it be so long that C pointer
1024 arithmetic stops working on the string plus its terminating null.
1025 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1026 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1027 would expose alloc.c internal details that we'd rather keep
1030 This is a macro for use in static initializers. The cast to
1031 ptrdiff_t ensures that the macro is signed. */
1032 #define STRING_BYTES_BOUND \
1033 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1035 /* Mark STR as a unibyte string. */
1036 #define STRING_SET_UNIBYTE(STR) \
1037 do { if (EQ (STR, empty_multibyte_string)) \
1038 (STR) = empty_unibyte_string; \
1039 else XSTRING (STR)->size_byte = -1; } while (0)
1041 /* Mark STR as a multibyte string. Assure that STR contains only
1042 ASCII characters in advance. */
1043 #define STRING_SET_MULTIBYTE(STR) \
1044 do { if (EQ (STR, empty_unibyte_string)) \
1045 (STR) = empty_multibyte_string; \
1046 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
1048 /* Convenience functions for dealing with Lisp strings. */
1050 LISP_INLINE
unsigned char *
1051 SDATA (Lisp_Object string
)
1053 return XSTRING (string
)->data
;
1056 SSDATA (Lisp_Object string
)
1058 /* Avoid "differ in sign" warnings. */
1059 return (char *) SDATA (string
);
1061 LISP_INLINE
unsigned char
1062 SREF (Lisp_Object string
, ptrdiff_t index
)
1064 return SDATA (string
)[index
];
1067 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1069 SDATA (string
)[index
] = new;
1071 LISP_INLINE
ptrdiff_t
1072 SCHARS (Lisp_Object string
)
1074 return XSTRING (string
)->size
;
1077 #ifdef GC_CHECK_STRING_BYTES
1078 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1080 LISP_INLINE
ptrdiff_t
1081 STRING_BYTES (struct Lisp_String
*s
)
1083 #ifdef GC_CHECK_STRING_BYTES
1084 return string_bytes (s
);
1086 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1090 LISP_INLINE
ptrdiff_t
1091 SBYTES (Lisp_Object string
)
1093 return STRING_BYTES (XSTRING (string
));
1096 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1098 XSTRING (string
)->size
= newsize
;
1101 STRING_COPYIN (Lisp_Object string
, ptrdiff_t index
, char const *new,
1104 memcpy (SDATA (string
) + index
, new, count
);
1107 /* Header of vector-like objects. This documents the layout constraints on
1108 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1109 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1110 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1111 because when two such pointers potentially alias, a compiler won't
1112 incorrectly reorder loads and stores to their size fields. See
1113 <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>. */
1114 struct vectorlike_header
1116 /* The only field contains various pieces of information:
1117 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1118 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1119 vector (0) or a pseudovector (1).
1120 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1121 of slots) of the vector.
1122 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1123 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1124 - b) number of Lisp_Objects slots at the beginning of the object
1125 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1127 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1128 measured in word_size units. Rest fields may also include
1129 Lisp_Objects, but these objects usually needs some special treatment
1131 There are some exceptions. For PVEC_FREE, b) is always zero. For
1132 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1133 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1134 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1138 /* Regular vector is just a header plus array of Lisp_Objects. */
1142 struct vectorlike_header header
;
1143 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1146 /* A boolvector is a kind of vectorlike, with contents are like a string. */
1148 struct Lisp_Bool_Vector
1150 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1151 just the subtype information. */
1152 struct vectorlike_header header
;
1153 /* This is the size in bits. */
1155 /* This contains the actual bits, packed into bytes. */
1156 unsigned char data
[FLEXIBLE_ARRAY_MEMBER
];
1159 /* Some handy constants for calculating sizes
1160 and offsets, mostly of vectorlike objects. */
1164 header_size
= offsetof (struct Lisp_Vector
, contents
),
1165 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1166 word_size
= sizeof (Lisp_Object
)
1169 /* Conveniences for dealing with Lisp arrays. */
1171 LISP_INLINE Lisp_Object
1172 AREF (Lisp_Object array
, ptrdiff_t idx
)
1174 return XVECTOR (array
)->contents
[idx
];
1177 LISP_INLINE Lisp_Object
*
1178 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1180 return & XVECTOR (array
)->contents
[idx
];
1183 LISP_INLINE
ptrdiff_t
1184 ASIZE (Lisp_Object array
)
1186 return XVECTOR (array
)->header
.size
;
1190 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1192 eassert (0 <= idx
&& idx
< ASIZE (array
));
1193 XVECTOR (array
)->contents
[idx
] = val
;
1197 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1199 /* Like ASET, but also can be used in the garbage collector:
1200 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1201 eassert (0 <= idx
&& idx
< (ASIZE (array
) & ~ARRAY_MARK_FLAG
));
1202 XVECTOR (array
)->contents
[idx
] = val
;
1205 /* If a struct is made to look like a vector, this macro returns the length
1206 of the shortest vector that would hold that struct. */
1208 #define VECSIZE(type) \
1209 ((sizeof (type) - header_size + word_size - 1) / word_size)
1211 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1212 at the end and we need to compute the number of Lisp_Object fields (the
1213 ones that the GC needs to trace). */
1215 #define PSEUDOVECSIZE(type, nonlispfield) \
1216 ((offsetof (type, nonlispfield) - header_size) / word_size)
1218 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1219 should be integer expressions. This is not the same as
1220 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1221 returns 1. For efficiency, prefer plain unsigned comparison if A
1222 and B's sizes both fit (after integer promotion). */
1223 #define UNSIGNED_CMP(a, op, b) \
1224 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1225 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1226 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1228 /* Nonzero iff C is an ASCII character. */
1229 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1231 /* A char-table is a kind of vectorlike, with contents are like a
1232 vector but with a few other slots. For some purposes, it makes
1233 sense to handle a char-table with type struct Lisp_Vector. An
1234 element of a char table can be any Lisp objects, but if it is a sub
1235 char-table, we treat it a table that contains information of a
1236 specific range of characters. A sub char-table has the same
1237 structure as a vector. A sub char table appears only in an element
1238 of a char-table, and there's no way to access it directly from
1239 Emacs Lisp program. */
1241 enum CHARTAB_SIZE_BITS
1243 CHARTAB_SIZE_BITS_0
= 6,
1244 CHARTAB_SIZE_BITS_1
= 4,
1245 CHARTAB_SIZE_BITS_2
= 5,
1246 CHARTAB_SIZE_BITS_3
= 7
1249 extern const int chartab_size
[4];
1251 struct Lisp_Char_Table
1253 /* HEADER.SIZE is the vector's size field, which also holds the
1254 pseudovector type information. It holds the size, too.
1255 The size counts the defalt, parent, purpose, ascii,
1256 contents, and extras slots. */
1257 struct vectorlike_header header
;
1259 /* This holds a default value,
1260 which is used whenever the value for a specific character is nil. */
1263 /* This points to another char table, which we inherit from when the
1264 value for a specific character is nil. The `defalt' slot takes
1265 precedence over this. */
1268 /* This is a symbol which says what kind of use this char-table is
1270 Lisp_Object purpose
;
1272 /* The bottom sub char-table for characters of the range 0..127. It
1273 is nil if none of ASCII character has a specific value. */
1276 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1278 /* These hold additional data. It is a vector. */
1279 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1282 struct Lisp_Sub_Char_Table
1284 /* HEADER.SIZE is the vector's size field, which also holds the
1285 pseudovector type information. It holds the size, too. */
1286 struct vectorlike_header header
;
1288 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1289 char-table of depth 1 contains 16 elements, and each element
1290 covers 4096 (128*32) characters. A sub char-table of depth 2
1291 contains 32 elements, and each element covers 128 characters. A
1292 sub char-table of depth 3 contains 128 elements, and each element
1293 is for one character. */
1296 /* Minimum character covered by the sub char-table. */
1297 Lisp_Object min_char
;
1299 /* Use set_sub_char_table_contents to set this. */
1300 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1303 LISP_INLINE Lisp_Object
1304 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1306 struct Lisp_Char_Table
*tbl
= NULL
;
1310 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1311 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1312 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1316 while (NILP (val
) && ! NILP (tbl
->parent
));
1321 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1322 characters. Do not check validity of CT. */
1323 LISP_INLINE Lisp_Object
1324 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1326 return (ASCII_CHAR_P (idx
)
1327 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1328 : char_table_ref (ct
, idx
));
1331 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1332 8-bit European characters. Do not check validity of CT. */
1334 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1336 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1337 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1339 char_table_set (ct
, idx
, val
);
1342 /* This structure describes a built-in function.
1343 It is generated by the DEFUN macro only.
1344 defsubr makes it into a Lisp object. */
1348 struct vectorlike_header header
;
1350 Lisp_Object (*a0
) (void);
1351 Lisp_Object (*a1
) (Lisp_Object
);
1352 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1353 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1354 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1355 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1356 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1357 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1358 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1359 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1360 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1362 short min_args
, max_args
;
1363 const char *symbol_name
;
1364 const char *intspec
;
1368 /* This is the number of slots that every char table must have. This
1369 counts the ordinary slots and the top, defalt, parent, and purpose
1371 enum CHAR_TABLE_STANDARD_SLOTS
1373 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1376 /* Return the number of "extra" slots in the char table CT. */
1379 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1381 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1382 - CHAR_TABLE_STANDARD_SLOTS
);
1386 /***********************************************************************
1388 ***********************************************************************/
1390 /* Interned state of a symbol. */
1392 enum symbol_interned
1394 SYMBOL_UNINTERNED
= 0,
1395 SYMBOL_INTERNED
= 1,
1396 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1399 enum symbol_redirect
1401 SYMBOL_PLAINVAL
= 4,
1402 SYMBOL_VARALIAS
= 1,
1403 SYMBOL_LOCALIZED
= 2,
1404 SYMBOL_FORWARDED
= 3
1409 unsigned gcmarkbit
: 1;
1411 /* Indicates where the value can be found:
1412 0 : it's a plain var, the value is in the `value' field.
1413 1 : it's a varalias, the value is really in the `alias' symbol.
1414 2 : it's a localized var, the value is in the `blv' object.
1415 3 : it's a forwarding variable, the value is in `forward'. */
1416 ENUM_BF (symbol_redirect
) redirect
: 3;
1418 /* Non-zero means symbol is constant, i.e. changing its value
1419 should signal an error. If the value is 3, then the var
1420 can be changed, but only by `defconst'. */
1421 unsigned constant
: 2;
1423 /* Interned state of the symbol. This is an enumerator from
1424 enum symbol_interned. */
1425 unsigned interned
: 2;
1427 /* Non-zero means that this variable has been explicitly declared
1428 special (with `defvar' etc), and shouldn't be lexically bound. */
1429 unsigned declared_special
: 1;
1431 /* The symbol's name, as a Lisp string. */
1434 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1435 union is used depends on the `redirect' field above. */
1438 struct Lisp_Symbol
*alias
;
1439 struct Lisp_Buffer_Local_Value
*blv
;
1440 union Lisp_Fwd
*fwd
;
1443 /* Function value of the symbol or Qnil if not fboundp. */
1444 Lisp_Object function
;
1446 /* The symbol's property list. */
1449 /* Next symbol in obarray bucket, if the symbol is interned. */
1450 struct Lisp_Symbol
*next
;
1453 /* Value is name of symbol. */
1455 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1457 LISP_INLINE
struct Lisp_Symbol
*
1458 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1460 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1461 return sym
->val
.alias
;
1463 LISP_INLINE
struct Lisp_Buffer_Local_Value
*
1464 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1466 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1467 return sym
->val
.blv
;
1469 LISP_INLINE
union Lisp_Fwd
*
1470 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1472 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1473 return sym
->val
.fwd
;
1476 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1477 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1480 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1482 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1486 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1488 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1492 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1494 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1498 LISP_INLINE Lisp_Object
1499 SYMBOL_NAME (Lisp_Object sym
)
1501 return XSYMBOL (sym
)->name
;
1504 /* Value is true if SYM is an interned symbol. */
1507 SYMBOL_INTERNED_P (Lisp_Object sym
)
1509 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1512 /* Value is true if SYM is interned in initial_obarray. */
1515 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1517 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1520 /* Value is non-zero if symbol is considered a constant, i.e. its
1521 value cannot be changed (there is an exception for keyword symbols,
1522 whose value can be set to the keyword symbol itself). */
1524 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1526 #define DEFSYM(sym, name) \
1527 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (0)
1530 /***********************************************************************
1532 ***********************************************************************/
1534 /* The structure of a Lisp hash table. */
1536 struct hash_table_test
1538 /* Name of the function used to compare keys. */
1541 /* User-supplied hash function, or nil. */
1542 Lisp_Object user_hash_function
;
1544 /* User-supplied key comparison function, or nil. */
1545 Lisp_Object user_cmp_function
;
1547 /* C function to compare two keys. */
1548 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1550 /* C function to compute hash code. */
1551 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1554 struct Lisp_Hash_Table
1556 /* This is for Lisp; the hash table code does not refer to it. */
1557 struct vectorlike_header header
;
1559 /* Nil if table is non-weak. Otherwise a symbol describing the
1560 weakness of the table. */
1563 /* When the table is resized, and this is an integer, compute the
1564 new size by adding this to the old size. If a float, compute the
1565 new size by multiplying the old size with this factor. */
1566 Lisp_Object rehash_size
;
1568 /* Resize hash table when number of entries/ table size is >= this
1570 Lisp_Object rehash_threshold
;
1572 /* Vector of hash codes.. If hash[I] is nil, this means that that
1573 entry I is unused. */
1576 /* Vector used to chain entries. If entry I is free, next[I] is the
1577 entry number of the next free item. If entry I is non-free,
1578 next[I] is the index of the next entry in the collision chain. */
1581 /* Index of first free entry in free list. */
1582 Lisp_Object next_free
;
1584 /* Bucket vector. A non-nil entry is the index of the first item in
1585 a collision chain. This vector's size can be larger than the
1586 hash table size to reduce collisions. */
1589 /* Only the fields above are traced normally by the GC. The ones below
1590 `count' are special and are either ignored by the GC or traced in
1591 a special way (e.g. because of weakness). */
1593 /* Number of key/value entries in the table. */
1596 /* Vector of keys and values. The key of item I is found at index
1597 2 * I, the value is found at index 2 * I + 1.
1598 This is gc_marked specially if the table is weak. */
1599 Lisp_Object key_and_value
;
1601 /* The comparison and hash functions. */
1602 struct hash_table_test test
;
1604 /* Next weak hash table if this is a weak hash table. The head
1605 of the list is in weak_hash_tables. */
1606 struct Lisp_Hash_Table
*next_weak
;
1610 LISP_INLINE
struct Lisp_Hash_Table
*
1611 XHASH_TABLE (Lisp_Object a
)
1613 return XUNTAG (a
, Lisp_Vectorlike
);
1616 #define XSET_HASH_TABLE(VAR, PTR) \
1617 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1620 HASH_TABLE_P (Lisp_Object a
)
1622 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1625 /* Value is the key part of entry IDX in hash table H. */
1626 LISP_INLINE Lisp_Object
1627 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1629 return AREF (h
->key_and_value
, 2 * idx
);
1632 /* Value is the value part of entry IDX in hash table H. */
1633 LISP_INLINE Lisp_Object
1634 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1636 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1639 /* Value is the index of the next entry following the one at IDX
1641 LISP_INLINE Lisp_Object
1642 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1644 return AREF (h
->next
, idx
);
1647 /* Value is the hash code computed for entry IDX in hash table H. */
1648 LISP_INLINE Lisp_Object
1649 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1651 return AREF (h
->hash
, idx
);
1654 /* Value is the index of the element in hash table H that is the
1655 start of the collision list at index IDX in the index vector of H. */
1656 LISP_INLINE Lisp_Object
1657 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1659 return AREF (h
->index
, idx
);
1662 /* Value is the size of hash table H. */
1663 LISP_INLINE
ptrdiff_t
1664 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1666 return ASIZE (h
->next
);
1669 /* Default size for hash tables if not specified. */
1671 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1673 /* Default threshold specifying when to resize a hash table. The
1674 value gives the ratio of current entries in the hash table and the
1675 size of the hash table. */
1677 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1679 /* Default factor by which to increase the size of a hash table. */
1681 static double const DEFAULT_REHASH_SIZE
= 1.5;
1683 /* Combine two integers X and Y for hashing. The result might not fit
1684 into a Lisp integer. */
1686 LISP_INLINE EMACS_UINT
1687 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1689 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1692 /* Hash X, returning a value that fits into a fixnum. */
1694 LISP_INLINE EMACS_UINT
1695 SXHASH_REDUCE (EMACS_UINT x
)
1697 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1700 /* These structures are used for various misc types. */
1702 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1704 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1705 unsigned gcmarkbit
: 1;
1711 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1712 unsigned gcmarkbit
: 1;
1714 /* This flag is temporarily used in the functions
1715 decode/encode_coding_object to record that the marker position
1716 must be adjusted after the conversion. */
1717 unsigned int need_adjustment
: 1;
1718 /* 1 means normal insertion at the marker's position
1719 leaves the marker after the inserted text. */
1720 unsigned int insertion_type
: 1;
1721 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1722 Note: a chain of markers can contain markers pointing into different
1723 buffers (the chain is per buffer_text rather than per buffer, so it's
1724 shared between indirect buffers). */
1725 /* This is used for (other than NULL-checking):
1727 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1728 - unchain_marker: to find the list from which to unchain.
1729 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1731 struct buffer
*buffer
;
1733 /* The remaining fields are meaningless in a marker that
1734 does not point anywhere. */
1736 /* For markers that point somewhere,
1737 this is used to chain of all the markers in a given buffer. */
1738 /* We could remove it and use an array in buffer_text instead.
1739 That would also allow to preserve it ordered. */
1740 struct Lisp_Marker
*next
;
1741 /* This is the char position where the marker points. */
1743 /* This is the byte position.
1744 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1745 used to implement the functionality of markers, but rather to (ab)use
1746 markers as a cache for char<->byte mappings). */
1750 /* START and END are markers in the overlay's buffer, and
1751 PLIST is the overlay's property list. */
1753 /* An overlay's real data content is:
1755 - buffer (really there are two buffer pointers, one per marker,
1756 and both points to the same buffer)
1757 - insertion type of both ends (per-marker fields)
1758 - start & start byte (of start marker)
1759 - end & end byte (of end marker)
1760 - next (singly linked list of overlays)
1761 - next fields of start and end markers (singly linked list of markers).
1762 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1765 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1766 unsigned gcmarkbit
: 1;
1768 struct Lisp_Overlay
*next
;
1774 /* Types of data which may be saved in a Lisp_Save_Value. */
1785 /* Number of bits needed to store one of the above values. */
1786 enum { SAVE_SLOT_BITS
= 3 };
1788 /* Number of slots in a save value where save_type is nonzero. */
1789 enum { SAVE_VALUE_SLOTS
= 4 };
1791 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1793 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1797 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1798 SAVE_TYPE_INT_INT_INT
1799 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1800 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1801 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1802 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1803 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1804 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1805 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1806 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1807 SAVE_TYPE_FUNCPTR_PTR_OBJ
1808 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1810 /* This has an extra bit indicating it's raw memory. */
1811 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1814 /* Special object used to hold a different values for later use.
1816 This is mostly used to package C integers and pointers to call
1817 record_unwind_protect. A typical task is to pass just one C object
1818 pointer to the unwind function. You should pack an object pointer with
1819 make_save_pointer and then get it back with XSAVE_POINTER, e.g.:
1822 struct my_data *md = get_my_data ();
1823 record_unwind_protect (my_unwind, make_save_pointer (md));
1826 Lisp_Object my_unwind (Lisp_Object arg)
1828 struct my_data *md = XSAVE_POINTER (arg, 0);
1832 If you need to pass something else you can use make_save_value,
1833 which allows you to pack up to SAVE_VALUE_SLOTS integers, pointers,
1834 function pointers or Lisp_Objects and conveniently get them back
1835 with XSAVE_INTEGER, XSAVE_POINTER, XSAVE_FUNCPOINTER, and
1836 XSAVE_OBJECT macros:
1839 struct my_data *md = get_my_data ();
1840 Lisp_Object my_object = get_my_object ();
1841 record_unwind_protect
1842 (my_unwind, make_save_value (SAVE_TYPE_PTR_OBJ, md, my_object));
1845 Lisp_Object my_unwind (Lisp_Object arg)
1847 struct my_data *md = XSAVE_POINTER (arg, 0);
1848 Lisp_Object my_object = XSAVE_OBJECT (arg, 1);
1852 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1853 saved objects and raise eassert if type of the saved object doesn't match
1854 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1855 or XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1856 Lisp_Object was saved in slot 1 of ARG. */
1858 typedef void (*voidfuncptr
) (void);
1860 struct Lisp_Save_Value
1862 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1863 unsigned gcmarkbit
: 1;
1864 int spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
1866 /* DATA[N] may hold up to SAVE_VALUE_SLOTS entries. The type of
1867 V's Ith entry is given by save_type (V, I). E.g., if save_type
1868 (V, 3) == SAVE_INTEGER, V->data[3].integer is in use.
1870 If SAVE_TYPE == SAVE_TYPE_MEMORY, DATA[0].pointer is the address of
1871 a memory area containing DATA[1].integer potential Lisp_Objects. */
1872 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1875 voidfuncptr funcpointer
;
1878 } data
[SAVE_VALUE_SLOTS
];
1881 /* Return the type of V's Nth saved value. */
1883 save_type (struct Lisp_Save_Value
*v
, int n
)
1885 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1886 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1889 /* Get and set the Nth saved pointer. */
1892 XSAVE_POINTER (Lisp_Object obj
, int n
)
1894 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1895 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1898 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1900 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1901 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1903 LISP_INLINE voidfuncptr
1904 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1906 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1907 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1910 /* Likewise for the saved integer. */
1912 LISP_INLINE
ptrdiff_t
1913 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1915 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1916 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1919 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1921 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1922 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1925 /* Extract Nth saved object. */
1927 LISP_INLINE Lisp_Object
1928 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1930 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1931 return XSAVE_VALUE (obj
)->data
[n
].object
;
1934 /* A miscellaneous object, when it's on the free list. */
1937 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
1938 unsigned gcmarkbit
: 1;
1940 union Lisp_Misc
*chain
;
1943 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1944 It uses one of these struct subtypes to get the type field. */
1948 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1949 struct Lisp_Free u_free
;
1950 struct Lisp_Marker u_marker
;
1951 struct Lisp_Overlay u_overlay
;
1952 struct Lisp_Save_Value u_save_value
;
1955 LISP_INLINE
union Lisp_Misc
*
1956 XMISC (Lisp_Object a
)
1958 return XUNTAG (a
, Lisp_Misc
);
1961 LISP_INLINE
struct Lisp_Misc_Any
*
1962 XMISCANY (Lisp_Object a
)
1964 eassert (MISCP (a
));
1965 return & XMISC (a
)->u_any
;
1968 LISP_INLINE
enum Lisp_Misc_Type
1969 XMISCTYPE (Lisp_Object a
)
1971 return XMISCANY (a
)->type
;
1974 LISP_INLINE
struct Lisp_Marker
*
1975 XMARKER (Lisp_Object a
)
1977 eassert (MARKERP (a
));
1978 return & XMISC (a
)->u_marker
;
1981 LISP_INLINE
struct Lisp_Overlay
*
1982 XOVERLAY (Lisp_Object a
)
1984 eassert (OVERLAYP (a
));
1985 return & XMISC (a
)->u_overlay
;
1988 LISP_INLINE
struct Lisp_Save_Value
*
1989 XSAVE_VALUE (Lisp_Object a
)
1991 eassert (SAVE_VALUEP (a
));
1992 return & XMISC (a
)->u_save_value
;
1995 /* Forwarding pointer to an int variable.
1996 This is allowed only in the value cell of a symbol,
1997 and it means that the symbol's value really lives in the
1998 specified int variable. */
2001 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2005 /* Boolean forwarding pointer to an int variable.
2006 This is like Lisp_Intfwd except that the ostensible
2007 "value" of the symbol is t if the int variable is nonzero,
2008 nil if it is zero. */
2011 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2015 /* Forwarding pointer to a Lisp_Object variable.
2016 This is allowed only in the value cell of a symbol,
2017 and it means that the symbol's value really lives in the
2018 specified variable. */
2021 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2022 Lisp_Object
*objvar
;
2025 /* Like Lisp_Objfwd except that value lives in a slot in the
2026 current buffer. Value is byte index of slot within buffer. */
2027 struct Lisp_Buffer_Objfwd
2029 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2031 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2032 Lisp_Object predicate
;
2035 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2036 the symbol has buffer-local or frame-local bindings. (Exception:
2037 some buffer-local variables are built-in, with their values stored
2038 in the buffer structure itself. They are handled differently,
2039 using struct Lisp_Buffer_Objfwd.)
2041 The `realvalue' slot holds the variable's current value, or a
2042 forwarding pointer to where that value is kept. This value is the
2043 one that corresponds to the loaded binding. To read or set the
2044 variable, you must first make sure the right binding is loaded;
2045 then you can access the value in (or through) `realvalue'.
2047 `buffer' and `frame' are the buffer and frame for which the loaded
2048 binding was found. If those have changed, to make sure the right
2049 binding is loaded it is necessary to find which binding goes with
2050 the current buffer and selected frame, then load it. To load it,
2051 first unload the previous binding, then copy the value of the new
2052 binding into `realvalue' (or through it). Also update
2053 LOADED-BINDING to point to the newly loaded binding.
2055 `local_if_set' indicates that merely setting the variable creates a
2056 local binding for the current buffer. Otherwise the latter, setting
2057 the variable does not do that; only make-local-variable does that. */
2059 struct Lisp_Buffer_Local_Value
2061 /* 1 means that merely setting the variable creates a local
2062 binding for the current buffer. */
2063 unsigned int local_if_set
: 1;
2064 /* 1 means this variable can have frame-local bindings, otherwise, it is
2065 can have buffer-local bindings. The two cannot be combined. */
2066 unsigned int frame_local
: 1;
2067 /* 1 means that the binding now loaded was found.
2068 Presumably equivalent to (defcell!=valcell). */
2069 unsigned int found
: 1;
2070 /* If non-NULL, a forwarding to the C var where it should also be set. */
2071 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2072 /* The buffer or frame for which the loaded binding was found. */
2074 /* A cons cell that holds the default value. It has the form
2075 (SYMBOL . DEFAULT-VALUE). */
2076 Lisp_Object defcell
;
2077 /* The cons cell from `where's parameter alist.
2078 It always has the form (SYMBOL . VALUE)
2079 Note that if `forward' is non-nil, VALUE may be out of date.
2080 Also if the currently loaded binding is the default binding, then
2081 this is `eq'ual to defcell. */
2082 Lisp_Object valcell
;
2085 /* Like Lisp_Objfwd except that value lives in a slot in the
2087 struct Lisp_Kboard_Objfwd
2089 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2095 struct Lisp_Intfwd u_intfwd
;
2096 struct Lisp_Boolfwd u_boolfwd
;
2097 struct Lisp_Objfwd u_objfwd
;
2098 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2099 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2102 LISP_INLINE
enum Lisp_Fwd_Type
2103 XFWDTYPE (union Lisp_Fwd
*a
)
2105 return a
->u_intfwd
.type
;
2108 LISP_INLINE
struct Lisp_Buffer_Objfwd
*
2109 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2111 eassert (BUFFER_OBJFWDP (a
));
2112 return &a
->u_buffer_objfwd
;
2115 /* Lisp floating point type. */
2121 struct Lisp_Float
*chain
;
2126 XFLOAT_DATA (Lisp_Object f
)
2128 return XFLOAT (f
)->u
.data
;
2131 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2132 representations, have infinities and NaNs, and do not trap on
2133 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2134 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2135 wanted here, but is not quite right because Emacs does not require
2136 all the features of C11 Annex F (and does not require C11 at all,
2137 for that matter). */
2141 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2142 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2145 /* A character, declared with the following typedef, is a member
2146 of some character set associated with the current buffer. */
2147 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2149 typedef unsigned char UCHAR
;
2152 /* Meanings of slots in a Lisp_Compiled: */
2156 COMPILED_ARGLIST
= 0,
2157 COMPILED_BYTECODE
= 1,
2158 COMPILED_CONSTANTS
= 2,
2159 COMPILED_STACK_DEPTH
= 3,
2160 COMPILED_DOC_STRING
= 4,
2161 COMPILED_INTERACTIVE
= 5
2164 /* Flag bits in a character. These also get used in termhooks.h.
2165 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2166 (MUlti-Lingual Emacs) might need 22 bits for the character value
2167 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2170 CHAR_ALT
= 0x0400000,
2171 CHAR_SUPER
= 0x0800000,
2172 CHAR_HYPER
= 0x1000000,
2173 CHAR_SHIFT
= 0x2000000,
2174 CHAR_CTL
= 0x4000000,
2175 CHAR_META
= 0x8000000,
2177 CHAR_MODIFIER_MASK
=
2178 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2180 /* Actually, the current Emacs uses 22 bits for the character value
2185 /* Structure to hold mouse highlight data. This is here because other
2186 header files need it for defining struct x_output etc. */
2188 /* These variables describe the range of text currently shown in its
2189 mouse-face, together with the window they apply to. As long as
2190 the mouse stays within this range, we need not redraw anything on
2191 its account. Rows and columns are glyph matrix positions in
2192 MOUSE_FACE_WINDOW. */
2193 int mouse_face_beg_row
, mouse_face_beg_col
;
2194 int mouse_face_beg_x
, mouse_face_beg_y
;
2195 int mouse_face_end_row
, mouse_face_end_col
;
2196 int mouse_face_end_x
, mouse_face_end_y
;
2197 Lisp_Object mouse_face_window
;
2198 int mouse_face_face_id
;
2199 Lisp_Object mouse_face_overlay
;
2201 /* FRAME and X, Y position of mouse when last checked for
2202 highlighting. X and Y can be negative or out of range for the frame. */
2203 struct frame
*mouse_face_mouse_frame
;
2204 int mouse_face_mouse_x
, mouse_face_mouse_y
;
2206 /* Nonzero if part of the text currently shown in
2207 its mouse-face is beyond the window end. */
2208 unsigned mouse_face_past_end
: 1;
2210 /* Nonzero means defer mouse-motion highlighting. */
2211 unsigned mouse_face_defer
: 1;
2213 /* Nonzero means that the mouse highlight should not be shown. */
2214 unsigned mouse_face_hidden
: 1;
2217 /* Data type checking. */
2219 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2222 NUMBERP (Lisp_Object x
)
2224 return INTEGERP (x
) || FLOATP (x
);
2227 NATNUMP (Lisp_Object x
)
2229 return INTEGERP (x
) && 0 <= XINT (x
);
2233 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2235 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2238 #define TYPE_RANGED_INTEGERP(type, x) \
2240 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2241 && XINT (x) <= TYPE_MAXIMUM (type))
2243 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2244 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2245 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2246 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2247 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2248 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2249 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2252 STRINGP (Lisp_Object x
)
2254 return XTYPE (x
) == Lisp_String
;
2257 VECTORP (Lisp_Object x
)
2259 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2262 OVERLAYP (Lisp_Object x
)
2264 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2267 SAVE_VALUEP (Lisp_Object x
)
2269 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2273 AUTOLOADP (Lisp_Object x
)
2275 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2279 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2281 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2285 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2287 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2288 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2291 /* True if A is a pseudovector whose code is CODE. */
2293 PSEUDOVECTORP (Lisp_Object a
, int code
)
2295 if (! VECTORLIKEP (a
))
2299 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2300 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2301 return PSEUDOVECTOR_TYPEP (h
, code
);
2306 /* Test for specific pseudovector types. */
2309 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2311 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2315 PROCESSP (Lisp_Object a
)
2317 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2321 WINDOWP (Lisp_Object a
)
2323 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2327 TERMINALP (Lisp_Object a
)
2329 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2333 SUBRP (Lisp_Object a
)
2335 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2339 COMPILEDP (Lisp_Object a
)
2341 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2345 BUFFERP (Lisp_Object a
)
2347 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2351 CHAR_TABLE_P (Lisp_Object a
)
2353 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2357 SUB_CHAR_TABLE_P (Lisp_Object a
)
2359 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2363 BOOL_VECTOR_P (Lisp_Object a
)
2365 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2369 FRAMEP (Lisp_Object a
)
2371 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2374 /* Test for image (image . spec) */
2376 IMAGEP (Lisp_Object x
)
2378 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2383 ARRAYP (Lisp_Object x
)
2385 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2389 CHECK_LIST (Lisp_Object x
)
2391 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2394 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2395 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2396 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2399 CHECK_STRING (Lisp_Object x
)
2401 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2404 CHECK_STRING_CAR (Lisp_Object x
)
2406 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2409 CHECK_CONS (Lisp_Object x
)
2411 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2414 CHECK_VECTOR (Lisp_Object x
)
2416 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2419 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2421 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2424 CHECK_ARRAY (Lisp_Object x
, Lisp_Object Qxxxp
)
2426 CHECK_TYPE (ARRAYP (x
), Qxxxp
, x
);
2429 CHECK_BUFFER (Lisp_Object x
)
2431 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2434 CHECK_WINDOW (Lisp_Object x
)
2436 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2439 CHECK_PROCESS (Lisp_Object x
)
2441 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2444 CHECK_NATNUM (Lisp_Object x
)
2446 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2449 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2452 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2453 args_out_of_range_3 \
2455 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2456 ? MOST_NEGATIVE_FIXNUM \
2458 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2460 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2462 if (TYPE_SIGNED (type)) \
2463 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2465 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2468 #define CHECK_NUMBER_COERCE_MARKER(x) \
2469 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
2470 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
2473 XFLOATINT (Lisp_Object n
)
2475 return extract_float (n
);
2479 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2481 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2484 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2485 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
2486 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
2488 /* Since we can't assign directly to the CAR or CDR fields of a cons
2489 cell, use these when checking that those fields contain numbers. */
2491 CHECK_NUMBER_CAR (Lisp_Object x
)
2493 Lisp_Object tmp
= XCAR (x
);
2499 CHECK_NUMBER_CDR (Lisp_Object x
)
2501 Lisp_Object tmp
= XCDR (x
);
2506 /* Define a built-in function for calling from Lisp.
2507 `lname' should be the name to give the function in Lisp,
2508 as a null-terminated C string.
2509 `fnname' should be the name of the function in C.
2510 By convention, it starts with F.
2511 `sname' should be the name for the C constant structure
2512 that records information on this function for internal use.
2513 By convention, it should be the same as `fnname' but with S instead of F.
2514 It's too bad that C macros can't compute this from `fnname'.
2515 `minargs' should be a number, the minimum number of arguments allowed.
2516 `maxargs' should be a number, the maximum number of arguments allowed,
2517 or else MANY or UNEVALLED.
2518 MANY means pass a vector of evaluated arguments,
2519 in the form of an integer number-of-arguments
2520 followed by the address of a vector of Lisp_Objects
2521 which contains the argument values.
2522 UNEVALLED means pass the list of unevaluated arguments
2523 `intspec' says how interactive arguments are to be fetched.
2524 If the string starts with a `(', `intspec' is evaluated and the resulting
2525 list is the list of arguments.
2526 If it's a string that doesn't start with `(', the value should follow
2527 the one of the doc string for `interactive'.
2528 A null string means call interactively with no arguments.
2529 `doc' is documentation for the user. */
2531 /* This version of DEFUN declares a function prototype with the right
2532 arguments, so we can catch errors with maxargs at compile-time. */
2534 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2535 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2536 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2537 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2538 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2539 { (Lisp_Object (__cdecl *)(void))fnname }, \
2540 minargs, maxargs, lname, intspec, 0}; \
2542 #else /* not _MSC_VER */
2543 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2544 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2545 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2546 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2547 { .a ## maxargs = fnname }, \
2548 minargs, maxargs, lname, intspec, 0}; \
2552 /* Note that the weird token-substitution semantics of ANSI C makes
2553 this work for MANY and UNEVALLED. */
2554 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2555 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2556 #define DEFUN_ARGS_0 (void)
2557 #define DEFUN_ARGS_1 (Lisp_Object)
2558 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2559 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2560 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2561 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2563 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2564 Lisp_Object, Lisp_Object)
2565 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2566 Lisp_Object, Lisp_Object, Lisp_Object)
2567 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2568 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2570 /* True if OBJ is a Lisp function. */
2572 FUNCTIONP (Lisp_Object obj
)
2574 return functionp (obj
);
2578 is how we define the symbol for function `name' at start-up time. */
2579 extern void defsubr (struct Lisp_Subr
*);
2587 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2588 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2589 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2590 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2591 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2593 /* Macros we use to define forwarded Lisp variables.
2594 These are used in the syms_of_FILENAME functions.
2596 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2597 lisp variable is actually a field in `struct emacs_globals'. The
2598 field's name begins with "f_", which is a convention enforced by
2599 these macros. Each such global has a corresponding #define in
2600 globals.h; the plain name should be used in the code.
2602 E.g., the global "cons_cells_consed" is declared as "int
2603 f_cons_cells_consed" in globals.h, but there is a define:
2605 #define cons_cells_consed globals.f_cons_cells_consed
2607 All C code uses the `cons_cells_consed' name. This is all done
2608 this way to support indirection for multi-threaded Emacs. */
2610 #define DEFVAR_LISP(lname, vname, doc) \
2612 static struct Lisp_Objfwd o_fwd; \
2613 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2615 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2617 static struct Lisp_Objfwd o_fwd; \
2618 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2620 #define DEFVAR_BOOL(lname, vname, doc) \
2622 static struct Lisp_Boolfwd b_fwd; \
2623 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2625 #define DEFVAR_INT(lname, vname, doc) \
2627 static struct Lisp_Intfwd i_fwd; \
2628 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2631 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2633 static struct Lisp_Objfwd o_fwd; \
2634 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2637 #define DEFVAR_KBOARD(lname, vname, doc) \
2639 static struct Lisp_Kboard_Objfwd ko_fwd; \
2640 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2643 /* Save and restore the instruction and environment pointers,
2644 without affecting the signal mask. */
2647 typedef jmp_buf sys_jmp_buf
;
2648 # define sys_setjmp(j) _setjmp (j)
2649 # define sys_longjmp(j, v) _longjmp (j, v)
2650 #elif defined HAVE_SIGSETJMP
2651 typedef sigjmp_buf sys_jmp_buf
;
2652 # define sys_setjmp(j) sigsetjmp (j, 0)
2653 # define sys_longjmp(j, v) siglongjmp (j, v)
2655 /* A platform that uses neither _longjmp nor siglongjmp; assume
2656 longjmp does not affect the sigmask. */
2657 typedef jmp_buf sys_jmp_buf
;
2658 # define sys_setjmp(j) setjmp (j)
2659 # define sys_longjmp(j, v) longjmp (j, v)
2663 /* Elisp uses several stacks:
2665 - the bytecode stack: used internally by the bytecode interpreter.
2666 Allocated from the C stack.
2667 - The specpdl stack: keeps track of active unwind-protect and
2668 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2670 - The catch stack: keeps track of active catch tags.
2671 Allocated on the C stack. This is where the setmp data is kept.
2672 - The handler stack: keeps track of active condition-case handlers.
2673 Allocated on the C stack. Every entry there also uses an entry in
2676 /* Structure for recording Lisp call stack for backtrace purposes. */
2678 /* The special binding stack holds the outer values of variables while
2679 they are bound by a function application or a let form, stores the
2680 code to be executed for unwind-protect forms.
2682 If func is non-zero, undoing this binding applies func to old_value;
2683 This implements record_unwind_protect.
2685 Otherwise, the element is a variable binding.
2687 If the symbol field is a symbol, it is an ordinary variable binding.
2689 Otherwise, it should be a structure (SYMBOL WHERE . CURRENT-BUFFER),
2690 which means having bound a local value while CURRENT-BUFFER was active.
2691 If WHERE is nil this means we saw the default value when binding SYMBOL.
2692 WHERE being a buffer or frame means we saw a buffer-local or frame-local
2693 value. Other values of WHERE mean an internal error.
2695 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2696 used all over the place, needs to be fast, and needs to know the size of
2697 union specbinding. But only eval.c should access it. */
2699 typedef Lisp_Object (*specbinding_func
) (Lisp_Object
);
2702 SPECPDL_UNWIND
, /* An unwind_protect function. */
2703 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2704 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2705 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2706 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2707 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2712 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2714 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2716 specbinding_func func
;
2719 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2720 /* `where' is not used in the case of SPECPDL_LET. */
2721 Lisp_Object symbol
, old_value
, where
;
2724 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2725 bool debug_on_exit
: 1;
2726 Lisp_Object function
;
2732 extern union specbinding
*specpdl
;
2733 extern union specbinding
*specpdl_ptr
;
2734 extern ptrdiff_t specpdl_size
;
2736 LISP_INLINE
ptrdiff_t
2737 SPECPDL_INDEX (void)
2739 return specpdl_ptr
- specpdl
;
2742 /* Everything needed to describe an active condition case.
2744 Members are volatile if their values need to survive _longjmp when
2745 a 'struct handler' is a local variable. */
2748 /* The handler clauses and variable from the condition-case form. */
2749 /* For a handler set up in Lisp code, this is always a list.
2750 For an internal handler set up by internal_condition_case*,
2751 this can instead be the symbol t or `error'.
2752 t: handle all conditions.
2753 error: handle all conditions, and errors can run the debugger
2754 or display a backtrace. */
2755 Lisp_Object handler
;
2757 Lisp_Object
volatile var
;
2759 /* Fsignal stores here the condition-case clause that applies,
2760 and Fcondition_case thus knows which clause to run. */
2761 Lisp_Object
volatile chosen_clause
;
2763 /* Used to effect the longjump out to the handler. */
2764 struct catchtag
*tag
;
2766 /* The next enclosing handler. */
2767 struct handler
*next
;
2770 /* This structure helps implement the `catch' and `throw' control
2771 structure. A struct catchtag contains all the information needed
2772 to restore the state of the interpreter after a non-local jump.
2774 Handlers for error conditions (represented by `struct handler'
2775 structures) just point to a catch tag to do the cleanup required
2778 catchtag structures are chained together in the C calling stack;
2779 the `next' member points to the next outer catchtag.
2781 A call like (throw TAG VAL) searches for a catchtag whose `tag'
2782 member is TAG, and then unbinds to it. The `val' member is used to
2783 hold VAL while the stack is unwound; `val' is returned as the value
2786 All the other members are concerned with restoring the interpreter
2789 Members are volatile if their values need to survive _longjmp when
2790 a 'struct catchtag' is a local variable. */
2794 Lisp_Object
volatile val
;
2795 struct catchtag
*volatile next
;
2796 #if 1 /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but they're defined later. */
2797 struct gcpro
*gcpro
;
2800 struct handler
*handlerlist
;
2801 EMACS_INT lisp_eval_depth
;
2802 ptrdiff_t volatile pdlcount
;
2803 int poll_suppress_count
;
2804 int interrupt_input_blocked
;
2805 struct byte_stack
*byte_stack
;
2808 extern Lisp_Object memory_signal_data
;
2810 /* An address near the bottom of the stack.
2811 Tells GC how to save a copy of the stack. */
2812 extern char *stack_bottom
;
2814 /* Check quit-flag and quit if it is non-nil.
2815 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2816 So the program needs to do QUIT at times when it is safe to quit.
2817 Every loop that might run for a long time or might not exit
2818 ought to do QUIT at least once, at a safe place.
2819 Unless that is impossible, of course.
2820 But it is very desirable to avoid creating loops where QUIT is impossible.
2822 Exception: if you set immediate_quit to nonzero,
2823 then the handler that responds to the C-g does the quit itself.
2824 This is a good thing to do around a loop that has no side effects
2825 and (in particular) cannot call arbitrary Lisp code.
2827 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2828 a request to exit Emacs when it is safe to do. */
2830 extern void process_pending_signals (void);
2831 extern bool volatile pending_signals
;
2833 extern void process_quit_flag (void);
2836 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2837 process_quit_flag (); \
2838 else if (pending_signals) \
2839 process_pending_signals (); \
2843 /* Nonzero if ought to quit now. */
2845 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2847 extern Lisp_Object Vascii_downcase_table
;
2848 extern Lisp_Object Vascii_canon_table
;
2850 /* Structure for recording stack slots that need marking. */
2852 /* This is a chain of structures, each of which points at a Lisp_Object
2853 variable whose value should be marked in garbage collection.
2854 Normally every link of the chain is an automatic variable of a function,
2855 and its `val' points to some argument or local variable of the function.
2856 On exit to the function, the chain is set back to the value it had on entry.
2857 This way, no link remains in the chain when the stack frame containing the
2860 Every function that can call Feval must protect in this fashion all
2861 Lisp_Object variables whose contents will be used again. */
2863 extern struct gcpro
*gcprolist
;
2869 /* Address of first protected variable. */
2870 volatile Lisp_Object
*var
;
2872 /* Number of consecutive protected variables. */
2880 /* Values of GC_MARK_STACK during compilation:
2882 0 Use GCPRO as before
2883 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
2884 2 Mark the stack, and check that everything GCPRO'd is
2886 3 Mark using GCPRO's, mark stack last, and count how many
2887 dead objects are kept alive.
2889 Formerly, method 0 was used. Currently, method 1 is used unless
2890 otherwise specified by hand when building, e.g.,
2891 "make CPPFLAGS='-DGC_MARK_STACK=GC_USE_GCPROS_AS_BEFORE'".
2892 Methods 2 and 3 are present mainly to debug the transition from 0 to 1. */
2894 #define GC_USE_GCPROS_AS_BEFORE 0
2895 #define GC_MAKE_GCPROS_NOOPS 1
2896 #define GC_MARK_STACK_CHECK_GCPROS 2
2897 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
2899 #ifndef GC_MARK_STACK
2900 #define GC_MARK_STACK GC_MAKE_GCPROS_NOOPS
2903 /* Whether we do the stack marking manually. */
2904 #define BYTE_MARK_STACK !(GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
2905 || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
2908 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
2910 /* Do something silly with gcproN vars just so gcc shuts up. */
2911 /* You get warnings from MIPSPro... */
2913 #define GCPRO1(varname) ((void) gcpro1)
2914 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2915 #define GCPRO3(varname1, varname2, varname3) \
2916 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2917 #define GCPRO4(varname1, varname2, varname3, varname4) \
2918 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2919 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2920 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2921 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2922 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2924 #define UNGCPRO ((void) 0)
2926 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2930 #define GCPRO1(varname) \
2931 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2932 gcprolist = &gcpro1; }
2934 #define GCPRO2(varname1, varname2) \
2935 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2936 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2937 gcprolist = &gcpro2; }
2939 #define GCPRO3(varname1, varname2, varname3) \
2940 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2941 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2942 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2943 gcprolist = &gcpro3; }
2945 #define GCPRO4(varname1, varname2, varname3, varname4) \
2946 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2947 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2948 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2949 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2950 gcprolist = &gcpro4; }
2952 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
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 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2958 gcprolist = &gcpro5; }
2960 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2961 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2962 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2963 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2964 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2965 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2966 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2967 gcprolist = &gcpro6; }
2969 #define UNGCPRO (gcprolist = gcpro1.next)
2973 extern int gcpro_level
;
2975 #define GCPRO1(varname) \
2976 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2977 gcpro1.level = gcpro_level++; \
2978 gcprolist = &gcpro1; }
2980 #define GCPRO2(varname1, varname2) \
2981 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2982 gcpro1.level = gcpro_level; \
2983 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2984 gcpro2.level = gcpro_level++; \
2985 gcprolist = &gcpro2; }
2987 #define GCPRO3(varname1, varname2, varname3) \
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 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2992 gcpro3.level = gcpro_level++; \
2993 gcprolist = &gcpro3; }
2995 #define GCPRO4(varname1, varname2, varname3, varname4) \
2996 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2997 gcpro1.level = gcpro_level; \
2998 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2999 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3000 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3001 gcpro4.level = gcpro_level++; \
3002 gcprolist = &gcpro4; }
3004 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
3005 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3006 gcpro1.level = gcpro_level; \
3007 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3008 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3009 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3010 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3011 gcpro5.level = gcpro_level++; \
3012 gcprolist = &gcpro5; }
3014 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
3015 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
3016 gcpro1.level = gcpro_level; \
3017 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
3018 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
3019 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
3020 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
3021 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
3022 gcpro6.level = gcpro_level++; \
3023 gcprolist = &gcpro6; }
3026 ((--gcpro_level != gcpro1.level) \
3027 ? (emacs_abort (), 0) \
3028 : ((gcprolist = gcpro1.next), 0))
3030 #endif /* DEBUG_GCPRO */
3031 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
3034 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
3035 #define RETURN_UNGCPRO(expr) \
3038 Lisp_Object ret_ungc_val; \
3039 ret_ungc_val = (expr); \
3041 return ret_ungc_val; \
3045 /* Call staticpro (&var) to protect static variable `var'. */
3047 void staticpro (Lisp_Object
*);
3049 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
3050 meaning as in the DEFUN macro, and is used to construct a prototype. */
3051 /* We can use the same trick as in the DEFUN macro to generate the
3052 appropriate prototype. */
3053 #define EXFUN(fnname, maxargs) \
3054 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3056 #include "globals.h"
3058 /* Forward declarations for prototypes. */
3062 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3065 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3067 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3068 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3071 /* Functions to modify hash tables. */
3074 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3076 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3080 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3082 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3085 /* Use these functions to set Lisp_Object
3086 or pointer slots of struct Lisp_Symbol. */
3089 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3091 XSYMBOL (sym
)->function
= function
;
3095 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3097 XSYMBOL (sym
)->plist
= plist
;
3101 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3103 XSYMBOL (sym
)->next
= next
;
3106 /* Buffer-local (also frame-local) variable access functions. */
3109 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3111 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3115 /* Set overlay's property list. */
3118 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3120 XOVERLAY (overlay
)->plist
= plist
;
3123 /* Get text properties of S. */
3125 LISP_INLINE INTERVAL
3126 string_intervals (Lisp_Object s
)
3128 return XSTRING (s
)->intervals
;
3131 /* Set text properties of S to I. */
3134 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3136 XSTRING (s
)->intervals
= i
;
3139 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3140 of setting slots directly. */
3143 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3145 XCHAR_TABLE (table
)->defalt
= val
;
3148 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3150 XCHAR_TABLE (table
)->purpose
= val
;
3153 /* Set different slots in (sub)character tables. */
3156 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3158 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3159 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3163 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3165 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3166 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3170 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3172 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3175 /* Defined in data.c. */
3176 extern Lisp_Object Qnil
, Qt
, Qquote
, Qlambda
, Qunbound
;
3177 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3178 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3179 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3180 extern Lisp_Object Qinvalid_read_syntax
;
3181 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3182 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3183 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3184 extern Lisp_Object Qtext_read_only
;
3185 extern Lisp_Object Qinteractive_form
;
3186 extern Lisp_Object Qcircular_list
;
3187 extern Lisp_Object Qintegerp
, Qwholenump
, Qsymbolp
, Qlistp
, Qconsp
;
3188 extern Lisp_Object Qstringp
, Qarrayp
, Qsequencep
, Qbufferp
;
3189 extern Lisp_Object Qchar_or_string_p
, Qmarkerp
, Qinteger_or_marker_p
, Qvectorp
;
3190 extern Lisp_Object Qbuffer_or_string_p
;
3191 extern Lisp_Object Qfboundp
;
3192 extern Lisp_Object Qchar_table_p
, Qvector_or_char_table_p
;
3194 extern Lisp_Object Qcdr
;
3196 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3198 extern Lisp_Object Qfloatp
;
3199 extern Lisp_Object Qnumberp
, Qnumber_or_marker_p
;
3201 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3203 extern Lisp_Object Qfont_spec
, Qfont_entity
, Qfont_object
;
3205 EXFUN (Fbyteorder
, 0) ATTRIBUTE_CONST
;
3207 /* Defined in data.c. */
3208 extern Lisp_Object
indirect_function (Lisp_Object
);
3209 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3211 /* Convert the integer I to an Emacs representation, either the integer
3212 itself, or a cons of two or three integers, or if all else fails a float.
3213 I should not have side effects. */
3214 #define INTEGER_TO_CONS(i) \
3215 (! FIXNUM_OVERFLOW_P (i) \
3217 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3218 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3219 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3220 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3221 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3222 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3223 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3224 ? Fcons (make_number ((i) >> 16 >> 24), \
3225 Fcons (make_number ((i) >> 16 & 0xffffff), \
3226 make_number ((i) & 0xffff))) \
3229 /* Convert the Emacs representation CONS back to an integer of type
3230 TYPE, storing the result the variable VAR. Signal an error if CONS
3231 is not a valid representation or is out of range for TYPE. */
3232 #define CONS_TO_INTEGER(cons, type, var) \
3233 (TYPE_SIGNED (type) \
3234 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3235 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3236 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3237 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3239 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3240 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3241 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3243 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
3244 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3245 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3246 extern void syms_of_data (void);
3247 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3249 /* Defined in cmds.c */
3250 extern void syms_of_cmds (void);
3251 extern void keys_of_cmds (void);
3253 /* Defined in coding.c. */
3254 extern Lisp_Object Qcharset
;
3255 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3256 ptrdiff_t, bool, bool, Lisp_Object
);
3257 extern void init_coding (void);
3258 extern void init_coding_once (void);
3259 extern void syms_of_coding (void);
3261 /* Defined in character.c. */
3262 EXFUN (Fmax_char
, 0) ATTRIBUTE_CONST
;
3263 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3264 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3265 extern int multibyte_char_to_unibyte (int) ATTRIBUTE_CONST
;
3266 extern int multibyte_char_to_unibyte_safe (int) ATTRIBUTE_CONST
;
3267 extern void syms_of_character (void);
3269 /* Defined in charset.c. */
3270 extern void init_charset (void);
3271 extern void init_charset_once (void);
3272 extern void syms_of_charset (void);
3273 /* Structure forward declarations. */
3276 /* Defined in composite.c. */
3277 extern void syms_of_composite (void);
3279 /* Defined in syntax.c. */
3280 extern void init_syntax_once (void);
3281 extern void syms_of_syntax (void);
3283 /* Defined in fns.c. */
3284 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3285 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3286 EXFUN (Fidentity
, 1) ATTRIBUTE_CONST
;
3287 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3288 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3289 extern void sweep_weak_hash_tables (void);
3290 extern Lisp_Object Qcursor_in_echo_area
;
3291 extern Lisp_Object Qstring_lessp
;
3292 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3293 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3294 EMACS_UINT
sxhash (Lisp_Object
, int);
3295 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3296 Lisp_Object
, Lisp_Object
);
3297 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3298 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3300 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3302 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3303 ptrdiff_t, ptrdiff_t);
3304 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3305 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3306 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3307 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3308 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3309 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3310 extern void clear_string_char_byte_cache (void);
3311 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3312 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3313 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3314 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3315 extern void syms_of_fns (void);
3317 /* Defined in floatfns.c. */
3318 extern double extract_float (Lisp_Object
);
3319 extern void syms_of_floatfns (void);
3320 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3322 /* Defined in fringe.c. */
3323 extern void syms_of_fringe (void);
3324 extern void init_fringe (void);
3325 #ifdef HAVE_WINDOW_SYSTEM
3326 extern void mark_fringe_data (void);
3327 extern void init_fringe_once (void);
3328 #endif /* HAVE_WINDOW_SYSTEM */
3330 /* Defined in image.c. */
3331 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3332 extern Lisp_Object QCconversion
;
3333 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3334 extern void reset_image_types (void);
3335 extern void syms_of_image (void);
3337 /* Defined in insdel.c. */
3338 extern Lisp_Object Qinhibit_modification_hooks
;
3339 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3340 extern _Noreturn
void buffer_overflow (void);
3341 extern void make_gap (ptrdiff_t);
3342 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3343 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3344 ptrdiff_t, bool, bool);
3345 extern int count_combining_before (const unsigned char *,
3346 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3347 extern int count_combining_after (const unsigned char *,
3348 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3349 extern void insert (const char *, ptrdiff_t);
3350 extern void insert_and_inherit (const char *, ptrdiff_t);
3351 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3353 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3354 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3355 ptrdiff_t, ptrdiff_t, bool);
3356 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3357 extern void insert_char (int);
3358 extern void insert_string (const char *);
3359 extern void insert_before_markers (const char *, ptrdiff_t);
3360 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3361 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3362 ptrdiff_t, ptrdiff_t,
3364 extern void del_range (ptrdiff_t, ptrdiff_t);
3365 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3366 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3367 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3368 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3369 ptrdiff_t, ptrdiff_t, bool);
3370 extern void modify_region_1 (ptrdiff_t, ptrdiff_t, bool);
3371 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3372 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3373 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3374 ptrdiff_t, ptrdiff_t);
3375 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3376 ptrdiff_t, ptrdiff_t);
3377 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3378 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3379 const char *, ptrdiff_t, ptrdiff_t, bool);
3380 extern void syms_of_insdel (void);
3382 /* Defined in dispnew.c. */
3383 #if (defined PROFILING \
3384 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3385 _Noreturn
void __executable_start (void);
3387 extern Lisp_Object selected_frame
;
3388 extern Lisp_Object Vwindow_system
;
3389 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3390 extern void init_display (void);
3391 extern void syms_of_display (void);
3393 /* Defined in xdisp.c. */
3394 extern Lisp_Object Qinhibit_point_motion_hooks
;
3395 extern Lisp_Object Qinhibit_redisplay
, Qdisplay
;
3396 extern Lisp_Object Qmenu_bar_update_hook
;
3397 extern Lisp_Object Qwindow_scroll_functions
;
3398 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3399 extern Lisp_Object Qimage
, Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3400 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3401 extern Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
3402 extern Lisp_Object Qleft_margin
, Qright_margin
;
3403 extern Lisp_Object Qglyphless_char
;
3404 extern Lisp_Object QCdata
, QCfile
;
3405 extern Lisp_Object QCmap
;
3406 extern Lisp_Object Qrisky_local_variable
;
3407 extern struct frame
*last_glyphless_glyph_frame
;
3408 extern int last_glyphless_glyph_face_id
;
3409 extern int last_glyphless_glyph_merged_face_id
;
3410 extern int noninteractive_need_newline
;
3411 extern Lisp_Object echo_area_buffer
[2];
3412 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3413 extern void check_message_stack (void);
3414 extern void setup_echo_area_for_printing (int);
3415 extern bool push_message (void);
3416 extern Lisp_Object
pop_message_unwind (Lisp_Object
);
3417 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3418 extern void restore_message (void);
3419 extern Lisp_Object
current_message (void);
3420 extern void clear_message (int, int);
3421 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3422 extern void message1 (const char *);
3423 extern void message1_nolog (const char *);
3424 extern void message3 (Lisp_Object
);
3425 extern void message3_nolog (Lisp_Object
);
3426 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3427 extern void message_with_string (const char *, Lisp_Object
, int);
3428 extern void message_log_maybe_newline (void);
3429 extern void update_echo_area (void);
3430 extern void truncate_echo_area (ptrdiff_t);
3431 extern void redisplay (void);
3432 extern void redisplay_preserve_echo_area (int);
3433 extern void prepare_menu_bars (void);
3435 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3436 extern void syms_of_xdisp (void);
3437 extern void init_xdisp (void);
3438 extern Lisp_Object
safe_eval (Lisp_Object
);
3439 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3440 int *, int *, int *, int *, int *);
3442 /* Defined in xsettings.c. */
3443 extern void syms_of_xsettings (void);
3445 /* Defined in vm-limit.c. */
3446 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3448 /* Defined in alloc.c. */
3449 extern void check_pure_size (void);
3450 extern void free_misc (Lisp_Object
);
3451 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3452 extern void malloc_warning (const char *);
3453 extern _Noreturn
void memory_full (size_t);
3454 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3455 extern bool survives_gc_p (Lisp_Object
);
3456 extern void mark_object (Lisp_Object
);
3457 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3458 extern void refill_memory_reserve (void);
3460 extern const char *pending_malloc_warning
;
3461 extern Lisp_Object zero_vector
;
3462 extern Lisp_Object
*stack_base
;
3463 extern EMACS_INT consing_since_gc
;
3464 extern EMACS_INT gc_relative_threshold
;
3465 extern EMACS_INT memory_full_cons_threshold
;
3466 extern Lisp_Object
list1 (Lisp_Object
);
3467 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3468 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3469 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3470 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3472 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3473 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3475 /* Build a frequently used 2/3/4-integer lists. */
3477 LISP_INLINE Lisp_Object
3478 list2i (EMACS_INT x
, EMACS_INT y
)
3480 return list2 (make_number (x
), make_number (y
));
3483 LISP_INLINE Lisp_Object
3484 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3486 return list3 (make_number (x
), make_number (y
), make_number (w
));
3489 LISP_INLINE Lisp_Object
3490 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3492 return list4 (make_number (x
), make_number (y
),
3493 make_number (w
), make_number (h
));
3496 extern _Noreturn
void string_overflow (void);
3497 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3498 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3499 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3500 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3502 /* Make unibyte string from C string when the length isn't known. */
3504 LISP_INLINE Lisp_Object
3505 build_unibyte_string (const char *str
)
3507 return make_unibyte_string (str
, strlen (str
));
3510 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3511 extern Lisp_Object
make_event_array (int, Lisp_Object
*);
3512 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3513 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3514 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3515 extern Lisp_Object
make_specified_string (const char *,
3516 ptrdiff_t, ptrdiff_t, bool);
3517 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3518 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3520 /* Make a string allocated in pure space, use STR as string data. */
3522 LISP_INLINE Lisp_Object
3523 build_pure_c_string (const char *str
)
3525 return make_pure_c_string (str
, strlen (str
));
3528 /* Make a string from the data at STR, treating it as multibyte if the
3531 LISP_INLINE Lisp_Object
3532 build_string (const char *str
)
3534 return make_string (str
, strlen (str
));
3537 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3538 extern void make_byte_code (struct Lisp_Vector
*);
3539 extern Lisp_Object Qautomatic_gc
;
3540 extern Lisp_Object Qchar_table_extra_slots
;
3541 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3543 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3544 be sure that GC cannot happen until the vector is completely
3545 initialized. E.g. the following code is likely to crash:
3547 v = make_uninit_vector (3);
3549 ASET (v, 1, Ffunction_can_gc ());
3550 ASET (v, 2, obj1); */
3552 LISP_INLINE Lisp_Object
3553 make_uninit_vector (ptrdiff_t size
)
3556 struct Lisp_Vector
*p
;
3558 p
= allocate_vector (size
);
3563 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3564 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3566 allocate_pseudovector \
3567 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3568 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3569 extern struct window
*allocate_window (void);
3570 extern struct frame
*allocate_frame (void);
3571 extern struct Lisp_Process
*allocate_process (void);
3572 extern struct terminal
*allocate_terminal (void);
3573 extern bool gc_in_progress
;
3574 extern bool abort_on_gc
;
3575 extern Lisp_Object
make_float (double);
3576 extern void display_malloc_warning (void);
3577 extern ptrdiff_t inhibit_garbage_collection (void);
3578 extern Lisp_Object
make_save_value (enum Lisp_Save_Type
, ...);
3579 extern Lisp_Object
make_save_pointer (void *);
3580 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3581 extern void free_marker (Lisp_Object
);
3582 extern void free_cons (struct Lisp_Cons
*);
3583 extern void init_alloc_once (void);
3584 extern void init_alloc (void);
3585 extern void syms_of_alloc (void);
3586 extern struct buffer
* allocate_buffer (void);
3587 extern int valid_lisp_object_p (Lisp_Object
);
3588 #ifdef GC_CHECK_CONS_LIST
3589 extern void check_cons_list (void);
3591 LISP_INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3595 /* Defined in ralloc.c. */
3596 extern void *r_alloc (void **, size_t);
3597 extern void r_alloc_free (void **);
3598 extern void *r_re_alloc (void **, size_t);
3599 extern void r_alloc_reset_variable (void **, void **);
3600 extern void r_alloc_inhibit_buffer_relocation (int);
3603 /* Defined in chartab.c. */
3604 extern Lisp_Object
copy_char_table (Lisp_Object
);
3605 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
3606 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3608 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
3609 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3610 extern int char_table_translate (Lisp_Object
, int);
3611 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3613 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3614 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3615 Lisp_Object
, Lisp_Object
,
3616 Lisp_Object
, struct charset
*,
3617 unsigned, unsigned);
3618 extern Lisp_Object
uniprop_table (Lisp_Object
);
3619 extern void syms_of_chartab (void);
3621 /* Defined in print.c. */
3622 extern Lisp_Object Vprin1_to_string_buffer
;
3623 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3624 extern Lisp_Object Qstandard_output
;
3625 extern Lisp_Object Qexternal_debugging_output
;
3626 extern void temp_output_buffer_setup (const char *);
3627 extern int print_level
;
3628 extern Lisp_Object Qprint_escape_newlines
;
3629 extern void write_string (const char *, int);
3630 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3632 extern Lisp_Object internal_with_output_to_temp_buffer
3633 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3634 enum FLOAT_TO_STRING_BUFSIZE
{ FLOAT_TO_STRING_BUFSIZE
= 350 };
3635 extern int float_to_string (char *, double);
3636 extern void init_print_once (void);
3637 extern void syms_of_print (void);
3639 /* Defined in doprnt.c. */
3640 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3642 extern ptrdiff_t esprintf (char *, char const *, ...)
3643 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3644 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3646 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3647 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3648 char const *, va_list)
3649 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3651 /* Defined in lread.c. */
3652 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3653 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3654 extern Lisp_Object Qlexical_binding
;
3655 extern Lisp_Object
check_obarray (Lisp_Object
);
3656 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3657 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3658 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3660 LOADHIST_ATTACH (Lisp_Object x
)
3663 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3665 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3666 Lisp_Object
*, Lisp_Object
);
3667 extern Lisp_Object
string_to_number (char const *, int, bool);
3668 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3670 extern void dir_warning (const char *, Lisp_Object
);
3671 extern void init_obarray (void);
3672 extern void init_lread (void);
3673 extern void syms_of_lread (void);
3675 LISP_INLINE Lisp_Object
3676 intern (const char *str
)
3678 return intern_1 (str
, strlen (str
));
3681 LISP_INLINE Lisp_Object
3682 intern_c_string (const char *str
)
3684 return intern_c_string_1 (str
, strlen (str
));
3687 /* Defined in eval.c. */
3688 extern Lisp_Object Qautoload
, Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3689 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3690 extern Lisp_Object Qand_rest
;
3691 extern Lisp_Object Vautoload_queue
;
3692 extern Lisp_Object Vsignaling_function
;
3693 extern Lisp_Object inhibit_lisp_code
;
3695 extern struct catchtag
*catchlist
;
3696 extern struct handler
*handlerlist
;
3698 /* To run a normal hook, use the appropriate function from the list below.
3699 The calling convention:
3701 if (!NILP (Vrun_hooks))
3702 call1 (Vrun_hooks, Qmy_funny_hook);
3704 should no longer be used. */
3705 extern Lisp_Object Vrun_hooks
;
3706 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3707 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3708 Lisp_Object (*funcall
)
3709 (ptrdiff_t nargs
, Lisp_Object
*args
));
3710 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3711 extern _Noreturn
void xsignal0 (Lisp_Object
);
3712 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3713 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3714 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3716 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3717 extern Lisp_Object
eval_sub (Lisp_Object form
);
3718 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3719 extern Lisp_Object
call0 (Lisp_Object
);
3720 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3721 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3722 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3723 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3724 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3725 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3726 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3727 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3728 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3729 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3730 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3731 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3732 extern Lisp_Object internal_condition_case_n
3733 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3734 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3735 extern void specbind (Lisp_Object
, Lisp_Object
);
3736 extern void record_unwind_protect (Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3737 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3738 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3739 extern _Noreturn
void verror (const char *, va_list)
3740 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3741 extern Lisp_Object
un_autoload (Lisp_Object
);
3742 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3743 extern void init_eval_once (void);
3744 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3745 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3746 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3747 extern void init_eval (void);
3748 extern void syms_of_eval (void);
3749 extern void record_in_backtrace (Lisp_Object function
,
3750 Lisp_Object
*args
, ptrdiff_t nargs
);
3751 extern void mark_specpdl (void);
3752 extern void get_backtrace (Lisp_Object array
);
3753 Lisp_Object
backtrace_top_function (void);
3754 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3755 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3758 /* Defined in editfns.c. */
3759 extern Lisp_Object Qfield
;
3760 extern void insert1 (Lisp_Object
);
3761 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3762 extern Lisp_Object
save_excursion_save (void);
3763 extern Lisp_Object
save_restriction_save (void);
3764 extern Lisp_Object
save_excursion_restore (Lisp_Object
);
3765 extern Lisp_Object
save_restriction_restore (Lisp_Object
);
3766 extern _Noreturn
void time_overflow (void);
3767 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3768 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3770 extern void init_editfns (void);
3771 extern void syms_of_editfns (void);
3772 extern void set_time_zone_rule (const char *);
3774 /* Defined in buffer.c. */
3775 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3776 extern _Noreturn
void nsberror (Lisp_Object
);
3777 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3778 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3779 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3780 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3781 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3782 extern bool overlay_touches_p (ptrdiff_t);
3783 extern Lisp_Object Vbuffer_alist
;
3784 extern Lisp_Object
set_buffer_if_live (Lisp_Object
);
3785 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3786 extern Lisp_Object Qpriority
, Qwindow
, Qbefore_string
, Qafter_string
;
3787 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3788 extern void init_buffer_once (void);
3789 extern void init_buffer (void);
3790 extern void syms_of_buffer (void);
3791 extern void keys_of_buffer (void);
3793 /* Defined in marker.c. */
3795 extern ptrdiff_t marker_position (Lisp_Object
);
3796 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3797 extern void clear_charpos_cache (struct buffer
*);
3798 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3799 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3800 extern void unchain_marker (struct Lisp_Marker
*marker
);
3801 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3802 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3803 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3804 ptrdiff_t, ptrdiff_t);
3805 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3806 extern void syms_of_marker (void);
3808 /* Defined in fileio.c. */
3810 extern Lisp_Object Qfile_error
;
3811 extern Lisp_Object Qfile_notify_error
;
3812 extern Lisp_Object Qfile_exists_p
;
3813 extern Lisp_Object Qfile_directory_p
;
3814 extern Lisp_Object Qinsert_file_contents
;
3815 extern Lisp_Object Qfile_name_history
;
3816 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3817 EXFUN (Fread_file_name
, 6); /* Not a normal DEFUN. */
3818 extern Lisp_Object
close_file_unwind (Lisp_Object
);
3819 extern Lisp_Object
restore_point_unwind (Lisp_Object
);
3820 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3821 extern bool internal_delete_file (Lisp_Object
);
3822 extern Lisp_Object
emacs_readlinkat (int, const char *);
3823 extern bool file_directory_p (const char *);
3824 extern bool file_accessible_directory_p (const char *);
3825 extern void init_fileio (void);
3826 extern void syms_of_fileio (void);
3827 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3828 extern Lisp_Object Qdelete_file
;
3829 extern bool check_existing (const char *);
3831 /* Defined in search.c. */
3832 extern void shrink_regexp_cache (void);
3833 extern void restore_search_regs (void);
3834 extern void record_unwind_save_match_data (void);
3835 struct re_registers
;
3836 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3837 struct re_registers
*,
3838 Lisp_Object
, bool, bool);
3839 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3840 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3842 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3843 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3844 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3845 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3846 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3847 extern EMACS_INT
scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3849 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3850 ptrdiff_t, ptrdiff_t *);
3851 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3852 ptrdiff_t, ptrdiff_t *);
3853 extern void syms_of_search (void);
3854 extern void clear_regexp_cache (void);
3856 /* Defined in minibuf.c. */
3858 extern Lisp_Object Qcompletion_ignore_case
;
3859 extern Lisp_Object Vminibuffer_list
;
3860 extern Lisp_Object last_minibuf_string
;
3861 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3862 extern void init_minibuf_once (void);
3863 extern void syms_of_minibuf (void);
3865 /* Defined in callint.c. */
3867 extern Lisp_Object Qminus
, Qplus
;
3868 extern Lisp_Object Qwhen
;
3869 extern Lisp_Object Qmouse_leave_buffer_hook
;
3870 extern void syms_of_callint (void);
3872 /* Defined in casefiddle.c. */
3874 extern Lisp_Object Qidentity
;
3875 extern void syms_of_casefiddle (void);
3876 extern void keys_of_casefiddle (void);
3878 /* Defined in casetab.c. */
3880 extern void init_casetab_once (void);
3881 extern void syms_of_casetab (void);
3883 /* Defined in keyboard.c. */
3885 extern Lisp_Object echo_message_buffer
;
3886 extern struct kboard
*echo_kboard
;
3887 extern void cancel_echoing (void);
3888 extern Lisp_Object Qdisabled
, QCfilter
;
3889 extern Lisp_Object Qup
, Qdown
, Qbottom
;
3890 extern Lisp_Object Qtop
;
3891 extern Lisp_Object last_undo_boundary
;
3892 extern bool input_pending
;
3893 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3894 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3895 extern void discard_mouse_events (void);
3897 void handle_input_available_signal (int);
3899 extern Lisp_Object pending_funcalls
;
3900 extern bool detect_input_pending (void);
3901 extern bool detect_input_pending_ignore_squeezables (void);
3902 extern bool detect_input_pending_run_timers (bool);
3903 extern void safe_run_hooks (Lisp_Object
);
3904 extern void cmd_error_internal (Lisp_Object
, const char *);
3905 extern Lisp_Object
command_loop_1 (void);
3906 extern Lisp_Object
recursive_edit_1 (void);
3907 extern void record_auto_save (void);
3908 extern void force_auto_save_soon (void);
3909 extern void init_keyboard (void);
3910 extern void syms_of_keyboard (void);
3911 extern void keys_of_keyboard (void);
3913 /* Defined in indent.c. */
3914 extern ptrdiff_t current_column (void);
3915 extern void invalidate_current_column (void);
3916 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3917 extern void syms_of_indent (void);
3919 /* Defined in frame.c. */
3920 extern Lisp_Object Qonly
, Qnone
;
3921 extern Lisp_Object Qvisible
;
3922 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3923 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3924 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3925 #if HAVE_NS || defined WINDOWSNT
3926 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3928 extern void frames_discard_buffer (Lisp_Object
);
3929 extern void syms_of_frame (void);
3931 /* Defined in emacs.c. */
3932 extern char **initial_argv
;
3933 extern int initial_argc
;
3934 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3935 extern bool display_arg
;
3937 extern Lisp_Object
decode_env_path (const char *, const char *);
3938 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3939 extern Lisp_Object Qfile_name_handler_alist
;
3940 extern _Noreturn
void terminate_due_to_signal (int, int);
3941 extern Lisp_Object Qkill_emacs
;
3943 extern Lisp_Object Vlibrary_cache
;
3946 void fixup_locale (void);
3947 void synchronize_system_messages_locale (void);
3948 void synchronize_system_time_locale (void);
3950 LISP_INLINE
void fixup_locale (void) {}
3951 LISP_INLINE
void synchronize_system_messages_locale (void) {}
3952 LISP_INLINE
void synchronize_system_time_locale (void) {}
3954 extern void shut_down_emacs (int, Lisp_Object
);
3956 /* True means don't do interactive redisplay and don't change tty modes. */
3957 extern bool noninteractive
;
3959 /* True means remove site-lisp directories from load-path. */
3960 extern bool no_site_lisp
;
3962 /* Pipe used to send exit notification to the daemon parent at
3964 extern int daemon_pipe
[2];
3965 #define IS_DAEMON (daemon_pipe[1] != 0)
3967 /* True if handling a fatal error already. */
3968 extern bool fatal_error_in_progress
;
3970 /* True means don't do use window-system-specific display code. */
3971 extern bool inhibit_window_system
;
3972 /* True means that a filter or a sentinel is running. */
3973 extern bool running_asynch_code
;
3975 /* Defined in process.c. */
3976 extern Lisp_Object QCtype
, Qlocal
;
3977 extern Lisp_Object Qprocessp
;
3978 extern void kill_buffer_processes (Lisp_Object
);
3979 extern bool wait_reading_process_output (intmax_t, int, int, bool,
3981 struct Lisp_Process
*,
3983 /* Max value for the first argument of wait_reading_process_output. */
3984 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3985 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3986 The bug merely causes a bogus warning, but the warning is annoying. */
3987 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3989 # define WAIT_READING_MAX INTMAX_MAX
3991 extern void add_keyboard_wait_descriptor (int);
3992 extern void delete_keyboard_wait_descriptor (int);
3994 extern void add_gpm_wait_descriptor (int);
3995 extern void delete_gpm_wait_descriptor (int);
3997 extern void init_process_emacs (void);
3998 extern void syms_of_process (void);
3999 extern void setup_process_coding_systems (Lisp_Object
);
4004 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
4005 extern void init_callproc_1 (void);
4006 extern void init_callproc (void);
4007 extern void set_initial_environment (void);
4008 extern void syms_of_callproc (void);
4010 /* Defined in doc.c. */
4011 extern Lisp_Object Qfunction_documentation
;
4012 extern Lisp_Object
read_doc_string (Lisp_Object
);
4013 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4014 extern void syms_of_doc (void);
4015 extern int read_bytecode_char (bool);
4017 /* Defined in bytecode.c. */
4018 extern void syms_of_bytecode (void);
4019 extern struct byte_stack
*byte_stack_list
;
4021 extern void mark_byte_stack (void);
4023 extern void unmark_byte_stack (void);
4024 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4025 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4027 /* Defined in macros.c. */
4028 extern void init_macros (void);
4029 extern void syms_of_macros (void);
4031 /* Defined in undo.c. */
4032 extern Lisp_Object Qapply
;
4033 extern Lisp_Object Qinhibit_read_only
;
4034 extern void truncate_undo_list (struct buffer
*);
4035 extern void record_marker_adjustment (Lisp_Object
, ptrdiff_t);
4036 extern void record_insert (ptrdiff_t, ptrdiff_t);
4037 extern void record_delete (ptrdiff_t, Lisp_Object
);
4038 extern void record_first_change (void);
4039 extern void record_change (ptrdiff_t, ptrdiff_t);
4040 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4041 Lisp_Object
, Lisp_Object
,
4043 extern void syms_of_undo (void);
4044 /* Defined in textprop.c. */
4045 extern Lisp_Object Qfont
, Qmouse_face
;
4046 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
4047 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
4048 extern Lisp_Object Qminibuffer_prompt
;
4050 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4052 /* Defined in menu.c. */
4053 extern void syms_of_menu (void);
4055 /* Defined in xmenu.c. */
4056 extern void syms_of_xmenu (void);
4058 /* Defined in termchar.h. */
4059 struct tty_display_info
;
4061 /* Defined in termhooks.h. */
4064 /* Defined in sysdep.c. */
4065 #ifndef HAVE_GET_CURRENT_DIR_NAME
4066 extern char *get_current_dir_name (void);
4068 extern void stuff_char (char c
);
4069 extern void init_foreground_group (void);
4070 extern void init_sigio (int);
4071 extern void sys_subshell (void);
4072 extern void sys_suspend (void);
4073 extern void discard_tty_input (void);
4074 extern void block_tty_out_signal (void);
4075 extern void unblock_tty_out_signal (void);
4076 extern void init_sys_modes (struct tty_display_info
*);
4077 extern void reset_sys_modes (struct tty_display_info
*);
4078 extern void init_all_sys_modes (void);
4079 extern void reset_all_sys_modes (void);
4080 extern void flush_pending_output (int) ATTRIBUTE_CONST
;
4081 extern void child_setup_tty (int);
4082 extern void setup_pty (int);
4083 extern int set_window_size (int, int, int);
4084 extern EMACS_INT
get_random (void);
4085 extern void seed_random (void *, ptrdiff_t);
4086 extern void init_random (void);
4087 extern void emacs_backtrace (int);
4088 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4089 extern int emacs_open (const char *, int, int);
4090 extern int emacs_close (int);
4091 extern ptrdiff_t emacs_read (int, char *, ptrdiff_t);
4092 extern ptrdiff_t emacs_write (int, const char *, ptrdiff_t);
4094 extern void unlock_all_files (void);
4095 extern void lock_file (Lisp_Object
);
4096 extern void unlock_file (Lisp_Object
);
4097 extern void unlock_buffer (struct buffer
*);
4098 extern void syms_of_filelock (void);
4100 /* Defined in sound.c. */
4101 extern void syms_of_sound (void);
4103 /* Defined in category.c. */
4104 extern void init_category_once (void);
4105 extern Lisp_Object
char_category_set (int);
4106 extern void syms_of_category (void);
4108 /* Defined in ccl.c. */
4109 extern void syms_of_ccl (void);
4111 /* Defined in dired.c. */
4112 extern void syms_of_dired (void);
4113 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4114 Lisp_Object
, Lisp_Object
,
4117 /* Defined in term.c. */
4118 extern int *char_ins_del_vector
;
4119 extern void syms_of_term (void);
4120 extern _Noreturn
void fatal (const char *msgid
, ...)
4121 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4123 /* Defined in terminal.c. */
4124 extern void syms_of_terminal (void);
4126 /* Defined in font.c. */
4127 extern void syms_of_font (void);
4128 extern void init_font (void);
4130 #ifdef HAVE_WINDOW_SYSTEM
4131 /* Defined in fontset.c. */
4132 extern void syms_of_fontset (void);
4134 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4135 extern Lisp_Object Qfont_param
;
4138 /* Defined in gfilenotify.c */
4139 #ifdef HAVE_GFILENOTIFY
4140 extern void globals_of_gfilenotify (void);
4141 extern void syms_of_gfilenotify (void);
4144 /* Defined in inotify.c */
4146 extern void syms_of_inotify (void);
4149 #ifdef HAVE_W32NOTIFY
4150 /* Defined on w32notify.c. */
4151 extern void syms_of_w32notify (void);
4154 /* Defined in xfaces.c. */
4155 extern Lisp_Object Qdefault
, Qtool_bar
, Qfringe
;
4156 extern Lisp_Object Qheader_line
, Qscroll_bar
, Qcursor
;
4157 extern Lisp_Object Qmode_line_inactive
;
4158 extern Lisp_Object Qface
;
4159 extern Lisp_Object Qnormal
;
4160 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4161 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4162 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4163 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4164 extern Lisp_Object Qoblique
, Qitalic
;
4165 extern Lisp_Object Vface_alternative_font_family_alist
;
4166 extern Lisp_Object Vface_alternative_font_registry_alist
;
4167 extern void syms_of_xfaces (void);
4169 #ifdef HAVE_X_WINDOWS
4170 /* Defined in xfns.c. */
4171 extern void syms_of_xfns (void);
4173 /* Defined in xsmfns.c. */
4174 extern void syms_of_xsmfns (void);
4176 /* Defined in xselect.c. */
4177 extern void syms_of_xselect (void);
4179 /* Defined in xterm.c. */
4180 extern void syms_of_xterm (void);
4181 #endif /* HAVE_X_WINDOWS */
4183 #ifdef HAVE_WINDOW_SYSTEM
4184 /* Defined in xterm.c, nsterm.m, w32term.c. */
4185 extern char *x_get_keysym_name (int);
4186 #endif /* HAVE_WINDOW_SYSTEM */
4189 /* Defined in xml.c. */
4190 extern void syms_of_xml (void);
4191 extern void xml_cleanup_parser (void);
4195 /* Defined in dbusbind.c. */
4196 void syms_of_dbusbind (void);
4200 /* Defined in profiler.c. */
4201 extern bool profiler_memory_running
;
4202 extern void malloc_probe (size_t);
4203 extern void syms_of_profiler (void);
4207 /* Defined in msdos.c, w32.c. */
4208 extern char *emacs_root_dir (void);
4211 /* True means Emacs has already been initialized.
4212 Used during startup to detect startup of dumped Emacs. */
4213 extern bool initialized
;
4215 /* True means ^G can quit instantly. */
4216 extern bool immediate_quit
;
4218 extern void *xmalloc (size_t);
4219 extern void *xzalloc (size_t);
4220 extern void *xrealloc (void *, size_t);
4221 extern void xfree (void *);
4222 extern void *xnmalloc (ptrdiff_t, ptrdiff_t);
4223 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t);
4224 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4226 extern char *xstrdup (const char *);
4227 extern void xputenv (const char *);
4229 extern char *egetenv (const char *);
4231 /* Set up the name of the machine we're running on. */
4232 extern void init_system_name (void);
4234 /* Return the absolute value of X. X should be a signed integer
4235 expression without side effects, and X's absolute value should not
4236 exceed the maximum for its promoted type. This is called 'eabs'
4237 because 'abs' is reserved by the C standard. */
4238 #define eabs(x) ((x) < 0 ? -(x) : (x))
4240 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4243 #define make_fixnum_or_float(val) \
4244 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4246 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4247 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4249 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4251 extern Lisp_Object
safe_alloca_unwind (Lisp_Object
);
4252 extern void *record_xmalloc (size_t);
4254 #define USE_SAFE_ALLOCA \
4255 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = 0
4257 /* SAFE_ALLOCA allocates a simple buffer. */
4259 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4261 : (sa_must_free = 1, record_xmalloc (size)))
4263 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4264 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4265 positive. The code is tuned for MULTIPLIER being a constant. */
4267 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4269 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4270 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4273 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4275 record_unwind_protect (safe_alloca_unwind, \
4276 make_save_pointer (buf)); \
4280 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4282 #define SAFE_FREE() \
4284 if (sa_must_free) { \
4286 unbind_to (sa_count, Qnil); \
4291 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4293 #define SAFE_ALLOCA_LISP(buf, nelt) \
4295 if ((nelt) < MAX_ALLOCA / word_size) \
4296 buf = alloca ((nelt) * word_size); \
4297 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4300 buf = xmalloc ((nelt) * word_size); \
4301 arg_ = make_save_value (SAVE_TYPE_MEMORY, buf, nelt); \
4303 record_unwind_protect (safe_alloca_unwind, arg_); \
4306 memory_full (SIZE_MAX); \
4310 /* Check whether it's time for GC, and run it if so. */
4315 if ((consing_since_gc
> gc_cons_threshold
4316 && consing_since_gc
> gc_relative_threshold
)
4317 || (!NILP (Vmemory_full
)
4318 && consing_since_gc
> memory_full_cons_threshold
))
4319 Fgarbage_collect ();
4323 functionp (Lisp_Object object
)
4325 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4327 object
= Findirect_function (object
, Qt
);
4329 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4331 /* Autoloaded symbols are functions, except if they load
4332 macros or keymaps. */
4334 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4335 object
= XCDR (object
);
4337 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4342 return XSUBR (object
)->max_args
!= UNEVALLED
;
4343 else if (COMPILEDP (object
))
4345 else if (CONSP (object
))
4347 Lisp_Object car
= XCAR (object
);
4348 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4356 #endif /* EMACS_LISP_H */