1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
102 typedef scm_t_signed_bits EMACS_INT
;
103 typedef scm_t_bits EMACS_UINT
;
104 #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX
106 #if INTPTR_MAX == INT_MAX
108 #elif INTPTR_MAX == LONG_MAX
110 #elif INTPTR_MAX == LLONG_MAX
112 #elif INTPTR_MAX == INTMAX_MAX
115 #error "Cannot determine length modifier for EMACS_INT"
118 /* Number of bits to put in each character in the internal representation
119 of bool vectors. This should not vary across implementations. */
120 enum { BOOL_VECTOR_BITS_PER_CHAR
=
121 #define BOOL_VECTOR_BITS_PER_CHAR 8
122 BOOL_VECTOR_BITS_PER_CHAR
125 /* An unsigned integer type representing a fixed-length bit sequence,
126 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
127 for speed, but it is unsigned char on weird platforms. */
128 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
129 typedef size_t bits_word
;
130 # define BITS_WORD_MAX SIZE_MAX
131 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
133 typedef unsigned char bits_word
;
134 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
135 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
137 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
139 /* Number of bits in some machine integer types. */
142 BITS_PER_CHAR
= CHAR_BIT
,
143 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
144 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
145 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
148 /* printmax_t and uprintmax_t are types for printing large integers.
149 These are the widest integers that are supported for printing.
150 pMd etc. are conversions for printing them.
151 On C99 hosts, there's no problem, as even the widest integers work.
152 Fall back on EMACS_INT on pre-C99 hosts. */
154 typedef intmax_t printmax_t
;
155 typedef uintmax_t uprintmax_t
;
159 typedef EMACS_INT printmax_t
;
160 typedef EMACS_UINT uprintmax_t
;
165 /* Use pD to format ptrdiff_t values, which suffice for indexes into
166 buffers and strings. Emacs never allocates objects larger than
167 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
168 In C99, pD can always be "t"; configure it here for the sake of
169 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
170 #if PTRDIFF_MAX == INT_MAX
172 #elif PTRDIFF_MAX == LONG_MAX
174 #elif PTRDIFF_MAX == LLONG_MAX
180 /* Extra internal type checking? */
182 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
183 'assume (COND)'. COND should be free of side effects, as it may or
184 may not be evaluated.
186 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
187 defined and suppress_checking is false, and does nothing otherwise.
188 Emacs dies if COND is checked and is false. The suppress_checking
189 variable is initialized to 0 in alloc.c. Set it to 1 using a
190 debugger to temporarily disable aborting on detected internal
191 inconsistencies or error conditions.
193 In some cases, a good compiler may be able to optimize away the
194 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
195 uses eassert to test STRINGP (x), but a particular use of XSTRING
196 is invoked only after testing that STRINGP (x) is true, making the
199 eassume is like eassert except that it also causes the compiler to
200 assume that COND is true afterwards, regardless of whether runtime
201 checking is enabled. This can improve performance in some cases,
202 though it can degrade performance in others. It's often suboptimal
203 for COND to call external functions or access volatile storage. */
205 #ifndef ENABLE_CHECKING
206 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
207 # define eassume(cond) assume (cond)
208 #else /* ENABLE_CHECKING */
210 extern _Noreturn
void die (const char *, const char *, int);
212 extern bool suppress_checking EXTERNALLY_VISIBLE
;
214 # define eassert(cond) \
215 (suppress_checking || (cond) \
217 : die (# cond, __FILE__, __LINE__))
218 # define eassume(cond) \
223 : die (# cond, __FILE__, __LINE__))
224 #endif /* ENABLE_CHECKING */
229 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
230 integer constant, for MSVC. */
231 #define GCALIGNMENT 8
233 /* Number of bits in a Lisp fixnum value, not counting the tag. */
234 FIXNUM_BITS
= SCM_I_FIXNUM_BIT
237 #if GCALIGNMENT != 1 << GCTYPEBITS
238 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
241 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
242 #define USE_LSB_TAG 1
243 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
246 # define alignas(alignment) /* empty */
248 # error "USE_LSB_TAG requires alignas"
252 /* Some operations are so commonly executed that they are implemented
253 as macros, not functions, because otherwise runtime performance would
254 suffer too much when compiling with GCC without optimization.
255 There's no need to inline everything, just the operations that
256 would otherwise cause a serious performance problem.
258 For each such operation OP, define a macro lisp_h_OP that contains
259 the operation's implementation. That way, OP can be implemented
260 via a macro definition like this:
262 #define OP(x) lisp_h_OP (x)
264 and/or via a function definition like this:
266 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
268 which macro-expands to this:
270 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
272 without worrying about the implementations diverging, since
273 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
274 are intended to be private to this include file, and should not be
277 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
278 functions, once most developers have access to GCC 4.8 or later and
279 can use "gcc -Og" to debug. Maybe in the year 2016. See
282 Commentary for these macros can be found near their corresponding
285 #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a))
286 #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x))
287 #define lisp_h_XLI(o) (SCM_UNPACK (o))
288 #define lisp_h_XIL(i) (SCM_PACK (i))
289 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
290 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
291 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
292 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
293 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
294 #define lisp_h_CONSP(x) (x && scm_is_pair (x))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (x && SCM_INEXACTP (x))
297 #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x))
298 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
299 #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag))
300 #define lisp_h_NILP(x) EQ (x, Qnil)
301 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
302 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
303 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
304 #define lisp_h_SYMBOL_VAL(sym) \
305 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
306 #define lisp_h_SYMBOLP(x) (x && scm_is_symbol (x))
307 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
308 #define lisp_h_XCAR(c) (scm_car (c))
309 #define lisp_h_XCDR(c) (scm_cdr (c))
310 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
312 /* Define NAME as a lisp.h inline function that returns TYPE and has
313 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
314 ARGS should be parenthesized. Implement the function by calling
316 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
317 INLINE type (name) argdecls { return lisp_h_##name args; }
319 /* like LISP_MACRO_DEFUN, except NAME returns void. */
320 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
321 INLINE void (name) argdecls { lisp_h_##name args; }
324 /* Define the fundamental Lisp data structures. */
326 /* This is the set of Lisp data types. If you want to define a new
327 data type, read the comments after Lisp_Fwd_Type definition
330 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
331 #define case_Lisp_Int case Lisp_Int
333 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
334 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
335 vociferously about them. */
336 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
337 || (defined __SUNPRO_C && __STDC__))
338 #define ENUM_BF(TYPE) unsigned int
340 #define ENUM_BF(TYPE) enum TYPE
343 scm_t_bits lisp_misc_tag
;
344 scm_t_bits lisp_string_tag
;
345 scm_t_bits lisp_vectorlike_tag
;
351 /* Integer. XINT (obj) is the integer value. */
354 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
357 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
358 whose first member indicates the subtype. */
361 /* String. XSTRING (object) points to a struct Lisp_String.
362 The length of the string, and its contents, are stored therein. */
365 /* Vector of Lisp objects, or something resembling it.
366 XVECTOR (object) points to a struct Lisp_Vector, which contains
367 the size and contents. The size field also contains the type
368 information, if it's not a real vector object. */
371 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
377 /* This is the set of data types that share a common structure.
378 The first member of the structure is a type code from this set.
379 The enum values are arbitrary, but we'll use large numbers to make it
380 more likely that we'll spot the error if a random word in memory is
381 mistakenly interpreted as a Lisp_Misc. */
384 Lisp_Misc_Free
= 0x5eab,
387 Lisp_Misc_Save_Value
,
388 /* Currently floats are not a misc type,
389 but let's define this in case we want to change that. */
391 /* This is not a type code. It is for range checking. */
395 /* These are the types of forwarding objects used in the value slot
396 of symbols for special built-in variables whose value is stored in
400 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
401 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
402 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
403 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
404 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
407 typedef SCM Lisp_Object
;
409 #define LISP_INITIALLY_ZERO SCM_INUM0
411 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
412 At the machine level, these operations are no-ops. */
413 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
414 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
416 /* In the size word of a struct Lisp_Vector, this bit means it's really
417 some other vector-like object. */
418 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
419 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
420 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
422 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
423 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
424 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
427 /* In a pseudovector, the size field actually contains a word with one
428 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
429 with PVEC_TYPE_MASK to indicate the actual type. */
441 PVEC_WINDOW_CONFIGURATION
,
444 /* These should be last, check internal_equal to see why. */
448 PVEC_FONT
/* Should be last because it's used for range checking. */
453 /* For convenience, we also store the number of elements in these bits.
454 Note that this size is not necessarily the memory-footprint size, but
455 only the number of Lisp_Object fields (that need to be traced by GC).
456 The distinction is used, e.g., by Lisp_Process, which places extra
457 non-Lisp_Object fields at the end of the structure. */
458 PSEUDOVECTOR_SIZE_BITS
= 12,
459 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
461 /* To calculate the memory footprint of the pseudovector, it's useful
462 to store the size of non-Lisp area in word_size units here. */
463 PSEUDOVECTOR_REST_BITS
= 12,
464 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
465 << PSEUDOVECTOR_SIZE_BITS
),
467 /* Used to extract pseudovector subtype information. */
468 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
469 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
472 /* These functions extract various sorts of values from a Lisp_Object.
473 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
474 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
477 /* Largest and smallest representable fixnum values. These are the C
478 values. They are macros for use in static initializers. */
479 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
480 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
482 /* Make a Lisp integer representing the value of the low order
485 make_number (EMACS_INT n
)
487 return SCM_I_MAKINUM (n
);
490 /* Extract A's value as a signed integer. */
494 return SCM_I_INUM (a
);
497 /* Like XINT (A), but may be faster. A must be nonnegative.
498 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
499 integers have zero-bits in their tags. */
501 XFASTINT (Lisp_Object a
)
503 EMACS_INT n
= XINT (a
);
508 /* Extract A's value as an unsigned integer. */
510 XUINT (Lisp_Object a
)
512 return SCM_I_INUM (a
);
515 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
516 right now, but XUINT should only be applied to objects we know are
518 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
520 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
522 make_natnum (EMACS_INT n
)
524 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
525 return make_number (n
);
528 /* Return true if X and Y are the same object. */
529 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
531 /* Value is true if I doesn't fit into a Lisp fixnum. It is
532 written this way so that it also works if I is of unsigned
533 type or if I is a NaN. */
535 #define FIXNUM_OVERFLOW_P(i) \
536 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
539 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
541 return num
< lower
? lower
: num
<= upper
? num
: upper
;
544 /* Forward declarations. */
546 /* Defined in this file. */
548 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
549 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
550 INLINE
bool BUFFERP (Lisp_Object
);
551 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
552 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
553 INLINE
bool (CONSP
) (Lisp_Object
);
554 INLINE
bool (FLOATP
) (Lisp_Object
);
555 INLINE
bool functionp (Lisp_Object
);
556 INLINE
bool (INTEGERP
) (Lisp_Object
);
557 INLINE
bool (MARKERP
) (Lisp_Object
);
558 INLINE
bool (MISCP
) (Lisp_Object
);
559 INLINE
bool (NILP
) (Lisp_Object
);
560 INLINE
bool OVERLAYP (Lisp_Object
);
561 INLINE
bool PROCESSP (Lisp_Object
);
562 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
563 INLINE
bool SAVE_VALUEP (Lisp_Object
);
564 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
566 INLINE
bool STRINGP (Lisp_Object
);
567 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
568 INLINE
bool SUBRP (Lisp_Object
);
569 INLINE
bool (SYMBOLP
) (Lisp_Object
);
570 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
571 INLINE
bool WINDOWP (Lisp_Object
);
572 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
574 /* Defined in chartab.c. */
575 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
576 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
577 extern int char_table_translate (Lisp_Object
, int);
579 /* Defined in data.c. */
580 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
581 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
582 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
583 extern Lisp_Object Qbool_vector_p
;
584 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
585 extern Lisp_Object Qwindow
;
586 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
588 /* Defined in emacs.c. */
589 extern bool might_dump
;
590 /* True means Emacs has already been initialized.
591 Used during startup to detect startup of dumped Emacs. */
592 extern bool initialized
;
594 /* Defined in eval.c. */
595 extern Lisp_Object Qautoload
;
597 /* Defined in floatfns.c. */
598 extern double extract_float (Lisp_Object
);
600 /* Defined in process.c. */
601 extern Lisp_Object Qprocessp
;
603 /* Defined in window.c. */
604 extern Lisp_Object Qwindowp
;
606 /* Defined in xdisp.c. */
607 extern Lisp_Object Qimage
;
609 /* Extract A's type. */
610 INLINE
enum Lisp_Type
611 XTYPE (Lisp_Object o
)
615 else if (SYMBOLP (o
))
619 else if (STRINGP (o
))
621 else if (VECTORLIKEP (o
))
622 return Lisp_Vectorlike
;
631 /* Extract a value or address from a Lisp_Object. */
633 INLINE
struct Lisp_Vector
*
634 XVECTOR (Lisp_Object a
)
636 eassert (VECTORLIKEP (a
));
640 INLINE
struct Lisp_String
*
641 XSTRING (Lisp_Object a
)
643 eassert (STRINGP (a
));
647 extern void initialize_symbol (Lisp_Object
, Lisp_Object
);
648 INLINE Lisp_Object
build_string (const char *);
649 extern Lisp_Object symbol_module
;
650 extern Lisp_Object function_module
;
651 extern Lisp_Object plist_module
;
653 INLINE
struct Lisp_Symbol
*
654 XSYMBOL (Lisp_Object a
)
657 eassert (SYMBOLP (a
));
658 tem
= scm_variable_ref (scm_module_lookup (symbol_module
, a
));
659 return scm_to_pointer (tem
);
662 /* Pseudovector types. */
664 INLINE
struct Lisp_Process
*
665 XPROCESS (Lisp_Object a
)
667 eassert (PROCESSP (a
));
671 INLINE
struct window
*
672 XWINDOW (Lisp_Object a
)
674 eassert (WINDOWP (a
));
678 INLINE
struct terminal
*
679 XTERMINAL (Lisp_Object a
)
684 INLINE
struct Lisp_Subr
*
685 XSUBR (Lisp_Object a
)
691 INLINE
struct buffer
*
692 XBUFFER (Lisp_Object a
)
694 eassert (BUFFERP (a
));
698 INLINE
struct Lisp_Char_Table
*
699 XCHAR_TABLE (Lisp_Object a
)
701 eassert (CHAR_TABLE_P (a
));
705 INLINE
struct Lisp_Sub_Char_Table
*
706 XSUB_CHAR_TABLE (Lisp_Object a
)
708 eassert (SUB_CHAR_TABLE_P (a
));
712 INLINE
struct Lisp_Bool_Vector
*
713 XBOOL_VECTOR (Lisp_Object a
)
715 eassert (BOOL_VECTOR_P (a
));
720 make_lisp_proc (struct Lisp_Process
*p
)
722 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
725 #define XSETINT(a, b) ((a) = make_number (b))
726 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
727 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
728 #define XSETSTRING(a, b) ((a) = (b)->self)
729 #define XSETSYMBOL(a, b) ((a) = (b)->self)
730 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
732 /* Pseudovector types. */
734 #define XSETPVECTYPE(v, code) \
735 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
736 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
737 ((v)->header.size = (PSEUDOVECTOR_FLAG \
738 | ((code) << PSEUDOVECTOR_AREA_BITS) \
739 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
742 /* The cast to struct vectorlike_header * avoids aliasing issues. */
743 #define XSETPSEUDOVECTOR(a, b, code) \
744 XSETTYPED_PSEUDOVECTOR (a, b, \
745 (((struct vectorlike_header *) \
749 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
750 (XSETVECTOR (a, b), \
751 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
752 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
754 #define XSETWINDOW_CONFIGURATION(a, b) \
755 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
756 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
757 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
758 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
759 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
760 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
761 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
762 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
763 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
764 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
768 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
769 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
772 /* Deprecated and will be removed soon. */
774 #define INTERNAL_FIELD(field) field ## _
776 /* See the macros in intervals.h. */
778 typedef struct interval
*INTERVAL
;
780 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
781 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
783 /* Use these to set the fields of a cons cell.
785 Note that both arguments may refer to the same object, so 'n'
786 should not be read after 'c' is first modified. */
788 XSETCAR (Lisp_Object c
, Lisp_Object n
)
790 scm_set_car_x (c
, n
);
793 XSETCDR (Lisp_Object c
, Lisp_Object n
)
795 scm_set_cdr_x (c
, n
);
798 /* Take the car or cdr of something whose type is not known. */
802 return (CONSP (c
) ? XCAR (c
)
804 : wrong_type_argument (Qlistp
, c
));
809 return (CONSP (c
) ? XCDR (c
)
811 : wrong_type_argument (Qlistp
, c
));
814 /* Take the car or cdr of something whose type is not known. */
816 CAR_SAFE (Lisp_Object c
)
818 return CONSP (c
) ? XCAR (c
) : Qnil
;
821 CDR_SAFE (Lisp_Object c
)
823 return CONSP (c
) ? XCDR (c
) : Qnil
;
826 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
833 INTERVAL intervals
; /* Text properties in this string. */
837 /* True if STR is a multibyte string. */
839 STRING_MULTIBYTE (Lisp_Object str
)
841 return 0 <= XSTRING (str
)->size_byte
;
844 /* An upper bound on the number of bytes in a Lisp string, not
845 counting the terminating null. This a tight enough bound to
846 prevent integer overflow errors that would otherwise occur during
847 string size calculations. A string cannot contain more bytes than
848 a fixnum can represent, nor can it be so long that C pointer
849 arithmetic stops working on the string plus its terminating null.
850 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
851 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
852 would expose alloc.c internal details that we'd rather keep
855 This is a macro for use in static initializers. The cast to
856 ptrdiff_t ensures that the macro is signed. */
857 #define STRING_BYTES_BOUND \
858 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
860 /* Mark STR as a unibyte string. */
861 #define STRING_SET_UNIBYTE(STR) \
863 if (EQ (STR, empty_multibyte_string)) \
864 (STR) = empty_unibyte_string; \
866 XSTRING (STR)->size_byte = -1; \
869 /* Mark STR as a multibyte string. Assure that STR contains only
870 ASCII characters in advance. */
871 #define STRING_SET_MULTIBYTE(STR) \
873 if (EQ (STR, empty_unibyte_string)) \
874 (STR) = empty_multibyte_string; \
876 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
879 /* Convenience functions for dealing with Lisp strings. */
881 INLINE
unsigned char *
882 SDATA (Lisp_Object string
)
884 return XSTRING (string
)->data
;
887 SSDATA (Lisp_Object string
)
889 /* Avoid "differ in sign" warnings. */
890 return (char *) SDATA (string
);
893 SREF (Lisp_Object string
, ptrdiff_t index
)
895 return SDATA (string
)[index
];
898 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
900 SDATA (string
)[index
] = new;
903 SCHARS (Lisp_Object string
)
905 return XSTRING (string
)->size
;
909 STRING_BYTES (struct Lisp_String
*s
)
911 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
915 SBYTES (Lisp_Object string
)
917 return STRING_BYTES (XSTRING (string
));
920 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
922 XSTRING (string
)->size
= newsize
;
925 /* Header of vector-like objects. This documents the layout constraints on
926 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
927 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
928 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
929 because when two such pointers potentially alias, a compiler won't
930 incorrectly reorder loads and stores to their size fields. See
932 struct vectorlike_header
936 /* This field contains various pieces of information:
937 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
938 vector (0) or a pseudovector (1).
939 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
940 of slots) of the vector.
941 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
942 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
943 - b) number of Lisp_Objects slots at the beginning of the object
944 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
946 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
947 measured in word_size units. Rest fields may also include
948 Lisp_Objects, but these objects usually needs some special treatment
950 There are some exceptions. For PVEC_FREE, b) is always zero. For
951 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
952 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
953 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
957 /* A regular vector is just a header plus an array of Lisp_Objects. */
961 struct vectorlike_header header
;
962 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
965 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
968 ALIGNOF_STRUCT_LISP_VECTOR
969 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
972 /* A boolvector is a kind of vectorlike, with contents like a string. */
974 struct Lisp_Bool_Vector
976 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
977 just the subtype information. */
978 struct vectorlike_header header
;
979 /* This is the size in bits. */
981 /* The actual bits, packed into bytes.
982 Zeros fill out the last word if needed.
983 The bits are in little-endian order in the bytes, and
984 the bytes are in little-endian order in the words. */
985 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
989 bool_vector_size (Lisp_Object a
)
991 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
997 bool_vector_data (Lisp_Object a
)
999 return XBOOL_VECTOR (a
)->data
;
1002 INLINE
unsigned char *
1003 bool_vector_uchar_data (Lisp_Object a
)
1005 return (unsigned char *) bool_vector_data (a
);
1008 /* The number of data words and bytes in a bool vector with SIZE bits. */
1011 bool_vector_words (EMACS_INT size
)
1013 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1014 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1018 bool_vector_bytes (EMACS_INT size
)
1020 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1021 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1024 /* True if A's Ith bit is set. */
1027 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1029 eassume (0 <= i
&& i
< bool_vector_size (a
));
1030 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1031 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1035 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1037 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1040 /* Set A's Ith bit to B. */
1043 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1045 unsigned char *addr
;
1047 eassume (0 <= i
&& i
< bool_vector_size (a
));
1048 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1051 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1053 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1056 /* Some handy constants for calculating sizes
1057 and offsets, mostly of vectorlike objects. */
1061 header_size
= offsetof (struct Lisp_Vector
, contents
),
1062 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1063 word_size
= sizeof (Lisp_Object
)
1066 /* Conveniences for dealing with Lisp arrays. */
1069 AREF (Lisp_Object array
, ptrdiff_t idx
)
1071 return XVECTOR (array
)->contents
[idx
];
1074 INLINE Lisp_Object
*
1075 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1077 return & XVECTOR (array
)->contents
[idx
];
1081 ASIZE (Lisp_Object array
)
1083 return XVECTOR (array
)->header
.size
;
1087 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1089 eassert (0 <= idx
&& idx
< ASIZE (array
));
1090 XVECTOR (array
)->contents
[idx
] = val
;
1094 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1096 /* Like ASET, but also can be used in the garbage collector:
1097 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1098 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1099 XVECTOR (array
)->contents
[idx
] = val
;
1102 /* If a struct is made to look like a vector, this macro returns the length
1103 of the shortest vector that would hold that struct. */
1105 #define VECSIZE(type) \
1106 ((sizeof (type) - header_size + word_size - 1) / word_size)
1108 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1109 at the end and we need to compute the number of Lisp_Object fields (the
1110 ones that the GC needs to trace). */
1112 #define PSEUDOVECSIZE(type, nonlispfield) \
1113 ((offsetof (type, nonlispfield) - header_size) / word_size)
1115 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1116 should be integer expressions. This is not the same as
1117 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1118 returns true. For efficiency, prefer plain unsigned comparison if A
1119 and B's sizes both fit (after integer promotion). */
1120 #define UNSIGNED_CMP(a, op, b) \
1121 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1122 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1123 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1125 /* True iff C is an ASCII character. */
1126 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1128 /* A char-table is a kind of vectorlike, with contents are like a
1129 vector but with a few other slots. For some purposes, it makes
1130 sense to handle a char-table with type struct Lisp_Vector. An
1131 element of a char table can be any Lisp objects, but if it is a sub
1132 char-table, we treat it a table that contains information of a
1133 specific range of characters. A sub char-table has the same
1134 structure as a vector. A sub char table appears only in an element
1135 of a char-table, and there's no way to access it directly from
1136 Emacs Lisp program. */
1138 enum CHARTAB_SIZE_BITS
1140 CHARTAB_SIZE_BITS_0
= 6,
1141 CHARTAB_SIZE_BITS_1
= 4,
1142 CHARTAB_SIZE_BITS_2
= 5,
1143 CHARTAB_SIZE_BITS_3
= 7
1146 extern const int chartab_size
[4];
1148 struct Lisp_Char_Table
1150 /* HEADER.SIZE is the vector's size field, which also holds the
1151 pseudovector type information. It holds the size, too.
1152 The size counts the defalt, parent, purpose, ascii,
1153 contents, and extras slots. */
1154 struct vectorlike_header header
;
1156 /* This holds a default value,
1157 which is used whenever the value for a specific character is nil. */
1160 /* This points to another char table, which we inherit from when the
1161 value for a specific character is nil. The `defalt' slot takes
1162 precedence over this. */
1165 /* This is a symbol which says what kind of use this char-table is
1167 Lisp_Object purpose
;
1169 /* The bottom sub char-table for characters of the range 0..127. It
1170 is nil if none of ASCII character has a specific value. */
1173 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1175 /* These hold additional data. It is a vector. */
1176 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1179 struct Lisp_Sub_Char_Table
1181 /* HEADER.SIZE is the vector's size field, which also holds the
1182 pseudovector type information. It holds the size, too. */
1183 struct vectorlike_header header
;
1185 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1186 char-table of depth 1 contains 16 elements, and each element
1187 covers 4096 (128*32) characters. A sub char-table of depth 2
1188 contains 32 elements, and each element covers 128 characters. A
1189 sub char-table of depth 3 contains 128 elements, and each element
1190 is for one character. */
1193 /* Minimum character covered by the sub char-table. */
1194 Lisp_Object min_char
;
1196 /* Use set_sub_char_table_contents to set this. */
1197 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1201 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1203 struct Lisp_Char_Table
*tbl
= NULL
;
1207 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1208 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1209 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1213 while (NILP (val
) && ! NILP (tbl
->parent
));
1218 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1219 characters. Do not check validity of CT. */
1221 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1223 return (ASCII_CHAR_P (idx
)
1224 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1225 : char_table_ref (ct
, idx
));
1228 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1229 8-bit European characters. Do not check validity of CT. */
1231 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1233 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1234 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1236 char_table_set (ct
, idx
, val
);
1239 /* This structure describes a built-in function.
1240 It is generated by the DEFUN macro only.
1241 defsubr makes it into a Lisp object. */
1245 struct vectorlike_header header
;
1247 Lisp_Object (*a0
) (void);
1248 Lisp_Object (*a1
) (Lisp_Object
);
1249 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1250 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1251 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1252 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1253 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1254 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1255 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1256 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1257 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1259 short min_args
, max_args
;
1260 const char *symbol_name
;
1261 const char *intspec
;
1265 /* This is the number of slots that every char table must have. This
1266 counts the ordinary slots and the top, defalt, parent, and purpose
1268 enum CHAR_TABLE_STANDARD_SLOTS
1270 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1273 /* Return the number of "extra" slots in the char table CT. */
1276 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1278 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1279 - CHAR_TABLE_STANDARD_SLOTS
);
1283 /***********************************************************************
1285 ***********************************************************************/
1287 /* Interned state of a symbol. */
1289 enum symbol_interned
1291 SYMBOL_UNINTERNED
= 0,
1292 SYMBOL_INTERNED
= 1,
1293 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
1296 enum symbol_redirect
1298 SYMBOL_PLAINVAL
= 4,
1299 SYMBOL_VARALIAS
= 1,
1300 SYMBOL_LOCALIZED
= 2,
1301 SYMBOL_FORWARDED
= 3
1308 /* Indicates where the value can be found:
1309 0 : it's a plain var, the value is in the `value' field.
1310 1 : it's a varalias, the value is really in the `alias' symbol.
1311 2 : it's a localized var, the value is in the `blv' object.
1312 3 : it's a forwarding variable, the value is in `forward'. */
1313 ENUM_BF (symbol_redirect
) redirect
: 3;
1315 /* Non-zero means symbol is constant, i.e. changing its value
1316 should signal an error. If the value is 3, then the var
1317 can be changed, but only by `defconst'. */
1318 unsigned constant
: 2;
1320 /* Interned state of the symbol. This is an enumerator from
1321 enum symbol_interned. */
1322 unsigned interned
: 2;
1324 /* True means that this variable has been explicitly declared
1325 special (with `defvar' etc), and shouldn't be lexically bound. */
1326 bool_bf declared_special
: 1;
1328 /* True if pointed to from purespace and hence can't be GC'd. */
1331 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1332 union is used depends on the `redirect' field above. */
1335 struct Lisp_Symbol
*alias
;
1336 struct Lisp_Buffer_Local_Value
*blv
;
1337 union Lisp_Fwd
*fwd
;
1341 /* Value is name of symbol. */
1343 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (struct Lisp_Symbol
*sym
), (sym
))
1345 INLINE
struct Lisp_Symbol
*
1346 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1348 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1349 return sym
->val
.alias
;
1351 INLINE
struct Lisp_Buffer_Local_Value
*
1352 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1354 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1355 return sym
->val
.blv
;
1357 INLINE
union Lisp_Fwd
*
1358 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1360 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1361 return sym
->val
.fwd
;
1364 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1365 (struct Lisp_Symbol
*sym
, Lisp_Object v
), (sym
, v
))
1368 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1370 eassert (sym
->redirect
== SYMBOL_VARALIAS
);
1374 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1376 eassert (sym
->redirect
== SYMBOL_LOCALIZED
);
1380 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1382 eassert (sym
->redirect
== SYMBOL_FORWARDED
);
1387 SYMBOL_NAME (Lisp_Object sym
)
1389 return build_string (scm_to_locale_string (scm_symbol_to_string (sym
)));
1392 /* Value is true if SYM is an interned symbol. */
1395 SYMBOL_INTERNED_P (Lisp_Object sym
)
1397 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1400 /* Value is true if SYM is interned in initial_obarray. */
1403 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1405 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1409 SYMBOL_FUNCTION (Lisp_Object sym
)
1411 return scm_variable_ref (scm_module_lookup (function_module
, sym
));
1414 /* Value is non-zero if symbol is considered a constant, i.e. its
1415 value cannot be changed (there is an exception for keyword symbols,
1416 whose value can be set to the keyword symbol itself). */
1418 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1420 #define DEFSYM(sym, name) \
1421 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1424 /***********************************************************************
1426 ***********************************************************************/
1428 /* The structure of a Lisp hash table. */
1430 struct hash_table_test
1432 /* Name of the function used to compare keys. */
1435 /* User-supplied hash function, or nil. */
1436 Lisp_Object user_hash_function
;
1438 /* User-supplied key comparison function, or nil. */
1439 Lisp_Object user_cmp_function
;
1441 /* C function to compare two keys. */
1442 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1444 /* C function to compute hash code. */
1445 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1448 struct Lisp_Hash_Table
1450 /* This is for Lisp; the hash table code does not refer to it. */
1451 struct vectorlike_header header
;
1453 /* Nil if table is non-weak. Otherwise a symbol describing the
1454 weakness of the table. */
1457 /* When the table is resized, and this is an integer, compute the
1458 new size by adding this to the old size. If a float, compute the
1459 new size by multiplying the old size with this factor. */
1460 Lisp_Object rehash_size
;
1462 /* Resize hash table when number of entries/ table size is >= this
1464 Lisp_Object rehash_threshold
;
1466 /* Vector of hash codes. If hash[I] is nil, this means that the
1467 I-th entry is unused. */
1470 /* Vector used to chain entries. If entry I is free, next[I] is the
1471 entry number of the next free item. If entry I is non-free,
1472 next[I] is the index of the next entry in the collision chain. */
1475 /* Index of first free entry in free list. */
1476 Lisp_Object next_free
;
1478 /* Bucket vector. A non-nil entry is the index of the first item in
1479 a collision chain. This vector's size can be larger than the
1480 hash table size to reduce collisions. */
1483 /* Only the fields above are traced normally by the GC. The ones below
1484 `count' are special and are either ignored by the GC or traced in
1485 a special way (e.g. because of weakness). */
1487 /* Number of key/value entries in the table. */
1490 /* Vector of keys and values. The key of item I is found at index
1491 2 * I, the value is found at index 2 * I + 1.
1492 This is gc_marked specially if the table is weak. */
1493 Lisp_Object key_and_value
;
1495 /* The comparison and hash functions. */
1496 struct hash_table_test test
;
1498 /* Next weak hash table if this is a weak hash table. The head
1499 of the list is in weak_hash_tables. */
1500 struct Lisp_Hash_Table
*next_weak
;
1504 INLINE
struct Lisp_Hash_Table
*
1505 XHASH_TABLE (Lisp_Object a
)
1507 return SMOB_PTR (a
);
1510 #define XSET_HASH_TABLE(VAR, PTR) \
1511 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1514 HASH_TABLE_P (Lisp_Object a
)
1516 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1519 /* Value is the key part of entry IDX in hash table H. */
1521 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1523 return AREF (h
->key_and_value
, 2 * idx
);
1526 /* Value is the value part of entry IDX in hash table H. */
1528 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1530 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1533 /* Value is the index of the next entry following the one at IDX
1536 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1538 return AREF (h
->next
, idx
);
1541 /* Value is the hash code computed for entry IDX in hash table H. */
1543 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1545 return AREF (h
->hash
, idx
);
1548 /* Value is the index of the element in hash table H that is the
1549 start of the collision list at index IDX in the index vector of H. */
1551 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1553 return AREF (h
->index
, idx
);
1556 /* Value is the size of hash table H. */
1558 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1560 return ASIZE (h
->next
);
1563 /* Default size for hash tables if not specified. */
1565 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1567 /* Default threshold specifying when to resize a hash table. The
1568 value gives the ratio of current entries in the hash table and the
1569 size of the hash table. */
1571 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1573 /* Default factor by which to increase the size of a hash table. */
1575 static double const DEFAULT_REHASH_SIZE
= 1.5;
1577 /* Combine two integers X and Y for hashing. The result might not fit
1578 into a Lisp integer. */
1581 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1583 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1586 /* Hash X, returning a value that fits into a fixnum. */
1589 SXHASH_REDUCE (EMACS_UINT x
)
1591 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1594 /* These structures are used for various misc types. */
1596 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1599 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1605 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1606 /* This flag is temporarily used in the functions
1607 decode/encode_coding_object to record that the marker position
1608 must be adjusted after the conversion. */
1609 bool_bf need_adjustment
: 1;
1610 /* True means normal insertion at the marker's position
1611 leaves the marker after the inserted text. */
1612 bool_bf insertion_type
: 1;
1613 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1614 Note: a chain of markers can contain markers pointing into different
1615 buffers (the chain is per buffer_text rather than per buffer, so it's
1616 shared between indirect buffers). */
1617 /* This is used for (other than NULL-checking):
1619 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1620 - unchain_marker: to find the list from which to unchain.
1621 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1623 struct buffer
*buffer
;
1625 /* The remaining fields are meaningless in a marker that
1626 does not point anywhere. */
1628 /* For markers that point somewhere,
1629 this is used to chain of all the markers in a given buffer. */
1630 /* We could remove it and use an array in buffer_text instead.
1631 That would also allow to preserve it ordered. */
1632 struct Lisp_Marker
*next
;
1633 /* This is the char position where the marker points. */
1635 /* This is the byte position.
1636 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1637 used to implement the functionality of markers, but rather to (ab)use
1638 markers as a cache for char<->byte mappings). */
1642 /* START and END are markers in the overlay's buffer, and
1643 PLIST is the overlay's property list. */
1645 /* An overlay's real data content is:
1647 - buffer (really there are two buffer pointers, one per marker,
1648 and both points to the same buffer)
1649 - insertion type of both ends (per-marker fields)
1650 - start & start byte (of start marker)
1651 - end & end byte (of end marker)
1652 - next (singly linked list of overlays)
1653 - next fields of start and end markers (singly linked list of markers).
1654 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1658 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1659 struct Lisp_Overlay
*next
;
1665 /* Types of data which may be saved in a Lisp_Save_Value. */
1676 /* Number of bits needed to store one of the above values. */
1677 enum { SAVE_SLOT_BITS
= 3 };
1679 /* Number of slots in a save value where save_type is nonzero. */
1680 enum { SAVE_VALUE_SLOTS
= 4 };
1682 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1684 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1688 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1689 SAVE_TYPE_INT_INT_INT
1690 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1691 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1692 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1693 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1694 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1695 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1696 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1697 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1698 SAVE_TYPE_FUNCPTR_PTR_OBJ
1699 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1701 /* This has an extra bit indicating it's raw memory. */
1702 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1705 /* Special object used to hold a different values for later use.
1707 This is mostly used to package C integers and pointers to call
1708 record_unwind_protect when two or more values need to be saved.
1712 struct my_data *md = get_my_data ();
1713 ptrdiff_t mi = get_my_integer ();
1714 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1717 Lisp_Object my_unwind (Lisp_Object arg)
1719 struct my_data *md = XSAVE_POINTER (arg, 0);
1720 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1724 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1725 saved objects and raise eassert if type of the saved object doesn't match
1726 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1727 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1728 slot 0 is a pointer. */
1730 typedef void (*voidfuncptr
) (void);
1732 struct Lisp_Save_Value
1735 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1736 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1738 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1739 V's data entries are determined by V->save_type. E.g., if
1740 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1741 V->data[1] is an integer, and V's other data entries are unused.
1743 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1744 a memory area containing V->data[1].integer potential Lisp_Objects. */
1745 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1748 voidfuncptr funcpointer
;
1751 } data
[SAVE_VALUE_SLOTS
];
1754 /* Return the type of V's Nth saved value. */
1756 save_type (struct Lisp_Save_Value
*v
, int n
)
1758 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1759 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1762 /* Get and set the Nth saved pointer. */
1765 XSAVE_POINTER (Lisp_Object obj
, int n
)
1767 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1768 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1771 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1773 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1774 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1777 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1779 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1780 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1783 /* Likewise for the saved integer. */
1786 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1788 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1789 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1792 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1794 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1795 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1798 /* Extract Nth saved object. */
1801 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1803 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1804 return XSAVE_VALUE (obj
)->data
[n
].object
;
1807 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1808 It uses one of these struct subtypes to get the type field. */
1812 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1813 struct Lisp_Marker u_marker
;
1814 struct Lisp_Overlay u_overlay
;
1815 struct Lisp_Save_Value u_save_value
;
1818 INLINE
union Lisp_Misc
*
1819 XMISC (Lisp_Object a
)
1821 return SMOB_PTR (a
);
1824 INLINE
struct Lisp_Misc_Any
*
1825 XMISCANY (Lisp_Object a
)
1827 eassert (MISCP (a
));
1828 return & XMISC (a
)->u_any
;
1831 INLINE
enum Lisp_Misc_Type
1832 XMISCTYPE (Lisp_Object a
)
1834 return XMISCANY (a
)->type
;
1837 INLINE
struct Lisp_Marker
*
1838 XMARKER (Lisp_Object a
)
1840 eassert (MARKERP (a
));
1841 return & XMISC (a
)->u_marker
;
1844 INLINE
struct Lisp_Overlay
*
1845 XOVERLAY (Lisp_Object a
)
1847 eassert (OVERLAYP (a
));
1848 return & XMISC (a
)->u_overlay
;
1851 INLINE
struct Lisp_Save_Value
*
1852 XSAVE_VALUE (Lisp_Object a
)
1854 eassert (SAVE_VALUEP (a
));
1855 return & XMISC (a
)->u_save_value
;
1858 /* Forwarding pointer to an int variable.
1859 This is allowed only in the value cell of a symbol,
1860 and it means that the symbol's value really lives in the
1861 specified int variable. */
1864 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1868 /* Boolean forwarding pointer to an int variable.
1869 This is like Lisp_Intfwd except that the ostensible
1870 "value" of the symbol is t if the bool variable is true,
1871 nil if it is false. */
1874 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1878 /* Forwarding pointer to a Lisp_Object variable.
1879 This is allowed only in the value cell of a symbol,
1880 and it means that the symbol's value really lives in the
1881 specified variable. */
1884 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1885 Lisp_Object
*objvar
;
1888 /* Like Lisp_Objfwd except that value lives in a slot in the
1889 current buffer. Value is byte index of slot within buffer. */
1890 struct Lisp_Buffer_Objfwd
1892 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1894 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1895 Lisp_Object predicate
;
1898 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1899 the symbol has buffer-local or frame-local bindings. (Exception:
1900 some buffer-local variables are built-in, with their values stored
1901 in the buffer structure itself. They are handled differently,
1902 using struct Lisp_Buffer_Objfwd.)
1904 The `realvalue' slot holds the variable's current value, or a
1905 forwarding pointer to where that value is kept. This value is the
1906 one that corresponds to the loaded binding. To read or set the
1907 variable, you must first make sure the right binding is loaded;
1908 then you can access the value in (or through) `realvalue'.
1910 `buffer' and `frame' are the buffer and frame for which the loaded
1911 binding was found. If those have changed, to make sure the right
1912 binding is loaded it is necessary to find which binding goes with
1913 the current buffer and selected frame, then load it. To load it,
1914 first unload the previous binding, then copy the value of the new
1915 binding into `realvalue' (or through it). Also update
1916 LOADED-BINDING to point to the newly loaded binding.
1918 `local_if_set' indicates that merely setting the variable creates a
1919 local binding for the current buffer. Otherwise the latter, setting
1920 the variable does not do that; only make-local-variable does that. */
1922 struct Lisp_Buffer_Local_Value
1924 /* True means that merely setting the variable creates a local
1925 binding for the current buffer. */
1926 bool_bf local_if_set
: 1;
1927 /* True means this variable can have frame-local bindings, otherwise, it is
1928 can have buffer-local bindings. The two cannot be combined. */
1929 bool_bf frame_local
: 1;
1930 /* True means that the binding now loaded was found.
1931 Presumably equivalent to (defcell!=valcell). */
1933 /* If non-NULL, a forwarding to the C var where it should also be set. */
1934 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1935 /* The buffer or frame for which the loaded binding was found. */
1937 /* A cons cell that holds the default value. It has the form
1938 (SYMBOL . DEFAULT-VALUE). */
1939 Lisp_Object defcell
;
1940 /* The cons cell from `where's parameter alist.
1941 It always has the form (SYMBOL . VALUE)
1942 Note that if `forward' is non-nil, VALUE may be out of date.
1943 Also if the currently loaded binding is the default binding, then
1944 this is `eq'ual to defcell. */
1945 Lisp_Object valcell
;
1948 /* Like Lisp_Objfwd except that value lives in a slot in the
1950 struct Lisp_Kboard_Objfwd
1952 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1958 struct Lisp_Intfwd u_intfwd
;
1959 struct Lisp_Boolfwd u_boolfwd
;
1960 struct Lisp_Objfwd u_objfwd
;
1961 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1962 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1965 INLINE
enum Lisp_Fwd_Type
1966 XFWDTYPE (union Lisp_Fwd
*a
)
1968 return a
->u_intfwd
.type
;
1971 INLINE
struct Lisp_Buffer_Objfwd
*
1972 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
1974 eassert (BUFFER_OBJFWDP (a
));
1975 return &a
->u_buffer_objfwd
;
1978 #define XFLOAT_DATA(f) (scm_to_double (f))
1980 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1981 representations, have infinities and NaNs, and do not trap on
1982 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1983 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1984 wanted here, but is not quite right because Emacs does not require
1985 all the features of C11 Annex F (and does not require C11 at all,
1986 for that matter). */
1990 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
1991 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
1994 /* A character, declared with the following typedef, is a member
1995 of some character set associated with the current buffer. */
1996 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1998 typedef unsigned char UCHAR
;
2001 /* Meanings of slots in a Lisp_Compiled: */
2005 COMPILED_ARGLIST
= 0,
2006 COMPILED_BYTECODE
= 1,
2007 COMPILED_CONSTANTS
= 2,
2008 COMPILED_STACK_DEPTH
= 3,
2009 COMPILED_DOC_STRING
= 4,
2010 COMPILED_INTERACTIVE
= 5
2013 /* Flag bits in a character. These also get used in termhooks.h.
2014 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2015 (MUlti-Lingual Emacs) might need 22 bits for the character value
2016 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2019 CHAR_ALT
= 0x0400000,
2020 CHAR_SUPER
= 0x0800000,
2021 CHAR_HYPER
= 0x1000000,
2022 CHAR_SHIFT
= 0x2000000,
2023 CHAR_CTL
= 0x4000000,
2024 CHAR_META
= 0x8000000,
2026 CHAR_MODIFIER_MASK
=
2027 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2029 /* Actually, the current Emacs uses 22 bits for the character value
2034 /* Data type checking. */
2036 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2039 NUMBERP (Lisp_Object x
)
2041 return INTEGERP (x
) || FLOATP (x
);
2044 NATNUMP (Lisp_Object x
)
2046 return INTEGERP (x
) && 0 <= XINT (x
);
2050 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2052 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2055 #define TYPE_RANGED_INTEGERP(type, x) \
2057 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2058 && XINT (x) <= TYPE_MAXIMUM (type))
2060 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2061 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2062 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2063 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2064 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2065 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2066 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2069 STRINGP (Lisp_Object x
)
2071 return SMOB_TYPEP (x
, lisp_string_tag
);
2074 VECTORP (Lisp_Object x
)
2076 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2079 OVERLAYP (Lisp_Object x
)
2081 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2084 SAVE_VALUEP (Lisp_Object x
)
2086 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2090 AUTOLOADP (Lisp_Object x
)
2092 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2096 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2098 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2102 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2104 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2105 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2108 /* True if A is a pseudovector whose code is CODE. */
2110 PSEUDOVECTORP (Lisp_Object a
, int code
)
2112 if (! VECTORLIKEP (a
))
2116 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2117 struct vectorlike_header
*h
= SMOB_PTR (a
);
2118 return PSEUDOVECTOR_TYPEP (h
, code
);
2122 /* Test for specific pseudovector types. */
2125 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2127 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2131 PROCESSP (Lisp_Object a
)
2133 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2137 WINDOWP (Lisp_Object a
)
2139 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2143 TERMINALP (Lisp_Object a
)
2145 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2149 SUBRP (Lisp_Object a
)
2151 return PSEUDOVECTORP (a
, PVEC_SUBR
);
2155 COMPILEDP (Lisp_Object a
)
2157 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2161 BUFFERP (Lisp_Object a
)
2163 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2167 CHAR_TABLE_P (Lisp_Object a
)
2169 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2173 SUB_CHAR_TABLE_P (Lisp_Object a
)
2175 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2179 BOOL_VECTOR_P (Lisp_Object a
)
2181 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2185 FRAMEP (Lisp_Object a
)
2187 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2190 /* Test for image (image . spec) */
2192 IMAGEP (Lisp_Object x
)
2194 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2199 ARRAYP (Lisp_Object x
)
2201 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2205 CHECK_LIST (Lisp_Object x
)
2207 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2210 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2211 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2212 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2215 CHECK_STRING (Lisp_Object x
)
2217 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2220 CHECK_STRING_CAR (Lisp_Object x
)
2222 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2225 CHECK_CONS (Lisp_Object x
)
2227 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2230 CHECK_VECTOR (Lisp_Object x
)
2232 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2235 CHECK_BOOL_VECTOR (Lisp_Object x
)
2237 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2240 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2242 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2245 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2247 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2250 CHECK_BUFFER (Lisp_Object x
)
2252 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2255 CHECK_WINDOW (Lisp_Object x
)
2257 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2261 CHECK_PROCESS (Lisp_Object x
)
2263 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2267 CHECK_NATNUM (Lisp_Object x
)
2269 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2272 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2275 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2276 args_out_of_range_3 \
2278 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2279 ? MOST_NEGATIVE_FIXNUM \
2281 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2283 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2285 if (TYPE_SIGNED (type)) \
2286 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2288 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2291 #define CHECK_NUMBER_COERCE_MARKER(x) \
2293 if (MARKERP ((x))) \
2294 XSETFASTINT (x, marker_position (x)); \
2296 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2300 XFLOATINT (Lisp_Object n
)
2302 return extract_float (n
);
2306 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2308 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2311 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2314 XSETFASTINT (x, marker_position (x)); \
2316 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2319 /* Since we can't assign directly to the CAR or CDR fields of a cons
2320 cell, use these when checking that those fields contain numbers. */
2322 CHECK_NUMBER_CAR (Lisp_Object x
)
2324 Lisp_Object tmp
= XCAR (x
);
2330 CHECK_NUMBER_CDR (Lisp_Object x
)
2332 Lisp_Object tmp
= XCDR (x
);
2337 /* Define a built-in function for calling from Lisp.
2338 `lname' should be the name to give the function in Lisp,
2339 as a null-terminated C string.
2340 `fnname' should be the name of the function in C.
2341 By convention, it starts with F.
2342 `sname' should be the name for the C constant structure
2343 that records information on this function for internal use.
2344 By convention, it should be the same as `fnname' but with S instead of F.
2345 It's too bad that C macros can't compute this from `fnname'.
2346 `minargs' should be a number, the minimum number of arguments allowed.
2347 `maxargs' should be a number, the maximum number of arguments allowed,
2348 or else MANY or UNEVALLED.
2349 MANY means pass a vector of evaluated arguments,
2350 in the form of an integer number-of-arguments
2351 followed by the address of a vector of Lisp_Objects
2352 which contains the argument values.
2353 UNEVALLED means pass the list of unevaluated arguments
2354 `intspec' says how interactive arguments are to be fetched.
2355 If the string starts with a `(', `intspec' is evaluated and the resulting
2356 list is the list of arguments.
2357 If it's a string that doesn't start with `(', the value should follow
2358 the one of the doc string for `interactive'.
2359 A null string means call interactively with no arguments.
2360 `doc' is documentation for the user. */
2362 /* This version of DEFUN declares a function prototype with the right
2363 arguments, so we can catch errors with maxargs at compile-time. */
2365 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2366 SCM_SNARF_INIT (defsubr (&sname);) \
2367 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2368 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2370 (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2371 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2372 { (Lisp_Object (__cdecl *)(void))fnname }, \
2373 minargs, maxargs, lname, intspec, 0}; \
2375 #else /* not _MSC_VER */
2376 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2377 SCM_SNARF_INIT (defsubr (&sname);) \
2378 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2379 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2381 .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2382 { .a ## maxargs = fnname }, \
2383 minargs, maxargs, lname, intspec, 0}; \
2387 /* Note that the weird token-substitution semantics of ANSI C makes
2388 this work for MANY and UNEVALLED. */
2389 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2390 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2391 #define DEFUN_ARGS_0 (void)
2392 #define DEFUN_ARGS_1 (Lisp_Object)
2393 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2394 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2395 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2396 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2398 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2399 Lisp_Object, Lisp_Object)
2400 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2401 Lisp_Object, Lisp_Object, Lisp_Object)
2402 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2403 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2405 /* True if OBJ is a Lisp function. */
2407 FUNCTIONP (Lisp_Object obj
)
2409 return functionp (obj
);
2413 is how we define the symbol for function `name' at start-up time. */
2414 extern void defsubr (struct Lisp_Subr
*);
2422 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2423 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2424 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2425 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2426 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2428 /* Macros we use to define forwarded Lisp variables.
2429 These are used in the syms_of_FILENAME functions.
2431 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2432 lisp variable is actually a field in `struct emacs_globals'. The
2433 field's name begins with "f_", which is a convention enforced by
2434 these macros. Each such global has a corresponding #define in
2435 globals.h; the plain name should be used in the code.
2437 E.g., the global "cons_cells_consed" is declared as "int
2438 f_cons_cells_consed" in globals.h, but there is a define:
2440 #define cons_cells_consed globals.f_cons_cells_consed
2442 All C code uses the `cons_cells_consed' name. This is all done
2443 this way to support indirection for multi-threaded Emacs. */
2445 #define DEFVAR_LISP(lname, vname, doc) \
2447 static struct Lisp_Objfwd o_fwd; \
2448 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2450 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2452 static struct Lisp_Objfwd o_fwd; \
2453 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2455 #define DEFVAR_BOOL(lname, vname, doc) \
2457 static struct Lisp_Boolfwd b_fwd; \
2458 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2460 #define DEFVAR_INT(lname, vname, doc) \
2462 static struct Lisp_Intfwd i_fwd; \
2463 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2466 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2468 static struct Lisp_Objfwd o_fwd; \
2469 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2472 #define DEFVAR_KBOARD(lname, vname, doc) \
2474 static struct Lisp_Kboard_Objfwd ko_fwd; \
2475 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2478 /* Save and restore the instruction and environment pointers,
2479 without affecting the signal mask. */
2482 typedef jmp_buf sys_jmp_buf
;
2483 # define sys_setjmp(j) _setjmp (j)
2484 # define sys_longjmp(j, v) _longjmp (j, v)
2485 #elif defined HAVE_SIGSETJMP
2486 typedef sigjmp_buf sys_jmp_buf
;
2487 # define sys_setjmp(j) sigsetjmp (j, 0)
2488 # define sys_longjmp(j, v) siglongjmp (j, v)
2490 /* A platform that uses neither _longjmp nor siglongjmp; assume
2491 longjmp does not affect the sigmask. */
2492 typedef jmp_buf sys_jmp_buf
;
2493 # define sys_setjmp(j) setjmp (j)
2494 # define sys_longjmp(j, v) longjmp (j, v)
2498 /* Elisp uses several stacks:
2500 - the bytecode stack: used internally by the bytecode interpreter.
2501 Allocated from the C stack.
2502 - The specpdl stack: keeps track of active unwind-protect and
2503 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2505 - The handler stack: keeps track of active catch tags and condition-case
2506 handlers. Allocated in a manually managed stack implemented by a
2507 doubly-linked list allocated via xmalloc and never freed. */
2509 /* Structure for recording Lisp call stack for backtrace purposes. */
2511 /* The special binding stack holds the outer values of variables while
2512 they are bound by a function application or a let form, stores the
2513 code to be executed for unwind-protect forms.
2515 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2516 used all over the place, needs to be fast, and needs to know the size of
2517 union specbinding. But only eval.c should access it. */
2520 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2521 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2522 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2523 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2524 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2529 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2531 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2534 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2535 bool wind_explicitly
;
2536 void (*func
) (Lisp_Object
);
2540 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2541 bool wind_explicitly
;
2542 void (*func
) (void *);
2546 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2547 bool wind_explicitly
;
2552 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2553 bool wind_explicitly
;
2554 void (*func
) (void);
2557 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2558 /* `where' is not used in the case of SPECPDL_LET. */
2559 Lisp_Object symbol
, old_value
, where
;
2562 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2563 bool_bf debug_on_exit
: 1;
2564 Lisp_Object function
;
2570 extern union specbinding
*specpdl
;
2571 extern union specbinding
*specpdl_ptr
;
2572 extern ptrdiff_t specpdl_size
;
2575 SPECPDL_INDEX (void)
2577 return specpdl_ptr
- specpdl
;
2580 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2581 control structures. A struct handler contains all the information needed to
2582 restore the state of the interpreter after a non-local jump.
2584 handler structures are chained together in a doubly linked list; the `next'
2585 member points to the next outer catchtag and the `nextfree' member points in
2586 the other direction to the next inner element (which is typically the next
2587 free element since we mostly use it on the deepest handler).
2589 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2590 member is TAG, and then unbinds to it. The `val' member is used to
2591 hold VAL while the stack is unwound; `val' is returned as the value
2594 All the other members are concerned with restoring the interpreter
2597 Members are volatile if their values need to survive _longjmp when
2598 a 'struct handler' is a local variable. */
2600 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2604 enum handlertype type
;
2606 Lisp_Object tag_or_ch
;
2610 struct handler
*next
;
2611 EMACS_INT lisp_eval_depth
;
2612 int poll_suppress_count
;
2613 int interrupt_input_blocked
;
2616 extern Lisp_Object memory_signal_data
;
2618 /* Check quit-flag and quit if it is non-nil.
2619 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
2620 So the program needs to do QUIT at times when it is safe to quit.
2621 Every loop that might run for a long time or might not exit
2622 ought to do QUIT at least once, at a safe place.
2623 Unless that is impossible, of course.
2624 But it is very desirable to avoid creating loops where QUIT is impossible.
2626 Exception: if you set immediate_quit to true,
2627 then the handler that responds to the C-g does the quit itself.
2628 This is a good thing to do around a loop that has no side effects
2629 and (in particular) cannot call arbitrary Lisp code.
2631 If quit-flag is set to `kill-emacs' the SIGINT handler has received
2632 a request to exit Emacs when it is safe to do. */
2634 extern void process_pending_signals (void);
2635 extern bool volatile pending_signals
;
2637 extern void process_quit_flag (void);
2640 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
2641 process_quit_flag (); \
2642 else if (pending_signals) \
2643 process_pending_signals (); \
2647 /* True if ought to quit now. */
2649 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
2651 extern Lisp_Object Vascii_downcase_table
;
2652 extern Lisp_Object Vascii_canon_table
;
2654 /* Structure for recording stack slots that need marking. */
2656 /* This is a chain of structures, each of which points at a Lisp_Object
2657 variable whose value should be marked in garbage collection.
2658 Normally every link of the chain is an automatic variable of a function,
2659 and its `val' points to some argument or local variable of the function.
2660 On exit to the function, the chain is set back to the value it had on entry.
2661 This way, no link remains in the chain when the stack frame containing the
2664 Every function that can call Feval must protect in this fashion all
2665 Lisp_Object variables whose contents will be used again. */
2667 extern struct gcpro
*gcprolist
;
2673 /* Address of first protected variable. */
2674 volatile Lisp_Object
*var
;
2676 /* Number of consecutive protected variables. */
2684 /* Do something silly with gcproN vars just so gcc shuts up. */
2685 /* You get warnings from MIPSPro... */
2687 #define GCPRO1(varname) ((void) gcpro1)
2688 #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1)
2689 #define GCPRO3(varname1, varname2, varname3) \
2690 ((void) gcpro3, (void) gcpro2, (void) gcpro1)
2691 #define GCPRO4(varname1, varname2, varname3, varname4) \
2692 ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2693 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2694 ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1)
2695 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2696 ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \
2698 #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7)
2699 #define UNGCPRO ((void) 0)
2701 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2702 #define RETURN_UNGCPRO(expr) \
2705 Lisp_Object ret_ungc_val; \
2706 ret_ungc_val = (expr); \
2708 return ret_ungc_val; \
2712 /* Call staticpro (&var) to protect static variable `var'. */
2714 void staticpro (Lisp_Object
*);
2716 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2717 meaning as in the DEFUN macro, and is used to construct a prototype. */
2718 /* We can use the same trick as in the DEFUN macro to generate the
2719 appropriate prototype. */
2720 #define EXFUN(fnname, maxargs) \
2721 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2723 #include "globals.h"
2725 /* Forward declarations for prototypes. */
2729 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
2732 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
2734 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
2735 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
2738 /* Functions to modify hash tables. */
2741 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2743 gc_aset (h
->key_and_value
, 2 * idx
, val
);
2747 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
2749 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
2752 /* Use these functions to set Lisp_Object
2753 or pointer slots of struct Lisp_Symbol. */
2756 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
2758 scm_variable_set_x (scm_module_lookup (function_module
, sym
), function
);
2762 symbol_plist (Lisp_Object sym
)
2764 return scm_variable_ref (scm_module_lookup (plist_module
, sym
));
2768 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2770 scm_variable_set_x (scm_module_lookup (plist_module
, sym
), plist
);
2773 /* Buffer-local (also frame-local) variable access functions. */
2776 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2778 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2782 /* Set overlay's property list. */
2785 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2787 XOVERLAY (overlay
)->plist
= plist
;
2790 /* Get text properties of S. */
2793 string_intervals (Lisp_Object s
)
2795 return XSTRING (s
)->intervals
;
2798 /* Set text properties of S to I. */
2801 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2803 XSTRING (s
)->intervals
= i
;
2806 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2807 of setting slots directly. */
2810 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2812 XCHAR_TABLE (table
)->defalt
= val
;
2815 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2817 XCHAR_TABLE (table
)->purpose
= val
;
2820 /* Set different slots in (sub)character tables. */
2823 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2825 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2826 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2830 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2832 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2833 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2837 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2839 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2842 /* Defined in data.c. */
2843 extern Lisp_Object Qquote
, Qunbound
;
2844 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2845 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2846 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2847 extern Lisp_Object Qinvalid_read_syntax
;
2848 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2849 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2850 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2851 extern Lisp_Object Qtext_read_only
;
2852 extern Lisp_Object Qinteractive_form
;
2853 extern Lisp_Object Qcircular_list
;
2854 extern Lisp_Object Qsequencep
;
2855 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2856 extern Lisp_Object Qfboundp
;
2858 extern Lisp_Object Qcdr
;
2860 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2862 extern Lisp_Object Qnumber_or_marker_p
;
2864 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2866 /* Defined in data.c. */
2867 extern Lisp_Object
indirect_function (Lisp_Object
);
2868 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2869 enum Arith_Comparison
{
2874 ARITH_LESS_OR_EQUAL
,
2877 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2878 enum Arith_Comparison comparison
);
2880 /* Convert the integer I to an Emacs representation, either the integer
2881 itself, or a cons of two or three integers, or if all else fails a float.
2882 I should not have side effects. */
2883 #define INTEGER_TO_CONS(i) \
2884 (! FIXNUM_OVERFLOW_P (i) \
2886 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2887 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2888 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2889 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2890 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2891 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2892 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2893 ? Fcons (make_number ((i) >> 16 >> 24), \
2894 Fcons (make_number ((i) >> 16 & 0xffffff), \
2895 make_number ((i) & 0xffff))) \
2898 /* Convert the Emacs representation CONS back to an integer of type
2899 TYPE, storing the result the variable VAR. Signal an error if CONS
2900 is not a valid representation or is out of range for TYPE. */
2901 #define CONS_TO_INTEGER(cons, type, var) \
2902 (TYPE_SIGNED (type) \
2903 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2904 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2905 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2906 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2908 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
2909 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2910 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2912 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2913 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2914 extern void syms_of_data (void);
2915 extern void swap_in_global_binding (struct Lisp_Symbol
*);
2917 /* Defined in cmds.c */
2918 extern void syms_of_cmds (void);
2919 extern void keys_of_cmds (void);
2921 /* Defined in coding.c. */
2922 extern Lisp_Object Qcharset
;
2923 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2924 ptrdiff_t, bool, bool, Lisp_Object
);
2925 extern void init_coding (void);
2926 extern void init_coding_once (void);
2927 extern void syms_of_coding (void);
2929 /* Defined in character.c. */
2930 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2931 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2932 extern void syms_of_character (void);
2934 /* Defined in charset.c. */
2935 extern void init_charset (void);
2936 extern void init_charset_once (void);
2937 extern void syms_of_charset (void);
2938 /* Structure forward declarations. */
2941 /* Defined in syntax.c. */
2942 extern void init_syntax_once (void);
2943 extern void syms_of_syntax (void);
2945 /* Defined in fns.c. */
2946 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2947 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2948 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2949 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2950 extern void sweep_weak_hash_tables (void);
2951 extern Lisp_Object Qcursor_in_echo_area
;
2952 extern Lisp_Object Qstring_lessp
;
2953 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2954 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2955 EMACS_UINT
sxhash (Lisp_Object
, int);
2956 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2957 Lisp_Object
, Lisp_Object
);
2958 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2959 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2961 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2962 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2963 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2964 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2965 ptrdiff_t, ptrdiff_t);
2966 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2967 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2968 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2969 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2970 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2971 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2972 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2973 extern void clear_string_char_byte_cache (void);
2974 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2975 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2976 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2977 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2978 extern void init_fns_once (void);
2979 extern void syms_of_fns (void);
2981 /* Defined in floatfns.c. */
2982 extern void syms_of_floatfns (void);
2983 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2985 /* Defined in fringe.c. */
2986 extern void syms_of_fringe (void);
2987 extern void init_fringe (void);
2988 #ifdef HAVE_WINDOW_SYSTEM
2989 extern void mark_fringe_data (void);
2990 extern void init_fringe_once (void);
2991 #endif /* HAVE_WINDOW_SYSTEM */
2993 /* Defined in image.c. */
2994 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
2995 extern Lisp_Object QCconversion
;
2996 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
2997 extern void reset_image_types (void);
2998 extern void syms_of_image (void);
3000 /* Defined in insdel.c. */
3001 extern Lisp_Object Qinhibit_modification_hooks
;
3002 extern Lisp_Object Qregion_extract_function
;
3003 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3004 extern _Noreturn
void buffer_overflow (void);
3005 extern void make_gap (ptrdiff_t);
3006 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3007 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3008 ptrdiff_t, bool, bool);
3009 extern int count_combining_before (const unsigned char *,
3010 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3011 extern int count_combining_after (const unsigned char *,
3012 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3013 extern void insert (const char *, ptrdiff_t);
3014 extern void insert_and_inherit (const char *, ptrdiff_t);
3015 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3017 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3018 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3019 ptrdiff_t, ptrdiff_t, bool);
3020 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3021 extern void insert_char (int);
3022 extern void insert_string (const char *);
3023 extern void insert_before_markers (const char *, ptrdiff_t);
3024 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3025 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3026 ptrdiff_t, ptrdiff_t,
3028 extern void del_range (ptrdiff_t, ptrdiff_t);
3029 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3030 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3031 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3032 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3033 ptrdiff_t, ptrdiff_t, bool);
3034 extern void modify_text (ptrdiff_t, ptrdiff_t);
3035 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3036 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3037 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3038 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3039 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3040 ptrdiff_t, ptrdiff_t);
3041 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3042 ptrdiff_t, ptrdiff_t);
3043 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3044 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3045 const char *, ptrdiff_t, ptrdiff_t, bool);
3046 extern void syms_of_insdel (void);
3048 /* Defined in dispnew.c. */
3049 #if (defined PROFILING \
3050 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3051 _Noreturn
void __executable_start (void);
3053 extern Lisp_Object Vwindow_system
;
3054 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3056 /* Defined in xdisp.c. */
3057 extern Lisp_Object Qinhibit_point_motion_hooks
;
3058 extern Lisp_Object Qinhibit_redisplay
;
3059 extern Lisp_Object Qmenu_bar_update_hook
;
3060 extern Lisp_Object Qwindow_scroll_functions
;
3061 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3062 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3063 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3064 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3065 extern Lisp_Object Qleft_margin
, Qright_margin
;
3066 extern Lisp_Object QCdata
, QCfile
;
3067 extern Lisp_Object QCmap
;
3068 extern Lisp_Object Qrisky_local_variable
;
3069 extern bool noninteractive_need_newline
;
3070 extern Lisp_Object echo_area_buffer
[2];
3071 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3072 extern void check_message_stack (void);
3073 extern void setup_echo_area_for_printing (int);
3074 extern bool push_message (void);
3075 extern void pop_message_unwind (void);
3076 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3077 extern void restore_message (void);
3078 extern Lisp_Object
current_message (void);
3079 extern void clear_message (bool, bool);
3080 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3081 extern void message1 (const char *);
3082 extern void message1_nolog (const char *);
3083 extern void message3 (Lisp_Object
);
3084 extern void message3_nolog (Lisp_Object
);
3085 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3086 extern void message_with_string (const char *, Lisp_Object
, int);
3087 extern void message_log_maybe_newline (void);
3088 extern void update_echo_area (void);
3089 extern void truncate_echo_area (ptrdiff_t);
3090 extern void redisplay (void);
3092 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3093 extern void syms_of_xdisp (void);
3094 extern void init_xdisp (void);
3095 extern Lisp_Object
safe_eval (Lisp_Object
);
3096 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3097 int *, int *, int *, int *, int *);
3099 /* Defined in xsettings.c. */
3100 extern void syms_of_xsettings (void);
3102 /* Defined in vm-limit.c. */
3103 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3105 /* Defined in alloc.c. */
3106 extern void check_pure_size (void);
3107 extern void free_misc (Lisp_Object
);
3108 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3109 extern void malloc_warning (const char *);
3110 extern _Noreturn
void memory_full (size_t);
3111 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3112 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3113 extern void refill_memory_reserve (void);
3115 extern const char *pending_malloc_warning
;
3116 extern Lisp_Object zero_vector
;
3117 extern Lisp_Object
list1 (Lisp_Object
);
3118 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3119 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3120 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3121 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3123 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3124 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3126 /* Build a frequently used 2/3/4-integer lists. */
3129 list2i (EMACS_INT x
, EMACS_INT y
)
3131 return list2 (make_number (x
), make_number (y
));
3135 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3137 return list3 (make_number (x
), make_number (y
), make_number (w
));
3141 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3143 return list4 (make_number (x
), make_number (y
),
3144 make_number (w
), make_number (h
));
3147 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3148 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3149 extern _Noreturn
void string_overflow (void);
3150 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3151 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3152 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3153 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3155 /* Make unibyte string from C string when the length isn't known. */
3158 build_unibyte_string (const char *str
)
3160 return make_unibyte_string (str
, strlen (str
));
3163 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3164 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3165 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3166 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3167 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3168 extern Lisp_Object
make_specified_string (const char *,
3169 ptrdiff_t, ptrdiff_t, bool);
3170 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3171 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3173 /* Make a string allocated in pure space, use STR as string data. */
3176 build_pure_c_string (const char *str
)
3178 return make_pure_c_string (str
, strlen (str
));
3181 /* Make a string from the data at STR, treating it as multibyte if the
3185 build_string (const char *str
)
3187 return make_string (str
, strlen (str
));
3190 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3191 extern void make_byte_code (struct Lisp_Vector
*);
3192 extern Lisp_Object Qchar_table_extra_slots
;
3193 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3195 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3196 be sure that GC cannot happen until the vector is completely
3197 initialized. E.g. the following code is likely to crash:
3199 v = make_uninit_vector (3);
3201 ASET (v, 1, Ffunction_can_gc ());
3202 ASET (v, 2, obj1); */
3205 make_uninit_vector (ptrdiff_t size
)
3208 struct Lisp_Vector
*p
;
3210 p
= allocate_vector (size
);
3215 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3216 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3218 allocate_pseudovector \
3219 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3220 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3221 extern struct window
*allocate_window (void);
3222 extern struct frame
*allocate_frame (void);
3223 extern struct Lisp_Process
*allocate_process (void);
3224 extern struct terminal
*allocate_terminal (void);
3225 extern Lisp_Object
make_float (double);
3226 extern void display_malloc_warning (void);
3227 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3228 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3229 Lisp_Object
, Lisp_Object
);
3230 extern Lisp_Object
make_save_ptr (void *);
3231 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3232 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3233 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3235 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3236 extern void free_save_value (Lisp_Object
);
3237 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3238 extern void init_alloc_once (void);
3239 extern void init_alloc (void);
3240 extern void syms_of_alloc (void);
3241 extern struct buffer
* allocate_buffer (void);
3242 extern int valid_lisp_object_p (Lisp_Object
);
3243 extern int relocatable_string_data_p (const char *);
3246 /* Defined in ralloc.c. */
3247 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3248 extern void r_alloc_free (void **);
3249 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3250 extern void r_alloc_reset_variable (void **, void **);
3251 extern void r_alloc_inhibit_buffer_relocation (int);
3254 /* Defined in chartab.c. */
3255 extern Lisp_Object
copy_char_table (Lisp_Object
);
3256 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3258 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3259 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3261 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3262 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3263 Lisp_Object
, Lisp_Object
,
3264 Lisp_Object
, struct charset
*,
3265 unsigned, unsigned);
3266 extern Lisp_Object
uniprop_table (Lisp_Object
);
3267 extern void syms_of_chartab (void);
3269 /* Defined in print.c. */
3270 extern Lisp_Object Vprin1_to_string_buffer
;
3271 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3272 extern Lisp_Object Qstandard_output
;
3273 extern Lisp_Object Qexternal_debugging_output
;
3274 extern void temp_output_buffer_setup (const char *);
3275 extern int print_level
;
3276 extern Lisp_Object Qprint_escape_newlines
;
3277 extern void write_string (const char *, int);
3278 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3280 extern Lisp_Object internal_with_output_to_temp_buffer
3281 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3282 #define FLOAT_TO_STRING_BUFSIZE 350
3283 extern int float_to_string (char *, double);
3284 extern void init_print_once (void);
3285 extern void syms_of_print (void);
3287 /* Defined in doprnt.c. */
3288 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3290 extern ptrdiff_t esprintf (char *, char const *, ...)
3291 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3292 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3294 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3295 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3296 char const *, va_list)
3297 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3299 /* Defined in lread.c. */
3300 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3301 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3302 extern Lisp_Object Qlexical_binding
;
3303 extern Lisp_Object
check_obarray (Lisp_Object
);
3304 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3305 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3306 extern Lisp_Object
obhash (Lisp_Object
);
3307 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3309 LOADHIST_ATTACH (Lisp_Object x
)
3312 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3314 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3315 Lisp_Object
*, Lisp_Object
, bool);
3316 extern Lisp_Object
string_to_number (char const *, int, bool);
3317 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3319 extern void dir_warning (const char *, Lisp_Object
);
3320 extern void init_obarray (void);
3321 extern void init_lread (void);
3322 extern void syms_of_lread (void);
3325 intern (const char *str
)
3327 return intern_1 (str
, strlen (str
));
3331 intern_c_string (const char *str
)
3333 return intern_c_string_1 (str
, strlen (str
));
3336 /* Defined in eval.c. */
3337 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3338 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3339 extern Lisp_Object Qand_rest
;
3340 extern Lisp_Object Vautoload_queue
;
3341 extern Lisp_Object Vsignaling_function
;
3342 extern Lisp_Object inhibit_lisp_code
;
3343 extern struct handler
*handlerlist
;
3345 /* To run a normal hook, use the appropriate function from the list below.
3346 The calling convention:
3348 if (!NILP (Vrun_hooks))
3349 call1 (Vrun_hooks, Qmy_funny_hook);
3351 should no longer be used. */
3352 extern Lisp_Object Vrun_hooks
;
3353 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3354 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3355 Lisp_Object (*funcall
)
3356 (ptrdiff_t nargs
, Lisp_Object
*args
));
3357 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3358 extern _Noreturn
void xsignal0 (Lisp_Object
);
3359 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3360 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3361 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3363 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3364 extern Lisp_Object
eval_sub (Lisp_Object form
);
3365 extern Lisp_Object
Ffuncall (ptrdiff_t nargs
, Lisp_Object
*args
);
3366 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3367 extern Lisp_Object
call0 (Lisp_Object
);
3368 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3369 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3370 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3371 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3372 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3373 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3374 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3375 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3376 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3377 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3378 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3379 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3380 extern Lisp_Object internal_condition_case_n
3381 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3382 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3383 extern void specbind (Lisp_Object
, Lisp_Object
);
3384 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3385 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3386 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3387 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3388 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3389 extern void record_unwind_protect_int (void (*) (int), int);
3390 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3391 extern void record_unwind_protect_void (void (*) (void));
3392 extern void dynwind_begin (void);
3393 extern void dynwind_end (void);
3394 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3395 extern _Noreturn
void verror (const char *, va_list)
3396 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3397 extern void un_autoload (Lisp_Object
);
3398 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3399 extern void init_eval_once (void);
3400 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3401 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3402 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3403 extern void init_eval (void);
3404 extern void syms_of_eval (void);
3405 extern void unwind_body (Lisp_Object
);
3406 extern void record_in_backtrace (Lisp_Object function
,
3407 Lisp_Object
*args
, ptrdiff_t nargs
);
3408 extern void mark_specpdl (void);
3409 extern void get_backtrace (Lisp_Object array
);
3410 Lisp_Object
backtrace_top_function (void);
3411 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3412 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3413 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3414 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3415 extern SCM
make_prompt_tag (void);
3418 /* Defined in editfns.c. */
3419 extern Lisp_Object Qfield
;
3420 extern void insert1 (Lisp_Object
);
3421 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3422 extern Lisp_Object
save_excursion_save (void);
3423 extern Lisp_Object
save_restriction_save (void);
3424 extern void save_excursion_restore (Lisp_Object
);
3425 extern void save_restriction_restore (Lisp_Object
);
3426 extern _Noreturn
void time_overflow (void);
3427 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3428 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3430 extern void init_editfns (void);
3431 extern void syms_of_editfns (void);
3432 extern void set_time_zone_rule (const char *);
3434 /* Defined in buffer.c. */
3435 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3436 extern _Noreturn
void nsberror (Lisp_Object
);
3437 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3438 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3439 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3440 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3441 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3442 extern bool overlay_touches_p (ptrdiff_t);
3443 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3444 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3445 extern void init_buffer_once (void);
3446 extern void init_buffer (int);
3447 extern void syms_of_buffer (void);
3448 extern void keys_of_buffer (void);
3450 /* Defined in marker.c. */
3452 extern ptrdiff_t marker_position (Lisp_Object
);
3453 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3454 extern void clear_charpos_cache (struct buffer
*);
3455 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3456 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3457 extern void unchain_marker (struct Lisp_Marker
*marker
);
3458 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3459 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3460 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3461 ptrdiff_t, ptrdiff_t);
3462 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3463 extern void syms_of_marker (void);
3465 /* Defined in fileio.c. */
3467 extern Lisp_Object Qfile_error
;
3468 extern Lisp_Object Qfile_notify_error
;
3469 extern Lisp_Object Qfile_exists_p
;
3470 extern Lisp_Object Qfile_directory_p
;
3471 extern Lisp_Object Qinsert_file_contents
;
3472 extern Lisp_Object Qfile_name_history
;
3473 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3474 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3475 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3477 extern void close_file_unwind (int);
3478 extern void close_file_ptr_unwind (void *);
3479 extern void fclose_unwind (void *);
3480 extern void fclose_ptr_unwind (void *);
3481 extern void restore_point_unwind (Lisp_Object
);
3482 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3483 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3484 extern bool internal_delete_file (Lisp_Object
);
3485 extern Lisp_Object
emacs_readlinkat (int, const char *);
3486 extern bool file_directory_p (const char *);
3487 extern bool file_accessible_directory_p (const char *);
3488 extern void init_fileio (void);
3489 extern void syms_of_fileio (void);
3490 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3491 extern Lisp_Object Qdelete_file
;
3493 /* Defined in search.c. */
3494 extern void shrink_regexp_cache (void);
3495 extern void restore_search_regs (void);
3496 extern void record_unwind_save_match_data (void);
3497 struct re_registers
;
3498 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3499 struct re_registers
*,
3500 Lisp_Object
, bool, bool);
3501 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3502 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3504 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3505 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3506 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3507 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3508 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3509 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3511 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3512 ptrdiff_t, ptrdiff_t *);
3513 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3514 ptrdiff_t, ptrdiff_t *);
3515 extern void syms_of_search (void);
3516 extern void clear_regexp_cache (void);
3518 /* Defined in minibuf.c. */
3520 extern Lisp_Object Qcompletion_ignore_case
;
3521 extern Lisp_Object Vminibuffer_list
;
3522 extern Lisp_Object last_minibuf_string
;
3523 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3524 extern void init_minibuf_once (void);
3525 extern void syms_of_minibuf (void);
3527 /* Defined in callint.c. */
3529 extern Lisp_Object Qminus
, Qplus
;
3530 extern Lisp_Object Qprogn
;
3531 extern Lisp_Object Qwhen
;
3532 extern Lisp_Object Qmouse_leave_buffer_hook
;
3533 extern void syms_of_callint (void);
3535 /* Defined in casefiddle.c. */
3537 extern Lisp_Object Qidentity
;
3538 extern void syms_of_casefiddle (void);
3539 extern void keys_of_casefiddle (void);
3541 /* Defined in casetab.c. */
3543 extern void init_casetab_once (void);
3544 extern void syms_of_casetab (void);
3546 /* Defined in keyboard.c. */
3548 extern Lisp_Object echo_message_buffer
;
3549 extern struct kboard
*echo_kboard
;
3550 extern void cancel_echoing (void);
3551 extern Lisp_Object Qdisabled
, QCfilter
;
3552 extern Lisp_Object Qup
, Qdown
;
3553 extern Lisp_Object last_undo_boundary
;
3554 extern bool input_pending
;
3555 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3556 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3557 extern void discard_mouse_events (void);
3559 void handle_input_available_signal (int);
3561 extern Lisp_Object pending_funcalls
;
3562 extern bool detect_input_pending (void);
3563 extern bool detect_input_pending_ignore_squeezables (void);
3564 extern bool detect_input_pending_run_timers (bool);
3565 extern void safe_run_hooks (Lisp_Object
);
3566 extern void cmd_error_internal (Lisp_Object
, const char *);
3567 extern Lisp_Object
command_loop_1 (void);
3568 extern Lisp_Object
read_menu_command (void);
3569 extern Lisp_Object
recursive_edit_1 (void);
3570 extern void record_auto_save (void);
3571 extern void force_auto_save_soon (void);
3572 extern void init_keyboard (void);
3573 extern void syms_of_keyboard (void);
3574 extern void keys_of_keyboard (void);
3576 /* Defined in indent.c. */
3577 extern ptrdiff_t current_column (void);
3578 extern void invalidate_current_column (void);
3579 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3580 extern void syms_of_indent (void);
3582 /* Defined in frame.c. */
3583 extern Lisp_Object Qonly
, Qnone
;
3584 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3585 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3586 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3587 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3588 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3589 extern void frames_discard_buffer (Lisp_Object
);
3590 extern void syms_of_frame (void);
3592 /* Defined in emacs.c. */
3593 extern char **initial_argv
;
3594 extern int initial_argc
;
3595 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3596 extern bool display_arg
;
3598 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3599 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3600 extern Lisp_Object Qfile_name_handler_alist
;
3601 extern _Noreturn
void terminate_due_to_signal (int, int);
3602 extern Lisp_Object Qkill_emacs
;
3604 extern Lisp_Object Vlibrary_cache
;
3607 void fixup_locale (void);
3608 void synchronize_system_messages_locale (void);
3609 void synchronize_system_time_locale (void);
3611 INLINE
void fixup_locale (void) {}
3612 INLINE
void synchronize_system_messages_locale (void) {}
3613 INLINE
void synchronize_system_time_locale (void) {}
3615 extern void shut_down_emacs (int, Lisp_Object
);
3617 /* True means don't do interactive redisplay and don't change tty modes. */
3618 extern bool noninteractive
;
3620 /* True means remove site-lisp directories from load-path. */
3621 extern bool no_site_lisp
;
3623 /* Pipe used to send exit notification to the daemon parent at
3625 extern int daemon_pipe
[2];
3626 #define IS_DAEMON (daemon_pipe[1] != 0)
3628 /* True if handling a fatal error already. */
3629 extern bool fatal_error_in_progress
;
3631 /* True means don't do use window-system-specific display code. */
3632 extern bool inhibit_window_system
;
3633 /* True means that a filter or a sentinel is running. */
3634 extern bool running_asynch_code
;
3636 /* Defined in process.c. */
3637 extern Lisp_Object QCtype
, Qlocal
;
3638 extern void kill_buffer_processes (Lisp_Object
);
3639 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3640 struct Lisp_Process
*, int);
3641 /* Max value for the first argument of wait_reading_process_output. */
3642 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3643 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3644 The bug merely causes a bogus warning, but the warning is annoying. */
3645 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3647 # define WAIT_READING_MAX INTMAX_MAX
3649 extern void add_keyboard_wait_descriptor (int);
3650 extern void delete_keyboard_wait_descriptor (int);
3652 extern void add_gpm_wait_descriptor (int);
3653 extern void delete_gpm_wait_descriptor (int);
3655 extern void init_process_emacs (void);
3656 extern void syms_of_process (void);
3657 extern void setup_process_coding_systems (Lisp_Object
);
3659 /* Defined in callproc.c. */
3663 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3664 extern void init_callproc_1 (void);
3665 extern void init_callproc (void);
3666 extern void set_initial_environment (void);
3667 extern void syms_of_callproc (void);
3669 /* Defined in doc.c. */
3670 extern Lisp_Object Qfunction_documentation
;
3671 extern Lisp_Object
read_doc_string (Lisp_Object
);
3672 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3673 extern void syms_of_doc (void);
3674 extern int read_bytecode_char (bool);
3676 /* Defined in bytecode.c. */
3677 extern void syms_of_bytecode (void);
3678 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3679 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3681 /* Defined in macros.c. */
3682 extern void init_macros (void);
3683 extern void syms_of_macros (void);
3685 /* Defined in undo.c. */
3686 extern Lisp_Object Qapply
;
3687 extern Lisp_Object Qinhibit_read_only
;
3688 extern void truncate_undo_list (struct buffer
*);
3689 extern void record_insert (ptrdiff_t, ptrdiff_t);
3690 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3691 extern void record_first_change (void);
3692 extern void record_change (ptrdiff_t, ptrdiff_t);
3693 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3694 Lisp_Object
, Lisp_Object
,
3696 extern void syms_of_undo (void);
3697 /* Defined in textprop.c. */
3698 extern Lisp_Object Qmouse_face
;
3699 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3700 extern Lisp_Object Qminibuffer_prompt
;
3702 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3704 /* Defined in menu.c. */
3705 extern void syms_of_menu (void);
3707 /* Defined in xmenu.c. */
3708 extern void syms_of_xmenu (void);
3710 /* Defined in termchar.h. */
3711 struct tty_display_info
;
3713 /* Defined in termhooks.h. */
3716 /* Defined in sysdep.c. */
3717 #ifndef HAVE_GET_CURRENT_DIR_NAME
3718 extern char *get_current_dir_name (void);
3720 extern void stuff_char (char c
);
3721 extern void init_foreground_group (void);
3722 extern void sys_subshell (void);
3723 extern void sys_suspend (void);
3724 extern void discard_tty_input (void);
3725 extern void init_sys_modes (struct tty_display_info
*);
3726 extern void reset_sys_modes (struct tty_display_info
*);
3727 extern void init_all_sys_modes (void);
3728 extern void reset_all_sys_modes (void);
3729 extern void child_setup_tty (int);
3730 extern void setup_pty (int);
3731 extern int set_window_size (int, int, int);
3732 extern EMACS_INT
get_random (void);
3733 extern void seed_random (void *, ptrdiff_t);
3734 extern void init_random (void);
3735 extern void emacs_backtrace (int);
3736 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3737 extern int emacs_open (const char *, int, int);
3738 extern int emacs_pipe (int[2]);
3739 extern int emacs_close (int);
3740 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3741 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3742 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3743 extern void emacs_perror (char const *);
3745 extern void unlock_all_files (void);
3746 extern void lock_file (Lisp_Object
);
3747 extern void unlock_file (Lisp_Object
);
3748 extern void unlock_buffer (struct buffer
*);
3749 extern void syms_of_filelock (void);
3751 /* Defined in sound.c. */
3752 extern void syms_of_sound (void);
3754 /* Defined in category.c. */
3755 extern void init_category_once (void);
3756 extern Lisp_Object
char_category_set (int);
3757 extern void syms_of_category (void);
3759 /* Defined in ccl.c. */
3760 extern void syms_of_ccl (void);
3762 /* Defined in dired.c. */
3763 extern void syms_of_dired (void);
3764 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3765 Lisp_Object
, Lisp_Object
,
3768 /* Defined in term.c. */
3769 extern int *char_ins_del_vector
;
3770 extern void syms_of_term (void);
3771 extern _Noreturn
void fatal (const char *msgid
, ...)
3772 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3774 /* Defined in terminal.c. */
3775 extern void syms_of_terminal (void);
3777 /* Defined in font.c. */
3778 extern void syms_of_font (void);
3779 extern void init_font (void);
3781 #ifdef HAVE_WINDOW_SYSTEM
3782 /* Defined in fontset.c. */
3783 extern void syms_of_fontset (void);
3785 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3786 extern Lisp_Object Qfont_param
;
3789 /* Defined in gfilenotify.c */
3790 #ifdef HAVE_GFILENOTIFY
3791 extern void globals_of_gfilenotify (void);
3792 extern void syms_of_gfilenotify (void);
3795 /* Defined in inotify.c */
3797 extern void syms_of_inotify (void);
3800 #ifdef HAVE_W32NOTIFY
3801 /* Defined on w32notify.c. */
3802 extern void syms_of_w32notify (void);
3805 /* Defined in xfaces.c. */
3806 extern Lisp_Object Qdefault
, Qfringe
;
3807 extern Lisp_Object Qscroll_bar
, Qcursor
;
3808 extern Lisp_Object Qmode_line_inactive
;
3809 extern Lisp_Object Qface
;
3810 extern Lisp_Object Qnormal
;
3811 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3812 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3813 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3814 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3815 extern Lisp_Object Qoblique
, Qitalic
;
3816 extern Lisp_Object Vface_alternative_font_family_alist
;
3817 extern Lisp_Object Vface_alternative_font_registry_alist
;
3818 extern void syms_of_xfaces (void);
3820 #ifdef HAVE_X_WINDOWS
3821 /* Defined in xfns.c. */
3822 extern void syms_of_xfns (void);
3824 /* Defined in xsmfns.c. */
3825 extern void syms_of_xsmfns (void);
3827 /* Defined in xselect.c. */
3828 extern void syms_of_xselect (void);
3830 /* Defined in xterm.c. */
3831 extern void syms_of_xterm (void);
3832 #endif /* HAVE_X_WINDOWS */
3834 #ifdef HAVE_WINDOW_SYSTEM
3835 /* Defined in xterm.c, nsterm.m, w32term.c. */
3836 extern char *x_get_keysym_name (int);
3837 #endif /* HAVE_WINDOW_SYSTEM */
3840 /* Defined in xml.c. */
3841 extern void syms_of_xml (void);
3842 extern void xml_cleanup_parser (void);
3846 /* Defined in decompress.c. */
3847 extern void syms_of_decompress (void);
3851 /* Defined in dbusbind.c. */
3852 void syms_of_dbusbind (void);
3856 /* Defined in profiler.c. */
3857 extern bool profiler_memory_running
;
3858 extern void malloc_probe (size_t);
3859 extern void syms_of_profiler (void);
3863 /* Defined in msdos.c, w32.c. */
3864 extern char *emacs_root_dir (void);
3867 /* True means ^G can quit instantly. */
3868 extern bool immediate_quit
;
3870 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3871 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3872 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3873 extern void xfree (void *);
3874 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3875 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3876 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3877 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3878 ATTRIBUTE_ALLOC_SIZE ((2,3));
3879 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3880 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3881 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3882 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3883 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3885 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3886 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3887 extern void dupstring (char **, char const *);
3888 extern void xputenv (const char *);
3890 extern char *egetenv (const char *);
3892 /* Copy Lisp string to temporary (allocated on stack) C string. */
3894 #define xlispstrdupa(string) \
3895 memcpy (alloca (SBYTES (string) + 1), \
3896 SSDATA (string), SBYTES (string) + 1)
3898 /* Set up the name of the machine we're running on. */
3899 extern void init_system_name (void);
3901 /* Return the absolute value of X. X should be a signed integer
3902 expression without side effects, and X's absolute value should not
3903 exceed the maximum for its promoted type. This is called 'eabs'
3904 because 'abs' is reserved by the C standard. */
3905 #define eabs(x) ((x) < 0 ? -(x) : (x))
3907 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3910 #define make_fixnum_or_float(val) \
3911 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3913 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3914 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3916 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3918 #define USE_SAFE_ALLOCA ((void) 0)
3920 /* SAFE_ALLOCA allocates a simple buffer. */
3922 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3926 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3927 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3928 positive. The code is tuned for MULTIPLIER being a constant. */
3930 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3932 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3933 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3935 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3938 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3940 #define SAFE_FREE() ((void) 0)
3942 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3944 #define SAFE_ALLOCA_LISP(buf, nelt) \
3946 if ((nelt) < MAX_ALLOCA / word_size) \
3947 (buf) = alloca ((nelt) * word_size); \
3948 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3949 buf = xmalloc ((nelt) * word_size); \
3951 memory_full (SIZE_MAX); \
3954 /* Loop over all tails of a list, checking for cycles.
3955 FIXME: Make tortoise and n internal declarations.
3956 FIXME: Unroll the loop body so we don't need `n'. */
3957 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3958 for ((tortoise) = (hare) = (list), (n) = true; \
3960 (hare = XCDR (hare), (n) = !(n), \
3962 ? (EQ (hare, tortoise) \
3963 ? xsignal1 (Qcircular_list, list) \
3965 /* Move tortoise before the next iteration, in case */ \
3966 /* the next iteration does an Fsetcdr. */ \
3967 : (void) ((tortoise) = XCDR (tortoise)))))
3969 /* Do a `for' loop over alist values. */
3971 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3972 for ((list_var) = (head_var); \
3973 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
3974 (list_var) = XCDR (list_var))
3976 /* Check whether it's time for GC, and run it if so. */
3985 functionp (Lisp_Object object
)
3987 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3989 object
= Findirect_function (object
, Qt
);
3991 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
3993 /* Autoloaded symbols are functions, except if they load
3994 macros or keymaps. */
3996 for (i
= 0; i
< 4 && CONSP (object
); i
++)
3997 object
= XCDR (object
);
3999 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4004 return XSUBR (object
)->max_args
!= UNEVALLED
;
4005 else if (COMPILEDP (object
))
4007 else if (CONSP (object
))
4009 Lisp_Object car
= XCAR (object
);
4010 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4017 #endif /* EMACS_LISP_H */