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
;
386 /* Integer. XINT (obj) is the integer value. */
389 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
392 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
393 whose first member indicates the subtype. */
396 /* String. XSTRING (object) points to a struct Lisp_String.
397 The length of the string, and its contents, are stored therein. */
400 /* Vector of Lisp objects, or something resembling it.
401 XVECTOR (object) points to a struct Lisp_Vector, which contains
402 the size and contents. The size field also contains the type
403 information, if it's not a real vector object. */
406 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
412 /* This is the set of data types that share a common structure.
413 The first member of the structure is a type code from this set.
414 The enum values are arbitrary, but we'll use large numbers to make it
415 more likely that we'll spot the error if a random word in memory is
416 mistakenly interpreted as a Lisp_Misc. */
419 Lisp_Misc_Free
= 0x5eab,
422 Lisp_Misc_Save_Value
,
423 /* Currently floats are not a misc type,
424 but let's define this in case we want to change that. */
426 /* This is not a type code. It is for range checking. */
430 /* These are the types of forwarding objects used in the value slot
431 of symbols for special built-in variables whose value is stored in
435 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
436 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
437 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
438 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
439 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
442 typedef SCM Lisp_Object
;
444 #define LISP_INITIALLY_ZERO SCM_INUM0
446 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
447 At the machine level, these operations are no-ops. */
448 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
449 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
451 /* In the size word of a struct Lisp_Vector, this bit means it's really
452 some other vector-like object. */
453 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
454 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
455 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
457 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
458 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
459 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
462 /* In a pseudovector, the size field actually contains a word with one
463 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
464 with PVEC_TYPE_MASK to indicate the actual type. */
476 PVEC_WINDOW_CONFIGURATION
,
479 /* These should be last, check internal_equal to see why. */
483 PVEC_FONT
/* Should be last because it's used for range checking. */
488 /* For convenience, we also store the number of elements in these bits.
489 Note that this size is not necessarily the memory-footprint size, but
490 only the number of Lisp_Object fields (that need to be traced by GC).
491 The distinction is used, e.g., by Lisp_Process, which places extra
492 non-Lisp_Object fields at the end of the structure. */
493 PSEUDOVECTOR_SIZE_BITS
= 12,
494 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
496 /* To calculate the memory footprint of the pseudovector, it's useful
497 to store the size of non-Lisp area in word_size units here. */
498 PSEUDOVECTOR_REST_BITS
= 12,
499 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
500 << PSEUDOVECTOR_SIZE_BITS
),
502 /* Used to extract pseudovector subtype information. */
503 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
504 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
507 /* These functions extract various sorts of values from a Lisp_Object.
508 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
509 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
512 /* Largest and smallest representable fixnum values. These are the C
513 values. They are macros for use in static initializers. */
514 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
515 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
517 /* Make a Lisp integer representing the value of the low order
520 make_number (EMACS_INT n
)
522 return SCM_I_MAKINUM (n
);
525 /* Extract A's value as a signed integer. */
529 return SCM_I_INUM (a
);
532 /* Like XINT (A), but may be faster. A must be nonnegative.
533 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
534 integers have zero-bits in their tags. */
536 XFASTINT (Lisp_Object a
)
538 EMACS_INT n
= XINT (a
);
543 /* Extract A's value as an unsigned integer. */
545 XUINT (Lisp_Object a
)
547 return SCM_I_INUM (a
);
550 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
551 right now, but XUINT should only be applied to objects we know are
553 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
555 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
557 make_natnum (EMACS_INT n
)
559 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
560 return make_number (n
);
563 /* Return true if X and Y are the same object. */
564 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
566 /* Value is true if I doesn't fit into a Lisp fixnum. It is
567 written this way so that it also works if I is of unsigned
568 type or if I is a NaN. */
570 #define FIXNUM_OVERFLOW_P(i) \
571 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
574 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
576 return num
< lower
? lower
: num
<= upper
? num
: upper
;
579 /* Forward declarations. */
581 /* Defined in this file. */
583 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
584 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
585 INLINE
bool BUFFERP (Lisp_Object
);
586 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
587 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
588 INLINE
bool (CONSP
) (Lisp_Object
);
589 INLINE
bool (FLOATP
) (Lisp_Object
);
590 INLINE
bool functionp (Lisp_Object
);
591 INLINE
bool (INTEGERP
) (Lisp_Object
);
592 INLINE
bool (MARKERP
) (Lisp_Object
);
593 INLINE
bool (MISCP
) (Lisp_Object
);
594 INLINE
bool (NILP
) (Lisp_Object
);
595 INLINE
bool OVERLAYP (Lisp_Object
);
596 INLINE
bool PROCESSP (Lisp_Object
);
597 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
598 INLINE
bool SAVE_VALUEP (Lisp_Object
);
599 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
601 INLINE
bool STRINGP (Lisp_Object
);
602 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
603 INLINE
bool SUBRP (Lisp_Object
);
604 INLINE
bool (SYMBOLP
) (Lisp_Object
);
605 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
606 INLINE
bool WINDOWP (Lisp_Object
);
607 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
609 /* Defined in chartab.c. */
610 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
611 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
612 extern int char_table_translate (Lisp_Object
, int);
614 /* Defined in data.c. */
615 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
616 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
617 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
618 extern Lisp_Object Qbool_vector_p
;
619 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
620 extern Lisp_Object Qwindow
;
621 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
623 /* Defined in emacs.c. */
624 extern bool might_dump
;
625 /* True means Emacs has already been initialized.
626 Used during startup to detect startup of dumped Emacs. */
627 extern bool initialized
;
629 /* Defined in eval.c. */
630 extern Lisp_Object Qautoload
;
632 /* Defined in floatfns.c. */
633 extern double extract_float (Lisp_Object
);
635 /* Defined in process.c. */
636 extern Lisp_Object Qprocessp
;
638 /* Defined in window.c. */
639 extern Lisp_Object Qwindowp
;
641 /* Defined in xdisp.c. */
642 extern Lisp_Object Qimage
;
644 /* Extract A's type. */
645 INLINE
enum Lisp_Type
646 XTYPE (Lisp_Object o
)
650 else if (SYMBOLP (o
))
654 else if (STRINGP (o
))
656 else if (VECTORLIKEP (o
))
657 return Lisp_Vectorlike
;
666 /* Extract a value or address from a Lisp_Object. */
668 INLINE
struct Lisp_Vector
*
669 XVECTOR (Lisp_Object a
)
671 eassert (VECTORLIKEP (a
));
675 INLINE
struct Lisp_String
*
676 XSTRING (Lisp_Object a
)
678 eassert (STRINGP (a
));
682 LISP_MACRO_DEFUN (XSYMBOL
, struct Lisp_Symbol
*, (Lisp_Object a
), (a
))
684 /* Pseudovector types. */
686 INLINE
struct Lisp_Process
*
687 XPROCESS (Lisp_Object a
)
689 eassert (PROCESSP (a
));
693 INLINE
struct window
*
694 XWINDOW (Lisp_Object a
)
696 eassert (WINDOWP (a
));
700 INLINE
struct terminal
*
701 XTERMINAL (Lisp_Object a
)
706 INLINE
struct Lisp_Subr
*
707 XSUBR (Lisp_Object a
)
713 INLINE
struct buffer
*
714 XBUFFER (Lisp_Object a
)
716 eassert (BUFFERP (a
));
720 INLINE
struct Lisp_Char_Table
*
721 XCHAR_TABLE (Lisp_Object a
)
723 eassert (CHAR_TABLE_P (a
));
727 INLINE
struct Lisp_Sub_Char_Table
*
728 XSUB_CHAR_TABLE (Lisp_Object a
)
730 eassert (SUB_CHAR_TABLE_P (a
));
734 INLINE
struct Lisp_Bool_Vector
*
735 XBOOL_VECTOR (Lisp_Object a
)
737 eassert (BOOL_VECTOR_P (a
));
742 make_lisp_proc (struct Lisp_Process
*p
)
744 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
747 #define XSETINT(a, b) ((a) = make_number (b))
748 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
749 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
750 #define XSETSTRING(a, b) ((a) = (b)->self)
751 #define XSETSYMBOL(a, b) ((a) = (b)->self)
752 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
754 /* Pseudovector types. */
756 #define XSETPVECTYPE(v, code) \
757 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
758 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
759 ((v)->header.size = (PSEUDOVECTOR_FLAG \
760 | ((code) << PSEUDOVECTOR_AREA_BITS) \
761 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
764 /* The cast to struct vectorlike_header * avoids aliasing issues. */
765 #define XSETPSEUDOVECTOR(a, b, code) \
766 XSETTYPED_PSEUDOVECTOR (a, b, \
767 (((struct vectorlike_header *) \
771 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
772 (XSETVECTOR (a, b), \
773 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
774 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
776 #define XSETWINDOW_CONFIGURATION(a, b) \
777 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
778 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
779 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
780 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
781 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
782 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
783 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
784 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
785 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
786 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
790 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
791 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
794 /* Deprecated and will be removed soon. */
796 #define INTERNAL_FIELD(field) field ## _
798 /* See the macros in intervals.h. */
800 typedef struct interval
*INTERVAL
;
802 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
803 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
805 /* Use these to set the fields of a cons cell.
807 Note that both arguments may refer to the same object, so 'n'
808 should not be read after 'c' is first modified. */
810 XSETCAR (Lisp_Object c
, Lisp_Object n
)
812 scm_set_car_x (c
, n
);
815 XSETCDR (Lisp_Object c
, Lisp_Object n
)
817 scm_set_cdr_x (c
, n
);
820 /* Take the car or cdr of something whose type is not known. */
824 return (CONSP (c
) ? XCAR (c
)
826 : wrong_type_argument (Qlistp
, c
));
831 return (CONSP (c
) ? XCDR (c
)
833 : wrong_type_argument (Qlistp
, c
));
836 /* Take the car or cdr of something whose type is not known. */
838 CAR_SAFE (Lisp_Object c
)
840 return CONSP (c
) ? XCAR (c
) : Qnil
;
843 CDR_SAFE (Lisp_Object c
)
845 return CONSP (c
) ? XCDR (c
) : Qnil
;
848 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
855 INTERVAL intervals
; /* Text properties in this string. */
859 /* True if STR is a multibyte string. */
861 STRING_MULTIBYTE (Lisp_Object str
)
863 return 0 <= XSTRING (str
)->size_byte
;
866 /* An upper bound on the number of bytes in a Lisp string, not
867 counting the terminating null. This a tight enough bound to
868 prevent integer overflow errors that would otherwise occur during
869 string size calculations. A string cannot contain more bytes than
870 a fixnum can represent, nor can it be so long that C pointer
871 arithmetic stops working on the string plus its terminating null.
872 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
873 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
874 would expose alloc.c internal details that we'd rather keep
877 This is a macro for use in static initializers. The cast to
878 ptrdiff_t ensures that the macro is signed. */
879 #define STRING_BYTES_BOUND \
880 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
882 /* Mark STR as a unibyte string. */
883 #define STRING_SET_UNIBYTE(STR) \
885 if (EQ (STR, empty_multibyte_string)) \
886 (STR) = empty_unibyte_string; \
888 XSTRING (STR)->size_byte = -1; \
891 /* Mark STR as a multibyte string. Assure that STR contains only
892 ASCII characters in advance. */
893 #define STRING_SET_MULTIBYTE(STR) \
895 if (EQ (STR, empty_unibyte_string)) \
896 (STR) = empty_multibyte_string; \
898 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
901 /* Convenience functions for dealing with Lisp strings. */
903 INLINE
unsigned char *
904 SDATA (Lisp_Object string
)
906 return XSTRING (string
)->data
;
909 SSDATA (Lisp_Object string
)
911 /* Avoid "differ in sign" warnings. */
912 return (char *) SDATA (string
);
915 SREF (Lisp_Object string
, ptrdiff_t index
)
917 return SDATA (string
)[index
];
920 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
922 SDATA (string
)[index
] = new;
925 SCHARS (Lisp_Object string
)
927 return XSTRING (string
)->size
;
931 STRING_BYTES (struct Lisp_String
*s
)
933 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
937 SBYTES (Lisp_Object string
)
939 return STRING_BYTES (XSTRING (string
));
942 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
944 XSTRING (string
)->size
= newsize
;
947 /* Header of vector-like objects. This documents the layout constraints on
948 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
949 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
950 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
951 because when two such pointers potentially alias, a compiler won't
952 incorrectly reorder loads and stores to their size fields. See
954 struct vectorlike_header
958 /* This field contains various pieces of information:
959 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
960 vector (0) or a pseudovector (1).
961 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
962 of slots) of the vector.
963 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
964 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
965 - b) number of Lisp_Objects slots at the beginning of the object
966 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
968 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
969 measured in word_size units. Rest fields may also include
970 Lisp_Objects, but these objects usually needs some special treatment
972 There are some exceptions. For PVEC_FREE, b) is always zero. For
973 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
974 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
975 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
979 /* A regular vector is just a header plus an array of Lisp_Objects. */
983 struct vectorlike_header header
;
984 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
987 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
990 ALIGNOF_STRUCT_LISP_VECTOR
991 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
994 /* A boolvector is a kind of vectorlike, with contents like a string. */
996 struct Lisp_Bool_Vector
998 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
999 just the subtype information. */
1000 struct vectorlike_header header
;
1001 /* This is the size in bits. */
1003 /* The actual bits, packed into bytes.
1004 Zeros fill out the last word if needed.
1005 The bits are in little-endian order in the bytes, and
1006 the bytes are in little-endian order in the words. */
1007 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1011 bool_vector_size (Lisp_Object a
)
1013 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1014 eassume (0 <= size
);
1019 bool_vector_data (Lisp_Object a
)
1021 return XBOOL_VECTOR (a
)->data
;
1024 INLINE
unsigned char *
1025 bool_vector_uchar_data (Lisp_Object a
)
1027 return (unsigned char *) bool_vector_data (a
);
1030 /* The number of data words and bytes in a bool vector with SIZE bits. */
1033 bool_vector_words (EMACS_INT size
)
1035 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1036 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1040 bool_vector_bytes (EMACS_INT size
)
1042 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1043 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1046 /* True if A's Ith bit is set. */
1049 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1051 eassume (0 <= i
&& i
< bool_vector_size (a
));
1052 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1053 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1057 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1059 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1062 /* Set A's Ith bit to B. */
1065 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1067 unsigned char *addr
;
1069 eassume (0 <= i
&& i
< bool_vector_size (a
));
1070 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1073 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1075 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1078 /* Some handy constants for calculating sizes
1079 and offsets, mostly of vectorlike objects. */
1083 header_size
= offsetof (struct Lisp_Vector
, contents
),
1084 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1085 word_size
= sizeof (Lisp_Object
)
1088 /* Conveniences for dealing with Lisp arrays. */
1091 AREF (Lisp_Object array
, ptrdiff_t idx
)
1093 return XVECTOR (array
)->contents
[idx
];
1096 INLINE Lisp_Object
*
1097 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1099 return & XVECTOR (array
)->contents
[idx
];
1103 ASIZE (Lisp_Object array
)
1105 return XVECTOR (array
)->header
.size
;
1109 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1111 eassert (0 <= idx
&& idx
< ASIZE (array
));
1112 XVECTOR (array
)->contents
[idx
] = val
;
1116 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1118 /* Like ASET, but also can be used in the garbage collector:
1119 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1120 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1121 XVECTOR (array
)->contents
[idx
] = val
;
1124 /* If a struct is made to look like a vector, this macro returns the length
1125 of the shortest vector that would hold that struct. */
1127 #define VECSIZE(type) \
1128 ((sizeof (type) - header_size + word_size - 1) / word_size)
1130 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1131 at the end and we need to compute the number of Lisp_Object fields (the
1132 ones that the GC needs to trace). */
1134 #define PSEUDOVECSIZE(type, nonlispfield) \
1135 ((offsetof (type, nonlispfield) - header_size) / word_size)
1137 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1138 should be integer expressions. This is not the same as
1139 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1140 returns true. For efficiency, prefer plain unsigned comparison if A
1141 and B's sizes both fit (after integer promotion). */
1142 #define UNSIGNED_CMP(a, op, b) \
1143 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1144 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1145 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1147 /* True iff C is an ASCII character. */
1148 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1150 /* A char-table is a kind of vectorlike, with contents are like a
1151 vector but with a few other slots. For some purposes, it makes
1152 sense to handle a char-table with type struct Lisp_Vector. An
1153 element of a char table can be any Lisp objects, but if it is a sub
1154 char-table, we treat it a table that contains information of a
1155 specific range of characters. A sub char-table has the same
1156 structure as a vector. A sub char table appears only in an element
1157 of a char-table, and there's no way to access it directly from
1158 Emacs Lisp program. */
1160 enum CHARTAB_SIZE_BITS
1162 CHARTAB_SIZE_BITS_0
= 6,
1163 CHARTAB_SIZE_BITS_1
= 4,
1164 CHARTAB_SIZE_BITS_2
= 5,
1165 CHARTAB_SIZE_BITS_3
= 7
1168 extern const int chartab_size
[4];
1170 struct Lisp_Char_Table
1172 /* HEADER.SIZE is the vector's size field, which also holds the
1173 pseudovector type information. It holds the size, too.
1174 The size counts the defalt, parent, purpose, ascii,
1175 contents, and extras slots. */
1176 struct vectorlike_header header
;
1178 /* This holds a default value,
1179 which is used whenever the value for a specific character is nil. */
1182 /* This points to another char table, which we inherit from when the
1183 value for a specific character is nil. The `defalt' slot takes
1184 precedence over this. */
1187 /* This is a symbol which says what kind of use this char-table is
1189 Lisp_Object purpose
;
1191 /* The bottom sub char-table for characters of the range 0..127. It
1192 is nil if none of ASCII character has a specific value. */
1195 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1197 /* These hold additional data. It is a vector. */
1198 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1201 struct Lisp_Sub_Char_Table
1203 /* HEADER.SIZE is the vector's size field, which also holds the
1204 pseudovector type information. It holds the size, too. */
1205 struct vectorlike_header header
;
1207 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1208 char-table of depth 1 contains 16 elements, and each element
1209 covers 4096 (128*32) characters. A sub char-table of depth 2
1210 contains 32 elements, and each element covers 128 characters. A
1211 sub char-table of depth 3 contains 128 elements, and each element
1212 is for one character. */
1215 /* Minimum character covered by the sub char-table. */
1216 Lisp_Object min_char
;
1218 /* Use set_sub_char_table_contents to set this. */
1219 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1223 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1225 struct Lisp_Char_Table
*tbl
= NULL
;
1229 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1230 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1231 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1235 while (NILP (val
) && ! NILP (tbl
->parent
));
1240 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1241 characters. Do not check validity of CT. */
1243 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1245 return (ASCII_CHAR_P (idx
)
1246 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1247 : char_table_ref (ct
, idx
));
1250 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1251 8-bit European characters. Do not check validity of CT. */
1253 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1255 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1256 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1258 char_table_set (ct
, idx
, val
);
1261 /* This structure describes a built-in function.
1262 It is generated by the DEFUN macro only.
1263 defsubr makes it into a Lisp object. */
1267 struct vectorlike_header header
;
1269 Lisp_Object (*a0
) (void);
1270 Lisp_Object (*a1
) (Lisp_Object
);
1271 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1272 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1273 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1274 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1275 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1276 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1277 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1278 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1279 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1281 short min_args
, max_args
;
1282 const char *symbol_name
;
1283 const char *intspec
;
1287 /* This is the number of slots that every char table must have. This
1288 counts the ordinary slots and the top, defalt, parent, and purpose
1290 enum CHAR_TABLE_STANDARD_SLOTS
1292 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1295 /* Return the number of "extra" slots in the char table CT. */
1298 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1300 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1301 - CHAR_TABLE_STANDARD_SLOTS
);
1305 /***********************************************************************
1307 ***********************************************************************/
1309 /* Interned state of a symbol. */
1311 enum symbol_interned
1313 SYMBOL_UNINTERNED
= 0,
1314 SYMBOL_INTERNED
= 1,
1315 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1318 enum symbol_redirect
1320 SYMBOL_PLAINVAL
= 4,
1321 SYMBOL_VARALIAS
= 1,
1322 SYMBOL_LOCALIZED
= 2,
1323 SYMBOL_FORWARDED
= 3
1330 /* Indicates where the value can be found:
1331 0 : it's a plain var, the value is in the `value' field.
1332 1 : it's a varalias, the value is really in the `alias' symbol.
1333 2 : it's a localized var, the value is in the `blv' object.
1334 3 : it's a forwarding variable, the value is in `forward'. */
1335 ENUM_BF (symbol_redirect
) redirect
: 3;
1337 /* Non-zero means symbol is constant, i.e. changing its value
1338 should signal an error. If the value is 3, then the var
1339 can be changed, but only by `defconst'. */
1340 unsigned constant
: 2;
1342 /* Interned state of the symbol. This is an enumerator from
1343 enum symbol_interned. */
1344 unsigned interned
: 2;
1346 /* True means that this variable has been explicitly declared
1347 special (with `defvar' etc), and shouldn't be lexically bound. */
1348 bool_bf declared_special
: 1;
1350 /* True if pointed to from purespace and hence can't be GC'd. */
1353 /* The symbol's name, as a Lisp string. */
1356 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1357 union is used depends on the `redirect' field above. */
1360 struct Lisp_Symbol
*alias
;
1361 struct Lisp_Buffer_Local_Value
*blv
;
1362 union Lisp_Fwd
*fwd
;
1365 /* Function value of the symbol or Qnil if not fboundp. */
1366 Lisp_Object function
;
1368 /* The symbol's property list. */
1371 /* Next symbol in obarray bucket, if the symbol is interned. */
1372 struct Lisp_Symbol
*next
;
1375 /* Value is name of symbol. */
1377 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1379 INLINE
struct Lisp_Symbol
*
1380 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1382 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1383 return sym
->val
.alias
;
1385 INLINE
struct Lisp_Buffer_Local_Value
*
1386 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1388 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1389 return sym
->val
.blv
;
1391 INLINE
union Lisp_Fwd
*
1392 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1394 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1395 return sym
->val
.fwd
;
1398 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1399 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1402 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1404 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1408 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1410 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1414 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1416 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1421 SYMBOL_NAME (Lisp_Object sym
)
1423 return XSYMBOL (sym
)->name
;
1426 /* Value is true if SYM is an interned symbol. */
1429 SYMBOL_INTERNED_P (Lisp_Object sym
)
1431 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1434 /* Value is true if SYM is interned in initial_obarray. */
1437 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1439 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1442 /* Value is non-zero if symbol is considered a constant, i.e. its
1443 value cannot be changed (there is an exception for keyword symbols,
1444 whose value can be set to the keyword symbol itself). */
1446 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1448 #define DEFSYM(sym, name) \
1449 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1452 /***********************************************************************
1454 ***********************************************************************/
1456 /* The structure of a Lisp hash table. */
1458 struct hash_table_test
1460 /* Name of the function used to compare keys. */
1463 /* User-supplied hash function, or nil. */
1464 Lisp_Object user_hash_function
;
1466 /* User-supplied key comparison function, or nil. */
1467 Lisp_Object user_cmp_function
;
1469 /* C function to compare two keys. */
1470 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1472 /* C function to compute hash code. */
1473 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1476 struct Lisp_Hash_Table
1478 /* This is for Lisp; the hash table code does not refer to it. */
1479 struct vectorlike_header header
;
1481 /* Nil if table is non-weak. Otherwise a symbol describing the
1482 weakness of the table. */
1485 /* When the table is resized, and this is an integer, compute the
1486 new size by adding this to the old size. If a float, compute the
1487 new size by multiplying the old size with this factor. */
1488 Lisp_Object rehash_size
;
1490 /* Resize hash table when number of entries/ table size is >= this
1492 Lisp_Object rehash_threshold
;
1494 /* Vector of hash codes. If hash[I] is nil, this means that the
1495 I-th entry is unused. */
1498 /* Vector used to chain entries. If entry I is free, next[I] is the
1499 entry number of the next free item. If entry I is non-free,
1500 next[I] is the index of the next entry in the collision chain. */
1503 /* Index of first free entry in free list. */
1504 Lisp_Object next_free
;
1506 /* Bucket vector. A non-nil entry is the index of the first item in
1507 a collision chain. This vector's size can be larger than the
1508 hash table size to reduce collisions. */
1511 /* Only the fields above are traced normally by the GC. The ones below
1512 `count' are special and are either ignored by the GC or traced in
1513 a special way (e.g. because of weakness). */
1515 /* Number of key/value entries in the table. */
1518 /* Vector of keys and values. The key of item I is found at index
1519 2 * I, the value is found at index 2 * I + 1.
1520 This is gc_marked specially if the table is weak. */
1521 Lisp_Object key_and_value
;
1523 /* The comparison and hash functions. */
1524 struct hash_table_test test
;
1526 /* Next weak hash table if this is a weak hash table. The head
1527 of the list is in weak_hash_tables. */
1528 struct Lisp_Hash_Table
*next_weak
;
1532 INLINE
struct Lisp_Hash_Table
*
1533 XHASH_TABLE (Lisp_Object a
)
1535 return SMOB_PTR (a
);
1538 #define XSET_HASH_TABLE(VAR, PTR) \
1539 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1542 HASH_TABLE_P (Lisp_Object a
)
1544 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1547 /* Value is the key part of entry IDX in hash table H. */
1549 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1551 return AREF (h
->key_and_value
, 2 * idx
);
1554 /* Value is the value part of entry IDX in hash table H. */
1556 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1558 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1561 /* Value is the index of the next entry following the one at IDX
1564 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1566 return AREF (h
->next
, idx
);
1569 /* Value is the hash code computed for entry IDX in hash table H. */
1571 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1573 return AREF (h
->hash
, idx
);
1576 /* Value is the index of the element in hash table H that is the
1577 start of the collision list at index IDX in the index vector of H. */
1579 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1581 return AREF (h
->index
, idx
);
1584 /* Value is the size of hash table H. */
1586 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1588 return ASIZE (h
->next
);
1591 /* Default size for hash tables if not specified. */
1593 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1595 /* Default threshold specifying when to resize a hash table. The
1596 value gives the ratio of current entries in the hash table and the
1597 size of the hash table. */
1599 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1601 /* Default factor by which to increase the size of a hash table. */
1603 static double const DEFAULT_REHASH_SIZE
= 1.5;
1605 /* Combine two integers X and Y for hashing. The result might not fit
1606 into a Lisp integer. */
1609 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1611 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1614 /* Hash X, returning a value that fits into a fixnum. */
1617 SXHASH_REDUCE (EMACS_UINT x
)
1619 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1622 /* These structures are used for various misc types. */
1624 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1627 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1633 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1634 /* This flag is temporarily used in the functions
1635 decode/encode_coding_object to record that the marker position
1636 must be adjusted after the conversion. */
1637 bool_bf need_adjustment
: 1;
1638 /* True means normal insertion at the marker's position
1639 leaves the marker after the inserted text. */
1640 bool_bf insertion_type
: 1;
1641 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1642 Note: a chain of markers can contain markers pointing into different
1643 buffers (the chain is per buffer_text rather than per buffer, so it's
1644 shared between indirect buffers). */
1645 /* This is used for (other than NULL-checking):
1647 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1648 - unchain_marker: to find the list from which to unchain.
1649 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1651 struct buffer
*buffer
;
1653 /* The remaining fields are meaningless in a marker that
1654 does not point anywhere. */
1656 /* For markers that point somewhere,
1657 this is used to chain of all the markers in a given buffer. */
1658 /* We could remove it and use an array in buffer_text instead.
1659 That would also allow to preserve it ordered. */
1660 struct Lisp_Marker
*next
;
1661 /* This is the char position where the marker points. */
1663 /* This is the byte position.
1664 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1665 used to implement the functionality of markers, but rather to (ab)use
1666 markers as a cache for char<->byte mappings). */
1670 /* START and END are markers in the overlay's buffer, and
1671 PLIST is the overlay's property list. */
1673 /* An overlay's real data content is:
1675 - buffer (really there are two buffer pointers, one per marker,
1676 and both points to the same buffer)
1677 - insertion type of both ends (per-marker fields)
1678 - start & start byte (of start marker)
1679 - end & end byte (of end marker)
1680 - next (singly linked list of overlays)
1681 - next fields of start and end markers (singly linked list of markers).
1682 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1686 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1687 struct Lisp_Overlay
*next
;
1693 /* Types of data which may be saved in a Lisp_Save_Value. */
1704 /* Number of bits needed to store one of the above values. */
1705 enum { SAVE_SLOT_BITS
= 3 };
1707 /* Number of slots in a save value where save_type is nonzero. */
1708 enum { SAVE_VALUE_SLOTS
= 4 };
1710 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1712 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1716 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1717 SAVE_TYPE_INT_INT_INT
1718 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1719 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1720 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1721 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1722 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1723 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1724 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1725 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1726 SAVE_TYPE_FUNCPTR_PTR_OBJ
1727 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1729 /* This has an extra bit indicating it's raw memory. */
1730 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1733 /* Special object used to hold a different values for later use.
1735 This is mostly used to package C integers and pointers to call
1736 record_unwind_protect when two or more values need to be saved.
1740 struct my_data *md = get_my_data ();
1741 ptrdiff_t mi = get_my_integer ();
1742 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1745 Lisp_Object my_unwind (Lisp_Object arg)
1747 struct my_data *md = XSAVE_POINTER (arg, 0);
1748 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1752 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1753 saved objects and raise eassert if type of the saved object doesn't match
1754 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1755 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1756 slot 0 is a pointer. */
1758 typedef void (*voidfuncptr
) (void);
1760 struct Lisp_Save_Value
1763 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1764 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1766 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1767 V's data entries are determined by V->save_type. E.g., if
1768 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1769 V->data[1] is an integer, and V's other data entries are unused.
1771 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1772 a memory area containing V->data[1].integer potential Lisp_Objects. */
1773 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1776 voidfuncptr funcpointer
;
1779 } data
[SAVE_VALUE_SLOTS
];
1782 /* Return the type of V's Nth saved value. */
1784 save_type (struct Lisp_Save_Value
*v
, int n
)
1786 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1787 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1790 /* Get and set the Nth saved pointer. */
1793 XSAVE_POINTER (Lisp_Object obj
, int n
)
1795 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1796 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1799 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1801 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1802 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1805 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1807 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1808 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1811 /* Likewise for the saved integer. */
1814 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1816 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1817 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1820 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1822 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1823 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1826 /* Extract Nth saved object. */
1829 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1831 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1832 return XSAVE_VALUE (obj
)->data
[n
].object
;
1835 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1836 It uses one of these struct subtypes to get the type field. */
1840 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1841 struct Lisp_Marker u_marker
;
1842 struct Lisp_Overlay u_overlay
;
1843 struct Lisp_Save_Value u_save_value
;
1846 INLINE
union Lisp_Misc
*
1847 XMISC (Lisp_Object a
)
1849 return SMOB_PTR (a
);
1852 INLINE
struct Lisp_Misc_Any
*
1853 XMISCANY (Lisp_Object a
)
1855 eassert (MISCP (a
));
1856 return & XMISC (a
)->u_any
;
1859 INLINE
enum Lisp_Misc_Type
1860 XMISCTYPE (Lisp_Object a
)
1862 return XMISCANY (a
)->type
;
1865 INLINE
struct Lisp_Marker
*
1866 XMARKER (Lisp_Object a
)
1868 eassert (MARKERP (a
));
1869 return & XMISC (a
)->u_marker
;
1872 INLINE
struct Lisp_Overlay
*
1873 XOVERLAY (Lisp_Object a
)
1875 eassert (OVERLAYP (a
));
1876 return & XMISC (a
)->u_overlay
;
1879 INLINE
struct Lisp_Save_Value
*
1880 XSAVE_VALUE (Lisp_Object a
)
1882 eassert (SAVE_VALUEP (a
));
1883 return & XMISC (a
)->u_save_value
;
1886 /* Forwarding pointer to an int variable.
1887 This is allowed only in the value cell of a symbol,
1888 and it means that the symbol's value really lives in the
1889 specified int variable. */
1892 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1896 /* Boolean forwarding pointer to an int variable.
1897 This is like Lisp_Intfwd except that the ostensible
1898 "value" of the symbol is t if the bool variable is true,
1899 nil if it is false. */
1902 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1906 /* Forwarding pointer to a Lisp_Object variable.
1907 This is allowed only in the value cell of a symbol,
1908 and it means that the symbol's value really lives in the
1909 specified variable. */
1912 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1913 Lisp_Object
*objvar
;
1916 /* Like Lisp_Objfwd except that value lives in a slot in the
1917 current buffer. Value is byte index of slot within buffer. */
1918 struct Lisp_Buffer_Objfwd
1920 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1922 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1923 Lisp_Object predicate
;
1926 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1927 the symbol has buffer-local or frame-local bindings. (Exception:
1928 some buffer-local variables are built-in, with their values stored
1929 in the buffer structure itself. They are handled differently,
1930 using struct Lisp_Buffer_Objfwd.)
1932 The `realvalue' slot holds the variable's current value, or a
1933 forwarding pointer to where that value is kept. This value is the
1934 one that corresponds to the loaded binding. To read or set the
1935 variable, you must first make sure the right binding is loaded;
1936 then you can access the value in (or through) `realvalue'.
1938 `buffer' and `frame' are the buffer and frame for which the loaded
1939 binding was found. If those have changed, to make sure the right
1940 binding is loaded it is necessary to find which binding goes with
1941 the current buffer and selected frame, then load it. To load it,
1942 first unload the previous binding, then copy the value of the new
1943 binding into `realvalue' (or through it). Also update
1944 LOADED-BINDING to point to the newly loaded binding.
1946 `local_if_set' indicates that merely setting the variable creates a
1947 local binding for the current buffer. Otherwise the latter, setting
1948 the variable does not do that; only make-local-variable does that. */
1950 struct Lisp_Buffer_Local_Value
1952 /* True means that merely setting the variable creates a local
1953 binding for the current buffer. */
1954 bool_bf local_if_set
: 1;
1955 /* True means this variable can have frame-local bindings, otherwise, it is
1956 can have buffer-local bindings. The two cannot be combined. */
1957 bool_bf frame_local
: 1;
1958 /* True means that the binding now loaded was found.
1959 Presumably equivalent to (defcell!=valcell). */
1961 /* If non-NULL, a forwarding to the C var where it should also be set. */
1962 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1963 /* The buffer or frame for which the loaded binding was found. */
1965 /* A cons cell that holds the default value. It has the form
1966 (SYMBOL . DEFAULT-VALUE). */
1967 Lisp_Object defcell
;
1968 /* The cons cell from `where's parameter alist.
1969 It always has the form (SYMBOL . VALUE)
1970 Note that if `forward' is non-nil, VALUE may be out of date.
1971 Also if the currently loaded binding is the default binding, then
1972 this is `eq'ual to defcell. */
1973 Lisp_Object valcell
;
1976 /* Like Lisp_Objfwd except that value lives in a slot in the
1978 struct Lisp_Kboard_Objfwd
1980 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1986 struct Lisp_Intfwd u_intfwd
;
1987 struct Lisp_Boolfwd u_boolfwd
;
1988 struct Lisp_Objfwd u_objfwd
;
1989 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1990 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1993 INLINE
enum Lisp_Fwd_Type
1994 XFWDTYPE (union Lisp_Fwd
*a
)
1996 return a
->u_intfwd
.type
;
1999 INLINE
struct Lisp_Buffer_Objfwd
*
2000 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2002 eassert (BUFFER_OBJFWDP (a
));
2003 return &a
->u_buffer_objfwd
;
2006 #define XFLOAT_DATA(f) (scm_to_double (f))
2008 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2009 representations, have infinities and NaNs, and do not trap on
2010 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2011 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2012 wanted here, but is not quite right because Emacs does not require
2013 all the features of C11 Annex F (and does not require C11 at all,
2014 for that matter). */
2018 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2019 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2022 /* A character, declared with the following typedef, is a member
2023 of some character set associated with the current buffer. */
2024 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2026 typedef unsigned char UCHAR
;
2029 /* Meanings of slots in a Lisp_Compiled: */
2033 COMPILED_ARGLIST
= 0,
2034 COMPILED_BYTECODE
= 1,
2035 COMPILED_CONSTANTS
= 2,
2036 COMPILED_STACK_DEPTH
= 3,
2037 COMPILED_DOC_STRING
= 4,
2038 COMPILED_INTERACTIVE
= 5
2041 /* Flag bits in a character. These also get used in termhooks.h.
2042 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2043 (MUlti-Lingual Emacs) might need 22 bits for the character value
2044 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2047 CHAR_ALT
= 0x0400000,
2048 CHAR_SUPER
= 0x0800000,
2049 CHAR_HYPER
= 0x1000000,
2050 CHAR_SHIFT
= 0x2000000,
2051 CHAR_CTL
= 0x4000000,
2052 CHAR_META
= 0x8000000,
2054 CHAR_MODIFIER_MASK
=
2055 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2057 /* Actually, the current Emacs uses 22 bits for the character value
2062 /* Data type checking. */
2064 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2067 NUMBERP (Lisp_Object x
)
2069 return INTEGERP (x
) || FLOATP (x
);
2072 NATNUMP (Lisp_Object x
)
2074 return INTEGERP (x
) && 0 <= XINT (x
);
2078 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2080 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2083 #define TYPE_RANGED_INTEGERP(type, x) \
2085 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2086 && XINT (x) <= TYPE_MAXIMUM (type))
2088 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2089 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2090 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2091 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2092 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2093 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2094 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2097 STRINGP (Lisp_Object x
)
2099 return SMOB_TYPEP (x
, lisp_string_tag
);
2102 VECTORP (Lisp_Object x
)
2104 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2107 OVERLAYP (Lisp_Object x
)
2109 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2112 SAVE_VALUEP (Lisp_Object x
)
2114 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2118 AUTOLOADP (Lisp_Object x
)
2120 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2124 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2126 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2130 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2132 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2133 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2136 /* True if A is a pseudovector whose code is CODE. */
2138 PSEUDOVECTORP (Lisp_Object a
, int code
)
2140 if (! VECTORLIKEP (a
))
2144 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2145 struct vectorlike_header
*h
= SMOB_PTR (a
);
2146 return PSEUDOVECTOR_TYPEP (h
, code
);
2150 /* Test for specific pseudovector types. */
2153 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2155 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2159 PROCESSP (Lisp_Object a
)
2161 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2165 WINDOWP (Lisp_Object a
)
2167 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2171 TERMINALP (Lisp_Object a
)
2173 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2177 SUBRP (Lisp_Object a
)
2179 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2183 COMPILEDP (Lisp_Object a
)
2185 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2189 BUFFERP (Lisp_Object a
)
2191 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2195 CHAR_TABLE_P (Lisp_Object a
)
2197 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2201 SUB_CHAR_TABLE_P (Lisp_Object a
)
2203 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2207 BOOL_VECTOR_P (Lisp_Object a
)
2209 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2213 FRAMEP (Lisp_Object a
)
2215 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2218 /* Test for image (image . spec) */
2220 IMAGEP (Lisp_Object x
)
2222 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2227 ARRAYP (Lisp_Object x
)
2229 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2233 CHECK_LIST (Lisp_Object x
)
2235 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2238 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2239 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2240 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2243 CHECK_STRING (Lisp_Object x
)
2245 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2248 CHECK_STRING_CAR (Lisp_Object x
)
2250 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2253 CHECK_CONS (Lisp_Object x
)
2255 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2258 CHECK_VECTOR (Lisp_Object x
)
2260 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2263 CHECK_BOOL_VECTOR (Lisp_Object x
)
2265 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2268 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2270 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2273 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2275 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2278 CHECK_BUFFER (Lisp_Object x
)
2280 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2283 CHECK_WINDOW (Lisp_Object x
)
2285 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2289 CHECK_PROCESS (Lisp_Object x
)
2291 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2295 CHECK_NATNUM (Lisp_Object x
)
2297 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2300 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2303 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2304 args_out_of_range_3 \
2306 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2307 ? MOST_NEGATIVE_FIXNUM \
2309 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2311 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2313 if (TYPE_SIGNED (type)) \
2314 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2316 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2319 #define CHECK_NUMBER_COERCE_MARKER(x) \
2321 if (MARKERP ((x))) \
2322 XSETFASTINT (x, marker_position (x)); \
2324 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2328 XFLOATINT (Lisp_Object n
)
2330 return extract_float (n
);
2334 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2336 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2339 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2342 XSETFASTINT (x, marker_position (x)); \
2344 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2347 /* Since we can't assign directly to the CAR or CDR fields of a cons
2348 cell, use these when checking that those fields contain numbers. */
2350 CHECK_NUMBER_CAR (Lisp_Object x
)
2352 Lisp_Object tmp
= XCAR (x
);
2358 CHECK_NUMBER_CDR (Lisp_Object x
)
2360 Lisp_Object tmp
= XCDR (x
);
2365 /* Define a built-in function for calling from Lisp.
2366 `lname' should be the name to give the function in Lisp,
2367 as a null-terminated C string.
2368 `fnname' should be the name of the function in C.
2369 By convention, it starts with F.
2370 `sname' should be the name for the C constant structure
2371 that records information on this function for internal use.
2372 By convention, it should be the same as `fnname' but with S instead of F.
2373 It's too bad that C macros can't compute this from `fnname'.
2374 `minargs' should be a number, the minimum number of arguments allowed.
2375 `maxargs' should be a number, the maximum number of arguments allowed,
2376 or else MANY or UNEVALLED.
2377 MANY means pass a vector of evaluated arguments,
2378 in the form of an integer number-of-arguments
2379 followed by the address of a vector of Lisp_Objects
2380 which contains the argument values.
2381 UNEVALLED means pass the list of unevaluated arguments
2382 `intspec' says how interactive arguments are to be fetched.
2383 If the string starts with a `(', `intspec' is evaluated and the resulting
2384 list is the list of arguments.
2385 If it's a string that doesn't start with `(', the value should follow
2386 the one of the doc string for `interactive'.
2387 A null string means call interactively with no arguments.
2388 `doc' is documentation for the user. */
2390 /* This version of DEFUN declares a function prototype with the right
2391 arguments, so we can catch errors with maxargs at compile-time. */
2393 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2394 SCM_SNARF_INIT (defsubr (&sname);) \
2395 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2396 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2398 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2399 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2400 { (Lisp_Object (__cdecl *)(void))fnname }, \
2401 minargs, maxargs, lname, intspec, 0}; \
2403 #else /* not _MSC_VER */
2404 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2405 SCM_SNARF_INIT (defsubr (&sname);) \
2406 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2407 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2409 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2410 { .a ## maxargs = fnname }, \
2411 minargs, maxargs, lname, intspec, 0}; \
2415 /* Note that the weird token-substitution semantics of ANSI C makes
2416 this work for MANY and UNEVALLED. */
2417 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2418 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2419 #define DEFUN_ARGS_0 (void)
2420 #define DEFUN_ARGS_1 (Lisp_Object)
2421 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2422 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2423 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2424 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2426 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2427 Lisp_Object, Lisp_Object)
2428 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2429 Lisp_Object, Lisp_Object, Lisp_Object)
2430 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2431 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2433 /* True if OBJ is a Lisp function. */
2435 FUNCTIONP (Lisp_Object obj
)
2437 return functionp (obj
);
2441 is how we define the symbol for function `name' at start-up time. */
2442 extern void defsubr (struct Lisp_Subr
*);
2450 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2451 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2452 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2453 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2454 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2456 /* Macros we use to define forwarded Lisp variables.
2457 These are used in the syms_of_FILENAME functions.
2459 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2460 lisp variable is actually a field in `struct emacs_globals'. The
2461 field's name begins with "f_", which is a convention enforced by
2462 these macros. Each such global has a corresponding #define in
2463 globals.h; the plain name should be used in the code.
2465 E.g., the global "cons_cells_consed" is declared as "int
2466 f_cons_cells_consed" in globals.h, but there is a define:
2468 #define cons_cells_consed globals.f_cons_cells_consed
2470 All C code uses the `cons_cells_consed' name. This is all done
2471 this way to support indirection for multi-threaded Emacs. */
2473 #define DEFVAR_LISP(lname, vname, doc) \
2475 static struct Lisp_Objfwd o_fwd; \
2476 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2478 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2480 static struct Lisp_Objfwd o_fwd; \
2481 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2483 #define DEFVAR_BOOL(lname, vname, doc) \
2485 static struct Lisp_Boolfwd b_fwd; \
2486 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2488 #define DEFVAR_INT(lname, vname, doc) \
2490 static struct Lisp_Intfwd i_fwd; \
2491 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2494 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2496 static struct Lisp_Objfwd o_fwd; \
2497 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2500 #define DEFVAR_KBOARD(lname, vname, doc) \
2502 static struct Lisp_Kboard_Objfwd ko_fwd; \
2503 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2506 /* Save and restore the instruction and environment pointers,
2507 without affecting the signal mask. */
2510 typedef jmp_buf sys_jmp_buf
;
2511 # define sys_setjmp(j) _setjmp (j)
2512 # define sys_longjmp(j, v) _longjmp (j, v)
2513 #elif defined HAVE_SIGSETJMP
2514 typedef sigjmp_buf sys_jmp_buf
;
2515 # define sys_setjmp(j) sigsetjmp (j, 0)
2516 # define sys_longjmp(j, v) siglongjmp (j, v)
2518 /* A platform that uses neither _longjmp nor siglongjmp; assume
2519 longjmp does not affect the sigmask. */
2520 typedef jmp_buf sys_jmp_buf
;
2521 # define sys_setjmp(j) setjmp (j)
2522 # define sys_longjmp(j, v) longjmp (j, v)
2526 /* Elisp uses several stacks:
2528 - the bytecode stack: used internally by the bytecode interpreter.
2529 Allocated from the C stack.
2530 - The specpdl stack: keeps track of active unwind-protect and
2531 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2533 - The handler stack: keeps track of active catch tags and condition-case
2534 handlers. Allocated in a manually managed stack implemented by a
2535 doubly-linked list allocated via xmalloc and never freed. */
2537 /* Structure for recording Lisp call stack for backtrace purposes. */
2539 /* The special binding stack holds the outer values of variables while
2540 they are bound by a function application or a let form, stores the
2541 code to be executed for unwind-protect forms.
2543 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2544 used all over the place, needs to be fast, and needs to know the size of
2545 union specbinding. But only eval.c should access it. */
2548 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2549 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2550 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2551 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2552 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2557 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2559 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2562 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2563 bool wind_explicitly
;
2564 void (*func
) (Lisp_Object
);
2568 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2569 bool wind_explicitly
;
2570 void (*func
) (void *);
2574 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2575 bool wind_explicitly
;
2580 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2581 bool wind_explicitly
;
2582 void (*func
) (void);
2585 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2586 /* `where' is not used in the case of SPECPDL_LET. */
2587 Lisp_Object symbol
, old_value
, where
;
2590 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2591 bool_bf debug_on_exit
: 1;
2592 Lisp_Object function
;
2598 extern union specbinding
*specpdl
;
2599 extern union specbinding
*specpdl_ptr
;
2600 extern ptrdiff_t specpdl_size
;
2603 SPECPDL_INDEX (void)
2605 return specpdl_ptr
- specpdl
;
2608 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2609 control structures. A struct handler contains all the information needed to
2610 restore the state of the interpreter after a non-local jump.
2612 handler structures are chained together in a doubly linked list; the `next'
2613 member points to the next outer catchtag and the `nextfree' member points in
2614 the other direction to the next inner element (which is typically the next
2615 free element since we mostly use it on the deepest handler).
2617 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2618 member is TAG, and then unbinds to it. The `val' member is used to
2619 hold VAL while the stack is unwound; `val' is returned as the value
2622 All the other members are concerned with restoring the interpreter
2625 Members are volatile if their values need to survive _longjmp when
2626 a 'struct handler' is a local variable. */
2628 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2632 enum handlertype type
;
2634 Lisp_Object tag_or_ch
;
2638 struct handler
*next
;
2639 EMACS_INT lisp_eval_depth
;
2640 int poll_suppress_count
;
2641 int interrupt_input_blocked
;
2644 extern Lisp_Object memory_signal_data
;
2646 /* Check quit-flag and quit if it is non-nil.
2647 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2648 So the program needs to do QUIT at times when it is safe to quit.
2649 Every loop that might run for a long time or might not exit
2650 ought to do QUIT at least once, at a safe place.
2651 Unless that is impossible, of course.
2652 But it is very desirable to avoid creating loops where QUIT is impossible.
2654 Exception: if you set immediate_quit to true,
2655 then the handler that responds to the C-g does the quit itself.
2656 This is a good thing to do around a loop that has no side effects
2657 and (in particular) cannot call arbitrary Lisp code.
2659 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2660 a request to exit Emacs when it is safe to do. */
2662 extern void process_pending_signals (void);
2663 extern bool volatile pending_signals
;
2665 extern void process_quit_flag (void);
2668 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2669 process_quit_flag (); \
2670 else if (pending_signals) \
2671 process_pending_signals (); \
2675 /* True if ought to quit now. */
2677 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2679 extern Lisp_Object Vascii_downcase_table
;
2680 extern Lisp_Object Vascii_canon_table
;
2682 /* Structure for recording stack slots that need marking. */
2684 /* This is a chain of structures, each of which points at a Lisp_Object
2685 variable whose value should be marked in garbage collection.
2686 Normally every link of the chain is an automatic variable of a function,
2687 and its `val' points to some argument or local variable of the function.
2688 On exit to the function, the chain is set back to the value it had on entry.
2689 This way, no link remains in the chain when the stack frame containing the
2692 Every function that can call Feval must protect in this fashion all
2693 Lisp_Object variables whose contents will be used again. */
2695 extern struct gcpro
*gcprolist
;
2701 /* Address of first protected variable. */
2702 volatile Lisp_Object
*var
;
2704 /* Number of consecutive protected variables. */
2712 /* Do something silly with gcproN vars just so gcc shuts up. */
2713 /* You get warnings from MIPSPro... */
2715 #define GCPRO1(varname) ((void) gcpro1)
2716 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2717 #define GCPRO3(varname1, varname2, varname3) \
2718 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2719 #define GCPRO4(varname1, varname2, varname3, varname4) \
2720 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2721 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2722 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2723 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2724 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2726 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2727 #define UNGCPRO ((void) 0)
2729 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2730 #define RETURN_UNGCPRO(expr) \
2733 Lisp_Object ret_ungc_val; \
2734 ret_ungc_val = (expr); \
2736 return ret_ungc_val; \
2740 /* Call staticpro (&var) to protect static variable `var'. */
2742 void staticpro (Lisp_Object
*);
2744 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2745 meaning as in the DEFUN macro, and is used to construct a prototype. */
2746 /* We can use the same trick as in the DEFUN macro to generate the
2747 appropriate prototype. */
2748 #define EXFUN(fnname, maxargs) \
2749 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2751 #include "globals.h"
2753 /* Forward declarations for prototypes. */
2757 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2760 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2762 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2763 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2766 /* Functions to modify hash tables. */
2769 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2771 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2775 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2777 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2780 /* Use these functions to set Lisp_Object
2781 or pointer slots of struct Lisp_Symbol. */
2784 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2786 XSYMBOL (sym
)->function
= function
;
2790 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2792 XSYMBOL (sym
)->plist
= plist
;
2796 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
2798 XSYMBOL (sym
)->next
= next
;
2801 /* Buffer-local (also frame-local) variable access functions. */
2804 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2806 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2810 /* Set overlay's property list. */
2813 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2815 XOVERLAY (overlay
)->plist
= plist
;
2818 /* Get text properties of S. */
2821 string_intervals (Lisp_Object s
)
2823 return XSTRING (s
)->intervals
;
2826 /* Set text properties of S to I. */
2829 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2831 XSTRING (s
)->intervals
= i
;
2834 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2835 of setting slots directly. */
2838 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2840 XCHAR_TABLE (table
)->defalt
= val
;
2843 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2845 XCHAR_TABLE (table
)->purpose
= val
;
2848 /* Set different slots in (sub)character tables. */
2851 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2853 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2854 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2858 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2860 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2861 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2865 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2867 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2870 /* Defined in data.c. */
2871 extern Lisp_Object Qquote
, Qunbound
;
2872 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2873 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2874 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2875 extern Lisp_Object Qinvalid_read_syntax
;
2876 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2877 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2878 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2879 extern Lisp_Object Qtext_read_only
;
2880 extern Lisp_Object Qinteractive_form
;
2881 extern Lisp_Object Qcircular_list
;
2882 extern Lisp_Object Qsequencep
;
2883 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2884 extern Lisp_Object Qfboundp
;
2886 extern Lisp_Object Qcdr
;
2888 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2890 extern Lisp_Object Qnumber_or_marker_p
;
2892 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2894 /* Defined in data.c. */
2895 extern Lisp_Object
indirect_function (Lisp_Object
);
2896 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2897 enum Arith_Comparison
{
2902 ARITH_LESS_OR_EQUAL
,
2905 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2906 enum Arith_Comparison comparison
);
2908 /* Convert the integer I to an Emacs representation, either the integer
2909 itself, or a cons of two or three integers, or if all else fails a float.
2910 I should not have side effects. */
2911 #define INTEGER_TO_CONS(i) \
2912 (! FIXNUM_OVERFLOW_P (i) \
2914 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2915 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2916 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2917 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2918 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2919 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2920 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2921 ? Fcons (make_number ((i) >> 16 >> 24), \
2922 Fcons (make_number ((i) >> 16 & 0xffffff), \
2923 make_number ((i) & 0xffff))) \
2926 /* Convert the Emacs representation CONS back to an integer of type
2927 TYPE, storing the result the variable VAR. Signal an error if CONS
2928 is not a valid representation or is out of range for TYPE. */
2929 #define CONS_TO_INTEGER(cons, type, var) \
2930 (TYPE_SIGNED (type) \
2931 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2932 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2933 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2934 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2936 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2937 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2938 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2940 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2941 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2942 extern void syms_of_data (void);
2943 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2945 /* Defined in cmds.c */
2946 extern void syms_of_cmds (void);
2947 extern void keys_of_cmds (void);
2949 /* Defined in coding.c. */
2950 extern Lisp_Object Qcharset
;
2951 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2952 ptrdiff_t, bool, bool, Lisp_Object
);
2953 extern void init_coding (void);
2954 extern void init_coding_once (void);
2955 extern void syms_of_coding (void);
2957 /* Defined in character.c. */
2958 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2959 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2960 extern void syms_of_character (void);
2962 /* Defined in charset.c. */
2963 extern void init_charset (void);
2964 extern void init_charset_once (void);
2965 extern void syms_of_charset (void);
2966 /* Structure forward declarations. */
2969 /* Defined in syntax.c. */
2970 extern void init_syntax_once (void);
2971 extern void syms_of_syntax (void);
2973 /* Defined in fns.c. */
2974 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2975 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2976 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2977 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2978 extern void sweep_weak_hash_tables (void);
2979 extern Lisp_Object Qcursor_in_echo_area
;
2980 extern Lisp_Object Qstring_lessp
;
2981 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2982 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2983 EMACS_UINT
sxhash (Lisp_Object
, int);
2984 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2985 Lisp_Object
, Lisp_Object
);
2986 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2987 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2989 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2990 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2991 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2992 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2993 ptrdiff_t, ptrdiff_t);
2994 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2995 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2996 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2997 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2998 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2999 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3000 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3001 extern void clear_string_char_byte_cache (void);
3002 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3003 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3004 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3005 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3006 extern void init_fns_once (void);
3007 extern void syms_of_fns (void);
3009 /* Defined in floatfns.c. */
3010 extern void syms_of_floatfns (void);
3011 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3013 /* Defined in fringe.c. */
3014 extern void syms_of_fringe (void);
3015 extern void init_fringe (void);
3016 #ifdef HAVE_WINDOW_SYSTEM
3017 extern void mark_fringe_data (void);
3018 extern void init_fringe_once (void);
3019 #endif /* HAVE_WINDOW_SYSTEM */
3021 /* Defined in image.c. */
3022 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3023 extern Lisp_Object QCconversion
;
3024 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3025 extern void reset_image_types (void);
3026 extern void syms_of_image (void);
3028 /* Defined in insdel.c. */
3029 extern Lisp_Object Qinhibit_modification_hooks
;
3030 extern Lisp_Object Qregion_extract_function
;
3031 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3032 extern _Noreturn
void buffer_overflow (void);
3033 extern void make_gap (ptrdiff_t);
3034 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3035 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3036 ptrdiff_t, bool, bool);
3037 extern int count_combining_before (const unsigned char *,
3038 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3039 extern int count_combining_after (const unsigned char *,
3040 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3041 extern void insert (const char *, ptrdiff_t);
3042 extern void insert_and_inherit (const char *, ptrdiff_t);
3043 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3045 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3046 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3047 ptrdiff_t, ptrdiff_t, bool);
3048 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3049 extern void insert_char (int);
3050 extern void insert_string (const char *);
3051 extern void insert_before_markers (const char *, ptrdiff_t);
3052 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3053 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3054 ptrdiff_t, ptrdiff_t,
3056 extern void del_range (ptrdiff_t, ptrdiff_t);
3057 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3058 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3059 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3060 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3061 ptrdiff_t, ptrdiff_t, bool);
3062 extern void modify_text (ptrdiff_t, ptrdiff_t);
3063 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3064 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3065 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3066 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3067 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3068 ptrdiff_t, ptrdiff_t);
3069 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3070 ptrdiff_t, ptrdiff_t);
3071 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3072 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3073 const char *, ptrdiff_t, ptrdiff_t, bool);
3074 extern void syms_of_insdel (void);
3076 /* Defined in dispnew.c. */
3077 #if (defined PROFILING \
3078 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3079 _Noreturn
void __executable_start (void);
3081 extern Lisp_Object Vwindow_system
;
3082 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3084 /* Defined in xdisp.c. */
3085 extern Lisp_Object Qinhibit_point_motion_hooks
;
3086 extern Lisp_Object Qinhibit_redisplay
;
3087 extern Lisp_Object Qmenu_bar_update_hook
;
3088 extern Lisp_Object Qwindow_scroll_functions
;
3089 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3090 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3091 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3092 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3093 extern Lisp_Object Qleft_margin
, Qright_margin
;
3094 extern Lisp_Object QCdata
, QCfile
;
3095 extern Lisp_Object QCmap
;
3096 extern Lisp_Object Qrisky_local_variable
;
3097 extern bool noninteractive_need_newline
;
3098 extern Lisp_Object echo_area_buffer
[2];
3099 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3100 extern void check_message_stack (void);
3101 extern void setup_echo_area_for_printing (int);
3102 extern bool push_message (void);
3103 extern void pop_message_unwind (void);
3104 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3105 extern void restore_message (void);
3106 extern Lisp_Object
current_message (void);
3107 extern void clear_message (bool, bool);
3108 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3109 extern void message1 (const char *);
3110 extern void message1_nolog (const char *);
3111 extern void message3 (Lisp_Object
);
3112 extern void message3_nolog (Lisp_Object
);
3113 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3114 extern void message_with_string (const char *, Lisp_Object
, int);
3115 extern void message_log_maybe_newline (void);
3116 extern void update_echo_area (void);
3117 extern void truncate_echo_area (ptrdiff_t);
3118 extern void redisplay (void);
3120 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3121 extern void syms_of_xdisp (void);
3122 extern void init_xdisp (void);
3123 extern Lisp_Object
safe_eval (Lisp_Object
);
3124 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3125 int *, int *, int *, int *, int *);
3127 /* Defined in xsettings.c. */
3128 extern void syms_of_xsettings (void);
3130 /* Defined in vm-limit.c. */
3131 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3133 /* Defined in alloc.c. */
3134 extern void check_pure_size (void);
3135 extern void free_misc (Lisp_Object
);
3136 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3137 extern void malloc_warning (const char *);
3138 extern _Noreturn
void memory_full (size_t);
3139 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3140 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3141 extern void refill_memory_reserve (void);
3143 extern const char *pending_malloc_warning
;
3144 extern Lisp_Object zero_vector
;
3145 extern Lisp_Object
list1 (Lisp_Object
);
3146 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3147 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3148 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3149 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3151 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3152 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3154 /* Build a frequently used 2/3/4-integer lists. */
3157 list2i (EMACS_INT x
, EMACS_INT y
)
3159 return list2 (make_number (x
), make_number (y
));
3163 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3165 return list3 (make_number (x
), make_number (y
), make_number (w
));
3169 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3171 return list4 (make_number (x
), make_number (y
),
3172 make_number (w
), make_number (h
));
3175 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3176 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3177 extern _Noreturn
void string_overflow (void);
3178 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3179 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3180 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3181 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3183 /* Make unibyte string from C string when the length isn't known. */
3186 build_unibyte_string (const char *str
)
3188 return make_unibyte_string (str
, strlen (str
));
3191 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3192 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3193 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3194 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3195 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3196 extern Lisp_Object
make_specified_string (const char *,
3197 ptrdiff_t, ptrdiff_t, bool);
3198 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3199 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3201 /* Make a string allocated in pure space, use STR as string data. */
3204 build_pure_c_string (const char *str
)
3206 return make_pure_c_string (str
, strlen (str
));
3209 /* Make a string from the data at STR, treating it as multibyte if the
3213 build_string (const char *str
)
3215 return make_string (str
, strlen (str
));
3218 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3219 extern void make_byte_code (struct Lisp_Vector
*);
3220 extern Lisp_Object Qchar_table_extra_slots
;
3221 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3223 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3224 be sure that GC cannot happen until the vector is completely
3225 initialized. E.g. the following code is likely to crash:
3227 v = make_uninit_vector (3);
3229 ASET (v, 1, Ffunction_can_gc ());
3230 ASET (v, 2, obj1); */
3233 make_uninit_vector (ptrdiff_t size
)
3236 struct Lisp_Vector
*p
;
3238 p
= allocate_vector (size
);
3243 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3244 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3246 allocate_pseudovector \
3247 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3248 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3249 extern struct window
*allocate_window (void);
3250 extern struct frame
*allocate_frame (void);
3251 extern struct Lisp_Process
*allocate_process (void);
3252 extern struct terminal
*allocate_terminal (void);
3253 extern Lisp_Object
make_float (double);
3254 extern void display_malloc_warning (void);
3255 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3256 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3257 Lisp_Object
, Lisp_Object
);
3258 extern Lisp_Object
make_save_ptr (void *);
3259 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3260 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3261 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3263 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3264 extern void free_save_value (Lisp_Object
);
3265 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3266 extern void init_alloc_once (void);
3267 extern void init_alloc (void);
3268 extern void syms_of_alloc (void);
3269 extern struct buffer
* allocate_buffer (void);
3270 extern int valid_lisp_object_p (Lisp_Object
);
3271 extern int relocatable_string_data_p (const char *);
3274 /* Defined in ralloc.c. */
3275 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3276 extern void r_alloc_free (void **);
3277 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3278 extern void r_alloc_reset_variable (void **, void **);
3279 extern void r_alloc_inhibit_buffer_relocation (int);
3282 /* Defined in chartab.c. */
3283 extern Lisp_Object
copy_char_table (Lisp_Object
);
3284 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3286 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3287 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3289 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3290 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3291 Lisp_Object
, Lisp_Object
,
3292 Lisp_Object
, struct charset
*,
3293 unsigned, unsigned);
3294 extern Lisp_Object
uniprop_table (Lisp_Object
);
3295 extern void syms_of_chartab (void);
3297 /* Defined in print.c. */
3298 extern Lisp_Object Vprin1_to_string_buffer
;
3299 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3300 extern Lisp_Object Qstandard_output
;
3301 extern Lisp_Object Qexternal_debugging_output
;
3302 extern void temp_output_buffer_setup (const char *);
3303 extern int print_level
;
3304 extern Lisp_Object Qprint_escape_newlines
;
3305 extern void write_string (const char *, int);
3306 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3308 extern Lisp_Object internal_with_output_to_temp_buffer
3309 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3310 #define FLOAT_TO_STRING_BUFSIZE 350
3311 extern int float_to_string (char *, double);
3312 extern void init_print_once (void);
3313 extern void syms_of_print (void);
3315 /* Defined in doprnt.c. */
3316 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3318 extern ptrdiff_t esprintf (char *, char const *, ...)
3319 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3320 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3322 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3323 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3324 char const *, va_list)
3325 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3327 /* Defined in lread.c. */
3328 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3329 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3330 extern Lisp_Object Qlexical_binding
;
3331 extern Lisp_Object
check_obarray (Lisp_Object
);
3332 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3333 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3334 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3336 LOADHIST_ATTACH (Lisp_Object x
)
3339 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3341 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3342 Lisp_Object
*, Lisp_Object
, bool);
3343 extern Lisp_Object
string_to_number (char const *, int, bool);
3344 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3346 extern void dir_warning (const char *, Lisp_Object
);
3347 extern void init_obarray (void);
3348 extern void init_lread (void);
3349 extern void syms_of_lread (void);
3352 intern (const char *str
)
3354 return intern_1 (str
, strlen (str
));
3358 intern_c_string (const char *str
)
3360 return intern_c_string_1 (str
, strlen (str
));
3363 /* Defined in eval.c. */
3364 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3365 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3366 extern Lisp_Object Qand_rest
;
3367 extern Lisp_Object Vautoload_queue
;
3368 extern Lisp_Object Vsignaling_function
;
3369 extern Lisp_Object inhibit_lisp_code
;
3370 extern struct handler
*handlerlist
;
3372 /* To run a normal hook, use the appropriate function from the list below.
3373 The calling convention:
3375 if (!NILP (Vrun_hooks))
3376 call1 (Vrun_hooks, Qmy_funny_hook);
3378 should no longer be used. */
3379 extern Lisp_Object Vrun_hooks
;
3380 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3381 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3382 Lisp_Object (*funcall
)
3383 (ptrdiff_t nargs
, Lisp_Object
*args
));
3384 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3385 extern _Noreturn
void xsignal0 (Lisp_Object
);
3386 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3387 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3388 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3390 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3391 extern Lisp_Object
eval_sub (Lisp_Object form
);
3392 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3393 extern Lisp_Object
call0 (Lisp_Object
);
3394 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3395 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3396 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3397 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3398 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3399 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3400 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3401 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3402 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3403 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3404 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3405 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3406 extern Lisp_Object internal_condition_case_n
3407 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3408 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3409 extern void specbind (Lisp_Object
, Lisp_Object
);
3410 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3411 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3412 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3413 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3414 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3415 extern void record_unwind_protect_int (void (*) (int), int);
3416 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3417 extern void record_unwind_protect_void (void (*) (void));
3418 extern void dynwind_begin (void);
3419 extern void dynwind_end (void);
3420 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3421 extern _Noreturn
void verror (const char *, va_list)
3422 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3423 extern void un_autoload (Lisp_Object
);
3424 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3425 extern void init_eval_once (void);
3426 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3427 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3428 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3429 extern void init_eval (void);
3430 extern void syms_of_eval (void);
3431 extern void unwind_body (Lisp_Object
);
3432 extern void record_in_backtrace (Lisp_Object function
,
3433 Lisp_Object
*args
, ptrdiff_t nargs
);
3434 extern void mark_specpdl (void);
3435 extern void get_backtrace (Lisp_Object array
);
3436 Lisp_Object
backtrace_top_function (void);
3437 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3438 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3439 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3440 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3441 extern SCM
make_prompt_tag (void);
3444 /* Defined in editfns.c. */
3445 extern Lisp_Object Qfield
;
3446 extern void insert1 (Lisp_Object
);
3447 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3448 extern Lisp_Object
save_excursion_save (void);
3449 extern Lisp_Object
save_restriction_save (void);
3450 extern void save_excursion_restore (Lisp_Object
);
3451 extern void save_restriction_restore (Lisp_Object
);
3452 extern _Noreturn
void time_overflow (void);
3453 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3454 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3456 extern void init_editfns (void);
3457 extern void syms_of_editfns (void);
3458 extern void set_time_zone_rule (const char *);
3460 /* Defined in buffer.c. */
3461 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3462 extern _Noreturn
void nsberror (Lisp_Object
);
3463 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3464 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3465 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3466 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3467 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3468 extern bool overlay_touches_p (ptrdiff_t);
3469 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3470 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3471 extern void init_buffer_once (void);
3472 extern void init_buffer (int);
3473 extern void syms_of_buffer (void);
3474 extern void keys_of_buffer (void);
3476 /* Defined in marker.c. */
3478 extern ptrdiff_t marker_position (Lisp_Object
);
3479 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3480 extern void clear_charpos_cache (struct buffer
*);
3481 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3482 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3483 extern void unchain_marker (struct Lisp_Marker
*marker
);
3484 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3485 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3486 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3487 ptrdiff_t, ptrdiff_t);
3488 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3489 extern void syms_of_marker (void);
3491 /* Defined in fileio.c. */
3493 extern Lisp_Object Qfile_error
;
3494 extern Lisp_Object Qfile_notify_error
;
3495 extern Lisp_Object Qfile_exists_p
;
3496 extern Lisp_Object Qfile_directory_p
;
3497 extern Lisp_Object Qinsert_file_contents
;
3498 extern Lisp_Object Qfile_name_history
;
3499 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3500 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3501 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3503 extern void close_file_unwind (int);
3504 extern void close_file_ptr_unwind (void *);
3505 extern void fclose_unwind (void *);
3506 extern void fclose_ptr_unwind (void *);
3507 extern void restore_point_unwind (Lisp_Object
);
3508 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3509 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3510 extern bool internal_delete_file (Lisp_Object
);
3511 extern Lisp_Object
emacs_readlinkat (int, const char *);
3512 extern bool file_directory_p (const char *);
3513 extern bool file_accessible_directory_p (const char *);
3514 extern void init_fileio (void);
3515 extern void syms_of_fileio (void);
3516 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3517 extern Lisp_Object Qdelete_file
;
3519 /* Defined in search.c. */
3520 extern void shrink_regexp_cache (void);
3521 extern void restore_search_regs (void);
3522 extern void record_unwind_save_match_data (void);
3523 struct re_registers
;
3524 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3525 struct re_registers
*,
3526 Lisp_Object
, bool, bool);
3527 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3528 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3530 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3531 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3532 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3533 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3534 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3535 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3537 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3538 ptrdiff_t, ptrdiff_t *);
3539 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3540 ptrdiff_t, ptrdiff_t *);
3541 extern void syms_of_search (void);
3542 extern void clear_regexp_cache (void);
3544 /* Defined in minibuf.c. */
3546 extern Lisp_Object Qcompletion_ignore_case
;
3547 extern Lisp_Object Vminibuffer_list
;
3548 extern Lisp_Object last_minibuf_string
;
3549 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3550 extern void init_minibuf_once (void);
3551 extern void syms_of_minibuf (void);
3553 /* Defined in callint.c. */
3555 extern Lisp_Object Qminus
, Qplus
;
3556 extern Lisp_Object Qprogn
;
3557 extern Lisp_Object Qwhen
;
3558 extern Lisp_Object Qmouse_leave_buffer_hook
;
3559 extern void syms_of_callint (void);
3561 /* Defined in casefiddle.c. */
3563 extern Lisp_Object Qidentity
;
3564 extern void syms_of_casefiddle (void);
3565 extern void keys_of_casefiddle (void);
3567 /* Defined in casetab.c. */
3569 extern void init_casetab_once (void);
3570 extern void syms_of_casetab (void);
3572 /* Defined in keyboard.c. */
3574 extern Lisp_Object echo_message_buffer
;
3575 extern struct kboard
*echo_kboard
;
3576 extern void cancel_echoing (void);
3577 extern Lisp_Object Qdisabled
, QCfilter
;
3578 extern Lisp_Object Qup
, Qdown
;
3579 extern Lisp_Object last_undo_boundary
;
3580 extern bool input_pending
;
3581 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3582 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3583 extern void discard_mouse_events (void);
3585 void handle_input_available_signal (int);
3587 extern Lisp_Object pending_funcalls
;
3588 extern bool detect_input_pending (void);
3589 extern bool detect_input_pending_ignore_squeezables (void);
3590 extern bool detect_input_pending_run_timers (bool);
3591 extern void safe_run_hooks (Lisp_Object
);
3592 extern void cmd_error_internal (Lisp_Object
, const char *);
3593 extern Lisp_Object
command_loop_1 (void);
3594 extern Lisp_Object
read_menu_command (void);
3595 extern Lisp_Object
recursive_edit_1 (void);
3596 extern void record_auto_save (void);
3597 extern void force_auto_save_soon (void);
3598 extern void init_keyboard (void);
3599 extern void syms_of_keyboard (void);
3600 extern void keys_of_keyboard (void);
3602 /* Defined in indent.c. */
3603 extern ptrdiff_t current_column (void);
3604 extern void invalidate_current_column (void);
3605 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3606 extern void syms_of_indent (void);
3608 /* Defined in frame.c. */
3609 extern Lisp_Object Qonly
, Qnone
;
3610 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3611 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3612 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3613 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3614 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3615 extern void frames_discard_buffer (Lisp_Object
);
3616 extern void syms_of_frame (void);
3618 /* Defined in emacs.c. */
3619 extern char **initial_argv
;
3620 extern int initial_argc
;
3621 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3622 extern bool display_arg
;
3624 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3625 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3626 extern Lisp_Object Qfile_name_handler_alist
;
3627 extern _Noreturn
void terminate_due_to_signal (int, int);
3628 extern Lisp_Object Qkill_emacs
;
3630 extern Lisp_Object Vlibrary_cache
;
3633 void fixup_locale (void);
3634 void synchronize_system_messages_locale (void);
3635 void synchronize_system_time_locale (void);
3637 INLINE
void fixup_locale (void) {}
3638 INLINE
void synchronize_system_messages_locale (void) {}
3639 INLINE
void synchronize_system_time_locale (void) {}
3641 extern void shut_down_emacs (int, Lisp_Object
);
3643 /* True means don't do interactive redisplay and don't change tty modes. */
3644 extern bool noninteractive
;
3646 /* True means remove site-lisp directories from load-path. */
3647 extern bool no_site_lisp
;
3649 /* Pipe used to send exit notification to the daemon parent at
3651 extern int daemon_pipe
[2];
3652 #define IS_DAEMON (daemon_pipe[1] != 0)
3654 /* True if handling a fatal error already. */
3655 extern bool fatal_error_in_progress
;
3657 /* True means don't do use window-system-specific display code. */
3658 extern bool inhibit_window_system
;
3659 /* True means that a filter or a sentinel is running. */
3660 extern bool running_asynch_code
;
3662 /* Defined in process.c. */
3663 extern Lisp_Object QCtype
, Qlocal
;
3664 extern void kill_buffer_processes (Lisp_Object
);
3665 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3666 struct Lisp_Process
*, int);
3667 /* Max value for the first argument of wait_reading_process_output. */
3668 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3669 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3670 The bug merely causes a bogus warning, but the warning is annoying. */
3671 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3673 # define WAIT_READING_MAX INTMAX_MAX
3675 extern void add_keyboard_wait_descriptor (int);
3676 extern void delete_keyboard_wait_descriptor (int);
3678 extern void add_gpm_wait_descriptor (int);
3679 extern void delete_gpm_wait_descriptor (int);
3681 extern void init_process_emacs (void);
3682 extern void syms_of_process (void);
3683 extern void setup_process_coding_systems (Lisp_Object
);
3685 /* Defined in callproc.c. */
3689 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3690 extern void init_callproc_1 (void);
3691 extern void init_callproc (void);
3692 extern void set_initial_environment (void);
3693 extern void syms_of_callproc (void);
3695 /* Defined in doc.c. */
3696 extern Lisp_Object Qfunction_documentation
;
3697 extern Lisp_Object
read_doc_string (Lisp_Object
);
3698 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3699 extern void syms_of_doc (void);
3700 extern int read_bytecode_char (bool);
3702 /* Defined in bytecode.c. */
3703 extern void syms_of_bytecode (void);
3704 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3705 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3707 /* Defined in macros.c. */
3708 extern void init_macros (void);
3709 extern void syms_of_macros (void);
3711 /* Defined in undo.c. */
3712 extern Lisp_Object Qapply
;
3713 extern Lisp_Object Qinhibit_read_only
;
3714 extern void truncate_undo_list (struct buffer
*);
3715 extern void record_insert (ptrdiff_t, ptrdiff_t);
3716 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3717 extern void record_first_change (void);
3718 extern void record_change (ptrdiff_t, ptrdiff_t);
3719 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3720 Lisp_Object
, Lisp_Object
,
3722 extern void syms_of_undo (void);
3723 /* Defined in textprop.c. */
3724 extern Lisp_Object Qmouse_face
;
3725 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3726 extern Lisp_Object Qminibuffer_prompt
;
3728 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3730 /* Defined in menu.c. */
3731 extern void syms_of_menu (void);
3733 /* Defined in xmenu.c. */
3734 extern void syms_of_xmenu (void);
3736 /* Defined in termchar.h. */
3737 struct tty_display_info
;
3739 /* Defined in termhooks.h. */
3742 /* Defined in sysdep.c. */
3743 #ifndef HAVE_GET_CURRENT_DIR_NAME
3744 extern char *get_current_dir_name (void);
3746 extern void stuff_char (char c
);
3747 extern void init_foreground_group (void);
3748 extern void sys_subshell (void);
3749 extern void sys_suspend (void);
3750 extern void discard_tty_input (void);
3751 extern void init_sys_modes (struct tty_display_info
*);
3752 extern void reset_sys_modes (struct tty_display_info
*);
3753 extern void init_all_sys_modes (void);
3754 extern void reset_all_sys_modes (void);
3755 extern void child_setup_tty (int);
3756 extern void setup_pty (int);
3757 extern int set_window_size (int, int, int);
3758 extern EMACS_INT
get_random (void);
3759 extern void seed_random (void *, ptrdiff_t);
3760 extern void init_random (void);
3761 extern void emacs_backtrace (int);
3762 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3763 extern int emacs_open (const char *, int, int);
3764 extern int emacs_pipe (int[2]);
3765 extern int emacs_close (int);
3766 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3767 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3768 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3769 extern void emacs_perror (char const *);
3771 extern void unlock_all_files (void);
3772 extern void lock_file (Lisp_Object
);
3773 extern void unlock_file (Lisp_Object
);
3774 extern void unlock_buffer (struct buffer
*);
3775 extern void syms_of_filelock (void);
3777 /* Defined in sound.c. */
3778 extern void syms_of_sound (void);
3780 /* Defined in category.c. */
3781 extern void init_category_once (void);
3782 extern Lisp_Object
char_category_set (int);
3783 extern void syms_of_category (void);
3785 /* Defined in ccl.c. */
3786 extern void syms_of_ccl (void);
3788 /* Defined in dired.c. */
3789 extern void syms_of_dired (void);
3790 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3791 Lisp_Object
, Lisp_Object
,
3794 /* Defined in term.c. */
3795 extern int *char_ins_del_vector
;
3796 extern void syms_of_term (void);
3797 extern _Noreturn
void fatal (const char *msgid
, ...)
3798 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3800 /* Defined in terminal.c. */
3801 extern void syms_of_terminal (void);
3803 /* Defined in font.c. */
3804 extern void syms_of_font (void);
3805 extern void init_font (void);
3807 #ifdef HAVE_WINDOW_SYSTEM
3808 /* Defined in fontset.c. */
3809 extern void syms_of_fontset (void);
3811 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3812 extern Lisp_Object Qfont_param
;
3815 /* Defined in gfilenotify.c */
3816 #ifdef HAVE_GFILENOTIFY
3817 extern void globals_of_gfilenotify (void);
3818 extern void syms_of_gfilenotify (void);
3821 /* Defined in inotify.c */
3823 extern void syms_of_inotify (void);
3826 #ifdef HAVE_W32NOTIFY
3827 /* Defined on w32notify.c. */
3828 extern void syms_of_w32notify (void);
3831 /* Defined in xfaces.c. */
3832 extern Lisp_Object Qdefault
, Qfringe
;
3833 extern Lisp_Object Qscroll_bar
, Qcursor
;
3834 extern Lisp_Object Qmode_line_inactive
;
3835 extern Lisp_Object Qface
;
3836 extern Lisp_Object Qnormal
;
3837 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3838 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3839 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3840 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3841 extern Lisp_Object Qoblique
, Qitalic
;
3842 extern Lisp_Object Vface_alternative_font_family_alist
;
3843 extern Lisp_Object Vface_alternative_font_registry_alist
;
3844 extern void syms_of_xfaces (void);
3846 #ifdef HAVE_X_WINDOWS
3847 /* Defined in xfns.c. */
3848 extern void syms_of_xfns (void);
3850 /* Defined in xsmfns.c. */
3851 extern void syms_of_xsmfns (void);
3853 /* Defined in xselect.c. */
3854 extern void syms_of_xselect (void);
3856 /* Defined in xterm.c. */
3857 extern void syms_of_xterm (void);
3858 #endif /* HAVE_X_WINDOWS */
3860 #ifdef HAVE_WINDOW_SYSTEM
3861 /* Defined in xterm.c, nsterm.m, w32term.c. */
3862 extern char *x_get_keysym_name (int);
3863 #endif /* HAVE_WINDOW_SYSTEM */
3866 /* Defined in xml.c. */
3867 extern void syms_of_xml (void);
3868 extern void xml_cleanup_parser (void);
3872 /* Defined in decompress.c. */
3873 extern void syms_of_decompress (void);
3877 /* Defined in dbusbind.c. */
3878 void syms_of_dbusbind (void);
3882 /* Defined in profiler.c. */
3883 extern bool profiler_memory_running
;
3884 extern void malloc_probe (size_t);
3885 extern void syms_of_profiler (void);
3889 /* Defined in msdos.c, w32.c. */
3890 extern char *emacs_root_dir (void);
3893 /* True means ^G can quit instantly. */
3894 extern bool immediate_quit
;
3896 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3897 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3898 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3899 extern void xfree (void *);
3900 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3901 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3902 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3903 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3904 ATTRIBUTE_ALLOC_SIZE ((2,3));
3905 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3906 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3907 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3908 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3909 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3911 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3912 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3913 extern void dupstring (char **, char const *);
3914 extern void xputenv (const char *);
3916 extern char *egetenv (const char *);
3918 /* Copy Lisp string to temporary (allocated on stack) C string. */
3920 #define xlispstrdupa(string) \
3921 memcpy (alloca (SBYTES (string) + 1), \
3922 SSDATA (string), SBYTES (string) + 1)
3924 /* Set up the name of the machine we're running on. */
3925 extern void init_system_name (void);
3927 /* Return the absolute value of X. X should be a signed integer
3928 expression without side effects, and X's absolute value should not
3929 exceed the maximum for its promoted type. This is called 'eabs'
3930 because 'abs' is reserved by the C standard. */
3931 #define eabs(x) ((x) < 0 ? -(x) : (x))
3933 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3936 #define make_fixnum_or_float(val) \
3937 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3939 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3940 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3942 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3944 #define USE_SAFE_ALLOCA ((void) 0)
3946 /* SAFE_ALLOCA allocates a simple buffer. */
3948 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3952 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3953 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3954 positive. The code is tuned for MULTIPLIER being a constant. */
3956 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3958 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3959 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3961 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3964 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3966 #define SAFE_FREE() ((void) 0)
3968 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3970 #define SAFE_ALLOCA_LISP(buf, nelt) \
3972 if ((nelt) < MAX_ALLOCA / word_size) \
3973 (buf) = alloca ((nelt) * word_size); \
3974 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3975 buf = xmalloc ((nelt) * word_size); \
3977 memory_full (SIZE_MAX); \
3980 /* Loop over all tails of a list, checking for cycles.
3981 FIXME: Make tortoise and n internal declarations.
3982 FIXME: Unroll the loop body so we don't need `n'. */
3983 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3984 for ((tortoise) = (hare) = (list), (n) = true; \
3986 (hare = XCDR (hare), (n) = !(n), \
3988 ? (EQ (hare, tortoise) \
3989 ? xsignal1 (Qcircular_list, list) \
3991 /* Move tortoise before the next iteration, in case */ \
3992 /* the next iteration does an Fsetcdr. */ \
3993 : (void) ((tortoise) = XCDR (tortoise)))))
3995 /* Do a `for' loop over alist values. */
3997 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3998 for ((list_var) = (head_var); \
3999 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4000 (list_var) = XCDR (list_var))
4002 /* Check whether it's time for GC, and run it if so. */
4011 functionp (Lisp_Object object
)
4013 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
4015 object
= Findirect_function (object
, Qt
);
4017 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4019 /* Autoloaded symbols are functions, except if they load
4020 macros or keymaps. */
4022 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4023 object
= XCDR (object
);
4025 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4030 return XSUBR (object
)->max_args
!= UNEVALLED
;
4031 else if (COMPILEDP (object
))
4033 else if (CONSP (object
))
4035 Lisp_Object car
= XCAR (object
);
4036 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4043 #endif /* EMACS_LISP_H */