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) (scm_is_lisp_false (x))
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) \
307 (x && (scm_is_symbol (x) || EQ (x, Qnil) || EQ (x, Qt)))
308 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
309 #define lisp_h_XCAR(c) (scm_car (c))
310 #define lisp_h_XCDR(c) (scm_cdr (c))
311 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
313 /* Define NAME as a lisp.h inline function that returns TYPE and has
314 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
315 ARGS should be parenthesized. Implement the function by calling
317 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
318 INLINE type (name) argdecls { return lisp_h_##name args; }
320 /* like LISP_MACRO_DEFUN, except NAME returns void. */
321 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
322 INLINE void (name) argdecls { lisp_h_##name args; }
325 /* Define the fundamental Lisp data structures. */
327 /* This is the set of Lisp data types. If you want to define a new
328 data type, read the comments after Lisp_Fwd_Type definition
331 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
332 #define case_Lisp_Int case Lisp_Int
334 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
335 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
336 vociferously about them. */
337 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
338 || (defined __SUNPRO_C && __STDC__))
339 #define ENUM_BF(TYPE) unsigned int
341 #define ENUM_BF(TYPE) enum TYPE
344 scm_t_bits lisp_misc_tag
;
345 scm_t_bits lisp_string_tag
;
346 scm_t_bits lisp_vectorlike_tag
;
352 /* Integer. XINT (obj) is the integer value. */
355 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
358 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
359 whose first member indicates the subtype. */
362 /* String. XSTRING (object) points to a struct Lisp_String.
363 The length of the string, and its contents, are stored therein. */
366 /* Vector of Lisp objects, or something resembling it.
367 XVECTOR (object) points to a struct Lisp_Vector, which contains
368 the size and contents. The size field also contains the type
369 information, if it's not a real vector object. */
372 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
378 /* This is the set of data types that share a common structure.
379 The first member of the structure is a type code from this set.
380 The enum values are arbitrary, but we'll use large numbers to make it
381 more likely that we'll spot the error if a random word in memory is
382 mistakenly interpreted as a Lisp_Misc. */
385 Lisp_Misc_Free
= 0x5eab,
388 Lisp_Misc_Save_Value
,
389 /* Currently floats are not a misc type,
390 but let's define this in case we want to change that. */
392 /* This is not a type code. It is for range checking. */
396 /* These are the types of forwarding objects used in the value slot
397 of symbols for special built-in variables whose value is stored in
401 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
402 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
403 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
404 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
405 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
408 typedef SCM Lisp_Object
;
410 #define LISP_INITIALLY_ZERO SCM_INUM0
412 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
413 At the machine level, these operations are no-ops. */
414 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
415 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
417 /* In the size word of a struct Lisp_Vector, this bit means it's really
418 some other vector-like object. */
419 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
420 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
421 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
423 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
424 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
425 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
428 /* In a pseudovector, the size field actually contains a word with one
429 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
430 with PVEC_TYPE_MASK to indicate the actual type. */
442 PVEC_WINDOW_CONFIGURATION
,
445 /* These should be last, check internal_equal to see why. */
449 PVEC_FONT
/* Should be last because it's used for range checking. */
454 /* For convenience, we also store the number of elements in these bits.
455 Note that this size is not necessarily the memory-footprint size, but
456 only the number of Lisp_Object fields (that need to be traced by GC).
457 The distinction is used, e.g., by Lisp_Process, which places extra
458 non-Lisp_Object fields at the end of the structure. */
459 PSEUDOVECTOR_SIZE_BITS
= 12,
460 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
462 /* To calculate the memory footprint of the pseudovector, it's useful
463 to store the size of non-Lisp area in word_size units here. */
464 PSEUDOVECTOR_REST_BITS
= 12,
465 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
466 << PSEUDOVECTOR_SIZE_BITS
),
468 /* Used to extract pseudovector subtype information. */
469 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
470 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
473 /* These functions extract various sorts of values from a Lisp_Object.
474 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
475 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
478 /* Largest and smallest representable fixnum values. These are the C
479 values. They are macros for use in static initializers. */
480 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
481 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
483 /* Make a Lisp integer representing the value of the low order
486 make_number (EMACS_INT n
)
488 return SCM_I_MAKINUM (n
);
491 /* Extract A's value as a signed integer. */
495 return SCM_I_INUM (a
);
498 /* Like XINT (A), but may be faster. A must be nonnegative.
499 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
500 integers have zero-bits in their tags. */
502 XFASTINT (Lisp_Object a
)
504 EMACS_INT n
= XINT (a
);
509 /* Extract A's value as an unsigned integer. */
511 XUINT (Lisp_Object a
)
513 return SCM_I_INUM (a
);
516 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
517 right now, but XUINT should only be applied to objects we know are
519 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
521 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
523 make_natnum (EMACS_INT n
)
525 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
526 return make_number (n
);
529 /* Return true if X and Y are the same object. */
530 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
532 /* Value is true if I doesn't fit into a Lisp fixnum. It is
533 written this way so that it also works if I is of unsigned
534 type or if I is a NaN. */
536 #define FIXNUM_OVERFLOW_P(i) \
537 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
540 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
542 return num
< lower
? lower
: num
<= upper
? num
: upper
;
545 /* Forward declarations. */
547 /* Defined in this file. */
549 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
550 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
551 INLINE
bool BUFFERP (Lisp_Object
);
552 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
553 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
554 INLINE
bool (CONSP
) (Lisp_Object
);
555 INLINE
bool (FLOATP
) (Lisp_Object
);
556 INLINE
bool functionp (Lisp_Object
);
557 INLINE
bool (INTEGERP
) (Lisp_Object
);
558 INLINE
bool (MARKERP
) (Lisp_Object
);
559 INLINE
bool (MISCP
) (Lisp_Object
);
560 INLINE
bool (NILP
) (Lisp_Object
);
561 INLINE
bool OVERLAYP (Lisp_Object
);
562 INLINE
bool PROCESSP (Lisp_Object
);
563 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
564 INLINE
bool SAVE_VALUEP (Lisp_Object
);
565 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
567 INLINE
bool STRINGP (Lisp_Object
);
568 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
569 INLINE
bool SUBRP (Lisp_Object
);
570 INLINE
bool (SYMBOLP
) (Lisp_Object
);
571 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
572 INLINE
bool WINDOWP (Lisp_Object
);
573 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
575 /* Defined in chartab.c. */
576 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
577 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
578 extern int char_table_translate (Lisp_Object
, int);
580 /* Defined in data.c. */
581 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
582 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
583 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
584 extern Lisp_Object Qbool_vector_p
;
585 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
586 extern Lisp_Object Qwindow
;
587 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
589 /* Defined in emacs.c. */
590 extern bool might_dump
;
591 /* True means Emacs has already been initialized.
592 Used during startup to detect startup of dumped Emacs. */
593 extern bool initialized
;
595 /* Defined in eval.c. */
596 extern Lisp_Object Qautoload
;
598 /* Defined in floatfns.c. */
599 extern double extract_float (Lisp_Object
);
601 /* Defined in process.c. */
602 extern Lisp_Object Qprocessp
;
604 /* Defined in window.c. */
605 extern Lisp_Object Qwindowp
;
607 /* Defined in xdisp.c. */
608 extern Lisp_Object Qimage
;
610 /* Extract A's type. */
611 INLINE
enum Lisp_Type
612 XTYPE (Lisp_Object o
)
616 else if (SYMBOLP (o
))
620 else if (STRINGP (o
))
622 else if (VECTORLIKEP (o
))
623 return Lisp_Vectorlike
;
632 /* Extract a value or address from a Lisp_Object. */
634 INLINE
struct Lisp_Vector
*
635 XVECTOR (Lisp_Object a
)
637 eassert (VECTORLIKEP (a
));
641 INLINE
struct Lisp_String
*
642 XSTRING (Lisp_Object a
)
644 eassert (STRINGP (a
));
648 extern void initialize_symbol (Lisp_Object
, Lisp_Object
);
649 INLINE Lisp_Object
build_string (const char *);
650 extern Lisp_Object symbol_module
;
651 extern Lisp_Object function_module
;
652 extern Lisp_Object plist_module
;
653 extern Lisp_Object Qt
, Qnil
, Qt_
, Qnil_
;
655 INLINE
struct Lisp_Symbol
*
656 XSYMBOL (Lisp_Object a
)
659 if (EQ (a
, Qt
)) a
= Qt_
;
660 if (EQ (a
, Qnil
)) a
= Qnil_
;
661 eassert (SYMBOLP (a
));
662 tem
= scm_variable_ref (scm_module_lookup (symbol_module
, a
));
663 return scm_to_pointer (tem
);
666 /* Pseudovector types. */
668 INLINE
struct Lisp_Process
*
669 XPROCESS (Lisp_Object a
)
671 eassert (PROCESSP (a
));
675 INLINE
struct window
*
676 XWINDOW (Lisp_Object a
)
678 eassert (WINDOWP (a
));
682 INLINE
struct terminal
*
683 XTERMINAL (Lisp_Object a
)
688 INLINE
struct Lisp_Subr
*
689 XSUBR (Lisp_Object a
)
695 INLINE
struct buffer
*
696 XBUFFER (Lisp_Object a
)
698 eassert (BUFFERP (a
));
702 INLINE
struct Lisp_Char_Table
*
703 XCHAR_TABLE (Lisp_Object a
)
705 eassert (CHAR_TABLE_P (a
));
709 INLINE
struct Lisp_Sub_Char_Table
*
710 XSUB_CHAR_TABLE (Lisp_Object a
)
712 eassert (SUB_CHAR_TABLE_P (a
));
716 INLINE
struct Lisp_Bool_Vector
*
717 XBOOL_VECTOR (Lisp_Object a
)
719 eassert (BOOL_VECTOR_P (a
));
724 make_lisp_proc (struct Lisp_Process
*p
)
726 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
729 #define XSETINT(a, b) ((a) = make_number (b))
730 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
731 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
732 #define XSETSTRING(a, b) ((a) = (b)->self)
733 #define XSETSYMBOL(a, b) ((a) = (b)->self)
734 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
736 /* Pseudovector types. */
738 #define XSETPVECTYPE(v, code) \
739 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
740 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
741 ((v)->header.size = (PSEUDOVECTOR_FLAG \
742 | ((code) << PSEUDOVECTOR_AREA_BITS) \
743 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
746 /* The cast to struct vectorlike_header * avoids aliasing issues. */
747 #define XSETPSEUDOVECTOR(a, b, code) \
748 XSETTYPED_PSEUDOVECTOR (a, b, \
749 (((struct vectorlike_header *) \
753 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
754 (XSETVECTOR (a, b), \
755 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
756 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
758 #define XSETWINDOW_CONFIGURATION(a, b) \
759 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
760 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
761 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
762 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
763 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
764 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
765 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
766 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
767 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
768 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
772 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
773 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
776 /* Deprecated and will be removed soon. */
778 #define INTERNAL_FIELD(field) field ## _
780 /* See the macros in intervals.h. */
782 typedef struct interval
*INTERVAL
;
784 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
785 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
787 /* Use these to set the fields of a cons cell.
789 Note that both arguments may refer to the same object, so 'n'
790 should not be read after 'c' is first modified. */
792 XSETCAR (Lisp_Object c
, Lisp_Object n
)
794 scm_set_car_x (c
, n
);
797 XSETCDR (Lisp_Object c
, Lisp_Object n
)
799 scm_set_cdr_x (c
, n
);
802 /* Take the car or cdr of something whose type is not known. */
806 return (CONSP (c
) ? XCAR (c
)
808 : wrong_type_argument (Qlistp
, c
));
813 return (CONSP (c
) ? XCDR (c
)
815 : wrong_type_argument (Qlistp
, c
));
818 /* Take the car or cdr of something whose type is not known. */
820 CAR_SAFE (Lisp_Object c
)
822 return CONSP (c
) ? XCAR (c
) : Qnil
;
825 CDR_SAFE (Lisp_Object c
)
827 return CONSP (c
) ? XCDR (c
) : Qnil
;
830 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
837 INTERVAL intervals
; /* Text properties in this string. */
841 /* True if STR is a multibyte string. */
843 STRING_MULTIBYTE (Lisp_Object str
)
845 return 0 <= XSTRING (str
)->size_byte
;
848 /* An upper bound on the number of bytes in a Lisp string, not
849 counting the terminating null. This a tight enough bound to
850 prevent integer overflow errors that would otherwise occur during
851 string size calculations. A string cannot contain more bytes than
852 a fixnum can represent, nor can it be so long that C pointer
853 arithmetic stops working on the string plus its terminating null.
854 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
855 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
856 would expose alloc.c internal details that we'd rather keep
859 This is a macro for use in static initializers. The cast to
860 ptrdiff_t ensures that the macro is signed. */
861 #define STRING_BYTES_BOUND \
862 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
864 /* Mark STR as a unibyte string. */
865 #define STRING_SET_UNIBYTE(STR) \
867 if (EQ (STR, empty_multibyte_string)) \
868 (STR) = empty_unibyte_string; \
870 XSTRING (STR)->size_byte = -1; \
873 /* Mark STR as a multibyte string. Assure that STR contains only
874 ASCII characters in advance. */
875 #define STRING_SET_MULTIBYTE(STR) \
877 if (EQ (STR, empty_unibyte_string)) \
878 (STR) = empty_multibyte_string; \
880 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
883 /* Convenience functions for dealing with Lisp strings. */
885 INLINE
unsigned char *
886 SDATA (Lisp_Object string
)
888 return XSTRING (string
)->data
;
891 SSDATA (Lisp_Object string
)
893 /* Avoid "differ in sign" warnings. */
894 return (char *) SDATA (string
);
897 SREF (Lisp_Object string
, ptrdiff_t index
)
899 return SDATA (string
)[index
];
902 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
904 SDATA (string
)[index
] = new;
907 SCHARS (Lisp_Object string
)
909 return XSTRING (string
)->size
;
913 STRING_BYTES (struct Lisp_String
*s
)
915 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
919 SBYTES (Lisp_Object string
)
921 return STRING_BYTES (XSTRING (string
));
924 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
926 XSTRING (string
)->size
= newsize
;
929 /* Header of vector-like objects. This documents the layout constraints on
930 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
931 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
932 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
933 because when two such pointers potentially alias, a compiler won't
934 incorrectly reorder loads and stores to their size fields. See
936 struct vectorlike_header
940 /* This field contains various pieces of information:
941 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
942 vector (0) or a pseudovector (1).
943 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
944 of slots) of the vector.
945 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
946 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
947 - b) number of Lisp_Objects slots at the beginning of the object
948 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
950 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
951 measured in word_size units. Rest fields may also include
952 Lisp_Objects, but these objects usually needs some special treatment
954 There are some exceptions. For PVEC_FREE, b) is always zero. For
955 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
956 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
957 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
961 /* A regular vector is just a header plus an array of Lisp_Objects. */
965 struct vectorlike_header header
;
966 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
969 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
972 ALIGNOF_STRUCT_LISP_VECTOR
973 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
976 /* A boolvector is a kind of vectorlike, with contents like a string. */
978 struct Lisp_Bool_Vector
980 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
981 just the subtype information. */
982 struct vectorlike_header header
;
983 /* This is the size in bits. */
985 /* The actual bits, packed into bytes.
986 Zeros fill out the last word if needed.
987 The bits are in little-endian order in the bytes, and
988 the bytes are in little-endian order in the words. */
989 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
993 bool_vector_size (Lisp_Object a
)
995 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1001 bool_vector_data (Lisp_Object a
)
1003 return XBOOL_VECTOR (a
)->data
;
1006 INLINE
unsigned char *
1007 bool_vector_uchar_data (Lisp_Object a
)
1009 return (unsigned char *) bool_vector_data (a
);
1012 /* The number of data words and bytes in a bool vector with SIZE bits. */
1015 bool_vector_words (EMACS_INT size
)
1017 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1018 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1022 bool_vector_bytes (EMACS_INT size
)
1024 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1025 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1028 /* True if A's Ith bit is set. */
1031 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1033 eassume (0 <= i
&& i
< bool_vector_size (a
));
1034 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1035 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1039 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1041 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1044 /* Set A's Ith bit to B. */
1047 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1049 unsigned char *addr
;
1051 eassume (0 <= i
&& i
< bool_vector_size (a
));
1052 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1055 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1057 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1060 /* Some handy constants for calculating sizes
1061 and offsets, mostly of vectorlike objects. */
1065 header_size
= offsetof (struct Lisp_Vector
, contents
),
1066 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1067 word_size
= sizeof (Lisp_Object
)
1070 /* Conveniences for dealing with Lisp arrays. */
1073 AREF (Lisp_Object array
, ptrdiff_t idx
)
1075 return XVECTOR (array
)->contents
[idx
];
1078 INLINE Lisp_Object
*
1079 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1081 return & XVECTOR (array
)->contents
[idx
];
1085 ASIZE (Lisp_Object array
)
1087 return XVECTOR (array
)->header
.size
;
1091 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1093 eassert (0 <= idx
&& idx
< ASIZE (array
));
1094 XVECTOR (array
)->contents
[idx
] = val
;
1098 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1100 /* Like ASET, but also can be used in the garbage collector:
1101 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1102 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1103 XVECTOR (array
)->contents
[idx
] = val
;
1106 /* If a struct is made to look like a vector, this macro returns the length
1107 of the shortest vector that would hold that struct. */
1109 #define VECSIZE(type) \
1110 ((sizeof (type) - header_size + word_size - 1) / word_size)
1112 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1113 at the end and we need to compute the number of Lisp_Object fields (the
1114 ones that the GC needs to trace). */
1116 #define PSEUDOVECSIZE(type, nonlispfield) \
1117 ((offsetof (type, nonlispfield) - header_size) / word_size)
1119 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1120 should be integer expressions. This is not the same as
1121 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1122 returns true. For efficiency, prefer plain unsigned comparison if A
1123 and B's sizes both fit (after integer promotion). */
1124 #define UNSIGNED_CMP(a, op, b) \
1125 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1126 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1127 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1129 /* True iff C is an ASCII character. */
1130 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1132 /* A char-table is a kind of vectorlike, with contents are like a
1133 vector but with a few other slots. For some purposes, it makes
1134 sense to handle a char-table with type struct Lisp_Vector. An
1135 element of a char table can be any Lisp objects, but if it is a sub
1136 char-table, we treat it a table that contains information of a
1137 specific range of characters. A sub char-table has the same
1138 structure as a vector. A sub char table appears only in an element
1139 of a char-table, and there's no way to access it directly from
1140 Emacs Lisp program. */
1142 enum CHARTAB_SIZE_BITS
1144 CHARTAB_SIZE_BITS_0
= 6,
1145 CHARTAB_SIZE_BITS_1
= 4,
1146 CHARTAB_SIZE_BITS_2
= 5,
1147 CHARTAB_SIZE_BITS_3
= 7
1150 extern const int chartab_size
[4];
1152 struct Lisp_Char_Table
1154 /* HEADER.SIZE is the vector's size field, which also holds the
1155 pseudovector type information. It holds the size, too.
1156 The size counts the defalt, parent, purpose, ascii,
1157 contents, and extras slots. */
1158 struct vectorlike_header header
;
1160 /* This holds a default value,
1161 which is used whenever the value for a specific character is nil. */
1164 /* This points to another char table, which we inherit from when the
1165 value for a specific character is nil. The `defalt' slot takes
1166 precedence over this. */
1169 /* This is a symbol which says what kind of use this char-table is
1171 Lisp_Object purpose
;
1173 /* The bottom sub char-table for characters of the range 0..127. It
1174 is nil if none of ASCII character has a specific value. */
1177 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1179 /* These hold additional data. It is a vector. */
1180 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1183 struct Lisp_Sub_Char_Table
1185 /* HEADER.SIZE is the vector's size field, which also holds the
1186 pseudovector type information. It holds the size, too. */
1187 struct vectorlike_header header
;
1189 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1190 char-table of depth 1 contains 16 elements, and each element
1191 covers 4096 (128*32) characters. A sub char-table of depth 2
1192 contains 32 elements, and each element covers 128 characters. A
1193 sub char-table of depth 3 contains 128 elements, and each element
1194 is for one character. */
1197 /* Minimum character covered by the sub char-table. */
1198 Lisp_Object min_char
;
1200 /* Use set_sub_char_table_contents to set this. */
1201 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1205 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1207 struct Lisp_Char_Table
*tbl
= NULL
;
1211 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1212 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1213 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1217 while (NILP (val
) && ! NILP (tbl
->parent
));
1222 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1223 characters. Do not check validity of CT. */
1225 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1227 return (ASCII_CHAR_P (idx
)
1228 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1229 : char_table_ref (ct
, idx
));
1232 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1233 8-bit European characters. Do not check validity of CT. */
1235 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1237 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1238 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1240 char_table_set (ct
, idx
, val
);
1243 /* This structure describes a built-in function.
1244 It is generated by the DEFUN macro only.
1245 defsubr makes it into a Lisp object. */
1249 struct vectorlike_header header
;
1251 Lisp_Object (*a0
) (void);
1252 Lisp_Object (*a1
) (Lisp_Object
);
1253 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1254 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1255 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1256 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1257 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1258 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1259 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1260 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1261 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1263 short min_args
, max_args
;
1264 const char *symbol_name
;
1265 const char *intspec
;
1269 /* This is the number of slots that every char table must have. This
1270 counts the ordinary slots and the top, defalt, parent, and purpose
1272 enum CHAR_TABLE_STANDARD_SLOTS
1274 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1277 /* Return the number of "extra" slots in the char table CT. */
1280 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1282 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1283 - CHAR_TABLE_STANDARD_SLOTS
);
1287 /***********************************************************************
1289 ***********************************************************************/
1291 enum symbol_redirect
1293 SYMBOL_PLAINVAL
= 4,
1294 SYMBOL_VARALIAS
= 1,
1295 SYMBOL_LOCALIZED
= 2,
1296 SYMBOL_FORWARDED
= 3
1303 /* Indicates where the value can be found:
1304 0 : it's a plain var, the value is in the `value' field.
1305 1 : it's a varalias, the value is really in the `alias' symbol.
1306 2 : it's a localized var, the value is in the `blv' object.
1307 3 : it's a forwarding variable, the value is in `forward'. */
1308 ENUM_BF (symbol_redirect
) redirect
: 3;
1310 /* Non-zero means symbol is constant, i.e. changing its value
1311 should signal an error. If the value is 3, then the var
1312 can be changed, but only by `defconst'. */
1313 unsigned constant
: 2;
1315 /* True means that this variable has been explicitly declared
1316 special (with `defvar' etc), and shouldn't be lexically bound. */
1317 bool_bf declared_special
: 1;
1319 /* True if pointed to from purespace and hence can't be GC'd. */
1322 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1323 union is used depends on the `redirect' field above. */
1326 struct Lisp_Symbol
*alias
;
1327 struct Lisp_Buffer_Local_Value
*blv
;
1328 union Lisp_Fwd
*fwd
;
1332 /* Value is name of symbol. */
1334 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1336 INLINE
struct Lisp_Symbol
*
1337 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1339 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1340 return sym
->val
.alias
;
1342 INLINE
struct Lisp_Buffer_Local_Value
*
1343 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1345 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1346 return sym
->val
.blv
;
1348 INLINE
union Lisp_Fwd
*
1349 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1351 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1352 return sym
->val
.fwd
;
1355 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1356 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1359 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1361 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1365 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1367 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1371 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1373 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1378 SYMBOL_NAME (Lisp_Object sym
)
1380 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1381 if (EQ (sym
, Qt
)) sym
= Qt_
;
1382 return build_string (scm_to_locale_string (scm_symbol_to_string (sym
)));
1385 /* Value is true if SYM is an interned symbol. */
1388 SYMBOL_INTERNED_P (Lisp_Object sym
)
1390 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1391 if (EQ (sym
, Qt
)) sym
= Qt_
;
1392 return scm_is_true (scm_symbol_interned_p (sym
));
1396 SYMBOL_FUNCTION (Lisp_Object sym
)
1398 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1399 if (EQ (sym
, Qt
)) sym
= Qt_
;
1400 return scm_variable_ref (scm_module_lookup (function_module
, sym
));
1403 /* Value is non-zero if symbol is considered a constant, i.e. its
1404 value cannot be changed (there is an exception for keyword symbols,
1405 whose value can be set to the keyword symbol itself). */
1407 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1409 #define DEFSYM(sym, name) \
1410 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1413 /***********************************************************************
1415 ***********************************************************************/
1417 /* The structure of a Lisp hash table. */
1419 struct hash_table_test
1421 /* Name of the function used to compare keys. */
1424 /* User-supplied hash function, or nil. */
1425 Lisp_Object user_hash_function
;
1427 /* User-supplied key comparison function, or nil. */
1428 Lisp_Object user_cmp_function
;
1430 /* C function to compare two keys. */
1431 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1433 /* C function to compute hash code. */
1434 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1437 struct Lisp_Hash_Table
1439 /* This is for Lisp; the hash table code does not refer to it. */
1440 struct vectorlike_header header
;
1442 /* Nil if table is non-weak. Otherwise a symbol describing the
1443 weakness of the table. */
1446 /* When the table is resized, and this is an integer, compute the
1447 new size by adding this to the old size. If a float, compute the
1448 new size by multiplying the old size with this factor. */
1449 Lisp_Object rehash_size
;
1451 /* Resize hash table when number of entries/ table size is >= this
1453 Lisp_Object rehash_threshold
;
1455 /* Vector of hash codes. If hash[I] is nil, this means that the
1456 I-th entry is unused. */
1459 /* Vector used to chain entries. If entry I is free, next[I] is the
1460 entry number of the next free item. If entry I is non-free,
1461 next[I] is the index of the next entry in the collision chain. */
1464 /* Index of first free entry in free list. */
1465 Lisp_Object next_free
;
1467 /* Bucket vector. A non-nil entry is the index of the first item in
1468 a collision chain. This vector's size can be larger than the
1469 hash table size to reduce collisions. */
1472 /* Only the fields above are traced normally by the GC. The ones below
1473 `count' are special and are either ignored by the GC or traced in
1474 a special way (e.g. because of weakness). */
1476 /* Number of key/value entries in the table. */
1479 /* Vector of keys and values. The key of item I is found at index
1480 2 * I, the value is found at index 2 * I + 1.
1481 This is gc_marked specially if the table is weak. */
1482 Lisp_Object key_and_value
;
1484 /* The comparison and hash functions. */
1485 struct hash_table_test test
;
1487 /* Next weak hash table if this is a weak hash table. The head
1488 of the list is in weak_hash_tables. */
1489 struct Lisp_Hash_Table
*next_weak
;
1493 INLINE
struct Lisp_Hash_Table
*
1494 XHASH_TABLE (Lisp_Object a
)
1496 return SMOB_PTR (a
);
1499 #define XSET_HASH_TABLE(VAR, PTR) \
1500 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1503 HASH_TABLE_P (Lisp_Object a
)
1505 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1508 /* Value is the key part of entry IDX in hash table H. */
1510 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1512 return AREF (h
->key_and_value
, 2 * idx
);
1515 /* Value is the value part of entry IDX in hash table H. */
1517 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1519 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1522 /* Value is the index of the next entry following the one at IDX
1525 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1527 return AREF (h
->next
, idx
);
1530 /* Value is the hash code computed for entry IDX in hash table H. */
1532 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1534 return AREF (h
->hash
, idx
);
1537 /* Value is the index of the element in hash table H that is the
1538 start of the collision list at index IDX in the index vector of H. */
1540 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1542 return AREF (h
->index
, idx
);
1545 /* Value is the size of hash table H. */
1547 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1549 return ASIZE (h
->next
);
1552 /* Default size for hash tables if not specified. */
1554 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1556 /* Default threshold specifying when to resize a hash table. The
1557 value gives the ratio of current entries in the hash table and the
1558 size of the hash table. */
1560 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1562 /* Default factor by which to increase the size of a hash table. */
1564 static double const DEFAULT_REHASH_SIZE
= 1.5;
1566 /* Combine two integers X and Y for hashing. The result might not fit
1567 into a Lisp integer. */
1570 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1572 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1575 /* Hash X, returning a value that fits into a fixnum. */
1578 SXHASH_REDUCE (EMACS_UINT x
)
1580 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1583 /* These structures are used for various misc types. */
1585 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1588 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1594 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1595 /* This flag is temporarily used in the functions
1596 decode/encode_coding_object to record that the marker position
1597 must be adjusted after the conversion. */
1598 bool_bf need_adjustment
: 1;
1599 /* True means normal insertion at the marker's position
1600 leaves the marker after the inserted text. */
1601 bool_bf insertion_type
: 1;
1602 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1603 Note: a chain of markers can contain markers pointing into different
1604 buffers (the chain is per buffer_text rather than per buffer, so it's
1605 shared between indirect buffers). */
1606 /* This is used for (other than NULL-checking):
1608 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1609 - unchain_marker: to find the list from which to unchain.
1610 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1612 struct buffer
*buffer
;
1614 /* The remaining fields are meaningless in a marker that
1615 does not point anywhere. */
1617 /* For markers that point somewhere,
1618 this is used to chain of all the markers in a given buffer. */
1619 /* We could remove it and use an array in buffer_text instead.
1620 That would also allow to preserve it ordered. */
1621 struct Lisp_Marker
*next
;
1622 /* This is the char position where the marker points. */
1624 /* This is the byte position.
1625 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1626 used to implement the functionality of markers, but rather to (ab)use
1627 markers as a cache for char<->byte mappings). */
1631 /* START and END are markers in the overlay's buffer, and
1632 PLIST is the overlay's property list. */
1634 /* An overlay's real data content is:
1636 - buffer (really there are two buffer pointers, one per marker,
1637 and both points to the same buffer)
1638 - insertion type of both ends (per-marker fields)
1639 - start & start byte (of start marker)
1640 - end & end byte (of end marker)
1641 - next (singly linked list of overlays)
1642 - next fields of start and end markers (singly linked list of markers).
1643 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1647 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1648 struct Lisp_Overlay
*next
;
1654 /* Types of data which may be saved in a Lisp_Save_Value. */
1665 /* Number of bits needed to store one of the above values. */
1666 enum { SAVE_SLOT_BITS
= 3 };
1668 /* Number of slots in a save value where save_type is nonzero. */
1669 enum { SAVE_VALUE_SLOTS
= 4 };
1671 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1673 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1677 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1678 SAVE_TYPE_INT_INT_INT
1679 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1680 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1681 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1682 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1683 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1684 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1685 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1686 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1687 SAVE_TYPE_FUNCPTR_PTR_OBJ
1688 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1690 /* This has an extra bit indicating it's raw memory. */
1691 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1694 /* Special object used to hold a different values for later use.
1696 This is mostly used to package C integers and pointers to call
1697 record_unwind_protect when two or more values need to be saved.
1701 struct my_data *md = get_my_data ();
1702 ptrdiff_t mi = get_my_integer ();
1703 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1706 Lisp_Object my_unwind (Lisp_Object arg)
1708 struct my_data *md = XSAVE_POINTER (arg, 0);
1709 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1713 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1714 saved objects and raise eassert if type of the saved object doesn't match
1715 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1716 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1717 slot 0 is a pointer. */
1719 typedef void (*voidfuncptr
) (void);
1721 struct Lisp_Save_Value
1724 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1725 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1727 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1728 V's data entries are determined by V->save_type. E.g., if
1729 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1730 V->data[1] is an integer, and V's other data entries are unused.
1732 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1733 a memory area containing V->data[1].integer potential Lisp_Objects. */
1734 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1737 voidfuncptr funcpointer
;
1740 } data
[SAVE_VALUE_SLOTS
];
1743 /* Return the type of V's Nth saved value. */
1745 save_type (struct Lisp_Save_Value
*v
, int n
)
1747 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1748 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1751 /* Get and set the Nth saved pointer. */
1754 XSAVE_POINTER (Lisp_Object obj
, int n
)
1756 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1757 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1760 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1762 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1763 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1766 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1768 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1769 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1772 /* Likewise for the saved integer. */
1775 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1777 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1778 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1781 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1783 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1784 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1787 /* Extract Nth saved object. */
1790 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1792 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1793 return XSAVE_VALUE (obj
)->data
[n
].object
;
1796 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1797 It uses one of these struct subtypes to get the type field. */
1801 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1802 struct Lisp_Marker u_marker
;
1803 struct Lisp_Overlay u_overlay
;
1804 struct Lisp_Save_Value u_save_value
;
1807 INLINE
union Lisp_Misc
*
1808 XMISC (Lisp_Object a
)
1810 return SMOB_PTR (a
);
1813 INLINE
struct Lisp_Misc_Any
*
1814 XMISCANY (Lisp_Object a
)
1816 eassert (MISCP (a
));
1817 return & XMISC (a
)->u_any
;
1820 INLINE
enum Lisp_Misc_Type
1821 XMISCTYPE (Lisp_Object a
)
1823 return XMISCANY (a
)->type
;
1826 INLINE
struct Lisp_Marker
*
1827 XMARKER (Lisp_Object a
)
1829 eassert (MARKERP (a
));
1830 return & XMISC (a
)->u_marker
;
1833 INLINE
struct Lisp_Overlay
*
1834 XOVERLAY (Lisp_Object a
)
1836 eassert (OVERLAYP (a
));
1837 return & XMISC (a
)->u_overlay
;
1840 INLINE
struct Lisp_Save_Value
*
1841 XSAVE_VALUE (Lisp_Object a
)
1843 eassert (SAVE_VALUEP (a
));
1844 return & XMISC (a
)->u_save_value
;
1847 /* Forwarding pointer to an int variable.
1848 This is allowed only in the value cell of a symbol,
1849 and it means that the symbol's value really lives in the
1850 specified int variable. */
1853 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1857 /* Boolean forwarding pointer to an int variable.
1858 This is like Lisp_Intfwd except that the ostensible
1859 "value" of the symbol is t if the bool variable is true,
1860 nil if it is false. */
1863 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1867 /* Forwarding pointer to a Lisp_Object variable.
1868 This is allowed only in the value cell of a symbol,
1869 and it means that the symbol's value really lives in the
1870 specified variable. */
1873 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1874 Lisp_Object
*objvar
;
1877 /* Like Lisp_Objfwd except that value lives in a slot in the
1878 current buffer. Value is byte index of slot within buffer. */
1879 struct Lisp_Buffer_Objfwd
1881 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1883 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1884 Lisp_Object predicate
;
1887 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1888 the symbol has buffer-local or frame-local bindings. (Exception:
1889 some buffer-local variables are built-in, with their values stored
1890 in the buffer structure itself. They are handled differently,
1891 using struct Lisp_Buffer_Objfwd.)
1893 The `realvalue' slot holds the variable's current value, or a
1894 forwarding pointer to where that value is kept. This value is the
1895 one that corresponds to the loaded binding. To read or set the
1896 variable, you must first make sure the right binding is loaded;
1897 then you can access the value in (or through) `realvalue'.
1899 `buffer' and `frame' are the buffer and frame for which the loaded
1900 binding was found. If those have changed, to make sure the right
1901 binding is loaded it is necessary to find which binding goes with
1902 the current buffer and selected frame, then load it. To load it,
1903 first unload the previous binding, then copy the value of the new
1904 binding into `realvalue' (or through it). Also update
1905 LOADED-BINDING to point to the newly loaded binding.
1907 `local_if_set' indicates that merely setting the variable creates a
1908 local binding for the current buffer. Otherwise the latter, setting
1909 the variable does not do that; only make-local-variable does that. */
1911 struct Lisp_Buffer_Local_Value
1913 /* True means that merely setting the variable creates a local
1914 binding for the current buffer. */
1915 bool_bf local_if_set
: 1;
1916 /* True means this variable can have frame-local bindings, otherwise, it is
1917 can have buffer-local bindings. The two cannot be combined. */
1918 bool_bf frame_local
: 1;
1919 /* True means that the binding now loaded was found.
1920 Presumably equivalent to (defcell!=valcell). */
1922 /* If non-NULL, a forwarding to the C var where it should also be set. */
1923 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1924 /* The buffer or frame for which the loaded binding was found. */
1926 /* A cons cell that holds the default value. It has the form
1927 (SYMBOL . DEFAULT-VALUE). */
1928 Lisp_Object defcell
;
1929 /* The cons cell from `where's parameter alist.
1930 It always has the form (SYMBOL . VALUE)
1931 Note that if `forward' is non-nil, VALUE may be out of date.
1932 Also if the currently loaded binding is the default binding, then
1933 this is `eq'ual to defcell. */
1934 Lisp_Object valcell
;
1937 /* Like Lisp_Objfwd except that value lives in a slot in the
1939 struct Lisp_Kboard_Objfwd
1941 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1947 struct Lisp_Intfwd u_intfwd
;
1948 struct Lisp_Boolfwd u_boolfwd
;
1949 struct Lisp_Objfwd u_objfwd
;
1950 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1951 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1954 INLINE
enum Lisp_Fwd_Type
1955 XFWDTYPE (union Lisp_Fwd
*a
)
1957 return a
->u_intfwd
.type
;
1960 INLINE
struct Lisp_Buffer_Objfwd
*
1961 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
1963 eassert (BUFFER_OBJFWDP (a
));
1964 return &a
->u_buffer_objfwd
;
1967 #define XFLOAT_DATA(f) (scm_to_double (f))
1969 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1970 representations, have infinities and NaNs, and do not trap on
1971 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1972 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1973 wanted here, but is not quite right because Emacs does not require
1974 all the features of C11 Annex F (and does not require C11 at all,
1975 for that matter). */
1979 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
1980 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
1983 /* A character, declared with the following typedef, is a member
1984 of some character set associated with the current buffer. */
1985 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1987 typedef unsigned char UCHAR
;
1990 /* Meanings of slots in a Lisp_Compiled: */
1994 COMPILED_ARGLIST
= 0,
1995 COMPILED_BYTECODE
= 1,
1996 COMPILED_CONSTANTS
= 2,
1997 COMPILED_STACK_DEPTH
= 3,
1998 COMPILED_DOC_STRING
= 4,
1999 COMPILED_INTERACTIVE
= 5
2002 /* Flag bits in a character. These also get used in termhooks.h.
2003 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2004 (MUlti-Lingual Emacs) might need 22 bits for the character value
2005 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2008 CHAR_ALT
= 0x0400000,
2009 CHAR_SUPER
= 0x0800000,
2010 CHAR_HYPER
= 0x1000000,
2011 CHAR_SHIFT
= 0x2000000,
2012 CHAR_CTL
= 0x4000000,
2013 CHAR_META
= 0x8000000,
2015 CHAR_MODIFIER_MASK
=
2016 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2018 /* Actually, the current Emacs uses 22 bits for the character value
2023 /* Data type checking. */
2025 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2028 NUMBERP (Lisp_Object x
)
2030 return INTEGERP (x
) || FLOATP (x
);
2033 NATNUMP (Lisp_Object x
)
2035 return INTEGERP (x
) && 0 <= XINT (x
);
2039 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2041 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2044 #define TYPE_RANGED_INTEGERP(type, x) \
2046 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2047 && XINT (x) <= TYPE_MAXIMUM (type))
2049 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2050 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2051 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2052 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2053 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2054 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2055 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2058 STRINGP (Lisp_Object x
)
2060 return SMOB_TYPEP (x
, lisp_string_tag
);
2063 VECTORP (Lisp_Object x
)
2065 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2068 OVERLAYP (Lisp_Object x
)
2070 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2073 SAVE_VALUEP (Lisp_Object x
)
2075 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2079 AUTOLOADP (Lisp_Object x
)
2081 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2085 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2087 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2091 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2093 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2094 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2097 /* True if A is a pseudovector whose code is CODE. */
2099 PSEUDOVECTORP (Lisp_Object a
, int code
)
2101 if (! VECTORLIKEP (a
))
2105 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2106 struct vectorlike_header
*h
= SMOB_PTR (a
);
2107 return PSEUDOVECTOR_TYPEP (h
, code
);
2111 /* Test for specific pseudovector types. */
2114 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2116 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2120 PROCESSP (Lisp_Object a
)
2122 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2126 WINDOWP (Lisp_Object a
)
2128 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2132 TERMINALP (Lisp_Object a
)
2134 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2138 SUBRP (Lisp_Object a
)
2140 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2144 COMPILEDP (Lisp_Object a
)
2146 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2150 BUFFERP (Lisp_Object a
)
2152 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2156 CHAR_TABLE_P (Lisp_Object a
)
2158 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2162 SUB_CHAR_TABLE_P (Lisp_Object a
)
2164 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2168 BOOL_VECTOR_P (Lisp_Object a
)
2170 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2174 FRAMEP (Lisp_Object a
)
2176 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2179 /* Test for image (image . spec) */
2181 IMAGEP (Lisp_Object x
)
2183 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2188 ARRAYP (Lisp_Object x
)
2190 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2194 CHECK_LIST (Lisp_Object x
)
2196 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2199 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2200 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2201 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2204 CHECK_STRING (Lisp_Object x
)
2206 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2209 CHECK_STRING_CAR (Lisp_Object x
)
2211 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2214 CHECK_CONS (Lisp_Object x
)
2216 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2219 CHECK_VECTOR (Lisp_Object x
)
2221 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2224 CHECK_BOOL_VECTOR (Lisp_Object x
)
2226 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2229 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2231 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2234 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2236 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2239 CHECK_BUFFER (Lisp_Object x
)
2241 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2244 CHECK_WINDOW (Lisp_Object x
)
2246 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2250 CHECK_PROCESS (Lisp_Object x
)
2252 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2256 CHECK_NATNUM (Lisp_Object x
)
2258 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2261 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2264 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2265 args_out_of_range_3 \
2267 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2268 ? MOST_NEGATIVE_FIXNUM \
2270 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2272 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2274 if (TYPE_SIGNED (type)) \
2275 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2277 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2280 #define CHECK_NUMBER_COERCE_MARKER(x) \
2282 if (MARKERP ((x))) \
2283 XSETFASTINT (x, marker_position (x)); \
2285 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2289 XFLOATINT (Lisp_Object n
)
2291 return extract_float (n
);
2295 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2297 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2300 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2303 XSETFASTINT (x, marker_position (x)); \
2305 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2308 /* Since we can't assign directly to the CAR or CDR fields of a cons
2309 cell, use these when checking that those fields contain numbers. */
2311 CHECK_NUMBER_CAR (Lisp_Object x
)
2313 Lisp_Object tmp
= XCAR (x
);
2319 CHECK_NUMBER_CDR (Lisp_Object x
)
2321 Lisp_Object tmp
= XCDR (x
);
2326 /* Define a built-in function for calling from Lisp.
2327 `lname' should be the name to give the function in Lisp,
2328 as a null-terminated C string.
2329 `fnname' should be the name of the function in C.
2330 By convention, it starts with F.
2331 `sname' should be the name for the C constant structure
2332 that records information on this function for internal use.
2333 By convention, it should be the same as `fnname' but with S instead of F.
2334 It's too bad that C macros can't compute this from `fnname'.
2335 `minargs' should be a number, the minimum number of arguments allowed.
2336 `maxargs' should be a number, the maximum number of arguments allowed,
2337 or else MANY or UNEVALLED.
2338 MANY means pass a vector of evaluated arguments,
2339 in the form of an integer number-of-arguments
2340 followed by the address of a vector of Lisp_Objects
2341 which contains the argument values.
2342 UNEVALLED means pass the list of unevaluated arguments
2343 `intspec' says how interactive arguments are to be fetched.
2344 If the string starts with a `(', `intspec' is evaluated and the resulting
2345 list is the list of arguments.
2346 If it's a string that doesn't start with `(', the value should follow
2347 the one of the doc string for `interactive'.
2348 A null string means call interactively with no arguments.
2349 `doc' is documentation for the user. */
2351 /* This version of DEFUN declares a function prototype with the right
2352 arguments, so we can catch errors with maxargs at compile-time. */
2354 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2355 SCM_SNARF_INIT (defsubr (&sname);) \
2356 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2357 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2359 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2360 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2361 { (Lisp_Object (__cdecl *)(void))fnname }, \
2362 minargs, maxargs, lname, intspec, 0}; \
2364 #else /* not _MSC_VER */
2365 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2366 SCM_SNARF_INIT (defsubr (&sname);) \
2367 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2368 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2370 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2371 { .a ## maxargs = fnname }, \
2372 minargs, maxargs, lname, intspec, 0}; \
2376 /* Note that the weird token-substitution semantics of ANSI C makes
2377 this work for MANY and UNEVALLED. */
2378 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2379 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2380 #define DEFUN_ARGS_0 (void)
2381 #define DEFUN_ARGS_1 (Lisp_Object)
2382 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2383 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2384 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2385 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2387 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2388 Lisp_Object, Lisp_Object)
2389 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2390 Lisp_Object, Lisp_Object, Lisp_Object)
2391 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2392 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2394 /* True if OBJ is a Lisp function. */
2396 FUNCTIONP (Lisp_Object obj
)
2398 return functionp (obj
);
2402 is how we define the symbol for function `name' at start-up time. */
2403 extern void defsubr (struct Lisp_Subr
*);
2411 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2412 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2413 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2414 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2415 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2417 /* Macros we use to define forwarded Lisp variables.
2418 These are used in the syms_of_FILENAME functions.
2420 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2421 lisp variable is actually a field in `struct emacs_globals'. The
2422 field's name begins with "f_", which is a convention enforced by
2423 these macros. Each such global has a corresponding #define in
2424 globals.h; the plain name should be used in the code.
2426 E.g., the global "cons_cells_consed" is declared as "int
2427 f_cons_cells_consed" in globals.h, but there is a define:
2429 #define cons_cells_consed globals.f_cons_cells_consed
2431 All C code uses the `cons_cells_consed' name. This is all done
2432 this way to support indirection for multi-threaded Emacs. */
2434 #define DEFVAR_LISP(lname, vname, doc) \
2436 static struct Lisp_Objfwd o_fwd; \
2437 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2439 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2441 static struct Lisp_Objfwd o_fwd; \
2442 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2444 #define DEFVAR_BOOL(lname, vname, doc) \
2446 static struct Lisp_Boolfwd b_fwd; \
2447 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2449 #define DEFVAR_INT(lname, vname, doc) \
2451 static struct Lisp_Intfwd i_fwd; \
2452 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2455 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2457 static struct Lisp_Objfwd o_fwd; \
2458 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2461 #define DEFVAR_KBOARD(lname, vname, doc) \
2463 static struct Lisp_Kboard_Objfwd ko_fwd; \
2464 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2467 /* Save and restore the instruction and environment pointers,
2468 without affecting the signal mask. */
2471 typedef jmp_buf sys_jmp_buf
;
2472 # define sys_setjmp(j) _setjmp (j)
2473 # define sys_longjmp(j, v) _longjmp (j, v)
2474 #elif defined HAVE_SIGSETJMP
2475 typedef sigjmp_buf sys_jmp_buf
;
2476 # define sys_setjmp(j) sigsetjmp (j, 0)
2477 # define sys_longjmp(j, v) siglongjmp (j, v)
2479 /* A platform that uses neither _longjmp nor siglongjmp; assume
2480 longjmp does not affect the sigmask. */
2481 typedef jmp_buf sys_jmp_buf
;
2482 # define sys_setjmp(j) setjmp (j)
2483 # define sys_longjmp(j, v) longjmp (j, v)
2487 /* Elisp uses several stacks:
2489 - the bytecode stack: used internally by the bytecode interpreter.
2490 Allocated from the C stack.
2491 - The specpdl stack: keeps track of active unwind-protect and
2492 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2494 - The handler stack: keeps track of active catch tags and condition-case
2495 handlers. Allocated in a manually managed stack implemented by a
2496 doubly-linked list allocated via xmalloc and never freed. */
2498 /* Structure for recording Lisp call stack for backtrace purposes. */
2500 /* The special binding stack holds the outer values of variables while
2501 they are bound by a function application or a let form, stores the
2502 code to be executed for unwind-protect forms.
2504 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2505 used all over the place, needs to be fast, and needs to know the size of
2506 union specbinding. But only eval.c should access it. */
2509 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2510 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2511 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2512 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2513 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2518 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2520 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2523 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2524 bool wind_explicitly
;
2525 void (*func
) (Lisp_Object
);
2529 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2530 bool wind_explicitly
;
2531 void (*func
) (void *);
2535 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2536 bool wind_explicitly
;
2541 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2542 bool wind_explicitly
;
2543 void (*func
) (void);
2546 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2547 /* `where' is not used in the case of SPECPDL_LET. */
2548 Lisp_Object symbol
, old_value
, where
;
2551 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2552 bool_bf debug_on_exit
: 1;
2553 Lisp_Object function
;
2559 extern union specbinding
*specpdl
;
2560 extern union specbinding
*specpdl_ptr
;
2561 extern ptrdiff_t specpdl_size
;
2564 SPECPDL_INDEX (void)
2566 return specpdl_ptr
- specpdl
;
2569 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2570 control structures. A struct handler contains all the information needed to
2571 restore the state of the interpreter after a non-local jump.
2573 handler structures are chained together in a doubly linked list; the `next'
2574 member points to the next outer catchtag and the `nextfree' member points in
2575 the other direction to the next inner element (which is typically the next
2576 free element since we mostly use it on the deepest handler).
2578 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2579 member is TAG, and then unbinds to it. The `val' member is used to
2580 hold VAL while the stack is unwound; `val' is returned as the value
2583 All the other members are concerned with restoring the interpreter
2586 Members are volatile if their values need to survive _longjmp when
2587 a 'struct handler' is a local variable. */
2589 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2593 enum handlertype type
;
2595 Lisp_Object tag_or_ch
;
2599 struct handler
*next
;
2600 EMACS_INT lisp_eval_depth
;
2601 int poll_suppress_count
;
2602 int interrupt_input_blocked
;
2605 extern Lisp_Object memory_signal_data
;
2607 /* Check quit-flag and quit if it is non-nil.
2608 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2609 So the program needs to do QUIT at times when it is safe to quit.
2610 Every loop that might run for a long time or might not exit
2611 ought to do QUIT at least once, at a safe place.
2612 Unless that is impossible, of course.
2613 But it is very desirable to avoid creating loops where QUIT is impossible.
2615 Exception: if you set immediate_quit to true,
2616 then the handler that responds to the C-g does the quit itself.
2617 This is a good thing to do around a loop that has no side effects
2618 and (in particular) cannot call arbitrary Lisp code.
2620 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2621 a request to exit Emacs when it is safe to do. */
2623 extern void process_pending_signals (void);
2624 extern bool volatile pending_signals
;
2626 extern void process_quit_flag (void);
2629 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2630 process_quit_flag (); \
2631 else if (pending_signals) \
2632 process_pending_signals (); \
2636 /* True if ought to quit now. */
2638 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2640 extern Lisp_Object Vascii_downcase_table
;
2641 extern Lisp_Object Vascii_canon_table
;
2643 /* Structure for recording stack slots that need marking. */
2645 /* This is a chain of structures, each of which points at a Lisp_Object
2646 variable whose value should be marked in garbage collection.
2647 Normally every link of the chain is an automatic variable of a function,
2648 and its `val' points to some argument or local variable of the function.
2649 On exit to the function, the chain is set back to the value it had on entry.
2650 This way, no link remains in the chain when the stack frame containing the
2653 Every function that can call Feval must protect in this fashion all
2654 Lisp_Object variables whose contents will be used again. */
2656 extern struct gcpro
*gcprolist
;
2662 /* Address of first protected variable. */
2663 volatile Lisp_Object
*var
;
2665 /* Number of consecutive protected variables. */
2673 /* Do something silly with gcproN vars just so gcc shuts up. */
2674 /* You get warnings from MIPSPro... */
2676 #define GCPRO1(varname) ((void) gcpro1)
2677 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2678 #define GCPRO3(varname1, varname2, varname3) \
2679 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2680 #define GCPRO4(varname1, varname2, varname3, varname4) \
2681 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2682 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2683 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2684 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2685 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2687 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2688 #define UNGCPRO ((void) 0)
2690 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2691 #define RETURN_UNGCPRO(expr) \
2694 Lisp_Object ret_ungc_val; \
2695 ret_ungc_val = (expr); \
2697 return ret_ungc_val; \
2701 /* Call staticpro (&var) to protect static variable `var'. */
2703 void staticpro (Lisp_Object
*);
2705 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2706 meaning as in the DEFUN macro, and is used to construct a prototype. */
2707 /* We can use the same trick as in the DEFUN macro to generate the
2708 appropriate prototype. */
2709 #define EXFUN(fnname, maxargs) \
2710 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2712 #include "globals.h"
2714 /* Forward declarations for prototypes. */
2718 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2721 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2723 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2724 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2727 /* Functions to modify hash tables. */
2730 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2732 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2736 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2738 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2741 /* Use these functions to set Lisp_Object
2742 or pointer slots of struct Lisp_Symbol. */
2745 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2747 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2748 if (EQ (sym
, Qt
)) sym
= Qt_
;
2749 scm_variable_set_x (scm_module_lookup (function_module
, sym
), function
);
2753 symbol_plist (Lisp_Object sym
)
2755 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2756 if (EQ (sym
, Qt
)) sym
= Qt_
;
2757 return scm_variable_ref (scm_module_lookup (plist_module
, sym
));
2761 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2763 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2764 if (EQ (sym
, Qt
)) sym
= Qt_
;
2765 scm_variable_set_x (scm_module_lookup (plist_module
, sym
), plist
);
2768 /* Buffer-local (also frame-local) variable access functions. */
2771 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2773 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2777 /* Set overlay's property list. */
2780 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2782 XOVERLAY (overlay
)->plist
= plist
;
2785 /* Get text properties of S. */
2788 string_intervals (Lisp_Object s
)
2790 return XSTRING (s
)->intervals
;
2793 /* Set text properties of S to I. */
2796 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2798 XSTRING (s
)->intervals
= i
;
2801 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2802 of setting slots directly. */
2805 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2807 XCHAR_TABLE (table
)->defalt
= val
;
2810 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2812 XCHAR_TABLE (table
)->purpose
= val
;
2815 /* Set different slots in (sub)character tables. */
2818 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2820 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2821 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2825 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2827 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2828 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2832 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2834 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2837 /* Defined in data.c. */
2838 extern Lisp_Object Qnil_
, Qt_
;
2839 extern Lisp_Object Qquote
, Qunbound
;
2840 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2841 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2842 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2843 extern Lisp_Object Qinvalid_read_syntax
;
2844 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2845 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2846 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2847 extern Lisp_Object Qtext_read_only
;
2848 extern Lisp_Object Qinteractive_form
;
2849 extern Lisp_Object Qcircular_list
;
2850 extern Lisp_Object Qsequencep
;
2851 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2852 extern Lisp_Object Qfboundp
;
2854 extern Lisp_Object Qcdr
;
2856 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2858 extern Lisp_Object Qnumber_or_marker_p
;
2860 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2862 /* Defined in data.c. */
2863 extern Lisp_Object
indirect_function (Lisp_Object
);
2864 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2865 enum Arith_Comparison
{
2870 ARITH_LESS_OR_EQUAL
,
2873 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2874 enum Arith_Comparison comparison
);
2876 /* Convert the integer I to an Emacs representation, either the integer
2877 itself, or a cons of two or three integers, or if all else fails a float.
2878 I should not have side effects. */
2879 #define INTEGER_TO_CONS(i) \
2880 (! FIXNUM_OVERFLOW_P (i) \
2882 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2883 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2884 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2885 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2886 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2887 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2888 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2889 ? Fcons (make_number ((i) >> 16 >> 24), \
2890 Fcons (make_number ((i) >> 16 & 0xffffff), \
2891 make_number ((i) & 0xffff))) \
2894 /* Convert the Emacs representation CONS back to an integer of type
2895 TYPE, storing the result the variable VAR. Signal an error if CONS
2896 is not a valid representation or is out of range for TYPE. */
2897 #define CONS_TO_INTEGER(cons, type, var) \
2898 (TYPE_SIGNED (type) \
2899 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2900 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2901 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2902 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2904 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2905 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2906 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2908 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2909 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2910 extern void syms_of_data (void);
2911 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2913 /* Defined in cmds.c */
2914 extern void syms_of_cmds (void);
2915 extern void keys_of_cmds (void);
2917 /* Defined in coding.c. */
2918 extern Lisp_Object Qcharset
;
2919 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2920 ptrdiff_t, bool, bool, Lisp_Object
);
2921 extern void init_coding (void);
2922 extern void init_coding_once (void);
2923 extern void syms_of_coding (void);
2925 /* Defined in character.c. */
2926 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2927 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2928 extern void syms_of_character (void);
2930 /* Defined in charset.c. */
2931 extern void init_charset (void);
2932 extern void init_charset_once (void);
2933 extern void syms_of_charset (void);
2934 /* Structure forward declarations. */
2937 /* Defined in syntax.c. */
2938 extern void init_syntax_once (void);
2939 extern void syms_of_syntax (void);
2941 /* Defined in fns.c. */
2942 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2943 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2944 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2945 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2946 extern void sweep_weak_hash_tables (void);
2947 extern Lisp_Object Qcursor_in_echo_area
;
2948 extern Lisp_Object Qstring_lessp
;
2949 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2950 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2951 EMACS_UINT
sxhash (Lisp_Object
, int);
2952 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2953 Lisp_Object
, Lisp_Object
);
2954 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2955 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2957 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2958 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2959 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2960 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2961 ptrdiff_t, ptrdiff_t);
2962 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2963 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2964 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2965 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2966 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2967 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2968 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2969 extern void clear_string_char_byte_cache (void);
2970 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2971 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2972 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2973 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2974 extern void init_fns_once (void);
2975 extern void syms_of_fns (void);
2977 /* Defined in floatfns.c. */
2978 extern void syms_of_floatfns (void);
2979 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2981 /* Defined in fringe.c. */
2982 extern void syms_of_fringe (void);
2983 extern void init_fringe (void);
2984 #ifdef HAVE_WINDOW_SYSTEM
2985 extern void mark_fringe_data (void);
2986 extern void init_fringe_once (void);
2987 #endif /* HAVE_WINDOW_SYSTEM */
2989 /* Defined in image.c. */
2990 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2991 extern Lisp_Object QCconversion
;
2992 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2993 extern void reset_image_types (void);
2994 extern void syms_of_image (void);
2996 /* Defined in insdel.c. */
2997 extern Lisp_Object Qinhibit_modification_hooks
;
2998 extern Lisp_Object Qregion_extract_function
;
2999 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3000 extern _Noreturn
void buffer_overflow (void);
3001 extern void make_gap (ptrdiff_t);
3002 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3003 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3004 ptrdiff_t, bool, bool);
3005 extern int count_combining_before (const unsigned char *,
3006 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3007 extern int count_combining_after (const unsigned char *,
3008 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3009 extern void insert (const char *, ptrdiff_t);
3010 extern void insert_and_inherit (const char *, ptrdiff_t);
3011 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3013 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3014 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3015 ptrdiff_t, ptrdiff_t, bool);
3016 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3017 extern void insert_char (int);
3018 extern void insert_string (const char *);
3019 extern void insert_before_markers (const char *, ptrdiff_t);
3020 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3021 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3022 ptrdiff_t, ptrdiff_t,
3024 extern void del_range (ptrdiff_t, ptrdiff_t);
3025 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3026 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3027 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3028 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3029 ptrdiff_t, ptrdiff_t, bool);
3030 extern void modify_text (ptrdiff_t, ptrdiff_t);
3031 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3032 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3033 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3034 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3035 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3036 ptrdiff_t, ptrdiff_t);
3037 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3038 ptrdiff_t, ptrdiff_t);
3039 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3040 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3041 const char *, ptrdiff_t, ptrdiff_t, bool);
3042 extern void syms_of_insdel (void);
3044 /* Defined in dispnew.c. */
3045 #if (defined PROFILING \
3046 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3047 _Noreturn
void __executable_start (void);
3049 extern Lisp_Object Vwindow_system
;
3050 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3052 /* Defined in xdisp.c. */
3053 extern Lisp_Object Qinhibit_point_motion_hooks
;
3054 extern Lisp_Object Qinhibit_redisplay
;
3055 extern Lisp_Object Qmenu_bar_update_hook
;
3056 extern Lisp_Object Qwindow_scroll_functions
;
3057 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3058 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3059 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3060 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3061 extern Lisp_Object Qleft_margin
, Qright_margin
;
3062 extern Lisp_Object QCdata
, QCfile
;
3063 extern Lisp_Object QCmap
;
3064 extern Lisp_Object Qrisky_local_variable
;
3065 extern bool noninteractive_need_newline
;
3066 extern Lisp_Object echo_area_buffer
[2];
3067 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3068 extern void check_message_stack (void);
3069 extern void setup_echo_area_for_printing (int);
3070 extern bool push_message (void);
3071 extern void pop_message_unwind (void);
3072 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3073 extern void restore_message (void);
3074 extern Lisp_Object
current_message (void);
3075 extern void clear_message (bool, bool);
3076 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3077 extern void message1 (const char *);
3078 extern void message1_nolog (const char *);
3079 extern void message3 (Lisp_Object
);
3080 extern void message3_nolog (Lisp_Object
);
3081 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3082 extern void message_with_string (const char *, Lisp_Object
, int);
3083 extern void message_log_maybe_newline (void);
3084 extern void update_echo_area (void);
3085 extern void truncate_echo_area (ptrdiff_t);
3086 extern void redisplay (void);
3088 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3089 extern void syms_of_xdisp (void);
3090 extern void init_xdisp (void);
3091 extern Lisp_Object
safe_eval (Lisp_Object
);
3092 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3093 int *, int *, int *, int *, int *);
3095 /* Defined in xsettings.c. */
3096 extern void syms_of_xsettings (void);
3098 /* Defined in vm-limit.c. */
3099 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3101 /* Defined in alloc.c. */
3102 extern void check_pure_size (void);
3103 extern void free_misc (Lisp_Object
);
3104 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3105 extern void malloc_warning (const char *);
3106 extern _Noreturn
void memory_full (size_t);
3107 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3108 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3109 extern void refill_memory_reserve (void);
3111 extern const char *pending_malloc_warning
;
3112 extern Lisp_Object zero_vector
;
3113 extern Lisp_Object
list1 (Lisp_Object
);
3114 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3115 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3116 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3117 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3119 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3120 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3122 /* Build a frequently used 2/3/4-integer lists. */
3125 list2i (EMACS_INT x
, EMACS_INT y
)
3127 return list2 (make_number (x
), make_number (y
));
3131 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3133 return list3 (make_number (x
), make_number (y
), make_number (w
));
3137 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3139 return list4 (make_number (x
), make_number (y
),
3140 make_number (w
), make_number (h
));
3143 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3144 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3145 extern _Noreturn
void string_overflow (void);
3146 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3147 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3148 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3149 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3151 /* Make unibyte string from C string when the length isn't known. */
3154 build_unibyte_string (const char *str
)
3156 return make_unibyte_string (str
, strlen (str
));
3159 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3160 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3161 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3162 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3163 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3164 extern Lisp_Object
make_specified_string (const char *,
3165 ptrdiff_t, ptrdiff_t, bool);
3166 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3167 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3169 /* Make a string allocated in pure space, use STR as string data. */
3172 build_pure_c_string (const char *str
)
3174 return make_pure_c_string (str
, strlen (str
));
3177 /* Make a string from the data at STR, treating it as multibyte if the
3181 build_string (const char *str
)
3183 return make_string (str
, strlen (str
));
3186 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3187 extern void make_byte_code (struct Lisp_Vector
*);
3188 extern Lisp_Object Qchar_table_extra_slots
;
3189 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3191 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3192 be sure that GC cannot happen until the vector is completely
3193 initialized. E.g. the following code is likely to crash:
3195 v = make_uninit_vector (3);
3197 ASET (v, 1, Ffunction_can_gc ());
3198 ASET (v, 2, obj1); */
3201 make_uninit_vector (ptrdiff_t size
)
3204 struct Lisp_Vector
*p
;
3206 p
= allocate_vector (size
);
3211 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3212 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3214 allocate_pseudovector \
3215 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3216 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3217 extern struct window
*allocate_window (void);
3218 extern struct frame
*allocate_frame (void);
3219 extern struct Lisp_Process
*allocate_process (void);
3220 extern struct terminal
*allocate_terminal (void);
3221 extern Lisp_Object
make_float (double);
3222 extern void display_malloc_warning (void);
3223 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3224 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3225 Lisp_Object
, Lisp_Object
);
3226 extern Lisp_Object
make_save_ptr (void *);
3227 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3228 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3229 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3231 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3232 extern void free_save_value (Lisp_Object
);
3233 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3234 extern void init_alloc_once (void);
3235 extern void init_alloc (void);
3236 extern void syms_of_alloc (void);
3237 extern struct buffer
* allocate_buffer (void);
3238 extern int valid_lisp_object_p (Lisp_Object
);
3239 extern int relocatable_string_data_p (const char *);
3242 /* Defined in ralloc.c. */
3243 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3244 extern void r_alloc_free (void **);
3245 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3246 extern void r_alloc_reset_variable (void **, void **);
3247 extern void r_alloc_inhibit_buffer_relocation (int);
3250 /* Defined in chartab.c. */
3251 extern Lisp_Object
copy_char_table (Lisp_Object
);
3252 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3254 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3255 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3257 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3258 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3259 Lisp_Object
, Lisp_Object
,
3260 Lisp_Object
, struct charset
*,
3261 unsigned, unsigned);
3262 extern Lisp_Object
uniprop_table (Lisp_Object
);
3263 extern void syms_of_chartab (void);
3265 /* Defined in print.c. */
3266 extern Lisp_Object Vprin1_to_string_buffer
;
3267 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3268 extern Lisp_Object Qstandard_output
;
3269 extern Lisp_Object Qexternal_debugging_output
;
3270 extern void temp_output_buffer_setup (const char *);
3271 extern int print_level
;
3272 extern Lisp_Object Qprint_escape_newlines
;
3273 extern void write_string (const char *, int);
3274 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3276 extern Lisp_Object internal_with_output_to_temp_buffer
3277 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3278 #define FLOAT_TO_STRING_BUFSIZE 350
3279 extern int float_to_string (char *, double);
3280 extern void init_print_once (void);
3281 extern void syms_of_print (void);
3283 /* Defined in doprnt.c. */
3284 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3286 extern ptrdiff_t esprintf (char *, char const *, ...)
3287 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3288 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3290 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3291 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3292 char const *, va_list)
3293 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3295 /* Defined in lread.c. */
3296 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3297 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3298 extern Lisp_Object Qlexical_binding
;
3299 extern Lisp_Object
check_obarray (Lisp_Object
);
3300 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3301 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3302 extern Lisp_Object
obhash (Lisp_Object
);
3303 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3305 LOADHIST_ATTACH (Lisp_Object x
)
3308 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3310 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3311 Lisp_Object
*, Lisp_Object
, bool);
3312 extern Lisp_Object
string_to_number (char const *, int, bool);
3313 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3315 extern void dir_warning (const char *, Lisp_Object
);
3316 extern void init_obarray (void);
3317 extern void init_lread (void);
3318 extern void syms_of_lread (void);
3321 intern (const char *str
)
3323 return intern_1 (str
, strlen (str
));
3327 intern_c_string (const char *str
)
3329 return intern_c_string_1 (str
, strlen (str
));
3332 /* Defined in eval.c. */
3333 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3334 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3335 extern Lisp_Object Qand_rest
;
3336 extern Lisp_Object Vautoload_queue
;
3337 extern Lisp_Object Vsignaling_function
;
3338 extern Lisp_Object inhibit_lisp_code
;
3339 extern struct handler
*handlerlist
;
3341 /* To run a normal hook, use the appropriate function from the list below.
3342 The calling convention:
3344 if (!NILP (Vrun_hooks))
3345 call1 (Vrun_hooks, Qmy_funny_hook);
3347 should no longer be used. */
3348 extern Lisp_Object Vrun_hooks
;
3349 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3350 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3351 Lisp_Object (*funcall
)
3352 (ptrdiff_t nargs
, Lisp_Object
*args
));
3353 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3354 extern _Noreturn
void xsignal0 (Lisp_Object
);
3355 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3356 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3357 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3359 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3360 extern Lisp_Object
eval_sub (Lisp_Object form
);
3361 extern Lisp_Object
Ffuncall (ptrdiff_t nargs
, Lisp_Object
*args
);
3362 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3363 extern Lisp_Object
call0 (Lisp_Object
);
3364 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3365 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3366 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3367 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3368 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3369 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3370 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3371 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3372 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3373 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3374 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3375 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3376 extern Lisp_Object internal_condition_case_n
3377 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3378 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3379 extern void specbind (Lisp_Object
, Lisp_Object
);
3380 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3381 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3382 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3383 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3384 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3385 extern void record_unwind_protect_int (void (*) (int), int);
3386 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3387 extern void record_unwind_protect_void (void (*) (void));
3388 extern void dynwind_begin (void);
3389 extern void dynwind_end (void);
3390 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3391 extern _Noreturn
void verror (const char *, va_list)
3392 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3393 extern void un_autoload (Lisp_Object
);
3394 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3395 extern void init_eval_once (void);
3396 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3397 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3398 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3399 extern void init_eval (void);
3400 extern void syms_of_eval (void);
3401 extern void unwind_body (Lisp_Object
);
3402 extern void record_in_backtrace (Lisp_Object function
,
3403 Lisp_Object
*args
, ptrdiff_t nargs
);
3404 extern void mark_specpdl (void);
3405 extern void get_backtrace (Lisp_Object array
);
3406 Lisp_Object
backtrace_top_function (void);
3407 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3408 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3409 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3410 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3411 extern SCM
make_prompt_tag (void);
3414 /* Defined in editfns.c. */
3415 extern Lisp_Object Qfield
;
3416 extern void insert1 (Lisp_Object
);
3417 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3418 extern Lisp_Object
save_excursion_save (void);
3419 extern Lisp_Object
save_restriction_save (void);
3420 extern void save_excursion_restore (Lisp_Object
);
3421 extern void save_restriction_restore (Lisp_Object
);
3422 extern _Noreturn
void time_overflow (void);
3423 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3424 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3426 extern void init_editfns (void);
3427 extern void syms_of_editfns (void);
3428 extern void set_time_zone_rule (const char *);
3430 /* Defined in buffer.c. */
3431 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3432 extern _Noreturn
void nsberror (Lisp_Object
);
3433 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3434 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3435 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3436 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3437 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3438 extern bool overlay_touches_p (ptrdiff_t);
3439 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3440 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3441 extern void init_buffer_once (void);
3442 extern void init_buffer (int);
3443 extern void syms_of_buffer (void);
3444 extern void keys_of_buffer (void);
3446 /* Defined in marker.c. */
3448 extern ptrdiff_t marker_position (Lisp_Object
);
3449 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3450 extern void clear_charpos_cache (struct buffer
*);
3451 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3452 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3453 extern void unchain_marker (struct Lisp_Marker
*marker
);
3454 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3455 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3456 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3457 ptrdiff_t, ptrdiff_t);
3458 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3459 extern void syms_of_marker (void);
3461 /* Defined in fileio.c. */
3463 extern Lisp_Object Qfile_error
;
3464 extern Lisp_Object Qfile_notify_error
;
3465 extern Lisp_Object Qfile_exists_p
;
3466 extern Lisp_Object Qfile_directory_p
;
3467 extern Lisp_Object Qinsert_file_contents
;
3468 extern Lisp_Object Qfile_name_history
;
3469 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3470 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3471 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3473 extern void close_file_unwind (int);
3474 extern void close_file_ptr_unwind (void *);
3475 extern void fclose_unwind (void *);
3476 extern void fclose_ptr_unwind (void *);
3477 extern void restore_point_unwind (Lisp_Object
);
3478 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3479 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3480 extern bool internal_delete_file (Lisp_Object
);
3481 extern Lisp_Object
emacs_readlinkat (int, const char *);
3482 extern bool file_directory_p (const char *);
3483 extern bool file_accessible_directory_p (const char *);
3484 extern void init_fileio (void);
3485 extern void syms_of_fileio (void);
3486 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3487 extern Lisp_Object Qdelete_file
;
3489 /* Defined in search.c. */
3490 extern void shrink_regexp_cache (void);
3491 extern void restore_search_regs (void);
3492 extern void record_unwind_save_match_data (void);
3493 struct re_registers
;
3494 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3495 struct re_registers
*,
3496 Lisp_Object
, bool, bool);
3497 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3498 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3500 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3501 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3502 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3503 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3504 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3505 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3507 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3508 ptrdiff_t, ptrdiff_t *);
3509 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3510 ptrdiff_t, ptrdiff_t *);
3511 extern void syms_of_search (void);
3512 extern void clear_regexp_cache (void);
3514 /* Defined in minibuf.c. */
3516 extern Lisp_Object Qcompletion_ignore_case
;
3517 extern Lisp_Object Vminibuffer_list
;
3518 extern Lisp_Object last_minibuf_string
;
3519 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3520 extern void init_minibuf_once (void);
3521 extern void syms_of_minibuf (void);
3523 /* Defined in callint.c. */
3525 extern Lisp_Object Qminus
, Qplus
;
3526 extern Lisp_Object Qprogn
;
3527 extern Lisp_Object Qwhen
;
3528 extern Lisp_Object Qmouse_leave_buffer_hook
;
3529 extern void syms_of_callint (void);
3531 /* Defined in casefiddle.c. */
3533 extern Lisp_Object Qidentity
;
3534 extern void syms_of_casefiddle (void);
3535 extern void keys_of_casefiddle (void);
3537 /* Defined in casetab.c. */
3539 extern void init_casetab_once (void);
3540 extern void syms_of_casetab (void);
3542 /* Defined in keyboard.c. */
3544 extern Lisp_Object echo_message_buffer
;
3545 extern struct kboard
*echo_kboard
;
3546 extern void cancel_echoing (void);
3547 extern Lisp_Object Qdisabled
, QCfilter
;
3548 extern Lisp_Object Qup
, Qdown
;
3549 extern Lisp_Object last_undo_boundary
;
3550 extern bool input_pending
;
3551 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3552 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3553 extern void discard_mouse_events (void);
3555 void handle_input_available_signal (int);
3557 extern Lisp_Object pending_funcalls
;
3558 extern bool detect_input_pending (void);
3559 extern bool detect_input_pending_ignore_squeezables (void);
3560 extern bool detect_input_pending_run_timers (bool);
3561 extern void safe_run_hooks (Lisp_Object
);
3562 extern void cmd_error_internal (Lisp_Object
, const char *);
3563 extern Lisp_Object
command_loop_1 (void);
3564 extern Lisp_Object
read_menu_command (void);
3565 extern Lisp_Object
recursive_edit_1 (void);
3566 extern void record_auto_save (void);
3567 extern void force_auto_save_soon (void);
3568 extern void init_keyboard (void);
3569 extern void syms_of_keyboard (void);
3570 extern void keys_of_keyboard (void);
3572 /* Defined in indent.c. */
3573 extern ptrdiff_t current_column (void);
3574 extern void invalidate_current_column (void);
3575 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3576 extern void syms_of_indent (void);
3578 /* Defined in frame.c. */
3579 extern Lisp_Object Qonly
, Qnone
;
3580 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3581 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3582 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3583 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3584 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3585 extern void frames_discard_buffer (Lisp_Object
);
3586 extern void syms_of_frame (void);
3588 /* Defined in emacs.c. */
3589 extern char **initial_argv
;
3590 extern int initial_argc
;
3591 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3592 extern bool display_arg
;
3594 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3595 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3596 extern Lisp_Object Qfile_name_handler_alist
;
3597 extern _Noreturn
void terminate_due_to_signal (int, int);
3598 extern Lisp_Object Qkill_emacs
;
3600 extern Lisp_Object Vlibrary_cache
;
3603 void fixup_locale (void);
3604 void synchronize_system_messages_locale (void);
3605 void synchronize_system_time_locale (void);
3607 INLINE
void fixup_locale (void) {}
3608 INLINE
void synchronize_system_messages_locale (void) {}
3609 INLINE
void synchronize_system_time_locale (void) {}
3611 extern void shut_down_emacs (int, Lisp_Object
);
3613 /* True means don't do interactive redisplay and don't change tty modes. */
3614 extern bool noninteractive
;
3616 /* True means remove site-lisp directories from load-path. */
3617 extern bool no_site_lisp
;
3619 /* Pipe used to send exit notification to the daemon parent at
3621 extern int daemon_pipe
[2];
3622 #define IS_DAEMON (daemon_pipe[1] != 0)
3624 /* True if handling a fatal error already. */
3625 extern bool fatal_error_in_progress
;
3627 /* True means don't do use window-system-specific display code. */
3628 extern bool inhibit_window_system
;
3629 /* True means that a filter or a sentinel is running. */
3630 extern bool running_asynch_code
;
3632 /* Defined in process.c. */
3633 extern Lisp_Object QCtype
, Qlocal
;
3634 extern void kill_buffer_processes (Lisp_Object
);
3635 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3636 struct Lisp_Process
*, int);
3637 /* Max value for the first argument of wait_reading_process_output. */
3638 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3639 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3640 The bug merely causes a bogus warning, but the warning is annoying. */
3641 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3643 # define WAIT_READING_MAX INTMAX_MAX
3645 extern void add_keyboard_wait_descriptor (int);
3646 extern void delete_keyboard_wait_descriptor (int);
3648 extern void add_gpm_wait_descriptor (int);
3649 extern void delete_gpm_wait_descriptor (int);
3651 extern void init_process_emacs (void);
3652 extern void syms_of_process (void);
3653 extern void setup_process_coding_systems (Lisp_Object
);
3655 /* Defined in callproc.c. */
3659 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3660 extern void init_callproc_1 (void);
3661 extern void init_callproc (void);
3662 extern void set_initial_environment (void);
3663 extern void syms_of_callproc (void);
3665 /* Defined in doc.c. */
3666 extern Lisp_Object Qfunction_documentation
;
3667 extern Lisp_Object
read_doc_string (Lisp_Object
);
3668 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3669 extern void syms_of_doc (void);
3670 extern int read_bytecode_char (bool);
3672 /* Defined in bytecode.c. */
3673 extern void syms_of_bytecode (void);
3674 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3675 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3677 /* Defined in macros.c. */
3678 extern void init_macros (void);
3679 extern void syms_of_macros (void);
3681 /* Defined in undo.c. */
3682 extern Lisp_Object Qapply
;
3683 extern Lisp_Object Qinhibit_read_only
;
3684 extern void truncate_undo_list (struct buffer
*);
3685 extern void record_insert (ptrdiff_t, ptrdiff_t);
3686 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3687 extern void record_first_change (void);
3688 extern void record_change (ptrdiff_t, ptrdiff_t);
3689 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3690 Lisp_Object
, Lisp_Object
,
3692 extern void syms_of_undo (void);
3693 /* Defined in textprop.c. */
3694 extern Lisp_Object Qmouse_face
;
3695 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3696 extern Lisp_Object Qminibuffer_prompt
;
3698 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3700 /* Defined in menu.c. */
3701 extern void syms_of_menu (void);
3703 /* Defined in xmenu.c. */
3704 extern void syms_of_xmenu (void);
3706 /* Defined in termchar.h. */
3707 struct tty_display_info
;
3709 /* Defined in termhooks.h. */
3712 /* Defined in sysdep.c. */
3713 #ifndef HAVE_GET_CURRENT_DIR_NAME
3714 extern char *get_current_dir_name (void);
3716 extern void stuff_char (char c
);
3717 extern void init_foreground_group (void);
3718 extern void sys_subshell (void);
3719 extern void sys_suspend (void);
3720 extern void discard_tty_input (void);
3721 extern void init_sys_modes (struct tty_display_info
*);
3722 extern void reset_sys_modes (struct tty_display_info
*);
3723 extern void init_all_sys_modes (void);
3724 extern void reset_all_sys_modes (void);
3725 extern void child_setup_tty (int);
3726 extern void setup_pty (int);
3727 extern int set_window_size (int, int, int);
3728 extern EMACS_INT
get_random (void);
3729 extern void seed_random (void *, ptrdiff_t);
3730 extern void init_random (void);
3731 extern void emacs_backtrace (int);
3732 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3733 extern int emacs_open (const char *, int, int);
3734 extern int emacs_pipe (int[2]);
3735 extern int emacs_close (int);
3736 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3737 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3738 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3739 extern void emacs_perror (char const *);
3741 extern void unlock_all_files (void);
3742 extern void lock_file (Lisp_Object
);
3743 extern void unlock_file (Lisp_Object
);
3744 extern void unlock_buffer (struct buffer
*);
3745 extern void syms_of_filelock (void);
3747 /* Defined in sound.c. */
3748 extern void syms_of_sound (void);
3750 /* Defined in category.c. */
3751 extern void init_category_once (void);
3752 extern Lisp_Object
char_category_set (int);
3753 extern void syms_of_category (void);
3755 /* Defined in ccl.c. */
3756 extern void syms_of_ccl (void);
3758 /* Defined in dired.c. */
3759 extern void syms_of_dired (void);
3760 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3761 Lisp_Object
, Lisp_Object
,
3764 /* Defined in term.c. */
3765 extern int *char_ins_del_vector
;
3766 extern void syms_of_term (void);
3767 extern _Noreturn
void fatal (const char *msgid
, ...)
3768 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3770 /* Defined in terminal.c. */
3771 extern void syms_of_terminal (void);
3773 /* Defined in font.c. */
3774 extern void syms_of_font (void);
3775 extern void init_font (void);
3777 #ifdef HAVE_WINDOW_SYSTEM
3778 /* Defined in fontset.c. */
3779 extern void syms_of_fontset (void);
3781 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3782 extern Lisp_Object Qfont_param
;
3785 /* Defined in gfilenotify.c */
3786 #ifdef HAVE_GFILENOTIFY
3787 extern void globals_of_gfilenotify (void);
3788 extern void syms_of_gfilenotify (void);
3791 /* Defined in inotify.c */
3793 extern void syms_of_inotify (void);
3796 #ifdef HAVE_W32NOTIFY
3797 /* Defined on w32notify.c. */
3798 extern void syms_of_w32notify (void);
3801 /* Defined in xfaces.c. */
3802 extern Lisp_Object Qdefault
, Qfringe
;
3803 extern Lisp_Object Qscroll_bar
, Qcursor
;
3804 extern Lisp_Object Qmode_line_inactive
;
3805 extern Lisp_Object Qface
;
3806 extern Lisp_Object Qnormal
;
3807 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3808 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3809 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3810 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3811 extern Lisp_Object Qoblique
, Qitalic
;
3812 extern Lisp_Object Vface_alternative_font_family_alist
;
3813 extern Lisp_Object Vface_alternative_font_registry_alist
;
3814 extern void syms_of_xfaces (void);
3816 #ifdef HAVE_X_WINDOWS
3817 /* Defined in xfns.c. */
3818 extern void syms_of_xfns (void);
3820 /* Defined in xsmfns.c. */
3821 extern void syms_of_xsmfns (void);
3823 /* Defined in xselect.c. */
3824 extern void syms_of_xselect (void);
3826 /* Defined in xterm.c. */
3827 extern void syms_of_xterm (void);
3828 #endif /* HAVE_X_WINDOWS */
3830 #ifdef HAVE_WINDOW_SYSTEM
3831 /* Defined in xterm.c, nsterm.m, w32term.c. */
3832 extern char *x_get_keysym_name (int);
3833 #endif /* HAVE_WINDOW_SYSTEM */
3836 /* Defined in xml.c. */
3837 extern void syms_of_xml (void);
3838 extern void xml_cleanup_parser (void);
3842 /* Defined in decompress.c. */
3843 extern void syms_of_decompress (void);
3847 /* Defined in dbusbind.c. */
3848 void syms_of_dbusbind (void);
3852 /* Defined in profiler.c. */
3853 extern bool profiler_memory_running
;
3854 extern void malloc_probe (size_t);
3855 extern void syms_of_profiler (void);
3859 /* Defined in msdos.c, w32.c. */
3860 extern char *emacs_root_dir (void);
3863 /* True means ^G can quit instantly. */
3864 extern bool immediate_quit
;
3866 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3867 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3868 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3869 extern void xfree (void *);
3870 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3871 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3872 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3873 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3874 ATTRIBUTE_ALLOC_SIZE ((2,3));
3875 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3876 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3877 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3878 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3879 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3881 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3882 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3883 extern void dupstring (char **, char const *);
3884 extern void xputenv (const char *);
3886 extern char *egetenv (const char *);
3888 /* Copy Lisp string to temporary (allocated on stack) C string. */
3890 #define xlispstrdupa(string) \
3891 memcpy (alloca (SBYTES (string) + 1), \
3892 SSDATA (string), SBYTES (string) + 1)
3894 /* Set up the name of the machine we're running on. */
3895 extern void init_system_name (void);
3897 /* Return the absolute value of X. X should be a signed integer
3898 expression without side effects, and X's absolute value should not
3899 exceed the maximum for its promoted type. This is called 'eabs'
3900 because 'abs' is reserved by the C standard. */
3901 #define eabs(x) ((x) < 0 ? -(x) : (x))
3903 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3906 #define make_fixnum_or_float(val) \
3907 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3909 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3910 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3912 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3914 #define USE_SAFE_ALLOCA ((void) 0)
3916 /* SAFE_ALLOCA allocates a simple buffer. */
3918 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3922 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3923 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3924 positive. The code is tuned for MULTIPLIER being a constant. */
3926 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3928 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3929 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3931 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3934 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3936 #define SAFE_FREE() ((void) 0)
3938 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3940 #define SAFE_ALLOCA_LISP(buf, nelt) \
3942 if ((nelt) < MAX_ALLOCA / word_size) \
3943 (buf) = alloca ((nelt) * word_size); \
3944 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3945 buf = xmalloc ((nelt) * word_size); \
3947 memory_full (SIZE_MAX); \
3950 /* Loop over all tails of a list, checking for cycles.
3951 FIXME: Make tortoise and n internal declarations.
3952 FIXME: Unroll the loop body so we don't need `n'. */
3953 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3954 for ((tortoise) = (hare) = (list), (n) = true; \
3956 (hare = XCDR (hare), (n) = !(n), \
3958 ? (EQ (hare, tortoise) \
3959 ? xsignal1 (Qcircular_list, list) \
3961 /* Move tortoise before the next iteration, in case */ \
3962 /* the next iteration does an Fsetcdr. */ \
3963 : (void) ((tortoise) = XCDR (tortoise)))))
3965 /* Do a `for' loop over alist values. */
3967 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3968 for ((list_var) = (head_var); \
3969 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
3970 (list_var) = XCDR (list_var))
3972 /* Check whether it's time for GC, and run it if so. */
3981 functionp (Lisp_Object object
)
3983 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3985 object
= Findirect_function (object
, Qt
);
3987 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3989 /* Autoloaded symbols are functions, except if they load
3990 macros or keymaps. */
3992 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3993 object
= XCDR (object
);
3995 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4000 return XSUBR (object
)->max_args
!= UNEVALLED
;
4001 else if (COMPILEDP (object
))
4003 else if (CONSP (object
))
4005 Lisp_Object car
= XCAR (object
);
4006 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4009 return scm_is_true (scm_procedure_p (object
));
4013 #endif /* EMACS_LISP_H */