1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 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 a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
101 #ifndef EMACS_INT_MAX
103 # error "INTPTR_MAX misconfigured"
104 # elif INTPTR_MAX <= INT_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
105 typedef int EMACS_INT
;
106 typedef unsigned int EMACS_UINT
;
107 # define EMACS_INT_MAX INT_MAX
109 # elif INTPTR_MAX <= LONG_MAX >> NONPOINTER_BITS && !defined WIDE_EMACS_INT
110 typedef long int EMACS_INT
;
111 typedef unsigned long EMACS_UINT
;
112 # define EMACS_INT_MAX LONG_MAX
114 /* Check versus LLONG_MAX, not LLONG_MAX >> NONPOINTER_BITS.
115 In theory this is not safe, but in practice it seems to be OK. */
116 # elif INTPTR_MAX <= LLONG_MAX
117 typedef long long int EMACS_INT
;
118 typedef unsigned long long int EMACS_UINT
;
119 # define EMACS_INT_MAX LLONG_MAX
122 # error "INTPTR_MAX too large"
126 /* Number of bits to put in each character in the internal representation
127 of bool vectors. This should not vary across implementations. */
128 enum { BOOL_VECTOR_BITS_PER_CHAR
=
129 #define BOOL_VECTOR_BITS_PER_CHAR 8
130 BOOL_VECTOR_BITS_PER_CHAR
133 /* An unsigned integer type representing a fixed-length bit sequence,
134 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
135 for speed, but it is unsigned char on weird platforms. */
136 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
137 typedef size_t bits_word
;
138 # define BITS_WORD_MAX SIZE_MAX
139 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
141 typedef unsigned char bits_word
;
142 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
143 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
145 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
147 /* Number of bits in some machine integer types. */
150 BITS_PER_CHAR
= CHAR_BIT
,
151 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
152 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
153 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
156 /* printmax_t and uprintmax_t are types for printing large integers.
157 These are the widest integers that are supported for printing.
158 pMd etc. are conversions for printing them.
159 On C99 hosts, there's no problem, as even the widest integers work.
160 Fall back on EMACS_INT on pre-C99 hosts. */
162 typedef intmax_t printmax_t
;
163 typedef uintmax_t uprintmax_t
;
167 typedef EMACS_INT printmax_t
;
168 typedef EMACS_UINT uprintmax_t
;
173 /* Use pD to format ptrdiff_t values, which suffice for indexes into
174 buffers and strings. Emacs never allocates objects larger than
175 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
176 In C99, pD can always be "t"; configure it here for the sake of
177 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
178 #if PTRDIFF_MAX == INT_MAX
180 #elif PTRDIFF_MAX == LONG_MAX
182 #elif PTRDIFF_MAX == LLONG_MAX
188 /* Extra internal type checking? */
190 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
191 'assume (COND)'. COND should be free of side effects, as it may or
192 may not be evaluated.
194 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
195 defined and suppress_checking is false, and does nothing otherwise.
196 Emacs dies if COND is checked and is false. The suppress_checking
197 variable is initialized to 0 in alloc.c. Set it to 1 using a
198 debugger to temporarily disable aborting on detected internal
199 inconsistencies or error conditions.
201 In some cases, a good compiler may be able to optimize away the
202 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
203 uses eassert to test STRINGP (x), but a particular use of XSTRING
204 is invoked only after testing that STRINGP (x) is true, making the
207 eassume is like eassert except that it also causes the compiler to
208 assume that COND is true afterwards, regardless of whether runtime
209 checking is enabled. This can improve performance in some cases,
210 though it can degrade performance in others. It's often suboptimal
211 for COND to call external functions or access volatile storage. */
213 #ifndef ENABLE_CHECKING
214 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
215 # define eassume(cond) assume (cond)
216 #else /* ENABLE_CHECKING */
218 extern _Noreturn
void die (const char *, const char *, int);
220 extern bool suppress_checking EXTERNALLY_VISIBLE
;
222 # define eassert(cond) \
223 (suppress_checking || (cond) \
225 : die (# cond, __FILE__, __LINE__))
226 # define eassume(cond) \
231 : die (# cond, __FILE__, __LINE__))
232 #endif /* ENABLE_CHECKING */
235 /* Use the configure flag --enable-check-lisp-object-type to make
236 Lisp_Object use a struct type instead of the default int. The flag
237 causes CHECK_LISP_OBJECT_TYPE to be defined. */
239 /***** Select the tagging scheme. *****/
240 /* The following option controls the tagging scheme:
241 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
242 always 0, and we can thus use them to hold tag bits, without
243 restricting our addressing space.
245 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
246 restricting our possible address range.
248 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
249 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
250 on the few static Lisp_Objects used: all the defsubr as well
251 as the two special buffers buffer_defaults and buffer_local_symbols. */
255 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
256 integer constant, for MSVC. */
257 #define GCALIGNMENT 8
259 /* Number of bits in a Lisp_Object value, not counting the tag. */
260 VALBITS
= BITS_PER_EMACS_INT
- GCTYPEBITS
,
262 /* Number of bits in a Lisp fixnum tag. */
263 INTTYPEBITS
= GCTYPEBITS
- 1,
265 /* Number of bits in a Lisp fixnum value, not counting the tag. */
266 FIXNUM_BITS
= VALBITS
+ 1
269 #if GCALIGNMENT != 1 << GCTYPEBITS
270 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
273 /* The maximum value that can be stored in a EMACS_INT, assuming all
274 bits other than the type bits contribute to a nonnegative signed value.
275 This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below. */
276 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
278 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
279 #define USE_LSB_TAG 1
280 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
283 # define alignas(alignment) /* empty */
285 # error "USE_LSB_TAG requires alignas"
289 /* Some operations are so commonly executed that they are implemented
290 as macros, not functions, because otherwise runtime performance would
291 suffer too much when compiling with GCC without optimization.
292 There's no need to inline everything, just the operations that
293 would otherwise cause a serious performance problem.
295 For each such operation OP, define a macro lisp_h_OP that contains
296 the operation's implementation. That way, OP can be implemented
297 via a macro definition like this:
299 #define OP(x) lisp_h_OP (x)
301 and/or via a function definition like this:
303 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
305 which macro-expands to this:
307 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
309 without worrying about the implementations diverging, since
310 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
311 are intended to be private to this include file, and should not be
314 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
315 functions, once most developers have access to GCC 4.8 or later and
316 can use "gcc -Og" to debug. Maybe in the year 2016. See
319 Commentary for these macros can be found near their corresponding
322 #if CHECK_LISP_OBJECT_TYPE
323 # define lisp_h_XLI(o) ((o).i)
324 # define lisp_h_XIL(i) ((Lisp_Object) { i })
326 # define lisp_h_XLI(o) (o)
327 # define lisp_h_XIL(i) (i)
329 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
330 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
331 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
332 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
333 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
334 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
335 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
336 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
337 #define lisp_h_INTEGERP(x) ((XTYPE (x) & ~Lisp_Int1) == 0)
338 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
339 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
340 #define lisp_h_NILP(x) EQ (x, Qnil)
341 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
342 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
343 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
344 #define lisp_h_SYMBOL_VAL(sym) \
345 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
346 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
347 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
348 #define lisp_h_XCAR(c) XCONS (c)->car
349 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
350 #define lisp_h_XCONS(a) \
351 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
352 #define lisp_h_XHASH(a) XUINT (a)
353 #define lisp_h_XPNTR(a) ((void *) (intptr_t) (XLI (a) & VALMASK))
354 #define lisp_h_XSYMBOL(a) \
355 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
357 # define lisp_h_make_number(n) \
358 XIL ((EMACS_INT) ((EMACS_UINT) (n) << INTTYPEBITS))
359 # define lisp_h_XFASTINT(a) XINT (a)
360 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
361 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
362 # define lisp_h_XUNTAG(a, type) ((void *) (XLI (a) - (type)))
365 /* When compiling via gcc -O0, define the key operations as macros, as
366 Emacs is too slow otherwise. To disable this optimization, compile
367 with -DINLINING=false. */
368 #if (defined __NO_INLINE__ \
369 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
370 && ! (defined INLINING && ! INLINING))
371 # define XLI(o) lisp_h_XLI (o)
372 # define XIL(i) lisp_h_XIL (i)
373 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
374 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
375 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
376 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
377 # define CONSP(x) lisp_h_CONSP (x)
378 # define EQ(x, y) lisp_h_EQ (x, y)
379 # define FLOATP(x) lisp_h_FLOATP (x)
380 # define INTEGERP(x) lisp_h_INTEGERP (x)
381 # define MARKERP(x) lisp_h_MARKERP (x)
382 # define MISCP(x) lisp_h_MISCP (x)
383 # define NILP(x) lisp_h_NILP (x)
384 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
385 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
386 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
387 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
388 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
389 # define XCAR(c) lisp_h_XCAR (c)
390 # define XCDR(c) lisp_h_XCDR (c)
391 # define XCONS(a) lisp_h_XCONS (a)
392 # define XHASH(a) lisp_h_XHASH (a)
393 # define XPNTR(a) lisp_h_XPNTR (a)
394 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
396 # define make_number(n) lisp_h_make_number (n)
397 # define XFASTINT(a) lisp_h_XFASTINT (a)
398 # define XINT(a) lisp_h_XINT (a)
399 # define XTYPE(a) lisp_h_XTYPE (a)
400 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
404 /* Define NAME as a lisp.h inline function that returns TYPE and has
405 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
406 ARGS should be parenthesized. Implement the function by calling
408 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
409 INLINE type (name) argdecls { return lisp_h_##name args; }
411 /* like LISP_MACRO_DEFUN, except NAME returns void. */
412 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
413 INLINE void (name) argdecls { lisp_h_##name args; }
416 /* Define the fundamental Lisp data structures. */
418 /* This is the set of Lisp data types. If you want to define a new
419 data type, read the comments after Lisp_Fwd_Type definition
422 /* Lisp integers use 2 tags, to give them one extra bit, thus
423 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
424 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
425 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
427 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
428 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
429 vociferously about them. */
430 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
431 || (defined __SUNPRO_C && __STDC__))
432 #define ENUM_BF(TYPE) unsigned int
434 #define ENUM_BF(TYPE) enum TYPE
440 /* Integer. XINT (obj) is the integer value. */
442 Lisp_Int1
= USE_LSB_TAG
? 1 << INTTYPEBITS
: 1,
444 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
447 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
448 whose first member indicates the subtype. */
451 /* String. XSTRING (object) points to a struct Lisp_String.
452 The length of the string, and its contents, are stored therein. */
453 Lisp_String
= USE_LSB_TAG
? 1 : 1 << INTTYPEBITS
,
455 /* Vector of Lisp objects, or something resembling it.
456 XVECTOR (object) points to a struct Lisp_Vector, which contains
457 the size and contents. The size field also contains the type
458 information, if it's not a real vector object. */
461 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
467 /* This is the set of data types that share a common structure.
468 The first member of the structure is a type code from this set.
469 The enum values are arbitrary, but we'll use large numbers to make it
470 more likely that we'll spot the error if a random word in memory is
471 mistakenly interpreted as a Lisp_Misc. */
474 Lisp_Misc_Free
= 0x5eab,
477 Lisp_Misc_Save_Value
,
478 /* Currently floats are not a misc type,
479 but let's define this in case we want to change that. */
481 /* This is not a type code. It is for range checking. */
485 /* These are the types of forwarding objects used in the value slot
486 of symbols for special built-in variables whose value is stored in
490 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
491 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
492 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
493 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
494 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
497 /* If you want to define a new Lisp data type, here are some
498 instructions. See the thread at
499 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
502 First, there are already a couple of Lisp types that can be used if
503 your new type does not need to be exposed to Lisp programs nor
504 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
505 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
506 is suitable for temporarily stashing away pointers and integers in
507 a Lisp object. The latter is useful for vector-like Lisp objects
508 that need to be used as part of other objects, but which are never
509 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
512 These two types don't look pretty when printed, so they are
513 unsuitable for Lisp objects that can be exposed to users.
515 To define a new data type, add one more Lisp_Misc subtype or one
516 more pseudovector subtype. Pseudovectors are more suitable for
517 objects with several slots that need to support fast random access,
518 while Lisp_Misc types are for everything else. A pseudovector object
519 provides one or more slots for Lisp objects, followed by struct
520 members that are accessible only from C. A Lisp_Misc object is a
521 wrapper for a C struct that can contain anything you like.
523 Explicit freeing is discouraged for Lisp objects in general. But if
524 you really need to exploit this, use Lisp_Misc (check free_misc in
525 alloc.c to see why). There is no way to free a vectorlike object.
527 To add a new pseudovector type, extend the pvec_type enumeration;
528 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
530 For a Lisp_Misc, you will also need to add your entry to union
531 Lisp_Misc (but make sure the first word has the same structure as
532 the others, starting with a 16-bit member of the Lisp_Misc_Type
533 enumeration and a 1-bit GC markbit) and make sure the overall size
534 of the union is not increased by your addition.
536 For a new pseudovector, it's highly desirable to limit the size
537 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
538 Otherwise you will need to change sweep_vectors (also in alloc.c).
540 Then you will need to add switch branches in print.c (in
541 print_object, to print your object, and possibly also in
542 print_preprocess) and to alloc.c, to mark your object (in
543 mark_object) and to free it (in gc_sweep). The latter is also the
544 right place to call any code specific to your data type that needs
545 to run when the object is recycled -- e.g., free any additional
546 resources allocated for it that are not Lisp objects. You can even
547 make a pointer to the function that frees the resources a slot in
548 your object -- this way, the same object could be used to represent
549 several disparate C structures. */
551 #ifdef CHECK_LISP_OBJECT_TYPE
553 typedef struct { EMACS_INT i
; } Lisp_Object
;
555 #define LISP_INITIALLY_ZERO {0}
557 #undef CHECK_LISP_OBJECT_TYPE
558 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
559 #else /* CHECK_LISP_OBJECT_TYPE */
561 /* If a struct type is not wanted, define Lisp_Object as just a number. */
563 typedef EMACS_INT Lisp_Object
;
564 #define LISP_INITIALLY_ZERO 0
565 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
566 #endif /* CHECK_LISP_OBJECT_TYPE */
568 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
569 At the machine level, these operations are no-ops. */
570 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
571 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
573 /* In the size word of a struct Lisp_Vector, this bit means it's really
574 some other vector-like object. */
575 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
576 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
577 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
579 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
580 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
581 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
584 /* In a pseudovector, the size field actually contains a word with one
585 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
586 with PVEC_TYPE_MASK to indicate the actual type. */
598 PVEC_WINDOW_CONFIGURATION
,
601 /* These should be last, check internal_equal to see why. */
605 PVEC_FONT
/* Should be last because it's used for range checking. */
610 /* For convenience, we also store the number of elements in these bits.
611 Note that this size is not necessarily the memory-footprint size, but
612 only the number of Lisp_Object fields (that need to be traced by GC).
613 The distinction is used, e.g., by Lisp_Process, which places extra
614 non-Lisp_Object fields at the end of the structure. */
615 PSEUDOVECTOR_SIZE_BITS
= 12,
616 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
618 /* To calculate the memory footprint of the pseudovector, it's useful
619 to store the size of non-Lisp area in word_size units here. */
620 PSEUDOVECTOR_REST_BITS
= 12,
621 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
622 << PSEUDOVECTOR_SIZE_BITS
),
624 /* Used to extract pseudovector subtype information. */
625 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
626 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
629 /* These functions extract various sorts of values from a Lisp_Object.
630 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
631 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
634 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
635 #define VALMASK_val (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
636 #if ENUMABLE (VALMASK_val)
637 DEFINE_GDB_SYMBOL_ENUM (VALMASK
)
639 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
640 # define VALMASK VALMASK_val
641 DEFINE_GDB_SYMBOL_END (VALMASK
)
644 /* Largest and smallest representable fixnum values. These are the C
645 values. They are macros for use in static initializers. */
646 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
647 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
649 /* Extract the pointer hidden within A. */
650 LISP_MACRO_DEFUN (XPNTR
, void *, (Lisp_Object a
), (a
))
654 LISP_MACRO_DEFUN (make_number
, Lisp_Object
, (EMACS_INT n
), (n
))
655 LISP_MACRO_DEFUN (XINT
, EMACS_INT
, (Lisp_Object a
), (a
))
656 LISP_MACRO_DEFUN (XFASTINT
, EMACS_INT
, (Lisp_Object a
), (a
))
657 LISP_MACRO_DEFUN (XTYPE
, enum Lisp_Type
, (Lisp_Object a
), (a
))
658 LISP_MACRO_DEFUN (XUNTAG
, void *, (Lisp_Object a
, int type
), (a
, type
))
660 #else /* ! USE_LSB_TAG */
662 /* Although compiled only if ! USE_LSB_TAG, the following functions
663 also work when USE_LSB_TAG; this is to aid future maintenance when
664 the lisp_h_* macros are eventually removed. */
666 /* Make a Lisp integer representing the value of the low order
669 make_number (EMACS_INT n
)
674 n
= u
<< INTTYPEBITS
;
681 /* Extract A's value as a signed integer. */
685 EMACS_INT i
= XLI (a
);
689 i
= u
<< INTTYPEBITS
;
691 return i
>> INTTYPEBITS
;
694 /* Like XINT (A), but may be faster. A must be nonnegative.
695 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
696 integers have zero-bits in their tags. */
698 XFASTINT (Lisp_Object a
)
700 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
);
705 /* Extract A's type. */
706 INLINE
enum Lisp_Type
707 XTYPE (Lisp_Object a
)
709 EMACS_UINT i
= XLI (a
);
710 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
713 /* Extract A's pointer value, assuming A's type is TYPE. */
715 XUNTAG (Lisp_Object a
, int type
)
719 intptr_t i
= XLI (a
) - type
;
725 #endif /* ! USE_LSB_TAG */
727 /* Extract A's value as an unsigned integer. */
729 XUINT (Lisp_Object a
)
731 EMACS_UINT i
= XLI (a
);
732 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
735 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
736 right now, but XUINT should only be applied to objects we know are
738 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
740 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
742 make_natnum (EMACS_INT n
)
744 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
745 return USE_LSB_TAG
? make_number (n
) : XIL (n
);
748 /* Return true if X and Y are the same object. */
749 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
751 /* Value is true if I doesn't fit into a Lisp fixnum. It is
752 written this way so that it also works if I is of unsigned
753 type or if I is a NaN. */
755 #define FIXNUM_OVERFLOW_P(i) \
756 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
759 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
761 return num
< lower
? lower
: num
<= upper
? num
: upper
;
764 /* Forward declarations. */
766 /* Defined in this file. */
768 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
769 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
770 INLINE
bool BUFFERP (Lisp_Object
);
771 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
772 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
773 INLINE
bool (CONSP
) (Lisp_Object
);
774 INLINE
bool (FLOATP
) (Lisp_Object
);
775 INLINE
bool functionp (Lisp_Object
);
776 INLINE
bool (INTEGERP
) (Lisp_Object
);
777 INLINE
bool (MARKERP
) (Lisp_Object
);
778 INLINE
bool (MISCP
) (Lisp_Object
);
779 INLINE
bool (NILP
) (Lisp_Object
);
780 INLINE
bool OVERLAYP (Lisp_Object
);
781 INLINE
bool PROCESSP (Lisp_Object
);
782 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
783 INLINE
bool SAVE_VALUEP (Lisp_Object
);
784 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
786 INLINE
bool STRINGP (Lisp_Object
);
787 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
788 INLINE
bool SUBRP (Lisp_Object
);
789 INLINE
bool (SYMBOLP
) (Lisp_Object
);
790 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
791 INLINE
bool WINDOWP (Lisp_Object
);
792 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
794 /* Defined in chartab.c. */
795 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
796 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
797 extern int char_table_translate (Lisp_Object
, int);
799 /* Defined in data.c. */
800 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
801 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
802 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
803 extern Lisp_Object Qbool_vector_p
;
804 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
805 extern Lisp_Object Qwindow
;
806 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
808 /* Defined in emacs.c. */
809 extern bool might_dump
;
810 /* True means Emacs has already been initialized.
811 Used during startup to detect startup of dumped Emacs. */
812 extern bool initialized
;
814 /* Defined in eval.c. */
815 extern Lisp_Object Qautoload
;
817 /* Defined in floatfns.c. */
818 extern double extract_float (Lisp_Object
);
820 /* Defined in process.c. */
821 extern Lisp_Object Qprocessp
;
823 /* Defined in window.c. */
824 extern Lisp_Object Qwindowp
;
826 /* Defined in xdisp.c. */
827 extern Lisp_Object Qimage
;
830 /* Extract a value or address from a Lisp_Object. */
832 LISP_MACRO_DEFUN (XCONS
, struct Lisp_Cons
*, (Lisp_Object a
), (a
))
834 INLINE
struct Lisp_Vector
*
835 XVECTOR (Lisp_Object a
)
837 eassert (VECTORLIKEP (a
));
838 return XUNTAG (a
, Lisp_Vectorlike
);
841 INLINE
struct Lisp_String
*
842 XSTRING (Lisp_Object a
)
844 eassert (STRINGP (a
));
845 return XUNTAG (a
, Lisp_String
);
848 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
850 INLINE
struct Lisp_Float
*
851 XFLOAT (Lisp_Object a
)
853 eassert (FLOATP (a
));
854 return XUNTAG (a
, Lisp_Float
);
857 /* Pseudovector types. */
859 INLINE
struct Lisp_Process
*
860 XPROCESS (Lisp_Object a
)
862 eassert (PROCESSP (a
));
863 return XUNTAG (a
, Lisp_Vectorlike
);
866 INLINE
struct window
*
867 XWINDOW (Lisp_Object a
)
869 eassert (WINDOWP (a
));
870 return XUNTAG (a
, Lisp_Vectorlike
);
873 INLINE
struct terminal
*
874 XTERMINAL (Lisp_Object a
)
876 return XUNTAG (a
, Lisp_Vectorlike
);
879 INLINE
struct Lisp_Subr
*
880 XSUBR (Lisp_Object a
)
883 return XUNTAG (a
, Lisp_Vectorlike
);
886 INLINE
struct buffer
*
887 XBUFFER (Lisp_Object a
)
889 eassert (BUFFERP (a
));
890 return XUNTAG (a
, Lisp_Vectorlike
);
893 INLINE
struct Lisp_Char_Table
*
894 XCHAR_TABLE (Lisp_Object a
)
896 eassert (CHAR_TABLE_P (a
));
897 return XUNTAG (a
, Lisp_Vectorlike
);
900 INLINE
struct Lisp_Sub_Char_Table
*
901 XSUB_CHAR_TABLE (Lisp_Object a
)
903 eassert (SUB_CHAR_TABLE_P (a
));
904 return XUNTAG (a
, Lisp_Vectorlike
);
907 INLINE
struct Lisp_Bool_Vector
*
908 XBOOL_VECTOR (Lisp_Object a
)
910 eassert (BOOL_VECTOR_P (a
));
911 return XUNTAG (a
, Lisp_Vectorlike
);
914 /* Construct a Lisp_Object from a value or address. */
917 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
919 EMACS_UINT utype
= type
;
920 EMACS_UINT typebits
= USE_LSB_TAG
? type
: utype
<< VALBITS
;
921 Lisp_Object a
= XIL (typebits
| (uintptr_t) ptr
);
922 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
927 make_lisp_proc (struct Lisp_Process
*p
)
929 return make_lisp_ptr (p
, Lisp_Vectorlike
);
932 #define XSETINT(a, b) ((a) = make_number (b))
933 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
934 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
935 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
936 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
937 #define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
938 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
939 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
941 /* Pseudovector types. */
943 #define XSETPVECTYPE(v, code) \
944 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
945 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
946 ((v)->header.size = (PSEUDOVECTOR_FLAG \
947 | ((code) << PSEUDOVECTOR_AREA_BITS) \
948 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
951 /* The cast to struct vectorlike_header * avoids aliasing issues. */
952 #define XSETPSEUDOVECTOR(a, b, code) \
953 XSETTYPED_PSEUDOVECTOR (a, b, \
954 (((struct vectorlike_header *) \
955 XUNTAG (a, Lisp_Vectorlike)) \
958 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
959 (XSETVECTOR (a, b), \
960 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
961 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
963 #define XSETWINDOW_CONFIGURATION(a, b) \
964 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
965 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
966 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
967 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
968 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
969 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
970 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
971 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
972 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
973 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
977 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
978 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
981 /* Deprecated and will be removed soon. */
983 #define INTERNAL_FIELD(field) field ## _
985 /* See the macros in intervals.h. */
987 typedef struct interval
*INTERVAL
;
991 /* Car of this cons cell. */
996 /* Cdr of this cons cell. */
999 /* Used to chain conses on a free list. */
1000 struct Lisp_Cons
*chain
;
1004 /* Take the car or cdr of something known to be a cons cell. */
1005 /* The _addr functions shouldn't be used outside of the minimal set
1006 of code that has to know what a cons cell looks like. Other code not
1007 part of the basic lisp implementation should assume that the car and cdr
1008 fields are not accessible. (What if we want to switch to
1009 a copying collector someday? Cached cons cell field addresses may be
1010 invalidated at arbitrary points.) */
1011 INLINE Lisp_Object
*
1012 xcar_addr (Lisp_Object c
)
1014 return &XCONS (c
)->car
;
1016 INLINE Lisp_Object
*
1017 xcdr_addr (Lisp_Object c
)
1019 return &XCONS (c
)->u
.cdr
;
1022 /* Use these from normal code. */
1023 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
1024 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
1026 /* Use these to set the fields of a cons cell.
1028 Note that both arguments may refer to the same object, so 'n'
1029 should not be read after 'c' is first modified. */
1031 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1036 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1041 /* Take the car or cdr of something whose type is not known. */
1045 return (CONSP (c
) ? XCAR (c
)
1047 : wrong_type_argument (Qlistp
, c
));
1052 return (CONSP (c
) ? XCDR (c
)
1054 : wrong_type_argument (Qlistp
, c
));
1057 /* Take the car or cdr of something whose type is not known. */
1059 CAR_SAFE (Lisp_Object c
)
1061 return CONSP (c
) ? XCAR (c
) : Qnil
;
1064 CDR_SAFE (Lisp_Object c
)
1066 return CONSP (c
) ? XCDR (c
) : Qnil
;
1069 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1074 ptrdiff_t size_byte
;
1075 INTERVAL intervals
; /* Text properties in this string. */
1076 unsigned char *data
;
1079 /* True if STR is a multibyte string. */
1081 STRING_MULTIBYTE (Lisp_Object str
)
1083 return 0 <= XSTRING (str
)->size_byte
;
1086 /* An upper bound on the number of bytes in a Lisp string, not
1087 counting the terminating null. This a tight enough bound to
1088 prevent integer overflow errors that would otherwise occur during
1089 string size calculations. A string cannot contain more bytes than
1090 a fixnum can represent, nor can it be so long that C pointer
1091 arithmetic stops working on the string plus its terminating null.
1092 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1093 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1094 would expose alloc.c internal details that we'd rather keep
1097 This is a macro for use in static initializers. The cast to
1098 ptrdiff_t ensures that the macro is signed. */
1099 #define STRING_BYTES_BOUND \
1100 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1102 /* Mark STR as a unibyte string. */
1103 #define STRING_SET_UNIBYTE(STR) \
1105 if (EQ (STR, empty_multibyte_string)) \
1106 (STR) = empty_unibyte_string; \
1108 XSTRING (STR)->size_byte = -1; \
1111 /* Mark STR as a multibyte string. Assure that STR contains only
1112 ASCII characters in advance. */
1113 #define STRING_SET_MULTIBYTE(STR) \
1115 if (EQ (STR, empty_unibyte_string)) \
1116 (STR) = empty_multibyte_string; \
1118 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1121 /* Convenience functions for dealing with Lisp strings. */
1123 INLINE
unsigned char *
1124 SDATA (Lisp_Object string
)
1126 return XSTRING (string
)->data
;
1129 SSDATA (Lisp_Object string
)
1131 /* Avoid "differ in sign" warnings. */
1132 return (char *) SDATA (string
);
1134 INLINE
unsigned char
1135 SREF (Lisp_Object string
, ptrdiff_t index
)
1137 return SDATA (string
)[index
];
1140 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1142 SDATA (string
)[index
] = new;
1145 SCHARS (Lisp_Object string
)
1147 return XSTRING (string
)->size
;
1151 STRING_BYTES (struct Lisp_String
*s
)
1153 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1157 SBYTES (Lisp_Object string
)
1159 return STRING_BYTES (XSTRING (string
));
1162 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1164 XSTRING (string
)->size
= newsize
;
1167 /* Header of vector-like objects. This documents the layout constraints on
1168 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1169 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1170 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1171 because when two such pointers potentially alias, a compiler won't
1172 incorrectly reorder loads and stores to their size fields. See
1174 struct vectorlike_header
1176 /* The only field contains various pieces of information:
1177 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1178 vector (0) or a pseudovector (1).
1179 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1180 of slots) of the vector.
1181 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1182 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1183 - b) number of Lisp_Objects slots at the beginning of the object
1184 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1186 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1187 measured in word_size units. Rest fields may also include
1188 Lisp_Objects, but these objects usually needs some special treatment
1190 There are some exceptions. For PVEC_FREE, b) is always zero. For
1191 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1192 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1193 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1197 /* A regular vector is just a header plus an array of Lisp_Objects. */
1201 struct vectorlike_header header
;
1202 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1205 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1208 ALIGNOF_STRUCT_LISP_VECTOR
1209 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1212 /* A boolvector is a kind of vectorlike, with contents like a string. */
1214 struct Lisp_Bool_Vector
1216 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1217 just the subtype information. */
1218 struct vectorlike_header header
;
1219 /* This is the size in bits. */
1221 /* The actual bits, packed into bytes.
1222 Zeros fill out the last word if needed.
1223 The bits are in little-endian order in the bytes, and
1224 the bytes are in little-endian order in the words. */
1225 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1229 bool_vector_size (Lisp_Object a
)
1231 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1232 eassume (0 <= size
);
1237 bool_vector_data (Lisp_Object a
)
1239 return XBOOL_VECTOR (a
)->data
;
1242 INLINE
unsigned char *
1243 bool_vector_uchar_data (Lisp_Object a
)
1245 return (unsigned char *) bool_vector_data (a
);
1248 /* The number of data words and bytes in a bool vector with SIZE bits. */
1251 bool_vector_words (EMACS_INT size
)
1253 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1254 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1258 bool_vector_bytes (EMACS_INT size
)
1260 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1261 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1264 /* True if A's Ith bit is set. */
1267 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1269 eassume (0 <= i
&& i
< bool_vector_size (a
));
1270 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1271 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1275 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1277 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1280 /* Set A's Ith bit to B. */
1283 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1285 unsigned char *addr
;
1287 eassume (0 <= i
&& i
< bool_vector_size (a
));
1288 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1291 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1293 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1296 /* Some handy constants for calculating sizes
1297 and offsets, mostly of vectorlike objects. */
1301 header_size
= offsetof (struct Lisp_Vector
, contents
),
1302 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1303 word_size
= sizeof (Lisp_Object
)
1306 /* Conveniences for dealing with Lisp arrays. */
1309 AREF (Lisp_Object array
, ptrdiff_t idx
)
1311 return XVECTOR (array
)->contents
[idx
];
1314 INLINE Lisp_Object
*
1315 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1317 return & XVECTOR (array
)->contents
[idx
];
1321 ASIZE (Lisp_Object array
)
1323 return XVECTOR (array
)->header
.size
;
1327 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1329 eassert (0 <= idx
&& idx
< ASIZE (array
));
1330 XVECTOR (array
)->contents
[idx
] = val
;
1334 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1336 /* Like ASET, but also can be used in the garbage collector:
1337 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1338 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1339 XVECTOR (array
)->contents
[idx
] = val
;
1342 /* If a struct is made to look like a vector, this macro returns the length
1343 of the shortest vector that would hold that struct. */
1345 #define VECSIZE(type) \
1346 ((sizeof (type) - header_size + word_size - 1) / word_size)
1348 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1349 at the end and we need to compute the number of Lisp_Object fields (the
1350 ones that the GC needs to trace). */
1352 #define PSEUDOVECSIZE(type, nonlispfield) \
1353 ((offsetof (type, nonlispfield) - header_size) / word_size)
1355 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1356 should be integer expressions. This is not the same as
1357 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1358 returns true. For efficiency, prefer plain unsigned comparison if A
1359 and B's sizes both fit (after integer promotion). */
1360 #define UNSIGNED_CMP(a, op, b) \
1361 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1362 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1363 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1365 /* True iff C is an ASCII character. */
1366 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1368 /* A char-table is a kind of vectorlike, with contents are like a
1369 vector but with a few other slots. For some purposes, it makes
1370 sense to handle a char-table with type struct Lisp_Vector. An
1371 element of a char table can be any Lisp objects, but if it is a sub
1372 char-table, we treat it a table that contains information of a
1373 specific range of characters. A sub char-table has the same
1374 structure as a vector. A sub char table appears only in an element
1375 of a char-table, and there's no way to access it directly from
1376 Emacs Lisp program. */
1378 enum CHARTAB_SIZE_BITS
1380 CHARTAB_SIZE_BITS_0
= 6,
1381 CHARTAB_SIZE_BITS_1
= 4,
1382 CHARTAB_SIZE_BITS_2
= 5,
1383 CHARTAB_SIZE_BITS_3
= 7
1386 extern const int chartab_size
[4];
1388 struct Lisp_Char_Table
1390 /* HEADER.SIZE is the vector's size field, which also holds the
1391 pseudovector type information. It holds the size, too.
1392 The size counts the defalt, parent, purpose, ascii,
1393 contents, and extras slots. */
1394 struct vectorlike_header header
;
1396 /* This holds a default value,
1397 which is used whenever the value for a specific character is nil. */
1400 /* This points to another char table, which we inherit from when the
1401 value for a specific character is nil. The `defalt' slot takes
1402 precedence over this. */
1405 /* This is a symbol which says what kind of use this char-table is
1407 Lisp_Object purpose
;
1409 /* The bottom sub char-table for characters of the range 0..127. It
1410 is nil if none of ASCII character has a specific value. */
1413 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1415 /* These hold additional data. It is a vector. */
1416 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1419 struct Lisp_Sub_Char_Table
1421 /* HEADER.SIZE is the vector's size field, which also holds the
1422 pseudovector type information. It holds the size, too. */
1423 struct vectorlike_header header
;
1425 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1426 char-table of depth 1 contains 16 elements, and each element
1427 covers 4096 (128*32) characters. A sub char-table of depth 2
1428 contains 32 elements, and each element covers 128 characters. A
1429 sub char-table of depth 3 contains 128 elements, and each element
1430 is for one character. */
1433 /* Minimum character covered by the sub char-table. */
1434 Lisp_Object min_char
;
1436 /* Use set_sub_char_table_contents to set this. */
1437 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1441 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1443 struct Lisp_Char_Table
*tbl
= NULL
;
1447 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1448 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1449 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1453 while (NILP (val
) && ! NILP (tbl
->parent
));
1458 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1459 characters. Do not check validity of CT. */
1461 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1463 return (ASCII_CHAR_P (idx
)
1464 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1465 : char_table_ref (ct
, idx
));
1468 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1469 8-bit European characters. Do not check validity of CT. */
1471 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1473 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1474 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1476 char_table_set (ct
, idx
, val
);
1479 /* This structure describes a built-in function.
1480 It is generated by the DEFUN macro only.
1481 defsubr makes it into a Lisp object. */
1485 struct vectorlike_header header
;
1487 Lisp_Object (*a0
) (void);
1488 Lisp_Object (*a1
) (Lisp_Object
);
1489 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1490 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1491 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1492 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1493 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1494 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1495 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1496 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1497 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1499 short min_args
, max_args
;
1500 const char *symbol_name
;
1501 const char *intspec
;
1505 /* This is the number of slots that every char table must have. This
1506 counts the ordinary slots and the top, defalt, parent, and purpose
1508 enum CHAR_TABLE_STANDARD_SLOTS
1510 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1513 /* Return the number of "extra" slots in the char table CT. */
1516 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1518 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1519 - CHAR_TABLE_STANDARD_SLOTS
);
1523 /***********************************************************************
1525 ***********************************************************************/
1527 /* Interned state of a symbol. */
1529 enum symbol_interned
1531 SYMBOL_UNINTERNED
= 0,
1532 SYMBOL_INTERNED
= 1,
1533 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1536 enum symbol_redirect
1538 SYMBOL_PLAINVAL
= 4,
1539 SYMBOL_VARALIAS
= 1,
1540 SYMBOL_LOCALIZED
= 2,
1541 SYMBOL_FORWARDED
= 3
1546 /* Indicates where the value can be found:
1547 0 : it's a plain var, the value is in the `value' field.
1548 1 : it's a varalias, the value is really in the `alias' symbol.
1549 2 : it's a localized var, the value is in the `blv' object.
1550 3 : it's a forwarding variable, the value is in `forward'. */
1551 ENUM_BF (symbol_redirect
) redirect
: 3;
1553 /* Non-zero means symbol is constant, i.e. changing its value
1554 should signal an error. If the value is 3, then the var
1555 can be changed, but only by `defconst'. */
1556 unsigned constant
: 2;
1558 /* Interned state of the symbol. This is an enumerator from
1559 enum symbol_interned. */
1560 unsigned interned
: 2;
1562 /* True means that this variable has been explicitly declared
1563 special (with `defvar' etc), and shouldn't be lexically bound. */
1564 bool_bf declared_special
: 1;
1566 /* True if pointed to from purespace and hence can't be GC'd. */
1569 /* The symbol's name, as a Lisp string. */
1572 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1573 union is used depends on the `redirect' field above. */
1576 struct Lisp_Symbol
*alias
;
1577 struct Lisp_Buffer_Local_Value
*blv
;
1578 union Lisp_Fwd
*fwd
;
1581 /* Function value of the symbol or Qnil if not fboundp. */
1582 Lisp_Object function
;
1584 /* The symbol's property list. */
1587 /* Next symbol in obarray bucket, if the symbol is interned. */
1588 struct Lisp_Symbol
*next
;
1591 /* Value is name of symbol. */
1593 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1595 INLINE
struct Lisp_Symbol
*
1596 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1598 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1599 return sym
->val
.alias
;
1601 INLINE
struct Lisp_Buffer_Local_Value
*
1602 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1604 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1605 return sym
->val
.blv
;
1607 INLINE
union Lisp_Fwd
*
1608 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1610 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1611 return sym
->val
.fwd
;
1614 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1615 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1618 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1620 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1624 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1626 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1630 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1632 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1637 SYMBOL_NAME (Lisp_Object sym
)
1639 return XSYMBOL (sym
)->name
;
1642 /* Value is true if SYM is an interned symbol. */
1645 SYMBOL_INTERNED_P (Lisp_Object sym
)
1647 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1650 /* Value is true if SYM is interned in initial_obarray. */
1653 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1655 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1658 /* Value is non-zero if symbol is considered a constant, i.e. its
1659 value cannot be changed (there is an exception for keyword symbols,
1660 whose value can be set to the keyword symbol itself). */
1662 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1664 #define DEFSYM(sym, name) \
1665 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1668 /***********************************************************************
1670 ***********************************************************************/
1672 /* The structure of a Lisp hash table. */
1674 struct hash_table_test
1676 /* Name of the function used to compare keys. */
1679 /* User-supplied hash function, or nil. */
1680 Lisp_Object user_hash_function
;
1682 /* User-supplied key comparison function, or nil. */
1683 Lisp_Object user_cmp_function
;
1685 /* C function to compare two keys. */
1686 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1688 /* C function to compute hash code. */
1689 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1692 struct Lisp_Hash_Table
1694 /* This is for Lisp; the hash table code does not refer to it. */
1695 struct vectorlike_header header
;
1697 /* Nil if table is non-weak. Otherwise a symbol describing the
1698 weakness of the table. */
1701 /* When the table is resized, and this is an integer, compute the
1702 new size by adding this to the old size. If a float, compute the
1703 new size by multiplying the old size with this factor. */
1704 Lisp_Object rehash_size
;
1706 /* Resize hash table when number of entries/ table size is >= this
1708 Lisp_Object rehash_threshold
;
1710 /* Vector of hash codes. If hash[I] is nil, this means that the
1711 I-th entry is unused. */
1714 /* Vector used to chain entries. If entry I is free, next[I] is the
1715 entry number of the next free item. If entry I is non-free,
1716 next[I] is the index of the next entry in the collision chain. */
1719 /* Index of first free entry in free list. */
1720 Lisp_Object next_free
;
1722 /* Bucket vector. A non-nil entry is the index of the first item in
1723 a collision chain. This vector's size can be larger than the
1724 hash table size to reduce collisions. */
1727 /* Only the fields above are traced normally by the GC. The ones below
1728 `count' are special and are either ignored by the GC or traced in
1729 a special way (e.g. because of weakness). */
1731 /* Number of key/value entries in the table. */
1734 /* Vector of keys and values. The key of item I is found at index
1735 2 * I, the value is found at index 2 * I + 1.
1736 This is gc_marked specially if the table is weak. */
1737 Lisp_Object key_and_value
;
1739 /* The comparison and hash functions. */
1740 struct hash_table_test test
;
1742 /* Next weak hash table if this is a weak hash table. The head
1743 of the list is in weak_hash_tables. */
1744 struct Lisp_Hash_Table
*next_weak
;
1748 INLINE
struct Lisp_Hash_Table
*
1749 XHASH_TABLE (Lisp_Object a
)
1751 return XUNTAG (a
, Lisp_Vectorlike
);
1754 #define XSET_HASH_TABLE(VAR, PTR) \
1755 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1758 HASH_TABLE_P (Lisp_Object a
)
1760 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1763 /* Value is the key part of entry IDX in hash table H. */
1765 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1767 return AREF (h
->key_and_value
, 2 * idx
);
1770 /* Value is the value part of entry IDX in hash table H. */
1772 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1774 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1777 /* Value is the index of the next entry following the one at IDX
1780 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1782 return AREF (h
->next
, idx
);
1785 /* Value is the hash code computed for entry IDX in hash table H. */
1787 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1789 return AREF (h
->hash
, idx
);
1792 /* Value is the index of the element in hash table H that is the
1793 start of the collision list at index IDX in the index vector of H. */
1795 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1797 return AREF (h
->index
, idx
);
1800 /* Value is the size of hash table H. */
1802 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1804 return ASIZE (h
->next
);
1807 /* Default size for hash tables if not specified. */
1809 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1811 /* Default threshold specifying when to resize a hash table. The
1812 value gives the ratio of current entries in the hash table and the
1813 size of the hash table. */
1815 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1817 /* Default factor by which to increase the size of a hash table. */
1819 static double const DEFAULT_REHASH_SIZE
= 1.5;
1821 /* Combine two integers X and Y for hashing. The result might not fit
1822 into a Lisp integer. */
1825 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1827 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1830 /* Hash X, returning a value that fits into a fixnum. */
1833 SXHASH_REDUCE (EMACS_UINT x
)
1835 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
)) & INTMASK
;
1838 /* These structures are used for various misc types. */
1840 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1842 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1847 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1848 /* This flag is temporarily used in the functions
1849 decode/encode_coding_object to record that the marker position
1850 must be adjusted after the conversion. */
1851 bool_bf need_adjustment
: 1;
1852 /* True means normal insertion at the marker's position
1853 leaves the marker after the inserted text. */
1854 bool_bf insertion_type
: 1;
1855 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1856 Note: a chain of markers can contain markers pointing into different
1857 buffers (the chain is per buffer_text rather than per buffer, so it's
1858 shared between indirect buffers). */
1859 /* This is used for (other than NULL-checking):
1861 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1862 - unchain_marker: to find the list from which to unchain.
1863 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1865 struct buffer
*buffer
;
1867 /* The remaining fields are meaningless in a marker that
1868 does not point anywhere. */
1870 /* For markers that point somewhere,
1871 this is used to chain of all the markers in a given buffer. */
1872 /* We could remove it and use an array in buffer_text instead.
1873 That would also allow to preserve it ordered. */
1874 struct Lisp_Marker
*next
;
1875 /* This is the char position where the marker points. */
1877 /* This is the byte position.
1878 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1879 used to implement the functionality of markers, but rather to (ab)use
1880 markers as a cache for char<->byte mappings). */
1884 /* START and END are markers in the overlay's buffer, and
1885 PLIST is the overlay's property list. */
1887 /* An overlay's real data content is:
1889 - buffer (really there are two buffer pointers, one per marker,
1890 and both points to the same buffer)
1891 - insertion type of both ends (per-marker fields)
1892 - start & start byte (of start marker)
1893 - end & end byte (of end marker)
1894 - next (singly linked list of overlays)
1895 - next fields of start and end markers (singly linked list of markers).
1896 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1899 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1900 struct Lisp_Overlay
*next
;
1906 /* Types of data which may be saved in a Lisp_Save_Value. */
1917 /* Number of bits needed to store one of the above values. */
1918 enum { SAVE_SLOT_BITS
= 3 };
1920 /* Number of slots in a save value where save_type is nonzero. */
1921 enum { SAVE_VALUE_SLOTS
= 4 };
1923 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1925 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1929 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1930 SAVE_TYPE_INT_INT_INT
1931 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1932 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1933 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1934 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1935 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1936 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1937 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1938 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1939 SAVE_TYPE_FUNCPTR_PTR_OBJ
1940 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1942 /* This has an extra bit indicating it's raw memory. */
1943 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1946 /* Special object used to hold a different values for later use.
1948 This is mostly used to package C integers and pointers to call
1949 record_unwind_protect when two or more values need to be saved.
1953 struct my_data *md = get_my_data ();
1954 ptrdiff_t mi = get_my_integer ();
1955 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1958 Lisp_Object my_unwind (Lisp_Object arg)
1960 struct my_data *md = XSAVE_POINTER (arg, 0);
1961 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1965 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1966 saved objects and raise eassert if type of the saved object doesn't match
1967 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1968 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1969 slot 0 is a pointer. */
1971 typedef void (*voidfuncptr
) (void);
1973 struct Lisp_Save_Value
1975 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1976 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1978 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1979 V's data entries are determined by V->save_type. E.g., if
1980 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1981 V->data[1] is an integer, and V's other data entries are unused.
1983 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1984 a memory area containing V->data[1].integer potential Lisp_Objects. */
1985 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1988 voidfuncptr funcpointer
;
1991 } data
[SAVE_VALUE_SLOTS
];
1994 /* Return the type of V's Nth saved value. */
1996 save_type (struct Lisp_Save_Value
*v
, int n
)
1998 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1999 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2002 /* Get and set the Nth saved pointer. */
2005 XSAVE_POINTER (Lisp_Object obj
, int n
)
2007 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2008 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2011 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2013 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2014 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2017 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2019 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2020 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2023 /* Likewise for the saved integer. */
2026 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2028 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2029 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2032 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2034 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2035 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2038 /* Extract Nth saved object. */
2041 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2043 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2044 return XSAVE_VALUE (obj
)->data
[n
].object
;
2047 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2048 It uses one of these struct subtypes to get the type field. */
2052 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2053 struct Lisp_Marker u_marker
;
2054 struct Lisp_Overlay u_overlay
;
2055 struct Lisp_Save_Value u_save_value
;
2058 INLINE
union Lisp_Misc
*
2059 XMISC (Lisp_Object a
)
2061 return XUNTAG (a
, Lisp_Misc
);
2064 INLINE
struct Lisp_Misc_Any
*
2065 XMISCANY (Lisp_Object a
)
2067 eassert (MISCP (a
));
2068 return & XMISC (a
)->u_any
;
2071 INLINE
enum Lisp_Misc_Type
2072 XMISCTYPE (Lisp_Object a
)
2074 return XMISCANY (a
)->type
;
2077 INLINE
struct Lisp_Marker
*
2078 XMARKER (Lisp_Object a
)
2080 eassert (MARKERP (a
));
2081 return & XMISC (a
)->u_marker
;
2084 INLINE
struct Lisp_Overlay
*
2085 XOVERLAY (Lisp_Object a
)
2087 eassert (OVERLAYP (a
));
2088 return & XMISC (a
)->u_overlay
;
2091 INLINE
struct Lisp_Save_Value
*
2092 XSAVE_VALUE (Lisp_Object a
)
2094 eassert (SAVE_VALUEP (a
));
2095 return & XMISC (a
)->u_save_value
;
2098 /* Forwarding pointer to an int variable.
2099 This is allowed only in the value cell of a symbol,
2100 and it means that the symbol's value really lives in the
2101 specified int variable. */
2104 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2108 /* Boolean forwarding pointer to an int variable.
2109 This is like Lisp_Intfwd except that the ostensible
2110 "value" of the symbol is t if the bool variable is true,
2111 nil if it is false. */
2114 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2118 /* Forwarding pointer to a Lisp_Object variable.
2119 This is allowed only in the value cell of a symbol,
2120 and it means that the symbol's value really lives in the
2121 specified variable. */
2124 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2125 Lisp_Object
*objvar
;
2128 /* Like Lisp_Objfwd except that value lives in a slot in the
2129 current buffer. Value is byte index of slot within buffer. */
2130 struct Lisp_Buffer_Objfwd
2132 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2134 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2135 Lisp_Object predicate
;
2138 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2139 the symbol has buffer-local or frame-local bindings. (Exception:
2140 some buffer-local variables are built-in, with their values stored
2141 in the buffer structure itself. They are handled differently,
2142 using struct Lisp_Buffer_Objfwd.)
2144 The `realvalue' slot holds the variable's current value, or a
2145 forwarding pointer to where that value is kept. This value is the
2146 one that corresponds to the loaded binding. To read or set the
2147 variable, you must first make sure the right binding is loaded;
2148 then you can access the value in (or through) `realvalue'.
2150 `buffer' and `frame' are the buffer and frame for which the loaded
2151 binding was found. If those have changed, to make sure the right
2152 binding is loaded it is necessary to find which binding goes with
2153 the current buffer and selected frame, then load it. To load it,
2154 first unload the previous binding, then copy the value of the new
2155 binding into `realvalue' (or through it). Also update
2156 LOADED-BINDING to point to the newly loaded binding.
2158 `local_if_set' indicates that merely setting the variable creates a
2159 local binding for the current buffer. Otherwise the latter, setting
2160 the variable does not do that; only make-local-variable does that. */
2162 struct Lisp_Buffer_Local_Value
2164 /* True means that merely setting the variable creates a local
2165 binding for the current buffer. */
2166 bool_bf local_if_set
: 1;
2167 /* True means this variable can have frame-local bindings, otherwise, it is
2168 can have buffer-local bindings. The two cannot be combined. */
2169 bool_bf frame_local
: 1;
2170 /* True means that the binding now loaded was found.
2171 Presumably equivalent to (defcell!=valcell). */
2173 /* If non-NULL, a forwarding to the C var where it should also be set. */
2174 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2175 /* The buffer or frame for which the loaded binding was found. */
2177 /* A cons cell that holds the default value. It has the form
2178 (SYMBOL . DEFAULT-VALUE). */
2179 Lisp_Object defcell
;
2180 /* The cons cell from `where's parameter alist.
2181 It always has the form (SYMBOL . VALUE)
2182 Note that if `forward' is non-nil, VALUE may be out of date.
2183 Also if the currently loaded binding is the default binding, then
2184 this is `eq'ual to defcell. */
2185 Lisp_Object valcell
;
2188 /* Like Lisp_Objfwd except that value lives in a slot in the
2190 struct Lisp_Kboard_Objfwd
2192 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2198 struct Lisp_Intfwd u_intfwd
;
2199 struct Lisp_Boolfwd u_boolfwd
;
2200 struct Lisp_Objfwd u_objfwd
;
2201 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2202 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2205 INLINE
enum Lisp_Fwd_Type
2206 XFWDTYPE (union Lisp_Fwd
*a
)
2208 return a
->u_intfwd
.type
;
2211 INLINE
struct Lisp_Buffer_Objfwd
*
2212 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2214 eassert (BUFFER_OBJFWDP (a
));
2215 return &a
->u_buffer_objfwd
;
2218 /* Lisp floating point type. */
2225 XFLOAT_DATA (Lisp_Object f
)
2227 return XFLOAT (f
)->data
;
2230 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2231 representations, have infinities and NaNs, and do not trap on
2232 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2233 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2234 wanted here, but is not quite right because Emacs does not require
2235 all the features of C11 Annex F (and does not require C11 at all,
2236 for that matter). */
2240 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2241 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2244 /* A character, declared with the following typedef, is a member
2245 of some character set associated with the current buffer. */
2246 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2248 typedef unsigned char UCHAR
;
2251 /* Meanings of slots in a Lisp_Compiled: */
2255 COMPILED_ARGLIST
= 0,
2256 COMPILED_BYTECODE
= 1,
2257 COMPILED_CONSTANTS
= 2,
2258 COMPILED_STACK_DEPTH
= 3,
2259 COMPILED_DOC_STRING
= 4,
2260 COMPILED_INTERACTIVE
= 5
2263 /* Flag bits in a character. These also get used in termhooks.h.
2264 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2265 (MUlti-Lingual Emacs) might need 22 bits for the character value
2266 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2269 CHAR_ALT
= 0x0400000,
2270 CHAR_SUPER
= 0x0800000,
2271 CHAR_HYPER
= 0x1000000,
2272 CHAR_SHIFT
= 0x2000000,
2273 CHAR_CTL
= 0x4000000,
2274 CHAR_META
= 0x8000000,
2276 CHAR_MODIFIER_MASK
=
2277 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2279 /* Actually, the current Emacs uses 22 bits for the character value
2284 /* Data type checking. */
2286 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2289 NUMBERP (Lisp_Object x
)
2291 return INTEGERP (x
) || FLOATP (x
);
2294 NATNUMP (Lisp_Object x
)
2296 return INTEGERP (x
) && 0 <= XINT (x
);
2300 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2302 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2305 #define TYPE_RANGED_INTEGERP(type, x) \
2307 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2308 && XINT (x) <= TYPE_MAXIMUM (type))
2310 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2311 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2312 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2313 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2314 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2315 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2316 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2319 STRINGP (Lisp_Object x
)
2321 return XTYPE (x
) == Lisp_String
;
2324 VECTORP (Lisp_Object x
)
2326 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2329 OVERLAYP (Lisp_Object x
)
2331 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2334 SAVE_VALUEP (Lisp_Object x
)
2336 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2340 AUTOLOADP (Lisp_Object x
)
2342 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2346 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2348 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2352 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2354 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2355 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2358 /* True if A is a pseudovector whose code is CODE. */
2360 PSEUDOVECTORP (Lisp_Object a
, int code
)
2362 if (! VECTORLIKEP (a
))
2366 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2367 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
2368 return PSEUDOVECTOR_TYPEP (h
, code
);
2373 /* Test for specific pseudovector types. */
2376 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2378 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2382 PROCESSP (Lisp_Object a
)
2384 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2388 WINDOWP (Lisp_Object a
)
2390 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2394 TERMINALP (Lisp_Object a
)
2396 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2400 SUBRP (Lisp_Object a
)
2402 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2406 COMPILEDP (Lisp_Object a
)
2408 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2412 BUFFERP (Lisp_Object a
)
2414 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2418 CHAR_TABLE_P (Lisp_Object a
)
2420 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2424 SUB_CHAR_TABLE_P (Lisp_Object a
)
2426 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2430 BOOL_VECTOR_P (Lisp_Object a
)
2432 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2436 FRAMEP (Lisp_Object a
)
2438 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2441 /* Test for image (image . spec) */
2443 IMAGEP (Lisp_Object x
)
2445 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2450 ARRAYP (Lisp_Object x
)
2452 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2456 CHECK_LIST (Lisp_Object x
)
2458 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2461 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2462 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2463 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2466 CHECK_STRING (Lisp_Object x
)
2468 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2471 CHECK_STRING_CAR (Lisp_Object x
)
2473 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2476 CHECK_CONS (Lisp_Object x
)
2478 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2481 CHECK_VECTOR (Lisp_Object x
)
2483 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2486 CHECK_BOOL_VECTOR (Lisp_Object x
)
2488 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2491 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2493 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2496 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2498 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2501 CHECK_BUFFER (Lisp_Object x
)
2503 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2506 CHECK_WINDOW (Lisp_Object x
)
2508 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2512 CHECK_PROCESS (Lisp_Object x
)
2514 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2518 CHECK_NATNUM (Lisp_Object x
)
2520 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2523 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2526 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2527 args_out_of_range_3 \
2529 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2530 ? MOST_NEGATIVE_FIXNUM \
2532 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2534 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2536 if (TYPE_SIGNED (type)) \
2537 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2539 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2542 #define CHECK_NUMBER_COERCE_MARKER(x) \
2544 if (MARKERP ((x))) \
2545 XSETFASTINT (x, marker_position (x)); \
2547 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2551 XFLOATINT (Lisp_Object n
)
2553 return extract_float (n
);
2557 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2559 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2562 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2565 XSETFASTINT (x, marker_position (x)); \
2567 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2570 /* Since we can't assign directly to the CAR or CDR fields of a cons
2571 cell, use these when checking that those fields contain numbers. */
2573 CHECK_NUMBER_CAR (Lisp_Object x
)
2575 Lisp_Object tmp
= XCAR (x
);
2581 CHECK_NUMBER_CDR (Lisp_Object x
)
2583 Lisp_Object tmp
= XCDR (x
);
2588 /* Define a built-in function for calling from Lisp.
2589 `lname' should be the name to give the function in Lisp,
2590 as a null-terminated C string.
2591 `fnname' should be the name of the function in C.
2592 By convention, it starts with F.
2593 `sname' should be the name for the C constant structure
2594 that records information on this function for internal use.
2595 By convention, it should be the same as `fnname' but with S instead of F.
2596 It's too bad that C macros can't compute this from `fnname'.
2597 `minargs' should be a number, the minimum number of arguments allowed.
2598 `maxargs' should be a number, the maximum number of arguments allowed,
2599 or else MANY or UNEVALLED.
2600 MANY means pass a vector of evaluated arguments,
2601 in the form of an integer number-of-arguments
2602 followed by the address of a vector of Lisp_Objects
2603 which contains the argument values.
2604 UNEVALLED means pass the list of unevaluated arguments
2605 `intspec' says how interactive arguments are to be fetched.
2606 If the string starts with a `(', `intspec' is evaluated and the resulting
2607 list is the list of arguments.
2608 If it's a string that doesn't start with `(', the value should follow
2609 the one of the doc string for `interactive'.
2610 A null string means call interactively with no arguments.
2611 `doc' is documentation for the user. */
2613 /* This version of DEFUN declares a function prototype with the right
2614 arguments, so we can catch errors with maxargs at compile-time. */
2616 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2617 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2618 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2619 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2620 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2621 { (Lisp_Object (__cdecl *)(void))fnname }, \
2622 minargs, maxargs, lname, intspec, 0}; \
2624 #else /* not _MSC_VER */
2625 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2626 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2627 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2628 { .a ## maxargs = fnname }, \
2629 minargs, maxargs, lname, intspec, 0}; \
2633 /* Note that the weird token-substitution semantics of ANSI C makes
2634 this work for MANY and UNEVALLED. */
2635 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2636 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2637 #define DEFUN_ARGS_0 (void)
2638 #define DEFUN_ARGS_1 (Lisp_Object)
2639 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2640 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2641 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2642 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2644 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2645 Lisp_Object, Lisp_Object)
2646 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2647 Lisp_Object, Lisp_Object, Lisp_Object)
2648 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2649 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2651 /* True if OBJ is a Lisp function. */
2653 FUNCTIONP (Lisp_Object obj
)
2655 return functionp (obj
);
2659 is how we define the symbol for function `name' at start-up time. */
2660 extern void defsubr (struct Lisp_Subr
*);
2668 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2669 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2670 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2671 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2672 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2674 /* Macros we use to define forwarded Lisp variables.
2675 These are used in the syms_of_FILENAME functions.
2677 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2678 lisp variable is actually a field in `struct emacs_globals'. The
2679 field's name begins with "f_", which is a convention enforced by
2680 these macros. Each such global has a corresponding #define in
2681 globals.h; the plain name should be used in the code.
2683 E.g., the global "cons_cells_consed" is declared as "int
2684 f_cons_cells_consed" in globals.h, but there is a define:
2686 #define cons_cells_consed globals.f_cons_cells_consed
2688 All C code uses the `cons_cells_consed' name. This is all done
2689 this way to support indirection for multi-threaded Emacs. */
2691 #define DEFVAR_LISP(lname, vname, doc) \
2693 static struct Lisp_Objfwd o_fwd; \
2694 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2696 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2698 static struct Lisp_Objfwd o_fwd; \
2699 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2701 #define DEFVAR_BOOL(lname, vname, doc) \
2703 static struct Lisp_Boolfwd b_fwd; \
2704 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2706 #define DEFVAR_INT(lname, vname, doc) \
2708 static struct Lisp_Intfwd i_fwd; \
2709 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2712 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2714 static struct Lisp_Objfwd o_fwd; \
2715 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2718 #define DEFVAR_KBOARD(lname, vname, doc) \
2720 static struct Lisp_Kboard_Objfwd ko_fwd; \
2721 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2724 /* Save and restore the instruction and environment pointers,
2725 without affecting the signal mask. */
2728 typedef jmp_buf sys_jmp_buf
;
2729 # define sys_setjmp(j) _setjmp (j)
2730 # define sys_longjmp(j, v) _longjmp (j, v)
2731 #elif defined HAVE_SIGSETJMP
2732 typedef sigjmp_buf sys_jmp_buf
;
2733 # define sys_setjmp(j) sigsetjmp (j, 0)
2734 # define sys_longjmp(j, v) siglongjmp (j, v)
2736 /* A platform that uses neither _longjmp nor siglongjmp; assume
2737 longjmp does not affect the sigmask. */
2738 typedef jmp_buf sys_jmp_buf
;
2739 # define sys_setjmp(j) setjmp (j)
2740 # define sys_longjmp(j, v) longjmp (j, v)
2744 /* Elisp uses several stacks:
2746 - the bytecode stack: used internally by the bytecode interpreter.
2747 Allocated from the C stack.
2748 - The specpdl stack: keeps track of active unwind-protect and
2749 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2751 - The handler stack: keeps track of active catch tags and condition-case
2752 handlers. Allocated in a manually managed stack implemented by a
2753 doubly-linked list allocated via xmalloc and never freed. */
2755 /* Structure for recording Lisp call stack for backtrace purposes. */
2757 /* The special binding stack holds the outer values of variables while
2758 they are bound by a function application or a let form, stores the
2759 code to be executed for unwind-protect forms.
2761 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2762 used all over the place, needs to be fast, and needs to know the size of
2763 union specbinding. But only eval.c should access it. */
2766 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2767 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2768 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2769 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2770 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2771 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2772 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2773 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2774 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2779 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2781 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2782 void (*func
) (Lisp_Object
);
2786 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2787 void (*func
) (void *);
2791 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2796 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2797 void (*func
) (void);
2800 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2801 /* `where' is not used in the case of SPECPDL_LET. */
2802 Lisp_Object symbol
, old_value
, where
;
2805 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2806 bool_bf debug_on_exit
: 1;
2807 Lisp_Object function
;
2813 extern union specbinding
*specpdl
;
2814 extern union specbinding
*specpdl_ptr
;
2815 extern ptrdiff_t specpdl_size
;
2818 SPECPDL_INDEX (void)
2820 return specpdl_ptr
- specpdl
;
2823 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2824 control structures. A struct handler contains all the information needed to
2825 restore the state of the interpreter after a non-local jump.
2827 handler structures are chained together in a doubly linked list; the `next'
2828 member points to the next outer catchtag and the `nextfree' member points in
2829 the other direction to the next inner element (which is typically the next
2830 free element since we mostly use it on the deepest handler).
2832 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2833 member is TAG, and then unbinds to it. The `val' member is used to
2834 hold VAL while the stack is unwound; `val' is returned as the value
2837 All the other members are concerned with restoring the interpreter
2840 Members are volatile if their values need to survive _longjmp when
2841 a 'struct handler' is a local variable. */
2843 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2847 enum handlertype type
;
2848 Lisp_Object tag_or_ch
;
2850 struct handler
*next
;
2851 struct handler
*nextfree
;
2853 /* The bytecode interpreter can have several handlers active at the same
2854 time, so when we longjmp to one of them, it needs to know which handler
2855 this was and what was the corresponding internal state. This is stored
2856 here, and when we longjmp we make sure that handlerlist points to the
2858 Lisp_Object
*bytecode_top
;
2861 /* Most global vars are reset to their value via the specpdl mechanism,
2862 but a few others are handled by storing their value here. */
2863 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2864 struct gcpro
*gcpro
;
2867 EMACS_INT lisp_eval_depth
;
2869 int poll_suppress_count
;
2870 int interrupt_input_blocked
;
2873 /* Fill in the components of c, and put it on the list. */
2874 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2875 if (handlerlist->nextfree) \
2876 (c) = handlerlist->nextfree; \
2879 (c) = xmalloc (sizeof (struct handler)); \
2880 (c)->nextfree = NULL; \
2881 handlerlist->nextfree = (c); \
2883 (c)->type = (handlertype); \
2884 (c)->tag_or_ch = (tag_ch_val); \
2886 (c)->next = handlerlist; \
2887 (c)->lisp_eval_depth = lisp_eval_depth; \
2888 (c)->pdlcount = SPECPDL_INDEX (); \
2889 (c)->poll_suppress_count = poll_suppress_count; \
2890 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2891 (c)->gcpro = gcprolist; \
2895 extern Lisp_Object memory_signal_data
;
2897 /* Check quit-flag and quit if it is non-nil.
2898 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2899 So the program needs to do QUIT at times when it is safe to quit.
2900 Every loop that might run for a long time or might not exit
2901 ought to do QUIT at least once, at a safe place.
2902 Unless that is impossible, of course.
2903 But it is very desirable to avoid creating loops where QUIT is impossible.
2905 Exception: if you set immediate_quit to true,
2906 then the handler that responds to the C-g does the quit itself.
2907 This is a good thing to do around a loop that has no side effects
2908 and (in particular) cannot call arbitrary Lisp code.
2910 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2911 a request to exit Emacs when it is safe to do. */
2913 extern void process_pending_signals (void);
2914 extern bool volatile pending_signals
;
2916 extern void process_quit_flag (void);
2919 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2920 process_quit_flag (); \
2921 else if (pending_signals) \
2922 process_pending_signals (); \
2926 /* True if ought to quit now. */
2928 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2930 extern Lisp_Object Vascii_downcase_table
;
2931 extern Lisp_Object Vascii_canon_table
;
2933 /* Structure for recording stack slots that need marking. */
2935 /* This is a chain of structures, each of which points at a Lisp_Object
2936 variable whose value should be marked in garbage collection.
2937 Normally every link of the chain is an automatic variable of a function,
2938 and its `val' points to some argument or local variable of the function.
2939 On exit to the function, the chain is set back to the value it had on entry.
2940 This way, no link remains in the chain when the stack frame containing the
2943 Every function that can call Feval must protect in this fashion all
2944 Lisp_Object variables whose contents will be used again. */
2946 extern struct gcpro
*gcprolist
;
2952 /* Address of first protected variable. */
2953 volatile Lisp_Object
*var
;
2955 /* Number of consecutive protected variables. */
2963 /* Do something silly with gcproN vars just so gcc shuts up. */
2964 /* You get warnings from MIPSPro... */
2966 #define GCPRO1(varname) ((void) gcpro1)
2967 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2968 #define GCPRO3(varname1, varname2, varname3) \
2969 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2970 #define GCPRO4(varname1, varname2, varname3, varname4) \
2971 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2972 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2973 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2974 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2975 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2977 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2978 #define UNGCPRO ((void) 0)
2980 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2981 #define RETURN_UNGCPRO(expr) \
2984 Lisp_Object ret_ungc_val; \
2985 ret_ungc_val = (expr); \
2987 return ret_ungc_val; \
2991 /* Call staticpro (&var) to protect static variable `var'. */
2993 void staticpro (Lisp_Object
*);
2995 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2996 meaning as in the DEFUN macro, and is used to construct a prototype. */
2997 /* We can use the same trick as in the DEFUN macro to generate the
2998 appropriate prototype. */
2999 #define EXFUN(fnname, maxargs) \
3000 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
3002 #include "globals.h"
3004 /* Forward declarations for prototypes. */
3008 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3011 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3013 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3014 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3017 /* Functions to modify hash tables. */
3020 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3022 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3026 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3028 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3031 /* Use these functions to set Lisp_Object
3032 or pointer slots of struct Lisp_Symbol. */
3035 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3037 XSYMBOL (sym
)->function
= function
;
3041 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3043 XSYMBOL (sym
)->plist
= plist
;
3047 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3049 XSYMBOL (sym
)->next
= next
;
3052 /* Buffer-local (also frame-local) variable access functions. */
3055 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3057 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3061 /* Set overlay's property list. */
3064 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3066 XOVERLAY (overlay
)->plist
= plist
;
3069 /* Get text properties of S. */
3072 string_intervals (Lisp_Object s
)
3074 return XSTRING (s
)->intervals
;
3077 /* Set text properties of S to I. */
3080 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3082 XSTRING (s
)->intervals
= i
;
3085 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3086 of setting slots directly. */
3089 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3091 XCHAR_TABLE (table
)->defalt
= val
;
3094 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3096 XCHAR_TABLE (table
)->purpose
= val
;
3099 /* Set different slots in (sub)character tables. */
3102 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3104 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3105 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3109 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3111 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3112 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3116 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3118 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3121 /* Defined in data.c. */
3122 extern Lisp_Object Qquote
, Qunbound
;
3123 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
3124 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
3125 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
3126 extern Lisp_Object Qinvalid_read_syntax
;
3127 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
3128 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
3129 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
3130 extern Lisp_Object Qtext_read_only
;
3131 extern Lisp_Object Qinteractive_form
;
3132 extern Lisp_Object Qcircular_list
;
3133 extern Lisp_Object Qsequencep
;
3134 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
3135 extern Lisp_Object Qfboundp
;
3137 extern Lisp_Object Qcdr
;
3139 extern Lisp_Object Qrange_error
, Qoverflow_error
;
3141 extern Lisp_Object Qnumber_or_marker_p
;
3143 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
3145 /* Defined in data.c. */
3146 extern Lisp_Object
indirect_function (Lisp_Object
);
3147 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3148 enum Arith_Comparison
{
3153 ARITH_LESS_OR_EQUAL
,
3156 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3157 enum Arith_Comparison comparison
);
3159 /* Convert the integer I to an Emacs representation, either the integer
3160 itself, or a cons of two or three integers, or if all else fails a float.
3161 I should not have side effects. */
3162 #define INTEGER_TO_CONS(i) \
3163 (! FIXNUM_OVERFLOW_P (i) \
3165 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3166 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3167 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3168 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3169 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3170 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3171 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3172 ? Fcons (make_number ((i) >> 16 >> 24), \
3173 Fcons (make_number ((i) >> 16 & 0xffffff), \
3174 make_number ((i) & 0xffff))) \
3177 /* Convert the Emacs representation CONS back to an integer of type
3178 TYPE, storing the result the variable VAR. Signal an error if CONS
3179 is not a valid representation or is out of range for TYPE. */
3180 #define CONS_TO_INTEGER(cons, type, var) \
3181 (TYPE_SIGNED (type) \
3182 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3183 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3184 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3185 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3187 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3188 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3189 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3191 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3192 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3193 extern void syms_of_data (void);
3194 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3196 /* Defined in cmds.c */
3197 extern void syms_of_cmds (void);
3198 extern void keys_of_cmds (void);
3200 /* Defined in coding.c. */
3201 extern Lisp_Object Qcharset
;
3202 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3203 ptrdiff_t, bool, bool, Lisp_Object
);
3204 extern void init_coding (void);
3205 extern void init_coding_once (void);
3206 extern void syms_of_coding (void);
3208 /* Defined in character.c. */
3209 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3210 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3211 extern void syms_of_character (void);
3213 /* Defined in charset.c. */
3214 extern void init_charset (void);
3215 extern void init_charset_once (void);
3216 extern void syms_of_charset (void);
3217 /* Structure forward declarations. */
3220 /* Defined in syntax.c. */
3221 extern void init_syntax_once (void);
3222 extern void syms_of_syntax (void);
3224 /* Defined in fns.c. */
3225 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3226 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3227 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3228 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3229 extern void sweep_weak_hash_tables (void);
3230 extern Lisp_Object Qcursor_in_echo_area
;
3231 extern Lisp_Object Qstring_lessp
;
3232 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3233 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3234 EMACS_UINT
sxhash (Lisp_Object
, int);
3235 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3236 Lisp_Object
, Lisp_Object
);
3237 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3238 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3240 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3241 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3242 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3243 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3244 ptrdiff_t, ptrdiff_t);
3245 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3246 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3247 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3248 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3249 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3250 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3251 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3252 extern void clear_string_char_byte_cache (void);
3253 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3254 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3255 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3256 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3257 extern void syms_of_fns (void);
3259 /* Defined in floatfns.c. */
3260 extern void syms_of_floatfns (void);
3261 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3263 /* Defined in fringe.c. */
3264 extern void syms_of_fringe (void);
3265 extern void init_fringe (void);
3266 #ifdef HAVE_WINDOW_SYSTEM
3267 extern void mark_fringe_data (void);
3268 extern void init_fringe_once (void);
3269 #endif /* HAVE_WINDOW_SYSTEM */
3271 /* Defined in image.c. */
3272 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3273 extern Lisp_Object QCconversion
;
3274 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3275 extern void reset_image_types (void);
3276 extern void syms_of_image (void);
3278 /* Defined in insdel.c. */
3279 extern Lisp_Object Qinhibit_modification_hooks
;
3280 extern Lisp_Object Qregion_extract_function
;
3281 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3282 extern _Noreturn
void buffer_overflow (void);
3283 extern void make_gap (ptrdiff_t);
3284 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3285 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3286 ptrdiff_t, bool, bool);
3287 extern int count_combining_before (const unsigned char *,
3288 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3289 extern int count_combining_after (const unsigned char *,
3290 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3291 extern void insert (const char *, ptrdiff_t);
3292 extern void insert_and_inherit (const char *, ptrdiff_t);
3293 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3295 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3296 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3297 ptrdiff_t, ptrdiff_t, bool);
3298 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3299 extern void insert_char (int);
3300 extern void insert_string (const char *);
3301 extern void insert_before_markers (const char *, ptrdiff_t);
3302 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3303 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3304 ptrdiff_t, ptrdiff_t,
3306 extern void del_range (ptrdiff_t, ptrdiff_t);
3307 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3308 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3309 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3310 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3311 ptrdiff_t, ptrdiff_t, bool);
3312 extern void modify_text (ptrdiff_t, ptrdiff_t);
3313 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3314 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3315 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3316 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3317 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3318 ptrdiff_t, ptrdiff_t);
3319 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3320 ptrdiff_t, ptrdiff_t);
3321 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3322 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3323 const char *, ptrdiff_t, ptrdiff_t, bool);
3324 extern void syms_of_insdel (void);
3326 /* Defined in dispnew.c. */
3327 #if (defined PROFILING \
3328 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3329 _Noreturn
void __executable_start (void);
3331 extern Lisp_Object Vwindow_system
;
3332 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3334 /* Defined in xdisp.c. */
3335 extern Lisp_Object Qinhibit_point_motion_hooks
;
3336 extern Lisp_Object Qinhibit_redisplay
;
3337 extern Lisp_Object Qmenu_bar_update_hook
;
3338 extern Lisp_Object Qwindow_scroll_functions
;
3339 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3340 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3341 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3342 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3343 extern Lisp_Object Qleft_margin
, Qright_margin
;
3344 extern Lisp_Object QCdata
, QCfile
;
3345 extern Lisp_Object QCmap
;
3346 extern Lisp_Object Qrisky_local_variable
;
3347 extern bool noninteractive_need_newline
;
3348 extern Lisp_Object echo_area_buffer
[2];
3349 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3350 extern void check_message_stack (void);
3351 extern void setup_echo_area_for_printing (int);
3352 extern bool push_message (void);
3353 extern void pop_message_unwind (void);
3354 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3355 extern void restore_message (void);
3356 extern Lisp_Object
current_message (void);
3357 extern void clear_message (bool, bool);
3358 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3359 extern void message1 (const char *);
3360 extern void message1_nolog (const char *);
3361 extern void message3 (Lisp_Object
);
3362 extern void message3_nolog (Lisp_Object
);
3363 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3364 extern void message_with_string (const char *, Lisp_Object
, int);
3365 extern void message_log_maybe_newline (void);
3366 extern void update_echo_area (void);
3367 extern void truncate_echo_area (ptrdiff_t);
3368 extern void redisplay (void);
3370 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3371 extern void syms_of_xdisp (void);
3372 extern void init_xdisp (void);
3373 extern Lisp_Object
safe_eval (Lisp_Object
);
3374 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3375 int *, int *, int *, int *, int *);
3377 /* Defined in xsettings.c. */
3378 extern void syms_of_xsettings (void);
3380 /* Defined in vm-limit.c. */
3381 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3383 /* Defined in alloc.c. */
3384 extern void check_pure_size (void);
3385 extern void free_misc (Lisp_Object
);
3386 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3387 extern void malloc_warning (const char *);
3388 extern _Noreturn
void memory_full (size_t);
3389 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3390 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3391 extern void refill_memory_reserve (void);
3393 extern const char *pending_malloc_warning
;
3394 extern Lisp_Object zero_vector
;
3395 extern Lisp_Object
list1 (Lisp_Object
);
3396 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3397 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3398 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3399 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3401 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3402 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3404 /* Build a frequently used 2/3/4-integer lists. */
3407 list2i (EMACS_INT x
, EMACS_INT y
)
3409 return list2 (make_number (x
), make_number (y
));
3413 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3415 return list3 (make_number (x
), make_number (y
), make_number (w
));
3419 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3421 return list4 (make_number (x
), make_number (y
),
3422 make_number (w
), make_number (h
));
3425 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3426 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3427 extern _Noreturn
void string_overflow (void);
3428 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3429 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3430 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3431 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3433 /* Make unibyte string from C string when the length isn't known. */
3436 build_unibyte_string (const char *str
)
3438 return make_unibyte_string (str
, strlen (str
));
3441 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3442 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3443 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3444 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3445 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3446 extern Lisp_Object
make_specified_string (const char *,
3447 ptrdiff_t, ptrdiff_t, bool);
3448 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3449 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3451 /* Make a string allocated in pure space, use STR as string data. */
3454 build_pure_c_string (const char *str
)
3456 return make_pure_c_string (str
, strlen (str
));
3459 /* Make a string from the data at STR, treating it as multibyte if the
3463 build_string (const char *str
)
3465 return make_string (str
, strlen (str
));
3468 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3469 extern void make_byte_code (struct Lisp_Vector
*);
3470 extern Lisp_Object Qchar_table_extra_slots
;
3471 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3473 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3474 be sure that GC cannot happen until the vector is completely
3475 initialized. E.g. the following code is likely to crash:
3477 v = make_uninit_vector (3);
3479 ASET (v, 1, Ffunction_can_gc ());
3480 ASET (v, 2, obj1); */
3483 make_uninit_vector (ptrdiff_t size
)
3486 struct Lisp_Vector
*p
;
3488 p
= allocate_vector (size
);
3493 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3494 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3496 allocate_pseudovector \
3497 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3498 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3499 extern struct window
*allocate_window (void);
3500 extern struct frame
*allocate_frame (void);
3501 extern struct Lisp_Process
*allocate_process (void);
3502 extern struct terminal
*allocate_terminal (void);
3503 extern Lisp_Object
make_float (double);
3504 extern void display_malloc_warning (void);
3505 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3506 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3507 Lisp_Object
, Lisp_Object
);
3508 extern Lisp_Object
make_save_ptr (void *);
3509 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3510 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3511 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3513 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3514 extern void free_save_value (Lisp_Object
);
3515 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3516 extern void init_alloc_once (void);
3517 extern void init_alloc (void);
3518 extern void syms_of_alloc (void);
3519 extern struct buffer
* allocate_buffer (void);
3520 extern int valid_lisp_object_p (Lisp_Object
);
3521 extern int relocatable_string_data_p (const char *);
3524 /* Defined in ralloc.c. */
3525 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3526 extern void r_alloc_free (void **);
3527 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3528 extern void r_alloc_reset_variable (void **, void **);
3529 extern void r_alloc_inhibit_buffer_relocation (int);
3532 /* Defined in chartab.c. */
3533 extern Lisp_Object
copy_char_table (Lisp_Object
);
3534 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3536 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3537 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3539 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3540 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3541 Lisp_Object
, Lisp_Object
,
3542 Lisp_Object
, struct charset
*,
3543 unsigned, unsigned);
3544 extern Lisp_Object
uniprop_table (Lisp_Object
);
3545 extern void syms_of_chartab (void);
3547 /* Defined in print.c. */
3548 extern Lisp_Object Vprin1_to_string_buffer
;
3549 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3550 extern Lisp_Object Qstandard_output
;
3551 extern Lisp_Object Qexternal_debugging_output
;
3552 extern void temp_output_buffer_setup (const char *);
3553 extern int print_level
;
3554 extern Lisp_Object Qprint_escape_newlines
;
3555 extern void write_string (const char *, int);
3556 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3558 extern Lisp_Object internal_with_output_to_temp_buffer
3559 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3560 #define FLOAT_TO_STRING_BUFSIZE 350
3561 extern int float_to_string (char *, double);
3562 extern void init_print_once (void);
3563 extern void syms_of_print (void);
3565 /* Defined in doprnt.c. */
3566 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3568 extern ptrdiff_t esprintf (char *, char const *, ...)
3569 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3570 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3572 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3573 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3574 char const *, va_list)
3575 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3577 /* Defined in lread.c. */
3578 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3579 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3580 extern Lisp_Object Qlexical_binding
;
3581 extern Lisp_Object
check_obarray (Lisp_Object
);
3582 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3583 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3584 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3586 LOADHIST_ATTACH (Lisp_Object x
)
3589 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3591 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3592 Lisp_Object
*, Lisp_Object
, bool);
3593 extern Lisp_Object
string_to_number (char const *, int, bool);
3594 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3596 extern void dir_warning (const char *, Lisp_Object
);
3597 extern void init_obarray (void);
3598 extern void init_lread (void);
3599 extern void syms_of_lread (void);
3602 intern (const char *str
)
3604 return intern_1 (str
, strlen (str
));
3608 intern_c_string (const char *str
)
3610 return intern_c_string_1 (str
, strlen (str
));
3613 /* Defined in eval.c. */
3614 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3615 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3616 extern Lisp_Object Qand_rest
;
3617 extern Lisp_Object Vautoload_queue
;
3618 extern Lisp_Object Vsignaling_function
;
3619 extern Lisp_Object inhibit_lisp_code
;
3620 extern struct handler
*handlerlist
;
3622 /* To run a normal hook, use the appropriate function from the list below.
3623 The calling convention:
3625 if (!NILP (Vrun_hooks))
3626 call1 (Vrun_hooks, Qmy_funny_hook);
3628 should no longer be used. */
3629 extern Lisp_Object Vrun_hooks
;
3630 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3631 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3632 Lisp_Object (*funcall
)
3633 (ptrdiff_t nargs
, Lisp_Object
*args
));
3634 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3635 extern _Noreturn
void xsignal0 (Lisp_Object
);
3636 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3637 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3638 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3640 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3641 extern Lisp_Object
eval_sub (Lisp_Object form
);
3642 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3643 extern Lisp_Object
call0 (Lisp_Object
);
3644 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3645 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3646 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3647 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3648 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3649 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3650 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3651 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3652 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3653 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3654 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3655 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3656 extern Lisp_Object internal_condition_case_n
3657 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3658 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3659 extern void specbind (Lisp_Object
, Lisp_Object
);
3660 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3661 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3662 extern void record_unwind_protect_int (void (*) (int), int);
3663 extern void record_unwind_protect_void (void (*) (void));
3664 extern void record_unwind_protect_nothing (void);
3665 extern void clear_unwind_protect (ptrdiff_t);
3666 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3667 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3668 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3669 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3670 extern _Noreturn
void verror (const char *, va_list)
3671 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3672 extern void un_autoload (Lisp_Object
);
3673 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3674 extern void init_eval_once (void);
3675 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3676 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3677 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3678 extern void init_eval (void);
3679 extern void syms_of_eval (void);
3680 extern void unwind_body (Lisp_Object
);
3681 extern void record_in_backtrace (Lisp_Object function
,
3682 Lisp_Object
*args
, ptrdiff_t nargs
);
3683 extern void mark_specpdl (void);
3684 extern void get_backtrace (Lisp_Object array
);
3685 Lisp_Object
backtrace_top_function (void);
3686 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3687 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3690 /* Defined in editfns.c. */
3691 extern Lisp_Object Qfield
;
3692 extern void insert1 (Lisp_Object
);
3693 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3694 extern Lisp_Object
save_excursion_save (void);
3695 extern Lisp_Object
save_restriction_save (void);
3696 extern void save_excursion_restore (Lisp_Object
);
3697 extern void save_restriction_restore (Lisp_Object
);
3698 extern _Noreturn
void time_overflow (void);
3699 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3700 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3702 extern void init_editfns (void);
3703 extern void syms_of_editfns (void);
3704 extern void set_time_zone_rule (const char *);
3706 /* Defined in buffer.c. */
3707 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3708 extern _Noreturn
void nsberror (Lisp_Object
);
3709 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3710 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3711 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3712 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3713 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3714 extern bool overlay_touches_p (ptrdiff_t);
3715 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3716 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3717 extern void init_buffer_once (void);
3718 extern void init_buffer (int);
3719 extern void syms_of_buffer (void);
3720 extern void keys_of_buffer (void);
3722 /* Defined in marker.c. */
3724 extern ptrdiff_t marker_position (Lisp_Object
);
3725 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3726 extern void clear_charpos_cache (struct buffer
*);
3727 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3728 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3729 extern void unchain_marker (struct Lisp_Marker
*marker
);
3730 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3731 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3732 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3733 ptrdiff_t, ptrdiff_t);
3734 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3735 extern void syms_of_marker (void);
3737 /* Defined in fileio.c. */
3739 extern Lisp_Object Qfile_error
;
3740 extern Lisp_Object Qfile_notify_error
;
3741 extern Lisp_Object Qfile_exists_p
;
3742 extern Lisp_Object Qfile_directory_p
;
3743 extern Lisp_Object Qinsert_file_contents
;
3744 extern Lisp_Object Qfile_name_history
;
3745 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3746 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3747 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3749 extern void close_file_unwind (int);
3750 extern void fclose_unwind (void *);
3751 extern void restore_point_unwind (Lisp_Object
);
3752 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3753 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3754 extern bool internal_delete_file (Lisp_Object
);
3755 extern Lisp_Object
emacs_readlinkat (int, const char *);
3756 extern bool file_directory_p (const char *);
3757 extern bool file_accessible_directory_p (const char *);
3758 extern void init_fileio (void);
3759 extern void syms_of_fileio (void);
3760 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3761 extern Lisp_Object Qdelete_file
;
3763 /* Defined in search.c. */
3764 extern void shrink_regexp_cache (void);
3765 extern void restore_search_regs (void);
3766 extern void record_unwind_save_match_data (void);
3767 struct re_registers
;
3768 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3769 struct re_registers
*,
3770 Lisp_Object
, bool, bool);
3771 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3772 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3774 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3775 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3776 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3777 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3778 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3779 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3781 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3782 ptrdiff_t, ptrdiff_t *);
3783 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3784 ptrdiff_t, ptrdiff_t *);
3785 extern void syms_of_search (void);
3786 extern void clear_regexp_cache (void);
3788 /* Defined in minibuf.c. */
3790 extern Lisp_Object Qcompletion_ignore_case
;
3791 extern Lisp_Object Vminibuffer_list
;
3792 extern Lisp_Object last_minibuf_string
;
3793 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3794 extern void init_minibuf_once (void);
3795 extern void syms_of_minibuf (void);
3797 /* Defined in callint.c. */
3799 extern Lisp_Object Qminus
, Qplus
;
3800 extern Lisp_Object Qprogn
;
3801 extern Lisp_Object Qwhen
;
3802 extern Lisp_Object Qmouse_leave_buffer_hook
;
3803 extern void syms_of_callint (void);
3805 /* Defined in casefiddle.c. */
3807 extern Lisp_Object Qidentity
;
3808 extern void syms_of_casefiddle (void);
3809 extern void keys_of_casefiddle (void);
3811 /* Defined in casetab.c. */
3813 extern void init_casetab_once (void);
3814 extern void syms_of_casetab (void);
3816 /* Defined in keyboard.c. */
3818 extern Lisp_Object echo_message_buffer
;
3819 extern struct kboard
*echo_kboard
;
3820 extern void cancel_echoing (void);
3821 extern Lisp_Object Qdisabled
, QCfilter
;
3822 extern Lisp_Object Qup
, Qdown
;
3823 extern Lisp_Object last_undo_boundary
;
3824 extern bool input_pending
;
3825 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3826 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3827 extern void discard_mouse_events (void);
3829 void handle_input_available_signal (int);
3831 extern Lisp_Object pending_funcalls
;
3832 extern bool detect_input_pending (void);
3833 extern bool detect_input_pending_ignore_squeezables (void);
3834 extern bool detect_input_pending_run_timers (bool);
3835 extern void safe_run_hooks (Lisp_Object
);
3836 extern void cmd_error_internal (Lisp_Object
, const char *);
3837 extern Lisp_Object
command_loop_1 (void);
3838 extern Lisp_Object
read_menu_command (void);
3839 extern Lisp_Object
recursive_edit_1 (void);
3840 extern void record_auto_save (void);
3841 extern void force_auto_save_soon (void);
3842 extern void init_keyboard (void);
3843 extern void syms_of_keyboard (void);
3844 extern void keys_of_keyboard (void);
3846 /* Defined in indent.c. */
3847 extern ptrdiff_t current_column (void);
3848 extern void invalidate_current_column (void);
3849 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3850 extern void syms_of_indent (void);
3852 /* Defined in frame.c. */
3853 extern Lisp_Object Qonly
, Qnone
;
3854 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3855 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3856 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3857 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3858 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3859 extern void frames_discard_buffer (Lisp_Object
);
3860 extern void syms_of_frame (void);
3862 /* Defined in emacs.c. */
3863 extern char **initial_argv
;
3864 extern int initial_argc
;
3865 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3866 extern bool display_arg
;
3868 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3869 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3870 extern Lisp_Object Qfile_name_handler_alist
;
3871 extern _Noreturn
void terminate_due_to_signal (int, int);
3872 extern Lisp_Object Qkill_emacs
;
3874 extern Lisp_Object Vlibrary_cache
;
3877 void fixup_locale (void);
3878 void synchronize_system_messages_locale (void);
3879 void synchronize_system_time_locale (void);
3881 INLINE
void fixup_locale (void) {}
3882 INLINE
void synchronize_system_messages_locale (void) {}
3883 INLINE
void synchronize_system_time_locale (void) {}
3885 extern void shut_down_emacs (int, Lisp_Object
);
3887 /* True means don't do interactive redisplay and don't change tty modes. */
3888 extern bool noninteractive
;
3890 /* True means remove site-lisp directories from load-path. */
3891 extern bool no_site_lisp
;
3893 /* Pipe used to send exit notification to the daemon parent at
3895 extern int daemon_pipe
[2];
3896 #define IS_DAEMON (daemon_pipe[1] != 0)
3898 /* True if handling a fatal error already. */
3899 extern bool fatal_error_in_progress
;
3901 /* True means don't do use window-system-specific display code. */
3902 extern bool inhibit_window_system
;
3903 /* True means that a filter or a sentinel is running. */
3904 extern bool running_asynch_code
;
3906 /* Defined in process.c. */
3907 extern Lisp_Object QCtype
, Qlocal
;
3908 extern void kill_buffer_processes (Lisp_Object
);
3909 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3910 struct Lisp_Process
*, int);
3911 /* Max value for the first argument of wait_reading_process_output. */
3912 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3913 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3914 The bug merely causes a bogus warning, but the warning is annoying. */
3915 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3917 # define WAIT_READING_MAX INTMAX_MAX
3919 extern void add_keyboard_wait_descriptor (int);
3920 extern void delete_keyboard_wait_descriptor (int);
3922 extern void add_gpm_wait_descriptor (int);
3923 extern void delete_gpm_wait_descriptor (int);
3925 extern void init_process_emacs (void);
3926 extern void syms_of_process (void);
3927 extern void setup_process_coding_systems (Lisp_Object
);
3929 /* Defined in callproc.c. */
3933 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3934 extern void init_callproc_1 (void);
3935 extern void init_callproc (void);
3936 extern void set_initial_environment (void);
3937 extern void syms_of_callproc (void);
3939 /* Defined in doc.c. */
3940 extern Lisp_Object Qfunction_documentation
;
3941 extern Lisp_Object
read_doc_string (Lisp_Object
);
3942 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3943 extern void syms_of_doc (void);
3944 extern int read_bytecode_char (bool);
3946 /* Defined in bytecode.c. */
3947 extern void syms_of_bytecode (void);
3948 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3949 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3951 /* Defined in macros.c. */
3952 extern void init_macros (void);
3953 extern void syms_of_macros (void);
3955 /* Defined in undo.c. */
3956 extern Lisp_Object Qapply
;
3957 extern Lisp_Object Qinhibit_read_only
;
3958 extern void truncate_undo_list (struct buffer
*);
3959 extern void record_insert (ptrdiff_t, ptrdiff_t);
3960 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3961 extern void record_first_change (void);
3962 extern void record_change (ptrdiff_t, ptrdiff_t);
3963 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3964 Lisp_Object
, Lisp_Object
,
3966 extern void syms_of_undo (void);
3967 /* Defined in textprop.c. */
3968 extern Lisp_Object Qmouse_face
;
3969 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3970 extern Lisp_Object Qminibuffer_prompt
;
3972 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3974 /* Defined in menu.c. */
3975 extern void syms_of_menu (void);
3977 /* Defined in xmenu.c. */
3978 extern void syms_of_xmenu (void);
3980 /* Defined in termchar.h. */
3981 struct tty_display_info
;
3983 /* Defined in termhooks.h. */
3986 /* Defined in sysdep.c. */
3987 #ifndef HAVE_GET_CURRENT_DIR_NAME
3988 extern char *get_current_dir_name (void);
3990 extern void stuff_char (char c
);
3991 extern void init_foreground_group (void);
3992 extern void sys_subshell (void);
3993 extern void sys_suspend (void);
3994 extern void discard_tty_input (void);
3995 extern void init_sys_modes (struct tty_display_info
*);
3996 extern void reset_sys_modes (struct tty_display_info
*);
3997 extern void init_all_sys_modes (void);
3998 extern void reset_all_sys_modes (void);
3999 extern void child_setup_tty (int);
4000 extern void setup_pty (int);
4001 extern int set_window_size (int, int, int);
4002 extern EMACS_INT
get_random (void);
4003 extern void seed_random (void *, ptrdiff_t);
4004 extern void init_random (void);
4005 extern void emacs_backtrace (int);
4006 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4007 extern int emacs_open (const char *, int, int);
4008 extern int emacs_pipe (int[2]);
4009 extern int emacs_close (int);
4010 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4011 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4012 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4013 extern void emacs_perror (char const *);
4015 extern void unlock_all_files (void);
4016 extern void lock_file (Lisp_Object
);
4017 extern void unlock_file (Lisp_Object
);
4018 extern void unlock_buffer (struct buffer
*);
4019 extern void syms_of_filelock (void);
4021 /* Defined in sound.c. */
4022 extern void syms_of_sound (void);
4024 /* Defined in category.c. */
4025 extern void init_category_once (void);
4026 extern Lisp_Object
char_category_set (int);
4027 extern void syms_of_category (void);
4029 /* Defined in ccl.c. */
4030 extern void syms_of_ccl (void);
4032 /* Defined in dired.c. */
4033 extern void syms_of_dired (void);
4034 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4035 Lisp_Object
, Lisp_Object
,
4038 /* Defined in term.c. */
4039 extern int *char_ins_del_vector
;
4040 extern void syms_of_term (void);
4041 extern _Noreturn
void fatal (const char *msgid
, ...)
4042 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4044 /* Defined in terminal.c. */
4045 extern void syms_of_terminal (void);
4047 /* Defined in font.c. */
4048 extern void syms_of_font (void);
4049 extern void init_font (void);
4051 #ifdef HAVE_WINDOW_SYSTEM
4052 /* Defined in fontset.c. */
4053 extern void syms_of_fontset (void);
4055 /* Defined in xfns.c, w32fns.c, or macfns.c. */
4056 extern Lisp_Object Qfont_param
;
4059 /* Defined in gfilenotify.c */
4060 #ifdef HAVE_GFILENOTIFY
4061 extern void globals_of_gfilenotify (void);
4062 extern void syms_of_gfilenotify (void);
4065 /* Defined in inotify.c */
4067 extern void syms_of_inotify (void);
4070 #ifdef HAVE_W32NOTIFY
4071 /* Defined on w32notify.c. */
4072 extern void syms_of_w32notify (void);
4075 /* Defined in xfaces.c. */
4076 extern Lisp_Object Qdefault
, Qfringe
;
4077 extern Lisp_Object Qscroll_bar
, Qcursor
;
4078 extern Lisp_Object Qmode_line_inactive
;
4079 extern Lisp_Object Qface
;
4080 extern Lisp_Object Qnormal
;
4081 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
4082 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
4083 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
4084 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
4085 extern Lisp_Object Qoblique
, Qitalic
;
4086 extern Lisp_Object Vface_alternative_font_family_alist
;
4087 extern Lisp_Object Vface_alternative_font_registry_alist
;
4088 extern void syms_of_xfaces (void);
4090 #ifdef HAVE_X_WINDOWS
4091 /* Defined in xfns.c. */
4092 extern void syms_of_xfns (void);
4094 /* Defined in xsmfns.c. */
4095 extern void syms_of_xsmfns (void);
4097 /* Defined in xselect.c. */
4098 extern void syms_of_xselect (void);
4100 /* Defined in xterm.c. */
4101 extern void syms_of_xterm (void);
4102 #endif /* HAVE_X_WINDOWS */
4104 #ifdef HAVE_WINDOW_SYSTEM
4105 /* Defined in xterm.c, nsterm.m, w32term.c. */
4106 extern char *x_get_keysym_name (int);
4107 #endif /* HAVE_WINDOW_SYSTEM */
4110 /* Defined in xml.c. */
4111 extern void syms_of_xml (void);
4112 extern void xml_cleanup_parser (void);
4116 /* Defined in decompress.c. */
4117 extern void syms_of_decompress (void);
4121 /* Defined in dbusbind.c. */
4122 void syms_of_dbusbind (void);
4126 /* Defined in profiler.c. */
4127 extern bool profiler_memory_running
;
4128 extern void malloc_probe (size_t);
4129 extern void syms_of_profiler (void);
4133 /* Defined in msdos.c, w32.c. */
4134 extern char *emacs_root_dir (void);
4137 /* True means ^G can quit instantly. */
4138 extern bool immediate_quit
;
4140 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4141 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4142 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4143 extern void xfree (void *);
4144 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4145 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4146 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4147 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4148 ATTRIBUTE_ALLOC_SIZE ((2,3));
4149 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4150 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4151 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4152 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4153 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4155 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4156 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4157 extern void dupstring (char **, char const *);
4158 extern void xputenv (const char *);
4160 extern char *egetenv (const char *);
4162 /* Copy Lisp string to temporary (allocated on stack) C string. */
4164 #define xlispstrdupa(string) \
4165 memcpy (alloca (SBYTES (string) + 1), \
4166 SSDATA (string), SBYTES (string) + 1)
4168 /* Set up the name of the machine we're running on. */
4169 extern void init_system_name (void);
4171 /* Return the absolute value of X. X should be a signed integer
4172 expression without side effects, and X's absolute value should not
4173 exceed the maximum for its promoted type. This is called 'eabs'
4174 because 'abs' is reserved by the C standard. */
4175 #define eabs(x) ((x) < 0 ? -(x) : (x))
4177 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4180 #define make_fixnum_or_float(val) \
4181 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4183 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4184 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4186 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4188 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4190 #define USE_SAFE_ALLOCA \
4191 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4193 /* SAFE_ALLOCA allocates a simple buffer. */
4195 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4197 : (sa_must_free = true, record_xmalloc (size)))
4199 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4200 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4201 positive. The code is tuned for MULTIPLIER being a constant. */
4203 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4205 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4206 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4209 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4210 sa_must_free = true; \
4211 record_unwind_protect_ptr (xfree, buf); \
4215 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4217 #define SAFE_FREE() \
4219 if (sa_must_free) { \
4220 sa_must_free = false; \
4221 unbind_to (sa_count, Qnil); \
4226 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4228 #define SAFE_ALLOCA_LISP(buf, nelt) \
4230 if ((nelt) < MAX_ALLOCA / word_size) \
4231 (buf) = alloca ((nelt) * word_size); \
4232 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4235 (buf) = xmalloc ((nelt) * word_size); \
4236 arg_ = make_save_memory (buf, nelt); \
4237 sa_must_free = true; \
4238 record_unwind_protect (free_save_value, arg_); \
4241 memory_full (SIZE_MAX); \
4244 /* Loop over all tails of a list, checking for cycles.
4245 FIXME: Make tortoise and n internal declarations.
4246 FIXME: Unroll the loop body so we don't need `n'. */
4247 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4248 for ((tortoise) = (hare) = (list), (n) = true; \
4250 (hare = XCDR (hare), (n) = !(n), \
4252 ? (EQ (hare, tortoise) \
4253 ? xsignal1 (Qcircular_list, list) \
4255 /* Move tortoise before the next iteration, in case */ \
4256 /* the next iteration does an Fsetcdr. */ \
4257 : (void) ((tortoise) = XCDR (tortoise)))))
4259 /* Do a `for' loop over alist values. */
4261 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4262 for ((list_var) = (head_var); \
4263 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4264 (list_var) = XCDR (list_var))
4266 /* Check whether it's time for GC, and run it if so. */
4275 functionp (Lisp_Object object
)
4277 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4279 object
= Findirect_function (object
, Qt
);
4281 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4283 /* Autoloaded symbols are functions, except if they load
4284 macros or keymaps. */
4286 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4287 object
= XCDR (object
);
4289 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4294 return XSUBR (object
)->max_args
!= UNEVALLED
;
4295 else if (COMPILEDP (object
))
4297 else if (CONSP (object
))
4299 Lisp_Object car
= XCAR (object
);
4300 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4308 #endif /* EMACS_LISP_H */