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) (x && scm_is_pair (x))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (x && SCM_INEXACTP (x))
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) (scm_car (c))
309 #define lisp_h_XCDR(c) (scm_cdr (c))
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 XHASH(a) lisp_h_XHASH (a)
342 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
346 /* Define NAME as a lisp.h inline function that returns TYPE and has
347 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
348 ARGS should be parenthesized. Implement the function by calling
350 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
351 INLINE type (name) argdecls { return lisp_h_##name args; }
353 /* like LISP_MACRO_DEFUN, except NAME returns void. */
354 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
355 INLINE void (name) argdecls { lisp_h_##name args; }
358 /* Define the fundamental Lisp data structures. */
360 /* This is the set of Lisp data types. If you want to define a new
361 data type, read the comments after Lisp_Fwd_Type definition
364 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
365 #define case_Lisp_Int case Lisp_Int
367 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
368 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
369 vociferously about them. */
370 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
371 || (defined __SUNPRO_C && __STDC__))
372 #define ENUM_BF(TYPE) unsigned int
374 #define ENUM_BF(TYPE) enum TYPE
377 scm_t_bits lisp_symbol_tag
;
378 scm_t_bits lisp_misc_tag
;
379 scm_t_bits lisp_string_tag
;
380 scm_t_bits lisp_vectorlike_tag
;
384 /* Integer. XINT (obj) is the integer value. */
387 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
390 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
391 whose first member indicates the subtype. */
394 /* String. XSTRING (object) points to a struct Lisp_String.
395 The length of the string, and its contents, are stored therein. */
398 /* Vector of Lisp objects, or something resembling it.
399 XVECTOR (object) points to a struct Lisp_Vector, which contains
400 the size and contents. The size field also contains the type
401 information, if it's not a real vector object. */
404 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
410 /* This is the set of data types that share a common structure.
411 The first member of the structure is a type code from this set.
412 The enum values are arbitrary, but we'll use large numbers to make it
413 more likely that we'll spot the error if a random word in memory is
414 mistakenly interpreted as a Lisp_Misc. */
417 Lisp_Misc_Free
= 0x5eab,
420 Lisp_Misc_Save_Value
,
421 /* Currently floats are not a misc type,
422 but let's define this in case we want to change that. */
424 /* This is not a type code. It is for range checking. */
428 /* These are the types of forwarding objects used in the value slot
429 of symbols for special built-in variables whose value is stored in
433 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
434 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
435 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
436 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
437 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
440 typedef SCM Lisp_Object
;
442 #define LISP_INITIALLY_ZERO SCM_INUM0
444 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
445 At the machine level, these operations are no-ops. */
446 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
447 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
449 /* In the size word of a struct Lisp_Vector, this bit means it's really
450 some other vector-like object. */
451 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
452 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
453 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
455 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
456 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
457 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
460 /* In a pseudovector, the size field actually contains a word with one
461 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
462 with PVEC_TYPE_MASK to indicate the actual type. */
474 PVEC_WINDOW_CONFIGURATION
,
477 /* These should be last, check internal_equal to see why. */
481 PVEC_FONT
/* Should be last because it's used for range checking. */
486 /* For convenience, we also store the number of elements in these bits.
487 Note that this size is not necessarily the memory-footprint size, but
488 only the number of Lisp_Object fields (that need to be traced by GC).
489 The distinction is used, e.g., by Lisp_Process, which places extra
490 non-Lisp_Object fields at the end of the structure. */
491 PSEUDOVECTOR_SIZE_BITS
= 12,
492 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
494 /* To calculate the memory footprint of the pseudovector, it's useful
495 to store the size of non-Lisp area in word_size units here. */
496 PSEUDOVECTOR_REST_BITS
= 12,
497 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
498 << PSEUDOVECTOR_SIZE_BITS
),
500 /* Used to extract pseudovector subtype information. */
501 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
502 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
505 /* These functions extract various sorts of values from a Lisp_Object.
506 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
507 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
510 /* Largest and smallest representable fixnum values. These are the C
511 values. They are macros for use in static initializers. */
512 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
513 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
515 /* Make a Lisp integer representing the value of the low order
518 make_number (EMACS_INT n
)
520 return SCM_I_MAKINUM (n
);
523 /* Extract A's value as a signed integer. */
527 return SCM_I_INUM (a
);
530 /* Like XINT (A), but may be faster. A must be nonnegative.
531 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
532 integers have zero-bits in their tags. */
534 XFASTINT (Lisp_Object a
)
536 EMACS_INT n
= XINT (a
);
541 /* Extract A's value as an unsigned integer. */
543 XUINT (Lisp_Object a
)
545 return SCM_I_INUM (a
);
548 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
549 right now, but XUINT should only be applied to objects we know are
551 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
553 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
555 make_natnum (EMACS_INT n
)
557 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
558 return make_number (n
);
561 /* Return true if X and Y are the same object. */
562 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
564 /* Value is true if I doesn't fit into a Lisp fixnum. It is
565 written this way so that it also works if I is of unsigned
566 type or if I is a NaN. */
568 #define FIXNUM_OVERFLOW_P(i) \
569 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
572 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
574 return num
< lower
? lower
: num
<= upper
? num
: upper
;
577 /* Forward declarations. */
579 /* Defined in this file. */
581 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
582 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
583 INLINE
bool BUFFERP (Lisp_Object
);
584 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
585 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
586 INLINE
bool (CONSP
) (Lisp_Object
);
587 INLINE
bool (FLOATP
) (Lisp_Object
);
588 INLINE
bool functionp (Lisp_Object
);
589 INLINE
bool (INTEGERP
) (Lisp_Object
);
590 INLINE
bool (MARKERP
) (Lisp_Object
);
591 INLINE
bool (MISCP
) (Lisp_Object
);
592 INLINE
bool (NILP
) (Lisp_Object
);
593 INLINE
bool OVERLAYP (Lisp_Object
);
594 INLINE
bool PROCESSP (Lisp_Object
);
595 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
596 INLINE
bool SAVE_VALUEP (Lisp_Object
);
597 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
599 INLINE
bool STRINGP (Lisp_Object
);
600 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
601 INLINE
bool SUBRP (Lisp_Object
);
602 INLINE
bool (SYMBOLP
) (Lisp_Object
);
603 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
604 INLINE
bool WINDOWP (Lisp_Object
);
605 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
607 /* Defined in chartab.c. */
608 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
609 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
610 extern int char_table_translate (Lisp_Object
, int);
612 /* Defined in data.c. */
613 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
614 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
615 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
616 extern Lisp_Object Qbool_vector_p
;
617 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
618 extern Lisp_Object Qwindow
;
619 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
621 /* Defined in emacs.c. */
622 extern bool might_dump
;
623 /* True means Emacs has already been initialized.
624 Used during startup to detect startup of dumped Emacs. */
625 extern bool initialized
;
627 /* Defined in eval.c. */
628 extern Lisp_Object Qautoload
;
630 /* Defined in floatfns.c. */
631 extern double extract_float (Lisp_Object
);
633 /* Defined in process.c. */
634 extern Lisp_Object Qprocessp
;
636 /* Defined in window.c. */
637 extern Lisp_Object Qwindowp
;
639 /* Defined in xdisp.c. */
640 extern Lisp_Object Qimage
;
642 /* Extract A's type. */
643 INLINE
enum Lisp_Type
644 XTYPE (Lisp_Object o
)
648 else if (SYMBOLP (o
))
652 else if (STRINGP (o
))
654 else if (VECTORLIKEP (o
))
655 return Lisp_Vectorlike
;
664 /* Extract a value or address from a Lisp_Object. */
666 INLINE
struct Lisp_Vector
*
667 XVECTOR (Lisp_Object a
)
669 eassert (VECTORLIKEP (a
));
673 INLINE
struct Lisp_String
*
674 XSTRING (Lisp_Object a
)
676 eassert (STRINGP (a
));
680 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
682 /* Pseudovector types. */
684 INLINE
struct Lisp_Process
*
685 XPROCESS (Lisp_Object a
)
687 eassert (PROCESSP (a
));
691 INLINE
struct window
*
692 XWINDOW (Lisp_Object a
)
694 eassert (WINDOWP (a
));
698 INLINE
struct terminal
*
699 XTERMINAL (Lisp_Object a
)
704 INLINE
struct Lisp_Subr
*
705 XSUBR (Lisp_Object a
)
711 INLINE
struct buffer
*
712 XBUFFER (Lisp_Object a
)
714 eassert (BUFFERP (a
));
718 INLINE
struct Lisp_Char_Table
*
719 XCHAR_TABLE (Lisp_Object a
)
721 eassert (CHAR_TABLE_P (a
));
725 INLINE
struct Lisp_Sub_Char_Table
*
726 XSUB_CHAR_TABLE (Lisp_Object a
)
728 eassert (SUB_CHAR_TABLE_P (a
));
732 INLINE
struct Lisp_Bool_Vector
*
733 XBOOL_VECTOR (Lisp_Object a
)
735 eassert (BOOL_VECTOR_P (a
));
740 make_lisp_proc (struct Lisp_Process
*p
)
742 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
745 #define XSETINT(a, b) ((a) = make_number (b))
746 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
747 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
748 #define XSETSTRING(a, b) ((a) = (b)->self)
749 #define XSETSYMBOL(a, b) ((a) = (b)->self)
750 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
752 /* Pseudovector types. */
754 #define XSETPVECTYPE(v, code) \
755 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
756 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
757 ((v)->header.size = (PSEUDOVECTOR_FLAG \
758 | ((code) << PSEUDOVECTOR_AREA_BITS) \
759 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
762 /* The cast to struct vectorlike_header * avoids aliasing issues. */
763 #define XSETPSEUDOVECTOR(a, b, code) \
764 XSETTYPED_PSEUDOVECTOR (a, b, \
765 (((struct vectorlike_header *) \
769 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
770 (XSETVECTOR (a, b), \
771 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
772 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
774 #define XSETWINDOW_CONFIGURATION(a, b) \
775 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
776 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
777 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
778 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
779 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
780 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
781 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
782 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
783 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
784 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
788 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
789 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
792 /* Deprecated and will be removed soon. */
794 #define INTERNAL_FIELD(field) field ## _
796 /* See the macros in intervals.h. */
798 typedef struct interval
*INTERVAL
;
800 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
801 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
803 /* Use these to set the fields of a cons cell.
805 Note that both arguments may refer to the same object, so 'n'
806 should not be read after 'c' is first modified. */
808 XSETCAR (Lisp_Object c
, Lisp_Object n
)
810 scm_set_car_x (c
, n
);
813 XSETCDR (Lisp_Object c
, Lisp_Object n
)
815 scm_set_cdr_x (c
, n
);
818 /* Take the car or cdr of something whose type is not known. */
822 return (CONSP (c
) ? XCAR (c
)
824 : wrong_type_argument (Qlistp
, c
));
829 return (CONSP (c
) ? XCDR (c
)
831 : wrong_type_argument (Qlistp
, c
));
834 /* Take the car or cdr of something whose type is not known. */
836 CAR_SAFE (Lisp_Object c
)
838 return CONSP (c
) ? XCAR (c
) : Qnil
;
841 CDR_SAFE (Lisp_Object c
)
843 return CONSP (c
) ? XCDR (c
) : Qnil
;
846 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
853 INTERVAL intervals
; /* Text properties in this string. */
857 /* True if STR is a multibyte string. */
859 STRING_MULTIBYTE (Lisp_Object str
)
861 return 0 <= XSTRING (str
)->size_byte
;
864 /* An upper bound on the number of bytes in a Lisp string, not
865 counting the terminating null. This a tight enough bound to
866 prevent integer overflow errors that would otherwise occur during
867 string size calculations. A string cannot contain more bytes than
868 a fixnum can represent, nor can it be so long that C pointer
869 arithmetic stops working on the string plus its terminating null.
870 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
871 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
872 would expose alloc.c internal details that we'd rather keep
875 This is a macro for use in static initializers. The cast to
876 ptrdiff_t ensures that the macro is signed. */
877 #define STRING_BYTES_BOUND \
878 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
880 /* Mark STR as a unibyte string. */
881 #define STRING_SET_UNIBYTE(STR) \
883 if (EQ (STR, empty_multibyte_string)) \
884 (STR) = empty_unibyte_string; \
886 XSTRING (STR)->size_byte = -1; \
889 /* Mark STR as a multibyte string. Assure that STR contains only
890 ASCII characters in advance. */
891 #define STRING_SET_MULTIBYTE(STR) \
893 if (EQ (STR, empty_unibyte_string)) \
894 (STR) = empty_multibyte_string; \
896 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
899 /* Convenience functions for dealing with Lisp strings. */
901 INLINE
unsigned char *
902 SDATA (Lisp_Object string
)
904 return XSTRING (string
)->data
;
907 SSDATA (Lisp_Object string
)
909 /* Avoid "differ in sign" warnings. */
910 return (char *) SDATA (string
);
913 SREF (Lisp_Object string
, ptrdiff_t index
)
915 return SDATA (string
)[index
];
918 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
920 SDATA (string
)[index
] = new;
923 SCHARS (Lisp_Object string
)
925 return XSTRING (string
)->size
;
929 STRING_BYTES (struct Lisp_String
*s
)
931 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
935 SBYTES (Lisp_Object string
)
937 return STRING_BYTES (XSTRING (string
));
940 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
942 XSTRING (string
)->size
= newsize
;
945 /* Header of vector-like objects. This documents the layout constraints on
946 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
947 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
948 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
949 because when two such pointers potentially alias, a compiler won't
950 incorrectly reorder loads and stores to their size fields. See
952 struct vectorlike_header
956 /* This field contains various pieces of information:
957 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
958 vector (0) or a pseudovector (1).
959 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
960 of slots) of the vector.
961 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
962 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
963 - b) number of Lisp_Objects slots at the beginning of the object
964 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
966 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
967 measured in word_size units. Rest fields may also include
968 Lisp_Objects, but these objects usually needs some special treatment
970 There are some exceptions. For PVEC_FREE, b) is always zero. For
971 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
972 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
973 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
977 /* A regular vector is just a header plus an array of Lisp_Objects. */
981 struct vectorlike_header header
;
982 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
985 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
988 ALIGNOF_STRUCT_LISP_VECTOR
989 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
992 /* A boolvector is a kind of vectorlike, with contents like a string. */
994 struct Lisp_Bool_Vector
996 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
997 just the subtype information. */
998 struct vectorlike_header header
;
999 /* This is the size in bits. */
1001 /* The actual bits, packed into bytes.
1002 Zeros fill out the last word if needed.
1003 The bits are in little-endian order in the bytes, and
1004 the bytes are in little-endian order in the words. */
1005 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1009 bool_vector_size (Lisp_Object a
)
1011 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1012 eassume (0 <= size
);
1017 bool_vector_data (Lisp_Object a
)
1019 return XBOOL_VECTOR (a
)->data
;
1022 INLINE
unsigned char *
1023 bool_vector_uchar_data (Lisp_Object a
)
1025 return (unsigned char *) bool_vector_data (a
);
1028 /* The number of data words and bytes in a bool vector with SIZE bits. */
1031 bool_vector_words (EMACS_INT size
)
1033 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1034 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1038 bool_vector_bytes (EMACS_INT size
)
1040 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1041 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1044 /* True if A's Ith bit is set. */
1047 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1049 eassume (0 <= i
&& i
< bool_vector_size (a
));
1050 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1051 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1055 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1057 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1060 /* Set A's Ith bit to B. */
1063 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1065 unsigned char *addr
;
1067 eassume (0 <= i
&& i
< bool_vector_size (a
));
1068 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1071 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1073 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1076 /* Some handy constants for calculating sizes
1077 and offsets, mostly of vectorlike objects. */
1081 header_size
= offsetof (struct Lisp_Vector
, contents
),
1082 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1083 word_size
= sizeof (Lisp_Object
)
1086 /* Conveniences for dealing with Lisp arrays. */
1089 AREF (Lisp_Object array
, ptrdiff_t idx
)
1091 return XVECTOR (array
)->contents
[idx
];
1094 INLINE Lisp_Object
*
1095 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1097 return & XVECTOR (array
)->contents
[idx
];
1101 ASIZE (Lisp_Object array
)
1103 return XVECTOR (array
)->header
.size
;
1107 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1109 eassert (0 <= idx
&& idx
< ASIZE (array
));
1110 XVECTOR (array
)->contents
[idx
] = val
;
1114 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1116 /* Like ASET, but also can be used in the garbage collector:
1117 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1118 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1119 XVECTOR (array
)->contents
[idx
] = val
;
1122 /* If a struct is made to look like a vector, this macro returns the length
1123 of the shortest vector that would hold that struct. */
1125 #define VECSIZE(type) \
1126 ((sizeof (type) - header_size + word_size - 1) / word_size)
1128 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1129 at the end and we need to compute the number of Lisp_Object fields (the
1130 ones that the GC needs to trace). */
1132 #define PSEUDOVECSIZE(type, nonlispfield) \
1133 ((offsetof (type, nonlispfield) - header_size) / word_size)
1135 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1136 should be integer expressions. This is not the same as
1137 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1138 returns true. For efficiency, prefer plain unsigned comparison if A
1139 and B's sizes both fit (after integer promotion). */
1140 #define UNSIGNED_CMP(a, op, b) \
1141 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1142 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1143 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1145 /* True iff C is an ASCII character. */
1146 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1148 /* A char-table is a kind of vectorlike, with contents are like a
1149 vector but with a few other slots. For some purposes, it makes
1150 sense to handle a char-table with type struct Lisp_Vector. An
1151 element of a char table can be any Lisp objects, but if it is a sub
1152 char-table, we treat it a table that contains information of a
1153 specific range of characters. A sub char-table has the same
1154 structure as a vector. A sub char table appears only in an element
1155 of a char-table, and there's no way to access it directly from
1156 Emacs Lisp program. */
1158 enum CHARTAB_SIZE_BITS
1160 CHARTAB_SIZE_BITS_0
= 6,
1161 CHARTAB_SIZE_BITS_1
= 4,
1162 CHARTAB_SIZE_BITS_2
= 5,
1163 CHARTAB_SIZE_BITS_3
= 7
1166 extern const int chartab_size
[4];
1168 struct Lisp_Char_Table
1170 /* HEADER.SIZE is the vector's size field, which also holds the
1171 pseudovector type information. It holds the size, too.
1172 The size counts the defalt, parent, purpose, ascii,
1173 contents, and extras slots. */
1174 struct vectorlike_header header
;
1176 /* This holds a default value,
1177 which is used whenever the value for a specific character is nil. */
1180 /* This points to another char table, which we inherit from when the
1181 value for a specific character is nil. The `defalt' slot takes
1182 precedence over this. */
1185 /* This is a symbol which says what kind of use this char-table is
1187 Lisp_Object purpose
;
1189 /* The bottom sub char-table for characters of the range 0..127. It
1190 is nil if none of ASCII character has a specific value. */
1193 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1195 /* These hold additional data. It is a vector. */
1196 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1199 struct Lisp_Sub_Char_Table
1201 /* HEADER.SIZE is the vector's size field, which also holds the
1202 pseudovector type information. It holds the size, too. */
1203 struct vectorlike_header header
;
1205 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1206 char-table of depth 1 contains 16 elements, and each element
1207 covers 4096 (128*32) characters. A sub char-table of depth 2
1208 contains 32 elements, and each element covers 128 characters. A
1209 sub char-table of depth 3 contains 128 elements, and each element
1210 is for one character. */
1213 /* Minimum character covered by the sub char-table. */
1214 Lisp_Object min_char
;
1216 /* Use set_sub_char_table_contents to set this. */
1217 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1221 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1223 struct Lisp_Char_Table
*tbl
= NULL
;
1227 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1228 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1229 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1233 while (NILP (val
) && ! NILP (tbl
->parent
));
1238 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1239 characters. Do not check validity of CT. */
1241 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1243 return (ASCII_CHAR_P (idx
)
1244 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1245 : char_table_ref (ct
, idx
));
1248 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1249 8-bit European characters. Do not check validity of CT. */
1251 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1253 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1254 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1256 char_table_set (ct
, idx
, val
);
1259 /* This structure describes a built-in function.
1260 It is generated by the DEFUN macro only.
1261 defsubr makes it into a Lisp object. */
1265 struct vectorlike_header header
;
1267 Lisp_Object (*a0
) (void);
1268 Lisp_Object (*a1
) (Lisp_Object
);
1269 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1270 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1271 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1272 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1273 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1274 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1275 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1276 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1277 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1279 short min_args
, max_args
;
1280 const char *symbol_name
;
1281 const char *intspec
;
1285 /* This is the number of slots that every char table must have. This
1286 counts the ordinary slots and the top, defalt, parent, and purpose
1288 enum CHAR_TABLE_STANDARD_SLOTS
1290 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1293 /* Return the number of "extra" slots in the char table CT. */
1296 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1298 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1299 - CHAR_TABLE_STANDARD_SLOTS
);
1303 /***********************************************************************
1305 ***********************************************************************/
1307 /* Interned state of a symbol. */
1309 enum symbol_interned
1311 SYMBOL_UNINTERNED
= 0,
1312 SYMBOL_INTERNED
= 1,
1313 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1316 enum symbol_redirect
1318 SYMBOL_PLAINVAL
= 4,
1319 SYMBOL_VARALIAS
= 1,
1320 SYMBOL_LOCALIZED
= 2,
1321 SYMBOL_FORWARDED
= 3
1328 /* Indicates where the value can be found:
1329 0 : it's a plain var, the value is in the `value' field.
1330 1 : it's a varalias, the value is really in the `alias' symbol.
1331 2 : it's a localized var, the value is in the `blv' object.
1332 3 : it's a forwarding variable, the value is in `forward'. */
1333 ENUM_BF (symbol_redirect
) redirect
: 3;
1335 /* Non-zero means symbol is constant, i.e. changing its value
1336 should signal an error. If the value is 3, then the var
1337 can be changed, but only by `defconst'. */
1338 unsigned constant
: 2;
1340 /* Interned state of the symbol. This is an enumerator from
1341 enum symbol_interned. */
1342 unsigned interned
: 2;
1344 /* True means that this variable has been explicitly declared
1345 special (with `defvar' etc), and shouldn't be lexically bound. */
1346 bool_bf declared_special
: 1;
1348 /* True if pointed to from purespace and hence can't be GC'd. */
1351 /* The symbol's name, as a Lisp string. */
1354 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1355 union is used depends on the `redirect' field above. */
1358 struct Lisp_Symbol
*alias
;
1359 struct Lisp_Buffer_Local_Value
*blv
;
1360 union Lisp_Fwd
*fwd
;
1363 /* Function value of the symbol or Qnil if not fboundp. */
1364 Lisp_Object function
;
1366 /* The symbol's property list. */
1369 /* Next symbol in obarray bucket, if the symbol is interned. */
1370 struct Lisp_Symbol
*next
;
1373 /* Value is name of symbol. */
1375 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1377 INLINE
struct Lisp_Symbol
*
1378 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1380 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1381 return sym
->val
.alias
;
1383 INLINE
struct Lisp_Buffer_Local_Value
*
1384 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1386 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1387 return sym
->val
.blv
;
1389 INLINE
union Lisp_Fwd
*
1390 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1392 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1393 return sym
->val
.fwd
;
1396 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1397 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1400 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1402 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1406 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1408 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1412 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1414 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1419 SYMBOL_NAME (Lisp_Object sym
)
1421 return XSYMBOL (sym
)->name
;
1424 /* Value is true if SYM is an interned symbol. */
1427 SYMBOL_INTERNED_P (Lisp_Object sym
)
1429 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1432 /* Value is true if SYM is interned in initial_obarray. */
1435 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1437 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1440 /* Value is non-zero if symbol is considered a constant, i.e. its
1441 value cannot be changed (there is an exception for keyword symbols,
1442 whose value can be set to the keyword symbol itself). */
1444 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1446 #define DEFSYM(sym, name) \
1447 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1450 /***********************************************************************
1452 ***********************************************************************/
1454 /* The structure of a Lisp hash table. */
1456 struct hash_table_test
1458 /* Name of the function used to compare keys. */
1461 /* User-supplied hash function, or nil. */
1462 Lisp_Object user_hash_function
;
1464 /* User-supplied key comparison function, or nil. */
1465 Lisp_Object user_cmp_function
;
1467 /* C function to compare two keys. */
1468 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1470 /* C function to compute hash code. */
1471 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1474 struct Lisp_Hash_Table
1476 /* This is for Lisp; the hash table code does not refer to it. */
1477 struct vectorlike_header header
;
1479 /* Nil if table is non-weak. Otherwise a symbol describing the
1480 weakness of the table. */
1483 /* When the table is resized, and this is an integer, compute the
1484 new size by adding this to the old size. If a float, compute the
1485 new size by multiplying the old size with this factor. */
1486 Lisp_Object rehash_size
;
1488 /* Resize hash table when number of entries/ table size is >= this
1490 Lisp_Object rehash_threshold
;
1492 /* Vector of hash codes. If hash[I] is nil, this means that the
1493 I-th entry is unused. */
1496 /* Vector used to chain entries. If entry I is free, next[I] is the
1497 entry number of the next free item. If entry I is non-free,
1498 next[I] is the index of the next entry in the collision chain. */
1501 /* Index of first free entry in free list. */
1502 Lisp_Object next_free
;
1504 /* Bucket vector. A non-nil entry is the index of the first item in
1505 a collision chain. This vector's size can be larger than the
1506 hash table size to reduce collisions. */
1509 /* Only the fields above are traced normally by the GC. The ones below
1510 `count' are special and are either ignored by the GC or traced in
1511 a special way (e.g. because of weakness). */
1513 /* Number of key/value entries in the table. */
1516 /* Vector of keys and values. The key of item I is found at index
1517 2 * I, the value is found at index 2 * I + 1.
1518 This is gc_marked specially if the table is weak. */
1519 Lisp_Object key_and_value
;
1521 /* The comparison and hash functions. */
1522 struct hash_table_test test
;
1524 /* Next weak hash table if this is a weak hash table. The head
1525 of the list is in weak_hash_tables. */
1526 struct Lisp_Hash_Table
*next_weak
;
1530 INLINE
struct Lisp_Hash_Table
*
1531 XHASH_TABLE (Lisp_Object a
)
1533 return SMOB_PTR (a
);
1536 #define XSET_HASH_TABLE(VAR, PTR) \
1537 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1540 HASH_TABLE_P (Lisp_Object a
)
1542 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1545 /* Value is the key part of entry IDX in hash table H. */
1547 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1549 return AREF (h
->key_and_value
, 2 * idx
);
1552 /* Value is the value part of entry IDX in hash table H. */
1554 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1556 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1559 /* Value is the index of the next entry following the one at IDX
1562 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1564 return AREF (h
->next
, idx
);
1567 /* Value is the hash code computed for entry IDX in hash table H. */
1569 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1571 return AREF (h
->hash
, idx
);
1574 /* Value is the index of the element in hash table H that is the
1575 start of the collision list at index IDX in the index vector of H. */
1577 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1579 return AREF (h
->index
, idx
);
1582 /* Value is the size of hash table H. */
1584 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1586 return ASIZE (h
->next
);
1589 /* Default size for hash tables if not specified. */
1591 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1593 /* Default threshold specifying when to resize a hash table. The
1594 value gives the ratio of current entries in the hash table and the
1595 size of the hash table. */
1597 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1599 /* Default factor by which to increase the size of a hash table. */
1601 static double const DEFAULT_REHASH_SIZE
= 1.5;
1603 /* Combine two integers X and Y for hashing. The result might not fit
1604 into a Lisp integer. */
1607 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1609 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1612 /* Hash X, returning a value that fits into a fixnum. */
1615 SXHASH_REDUCE (EMACS_UINT x
)
1617 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1620 /* These structures are used for various misc types. */
1622 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1625 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1631 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1632 /* This flag is temporarily used in the functions
1633 decode/encode_coding_object to record that the marker position
1634 must be adjusted after the conversion. */
1635 bool_bf need_adjustment
: 1;
1636 /* True means normal insertion at the marker's position
1637 leaves the marker after the inserted text. */
1638 bool_bf insertion_type
: 1;
1639 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1640 Note: a chain of markers can contain markers pointing into different
1641 buffers (the chain is per buffer_text rather than per buffer, so it's
1642 shared between indirect buffers). */
1643 /* This is used for (other than NULL-checking):
1645 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1646 - unchain_marker: to find the list from which to unchain.
1647 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1649 struct buffer
*buffer
;
1651 /* The remaining fields are meaningless in a marker that
1652 does not point anywhere. */
1654 /* For markers that point somewhere,
1655 this is used to chain of all the markers in a given buffer. */
1656 /* We could remove it and use an array in buffer_text instead.
1657 That would also allow to preserve it ordered. */
1658 struct Lisp_Marker
*next
;
1659 /* This is the char position where the marker points. */
1661 /* This is the byte position.
1662 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1663 used to implement the functionality of markers, but rather to (ab)use
1664 markers as a cache for char<->byte mappings). */
1668 /* START and END are markers in the overlay's buffer, and
1669 PLIST is the overlay's property list. */
1671 /* An overlay's real data content is:
1673 - buffer (really there are two buffer pointers, one per marker,
1674 and both points to the same buffer)
1675 - insertion type of both ends (per-marker fields)
1676 - start & start byte (of start marker)
1677 - end & end byte (of end marker)
1678 - next (singly linked list of overlays)
1679 - next fields of start and end markers (singly linked list of markers).
1680 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1684 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1685 struct Lisp_Overlay
*next
;
1691 /* Types of data which may be saved in a Lisp_Save_Value. */
1702 /* Number of bits needed to store one of the above values. */
1703 enum { SAVE_SLOT_BITS
= 3 };
1705 /* Number of slots in a save value where save_type is nonzero. */
1706 enum { SAVE_VALUE_SLOTS
= 4 };
1708 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1710 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1714 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1715 SAVE_TYPE_INT_INT_INT
1716 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1717 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1718 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1719 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1720 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1721 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1722 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1723 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1724 SAVE_TYPE_FUNCPTR_PTR_OBJ
1725 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1727 /* This has an extra bit indicating it's raw memory. */
1728 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1731 /* Special object used to hold a different values for later use.
1733 This is mostly used to package C integers and pointers to call
1734 record_unwind_protect when two or more values need to be saved.
1738 struct my_data *md = get_my_data ();
1739 ptrdiff_t mi = get_my_integer ();
1740 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1743 Lisp_Object my_unwind (Lisp_Object arg)
1745 struct my_data *md = XSAVE_POINTER (arg, 0);
1746 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1750 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1751 saved objects and raise eassert if type of the saved object doesn't match
1752 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1753 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1754 slot 0 is a pointer. */
1756 typedef void (*voidfuncptr
) (void);
1758 struct Lisp_Save_Value
1761 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1762 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1764 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1765 V's data entries are determined by V->save_type. E.g., if
1766 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1767 V->data[1] is an integer, and V's other data entries are unused.
1769 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1770 a memory area containing V->data[1].integer potential Lisp_Objects. */
1771 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1774 voidfuncptr funcpointer
;
1777 } data
[SAVE_VALUE_SLOTS
];
1780 /* Return the type of V's Nth saved value. */
1782 save_type (struct Lisp_Save_Value
*v
, int n
)
1784 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1785 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1788 /* Get and set the Nth saved pointer. */
1791 XSAVE_POINTER (Lisp_Object obj
, int n
)
1793 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1794 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1797 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1799 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1800 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1803 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1805 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1806 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1809 /* Likewise for the saved integer. */
1812 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1814 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1815 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1818 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1820 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1821 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1824 /* Extract Nth saved object. */
1827 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1829 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1830 return XSAVE_VALUE (obj
)->data
[n
].object
;
1833 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1834 It uses one of these struct subtypes to get the type field. */
1838 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1839 struct Lisp_Marker u_marker
;
1840 struct Lisp_Overlay u_overlay
;
1841 struct Lisp_Save_Value u_save_value
;
1844 INLINE
union Lisp_Misc
*
1845 XMISC (Lisp_Object a
)
1847 return SMOB_PTR (a
);
1850 INLINE
struct Lisp_Misc_Any
*
1851 XMISCANY (Lisp_Object a
)
1853 eassert (MISCP (a
));
1854 return & XMISC (a
)->u_any
;
1857 INLINE
enum Lisp_Misc_Type
1858 XMISCTYPE (Lisp_Object a
)
1860 return XMISCANY (a
)->type
;
1863 INLINE
struct Lisp_Marker
*
1864 XMARKER (Lisp_Object a
)
1866 eassert (MARKERP (a
));
1867 return & XMISC (a
)->u_marker
;
1870 INLINE
struct Lisp_Overlay
*
1871 XOVERLAY (Lisp_Object a
)
1873 eassert (OVERLAYP (a
));
1874 return & XMISC (a
)->u_overlay
;
1877 INLINE
struct Lisp_Save_Value
*
1878 XSAVE_VALUE (Lisp_Object a
)
1880 eassert (SAVE_VALUEP (a
));
1881 return & XMISC (a
)->u_save_value
;
1884 /* Forwarding pointer to an int variable.
1885 This is allowed only in the value cell of a symbol,
1886 and it means that the symbol's value really lives in the
1887 specified int variable. */
1890 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1894 /* Boolean forwarding pointer to an int variable.
1895 This is like Lisp_Intfwd except that the ostensible
1896 "value" of the symbol is t if the bool variable is true,
1897 nil if it is false. */
1900 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1904 /* Forwarding pointer to a Lisp_Object variable.
1905 This is allowed only in the value cell of a symbol,
1906 and it means that the symbol's value really lives in the
1907 specified variable. */
1910 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1911 Lisp_Object
*objvar
;
1914 /* Like Lisp_Objfwd except that value lives in a slot in the
1915 current buffer. Value is byte index of slot within buffer. */
1916 struct Lisp_Buffer_Objfwd
1918 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1920 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1921 Lisp_Object predicate
;
1924 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1925 the symbol has buffer-local or frame-local bindings. (Exception:
1926 some buffer-local variables are built-in, with their values stored
1927 in the buffer structure itself. They are handled differently,
1928 using struct Lisp_Buffer_Objfwd.)
1930 The `realvalue' slot holds the variable's current value, or a
1931 forwarding pointer to where that value is kept. This value is the
1932 one that corresponds to the loaded binding. To read or set the
1933 variable, you must first make sure the right binding is loaded;
1934 then you can access the value in (or through) `realvalue'.
1936 `buffer' and `frame' are the buffer and frame for which the loaded
1937 binding was found. If those have changed, to make sure the right
1938 binding is loaded it is necessary to find which binding goes with
1939 the current buffer and selected frame, then load it. To load it,
1940 first unload the previous binding, then copy the value of the new
1941 binding into `realvalue' (or through it). Also update
1942 LOADED-BINDING to point to the newly loaded binding.
1944 `local_if_set' indicates that merely setting the variable creates a
1945 local binding for the current buffer. Otherwise the latter, setting
1946 the variable does not do that; only make-local-variable does that. */
1948 struct Lisp_Buffer_Local_Value
1950 /* True means that merely setting the variable creates a local
1951 binding for the current buffer. */
1952 bool_bf local_if_set
: 1;
1953 /* True means this variable can have frame-local bindings, otherwise, it is
1954 can have buffer-local bindings. The two cannot be combined. */
1955 bool_bf frame_local
: 1;
1956 /* True means that the binding now loaded was found.
1957 Presumably equivalent to (defcell!=valcell). */
1959 /* If non-NULL, a forwarding to the C var where it should also be set. */
1960 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1961 /* The buffer or frame for which the loaded binding was found. */
1963 /* A cons cell that holds the default value. It has the form
1964 (SYMBOL . DEFAULT-VALUE). */
1965 Lisp_Object defcell
;
1966 /* The cons cell from `where's parameter alist.
1967 It always has the form (SYMBOL . VALUE)
1968 Note that if `forward' is non-nil, VALUE may be out of date.
1969 Also if the currently loaded binding is the default binding, then
1970 this is `eq'ual to defcell. */
1971 Lisp_Object valcell
;
1974 /* Like Lisp_Objfwd except that value lives in a slot in the
1976 struct Lisp_Kboard_Objfwd
1978 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1984 struct Lisp_Intfwd u_intfwd
;
1985 struct Lisp_Boolfwd u_boolfwd
;
1986 struct Lisp_Objfwd u_objfwd
;
1987 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1988 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1991 INLINE
enum Lisp_Fwd_Type
1992 XFWDTYPE (union Lisp_Fwd
*a
)
1994 return a
->u_intfwd
.type
;
1997 INLINE
struct Lisp_Buffer_Objfwd
*
1998 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2000 eassert (BUFFER_OBJFWDP (a
));
2001 return &a
->u_buffer_objfwd
;
2004 #define XFLOAT_DATA(f) (scm_to_double (f))
2006 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2007 representations, have infinities and NaNs, and do not trap on
2008 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2009 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2010 wanted here, but is not quite right because Emacs does not require
2011 all the features of C11 Annex F (and does not require C11 at all,
2012 for that matter). */
2016 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2017 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2020 /* A character, declared with the following typedef, is a member
2021 of some character set associated with the current buffer. */
2022 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2024 typedef unsigned char UCHAR
;
2027 /* Meanings of slots in a Lisp_Compiled: */
2031 COMPILED_ARGLIST
= 0,
2032 COMPILED_BYTECODE
= 1,
2033 COMPILED_CONSTANTS
= 2,
2034 COMPILED_STACK_DEPTH
= 3,
2035 COMPILED_DOC_STRING
= 4,
2036 COMPILED_INTERACTIVE
= 5
2039 /* Flag bits in a character. These also get used in termhooks.h.
2040 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2041 (MUlti-Lingual Emacs) might need 22 bits for the character value
2042 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2045 CHAR_ALT
= 0x0400000,
2046 CHAR_SUPER
= 0x0800000,
2047 CHAR_HYPER
= 0x1000000,
2048 CHAR_SHIFT
= 0x2000000,
2049 CHAR_CTL
= 0x4000000,
2050 CHAR_META
= 0x8000000,
2052 CHAR_MODIFIER_MASK
=
2053 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2055 /* Actually, the current Emacs uses 22 bits for the character value
2060 /* Data type checking. */
2062 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2065 NUMBERP (Lisp_Object x
)
2067 return INTEGERP (x
) || FLOATP (x
);
2070 NATNUMP (Lisp_Object x
)
2072 return INTEGERP (x
) && 0 <= XINT (x
);
2076 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2078 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2081 #define TYPE_RANGED_INTEGERP(type, x) \
2083 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2084 && XINT (x) <= TYPE_MAXIMUM (type))
2086 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2087 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2088 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2089 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2090 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2091 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2092 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2095 STRINGP (Lisp_Object x
)
2097 return SMOB_TYPEP (x
, lisp_string_tag
);
2100 VECTORP (Lisp_Object x
)
2102 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2105 OVERLAYP (Lisp_Object x
)
2107 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2110 SAVE_VALUEP (Lisp_Object x
)
2112 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2116 AUTOLOADP (Lisp_Object x
)
2118 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2122 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2124 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2128 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2130 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2131 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2134 /* True if A is a pseudovector whose code is CODE. */
2136 PSEUDOVECTORP (Lisp_Object a
, int code
)
2138 if (! VECTORLIKEP (a
))
2142 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2143 struct vectorlike_header
*h
= SMOB_PTR (a
);
2144 return PSEUDOVECTOR_TYPEP (h
, code
);
2148 /* Test for specific pseudovector types. */
2151 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2153 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2157 PROCESSP (Lisp_Object a
)
2159 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2163 WINDOWP (Lisp_Object a
)
2165 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2169 TERMINALP (Lisp_Object a
)
2171 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2175 SUBRP (Lisp_Object a
)
2177 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2181 COMPILEDP (Lisp_Object a
)
2183 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2187 BUFFERP (Lisp_Object a
)
2189 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2193 CHAR_TABLE_P (Lisp_Object a
)
2195 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2199 SUB_CHAR_TABLE_P (Lisp_Object a
)
2201 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2205 BOOL_VECTOR_P (Lisp_Object a
)
2207 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2211 FRAMEP (Lisp_Object a
)
2213 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2216 /* Test for image (image . spec) */
2218 IMAGEP (Lisp_Object x
)
2220 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2225 ARRAYP (Lisp_Object x
)
2227 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2231 CHECK_LIST (Lisp_Object x
)
2233 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2236 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2237 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2238 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2241 CHECK_STRING (Lisp_Object x
)
2243 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2246 CHECK_STRING_CAR (Lisp_Object x
)
2248 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2251 CHECK_CONS (Lisp_Object x
)
2253 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2256 CHECK_VECTOR (Lisp_Object x
)
2258 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2261 CHECK_BOOL_VECTOR (Lisp_Object x
)
2263 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2266 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2268 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2271 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2273 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2276 CHECK_BUFFER (Lisp_Object x
)
2278 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2281 CHECK_WINDOW (Lisp_Object x
)
2283 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2287 CHECK_PROCESS (Lisp_Object x
)
2289 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2293 CHECK_NATNUM (Lisp_Object x
)
2295 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2298 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2301 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2302 args_out_of_range_3 \
2304 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2305 ? MOST_NEGATIVE_FIXNUM \
2307 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2309 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2311 if (TYPE_SIGNED (type)) \
2312 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2314 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2317 #define CHECK_NUMBER_COERCE_MARKER(x) \
2319 if (MARKERP ((x))) \
2320 XSETFASTINT (x, marker_position (x)); \
2322 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2326 XFLOATINT (Lisp_Object n
)
2328 return extract_float (n
);
2332 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2334 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2337 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2340 XSETFASTINT (x, marker_position (x)); \
2342 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2345 /* Since we can't assign directly to the CAR or CDR fields of a cons
2346 cell, use these when checking that those fields contain numbers. */
2348 CHECK_NUMBER_CAR (Lisp_Object x
)
2350 Lisp_Object tmp
= XCAR (x
);
2356 CHECK_NUMBER_CDR (Lisp_Object x
)
2358 Lisp_Object tmp
= XCDR (x
);
2363 /* Define a built-in function for calling from Lisp.
2364 `lname' should be the name to give the function in Lisp,
2365 as a null-terminated C string.
2366 `fnname' should be the name of the function in C.
2367 By convention, it starts with F.
2368 `sname' should be the name for the C constant structure
2369 that records information on this function for internal use.
2370 By convention, it should be the same as `fnname' but with S instead of F.
2371 It's too bad that C macros can't compute this from `fnname'.
2372 `minargs' should be a number, the minimum number of arguments allowed.
2373 `maxargs' should be a number, the maximum number of arguments allowed,
2374 or else MANY or UNEVALLED.
2375 MANY means pass a vector of evaluated arguments,
2376 in the form of an integer number-of-arguments
2377 followed by the address of a vector of Lisp_Objects
2378 which contains the argument values.
2379 UNEVALLED means pass the list of unevaluated arguments
2380 `intspec' says how interactive arguments are to be fetched.
2381 If the string starts with a `(', `intspec' is evaluated and the resulting
2382 list is the list of arguments.
2383 If it's a string that doesn't start with `(', the value should follow
2384 the one of the doc string for `interactive'.
2385 A null string means call interactively with no arguments.
2386 `doc' is documentation for the user. */
2388 /* This version of DEFUN declares a function prototype with the right
2389 arguments, so we can catch errors with maxargs at compile-time. */
2391 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2392 SCM_SNARF_INIT (defsubr (&sname);) \
2393 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2394 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2396 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2397 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2398 { (Lisp_Object (__cdecl *)(void))fnname }, \
2399 minargs, maxargs, lname, intspec, 0}; \
2401 #else /* not _MSC_VER */
2402 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2403 SCM_SNARF_INIT (defsubr (&sname);) \
2404 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2405 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2407 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2408 { .a ## maxargs = fnname }, \
2409 minargs, maxargs, lname, intspec, 0}; \
2413 /* Note that the weird token-substitution semantics of ANSI C makes
2414 this work for MANY and UNEVALLED. */
2415 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2416 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2417 #define DEFUN_ARGS_0 (void)
2418 #define DEFUN_ARGS_1 (Lisp_Object)
2419 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2420 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2421 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2422 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2424 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2425 Lisp_Object, Lisp_Object)
2426 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2427 Lisp_Object, Lisp_Object, Lisp_Object)
2428 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2429 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2431 /* True if OBJ is a Lisp function. */
2433 FUNCTIONP (Lisp_Object obj
)
2435 return functionp (obj
);
2439 is how we define the symbol for function `name' at start-up time. */
2440 extern void defsubr (struct Lisp_Subr
*);
2448 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2449 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2450 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2451 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2452 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2454 /* Macros we use to define forwarded Lisp variables.
2455 These are used in the syms_of_FILENAME functions.
2457 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2458 lisp variable is actually a field in `struct emacs_globals'. The
2459 field's name begins with "f_", which is a convention enforced by
2460 these macros. Each such global has a corresponding #define in
2461 globals.h; the plain name should be used in the code.
2463 E.g., the global "cons_cells_consed" is declared as "int
2464 f_cons_cells_consed" in globals.h, but there is a define:
2466 #define cons_cells_consed globals.f_cons_cells_consed
2468 All C code uses the `cons_cells_consed' name. This is all done
2469 this way to support indirection for multi-threaded Emacs. */
2471 #define DEFVAR_LISP(lname, vname, doc) \
2473 static struct Lisp_Objfwd o_fwd; \
2474 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2476 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2478 static struct Lisp_Objfwd o_fwd; \
2479 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2481 #define DEFVAR_BOOL(lname, vname, doc) \
2483 static struct Lisp_Boolfwd b_fwd; \
2484 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2486 #define DEFVAR_INT(lname, vname, doc) \
2488 static struct Lisp_Intfwd i_fwd; \
2489 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2492 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2494 static struct Lisp_Objfwd o_fwd; \
2495 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2498 #define DEFVAR_KBOARD(lname, vname, doc) \
2500 static struct Lisp_Kboard_Objfwd ko_fwd; \
2501 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2504 /* Save and restore the instruction and environment pointers,
2505 without affecting the signal mask. */
2508 typedef jmp_buf sys_jmp_buf
;
2509 # define sys_setjmp(j) _setjmp (j)
2510 # define sys_longjmp(j, v) _longjmp (j, v)
2511 #elif defined HAVE_SIGSETJMP
2512 typedef sigjmp_buf sys_jmp_buf
;
2513 # define sys_setjmp(j) sigsetjmp (j, 0)
2514 # define sys_longjmp(j, v) siglongjmp (j, v)
2516 /* A platform that uses neither _longjmp nor siglongjmp; assume
2517 longjmp does not affect the sigmask. */
2518 typedef jmp_buf sys_jmp_buf
;
2519 # define sys_setjmp(j) setjmp (j)
2520 # define sys_longjmp(j, v) longjmp (j, v)
2524 /* Elisp uses several stacks:
2526 - the bytecode stack: used internally by the bytecode interpreter.
2527 Allocated from the C stack.
2528 - The specpdl stack: keeps track of active unwind-protect and
2529 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2531 - The handler stack: keeps track of active catch tags and condition-case
2532 handlers. Allocated in a manually managed stack implemented by a
2533 doubly-linked list allocated via xmalloc and never freed. */
2535 /* Structure for recording Lisp call stack for backtrace purposes. */
2537 /* The special binding stack holds the outer values of variables while
2538 they are bound by a function application or a let form, stores the
2539 code to be executed for unwind-protect forms.
2541 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2542 used all over the place, needs to be fast, and needs to know the size of
2543 union specbinding. But only eval.c should access it. */
2546 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
2547 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
2548 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
2549 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
2550 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2551 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2552 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2553 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2554 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2559 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2561 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2562 void (*func
) (Lisp_Object
);
2566 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2567 void (*func
) (void *);
2571 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2576 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2577 void (*func
) (void);
2580 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2581 /* `where' is not used in the case of SPECPDL_LET. */
2582 Lisp_Object symbol
, old_value
, where
;
2585 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2586 bool_bf debug_on_exit
: 1;
2587 Lisp_Object function
;
2593 extern union specbinding
*specpdl
;
2594 extern union specbinding
*specpdl_ptr
;
2595 extern ptrdiff_t specpdl_size
;
2598 SPECPDL_INDEX (void)
2600 return specpdl_ptr
- specpdl
;
2603 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2604 control structures. A struct handler contains all the information needed to
2605 restore the state of the interpreter after a non-local jump.
2607 handler structures are chained together in a doubly linked list; the `next'
2608 member points to the next outer catchtag and the `nextfree' member points in
2609 the other direction to the next inner element (which is typically the next
2610 free element since we mostly use it on the deepest handler).
2612 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2613 member is TAG, and then unbinds to it. The `val' member is used to
2614 hold VAL while the stack is unwound; `val' is returned as the value
2617 All the other members are concerned with restoring the interpreter
2620 Members are volatile if their values need to survive _longjmp when
2621 a 'struct handler' is a local variable. */
2623 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2627 enum handlertype type
;
2628 Lisp_Object tag_or_ch
;
2630 struct handler
*next
;
2631 struct handler
*nextfree
;
2633 /* The bytecode interpreter can have several handlers active at the same
2634 time, so when we longjmp to one of them, it needs to know which handler
2635 this was and what was the corresponding internal state. This is stored
2636 here, and when we longjmp we make sure that handlerlist points to the
2638 Lisp_Object
*bytecode_top
;
2641 /* Most global vars are reset to their value via the specpdl mechanism,
2642 but a few others are handled by storing their value here. */
2643 #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */
2644 struct gcpro
*gcpro
;
2647 EMACS_INT lisp_eval_depth
;
2649 int poll_suppress_count
;
2650 int interrupt_input_blocked
;
2653 /* Fill in the components of c, and put it on the list. */
2654 #define PUSH_HANDLER(c, tag_ch_val, handlertype) \
2655 if (handlerlist->nextfree) \
2656 (c) = handlerlist->nextfree; \
2659 (c) = xmalloc (sizeof (struct handler)); \
2660 (c)->nextfree = NULL; \
2661 handlerlist->nextfree = (c); \
2663 (c)->type = (handlertype); \
2664 (c)->tag_or_ch = (tag_ch_val); \
2666 (c)->next = handlerlist; \
2667 (c)->lisp_eval_depth = lisp_eval_depth; \
2668 (c)->pdlcount = SPECPDL_INDEX (); \
2669 (c)->poll_suppress_count = poll_suppress_count; \
2670 (c)->interrupt_input_blocked = interrupt_input_blocked;\
2671 (c)->gcpro = gcprolist; \
2675 extern Lisp_Object memory_signal_data
;
2677 /* Check quit-flag and quit if it is non-nil.
2678 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2679 So the program needs to do QUIT at times when it is safe to quit.
2680 Every loop that might run for a long time or might not exit
2681 ought to do QUIT at least once, at a safe place.
2682 Unless that is impossible, of course.
2683 But it is very desirable to avoid creating loops where QUIT is impossible.
2685 Exception: if you set immediate_quit to true,
2686 then the handler that responds to the C-g does the quit itself.
2687 This is a good thing to do around a loop that has no side effects
2688 and (in particular) cannot call arbitrary Lisp code.
2690 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2691 a request to exit Emacs when it is safe to do. */
2693 extern void process_pending_signals (void);
2694 extern bool volatile pending_signals
;
2696 extern void process_quit_flag (void);
2699 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2700 process_quit_flag (); \
2701 else if (pending_signals) \
2702 process_pending_signals (); \
2706 /* True if ought to quit now. */
2708 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2710 extern Lisp_Object Vascii_downcase_table
;
2711 extern Lisp_Object Vascii_canon_table
;
2713 /* Structure for recording stack slots that need marking. */
2715 /* This is a chain of structures, each of which points at a Lisp_Object
2716 variable whose value should be marked in garbage collection.
2717 Normally every link of the chain is an automatic variable of a function,
2718 and its `val' points to some argument or local variable of the function.
2719 On exit to the function, the chain is set back to the value it had on entry.
2720 This way, no link remains in the chain when the stack frame containing the
2723 Every function that can call Feval must protect in this fashion all
2724 Lisp_Object variables whose contents will be used again. */
2726 extern struct gcpro
*gcprolist
;
2732 /* Address of first protected variable. */
2733 volatile Lisp_Object
*var
;
2735 /* Number of consecutive protected variables. */
2743 /* Do something silly with gcproN vars just so gcc shuts up. */
2744 /* You get warnings from MIPSPro... */
2746 #define GCPRO1(varname) ((void) gcpro1)
2747 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2748 #define GCPRO3(varname1, varname2, varname3) \
2749 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2750 #define GCPRO4(varname1, varname2, varname3, varname4) \
2751 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2752 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2753 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2754 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2755 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2757 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2758 #define UNGCPRO ((void) 0)
2760 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2761 #define RETURN_UNGCPRO(expr) \
2764 Lisp_Object ret_ungc_val; \
2765 ret_ungc_val = (expr); \
2767 return ret_ungc_val; \
2771 /* Call staticpro (&var) to protect static variable `var'. */
2773 void staticpro (Lisp_Object
*);
2775 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2776 meaning as in the DEFUN macro, and is used to construct a prototype. */
2777 /* We can use the same trick as in the DEFUN macro to generate the
2778 appropriate prototype. */
2779 #define EXFUN(fnname, maxargs) \
2780 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2782 #include "globals.h"
2784 /* Forward declarations for prototypes. */
2788 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2791 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2793 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2794 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2797 /* Functions to modify hash tables. */
2800 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2802 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2806 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2808 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2811 /* Use these functions to set Lisp_Object
2812 or pointer slots of struct Lisp_Symbol. */
2815 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2817 XSYMBOL (sym
)->function
= function
;
2821 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2823 XSYMBOL (sym
)->plist
= plist
;
2827 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2829 XSYMBOL (sym
)->next
= next
;
2832 /* Buffer-local (also frame-local) variable access functions. */
2835 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2837 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2841 /* Set overlay's property list. */
2844 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2846 XOVERLAY (overlay
)->plist
= plist
;
2849 /* Get text properties of S. */
2852 string_intervals (Lisp_Object s
)
2854 return XSTRING (s
)->intervals
;
2857 /* Set text properties of S to I. */
2860 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2862 XSTRING (s
)->intervals
= i
;
2865 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2866 of setting slots directly. */
2869 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2871 XCHAR_TABLE (table
)->defalt
= val
;
2874 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2876 XCHAR_TABLE (table
)->purpose
= val
;
2879 /* Set different slots in (sub)character tables. */
2882 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2884 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2885 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2889 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2891 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2892 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2896 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2898 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2901 /* Defined in data.c. */
2902 extern Lisp_Object Qquote
, Qunbound
;
2903 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2904 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2905 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2906 extern Lisp_Object Qinvalid_read_syntax
;
2907 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2908 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2909 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2910 extern Lisp_Object Qtext_read_only
;
2911 extern Lisp_Object Qinteractive_form
;
2912 extern Lisp_Object Qcircular_list
;
2913 extern Lisp_Object Qsequencep
;
2914 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2915 extern Lisp_Object Qfboundp
;
2917 extern Lisp_Object Qcdr
;
2919 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2921 extern Lisp_Object Qnumber_or_marker_p
;
2923 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2925 /* Defined in data.c. */
2926 extern Lisp_Object
indirect_function (Lisp_Object
);
2927 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2928 enum Arith_Comparison
{
2933 ARITH_LESS_OR_EQUAL
,
2936 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2937 enum Arith_Comparison comparison
);
2939 /* Convert the integer I to an Emacs representation, either the integer
2940 itself, or a cons of two or three integers, or if all else fails a float.
2941 I should not have side effects. */
2942 #define INTEGER_TO_CONS(i) \
2943 (! FIXNUM_OVERFLOW_P (i) \
2945 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2946 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2947 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2948 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2949 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2950 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2951 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2952 ? Fcons (make_number ((i) >> 16 >> 24), \
2953 Fcons (make_number ((i) >> 16 & 0xffffff), \
2954 make_number ((i) & 0xffff))) \
2957 /* Convert the Emacs representation CONS back to an integer of type
2958 TYPE, storing the result the variable VAR. Signal an error if CONS
2959 is not a valid representation or is out of range for TYPE. */
2960 #define CONS_TO_INTEGER(cons, type, var) \
2961 (TYPE_SIGNED (type) \
2962 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2963 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2964 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2965 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2967 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2968 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2969 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2971 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2972 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2973 extern void syms_of_data (void);
2974 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2976 /* Defined in cmds.c */
2977 extern void syms_of_cmds (void);
2978 extern void keys_of_cmds (void);
2980 /* Defined in coding.c. */
2981 extern Lisp_Object Qcharset
;
2982 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2983 ptrdiff_t, bool, bool, Lisp_Object
);
2984 extern void init_coding (void);
2985 extern void init_coding_once (void);
2986 extern void syms_of_coding (void);
2988 /* Defined in character.c. */
2989 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2990 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2991 extern void syms_of_character (void);
2993 /* Defined in charset.c. */
2994 extern void init_charset (void);
2995 extern void init_charset_once (void);
2996 extern void syms_of_charset (void);
2997 /* Structure forward declarations. */
3000 /* Defined in syntax.c. */
3001 extern void init_syntax_once (void);
3002 extern void syms_of_syntax (void);
3004 /* Defined in fns.c. */
3005 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
3006 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3007 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3008 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3009 extern void sweep_weak_hash_tables (void);
3010 extern Lisp_Object Qcursor_in_echo_area
;
3011 extern Lisp_Object Qstring_lessp
;
3012 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
3013 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3014 EMACS_UINT
sxhash (Lisp_Object
, int);
3015 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
3016 Lisp_Object
, Lisp_Object
);
3017 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3018 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3020 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
3021 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3022 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3023 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3024 ptrdiff_t, ptrdiff_t);
3025 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3026 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3027 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3028 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3029 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3030 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3031 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3032 extern void clear_string_char_byte_cache (void);
3033 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3034 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3035 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3036 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3037 extern void init_fns_once (void);
3038 extern void syms_of_fns (void);
3040 /* Defined in floatfns.c. */
3041 extern void syms_of_floatfns (void);
3042 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3044 /* Defined in fringe.c. */
3045 extern void syms_of_fringe (void);
3046 extern void init_fringe (void);
3047 #ifdef HAVE_WINDOW_SYSTEM
3048 extern void mark_fringe_data (void);
3049 extern void init_fringe_once (void);
3050 #endif /* HAVE_WINDOW_SYSTEM */
3052 /* Defined in image.c. */
3053 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3054 extern Lisp_Object QCconversion
;
3055 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3056 extern void reset_image_types (void);
3057 extern void syms_of_image (void);
3059 /* Defined in insdel.c. */
3060 extern Lisp_Object Qinhibit_modification_hooks
;
3061 extern Lisp_Object Qregion_extract_function
;
3062 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3063 extern _Noreturn
void buffer_overflow (void);
3064 extern void make_gap (ptrdiff_t);
3065 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3066 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3067 ptrdiff_t, bool, bool);
3068 extern int count_combining_before (const unsigned char *,
3069 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3070 extern int count_combining_after (const unsigned char *,
3071 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3072 extern void insert (const char *, ptrdiff_t);
3073 extern void insert_and_inherit (const char *, ptrdiff_t);
3074 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3076 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3077 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3078 ptrdiff_t, ptrdiff_t, bool);
3079 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3080 extern void insert_char (int);
3081 extern void insert_string (const char *);
3082 extern void insert_before_markers (const char *, ptrdiff_t);
3083 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3084 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3085 ptrdiff_t, ptrdiff_t,
3087 extern void del_range (ptrdiff_t, ptrdiff_t);
3088 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3089 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3090 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3091 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3092 ptrdiff_t, ptrdiff_t, bool);
3093 extern void modify_text (ptrdiff_t, ptrdiff_t);
3094 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3095 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3096 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3097 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3098 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3099 ptrdiff_t, ptrdiff_t);
3100 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3101 ptrdiff_t, ptrdiff_t);
3102 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3103 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3104 const char *, ptrdiff_t, ptrdiff_t, bool);
3105 extern void syms_of_insdel (void);
3107 /* Defined in dispnew.c. */
3108 #if (defined PROFILING \
3109 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3110 _Noreturn
void __executable_start (void);
3112 extern Lisp_Object Vwindow_system
;
3113 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3115 /* Defined in xdisp.c. */
3116 extern Lisp_Object Qinhibit_point_motion_hooks
;
3117 extern Lisp_Object Qinhibit_redisplay
;
3118 extern Lisp_Object Qmenu_bar_update_hook
;
3119 extern Lisp_Object Qwindow_scroll_functions
;
3120 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3121 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3122 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3123 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3124 extern Lisp_Object Qleft_margin
, Qright_margin
;
3125 extern Lisp_Object QCdata
, QCfile
;
3126 extern Lisp_Object QCmap
;
3127 extern Lisp_Object Qrisky_local_variable
;
3128 extern bool noninteractive_need_newline
;
3129 extern Lisp_Object echo_area_buffer
[2];
3130 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3131 extern void check_message_stack (void);
3132 extern void setup_echo_area_for_printing (int);
3133 extern bool push_message (void);
3134 extern void pop_message_unwind (void);
3135 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3136 extern void restore_message (void);
3137 extern Lisp_Object
current_message (void);
3138 extern void clear_message (bool, bool);
3139 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3140 extern void message1 (const char *);
3141 extern void message1_nolog (const char *);
3142 extern void message3 (Lisp_Object
);
3143 extern void message3_nolog (Lisp_Object
);
3144 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3145 extern void message_with_string (const char *, Lisp_Object
, int);
3146 extern void message_log_maybe_newline (void);
3147 extern void update_echo_area (void);
3148 extern void truncate_echo_area (ptrdiff_t);
3149 extern void redisplay (void);
3151 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3152 extern void syms_of_xdisp (void);
3153 extern void init_xdisp (void);
3154 extern Lisp_Object
safe_eval (Lisp_Object
);
3155 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3156 int *, int *, int *, int *, int *);
3158 /* Defined in xsettings.c. */
3159 extern void syms_of_xsettings (void);
3161 /* Defined in vm-limit.c. */
3162 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3164 /* Defined in alloc.c. */
3165 extern void check_pure_size (void);
3166 extern void free_misc (Lisp_Object
);
3167 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3168 extern void malloc_warning (const char *);
3169 extern _Noreturn
void memory_full (size_t);
3170 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3171 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3172 extern void refill_memory_reserve (void);
3174 extern const char *pending_malloc_warning
;
3175 extern Lisp_Object zero_vector
;
3176 extern Lisp_Object
list1 (Lisp_Object
);
3177 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3178 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3179 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3180 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3182 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3183 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3185 /* Build a frequently used 2/3/4-integer lists. */
3188 list2i (EMACS_INT x
, EMACS_INT y
)
3190 return list2 (make_number (x
), make_number (y
));
3194 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3196 return list3 (make_number (x
), make_number (y
), make_number (w
));
3200 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3202 return list4 (make_number (x
), make_number (y
),
3203 make_number (w
), make_number (h
));
3206 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3207 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3208 extern _Noreturn
void string_overflow (void);
3209 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3210 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3211 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3212 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3214 /* Make unibyte string from C string when the length isn't known. */
3217 build_unibyte_string (const char *str
)
3219 return make_unibyte_string (str
, strlen (str
));
3222 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3223 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3224 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3225 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3226 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3227 extern Lisp_Object
make_specified_string (const char *,
3228 ptrdiff_t, ptrdiff_t, bool);
3229 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3230 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3232 /* Make a string allocated in pure space, use STR as string data. */
3235 build_pure_c_string (const char *str
)
3237 return make_pure_c_string (str
, strlen (str
));
3240 /* Make a string from the data at STR, treating it as multibyte if the
3244 build_string (const char *str
)
3246 return make_string (str
, strlen (str
));
3249 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3250 extern void make_byte_code (struct Lisp_Vector
*);
3251 extern Lisp_Object Qchar_table_extra_slots
;
3252 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3254 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3255 be sure that GC cannot happen until the vector is completely
3256 initialized. E.g. the following code is likely to crash:
3258 v = make_uninit_vector (3);
3260 ASET (v, 1, Ffunction_can_gc ());
3261 ASET (v, 2, obj1); */
3264 make_uninit_vector (ptrdiff_t size
)
3267 struct Lisp_Vector
*p
;
3269 p
= allocate_vector (size
);
3274 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3275 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3277 allocate_pseudovector \
3278 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3279 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3280 extern struct window
*allocate_window (void);
3281 extern struct frame
*allocate_frame (void);
3282 extern struct Lisp_Process
*allocate_process (void);
3283 extern struct terminal
*allocate_terminal (void);
3284 extern Lisp_Object
make_float (double);
3285 extern void display_malloc_warning (void);
3286 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3287 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3288 Lisp_Object
, Lisp_Object
);
3289 extern Lisp_Object
make_save_ptr (void *);
3290 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3291 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3292 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3294 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3295 extern void free_save_value (Lisp_Object
);
3296 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3297 extern void init_alloc_once (void);
3298 extern void init_alloc (void);
3299 extern void syms_of_alloc (void);
3300 extern struct buffer
* allocate_buffer (void);
3301 extern int valid_lisp_object_p (Lisp_Object
);
3302 extern int relocatable_string_data_p (const char *);
3305 /* Defined in ralloc.c. */
3306 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3307 extern void r_alloc_free (void **);
3308 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3309 extern void r_alloc_reset_variable (void **, void **);
3310 extern void r_alloc_inhibit_buffer_relocation (int);
3313 /* Defined in chartab.c. */
3314 extern Lisp_Object
copy_char_table (Lisp_Object
);
3315 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3317 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3318 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3320 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3321 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3322 Lisp_Object
, Lisp_Object
,
3323 Lisp_Object
, struct charset
*,
3324 unsigned, unsigned);
3325 extern Lisp_Object
uniprop_table (Lisp_Object
);
3326 extern void syms_of_chartab (void);
3328 /* Defined in print.c. */
3329 extern Lisp_Object Vprin1_to_string_buffer
;
3330 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3331 extern Lisp_Object Qstandard_output
;
3332 extern Lisp_Object Qexternal_debugging_output
;
3333 extern void temp_output_buffer_setup (const char *);
3334 extern int print_level
;
3335 extern Lisp_Object Qprint_escape_newlines
;
3336 extern void write_string (const char *, int);
3337 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3339 extern Lisp_Object internal_with_output_to_temp_buffer
3340 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3341 #define FLOAT_TO_STRING_BUFSIZE 350
3342 extern int float_to_string (char *, double);
3343 extern void init_print_once (void);
3344 extern void syms_of_print (void);
3346 /* Defined in doprnt.c. */
3347 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3349 extern ptrdiff_t esprintf (char *, char const *, ...)
3350 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3351 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3353 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3354 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3355 char const *, va_list)
3356 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3358 /* Defined in lread.c. */
3359 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3360 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3361 extern Lisp_Object Qlexical_binding
;
3362 extern Lisp_Object
check_obarray (Lisp_Object
);
3363 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3364 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3365 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3367 LOADHIST_ATTACH (Lisp_Object x
)
3370 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3372 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3373 Lisp_Object
*, Lisp_Object
, bool);
3374 extern Lisp_Object
string_to_number (char const *, int, bool);
3375 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3377 extern void dir_warning (const char *, Lisp_Object
);
3378 extern void init_obarray (void);
3379 extern void init_lread (void);
3380 extern void syms_of_lread (void);
3383 intern (const char *str
)
3385 return intern_1 (str
, strlen (str
));
3389 intern_c_string (const char *str
)
3391 return intern_c_string_1 (str
, strlen (str
));
3394 /* Defined in eval.c. */
3395 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3396 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3397 extern Lisp_Object Qand_rest
;
3398 extern Lisp_Object Vautoload_queue
;
3399 extern Lisp_Object Vsignaling_function
;
3400 extern Lisp_Object inhibit_lisp_code
;
3401 extern struct handler
*handlerlist
;
3403 /* To run a normal hook, use the appropriate function from the list below.
3404 The calling convention:
3406 if (!NILP (Vrun_hooks))
3407 call1 (Vrun_hooks, Qmy_funny_hook);
3409 should no longer be used. */
3410 extern Lisp_Object Vrun_hooks
;
3411 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3412 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3413 Lisp_Object (*funcall
)
3414 (ptrdiff_t nargs
, Lisp_Object
*args
));
3415 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3416 extern _Noreturn
void xsignal0 (Lisp_Object
);
3417 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3418 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3419 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3421 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3422 extern Lisp_Object
eval_sub (Lisp_Object form
);
3423 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3424 extern Lisp_Object
call0 (Lisp_Object
);
3425 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3426 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3427 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3428 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3429 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3430 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3431 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3432 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3433 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3434 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3435 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3436 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3437 extern Lisp_Object internal_condition_case_n
3438 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3439 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3440 extern void specbind (Lisp_Object
, Lisp_Object
);
3441 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3442 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3443 extern void record_unwind_protect_int (void (*) (int), int);
3444 extern void record_unwind_protect_void (void (*) (void));
3445 extern void record_unwind_protect_nothing (void);
3446 extern void clear_unwind_protect (ptrdiff_t);
3447 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3448 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3449 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3450 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3451 extern _Noreturn
void verror (const char *, va_list)
3452 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3453 extern void un_autoload (Lisp_Object
);
3454 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3455 extern void init_eval_once (void);
3456 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3457 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3458 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3459 extern void init_eval (void);
3460 extern void syms_of_eval (void);
3461 extern void unwind_body (Lisp_Object
);
3462 extern void record_in_backtrace (Lisp_Object function
,
3463 Lisp_Object
*args
, ptrdiff_t nargs
);
3464 extern void mark_specpdl (void);
3465 extern void get_backtrace (Lisp_Object array
);
3466 Lisp_Object
backtrace_top_function (void);
3467 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3468 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3471 /* Defined in editfns.c. */
3472 extern Lisp_Object Qfield
;
3473 extern void insert1 (Lisp_Object
);
3474 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3475 extern Lisp_Object
save_excursion_save (void);
3476 extern Lisp_Object
save_restriction_save (void);
3477 extern void save_excursion_restore (Lisp_Object
);
3478 extern void save_restriction_restore (Lisp_Object
);
3479 extern _Noreturn
void time_overflow (void);
3480 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3481 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3483 extern void init_editfns (void);
3484 extern void syms_of_editfns (void);
3485 extern void set_time_zone_rule (const char *);
3487 /* Defined in buffer.c. */
3488 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3489 extern _Noreturn
void nsberror (Lisp_Object
);
3490 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3491 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3492 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3493 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3494 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3495 extern bool overlay_touches_p (ptrdiff_t);
3496 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3497 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3498 extern void init_buffer_once (void);
3499 extern void init_buffer (int);
3500 extern void syms_of_buffer (void);
3501 extern void keys_of_buffer (void);
3503 /* Defined in marker.c. */
3505 extern ptrdiff_t marker_position (Lisp_Object
);
3506 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3507 extern void clear_charpos_cache (struct buffer
*);
3508 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3509 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3510 extern void unchain_marker (struct Lisp_Marker
*marker
);
3511 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3512 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3513 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3514 ptrdiff_t, ptrdiff_t);
3515 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3516 extern void syms_of_marker (void);
3518 /* Defined in fileio.c. */
3520 extern Lisp_Object Qfile_error
;
3521 extern Lisp_Object Qfile_notify_error
;
3522 extern Lisp_Object Qfile_exists_p
;
3523 extern Lisp_Object Qfile_directory_p
;
3524 extern Lisp_Object Qinsert_file_contents
;
3525 extern Lisp_Object Qfile_name_history
;
3526 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3527 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3528 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3530 extern void close_file_unwind (int);
3531 extern void fclose_unwind (void *);
3532 extern void restore_point_unwind (Lisp_Object
);
3533 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3534 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3535 extern bool internal_delete_file (Lisp_Object
);
3536 extern Lisp_Object
emacs_readlinkat (int, const char *);
3537 extern bool file_directory_p (const char *);
3538 extern bool file_accessible_directory_p (const char *);
3539 extern void init_fileio (void);
3540 extern void syms_of_fileio (void);
3541 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3542 extern Lisp_Object Qdelete_file
;
3544 /* Defined in search.c. */
3545 extern void shrink_regexp_cache (void);
3546 extern void restore_search_regs (void);
3547 extern void record_unwind_save_match_data (void);
3548 struct re_registers
;
3549 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3550 struct re_registers
*,
3551 Lisp_Object
, bool, bool);
3552 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3553 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3555 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3556 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3557 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3558 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3559 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3560 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3562 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3563 ptrdiff_t, ptrdiff_t *);
3564 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3565 ptrdiff_t, ptrdiff_t *);
3566 extern void syms_of_search (void);
3567 extern void clear_regexp_cache (void);
3569 /* Defined in minibuf.c. */
3571 extern Lisp_Object Qcompletion_ignore_case
;
3572 extern Lisp_Object Vminibuffer_list
;
3573 extern Lisp_Object last_minibuf_string
;
3574 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3575 extern void init_minibuf_once (void);
3576 extern void syms_of_minibuf (void);
3578 /* Defined in callint.c. */
3580 extern Lisp_Object Qminus
, Qplus
;
3581 extern Lisp_Object Qprogn
;
3582 extern Lisp_Object Qwhen
;
3583 extern Lisp_Object Qmouse_leave_buffer_hook
;
3584 extern void syms_of_callint (void);
3586 /* Defined in casefiddle.c. */
3588 extern Lisp_Object Qidentity
;
3589 extern void syms_of_casefiddle (void);
3590 extern void keys_of_casefiddle (void);
3592 /* Defined in casetab.c. */
3594 extern void init_casetab_once (void);
3595 extern void syms_of_casetab (void);
3597 /* Defined in keyboard.c. */
3599 extern Lisp_Object echo_message_buffer
;
3600 extern struct kboard
*echo_kboard
;
3601 extern void cancel_echoing (void);
3602 extern Lisp_Object Qdisabled
, QCfilter
;
3603 extern Lisp_Object Qup
, Qdown
;
3604 extern Lisp_Object last_undo_boundary
;
3605 extern bool input_pending
;
3606 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3607 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3608 extern void discard_mouse_events (void);
3610 void handle_input_available_signal (int);
3612 extern Lisp_Object pending_funcalls
;
3613 extern bool detect_input_pending (void);
3614 extern bool detect_input_pending_ignore_squeezables (void);
3615 extern bool detect_input_pending_run_timers (bool);
3616 extern void safe_run_hooks (Lisp_Object
);
3617 extern void cmd_error_internal (Lisp_Object
, const char *);
3618 extern Lisp_Object
command_loop_1 (void);
3619 extern Lisp_Object
read_menu_command (void);
3620 extern Lisp_Object
recursive_edit_1 (void);
3621 extern void record_auto_save (void);
3622 extern void force_auto_save_soon (void);
3623 extern void init_keyboard (void);
3624 extern void syms_of_keyboard (void);
3625 extern void keys_of_keyboard (void);
3627 /* Defined in indent.c. */
3628 extern ptrdiff_t current_column (void);
3629 extern void invalidate_current_column (void);
3630 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3631 extern void syms_of_indent (void);
3633 /* Defined in frame.c. */
3634 extern Lisp_Object Qonly
, Qnone
;
3635 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3636 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3637 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3638 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3639 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3640 extern void frames_discard_buffer (Lisp_Object
);
3641 extern void syms_of_frame (void);
3643 /* Defined in emacs.c. */
3644 extern char **initial_argv
;
3645 extern int initial_argc
;
3646 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3647 extern bool display_arg
;
3649 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3650 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3651 extern Lisp_Object Qfile_name_handler_alist
;
3652 extern _Noreturn
void terminate_due_to_signal (int, int);
3653 extern Lisp_Object Qkill_emacs
;
3655 extern Lisp_Object Vlibrary_cache
;
3658 void fixup_locale (void);
3659 void synchronize_system_messages_locale (void);
3660 void synchronize_system_time_locale (void);
3662 INLINE
void fixup_locale (void) {}
3663 INLINE
void synchronize_system_messages_locale (void) {}
3664 INLINE
void synchronize_system_time_locale (void) {}
3666 extern void shut_down_emacs (int, Lisp_Object
);
3668 /* True means don't do interactive redisplay and don't change tty modes. */
3669 extern bool noninteractive
;
3671 /* True means remove site-lisp directories from load-path. */
3672 extern bool no_site_lisp
;
3674 /* Pipe used to send exit notification to the daemon parent at
3676 extern int daemon_pipe
[2];
3677 #define IS_DAEMON (daemon_pipe[1] != 0)
3679 /* True if handling a fatal error already. */
3680 extern bool fatal_error_in_progress
;
3682 /* True means don't do use window-system-specific display code. */
3683 extern bool inhibit_window_system
;
3684 /* True means that a filter or a sentinel is running. */
3685 extern bool running_asynch_code
;
3687 /* Defined in process.c. */
3688 extern Lisp_Object QCtype
, Qlocal
;
3689 extern void kill_buffer_processes (Lisp_Object
);
3690 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3691 struct Lisp_Process
*, int);
3692 /* Max value for the first argument of wait_reading_process_output. */
3693 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3694 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3695 The bug merely causes a bogus warning, but the warning is annoying. */
3696 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3698 # define WAIT_READING_MAX INTMAX_MAX
3700 extern void add_keyboard_wait_descriptor (int);
3701 extern void delete_keyboard_wait_descriptor (int);
3703 extern void add_gpm_wait_descriptor (int);
3704 extern void delete_gpm_wait_descriptor (int);
3706 extern void init_process_emacs (void);
3707 extern void syms_of_process (void);
3708 extern void setup_process_coding_systems (Lisp_Object
);
3710 /* Defined in callproc.c. */
3714 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3715 extern void init_callproc_1 (void);
3716 extern void init_callproc (void);
3717 extern void set_initial_environment (void);
3718 extern void syms_of_callproc (void);
3720 /* Defined in doc.c. */
3721 extern Lisp_Object Qfunction_documentation
;
3722 extern Lisp_Object
read_doc_string (Lisp_Object
);
3723 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3724 extern void syms_of_doc (void);
3725 extern int read_bytecode_char (bool);
3727 /* Defined in bytecode.c. */
3728 extern void syms_of_bytecode (void);
3729 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3730 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3732 /* Defined in macros.c. */
3733 extern void init_macros (void);
3734 extern void syms_of_macros (void);
3736 /* Defined in undo.c. */
3737 extern Lisp_Object Qapply
;
3738 extern Lisp_Object Qinhibit_read_only
;
3739 extern void truncate_undo_list (struct buffer
*);
3740 extern void record_insert (ptrdiff_t, ptrdiff_t);
3741 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3742 extern void record_first_change (void);
3743 extern void record_change (ptrdiff_t, ptrdiff_t);
3744 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3745 Lisp_Object
, Lisp_Object
,
3747 extern void syms_of_undo (void);
3748 /* Defined in textprop.c. */
3749 extern Lisp_Object Qmouse_face
;
3750 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3751 extern Lisp_Object Qminibuffer_prompt
;
3753 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3755 /* Defined in menu.c. */
3756 extern void syms_of_menu (void);
3758 /* Defined in xmenu.c. */
3759 extern void syms_of_xmenu (void);
3761 /* Defined in termchar.h. */
3762 struct tty_display_info
;
3764 /* Defined in termhooks.h. */
3767 /* Defined in sysdep.c. */
3768 #ifndef HAVE_GET_CURRENT_DIR_NAME
3769 extern char *get_current_dir_name (void);
3771 extern void stuff_char (char c
);
3772 extern void init_foreground_group (void);
3773 extern void sys_subshell (void);
3774 extern void sys_suspend (void);
3775 extern void discard_tty_input (void);
3776 extern void init_sys_modes (struct tty_display_info
*);
3777 extern void reset_sys_modes (struct tty_display_info
*);
3778 extern void init_all_sys_modes (void);
3779 extern void reset_all_sys_modes (void);
3780 extern void child_setup_tty (int);
3781 extern void setup_pty (int);
3782 extern int set_window_size (int, int, int);
3783 extern EMACS_INT
get_random (void);
3784 extern void seed_random (void *, ptrdiff_t);
3785 extern void init_random (void);
3786 extern void emacs_backtrace (int);
3787 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3788 extern int emacs_open (const char *, int, int);
3789 extern int emacs_pipe (int[2]);
3790 extern int emacs_close (int);
3791 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3792 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3793 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3794 extern void emacs_perror (char const *);
3796 extern void unlock_all_files (void);
3797 extern void lock_file (Lisp_Object
);
3798 extern void unlock_file (Lisp_Object
);
3799 extern void unlock_buffer (struct buffer
*);
3800 extern void syms_of_filelock (void);
3802 /* Defined in sound.c. */
3803 extern void syms_of_sound (void);
3805 /* Defined in category.c. */
3806 extern void init_category_once (void);
3807 extern Lisp_Object
char_category_set (int);
3808 extern void syms_of_category (void);
3810 /* Defined in ccl.c. */
3811 extern void syms_of_ccl (void);
3813 /* Defined in dired.c. */
3814 extern void syms_of_dired (void);
3815 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3816 Lisp_Object
, Lisp_Object
,
3819 /* Defined in term.c. */
3820 extern int *char_ins_del_vector
;
3821 extern void syms_of_term (void);
3822 extern _Noreturn
void fatal (const char *msgid
, ...)
3823 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3825 /* Defined in terminal.c. */
3826 extern void syms_of_terminal (void);
3828 /* Defined in font.c. */
3829 extern void syms_of_font (void);
3830 extern void init_font (void);
3832 #ifdef HAVE_WINDOW_SYSTEM
3833 /* Defined in fontset.c. */
3834 extern void syms_of_fontset (void);
3836 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3837 extern Lisp_Object Qfont_param
;
3840 /* Defined in gfilenotify.c */
3841 #ifdef HAVE_GFILENOTIFY
3842 extern void globals_of_gfilenotify (void);
3843 extern void syms_of_gfilenotify (void);
3846 /* Defined in inotify.c */
3848 extern void syms_of_inotify (void);
3851 #ifdef HAVE_W32NOTIFY
3852 /* Defined on w32notify.c. */
3853 extern void syms_of_w32notify (void);
3856 /* Defined in xfaces.c. */
3857 extern Lisp_Object Qdefault
, Qfringe
;
3858 extern Lisp_Object Qscroll_bar
, Qcursor
;
3859 extern Lisp_Object Qmode_line_inactive
;
3860 extern Lisp_Object Qface
;
3861 extern Lisp_Object Qnormal
;
3862 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3863 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3864 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3865 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3866 extern Lisp_Object Qoblique
, Qitalic
;
3867 extern Lisp_Object Vface_alternative_font_family_alist
;
3868 extern Lisp_Object Vface_alternative_font_registry_alist
;
3869 extern void syms_of_xfaces (void);
3871 #ifdef HAVE_X_WINDOWS
3872 /* Defined in xfns.c. */
3873 extern void syms_of_xfns (void);
3875 /* Defined in xsmfns.c. */
3876 extern void syms_of_xsmfns (void);
3878 /* Defined in xselect.c. */
3879 extern void syms_of_xselect (void);
3881 /* Defined in xterm.c. */
3882 extern void syms_of_xterm (void);
3883 #endif /* HAVE_X_WINDOWS */
3885 #ifdef HAVE_WINDOW_SYSTEM
3886 /* Defined in xterm.c, nsterm.m, w32term.c. */
3887 extern char *x_get_keysym_name (int);
3888 #endif /* HAVE_WINDOW_SYSTEM */
3891 /* Defined in xml.c. */
3892 extern void syms_of_xml (void);
3893 extern void xml_cleanup_parser (void);
3897 /* Defined in decompress.c. */
3898 extern void syms_of_decompress (void);
3902 /* Defined in dbusbind.c. */
3903 void syms_of_dbusbind (void);
3907 /* Defined in profiler.c. */
3908 extern bool profiler_memory_running
;
3909 extern void malloc_probe (size_t);
3910 extern void syms_of_profiler (void);
3914 /* Defined in msdos.c, w32.c. */
3915 extern char *emacs_root_dir (void);
3918 /* True means ^G can quit instantly. */
3919 extern bool immediate_quit
;
3921 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3922 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3923 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3924 extern void xfree (void *);
3925 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3926 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3927 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3928 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3929 ATTRIBUTE_ALLOC_SIZE ((2,3));
3930 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3931 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3932 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3933 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3934 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3936 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3937 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3938 extern void dupstring (char **, char const *);
3939 extern void xputenv (const char *);
3941 extern char *egetenv (const char *);
3943 /* Copy Lisp string to temporary (allocated on stack) C string. */
3945 #define xlispstrdupa(string) \
3946 memcpy (alloca (SBYTES (string) + 1), \
3947 SSDATA (string), SBYTES (string) + 1)
3949 /* Set up the name of the machine we're running on. */
3950 extern void init_system_name (void);
3952 /* Return the absolute value of X. X should be a signed integer
3953 expression without side effects, and X's absolute value should not
3954 exceed the maximum for its promoted type. This is called 'eabs'
3955 because 'abs' is reserved by the C standard. */
3956 #define eabs(x) ((x) < 0 ? -(x) : (x))
3958 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3961 #define make_fixnum_or_float(val) \
3962 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3964 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3965 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3967 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3969 #define USE_SAFE_ALLOCA ((void) 0)
3971 /* SAFE_ALLOCA allocates a simple buffer. */
3973 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3977 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3978 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3979 positive. The code is tuned for MULTIPLIER being a constant. */
3981 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3983 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3984 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3986 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3989 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3991 #define SAFE_FREE() ((void) 0)
3993 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3995 #define SAFE_ALLOCA_LISP(buf, nelt) \
3997 if ((nelt) < MAX_ALLOCA / word_size) \
3998 (buf) = alloca ((nelt) * word_size); \
3999 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
4000 buf = xmalloc ((nelt) * word_size); \
4002 memory_full (SIZE_MAX); \
4005 /* Loop over all tails of a list, checking for cycles.
4006 FIXME: Make tortoise and n internal declarations.
4007 FIXME: Unroll the loop body so we don't need `n'. */
4008 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4009 for ((tortoise) = (hare) = (list), (n) = true; \
4011 (hare = XCDR (hare), (n) = !(n), \
4013 ? (EQ (hare, tortoise) \
4014 ? xsignal1 (Qcircular_list, list) \
4016 /* Move tortoise before the next iteration, in case */ \
4017 /* the next iteration does an Fsetcdr. */ \
4018 : (void) ((tortoise) = XCDR (tortoise)))))
4020 /* Do a `for' loop over alist values. */
4022 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4023 for ((list_var) = (head_var); \
4024 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4025 (list_var) = XCDR (list_var))
4027 /* Check whether it's time for GC, and run it if so. */
4036 functionp (Lisp_Object object
)
4038 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4040 object
= Findirect_function (object
, Qt
);
4042 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4044 /* Autoloaded symbols are functions, except if they load
4045 macros or keymaps. */
4047 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4048 object
= XCDR (object
);
4050 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4055 return XSUBR (object
)->max_args
!= UNEVALLED
;
4056 else if (COMPILEDP (object
))
4058 else if (CONSP (object
))
4060 Lisp_Object car
= XCAR (object
);
4061 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4069 #endif /* EMACS_LISP_H */