1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
102 typedef scm_t_signed_bits EMACS_INT
;
103 typedef scm_t_bits EMACS_UINT
;
104 #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX
106 #if INTPTR_MAX == INT_MAX
108 #elif INTPTR_MAX == LONG_MAX
110 #elif INTPTR_MAX == LLONG_MAX
112 #elif INTPTR_MAX == INTMAX_MAX
115 #error "Cannot determine length modifier for EMACS_INT"
118 /* Number of bits to put in each character in the internal representation
119 of bool vectors. This should not vary across implementations. */
120 enum { BOOL_VECTOR_BITS_PER_CHAR
=
121 #define BOOL_VECTOR_BITS_PER_CHAR 8
122 BOOL_VECTOR_BITS_PER_CHAR
125 /* An unsigned integer type representing a fixed-length bit sequence,
126 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
127 for speed, but it is unsigned char on weird platforms. */
128 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
129 typedef size_t bits_word
;
130 # define BITS_WORD_MAX SIZE_MAX
131 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
133 typedef unsigned char bits_word
;
134 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
135 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
137 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
139 /* Number of bits in some machine integer types. */
142 BITS_PER_CHAR
= CHAR_BIT
,
143 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
144 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
145 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
148 /* printmax_t and uprintmax_t are types for printing large integers.
149 These are the widest integers that are supported for printing.
150 pMd etc. are conversions for printing them.
151 On C99 hosts, there's no problem, as even the widest integers work.
152 Fall back on EMACS_INT on pre-C99 hosts. */
154 typedef intmax_t printmax_t
;
155 typedef uintmax_t uprintmax_t
;
159 typedef EMACS_INT printmax_t
;
160 typedef EMACS_UINT uprintmax_t
;
165 /* Use pD to format ptrdiff_t values, which suffice for indexes into
166 buffers and strings. Emacs never allocates objects larger than
167 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
168 In C99, pD can always be "t"; configure it here for the sake of
169 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
170 #if PTRDIFF_MAX == INT_MAX
172 #elif PTRDIFF_MAX == LONG_MAX
174 #elif PTRDIFF_MAX == LLONG_MAX
180 /* Extra internal type checking? */
182 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
183 'assume (COND)'. COND should be free of side effects, as it may or
184 may not be evaluated.
186 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
187 defined and suppress_checking is false, and does nothing otherwise.
188 Emacs dies if COND is checked and is false. The suppress_checking
189 variable is initialized to 0 in alloc.c. Set it to 1 using a
190 debugger to temporarily disable aborting on detected internal
191 inconsistencies or error conditions.
193 In some cases, a good compiler may be able to optimize away the
194 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
195 uses eassert to test STRINGP (x), but a particular use of XSTRING
196 is invoked only after testing that STRINGP (x) is true, making the
199 eassume is like eassert except that it also causes the compiler to
200 assume that COND is true afterwards, regardless of whether runtime
201 checking is enabled. This can improve performance in some cases,
202 though it can degrade performance in others. It's often suboptimal
203 for COND to call external functions or access volatile storage. */
205 #ifndef ENABLE_CHECKING
206 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
207 # define eassume(cond) assume (cond)
208 #else /* ENABLE_CHECKING */
210 extern _Noreturn
void die (const char *, const char *, int);
212 extern bool suppress_checking EXTERNALLY_VISIBLE
;
214 # define eassert(cond) \
215 (suppress_checking || (cond) \
217 : die (# cond, __FILE__, __LINE__))
218 # define eassume(cond) \
223 : die (# cond, __FILE__, __LINE__))
224 #endif /* ENABLE_CHECKING */
229 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
230 integer constant, for MSVC. */
231 #define GCALIGNMENT 8
233 /* Number of bits in a Lisp fixnum value, not counting the tag. */
234 FIXNUM_BITS
= SCM_I_FIXNUM_BIT
237 #if GCALIGNMENT != 1 << GCTYPEBITS
238 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
241 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
242 #define USE_LSB_TAG 1
243 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
246 # define alignas(alignment) /* empty */
248 # error "USE_LSB_TAG requires alignas"
252 /* Some operations are so commonly executed that they are implemented
253 as macros, not functions, because otherwise runtime performance would
254 suffer too much when compiling with GCC without optimization.
255 There's no need to inline everything, just the operations that
256 would otherwise cause a serious performance problem.
258 For each such operation OP, define a macro lisp_h_OP that contains
259 the operation's implementation. That way, OP can be implemented
260 via a macro definition like this:
262 #define OP(x) lisp_h_OP (x)
264 and/or via a function definition like this:
266 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
268 which macro-expands to this:
270 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
272 without worrying about the implementations diverging, since
273 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
274 are intended to be private to this include file, and should not be
277 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
278 functions, once most developers have access to GCC 4.8 or later and
279 can use "gcc -Og" to debug. Maybe in the year 2016. See
282 Commentary for these macros can be found near their corresponding
285 #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a))
286 #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x))
287 #define lisp_h_XLI(o) (SCM_UNPACK (o))
288 #define lisp_h_XIL(i) (SCM_PACK (i))
289 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
290 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
291 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
292 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
293 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
294 #define lisp_h_CONSP(x) (x && scm_is_pair (x))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (x && SCM_INEXACTP (x))
297 #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x))
298 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
299 #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag))
300 #define lisp_h_NILP(x) EQ (x, Qnil)
301 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
302 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
303 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
304 #define lisp_h_SYMBOL_VAL(sym) \
305 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
306 #define lisp_h_SYMBOLP(x) (x && scm_is_symbol (x))
307 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
308 #define lisp_h_XCAR(c) (scm_car (c))
309 #define lisp_h_XCDR(c) (scm_cdr (c))
310 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
312 /* Define NAME as a lisp.h inline function that returns TYPE and has
313 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
314 ARGS should be parenthesized. Implement the function by calling
316 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
317 INLINE type (name) argdecls { return lisp_h_##name args; }
319 /* like LISP_MACRO_DEFUN, except NAME returns void. */
320 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
321 INLINE void (name) argdecls { lisp_h_##name args; }
324 /* Define the fundamental Lisp data structures. */
326 /* This is the set of Lisp data types. If you want to define a new
327 data type, read the comments after Lisp_Fwd_Type definition
330 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
331 #define case_Lisp_Int case Lisp_Int
333 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
334 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
335 vociferously about them. */
336 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
337 || (defined __SUNPRO_C && __STDC__))
338 #define ENUM_BF(TYPE) unsigned int
340 #define ENUM_BF(TYPE) enum TYPE
343 scm_t_bits lisp_misc_tag
;
344 scm_t_bits lisp_string_tag
;
345 scm_t_bits lisp_vectorlike_tag
;
351 /* Integer. XINT (obj) is the integer value. */
354 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
357 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
358 whose first member indicates the subtype. */
361 /* String. XSTRING (object) points to a struct Lisp_String.
362 The length of the string, and its contents, are stored therein. */
365 /* Vector of Lisp objects, or something resembling it.
366 XVECTOR (object) points to a struct Lisp_Vector, which contains
367 the size and contents. The size field also contains the type
368 information, if it's not a real vector object. */
371 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
377 /* This is the set of data types that share a common structure.
378 The first member of the structure is a type code from this set.
379 The enum values are arbitrary, but we'll use large numbers to make it
380 more likely that we'll spot the error if a random word in memory is
381 mistakenly interpreted as a Lisp_Misc. */
384 Lisp_Misc_Free
= 0x5eab,
387 Lisp_Misc_Save_Value
,
388 /* Currently floats are not a misc type,
389 but let's define this in case we want to change that. */
391 /* This is not a type code. It is for range checking. */
395 /* These are the types of forwarding objects used in the value slot
396 of symbols for special built-in variables whose value is stored in
400 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
401 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
402 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
403 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
404 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
407 typedef SCM Lisp_Object
;
409 #define LISP_INITIALLY_ZERO SCM_INUM0
411 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
412 At the machine level, these operations are no-ops. */
413 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
414 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
416 /* In the size word of a struct Lisp_Vector, this bit means it's really
417 some other vector-like object. */
418 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
419 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
420 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
422 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
423 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
424 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
427 /* In a pseudovector, the size field actually contains a word with one
428 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
429 with PVEC_TYPE_MASK to indicate the actual type. */
441 PVEC_WINDOW_CONFIGURATION
,
444 /* These should be last, check internal_equal to see why. */
448 PVEC_FONT
/* Should be last because it's used for range checking. */
453 /* For convenience, we also store the number of elements in these bits.
454 Note that this size is not necessarily the memory-footprint size, but
455 only the number of Lisp_Object fields (that need to be traced by GC).
456 The distinction is used, e.g., by Lisp_Process, which places extra
457 non-Lisp_Object fields at the end of the structure. */
458 PSEUDOVECTOR_SIZE_BITS
= 12,
459 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
461 /* To calculate the memory footprint of the pseudovector, it's useful
462 to store the size of non-Lisp area in word_size units here. */
463 PSEUDOVECTOR_REST_BITS
= 12,
464 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
465 << PSEUDOVECTOR_SIZE_BITS
),
467 /* Used to extract pseudovector subtype information. */
468 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
469 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
472 /* These functions extract various sorts of values from a Lisp_Object.
473 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
474 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
477 /* Largest and smallest representable fixnum values. These are the C
478 values. They are macros for use in static initializers. */
479 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
480 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
482 /* Make a Lisp integer representing the value of the low order
485 make_number (EMACS_INT n
)
487 return SCM_I_MAKINUM (n
);
490 /* Extract A's value as a signed integer. */
494 return SCM_I_INUM (a
);
497 /* Like XINT (A), but may be faster. A must be nonnegative.
498 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
499 integers have zero-bits in their tags. */
501 XFASTINT (Lisp_Object a
)
503 EMACS_INT n
= XINT (a
);
508 /* Extract A's value as an unsigned integer. */
510 XUINT (Lisp_Object a
)
512 return SCM_I_INUM (a
);
515 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
516 right now, but XUINT should only be applied to objects we know are
518 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
520 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
522 make_natnum (EMACS_INT n
)
524 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
525 return make_number (n
);
528 /* Return true if X and Y are the same object. */
529 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
531 /* Value is true if I doesn't fit into a Lisp fixnum. It is
532 written this way so that it also works if I is of unsigned
533 type or if I is a NaN. */
535 #define FIXNUM_OVERFLOW_P(i) \
536 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
539 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
541 return num
< lower
? lower
: num
<= upper
? num
: upper
;
544 /* Forward declarations. */
546 /* Defined in this file. */
548 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
549 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
550 INLINE
bool BUFFERP (Lisp_Object
);
551 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
552 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
553 INLINE
bool (CONSP
) (Lisp_Object
);
554 INLINE
bool (FLOATP
) (Lisp_Object
);
555 INLINE
bool functionp (Lisp_Object
);
556 INLINE
bool (INTEGERP
) (Lisp_Object
);
557 INLINE
bool (MARKERP
) (Lisp_Object
);
558 INLINE
bool (MISCP
) (Lisp_Object
);
559 INLINE
bool (NILP
) (Lisp_Object
);
560 INLINE
bool OVERLAYP (Lisp_Object
);
561 INLINE
bool PROCESSP (Lisp_Object
);
562 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
563 INLINE
bool SAVE_VALUEP (Lisp_Object
);
564 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
566 INLINE
bool STRINGP (Lisp_Object
);
567 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
568 INLINE
bool SUBRP (Lisp_Object
);
569 INLINE
bool (SYMBOLP
) (Lisp_Object
);
570 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
571 INLINE
bool WINDOWP (Lisp_Object
);
572 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
574 /* Defined in chartab.c. */
575 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
576 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
577 extern int char_table_translate (Lisp_Object
, int);
579 /* Defined in data.c. */
580 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
581 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
582 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
583 extern Lisp_Object Qbool_vector_p
;
584 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
585 extern Lisp_Object Qwindow
;
586 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
588 /* Defined in emacs.c. */
589 extern bool might_dump
;
590 /* True means Emacs has already been initialized.
591 Used during startup to detect startup of dumped Emacs. */
592 extern bool initialized
;
594 /* Defined in eval.c. */
595 extern Lisp_Object Qautoload
;
597 /* Defined in floatfns.c. */
598 extern double extract_float (Lisp_Object
);
600 /* Defined in process.c. */
601 extern Lisp_Object Qprocessp
;
603 /* Defined in window.c. */
604 extern Lisp_Object Qwindowp
;
606 /* Defined in xdisp.c. */
607 extern Lisp_Object Qimage
;
609 /* Extract A's type. */
610 INLINE
enum Lisp_Type
611 XTYPE (Lisp_Object o
)
615 else if (SYMBOLP (o
))
619 else if (STRINGP (o
))
621 else if (VECTORLIKEP (o
))
622 return Lisp_Vectorlike
;
631 /* Extract a value or address from a Lisp_Object. */
633 INLINE
struct Lisp_Vector
*
634 XVECTOR (Lisp_Object a
)
636 eassert (VECTORLIKEP (a
));
640 INLINE
struct Lisp_String
*
641 XSTRING (Lisp_Object a
)
643 eassert (STRINGP (a
));
647 extern void initialize_symbol (Lisp_Object
, Lisp_Object
);
648 INLINE Lisp_Object
build_string (const char *);
649 extern Lisp_Object symbol_module
;
650 extern Lisp_Object function_module
;
651 extern Lisp_Object plist_module
;
653 INLINE
struct Lisp_Symbol
*
654 XSYMBOL (Lisp_Object a
)
657 eassert (SYMBOLP (a
));
658 tem
= scm_variable_ref (scm_module_lookup (symbol_module
, a
));
659 return scm_to_pointer (tem
);
662 /* Pseudovector types. */
664 INLINE
struct Lisp_Process
*
665 XPROCESS (Lisp_Object a
)
667 eassert (PROCESSP (a
));
671 INLINE
struct window
*
672 XWINDOW (Lisp_Object a
)
674 eassert (WINDOWP (a
));
678 INLINE
struct terminal
*
679 XTERMINAL (Lisp_Object a
)
684 INLINE
struct Lisp_Subr
*
685 XSUBR (Lisp_Object a
)
691 INLINE
struct buffer
*
692 XBUFFER (Lisp_Object a
)
694 eassert (BUFFERP (a
));
698 INLINE
struct Lisp_Char_Table
*
699 XCHAR_TABLE (Lisp_Object a
)
701 eassert (CHAR_TABLE_P (a
));
705 INLINE
struct Lisp_Sub_Char_Table
*
706 XSUB_CHAR_TABLE (Lisp_Object a
)
708 eassert (SUB_CHAR_TABLE_P (a
));
712 INLINE
struct Lisp_Bool_Vector
*
713 XBOOL_VECTOR (Lisp_Object a
)
715 eassert (BOOL_VECTOR_P (a
));
720 make_lisp_proc (struct Lisp_Process
*p
)
722 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
725 #define XSETINT(a, b) ((a) = make_number (b))
726 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
727 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
728 #define XSETSTRING(a, b) ((a) = (b)->self)
729 #define XSETSYMBOL(a, b) ((a) = (b)->self)
730 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
732 /* Pseudovector types. */
734 #define XSETPVECTYPE(v, code) \
735 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
736 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
737 ((v)->header.size = (PSEUDOVECTOR_FLAG \
738 | ((code) << PSEUDOVECTOR_AREA_BITS) \
739 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
742 /* The cast to struct vectorlike_header * avoids aliasing issues. */
743 #define XSETPSEUDOVECTOR(a, b, code) \
744 XSETTYPED_PSEUDOVECTOR (a, b, \
745 (((struct vectorlike_header *) \
749 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
750 (XSETVECTOR (a, b), \
751 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
752 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
754 #define XSETWINDOW_CONFIGURATION(a, b) \
755 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
756 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
757 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
758 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
759 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
760 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
761 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
762 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
763 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
764 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
768 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
769 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
772 /* Deprecated and will be removed soon. */
774 #define INTERNAL_FIELD(field) field ## _
776 /* See the macros in intervals.h. */
778 typedef struct interval
*INTERVAL
;
780 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
781 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
783 /* Use these to set the fields of a cons cell.
785 Note that both arguments may refer to the same object, so 'n'
786 should not be read after 'c' is first modified. */
788 XSETCAR (Lisp_Object c
, Lisp_Object n
)
790 scm_set_car_x (c
, n
);
793 XSETCDR (Lisp_Object c
, Lisp_Object n
)
795 scm_set_cdr_x (c
, n
);
798 /* Take the car or cdr of something whose type is not known. */
802 return (CONSP (c
) ? XCAR (c
)
804 : wrong_type_argument (Qlistp
, c
));
809 return (CONSP (c
) ? XCDR (c
)
811 : wrong_type_argument (Qlistp
, c
));
814 /* Take the car or cdr of something whose type is not known. */
816 CAR_SAFE (Lisp_Object c
)
818 return CONSP (c
) ? XCAR (c
) : Qnil
;
821 CDR_SAFE (Lisp_Object c
)
823 return CONSP (c
) ? XCDR (c
) : Qnil
;
826 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
833 INTERVAL intervals
; /* Text properties in this string. */
837 /* True if STR is a multibyte string. */
839 STRING_MULTIBYTE (Lisp_Object str
)
841 return 0 <= XSTRING (str
)->size_byte
;
844 /* An upper bound on the number of bytes in a Lisp string, not
845 counting the terminating null. This a tight enough bound to
846 prevent integer overflow errors that would otherwise occur during
847 string size calculations. A string cannot contain more bytes than
848 a fixnum can represent, nor can it be so long that C pointer
849 arithmetic stops working on the string plus its terminating null.
850 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
851 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
852 would expose alloc.c internal details that we'd rather keep
855 This is a macro for use in static initializers. The cast to
856 ptrdiff_t ensures that the macro is signed. */
857 #define STRING_BYTES_BOUND \
858 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
860 /* Mark STR as a unibyte string. */
861 #define STRING_SET_UNIBYTE(STR) \
863 if (EQ (STR, empty_multibyte_string)) \
864 (STR) = empty_unibyte_string; \
866 XSTRING (STR)->size_byte = -1; \
869 /* Mark STR as a multibyte string. Assure that STR contains only
870 ASCII characters in advance. */
871 #define STRING_SET_MULTIBYTE(STR) \
873 if (EQ (STR, empty_unibyte_string)) \
874 (STR) = empty_multibyte_string; \
876 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
879 /* Convenience functions for dealing with Lisp strings. */
881 INLINE
unsigned char *
882 SDATA (Lisp_Object string
)
884 return XSTRING (string
)->data
;
887 SSDATA (Lisp_Object string
)
889 /* Avoid "differ in sign" warnings. */
890 return (char *) SDATA (string
);
893 SREF (Lisp_Object string
, ptrdiff_t index
)
895 return SDATA (string
)[index
];
898 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
900 SDATA (string
)[index
] = new;
903 SCHARS (Lisp_Object string
)
905 return XSTRING (string
)->size
;
909 STRING_BYTES (struct Lisp_String
*s
)
911 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
915 SBYTES (Lisp_Object string
)
917 return STRING_BYTES (XSTRING (string
));
920 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
922 XSTRING (string
)->size
= newsize
;
925 /* Header of vector-like objects. This documents the layout constraints on
926 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
927 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
928 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
929 because when two such pointers potentially alias, a compiler won't
930 incorrectly reorder loads and stores to their size fields. See
932 struct vectorlike_header
936 /* This field contains various pieces of information:
937 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
938 vector (0) or a pseudovector (1).
939 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
940 of slots) of the vector.
941 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
942 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
943 - b) number of Lisp_Objects slots at the beginning of the object
944 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
946 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
947 measured in word_size units. Rest fields may also include
948 Lisp_Objects, but these objects usually needs some special treatment
950 There are some exceptions. For PVEC_FREE, b) is always zero. For
951 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
952 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
953 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
957 /* A regular vector is just a header plus an array of Lisp_Objects. */
961 struct vectorlike_header header
;
962 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
965 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
968 ALIGNOF_STRUCT_LISP_VECTOR
969 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
972 /* A boolvector is a kind of vectorlike, with contents like a string. */
974 struct Lisp_Bool_Vector
976 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
977 just the subtype information. */
978 struct vectorlike_header header
;
979 /* This is the size in bits. */
981 /* The actual bits, packed into bytes.
982 Zeros fill out the last word if needed.
983 The bits are in little-endian order in the bytes, and
984 the bytes are in little-endian order in the words. */
985 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
989 bool_vector_size (Lisp_Object a
)
991 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
997 bool_vector_data (Lisp_Object a
)
999 return XBOOL_VECTOR (a
)->data
;
1002 INLINE
unsigned char *
1003 bool_vector_uchar_data (Lisp_Object a
)
1005 return (unsigned char *) bool_vector_data (a
);
1008 /* The number of data words and bytes in a bool vector with SIZE bits. */
1011 bool_vector_words (EMACS_INT size
)
1013 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1014 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1018 bool_vector_bytes (EMACS_INT size
)
1020 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1021 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1024 /* True if A's Ith bit is set. */
1027 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1029 eassume (0 <= i
&& i
< bool_vector_size (a
));
1030 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1031 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1035 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1037 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1040 /* Set A's Ith bit to B. */
1043 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1045 unsigned char *addr
;
1047 eassume (0 <= i
&& i
< bool_vector_size (a
));
1048 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1051 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1053 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1056 /* Some handy constants for calculating sizes
1057 and offsets, mostly of vectorlike objects. */
1061 header_size
= offsetof (struct Lisp_Vector
, contents
),
1062 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1063 word_size
= sizeof (Lisp_Object
)
1066 /* Conveniences for dealing with Lisp arrays. */
1069 AREF (Lisp_Object array
, ptrdiff_t idx
)
1071 return XVECTOR (array
)->contents
[idx
];
1074 INLINE Lisp_Object
*
1075 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1077 return & XVECTOR (array
)->contents
[idx
];
1081 ASIZE (Lisp_Object array
)
1083 return XVECTOR (array
)->header
.size
;
1087 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1089 eassert (0 <= idx
&& idx
< ASIZE (array
));
1090 XVECTOR (array
)->contents
[idx
] = val
;
1094 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1096 /* Like ASET, but also can be used in the garbage collector:
1097 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1098 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1099 XVECTOR (array
)->contents
[idx
] = val
;
1102 /* If a struct is made to look like a vector, this macro returns the length
1103 of the shortest vector that would hold that struct. */
1105 #define VECSIZE(type) \
1106 ((sizeof (type) - header_size + word_size - 1) / word_size)
1108 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1109 at the end and we need to compute the number of Lisp_Object fields (the
1110 ones that the GC needs to trace). */
1112 #define PSEUDOVECSIZE(type, nonlispfield) \
1113 ((offsetof (type, nonlispfield) - header_size) / word_size)
1115 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1116 should be integer expressions. This is not the same as
1117 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1118 returns true. For efficiency, prefer plain unsigned comparison if A
1119 and B's sizes both fit (after integer promotion). */
1120 #define UNSIGNED_CMP(a, op, b) \
1121 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1122 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1123 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1125 /* True iff C is an ASCII character. */
1126 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1128 /* A char-table is a kind of vectorlike, with contents are like a
1129 vector but with a few other slots. For some purposes, it makes
1130 sense to handle a char-table with type struct Lisp_Vector. An
1131 element of a char table can be any Lisp objects, but if it is a sub
1132 char-table, we treat it a table that contains information of a
1133 specific range of characters. A sub char-table has the same
1134 structure as a vector. A sub char table appears only in an element
1135 of a char-table, and there's no way to access it directly from
1136 Emacs Lisp program. */
1138 enum CHARTAB_SIZE_BITS
1140 CHARTAB_SIZE_BITS_0
= 6,
1141 CHARTAB_SIZE_BITS_1
= 4,
1142 CHARTAB_SIZE_BITS_2
= 5,
1143 CHARTAB_SIZE_BITS_3
= 7
1146 extern const int chartab_size
[4];
1148 struct Lisp_Char_Table
1150 /* HEADER.SIZE is the vector's size field, which also holds the
1151 pseudovector type information. It holds the size, too.
1152 The size counts the defalt, parent, purpose, ascii,
1153 contents, and extras slots. */
1154 struct vectorlike_header header
;
1156 /* This holds a default value,
1157 which is used whenever the value for a specific character is nil. */
1160 /* This points to another char table, which we inherit from when the
1161 value for a specific character is nil. The `defalt' slot takes
1162 precedence over this. */
1165 /* This is a symbol which says what kind of use this char-table is
1167 Lisp_Object purpose
;
1169 /* The bottom sub char-table for characters of the range 0..127. It
1170 is nil if none of ASCII character has a specific value. */
1173 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1175 /* These hold additional data. It is a vector. */
1176 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1179 struct Lisp_Sub_Char_Table
1181 /* HEADER.SIZE is the vector's size field, which also holds the
1182 pseudovector type information. It holds the size, too. */
1183 struct vectorlike_header header
;
1185 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1186 char-table of depth 1 contains 16 elements, and each element
1187 covers 4096 (128*32) characters. A sub char-table of depth 2
1188 contains 32 elements, and each element covers 128 characters. A
1189 sub char-table of depth 3 contains 128 elements, and each element
1190 is for one character. */
1193 /* Minimum character covered by the sub char-table. */
1194 Lisp_Object min_char
;
1196 /* Use set_sub_char_table_contents to set this. */
1197 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1201 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1203 struct Lisp_Char_Table
*tbl
= NULL
;
1207 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1208 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1209 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1213 while (NILP (val
) && ! NILP (tbl
->parent
));
1218 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1219 characters. Do not check validity of CT. */
1221 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1223 return (ASCII_CHAR_P (idx
)
1224 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1225 : char_table_ref (ct
, idx
));
1228 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1229 8-bit European characters. Do not check validity of CT. */
1231 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1233 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1234 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1236 char_table_set (ct
, idx
, val
);
1239 /* This structure describes a built-in function.
1240 It is generated by the DEFUN macro only.
1241 defsubr makes it into a Lisp object. */
1245 struct vectorlike_header header
;
1247 Lisp_Object (*a0
) (void);
1248 Lisp_Object (*a1
) (Lisp_Object
);
1249 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1250 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1251 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1252 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1253 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1254 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1255 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1256 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1257 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1259 short min_args
, max_args
;
1260 const char *symbol_name
;
1261 const char *intspec
;
1265 /* This is the number of slots that every char table must have. This
1266 counts the ordinary slots and the top, defalt, parent, and purpose
1268 enum CHAR_TABLE_STANDARD_SLOTS
1270 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1273 /* Return the number of "extra" slots in the char table CT. */
1276 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1278 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1279 - CHAR_TABLE_STANDARD_SLOTS
);
1283 /***********************************************************************
1285 ***********************************************************************/
1287 enum symbol_redirect
1289 SYMBOL_PLAINVAL
= 4,
1290 SYMBOL_VARALIAS
= 1,
1291 SYMBOL_LOCALIZED
= 2,
1292 SYMBOL_FORWARDED
= 3
1299 /* Indicates where the value can be found:
1300 0 : it's a plain var, the value is in the `value' field.
1301 1 : it's a varalias, the value is really in the `alias' symbol.
1302 2 : it's a localized var, the value is in the `blv' object.
1303 3 : it's a forwarding variable, the value is in `forward'. */
1304 ENUM_BF (symbol_redirect
) redirect
: 3;
1306 /* Non-zero means symbol is constant, i.e. changing its value
1307 should signal an error. If the value is 3, then the var
1308 can be changed, but only by `defconst'. */
1309 unsigned constant
: 2;
1311 /* True means that this variable has been explicitly declared
1312 special (with `defvar' etc), and shouldn't be lexically bound. */
1313 bool_bf declared_special
: 1;
1315 /* True if pointed to from purespace and hence can't be GC'd. */
1318 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1319 union is used depends on the `redirect' field above. */
1322 struct Lisp_Symbol
*alias
;
1323 struct Lisp_Buffer_Local_Value
*blv
;
1324 union Lisp_Fwd
*fwd
;
1328 /* Value is name of symbol. */
1330 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1332 INLINE
struct Lisp_Symbol
*
1333 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1335 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1336 return sym
->val
.alias
;
1338 INLINE
struct Lisp_Buffer_Local_Value
*
1339 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1341 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1342 return sym
->val
.blv
;
1344 INLINE
union Lisp_Fwd
*
1345 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1347 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1348 return sym
->val
.fwd
;
1351 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1352 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1355 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1357 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1361 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1363 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1367 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1369 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1374 SYMBOL_NAME (Lisp_Object sym
)
1376 return build_string (scm_to_locale_string (scm_symbol_to_string (sym
)));
1379 /* Value is true if SYM is an interned symbol. */
1382 SYMBOL_INTERNED_P (Lisp_Object sym
)
1384 return scm_is_true (scm_symbol_interned_p (sym
));
1388 SYMBOL_FUNCTION (Lisp_Object sym
)
1390 return scm_variable_ref (scm_module_lookup (function_module
, sym
));
1393 /* Value is non-zero if symbol is considered a constant, i.e. its
1394 value cannot be changed (there is an exception for keyword symbols,
1395 whose value can be set to the keyword symbol itself). */
1397 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1399 #define DEFSYM(sym, name) \
1400 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1403 /***********************************************************************
1405 ***********************************************************************/
1407 /* The structure of a Lisp hash table. */
1409 struct hash_table_test
1411 /* Name of the function used to compare keys. */
1414 /* User-supplied hash function, or nil. */
1415 Lisp_Object user_hash_function
;
1417 /* User-supplied key comparison function, or nil. */
1418 Lisp_Object user_cmp_function
;
1420 /* C function to compare two keys. */
1421 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1423 /* C function to compute hash code. */
1424 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1427 struct Lisp_Hash_Table
1429 /* This is for Lisp; the hash table code does not refer to it. */
1430 struct vectorlike_header header
;
1432 /* Nil if table is non-weak. Otherwise a symbol describing the
1433 weakness of the table. */
1436 /* When the table is resized, and this is an integer, compute the
1437 new size by adding this to the old size. If a float, compute the
1438 new size by multiplying the old size with this factor. */
1439 Lisp_Object rehash_size
;
1441 /* Resize hash table when number of entries/ table size is >= this
1443 Lisp_Object rehash_threshold
;
1445 /* Vector of hash codes. If hash[I] is nil, this means that the
1446 I-th entry is unused. */
1449 /* Vector used to chain entries. If entry I is free, next[I] is the
1450 entry number of the next free item. If entry I is non-free,
1451 next[I] is the index of the next entry in the collision chain. */
1454 /* Index of first free entry in free list. */
1455 Lisp_Object next_free
;
1457 /* Bucket vector. A non-nil entry is the index of the first item in
1458 a collision chain. This vector's size can be larger than the
1459 hash table size to reduce collisions. */
1462 /* Only the fields above are traced normally by the GC. The ones below
1463 `count' are special and are either ignored by the GC or traced in
1464 a special way (e.g. because of weakness). */
1466 /* Number of key/value entries in the table. */
1469 /* Vector of keys and values. The key of item I is found at index
1470 2 * I, the value is found at index 2 * I + 1.
1471 This is gc_marked specially if the table is weak. */
1472 Lisp_Object key_and_value
;
1474 /* The comparison and hash functions. */
1475 struct hash_table_test test
;
1477 /* Next weak hash table if this is a weak hash table. The head
1478 of the list is in weak_hash_tables. */
1479 struct Lisp_Hash_Table
*next_weak
;
1483 INLINE
struct Lisp_Hash_Table
*
1484 XHASH_TABLE (Lisp_Object a
)
1486 return SMOB_PTR (a
);
1489 #define XSET_HASH_TABLE(VAR, PTR) \
1490 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1493 HASH_TABLE_P (Lisp_Object a
)
1495 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1498 /* Value is the key part of entry IDX in hash table H. */
1500 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1502 return AREF (h
->key_and_value
, 2 * idx
);
1505 /* Value is the value part of entry IDX in hash table H. */
1507 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1509 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1512 /* Value is the index of the next entry following the one at IDX
1515 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1517 return AREF (h
->next
, idx
);
1520 /* Value is the hash code computed for entry IDX in hash table H. */
1522 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1524 return AREF (h
->hash
, idx
);
1527 /* Value is the index of the element in hash table H that is the
1528 start of the collision list at index IDX in the index vector of H. */
1530 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1532 return AREF (h
->index
, idx
);
1535 /* Value is the size of hash table H. */
1537 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1539 return ASIZE (h
->next
);
1542 /* Default size for hash tables if not specified. */
1544 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1546 /* Default threshold specifying when to resize a hash table. The
1547 value gives the ratio of current entries in the hash table and the
1548 size of the hash table. */
1550 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1552 /* Default factor by which to increase the size of a hash table. */
1554 static double const DEFAULT_REHASH_SIZE
= 1.5;
1556 /* Combine two integers X and Y for hashing. The result might not fit
1557 into a Lisp integer. */
1560 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1562 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1565 /* Hash X, returning a value that fits into a fixnum. */
1568 SXHASH_REDUCE (EMACS_UINT x
)
1570 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1573 /* These structures are used for various misc types. */
1575 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1578 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1584 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1585 /* This flag is temporarily used in the functions
1586 decode/encode_coding_object to record that the marker position
1587 must be adjusted after the conversion. */
1588 bool_bf need_adjustment
: 1;
1589 /* True means normal insertion at the marker's position
1590 leaves the marker after the inserted text. */
1591 bool_bf insertion_type
: 1;
1592 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1593 Note: a chain of markers can contain markers pointing into different
1594 buffers (the chain is per buffer_text rather than per buffer, so it's
1595 shared between indirect buffers). */
1596 /* This is used for (other than NULL-checking):
1598 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1599 - unchain_marker: to find the list from which to unchain.
1600 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1602 struct buffer
*buffer
;
1604 /* The remaining fields are meaningless in a marker that
1605 does not point anywhere. */
1607 /* For markers that point somewhere,
1608 this is used to chain of all the markers in a given buffer. */
1609 /* We could remove it and use an array in buffer_text instead.
1610 That would also allow to preserve it ordered. */
1611 struct Lisp_Marker
*next
;
1612 /* This is the char position where the marker points. */
1614 /* This is the byte position.
1615 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1616 used to implement the functionality of markers, but rather to (ab)use
1617 markers as a cache for char<->byte mappings). */
1621 /* START and END are markers in the overlay's buffer, and
1622 PLIST is the overlay's property list. */
1624 /* An overlay's real data content is:
1626 - buffer (really there are two buffer pointers, one per marker,
1627 and both points to the same buffer)
1628 - insertion type of both ends (per-marker fields)
1629 - start & start byte (of start marker)
1630 - end & end byte (of end marker)
1631 - next (singly linked list of overlays)
1632 - next fields of start and end markers (singly linked list of markers).
1633 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1637 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1638 struct Lisp_Overlay
*next
;
1644 /* Types of data which may be saved in a Lisp_Save_Value. */
1655 /* Number of bits needed to store one of the above values. */
1656 enum { SAVE_SLOT_BITS
= 3 };
1658 /* Number of slots in a save value where save_type is nonzero. */
1659 enum { SAVE_VALUE_SLOTS
= 4 };
1661 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1663 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1667 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1668 SAVE_TYPE_INT_INT_INT
1669 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1670 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1671 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1672 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1673 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1674 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1675 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1676 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1677 SAVE_TYPE_FUNCPTR_PTR_OBJ
1678 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1680 /* This has an extra bit indicating it's raw memory. */
1681 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1684 /* Special object used to hold a different values for later use.
1686 This is mostly used to package C integers and pointers to call
1687 record_unwind_protect when two or more values need to be saved.
1691 struct my_data *md = get_my_data ();
1692 ptrdiff_t mi = get_my_integer ();
1693 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1696 Lisp_Object my_unwind (Lisp_Object arg)
1698 struct my_data *md = XSAVE_POINTER (arg, 0);
1699 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1703 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1704 saved objects and raise eassert if type of the saved object doesn't match
1705 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1706 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1707 slot 0 is a pointer. */
1709 typedef void (*voidfuncptr
) (void);
1711 struct Lisp_Save_Value
1714 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1715 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1717 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1718 V's data entries are determined by V->save_type. E.g., if
1719 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1720 V->data[1] is an integer, and V's other data entries are unused.
1722 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1723 a memory area containing V->data[1].integer potential Lisp_Objects. */
1724 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1727 voidfuncptr funcpointer
;
1730 } data
[SAVE_VALUE_SLOTS
];
1733 /* Return the type of V's Nth saved value. */
1735 save_type (struct Lisp_Save_Value
*v
, int n
)
1737 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1738 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1741 /* Get and set the Nth saved pointer. */
1744 XSAVE_POINTER (Lisp_Object obj
, int n
)
1746 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1747 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1750 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1752 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1753 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1756 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1758 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1759 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1762 /* Likewise for the saved integer. */
1765 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1767 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1768 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1771 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1773 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1774 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1777 /* Extract Nth saved object. */
1780 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1782 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1783 return XSAVE_VALUE (obj
)->data
[n
].object
;
1786 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1787 It uses one of these struct subtypes to get the type field. */
1791 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1792 struct Lisp_Marker u_marker
;
1793 struct Lisp_Overlay u_overlay
;
1794 struct Lisp_Save_Value u_save_value
;
1797 INLINE
union Lisp_Misc
*
1798 XMISC (Lisp_Object a
)
1800 return SMOB_PTR (a
);
1803 INLINE
struct Lisp_Misc_Any
*
1804 XMISCANY (Lisp_Object a
)
1806 eassert (MISCP (a
));
1807 return & XMISC (a
)->u_any
;
1810 INLINE
enum Lisp_Misc_Type
1811 XMISCTYPE (Lisp_Object a
)
1813 return XMISCANY (a
)->type
;
1816 INLINE
struct Lisp_Marker
*
1817 XMARKER (Lisp_Object a
)
1819 eassert (MARKERP (a
));
1820 return & XMISC (a
)->u_marker
;
1823 INLINE
struct Lisp_Overlay
*
1824 XOVERLAY (Lisp_Object a
)
1826 eassert (OVERLAYP (a
));
1827 return & XMISC (a
)->u_overlay
;
1830 INLINE
struct Lisp_Save_Value
*
1831 XSAVE_VALUE (Lisp_Object a
)
1833 eassert (SAVE_VALUEP (a
));
1834 return & XMISC (a
)->u_save_value
;
1837 /* Forwarding pointer to an int variable.
1838 This is allowed only in the value cell of a symbol,
1839 and it means that the symbol's value really lives in the
1840 specified int variable. */
1843 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1847 /* Boolean forwarding pointer to an int variable.
1848 This is like Lisp_Intfwd except that the ostensible
1849 "value" of the symbol is t if the bool variable is true,
1850 nil if it is false. */
1853 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1857 /* Forwarding pointer to a Lisp_Object variable.
1858 This is allowed only in the value cell of a symbol,
1859 and it means that the symbol's value really lives in the
1860 specified variable. */
1863 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1864 Lisp_Object
*objvar
;
1867 /* Like Lisp_Objfwd except that value lives in a slot in the
1868 current buffer. Value is byte index of slot within buffer. */
1869 struct Lisp_Buffer_Objfwd
1871 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1873 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1874 Lisp_Object predicate
;
1877 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1878 the symbol has buffer-local or frame-local bindings. (Exception:
1879 some buffer-local variables are built-in, with their values stored
1880 in the buffer structure itself. They are handled differently,
1881 using struct Lisp_Buffer_Objfwd.)
1883 The `realvalue' slot holds the variable's current value, or a
1884 forwarding pointer to where that value is kept. This value is the
1885 one that corresponds to the loaded binding. To read or set the
1886 variable, you must first make sure the right binding is loaded;
1887 then you can access the value in (or through) `realvalue'.
1889 `buffer' and `frame' are the buffer and frame for which the loaded
1890 binding was found. If those have changed, to make sure the right
1891 binding is loaded it is necessary to find which binding goes with
1892 the current buffer and selected frame, then load it. To load it,
1893 first unload the previous binding, then copy the value of the new
1894 binding into `realvalue' (or through it). Also update
1895 LOADED-BINDING to point to the newly loaded binding.
1897 `local_if_set' indicates that merely setting the variable creates a
1898 local binding for the current buffer. Otherwise the latter, setting
1899 the variable does not do that; only make-local-variable does that. */
1901 struct Lisp_Buffer_Local_Value
1903 /* True means that merely setting the variable creates a local
1904 binding for the current buffer. */
1905 bool_bf local_if_set
: 1;
1906 /* True means this variable can have frame-local bindings, otherwise, it is
1907 can have buffer-local bindings. The two cannot be combined. */
1908 bool_bf frame_local
: 1;
1909 /* True means that the binding now loaded was found.
1910 Presumably equivalent to (defcell!=valcell). */
1912 /* If non-NULL, a forwarding to the C var where it should also be set. */
1913 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1914 /* The buffer or frame for which the loaded binding was found. */
1916 /* A cons cell that holds the default value. It has the form
1917 (SYMBOL . DEFAULT-VALUE). */
1918 Lisp_Object defcell
;
1919 /* The cons cell from `where's parameter alist.
1920 It always has the form (SYMBOL . VALUE)
1921 Note that if `forward' is non-nil, VALUE may be out of date.
1922 Also if the currently loaded binding is the default binding, then
1923 this is `eq'ual to defcell. */
1924 Lisp_Object valcell
;
1927 /* Like Lisp_Objfwd except that value lives in a slot in the
1929 struct Lisp_Kboard_Objfwd
1931 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1937 struct Lisp_Intfwd u_intfwd
;
1938 struct Lisp_Boolfwd u_boolfwd
;
1939 struct Lisp_Objfwd u_objfwd
;
1940 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1941 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1944 INLINE
enum Lisp_Fwd_Type
1945 XFWDTYPE (union Lisp_Fwd
*a
)
1947 return a
->u_intfwd
.type
;
1950 INLINE
struct Lisp_Buffer_Objfwd
*
1951 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
1953 eassert (BUFFER_OBJFWDP (a
));
1954 return &a
->u_buffer_objfwd
;
1957 #define XFLOAT_DATA(f) (scm_to_double (f))
1959 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1960 representations, have infinities and NaNs, and do not trap on
1961 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1962 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1963 wanted here, but is not quite right because Emacs does not require
1964 all the features of C11 Annex F (and does not require C11 at all,
1965 for that matter). */
1969 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
1970 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
1973 /* A character, declared with the following typedef, is a member
1974 of some character set associated with the current buffer. */
1975 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1977 typedef unsigned char UCHAR
;
1980 /* Meanings of slots in a Lisp_Compiled: */
1984 COMPILED_ARGLIST
= 0,
1985 COMPILED_BYTECODE
= 1,
1986 COMPILED_CONSTANTS
= 2,
1987 COMPILED_STACK_DEPTH
= 3,
1988 COMPILED_DOC_STRING
= 4,
1989 COMPILED_INTERACTIVE
= 5
1992 /* Flag bits in a character. These also get used in termhooks.h.
1993 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1994 (MUlti-Lingual Emacs) might need 22 bits for the character value
1995 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1998 CHAR_ALT
= 0x0400000,
1999 CHAR_SUPER
= 0x0800000,
2000 CHAR_HYPER
= 0x1000000,
2001 CHAR_SHIFT
= 0x2000000,
2002 CHAR_CTL
= 0x4000000,
2003 CHAR_META
= 0x8000000,
2005 CHAR_MODIFIER_MASK
=
2006 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2008 /* Actually, the current Emacs uses 22 bits for the character value
2013 /* Data type checking. */
2015 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2018 NUMBERP (Lisp_Object x
)
2020 return INTEGERP (x
) || FLOATP (x
);
2023 NATNUMP (Lisp_Object x
)
2025 return INTEGERP (x
) && 0 <= XINT (x
);
2029 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2031 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2034 #define TYPE_RANGED_INTEGERP(type, x) \
2036 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2037 && XINT (x) <= TYPE_MAXIMUM (type))
2039 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2040 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2041 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2042 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2043 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2044 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2045 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2048 STRINGP (Lisp_Object x
)
2050 return SMOB_TYPEP (x
, lisp_string_tag
);
2053 VECTORP (Lisp_Object x
)
2055 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2058 OVERLAYP (Lisp_Object x
)
2060 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2063 SAVE_VALUEP (Lisp_Object x
)
2065 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2069 AUTOLOADP (Lisp_Object x
)
2071 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2075 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2077 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2081 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2083 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2084 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2087 /* True if A is a pseudovector whose code is CODE. */
2089 PSEUDOVECTORP (Lisp_Object a
, int code
)
2091 if (! VECTORLIKEP (a
))
2095 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2096 struct vectorlike_header
*h
= SMOB_PTR (a
);
2097 return PSEUDOVECTOR_TYPEP (h
, code
);
2101 /* Test for specific pseudovector types. */
2104 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2106 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2110 PROCESSP (Lisp_Object a
)
2112 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2116 WINDOWP (Lisp_Object a
)
2118 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2122 TERMINALP (Lisp_Object a
)
2124 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2128 SUBRP (Lisp_Object a
)
2130 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2134 COMPILEDP (Lisp_Object a
)
2136 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2140 BUFFERP (Lisp_Object a
)
2142 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2146 CHAR_TABLE_P (Lisp_Object a
)
2148 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2152 SUB_CHAR_TABLE_P (Lisp_Object a
)
2154 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2158 BOOL_VECTOR_P (Lisp_Object a
)
2160 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2164 FRAMEP (Lisp_Object a
)
2166 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2169 /* Test for image (image . spec) */
2171 IMAGEP (Lisp_Object x
)
2173 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2178 ARRAYP (Lisp_Object x
)
2180 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2184 CHECK_LIST (Lisp_Object x
)
2186 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2189 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2190 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2191 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2194 CHECK_STRING (Lisp_Object x
)
2196 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2199 CHECK_STRING_CAR (Lisp_Object x
)
2201 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2204 CHECK_CONS (Lisp_Object x
)
2206 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2209 CHECK_VECTOR (Lisp_Object x
)
2211 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2214 CHECK_BOOL_VECTOR (Lisp_Object x
)
2216 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2219 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2221 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2224 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2226 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2229 CHECK_BUFFER (Lisp_Object x
)
2231 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2234 CHECK_WINDOW (Lisp_Object x
)
2236 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2240 CHECK_PROCESS (Lisp_Object x
)
2242 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2246 CHECK_NATNUM (Lisp_Object x
)
2248 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2251 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2254 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2255 args_out_of_range_3 \
2257 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2258 ? MOST_NEGATIVE_FIXNUM \
2260 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2262 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2264 if (TYPE_SIGNED (type)) \
2265 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2267 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2270 #define CHECK_NUMBER_COERCE_MARKER(x) \
2272 if (MARKERP ((x))) \
2273 XSETFASTINT (x, marker_position (x)); \
2275 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2279 XFLOATINT (Lisp_Object n
)
2281 return extract_float (n
);
2285 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2287 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2290 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2293 XSETFASTINT (x, marker_position (x)); \
2295 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2298 /* Since we can't assign directly to the CAR or CDR fields of a cons
2299 cell, use these when checking that those fields contain numbers. */
2301 CHECK_NUMBER_CAR (Lisp_Object x
)
2303 Lisp_Object tmp
= XCAR (x
);
2309 CHECK_NUMBER_CDR (Lisp_Object x
)
2311 Lisp_Object tmp
= XCDR (x
);
2316 /* Define a built-in function for calling from Lisp.
2317 `lname' should be the name to give the function in Lisp,
2318 as a null-terminated C string.
2319 `fnname' should be the name of the function in C.
2320 By convention, it starts with F.
2321 `sname' should be the name for the C constant structure
2322 that records information on this function for internal use.
2323 By convention, it should be the same as `fnname' but with S instead of F.
2324 It's too bad that C macros can't compute this from `fnname'.
2325 `minargs' should be a number, the minimum number of arguments allowed.
2326 `maxargs' should be a number, the maximum number of arguments allowed,
2327 or else MANY or UNEVALLED.
2328 MANY means pass a vector of evaluated arguments,
2329 in the form of an integer number-of-arguments
2330 followed by the address of a vector of Lisp_Objects
2331 which contains the argument values.
2332 UNEVALLED means pass the list of unevaluated arguments
2333 `intspec' says how interactive arguments are to be fetched.
2334 If the string starts with a `(', `intspec' is evaluated and the resulting
2335 list is the list of arguments.
2336 If it's a string that doesn't start with `(', the value should follow
2337 the one of the doc string for `interactive'.
2338 A null string means call interactively with no arguments.
2339 `doc' is documentation for the user. */
2341 /* This version of DEFUN declares a function prototype with the right
2342 arguments, so we can catch errors with maxargs at compile-time. */
2344 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2345 SCM_SNARF_INIT (defsubr (&sname);) \
2346 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2347 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2349 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2350 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2351 { (Lisp_Object (__cdecl *)(void))fnname }, \
2352 minargs, maxargs, lname, intspec, 0}; \
2354 #else /* not _MSC_VER */
2355 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2356 SCM_SNARF_INIT (defsubr (&sname);) \
2357 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2358 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2360 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2361 { .a ## maxargs = fnname }, \
2362 minargs, maxargs, lname, intspec, 0}; \
2366 /* Note that the weird token-substitution semantics of ANSI C makes
2367 this work for MANY and UNEVALLED. */
2368 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2369 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2370 #define DEFUN_ARGS_0 (void)
2371 #define DEFUN_ARGS_1 (Lisp_Object)
2372 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2373 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2374 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2375 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2377 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2378 Lisp_Object, Lisp_Object)
2379 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2380 Lisp_Object, Lisp_Object, Lisp_Object)
2381 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2382 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2384 /* True if OBJ is a Lisp function. */
2386 FUNCTIONP (Lisp_Object obj
)
2388 return functionp (obj
);
2392 is how we define the symbol for function `name' at start-up time. */
2393 extern void defsubr (struct Lisp_Subr
*);
2401 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2402 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2403 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2404 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2405 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2407 /* Macros we use to define forwarded Lisp variables.
2408 These are used in the syms_of_FILENAME functions.
2410 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2411 lisp variable is actually a field in `struct emacs_globals'. The
2412 field's name begins with "f_", which is a convention enforced by
2413 these macros. Each such global has a corresponding #define in
2414 globals.h; the plain name should be used in the code.
2416 E.g., the global "cons_cells_consed" is declared as "int
2417 f_cons_cells_consed" in globals.h, but there is a define:
2419 #define cons_cells_consed globals.f_cons_cells_consed
2421 All C code uses the `cons_cells_consed' name. This is all done
2422 this way to support indirection for multi-threaded Emacs. */
2424 #define DEFVAR_LISP(lname, vname, doc) \
2426 static struct Lisp_Objfwd o_fwd; \
2427 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2429 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2431 static struct Lisp_Objfwd o_fwd; \
2432 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2434 #define DEFVAR_BOOL(lname, vname, doc) \
2436 static struct Lisp_Boolfwd b_fwd; \
2437 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2439 #define DEFVAR_INT(lname, vname, doc) \
2441 static struct Lisp_Intfwd i_fwd; \
2442 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2445 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2447 static struct Lisp_Objfwd o_fwd; \
2448 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2451 #define DEFVAR_KBOARD(lname, vname, doc) \
2453 static struct Lisp_Kboard_Objfwd ko_fwd; \
2454 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2457 /* Save and restore the instruction and environment pointers,
2458 without affecting the signal mask. */
2461 typedef jmp_buf sys_jmp_buf
;
2462 # define sys_setjmp(j) _setjmp (j)
2463 # define sys_longjmp(j, v) _longjmp (j, v)
2464 #elif defined HAVE_SIGSETJMP
2465 typedef sigjmp_buf sys_jmp_buf
;
2466 # define sys_setjmp(j) sigsetjmp (j, 0)
2467 # define sys_longjmp(j, v) siglongjmp (j, v)
2469 /* A platform that uses neither _longjmp nor siglongjmp; assume
2470 longjmp does not affect the sigmask. */
2471 typedef jmp_buf sys_jmp_buf
;
2472 # define sys_setjmp(j) setjmp (j)
2473 # define sys_longjmp(j, v) longjmp (j, v)
2477 /* Elisp uses several stacks:
2479 - the bytecode stack: used internally by the bytecode interpreter.
2480 Allocated from the C stack.
2481 - The specpdl stack: keeps track of active unwind-protect and
2482 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2484 - The handler stack: keeps track of active catch tags and condition-case
2485 handlers. Allocated in a manually managed stack implemented by a
2486 doubly-linked list allocated via xmalloc and never freed. */
2488 /* Structure for recording Lisp call stack for backtrace purposes. */
2490 /* The special binding stack holds the outer values of variables while
2491 they are bound by a function application or a let form, stores the
2492 code to be executed for unwind-protect forms.
2494 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2495 used all over the place, needs to be fast, and needs to know the size of
2496 union specbinding. But only eval.c should access it. */
2499 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2500 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2501 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2502 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2503 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2508 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2510 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2513 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2514 bool wind_explicitly
;
2515 void (*func
) (Lisp_Object
);
2519 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2520 bool wind_explicitly
;
2521 void (*func
) (void *);
2525 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2526 bool wind_explicitly
;
2531 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2532 bool wind_explicitly
;
2533 void (*func
) (void);
2536 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2537 /* `where' is not used in the case of SPECPDL_LET. */
2538 Lisp_Object symbol
, old_value
, where
;
2541 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2542 bool_bf debug_on_exit
: 1;
2543 Lisp_Object function
;
2549 extern union specbinding
*specpdl
;
2550 extern union specbinding
*specpdl_ptr
;
2551 extern ptrdiff_t specpdl_size
;
2554 SPECPDL_INDEX (void)
2556 return specpdl_ptr
- specpdl
;
2559 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2560 control structures. A struct handler contains all the information needed to
2561 restore the state of the interpreter after a non-local jump.
2563 handler structures are chained together in a doubly linked list; the `next'
2564 member points to the next outer catchtag and the `nextfree' member points in
2565 the other direction to the next inner element (which is typically the next
2566 free element since we mostly use it on the deepest handler).
2568 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2569 member is TAG, and then unbinds to it. The `val' member is used to
2570 hold VAL while the stack is unwound; `val' is returned as the value
2573 All the other members are concerned with restoring the interpreter
2576 Members are volatile if their values need to survive _longjmp when
2577 a 'struct handler' is a local variable. */
2579 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2583 enum handlertype type
;
2585 Lisp_Object tag_or_ch
;
2589 struct handler
*next
;
2590 EMACS_INT lisp_eval_depth
;
2591 int poll_suppress_count
;
2592 int interrupt_input_blocked
;
2595 extern Lisp_Object memory_signal_data
;
2597 /* Check quit-flag and quit if it is non-nil.
2598 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2599 So the program needs to do QUIT at times when it is safe to quit.
2600 Every loop that might run for a long time or might not exit
2601 ought to do QUIT at least once, at a safe place.
2602 Unless that is impossible, of course.
2603 But it is very desirable to avoid creating loops where QUIT is impossible.
2605 Exception: if you set immediate_quit to true,
2606 then the handler that responds to the C-g does the quit itself.
2607 This is a good thing to do around a loop that has no side effects
2608 and (in particular) cannot call arbitrary Lisp code.
2610 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2611 a request to exit Emacs when it is safe to do. */
2613 extern void process_pending_signals (void);
2614 extern bool volatile pending_signals
;
2616 extern void process_quit_flag (void);
2619 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2620 process_quit_flag (); \
2621 else if (pending_signals) \
2622 process_pending_signals (); \
2626 /* True if ought to quit now. */
2628 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2630 extern Lisp_Object Vascii_downcase_table
;
2631 extern Lisp_Object Vascii_canon_table
;
2633 /* Structure for recording stack slots that need marking. */
2635 /* This is a chain of structures, each of which points at a Lisp_Object
2636 variable whose value should be marked in garbage collection.
2637 Normally every link of the chain is an automatic variable of a function,
2638 and its `val' points to some argument or local variable of the function.
2639 On exit to the function, the chain is set back to the value it had on entry.
2640 This way, no link remains in the chain when the stack frame containing the
2643 Every function that can call Feval must protect in this fashion all
2644 Lisp_Object variables whose contents will be used again. */
2646 extern struct gcpro
*gcprolist
;
2652 /* Address of first protected variable. */
2653 volatile Lisp_Object
*var
;
2655 /* Number of consecutive protected variables. */
2663 /* Do something silly with gcproN vars just so gcc shuts up. */
2664 /* You get warnings from MIPSPro... */
2666 #define GCPRO1(varname) ((void) gcpro1)
2667 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2668 #define GCPRO3(varname1, varname2, varname3) \
2669 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2670 #define GCPRO4(varname1, varname2, varname3, varname4) \
2671 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2672 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2673 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2674 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2675 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2677 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2678 #define UNGCPRO ((void) 0)
2680 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2681 #define RETURN_UNGCPRO(expr) \
2684 Lisp_Object ret_ungc_val; \
2685 ret_ungc_val = (expr); \
2687 return ret_ungc_val; \
2691 /* Call staticpro (&var) to protect static variable `var'. */
2693 void staticpro (Lisp_Object
*);
2695 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2696 meaning as in the DEFUN macro, and is used to construct a prototype. */
2697 /* We can use the same trick as in the DEFUN macro to generate the
2698 appropriate prototype. */
2699 #define EXFUN(fnname, maxargs) \
2700 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2702 #include "globals.h"
2704 /* Forward declarations for prototypes. */
2708 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2711 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2713 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2714 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2717 /* Functions to modify hash tables. */
2720 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2722 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2726 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2728 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2731 /* Use these functions to set Lisp_Object
2732 or pointer slots of struct Lisp_Symbol. */
2735 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2737 scm_variable_set_x (scm_module_lookup (function_module
, sym
), function
);
2741 symbol_plist (Lisp_Object sym
)
2743 return scm_variable_ref (scm_module_lookup (plist_module
, sym
));
2747 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2749 scm_variable_set_x (scm_module_lookup (plist_module
, sym
), plist
);
2752 /* Buffer-local (also frame-local) variable access functions. */
2755 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2757 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2761 /* Set overlay's property list. */
2764 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2766 XOVERLAY (overlay
)->plist
= plist
;
2769 /* Get text properties of S. */
2772 string_intervals (Lisp_Object s
)
2774 return XSTRING (s
)->intervals
;
2777 /* Set text properties of S to I. */
2780 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2782 XSTRING (s
)->intervals
= i
;
2785 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2786 of setting slots directly. */
2789 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2791 XCHAR_TABLE (table
)->defalt
= val
;
2794 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2796 XCHAR_TABLE (table
)->purpose
= val
;
2799 /* Set different slots in (sub)character tables. */
2802 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2804 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2805 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2809 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2811 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2812 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2816 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2818 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2821 /* Defined in data.c. */
2822 extern Lisp_Object Qquote
, Qunbound
;
2823 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2824 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2825 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2826 extern Lisp_Object Qinvalid_read_syntax
;
2827 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2828 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2829 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2830 extern Lisp_Object Qtext_read_only
;
2831 extern Lisp_Object Qinteractive_form
;
2832 extern Lisp_Object Qcircular_list
;
2833 extern Lisp_Object Qsequencep
;
2834 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2835 extern Lisp_Object Qfboundp
;
2837 extern Lisp_Object Qcdr
;
2839 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2841 extern Lisp_Object Qnumber_or_marker_p
;
2843 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2845 /* Defined in data.c. */
2846 extern Lisp_Object
indirect_function (Lisp_Object
);
2847 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2848 enum Arith_Comparison
{
2853 ARITH_LESS_OR_EQUAL
,
2856 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2857 enum Arith_Comparison comparison
);
2859 /* Convert the integer I to an Emacs representation, either the integer
2860 itself, or a cons of two or three integers, or if all else fails a float.
2861 I should not have side effects. */
2862 #define INTEGER_TO_CONS(i) \
2863 (! FIXNUM_OVERFLOW_P (i) \
2865 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2866 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2867 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2868 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2869 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2870 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2871 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2872 ? Fcons (make_number ((i) >> 16 >> 24), \
2873 Fcons (make_number ((i) >> 16 & 0xffffff), \
2874 make_number ((i) & 0xffff))) \
2877 /* Convert the Emacs representation CONS back to an integer of type
2878 TYPE, storing the result the variable VAR. Signal an error if CONS
2879 is not a valid representation or is out of range for TYPE. */
2880 #define CONS_TO_INTEGER(cons, type, var) \
2881 (TYPE_SIGNED (type) \
2882 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2883 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2884 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2885 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2887 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2888 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2889 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2891 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2892 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2893 extern void syms_of_data (void);
2894 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2896 /* Defined in cmds.c */
2897 extern void syms_of_cmds (void);
2898 extern void keys_of_cmds (void);
2900 /* Defined in coding.c. */
2901 extern Lisp_Object Qcharset
;
2902 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2903 ptrdiff_t, bool, bool, Lisp_Object
);
2904 extern void init_coding (void);
2905 extern void init_coding_once (void);
2906 extern void syms_of_coding (void);
2908 /* Defined in character.c. */
2909 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2910 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2911 extern void syms_of_character (void);
2913 /* Defined in charset.c. */
2914 extern void init_charset (void);
2915 extern void init_charset_once (void);
2916 extern void syms_of_charset (void);
2917 /* Structure forward declarations. */
2920 /* Defined in syntax.c. */
2921 extern void init_syntax_once (void);
2922 extern void syms_of_syntax (void);
2924 /* Defined in fns.c. */
2925 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2926 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2927 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2928 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2929 extern void sweep_weak_hash_tables (void);
2930 extern Lisp_Object Qcursor_in_echo_area
;
2931 extern Lisp_Object Qstring_lessp
;
2932 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2933 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2934 EMACS_UINT
sxhash (Lisp_Object
, int);
2935 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2936 Lisp_Object
, Lisp_Object
);
2937 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2938 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2940 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2941 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2942 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2943 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2944 ptrdiff_t, ptrdiff_t);
2945 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2946 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2947 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2948 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2949 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2950 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2951 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2952 extern void clear_string_char_byte_cache (void);
2953 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2954 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2955 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2956 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2957 extern void init_fns_once (void);
2958 extern void syms_of_fns (void);
2960 /* Defined in floatfns.c. */
2961 extern void syms_of_floatfns (void);
2962 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2964 /* Defined in fringe.c. */
2965 extern void syms_of_fringe (void);
2966 extern void init_fringe (void);
2967 #ifdef HAVE_WINDOW_SYSTEM
2968 extern void mark_fringe_data (void);
2969 extern void init_fringe_once (void);
2970 #endif /* HAVE_WINDOW_SYSTEM */
2972 /* Defined in image.c. */
2973 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2974 extern Lisp_Object QCconversion
;
2975 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2976 extern void reset_image_types (void);
2977 extern void syms_of_image (void);
2979 /* Defined in insdel.c. */
2980 extern Lisp_Object Qinhibit_modification_hooks
;
2981 extern Lisp_Object Qregion_extract_function
;
2982 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2983 extern _Noreturn
void buffer_overflow (void);
2984 extern void make_gap (ptrdiff_t);
2985 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
2986 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
2987 ptrdiff_t, bool, bool);
2988 extern int count_combining_before (const unsigned char *,
2989 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2990 extern int count_combining_after (const unsigned char *,
2991 ptrdiff_t, ptrdiff_t, ptrdiff_t);
2992 extern void insert (const char *, ptrdiff_t);
2993 extern void insert_and_inherit (const char *, ptrdiff_t);
2994 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
2996 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
2997 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2998 ptrdiff_t, ptrdiff_t, bool);
2999 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3000 extern void insert_char (int);
3001 extern void insert_string (const char *);
3002 extern void insert_before_markers (const char *, ptrdiff_t);
3003 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3004 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3005 ptrdiff_t, ptrdiff_t,
3007 extern void del_range (ptrdiff_t, ptrdiff_t);
3008 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3009 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3010 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3011 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3012 ptrdiff_t, ptrdiff_t, bool);
3013 extern void modify_text (ptrdiff_t, ptrdiff_t);
3014 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3015 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3016 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3017 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3018 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3019 ptrdiff_t, ptrdiff_t);
3020 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3021 ptrdiff_t, ptrdiff_t);
3022 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3023 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3024 const char *, ptrdiff_t, ptrdiff_t, bool);
3025 extern void syms_of_insdel (void);
3027 /* Defined in dispnew.c. */
3028 #if (defined PROFILING \
3029 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3030 _Noreturn
void __executable_start (void);
3032 extern Lisp_Object Vwindow_system
;
3033 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3035 /* Defined in xdisp.c. */
3036 extern Lisp_Object Qinhibit_point_motion_hooks
;
3037 extern Lisp_Object Qinhibit_redisplay
;
3038 extern Lisp_Object Qmenu_bar_update_hook
;
3039 extern Lisp_Object Qwindow_scroll_functions
;
3040 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3041 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3042 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3043 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3044 extern Lisp_Object Qleft_margin
, Qright_margin
;
3045 extern Lisp_Object QCdata
, QCfile
;
3046 extern Lisp_Object QCmap
;
3047 extern Lisp_Object Qrisky_local_variable
;
3048 extern bool noninteractive_need_newline
;
3049 extern Lisp_Object echo_area_buffer
[2];
3050 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3051 extern void check_message_stack (void);
3052 extern void setup_echo_area_for_printing (int);
3053 extern bool push_message (void);
3054 extern void pop_message_unwind (void);
3055 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3056 extern void restore_message (void);
3057 extern Lisp_Object
current_message (void);
3058 extern void clear_message (bool, bool);
3059 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3060 extern void message1 (const char *);
3061 extern void message1_nolog (const char *);
3062 extern void message3 (Lisp_Object
);
3063 extern void message3_nolog (Lisp_Object
);
3064 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3065 extern void message_with_string (const char *, Lisp_Object
, int);
3066 extern void message_log_maybe_newline (void);
3067 extern void update_echo_area (void);
3068 extern void truncate_echo_area (ptrdiff_t);
3069 extern void redisplay (void);
3071 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3072 extern void syms_of_xdisp (void);
3073 extern void init_xdisp (void);
3074 extern Lisp_Object
safe_eval (Lisp_Object
);
3075 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3076 int *, int *, int *, int *, int *);
3078 /* Defined in xsettings.c. */
3079 extern void syms_of_xsettings (void);
3081 /* Defined in vm-limit.c. */
3082 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3084 /* Defined in alloc.c. */
3085 extern void check_pure_size (void);
3086 extern void free_misc (Lisp_Object
);
3087 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3088 extern void malloc_warning (const char *);
3089 extern _Noreturn
void memory_full (size_t);
3090 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3091 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3092 extern void refill_memory_reserve (void);
3094 extern const char *pending_malloc_warning
;
3095 extern Lisp_Object zero_vector
;
3096 extern Lisp_Object
list1 (Lisp_Object
);
3097 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3098 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3099 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3100 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3102 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3103 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3105 /* Build a frequently used 2/3/4-integer lists. */
3108 list2i (EMACS_INT x
, EMACS_INT y
)
3110 return list2 (make_number (x
), make_number (y
));
3114 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3116 return list3 (make_number (x
), make_number (y
), make_number (w
));
3120 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3122 return list4 (make_number (x
), make_number (y
),
3123 make_number (w
), make_number (h
));
3126 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3127 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3128 extern _Noreturn
void string_overflow (void);
3129 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3130 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3131 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3132 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3134 /* Make unibyte string from C string when the length isn't known. */
3137 build_unibyte_string (const char *str
)
3139 return make_unibyte_string (str
, strlen (str
));
3142 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3143 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3144 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3145 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3146 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3147 extern Lisp_Object
make_specified_string (const char *,
3148 ptrdiff_t, ptrdiff_t, bool);
3149 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3150 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3152 /* Make a string allocated in pure space, use STR as string data. */
3155 build_pure_c_string (const char *str
)
3157 return make_pure_c_string (str
, strlen (str
));
3160 /* Make a string from the data at STR, treating it as multibyte if the
3164 build_string (const char *str
)
3166 return make_string (str
, strlen (str
));
3169 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3170 extern void make_byte_code (struct Lisp_Vector
*);
3171 extern Lisp_Object Qchar_table_extra_slots
;
3172 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3174 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3175 be sure that GC cannot happen until the vector is completely
3176 initialized. E.g. the following code is likely to crash:
3178 v = make_uninit_vector (3);
3180 ASET (v, 1, Ffunction_can_gc ());
3181 ASET (v, 2, obj1); */
3184 make_uninit_vector (ptrdiff_t size
)
3187 struct Lisp_Vector
*p
;
3189 p
= allocate_vector (size
);
3194 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3195 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3197 allocate_pseudovector \
3198 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3199 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3200 extern struct window
*allocate_window (void);
3201 extern struct frame
*allocate_frame (void);
3202 extern struct Lisp_Process
*allocate_process (void);
3203 extern struct terminal
*allocate_terminal (void);
3204 extern Lisp_Object
make_float (double);
3205 extern void display_malloc_warning (void);
3206 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3207 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3208 Lisp_Object
, Lisp_Object
);
3209 extern Lisp_Object
make_save_ptr (void *);
3210 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3211 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3212 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3214 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3215 extern void free_save_value (Lisp_Object
);
3216 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3217 extern void init_alloc_once (void);
3218 extern void init_alloc (void);
3219 extern void syms_of_alloc (void);
3220 extern struct buffer
* allocate_buffer (void);
3221 extern int valid_lisp_object_p (Lisp_Object
);
3222 extern int relocatable_string_data_p (const char *);
3225 /* Defined in ralloc.c. */
3226 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3227 extern void r_alloc_free (void **);
3228 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3229 extern void r_alloc_reset_variable (void **, void **);
3230 extern void r_alloc_inhibit_buffer_relocation (int);
3233 /* Defined in chartab.c. */
3234 extern Lisp_Object
copy_char_table (Lisp_Object
);
3235 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3237 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3238 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3240 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3241 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3242 Lisp_Object
, Lisp_Object
,
3243 Lisp_Object
, struct charset
*,
3244 unsigned, unsigned);
3245 extern Lisp_Object
uniprop_table (Lisp_Object
);
3246 extern void syms_of_chartab (void);
3248 /* Defined in print.c. */
3249 extern Lisp_Object Vprin1_to_string_buffer
;
3250 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3251 extern Lisp_Object Qstandard_output
;
3252 extern Lisp_Object Qexternal_debugging_output
;
3253 extern void temp_output_buffer_setup (const char *);
3254 extern int print_level
;
3255 extern Lisp_Object Qprint_escape_newlines
;
3256 extern void write_string (const char *, int);
3257 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3259 extern Lisp_Object internal_with_output_to_temp_buffer
3260 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3261 #define FLOAT_TO_STRING_BUFSIZE 350
3262 extern int float_to_string (char *, double);
3263 extern void init_print_once (void);
3264 extern void syms_of_print (void);
3266 /* Defined in doprnt.c. */
3267 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3269 extern ptrdiff_t esprintf (char *, char const *, ...)
3270 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3271 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3273 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3274 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3275 char const *, va_list)
3276 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3278 /* Defined in lread.c. */
3279 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3280 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3281 extern Lisp_Object Qlexical_binding
;
3282 extern Lisp_Object
check_obarray (Lisp_Object
);
3283 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3284 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3285 extern Lisp_Object
obhash (Lisp_Object
);
3286 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3288 LOADHIST_ATTACH (Lisp_Object x
)
3291 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3293 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3294 Lisp_Object
*, Lisp_Object
, bool);
3295 extern Lisp_Object
string_to_number (char const *, int, bool);
3296 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3298 extern void dir_warning (const char *, Lisp_Object
);
3299 extern void init_obarray (void);
3300 extern void init_lread (void);
3301 extern void syms_of_lread (void);
3304 intern (const char *str
)
3306 return intern_1 (str
, strlen (str
));
3310 intern_c_string (const char *str
)
3312 return intern_c_string_1 (str
, strlen (str
));
3315 /* Defined in eval.c. */
3316 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3317 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3318 extern Lisp_Object Qand_rest
;
3319 extern Lisp_Object Vautoload_queue
;
3320 extern Lisp_Object Vsignaling_function
;
3321 extern Lisp_Object inhibit_lisp_code
;
3322 extern struct handler
*handlerlist
;
3324 /* To run a normal hook, use the appropriate function from the list below.
3325 The calling convention:
3327 if (!NILP (Vrun_hooks))
3328 call1 (Vrun_hooks, Qmy_funny_hook);
3330 should no longer be used. */
3331 extern Lisp_Object Vrun_hooks
;
3332 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3333 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3334 Lisp_Object (*funcall
)
3335 (ptrdiff_t nargs
, Lisp_Object
*args
));
3336 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3337 extern _Noreturn
void xsignal0 (Lisp_Object
);
3338 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3339 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3340 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3342 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3343 extern Lisp_Object
eval_sub (Lisp_Object form
);
3344 extern Lisp_Object
Ffuncall (ptrdiff_t nargs
, Lisp_Object
*args
);
3345 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3346 extern Lisp_Object
call0 (Lisp_Object
);
3347 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3348 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3349 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3350 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3351 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3352 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3353 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3354 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3355 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3356 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3357 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3358 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3359 extern Lisp_Object internal_condition_case_n
3360 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3361 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3362 extern void specbind (Lisp_Object
, Lisp_Object
);
3363 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3364 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3365 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3366 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3367 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3368 extern void record_unwind_protect_int (void (*) (int), int);
3369 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3370 extern void record_unwind_protect_void (void (*) (void));
3371 extern void dynwind_begin (void);
3372 extern void dynwind_end (void);
3373 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3374 extern _Noreturn
void verror (const char *, va_list)
3375 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3376 extern void un_autoload (Lisp_Object
);
3377 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3378 extern void init_eval_once (void);
3379 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3380 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3381 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3382 extern void init_eval (void);
3383 extern void syms_of_eval (void);
3384 extern void unwind_body (Lisp_Object
);
3385 extern void record_in_backtrace (Lisp_Object function
,
3386 Lisp_Object
*args
, ptrdiff_t nargs
);
3387 extern void mark_specpdl (void);
3388 extern void get_backtrace (Lisp_Object array
);
3389 Lisp_Object
backtrace_top_function (void);
3390 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3391 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3392 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3393 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3394 extern SCM
make_prompt_tag (void);
3397 /* Defined in editfns.c. */
3398 extern Lisp_Object Qfield
;
3399 extern void insert1 (Lisp_Object
);
3400 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3401 extern Lisp_Object
save_excursion_save (void);
3402 extern Lisp_Object
save_restriction_save (void);
3403 extern void save_excursion_restore (Lisp_Object
);
3404 extern void save_restriction_restore (Lisp_Object
);
3405 extern _Noreturn
void time_overflow (void);
3406 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3407 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3409 extern void init_editfns (void);
3410 extern void syms_of_editfns (void);
3411 extern void set_time_zone_rule (const char *);
3413 /* Defined in buffer.c. */
3414 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3415 extern _Noreturn
void nsberror (Lisp_Object
);
3416 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3417 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3418 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3419 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3420 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3421 extern bool overlay_touches_p (ptrdiff_t);
3422 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3423 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3424 extern void init_buffer_once (void);
3425 extern void init_buffer (int);
3426 extern void syms_of_buffer (void);
3427 extern void keys_of_buffer (void);
3429 /* Defined in marker.c. */
3431 extern ptrdiff_t marker_position (Lisp_Object
);
3432 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3433 extern void clear_charpos_cache (struct buffer
*);
3434 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3435 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3436 extern void unchain_marker (struct Lisp_Marker
*marker
);
3437 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3438 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3439 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3440 ptrdiff_t, ptrdiff_t);
3441 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3442 extern void syms_of_marker (void);
3444 /* Defined in fileio.c. */
3446 extern Lisp_Object Qfile_error
;
3447 extern Lisp_Object Qfile_notify_error
;
3448 extern Lisp_Object Qfile_exists_p
;
3449 extern Lisp_Object Qfile_directory_p
;
3450 extern Lisp_Object Qinsert_file_contents
;
3451 extern Lisp_Object Qfile_name_history
;
3452 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3453 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3454 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3456 extern void close_file_unwind (int);
3457 extern void close_file_ptr_unwind (void *);
3458 extern void fclose_unwind (void *);
3459 extern void fclose_ptr_unwind (void *);
3460 extern void restore_point_unwind (Lisp_Object
);
3461 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3462 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3463 extern bool internal_delete_file (Lisp_Object
);
3464 extern Lisp_Object
emacs_readlinkat (int, const char *);
3465 extern bool file_directory_p (const char *);
3466 extern bool file_accessible_directory_p (const char *);
3467 extern void init_fileio (void);
3468 extern void syms_of_fileio (void);
3469 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3470 extern Lisp_Object Qdelete_file
;
3472 /* Defined in search.c. */
3473 extern void shrink_regexp_cache (void);
3474 extern void restore_search_regs (void);
3475 extern void record_unwind_save_match_data (void);
3476 struct re_registers
;
3477 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3478 struct re_registers
*,
3479 Lisp_Object
, bool, bool);
3480 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3481 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3483 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3484 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3485 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3486 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3487 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3488 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3490 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3491 ptrdiff_t, ptrdiff_t *);
3492 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3493 ptrdiff_t, ptrdiff_t *);
3494 extern void syms_of_search (void);
3495 extern void clear_regexp_cache (void);
3497 /* Defined in minibuf.c. */
3499 extern Lisp_Object Qcompletion_ignore_case
;
3500 extern Lisp_Object Vminibuffer_list
;
3501 extern Lisp_Object last_minibuf_string
;
3502 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3503 extern void init_minibuf_once (void);
3504 extern void syms_of_minibuf (void);
3506 /* Defined in callint.c. */
3508 extern Lisp_Object Qminus
, Qplus
;
3509 extern Lisp_Object Qprogn
;
3510 extern Lisp_Object Qwhen
;
3511 extern Lisp_Object Qmouse_leave_buffer_hook
;
3512 extern void syms_of_callint (void);
3514 /* Defined in casefiddle.c. */
3516 extern Lisp_Object Qidentity
;
3517 extern void syms_of_casefiddle (void);
3518 extern void keys_of_casefiddle (void);
3520 /* Defined in casetab.c. */
3522 extern void init_casetab_once (void);
3523 extern void syms_of_casetab (void);
3525 /* Defined in keyboard.c. */
3527 extern Lisp_Object echo_message_buffer
;
3528 extern struct kboard
*echo_kboard
;
3529 extern void cancel_echoing (void);
3530 extern Lisp_Object Qdisabled
, QCfilter
;
3531 extern Lisp_Object Qup
, Qdown
;
3532 extern Lisp_Object last_undo_boundary
;
3533 extern bool input_pending
;
3534 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3535 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3536 extern void discard_mouse_events (void);
3538 void handle_input_available_signal (int);
3540 extern Lisp_Object pending_funcalls
;
3541 extern bool detect_input_pending (void);
3542 extern bool detect_input_pending_ignore_squeezables (void);
3543 extern bool detect_input_pending_run_timers (bool);
3544 extern void safe_run_hooks (Lisp_Object
);
3545 extern void cmd_error_internal (Lisp_Object
, const char *);
3546 extern Lisp_Object
command_loop_1 (void);
3547 extern Lisp_Object
read_menu_command (void);
3548 extern Lisp_Object
recursive_edit_1 (void);
3549 extern void record_auto_save (void);
3550 extern void force_auto_save_soon (void);
3551 extern void init_keyboard (void);
3552 extern void syms_of_keyboard (void);
3553 extern void keys_of_keyboard (void);
3555 /* Defined in indent.c. */
3556 extern ptrdiff_t current_column (void);
3557 extern void invalidate_current_column (void);
3558 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3559 extern void syms_of_indent (void);
3561 /* Defined in frame.c. */
3562 extern Lisp_Object Qonly
, Qnone
;
3563 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3564 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3565 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3566 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3567 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3568 extern void frames_discard_buffer (Lisp_Object
);
3569 extern void syms_of_frame (void);
3571 /* Defined in emacs.c. */
3572 extern char **initial_argv
;
3573 extern int initial_argc
;
3574 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3575 extern bool display_arg
;
3577 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3578 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3579 extern Lisp_Object Qfile_name_handler_alist
;
3580 extern _Noreturn
void terminate_due_to_signal (int, int);
3581 extern Lisp_Object Qkill_emacs
;
3583 extern Lisp_Object Vlibrary_cache
;
3586 void fixup_locale (void);
3587 void synchronize_system_messages_locale (void);
3588 void synchronize_system_time_locale (void);
3590 INLINE
void fixup_locale (void) {}
3591 INLINE
void synchronize_system_messages_locale (void) {}
3592 INLINE
void synchronize_system_time_locale (void) {}
3594 extern void shut_down_emacs (int, Lisp_Object
);
3596 /* True means don't do interactive redisplay and don't change tty modes. */
3597 extern bool noninteractive
;
3599 /* True means remove site-lisp directories from load-path. */
3600 extern bool no_site_lisp
;
3602 /* Pipe used to send exit notification to the daemon parent at
3604 extern int daemon_pipe
[2];
3605 #define IS_DAEMON (daemon_pipe[1] != 0)
3607 /* True if handling a fatal error already. */
3608 extern bool fatal_error_in_progress
;
3610 /* True means don't do use window-system-specific display code. */
3611 extern bool inhibit_window_system
;
3612 /* True means that a filter or a sentinel is running. */
3613 extern bool running_asynch_code
;
3615 /* Defined in process.c. */
3616 extern Lisp_Object QCtype
, Qlocal
;
3617 extern void kill_buffer_processes (Lisp_Object
);
3618 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3619 struct Lisp_Process
*, int);
3620 /* Max value for the first argument of wait_reading_process_output. */
3621 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3622 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3623 The bug merely causes a bogus warning, but the warning is annoying. */
3624 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3626 # define WAIT_READING_MAX INTMAX_MAX
3628 extern void add_keyboard_wait_descriptor (int);
3629 extern void delete_keyboard_wait_descriptor (int);
3631 extern void add_gpm_wait_descriptor (int);
3632 extern void delete_gpm_wait_descriptor (int);
3634 extern void init_process_emacs (void);
3635 extern void syms_of_process (void);
3636 extern void setup_process_coding_systems (Lisp_Object
);
3638 /* Defined in callproc.c. */
3642 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3643 extern void init_callproc_1 (void);
3644 extern void init_callproc (void);
3645 extern void set_initial_environment (void);
3646 extern void syms_of_callproc (void);
3648 /* Defined in doc.c. */
3649 extern Lisp_Object Qfunction_documentation
;
3650 extern Lisp_Object
read_doc_string (Lisp_Object
);
3651 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3652 extern void syms_of_doc (void);
3653 extern int read_bytecode_char (bool);
3655 /* Defined in bytecode.c. */
3656 extern void syms_of_bytecode (void);
3657 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3658 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3660 /* Defined in macros.c. */
3661 extern void init_macros (void);
3662 extern void syms_of_macros (void);
3664 /* Defined in undo.c. */
3665 extern Lisp_Object Qapply
;
3666 extern Lisp_Object Qinhibit_read_only
;
3667 extern void truncate_undo_list (struct buffer
*);
3668 extern void record_insert (ptrdiff_t, ptrdiff_t);
3669 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3670 extern void record_first_change (void);
3671 extern void record_change (ptrdiff_t, ptrdiff_t);
3672 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3673 Lisp_Object
, Lisp_Object
,
3675 extern void syms_of_undo (void);
3676 /* Defined in textprop.c. */
3677 extern Lisp_Object Qmouse_face
;
3678 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3679 extern Lisp_Object Qminibuffer_prompt
;
3681 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3683 /* Defined in menu.c. */
3684 extern void syms_of_menu (void);
3686 /* Defined in xmenu.c. */
3687 extern void syms_of_xmenu (void);
3689 /* Defined in termchar.h. */
3690 struct tty_display_info
;
3692 /* Defined in termhooks.h. */
3695 /* Defined in sysdep.c. */
3696 #ifndef HAVE_GET_CURRENT_DIR_NAME
3697 extern char *get_current_dir_name (void);
3699 extern void stuff_char (char c
);
3700 extern void init_foreground_group (void);
3701 extern void sys_subshell (void);
3702 extern void sys_suspend (void);
3703 extern void discard_tty_input (void);
3704 extern void init_sys_modes (struct tty_display_info
*);
3705 extern void reset_sys_modes (struct tty_display_info
*);
3706 extern void init_all_sys_modes (void);
3707 extern void reset_all_sys_modes (void);
3708 extern void child_setup_tty (int);
3709 extern void setup_pty (int);
3710 extern int set_window_size (int, int, int);
3711 extern EMACS_INT
get_random (void);
3712 extern void seed_random (void *, ptrdiff_t);
3713 extern void init_random (void);
3714 extern void emacs_backtrace (int);
3715 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3716 extern int emacs_open (const char *, int, int);
3717 extern int emacs_pipe (int[2]);
3718 extern int emacs_close (int);
3719 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3720 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3721 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3722 extern void emacs_perror (char const *);
3724 extern void unlock_all_files (void);
3725 extern void lock_file (Lisp_Object
);
3726 extern void unlock_file (Lisp_Object
);
3727 extern void unlock_buffer (struct buffer
*);
3728 extern void syms_of_filelock (void);
3730 /* Defined in sound.c. */
3731 extern void syms_of_sound (void);
3733 /* Defined in category.c. */
3734 extern void init_category_once (void);
3735 extern Lisp_Object
char_category_set (int);
3736 extern void syms_of_category (void);
3738 /* Defined in ccl.c. */
3739 extern void syms_of_ccl (void);
3741 /* Defined in dired.c. */
3742 extern void syms_of_dired (void);
3743 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3744 Lisp_Object
, Lisp_Object
,
3747 /* Defined in term.c. */
3748 extern int *char_ins_del_vector
;
3749 extern void syms_of_term (void);
3750 extern _Noreturn
void fatal (const char *msgid
, ...)
3751 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3753 /* Defined in terminal.c. */
3754 extern void syms_of_terminal (void);
3756 /* Defined in font.c. */
3757 extern void syms_of_font (void);
3758 extern void init_font (void);
3760 #ifdef HAVE_WINDOW_SYSTEM
3761 /* Defined in fontset.c. */
3762 extern void syms_of_fontset (void);
3764 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3765 extern Lisp_Object Qfont_param
;
3768 /* Defined in gfilenotify.c */
3769 #ifdef HAVE_GFILENOTIFY
3770 extern void globals_of_gfilenotify (void);
3771 extern void syms_of_gfilenotify (void);
3774 /* Defined in inotify.c */
3776 extern void syms_of_inotify (void);
3779 #ifdef HAVE_W32NOTIFY
3780 /* Defined on w32notify.c. */
3781 extern void syms_of_w32notify (void);
3784 /* Defined in xfaces.c. */
3785 extern Lisp_Object Qdefault
, Qfringe
;
3786 extern Lisp_Object Qscroll_bar
, Qcursor
;
3787 extern Lisp_Object Qmode_line_inactive
;
3788 extern Lisp_Object Qface
;
3789 extern Lisp_Object Qnormal
;
3790 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3791 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3792 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3793 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3794 extern Lisp_Object Qoblique
, Qitalic
;
3795 extern Lisp_Object Vface_alternative_font_family_alist
;
3796 extern Lisp_Object Vface_alternative_font_registry_alist
;
3797 extern void syms_of_xfaces (void);
3799 #ifdef HAVE_X_WINDOWS
3800 /* Defined in xfns.c. */
3801 extern void syms_of_xfns (void);
3803 /* Defined in xsmfns.c. */
3804 extern void syms_of_xsmfns (void);
3806 /* Defined in xselect.c. */
3807 extern void syms_of_xselect (void);
3809 /* Defined in xterm.c. */
3810 extern void syms_of_xterm (void);
3811 #endif /* HAVE_X_WINDOWS */
3813 #ifdef HAVE_WINDOW_SYSTEM
3814 /* Defined in xterm.c, nsterm.m, w32term.c. */
3815 extern char *x_get_keysym_name (int);
3816 #endif /* HAVE_WINDOW_SYSTEM */
3819 /* Defined in xml.c. */
3820 extern void syms_of_xml (void);
3821 extern void xml_cleanup_parser (void);
3825 /* Defined in decompress.c. */
3826 extern void syms_of_decompress (void);
3830 /* Defined in dbusbind.c. */
3831 void syms_of_dbusbind (void);
3835 /* Defined in profiler.c. */
3836 extern bool profiler_memory_running
;
3837 extern void malloc_probe (size_t);
3838 extern void syms_of_profiler (void);
3842 /* Defined in msdos.c, w32.c. */
3843 extern char *emacs_root_dir (void);
3846 /* True means ^G can quit instantly. */
3847 extern bool immediate_quit
;
3849 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3850 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3851 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3852 extern void xfree (void *);
3853 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3854 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3855 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3856 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3857 ATTRIBUTE_ALLOC_SIZE ((2,3));
3858 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3859 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3860 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3861 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3862 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3864 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3865 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3866 extern void dupstring (char **, char const *);
3867 extern void xputenv (const char *);
3869 extern char *egetenv (const char *);
3871 /* Copy Lisp string to temporary (allocated on stack) C string. */
3873 #define xlispstrdupa(string) \
3874 memcpy (alloca (SBYTES (string) + 1), \
3875 SSDATA (string), SBYTES (string) + 1)
3877 /* Set up the name of the machine we're running on. */
3878 extern void init_system_name (void);
3880 /* Return the absolute value of X. X should be a signed integer
3881 expression without side effects, and X's absolute value should not
3882 exceed the maximum for its promoted type. This is called 'eabs'
3883 because 'abs' is reserved by the C standard. */
3884 #define eabs(x) ((x) < 0 ? -(x) : (x))
3886 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3889 #define make_fixnum_or_float(val) \
3890 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3892 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3893 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3895 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3897 #define USE_SAFE_ALLOCA ((void) 0)
3899 /* SAFE_ALLOCA allocates a simple buffer. */
3901 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3905 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3906 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3907 positive. The code is tuned for MULTIPLIER being a constant. */
3909 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3911 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3912 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3914 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3917 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3919 #define SAFE_FREE() ((void) 0)
3921 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3923 #define SAFE_ALLOCA_LISP(buf, nelt) \
3925 if ((nelt) < MAX_ALLOCA / word_size) \
3926 (buf) = alloca ((nelt) * word_size); \
3927 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3928 buf = xmalloc ((nelt) * word_size); \
3930 memory_full (SIZE_MAX); \
3933 /* Loop over all tails of a list, checking for cycles.
3934 FIXME: Make tortoise and n internal declarations.
3935 FIXME: Unroll the loop body so we don't need `n'. */
3936 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3937 for ((tortoise) = (hare) = (list), (n) = true; \
3939 (hare = XCDR (hare), (n) = !(n), \
3941 ? (EQ (hare, tortoise) \
3942 ? xsignal1 (Qcircular_list, list) \
3944 /* Move tortoise before the next iteration, in case */ \
3945 /* the next iteration does an Fsetcdr. */ \
3946 : (void) ((tortoise) = XCDR (tortoise)))))
3948 /* Do a `for' loop over alist values. */
3950 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3951 for ((list_var) = (head_var); \
3952 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
3953 (list_var) = XCDR (list_var))
3955 /* Check whether it's time for GC, and run it if so. */
3964 functionp (Lisp_Object object
)
3966 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3968 object
= Findirect_function (object
, Qt
);
3970 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3972 /* Autoloaded symbols are functions, except if they load
3973 macros or keymaps. */
3975 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3976 object
= XCDR (object
);
3978 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3983 return XSUBR (object
)->max_args
!= UNEVALLED
;
3984 else if (COMPILEDP (object
))
3986 else if (CONSP (object
))
3988 Lisp_Object car
= XCAR (object
);
3989 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
3996 #endif /* EMACS_LISP_H */