1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
102 typedef scm_t_signed_bits EMACS_INT
;
103 typedef scm_t_bits EMACS_UINT
;
104 #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX
106 #if INTPTR_MAX == INT_MAX
108 #elif INTPTR_MAX == LONG_MAX
110 #elif INTPTR_MAX == LLONG_MAX
112 #elif INTPTR_MAX == INTMAX_MAX
115 #error "Cannot determine length modifier for EMACS_INT"
118 /* Number of bits to put in each character in the internal representation
119 of bool vectors. This should not vary across implementations. */
120 enum { BOOL_VECTOR_BITS_PER_CHAR
=
121 #define BOOL_VECTOR_BITS_PER_CHAR 8
122 BOOL_VECTOR_BITS_PER_CHAR
125 /* An unsigned integer type representing a fixed-length bit sequence,
126 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
127 for speed, but it is unsigned char on weird platforms. */
128 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
129 typedef size_t bits_word
;
130 # define BITS_WORD_MAX SIZE_MAX
131 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
133 typedef unsigned char bits_word
;
134 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
135 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
137 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
139 /* Number of bits in some machine integer types. */
142 BITS_PER_CHAR
= CHAR_BIT
,
143 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
144 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
145 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
148 /* printmax_t and uprintmax_t are types for printing large integers.
149 These are the widest integers that are supported for printing.
150 pMd etc. are conversions for printing them.
151 On C99 hosts, there's no problem, as even the widest integers work.
152 Fall back on EMACS_INT on pre-C99 hosts. */
154 typedef intmax_t printmax_t
;
155 typedef uintmax_t uprintmax_t
;
159 typedef EMACS_INT printmax_t
;
160 typedef EMACS_UINT uprintmax_t
;
165 /* Use pD to format ptrdiff_t values, which suffice for indexes into
166 buffers and strings. Emacs never allocates objects larger than
167 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
168 In C99, pD can always be "t"; configure it here for the sake of
169 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
170 #if PTRDIFF_MAX == INT_MAX
172 #elif PTRDIFF_MAX == LONG_MAX
174 #elif PTRDIFF_MAX == LLONG_MAX
180 /* Extra internal type checking? */
182 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
183 'assume (COND)'. COND should be free of side effects, as it may or
184 may not be evaluated.
186 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
187 defined and suppress_checking is false, and does nothing otherwise.
188 Emacs dies if COND is checked and is false. The suppress_checking
189 variable is initialized to 0 in alloc.c. Set it to 1 using a
190 debugger to temporarily disable aborting on detected internal
191 inconsistencies or error conditions.
193 In some cases, a good compiler may be able to optimize away the
194 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
195 uses eassert to test STRINGP (x), but a particular use of XSTRING
196 is invoked only after testing that STRINGP (x) is true, making the
199 eassume is like eassert except that it also causes the compiler to
200 assume that COND is true afterwards, regardless of whether runtime
201 checking is enabled. This can improve performance in some cases,
202 though it can degrade performance in others. It's often suboptimal
203 for COND to call external functions or access volatile storage. */
205 #ifndef ENABLE_CHECKING
206 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
207 # define eassume(cond) assume (cond)
208 #else /* ENABLE_CHECKING */
210 extern _Noreturn
void die (const char *, const char *, int);
212 extern bool suppress_checking EXTERNALLY_VISIBLE
;
214 # define eassert(cond) \
215 (suppress_checking || (cond) \
217 : die (# cond, __FILE__, __LINE__))
218 # define eassume(cond) \
223 : die (# cond, __FILE__, __LINE__))
224 #endif /* ENABLE_CHECKING */
229 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
230 integer constant, for MSVC. */
231 #define GCALIGNMENT 8
233 /* Number of bits in a Lisp fixnum value, not counting the tag. */
234 FIXNUM_BITS
= SCM_I_FIXNUM_BIT
237 #if GCALIGNMENT != 1 << GCTYPEBITS
238 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
241 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
242 #define USE_LSB_TAG 1
243 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
246 # define alignas(alignment) /* empty */
248 # error "USE_LSB_TAG requires alignas"
252 /* Some operations are so commonly executed that they are implemented
253 as macros, not functions, because otherwise runtime performance would
254 suffer too much when compiling with GCC without optimization.
255 There's no need to inline everything, just the operations that
256 would otherwise cause a serious performance problem.
258 For each such operation OP, define a macro lisp_h_OP that contains
259 the operation's implementation. That way, OP can be implemented
260 via a macro definition like this:
262 #define OP(x) lisp_h_OP (x)
264 and/or via a function definition like this:
266 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
268 which macro-expands to this:
270 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
272 without worrying about the implementations diverging, since
273 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
274 are intended to be private to this include file, and should not be
277 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
278 functions, once most developers have access to GCC 4.8 or later and
279 can use "gcc -Og" to debug. Maybe in the year 2016. See
282 Commentary for these macros can be found near their corresponding
285 #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a))
286 #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x))
287 #define lisp_h_XLI(o) (SCM_UNPACK (o))
288 #define lisp_h_XIL(i) (SCM_PACK (i))
289 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
290 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
291 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
292 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
293 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
294 #define lisp_h_CONSP(x) (x && scm_is_pair (x))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (x && SCM_INEXACTP (x))
297 #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x))
298 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
299 #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag))
300 #define lisp_h_NILP(x) (scm_is_lisp_false (x))
301 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
302 (eassert (SYMBOL_REDIRECT (sym) == SYMBOL_PLAINVAL), \
303 scm_c_vector_set_x (sym, 4, v))
304 #define lisp_h_SYMBOL_CONSTANT_P(sym) (SYMBOL_CONSTANT (XSYMBOL (sym)))
305 #define lisp_h_SYMBOL_VAL(sym) \
306 (eassert (SYMBOL_REDIRECT (sym) == SYMBOL_PLAINVAL), \
307 scm_c_vector_ref (sym, 4))
308 #define lisp_h_SYMBOLP(x) \
309 (x && (scm_is_symbol (x) || EQ (x, Qnil) || EQ (x, Qt)))
310 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
311 #define lisp_h_XCAR(c) (scm_car (c))
312 #define lisp_h_XCDR(c) (scm_cdr (c))
313 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
315 /* Define NAME as a lisp.h inline function that returns TYPE and has
316 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
317 ARGS should be parenthesized. Implement the function by calling
319 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
320 INLINE type (name) argdecls { return lisp_h_##name args; }
322 /* like LISP_MACRO_DEFUN, except NAME returns void. */
323 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
324 INLINE void (name) argdecls { lisp_h_##name args; }
327 /* Define the fundamental Lisp data structures. */
329 /* This is the set of Lisp data types. If you want to define a new
330 data type, read the comments after Lisp_Fwd_Type definition
333 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
334 #define case_Lisp_Int case Lisp_Int
336 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
337 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
338 vociferously about them. */
339 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
340 || (defined __SUNPRO_C && __STDC__))
341 #define ENUM_BF(TYPE) unsigned int
343 #define ENUM_BF(TYPE) enum TYPE
346 scm_t_bits lisp_misc_tag
;
347 scm_t_bits lisp_string_tag
;
348 scm_t_bits lisp_vectorlike_tag
;
354 /* Integer. XINT (obj) is the integer value. */
357 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
360 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
361 whose first member indicates the subtype. */
364 /* String. XSTRING (object) points to a struct Lisp_String.
365 The length of the string, and its contents, are stored therein. */
368 /* Vector of Lisp objects, or something resembling it.
369 XVECTOR (object) points to a struct Lisp_Vector, which contains
370 the size and contents. The size field also contains the type
371 information, if it's not a real vector object. */
374 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
380 /* This is the set of data types that share a common structure.
381 The first member of the structure is a type code from this set.
382 The enum values are arbitrary, but we'll use large numbers to make it
383 more likely that we'll spot the error if a random word in memory is
384 mistakenly interpreted as a Lisp_Misc. */
387 Lisp_Misc_Free
= 0x5eab,
390 Lisp_Misc_Save_Value
,
391 /* Currently floats are not a misc type,
392 but let's define this in case we want to change that. */
394 /* This is not a type code. It is for range checking. */
398 /* These are the types of forwarding objects used in the value slot
399 of symbols for special built-in variables whose value is stored in
403 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
404 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
405 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
406 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
407 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
410 typedef SCM Lisp_Object
;
412 #define LISP_INITIALLY_ZERO SCM_INUM0
414 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
415 At the machine level, these operations are no-ops. */
416 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
417 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
419 /* In the size word of a struct Lisp_Vector, this bit means it's really
420 some other vector-like object. */
421 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
422 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
423 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
425 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
426 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
427 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
430 /* In a pseudovector, the size field actually contains a word with one
431 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
432 with PVEC_TYPE_MASK to indicate the actual type. */
444 PVEC_WINDOW_CONFIGURATION
,
446 /* These should be last, check internal_equal to see why. */
450 PVEC_FONT
/* Should be last because it's used for range checking. */
455 /* For convenience, we also store the number of elements in these bits.
456 Note that this size is not necessarily the memory-footprint size, but
457 only the number of Lisp_Object fields (that need to be traced by GC).
458 The distinction is used, e.g., by Lisp_Process, which places extra
459 non-Lisp_Object fields at the end of the structure. */
460 PSEUDOVECTOR_SIZE_BITS
= 12,
461 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
463 /* To calculate the memory footprint of the pseudovector, it's useful
464 to store the size of non-Lisp area in word_size units here. */
465 PSEUDOVECTOR_REST_BITS
= 12,
466 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
467 << PSEUDOVECTOR_SIZE_BITS
),
469 /* Used to extract pseudovector subtype information. */
470 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
471 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
474 /* These functions extract various sorts of values from a Lisp_Object.
475 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
476 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
479 /* Largest and smallest representable fixnum values. These are the C
480 values. They are macros for use in static initializers. */
481 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
482 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
484 /* Make a Lisp integer representing the value of the low order
487 make_number (EMACS_INT n
)
489 return SCM_I_MAKINUM (n
);
492 /* Extract A's value as a signed integer. */
496 return SCM_I_INUM (a
);
499 /* Like XINT (A), but may be faster. A must be nonnegative.
500 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
501 integers have zero-bits in their tags. */
503 XFASTINT (Lisp_Object a
)
505 EMACS_INT n
= XINT (a
);
510 /* Extract A's value as an unsigned integer. */
512 XUINT (Lisp_Object a
)
514 return SCM_I_INUM (a
);
517 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
518 right now, but XUINT should only be applied to objects we know are
520 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
522 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
524 make_natnum (EMACS_INT n
)
526 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
527 return make_number (n
);
530 /* Return true if X and Y are the same object. */
531 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
533 /* Value is true if I doesn't fit into a Lisp fixnum. It is
534 written this way so that it also works if I is of unsigned
535 type or if I is a NaN. */
537 #define FIXNUM_OVERFLOW_P(i) \
538 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
541 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
543 return num
< lower
? lower
: num
<= upper
? num
: upper
;
546 /* Forward declarations. */
548 /* Defined in this file. */
550 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
551 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
552 INLINE
bool BUFFERP (Lisp_Object
);
553 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
554 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
555 INLINE
bool (CONSP
) (Lisp_Object
);
556 INLINE
bool (FLOATP
) (Lisp_Object
);
557 INLINE
bool functionp (Lisp_Object
);
558 INLINE
bool (INTEGERP
) (Lisp_Object
);
559 INLINE
bool (MARKERP
) (Lisp_Object
);
560 INLINE
bool (MISCP
) (Lisp_Object
);
561 INLINE
bool (NILP
) (Lisp_Object
);
562 INLINE
bool OVERLAYP (Lisp_Object
);
563 INLINE
bool PROCESSP (Lisp_Object
);
564 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
565 INLINE
bool SAVE_VALUEP (Lisp_Object
);
566 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
568 INLINE
bool STRINGP (Lisp_Object
);
569 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
570 INLINE
bool (SYMBOLP
) (Lisp_Object
);
571 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
572 INLINE
bool WINDOWP (Lisp_Object
);
573 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
575 /* Defined in chartab.c. */
576 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
577 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
578 extern int char_table_translate (Lisp_Object
, int);
580 /* Defined in data.c. */
581 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
582 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
583 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
584 extern Lisp_Object Qbool_vector_p
;
585 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
586 extern Lisp_Object Qwindow
;
587 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
589 /* Defined in emacs.c. */
590 extern bool might_dump
;
591 /* True means Emacs has already been initialized.
592 Used during startup to detect startup of dumped Emacs. */
593 extern bool initialized
;
595 /* Defined in eval.c. */
596 extern Lisp_Object Qautoload
;
598 /* Defined in floatfns.c. */
599 extern double extract_float (Lisp_Object
);
601 /* Defined in process.c. */
602 extern Lisp_Object Qprocessp
;
604 /* Defined in window.c. */
605 extern Lisp_Object Qwindowp
;
607 /* Defined in xdisp.c. */
608 extern Lisp_Object Qimage
;
610 /* Extract A's type. */
611 INLINE
enum Lisp_Type
612 XTYPE (Lisp_Object o
)
616 else if (SYMBOLP (o
))
620 else if (STRINGP (o
))
622 else if (VECTORLIKEP (o
))
623 return Lisp_Vectorlike
;
632 /* Extract a value or address from a Lisp_Object. */
634 INLINE
struct Lisp_Vector
*
635 XVECTOR (Lisp_Object a
)
637 eassert (VECTORLIKEP (a
));
641 INLINE
struct Lisp_String
*
642 XSTRING (Lisp_Object a
)
644 eassert (STRINGP (a
));
648 extern void initialize_symbol (Lisp_Object
, Lisp_Object
);
649 INLINE Lisp_Object
build_string (const char *);
650 extern Lisp_Object symbol_module
;
651 extern Lisp_Object function_module
;
652 extern Lisp_Object plist_module
;
653 extern Lisp_Object Qt
, Qnil
, Qt_
, Qnil_
;
655 typedef Lisp_Object sym_t
;
657 INLINE sym_t
XSYMBOL (Lisp_Object a
);
659 /* Pseudovector types. */
661 INLINE
struct Lisp_Process
*
662 XPROCESS (Lisp_Object a
)
664 eassert (PROCESSP (a
));
668 INLINE
struct window
*
669 XWINDOW (Lisp_Object a
)
671 eassert (WINDOWP (a
));
675 INLINE
struct terminal
*
676 XTERMINAL (Lisp_Object a
)
681 INLINE
struct buffer
*
682 XBUFFER (Lisp_Object a
)
684 eassert (BUFFERP (a
));
688 INLINE
struct Lisp_Char_Table
*
689 XCHAR_TABLE (Lisp_Object a
)
691 eassert (CHAR_TABLE_P (a
));
695 INLINE
struct Lisp_Sub_Char_Table
*
696 XSUB_CHAR_TABLE (Lisp_Object a
)
698 eassert (SUB_CHAR_TABLE_P (a
));
702 INLINE
struct Lisp_Bool_Vector
*
703 XBOOL_VECTOR (Lisp_Object a
)
705 eassert (BOOL_VECTOR_P (a
));
710 make_lisp_proc (struct Lisp_Process
*p
)
712 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
715 #define XSETINT(a, b) ((a) = make_number (b))
716 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
717 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
718 #define XSETSTRING(a, b) ((a) = (b)->self)
719 #define XSETSYMBOL(a, b) ((a) = scm_c_vector_ref (b, 0))
720 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
722 /* Pseudovector types. */
724 #define XSETPVECTYPE(v, code) \
725 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
726 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
727 ((v)->header.size = (PSEUDOVECTOR_FLAG \
728 | ((code) << PSEUDOVECTOR_AREA_BITS) \
729 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
732 /* The cast to struct vectorlike_header * avoids aliasing issues. */
733 #define XSETPSEUDOVECTOR(a, b, code) \
734 XSETTYPED_PSEUDOVECTOR (a, b, \
735 (((struct vectorlike_header *) \
739 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
740 (XSETVECTOR (a, b), \
741 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
742 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
744 #define XSETWINDOW_CONFIGURATION(a, b) \
745 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
746 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
747 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
748 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
749 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
750 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
751 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
752 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
753 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
754 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
758 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
759 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
762 /* Deprecated and will be removed soon. */
764 #define INTERNAL_FIELD(field) field ## _
766 /* See the macros in intervals.h. */
768 typedef struct interval
*INTERVAL
;
770 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
771 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
773 /* Use these to set the fields of a cons cell.
775 Note that both arguments may refer to the same object, so 'n'
776 should not be read after 'c' is first modified. */
778 XSETCAR (Lisp_Object c
, Lisp_Object n
)
780 scm_set_car_x (c
, n
);
783 XSETCDR (Lisp_Object c
, Lisp_Object n
)
785 scm_set_cdr_x (c
, n
);
788 /* Take the car or cdr of something whose type is not known. */
792 return (CONSP (c
) ? XCAR (c
)
794 : wrong_type_argument (Qlistp
, c
));
799 return (CONSP (c
) ? XCDR (c
)
801 : wrong_type_argument (Qlistp
, c
));
804 /* Take the car or cdr of something whose type is not known. */
806 CAR_SAFE (Lisp_Object c
)
808 return CONSP (c
) ? XCAR (c
) : Qnil
;
811 CDR_SAFE (Lisp_Object c
)
813 return CONSP (c
) ? XCDR (c
) : Qnil
;
816 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
823 INTERVAL intervals
; /* Text properties in this string. */
827 /* True if STR is a multibyte string. */
829 STRING_MULTIBYTE (Lisp_Object str
)
831 return 0 <= XSTRING (str
)->size_byte
;
834 /* An upper bound on the number of bytes in a Lisp string, not
835 counting the terminating null. This a tight enough bound to
836 prevent integer overflow errors that would otherwise occur during
837 string size calculations. A string cannot contain more bytes than
838 a fixnum can represent, nor can it be so long that C pointer
839 arithmetic stops working on the string plus its terminating null.
840 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
841 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
842 would expose alloc.c internal details that we'd rather keep
845 This is a macro for use in static initializers. The cast to
846 ptrdiff_t ensures that the macro is signed. */
847 #define STRING_BYTES_BOUND \
848 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
850 /* Mark STR as a unibyte string. */
851 #define STRING_SET_UNIBYTE(STR) \
853 if (EQ (STR, empty_multibyte_string)) \
854 (STR) = empty_unibyte_string; \
856 XSTRING (STR)->size_byte = -1; \
859 /* Mark STR as a multibyte string. Assure that STR contains only
860 ASCII characters in advance. */
861 #define STRING_SET_MULTIBYTE(STR) \
863 if (EQ (STR, empty_unibyte_string)) \
864 (STR) = empty_multibyte_string; \
866 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
869 /* Convenience functions for dealing with Lisp strings. */
871 INLINE
unsigned char *
872 SDATA (Lisp_Object string
)
874 return XSTRING (string
)->data
;
877 SSDATA (Lisp_Object string
)
879 /* Avoid "differ in sign" warnings. */
880 return (char *) SDATA (string
);
883 SREF (Lisp_Object string
, ptrdiff_t index
)
885 return SDATA (string
)[index
];
888 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
890 SDATA (string
)[index
] = new;
893 SCHARS (Lisp_Object string
)
895 return XSTRING (string
)->size
;
899 STRING_BYTES (struct Lisp_String
*s
)
901 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
905 SBYTES (Lisp_Object string
)
907 return STRING_BYTES (XSTRING (string
));
910 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
912 XSTRING (string
)->size
= newsize
;
915 /* Header of vector-like objects. This documents the layout constraints on
916 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
917 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
918 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
919 because when two such pointers potentially alias, a compiler won't
920 incorrectly reorder loads and stores to their size fields. See
922 struct vectorlike_header
926 /* This field contains various pieces of information:
927 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
928 vector (0) or a pseudovector (1).
929 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
930 of slots) of the vector.
931 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
932 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
933 - b) number of Lisp_Objects slots at the beginning of the object
934 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
936 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
937 measured in word_size units. Rest fields may also include
938 Lisp_Objects, but these objects usually needs some special treatment
940 There are some exceptions. For PVEC_FREE, b) is always zero. For
941 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
942 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
943 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
947 /* A regular vector is just a header plus an array of Lisp_Objects. */
951 struct vectorlike_header header
;
952 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
955 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
958 ALIGNOF_STRUCT_LISP_VECTOR
959 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
962 /* A boolvector is a kind of vectorlike, with contents like a string. */
964 struct Lisp_Bool_Vector
966 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
967 just the subtype information. */
968 struct vectorlike_header header
;
969 /* This is the size in bits. */
971 /* The actual bits, packed into bytes.
972 Zeros fill out the last word if needed.
973 The bits are in little-endian order in the bytes, and
974 the bytes are in little-endian order in the words. */
975 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
979 bool_vector_size (Lisp_Object a
)
981 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
987 bool_vector_data (Lisp_Object a
)
989 return XBOOL_VECTOR (a
)->data
;
992 INLINE
unsigned char *
993 bool_vector_uchar_data (Lisp_Object a
)
995 return (unsigned char *) bool_vector_data (a
);
998 /* The number of data words and bytes in a bool vector with SIZE bits. */
1001 bool_vector_words (EMACS_INT size
)
1003 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1004 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1008 bool_vector_bytes (EMACS_INT size
)
1010 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1011 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1014 /* True if A's Ith bit is set. */
1017 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1019 eassume (0 <= i
&& i
< bool_vector_size (a
));
1020 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1021 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1025 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1027 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1030 /* Set A's Ith bit to B. */
1033 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1035 unsigned char *addr
;
1037 eassume (0 <= i
&& i
< bool_vector_size (a
));
1038 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1041 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1043 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1046 /* Some handy constants for calculating sizes
1047 and offsets, mostly of vectorlike objects. */
1051 header_size
= offsetof (struct Lisp_Vector
, contents
),
1052 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1053 word_size
= sizeof (Lisp_Object
)
1056 /* Conveniences for dealing with Lisp arrays. */
1059 AREF (Lisp_Object array
, ptrdiff_t idx
)
1061 return XVECTOR (array
)->contents
[idx
];
1064 INLINE Lisp_Object
*
1065 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1067 return & XVECTOR (array
)->contents
[idx
];
1071 ASIZE (Lisp_Object array
)
1073 return XVECTOR (array
)->header
.size
;
1077 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1079 eassert (0 <= idx
&& idx
< ASIZE (array
));
1080 XVECTOR (array
)->contents
[idx
] = val
;
1084 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1086 /* Like ASET, but also can be used in the garbage collector:
1087 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1088 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1089 XVECTOR (array
)->contents
[idx
] = val
;
1092 /* If a struct is made to look like a vector, this macro returns the length
1093 of the shortest vector that would hold that struct. */
1095 #define VECSIZE(type) \
1096 ((sizeof (type) - header_size + word_size - 1) / word_size)
1098 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1099 at the end and we need to compute the number of Lisp_Object fields (the
1100 ones that the GC needs to trace). */
1102 #define PSEUDOVECSIZE(type, nonlispfield) \
1103 ((offsetof (type, nonlispfield) - header_size) / word_size)
1105 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1106 should be integer expressions. This is not the same as
1107 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1108 returns true. For efficiency, prefer plain unsigned comparison if A
1109 and B's sizes both fit (after integer promotion). */
1110 #define UNSIGNED_CMP(a, op, b) \
1111 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1112 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1113 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1115 /* True iff C is an ASCII character. */
1116 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1118 /* A char-table is a kind of vectorlike, with contents are like a
1119 vector but with a few other slots. For some purposes, it makes
1120 sense to handle a char-table with type struct Lisp_Vector. An
1121 element of a char table can be any Lisp objects, but if it is a sub
1122 char-table, we treat it a table that contains information of a
1123 specific range of characters. A sub char-table has the same
1124 structure as a vector. A sub char table appears only in an element
1125 of a char-table, and there's no way to access it directly from
1126 Emacs Lisp program. */
1128 enum CHARTAB_SIZE_BITS
1130 CHARTAB_SIZE_BITS_0
= 6,
1131 CHARTAB_SIZE_BITS_1
= 4,
1132 CHARTAB_SIZE_BITS_2
= 5,
1133 CHARTAB_SIZE_BITS_3
= 7
1136 extern const int chartab_size
[4];
1138 struct Lisp_Char_Table
1140 /* HEADER.SIZE is the vector's size field, which also holds the
1141 pseudovector type information. It holds the size, too.
1142 The size counts the defalt, parent, purpose, ascii,
1143 contents, and extras slots. */
1144 struct vectorlike_header header
;
1146 /* This holds a default value,
1147 which is used whenever the value for a specific character is nil. */
1150 /* This points to another char table, which we inherit from when the
1151 value for a specific character is nil. The `defalt' slot takes
1152 precedence over this. */
1155 /* This is a symbol which says what kind of use this char-table is
1157 Lisp_Object purpose
;
1159 /* The bottom sub char-table for characters of the range 0..127. It
1160 is nil if none of ASCII character has a specific value. */
1163 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1165 /* These hold additional data. It is a vector. */
1166 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1169 struct Lisp_Sub_Char_Table
1171 /* HEADER.SIZE is the vector's size field, which also holds the
1172 pseudovector type information. It holds the size, too. */
1173 struct vectorlike_header header
;
1175 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1176 char-table of depth 1 contains 16 elements, and each element
1177 covers 4096 (128*32) characters. A sub char-table of depth 2
1178 contains 32 elements, and each element covers 128 characters. A
1179 sub char-table of depth 3 contains 128 elements, and each element
1180 is for one character. */
1183 /* Minimum character covered by the sub char-table. */
1184 Lisp_Object min_char
;
1186 /* Use set_sub_char_table_contents to set this. */
1187 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1191 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1193 struct Lisp_Char_Table
*tbl
= NULL
;
1197 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1198 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1199 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1203 while (NILP (val
) && ! NILP (tbl
->parent
));
1208 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1209 characters. Do not check validity of CT. */
1211 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1213 return (ASCII_CHAR_P (idx
)
1214 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1215 : char_table_ref (ct
, idx
));
1218 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1219 8-bit European characters. Do not check validity of CT. */
1221 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1223 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1224 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1226 char_table_set (ct
, idx
, val
);
1229 /* This is the number of slots that every char table must have. This
1230 counts the ordinary slots and the top, defalt, parent, and purpose
1232 enum CHAR_TABLE_STANDARD_SLOTS
1234 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1237 /* Return the number of "extra" slots in the char table CT. */
1240 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1242 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1243 - CHAR_TABLE_STANDARD_SLOTS
);
1247 /***********************************************************************
1249 ***********************************************************************/
1251 enum symbol_redirect
1253 SYMBOL_PLAINVAL
= 4,
1254 SYMBOL_VARALIAS
= 1,
1255 SYMBOL_LOCALIZED
= 2,
1256 SYMBOL_FORWARDED
= 3
1263 /* Indicates where the value can be found:
1264 0 : it's a plain var, the value is in the `value' field.
1265 1 : it's a varalias, the value is really in the `alias' symbol.
1266 2 : it's a localized var, the value is in the `blv' object.
1267 3 : it's a forwarding variable, the value is in `forward'. */
1268 ENUM_BF (symbol_redirect
) redirect_
: 3;
1270 /* Non-zero means symbol is constant, i.e. changing its value
1271 should signal an error. If the value is 3, then the var
1272 can be changed, but only by `defconst'. */
1273 unsigned constant_
: 2;
1275 /* True means that this variable has been explicitly declared
1276 special (with `defvar' etc), and shouldn't be lexically bound. */
1277 bool_bf declared_special_
: 1;
1279 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1280 union is used depends on the `redirect' field above. */
1284 struct Lisp_Buffer_Local_Value
*blv_
;
1285 union Lisp_Fwd
*fwd_
;
1289 #define SYMBOL_SELF(sym) (scm_c_vector_ref (sym, 0))
1290 #define SET_SYMBOL_SELF(sym, v) (scm_c_vector_set_x (sym, 0, v))
1291 #define SYMBOL_REDIRECT(sym) (XINT (scm_c_vector_ref (sym, 1)))
1292 #define SET_SYMBOL_REDIRECT(sym, v) (scm_c_vector_set_x (sym, 1, make_number (v)))
1293 #define SYMBOL_CONSTANT(sym) (XINT (scm_c_vector_ref (sym, 2)))
1294 #define SET_SYMBOL_CONSTANT(sym, v) (scm_c_vector_set_x (sym, 2, make_number (v)))
1295 #define SYMBOL_DECLARED_SPECIAL(sym) (XINT (scm_c_vector_ref (sym, 3)))
1296 #define SET_SYMBOL_DECLARED_SPECIAL(sym, v) (scm_c_vector_set_x (sym, 3, make_number (v)))
1298 /* Value is name of symbol. */
1301 SYMBOL_ALIAS (sym_t sym
)
1303 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_VARALIAS
);
1304 return scm_c_vector_ref (sym
, 4);
1306 INLINE
struct Lisp_Buffer_Local_Value
*
1307 SYMBOL_BLV (sym_t sym
)
1309 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_LOCALIZED
);
1310 return scm_to_pointer (scm_c_vector_ref (sym
, 4));
1312 INLINE
union Lisp_Fwd
*
1313 SYMBOL_FWD (sym_t sym
)
1315 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_FORWARDED
);
1316 return scm_to_pointer (scm_c_vector_ref (sym
, 4));
1319 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1320 (sym_t sym
, Lisp_Object v
), (sym
, v
))
1323 SET_SYMBOL_ALIAS (sym_t sym
, sym_t v
)
1325 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_VARALIAS
);
1326 scm_c_vector_set_x (sym
, 4, v
);
1329 SET_SYMBOL_BLV (sym_t sym
, struct Lisp_Buffer_Local_Value
*v
)
1331 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_LOCALIZED
);
1332 scm_c_vector_set_x (sym
, 4, scm_from_pointer (v
, NULL
));
1335 SET_SYMBOL_FWD (sym_t sym
, union Lisp_Fwd
*v
)
1337 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_FORWARDED
);
1338 scm_c_vector_set_x (sym
, 4, scm_from_pointer (v
, NULL
));
1342 SYMBOL_NAME (Lisp_Object sym
)
1344 return build_string (scm_to_locale_string (scm_call_1 (scm_c_public_ref ("language elisp runtime", "symbol-name"), sym
)));
1347 /* Value is true if SYM is an interned symbol. */
1350 SYMBOL_INTERNED_P (Lisp_Object sym
)
1352 if (EQ (sym
, Qnil
)) return true;
1353 if (EQ (sym
, Qt
)) return true;
1354 return scm_is_true (scm_symbol_interned_p (sym
));
1358 SYMBOL_FUNCTION (Lisp_Object sym
)
1360 return scm_call_1 (scm_c_public_ref ("elisp-functions", "symbol-function"), sym
);
1363 /* Value is non-zero if symbol is considered a constant, i.e. its
1364 value cannot be changed (there is an exception for keyword symbols,
1365 whose value can be set to the keyword symbol itself). */
1367 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1369 #define DEFSYM(sym, name) \
1370 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1372 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (sym_t sym
), (sym
))
1375 /***********************************************************************
1377 ***********************************************************************/
1379 /* The structure of a Lisp hash table. */
1381 struct hash_table_test
1383 /* Name of the function used to compare keys. */
1386 /* User-supplied hash function, or nil. */
1387 Lisp_Object user_hash_function
;
1389 /* User-supplied key comparison function, or nil. */
1390 Lisp_Object user_cmp_function
;
1392 /* C function to compare two keys. */
1393 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1395 /* C function to compute hash code. */
1396 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1399 struct Lisp_Hash_Table
1401 /* This is for Lisp; the hash table code does not refer to it. */
1402 struct vectorlike_header header
;
1404 /* Nil if table is non-weak. Otherwise a symbol describing the
1405 weakness of the table. */
1408 /* When the table is resized, and this is an integer, compute the
1409 new size by adding this to the old size. If a float, compute the
1410 new size by multiplying the old size with this factor. */
1411 Lisp_Object rehash_size
;
1413 /* Resize hash table when number of entries/ table size is >= this
1415 Lisp_Object rehash_threshold
;
1417 /* Vector of hash codes. If hash[I] is nil, this means that the
1418 I-th entry is unused. */
1421 /* Vector used to chain entries. If entry I is free, next[I] is the
1422 entry number of the next free item. If entry I is non-free,
1423 next[I] is the index of the next entry in the collision chain. */
1426 /* Index of first free entry in free list. */
1427 Lisp_Object next_free
;
1429 /* Bucket vector. A non-nil entry is the index of the first item in
1430 a collision chain. This vector's size can be larger than the
1431 hash table size to reduce collisions. */
1434 /* Only the fields above are traced normally by the GC. The ones below
1435 `count' are special and are either ignored by the GC or traced in
1436 a special way (e.g. because of weakness). */
1438 /* Number of key/value entries in the table. */
1441 /* Vector of keys and values. The key of item I is found at index
1442 2 * I, the value is found at index 2 * I + 1.
1443 This is gc_marked specially if the table is weak. */
1444 Lisp_Object key_and_value
;
1446 /* The comparison and hash functions. */
1447 struct hash_table_test test
;
1449 /* Next weak hash table if this is a weak hash table. The head
1450 of the list is in weak_hash_tables. */
1451 struct Lisp_Hash_Table
*next_weak
;
1455 INLINE
struct Lisp_Hash_Table
*
1456 XHASH_TABLE (Lisp_Object a
)
1458 return SMOB_PTR (a
);
1461 #define XSET_HASH_TABLE(VAR, PTR) \
1462 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1465 HASH_TABLE_P (Lisp_Object a
)
1467 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1470 /* Value is the key part of entry IDX in hash table H. */
1472 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1474 return AREF (h
->key_and_value
, 2 * idx
);
1477 /* Value is the value part of entry IDX in hash table H. */
1479 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1481 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1484 /* Value is the index of the next entry following the one at IDX
1487 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1489 return AREF (h
->next
, idx
);
1492 /* Value is the hash code computed for entry IDX in hash table H. */
1494 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1496 return AREF (h
->hash
, idx
);
1499 /* Value is the index of the element in hash table H that is the
1500 start of the collision list at index IDX in the index vector of H. */
1502 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1504 return AREF (h
->index
, idx
);
1507 /* Value is the size of hash table H. */
1509 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1511 return ASIZE (h
->next
);
1514 /* Default size for hash tables if not specified. */
1516 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1518 /* Default threshold specifying when to resize a hash table. The
1519 value gives the ratio of current entries in the hash table and the
1520 size of the hash table. */
1522 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1524 /* Default factor by which to increase the size of a hash table. */
1526 static double const DEFAULT_REHASH_SIZE
= 1.5;
1528 /* Combine two integers X and Y for hashing. The result might not fit
1529 into a Lisp integer. */
1532 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1534 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1537 /* Hash X, returning a value that fits into a fixnum. */
1540 SXHASH_REDUCE (EMACS_UINT x
)
1542 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1545 /* These structures are used for various misc types. */
1547 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1550 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1556 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1557 /* This flag is temporarily used in the functions
1558 decode/encode_coding_object to record that the marker position
1559 must be adjusted after the conversion. */
1560 bool_bf need_adjustment
: 1;
1561 /* True means normal insertion at the marker's position
1562 leaves the marker after the inserted text. */
1563 bool_bf insertion_type
: 1;
1564 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1565 Note: a chain of markers can contain markers pointing into different
1566 buffers (the chain is per buffer_text rather than per buffer, so it's
1567 shared between indirect buffers). */
1568 /* This is used for (other than NULL-checking):
1570 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1571 - unchain_marker: to find the list from which to unchain.
1572 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1574 struct buffer
*buffer
;
1576 /* The remaining fields are meaningless in a marker that
1577 does not point anywhere. */
1579 /* For markers that point somewhere,
1580 this is used to chain of all the markers in a given buffer. */
1581 /* We could remove it and use an array in buffer_text instead.
1582 That would also allow to preserve it ordered. */
1583 struct Lisp_Marker
*next
;
1584 /* This is the char position where the marker points. */
1586 /* This is the byte position.
1587 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1588 used to implement the functionality of markers, but rather to (ab)use
1589 markers as a cache for char<->byte mappings). */
1593 /* START and END are markers in the overlay's buffer, and
1594 PLIST is the overlay's property list. */
1596 /* An overlay's real data content is:
1598 - buffer (really there are two buffer pointers, one per marker,
1599 and both points to the same buffer)
1600 - insertion type of both ends (per-marker fields)
1601 - start & start byte (of start marker)
1602 - end & end byte (of end marker)
1603 - next (singly linked list of overlays)
1604 - next fields of start and end markers (singly linked list of markers).
1605 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1609 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1610 struct Lisp_Overlay
*next
;
1616 /* Types of data which may be saved in a Lisp_Save_Value. */
1627 /* Number of bits needed to store one of the above values. */
1628 enum { SAVE_SLOT_BITS
= 3 };
1630 /* Number of slots in a save value where save_type is nonzero. */
1631 enum { SAVE_VALUE_SLOTS
= 4 };
1633 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1635 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1639 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1640 SAVE_TYPE_INT_INT_INT
1641 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1642 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1643 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1644 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1645 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1646 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1647 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1648 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1649 SAVE_TYPE_FUNCPTR_PTR_OBJ
1650 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1652 /* This has an extra bit indicating it's raw memory. */
1653 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1656 /* Special object used to hold a different values for later use.
1658 This is mostly used to package C integers and pointers to call
1659 record_unwind_protect when two or more values need to be saved.
1663 struct my_data *md = get_my_data ();
1664 ptrdiff_t mi = get_my_integer ();
1665 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1668 Lisp_Object my_unwind (Lisp_Object arg)
1670 struct my_data *md = XSAVE_POINTER (arg, 0);
1671 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1675 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1676 saved objects and raise eassert if type of the saved object doesn't match
1677 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1678 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1679 slot 0 is a pointer. */
1681 typedef void (*voidfuncptr
) (void);
1683 struct Lisp_Save_Value
1686 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1687 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1689 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1690 V's data entries are determined by V->save_type. E.g., if
1691 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1692 V->data[1] is an integer, and V's other data entries are unused.
1694 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1695 a memory area containing V->data[1].integer potential Lisp_Objects. */
1696 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1699 voidfuncptr funcpointer
;
1702 } data
[SAVE_VALUE_SLOTS
];
1705 /* Return the type of V's Nth saved value. */
1707 save_type (struct Lisp_Save_Value
*v
, int n
)
1709 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1710 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1713 /* Get and set the Nth saved pointer. */
1716 XSAVE_POINTER (Lisp_Object obj
, int n
)
1718 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1719 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1722 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1724 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1725 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1728 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1730 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1731 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1734 /* Likewise for the saved integer. */
1737 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1739 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1740 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1743 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1745 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1746 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1749 /* Extract Nth saved object. */
1752 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1754 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1755 return XSAVE_VALUE (obj
)->data
[n
].object
;
1758 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1759 It uses one of these struct subtypes to get the type field. */
1763 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1764 struct Lisp_Marker u_marker
;
1765 struct Lisp_Overlay u_overlay
;
1766 struct Lisp_Save_Value u_save_value
;
1769 INLINE
union Lisp_Misc
*
1770 XMISC (Lisp_Object a
)
1772 return SMOB_PTR (a
);
1775 INLINE
struct Lisp_Misc_Any
*
1776 XMISCANY (Lisp_Object a
)
1778 eassert (MISCP (a
));
1779 return & XMISC (a
)->u_any
;
1782 INLINE
enum Lisp_Misc_Type
1783 XMISCTYPE (Lisp_Object a
)
1785 return XMISCANY (a
)->type
;
1788 INLINE
struct Lisp_Marker
*
1789 XMARKER (Lisp_Object a
)
1791 eassert (MARKERP (a
));
1792 return & XMISC (a
)->u_marker
;
1795 INLINE
struct Lisp_Overlay
*
1796 XOVERLAY (Lisp_Object a
)
1798 eassert (OVERLAYP (a
));
1799 return & XMISC (a
)->u_overlay
;
1802 INLINE
struct Lisp_Save_Value
*
1803 XSAVE_VALUE (Lisp_Object a
)
1805 eassert (SAVE_VALUEP (a
));
1806 return & XMISC (a
)->u_save_value
;
1809 /* Forwarding pointer to an int variable.
1810 This is allowed only in the value cell of a symbol,
1811 and it means that the symbol's value really lives in the
1812 specified int variable. */
1815 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1819 /* Boolean forwarding pointer to an int variable.
1820 This is like Lisp_Intfwd except that the ostensible
1821 "value" of the symbol is t if the bool variable is true,
1822 nil if it is false. */
1825 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1829 /* Forwarding pointer to a Lisp_Object variable.
1830 This is allowed only in the value cell of a symbol,
1831 and it means that the symbol's value really lives in the
1832 specified variable. */
1835 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1836 Lisp_Object
*objvar
;
1839 /* Like Lisp_Objfwd except that value lives in a slot in the
1840 current buffer. Value is byte index of slot within buffer. */
1841 struct Lisp_Buffer_Objfwd
1843 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1845 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1846 Lisp_Object predicate
;
1849 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1850 the symbol has buffer-local or frame-local bindings. (Exception:
1851 some buffer-local variables are built-in, with their values stored
1852 in the buffer structure itself. They are handled differently,
1853 using struct Lisp_Buffer_Objfwd.)
1855 The `realvalue' slot holds the variable's current value, or a
1856 forwarding pointer to where that value is kept. This value is the
1857 one that corresponds to the loaded binding. To read or set the
1858 variable, you must first make sure the right binding is loaded;
1859 then you can access the value in (or through) `realvalue'.
1861 `buffer' and `frame' are the buffer and frame for which the loaded
1862 binding was found. If those have changed, to make sure the right
1863 binding is loaded it is necessary to find which binding goes with
1864 the current buffer and selected frame, then load it. To load it,
1865 first unload the previous binding, then copy the value of the new
1866 binding into `realvalue' (or through it). Also update
1867 LOADED-BINDING to point to the newly loaded binding.
1869 `local_if_set' indicates that merely setting the variable creates a
1870 local binding for the current buffer. Otherwise the latter, setting
1871 the variable does not do that; only make-local-variable does that. */
1873 struct Lisp_Buffer_Local_Value
1875 /* True means that merely setting the variable creates a local
1876 binding for the current buffer. */
1877 bool_bf local_if_set
: 1;
1878 /* True means this variable can have frame-local bindings, otherwise, it is
1879 can have buffer-local bindings. The two cannot be combined. */
1880 bool_bf frame_local
: 1;
1881 /* True means that the binding now loaded was found.
1882 Presumably equivalent to (defcell!=valcell). */
1884 /* If non-NULL, a forwarding to the C var where it should also be set. */
1885 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1886 /* The buffer or frame for which the loaded binding was found. */
1888 /* A cons cell that holds the default value. It has the form
1889 (SYMBOL . DEFAULT-VALUE). */
1890 Lisp_Object defcell
;
1891 /* The cons cell from `where's parameter alist.
1892 It always has the form (SYMBOL . VALUE)
1893 Note that if `forward' is non-nil, VALUE may be out of date.
1894 Also if the currently loaded binding is the default binding, then
1895 this is `eq'ual to defcell. */
1896 Lisp_Object valcell
;
1899 /* Like Lisp_Objfwd except that value lives in a slot in the
1901 struct Lisp_Kboard_Objfwd
1903 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1909 struct Lisp_Intfwd u_intfwd
;
1910 struct Lisp_Boolfwd u_boolfwd
;
1911 struct Lisp_Objfwd u_objfwd
;
1912 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1913 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1916 INLINE
enum Lisp_Fwd_Type
1917 XFWDTYPE (union Lisp_Fwd
*a
)
1919 return a
->u_intfwd
.type
;
1922 INLINE
struct Lisp_Buffer_Objfwd
*
1923 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
1925 eassert (BUFFER_OBJFWDP (a
));
1926 return &a
->u_buffer_objfwd
;
1929 #define XFLOAT_DATA(f) (scm_to_double (f))
1931 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1932 representations, have infinities and NaNs, and do not trap on
1933 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1934 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1935 wanted here, but is not quite right because Emacs does not require
1936 all the features of C11 Annex F (and does not require C11 at all,
1937 for that matter). */
1941 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
1942 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
1945 /* A character, declared with the following typedef, is a member
1946 of some character set associated with the current buffer. */
1947 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1949 typedef unsigned char UCHAR
;
1952 /* Meanings of slots in a Lisp_Compiled: */
1956 COMPILED_ARGLIST
= 0,
1957 COMPILED_BYTECODE
= 1,
1958 COMPILED_CONSTANTS
= 2,
1959 COMPILED_STACK_DEPTH
= 3,
1960 COMPILED_DOC_STRING
= 4,
1961 COMPILED_INTERACTIVE
= 5
1964 /* Flag bits in a character. These also get used in termhooks.h.
1965 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1966 (MUlti-Lingual Emacs) might need 22 bits for the character value
1967 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1970 CHAR_ALT
= 0x0400000,
1971 CHAR_SUPER
= 0x0800000,
1972 CHAR_HYPER
= 0x1000000,
1973 CHAR_SHIFT
= 0x2000000,
1974 CHAR_CTL
= 0x4000000,
1975 CHAR_META
= 0x8000000,
1977 CHAR_MODIFIER_MASK
=
1978 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1980 /* Actually, the current Emacs uses 22 bits for the character value
1985 /* Data type checking. */
1987 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
1990 NUMBERP (Lisp_Object x
)
1992 return INTEGERP (x
) || FLOATP (x
);
1995 NATNUMP (Lisp_Object x
)
1997 return INTEGERP (x
) && 0 <= XINT (x
);
2001 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2003 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2006 #define TYPE_RANGED_INTEGERP(type, x) \
2008 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2009 && XINT (x) <= TYPE_MAXIMUM (type))
2011 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2012 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2013 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2014 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2015 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2016 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2017 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2020 STRINGP (Lisp_Object x
)
2022 return SMOB_TYPEP (x
, lisp_string_tag
);
2025 VECTORP (Lisp_Object x
)
2027 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2030 OVERLAYP (Lisp_Object x
)
2032 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2035 SAVE_VALUEP (Lisp_Object x
)
2037 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2041 AUTOLOADP (Lisp_Object x
)
2043 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2047 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2049 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2053 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2055 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2056 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2059 /* True if A is a pseudovector whose code is CODE. */
2061 PSEUDOVECTORP (Lisp_Object a
, int code
)
2063 if (! VECTORLIKEP (a
))
2067 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2068 struct vectorlike_header
*h
= SMOB_PTR (a
);
2069 return PSEUDOVECTOR_TYPEP (h
, code
);
2073 /* Test for specific pseudovector types. */
2076 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2078 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2082 PROCESSP (Lisp_Object a
)
2084 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2088 WINDOWP (Lisp_Object a
)
2090 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2094 TERMINALP (Lisp_Object a
)
2096 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2100 COMPILEDP (Lisp_Object a
)
2102 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2106 BUFFERP (Lisp_Object a
)
2108 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2112 CHAR_TABLE_P (Lisp_Object a
)
2114 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2118 SUB_CHAR_TABLE_P (Lisp_Object a
)
2120 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2124 BOOL_VECTOR_P (Lisp_Object a
)
2126 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2130 FRAMEP (Lisp_Object a
)
2132 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2135 /* Test for image (image . spec) */
2137 IMAGEP (Lisp_Object x
)
2139 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2144 ARRAYP (Lisp_Object x
)
2146 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2150 CHECK_LIST (Lisp_Object x
)
2152 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2155 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2156 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2157 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2160 CHECK_STRING (Lisp_Object x
)
2162 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2165 CHECK_STRING_CAR (Lisp_Object x
)
2167 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2170 CHECK_CONS (Lisp_Object x
)
2172 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2175 CHECK_VECTOR (Lisp_Object x
)
2177 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2180 CHECK_BOOL_VECTOR (Lisp_Object x
)
2182 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2185 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2187 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2190 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2192 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2195 CHECK_BUFFER (Lisp_Object x
)
2197 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2200 CHECK_WINDOW (Lisp_Object x
)
2202 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2206 CHECK_PROCESS (Lisp_Object x
)
2208 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2212 CHECK_NATNUM (Lisp_Object x
)
2214 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2217 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2220 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2221 args_out_of_range_3 \
2223 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2224 ? MOST_NEGATIVE_FIXNUM \
2226 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2228 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2230 if (TYPE_SIGNED (type)) \
2231 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2233 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2236 #define CHECK_NUMBER_COERCE_MARKER(x) \
2238 if (MARKERP ((x))) \
2239 XSETFASTINT (x, marker_position (x)); \
2241 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2245 XFLOATINT (Lisp_Object n
)
2247 return extract_float (n
);
2251 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2253 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2256 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2259 XSETFASTINT (x, marker_position (x)); \
2261 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2264 /* Since we can't assign directly to the CAR or CDR fields of a cons
2265 cell, use these when checking that those fields contain numbers. */
2267 CHECK_NUMBER_CAR (Lisp_Object x
)
2269 Lisp_Object tmp
= XCAR (x
);
2275 CHECK_NUMBER_CDR (Lisp_Object x
)
2277 Lisp_Object tmp
= XCDR (x
);
2282 /* Define a built-in function for calling from Lisp.
2283 `lname' should be the name to give the function in Lisp,
2284 as a null-terminated C string.
2285 `fnname' should be the name of the function in C.
2286 By convention, it starts with F.
2287 `sname' should be the name for the C constant structure
2288 that records information on this function for internal use.
2289 By convention, it should be the same as `fnname' but with S instead of F.
2290 It's too bad that C macros can't compute this from `fnname'.
2291 `minargs' should be a number, the minimum number of arguments allowed.
2292 `maxargs' should be a number, the maximum number of arguments allowed,
2293 or else MANY or UNEVALLED.
2294 MANY means pass a vector of evaluated arguments,
2295 in the form of an integer number-of-arguments
2296 followed by the address of a vector of Lisp_Objects
2297 which contains the argument values.
2298 UNEVALLED means pass the list of unevaluated arguments
2299 `intspec' says how interactive arguments are to be fetched.
2300 If the string starts with a `(', `intspec' is evaluated and the resulting
2301 list is the list of arguments.
2302 If it's a string that doesn't start with `(', the value should follow
2303 the one of the doc string for `interactive'.
2304 A null string means call interactively with no arguments.
2305 `doc' is documentation for the user. */
2307 /* This version of DEFUN declares a function prototype with the right
2308 arguments, so we can catch errors with maxargs at compile-time. */
2309 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2310 SCM_SNARF_INIT (defsubr (lname, gsubr_ ## fnname, minargs, maxargs, intspec)) \
2311 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2312 DEFUN_GSUBR_ ## maxargs (lname, fnname, minargs, maxargs) \
2315 #define GSUBR_ARGS_1(f) f (arg1)
2316 #define GSUBR_ARGS_2(f) GSUBR_ARGS_1 (f), f (arg2)
2317 #define GSUBR_ARGS_3(f) GSUBR_ARGS_2 (f), f (arg3)
2318 #define GSUBR_ARGS_4(f) GSUBR_ARGS_3 (f), f (arg4)
2319 #define GSUBR_ARGS_5(f) GSUBR_ARGS_4 (f), f (arg5)
2320 #define GSUBR_ARGS_6(f) GSUBR_ARGS_5 (f), f (arg6)
2321 #define GSUBR_ARGS_7(f) GSUBR_ARGS_6 (f), f (arg7)
2322 #define GSUBR_ARGS_8(f) GSUBR_ARGS_7 (f), f (arg8)
2324 #define GSUBR_ARGS(n) GSUBR_ARGS_PASTE (GSUBR_ARGS_, n)
2325 #define GSUBR_ARGS_PASTE(a, b) a ## b
2327 #define DEFUN_GSUBR_N(fn, maxargs) \
2330 (GSUBR_ARGS (maxargs) (Lisp_Object)) \
2332 return fn (GSUBR_ARGS (maxargs) (GSUBR_ARG)); \
2334 #define GSUBR_ARG(x) (SCM_UNBNDP (x) ? Qnil : x)
2336 #define DEFUN_GSUBR_0(lname, fn, minargs, maxargs) \
2337 Lisp_Object gsubr_ ## fn (void) { return fn (); }
2338 #define DEFUN_GSUBR_1(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2339 #define DEFUN_GSUBR_2(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2340 #define DEFUN_GSUBR_3(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2341 #define DEFUN_GSUBR_4(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2342 #define DEFUN_GSUBR_5(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2343 #define DEFUN_GSUBR_6(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2344 #define DEFUN_GSUBR_7(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2345 #define DEFUN_GSUBR_8(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2347 #define DEFUN_GSUBR_UNEVALLED(lname, fn, minargs, maxargs) \
2349 gsubr_ ## fn (Lisp_Object rest) \
2351 Lisp_Object len = Flength (rest); \
2352 if (XINT (len) < minargs) \
2353 xsignal2 (Qwrong_number_of_arguments, \
2354 intern (lname), len); \
2357 #define DEFUN_GSUBR_MANY(lname, fn, minargs, maxargs) \
2359 gsubr_ ## fn (Lisp_Object rest) \
2361 int len = scm_to_int (scm_length (rest)); \
2362 Lisp_Object *args; \
2363 SAFE_ALLOCA_LISP (args, len); \
2366 i < len && scm_is_pair (rest); \
2367 i++, rest = SCM_CDR (rest)) \
2368 args[i] = SCM_CAR (rest); \
2370 xsignal2 (Qwrong_number_of_arguments, \
2371 intern (lname), make_number (i)); \
2372 return fn (i, args); \
2375 /* Note that the weird token-substitution semantics of ANSI C makes
2376 this work for MANY and UNEVALLED. */
2377 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2378 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2379 #define DEFUN_ARGS_0 (void)
2380 #define DEFUN_ARGS_1 (Lisp_Object)
2381 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2382 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2383 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2384 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2386 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2387 Lisp_Object, Lisp_Object)
2388 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2389 Lisp_Object, Lisp_Object, Lisp_Object)
2390 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2391 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2393 #define WRAP1(cfn, lfn) Lisp_Object cfn (Lisp_Object a) { return call1 (intern (lfn), a); }
2394 #define WRAP2(cfn, lfn) Lisp_Object cfn (Lisp_Object a, Lisp_Object b) { return call2 (intern (lfn), a, b); }
2396 /* True if OBJ is a Lisp function. */
2398 FUNCTIONP (Lisp_Object obj
)
2400 return functionp (obj
);
2404 is how we define the symbol for function `name' at start-up time. */
2405 extern void defsubr (const char *, scm_t_subr
, short, short, const char *);
2413 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2414 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2415 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2416 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2417 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2419 /* Macros we use to define forwarded Lisp variables.
2420 These are used in the syms_of_FILENAME functions.
2422 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2423 lisp variable is actually a field in `struct emacs_globals'. The
2424 field's name begins with "f_", which is a convention enforced by
2425 these macros. Each such global has a corresponding #define in
2426 globals.h; the plain name should be used in the code.
2428 E.g., the global "cons_cells_consed" is declared as "int
2429 f_cons_cells_consed" in globals.h, but there is a define:
2431 #define cons_cells_consed globals.f_cons_cells_consed
2433 All C code uses the `cons_cells_consed' name. This is all done
2434 this way to support indirection for multi-threaded Emacs. */
2436 #define DEFVAR_LISP(lname, vname, doc) \
2438 static struct Lisp_Objfwd o_fwd; \
2439 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2441 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2443 static struct Lisp_Objfwd o_fwd; \
2444 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2446 #define DEFVAR_BOOL(lname, vname, doc) \
2448 static struct Lisp_Boolfwd b_fwd; \
2449 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2451 #define DEFVAR_INT(lname, vname, doc) \
2453 static struct Lisp_Intfwd i_fwd; \
2454 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2457 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2459 static struct Lisp_Objfwd o_fwd; \
2460 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2463 #define DEFVAR_KBOARD(lname, vname, doc) \
2465 static struct Lisp_Kboard_Objfwd ko_fwd; \
2466 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2469 /* Save and restore the instruction and environment pointers,
2470 without affecting the signal mask. */
2473 typedef jmp_buf sys_jmp_buf
;
2474 # define sys_setjmp(j) _setjmp (j)
2475 # define sys_longjmp(j, v) _longjmp (j, v)
2476 #elif defined HAVE_SIGSETJMP
2477 typedef sigjmp_buf sys_jmp_buf
;
2478 # define sys_setjmp(j) sigsetjmp (j, 0)
2479 # define sys_longjmp(j, v) siglongjmp (j, v)
2481 /* A platform that uses neither _longjmp nor siglongjmp; assume
2482 longjmp does not affect the sigmask. */
2483 typedef jmp_buf sys_jmp_buf
;
2484 # define sys_setjmp(j) setjmp (j)
2485 # define sys_longjmp(j, v) longjmp (j, v)
2489 /* Elisp uses several stacks:
2491 - the bytecode stack: used internally by the bytecode interpreter.
2492 Allocated from the C stack.
2493 - The specpdl stack: keeps track of active unwind-protect and
2494 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2496 - The handler stack: keeps track of active catch tags and condition-case
2497 handlers. Allocated in a manually managed stack implemented by a
2498 doubly-linked list allocated via xmalloc and never freed. */
2500 /* Structure for recording Lisp call stack for backtrace purposes. */
2502 /* The special binding stack holds the outer values of variables while
2503 they are bound by a function application or a let form, stores the
2504 code to be executed for unwind-protect forms.
2506 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2507 used all over the place, needs to be fast, and needs to know the size of
2508 union specbinding. But only eval.c should access it. */
2511 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2512 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2513 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2514 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2515 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2520 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2522 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2525 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2526 bool wind_explicitly
;
2527 void (*func
) (Lisp_Object
);
2531 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2532 bool wind_explicitly
;
2533 void (*func
) (void *);
2537 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2538 bool wind_explicitly
;
2543 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2544 bool wind_explicitly
;
2545 void (*func
) (void);
2548 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2549 /* `where' is not used in the case of SPECPDL_LET. */
2550 Lisp_Object symbol
, old_value
, where
;
2553 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2554 bool_bf debug_on_exit
: 1;
2555 Lisp_Object function
;
2561 extern union specbinding
*specpdl
;
2562 extern union specbinding
*specpdl_ptr
;
2563 extern ptrdiff_t specpdl_size
;
2566 SPECPDL_INDEX (void)
2568 return specpdl_ptr
- specpdl
;
2571 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2572 control structures. A struct handler contains all the information needed to
2573 restore the state of the interpreter after a non-local jump.
2575 handler structures are chained together in a doubly linked list; the `next'
2576 member points to the next outer catchtag and the `nextfree' member points in
2577 the other direction to the next inner element (which is typically the next
2578 free element since we mostly use it on the deepest handler).
2580 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2581 member is TAG, and then unbinds to it. The `val' member is used to
2582 hold VAL while the stack is unwound; `val' is returned as the value
2585 All the other members are concerned with restoring the interpreter
2588 Members are volatile if their values need to survive _longjmp when
2589 a 'struct handler' is a local variable. */
2591 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2595 enum handlertype type
;
2597 Lisp_Object tag_or_ch
;
2601 struct handler
*next
;
2602 EMACS_INT lisp_eval_depth
;
2603 int interrupt_input_blocked
;
2606 extern Lisp_Object memory_signal_data
;
2608 /* Check quit-flag and quit if it is non-nil.
2609 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2610 So the program needs to do QUIT at times when it is safe to quit.
2611 Every loop that might run for a long time or might not exit
2612 ought to do QUIT at least once, at a safe place.
2613 Unless that is impossible, of course.
2614 But it is very desirable to avoid creating loops where QUIT is impossible.
2616 Exception: if you set immediate_quit to true,
2617 then the handler that responds to the C-g does the quit itself.
2618 This is a good thing to do around a loop that has no side effects
2619 and (in particular) cannot call arbitrary Lisp code.
2621 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2622 a request to exit Emacs when it is safe to do. */
2624 extern void process_pending_signals (void);
2625 extern bool volatile pending_signals
;
2627 extern void process_quit_flag (void);
2630 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2631 process_quit_flag (); \
2632 else if (pending_signals) \
2633 process_pending_signals (); \
2637 /* True if ought to quit now. */
2639 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2641 extern Lisp_Object Vascii_downcase_table
;
2642 extern Lisp_Object Vascii_canon_table
;
2644 /* Structure for recording stack slots that need marking. */
2646 /* This is a chain of structures, each of which points at a Lisp_Object
2647 variable whose value should be marked in garbage collection.
2648 Normally every link of the chain is an automatic variable of a function,
2649 and its `val' points to some argument or local variable of the function.
2650 On exit to the function, the chain is set back to the value it had on entry.
2651 This way, no link remains in the chain when the stack frame containing the
2654 Every function that can call Feval must protect in this fashion all
2655 Lisp_Object variables whose contents will be used again. */
2657 extern struct gcpro
*gcprolist
;
2663 /* Address of first protected variable. */
2664 volatile Lisp_Object
*var
;
2666 /* Number of consecutive protected variables. */
2674 /* Do something silly with gcproN vars just so gcc shuts up. */
2675 /* You get warnings from MIPSPro... */
2677 #define GCPRO1(varname) ((void) gcpro1)
2678 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2679 #define GCPRO3(varname1, varname2, varname3) \
2680 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2681 #define GCPRO4(varname1, varname2, varname3, varname4) \
2682 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2683 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2684 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2685 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2686 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2688 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2689 #define UNGCPRO ((void) 0)
2691 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2692 #define RETURN_UNGCPRO(expr) \
2695 Lisp_Object ret_ungc_val; \
2696 ret_ungc_val = (expr); \
2698 return ret_ungc_val; \
2702 /* Call staticpro (&var) to protect static variable `var'. */
2704 void staticpro (Lisp_Object
*);
2706 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2707 meaning as in the DEFUN macro, and is used to construct a prototype. */
2708 /* We can use the same trick as in the DEFUN macro to generate the
2709 appropriate prototype. */
2710 #define EXFUN(fnname, maxargs) \
2711 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2713 #include "globals.h"
2715 /* Forward declarations for prototypes. */
2719 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2722 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2724 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2725 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2728 /* Functions to modify hash tables. */
2731 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2733 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2737 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2739 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2742 /* Use these functions to set Lisp_Object
2743 or pointer slots of struct Lisp_Symbol. */
2746 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2748 scm_call_2 (scm_c_public_ref ("language elisp runtime", "set-symbol-function!"),
2753 symbol_plist (Lisp_Object sym
)
2755 return scm_call_1 (scm_c_public_ref ("language elisp runtime", "symbol-plist"),
2760 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2762 scm_call_2 (scm_c_public_ref ("language elisp runtime", "set-symbol-plist!"),
2766 /* Buffer-local (also frame-local) variable access functions. */
2769 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2771 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2775 /* Set overlay's property list. */
2778 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2780 XOVERLAY (overlay
)->plist
= plist
;
2783 /* Get text properties of S. */
2786 string_intervals (Lisp_Object s
)
2788 return XSTRING (s
)->intervals
;
2791 /* Set text properties of S to I. */
2794 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2796 XSTRING (s
)->intervals
= i
;
2799 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2800 of setting slots directly. */
2803 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2805 XCHAR_TABLE (table
)->defalt
= val
;
2808 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2810 XCHAR_TABLE (table
)->purpose
= val
;
2813 /* Set different slots in (sub)character tables. */
2816 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2818 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2819 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2823 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2825 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2826 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2830 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2832 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2835 /* Defined in data.c. */
2836 extern Lisp_Object Qnil_
, Qt_
;
2837 extern Lisp_Object Qquote
, Qunbound
;
2838 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2839 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2840 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2841 extern Lisp_Object Qinvalid_read_syntax
;
2842 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2843 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2844 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2845 extern Lisp_Object Qtext_read_only
;
2846 extern Lisp_Object Qinteractive_form
;
2847 extern Lisp_Object Qcircular_list
;
2848 extern Lisp_Object Qsequencep
;
2849 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2850 extern Lisp_Object Qfboundp
;
2851 extern Lisp_Object Qspecial_operator
;
2853 extern Lisp_Object Qcdr
;
2855 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2857 extern Lisp_Object Qnumber_or_marker_p
;
2859 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2861 /* Defined in data.c. */
2862 extern Lisp_Object
indirect_function (Lisp_Object
);
2863 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2864 enum Arith_Comparison
{
2869 ARITH_LESS_OR_EQUAL
,
2872 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2873 enum Arith_Comparison comparison
);
2875 /* Convert the integer I to an Emacs representation, either the integer
2876 itself, or a cons of two or three integers, or if all else fails a float.
2877 I should not have side effects. */
2878 #define INTEGER_TO_CONS(i) \
2879 (! FIXNUM_OVERFLOW_P (i) \
2881 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2882 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2883 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2884 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2885 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2886 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2887 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2888 ? Fcons (make_number ((i) >> 16 >> 24), \
2889 Fcons (make_number ((i) >> 16 & 0xffffff), \
2890 make_number ((i) & 0xffff))) \
2893 /* Convert the Emacs representation CONS back to an integer of type
2894 TYPE, storing the result the variable VAR. Signal an error if CONS
2895 is not a valid representation or is out of range for TYPE. */
2896 #define CONS_TO_INTEGER(cons, type, var) \
2897 (TYPE_SIGNED (type) \
2898 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2899 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2900 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2901 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2903 extern sym_t
indirect_variable (sym_t
);
2904 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2905 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2907 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2908 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2909 extern void syms_of_data (void);
2910 extern void swap_in_global_binding (sym_t
);
2912 /* Defined in cmds.c */
2913 extern void syms_of_cmds (void);
2914 extern void keys_of_cmds (void);
2916 /* Defined in coding.c. */
2917 extern Lisp_Object Qcharset
;
2918 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2919 ptrdiff_t, bool, bool, Lisp_Object
);
2920 extern void init_coding (void);
2921 extern void init_coding_once (void);
2922 extern void syms_of_coding (void);
2924 /* Defined in character.c. */
2925 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2926 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2927 extern void syms_of_character (void);
2929 /* Defined in charset.c. */
2930 extern void init_charset (void);
2931 extern void init_charset_once (void);
2932 extern void syms_of_charset (void);
2933 /* Structure forward declarations. */
2936 /* Defined in syntax.c. */
2937 extern void init_syntax_once (void);
2938 extern void syms_of_syntax (void);
2940 /* Defined in fns.c. */
2941 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2942 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2943 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2944 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2945 extern void sweep_weak_hash_tables (void);
2946 extern Lisp_Object Qcursor_in_echo_area
;
2947 extern Lisp_Object Qstring_lessp
;
2948 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2949 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2950 EMACS_UINT
sxhash (Lisp_Object
, int);
2951 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2952 Lisp_Object
, Lisp_Object
);
2953 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2954 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2956 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2957 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2958 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2959 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2960 ptrdiff_t, ptrdiff_t);
2961 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2962 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2963 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2964 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2965 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2966 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2967 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2968 extern void clear_string_char_byte_cache (void);
2969 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2970 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2971 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2972 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2973 extern void init_fns_once (void);
2974 extern void syms_of_fns (void);
2976 /* Defined in floatfns.c. */
2977 extern void syms_of_floatfns (void);
2978 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2980 /* Defined in fringe.c. */
2981 extern void syms_of_fringe (void);
2982 extern void init_fringe (void);
2983 #ifdef HAVE_WINDOW_SYSTEM
2984 extern void mark_fringe_data (void);
2985 extern void init_fringe_once (void);
2986 #endif /* HAVE_WINDOW_SYSTEM */
2988 /* Defined in image.c. */
2989 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2990 extern Lisp_Object QCconversion
;
2991 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2992 extern void reset_image_types (void);
2993 extern void syms_of_image (void);
2995 /* Defined in insdel.c. */
2996 extern Lisp_Object Qinhibit_modification_hooks
;
2997 extern Lisp_Object Qregion_extract_function
;
2998 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
2999 extern _Noreturn
void buffer_overflow (void);
3000 extern void make_gap (ptrdiff_t);
3001 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3002 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3003 ptrdiff_t, bool, bool);
3004 extern int count_combining_before (const unsigned char *,
3005 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3006 extern int count_combining_after (const unsigned char *,
3007 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3008 extern void insert (const char *, ptrdiff_t);
3009 extern void insert_and_inherit (const char *, ptrdiff_t);
3010 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3012 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3013 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3014 ptrdiff_t, ptrdiff_t, bool);
3015 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3016 extern void insert_char (int);
3017 extern void insert_string (const char *);
3018 extern void insert_before_markers (const char *, ptrdiff_t);
3019 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3020 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3021 ptrdiff_t, ptrdiff_t,
3023 extern void del_range (ptrdiff_t, ptrdiff_t);
3024 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3025 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3026 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3027 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3028 ptrdiff_t, ptrdiff_t, bool);
3029 extern void modify_text (ptrdiff_t, ptrdiff_t);
3030 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3031 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3032 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3033 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3034 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3035 ptrdiff_t, ptrdiff_t);
3036 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3037 ptrdiff_t, ptrdiff_t);
3038 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3039 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3040 const char *, ptrdiff_t, ptrdiff_t, bool);
3041 extern void syms_of_insdel (void);
3043 /* Defined in dispnew.c. */
3044 #if (defined PROFILING \
3045 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3046 _Noreturn
void __executable_start (void);
3048 extern Lisp_Object Vwindow_system
;
3049 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3051 /* Defined in xdisp.c. */
3052 extern Lisp_Object Qinhibit_point_motion_hooks
;
3053 extern Lisp_Object Qinhibit_redisplay
;
3054 extern Lisp_Object Qmenu_bar_update_hook
;
3055 extern Lisp_Object Qwindow_scroll_functions
;
3056 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3057 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3058 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3059 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3060 extern Lisp_Object Qleft_margin
, Qright_margin
;
3061 extern Lisp_Object QCdata
, QCfile
;
3062 extern Lisp_Object QCmap
;
3063 extern Lisp_Object Qrisky_local_variable
;
3064 extern bool noninteractive_need_newline
;
3065 extern Lisp_Object echo_area_buffer
[2];
3066 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3067 extern void check_message_stack (void);
3068 extern void setup_echo_area_for_printing (int);
3069 extern bool push_message (void);
3070 extern void pop_message_unwind (void);
3071 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3072 extern void restore_message (void);
3073 extern Lisp_Object
current_message (void);
3074 extern void clear_message (bool, bool);
3075 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3076 extern void message1 (const char *);
3077 extern void message1_nolog (const char *);
3078 extern void message3 (Lisp_Object
);
3079 extern void message3_nolog (Lisp_Object
);
3080 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3081 extern void message_with_string (const char *, Lisp_Object
, int);
3082 extern void message_log_maybe_newline (void);
3083 extern void update_echo_area (void);
3084 extern void truncate_echo_area (ptrdiff_t);
3085 extern void redisplay (void);
3087 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3088 extern void syms_of_xdisp (void);
3089 extern void init_xdisp (void);
3090 extern Lisp_Object
safe_eval (Lisp_Object
);
3091 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3092 int *, int *, int *, int *, int *);
3094 /* Defined in xsettings.c. */
3095 extern void syms_of_xsettings (void);
3097 /* Defined in vm-limit.c. */
3098 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3100 /* Defined in alloc.c. */
3101 extern void check_pure_size (void);
3102 extern void free_misc (Lisp_Object
);
3103 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3104 extern void malloc_warning (const char *);
3105 extern _Noreturn
void memory_full (size_t);
3106 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3107 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3108 extern void refill_memory_reserve (void);
3110 extern const char *pending_malloc_warning
;
3111 extern Lisp_Object zero_vector
;
3112 extern Lisp_Object
list1 (Lisp_Object
);
3113 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3114 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3115 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3116 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3118 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3119 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3121 /* Build a frequently used 2/3/4-integer lists. */
3124 list2i (EMACS_INT x
, EMACS_INT y
)
3126 return list2 (make_number (x
), make_number (y
));
3130 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3132 return list3 (make_number (x
), make_number (y
), make_number (w
));
3136 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3138 return list4 (make_number (x
), make_number (y
),
3139 make_number (w
), make_number (h
));
3142 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3143 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3144 extern _Noreturn
void string_overflow (void);
3145 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3146 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3147 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3148 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3150 /* Make unibyte string from C string when the length isn't known. */
3153 build_unibyte_string (const char *str
)
3155 return make_unibyte_string (str
, strlen (str
));
3158 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3159 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3160 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3161 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3162 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3163 extern Lisp_Object
make_specified_string (const char *,
3164 ptrdiff_t, ptrdiff_t, bool);
3165 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3166 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3168 /* Make a string allocated in pure space, use STR as string data. */
3171 build_pure_c_string (const char *str
)
3173 return make_pure_c_string (str
, strlen (str
));
3176 /* Make a string from the data at STR, treating it as multibyte if the
3180 build_string (const char *str
)
3182 return make_string (str
, strlen (str
));
3185 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3186 extern void make_byte_code (struct Lisp_Vector
*);
3187 extern Lisp_Object Qchar_table_extra_slots
;
3188 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3190 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3191 be sure that GC cannot happen until the vector is completely
3192 initialized. E.g. the following code is likely to crash:
3194 v = make_uninit_vector (3);
3196 ASET (v, 1, Ffunction_can_gc ());
3197 ASET (v, 2, obj1); */
3200 make_uninit_vector (ptrdiff_t size
)
3203 struct Lisp_Vector
*p
;
3205 p
= allocate_vector (size
);
3210 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3211 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3213 allocate_pseudovector \
3214 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3215 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3216 extern struct window
*allocate_window (void);
3217 extern struct frame
*allocate_frame (void);
3218 extern struct Lisp_Process
*allocate_process (void);
3219 extern struct terminal
*allocate_terminal (void);
3220 extern Lisp_Object
make_float (double);
3221 extern void display_malloc_warning (void);
3222 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3223 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3224 Lisp_Object
, Lisp_Object
);
3225 extern Lisp_Object
make_save_ptr (void *);
3226 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3227 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3228 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3230 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3231 extern void free_save_value (Lisp_Object
);
3232 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3233 extern void init_alloc_once (void);
3234 extern void init_alloc (void);
3235 extern void syms_of_alloc (void);
3236 extern struct buffer
* allocate_buffer (void);
3237 extern int valid_lisp_object_p (Lisp_Object
);
3238 extern int relocatable_string_data_p (const char *);
3241 /* Defined in ralloc.c. */
3242 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3243 extern void r_alloc_free (void **);
3244 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3245 extern void r_alloc_reset_variable (void **, void **);
3246 extern void r_alloc_inhibit_buffer_relocation (int);
3249 /* Defined in chartab.c. */
3250 extern Lisp_Object
copy_char_table (Lisp_Object
);
3251 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3253 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3254 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3256 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3257 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3258 Lisp_Object
, Lisp_Object
,
3259 Lisp_Object
, struct charset
*,
3260 unsigned, unsigned);
3261 extern Lisp_Object
uniprop_table (Lisp_Object
);
3262 extern void syms_of_chartab (void);
3264 /* Defined in print.c. */
3265 extern Lisp_Object Vprin1_to_string_buffer
;
3266 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3267 extern Lisp_Object Qstandard_output
;
3268 extern Lisp_Object Qexternal_debugging_output
;
3269 extern void temp_output_buffer_setup (const char *);
3270 extern int print_level
;
3271 extern Lisp_Object Qprint_escape_newlines
;
3272 extern void write_string (const char *, int);
3273 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3275 extern Lisp_Object internal_with_output_to_temp_buffer
3276 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3277 #define FLOAT_TO_STRING_BUFSIZE 350
3278 extern int float_to_string (char *, double);
3279 extern void init_print_once (void);
3280 extern void syms_of_print (void);
3282 /* Defined in doprnt.c. */
3283 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3285 extern ptrdiff_t esprintf (char *, char const *, ...)
3286 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3287 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3289 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3290 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3291 char const *, va_list)
3292 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3294 /* Defined in lread.c. */
3295 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3296 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3297 extern Lisp_Object Qlexical_binding
;
3298 extern Lisp_Object
check_obarray (Lisp_Object
);
3299 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3300 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3301 extern Lisp_Object
obhash (Lisp_Object
);
3303 LOADHIST_ATTACH (Lisp_Object x
)
3306 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3308 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3309 Lisp_Object
*, Lisp_Object
, bool);
3310 extern Lisp_Object
string_to_number (char const *, int, bool);
3311 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3313 extern void dir_warning (const char *, Lisp_Object
);
3314 extern void init_obarray (void);
3315 extern void init_lread (void);
3316 extern void syms_of_lread (void);
3319 intern (const char *str
)
3321 return intern_1 (str
, strlen (str
));
3325 intern_c_string (const char *str
)
3327 return intern_c_string_1 (str
, strlen (str
));
3330 /* Defined in eval.c. */
3331 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3332 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3333 extern Lisp_Object Qand_rest
;
3334 extern Lisp_Object Vautoload_queue
;
3335 extern Lisp_Object Vsignaling_function
;
3336 extern Lisp_Object inhibit_lisp_code
;
3337 extern struct handler
*handlerlist
;
3339 /* To run a normal hook, use the appropriate function from the list below.
3340 The calling convention:
3342 if (!NILP (Vrun_hooks))
3343 call1 (Vrun_hooks, Qmy_funny_hook);
3345 should no longer be used. */
3346 extern Lisp_Object Vrun_hooks
;
3347 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3348 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3349 Lisp_Object (*funcall
)
3350 (ptrdiff_t nargs
, Lisp_Object
*args
));
3351 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3352 extern _Noreturn
void xsignal0 (Lisp_Object
);
3353 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3354 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3355 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3357 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3358 extern Lisp_Object
eval_sub (Lisp_Object form
);
3359 extern Lisp_Object
Ffuncall (ptrdiff_t nargs
, Lisp_Object
*args
);
3360 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3361 extern Lisp_Object
call0 (Lisp_Object
);
3362 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3363 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3364 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3365 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3366 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3367 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3368 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3369 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3370 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3371 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3372 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3373 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3374 extern Lisp_Object internal_condition_case_n
3375 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3376 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3377 extern void specbind (Lisp_Object
, Lisp_Object
);
3378 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3379 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3380 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3381 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3382 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3383 extern void record_unwind_protect_int (void (*) (int), int);
3384 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3385 extern void record_unwind_protect_void (void (*) (void));
3386 extern void dynwind_begin (void);
3387 extern void dynwind_end (void);
3388 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3389 extern _Noreturn
void verror (const char *, va_list)
3390 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3391 extern void un_autoload (Lisp_Object
);
3392 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3393 extern void init_eval_once (void);
3394 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3395 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3396 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3397 extern void init_eval (void);
3398 extern void syms_of_eval (void);
3399 extern void unwind_body (Lisp_Object
);
3400 extern void record_in_backtrace (Lisp_Object function
,
3401 Lisp_Object
*args
, ptrdiff_t nargs
);
3402 extern void mark_specpdl (void);
3403 extern void get_backtrace (Lisp_Object array
);
3404 Lisp_Object
backtrace_top_function (void);
3405 extern bool let_shadows_buffer_binding_p (sym_t symbol
);
3406 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3407 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3408 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3409 extern SCM
make_prompt_tag (void);
3412 /* Defined in editfns.c. */
3413 extern Lisp_Object Qfield
;
3414 extern void insert1 (Lisp_Object
);
3415 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3416 extern Lisp_Object
save_excursion_save (void);
3417 extern Lisp_Object
save_restriction_save (void);
3418 extern void save_excursion_restore (Lisp_Object
);
3419 extern void save_restriction_restore (Lisp_Object
);
3420 extern _Noreturn
void time_overflow (void);
3421 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3422 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3424 extern void init_editfns (void);
3425 extern void syms_of_editfns (void);
3426 extern void set_time_zone_rule (const char *);
3428 /* Defined in buffer.c. */
3429 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3430 extern _Noreturn
void nsberror (Lisp_Object
);
3431 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3432 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3433 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3434 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3435 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3436 extern bool overlay_touches_p (ptrdiff_t);
3437 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3438 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3439 extern void init_buffer_once (void);
3440 extern void init_buffer (int);
3441 extern void syms_of_buffer (void);
3442 extern void keys_of_buffer (void);
3444 /* Defined in marker.c. */
3446 extern ptrdiff_t marker_position (Lisp_Object
);
3447 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3448 extern void clear_charpos_cache (struct buffer
*);
3449 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3450 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3451 extern void unchain_marker (struct Lisp_Marker
*marker
);
3452 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3453 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3454 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3455 ptrdiff_t, ptrdiff_t);
3456 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3457 extern void syms_of_marker (void);
3459 /* Defined in fileio.c. */
3461 extern Lisp_Object Qfile_error
;
3462 extern Lisp_Object Qfile_notify_error
;
3463 extern Lisp_Object Qfile_exists_p
;
3464 extern Lisp_Object Qfile_directory_p
;
3465 extern Lisp_Object Qinsert_file_contents
;
3466 extern Lisp_Object Qfile_name_history
;
3467 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3468 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3469 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3471 extern void close_file_unwind (int);
3472 extern void close_file_ptr_unwind (void *);
3473 extern void fclose_unwind (void *);
3474 extern void fclose_ptr_unwind (void *);
3475 extern void restore_point_unwind (Lisp_Object
);
3476 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3477 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3478 extern bool internal_delete_file (Lisp_Object
);
3479 extern Lisp_Object
emacs_readlinkat (int, const char *);
3480 extern bool file_directory_p (const char *);
3481 extern bool file_accessible_directory_p (const char *);
3482 extern void init_fileio (void);
3483 extern void syms_of_fileio (void);
3484 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3485 extern Lisp_Object Qdelete_file
;
3487 /* Defined in search.c. */
3488 extern void shrink_regexp_cache (void);
3489 extern void restore_search_regs (void);
3490 extern void record_unwind_save_match_data (void);
3491 struct re_registers
;
3492 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3493 struct re_registers
*,
3494 Lisp_Object
, bool, bool);
3495 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3496 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3498 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3499 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3500 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3501 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3502 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3503 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3505 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3506 ptrdiff_t, ptrdiff_t *);
3507 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3508 ptrdiff_t, ptrdiff_t *);
3509 extern void syms_of_search (void);
3510 extern void clear_regexp_cache (void);
3512 /* Defined in minibuf.c. */
3514 extern Lisp_Object Qcompletion_ignore_case
;
3515 extern Lisp_Object Vminibuffer_list
;
3516 extern Lisp_Object last_minibuf_string
;
3517 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3518 extern void init_minibuf_once (void);
3519 extern void syms_of_minibuf (void);
3521 /* Defined in callint.c. */
3523 extern Lisp_Object Qminus
, Qplus
;
3524 extern Lisp_Object Qprogn
;
3525 extern Lisp_Object Qwhen
;
3526 extern Lisp_Object Qmouse_leave_buffer_hook
;
3527 extern void syms_of_callint (void);
3529 /* Defined in casefiddle.c. */
3531 extern Lisp_Object Qidentity
;
3532 extern void syms_of_casefiddle (void);
3533 extern void keys_of_casefiddle (void);
3535 /* Defined in casetab.c. */
3537 extern void init_casetab_once (void);
3538 extern void syms_of_casetab (void);
3540 /* Defined in keyboard.c. */
3542 extern Lisp_Object echo_message_buffer
;
3543 extern struct kboard
*echo_kboard
;
3544 extern void cancel_echoing (void);
3545 extern Lisp_Object Qdisabled
, QCfilter
;
3546 extern Lisp_Object Qup
, Qdown
;
3547 extern Lisp_Object last_undo_boundary
;
3548 extern bool input_pending
;
3549 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3550 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3551 extern void discard_mouse_events (void);
3553 void handle_input_available_signal (int);
3555 extern Lisp_Object pending_funcalls
;
3556 extern bool detect_input_pending (void);
3557 extern bool detect_input_pending_ignore_squeezables (void);
3558 extern bool detect_input_pending_run_timers (bool);
3559 extern void safe_run_hooks (Lisp_Object
);
3560 extern void cmd_error_internal (Lisp_Object
, const char *);
3561 extern Lisp_Object
command_loop_1 (void);
3562 extern Lisp_Object
read_menu_command (void);
3563 extern Lisp_Object
recursive_edit_1 (void);
3564 extern void record_auto_save (void);
3565 extern void force_auto_save_soon (void);
3566 extern void init_keyboard (void);
3567 extern void syms_of_keyboard (void);
3568 extern void keys_of_keyboard (void);
3570 /* Defined in indent.c. */
3571 extern ptrdiff_t current_column (void);
3572 extern void invalidate_current_column (void);
3573 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3574 extern void syms_of_indent (void);
3576 /* Defined in frame.c. */
3577 extern Lisp_Object Qonly
, Qnone
;
3578 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3579 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3580 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3581 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3582 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3583 extern void frames_discard_buffer (Lisp_Object
);
3584 extern void syms_of_frame (void);
3586 /* Defined in emacs.c. */
3587 extern char **initial_argv
;
3588 extern int initial_argc
;
3589 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3590 extern bool display_arg
;
3592 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3593 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3594 extern Lisp_Object Qfile_name_handler_alist
;
3595 extern _Noreturn
void terminate_due_to_signal (int, int);
3596 extern Lisp_Object Qkill_emacs
;
3598 extern Lisp_Object Vlibrary_cache
;
3601 void fixup_locale (void);
3602 void synchronize_system_messages_locale (void);
3603 void synchronize_system_time_locale (void);
3605 INLINE
void fixup_locale (void) {}
3606 INLINE
void synchronize_system_messages_locale (void) {}
3607 INLINE
void synchronize_system_time_locale (void) {}
3609 extern void shut_down_emacs (int, Lisp_Object
);
3611 /* True means don't do interactive redisplay and don't change tty modes. */
3612 extern bool noninteractive
;
3614 /* True means remove site-lisp directories from load-path. */
3615 extern bool no_site_lisp
;
3617 /* Pipe used to send exit notification to the daemon parent at
3619 extern int daemon_pipe
[2];
3620 #define IS_DAEMON (daemon_pipe[1] != 0)
3622 /* True if handling a fatal error already. */
3623 extern bool fatal_error_in_progress
;
3625 /* True means don't do use window-system-specific display code. */
3626 extern bool inhibit_window_system
;
3627 /* True means that a filter or a sentinel is running. */
3628 extern bool running_asynch_code
;
3630 /* Defined in process.c. */
3631 extern Lisp_Object QCtype
, Qlocal
;
3632 extern void kill_buffer_processes (Lisp_Object
);
3633 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3634 struct Lisp_Process
*, int);
3635 /* Max value for the first argument of wait_reading_process_output. */
3636 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3637 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3638 The bug merely causes a bogus warning, but the warning is annoying. */
3639 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3641 # define WAIT_READING_MAX INTMAX_MAX
3643 extern void add_keyboard_wait_descriptor (int);
3644 extern void delete_keyboard_wait_descriptor (int);
3646 extern void add_gpm_wait_descriptor (int);
3647 extern void delete_gpm_wait_descriptor (int);
3649 extern void init_process_emacs (void);
3650 extern void syms_of_process (void);
3651 extern void setup_process_coding_systems (Lisp_Object
);
3653 /* Defined in callproc.c. */
3657 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3658 extern void init_callproc_1 (void);
3659 extern void init_callproc (void);
3660 extern void set_initial_environment (void);
3661 extern void syms_of_callproc (void);
3663 /* Defined in doc.c. */
3664 extern Lisp_Object Qfunction_documentation
;
3665 extern Lisp_Object
read_doc_string (Lisp_Object
);
3666 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3667 extern void syms_of_doc (void);
3668 extern int read_bytecode_char (bool);
3670 /* Defined in bytecode.c. */
3671 extern void syms_of_bytecode (void);
3672 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3673 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3675 /* Defined in macros.c. */
3676 extern void init_macros (void);
3677 extern void syms_of_macros (void);
3679 /* Defined in undo.c. */
3680 extern Lisp_Object Qapply
;
3681 extern Lisp_Object Qinhibit_read_only
;
3682 extern void truncate_undo_list (struct buffer
*);
3683 extern void record_insert (ptrdiff_t, ptrdiff_t);
3684 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3685 extern void record_first_change (void);
3686 extern void record_change (ptrdiff_t, ptrdiff_t);
3687 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3688 Lisp_Object
, Lisp_Object
,
3690 extern void syms_of_undo (void);
3691 /* Defined in textprop.c. */
3692 extern Lisp_Object Qmouse_face
;
3693 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3694 extern Lisp_Object Qminibuffer_prompt
;
3696 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3698 /* Defined in menu.c. */
3699 extern void syms_of_menu (void);
3701 /* Defined in xmenu.c. */
3702 extern void syms_of_xmenu (void);
3704 /* Defined in termchar.h. */
3705 struct tty_display_info
;
3707 /* Defined in termhooks.h. */
3710 /* Defined in sysdep.c. */
3711 #ifndef HAVE_GET_CURRENT_DIR_NAME
3712 extern char *get_current_dir_name (void);
3714 extern void stuff_char (char c
);
3715 extern void init_foreground_group (void);
3716 extern void sys_subshell (void);
3717 extern void sys_suspend (void);
3718 extern void discard_tty_input (void);
3719 extern void init_sys_modes (struct tty_display_info
*);
3720 extern void reset_sys_modes (struct tty_display_info
*);
3721 extern void init_all_sys_modes (void);
3722 extern void reset_all_sys_modes (void);
3723 extern void child_setup_tty (int);
3724 extern void setup_pty (int);
3725 extern int set_window_size (int, int, int);
3726 extern EMACS_INT
get_random (void);
3727 extern void seed_random (void *, ptrdiff_t);
3728 extern void init_random (void);
3729 extern void emacs_backtrace (int);
3730 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3731 extern int emacs_open (const char *, int, int);
3732 extern int emacs_pipe (int[2]);
3733 extern int emacs_close (int);
3734 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3735 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3736 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3737 extern void emacs_perror (char const *);
3739 extern void unlock_all_files (void);
3740 extern void lock_file (Lisp_Object
);
3741 extern void unlock_file (Lisp_Object
);
3742 extern void unlock_buffer (struct buffer
*);
3743 extern void syms_of_filelock (void);
3745 /* Defined in sound.c. */
3746 extern void syms_of_sound (void);
3748 /* Defined in category.c. */
3749 extern void init_category_once (void);
3750 extern Lisp_Object
char_category_set (int);
3751 extern void syms_of_category (void);
3753 /* Defined in ccl.c. */
3754 extern void syms_of_ccl (void);
3756 /* Defined in dired.c. */
3757 extern void syms_of_dired (void);
3758 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3759 Lisp_Object
, Lisp_Object
,
3762 /* Defined in term.c. */
3763 extern int *char_ins_del_vector
;
3764 extern void syms_of_term (void);
3765 extern _Noreturn
void fatal (const char *msgid
, ...)
3766 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3768 /* Defined in terminal.c. */
3769 extern void syms_of_terminal (void);
3771 /* Defined in font.c. */
3772 extern void syms_of_font (void);
3773 extern void init_font (void);
3775 #ifdef HAVE_WINDOW_SYSTEM
3776 /* Defined in fontset.c. */
3777 extern void syms_of_fontset (void);
3779 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3780 extern Lisp_Object Qfont_param
;
3783 /* Defined in gfilenotify.c */
3784 #ifdef HAVE_GFILENOTIFY
3785 extern void globals_of_gfilenotify (void);
3786 extern void syms_of_gfilenotify (void);
3789 /* Defined in inotify.c */
3791 extern void syms_of_inotify (void);
3794 #ifdef HAVE_W32NOTIFY
3795 /* Defined on w32notify.c. */
3796 extern void syms_of_w32notify (void);
3799 /* Defined in xfaces.c. */
3800 extern Lisp_Object Qdefault
, Qfringe
;
3801 extern Lisp_Object Qscroll_bar
, Qcursor
;
3802 extern Lisp_Object Qmode_line_inactive
;
3803 extern Lisp_Object Qface
;
3804 extern Lisp_Object Qnormal
;
3805 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3806 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3807 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3808 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3809 extern Lisp_Object Qoblique
, Qitalic
;
3810 extern Lisp_Object Vface_alternative_font_family_alist
;
3811 extern Lisp_Object Vface_alternative_font_registry_alist
;
3812 extern void syms_of_xfaces (void);
3814 #ifdef HAVE_X_WINDOWS
3815 /* Defined in xfns.c. */
3816 extern void syms_of_xfns (void);
3818 /* Defined in xsmfns.c. */
3819 extern void syms_of_xsmfns (void);
3821 /* Defined in xselect.c. */
3822 extern void syms_of_xselect (void);
3824 /* Defined in xterm.c. */
3825 extern void syms_of_xterm (void);
3826 #endif /* HAVE_X_WINDOWS */
3828 #ifdef HAVE_WINDOW_SYSTEM
3829 /* Defined in xterm.c, nsterm.m, w32term.c. */
3830 extern char *x_get_keysym_name (int);
3831 #endif /* HAVE_WINDOW_SYSTEM */
3834 /* Defined in xml.c. */
3835 extern void syms_of_xml (void);
3836 extern void xml_cleanup_parser (void);
3840 /* Defined in decompress.c. */
3841 extern void syms_of_decompress (void);
3845 /* Defined in dbusbind.c. */
3846 void syms_of_dbusbind (void);
3850 /* Defined in profiler.c. */
3851 extern bool profiler_memory_running
;
3852 extern void malloc_probe (size_t);
3853 extern void syms_of_profiler (void);
3857 /* Defined in msdos.c, w32.c. */
3858 extern char *emacs_root_dir (void);
3861 /* True means ^G can quit instantly. */
3862 extern bool immediate_quit
;
3864 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3865 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3866 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3867 extern void xfree (void *);
3868 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3869 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3870 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3871 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3872 ATTRIBUTE_ALLOC_SIZE ((2,3));
3873 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3874 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3875 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3876 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3877 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3879 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3880 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3881 extern void dupstring (char **, char const *);
3882 extern void xputenv (const char *);
3884 extern char *egetenv (const char *);
3886 /* Copy Lisp string to temporary (allocated on stack) C string. */
3888 #define xlispstrdupa(string) \
3889 memcpy (alloca (SBYTES (string) + 1), \
3890 SSDATA (string), SBYTES (string) + 1)
3892 /* Set up the name of the machine we're running on. */
3893 extern void init_system_name (void);
3895 /* Return the absolute value of X. X should be a signed integer
3896 expression without side effects, and X's absolute value should not
3897 exceed the maximum for its promoted type. This is called 'eabs'
3898 because 'abs' is reserved by the C standard. */
3899 #define eabs(x) ((x) < 0 ? -(x) : (x))
3901 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3904 #define make_fixnum_or_float(val) \
3905 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3907 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3908 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3910 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3912 #define USE_SAFE_ALLOCA ((void) 0)
3914 /* SAFE_ALLOCA allocates a simple buffer. */
3916 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3920 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3921 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3922 positive. The code is tuned for MULTIPLIER being a constant. */
3924 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3926 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3927 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3929 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3932 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3934 #define SAFE_FREE() ((void) 0)
3936 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3938 #define SAFE_ALLOCA_LISP(buf, nelt) \
3940 if ((nelt) < MAX_ALLOCA / word_size) \
3941 (buf) = alloca ((nelt) * word_size); \
3942 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3943 buf = xmalloc ((nelt) * word_size); \
3945 memory_full (SIZE_MAX); \
3948 /* Loop over all tails of a list, checking for cycles.
3949 FIXME: Make tortoise and n internal declarations.
3950 FIXME: Unroll the loop body so we don't need `n'. */
3951 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3952 for ((tortoise) = (hare) = (list), (n) = true; \
3954 (hare = XCDR (hare), (n) = !(n), \
3956 ? (EQ (hare, tortoise) \
3957 ? xsignal1 (Qcircular_list, list) \
3959 /* Move tortoise before the next iteration, in case */ \
3960 /* the next iteration does an Fsetcdr. */ \
3961 : (void) ((tortoise) = XCDR (tortoise)))))
3963 /* Do a `for' loop over alist values. */
3965 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3966 for ((list_var) = (head_var); \
3967 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
3968 (list_var) = XCDR (list_var))
3970 /* Check whether it's time for GC, and run it if so. */
3979 functionp (Lisp_Object object
)
3981 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3983 object
= Findirect_function (object
, Qt
);
3985 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3987 /* Autoloaded symbols are functions, except if they load
3988 macros or keymaps. */
3990 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3991 object
= XCDR (object
);
3993 return ! (CONSP (object
) && !NILP (XCAR (object
)));
3997 if (scm_is_true (scm_procedure_p (object
)))
3999 else if (COMPILEDP (object
))
4001 else if (CONSP (object
))
4003 Lisp_Object car
= XCAR (object
);
4004 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4009 XSYMBOL (Lisp_Object a
)
4011 return scm_call_1 (scm_c_public_ref ("language elisp runtime", "symbol-desc"),
4016 #endif /* EMACS_LISP_H */