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 */
102 typedef scm_t_signed_bits EMACS_INT
;
103 typedef scm_t_bits EMACS_UINT
;
104 #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX
106 #if INTPTR_MAX == INT_MAX
108 #elif INTPTR_MAX == LONG_MAX
110 #elif INTPTR_MAX == LLONG_MAX
112 #elif INTPTR_MAX == INTMAX_MAX
115 #error "Cannot determine length modifier for EMACS_INT"
118 /* Number of bits to put in each character in the internal representation
119 of bool vectors. This should not vary across implementations. */
120 enum { BOOL_VECTOR_BITS_PER_CHAR
=
121 #define BOOL_VECTOR_BITS_PER_CHAR 8
122 BOOL_VECTOR_BITS_PER_CHAR
125 /* An unsigned integer type representing a fixed-length bit sequence,
126 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
127 for speed, but it is unsigned char on weird platforms. */
128 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
129 typedef size_t bits_word
;
130 # define BITS_WORD_MAX SIZE_MAX
131 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
133 typedef unsigned char bits_word
;
134 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
135 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
137 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
139 /* Number of bits in some machine integer types. */
142 BITS_PER_CHAR
= CHAR_BIT
,
143 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
144 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
145 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
148 /* printmax_t and uprintmax_t are types for printing large integers.
149 These are the widest integers that are supported for printing.
150 pMd etc. are conversions for printing them.
151 On C99 hosts, there's no problem, as even the widest integers work.
152 Fall back on EMACS_INT on pre-C99 hosts. */
154 typedef intmax_t printmax_t
;
155 typedef uintmax_t uprintmax_t
;
159 typedef EMACS_INT printmax_t
;
160 typedef EMACS_UINT uprintmax_t
;
165 /* Use pD to format ptrdiff_t values, which suffice for indexes into
166 buffers and strings. Emacs never allocates objects larger than
167 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
168 In C99, pD can always be "t"; configure it here for the sake of
169 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
170 #if PTRDIFF_MAX == INT_MAX
172 #elif PTRDIFF_MAX == LONG_MAX
174 #elif PTRDIFF_MAX == LLONG_MAX
180 /* Extra internal type checking? */
182 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
183 'assume (COND)'. COND should be free of side effects, as it may or
184 may not be evaluated.
186 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
187 defined and suppress_checking is false, and does nothing otherwise.
188 Emacs dies if COND is checked and is false. The suppress_checking
189 variable is initialized to 0 in alloc.c. Set it to 1 using a
190 debugger to temporarily disable aborting on detected internal
191 inconsistencies or error conditions.
193 In some cases, a good compiler may be able to optimize away the
194 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
195 uses eassert to test STRINGP (x), but a particular use of XSTRING
196 is invoked only after testing that STRINGP (x) is true, making the
199 eassume is like eassert except that it also causes the compiler to
200 assume that COND is true afterwards, regardless of whether runtime
201 checking is enabled. This can improve performance in some cases,
202 though it can degrade performance in others. It's often suboptimal
203 for COND to call external functions or access volatile storage. */
205 #ifndef ENABLE_CHECKING
206 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
207 # define eassume(cond) assume (cond)
208 #else /* ENABLE_CHECKING */
210 extern _Noreturn
void die (const char *, const char *, int);
212 extern bool suppress_checking EXTERNALLY_VISIBLE
;
214 # define eassert(cond) \
215 (suppress_checking || (cond) \
217 : die (# cond, __FILE__, __LINE__))
218 # define eassume(cond) \
223 : die (# cond, __FILE__, __LINE__))
224 #endif /* ENABLE_CHECKING */
229 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
230 integer constant, for MSVC. */
231 #define GCALIGNMENT 8
233 /* Number of bits in a Lisp fixnum value, not counting the tag. */
234 FIXNUM_BITS
= SCM_I_FIXNUM_BIT
237 #if GCALIGNMENT != 1 << GCTYPEBITS
238 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
241 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
242 #define USE_LSB_TAG 1
243 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
246 # define alignas(alignment) /* empty */
248 # error "USE_LSB_TAG requires alignas"
252 /* Some operations are so commonly executed that they are implemented
253 as macros, not functions, because otherwise runtime performance would
254 suffer too much when compiling with GCC without optimization.
255 There's no need to inline everything, just the operations that
256 would otherwise cause a serious performance problem.
258 For each such operation OP, define a macro lisp_h_OP that contains
259 the operation's implementation. That way, OP can be implemented
260 via a macro definition like this:
262 #define OP(x) lisp_h_OP (x)
264 and/or via a function definition like this:
266 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
268 which macro-expands to this:
270 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
272 without worrying about the implementations diverging, since
273 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
274 are intended to be private to this include file, and should not be
277 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
278 functions, once most developers have access to GCC 4.8 or later and
279 can use "gcc -Og" to debug. Maybe in the year 2016. See
282 Commentary for these macros can be found near their corresponding
285 #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a))
286 #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x))
287 #define lisp_h_XLI(o) (SCM_UNPACK (o))
288 #define lisp_h_XIL(i) (SCM_PACK (i))
289 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
290 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
291 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
292 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
293 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
294 #define lisp_h_CONSP(x) (SMOB_TYPEP (x, lisp_cons_tag))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (SMOB_TYPEP (x, lisp_float_tag))
297 #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x))
298 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
299 #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag))
300 #define lisp_h_NILP(x) EQ (x, Qnil)
301 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
302 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
303 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
304 #define lisp_h_SYMBOL_VAL(sym) \
305 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
306 #define lisp_h_SYMBOLP(x) (SMOB_TYPEP (x, lisp_symbol_tag))
307 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
308 #define lisp_h_XCAR(c) XCONS (c)->car
309 #define lisp_h_XCDR(c) XCONS (c)->cdr
310 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
311 #define lisp_h_XSYMBOL(a) \
312 (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) SMOB_PTR (a))
314 /* When compiling via gcc -O0, define the key operations as macros, as
315 Emacs is too slow otherwise. To disable this optimization, compile
316 with -DINLINING=false. */
318 #if (defined __NO_INLINE__ \
319 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
320 && ! (defined INLINING && ! INLINING))
321 # define XLI(o) lisp_h_XLI (o)
322 # define XIL(i) lisp_h_XIL (i)
323 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
324 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
325 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
326 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
327 # define CONSP(x) lisp_h_CONSP (x)
328 # define EQ(x, y) lisp_h_EQ (x, y)
329 # define FLOATP(x) lisp_h_FLOATP (x)
330 # define INTEGERP(x) lisp_h_INTEGERP (x)
331 # define MARKERP(x) lisp_h_MARKERP (x)
332 # define MISCP(x) lisp_h_MISCP (x)
333 # define NILP(x) lisp_h_NILP (x)
334 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
335 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
336 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
337 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
338 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
339 # define XCAR(c) lisp_h_XCAR (c)
340 # define XCDR(c) lisp_h_XCDR (c)
341 # define XCONS(a) lisp_h_XCONS (a)
342 # define XHASH(a) lisp_h_XHASH (a)
343 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
347 /* Define NAME as a lisp.h inline function that returns TYPE and has
348 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
349 ARGS should be parenthesized. Implement the function by calling
351 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
352 INLINE type (name) argdecls { return lisp_h_##name args; }
354 /* like LISP_MACRO_DEFUN, except NAME returns void. */
355 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
356 INLINE void (name) argdecls { lisp_h_##name args; }
359 /* Define the fundamental Lisp data structures. */
361 /* This is the set of Lisp data types. If you want to define a new
362 data type, read the comments after Lisp_Fwd_Type definition
365 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
366 #define case_Lisp_Int case Lisp_Int
368 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
369 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
370 vociferously about them. */
371 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
372 || (defined __SUNPRO_C && __STDC__))
373 #define ENUM_BF(TYPE) unsigned int
375 #define ENUM_BF(TYPE) enum TYPE
378 scm_t_bits lisp_symbol_tag
;
379 scm_t_bits lisp_misc_tag
;
380 scm_t_bits lisp_string_tag
;
381 scm_t_bits lisp_vectorlike_tag
;
382 scm_t_bits lisp_cons_tag
;
383 scm_t_bits lisp_float_tag
;
387 /* Integer. XINT (obj) is the integer value. */
390 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
393 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
394 whose first member indicates the subtype. */
397 /* String. XSTRING (object) points to a struct Lisp_String.
398 The length of the string, and its contents, are stored therein. */
401 /* Vector of Lisp objects, or something resembling it.
402 XVECTOR (object) points to a struct Lisp_Vector, which contains
403 the size and contents. The size field also contains the type
404 information, if it's not a real vector object. */
407 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
413 /* This is the set of data types that share a common structure.
414 The first member of the structure is a type code from this set.
415 The enum values are arbitrary, but we'll use large numbers to make it
416 more likely that we'll spot the error if a random word in memory is
417 mistakenly interpreted as a Lisp_Misc. */
420 Lisp_Misc_Free
= 0x5eab,
423 Lisp_Misc_Save_Value
,
424 /* Currently floats are not a misc type,
425 but let's define this in case we want to change that. */
427 /* This is not a type code. It is for range checking. */
431 /* These are the types of forwarding objects used in the value slot
432 of symbols for special built-in variables whose value is stored in
436 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
437 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
438 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
439 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
440 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
443 typedef SCM Lisp_Object
;
445 #define LISP_INITIALLY_ZERO SCM_INUM0
447 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
448 At the machine level, these operations are no-ops. */
449 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
450 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
452 /* In the size word of a struct Lisp_Vector, this bit means it's really
453 some other vector-like object. */
454 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
455 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
456 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
458 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
459 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
460 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
463 /* In a pseudovector, the size field actually contains a word with one
464 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
465 with PVEC_TYPE_MASK to indicate the actual type. */
477 PVEC_WINDOW_CONFIGURATION
,
480 /* These should be last, check internal_equal to see why. */
484 PVEC_FONT
/* Should be last because it's used for range checking. */
489 /* For convenience, we also store the number of elements in these bits.
490 Note that this size is not necessarily the memory-footprint size, but
491 only the number of Lisp_Object fields (that need to be traced by GC).
492 The distinction is used, e.g., by Lisp_Process, which places extra
493 non-Lisp_Object fields at the end of the structure. */
494 PSEUDOVECTOR_SIZE_BITS
= 12,
495 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
497 /* To calculate the memory footprint of the pseudovector, it's useful
498 to store the size of non-Lisp area in word_size units here. */
499 PSEUDOVECTOR_REST_BITS
= 12,
500 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
501 << PSEUDOVECTOR_SIZE_BITS
),
503 /* Used to extract pseudovector subtype information. */
504 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
505 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
508 /* These functions extract various sorts of values from a Lisp_Object.
509 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
510 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
513 /* Largest and smallest representable fixnum values. These are the C
514 values. They are macros for use in static initializers. */
515 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
516 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
518 /* Make a Lisp integer representing the value of the low order
521 make_number (EMACS_INT n
)
523 return SCM_I_MAKINUM (n
);
526 /* Extract A's value as a signed integer. */
530 return SCM_I_INUM (a
);
533 /* Like XINT (A), but may be faster. A must be nonnegative.
534 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
535 integers have zero-bits in their tags. */
537 XFASTINT (Lisp_Object a
)
539 EMACS_INT n
= XINT (a
);
544 /* Extract A's value as an unsigned integer. */
546 XUINT (Lisp_Object a
)
548 return SCM_I_INUM (a
);
551 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
552 right now, but XUINT should only be applied to objects we know are
554 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
556 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
558 make_natnum (EMACS_INT n
)
560 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
561 return make_number (n
);
564 /* Return true if X and Y are the same object. */
565 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
567 /* Value is true if I doesn't fit into a Lisp fixnum. It is
568 written this way so that it also works if I is of unsigned
569 type or if I is a NaN. */
571 #define FIXNUM_OVERFLOW_P(i) \
572 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
575 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
577 return num
< lower
? lower
: num
<= upper
? num
: upper
;
580 /* Forward declarations. */
582 /* Defined in this file. */
584 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
585 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
586 INLINE
bool BUFFERP (Lisp_Object
);
587 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
588 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
589 INLINE
bool (CONSP
) (Lisp_Object
);
590 INLINE
bool (FLOATP
) (Lisp_Object
);
591 INLINE
bool functionp (Lisp_Object
);
592 INLINE
bool (INTEGERP
) (Lisp_Object
);
593 INLINE
bool (MARKERP
) (Lisp_Object
);
594 INLINE
bool (MISCP
) (Lisp_Object
);
595 INLINE
bool (NILP
) (Lisp_Object
);
596 INLINE
bool OVERLAYP (Lisp_Object
);
597 INLINE
bool PROCESSP (Lisp_Object
);
598 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
599 INLINE
bool SAVE_VALUEP (Lisp_Object
);
600 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
602 INLINE
bool STRINGP (Lisp_Object
);
603 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
604 INLINE
bool SUBRP (Lisp_Object
);
605 INLINE
bool (SYMBOLP
) (Lisp_Object
);
606 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
607 INLINE
bool WINDOWP (Lisp_Object
);
608 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
610 /* Defined in chartab.c. */
611 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
612 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
613 extern int char_table_translate (Lisp_Object
, int);
615 /* Defined in data.c. */
616 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
617 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
618 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
619 extern Lisp_Object Qbool_vector_p
;
620 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
621 extern Lisp_Object Qwindow
;
622 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
624 /* Defined in emacs.c. */
625 extern bool might_dump
;
626 /* True means Emacs has already been initialized.
627 Used during startup to detect startup of dumped Emacs. */
628 extern bool initialized
;
630 /* Defined in eval.c. */
631 extern Lisp_Object Qautoload
;
633 /* Defined in floatfns.c. */
634 extern double extract_float (Lisp_Object
);
636 /* Defined in process.c. */
637 extern Lisp_Object Qprocessp
;
639 /* Defined in window.c. */
640 extern Lisp_Object Qwindowp
;
642 /* Defined in xdisp.c. */
643 extern Lisp_Object Qimage
;
645 /* Extract A's type. */
646 INLINE
enum Lisp_Type
647 XTYPE (Lisp_Object o
)
651 else if (SYMBOLP (o
))
655 else if (STRINGP (o
))
657 else if (VECTORLIKEP (o
))
658 return Lisp_Vectorlike
;
667 /* Extract a value or address from a Lisp_Object. */
669 INLINE
struct Lisp_Cons
*
670 XCONS (Lisp_Object a
)
676 INLINE
struct Lisp_Vector
*
677 XVECTOR (Lisp_Object a
)
679 eassert (VECTORLIKEP (a
));
683 INLINE
struct Lisp_String
*
684 XSTRING (Lisp_Object a
)
686 eassert (STRINGP (a
));
690 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
692 INLINE
struct Lisp_Float
*
693 XFLOAT (Lisp_Object a
)
695 eassert (FLOATP (a
));
699 /* Pseudovector types. */
701 INLINE
struct Lisp_Process
*
702 XPROCESS (Lisp_Object a
)
704 eassert (PROCESSP (a
));
708 INLINE
struct window
*
709 XWINDOW (Lisp_Object a
)
711 eassert (WINDOWP (a
));
715 INLINE
struct terminal
*
716 XTERMINAL (Lisp_Object a
)
721 INLINE
struct Lisp_Subr
*
722 XSUBR (Lisp_Object a
)
728 INLINE
struct buffer
*
729 XBUFFER (Lisp_Object a
)
731 eassert (BUFFERP (a
));
735 INLINE
struct Lisp_Char_Table
*
736 XCHAR_TABLE (Lisp_Object a
)
738 eassert (CHAR_TABLE_P (a
));
742 INLINE
struct Lisp_Sub_Char_Table
*
743 XSUB_CHAR_TABLE (Lisp_Object a
)
745 eassert (SUB_CHAR_TABLE_P (a
));
749 INLINE
struct Lisp_Bool_Vector
*
750 XBOOL_VECTOR (Lisp_Object a
)
752 eassert (BOOL_VECTOR_P (a
));
757 make_lisp_proc (struct Lisp_Process
*p
)
759 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
762 #define XSETINT(a, b) ((a) = make_number (b))
763 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
764 #define XSETCONS(a, b) ((a) = (b)->self)
765 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
766 #define XSETSTRING(a, b) ((a) = (b)->self)
767 #define XSETSYMBOL(a, b) ((a) = (b)->self)
768 #define XSETFLOAT(a, b) ((a) = (b)->self)
769 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
771 /* Pseudovector types. */
773 #define XSETPVECTYPE(v, code) \
774 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
775 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
776 ((v)->header.size = (PSEUDOVECTOR_FLAG \
777 | ((code) << PSEUDOVECTOR_AREA_BITS) \
778 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
781 /* The cast to struct vectorlike_header * avoids aliasing issues. */
782 #define XSETPSEUDOVECTOR(a, b, code) \
783 XSETTYPED_PSEUDOVECTOR (a, b, \
784 (((struct vectorlike_header *) \
788 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
789 (XSETVECTOR (a, b), \
790 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
791 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
793 #define XSETWINDOW_CONFIGURATION(a, b) \
794 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
795 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
796 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
797 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
798 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
799 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
800 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
801 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
802 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
803 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
807 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
808 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
811 /* Deprecated and will be removed soon. */
813 #define INTERNAL_FIELD(field) field ## _
815 /* See the macros in intervals.h. */
817 typedef struct interval
*INTERVAL
;
823 /* Car of this cons cell. */
826 /* Cdr of this cons cell. */
830 /* Take the car or cdr of something known to be a cons cell. */
831 /* The _addr functions shouldn't be used outside of the minimal set
832 of code that has to know what a cons cell looks like. Other code not
833 part of the basic lisp implementation should assume that the car and cdr
834 fields are not accessible. (What if we want to switch to
835 a copying collector someday? Cached cons cell field addresses may be
836 invalidated at arbitrary points.) */
838 xcar_addr (Lisp_Object c
)
840 return &XCONS (c
)->car
;
843 xcdr_addr (Lisp_Object c
)
845 return &XCONS (c
)->cdr
;
848 /* Use these from normal code. */
849 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
850 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
852 /* Use these to set the fields of a cons cell.
854 Note that both arguments may refer to the same object, so 'n'
855 should not be read after 'c' is first modified. */
857 XSETCAR (Lisp_Object c
, Lisp_Object n
)
862 XSETCDR (Lisp_Object c
, Lisp_Object n
)
867 /* Take the car or cdr of something whose type is not known. */
871 return (CONSP (c
) ? XCAR (c
)
873 : wrong_type_argument (Qlistp
, c
));
878 return (CONSP (c
) ? XCDR (c
)
880 : wrong_type_argument (Qlistp
, c
));
883 /* Take the car or cdr of something whose type is not known. */
885 CAR_SAFE (Lisp_Object c
)
887 return CONSP (c
) ? XCAR (c
) : Qnil
;
890 CDR_SAFE (Lisp_Object c
)
892 return CONSP (c
) ? XCDR (c
) : Qnil
;
895 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
902 INTERVAL intervals
; /* Text properties in this string. */
906 /* True if STR is a multibyte string. */
908 STRING_MULTIBYTE (Lisp_Object str
)
910 return 0 <= XSTRING (str
)->size_byte
;
913 /* An upper bound on the number of bytes in a Lisp string, not
914 counting the terminating null. This a tight enough bound to
915 prevent integer overflow errors that would otherwise occur during
916 string size calculations. A string cannot contain more bytes than
917 a fixnum can represent, nor can it be so long that C pointer
918 arithmetic stops working on the string plus its terminating null.
919 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
920 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
921 would expose alloc.c internal details that we'd rather keep
924 This is a macro for use in static initializers. The cast to
925 ptrdiff_t ensures that the macro is signed. */
926 #define STRING_BYTES_BOUND \
927 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
929 /* Mark STR as a unibyte string. */
930 #define STRING_SET_UNIBYTE(STR) \
932 if (EQ (STR, empty_multibyte_string)) \
933 (STR) = empty_unibyte_string; \
935 XSTRING (STR)->size_byte = -1; \
938 /* Mark STR as a multibyte string. Assure that STR contains only
939 ASCII characters in advance. */
940 #define STRING_SET_MULTIBYTE(STR) \
942 if (EQ (STR, empty_unibyte_string)) \
943 (STR) = empty_multibyte_string; \
945 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
948 /* Convenience functions for dealing with Lisp strings. */
950 INLINE
unsigned char *
951 SDATA (Lisp_Object string
)
953 return XSTRING (string
)->data
;
956 SSDATA (Lisp_Object string
)
958 /* Avoid "differ in sign" warnings. */
959 return (char *) SDATA (string
);
962 SREF (Lisp_Object string
, ptrdiff_t index
)
964 return SDATA (string
)[index
];
967 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
969 SDATA (string
)[index
] = new;
972 SCHARS (Lisp_Object string
)
974 return XSTRING (string
)->size
;
978 STRING_BYTES (struct Lisp_String
*s
)
980 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
984 SBYTES (Lisp_Object string
)
986 return STRING_BYTES (XSTRING (string
));
989 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
991 XSTRING (string
)->size
= newsize
;
994 /* Header of vector-like objects. This documents the layout constraints on
995 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
996 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
997 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
998 because when two such pointers potentially alias, a compiler won't
999 incorrectly reorder loads and stores to their size fields. See
1001 struct vectorlike_header
1005 /* This field contains various pieces of information:
1006 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1007 vector (0) or a pseudovector (1).
1008 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1009 of slots) of the vector.
1010 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1011 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1012 - b) number of Lisp_Objects slots at the beginning of the object
1013 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1015 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1016 measured in word_size units. Rest fields may also include
1017 Lisp_Objects, but these objects usually needs some special treatment
1019 There are some exceptions. For PVEC_FREE, b) is always zero. For
1020 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1021 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1022 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1026 /* A regular vector is just a header plus an array of Lisp_Objects. */
1030 struct vectorlike_header header
;
1031 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1034 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1037 ALIGNOF_STRUCT_LISP_VECTOR
1038 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
1041 /* A boolvector is a kind of vectorlike, with contents like a string. */
1043 struct Lisp_Bool_Vector
1045 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1046 just the subtype information. */
1047 struct vectorlike_header header
;
1048 /* This is the size in bits. */
1050 /* The actual bits, packed into bytes.
1051 Zeros fill out the last word if needed.
1052 The bits are in little-endian order in the bytes, and
1053 the bytes are in little-endian order in the words. */
1054 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1058 bool_vector_size (Lisp_Object a
)
1060 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1061 eassume (0 <= size
);
1066 bool_vector_data (Lisp_Object a
)
1068 return XBOOL_VECTOR (a
)->data
;
1071 INLINE
unsigned char *
1072 bool_vector_uchar_data (Lisp_Object a
)
1074 return (unsigned char *) bool_vector_data (a
);
1077 /* The number of data words and bytes in a bool vector with SIZE bits. */
1080 bool_vector_words (EMACS_INT size
)
1082 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1083 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1087 bool_vector_bytes (EMACS_INT size
)
1089 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1090 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1093 /* True if A's Ith bit is set. */
1096 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1098 eassume (0 <= i
&& i
< bool_vector_size (a
));
1099 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1100 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1104 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1106 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1109 /* Set A's Ith bit to B. */
1112 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1114 unsigned char *addr
;
1116 eassume (0 <= i
&& i
< bool_vector_size (a
));
1117 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1120 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1122 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1125 /* Some handy constants for calculating sizes
1126 and offsets, mostly of vectorlike objects. */
1130 header_size
= offsetof (struct Lisp_Vector
, contents
),
1131 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1132 word_size
= sizeof (Lisp_Object
)
1135 /* Conveniences for dealing with Lisp arrays. */
1138 AREF (Lisp_Object array
, ptrdiff_t idx
)
1140 return XVECTOR (array
)->contents
[idx
];
1143 INLINE Lisp_Object
*
1144 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1146 return & XVECTOR (array
)->contents
[idx
];
1150 ASIZE (Lisp_Object array
)
1152 return XVECTOR (array
)->header
.size
;
1156 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1158 eassert (0 <= idx
&& idx
< ASIZE (array
));
1159 XVECTOR (array
)->contents
[idx
] = val
;
1163 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1165 /* Like ASET, but also can be used in the garbage collector:
1166 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1167 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1168 XVECTOR (array
)->contents
[idx
] = val
;
1171 /* If a struct is made to look like a vector, this macro returns the length
1172 of the shortest vector that would hold that struct. */
1174 #define VECSIZE(type) \
1175 ((sizeof (type) - header_size + word_size - 1) / word_size)
1177 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1178 at the end and we need to compute the number of Lisp_Object fields (the
1179 ones that the GC needs to trace). */
1181 #define PSEUDOVECSIZE(type, nonlispfield) \
1182 ((offsetof (type, nonlispfield) - header_size) / word_size)
1184 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1185 should be integer expressions. This is not the same as
1186 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1187 returns true. For efficiency, prefer plain unsigned comparison if A
1188 and B's sizes both fit (after integer promotion). */
1189 #define UNSIGNED_CMP(a, op, b) \
1190 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1191 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1192 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1194 /* True iff C is an ASCII character. */
1195 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1197 /* A char-table is a kind of vectorlike, with contents are like a
1198 vector but with a few other slots. For some purposes, it makes
1199 sense to handle a char-table with type struct Lisp_Vector. An
1200 element of a char table can be any Lisp objects, but if it is a sub
1201 char-table, we treat it a table that contains information of a
1202 specific range of characters. A sub char-table has the same
1203 structure as a vector. A sub char table appears only in an element
1204 of a char-table, and there's no way to access it directly from
1205 Emacs Lisp program. */
1207 enum CHARTAB_SIZE_BITS
1209 CHARTAB_SIZE_BITS_0
= 6,
1210 CHARTAB_SIZE_BITS_1
= 4,
1211 CHARTAB_SIZE_BITS_2
= 5,
1212 CHARTAB_SIZE_BITS_3
= 7
1215 extern const int chartab_size
[4];
1217 struct Lisp_Char_Table
1219 /* HEADER.SIZE is the vector's size field, which also holds the
1220 pseudovector type information. It holds the size, too.
1221 The size counts the defalt, parent, purpose, ascii,
1222 contents, and extras slots. */
1223 struct vectorlike_header header
;
1225 /* This holds a default value,
1226 which is used whenever the value for a specific character is nil. */
1229 /* This points to another char table, which we inherit from when the
1230 value for a specific character is nil. The `defalt' slot takes
1231 precedence over this. */
1234 /* This is a symbol which says what kind of use this char-table is
1236 Lisp_Object purpose
;
1238 /* The bottom sub char-table for characters of the range 0..127. It
1239 is nil if none of ASCII character has a specific value. */
1242 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1244 /* These hold additional data. It is a vector. */
1245 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1248 struct Lisp_Sub_Char_Table
1250 /* HEADER.SIZE is the vector's size field, which also holds the
1251 pseudovector type information. It holds the size, too. */
1252 struct vectorlike_header header
;
1254 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1255 char-table of depth 1 contains 16 elements, and each element
1256 covers 4096 (128*32) characters. A sub char-table of depth 2
1257 contains 32 elements, and each element covers 128 characters. A
1258 sub char-table of depth 3 contains 128 elements, and each element
1259 is for one character. */
1262 /* Minimum character covered by the sub char-table. */
1263 Lisp_Object min_char
;
1265 /* Use set_sub_char_table_contents to set this. */
1266 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1270 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1272 struct Lisp_Char_Table
*tbl
= NULL
;
1276 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1277 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1278 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1282 while (NILP (val
) && ! NILP (tbl
->parent
));
1287 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1288 characters. Do not check validity of CT. */
1290 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1292 return (ASCII_CHAR_P (idx
)
1293 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1294 : char_table_ref (ct
, idx
));
1297 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1298 8-bit European characters. Do not check validity of CT. */
1300 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1302 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1303 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1305 char_table_set (ct
, idx
, val
);
1308 /* This structure describes a built-in function.
1309 It is generated by the DEFUN macro only.
1310 defsubr makes it into a Lisp object. */
1314 struct vectorlike_header header
;
1316 Lisp_Object (*a0
) (void);
1317 Lisp_Object (*a1
) (Lisp_Object
);
1318 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1319 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1320 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1321 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1322 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1323 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1324 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1325 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1326 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1328 short min_args
, max_args
;
1329 const char *symbol_name
;
1330 const char *intspec
;
1334 /* This is the number of slots that every char table must have. This
1335 counts the ordinary slots and the top, defalt, parent, and purpose
1337 enum CHAR_TABLE_STANDARD_SLOTS
1339 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1342 /* Return the number of "extra" slots in the char table CT. */
1345 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1347 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1348 - CHAR_TABLE_STANDARD_SLOTS
);
1352 /***********************************************************************
1354 ***********************************************************************/
1356 /* Interned state of a symbol. */
1358 enum symbol_interned
1360 SYMBOL_UNINTERNED
= 0,
1361 SYMBOL_INTERNED
= 1,
1362 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1365 enum symbol_redirect
1367 SYMBOL_PLAINVAL
= 4,
1368 SYMBOL_VARALIAS
= 1,
1369 SYMBOL_LOCALIZED
= 2,
1370 SYMBOL_FORWARDED
= 3
1377 /* Indicates where the value can be found:
1378 0 : it's a plain var, the value is in the `value' field.
1379 1 : it's a varalias, the value is really in the `alias' symbol.
1380 2 : it's a localized var, the value is in the `blv' object.
1381 3 : it's a forwarding variable, the value is in `forward'. */
1382 ENUM_BF (symbol_redirect
) redirect
: 3;
1384 /* Non-zero means symbol is constant, i.e. changing its value
1385 should signal an error. If the value is 3, then the var
1386 can be changed, but only by `defconst'. */
1387 unsigned constant
: 2;
1389 /* Interned state of the symbol. This is an enumerator from
1390 enum symbol_interned. */
1391 unsigned interned
: 2;
1393 /* True means that this variable has been explicitly declared
1394 special (with `defvar' etc), and shouldn't be lexically bound. */
1395 bool_bf declared_special
: 1;
1397 /* True if pointed to from purespace and hence can't be GC'd. */
1400 /* The symbol's name, as a Lisp string. */
1403 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1404 union is used depends on the `redirect' field above. */
1407 struct Lisp_Symbol
*alias
;
1408 struct Lisp_Buffer_Local_Value
*blv
;
1409 union Lisp_Fwd
*fwd
;
1412 /* Function value of the symbol or Qnil if not fboundp. */
1413 Lisp_Object function
;
1415 /* The symbol's property list. */
1418 /* Next symbol in obarray bucket, if the symbol is interned. */
1419 struct Lisp_Symbol
*next
;
1422 /* Value is name of symbol. */
1424 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1426 INLINE
struct Lisp_Symbol
*
1427 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1429 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1430 return sym
->val
.alias
;
1432 INLINE
struct Lisp_Buffer_Local_Value
*
1433 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1435 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1436 return sym
->val
.blv
;
1438 INLINE
union Lisp_Fwd
*
1439 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1441 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1442 return sym
->val
.fwd
;
1445 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1446 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1449 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1451 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1455 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1457 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1461 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1463 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1468 SYMBOL_NAME (Lisp_Object sym
)
1470 return XSYMBOL (sym
)->name
;
1473 /* Value is true if SYM is an interned symbol. */
1476 SYMBOL_INTERNED_P (Lisp_Object sym
)
1478 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1481 /* Value is true if SYM is interned in initial_obarray. */
1484 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1486 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1489 /* Value is non-zero if symbol is considered a constant, i.e. its
1490 value cannot be changed (there is an exception for keyword symbols,
1491 whose value can be set to the keyword symbol itself). */
1493 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1495 #define DEFSYM(sym, name) \
1496 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1499 /***********************************************************************
1501 ***********************************************************************/
1503 /* The structure of a Lisp hash table. */
1505 struct hash_table_test
1507 /* Name of the function used to compare keys. */
1510 /* User-supplied hash function, or nil. */
1511 Lisp_Object user_hash_function
;
1513 /* User-supplied key comparison function, or nil. */
1514 Lisp_Object user_cmp_function
;
1516 /* C function to compare two keys. */
1517 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1519 /* C function to compute hash code. */
1520 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1523 struct Lisp_Hash_Table
1525 /* This is for Lisp; the hash table code does not refer to it. */
1526 struct vectorlike_header header
;
1528 /* Nil if table is non-weak. Otherwise a symbol describing the
1529 weakness of the table. */
1532 /* When the table is resized, and this is an integer, compute the
1533 new size by adding this to the old size. If a float, compute the
1534 new size by multiplying the old size with this factor. */
1535 Lisp_Object rehash_size
;
1537 /* Resize hash table when number of entries/ table size is >= this
1539 Lisp_Object rehash_threshold
;
1541 /* Vector of hash codes. If hash[I] is nil, this means that the
1542 I-th entry is unused. */
1545 /* Vector used to chain entries. If entry I is free, next[I] is the
1546 entry number of the next free item. If entry I is non-free,
1547 next[I] is the index of the next entry in the collision chain. */
1550 /* Index of first free entry in free list. */
1551 Lisp_Object next_free
;
1553 /* Bucket vector. A non-nil entry is the index of the first item in
1554 a collision chain. This vector's size can be larger than the
1555 hash table size to reduce collisions. */
1558 /* Only the fields above are traced normally by the GC. The ones below
1559 `count' are special and are either ignored by the GC or traced in
1560 a special way (e.g. because of weakness). */
1562 /* Number of key/value entries in the table. */
1565 /* Vector of keys and values. The key of item I is found at index
1566 2 * I, the value is found at index 2 * I + 1.
1567 This is gc_marked specially if the table is weak. */
1568 Lisp_Object key_and_value
;
1570 /* The comparison and hash functions. */
1571 struct hash_table_test test
;
1573 /* Next weak hash table if this is a weak hash table. The head
1574 of the list is in weak_hash_tables. */
1575 struct Lisp_Hash_Table
*next_weak
;
1579 INLINE
struct Lisp_Hash_Table
*
1580 XHASH_TABLE (Lisp_Object a
)
1582 return SMOB_PTR (a
);
1585 #define XSET_HASH_TABLE(VAR, PTR) \
1586 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1589 HASH_TABLE_P (Lisp_Object a
)
1591 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1594 /* Value is the key part of entry IDX in hash table H. */
1596 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1598 return AREF (h
->key_and_value
, 2 * idx
);
1601 /* Value is the value part of entry IDX in hash table H. */
1603 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1605 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1608 /* Value is the index of the next entry following the one at IDX
1611 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1613 return AREF (h
->next
, idx
);
1616 /* Value is the hash code computed for entry IDX in hash table H. */
1618 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1620 return AREF (h
->hash
, idx
);
1623 /* Value is the index of the element in hash table H that is the
1624 start of the collision list at index IDX in the index vector of H. */
1626 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1628 return AREF (h
->index
, idx
);
1631 /* Value is the size of hash table H. */
1633 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1635 return ASIZE (h
->next
);
1638 /* Default size for hash tables if not specified. */
1640 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1642 /* Default threshold specifying when to resize a hash table. The
1643 value gives the ratio of current entries in the hash table and the
1644 size of the hash table. */
1646 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1648 /* Default factor by which to increase the size of a hash table. */
1650 static double const DEFAULT_REHASH_SIZE
= 1.5;
1652 /* Combine two integers X and Y for hashing. The result might not fit
1653 into a Lisp integer. */
1656 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1658 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1661 /* Hash X, returning a value that fits into a fixnum. */
1664 SXHASH_REDUCE (EMACS_UINT x
)
1666 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1669 /* These structures are used for various misc types. */
1671 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1674 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1680 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1681 /* This flag is temporarily used in the functions
1682 decode/encode_coding_object to record that the marker position
1683 must be adjusted after the conversion. */
1684 bool_bf need_adjustment
: 1;
1685 /* True means normal insertion at the marker's position
1686 leaves the marker after the inserted text. */
1687 bool_bf insertion_type
: 1;
1688 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1689 Note: a chain of markers can contain markers pointing into different
1690 buffers (the chain is per buffer_text rather than per buffer, so it's
1691 shared between indirect buffers). */
1692 /* This is used for (other than NULL-checking):
1694 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1695 - unchain_marker: to find the list from which to unchain.
1696 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1698 struct buffer
*buffer
;
1700 /* The remaining fields are meaningless in a marker that
1701 does not point anywhere. */
1703 /* For markers that point somewhere,
1704 this is used to chain of all the markers in a given buffer. */
1705 /* We could remove it and use an array in buffer_text instead.
1706 That would also allow to preserve it ordered. */
1707 struct Lisp_Marker
*next
;
1708 /* This is the char position where the marker points. */
1710 /* This is the byte position.
1711 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1712 used to implement the functionality of markers, but rather to (ab)use
1713 markers as a cache for char<->byte mappings). */
1717 /* START and END are markers in the overlay's buffer, and
1718 PLIST is the overlay's property list. */
1720 /* An overlay's real data content is:
1722 - buffer (really there are two buffer pointers, one per marker,
1723 and both points to the same buffer)
1724 - insertion type of both ends (per-marker fields)
1725 - start & start byte (of start marker)
1726 - end & end byte (of end marker)
1727 - next (singly linked list of overlays)
1728 - next fields of start and end markers (singly linked list of markers).
1729 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1733 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1734 struct Lisp_Overlay
*next
;
1740 /* Types of data which may be saved in a Lisp_Save_Value. */
1751 /* Number of bits needed to store one of the above values. */
1752 enum { SAVE_SLOT_BITS
= 3 };
1754 /* Number of slots in a save value where save_type is nonzero. */
1755 enum { SAVE_VALUE_SLOTS
= 4 };
1757 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1759 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1763 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1764 SAVE_TYPE_INT_INT_INT
1765 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1766 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1767 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1768 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1769 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1770 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1771 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1772 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1773 SAVE_TYPE_FUNCPTR_PTR_OBJ
1774 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1776 /* This has an extra bit indicating it's raw memory. */
1777 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1780 /* Special object used to hold a different values for later use.
1782 This is mostly used to package C integers and pointers to call
1783 record_unwind_protect when two or more values need to be saved.
1787 struct my_data *md = get_my_data ();
1788 ptrdiff_t mi = get_my_integer ();
1789 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1792 Lisp_Object my_unwind (Lisp_Object arg)
1794 struct my_data *md = XSAVE_POINTER (arg, 0);
1795 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1799 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1800 saved objects and raise eassert if type of the saved object doesn't match
1801 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1802 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1803 slot 0 is a pointer. */
1805 typedef void (*voidfuncptr
) (void);
1807 struct Lisp_Save_Value
1810 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1811 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1813 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1814 V's data entries are determined by V->save_type. E.g., if
1815 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1816 V->data[1] is an integer, and V's other data entries are unused.
1818 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1819 a memory area containing V->data[1].integer potential Lisp_Objects. */
1820 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1823 voidfuncptr funcpointer
;
1826 } data
[SAVE_VALUE_SLOTS
];
1829 /* Return the type of V's Nth saved value. */
1831 save_type (struct Lisp_Save_Value
*v
, int n
)
1833 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1834 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1837 /* Get and set the Nth saved pointer. */
1840 XSAVE_POINTER (Lisp_Object obj
, int n
)
1842 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1843 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1846 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1848 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1849 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1852 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1854 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1855 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1858 /* Likewise for the saved integer. */
1861 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1863 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1864 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1867 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1869 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1870 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1873 /* Extract Nth saved object. */
1876 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1878 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1879 return XSAVE_VALUE (obj
)->data
[n
].object
;
1882 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1883 It uses one of these struct subtypes to get the type field. */
1887 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1888 struct Lisp_Marker u_marker
;
1889 struct Lisp_Overlay u_overlay
;
1890 struct Lisp_Save_Value u_save_value
;
1893 INLINE
union Lisp_Misc
*
1894 XMISC (Lisp_Object a
)
1896 return SMOB_PTR (a
);
1899 INLINE
struct Lisp_Misc_Any
*
1900 XMISCANY (Lisp_Object a
)
1902 eassert (MISCP (a
));
1903 return & XMISC (a
)->u_any
;
1906 INLINE
enum Lisp_Misc_Type
1907 XMISCTYPE (Lisp_Object a
)
1909 return XMISCANY (a
)->type
;
1912 INLINE
struct Lisp_Marker
*
1913 XMARKER (Lisp_Object a
)
1915 eassert (MARKERP (a
));
1916 return & XMISC (a
)->u_marker
;
1919 INLINE
struct Lisp_Overlay
*
1920 XOVERLAY (Lisp_Object a
)
1922 eassert (OVERLAYP (a
));
1923 return & XMISC (a
)->u_overlay
;
1926 INLINE
struct Lisp_Save_Value
*
1927 XSAVE_VALUE (Lisp_Object a
)
1929 eassert (SAVE_VALUEP (a
));
1930 return & XMISC (a
)->u_save_value
;
1933 /* Forwarding pointer to an int variable.
1934 This is allowed only in the value cell of a symbol,
1935 and it means that the symbol's value really lives in the
1936 specified int variable. */
1939 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1943 /* Boolean forwarding pointer to an int variable.
1944 This is like Lisp_Intfwd except that the ostensible
1945 "value" of the symbol is t if the bool variable is true,
1946 nil if it is false. */
1949 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1953 /* Forwarding pointer to a Lisp_Object variable.
1954 This is allowed only in the value cell of a symbol,
1955 and it means that the symbol's value really lives in the
1956 specified variable. */
1959 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1960 Lisp_Object
*objvar
;
1963 /* Like Lisp_Objfwd except that value lives in a slot in the
1964 current buffer. Value is byte index of slot within buffer. */
1965 struct Lisp_Buffer_Objfwd
1967 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1969 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1970 Lisp_Object predicate
;
1973 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1974 the symbol has buffer-local or frame-local bindings. (Exception:
1975 some buffer-local variables are built-in, with their values stored
1976 in the buffer structure itself. They are handled differently,
1977 using struct Lisp_Buffer_Objfwd.)
1979 The `realvalue' slot holds the variable's current value, or a
1980 forwarding pointer to where that value is kept. This value is the
1981 one that corresponds to the loaded binding. To read or set the
1982 variable, you must first make sure the right binding is loaded;
1983 then you can access the value in (or through) `realvalue'.
1985 `buffer' and `frame' are the buffer and frame for which the loaded
1986 binding was found. If those have changed, to make sure the right
1987 binding is loaded it is necessary to find which binding goes with
1988 the current buffer and selected frame, then load it. To load it,
1989 first unload the previous binding, then copy the value of the new
1990 binding into `realvalue' (or through it). Also update
1991 LOADED-BINDING to point to the newly loaded binding.
1993 `local_if_set' indicates that merely setting the variable creates a
1994 local binding for the current buffer. Otherwise the latter, setting
1995 the variable does not do that; only make-local-variable does that. */
1997 struct Lisp_Buffer_Local_Value
1999 /* True means that merely setting the variable creates a local
2000 binding for the current buffer. */
2001 bool_bf local_if_set
: 1;
2002 /* True means this variable can have frame-local bindings, otherwise, it is
2003 can have buffer-local bindings. The two cannot be combined. */
2004 bool_bf frame_local
: 1;
2005 /* True means that the binding now loaded was found.
2006 Presumably equivalent to (defcell!=valcell). */
2008 /* If non-NULL, a forwarding to the C var where it should also be set. */
2009 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2010 /* The buffer or frame for which the loaded binding was found. */
2012 /* A cons cell that holds the default value. It has the form
2013 (SYMBOL . DEFAULT-VALUE). */
2014 Lisp_Object defcell
;
2015 /* The cons cell from `where's parameter alist.
2016 It always has the form (SYMBOL . VALUE)
2017 Note that if `forward' is non-nil, VALUE may be out of date.
2018 Also if the currently loaded binding is the default binding, then
2019 this is `eq'ual to defcell. */
2020 Lisp_Object valcell
;
2023 /* Like Lisp_Objfwd except that value lives in a slot in the
2025 struct Lisp_Kboard_Objfwd
2027 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2033 struct Lisp_Intfwd u_intfwd
;
2034 struct Lisp_Boolfwd u_boolfwd
;
2035 struct Lisp_Objfwd u_objfwd
;
2036 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2037 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2040 INLINE
enum Lisp_Fwd_Type
2041 XFWDTYPE (union Lisp_Fwd
*a
)
2043 return a
->u_intfwd
.type
;
2046 INLINE
struct Lisp_Buffer_Objfwd
*
2047 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2049 eassert (BUFFER_OBJFWDP (a
));
2050 return &a
->u_buffer_objfwd
;
2053 /* Lisp floating point type. */
2061 XFLOAT_DATA (Lisp_Object f
)
2063 return XFLOAT (f
)->data
;
2066 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2067 representations, have infinities and NaNs, and do not trap on
2068 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2069 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2070 wanted here, but is not quite right because Emacs does not require
2071 all the features of C11 Annex F (and does not require C11 at all,
2072 for that matter). */
2076 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2077 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2080 /* A character, declared with the following typedef, is a member
2081 of some character set associated with the current buffer. */
2082 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2084 typedef unsigned char UCHAR
;
2087 /* Meanings of slots in a Lisp_Compiled: */
2091 COMPILED_ARGLIST
= 0,
2092 COMPILED_BYTECODE
= 1,
2093 COMPILED_CONSTANTS
= 2,
2094 COMPILED_STACK_DEPTH
= 3,
2095 COMPILED_DOC_STRING
= 4,
2096 COMPILED_INTERACTIVE
= 5
2099 /* Flag bits in a character. These also get used in termhooks.h.
2100 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2101 (MUlti-Lingual Emacs) might need 22 bits for the character value
2102 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2105 CHAR_ALT
= 0x0400000,
2106 CHAR_SUPER
= 0x0800000,
2107 CHAR_HYPER
= 0x1000000,
2108 CHAR_SHIFT
= 0x2000000,
2109 CHAR_CTL
= 0x4000000,
2110 CHAR_META
= 0x8000000,
2112 CHAR_MODIFIER_MASK
=
2113 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2115 /* Actually, the current Emacs uses 22 bits for the character value
2120 /* Data type checking. */
2122 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2125 NUMBERP (Lisp_Object x
)
2127 return INTEGERP (x
) || FLOATP (x
);
2130 NATNUMP (Lisp_Object x
)
2132 return INTEGERP (x
) && 0 <= XINT (x
);
2136 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2138 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2141 #define TYPE_RANGED_INTEGERP(type, x) \
2143 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2144 && XINT (x) <= TYPE_MAXIMUM (type))
2146 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2147 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2148 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2149 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2150 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2151 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2152 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2155 STRINGP (Lisp_Object x
)
2157 return SMOB_TYPEP (x
, lisp_string_tag
);
2160 VECTORP (Lisp_Object x
)
2162 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2165 OVERLAYP (Lisp_Object x
)
2167 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2170 SAVE_VALUEP (Lisp_Object x
)
2172 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2176 AUTOLOADP (Lisp_Object x
)
2178 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2182 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2184 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2188 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2190 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2191 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2194 /* True if A is a pseudovector whose code is CODE. */
2196 PSEUDOVECTORP (Lisp_Object a
, int code
)
2198 if (! VECTORLIKEP (a
))
2202 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2203 struct vectorlike_header
*h
= SMOB_PTR (a
);
2204 return PSEUDOVECTOR_TYPEP (h
, code
);
2208 /* Test for specific pseudovector types. */
2211 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2213 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2217 PROCESSP (Lisp_Object a
)
2219 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2223 WINDOWP (Lisp_Object a
)
2225 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2229 TERMINALP (Lisp_Object a
)
2231 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2235 SUBRP (Lisp_Object a
)
2237 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2241 COMPILEDP (Lisp_Object a
)
2243 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2247 BUFFERP (Lisp_Object a
)
2249 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2253 CHAR_TABLE_P (Lisp_Object a
)
2255 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2259 SUB_CHAR_TABLE_P (Lisp_Object a
)
2261 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2265 BOOL_VECTOR_P (Lisp_Object a
)
2267 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2271 FRAMEP (Lisp_Object a
)
2273 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2276 /* Test for image (image . spec) */
2278 IMAGEP (Lisp_Object x
)
2280 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2285 ARRAYP (Lisp_Object x
)
2287 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2291 CHECK_LIST (Lisp_Object x
)
2293 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2296 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2297 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2298 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2301 CHECK_STRING (Lisp_Object x
)
2303 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2306 CHECK_STRING_CAR (Lisp_Object x
)
2308 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2311 CHECK_CONS (Lisp_Object x
)
2313 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2316 CHECK_VECTOR (Lisp_Object x
)
2318 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2321 CHECK_BOOL_VECTOR (Lisp_Object x
)
2323 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2326 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2328 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2331 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2333 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2336 CHECK_BUFFER (Lisp_Object x
)
2338 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2341 CHECK_WINDOW (Lisp_Object x
)
2343 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2347 CHECK_PROCESS (Lisp_Object x
)
2349 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2353 CHECK_NATNUM (Lisp_Object x
)
2355 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2358 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2361 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2362 args_out_of_range_3 \
2364 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2365 ? MOST_NEGATIVE_FIXNUM \
2367 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2369 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2371 if (TYPE_SIGNED (type)) \
2372 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2374 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2377 #define CHECK_NUMBER_COERCE_MARKER(x) \
2379 if (MARKERP ((x))) \
2380 XSETFASTINT (x, marker_position (x)); \
2382 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2386 XFLOATINT (Lisp_Object n
)
2388 return extract_float (n
);
2392 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2394 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2397 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2400 XSETFASTINT (x, marker_position (x)); \
2402 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2405 /* Since we can't assign directly to the CAR or CDR fields of a cons
2406 cell, use these when checking that those fields contain numbers. */
2408 CHECK_NUMBER_CAR (Lisp_Object x
)
2410 Lisp_Object tmp
= XCAR (x
);
2416 CHECK_NUMBER_CDR (Lisp_Object x
)
2418 Lisp_Object tmp
= XCDR (x
);
2423 /* Define a built-in function for calling from Lisp.
2424 `lname' should be the name to give the function in Lisp,
2425 as a null-terminated C string.
2426 `fnname' should be the name of the function in C.
2427 By convention, it starts with F.
2428 `sname' should be the name for the C constant structure
2429 that records information on this function for internal use.
2430 By convention, it should be the same as `fnname' but with S instead of F.
2431 It's too bad that C macros can't compute this from `fnname'.
2432 `minargs' should be a number, the minimum number of arguments allowed.
2433 `maxargs' should be a number, the maximum number of arguments allowed,
2434 or else MANY or UNEVALLED.
2435 MANY means pass a vector of evaluated arguments,
2436 in the form of an integer number-of-arguments
2437 followed by the address of a vector of Lisp_Objects
2438 which contains the argument values.
2439 UNEVALLED means pass the list of unevaluated arguments
2440 `intspec' says how interactive arguments are to be fetched.
2441 If the string starts with a `(', `intspec' is evaluated and the resulting
2442 list is the list of arguments.
2443 If it's a string that doesn't start with `(', the value should follow
2444 the one of the doc string for `interactive'.
2445 A null string means call interactively with no arguments.
2446 `doc' is documentation for the user. */
2448 /* This version of DEFUN declares a function prototype with the right
2449 arguments, so we can catch errors with maxargs at compile-time. */
2451 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2452 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2453 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2455 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2456 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2457 { (Lisp_Object (__cdecl *)(void))fnname }, \
2458 minargs, maxargs, lname, intspec, 0}; \
2460 #else /* not _MSC_VER */
2461 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2462 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2464 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2465 { .a ## maxargs = fnname }, \
2466 minargs, maxargs, lname, intspec, 0}; \
2470 /* Note that the weird token-substitution semantics of ANSI C makes
2471 this work for MANY and UNEVALLED. */
2472 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2473 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2474 #define DEFUN_ARGS_0 (void)
2475 #define DEFUN_ARGS_1 (Lisp_Object)
2476 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2477 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2478 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2479 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2481 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2482 Lisp_Object, Lisp_Object)
2483 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2484 Lisp_Object, Lisp_Object, Lisp_Object)
2485 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2486 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2488 /* True if OBJ is a Lisp function. */
2490 FUNCTIONP (Lisp_Object obj
)
2492 return functionp (obj
);
2496 is how we define the symbol for function `name' at start-up time. */
2497 extern void defsubr (struct Lisp_Subr
*);
2505 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2506 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2507 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2508 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2509 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2511 /* Macros we use to define forwarded Lisp variables.
2512 These are used in the syms_of_FILENAME functions.
2514 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2515 lisp variable is actually a field in `struct emacs_globals'. The
2516 field's name begins with "f_", which is a convention enforced by
2517 these macros. Each such global has a corresponding #define in
2518 globals.h; the plain name should be used in the code.
2520 E.g., the global "cons_cells_consed" is declared as "int
2521 f_cons_cells_consed" in globals.h, but there is a define:
2523 #define cons_cells_consed globals.f_cons_cells_consed
2525 All C code uses the `cons_cells_consed' name. This is all done
2526 this way to support indirection for multi-threaded Emacs. */
2528 #define DEFVAR_LISP(lname, vname, doc) \
2530 static struct Lisp_Objfwd o_fwd; \
2531 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2533 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2535 static struct Lisp_Objfwd o_fwd; \
2536 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2538 #define DEFVAR_BOOL(lname, vname, doc) \
2540 static struct Lisp_Boolfwd b_fwd; \
2541 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2543 #define DEFVAR_INT(lname, vname, doc) \
2545 static struct Lisp_Intfwd i_fwd; \
2546 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2549 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2551 static struct Lisp_Objfwd o_fwd; \
2552 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2555 #define DEFVAR_KBOARD(lname, vname, doc) \
2557 static struct Lisp_Kboard_Objfwd ko_fwd; \
2558 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2561 /* Save and restore the instruction and environment pointers,
2562 without affecting the signal mask. */
2565 typedef jmp_buf sys_jmp_buf
;
2566 # define sys_setjmp(j) _setjmp (j)
2567 # define sys_longjmp(j, v) _longjmp (j, v)
2568 #elif defined HAVE_SIGSETJMP
2569 typedef sigjmp_buf sys_jmp_buf
;
2570 # define sys_setjmp(j) sigsetjmp (j, 0)
2571 # define sys_longjmp(j, v) siglongjmp (j, v)
2573 /* A platform that uses neither _longjmp nor siglongjmp; assume
2574 longjmp does not affect the sigmask. */
2575 typedef jmp_buf sys_jmp_buf
;
2576 # define sys_setjmp(j) setjmp (j)
2577 # define sys_longjmp(j, v) longjmp (j, v)
2581 /* Elisp uses several stacks:
2583 - the bytecode stack: used internally by the bytecode interpreter.
2584 Allocated from the C stack.
2585 - The specpdl stack: keeps track of active unwind-protect and
2586 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2588 - The handler stack: keeps track of active catch tags and condition-case
2589 handlers. Allocated in a manually managed stack implemented by a
2590 doubly-linked list allocated via xmalloc and never freed. */
2592 /* Structure for recording Lisp call stack for backtrace purposes. */
2594 /* The special binding stack holds the outer values of variables while
2595 they are bound by a function application or a let form, stores the
2596 code to be executed for unwind-protect forms.
2598 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2599 used all over the place, needs to be fast, and needs to know the size of
2600 union specbinding. But only eval.c should access it. */
2603 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2604 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2605 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2606 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2607 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2608 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2609 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2610 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2611 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2616 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2618 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2619 void (*func
) (Lisp_Object
);
2623 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2624 void (*func
) (void *);
2628 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2633 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2634 void (*func
) (void);
2637 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2638 /* `where' is not used in the case of SPECPDL_LET. */
2639 Lisp_Object symbol
, old_value
, where
;
2642 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2643 bool_bf debug_on_exit
: 1;
2644 Lisp_Object function
;
2650 extern union specbinding
*specpdl
;
2651 extern union specbinding
*specpdl_ptr
;
2652 extern ptrdiff_t specpdl_size
;
2655 SPECPDL_INDEX (void)
2657 return specpdl_ptr
- specpdl
;
2660 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2661 control structures. A struct handler contains all the information needed to
2662 restore the state of the interpreter after a non-local jump.
2664 handler structures are chained together in a doubly linked list; the `next'
2665 member points to the next outer catchtag and the `nextfree' member points in
2666 the other direction to the next inner element (which is typically the next
2667 free element since we mostly use it on the deepest handler).
2669 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2670 member is TAG, and then unbinds to it. The `val' member is used to
2671 hold VAL while the stack is unwound; `val' is returned as the value
2674 All the other members are concerned with restoring the interpreter
2677 Members are volatile if their values need to survive _longjmp when
2678 a 'struct handler' is a local variable. */
2680 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2684 enum handlertype type
;
2685 Lisp_Object tag_or_ch
;
2687 struct handler
*next
;
2688 struct handler
*nextfree
;
2690 /* The bytecode interpreter can have several handlers active at the same
2691 time, so when we longjmp to one of them, it needs to know which handler
2692 this was and what was the corresponding internal state. This is stored
2693 here, and when we longjmp we make sure that handlerlist points to the
2695 Lisp_Object
*bytecode_top
;
2698 /* Most global vars are reset to their value via the specpdl mechanism,
2699 but a few others are handled by storing their value here. */
2700 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2701 struct gcpro
*gcpro
;
2704 EMACS_INT lisp_eval_depth
;
2706 int poll_suppress_count
;
2707 int interrupt_input_blocked
;
2710 /* Fill in the components of c, and put it on the list. */
2711 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2712 if (handlerlist->nextfree) \
2713 (c) = handlerlist->nextfree; \
2716 (c) = xmalloc (sizeof (struct handler)); \
2717 (c)->nextfree = NULL; \
2718 handlerlist->nextfree = (c); \
2720 (c)->type = (handlertype); \
2721 (c)->tag_or_ch = (tag_ch_val); \
2723 (c)->next = handlerlist; \
2724 (c)->lisp_eval_depth = lisp_eval_depth; \
2725 (c)->pdlcount = SPECPDL_INDEX (); \
2726 (c)->poll_suppress_count = poll_suppress_count; \
2727 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2728 (c)->gcpro = gcprolist; \
2732 extern Lisp_Object memory_signal_data
;
2734 /* Check quit-flag and quit if it is non-nil.
2735 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2736 So the program needs to do QUIT at times when it is safe to quit.
2737 Every loop that might run for a long time or might not exit
2738 ought to do QUIT at least once, at a safe place.
2739 Unless that is impossible, of course.
2740 But it is very desirable to avoid creating loops where QUIT is impossible.
2742 Exception: if you set immediate_quit to true,
2743 then the handler that responds to the C-g does the quit itself.
2744 This is a good thing to do around a loop that has no side effects
2745 and (in particular) cannot call arbitrary Lisp code.
2747 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2748 a request to exit Emacs when it is safe to do. */
2750 extern void process_pending_signals (void);
2751 extern bool volatile pending_signals
;
2753 extern void process_quit_flag (void);
2756 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2757 process_quit_flag (); \
2758 else if (pending_signals) \
2759 process_pending_signals (); \
2763 /* True if ought to quit now. */
2765 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2767 extern Lisp_Object Vascii_downcase_table
;
2768 extern Lisp_Object Vascii_canon_table
;
2770 /* Structure for recording stack slots that need marking. */
2772 /* This is a chain of structures, each of which points at a Lisp_Object
2773 variable whose value should be marked in garbage collection.
2774 Normally every link of the chain is an automatic variable of a function,
2775 and its `val' points to some argument or local variable of the function.
2776 On exit to the function, the chain is set back to the value it had on entry.
2777 This way, no link remains in the chain when the stack frame containing the
2780 Every function that can call Feval must protect in this fashion all
2781 Lisp_Object variables whose contents will be used again. */
2783 extern struct gcpro
*gcprolist
;
2789 /* Address of first protected variable. */
2790 volatile Lisp_Object
*var
;
2792 /* Number of consecutive protected variables. */
2800 /* Do something silly with gcproN vars just so gcc shuts up. */
2801 /* You get warnings from MIPSPro... */
2803 #define GCPRO1(varname) ((void) gcpro1)
2804 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2805 #define GCPRO3(varname1, varname2, varname3) \
2806 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2807 #define GCPRO4(varname1, varname2, varname3, varname4) \
2808 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2809 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2810 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2811 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2812 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2814 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2815 #define UNGCPRO ((void) 0)
2817 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2818 #define RETURN_UNGCPRO(expr) \
2821 Lisp_Object ret_ungc_val; \
2822 ret_ungc_val = (expr); \
2824 return ret_ungc_val; \
2828 /* Call staticpro (&var) to protect static variable `var'. */
2830 void staticpro (Lisp_Object
*);
2832 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2833 meaning as in the DEFUN macro, and is used to construct a prototype. */
2834 /* We can use the same trick as in the DEFUN macro to generate the
2835 appropriate prototype. */
2836 #define EXFUN(fnname, maxargs) \
2837 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2839 #include "globals.h"
2841 /* Forward declarations for prototypes. */
2845 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2848 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2850 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2851 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2854 /* Functions to modify hash tables. */
2857 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2859 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2863 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2865 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2868 /* Use these functions to set Lisp_Object
2869 or pointer slots of struct Lisp_Symbol. */
2872 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2874 XSYMBOL (sym
)->function
= function
;
2878 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2880 XSYMBOL (sym
)->plist
= plist
;
2884 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2886 XSYMBOL (sym
)->next
= next
;
2889 /* Buffer-local (also frame-local) variable access functions. */
2892 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2894 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2898 /* Set overlay's property list. */
2901 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2903 XOVERLAY (overlay
)->plist
= plist
;
2906 /* Get text properties of S. */
2909 string_intervals (Lisp_Object s
)
2911 return XSTRING (s
)->intervals
;
2914 /* Set text properties of S to I. */
2917 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2919 XSTRING (s
)->intervals
= i
;
2922 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2923 of setting slots directly. */
2926 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2928 XCHAR_TABLE (table
)->defalt
= val
;
2931 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2933 XCHAR_TABLE (table
)->purpose
= val
;
2936 /* Set different slots in (sub)character tables. */
2939 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2941 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2942 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2946 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2948 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2949 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2953 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2955 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2958 /* Defined in data.c. */
2959 extern Lisp_Object Qquote
, Qunbound
;
2960 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2961 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2962 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2963 extern Lisp_Object Qinvalid_read_syntax
;
2964 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2965 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2966 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2967 extern Lisp_Object Qtext_read_only
;
2968 extern Lisp_Object Qinteractive_form
;
2969 extern Lisp_Object Qcircular_list
;
2970 extern Lisp_Object Qsequencep
;
2971 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2972 extern Lisp_Object Qfboundp
;
2974 extern Lisp_Object Qcdr
;
2976 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2978 extern Lisp_Object Qnumber_or_marker_p
;
2980 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2982 /* Defined in data.c. */
2983 extern Lisp_Object
indirect_function (Lisp_Object
);
2984 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2985 enum Arith_Comparison
{
2990 ARITH_LESS_OR_EQUAL
,
2993 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2994 enum Arith_Comparison comparison
);
2996 /* Convert the integer I to an Emacs representation, either the integer
2997 itself, or a cons of two or three integers, or if all else fails a float.
2998 I should not have side effects. */
2999 #define INTEGER_TO_CONS(i) \
3000 (! FIXNUM_OVERFLOW_P (i) \
3002 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
3003 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
3004 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
3005 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
3006 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
3007 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
3008 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
3009 ? Fcons (make_number ((i) >> 16 >> 24), \
3010 Fcons (make_number ((i) >> 16 & 0xffffff), \
3011 make_number ((i) & 0xffff))) \
3014 /* Convert the Emacs representation CONS back to an integer of type
3015 TYPE, storing the result the variable VAR. Signal an error if CONS
3016 is not a valid representation or is out of range for TYPE. */
3017 #define CONS_TO_INTEGER(cons, type, var) \
3018 (TYPE_SIGNED (type) \
3019 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3020 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3021 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3022 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3024 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3025 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3026 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3028 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3029 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
3030 extern void syms_of_data (void);
3031 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3033 /* Defined in cmds.c */
3034 extern void syms_of_cmds (void);
3035 extern void keys_of_cmds (void);
3037 /* Defined in coding.c. */
3038 extern Lisp_Object Qcharset
;
3039 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3040 ptrdiff_t, bool, bool, Lisp_Object
);
3041 extern void init_coding (void);
3042 extern void init_coding_once (void);
3043 extern void syms_of_coding (void);
3045 /* Defined in character.c. */
3046 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3047 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3048 extern void syms_of_character (void);
3050 /* Defined in charset.c. */
3051 extern void init_charset (void);
3052 extern void init_charset_once (void);
3053 extern void syms_of_charset (void);
3054 /* Structure forward declarations. */
3057 /* Defined in syntax.c. */
3058 extern void init_syntax_once (void);
3059 extern void syms_of_syntax (void);
3061 /* Defined in fns.c. */
3062 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3063 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3064 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3065 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3066 extern void sweep_weak_hash_tables (void);
3067 extern Lisp_Object Qcursor_in_echo_area
;
3068 extern Lisp_Object Qstring_lessp
;
3069 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3070 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3071 EMACS_UINT
sxhash (Lisp_Object
, int);
3072 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3073 Lisp_Object
, Lisp_Object
);
3074 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3075 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3077 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3078 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3079 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3080 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3081 ptrdiff_t, ptrdiff_t);
3082 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3083 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3084 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3085 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3086 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3087 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3088 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3089 extern void clear_string_char_byte_cache (void);
3090 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3091 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3092 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3093 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3094 extern void syms_of_fns (void);
3096 /* Defined in floatfns.c. */
3097 extern void syms_of_floatfns (void);
3098 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3100 /* Defined in fringe.c. */
3101 extern void syms_of_fringe (void);
3102 extern void init_fringe (void);
3103 #ifdef HAVE_WINDOW_SYSTEM
3104 extern void mark_fringe_data (void);
3105 extern void init_fringe_once (void);
3106 #endif /* HAVE_WINDOW_SYSTEM */
3108 /* Defined in image.c. */
3109 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3110 extern Lisp_Object QCconversion
;
3111 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3112 extern void reset_image_types (void);
3113 extern void syms_of_image (void);
3115 /* Defined in insdel.c. */
3116 extern Lisp_Object Qinhibit_modification_hooks
;
3117 extern Lisp_Object Qregion_extract_function
;
3118 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3119 extern _Noreturn
void buffer_overflow (void);
3120 extern void make_gap (ptrdiff_t);
3121 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3122 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3123 ptrdiff_t, bool, bool);
3124 extern int count_combining_before (const unsigned char *,
3125 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3126 extern int count_combining_after (const unsigned char *,
3127 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3128 extern void insert (const char *, ptrdiff_t);
3129 extern void insert_and_inherit (const char *, ptrdiff_t);
3130 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3132 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3133 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3134 ptrdiff_t, ptrdiff_t, bool);
3135 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3136 extern void insert_char (int);
3137 extern void insert_string (const char *);
3138 extern void insert_before_markers (const char *, ptrdiff_t);
3139 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3140 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3141 ptrdiff_t, ptrdiff_t,
3143 extern void del_range (ptrdiff_t, ptrdiff_t);
3144 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3145 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3146 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3147 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3148 ptrdiff_t, ptrdiff_t, bool);
3149 extern void modify_text (ptrdiff_t, ptrdiff_t);
3150 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3151 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3152 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3153 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3154 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3155 ptrdiff_t, ptrdiff_t);
3156 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3157 ptrdiff_t, ptrdiff_t);
3158 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3159 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3160 const char *, ptrdiff_t, ptrdiff_t, bool);
3161 extern void syms_of_insdel (void);
3163 /* Defined in dispnew.c. */
3164 #if (defined PROFILING \
3165 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3166 _Noreturn
void __executable_start (void);
3168 extern Lisp_Object Vwindow_system
;
3169 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3171 /* Defined in xdisp.c. */
3172 extern Lisp_Object Qinhibit_point_motion_hooks
;
3173 extern Lisp_Object Qinhibit_redisplay
;
3174 extern Lisp_Object Qmenu_bar_update_hook
;
3175 extern Lisp_Object Qwindow_scroll_functions
;
3176 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3177 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3178 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3179 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3180 extern Lisp_Object Qleft_margin
, Qright_margin
;
3181 extern Lisp_Object QCdata
, QCfile
;
3182 extern Lisp_Object QCmap
;
3183 extern Lisp_Object Qrisky_local_variable
;
3184 extern bool noninteractive_need_newline
;
3185 extern Lisp_Object echo_area_buffer
[2];
3186 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3187 extern void check_message_stack (void);
3188 extern void setup_echo_area_for_printing (int);
3189 extern bool push_message (void);
3190 extern void pop_message_unwind (void);
3191 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3192 extern void restore_message (void);
3193 extern Lisp_Object
current_message (void);
3194 extern void clear_message (bool, bool);
3195 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3196 extern void message1 (const char *);
3197 extern void message1_nolog (const char *);
3198 extern void message3 (Lisp_Object
);
3199 extern void message3_nolog (Lisp_Object
);
3200 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3201 extern void message_with_string (const char *, Lisp_Object
, int);
3202 extern void message_log_maybe_newline (void);
3203 extern void update_echo_area (void);
3204 extern void truncate_echo_area (ptrdiff_t);
3205 extern void redisplay (void);
3207 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3208 extern void syms_of_xdisp (void);
3209 extern void init_xdisp (void);
3210 extern Lisp_Object
safe_eval (Lisp_Object
);
3211 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3212 int *, int *, int *, int *, int *);
3214 /* Defined in xsettings.c. */
3215 extern void syms_of_xsettings (void);
3217 /* Defined in vm-limit.c. */
3218 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3220 /* Defined in alloc.c. */
3221 extern void check_pure_size (void);
3222 extern void free_misc (Lisp_Object
);
3223 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3224 extern void malloc_warning (const char *);
3225 extern _Noreturn
void memory_full (size_t);
3226 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3227 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3228 extern void refill_memory_reserve (void);
3230 extern const char *pending_malloc_warning
;
3231 extern Lisp_Object zero_vector
;
3232 extern Lisp_Object
list1 (Lisp_Object
);
3233 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3234 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3235 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3236 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3238 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3239 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3241 /* Build a frequently used 2/3/4-integer lists. */
3244 list2i (EMACS_INT x
, EMACS_INT y
)
3246 return list2 (make_number (x
), make_number (y
));
3250 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3252 return list3 (make_number (x
), make_number (y
), make_number (w
));
3256 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3258 return list4 (make_number (x
), make_number (y
),
3259 make_number (w
), make_number (h
));
3262 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3263 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3264 extern _Noreturn
void string_overflow (void);
3265 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3266 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3267 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3268 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3270 /* Make unibyte string from C string when the length isn't known. */
3273 build_unibyte_string (const char *str
)
3275 return make_unibyte_string (str
, strlen (str
));
3278 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3279 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3280 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3281 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3282 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3283 extern Lisp_Object
make_specified_string (const char *,
3284 ptrdiff_t, ptrdiff_t, bool);
3285 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3286 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3288 /* Make a string allocated in pure space, use STR as string data. */
3291 build_pure_c_string (const char *str
)
3293 return make_pure_c_string (str
, strlen (str
));
3296 /* Make a string from the data at STR, treating it as multibyte if the
3300 build_string (const char *str
)
3302 return make_string (str
, strlen (str
));
3305 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3306 extern void make_byte_code (struct Lisp_Vector
*);
3307 extern Lisp_Object Qchar_table_extra_slots
;
3308 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3310 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3311 be sure that GC cannot happen until the vector is completely
3312 initialized. E.g. the following code is likely to crash:
3314 v = make_uninit_vector (3);
3316 ASET (v, 1, Ffunction_can_gc ());
3317 ASET (v, 2, obj1); */
3320 make_uninit_vector (ptrdiff_t size
)
3323 struct Lisp_Vector
*p
;
3325 p
= allocate_vector (size
);
3330 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3331 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3333 allocate_pseudovector \
3334 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3335 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3336 extern struct window
*allocate_window (void);
3337 extern struct frame
*allocate_frame (void);
3338 extern struct Lisp_Process
*allocate_process (void);
3339 extern struct terminal
*allocate_terminal (void);
3340 extern Lisp_Object
make_float (double);
3341 extern void display_malloc_warning (void);
3342 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3343 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3344 Lisp_Object
, Lisp_Object
);
3345 extern Lisp_Object
make_save_ptr (void *);
3346 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3347 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3348 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3350 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3351 extern void free_save_value (Lisp_Object
);
3352 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3353 extern void init_alloc_once (void);
3354 extern void init_alloc (void);
3355 extern void syms_of_alloc (void);
3356 extern struct buffer
* allocate_buffer (void);
3357 extern int valid_lisp_object_p (Lisp_Object
);
3358 extern int relocatable_string_data_p (const char *);
3361 /* Defined in ralloc.c. */
3362 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3363 extern void r_alloc_free (void **);
3364 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3365 extern void r_alloc_reset_variable (void **, void **);
3366 extern void r_alloc_inhibit_buffer_relocation (int);
3369 /* Defined in chartab.c. */
3370 extern Lisp_Object
copy_char_table (Lisp_Object
);
3371 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3373 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3374 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3376 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3377 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3378 Lisp_Object
, Lisp_Object
,
3379 Lisp_Object
, struct charset
*,
3380 unsigned, unsigned);
3381 extern Lisp_Object
uniprop_table (Lisp_Object
);
3382 extern void syms_of_chartab (void);
3384 /* Defined in print.c. */
3385 extern Lisp_Object Vprin1_to_string_buffer
;
3386 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3387 extern Lisp_Object Qstandard_output
;
3388 extern Lisp_Object Qexternal_debugging_output
;
3389 extern void temp_output_buffer_setup (const char *);
3390 extern int print_level
;
3391 extern Lisp_Object Qprint_escape_newlines
;
3392 extern void write_string (const char *, int);
3393 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3395 extern Lisp_Object internal_with_output_to_temp_buffer
3396 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3397 #define FLOAT_TO_STRING_BUFSIZE 350
3398 extern int float_to_string (char *, double);
3399 extern void init_print_once (void);
3400 extern void syms_of_print (void);
3402 /* Defined in doprnt.c. */
3403 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3405 extern ptrdiff_t esprintf (char *, char const *, ...)
3406 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3407 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3409 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3410 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3411 char const *, va_list)
3412 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3414 /* Defined in lread.c. */
3415 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3416 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3417 extern Lisp_Object Qlexical_binding
;
3418 extern Lisp_Object
check_obarray (Lisp_Object
);
3419 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3420 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3421 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3423 LOADHIST_ATTACH (Lisp_Object x
)
3426 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3428 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3429 Lisp_Object
*, Lisp_Object
, bool);
3430 extern Lisp_Object
string_to_number (char const *, int, bool);
3431 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3433 extern void dir_warning (const char *, Lisp_Object
);
3434 extern void init_obarray (void);
3435 extern void init_lread (void);
3436 extern void syms_of_lread (void);
3439 intern (const char *str
)
3441 return intern_1 (str
, strlen (str
));
3445 intern_c_string (const char *str
)
3447 return intern_c_string_1 (str
, strlen (str
));
3450 /* Defined in eval.c. */
3451 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3452 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3453 extern Lisp_Object Qand_rest
;
3454 extern Lisp_Object Vautoload_queue
;
3455 extern Lisp_Object Vsignaling_function
;
3456 extern Lisp_Object inhibit_lisp_code
;
3457 extern struct handler
*handlerlist
;
3459 /* To run a normal hook, use the appropriate function from the list below.
3460 The calling convention:
3462 if (!NILP (Vrun_hooks))
3463 call1 (Vrun_hooks, Qmy_funny_hook);
3465 should no longer be used. */
3466 extern Lisp_Object Vrun_hooks
;
3467 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3468 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3469 Lisp_Object (*funcall
)
3470 (ptrdiff_t nargs
, Lisp_Object
*args
));
3471 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3472 extern _Noreturn
void xsignal0 (Lisp_Object
);
3473 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3474 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3475 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3477 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3478 extern Lisp_Object
eval_sub (Lisp_Object form
);
3479 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3480 extern Lisp_Object
call0 (Lisp_Object
);
3481 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3482 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3483 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3484 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3485 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3486 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3487 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3488 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3489 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3490 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3491 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3492 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3493 extern Lisp_Object internal_condition_case_n
3494 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3495 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3496 extern void specbind (Lisp_Object
, Lisp_Object
);
3497 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3498 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3499 extern void record_unwind_protect_int (void (*) (int), int);
3500 extern void record_unwind_protect_void (void (*) (void));
3501 extern void record_unwind_protect_nothing (void);
3502 extern void clear_unwind_protect (ptrdiff_t);
3503 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3504 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3505 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3506 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3507 extern _Noreturn
void verror (const char *, va_list)
3508 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3509 extern void un_autoload (Lisp_Object
);
3510 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3511 extern void init_eval_once (void);
3512 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3513 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3514 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3515 extern void init_eval (void);
3516 extern void syms_of_eval (void);
3517 extern void unwind_body (Lisp_Object
);
3518 extern void record_in_backtrace (Lisp_Object function
,
3519 Lisp_Object
*args
, ptrdiff_t nargs
);
3520 extern void mark_specpdl (void);
3521 extern void get_backtrace (Lisp_Object array
);
3522 Lisp_Object
backtrace_top_function (void);
3523 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3524 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3527 /* Defined in editfns.c. */
3528 extern Lisp_Object Qfield
;
3529 extern void insert1 (Lisp_Object
);
3530 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3531 extern Lisp_Object
save_excursion_save (void);
3532 extern Lisp_Object
save_restriction_save (void);
3533 extern void save_excursion_restore (Lisp_Object
);
3534 extern void save_restriction_restore (Lisp_Object
);
3535 extern _Noreturn
void time_overflow (void);
3536 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3537 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3539 extern void init_editfns (void);
3540 extern void syms_of_editfns (void);
3541 extern void set_time_zone_rule (const char *);
3543 /* Defined in buffer.c. */
3544 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3545 extern _Noreturn
void nsberror (Lisp_Object
);
3546 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3547 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3548 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3549 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3550 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3551 extern bool overlay_touches_p (ptrdiff_t);
3552 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3553 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3554 extern void init_buffer_once (void);
3555 extern void init_buffer (int);
3556 extern void syms_of_buffer (void);
3557 extern void keys_of_buffer (void);
3559 /* Defined in marker.c. */
3561 extern ptrdiff_t marker_position (Lisp_Object
);
3562 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3563 extern void clear_charpos_cache (struct buffer
*);
3564 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3565 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3566 extern void unchain_marker (struct Lisp_Marker
*marker
);
3567 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3568 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3569 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3570 ptrdiff_t, ptrdiff_t);
3571 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3572 extern void syms_of_marker (void);
3574 /* Defined in fileio.c. */
3576 extern Lisp_Object Qfile_error
;
3577 extern Lisp_Object Qfile_notify_error
;
3578 extern Lisp_Object Qfile_exists_p
;
3579 extern Lisp_Object Qfile_directory_p
;
3580 extern Lisp_Object Qinsert_file_contents
;
3581 extern Lisp_Object Qfile_name_history
;
3582 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3583 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3584 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3586 extern void close_file_unwind (int);
3587 extern void fclose_unwind (void *);
3588 extern void restore_point_unwind (Lisp_Object
);
3589 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3590 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3591 extern bool internal_delete_file (Lisp_Object
);
3592 extern Lisp_Object
emacs_readlinkat (int, const char *);
3593 extern bool file_directory_p (const char *);
3594 extern bool file_accessible_directory_p (const char *);
3595 extern void init_fileio (void);
3596 extern void syms_of_fileio (void);
3597 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3598 extern Lisp_Object Qdelete_file
;
3600 /* Defined in search.c. */
3601 extern void shrink_regexp_cache (void);
3602 extern void restore_search_regs (void);
3603 extern void record_unwind_save_match_data (void);
3604 struct re_registers
;
3605 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3606 struct re_registers
*,
3607 Lisp_Object
, bool, bool);
3608 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3609 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3611 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3612 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3613 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3614 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3615 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3616 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3618 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3619 ptrdiff_t, ptrdiff_t *);
3620 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3621 ptrdiff_t, ptrdiff_t *);
3622 extern void syms_of_search (void);
3623 extern void clear_regexp_cache (void);
3625 /* Defined in minibuf.c. */
3627 extern Lisp_Object Qcompletion_ignore_case
;
3628 extern Lisp_Object Vminibuffer_list
;
3629 extern Lisp_Object last_minibuf_string
;
3630 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3631 extern void init_minibuf_once (void);
3632 extern void syms_of_minibuf (void);
3634 /* Defined in callint.c. */
3636 extern Lisp_Object Qminus
, Qplus
;
3637 extern Lisp_Object Qprogn
;
3638 extern Lisp_Object Qwhen
;
3639 extern Lisp_Object Qmouse_leave_buffer_hook
;
3640 extern void syms_of_callint (void);
3642 /* Defined in casefiddle.c. */
3644 extern Lisp_Object Qidentity
;
3645 extern void syms_of_casefiddle (void);
3646 extern void keys_of_casefiddle (void);
3648 /* Defined in casetab.c. */
3650 extern void init_casetab_once (void);
3651 extern void syms_of_casetab (void);
3653 /* Defined in keyboard.c. */
3655 extern Lisp_Object echo_message_buffer
;
3656 extern struct kboard
*echo_kboard
;
3657 extern void cancel_echoing (void);
3658 extern Lisp_Object Qdisabled
, QCfilter
;
3659 extern Lisp_Object Qup
, Qdown
;
3660 extern Lisp_Object last_undo_boundary
;
3661 extern bool input_pending
;
3662 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3663 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3664 extern void discard_mouse_events (void);
3666 void handle_input_available_signal (int);
3668 extern Lisp_Object pending_funcalls
;
3669 extern bool detect_input_pending (void);
3670 extern bool detect_input_pending_ignore_squeezables (void);
3671 extern bool detect_input_pending_run_timers (bool);
3672 extern void safe_run_hooks (Lisp_Object
);
3673 extern void cmd_error_internal (Lisp_Object
, const char *);
3674 extern Lisp_Object
command_loop_1 (void);
3675 extern Lisp_Object
read_menu_command (void);
3676 extern Lisp_Object
recursive_edit_1 (void);
3677 extern void record_auto_save (void);
3678 extern void force_auto_save_soon (void);
3679 extern void init_keyboard (void);
3680 extern void syms_of_keyboard (void);
3681 extern void keys_of_keyboard (void);
3683 /* Defined in indent.c. */
3684 extern ptrdiff_t current_column (void);
3685 extern void invalidate_current_column (void);
3686 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3687 extern void syms_of_indent (void);
3689 /* Defined in frame.c. */
3690 extern Lisp_Object Qonly
, Qnone
;
3691 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3692 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3693 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3694 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3695 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3696 extern void frames_discard_buffer (Lisp_Object
);
3697 extern void syms_of_frame (void);
3699 /* Defined in emacs.c. */
3700 extern char **initial_argv
;
3701 extern int initial_argc
;
3702 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3703 extern bool display_arg
;
3705 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3706 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3707 extern Lisp_Object Qfile_name_handler_alist
;
3708 extern _Noreturn
void terminate_due_to_signal (int, int);
3709 extern Lisp_Object Qkill_emacs
;
3711 extern Lisp_Object Vlibrary_cache
;
3714 void fixup_locale (void);
3715 void synchronize_system_messages_locale (void);
3716 void synchronize_system_time_locale (void);
3718 INLINE
void fixup_locale (void) {}
3719 INLINE
void synchronize_system_messages_locale (void) {}
3720 INLINE
void synchronize_system_time_locale (void) {}
3722 extern void shut_down_emacs (int, Lisp_Object
);
3724 /* True means don't do interactive redisplay and don't change tty modes. */
3725 extern bool noninteractive
;
3727 /* True means remove site-lisp directories from load-path. */
3728 extern bool no_site_lisp
;
3730 /* Pipe used to send exit notification to the daemon parent at
3732 extern int daemon_pipe
[2];
3733 #define IS_DAEMON (daemon_pipe[1] != 0)
3735 /* True if handling a fatal error already. */
3736 extern bool fatal_error_in_progress
;
3738 /* True means don't do use window-system-specific display code. */
3739 extern bool inhibit_window_system
;
3740 /* True means that a filter or a sentinel is running. */
3741 extern bool running_asynch_code
;
3743 /* Defined in process.c. */
3744 extern Lisp_Object QCtype
, Qlocal
;
3745 extern void kill_buffer_processes (Lisp_Object
);
3746 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3747 struct Lisp_Process
*, int);
3748 /* Max value for the first argument of wait_reading_process_output. */
3749 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3750 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3751 The bug merely causes a bogus warning, but the warning is annoying. */
3752 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3754 # define WAIT_READING_MAX INTMAX_MAX
3756 extern void add_keyboard_wait_descriptor (int);
3757 extern void delete_keyboard_wait_descriptor (int);
3759 extern void add_gpm_wait_descriptor (int);
3760 extern void delete_gpm_wait_descriptor (int);
3762 extern void init_process_emacs (void);
3763 extern void syms_of_process (void);
3764 extern void setup_process_coding_systems (Lisp_Object
);
3766 /* Defined in callproc.c. */
3770 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3771 extern void init_callproc_1 (void);
3772 extern void init_callproc (void);
3773 extern void set_initial_environment (void);
3774 extern void syms_of_callproc (void);
3776 /* Defined in doc.c. */
3777 extern Lisp_Object Qfunction_documentation
;
3778 extern Lisp_Object
read_doc_string (Lisp_Object
);
3779 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3780 extern void syms_of_doc (void);
3781 extern int read_bytecode_char (bool);
3783 /* Defined in bytecode.c. */
3784 extern void syms_of_bytecode (void);
3785 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3786 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3788 /* Defined in macros.c. */
3789 extern void init_macros (void);
3790 extern void syms_of_macros (void);
3792 /* Defined in undo.c. */
3793 extern Lisp_Object Qapply
;
3794 extern Lisp_Object Qinhibit_read_only
;
3795 extern void truncate_undo_list (struct buffer
*);
3796 extern void record_insert (ptrdiff_t, ptrdiff_t);
3797 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3798 extern void record_first_change (void);
3799 extern void record_change (ptrdiff_t, ptrdiff_t);
3800 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3801 Lisp_Object
, Lisp_Object
,
3803 extern void syms_of_undo (void);
3804 /* Defined in textprop.c. */
3805 extern Lisp_Object Qmouse_face
;
3806 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3807 extern Lisp_Object Qminibuffer_prompt
;
3809 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3811 /* Defined in menu.c. */
3812 extern void syms_of_menu (void);
3814 /* Defined in xmenu.c. */
3815 extern void syms_of_xmenu (void);
3817 /* Defined in termchar.h. */
3818 struct tty_display_info
;
3820 /* Defined in termhooks.h. */
3823 /* Defined in sysdep.c. */
3824 #ifndef HAVE_GET_CURRENT_DIR_NAME
3825 extern char *get_current_dir_name (void);
3827 extern void stuff_char (char c
);
3828 extern void init_foreground_group (void);
3829 extern void sys_subshell (void);
3830 extern void sys_suspend (void);
3831 extern void discard_tty_input (void);
3832 extern void init_sys_modes (struct tty_display_info
*);
3833 extern void reset_sys_modes (struct tty_display_info
*);
3834 extern void init_all_sys_modes (void);
3835 extern void reset_all_sys_modes (void);
3836 extern void child_setup_tty (int);
3837 extern void setup_pty (int);
3838 extern int set_window_size (int, int, int);
3839 extern EMACS_INT
get_random (void);
3840 extern void seed_random (void *, ptrdiff_t);
3841 extern void init_random (void);
3842 extern void emacs_backtrace (int);
3843 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3844 extern int emacs_open (const char *, int, int);
3845 extern int emacs_pipe (int[2]);
3846 extern int emacs_close (int);
3847 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3848 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3849 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3850 extern void emacs_perror (char const *);
3852 extern void unlock_all_files (void);
3853 extern void lock_file (Lisp_Object
);
3854 extern void unlock_file (Lisp_Object
);
3855 extern void unlock_buffer (struct buffer
*);
3856 extern void syms_of_filelock (void);
3858 /* Defined in sound.c. */
3859 extern void syms_of_sound (void);
3861 /* Defined in category.c. */
3862 extern void init_category_once (void);
3863 extern Lisp_Object
char_category_set (int);
3864 extern void syms_of_category (void);
3866 /* Defined in ccl.c. */
3867 extern void syms_of_ccl (void);
3869 /* Defined in dired.c. */
3870 extern void syms_of_dired (void);
3871 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3872 Lisp_Object
, Lisp_Object
,
3875 /* Defined in term.c. */
3876 extern int *char_ins_del_vector
;
3877 extern void syms_of_term (void);
3878 extern _Noreturn
void fatal (const char *msgid
, ...)
3879 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3881 /* Defined in terminal.c. */
3882 extern void syms_of_terminal (void);
3884 /* Defined in font.c. */
3885 extern void syms_of_font (void);
3886 extern void init_font (void);
3888 #ifdef HAVE_WINDOW_SYSTEM
3889 /* Defined in fontset.c. */
3890 extern void syms_of_fontset (void);
3892 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3893 extern Lisp_Object Qfont_param
;
3896 /* Defined in gfilenotify.c */
3897 #ifdef HAVE_GFILENOTIFY
3898 extern void globals_of_gfilenotify (void);
3899 extern void syms_of_gfilenotify (void);
3902 /* Defined in inotify.c */
3904 extern void syms_of_inotify (void);
3907 #ifdef HAVE_W32NOTIFY
3908 /* Defined on w32notify.c. */
3909 extern void syms_of_w32notify (void);
3912 /* Defined in xfaces.c. */
3913 extern Lisp_Object Qdefault
, Qfringe
;
3914 extern Lisp_Object Qscroll_bar
, Qcursor
;
3915 extern Lisp_Object Qmode_line_inactive
;
3916 extern Lisp_Object Qface
;
3917 extern Lisp_Object Qnormal
;
3918 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3919 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3920 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3921 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3922 extern Lisp_Object Qoblique
, Qitalic
;
3923 extern Lisp_Object Vface_alternative_font_family_alist
;
3924 extern Lisp_Object Vface_alternative_font_registry_alist
;
3925 extern void syms_of_xfaces (void);
3927 #ifdef HAVE_X_WINDOWS
3928 /* Defined in xfns.c. */
3929 extern void syms_of_xfns (void);
3931 /* Defined in xsmfns.c. */
3932 extern void syms_of_xsmfns (void);
3934 /* Defined in xselect.c. */
3935 extern void syms_of_xselect (void);
3937 /* Defined in xterm.c. */
3938 extern void syms_of_xterm (void);
3939 #endif /* HAVE_X_WINDOWS */
3941 #ifdef HAVE_WINDOW_SYSTEM
3942 /* Defined in xterm.c, nsterm.m, w32term.c. */
3943 extern char *x_get_keysym_name (int);
3944 #endif /* HAVE_WINDOW_SYSTEM */
3947 /* Defined in xml.c. */
3948 extern void syms_of_xml (void);
3949 extern void xml_cleanup_parser (void);
3953 /* Defined in decompress.c. */
3954 extern void syms_of_decompress (void);
3958 /* Defined in dbusbind.c. */
3959 void syms_of_dbusbind (void);
3963 /* Defined in profiler.c. */
3964 extern bool profiler_memory_running
;
3965 extern void malloc_probe (size_t);
3966 extern void syms_of_profiler (void);
3970 /* Defined in msdos.c, w32.c. */
3971 extern char *emacs_root_dir (void);
3974 /* True means ^G can quit instantly. */
3975 extern bool immediate_quit
;
3977 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3978 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3979 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3980 extern void xfree (void *);
3981 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3982 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3983 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3984 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3985 ATTRIBUTE_ALLOC_SIZE ((2,3));
3986 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3987 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3988 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3989 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3990 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3992 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3993 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3994 extern void dupstring (char **, char const *);
3995 extern void xputenv (const char *);
3997 extern char *egetenv (const char *);
3999 /* Copy Lisp string to temporary (allocated on stack) C string. */
4001 #define xlispstrdupa(string) \
4002 memcpy (alloca (SBYTES (string) + 1), \
4003 SSDATA (string), SBYTES (string) + 1)
4005 /* Set up the name of the machine we're running on. */
4006 extern void init_system_name (void);
4008 /* Return the absolute value of X. X should be a signed integer
4009 expression without side effects, and X's absolute value should not
4010 exceed the maximum for its promoted type. This is called 'eabs'
4011 because 'abs' is reserved by the C standard. */
4012 #define eabs(x) ((x) < 0 ? -(x) : (x))
4014 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4017 #define make_fixnum_or_float(val) \
4018 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4020 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4021 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4023 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4025 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4027 #define USE_SAFE_ALLOCA \
4028 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4030 /* SAFE_ALLOCA allocates a simple buffer. */
4032 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
4034 : (sa_must_free = true, record_xmalloc (size)))
4036 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4037 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4038 positive. The code is tuned for MULTIPLIER being a constant. */
4040 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4042 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
4043 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
4046 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4047 sa_must_free = true; \
4048 record_unwind_protect_ptr (xfree, buf); \
4052 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4054 #define SAFE_FREE() \
4056 if (sa_must_free) { \
4057 sa_must_free = false; \
4058 unbind_to (sa_count, Qnil); \
4063 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4065 #define SAFE_ALLOCA_LISP(buf, nelt) \
4067 if ((nelt) < MAX_ALLOCA / word_size) \
4068 (buf) = alloca ((nelt) * word_size); \
4069 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4072 (buf) = xmalloc ((nelt) * word_size); \
4073 arg_ = make_save_memory (buf, nelt); \
4074 sa_must_free = true; \
4075 record_unwind_protect (free_save_value, arg_); \
4078 memory_full (SIZE_MAX); \
4081 /* Loop over all tails of a list, checking for cycles.
4082 FIXME: Make tortoise and n internal declarations.
4083 FIXME: Unroll the loop body so we don't need `n'. */
4084 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4085 for ((tortoise) = (hare) = (list), (n) = true; \
4087 (hare = XCDR (hare), (n) = !(n), \
4089 ? (EQ (hare, tortoise) \
4090 ? xsignal1 (Qcircular_list, list) \
4092 /* Move tortoise before the next iteration, in case */ \
4093 /* the next iteration does an Fsetcdr. */ \
4094 : (void) ((tortoise) = XCDR (tortoise)))))
4096 /* Do a `for' loop over alist values. */
4098 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4099 for ((list_var) = (head_var); \
4100 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4101 (list_var) = XCDR (list_var))
4103 /* Check whether it's time for GC, and run it if so. */
4112 functionp (Lisp_Object object
)
4114 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4116 object
= Findirect_function (object
, Qt
);
4118 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4120 /* Autoloaded symbols are functions, except if they load
4121 macros or keymaps. */
4123 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4124 object
= XCDR (object
);
4126 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4131 return XSUBR (object
)->max_args
!= UNEVALLED
;
4132 else if (COMPILEDP (object
))
4134 else if (CONSP (object
))
4136 Lisp_Object car
= XCAR (object
);
4137 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4145 #endif /* EMACS_LISP_H */