1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
39 #define ID_val (some integer preprocessor expression)
41 DEFINE_GDB_SYMBOL_ENUM (ID)
43 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
45 DEFINE_GDB_SYMBOL_END (ID)
48 This hack is for the benefit of compilers that do not make macro
49 definitions visible to the debugger. It's used for symbols that
50 .gdbinit needs, symbols whose values may not fit in 'int' (where an
53 Some GCC versions before GCC 4.2 omit enums in debugging output;
54 see GCC bug 23336. So don't use enums with older GCC. */
56 #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__)
57 # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX)
59 # define ENUMABLE(val) 0
62 #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val };
63 #if defined MAIN_PROGRAM
64 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE
65 # define DEFINE_GDB_SYMBOL_END(id) = id;
67 # define DEFINE_GDB_SYMBOL_BEGIN(type, id)
68 # define DEFINE_GDB_SYMBOL_END(val)
71 /* The ubiquitous max and min macros. */
74 #define max(a, b) ((a) > (b) ? (a) : (b))
75 #define min(a, b) ((a) < (b) ? (a) : (b))
77 /* Number of elements in an array. */
78 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
80 /* Number of bits in a Lisp_Object tag. */
81 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
83 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
85 /* The number of bits needed in an EMACS_INT over and above the number
86 of bits in a pointer. This is 0 on systems where:
87 1. We can specify multiple-of-8 alignment on static variables.
88 2. We know malloc returns a multiple of 8. */
89 #if (defined alignas \
90 && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
91 || defined DARWIN_OS || defined __sun || defined __MINGW32__))
92 # define NONPOINTER_BITS 0
94 # define NONPOINTER_BITS GCTYPEBITS
97 /* EMACS_INT - signed integer wide enough to hold an Emacs value
98 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
99 pI - printf length modifier for EMACS_INT
100 EMACS_UINT - unsigned variant of EMACS_INT */
102 typedef scm_t_signed_bits EMACS_INT
;
103 typedef scm_t_bits EMACS_UINT
;
104 #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX
106 #if INTPTR_MAX == INT_MAX
108 #elif INTPTR_MAX == LONG_MAX
110 #elif INTPTR_MAX == LLONG_MAX
112 #elif INTPTR_MAX == INTMAX_MAX
115 #error "Cannot determine length modifier for EMACS_INT"
118 /* Number of bits to put in each character in the internal representation
119 of bool vectors. This should not vary across implementations. */
120 enum { BOOL_VECTOR_BITS_PER_CHAR
=
121 #define BOOL_VECTOR_BITS_PER_CHAR 8
122 BOOL_VECTOR_BITS_PER_CHAR
125 /* An unsigned integer type representing a fixed-length bit sequence,
126 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
127 for speed, but it is unsigned char on weird platforms. */
128 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
129 typedef size_t bits_word
;
130 # define BITS_WORD_MAX SIZE_MAX
131 enum { BITS_PER_BITS_WORD
= CHAR_BIT
* sizeof (bits_word
) };
133 typedef unsigned char bits_word
;
134 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
135 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
137 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
139 /* Number of bits in some machine integer types. */
142 BITS_PER_CHAR
= CHAR_BIT
,
143 BITS_PER_SHORT
= CHAR_BIT
* sizeof (short),
144 BITS_PER_LONG
= CHAR_BIT
* sizeof (long int),
145 BITS_PER_EMACS_INT
= CHAR_BIT
* sizeof (EMACS_INT
)
148 /* printmax_t and uprintmax_t are types for printing large integers.
149 These are the widest integers that are supported for printing.
150 pMd etc. are conversions for printing them.
151 On C99 hosts, there's no problem, as even the widest integers work.
152 Fall back on EMACS_INT on pre-C99 hosts. */
154 typedef intmax_t printmax_t
;
155 typedef uintmax_t uprintmax_t
;
159 typedef EMACS_INT printmax_t
;
160 typedef EMACS_UINT uprintmax_t
;
165 /* Use pD to format ptrdiff_t values, which suffice for indexes into
166 buffers and strings. Emacs never allocates objects larger than
167 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
168 In C99, pD can always be "t"; configure it here for the sake of
169 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
170 #if PTRDIFF_MAX == INT_MAX
172 #elif PTRDIFF_MAX == LONG_MAX
174 #elif PTRDIFF_MAX == LLONG_MAX
180 /* Extra internal type checking? */
182 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
183 'assume (COND)'. COND should be free of side effects, as it may or
184 may not be evaluated.
186 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
187 defined and suppress_checking is false, and does nothing otherwise.
188 Emacs dies if COND is checked and is false. The suppress_checking
189 variable is initialized to 0 in alloc.c. Set it to 1 using a
190 debugger to temporarily disable aborting on detected internal
191 inconsistencies or error conditions.
193 In some cases, a good compiler may be able to optimize away the
194 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
195 uses eassert to test STRINGP (x), but a particular use of XSTRING
196 is invoked only after testing that STRINGP (x) is true, making the
199 eassume is like eassert except that it also causes the compiler to
200 assume that COND is true afterwards, regardless of whether runtime
201 checking is enabled. This can improve performance in some cases,
202 though it can degrade performance in others. It's often suboptimal
203 for COND to call external functions or access volatile storage. */
205 #ifndef ENABLE_CHECKING
206 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
207 # define eassume(cond) assume (cond)
208 #else /* ENABLE_CHECKING */
210 extern _Noreturn
void die (const char *, const char *, int);
212 extern bool suppress_checking EXTERNALLY_VISIBLE
;
214 # define eassert(cond) \
215 (suppress_checking || (cond) \
217 : die (# cond, __FILE__, __LINE__))
218 # define eassume(cond) \
223 : die (# cond, __FILE__, __LINE__))
224 #endif /* ENABLE_CHECKING */
229 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
230 integer constant, for MSVC. */
231 #define GCALIGNMENT 8
233 /* Number of bits in a Lisp fixnum value, not counting the tag. */
234 FIXNUM_BITS
= SCM_I_FIXNUM_BIT
237 #if GCALIGNMENT != 1 << GCTYPEBITS
238 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
241 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
242 #define USE_LSB_TAG 1
243 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
246 # define alignas(alignment) /* empty */
248 # error "USE_LSB_TAG requires alignas"
252 /* Some operations are so commonly executed that they are implemented
253 as macros, not functions, because otherwise runtime performance would
254 suffer too much when compiling with GCC without optimization.
255 There's no need to inline everything, just the operations that
256 would otherwise cause a serious performance problem.
258 For each such operation OP, define a macro lisp_h_OP that contains
259 the operation's implementation. That way, OP can be implemented
260 via a macro definition like this:
262 #define OP(x) lisp_h_OP (x)
264 and/or via a function definition like this:
266 LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x))
268 which macro-expands to this:
270 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
272 without worrying about the implementations diverging, since
273 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
274 are intended to be private to this include file, and should not be
277 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
278 functions, once most developers have access to GCC 4.8 or later and
279 can use "gcc -Og" to debug. Maybe in the year 2016. See
282 Commentary for these macros can be found near their corresponding
285 #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a))
286 #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x))
287 #define lisp_h_XLI(o) (SCM_UNPACK (o))
288 #define lisp_h_XIL(i) (SCM_PACK (i))
289 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
290 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
291 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
292 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
293 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
294 #define lisp_h_CONSP(x) (x && scm_is_pair (x))
295 #define lisp_h_EQ(x, y) (scm_is_eq (x, y))
296 #define lisp_h_FLOATP(x) (x && SCM_INEXACTP (x))
297 #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x))
298 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
299 #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag))
300 #define lisp_h_NILP(x) (scm_is_lisp_false (x))
301 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
302 (eassert (SYMBOL_REDIRECT (sym) == SYMBOL_PLAINVAL), \
303 scm_c_vector_set_x (sym, 4, v))
304 #define lisp_h_SYMBOL_CONSTANT_P(sym) (SYMBOL_CONSTANT (XSYMBOL (sym)))
305 #define lisp_h_SYMBOL_VAL(sym) \
306 (eassert (SYMBOL_REDIRECT (sym) == SYMBOL_PLAINVAL), \
307 scm_c_vector_ref (sym, 4))
308 #define lisp_h_SYMBOLP(x) \
309 (x && (scm_is_symbol (x) || EQ (x, Qnil) || EQ (x, Qt)))
310 #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag))
311 #define lisp_h_XCAR(c) (scm_car (c))
312 #define lisp_h_XCDR(c) (scm_cdr (c))
313 #define lisp_h_XHASH(a) (SCM_UNPACK (a))
315 /* Define NAME as a lisp.h inline function that returns TYPE and has
316 arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and
317 ARGS should be parenthesized. Implement the function by calling
319 #define LISP_MACRO_DEFUN(name, type, argdecls, args) \
320 INLINE type (name) argdecls { return lisp_h_##name args; }
322 /* like LISP_MACRO_DEFUN, except NAME returns void. */
323 #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \
324 INLINE void (name) argdecls { lisp_h_##name args; }
327 /* Define the fundamental Lisp data structures. */
329 /* This is the set of Lisp data types. If you want to define a new
330 data type, read the comments after Lisp_Fwd_Type definition
333 #define INTMASK SCM_MOST_POSITIVE_FIXNUM
334 #define case_Lisp_Int case Lisp_Int
336 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
337 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
338 vociferously about them. */
339 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
340 || (defined __SUNPRO_C && __STDC__))
341 #define ENUM_BF(TYPE) unsigned int
343 #define ENUM_BF(TYPE) enum TYPE
346 scm_t_bits lisp_misc_tag
;
347 scm_t_bits lisp_string_tag
;
348 scm_t_bits lisp_vectorlike_tag
;
354 /* Integer. XINT (obj) is the integer value. */
357 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
360 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
361 whose first member indicates the subtype. */
364 /* String. XSTRING (object) points to a struct Lisp_String.
365 The length of the string, and its contents, are stored therein. */
368 /* Vector of Lisp objects, or something resembling it.
369 XVECTOR (object) points to a struct Lisp_Vector, which contains
370 the size and contents. The size field also contains the type
371 information, if it's not a real vector object. */
374 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
380 /* This is the set of data types that share a common structure.
381 The first member of the structure is a type code from this set.
382 The enum values are arbitrary, but we'll use large numbers to make it
383 more likely that we'll spot the error if a random word in memory is
384 mistakenly interpreted as a Lisp_Misc. */
387 Lisp_Misc_Free
= 0x5eab,
390 Lisp_Misc_Save_Value
,
391 /* Currently floats are not a misc type,
392 but let's define this in case we want to change that. */
394 /* This is not a type code. It is for range checking. */
398 /* These are the types of forwarding objects used in the value slot
399 of symbols for special built-in variables whose value is stored in
403 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
404 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
405 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
406 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
407 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
410 typedef SCM Lisp_Object
;
412 #define LISP_INITIALLY_ZERO SCM_INUM0
414 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
415 At the machine level, these operations are no-ops. */
416 LISP_MACRO_DEFUN (XLI
, EMACS_INT
, (Lisp_Object o
), (o
))
417 LISP_MACRO_DEFUN (XIL
, Lisp_Object
, (EMACS_INT i
), (i
))
419 /* In the size word of a struct Lisp_Vector, this bit means it's really
420 some other vector-like object. */
421 #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2)
422 #if ENUMABLE (PSEUDOVECTOR_FLAG_val)
423 DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG
)
425 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
426 # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val
427 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
430 /* In a pseudovector, the size field actually contains a word with one
431 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
432 with PVEC_TYPE_MASK to indicate the actual type. */
444 PVEC_WINDOW_CONFIGURATION
,
446 /* These should be last, check internal_equal to see why. */
450 PVEC_FONT
/* Should be last because it's used for range checking. */
455 /* For convenience, we also store the number of elements in these bits.
456 Note that this size is not necessarily the memory-footprint size, but
457 only the number of Lisp_Object fields (that need to be traced by GC).
458 The distinction is used, e.g., by Lisp_Process, which places extra
459 non-Lisp_Object fields at the end of the structure. */
460 PSEUDOVECTOR_SIZE_BITS
= 12,
461 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
463 /* To calculate the memory footprint of the pseudovector, it's useful
464 to store the size of non-Lisp area in word_size units here. */
465 PSEUDOVECTOR_REST_BITS
= 12,
466 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
467 << PSEUDOVECTOR_SIZE_BITS
),
469 /* Used to extract pseudovector subtype information. */
470 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
471 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
474 /* These functions extract various sorts of values from a Lisp_Object.
475 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
476 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
479 /* Largest and smallest representable fixnum values. These are the C
480 values. They are macros for use in static initializers. */
481 #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM
482 #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM
484 /* Make a Lisp integer representing the value of the low order
487 make_number (EMACS_INT n
)
489 return SCM_I_MAKINUM (n
);
492 /* Extract A's value as a signed integer. */
496 return SCM_I_INUM (a
);
499 /* Like XINT (A), but may be faster. A must be nonnegative.
500 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
501 integers have zero-bits in their tags. */
503 XFASTINT (Lisp_Object a
)
505 EMACS_INT n
= XINT (a
);
510 /* Extract A's value as an unsigned integer. */
512 XUINT (Lisp_Object a
)
514 return SCM_I_INUM (a
);
517 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
518 right now, but XUINT should only be applied to objects we know are
520 LISP_MACRO_DEFUN (XHASH
, EMACS_INT
, (Lisp_Object a
), (a
))
522 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
524 make_natnum (EMACS_INT n
)
526 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
527 return make_number (n
);
530 /* Return true if X and Y are the same object. */
531 LISP_MACRO_DEFUN (EQ
, bool, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
533 /* Value is true if I doesn't fit into a Lisp fixnum. It is
534 written this way so that it also works if I is of unsigned
535 type or if I is a NaN. */
537 #define FIXNUM_OVERFLOW_P(i) \
538 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
541 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
543 return num
< lower
? lower
: num
<= upper
? num
: upper
;
546 /* Forward declarations. */
548 /* Defined in this file. */
550 INLINE
bool BOOL_VECTOR_P (Lisp_Object
);
551 INLINE
bool BUFFER_OBJFWDP (union Lisp_Fwd
*);
552 INLINE
bool BUFFERP (Lisp_Object
);
553 INLINE
bool CHAR_TABLE_P (Lisp_Object
);
554 INLINE Lisp_Object
CHAR_TABLE_REF_ASCII (Lisp_Object
, ptrdiff_t);
555 INLINE
bool (CONSP
) (Lisp_Object
);
556 INLINE
bool (FLOATP
) (Lisp_Object
);
557 INLINE
bool functionp (Lisp_Object
);
558 INLINE
bool (INTEGERP
) (Lisp_Object
);
559 INLINE
bool (MARKERP
) (Lisp_Object
);
560 INLINE
bool (MISCP
) (Lisp_Object
);
561 INLINE
bool (NILP
) (Lisp_Object
);
562 INLINE
bool OVERLAYP (Lisp_Object
);
563 INLINE
bool PROCESSP (Lisp_Object
);
564 INLINE
bool PSEUDOVECTORP (Lisp_Object
, int);
565 INLINE
bool SAVE_VALUEP (Lisp_Object
);
566 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
568 INLINE
bool STRINGP (Lisp_Object
);
569 INLINE
bool SUB_CHAR_TABLE_P (Lisp_Object
);
570 INLINE
bool (SYMBOLP
) (Lisp_Object
);
571 INLINE
bool (VECTORLIKEP
) (Lisp_Object
);
572 INLINE
bool WINDOWP (Lisp_Object
);
573 INLINE
struct Lisp_Save_Value
*XSAVE_VALUE (Lisp_Object
);
575 /* Defined in chartab.c. */
576 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
577 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
578 extern int char_table_translate (Lisp_Object
, int);
580 /* Defined in data.c. */
581 extern Lisp_Object Qarrayp
, Qbufferp
, Qbuffer_or_string_p
, Qchar_table_p
;
582 extern Lisp_Object Qconsp
, Qfloatp
, Qintegerp
, Qlambda
, Qlistp
, Qmarkerp
, Qnil
;
583 extern Lisp_Object Qnumberp
, Qstringp
, Qsymbolp
, Qt
, Qvectorp
;
584 extern Lisp_Object Qbool_vector_p
;
585 extern Lisp_Object Qvector_or_char_table_p
, Qwholenump
;
586 extern Lisp_Object Qwindow
;
587 extern _Noreturn Lisp_Object
wrong_type_argument (Lisp_Object
, Lisp_Object
);
589 /* Defined in emacs.c. */
590 extern bool might_dump
;
591 /* True means Emacs has already been initialized.
592 Used during startup to detect startup of dumped Emacs. */
593 extern bool initialized
;
595 /* Defined in eval.c. */
596 extern Lisp_Object Qautoload
;
598 /* Defined in floatfns.c. */
599 extern double extract_float (Lisp_Object
);
601 /* Defined in process.c. */
602 extern Lisp_Object Qprocessp
;
604 /* Defined in window.c. */
605 extern Lisp_Object Qwindowp
;
607 /* Defined in xdisp.c. */
608 extern Lisp_Object Qimage
;
610 /* Extract A's type. */
611 INLINE
enum Lisp_Type
612 XTYPE (Lisp_Object o
)
616 else if (SYMBOLP (o
))
620 else if (STRINGP (o
))
622 else if (VECTORLIKEP (o
))
623 return Lisp_Vectorlike
;
632 /* Extract a value or address from a Lisp_Object. */
634 INLINE
struct Lisp_Vector
*
635 XVECTOR (Lisp_Object a
)
637 eassert (VECTORLIKEP (a
));
641 INLINE
struct Lisp_String
*
642 XSTRING (Lisp_Object a
)
644 eassert (STRINGP (a
));
648 extern void initialize_symbol (Lisp_Object
, Lisp_Object
);
649 INLINE Lisp_Object
build_string (const char *);
650 extern Lisp_Object symbol_module
;
651 extern Lisp_Object function_module
;
652 extern Lisp_Object plist_module
;
653 extern Lisp_Object Qt
, Qnil
, Qt_
, Qnil_
;
655 typedef Lisp_Object sym_t
;
658 XSYMBOL (Lisp_Object a
)
661 if (EQ (a
, Qt
)) a
= Qt_
;
662 if (EQ (a
, Qnil
)) a
= Qnil_
;
663 eassert (SYMBOLP (a
));
664 tem
= scm_variable_ref (scm_module_lookup (symbol_module
, a
));
668 /* Pseudovector types. */
670 INLINE
struct Lisp_Process
*
671 XPROCESS (Lisp_Object a
)
673 eassert (PROCESSP (a
));
677 INLINE
struct window
*
678 XWINDOW (Lisp_Object a
)
680 eassert (WINDOWP (a
));
684 INLINE
struct terminal
*
685 XTERMINAL (Lisp_Object a
)
690 INLINE
struct buffer
*
691 XBUFFER (Lisp_Object a
)
693 eassert (BUFFERP (a
));
697 INLINE
struct Lisp_Char_Table
*
698 XCHAR_TABLE (Lisp_Object a
)
700 eassert (CHAR_TABLE_P (a
));
704 INLINE
struct Lisp_Sub_Char_Table
*
705 XSUB_CHAR_TABLE (Lisp_Object a
)
707 eassert (SUB_CHAR_TABLE_P (a
));
711 INLINE
struct Lisp_Bool_Vector
*
712 XBOOL_VECTOR (Lisp_Object a
)
714 eassert (BOOL_VECTOR_P (a
));
719 make_lisp_proc (struct Lisp_Process
*p
)
721 return scm_new_smob (lisp_vectorlike_tag
, (scm_t_bits
) p
);
724 #define XSETINT(a, b) ((a) = make_number (b))
725 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
726 #define XSETVECTOR(a, b) ((a) = (b)->header.self)
727 #define XSETSTRING(a, b) ((a) = (b)->self)
728 #define XSETSYMBOL(a, b) ((a) = scm_c_vector_ref (b, 0))
729 #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self
731 /* Pseudovector types. */
733 #define XSETPVECTYPE(v, code) \
734 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
735 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
736 ((v)->header.size = (PSEUDOVECTOR_FLAG \
737 | ((code) << PSEUDOVECTOR_AREA_BITS) \
738 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
741 /* The cast to struct vectorlike_header * avoids aliasing issues. */
742 #define XSETPSEUDOVECTOR(a, b, code) \
743 XSETTYPED_PSEUDOVECTOR (a, b, \
744 (((struct vectorlike_header *) \
748 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
749 (XSETVECTOR (a, b), \
750 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
751 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
753 #define XSETWINDOW_CONFIGURATION(a, b) \
754 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
755 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
756 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
757 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
758 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
759 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
760 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
761 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
762 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
763 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
767 LISP_MACRO_DEFUN_VOID (CHECK_TYPE
,
768 (int ok
, Lisp_Object predicate
, Lisp_Object x
),
771 /* Deprecated and will be removed soon. */
773 #define INTERNAL_FIELD(field) field ## _
775 /* See the macros in intervals.h. */
777 typedef struct interval
*INTERVAL
;
779 LISP_MACRO_DEFUN (XCAR
, Lisp_Object
, (Lisp_Object c
), (c
))
780 LISP_MACRO_DEFUN (XCDR
, Lisp_Object
, (Lisp_Object c
), (c
))
782 /* Use these to set the fields of a cons cell.
784 Note that both arguments may refer to the same object, so 'n'
785 should not be read after 'c' is first modified. */
787 XSETCAR (Lisp_Object c
, Lisp_Object n
)
789 scm_set_car_x (c
, n
);
792 XSETCDR (Lisp_Object c
, Lisp_Object n
)
794 scm_set_cdr_x (c
, n
);
797 /* Take the car or cdr of something whose type is not known. */
801 return (CONSP (c
) ? XCAR (c
)
803 : wrong_type_argument (Qlistp
, c
));
808 return (CONSP (c
) ? XCDR (c
)
810 : wrong_type_argument (Qlistp
, c
));
813 /* Take the car or cdr of something whose type is not known. */
815 CAR_SAFE (Lisp_Object c
)
817 return CONSP (c
) ? XCAR (c
) : Qnil
;
820 CDR_SAFE (Lisp_Object c
)
822 return CONSP (c
) ? XCDR (c
) : Qnil
;
825 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
832 INTERVAL intervals
; /* Text properties in this string. */
836 /* True if STR is a multibyte string. */
838 STRING_MULTIBYTE (Lisp_Object str
)
840 return 0 <= XSTRING (str
)->size_byte
;
843 /* An upper bound on the number of bytes in a Lisp string, not
844 counting the terminating null. This a tight enough bound to
845 prevent integer overflow errors that would otherwise occur during
846 string size calculations. A string cannot contain more bytes than
847 a fixnum can represent, nor can it be so long that C pointer
848 arithmetic stops working on the string plus its terminating null.
849 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
850 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
851 would expose alloc.c internal details that we'd rather keep
854 This is a macro for use in static initializers. The cast to
855 ptrdiff_t ensures that the macro is signed. */
856 #define STRING_BYTES_BOUND \
857 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
859 /* Mark STR as a unibyte string. */
860 #define STRING_SET_UNIBYTE(STR) \
862 if (EQ (STR, empty_multibyte_string)) \
863 (STR) = empty_unibyte_string; \
865 XSTRING (STR)->size_byte = -1; \
868 /* Mark STR as a multibyte string. Assure that STR contains only
869 ASCII characters in advance. */
870 #define STRING_SET_MULTIBYTE(STR) \
872 if (EQ (STR, empty_unibyte_string)) \
873 (STR) = empty_multibyte_string; \
875 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
878 /* Convenience functions for dealing with Lisp strings. */
880 INLINE
unsigned char *
881 SDATA (Lisp_Object string
)
883 return XSTRING (string
)->data
;
886 SSDATA (Lisp_Object string
)
888 /* Avoid "differ in sign" warnings. */
889 return (char *) SDATA (string
);
892 SREF (Lisp_Object string
, ptrdiff_t index
)
894 return SDATA (string
)[index
];
897 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
899 SDATA (string
)[index
] = new;
902 SCHARS (Lisp_Object string
)
904 return XSTRING (string
)->size
;
908 STRING_BYTES (struct Lisp_String
*s
)
910 return s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
914 SBYTES (Lisp_Object string
)
916 return STRING_BYTES (XSTRING (string
));
919 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
921 XSTRING (string
)->size
= newsize
;
924 /* Header of vector-like objects. This documents the layout constraints on
925 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
926 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
927 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
928 because when two such pointers potentially alias, a compiler won't
929 incorrectly reorder loads and stores to their size fields. See
931 struct vectorlike_header
935 /* This field contains various pieces of information:
936 - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
937 vector (0) or a pseudovector (1).
938 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
939 of slots) of the vector.
940 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
941 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
942 - b) number of Lisp_Objects slots at the beginning of the object
943 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
945 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
946 measured in word_size units. Rest fields may also include
947 Lisp_Objects, but these objects usually needs some special treatment
949 There are some exceptions. For PVEC_FREE, b) is always zero. For
950 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
951 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
952 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
956 /* A regular vector is just a header plus an array of Lisp_Objects. */
960 struct vectorlike_header header
;
961 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
964 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
967 ALIGNOF_STRUCT_LISP_VECTOR
968 = alignof (union { struct vectorlike_header a
; Lisp_Object b
; })
971 /* A boolvector is a kind of vectorlike, with contents like a string. */
973 struct Lisp_Bool_Vector
975 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
976 just the subtype information. */
977 struct vectorlike_header header
;
978 /* This is the size in bits. */
980 /* The actual bits, packed into bytes.
981 Zeros fill out the last word if needed.
982 The bits are in little-endian order in the bytes, and
983 the bytes are in little-endian order in the words. */
984 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
988 bool_vector_size (Lisp_Object a
)
990 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
996 bool_vector_data (Lisp_Object a
)
998 return XBOOL_VECTOR (a
)->data
;
1001 INLINE
unsigned char *
1002 bool_vector_uchar_data (Lisp_Object a
)
1004 return (unsigned char *) bool_vector_data (a
);
1007 /* The number of data words and bytes in a bool vector with SIZE bits. */
1010 bool_vector_words (EMACS_INT size
)
1012 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1013 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1017 bool_vector_bytes (EMACS_INT size
)
1019 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1020 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1023 /* True if A's Ith bit is set. */
1026 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1028 eassume (0 <= i
&& i
< bool_vector_size (a
));
1029 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1030 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1034 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1036 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1039 /* Set A's Ith bit to B. */
1042 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1044 unsigned char *addr
;
1046 eassume (0 <= i
&& i
< bool_vector_size (a
));
1047 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1050 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1052 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1055 /* Some handy constants for calculating sizes
1056 and offsets, mostly of vectorlike objects. */
1060 header_size
= offsetof (struct Lisp_Vector
, contents
),
1061 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1062 word_size
= sizeof (Lisp_Object
)
1065 /* Conveniences for dealing with Lisp arrays. */
1068 AREF (Lisp_Object array
, ptrdiff_t idx
)
1070 return XVECTOR (array
)->contents
[idx
];
1073 INLINE Lisp_Object
*
1074 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1076 return & XVECTOR (array
)->contents
[idx
];
1080 ASIZE (Lisp_Object array
)
1082 return XVECTOR (array
)->header
.size
;
1086 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1088 eassert (0 <= idx
&& idx
< ASIZE (array
));
1089 XVECTOR (array
)->contents
[idx
] = val
;
1093 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1095 /* Like ASET, but also can be used in the garbage collector:
1096 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1097 eassert (0 <= idx
&& idx
< (ASIZE (array
)));
1098 XVECTOR (array
)->contents
[idx
] = val
;
1101 /* If a struct is made to look like a vector, this macro returns the length
1102 of the shortest vector that would hold that struct. */
1104 #define VECSIZE(type) \
1105 ((sizeof (type) - header_size + word_size - 1) / word_size)
1107 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1108 at the end and we need to compute the number of Lisp_Object fields (the
1109 ones that the GC needs to trace). */
1111 #define PSEUDOVECSIZE(type, nonlispfield) \
1112 ((offsetof (type, nonlispfield) - header_size) / word_size)
1114 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1115 should be integer expressions. This is not the same as
1116 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1117 returns true. For efficiency, prefer plain unsigned comparison if A
1118 and B's sizes both fit (after integer promotion). */
1119 #define UNSIGNED_CMP(a, op, b) \
1120 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1121 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1122 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1124 /* True iff C is an ASCII character. */
1125 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1127 /* A char-table is a kind of vectorlike, with contents are like a
1128 vector but with a few other slots. For some purposes, it makes
1129 sense to handle a char-table with type struct Lisp_Vector. An
1130 element of a char table can be any Lisp objects, but if it is a sub
1131 char-table, we treat it a table that contains information of a
1132 specific range of characters. A sub char-table has the same
1133 structure as a vector. A sub char table appears only in an element
1134 of a char-table, and there's no way to access it directly from
1135 Emacs Lisp program. */
1137 enum CHARTAB_SIZE_BITS
1139 CHARTAB_SIZE_BITS_0
= 6,
1140 CHARTAB_SIZE_BITS_1
= 4,
1141 CHARTAB_SIZE_BITS_2
= 5,
1142 CHARTAB_SIZE_BITS_3
= 7
1145 extern const int chartab_size
[4];
1147 struct Lisp_Char_Table
1149 /* HEADER.SIZE is the vector's size field, which also holds the
1150 pseudovector type information. It holds the size, too.
1151 The size counts the defalt, parent, purpose, ascii,
1152 contents, and extras slots. */
1153 struct vectorlike_header header
;
1155 /* This holds a default value,
1156 which is used whenever the value for a specific character is nil. */
1159 /* This points to another char table, which we inherit from when the
1160 value for a specific character is nil. The `defalt' slot takes
1161 precedence over this. */
1164 /* This is a symbol which says what kind of use this char-table is
1166 Lisp_Object purpose
;
1168 /* The bottom sub char-table for characters of the range 0..127. It
1169 is nil if none of ASCII character has a specific value. */
1172 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1174 /* These hold additional data. It is a vector. */
1175 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1178 struct Lisp_Sub_Char_Table
1180 /* HEADER.SIZE is the vector's size field, which also holds the
1181 pseudovector type information. It holds the size, too. */
1182 struct vectorlike_header header
;
1184 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1185 char-table of depth 1 contains 16 elements, and each element
1186 covers 4096 (128*32) characters. A sub char-table of depth 2
1187 contains 32 elements, and each element covers 128 characters. A
1188 sub char-table of depth 3 contains 128 elements, and each element
1189 is for one character. */
1192 /* Minimum character covered by the sub char-table. */
1193 Lisp_Object min_char
;
1195 /* Use set_sub_char_table_contents to set this. */
1196 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1200 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1202 struct Lisp_Char_Table
*tbl
= NULL
;
1206 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1207 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1208 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1212 while (NILP (val
) && ! NILP (tbl
->parent
));
1217 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1218 characters. Do not check validity of CT. */
1220 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1222 return (ASCII_CHAR_P (idx
)
1223 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1224 : char_table_ref (ct
, idx
));
1227 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1228 8-bit European characters. Do not check validity of CT. */
1230 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1232 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1233 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1235 char_table_set (ct
, idx
, val
);
1238 /* This is the number of slots that every char table must have. This
1239 counts the ordinary slots and the top, defalt, parent, and purpose
1241 enum CHAR_TABLE_STANDARD_SLOTS
1243 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
)
1246 /* Return the number of "extra" slots in the char table CT. */
1249 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1251 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1252 - CHAR_TABLE_STANDARD_SLOTS
);
1256 /***********************************************************************
1258 ***********************************************************************/
1260 enum symbol_redirect
1262 SYMBOL_PLAINVAL
= 4,
1263 SYMBOL_VARALIAS
= 1,
1264 SYMBOL_LOCALIZED
= 2,
1265 SYMBOL_FORWARDED
= 3
1272 /* Indicates where the value can be found:
1273 0 : it's a plain var, the value is in the `value' field.
1274 1 : it's a varalias, the value is really in the `alias' symbol.
1275 2 : it's a localized var, the value is in the `blv' object.
1276 3 : it's a forwarding variable, the value is in `forward'. */
1277 ENUM_BF (symbol_redirect
) redirect_
: 3;
1279 /* Non-zero means symbol is constant, i.e. changing its value
1280 should signal an error. If the value is 3, then the var
1281 can be changed, but only by `defconst'. */
1282 unsigned constant_
: 2;
1284 /* True means that this variable has been explicitly declared
1285 special (with `defvar' etc), and shouldn't be lexically bound. */
1286 bool_bf declared_special_
: 1;
1288 /* Value of the symbol or Qunbound if unbound. Which alternative of the
1289 union is used depends on the `redirect' field above. */
1293 struct Lisp_Buffer_Local_Value
*blv_
;
1294 union Lisp_Fwd
*fwd_
;
1298 #define SYMBOL_SELF(sym) (scm_c_vector_ref (sym, 0))
1299 #define SET_SYMBOL_SELF(sym, v) (scm_c_vector_set_x (sym, 0, v))
1300 #define SYMBOL_REDIRECT(sym) (XINT (scm_c_vector_ref (sym, 1)))
1301 #define SET_SYMBOL_REDIRECT(sym, v) (scm_c_vector_set_x (sym, 1, make_number (v)))
1302 #define SYMBOL_CONSTANT(sym) (XINT (scm_c_vector_ref (sym, 2)))
1303 #define SET_SYMBOL_CONSTANT(sym, v) (scm_c_vector_set_x (sym, 2, make_number (v)))
1304 #define SYMBOL_DECLARED_SPECIAL(sym) (XINT (scm_c_vector_ref (sym, 3)))
1305 #define SET_SYMBOL_DECLARED_SPECIAL(sym, v) (scm_c_vector_set_x (sym, 3, make_number (v)))
1307 /* Value is name of symbol. */
1310 SYMBOL_ALIAS (sym_t sym
)
1312 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_VARALIAS
);
1313 return scm_c_vector_ref (sym
, 4);
1315 INLINE
struct Lisp_Buffer_Local_Value
*
1316 SYMBOL_BLV (sym_t sym
)
1318 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_LOCALIZED
);
1319 return scm_to_pointer (scm_c_vector_ref (sym
, 4));
1321 INLINE
union Lisp_Fwd
*
1322 SYMBOL_FWD (sym_t sym
)
1324 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_FORWARDED
);
1325 return scm_to_pointer (scm_c_vector_ref (sym
, 4));
1328 LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL
,
1329 (sym_t sym
, Lisp_Object v
), (sym
, v
))
1332 SET_SYMBOL_ALIAS (sym_t sym
, sym_t v
)
1334 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_VARALIAS
);
1335 scm_c_vector_set_x (sym
, 4, v
);
1338 SET_SYMBOL_BLV (sym_t sym
, struct Lisp_Buffer_Local_Value
*v
)
1340 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_LOCALIZED
);
1341 scm_c_vector_set_x (sym
, 4, scm_from_pointer (v
, NULL
));
1344 SET_SYMBOL_FWD (sym_t sym
, union Lisp_Fwd
*v
)
1346 eassert (SYMBOL_REDIRECT (sym
) == SYMBOL_FORWARDED
);
1347 scm_c_vector_set_x (sym
, 4, scm_from_pointer (v
, NULL
));
1351 SYMBOL_NAME (Lisp_Object sym
)
1353 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1354 if (EQ (sym
, Qt
)) sym
= Qt_
;
1355 return build_string (scm_to_locale_string (scm_symbol_to_string (sym
)));
1358 /* Value is true if SYM is an interned symbol. */
1361 SYMBOL_INTERNED_P (Lisp_Object sym
)
1363 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1364 if (EQ (sym
, Qt
)) sym
= Qt_
;
1365 return scm_is_true (scm_symbol_interned_p (sym
));
1369 SYMBOL_FUNCTION (Lisp_Object sym
)
1371 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
1372 if (EQ (sym
, Qt
)) sym
= Qt_
;
1373 return scm_variable_ref (scm_module_lookup (function_module
, sym
));
1376 /* Value is non-zero if symbol is considered a constant, i.e. its
1377 value cannot be changed (there is an exception for keyword symbols,
1378 whose value can be set to the keyword symbol itself). */
1380 LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P
, int, (Lisp_Object sym
), (sym
))
1382 #define DEFSYM(sym, name) \
1383 do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false)
1385 LISP_MACRO_DEFUN (SYMBOL_VAL
, Lisp_Object
, (sym_t sym
), (sym
))
1388 /***********************************************************************
1390 ***********************************************************************/
1392 /* The structure of a Lisp hash table. */
1394 struct hash_table_test
1396 /* Name of the function used to compare keys. */
1399 /* User-supplied hash function, or nil. */
1400 Lisp_Object user_hash_function
;
1402 /* User-supplied key comparison function, or nil. */
1403 Lisp_Object user_cmp_function
;
1405 /* C function to compare two keys. */
1406 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1408 /* C function to compute hash code. */
1409 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1412 struct Lisp_Hash_Table
1414 /* This is for Lisp; the hash table code does not refer to it. */
1415 struct vectorlike_header header
;
1417 /* Nil if table is non-weak. Otherwise a symbol describing the
1418 weakness of the table. */
1421 /* When the table is resized, and this is an integer, compute the
1422 new size by adding this to the old size. If a float, compute the
1423 new size by multiplying the old size with this factor. */
1424 Lisp_Object rehash_size
;
1426 /* Resize hash table when number of entries/ table size is >= this
1428 Lisp_Object rehash_threshold
;
1430 /* Vector of hash codes. If hash[I] is nil, this means that the
1431 I-th entry is unused. */
1434 /* Vector used to chain entries. If entry I is free, next[I] is the
1435 entry number of the next free item. If entry I is non-free,
1436 next[I] is the index of the next entry in the collision chain. */
1439 /* Index of first free entry in free list. */
1440 Lisp_Object next_free
;
1442 /* Bucket vector. A non-nil entry is the index of the first item in
1443 a collision chain. This vector's size can be larger than the
1444 hash table size to reduce collisions. */
1447 /* Only the fields above are traced normally by the GC. The ones below
1448 `count' are special and are either ignored by the GC or traced in
1449 a special way (e.g. because of weakness). */
1451 /* Number of key/value entries in the table. */
1454 /* Vector of keys and values. The key of item I is found at index
1455 2 * I, the value is found at index 2 * I + 1.
1456 This is gc_marked specially if the table is weak. */
1457 Lisp_Object key_and_value
;
1459 /* The comparison and hash functions. */
1460 struct hash_table_test test
;
1462 /* Next weak hash table if this is a weak hash table. The head
1463 of the list is in weak_hash_tables. */
1464 struct Lisp_Hash_Table
*next_weak
;
1468 INLINE
struct Lisp_Hash_Table
*
1469 XHASH_TABLE (Lisp_Object a
)
1471 return SMOB_PTR (a
);
1474 #define XSET_HASH_TABLE(VAR, PTR) \
1475 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1478 HASH_TABLE_P (Lisp_Object a
)
1480 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
1483 /* Value is the key part of entry IDX in hash table H. */
1485 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1487 return AREF (h
->key_and_value
, 2 * idx
);
1490 /* Value is the value part of entry IDX in hash table H. */
1492 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1494 return AREF (h
->key_and_value
, 2 * idx
+ 1);
1497 /* Value is the index of the next entry following the one at IDX
1500 HASH_NEXT (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1502 return AREF (h
->next
, idx
);
1505 /* Value is the hash code computed for entry IDX in hash table H. */
1507 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1509 return AREF (h
->hash
, idx
);
1512 /* Value is the index of the element in hash table H that is the
1513 start of the collision list at index IDX in the index vector of H. */
1515 HASH_INDEX (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
1517 return AREF (h
->index
, idx
);
1520 /* Value is the size of hash table H. */
1522 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
1524 return ASIZE (h
->next
);
1527 /* Default size for hash tables if not specified. */
1529 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
1531 /* Default threshold specifying when to resize a hash table. The
1532 value gives the ratio of current entries in the hash table and the
1533 size of the hash table. */
1535 static double const DEFAULT_REHASH_THRESHOLD
= 0.8;
1537 /* Default factor by which to increase the size of a hash table. */
1539 static double const DEFAULT_REHASH_SIZE
= 1.5;
1541 /* Combine two integers X and Y for hashing. The result might not fit
1542 into a Lisp integer. */
1545 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
1547 return (x
<< 4) + (x
>> (BITS_PER_EMACS_INT
- 4)) + y
;
1550 /* Hash X, returning a value that fits into a fixnum. */
1553 SXHASH_REDUCE (EMACS_UINT x
)
1555 return (x
^ x
>> (BITS_PER_EMACS_INT
- FIXNUM_BITS
+ 1)) & INTMASK
;
1558 /* These structures are used for various misc types. */
1560 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
1563 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
1569 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
1570 /* This flag is temporarily used in the functions
1571 decode/encode_coding_object to record that the marker position
1572 must be adjusted after the conversion. */
1573 bool_bf need_adjustment
: 1;
1574 /* True means normal insertion at the marker's position
1575 leaves the marker after the inserted text. */
1576 bool_bf insertion_type
: 1;
1577 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1578 Note: a chain of markers can contain markers pointing into different
1579 buffers (the chain is per buffer_text rather than per buffer, so it's
1580 shared between indirect buffers). */
1581 /* This is used for (other than NULL-checking):
1583 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1584 - unchain_marker: to find the list from which to unchain.
1585 - Fkill_buffer: to only unchain the markers of current indirect buffer.
1587 struct buffer
*buffer
;
1589 /* The remaining fields are meaningless in a marker that
1590 does not point anywhere. */
1592 /* For markers that point somewhere,
1593 this is used to chain of all the markers in a given buffer. */
1594 /* We could remove it and use an array in buffer_text instead.
1595 That would also allow to preserve it ordered. */
1596 struct Lisp_Marker
*next
;
1597 /* This is the char position where the marker points. */
1599 /* This is the byte position.
1600 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
1601 used to implement the functionality of markers, but rather to (ab)use
1602 markers as a cache for char<->byte mappings). */
1606 /* START and END are markers in the overlay's buffer, and
1607 PLIST is the overlay's property list. */
1609 /* An overlay's real data content is:
1611 - buffer (really there are two buffer pointers, one per marker,
1612 and both points to the same buffer)
1613 - insertion type of both ends (per-marker fields)
1614 - start & start byte (of start marker)
1615 - end & end byte (of end marker)
1616 - next (singly linked list of overlays)
1617 - next fields of start and end markers (singly linked list of markers).
1618 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
1622 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
1623 struct Lisp_Overlay
*next
;
1629 /* Types of data which may be saved in a Lisp_Save_Value. */
1640 /* Number of bits needed to store one of the above values. */
1641 enum { SAVE_SLOT_BITS
= 3 };
1643 /* Number of slots in a save value where save_type is nonzero. */
1644 enum { SAVE_VALUE_SLOTS
= 4 };
1646 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
1648 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
1652 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1653 SAVE_TYPE_INT_INT_INT
1654 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
1655 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1656 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1657 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
1658 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
1659 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
1660 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
1661 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
1662 SAVE_TYPE_FUNCPTR_PTR_OBJ
1663 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
1665 /* This has an extra bit indicating it's raw memory. */
1666 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
1669 /* Special object used to hold a different values for later use.
1671 This is mostly used to package C integers and pointers to call
1672 record_unwind_protect when two or more values need to be saved.
1676 struct my_data *md = get_my_data ();
1677 ptrdiff_t mi = get_my_integer ();
1678 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
1681 Lisp_Object my_unwind (Lisp_Object arg)
1683 struct my_data *md = XSAVE_POINTER (arg, 0);
1684 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
1688 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
1689 saved objects and raise eassert if type of the saved object doesn't match
1690 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
1691 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
1692 slot 0 is a pointer. */
1694 typedef void (*voidfuncptr
) (void);
1696 struct Lisp_Save_Value
1699 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
1700 unsigned spacer
: 32 - (16 + SAVE_TYPE_BITS
);
1702 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
1703 V's data entries are determined by V->save_type. E.g., if
1704 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
1705 V->data[1] is an integer, and V's other data entries are unused.
1707 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
1708 a memory area containing V->data[1].integer potential Lisp_Objects. */
1709 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
1712 voidfuncptr funcpointer
;
1715 } data
[SAVE_VALUE_SLOTS
];
1718 /* Return the type of V's Nth saved value. */
1720 save_type (struct Lisp_Save_Value
*v
, int n
)
1722 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
1723 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
1726 /* Get and set the Nth saved pointer. */
1729 XSAVE_POINTER (Lisp_Object obj
, int n
)
1731 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1732 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
1735 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
1737 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
1738 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
1741 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
1743 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
1744 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
1747 /* Likewise for the saved integer. */
1750 XSAVE_INTEGER (Lisp_Object obj
, int n
)
1752 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1753 return XSAVE_VALUE (obj
)->data
[n
].integer
;
1756 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
1758 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
1759 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
1762 /* Extract Nth saved object. */
1765 XSAVE_OBJECT (Lisp_Object obj
, int n
)
1767 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
1768 return XSAVE_VALUE (obj
)->data
[n
].object
;
1771 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1772 It uses one of these struct subtypes to get the type field. */
1776 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
1777 struct Lisp_Marker u_marker
;
1778 struct Lisp_Overlay u_overlay
;
1779 struct Lisp_Save_Value u_save_value
;
1782 INLINE
union Lisp_Misc
*
1783 XMISC (Lisp_Object a
)
1785 return SMOB_PTR (a
);
1788 INLINE
struct Lisp_Misc_Any
*
1789 XMISCANY (Lisp_Object a
)
1791 eassert (MISCP (a
));
1792 return & XMISC (a
)->u_any
;
1795 INLINE
enum Lisp_Misc_Type
1796 XMISCTYPE (Lisp_Object a
)
1798 return XMISCANY (a
)->type
;
1801 INLINE
struct Lisp_Marker
*
1802 XMARKER (Lisp_Object a
)
1804 eassert (MARKERP (a
));
1805 return & XMISC (a
)->u_marker
;
1808 INLINE
struct Lisp_Overlay
*
1809 XOVERLAY (Lisp_Object a
)
1811 eassert (OVERLAYP (a
));
1812 return & XMISC (a
)->u_overlay
;
1815 INLINE
struct Lisp_Save_Value
*
1816 XSAVE_VALUE (Lisp_Object a
)
1818 eassert (SAVE_VALUEP (a
));
1819 return & XMISC (a
)->u_save_value
;
1822 /* Forwarding pointer to an int variable.
1823 This is allowed only in the value cell of a symbol,
1824 and it means that the symbol's value really lives in the
1825 specified int variable. */
1828 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
1832 /* Boolean forwarding pointer to an int variable.
1833 This is like Lisp_Intfwd except that the ostensible
1834 "value" of the symbol is t if the bool variable is true,
1835 nil if it is false. */
1838 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
1842 /* Forwarding pointer to a Lisp_Object variable.
1843 This is allowed only in the value cell of a symbol,
1844 and it means that the symbol's value really lives in the
1845 specified variable. */
1848 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
1849 Lisp_Object
*objvar
;
1852 /* Like Lisp_Objfwd except that value lives in a slot in the
1853 current buffer. Value is byte index of slot within buffer. */
1854 struct Lisp_Buffer_Objfwd
1856 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
1858 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
1859 Lisp_Object predicate
;
1862 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1863 the symbol has buffer-local or frame-local bindings. (Exception:
1864 some buffer-local variables are built-in, with their values stored
1865 in the buffer structure itself. They are handled differently,
1866 using struct Lisp_Buffer_Objfwd.)
1868 The `realvalue' slot holds the variable's current value, or a
1869 forwarding pointer to where that value is kept. This value is the
1870 one that corresponds to the loaded binding. To read or set the
1871 variable, you must first make sure the right binding is loaded;
1872 then you can access the value in (or through) `realvalue'.
1874 `buffer' and `frame' are the buffer and frame for which the loaded
1875 binding was found. If those have changed, to make sure the right
1876 binding is loaded it is necessary to find which binding goes with
1877 the current buffer and selected frame, then load it. To load it,
1878 first unload the previous binding, then copy the value of the new
1879 binding into `realvalue' (or through it). Also update
1880 LOADED-BINDING to point to the newly loaded binding.
1882 `local_if_set' indicates that merely setting the variable creates a
1883 local binding for the current buffer. Otherwise the latter, setting
1884 the variable does not do that; only make-local-variable does that. */
1886 struct Lisp_Buffer_Local_Value
1888 /* True means that merely setting the variable creates a local
1889 binding for the current buffer. */
1890 bool_bf local_if_set
: 1;
1891 /* True means this variable can have frame-local bindings, otherwise, it is
1892 can have buffer-local bindings. The two cannot be combined. */
1893 bool_bf frame_local
: 1;
1894 /* True means that the binding now loaded was found.
1895 Presumably equivalent to (defcell!=valcell). */
1897 /* If non-NULL, a forwarding to the C var where it should also be set. */
1898 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
1899 /* The buffer or frame for which the loaded binding was found. */
1901 /* A cons cell that holds the default value. It has the form
1902 (SYMBOL . DEFAULT-VALUE). */
1903 Lisp_Object defcell
;
1904 /* The cons cell from `where's parameter alist.
1905 It always has the form (SYMBOL . VALUE)
1906 Note that if `forward' is non-nil, VALUE may be out of date.
1907 Also if the currently loaded binding is the default binding, then
1908 this is `eq'ual to defcell. */
1909 Lisp_Object valcell
;
1912 /* Like Lisp_Objfwd except that value lives in a slot in the
1914 struct Lisp_Kboard_Objfwd
1916 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
1922 struct Lisp_Intfwd u_intfwd
;
1923 struct Lisp_Boolfwd u_boolfwd
;
1924 struct Lisp_Objfwd u_objfwd
;
1925 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
1926 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
1929 INLINE
enum Lisp_Fwd_Type
1930 XFWDTYPE (union Lisp_Fwd
*a
)
1932 return a
->u_intfwd
.type
;
1935 INLINE
struct Lisp_Buffer_Objfwd
*
1936 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
1938 eassert (BUFFER_OBJFWDP (a
));
1939 return &a
->u_buffer_objfwd
;
1942 #define XFLOAT_DATA(f) (scm_to_double (f))
1944 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
1945 representations, have infinities and NaNs, and do not trap on
1946 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
1947 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
1948 wanted here, but is not quite right because Emacs does not require
1949 all the features of C11 Annex F (and does not require C11 at all,
1950 for that matter). */
1954 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
1955 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
1958 /* A character, declared with the following typedef, is a member
1959 of some character set associated with the current buffer. */
1960 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1962 typedef unsigned char UCHAR
;
1965 /* Meanings of slots in a Lisp_Compiled: */
1969 COMPILED_ARGLIST
= 0,
1970 COMPILED_BYTECODE
= 1,
1971 COMPILED_CONSTANTS
= 2,
1972 COMPILED_STACK_DEPTH
= 3,
1973 COMPILED_DOC_STRING
= 4,
1974 COMPILED_INTERACTIVE
= 5
1977 /* Flag bits in a character. These also get used in termhooks.h.
1978 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1979 (MUlti-Lingual Emacs) might need 22 bits for the character value
1980 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1983 CHAR_ALT
= 0x0400000,
1984 CHAR_SUPER
= 0x0800000,
1985 CHAR_HYPER
= 0x1000000,
1986 CHAR_SHIFT
= 0x2000000,
1987 CHAR_CTL
= 0x4000000,
1988 CHAR_META
= 0x8000000,
1990 CHAR_MODIFIER_MASK
=
1991 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
1993 /* Actually, the current Emacs uses 22 bits for the character value
1998 /* Data type checking. */
2000 LISP_MACRO_DEFUN (NILP
, bool, (Lisp_Object x
), (x
))
2003 NUMBERP (Lisp_Object x
)
2005 return INTEGERP (x
) || FLOATP (x
);
2008 NATNUMP (Lisp_Object x
)
2010 return INTEGERP (x
) && 0 <= XINT (x
);
2014 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2016 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2019 #define TYPE_RANGED_INTEGERP(type, x) \
2021 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2022 && XINT (x) <= TYPE_MAXIMUM (type))
2024 LISP_MACRO_DEFUN (CONSP
, bool, (Lisp_Object x
), (x
))
2025 LISP_MACRO_DEFUN (FLOATP
, bool, (Lisp_Object x
), (x
))
2026 LISP_MACRO_DEFUN (MISCP
, bool, (Lisp_Object x
), (x
))
2027 LISP_MACRO_DEFUN (SYMBOLP
, bool, (Lisp_Object x
), (x
))
2028 LISP_MACRO_DEFUN (INTEGERP
, bool, (Lisp_Object x
), (x
))
2029 LISP_MACRO_DEFUN (VECTORLIKEP
, bool, (Lisp_Object x
), (x
))
2030 LISP_MACRO_DEFUN (MARKERP
, bool, (Lisp_Object x
), (x
))
2033 STRINGP (Lisp_Object x
)
2035 return SMOB_TYPEP (x
, lisp_string_tag
);
2038 VECTORP (Lisp_Object x
)
2040 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
2043 OVERLAYP (Lisp_Object x
)
2045 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2048 SAVE_VALUEP (Lisp_Object x
)
2050 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2054 AUTOLOADP (Lisp_Object x
)
2056 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2060 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2062 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2066 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, int code
)
2068 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
2069 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
2072 /* True if A is a pseudovector whose code is CODE. */
2074 PSEUDOVECTORP (Lisp_Object a
, int code
)
2076 if (! VECTORLIKEP (a
))
2080 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2081 struct vectorlike_header
*h
= SMOB_PTR (a
);
2082 return PSEUDOVECTOR_TYPEP (h
, code
);
2086 /* Test for specific pseudovector types. */
2089 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2091 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2095 PROCESSP (Lisp_Object a
)
2097 return PSEUDOVECTORP (a
, PVEC_PROCESS
);
2101 WINDOWP (Lisp_Object a
)
2103 return PSEUDOVECTORP (a
, PVEC_WINDOW
);
2107 TERMINALP (Lisp_Object a
)
2109 return PSEUDOVECTORP (a
, PVEC_TERMINAL
);
2113 COMPILEDP (Lisp_Object a
)
2115 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2119 BUFFERP (Lisp_Object a
)
2121 return PSEUDOVECTORP (a
, PVEC_BUFFER
);
2125 CHAR_TABLE_P (Lisp_Object a
)
2127 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
2131 SUB_CHAR_TABLE_P (Lisp_Object a
)
2133 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
2137 BOOL_VECTOR_P (Lisp_Object a
)
2139 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
2143 FRAMEP (Lisp_Object a
)
2145 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2148 /* Test for image (image . spec) */
2150 IMAGEP (Lisp_Object x
)
2152 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2157 ARRAYP (Lisp_Object x
)
2159 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2163 CHECK_LIST (Lisp_Object x
)
2165 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2168 LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS
, (Lisp_Object x
, Lisp_Object y
), (x
, y
))
2169 LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL
, (Lisp_Object x
), (x
))
2170 LISP_MACRO_DEFUN_VOID (CHECK_NUMBER
, (Lisp_Object x
), (x
))
2173 CHECK_STRING (Lisp_Object x
)
2175 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
2178 CHECK_STRING_CAR (Lisp_Object x
)
2180 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2183 CHECK_CONS (Lisp_Object x
)
2185 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
2188 CHECK_VECTOR (Lisp_Object x
)
2190 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
2193 CHECK_BOOL_VECTOR (Lisp_Object x
)
2195 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
2198 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2200 CHECK_TYPE (VECTORP (x
) || STRINGP (x
), Qarrayp
, x
);
2203 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2205 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2208 CHECK_BUFFER (Lisp_Object x
)
2210 CHECK_TYPE (BUFFERP (x
), Qbufferp
, x
);
2213 CHECK_WINDOW (Lisp_Object x
)
2215 CHECK_TYPE (WINDOWP (x
), Qwindowp
, x
);
2219 CHECK_PROCESS (Lisp_Object x
)
2221 CHECK_TYPE (PROCESSP (x
), Qprocessp
, x
);
2225 CHECK_NATNUM (Lisp_Object x
)
2227 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2230 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2233 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2234 args_out_of_range_3 \
2236 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2237 ? MOST_NEGATIVE_FIXNUM \
2239 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2241 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2243 if (TYPE_SIGNED (type)) \
2244 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2246 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2249 #define CHECK_NUMBER_COERCE_MARKER(x) \
2251 if (MARKERP ((x))) \
2252 XSETFASTINT (x, marker_position (x)); \
2254 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2258 XFLOATINT (Lisp_Object n
)
2260 return extract_float (n
);
2264 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2266 CHECK_TYPE (FLOATP (x
) || INTEGERP (x
), Qnumberp
, x
);
2269 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2272 XSETFASTINT (x, marker_position (x)); \
2274 CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \
2277 /* Since we can't assign directly to the CAR or CDR fields of a cons
2278 cell, use these when checking that those fields contain numbers. */
2280 CHECK_NUMBER_CAR (Lisp_Object x
)
2282 Lisp_Object tmp
= XCAR (x
);
2288 CHECK_NUMBER_CDR (Lisp_Object x
)
2290 Lisp_Object tmp
= XCDR (x
);
2295 /* Define a built-in function for calling from Lisp.
2296 `lname' should be the name to give the function in Lisp,
2297 as a null-terminated C string.
2298 `fnname' should be the name of the function in C.
2299 By convention, it starts with F.
2300 `sname' should be the name for the C constant structure
2301 that records information on this function for internal use.
2302 By convention, it should be the same as `fnname' but with S instead of F.
2303 It's too bad that C macros can't compute this from `fnname'.
2304 `minargs' should be a number, the minimum number of arguments allowed.
2305 `maxargs' should be a number, the maximum number of arguments allowed,
2306 or else MANY or UNEVALLED.
2307 MANY means pass a vector of evaluated arguments,
2308 in the form of an integer number-of-arguments
2309 followed by the address of a vector of Lisp_Objects
2310 which contains the argument values.
2311 UNEVALLED means pass the list of unevaluated arguments
2312 `intspec' says how interactive arguments are to be fetched.
2313 If the string starts with a `(', `intspec' is evaluated and the resulting
2314 list is the list of arguments.
2315 If it's a string that doesn't start with `(', the value should follow
2316 the one of the doc string for `interactive'.
2317 A null string means call interactively with no arguments.
2318 `doc' is documentation for the user. */
2320 /* This version of DEFUN declares a function prototype with the right
2321 arguments, so we can catch errors with maxargs at compile-time. */
2322 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2323 SCM_SNARF_INIT (defsubr (lname, gsubr_ ## fnname, minargs, maxargs, intspec)) \
2324 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2325 DEFUN_GSUBR_ ## maxargs (lname, fnname, minargs, maxargs) \
2328 #define GSUBR_ARGS_1(f) f (arg1)
2329 #define GSUBR_ARGS_2(f) GSUBR_ARGS_1 (f), f (arg2)
2330 #define GSUBR_ARGS_3(f) GSUBR_ARGS_2 (f), f (arg3)
2331 #define GSUBR_ARGS_4(f) GSUBR_ARGS_3 (f), f (arg4)
2332 #define GSUBR_ARGS_5(f) GSUBR_ARGS_4 (f), f (arg5)
2333 #define GSUBR_ARGS_6(f) GSUBR_ARGS_5 (f), f (arg6)
2334 #define GSUBR_ARGS_7(f) GSUBR_ARGS_6 (f), f (arg7)
2335 #define GSUBR_ARGS_8(f) GSUBR_ARGS_7 (f), f (arg8)
2337 #define GSUBR_ARGS(n) GSUBR_ARGS_PASTE (GSUBR_ARGS_, n)
2338 #define GSUBR_ARGS_PASTE(a, b) a ## b
2340 #define DEFUN_GSUBR_N(fn, maxargs) \
2343 (GSUBR_ARGS (maxargs) (Lisp_Object)) \
2345 return fn (GSUBR_ARGS (maxargs) (GSUBR_ARG)); \
2347 #define GSUBR_ARG(x) (SCM_UNBNDP (x) ? Qnil : x)
2349 #define DEFUN_GSUBR_0(lname, fn, minargs, maxargs) \
2350 Lisp_Object gsubr_ ## fn (void) { return fn (); }
2351 #define DEFUN_GSUBR_1(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2352 #define DEFUN_GSUBR_2(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2353 #define DEFUN_GSUBR_3(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2354 #define DEFUN_GSUBR_4(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2355 #define DEFUN_GSUBR_5(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2356 #define DEFUN_GSUBR_6(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2357 #define DEFUN_GSUBR_7(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2358 #define DEFUN_GSUBR_8(lname, fn, min, max) DEFUN_GSUBR_N(fn, max)
2360 #define DEFUN_GSUBR_UNEVALLED(lname, fn, minargs, maxargs) \
2362 gsubr_ ## fn (Lisp_Object rest) \
2364 Lisp_Object len = Flength (rest); \
2365 if (XINT (len) < minargs) \
2366 xsignal2 (Qwrong_number_of_arguments, \
2367 intern (lname), len); \
2370 #define DEFUN_GSUBR_MANY(lname, fn, minargs, maxargs) \
2372 gsubr_ ## fn (Lisp_Object rest) \
2374 int len = scm_to_int (scm_length (rest)); \
2375 Lisp_Object *args; \
2376 SAFE_ALLOCA_LISP (args, len); \
2379 i < len && scm_is_pair (rest); \
2380 i++, rest = SCM_CDR (rest)) \
2381 args[i] = SCM_CAR (rest); \
2383 xsignal2 (Qwrong_number_of_arguments, \
2384 intern (lname), make_number (i)); \
2385 return fn (i, args); \
2388 /* Note that the weird token-substitution semantics of ANSI C makes
2389 this work for MANY and UNEVALLED. */
2390 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
2391 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
2392 #define DEFUN_ARGS_0 (void)
2393 #define DEFUN_ARGS_1 (Lisp_Object)
2394 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
2395 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
2396 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2397 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2399 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2400 Lisp_Object, Lisp_Object)
2401 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2402 Lisp_Object, Lisp_Object, Lisp_Object)
2403 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
2404 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
2406 /* True if OBJ is a Lisp function. */
2408 FUNCTIONP (Lisp_Object obj
)
2410 return functionp (obj
);
2414 is how we define the symbol for function `name' at start-up time. */
2415 extern void defsubr (const char *, scm_t_subr
, short, short, const char *);
2423 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2424 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2425 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2426 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2427 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2429 /* Macros we use to define forwarded Lisp variables.
2430 These are used in the syms_of_FILENAME functions.
2432 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2433 lisp variable is actually a field in `struct emacs_globals'. The
2434 field's name begins with "f_", which is a convention enforced by
2435 these macros. Each such global has a corresponding #define in
2436 globals.h; the plain name should be used in the code.
2438 E.g., the global "cons_cells_consed" is declared as "int
2439 f_cons_cells_consed" in globals.h, but there is a define:
2441 #define cons_cells_consed globals.f_cons_cells_consed
2443 All C code uses the `cons_cells_consed' name. This is all done
2444 this way to support indirection for multi-threaded Emacs. */
2446 #define DEFVAR_LISP(lname, vname, doc) \
2448 static struct Lisp_Objfwd o_fwd; \
2449 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2451 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2453 static struct Lisp_Objfwd o_fwd; \
2454 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2456 #define DEFVAR_BOOL(lname, vname, doc) \
2458 static struct Lisp_Boolfwd b_fwd; \
2459 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2461 #define DEFVAR_INT(lname, vname, doc) \
2463 static struct Lisp_Intfwd i_fwd; \
2464 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
2467 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
2469 static struct Lisp_Objfwd o_fwd; \
2470 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
2473 #define DEFVAR_KBOARD(lname, vname, doc) \
2475 static struct Lisp_Kboard_Objfwd ko_fwd; \
2476 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
2479 /* Save and restore the instruction and environment pointers,
2480 without affecting the signal mask. */
2483 typedef jmp_buf sys_jmp_buf
;
2484 # define sys_setjmp(j) _setjmp (j)
2485 # define sys_longjmp(j, v) _longjmp (j, v)
2486 #elif defined HAVE_SIGSETJMP
2487 typedef sigjmp_buf sys_jmp_buf
;
2488 # define sys_setjmp(j) sigsetjmp (j, 0)
2489 # define sys_longjmp(j, v) siglongjmp (j, v)
2491 /* A platform that uses neither _longjmp nor siglongjmp; assume
2492 longjmp does not affect the sigmask. */
2493 typedef jmp_buf sys_jmp_buf
;
2494 # define sys_setjmp(j) setjmp (j)
2495 # define sys_longjmp(j, v) longjmp (j, v)
2499 /* Elisp uses several stacks:
2501 - the bytecode stack: used internally by the bytecode interpreter.
2502 Allocated from the C stack.
2503 - The specpdl stack: keeps track of active unwind-protect and
2504 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
2506 - The handler stack: keeps track of active catch tags and condition-case
2507 handlers. Allocated in a manually managed stack implemented by a
2508 doubly-linked list allocated via xmalloc and never freed. */
2510 /* Structure for recording Lisp call stack for backtrace purposes. */
2512 /* The special binding stack holds the outer values of variables while
2513 they are bound by a function application or a let form, stores the
2514 code to be executed for unwind-protect forms.
2516 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
2517 used all over the place, needs to be fast, and needs to know the size of
2518 union specbinding. But only eval.c should access it. */
2521 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
2522 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
2523 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
2524 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
2525 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
2530 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2532 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2535 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2536 bool wind_explicitly
;
2537 void (*func
) (Lisp_Object
);
2541 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2542 bool wind_explicitly
;
2543 void (*func
) (void *);
2547 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2548 bool wind_explicitly
;
2553 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2554 bool wind_explicitly
;
2555 void (*func
) (void);
2558 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2559 /* `where' is not used in the case of SPECPDL_LET. */
2560 Lisp_Object symbol
, old_value
, where
;
2563 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
2564 bool_bf debug_on_exit
: 1;
2565 Lisp_Object function
;
2571 extern union specbinding
*specpdl
;
2572 extern union specbinding
*specpdl_ptr
;
2573 extern ptrdiff_t specpdl_size
;
2576 SPECPDL_INDEX (void)
2578 return specpdl_ptr
- specpdl
;
2581 /* This structure helps implement the `catch/throw' and `condition-case/signal'
2582 control structures. A struct handler contains all the information needed to
2583 restore the state of the interpreter after a non-local jump.
2585 handler structures are chained together in a doubly linked list; the `next'
2586 member points to the next outer catchtag and the `nextfree' member points in
2587 the other direction to the next inner element (which is typically the next
2588 free element since we mostly use it on the deepest handler).
2590 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
2591 member is TAG, and then unbinds to it. The `val' member is used to
2592 hold VAL while the stack is unwound; `val' is returned as the value
2595 All the other members are concerned with restoring the interpreter
2598 Members are volatile if their values need to survive _longjmp when
2599 a 'struct handler' is a local variable. */
2601 enum handlertype
{ CATCHER
, CONDITION_CASE
};
2605 enum handlertype type
;
2607 Lisp_Object tag_or_ch
;
2611 struct handler
*next
;
2612 EMACS_INT lisp_eval_depth
;
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 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2759 if (EQ (sym
, Qt
)) sym
= Qt_
;
2760 scm_variable_set_x (scm_module_lookup (function_module
, sym
), function
);
2764 symbol_plist (Lisp_Object sym
)
2766 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2767 if (EQ (sym
, Qt
)) sym
= Qt_
;
2768 return scm_variable_ref (scm_module_lookup (plist_module
, sym
));
2772 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
2774 if (EQ (sym
, Qnil
)) sym
= Qnil_
;
2775 if (EQ (sym
, Qt
)) sym
= Qt_
;
2776 scm_variable_set_x (scm_module_lookup (plist_module
, sym
), plist
);
2779 /* Buffer-local (also frame-local) variable access functions. */
2782 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
2784 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
2788 /* Set overlay's property list. */
2791 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
2793 XOVERLAY (overlay
)->plist
= plist
;
2796 /* Get text properties of S. */
2799 string_intervals (Lisp_Object s
)
2801 return XSTRING (s
)->intervals
;
2804 /* Set text properties of S to I. */
2807 set_string_intervals (Lisp_Object s
, INTERVAL i
)
2809 XSTRING (s
)->intervals
= i
;
2812 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
2813 of setting slots directly. */
2816 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
2818 XCHAR_TABLE (table
)->defalt
= val
;
2821 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
2823 XCHAR_TABLE (table
)->purpose
= val
;
2826 /* Set different slots in (sub)character tables. */
2829 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2831 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
2832 XCHAR_TABLE (table
)->extras
[idx
] = val
;
2836 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2838 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
2839 XCHAR_TABLE (table
)->contents
[idx
] = val
;
2843 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
2845 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
2848 /* Defined in data.c. */
2849 extern Lisp_Object Qnil_
, Qt_
;
2850 extern Lisp_Object Qquote
, Qunbound
;
2851 extern Lisp_Object Qerror_conditions
, Qerror_message
, Qtop_level
;
2852 extern Lisp_Object Qerror
, Qquit
, Qargs_out_of_range
;
2853 extern Lisp_Object Qvoid_variable
, Qvoid_function
;
2854 extern Lisp_Object Qinvalid_read_syntax
;
2855 extern Lisp_Object Qinvalid_function
, Qwrong_number_of_arguments
, Qno_catch
;
2856 extern Lisp_Object Quser_error
, Qend_of_file
, Qarith_error
, Qmark_inactive
;
2857 extern Lisp_Object Qbeginning_of_buffer
, Qend_of_buffer
, Qbuffer_read_only
;
2858 extern Lisp_Object Qtext_read_only
;
2859 extern Lisp_Object Qinteractive_form
;
2860 extern Lisp_Object Qcircular_list
;
2861 extern Lisp_Object Qsequencep
;
2862 extern Lisp_Object Qchar_or_string_p
, Qinteger_or_marker_p
;
2863 extern Lisp_Object Qfboundp
;
2864 extern Lisp_Object Qspecial_operator
;
2866 extern Lisp_Object Qcdr
;
2868 extern Lisp_Object Qrange_error
, Qoverflow_error
;
2870 extern Lisp_Object Qnumber_or_marker_p
;
2872 extern Lisp_Object Qbuffer
, Qinteger
, Qsymbol
;
2874 /* Defined in data.c. */
2875 extern Lisp_Object
indirect_function (Lisp_Object
);
2876 extern Lisp_Object
find_symbol_value (Lisp_Object
);
2877 enum Arith_Comparison
{
2882 ARITH_LESS_OR_EQUAL
,
2885 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
2886 enum Arith_Comparison comparison
);
2888 /* Convert the integer I to an Emacs representation, either the integer
2889 itself, or a cons of two or three integers, or if all else fails a float.
2890 I should not have side effects. */
2891 #define INTEGER_TO_CONS(i) \
2892 (! FIXNUM_OVERFLOW_P (i) \
2894 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \
2895 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \
2896 && FIXNUM_OVERFLOW_P ((i) >> 16)) \
2897 ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \
2898 : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \
2899 || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \
2900 && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \
2901 ? Fcons (make_number ((i) >> 16 >> 24), \
2902 Fcons (make_number ((i) >> 16 & 0xffffff), \
2903 make_number ((i) & 0xffff))) \
2906 /* Convert the Emacs representation CONS back to an integer of type
2907 TYPE, storing the result the variable VAR. Signal an error if CONS
2908 is not a valid representation or is out of range for TYPE. */
2909 #define CONS_TO_INTEGER(cons, type, var) \
2910 (TYPE_SIGNED (type) \
2911 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
2912 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
2913 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
2914 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
2916 extern sym_t
indirect_variable (sym_t
);
2917 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
2918 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
2920 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
2921 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
, bool);
2922 extern void syms_of_data (void);
2923 extern void swap_in_global_binding (sym_t
);
2925 /* Defined in cmds.c */
2926 extern void syms_of_cmds (void);
2927 extern void keys_of_cmds (void);
2929 /* Defined in coding.c. */
2930 extern Lisp_Object Qcharset
;
2931 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
2932 ptrdiff_t, bool, bool, Lisp_Object
);
2933 extern void init_coding (void);
2934 extern void init_coding_once (void);
2935 extern void syms_of_coding (void);
2937 /* Defined in character.c. */
2938 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
2939 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
2940 extern void syms_of_character (void);
2942 /* Defined in charset.c. */
2943 extern void init_charset (void);
2944 extern void init_charset_once (void);
2945 extern void syms_of_charset (void);
2946 /* Structure forward declarations. */
2949 /* Defined in syntax.c. */
2950 extern void init_syntax_once (void);
2951 extern void syms_of_syntax (void);
2953 /* Defined in fns.c. */
2954 extern Lisp_Object QCrehash_size
, QCrehash_threshold
;
2955 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
2956 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
2957 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
2958 extern void sweep_weak_hash_tables (void);
2959 extern Lisp_Object Qcursor_in_echo_area
;
2960 extern Lisp_Object Qstring_lessp
;
2961 extern Lisp_Object QCsize
, QCtest
, QCweakness
, Qequal
, Qeq
;
2962 EMACS_UINT
hash_string (char const *, ptrdiff_t);
2963 EMACS_UINT
sxhash (Lisp_Object
, int);
2964 Lisp_Object
make_hash_table (struct hash_table_test
, Lisp_Object
, Lisp_Object
,
2965 Lisp_Object
, Lisp_Object
);
2966 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
2967 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
2969 extern struct hash_table_test hashtest_eql
, hashtest_equal
;
2970 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
2971 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
2972 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
2973 ptrdiff_t, ptrdiff_t);
2974 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2975 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
2976 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
2977 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
2978 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
2979 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
2980 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
2981 extern void clear_string_char_byte_cache (void);
2982 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
2983 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
2984 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
2985 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
2986 extern void init_fns_once (void);
2987 extern void syms_of_fns (void);
2989 /* Defined in floatfns.c. */
2990 extern void syms_of_floatfns (void);
2991 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
2993 /* Defined in fringe.c. */
2994 extern void syms_of_fringe (void);
2995 extern void init_fringe (void);
2996 #ifdef HAVE_WINDOW_SYSTEM
2997 extern void mark_fringe_data (void);
2998 extern void init_fringe_once (void);
2999 #endif /* HAVE_WINDOW_SYSTEM */
3001 /* Defined in image.c. */
3002 extern Lisp_Object QCascent
, QCmargin
, QCrelief
;
3003 extern Lisp_Object QCconversion
;
3004 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3005 extern void reset_image_types (void);
3006 extern void syms_of_image (void);
3008 /* Defined in insdel.c. */
3009 extern Lisp_Object Qinhibit_modification_hooks
;
3010 extern Lisp_Object Qregion_extract_function
;
3011 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3012 extern _Noreturn
void buffer_overflow (void);
3013 extern void make_gap (ptrdiff_t);
3014 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3015 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3016 ptrdiff_t, bool, bool);
3017 extern int count_combining_before (const unsigned char *,
3018 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3019 extern int count_combining_after (const unsigned char *,
3020 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3021 extern void insert (const char *, ptrdiff_t);
3022 extern void insert_and_inherit (const char *, ptrdiff_t);
3023 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3025 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3026 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3027 ptrdiff_t, ptrdiff_t, bool);
3028 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3029 extern void insert_char (int);
3030 extern void insert_string (const char *);
3031 extern void insert_before_markers (const char *, ptrdiff_t);
3032 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3033 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3034 ptrdiff_t, ptrdiff_t,
3036 extern void del_range (ptrdiff_t, ptrdiff_t);
3037 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3038 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3039 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3040 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3041 ptrdiff_t, ptrdiff_t, bool);
3042 extern void modify_text (ptrdiff_t, ptrdiff_t);
3043 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3044 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3045 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3046 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3047 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3048 ptrdiff_t, ptrdiff_t);
3049 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3050 ptrdiff_t, ptrdiff_t);
3051 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool);
3052 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3053 const char *, ptrdiff_t, ptrdiff_t, bool);
3054 extern void syms_of_insdel (void);
3056 /* Defined in dispnew.c. */
3057 #if (defined PROFILING \
3058 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3059 _Noreturn
void __executable_start (void);
3061 extern Lisp_Object Vwindow_system
;
3062 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3064 /* Defined in xdisp.c. */
3065 extern Lisp_Object Qinhibit_point_motion_hooks
;
3066 extern Lisp_Object Qinhibit_redisplay
;
3067 extern Lisp_Object Qmenu_bar_update_hook
;
3068 extern Lisp_Object Qwindow_scroll_functions
;
3069 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
3070 extern Lisp_Object Qtext
, Qboth
, Qboth_horiz
, Qtext_image_horiz
;
3071 extern Lisp_Object Qspace
, Qcenter
, QCalign_to
;
3072 extern Lisp_Object Qbar
, Qhbar
, Qhollow
;
3073 extern Lisp_Object Qleft_margin
, Qright_margin
;
3074 extern Lisp_Object QCdata
, QCfile
;
3075 extern Lisp_Object QCmap
;
3076 extern Lisp_Object Qrisky_local_variable
;
3077 extern bool noninteractive_need_newline
;
3078 extern Lisp_Object echo_area_buffer
[2];
3079 extern void add_to_log (const char *, Lisp_Object
, Lisp_Object
);
3080 extern void check_message_stack (void);
3081 extern void setup_echo_area_for_printing (int);
3082 extern bool push_message (void);
3083 extern void pop_message_unwind (void);
3084 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3085 extern void restore_message (void);
3086 extern Lisp_Object
current_message (void);
3087 extern void clear_message (bool, bool);
3088 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3089 extern void message1 (const char *);
3090 extern void message1_nolog (const char *);
3091 extern void message3 (Lisp_Object
);
3092 extern void message3_nolog (Lisp_Object
);
3093 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3094 extern void message_with_string (const char *, Lisp_Object
, int);
3095 extern void message_log_maybe_newline (void);
3096 extern void update_echo_area (void);
3097 extern void truncate_echo_area (ptrdiff_t);
3098 extern void redisplay (void);
3100 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3101 extern void syms_of_xdisp (void);
3102 extern void init_xdisp (void);
3103 extern Lisp_Object
safe_eval (Lisp_Object
);
3104 extern int pos_visible_p (struct window
*, ptrdiff_t, int *,
3105 int *, int *, int *, int *, int *);
3107 /* Defined in xsettings.c. */
3108 extern void syms_of_xsettings (void);
3110 /* Defined in vm-limit.c. */
3111 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3113 /* Defined in alloc.c. */
3114 extern void check_pure_size (void);
3115 extern void free_misc (Lisp_Object
);
3116 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3117 extern void malloc_warning (const char *);
3118 extern _Noreturn
void memory_full (size_t);
3119 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3120 #if defined REL_ALLOC && !defined SYSTEM_MALLOC
3121 extern void refill_memory_reserve (void);
3123 extern const char *pending_malloc_warning
;
3124 extern Lisp_Object zero_vector
;
3125 extern Lisp_Object
list1 (Lisp_Object
);
3126 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3127 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3128 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3129 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3131 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3132 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3134 /* Build a frequently used 2/3/4-integer lists. */
3137 list2i (EMACS_INT x
, EMACS_INT y
)
3139 return list2 (make_number (x
), make_number (y
));
3143 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3145 return list3 (make_number (x
), make_number (y
), make_number (w
));
3149 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3151 return list4 (make_number (x
), make_number (y
),
3152 make_number (w
), make_number (h
));
3155 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3156 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3157 extern _Noreturn
void string_overflow (void);
3158 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3159 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3160 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3161 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3163 /* Make unibyte string from C string when the length isn't known. */
3166 build_unibyte_string (const char *str
)
3168 return make_unibyte_string (str
, strlen (str
));
3171 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3172 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3173 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3174 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3175 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3176 extern Lisp_Object
make_specified_string (const char *,
3177 ptrdiff_t, ptrdiff_t, bool);
3178 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3179 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3181 /* Make a string allocated in pure space, use STR as string data. */
3184 build_pure_c_string (const char *str
)
3186 return make_pure_c_string (str
, strlen (str
));
3189 /* Make a string from the data at STR, treating it as multibyte if the
3193 build_string (const char *str
)
3195 return make_string (str
, strlen (str
));
3198 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3199 extern void make_byte_code (struct Lisp_Vector
*);
3200 extern Lisp_Object Qchar_table_extra_slots
;
3201 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3203 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3204 be sure that GC cannot happen until the vector is completely
3205 initialized. E.g. the following code is likely to crash:
3207 v = make_uninit_vector (3);
3209 ASET (v, 1, Ffunction_can_gc ());
3210 ASET (v, 2, obj1); */
3213 make_uninit_vector (ptrdiff_t size
)
3216 struct Lisp_Vector
*p
;
3218 p
= allocate_vector (size
);
3223 extern struct Lisp_Vector
*allocate_pseudovector (int, int, enum pvec_type
);
3224 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
3226 allocate_pseudovector \
3227 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
3228 extern struct Lisp_Hash_Table
*allocate_hash_table (void);
3229 extern struct window
*allocate_window (void);
3230 extern struct frame
*allocate_frame (void);
3231 extern struct Lisp_Process
*allocate_process (void);
3232 extern struct terminal
*allocate_terminal (void);
3233 extern Lisp_Object
make_float (double);
3234 extern void display_malloc_warning (void);
3235 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3236 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3237 Lisp_Object
, Lisp_Object
);
3238 extern Lisp_Object
make_save_ptr (void *);
3239 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3240 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3241 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3243 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3244 extern void free_save_value (Lisp_Object
);
3245 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3246 extern void init_alloc_once (void);
3247 extern void init_alloc (void);
3248 extern void syms_of_alloc (void);
3249 extern struct buffer
* allocate_buffer (void);
3250 extern int valid_lisp_object_p (Lisp_Object
);
3251 extern int relocatable_string_data_p (const char *);
3254 /* Defined in ralloc.c. */
3255 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3256 extern void r_alloc_free (void **);
3257 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3258 extern void r_alloc_reset_variable (void **, void **);
3259 extern void r_alloc_inhibit_buffer_relocation (int);
3262 /* Defined in chartab.c. */
3263 extern Lisp_Object
copy_char_table (Lisp_Object
);
3264 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3266 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3267 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3269 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3270 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3271 Lisp_Object
, Lisp_Object
,
3272 Lisp_Object
, struct charset
*,
3273 unsigned, unsigned);
3274 extern Lisp_Object
uniprop_table (Lisp_Object
);
3275 extern void syms_of_chartab (void);
3277 /* Defined in print.c. */
3278 extern Lisp_Object Vprin1_to_string_buffer
;
3279 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3280 extern Lisp_Object Qstandard_output
;
3281 extern Lisp_Object Qexternal_debugging_output
;
3282 extern void temp_output_buffer_setup (const char *);
3283 extern int print_level
;
3284 extern Lisp_Object Qprint_escape_newlines
;
3285 extern void write_string (const char *, int);
3286 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3288 extern Lisp_Object internal_with_output_to_temp_buffer
3289 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3290 #define FLOAT_TO_STRING_BUFSIZE 350
3291 extern int float_to_string (char *, double);
3292 extern void init_print_once (void);
3293 extern void syms_of_print (void);
3295 /* Defined in doprnt.c. */
3296 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3298 extern ptrdiff_t esprintf (char *, char const *, ...)
3299 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3300 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3302 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3303 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3304 char const *, va_list)
3305 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3307 /* Defined in lread.c. */
3308 extern Lisp_Object Qvariable_documentation
, Qstandard_input
;
3309 extern Lisp_Object Qbackquote
, Qcomma
, Qcomma_at
, Qcomma_dot
, Qfunction
;
3310 extern Lisp_Object Qlexical_binding
;
3311 extern Lisp_Object
check_obarray (Lisp_Object
);
3312 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3313 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3314 extern Lisp_Object
obhash (Lisp_Object
);
3315 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3317 LOADHIST_ATTACH (Lisp_Object x
)
3320 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3322 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3323 Lisp_Object
*, Lisp_Object
, bool);
3324 extern Lisp_Object
string_to_number (char const *, int, bool);
3325 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3327 extern void dir_warning (const char *, Lisp_Object
);
3328 extern void init_obarray (void);
3329 extern void init_lread (void);
3330 extern void syms_of_lread (void);
3333 intern (const char *str
)
3335 return intern_1 (str
, strlen (str
));
3339 intern_c_string (const char *str
)
3341 return intern_c_string_1 (str
, strlen (str
));
3344 /* Defined in eval.c. */
3345 extern Lisp_Object Qexit
, Qinteractive
, Qcommandp
, Qmacro
;
3346 extern Lisp_Object Qinhibit_quit
, Qinternal_interpreter_environment
, Qclosure
;
3347 extern Lisp_Object Qand_rest
;
3348 extern Lisp_Object Vautoload_queue
;
3349 extern Lisp_Object Vsignaling_function
;
3350 extern Lisp_Object inhibit_lisp_code
;
3351 extern struct handler
*handlerlist
;
3353 /* To run a normal hook, use the appropriate function from the list below.
3354 The calling convention:
3356 if (!NILP (Vrun_hooks))
3357 call1 (Vrun_hooks, Qmy_funny_hook);
3359 should no longer be used. */
3360 extern Lisp_Object Vrun_hooks
;
3361 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3362 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3363 Lisp_Object (*funcall
)
3364 (ptrdiff_t nargs
, Lisp_Object
*args
));
3365 extern _Noreturn
void xsignal (Lisp_Object
, Lisp_Object
);
3366 extern _Noreturn
void xsignal0 (Lisp_Object
);
3367 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3368 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3369 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3371 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3372 extern Lisp_Object
eval_sub (Lisp_Object form
);
3373 extern Lisp_Object
Ffuncall (ptrdiff_t nargs
, Lisp_Object
*args
);
3374 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3375 extern Lisp_Object
call0 (Lisp_Object
);
3376 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3377 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3378 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3379 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3380 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3381 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3382 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3383 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3384 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3385 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3386 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3387 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3388 extern Lisp_Object internal_condition_case_n
3389 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3390 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3391 extern void specbind (Lisp_Object
, Lisp_Object
);
3392 extern void record_unwind_protect_1 (void (*) (Lisp_Object
), Lisp_Object
, bool);
3393 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3394 extern void record_unwind_protect_ptr_1 (void (*) (void *), void *, bool);
3395 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3396 extern void record_unwind_protect_int_1 (void (*) (int), int, bool);
3397 extern void record_unwind_protect_int (void (*) (int), int);
3398 extern void record_unwind_protect_void_1 (void (*) (void), bool);
3399 extern void record_unwind_protect_void (void (*) (void));
3400 extern void dynwind_begin (void);
3401 extern void dynwind_end (void);
3402 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3403 extern _Noreturn
void verror (const char *, va_list)
3404 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3405 extern void un_autoload (Lisp_Object
);
3406 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3407 extern void init_eval_once (void);
3408 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3409 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3410 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3411 extern void init_eval (void);
3412 extern void syms_of_eval (void);
3413 extern void unwind_body (Lisp_Object
);
3414 extern void record_in_backtrace (Lisp_Object function
,
3415 Lisp_Object
*args
, ptrdiff_t nargs
);
3416 extern void mark_specpdl (void);
3417 extern void get_backtrace (Lisp_Object array
);
3418 Lisp_Object
backtrace_top_function (void);
3419 extern bool let_shadows_buffer_binding_p (sym_t symbol
);
3420 extern bool let_shadows_global_binding_p (Lisp_Object symbol
);
3421 extern _Noreturn SCM
abort_to_prompt (SCM
, SCM
);
3422 extern SCM
call_with_prompt (SCM
, SCM
, SCM
);
3423 extern SCM
make_prompt_tag (void);
3426 /* Defined in editfns.c. */
3427 extern Lisp_Object Qfield
;
3428 extern void insert1 (Lisp_Object
);
3429 extern Lisp_Object
format2 (const char *, Lisp_Object
, Lisp_Object
);
3430 extern Lisp_Object
save_excursion_save (void);
3431 extern Lisp_Object
save_restriction_save (void);
3432 extern void save_excursion_restore (Lisp_Object
);
3433 extern void save_restriction_restore (Lisp_Object
);
3434 extern _Noreturn
void time_overflow (void);
3435 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3436 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3438 extern void init_editfns (void);
3439 extern void syms_of_editfns (void);
3440 extern void set_time_zone_rule (const char *);
3442 /* Defined in buffer.c. */
3443 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3444 extern _Noreturn
void nsberror (Lisp_Object
);
3445 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3446 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3447 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3448 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3449 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3450 extern bool overlay_touches_p (ptrdiff_t);
3451 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3452 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3453 extern void init_buffer_once (void);
3454 extern void init_buffer (int);
3455 extern void syms_of_buffer (void);
3456 extern void keys_of_buffer (void);
3458 /* Defined in marker.c. */
3460 extern ptrdiff_t marker_position (Lisp_Object
);
3461 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3462 extern void clear_charpos_cache (struct buffer
*);
3463 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3464 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3465 extern void unchain_marker (struct Lisp_Marker
*marker
);
3466 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3467 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
3468 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
3469 ptrdiff_t, ptrdiff_t);
3470 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
3471 extern void syms_of_marker (void);
3473 /* Defined in fileio.c. */
3475 extern Lisp_Object Qfile_error
;
3476 extern Lisp_Object Qfile_notify_error
;
3477 extern Lisp_Object Qfile_exists_p
;
3478 extern Lisp_Object Qfile_directory_p
;
3479 extern Lisp_Object Qinsert_file_contents
;
3480 extern Lisp_Object Qfile_name_history
;
3481 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
, Lisp_Object
);
3482 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3483 Lisp_Object
, Lisp_Object
, Lisp_Object
,
3485 extern void close_file_unwind (int);
3486 extern void close_file_ptr_unwind (void *);
3487 extern void fclose_unwind (void *);
3488 extern void fclose_ptr_unwind (void *);
3489 extern void restore_point_unwind (Lisp_Object
);
3490 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
3491 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
3492 extern bool internal_delete_file (Lisp_Object
);
3493 extern Lisp_Object
emacs_readlinkat (int, const char *);
3494 extern bool file_directory_p (const char *);
3495 extern bool file_accessible_directory_p (const char *);
3496 extern void init_fileio (void);
3497 extern void syms_of_fileio (void);
3498 extern Lisp_Object
make_temp_name (Lisp_Object
, bool);
3499 extern Lisp_Object Qdelete_file
;
3501 /* Defined in search.c. */
3502 extern void shrink_regexp_cache (void);
3503 extern void restore_search_regs (void);
3504 extern void record_unwind_save_match_data (void);
3505 struct re_registers
;
3506 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
3507 struct re_registers
*,
3508 Lisp_Object
, bool, bool);
3509 extern ptrdiff_t fast_string_match (Lisp_Object
, Lisp_Object
);
3510 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
3512 extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object
, Lisp_Object
);
3513 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3514 ptrdiff_t, ptrdiff_t, Lisp_Object
);
3515 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3516 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
3517 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3519 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
3520 ptrdiff_t, ptrdiff_t *);
3521 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
3522 ptrdiff_t, ptrdiff_t *);
3523 extern void syms_of_search (void);
3524 extern void clear_regexp_cache (void);
3526 /* Defined in minibuf.c. */
3528 extern Lisp_Object Qcompletion_ignore_case
;
3529 extern Lisp_Object Vminibuffer_list
;
3530 extern Lisp_Object last_minibuf_string
;
3531 extern Lisp_Object
get_minibuffer (EMACS_INT
);
3532 extern void init_minibuf_once (void);
3533 extern void syms_of_minibuf (void);
3535 /* Defined in callint.c. */
3537 extern Lisp_Object Qminus
, Qplus
;
3538 extern Lisp_Object Qprogn
;
3539 extern Lisp_Object Qwhen
;
3540 extern Lisp_Object Qmouse_leave_buffer_hook
;
3541 extern void syms_of_callint (void);
3543 /* Defined in casefiddle.c. */
3545 extern Lisp_Object Qidentity
;
3546 extern void syms_of_casefiddle (void);
3547 extern void keys_of_casefiddle (void);
3549 /* Defined in casetab.c. */
3551 extern void init_casetab_once (void);
3552 extern void syms_of_casetab (void);
3554 /* Defined in keyboard.c. */
3556 extern Lisp_Object echo_message_buffer
;
3557 extern struct kboard
*echo_kboard
;
3558 extern void cancel_echoing (void);
3559 extern Lisp_Object Qdisabled
, QCfilter
;
3560 extern Lisp_Object Qup
, Qdown
;
3561 extern Lisp_Object last_undo_boundary
;
3562 extern bool input_pending
;
3563 extern Lisp_Object
menu_bar_items (Lisp_Object
);
3564 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
3565 extern void discard_mouse_events (void);
3567 void handle_input_available_signal (int);
3569 extern Lisp_Object pending_funcalls
;
3570 extern bool detect_input_pending (void);
3571 extern bool detect_input_pending_ignore_squeezables (void);
3572 extern bool detect_input_pending_run_timers (bool);
3573 extern void safe_run_hooks (Lisp_Object
);
3574 extern void cmd_error_internal (Lisp_Object
, const char *);
3575 extern Lisp_Object
command_loop_1 (void);
3576 extern Lisp_Object
read_menu_command (void);
3577 extern Lisp_Object
recursive_edit_1 (void);
3578 extern void record_auto_save (void);
3579 extern void force_auto_save_soon (void);
3580 extern void init_keyboard (void);
3581 extern void syms_of_keyboard (void);
3582 extern void keys_of_keyboard (void);
3584 /* Defined in indent.c. */
3585 extern ptrdiff_t current_column (void);
3586 extern void invalidate_current_column (void);
3587 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
3588 extern void syms_of_indent (void);
3590 /* Defined in frame.c. */
3591 extern Lisp_Object Qonly
, Qnone
;
3592 extern void set_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3593 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
3594 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
3595 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
3596 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
3597 extern void frames_discard_buffer (Lisp_Object
);
3598 extern void syms_of_frame (void);
3600 /* Defined in emacs.c. */
3601 extern char **initial_argv
;
3602 extern int initial_argc
;
3603 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
3604 extern bool display_arg
;
3606 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
3607 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
3608 extern Lisp_Object Qfile_name_handler_alist
;
3609 extern _Noreturn
void terminate_due_to_signal (int, int);
3610 extern Lisp_Object Qkill_emacs
;
3612 extern Lisp_Object Vlibrary_cache
;
3615 void fixup_locale (void);
3616 void synchronize_system_messages_locale (void);
3617 void synchronize_system_time_locale (void);
3619 INLINE
void fixup_locale (void) {}
3620 INLINE
void synchronize_system_messages_locale (void) {}
3621 INLINE
void synchronize_system_time_locale (void) {}
3623 extern void shut_down_emacs (int, Lisp_Object
);
3625 /* True means don't do interactive redisplay and don't change tty modes. */
3626 extern bool noninteractive
;
3628 /* True means remove site-lisp directories from load-path. */
3629 extern bool no_site_lisp
;
3631 /* Pipe used to send exit notification to the daemon parent at
3633 extern int daemon_pipe
[2];
3634 #define IS_DAEMON (daemon_pipe[1] != 0)
3636 /* True if handling a fatal error already. */
3637 extern bool fatal_error_in_progress
;
3639 /* True means don't do use window-system-specific display code. */
3640 extern bool inhibit_window_system
;
3641 /* True means that a filter or a sentinel is running. */
3642 extern bool running_asynch_code
;
3644 /* Defined in process.c. */
3645 extern Lisp_Object QCtype
, Qlocal
;
3646 extern void kill_buffer_processes (Lisp_Object
);
3647 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
3648 struct Lisp_Process
*, int);
3649 /* Max value for the first argument of wait_reading_process_output. */
3650 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
3651 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
3652 The bug merely causes a bogus warning, but the warning is annoying. */
3653 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
3655 # define WAIT_READING_MAX INTMAX_MAX
3657 extern void add_keyboard_wait_descriptor (int);
3658 extern void delete_keyboard_wait_descriptor (int);
3660 extern void add_gpm_wait_descriptor (int);
3661 extern void delete_gpm_wait_descriptor (int);
3663 extern void init_process_emacs (void);
3664 extern void syms_of_process (void);
3665 extern void setup_process_coding_systems (Lisp_Object
);
3667 /* Defined in callproc.c. */
3671 extern int child_setup (int, int, int, char **, bool, Lisp_Object
);
3672 extern void init_callproc_1 (void);
3673 extern void init_callproc (void);
3674 extern void set_initial_environment (void);
3675 extern void syms_of_callproc (void);
3677 /* Defined in doc.c. */
3678 extern Lisp_Object Qfunction_documentation
;
3679 extern Lisp_Object
read_doc_string (Lisp_Object
);
3680 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
3681 extern void syms_of_doc (void);
3682 extern int read_bytecode_char (bool);
3684 /* Defined in bytecode.c. */
3685 extern void syms_of_bytecode (void);
3686 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3687 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3689 /* Defined in macros.c. */
3690 extern void init_macros (void);
3691 extern void syms_of_macros (void);
3693 /* Defined in undo.c. */
3694 extern Lisp_Object Qapply
;
3695 extern Lisp_Object Qinhibit_read_only
;
3696 extern void truncate_undo_list (struct buffer
*);
3697 extern void record_insert (ptrdiff_t, ptrdiff_t);
3698 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
3699 extern void record_first_change (void);
3700 extern void record_change (ptrdiff_t, ptrdiff_t);
3701 extern void record_property_change (ptrdiff_t, ptrdiff_t,
3702 Lisp_Object
, Lisp_Object
,
3704 extern void syms_of_undo (void);
3705 /* Defined in textprop.c. */
3706 extern Lisp_Object Qmouse_face
;
3707 extern Lisp_Object Qinsert_in_front_hooks
, Qinsert_behind_hooks
;
3708 extern Lisp_Object Qminibuffer_prompt
;
3710 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
3712 /* Defined in menu.c. */
3713 extern void syms_of_menu (void);
3715 /* Defined in xmenu.c. */
3716 extern void syms_of_xmenu (void);
3718 /* Defined in termchar.h. */
3719 struct tty_display_info
;
3721 /* Defined in termhooks.h. */
3724 /* Defined in sysdep.c. */
3725 #ifndef HAVE_GET_CURRENT_DIR_NAME
3726 extern char *get_current_dir_name (void);
3728 extern void stuff_char (char c
);
3729 extern void init_foreground_group (void);
3730 extern void sys_subshell (void);
3731 extern void sys_suspend (void);
3732 extern void discard_tty_input (void);
3733 extern void init_sys_modes (struct tty_display_info
*);
3734 extern void reset_sys_modes (struct tty_display_info
*);
3735 extern void init_all_sys_modes (void);
3736 extern void reset_all_sys_modes (void);
3737 extern void child_setup_tty (int);
3738 extern void setup_pty (int);
3739 extern int set_window_size (int, int, int);
3740 extern EMACS_INT
get_random (void);
3741 extern void seed_random (void *, ptrdiff_t);
3742 extern void init_random (void);
3743 extern void emacs_backtrace (int);
3744 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
3745 extern int emacs_open (const char *, int, int);
3746 extern int emacs_pipe (int[2]);
3747 extern int emacs_close (int);
3748 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
3749 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
3750 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
3751 extern void emacs_perror (char const *);
3753 extern void unlock_all_files (void);
3754 extern void lock_file (Lisp_Object
);
3755 extern void unlock_file (Lisp_Object
);
3756 extern void unlock_buffer (struct buffer
*);
3757 extern void syms_of_filelock (void);
3759 /* Defined in sound.c. */
3760 extern void syms_of_sound (void);
3762 /* Defined in category.c. */
3763 extern void init_category_once (void);
3764 extern Lisp_Object
char_category_set (int);
3765 extern void syms_of_category (void);
3767 /* Defined in ccl.c. */
3768 extern void syms_of_ccl (void);
3770 /* Defined in dired.c. */
3771 extern void syms_of_dired (void);
3772 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
3773 Lisp_Object
, Lisp_Object
,
3776 /* Defined in term.c. */
3777 extern int *char_ins_del_vector
;
3778 extern void syms_of_term (void);
3779 extern _Noreturn
void fatal (const char *msgid
, ...)
3780 ATTRIBUTE_FORMAT_PRINTF (1, 2);
3782 /* Defined in terminal.c. */
3783 extern void syms_of_terminal (void);
3785 /* Defined in font.c. */
3786 extern void syms_of_font (void);
3787 extern void init_font (void);
3789 #ifdef HAVE_WINDOW_SYSTEM
3790 /* Defined in fontset.c. */
3791 extern void syms_of_fontset (void);
3793 /* Defined in xfns.c, w32fns.c, or macfns.c. */
3794 extern Lisp_Object Qfont_param
;
3797 /* Defined in gfilenotify.c */
3798 #ifdef HAVE_GFILENOTIFY
3799 extern void globals_of_gfilenotify (void);
3800 extern void syms_of_gfilenotify (void);
3803 /* Defined in inotify.c */
3805 extern void syms_of_inotify (void);
3808 #ifdef HAVE_W32NOTIFY
3809 /* Defined on w32notify.c. */
3810 extern void syms_of_w32notify (void);
3813 /* Defined in xfaces.c. */
3814 extern Lisp_Object Qdefault
, Qfringe
;
3815 extern Lisp_Object Qscroll_bar
, Qcursor
;
3816 extern Lisp_Object Qmode_line_inactive
;
3817 extern Lisp_Object Qface
;
3818 extern Lisp_Object Qnormal
;
3819 extern Lisp_Object QCfamily
, QCweight
, QCslant
;
3820 extern Lisp_Object QCheight
, QCname
, QCwidth
, QCforeground
, QCbackground
;
3821 extern Lisp_Object Qextra_light
, Qlight
, Qsemi_light
, Qsemi_bold
;
3822 extern Lisp_Object Qbold
, Qextra_bold
, Qultra_bold
;
3823 extern Lisp_Object Qoblique
, Qitalic
;
3824 extern Lisp_Object Vface_alternative_font_family_alist
;
3825 extern Lisp_Object Vface_alternative_font_registry_alist
;
3826 extern void syms_of_xfaces (void);
3828 #ifdef HAVE_X_WINDOWS
3829 /* Defined in xfns.c. */
3830 extern void syms_of_xfns (void);
3832 /* Defined in xsmfns.c. */
3833 extern void syms_of_xsmfns (void);
3835 /* Defined in xselect.c. */
3836 extern void syms_of_xselect (void);
3838 /* Defined in xterm.c. */
3839 extern void syms_of_xterm (void);
3840 #endif /* HAVE_X_WINDOWS */
3842 #ifdef HAVE_WINDOW_SYSTEM
3843 /* Defined in xterm.c, nsterm.m, w32term.c. */
3844 extern char *x_get_keysym_name (int);
3845 #endif /* HAVE_WINDOW_SYSTEM */
3848 /* Defined in xml.c. */
3849 extern void syms_of_xml (void);
3850 extern void xml_cleanup_parser (void);
3854 /* Defined in decompress.c. */
3855 extern void syms_of_decompress (void);
3859 /* Defined in dbusbind.c. */
3860 void syms_of_dbusbind (void);
3864 /* Defined in profiler.c. */
3865 extern bool profiler_memory_running
;
3866 extern void malloc_probe (size_t);
3867 extern void syms_of_profiler (void);
3871 /* Defined in msdos.c, w32.c. */
3872 extern char *emacs_root_dir (void);
3875 /* True means ^G can quit instantly. */
3876 extern bool immediate_quit
;
3878 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3879 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3880 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3881 extern void xfree (void *);
3882 extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3883 extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3884 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3885 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
3886 ATTRIBUTE_ALLOC_SIZE ((2,3));
3887 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
3888 extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3889 extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3890 extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
3891 extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
3893 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
3894 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
3895 extern void dupstring (char **, char const *);
3896 extern void xputenv (const char *);
3898 extern char *egetenv (const char *);
3900 /* Copy Lisp string to temporary (allocated on stack) C string. */
3902 #define xlispstrdupa(string) \
3903 memcpy (alloca (SBYTES (string) + 1), \
3904 SSDATA (string), SBYTES (string) + 1)
3906 /* Set up the name of the machine we're running on. */
3907 extern void init_system_name (void);
3909 /* Return the absolute value of X. X should be a signed integer
3910 expression without side effects, and X's absolute value should not
3911 exceed the maximum for its promoted type. This is called 'eabs'
3912 because 'abs' is reserved by the C standard. */
3913 #define eabs(x) ((x) < 0 ? -(x) : (x))
3915 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3918 #define make_fixnum_or_float(val) \
3919 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
3921 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3922 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3924 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
3926 #define USE_SAFE_ALLOCA ((void) 0)
3928 /* SAFE_ALLOCA allocates a simple buffer. */
3930 #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \
3934 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
3935 NITEMS items, each of the same type as *BUF. MULTIPLIER must
3936 positive. The code is tuned for MULTIPLIER being a constant. */
3938 #define SAFE_NALLOCA(buf, multiplier, nitems) \
3940 if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \
3941 (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \
3943 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
3946 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3948 #define SAFE_FREE() ((void) 0)
3950 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3952 #define SAFE_ALLOCA_LISP(buf, nelt) \
3954 if ((nelt) < MAX_ALLOCA / word_size) \
3955 (buf) = alloca ((nelt) * word_size); \
3956 else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \
3957 buf = xmalloc ((nelt) * word_size); \
3959 memory_full (SIZE_MAX); \
3962 /* Loop over all tails of a list, checking for cycles.
3963 FIXME: Make tortoise and n internal declarations.
3964 FIXME: Unroll the loop body so we don't need `n'. */
3965 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
3966 for ((tortoise) = (hare) = (list), (n) = true; \
3968 (hare = XCDR (hare), (n) = !(n), \
3970 ? (EQ (hare, tortoise) \
3971 ? xsignal1 (Qcircular_list, list) \
3973 /* Move tortoise before the next iteration, in case */ \
3974 /* the next iteration does an Fsetcdr. */ \
3975 : (void) ((tortoise) = XCDR (tortoise)))))
3977 /* Do a `for' loop over alist values. */
3979 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
3980 for ((list_var) = (head_var); \
3981 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
3982 (list_var) = XCDR (list_var))
3984 /* Check whether it's time for GC, and run it if so. */
3993 functionp (Lisp_Object object
)
3995 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
3997 object
= Findirect_function (object
, Qt
);
3999 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
4001 /* Autoloaded symbols are functions, except if they load
4002 macros or keymaps. */
4004 for (i
= 0; i
< 4 && CONSP (object
); i
++)
4005 object
= XCDR (object
);
4007 return ! (CONSP (object
) && !NILP (XCAR (object
)));
4011 if (scm_is_true (scm_procedure_p (object
)))
4013 else if (COMPILEDP (object
))
4015 else if (CONSP (object
))
4017 Lisp_Object car
= XCAR (object
);
4018 return EQ (car
, Qlambda
) || EQ (car
, Qclosure
);
4023 #endif /* EMACS_LISP_H */