1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
3 Copyright (C) 1985-1987, 1993-1995, 1997-2017 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 (at
11 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 <https://www.gnu.org/licenses/>. */
39 /* Define a TYPE constant ID as an externally visible name. Use like this:
41 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
42 # define ID (some integer preprocessor expression of type TYPE)
43 DEFINE_GDB_SYMBOL_END (ID)
45 This hack is for the benefit of compilers that do not make macro
46 definitions or enums visible to the debugger. It's used for symbols
47 that .gdbinit needs. */
49 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
51 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
52 # define DEFINE_GDB_SYMBOL_END(id) = id;
54 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
55 # define DEFINE_GDB_SYMBOL_END(val) ;
58 /* The ubiquitous max and min macros. */
61 #define max(a, b) ((a) > (b) ? (a) : (b))
62 #define min(a, b) ((a) < (b) ? (a) : (b))
64 /* Number of elements in an array. */
65 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
67 /* Number of bits in a Lisp_Object tag. */
68 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS
)
70 DEFINE_GDB_SYMBOL_END (GCTYPEBITS
)
72 /* EMACS_INT - signed integer wide enough to hold an Emacs value
73 EMACS_INT_WIDTH - width in bits of EMACS_INT
74 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
75 pI - printf length modifier for EMACS_INT
76 EMACS_UINT - unsigned variant of EMACS_INT */
79 # error "INTPTR_MAX misconfigured"
80 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
81 typedef int EMACS_INT
;
82 typedef unsigned int EMACS_UINT
;
83 enum { EMACS_INT_WIDTH
= INT_WIDTH
, EMACS_UINT_WIDTH
= UINT_WIDTH
};
84 # define EMACS_INT_MAX INT_MAX
86 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
87 typedef long int EMACS_INT
;
88 typedef unsigned long EMACS_UINT
;
89 enum { EMACS_INT_WIDTH
= LONG_WIDTH
, EMACS_UINT_WIDTH
= ULONG_WIDTH
};
90 # define EMACS_INT_MAX LONG_MAX
92 # elif INTPTR_MAX <= LLONG_MAX
93 typedef long long int EMACS_INT
;
94 typedef unsigned long long int EMACS_UINT
;
95 enum { EMACS_INT_WIDTH
= LLONG_WIDTH
, EMACS_UINT_WIDTH
= ULLONG_WIDTH
};
96 # define EMACS_INT_MAX LLONG_MAX
97 /* MinGW supports %lld only if __USE_MINGW_ANSI_STDIO is non-zero,
98 which is arranged by config.h, and (for mingw.org) if GCC is 6.0 or
99 later and the runtime version is 5.0.0 or later. Otherwise,
100 printf-like functions are declared with __ms_printf__ attribute,
101 which will cause a warning for %lld etc. */
102 # if defined __MINGW32__ \
103 && (!defined __USE_MINGW_ANSI_STDIO \
104 || !(GNUC_PREREQ (6, 0, 0) && __MINGW32_MAJOR_VERSION >= 5))
110 # error "INTPTR_MAX too large"
114 /* Number of bits to put in each character in the internal representation
115 of bool vectors. This should not vary across implementations. */
116 enum { BOOL_VECTOR_BITS_PER_CHAR
=
117 #define BOOL_VECTOR_BITS_PER_CHAR 8
118 BOOL_VECTOR_BITS_PER_CHAR
121 /* An unsigned integer type representing a fixed-length bit sequence,
122 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
123 for speed, but on weird platforms it is unsigned char and not all
124 its bits are used. */
125 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
126 typedef size_t bits_word
;
127 # define BITS_WORD_MAX SIZE_MAX
128 enum { BITS_PER_BITS_WORD
= SIZE_WIDTH
};
130 typedef unsigned char bits_word
;
131 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
132 enum { BITS_PER_BITS_WORD
= BOOL_VECTOR_BITS_PER_CHAR
};
134 verify (BITS_WORD_MAX
>> (BITS_PER_BITS_WORD
- 1) == 1);
136 /* printmax_t and uprintmax_t are types for printing large integers.
137 These are the widest integers that are supported for printing.
138 pMd etc. are conversions for printing them.
139 On C99 hosts, there's no problem, as even the widest integers work.
140 Fall back on EMACS_INT on pre-C99 hosts. */
142 typedef intmax_t printmax_t
;
143 typedef uintmax_t uprintmax_t
;
147 typedef EMACS_INT printmax_t
;
148 typedef EMACS_UINT uprintmax_t
;
153 /* Use pD to format ptrdiff_t values, which suffice for indexes into
154 buffers and strings. Emacs never allocates objects larger than
155 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
156 In C99, pD can always be "t"; configure it here for the sake of
157 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
158 #if PTRDIFF_MAX == INT_MAX
160 #elif PTRDIFF_MAX == LONG_MAX
162 #elif PTRDIFF_MAX == LLONG_MAX
168 /* Extra internal type checking? */
170 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
171 'assume (COND)'. COND should be free of side effects, as it may or
172 may not be evaluated.
174 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
175 defined and suppress_checking is false, and does nothing otherwise.
176 Emacs dies if COND is checked and is false. The suppress_checking
177 variable is initialized to 0 in alloc.c. Set it to 1 using a
178 debugger to temporarily disable aborting on detected internal
179 inconsistencies or error conditions.
181 In some cases, a good compiler may be able to optimize away the
182 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
183 uses eassert to test STRINGP (x), but a particular use of XSTRING
184 is invoked only after testing that STRINGP (x) is true, making the
187 eassume is like eassert except that it also causes the compiler to
188 assume that COND is true afterwards, regardless of whether runtime
189 checking is enabled. This can improve performance in some cases,
190 though it can degrade performance in others. It's often suboptimal
191 for COND to call external functions or access volatile storage. */
193 #ifndef ENABLE_CHECKING
194 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
195 # define eassume(cond) assume (cond)
196 #else /* ENABLE_CHECKING */
198 extern _Noreturn
void die (const char *, const char *, int);
200 extern bool suppress_checking EXTERNALLY_VISIBLE
;
202 # define eassert(cond) \
203 (suppress_checking || (cond) \
205 : die (# cond, __FILE__, __LINE__))
206 # define eassume(cond) \
211 : die (# cond, __FILE__, __LINE__))
212 #endif /* ENABLE_CHECKING */
215 /* Use the configure flag --enable-check-lisp-object-type to make
216 Lisp_Object use a struct type instead of the default int. The flag
217 causes CHECK_LISP_OBJECT_TYPE to be defined. */
219 /***** Select the tagging scheme. *****/
220 /* The following option controls the tagging scheme:
221 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
222 always 0, and we can thus use them to hold tag bits, without
223 restricting our addressing space.
225 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
226 restricting our possible address range.
228 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
229 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
230 on the few static Lisp_Objects used: lispsym, all the defsubr, and
231 the two special buffers buffer_defaults and buffer_local_symbols. */
235 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
236 integer constant, for MSVC. */
237 #define GCALIGNMENT 8
239 /* Number of bits in a Lisp_Object value, not counting the tag. */
240 VALBITS
= EMACS_INT_WIDTH
- GCTYPEBITS
,
242 /* Number of bits in a Lisp fixnum tag. */
243 INTTYPEBITS
= GCTYPEBITS
- 1,
245 /* Number of bits in a Lisp fixnum value, not counting the tag. */
246 FIXNUM_BITS
= VALBITS
+ 1
249 #if GCALIGNMENT != 1 << GCTYPEBITS
250 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
253 /* The maximum value that can be stored in a EMACS_INT, assuming all
254 bits other than the type bits contribute to a nonnegative signed value.
255 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
256 expression involving VAL_MAX. */
257 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
259 /* Whether the least-significant bits of an EMACS_INT contain the tag.
260 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
261 a. unnecessary, because the top bits of an EMACS_INT are unused, and
262 b. slower, because it typically requires extra masking.
263 So, USE_LSB_TAG is true only on hosts where it might be useful. */
264 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG
)
265 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
266 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG
)
268 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
269 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT
, VALMASK
)
270 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
271 DEFINE_GDB_SYMBOL_END (VALMASK
)
273 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
274 # error "USE_LSB_TAG not supported on this platform; please report this." \
275 "Try 'configure --with-wide-int' to work around the problem."
279 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
280 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
282 # define GCALIGNED /* empty */
285 /* Some operations are so commonly executed that they are implemented
286 as macros, not functions, because otherwise runtime performance would
287 suffer too much when compiling with GCC without optimization.
288 There's no need to inline everything, just the operations that
289 would otherwise cause a serious performance problem.
291 For each such operation OP, define a macro lisp_h_OP that contains
292 the operation's implementation. That way, OP can be implemented
293 via a macro definition like this:
295 #define OP(x) lisp_h_OP (x)
297 and/or via a function definition like this:
299 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
301 without worrying about the implementations diverging, since
302 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
303 are intended to be private to this include file, and should not be
306 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
307 functions, once "gcc -Og" (new to GCC 4.8) works well enough for
308 Emacs developers. Maybe in the year 2020. See Bug#11935.
310 Commentary for these macros can be found near their corresponding
313 #if CHECK_LISP_OBJECT_TYPE
314 # define lisp_h_XLI(o) ((o).i)
315 # define lisp_h_XIL(i) ((Lisp_Object) { i })
317 # define lisp_h_XLI(o) (o)
318 # define lisp_h_XIL(i) (i)
320 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
321 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
322 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
323 ((ok) ? (void) 0 : wrong_type_argument (predicate, x))
324 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
325 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
326 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
327 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
328 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
329 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
330 #define lisp_h_NILP(x) EQ (x, Qnil)
331 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
332 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
333 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->trapped_write == SYMBOL_NOWRITE)
334 #define lisp_h_SYMBOL_TRAPPED_WRITE_P(sym) (XSYMBOL (sym)->trapped_write)
335 #define lisp_h_SYMBOL_VAL(sym) \
336 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
337 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
338 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
339 #define lisp_h_XCAR(c) XCONS (c)->car
340 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
341 #define lisp_h_XCONS(a) \
342 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
343 #define lisp_h_XHASH(a) XUINT (a)
344 #ifndef GC_CHECK_CONS_LIST
345 # define lisp_h_check_cons_list() ((void) 0)
348 # define lisp_h_make_number(n) \
349 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
350 # define lisp_h_XFASTINT(a) XINT (a)
351 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
352 # define lisp_h_XSYMBOL(a) \
353 (eassert (SYMBOLP (a)), \
354 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
356 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
357 # define lisp_h_XUNTAG(a, type) \
358 __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
362 /* When compiling via gcc -O0, define the key operations as macros, as
363 Emacs is too slow otherwise. To disable this optimization, compile
364 with -DINLINING=false. */
365 #if (defined __NO_INLINE__ \
366 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
367 && ! (defined INLINING && ! INLINING))
368 # define DEFINE_KEY_OPS_AS_MACROS true
370 # define DEFINE_KEY_OPS_AS_MACROS false
373 #if DEFINE_KEY_OPS_AS_MACROS
374 # define XLI(o) lisp_h_XLI (o)
375 # define XIL(i) lisp_h_XIL (i)
376 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
377 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
378 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
379 # define CONSP(x) lisp_h_CONSP (x)
380 # define EQ(x, y) lisp_h_EQ (x, y)
381 # define FLOATP(x) lisp_h_FLOATP (x)
382 # define INTEGERP(x) lisp_h_INTEGERP (x)
383 # define MARKERP(x) lisp_h_MARKERP (x)
384 # define MISCP(x) lisp_h_MISCP (x)
385 # define NILP(x) lisp_h_NILP (x)
386 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
387 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
388 # define SYMBOL_TRAPPED_WRITE_P(sym) lisp_h_SYMBOL_TRAPPED_WRITE_P (sym)
389 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
390 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
391 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
392 # define XCAR(c) lisp_h_XCAR (c)
393 # define XCDR(c) lisp_h_XCDR (c)
394 # define XCONS(a) lisp_h_XCONS (a)
395 # define XHASH(a) lisp_h_XHASH (a)
396 # ifndef GC_CHECK_CONS_LIST
397 # define check_cons_list() lisp_h_check_cons_list ()
400 # define make_number(n) lisp_h_make_number (n)
401 # define XFASTINT(a) lisp_h_XFASTINT (a)
402 # define XINT(a) lisp_h_XINT (a)
403 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
404 # define XTYPE(a) lisp_h_XTYPE (a)
405 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
410 /* Define the fundamental Lisp data structures. */
412 /* This is the set of Lisp data types. If you want to define a new
413 data type, read the comments after Lisp_Fwd_Type definition
416 /* Lisp integers use 2 tags, to give them one extra bit, thus
417 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
418 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
419 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
421 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
422 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
423 vociferously about them. */
424 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
425 || (defined __SUNPRO_C && __STDC__))
426 #define ENUM_BF(TYPE) unsigned int
428 #define ENUM_BF(TYPE) enum TYPE
434 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
437 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
438 whose first member indicates the subtype. */
441 /* Integer. XINT (obj) is the integer value. */
443 Lisp_Int1
= USE_LSB_TAG
? 6 : 3,
445 /* String. XSTRING (object) points to a struct Lisp_String.
446 The length of the string, and its contents, are stored therein. */
449 /* Vector of Lisp objects, or something resembling it.
450 XVECTOR (object) points to a struct Lisp_Vector, which contains
451 the size and contents. The size field also contains the type
452 information, if it's not a real vector object. */
455 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
456 Lisp_Cons
= USE_LSB_TAG
? 3 : 6,
461 /* This is the set of data types that share a common structure.
462 The first member of the structure is a type code from this set.
463 The enum values are arbitrary, but we'll use large numbers to make it
464 more likely that we'll spot the error if a random word in memory is
465 mistakenly interpreted as a Lisp_Misc. */
468 Lisp_Misc_Free
= 0x5eab,
471 Lisp_Misc_Save_Value
,
476 /* This is not a type code. It is for range checking. */
480 /* These are the types of forwarding objects used in the value slot
481 of symbols for special built-in variables whose value is stored in
485 Lisp_Fwd_Int
, /* Fwd to a C `int' variable. */
486 Lisp_Fwd_Bool
, /* Fwd to a C boolean var. */
487 Lisp_Fwd_Obj
, /* Fwd to a C Lisp_Object variable. */
488 Lisp_Fwd_Buffer_Obj
, /* Fwd to a Lisp_Object field of buffers. */
489 Lisp_Fwd_Kboard_Obj
/* Fwd to a Lisp_Object field of kboards. */
492 /* If you want to define a new Lisp data type, here are some
493 instructions. See the thread at
494 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
497 First, there are already a couple of Lisp types that can be used if
498 your new type does not need to be exposed to Lisp programs nor
499 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
500 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
501 is suitable for temporarily stashing away pointers and integers in
502 a Lisp object. The latter is useful for vector-like Lisp objects
503 that need to be used as part of other objects, but which are never
504 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
507 These two types don't look pretty when printed, so they are
508 unsuitable for Lisp objects that can be exposed to users.
510 To define a new data type, add one more Lisp_Misc subtype or one
511 more pseudovector subtype. Pseudovectors are more suitable for
512 objects with several slots that need to support fast random access,
513 while Lisp_Misc types are for everything else. A pseudovector object
514 provides one or more slots for Lisp objects, followed by struct
515 members that are accessible only from C. A Lisp_Misc object is a
516 wrapper for a C struct that can contain anything you like.
518 Explicit freeing is discouraged for Lisp objects in general. But if
519 you really need to exploit this, use Lisp_Misc (check free_misc in
520 alloc.c to see why). There is no way to free a vectorlike object.
522 To add a new pseudovector type, extend the pvec_type enumeration;
523 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
525 For a Lisp_Misc, you will also need to add your entry to union
526 Lisp_Misc, but make sure the first word has the same structure as
527 the others, starting with a 16-bit member of the Lisp_Misc_Type
528 enumeration and a 1-bit GC markbit. Also make sure the overall
529 size of the union is not increased by your addition. The latter
530 requirement is to keep Lisp_Misc objects small enough, so they
531 are handled faster: since all Lisp_Misc types use the same space,
532 enlarging any of them will affect all the rest. If you really
533 need a larger object, it is best to use Lisp_Vectorlike instead.
535 For a new pseudovector, it's highly desirable to limit the size
536 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
537 Otherwise you will need to change sweep_vectors (also in alloc.c).
539 Then you will need to add switch branches in print.c (in
540 print_object, to print your object, and possibly also in
541 print_preprocess) and to alloc.c, to mark your object (in
542 mark_object) and to free it (in gc_sweep). The latter is also the
543 right place to call any code specific to your data type that needs
544 to run when the object is recycled -- e.g., free any additional
545 resources allocated for it that are not Lisp objects. You can even
546 make a pointer to the function that frees the resources a slot in
547 your object -- this way, the same object could be used to represent
548 several disparate C structures. */
550 #ifdef CHECK_LISP_OBJECT_TYPE
552 typedef struct Lisp_Object
{ EMACS_INT i
; } Lisp_Object
;
554 #define LISP_INITIALLY(i) {i}
556 #undef CHECK_LISP_OBJECT_TYPE
557 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= true };
558 #else /* CHECK_LISP_OBJECT_TYPE */
560 /* If a struct type is not wanted, define Lisp_Object as just a number. */
562 typedef EMACS_INT Lisp_Object
;
563 #define LISP_INITIALLY(i) (i)
564 enum CHECK_LISP_OBJECT_TYPE
{ CHECK_LISP_OBJECT_TYPE
= false };
565 #endif /* CHECK_LISP_OBJECT_TYPE */
567 /* Forward declarations. */
569 /* Defined in this file. */
570 INLINE
void set_sub_char_table_contents (Lisp_Object
, ptrdiff_t,
573 /* Defined in chartab.c. */
574 extern Lisp_Object
char_table_ref (Lisp_Object
, int);
575 extern void char_table_set (Lisp_Object
, int, Lisp_Object
);
577 /* Defined in data.c. */
578 extern _Noreturn
void wrong_type_argument (Lisp_Object
, Lisp_Object
);
582 enum { might_dump
= false };
583 #elif defined DOUG_LEA_MALLOC
584 /* Defined in emacs.c. */
585 extern bool might_dump
;
587 /* True means Emacs has already been initialized.
588 Used during startup to detect startup of dumped Emacs. */
589 extern bool initialized
;
591 /* Defined in floatfns.c. */
592 extern double extract_float (Lisp_Object
);
595 /* Low-level conversion and type checking. */
597 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
598 At the machine level, these operations are no-ops. */
601 (XLI
) (Lisp_Object o
)
603 return lisp_h_XLI (o
);
609 return lisp_h_XIL (i
);
612 /* Extract A's type. */
614 INLINE
enum Lisp_Type
615 (XTYPE
) (Lisp_Object a
)
618 return lisp_h_XTYPE (a
);
620 EMACS_UINT i
= XLI (a
);
621 return USE_LSB_TAG
? i
& ~VALMASK
: i
>> VALBITS
;
626 (CHECK_TYPE
) (int ok
, Lisp_Object predicate
, Lisp_Object x
)
628 lisp_h_CHECK_TYPE (ok
, predicate
, x
);
631 /* Extract A's pointer value, assuming A's type is TYPE. */
634 (XUNTAG
) (Lisp_Object a
, int type
)
637 return lisp_h_XUNTAG (a
, type
);
639 intptr_t i
= USE_LSB_TAG
? XLI (a
) - type
: XLI (a
) & VALMASK
;
645 /* Interned state of a symbol. */
649 SYMBOL_UNINTERNED
= 0,
651 SYMBOL_INTERNED_IN_INITIAL_OBARRAY
= 2
658 SYMBOL_LOCALIZED
= 2,
662 enum symbol_trapped_write
664 SYMBOL_UNTRAPPED_WRITE
= 0,
666 SYMBOL_TRAPPED_WRITE
= 2
671 bool_bf gcmarkbit
: 1;
673 /* Indicates where the value can be found:
674 0 : it's a plain var, the value is in the `value' field.
675 1 : it's a varalias, the value is really in the `alias' symbol.
676 2 : it's a localized var, the value is in the `blv' object.
677 3 : it's a forwarding variable, the value is in `forward'. */
678 ENUM_BF (symbol_redirect
) redirect
: 3;
680 /* 0 : normal case, just set the value
681 1 : constant, cannot set, e.g. nil, t, :keywords.
682 2 : trap the write, call watcher functions. */
683 ENUM_BF (symbol_trapped_write
) trapped_write
: 2;
685 /* Interned state of the symbol. This is an enumerator from
686 enum symbol_interned. */
687 unsigned interned
: 2;
689 /* True means that this variable has been explicitly declared
690 special (with `defvar' etc), and shouldn't be lexically bound. */
691 bool_bf declared_special
: 1;
693 /* True if pointed to from purespace and hence can't be GC'd. */
696 /* The symbol's name, as a Lisp string. */
699 /* Value of the symbol or Qunbound if unbound. Which alternative of the
700 union is used depends on the `redirect' field above. */
703 struct Lisp_Symbol
*alias
;
704 struct Lisp_Buffer_Local_Value
*blv
;
708 /* Function value of the symbol or Qnil if not fboundp. */
709 Lisp_Object function
;
711 /* The symbol's property list. */
714 /* Next symbol in obarray bucket, if the symbol is interned. */
715 struct Lisp_Symbol
*next
;
718 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
719 meaning as in the DEFUN macro, and is used to construct a prototype. */
720 /* We can use the same trick as in the DEFUN macro to generate the
721 appropriate prototype. */
722 #define EXFUN(fnname, maxargs) \
723 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
725 /* Note that the weird token-substitution semantics of ANSI C makes
726 this work for MANY and UNEVALLED. */
727 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
728 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
729 #define DEFUN_ARGS_0 (void)
730 #define DEFUN_ARGS_1 (Lisp_Object)
731 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
732 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
733 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
734 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
736 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
737 Lisp_Object, Lisp_Object)
738 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
739 Lisp_Object, Lisp_Object, Lisp_Object)
740 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
741 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
743 /* Yield a signed integer that contains TAG along with PTR.
745 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
746 and zero-extend otherwise (that’s a bit faster here).
747 Sign extension matters only when EMACS_INT is wider than a pointer. */
748 #define TAG_PTR(tag, ptr) \
750 ? (intptr_t) (ptr) + (tag) \
751 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
753 /* Yield an integer that contains a symbol tag along with OFFSET.
754 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
755 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
757 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
758 XLI (builtin_lisp_symbol (Qwhatever)),
759 except the former expands to an integer constant expression. */
760 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
762 /* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
763 designed for use as an initializer, even for a constant initializer. */
764 #define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))
766 /* Declare extern constants for Lisp symbols. These can be helpful
767 when using a debugger like GDB, on older platforms where the debug
768 format does not represent C macros. */
769 #define DEFINE_LISP_SYMBOL(name) \
770 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
771 DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
773 /* The index of the C-defined Lisp symbol SYM.
774 This can be used in a static initializer. */
775 #define SYMBOL_INDEX(sym) i##sym
777 /* By default, define macros for Qt, etc., as this leads to a bit
778 better performance in the core Emacs interpreter. A plugin can
779 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
780 other Emacs instances that assign different values to Qt, etc. */
781 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
782 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
787 /* Header of vector-like objects. This documents the layout constraints on
788 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
789 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
790 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
791 because when two such pointers potentially alias, a compiler won't
792 incorrectly reorder loads and stores to their size fields. See
794 struct vectorlike_header
796 /* The only field contains various pieces of information:
797 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
798 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
799 vector (0) or a pseudovector (1).
800 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
801 of slots) of the vector.
802 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
803 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
804 - b) number of Lisp_Objects slots at the beginning of the object
805 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
807 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
808 measured in word_size units. Rest fields may also include
809 Lisp_Objects, but these objects usually needs some special treatment
811 There are some exceptions. For PVEC_FREE, b) is always zero. For
812 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
813 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
814 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
819 (SYMBOLP
) (Lisp_Object x
)
821 return lisp_h_SYMBOLP (x
);
824 INLINE
struct Lisp_Symbol
*
825 (XSYMBOL
) (Lisp_Object a
)
828 return lisp_h_XSYMBOL (a
);
830 eassert (SYMBOLP (a
));
831 intptr_t i
= (intptr_t) XUNTAG (a
, Lisp_Symbol
);
832 void *p
= (char *) lispsym
+ i
;
838 make_lisp_symbol (struct Lisp_Symbol
*sym
)
840 Lisp_Object a
= XIL (TAG_SYMOFFSET ((char *) sym
- (char *) lispsym
));
841 eassert (XSYMBOL (a
) == sym
);
846 builtin_lisp_symbol (int index
)
848 return make_lisp_symbol (&lispsym
[index
].s
);
852 (CHECK_SYMBOL
) (Lisp_Object x
)
854 lisp_h_CHECK_SYMBOL (x
);
857 /* In the size word of a vector, this bit means the vector has been marked. */
859 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG
)
860 # define ARRAY_MARK_FLAG PTRDIFF_MIN
861 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG
)
863 /* In the size word of a struct Lisp_Vector, this bit means it's really
864 some other vector-like object. */
865 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG
)
866 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
867 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG
)
869 /* In a pseudovector, the size field actually contains a word with one
870 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
871 with PVEC_TYPE_MASK to indicate the actual type. */
883 PVEC_WINDOW_CONFIGURATION
,
885 PVEC_OTHER
, /* Should never be visible to Elisp code. */
891 PVEC_MODULE_FUNCTION
,
893 /* These should be last, check internal_equal to see why. */
898 PVEC_FONT
/* Should be last because it's used for range checking. */
903 /* For convenience, we also store the number of elements in these bits.
904 Note that this size is not necessarily the memory-footprint size, but
905 only the number of Lisp_Object fields (that need to be traced by GC).
906 The distinction is used, e.g., by Lisp_Process, which places extra
907 non-Lisp_Object fields at the end of the structure. */
908 PSEUDOVECTOR_SIZE_BITS
= 12,
909 PSEUDOVECTOR_SIZE_MASK
= (1 << PSEUDOVECTOR_SIZE_BITS
) - 1,
911 /* To calculate the memory footprint of the pseudovector, it's useful
912 to store the size of non-Lisp area in word_size units here. */
913 PSEUDOVECTOR_REST_BITS
= 12,
914 PSEUDOVECTOR_REST_MASK
= (((1 << PSEUDOVECTOR_REST_BITS
) - 1)
915 << PSEUDOVECTOR_SIZE_BITS
),
917 /* Used to extract pseudovector subtype information. */
918 PSEUDOVECTOR_AREA_BITS
= PSEUDOVECTOR_SIZE_BITS
+ PSEUDOVECTOR_REST_BITS
,
919 PVEC_TYPE_MASK
= 0x3f << PSEUDOVECTOR_AREA_BITS
922 /* These functions extract various sorts of values from a Lisp_Object.
923 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
924 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
927 /* Largest and smallest representable fixnum values. These are the C
928 values. They are macros for use in static initializers. */
929 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
930 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
935 (make_number
) (EMACS_INT n
)
937 return lisp_h_make_number (n
);
941 (XINT
) (Lisp_Object a
)
943 return lisp_h_XINT (a
);
947 (XFASTINT
) (Lisp_Object a
)
949 EMACS_INT n
= lisp_h_XFASTINT (a
);
954 #else /* ! USE_LSB_TAG */
956 /* Although compiled only if ! USE_LSB_TAG, the following functions
957 also work when USE_LSB_TAG; this is to aid future maintenance when
958 the lisp_h_* macros are eventually removed. */
960 /* Make a Lisp integer representing the value of the low order
963 make_number (EMACS_INT n
)
965 EMACS_INT int0
= Lisp_Int0
;
969 n
= u
<< INTTYPEBITS
;
975 n
+= (int0
<< VALBITS
);
980 /* Extract A's value as a signed integer. */
984 EMACS_INT i
= XLI (a
);
988 i
= u
<< INTTYPEBITS
;
990 return i
>> INTTYPEBITS
;
993 /* Like XINT (A), but may be faster. A must be nonnegative.
994 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
995 integers have zero-bits in their tags. */
997 XFASTINT (Lisp_Object a
)
999 EMACS_INT int0
= Lisp_Int0
;
1000 EMACS_INT n
= USE_LSB_TAG
? XINT (a
) : XLI (a
) - (int0
<< VALBITS
);
1005 #endif /* ! USE_LSB_TAG */
1007 /* Extract A's value as an unsigned integer. */
1009 XUINT (Lisp_Object a
)
1011 EMACS_UINT i
= XLI (a
);
1012 return USE_LSB_TAG
? i
>> INTTYPEBITS
: i
& INTMASK
;
1015 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
1016 right now, but XUINT should only be applied to objects we know are
1020 (XHASH
) (Lisp_Object a
)
1022 return lisp_h_XHASH (a
);
1025 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
1027 make_natnum (EMACS_INT n
)
1029 eassert (0 <= n
&& n
<= MOST_POSITIVE_FIXNUM
);
1030 EMACS_INT int0
= Lisp_Int0
;
1031 return USE_LSB_TAG
? make_number (n
) : XIL (n
+ (int0
<< VALBITS
));
1034 /* Return true if X and Y are the same object. */
1037 (EQ
) (Lisp_Object x
, Lisp_Object y
)
1039 return lisp_h_EQ (x
, y
);
1042 /* True if the possibly-unsigned integer I doesn't fit in a Lisp fixnum. */
1044 #define FIXNUM_OVERFLOW_P(i) \
1045 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
1048 clip_to_bounds (ptrdiff_t lower
, EMACS_INT num
, ptrdiff_t upper
)
1050 return num
< lower
? lower
: num
<= upper
? num
: upper
;
1053 /* Construct a Lisp_Object from a value or address. */
1056 make_lisp_ptr (void *ptr
, enum Lisp_Type type
)
1058 Lisp_Object a
= XIL (TAG_PTR (type
, ptr
));
1059 eassert (XTYPE (a
) == type
&& XUNTAG (a
, type
) == ptr
);
1064 (INTEGERP
) (Lisp_Object x
)
1066 return lisp_h_INTEGERP (x
);
1069 #define XSETINT(a, b) ((a) = make_number (b))
1070 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1071 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1072 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1073 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1074 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1075 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1076 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1078 /* Pseudovector types. */
1080 #define XSETPVECTYPE(v, code) \
1081 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1082 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1083 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1084 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1085 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1088 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1089 #define XSETPSEUDOVECTOR(a, b, code) \
1090 XSETTYPED_PSEUDOVECTOR (a, b, \
1091 (((struct vectorlike_header *) \
1092 XUNTAG (a, Lisp_Vectorlike)) \
1095 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1096 (XSETVECTOR (a, b), \
1097 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1098 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1100 #define XSETWINDOW_CONFIGURATION(a, b) \
1101 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1102 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1103 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1104 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1105 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1106 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1107 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1108 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1109 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1110 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1111 #define XSETTHREAD(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_THREAD))
1112 #define XSETMUTEX(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_MUTEX))
1113 #define XSETCONDVAR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CONDVAR))
1115 /* Efficiently convert a pointer to a Lisp object and back. The
1116 pointer is represented as a Lisp integer, so the garbage collector
1117 does not know about it. The pointer should not have both Lisp_Int1
1118 bits set, which makes this conversion inherently unportable. */
1121 XINTPTR (Lisp_Object a
)
1123 return XUNTAG (a
, Lisp_Int0
);
1127 make_pointer_integer (void *p
)
1129 Lisp_Object a
= XIL (TAG_PTR (Lisp_Int0
, p
));
1130 eassert (INTEGERP (a
) && XINTPTR (a
) == p
);
1134 /* See the macros in intervals.h. */
1136 typedef struct interval
*INTERVAL
;
1138 struct GCALIGNED Lisp_Cons
1140 /* Car of this cons cell. */
1145 /* Cdr of this cons cell. */
1148 /* Used to chain conses on a free list. */
1149 struct Lisp_Cons
*chain
;
1154 (NILP
) (Lisp_Object x
)
1156 return lisp_h_NILP (x
);
1160 (CONSP
) (Lisp_Object x
)
1162 return lisp_h_CONSP (x
);
1166 CHECK_CONS (Lisp_Object x
)
1168 CHECK_TYPE (CONSP (x
), Qconsp
, x
);
1171 INLINE
struct Lisp_Cons
*
1172 (XCONS
) (Lisp_Object a
)
1174 return lisp_h_XCONS (a
);
1177 /* Take the car or cdr of something known to be a cons cell. */
1178 /* The _addr functions shouldn't be used outside of the minimal set
1179 of code that has to know what a cons cell looks like. Other code not
1180 part of the basic lisp implementation should assume that the car and cdr
1181 fields are not accessible. (What if we want to switch to
1182 a copying collector someday? Cached cons cell field addresses may be
1183 invalidated at arbitrary points.) */
1184 INLINE Lisp_Object
*
1185 xcar_addr (Lisp_Object c
)
1187 return &XCONS (c
)->car
;
1189 INLINE Lisp_Object
*
1190 xcdr_addr (Lisp_Object c
)
1192 return &XCONS (c
)->u
.cdr
;
1195 /* Use these from normal code. */
1198 (XCAR
) (Lisp_Object c
)
1200 return lisp_h_XCAR (c
);
1204 (XCDR
) (Lisp_Object c
)
1206 return lisp_h_XCDR (c
);
1209 /* Use these to set the fields of a cons cell.
1211 Note that both arguments may refer to the same object, so 'n'
1212 should not be read after 'c' is first modified. */
1214 XSETCAR (Lisp_Object c
, Lisp_Object n
)
1219 XSETCDR (Lisp_Object c
, Lisp_Object n
)
1224 /* Take the car or cdr of something whose type is not known. */
1231 wrong_type_argument (Qlistp
, c
);
1240 wrong_type_argument (Qlistp
, c
);
1244 /* Take the car or cdr of something whose type is not known. */
1246 CAR_SAFE (Lisp_Object c
)
1248 return CONSP (c
) ? XCAR (c
) : Qnil
;
1251 CDR_SAFE (Lisp_Object c
)
1253 return CONSP (c
) ? XCDR (c
) : Qnil
;
1256 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1258 struct GCALIGNED Lisp_String
1261 ptrdiff_t size_byte
;
1262 INTERVAL intervals
; /* Text properties in this string. */
1263 unsigned char *data
;
1267 STRINGP (Lisp_Object x
)
1269 return XTYPE (x
) == Lisp_String
;
1273 CHECK_STRING (Lisp_Object x
)
1275 CHECK_TYPE (STRINGP (x
), Qstringp
, x
);
1278 INLINE
struct Lisp_String
*
1279 XSTRING (Lisp_Object a
)
1281 eassert (STRINGP (a
));
1282 return XUNTAG (a
, Lisp_String
);
1285 /* True if STR is a multibyte string. */
1287 STRING_MULTIBYTE (Lisp_Object str
)
1289 return 0 <= XSTRING (str
)->size_byte
;
1292 /* An upper bound on the number of bytes in a Lisp string, not
1293 counting the terminating null. This a tight enough bound to
1294 prevent integer overflow errors that would otherwise occur during
1295 string size calculations. A string cannot contain more bytes than
1296 a fixnum can represent, nor can it be so long that C pointer
1297 arithmetic stops working on the string plus its terminating null.
1298 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1299 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1300 would expose alloc.c internal details that we'd rather keep
1303 This is a macro for use in static initializers. The cast to
1304 ptrdiff_t ensures that the macro is signed. */
1305 #define STRING_BYTES_BOUND \
1306 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1308 /* Mark STR as a unibyte string. */
1309 #define STRING_SET_UNIBYTE(STR) \
1311 if (XSTRING (STR)->size == 0) \
1312 (STR) = empty_unibyte_string; \
1314 XSTRING (STR)->size_byte = -1; \
1317 /* Mark STR as a multibyte string. Assure that STR contains only
1318 ASCII characters in advance. */
1319 #define STRING_SET_MULTIBYTE(STR) \
1321 if (XSTRING (STR)->size == 0) \
1322 (STR) = empty_multibyte_string; \
1324 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1327 /* Convenience functions for dealing with Lisp strings. */
1329 INLINE
unsigned char *
1330 SDATA (Lisp_Object string
)
1332 return XSTRING (string
)->data
;
1335 SSDATA (Lisp_Object string
)
1337 /* Avoid "differ in sign" warnings. */
1338 return (char *) SDATA (string
);
1340 INLINE
unsigned char
1341 SREF (Lisp_Object string
, ptrdiff_t index
)
1343 return SDATA (string
)[index
];
1346 SSET (Lisp_Object string
, ptrdiff_t index
, unsigned char new)
1348 SDATA (string
)[index
] = new;
1351 SCHARS (Lisp_Object string
)
1353 ptrdiff_t nchars
= XSTRING (string
)->size
;
1354 eassume (0 <= nchars
);
1358 #ifdef GC_CHECK_STRING_BYTES
1359 extern ptrdiff_t string_bytes (struct Lisp_String
*);
1362 STRING_BYTES (struct Lisp_String
*s
)
1364 #ifdef GC_CHECK_STRING_BYTES
1365 ptrdiff_t nbytes
= string_bytes (s
);
1367 ptrdiff_t nbytes
= s
->size_byte
< 0 ? s
->size
: s
->size_byte
;
1369 eassume (0 <= nbytes
);
1374 SBYTES (Lisp_Object string
)
1376 return STRING_BYTES (XSTRING (string
));
1379 STRING_SET_CHARS (Lisp_Object string
, ptrdiff_t newsize
)
1381 /* This function cannot change the size of data allocated for the
1382 string when it was created. */
1383 eassert (STRING_MULTIBYTE (string
)
1384 ? 0 <= newsize
&& newsize
<= SBYTES (string
)
1385 : newsize
== SCHARS (string
));
1386 XSTRING (string
)->size
= newsize
;
1389 /* A regular vector is just a header plus an array of Lisp_Objects. */
1393 struct vectorlike_header header
;
1394 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1398 (VECTORLIKEP
) (Lisp_Object x
)
1400 return lisp_h_VECTORLIKEP (x
);
1403 INLINE
struct Lisp_Vector
*
1404 XVECTOR (Lisp_Object a
)
1406 eassert (VECTORLIKEP (a
));
1407 return XUNTAG (a
, Lisp_Vectorlike
);
1411 ASIZE (Lisp_Object array
)
1413 ptrdiff_t size
= XVECTOR (array
)->header
.size
;
1414 eassume (0 <= size
);
1419 PVSIZE (Lisp_Object pv
)
1421 return ASIZE (pv
) & PSEUDOVECTOR_SIZE_MASK
;
1425 VECTORP (Lisp_Object x
)
1427 return VECTORLIKEP (x
) && ! (ASIZE (x
) & PSEUDOVECTOR_FLAG
);
1431 CHECK_VECTOR (Lisp_Object x
)
1433 CHECK_TYPE (VECTORP (x
), Qvectorp
, x
);
1437 /* A pseudovector is like a vector, but has other non-Lisp components. */
1439 INLINE
enum pvec_type
1440 PSEUDOVECTOR_TYPE (struct Lisp_Vector
*v
)
1442 ptrdiff_t size
= v
->header
.size
;
1443 return (size
& PSEUDOVECTOR_FLAG
1444 ? (size
& PVEC_TYPE_MASK
) >> PSEUDOVECTOR_AREA_BITS
1445 : PVEC_NORMAL_VECTOR
);
1448 /* Can't be used with PVEC_NORMAL_VECTOR. */
1450 PSEUDOVECTOR_TYPEP (struct vectorlike_header
*a
, enum pvec_type code
)
1452 /* We don't use PSEUDOVECTOR_TYPE here so as to avoid a shift
1453 * operation when `code' is known. */
1454 return ((a
->size
& (PSEUDOVECTOR_FLAG
| PVEC_TYPE_MASK
))
1455 == (PSEUDOVECTOR_FLAG
| (code
<< PSEUDOVECTOR_AREA_BITS
)));
1458 /* True if A is a pseudovector whose code is CODE. */
1460 PSEUDOVECTORP (Lisp_Object a
, int code
)
1462 if (! VECTORLIKEP (a
))
1466 /* Converting to struct vectorlike_header * avoids aliasing issues. */
1467 struct vectorlike_header
*h
= XUNTAG (a
, Lisp_Vectorlike
);
1468 return PSEUDOVECTOR_TYPEP (h
, code
);
1472 /* A boolvector is a kind of vectorlike, with contents like a string. */
1474 struct Lisp_Bool_Vector
1476 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1477 just the subtype information. */
1478 struct vectorlike_header header
;
1479 /* This is the size in bits. */
1481 /* The actual bits, packed into bytes.
1482 Zeros fill out the last word if needed.
1483 The bits are in little-endian order in the bytes, and
1484 the bytes are in little-endian order in the words. */
1485 bits_word data
[FLEXIBLE_ARRAY_MEMBER
];
1488 /* Some handy constants for calculating sizes
1489 and offsets, mostly of vectorlike objects. */
1493 header_size
= offsetof (struct Lisp_Vector
, contents
),
1494 bool_header_size
= offsetof (struct Lisp_Bool_Vector
, data
),
1495 word_size
= sizeof (Lisp_Object
)
1498 /* The number of data words and bytes in a bool vector with SIZE bits. */
1501 bool_vector_words (EMACS_INT size
)
1503 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1504 return (size
+ BITS_PER_BITS_WORD
- 1) / BITS_PER_BITS_WORD
;
1508 bool_vector_bytes (EMACS_INT size
)
1510 eassume (0 <= size
&& size
<= EMACS_INT_MAX
- (BITS_PER_BITS_WORD
- 1));
1511 return (size
+ BOOL_VECTOR_BITS_PER_CHAR
- 1) / BOOL_VECTOR_BITS_PER_CHAR
;
1515 BOOL_VECTOR_P (Lisp_Object a
)
1517 return PSEUDOVECTORP (a
, PVEC_BOOL_VECTOR
);
1521 CHECK_BOOL_VECTOR (Lisp_Object x
)
1523 CHECK_TYPE (BOOL_VECTOR_P (x
), Qbool_vector_p
, x
);
1526 INLINE
struct Lisp_Bool_Vector
*
1527 XBOOL_VECTOR (Lisp_Object a
)
1529 eassert (BOOL_VECTOR_P (a
));
1530 return XUNTAG (a
, Lisp_Vectorlike
);
1534 bool_vector_size (Lisp_Object a
)
1536 EMACS_INT size
= XBOOL_VECTOR (a
)->size
;
1537 eassume (0 <= size
);
1542 bool_vector_data (Lisp_Object a
)
1544 return XBOOL_VECTOR (a
)->data
;
1547 INLINE
unsigned char *
1548 bool_vector_uchar_data (Lisp_Object a
)
1550 return (unsigned char *) bool_vector_data (a
);
1553 /* True if A's Ith bit is set. */
1556 bool_vector_bitref (Lisp_Object a
, EMACS_INT i
)
1558 eassume (0 <= i
&& i
< bool_vector_size (a
));
1559 return !! (bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
]
1560 & (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
)));
1564 bool_vector_ref (Lisp_Object a
, EMACS_INT i
)
1566 return bool_vector_bitref (a
, i
) ? Qt
: Qnil
;
1569 /* Set A's Ith bit to B. */
1572 bool_vector_set (Lisp_Object a
, EMACS_INT i
, bool b
)
1574 unsigned char *addr
;
1576 eassume (0 <= i
&& i
< bool_vector_size (a
));
1577 addr
= &bool_vector_uchar_data (a
)[i
/ BOOL_VECTOR_BITS_PER_CHAR
];
1580 *addr
|= 1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
);
1582 *addr
&= ~ (1 << (i
% BOOL_VECTOR_BITS_PER_CHAR
));
1585 /* Conveniences for dealing with Lisp arrays. */
1588 AREF (Lisp_Object array
, ptrdiff_t idx
)
1590 return XVECTOR (array
)->contents
[idx
];
1593 INLINE Lisp_Object
*
1594 aref_addr (Lisp_Object array
, ptrdiff_t idx
)
1596 return & XVECTOR (array
)->contents
[idx
];
1600 gc_asize (Lisp_Object array
)
1602 /* Like ASIZE, but also can be used in the garbage collector. */
1603 return XVECTOR (array
)->header
.size
& ~ARRAY_MARK_FLAG
;
1607 ASET (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1609 eassert (0 <= idx
&& idx
< ASIZE (array
));
1610 XVECTOR (array
)->contents
[idx
] = val
;
1614 gc_aset (Lisp_Object array
, ptrdiff_t idx
, Lisp_Object val
)
1616 /* Like ASET, but also can be used in the garbage collector:
1617 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1618 eassert (0 <= idx
&& idx
< gc_asize (array
));
1619 XVECTOR (array
)->contents
[idx
] = val
;
1622 /* True, since Qnil's representation is zero. Every place in the code
1623 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1624 to find such assumptions later if we change Qnil to be nonzero. */
1625 enum { NIL_IS_ZERO
= XLI_BUILTIN_LISPSYM (iQnil
) == 0 };
1627 /* Clear the object addressed by P, with size NBYTES, so that all its
1628 bytes are zero and all its Lisp values are nil. */
1630 memclear (void *p
, ptrdiff_t nbytes
)
1632 eassert (0 <= nbytes
);
1633 verify (NIL_IS_ZERO
);
1634 /* Since Qnil is zero, memset suffices. */
1635 memset (p
, 0, nbytes
);
1638 /* If a struct is made to look like a vector, this macro returns the length
1639 of the shortest vector that would hold that struct. */
1641 #define VECSIZE(type) \
1642 ((sizeof (type) - header_size + word_size - 1) / word_size)
1644 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1645 at the end and we need to compute the number of Lisp_Object fields (the
1646 ones that the GC needs to trace). */
1648 #define PSEUDOVECSIZE(type, nonlispfield) \
1649 ((offsetof (type, nonlispfield) - header_size) / word_size)
1651 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1652 should be integer expressions. This is not the same as
1653 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1654 returns true. For efficiency, prefer plain unsigned comparison if A
1655 and B's sizes both fit (after integer promotion). */
1656 #define UNSIGNED_CMP(a, op, b) \
1657 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1658 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1659 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1661 /* True iff C is an ASCII character. */
1662 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1664 /* A char-table is a kind of vectorlike, with contents are like a
1665 vector but with a few other slots. For some purposes, it makes
1666 sense to handle a char-table with type struct Lisp_Vector. An
1667 element of a char table can be any Lisp objects, but if it is a sub
1668 char-table, we treat it a table that contains information of a
1669 specific range of characters. A sub char-table is like a vector but
1670 with two integer fields between the header and Lisp data, which means
1671 that it has to be marked with some precautions (see mark_char_table
1672 in alloc.c). A sub char-table appears only in an element of a char-table,
1673 and there's no way to access it directly from Emacs Lisp program. */
1675 enum CHARTAB_SIZE_BITS
1677 CHARTAB_SIZE_BITS_0
= 6,
1678 CHARTAB_SIZE_BITS_1
= 4,
1679 CHARTAB_SIZE_BITS_2
= 5,
1680 CHARTAB_SIZE_BITS_3
= 7
1683 extern const int chartab_size
[4];
1685 struct Lisp_Char_Table
1687 /* HEADER.SIZE is the vector's size field, which also holds the
1688 pseudovector type information. It holds the size, too.
1689 The size counts the defalt, parent, purpose, ascii,
1690 contents, and extras slots. */
1691 struct vectorlike_header header
;
1693 /* This holds a default value,
1694 which is used whenever the value for a specific character is nil. */
1697 /* This points to another char table, which we inherit from when the
1698 value for a specific character is nil. The `defalt' slot takes
1699 precedence over this. */
1702 /* This is a symbol which says what kind of use this char-table is
1704 Lisp_Object purpose
;
1706 /* The bottom sub char-table for characters of the range 0..127. It
1707 is nil if none of ASCII character has a specific value. */
1710 Lisp_Object contents
[(1 << CHARTAB_SIZE_BITS_0
)];
1712 /* These hold additional data. It is a vector. */
1713 Lisp_Object extras
[FLEXIBLE_ARRAY_MEMBER
];
1717 CHAR_TABLE_P (Lisp_Object a
)
1719 return PSEUDOVECTORP (a
, PVEC_CHAR_TABLE
);
1722 INLINE
struct Lisp_Char_Table
*
1723 XCHAR_TABLE (Lisp_Object a
)
1725 eassert (CHAR_TABLE_P (a
));
1726 return XUNTAG (a
, Lisp_Vectorlike
);
1729 struct Lisp_Sub_Char_Table
1731 /* HEADER.SIZE is the vector's size field, which also holds the
1732 pseudovector type information. It holds the size, too. */
1733 struct vectorlike_header header
;
1735 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1736 char-table of depth 1 contains 16 elements, and each element
1737 covers 4096 (128*32) characters. A sub char-table of depth 2
1738 contains 32 elements, and each element covers 128 characters. A
1739 sub char-table of depth 3 contains 128 elements, and each element
1740 is for one character. */
1743 /* Minimum character covered by the sub char-table. */
1746 /* Use set_sub_char_table_contents to set this. */
1747 Lisp_Object contents
[FLEXIBLE_ARRAY_MEMBER
];
1751 SUB_CHAR_TABLE_P (Lisp_Object a
)
1753 return PSEUDOVECTORP (a
, PVEC_SUB_CHAR_TABLE
);
1756 INLINE
struct Lisp_Sub_Char_Table
*
1757 XSUB_CHAR_TABLE (Lisp_Object a
)
1759 eassert (SUB_CHAR_TABLE_P (a
));
1760 return XUNTAG (a
, Lisp_Vectorlike
);
1764 CHAR_TABLE_REF_ASCII (Lisp_Object ct
, ptrdiff_t idx
)
1766 struct Lisp_Char_Table
*tbl
= NULL
;
1770 tbl
= tbl
? XCHAR_TABLE (tbl
->parent
) : XCHAR_TABLE (ct
);
1771 val
= (! SUB_CHAR_TABLE_P (tbl
->ascii
) ? tbl
->ascii
1772 : XSUB_CHAR_TABLE (tbl
->ascii
)->contents
[idx
]);
1776 while (NILP (val
) && ! NILP (tbl
->parent
));
1781 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1782 characters. Do not check validity of CT. */
1784 CHAR_TABLE_REF (Lisp_Object ct
, int idx
)
1786 return (ASCII_CHAR_P (idx
)
1787 ? CHAR_TABLE_REF_ASCII (ct
, idx
)
1788 : char_table_ref (ct
, idx
));
1791 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1792 8-bit European characters. Do not check validity of CT. */
1794 CHAR_TABLE_SET (Lisp_Object ct
, int idx
, Lisp_Object val
)
1796 if (ASCII_CHAR_P (idx
) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct
)->ascii
))
1797 set_sub_char_table_contents (XCHAR_TABLE (ct
)->ascii
, idx
, val
);
1799 char_table_set (ct
, idx
, val
);
1802 /* This structure describes a built-in function.
1803 It is generated by the DEFUN macro only.
1804 defsubr makes it into a Lisp object. */
1808 struct vectorlike_header header
;
1810 Lisp_Object (*a0
) (void);
1811 Lisp_Object (*a1
) (Lisp_Object
);
1812 Lisp_Object (*a2
) (Lisp_Object
, Lisp_Object
);
1813 Lisp_Object (*a3
) (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1814 Lisp_Object (*a4
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1815 Lisp_Object (*a5
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1816 Lisp_Object (*a6
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1817 Lisp_Object (*a7
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1818 Lisp_Object (*a8
) (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
1819 Lisp_Object (*aUNEVALLED
) (Lisp_Object args
);
1820 Lisp_Object (*aMANY
) (ptrdiff_t, Lisp_Object
*);
1822 short min_args
, max_args
;
1823 const char *symbol_name
;
1824 const char *intspec
;
1829 SUBRP (Lisp_Object a
)
1831 return PSEUDOVECTORP (a
, PVEC_SUBR
);
1834 INLINE
struct Lisp_Subr
*
1835 XSUBR (Lisp_Object a
)
1837 eassert (SUBRP (a
));
1838 return XUNTAG (a
, Lisp_Vectorlike
);
1841 enum char_table_specials
1843 /* This is the number of slots that every char table must have. This
1844 counts the ordinary slots and the top, defalt, parent, and purpose
1846 CHAR_TABLE_STANDARD_SLOTS
= PSEUDOVECSIZE (struct Lisp_Char_Table
, extras
),
1848 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1849 when the latter is treated as an ordinary Lisp_Vector. */
1850 SUB_CHAR_TABLE_OFFSET
= PSEUDOVECSIZE (struct Lisp_Sub_Char_Table
, contents
)
1853 /* Return the number of "extra" slots in the char table CT. */
1856 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table
*ct
)
1858 return ((ct
->header
.size
& PSEUDOVECTOR_SIZE_MASK
)
1859 - CHAR_TABLE_STANDARD_SLOTS
);
1862 /* Make sure that sub char-table contents slot is where we think it is. */
1863 verify (offsetof (struct Lisp_Sub_Char_Table
, contents
)
1864 == (offsetof (struct Lisp_Vector
, contents
)
1865 + SUB_CHAR_TABLE_OFFSET
* sizeof (Lisp_Object
)));
1869 /***********************************************************************
1871 ***********************************************************************/
1873 /* Value is name of symbol. */
1876 (SYMBOL_VAL
) (struct Lisp_Symbol
*sym
)
1878 return lisp_h_SYMBOL_VAL (sym
);
1881 INLINE
struct Lisp_Symbol
*
1882 SYMBOL_ALIAS (struct Lisp_Symbol
*sym
)
1884 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& sym
->val
.alias
);
1885 return sym
->val
.alias
;
1887 INLINE
struct Lisp_Buffer_Local_Value
*
1888 SYMBOL_BLV (struct Lisp_Symbol
*sym
)
1890 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& sym
->val
.blv
);
1891 return sym
->val
.blv
;
1893 INLINE
union Lisp_Fwd
*
1894 SYMBOL_FWD (struct Lisp_Symbol
*sym
)
1896 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& sym
->val
.fwd
);
1897 return sym
->val
.fwd
;
1901 (SET_SYMBOL_VAL
) (struct Lisp_Symbol
*sym
, Lisp_Object v
)
1903 lisp_h_SET_SYMBOL_VAL (sym
, v
);
1907 SET_SYMBOL_ALIAS (struct Lisp_Symbol
*sym
, struct Lisp_Symbol
*v
)
1909 eassume (sym
->redirect
== SYMBOL_VARALIAS
&& v
);
1913 SET_SYMBOL_BLV (struct Lisp_Symbol
*sym
, struct Lisp_Buffer_Local_Value
*v
)
1915 eassume (sym
->redirect
== SYMBOL_LOCALIZED
&& v
);
1919 SET_SYMBOL_FWD (struct Lisp_Symbol
*sym
, union Lisp_Fwd
*v
)
1921 eassume (sym
->redirect
== SYMBOL_FORWARDED
&& v
);
1926 SYMBOL_NAME (Lisp_Object sym
)
1928 return XSYMBOL (sym
)->name
;
1931 /* Value is true if SYM is an interned symbol. */
1934 SYMBOL_INTERNED_P (Lisp_Object sym
)
1936 return XSYMBOL (sym
)->interned
!= SYMBOL_UNINTERNED
;
1939 /* Value is true if SYM is interned in initial_obarray. */
1942 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym
)
1944 return XSYMBOL (sym
)->interned
== SYMBOL_INTERNED_IN_INITIAL_OBARRAY
;
1947 /* Value is non-zero if symbol cannot be changed through a simple set,
1948 i.e. it's a constant (e.g. nil, t, :keywords), or it has some
1949 watching functions. */
1952 (SYMBOL_TRAPPED_WRITE_P
) (Lisp_Object sym
)
1954 return lisp_h_SYMBOL_TRAPPED_WRITE_P (sym
);
1957 /* Value is non-zero if symbol cannot be changed at all, i.e. it's a
1958 constant (e.g. nil, t, :keywords). Code that actually wants to
1959 write to SYM, should also check whether there are any watching
1963 (SYMBOL_CONSTANT_P
) (Lisp_Object sym
)
1965 return lisp_h_SYMBOL_CONSTANT_P (sym
);
1968 /* Placeholder for make-docfile to process. The actual symbol
1969 definition is done by lread.c's defsym. */
1970 #define DEFSYM(sym, name) /* empty */
1973 /***********************************************************************
1975 ***********************************************************************/
1977 /* The structure of a Lisp hash table. */
1979 struct hash_table_test
1981 /* Name of the function used to compare keys. */
1984 /* User-supplied hash function, or nil. */
1985 Lisp_Object user_hash_function
;
1987 /* User-supplied key comparison function, or nil. */
1988 Lisp_Object user_cmp_function
;
1990 /* C function to compare two keys. */
1991 bool (*cmpfn
) (struct hash_table_test
*t
, Lisp_Object
, Lisp_Object
);
1993 /* C function to compute hash code. */
1994 EMACS_UINT (*hashfn
) (struct hash_table_test
*t
, Lisp_Object
);
1997 struct Lisp_Hash_Table
1999 /* This is for Lisp; the hash table code does not refer to it. */
2000 struct vectorlike_header header
;
2002 /* Nil if table is non-weak. Otherwise a symbol describing the
2003 weakness of the table. */
2006 /* Vector of hash codes. If hash[I] is nil, this means that the
2007 I-th entry is unused. */
2010 /* Vector used to chain entries. If entry I is free, next[I] is the
2011 entry number of the next free item. If entry I is non-free,
2012 next[I] is the index of the next entry in the collision chain,
2013 or -1 if there is such entry. */
2016 /* Bucket vector. An entry of -1 indicates no item is present,
2017 and a nonnegative entry is the index of the first item in
2018 a collision chain. This vector's size can be larger than the
2019 hash table size to reduce collisions. */
2022 /* Only the fields above are traced normally by the GC. The ones below
2023 `count' are special and are either ignored by the GC or traced in
2024 a special way (e.g. because of weakness). */
2026 /* Number of key/value entries in the table. */
2029 /* Index of first free entry in free list, or -1 if none. */
2030 ptrdiff_t next_free
;
2032 /* True if the table can be purecopied. The table cannot be
2033 changed afterwards. */
2036 /* Resize hash table when number of entries / table size is >= this
2038 float rehash_threshold
;
2040 /* Used when the table is resized. If equal to a negative integer,
2041 the user rehash-size is the integer -REHASH_SIZE, and the new
2042 size is the old size plus -REHASH_SIZE. If positive, the user
2043 rehash-size is the floating-point value REHASH_SIZE + 1, and the
2044 new size is the old size times REHASH_SIZE + 1. */
2047 /* Vector of keys and values. The key of item I is found at index
2048 2 * I, the value is found at index 2 * I + 1.
2049 This is gc_marked specially if the table is weak. */
2050 Lisp_Object key_and_value
;
2052 /* The comparison and hash functions. */
2053 struct hash_table_test test
;
2055 /* Next weak hash table if this is a weak hash table. The head
2056 of the list is in weak_hash_tables. */
2057 struct Lisp_Hash_Table
*next_weak
;
2062 HASH_TABLE_P (Lisp_Object a
)
2064 return PSEUDOVECTORP (a
, PVEC_HASH_TABLE
);
2067 INLINE
struct Lisp_Hash_Table
*
2068 XHASH_TABLE (Lisp_Object a
)
2070 eassert (HASH_TABLE_P (a
));
2071 return XUNTAG (a
, Lisp_Vectorlike
);
2074 #define XSET_HASH_TABLE(VAR, PTR) \
2075 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
2077 /* Value is the key part of entry IDX in hash table H. */
2079 HASH_KEY (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2081 return AREF (h
->key_and_value
, 2 * idx
);
2084 /* Value is the value part of entry IDX in hash table H. */
2086 HASH_VALUE (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2088 return AREF (h
->key_and_value
, 2 * idx
+ 1);
2091 /* Value is the hash code computed for entry IDX in hash table H. */
2093 HASH_HASH (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
)
2095 return AREF (h
->hash
, idx
);
2098 /* Value is the size of hash table H. */
2100 HASH_TABLE_SIZE (struct Lisp_Hash_Table
*h
)
2102 return ASIZE (h
->next
);
2105 /* Default size for hash tables if not specified. */
2107 enum DEFAULT_HASH_SIZE
{ DEFAULT_HASH_SIZE
= 65 };
2109 /* Default threshold specifying when to resize a hash table. The
2110 value gives the ratio of current entries in the hash table and the
2111 size of the hash table. */
2113 static float const DEFAULT_REHASH_THRESHOLD
= 0.8125;
2115 /* Default factor by which to increase the size of a hash table, minus 1. */
2117 static float const DEFAULT_REHASH_SIZE
= 1.5 - 1;
2119 /* Combine two integers X and Y for hashing. The result might not fit
2120 into a Lisp integer. */
2123 sxhash_combine (EMACS_UINT x
, EMACS_UINT y
)
2125 return (x
<< 4) + (x
>> (EMACS_INT_WIDTH
- 4)) + y
;
2128 /* Hash X, returning a value that fits into a fixnum. */
2131 SXHASH_REDUCE (EMACS_UINT x
)
2133 return (x
^ x
>> (EMACS_INT_WIDTH
- FIXNUM_BITS
)) & INTMASK
;
2136 /* These structures are used for various misc types. */
2138 struct Lisp_Misc_Any
/* Supertype of all Misc types. */
2140 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_??? */
2141 bool_bf gcmarkbit
: 1;
2142 unsigned spacer
: 15;
2146 (MISCP
) (Lisp_Object x
)
2148 return lisp_h_MISCP (x
);
2151 INLINE
struct Lisp_Misc_Any
*
2152 XMISCANY (Lisp_Object a
)
2154 eassert (MISCP (a
));
2155 return XUNTAG (a
, Lisp_Misc
);
2158 INLINE
enum Lisp_Misc_Type
2159 XMISCTYPE (Lisp_Object a
)
2161 return XMISCANY (a
)->type
;
2166 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Marker */
2167 bool_bf gcmarkbit
: 1;
2168 unsigned spacer
: 13;
2169 /* This flag is temporarily used in the functions
2170 decode/encode_coding_object to record that the marker position
2171 must be adjusted after the conversion. */
2172 bool_bf need_adjustment
: 1;
2173 /* True means normal insertion at the marker's position
2174 leaves the marker after the inserted text. */
2175 bool_bf insertion_type
: 1;
2176 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2177 Note: a chain of markers can contain markers pointing into different
2178 buffers (the chain is per buffer_text rather than per buffer, so it's
2179 shared between indirect buffers). */
2180 /* This is used for (other than NULL-checking):
2182 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2183 - unchain_marker: to find the list from which to unchain.
2184 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2186 struct buffer
*buffer
;
2188 /* The remaining fields are meaningless in a marker that
2189 does not point anywhere. */
2191 /* For markers that point somewhere,
2192 this is used to chain of all the markers in a given buffer. */
2193 /* We could remove it and use an array in buffer_text instead.
2194 That would also allow us to preserve it ordered. */
2195 struct Lisp_Marker
*next
;
2196 /* This is the char position where the marker points. */
2198 /* This is the byte position.
2199 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2200 used to implement the functionality of markers, but rather to (ab)use
2201 markers as a cache for char<->byte mappings). */
2205 /* START and END are markers in the overlay's buffer, and
2206 PLIST is the overlay's property list. */
2208 /* An overlay's real data content is:
2210 - buffer (really there are two buffer pointers, one per marker,
2211 and both points to the same buffer)
2212 - insertion type of both ends (per-marker fields)
2213 - start & start byte (of start marker)
2214 - end & end byte (of end marker)
2215 - next (singly linked list of overlays)
2216 - next fields of start and end markers (singly linked list of markers).
2217 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2220 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Overlay */
2221 bool_bf gcmarkbit
: 1;
2222 unsigned spacer
: 15;
2223 struct Lisp_Overlay
*next
;
2229 /* Number of bits needed to store one of the values
2230 SAVE_UNUSED..SAVE_OBJECT. */
2231 enum { SAVE_SLOT_BITS
= 3 };
2233 /* Number of slots in a save value where save_type is nonzero. */
2234 enum { SAVE_VALUE_SLOTS
= 4 };
2236 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2238 enum { SAVE_TYPE_BITS
= SAVE_VALUE_SLOTS
* SAVE_SLOT_BITS
+ 1 };
2240 /* Types of data which may be saved in a Lisp_Save_Value. */
2249 SAVE_TYPE_INT_INT
= SAVE_INTEGER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2250 SAVE_TYPE_INT_INT_INT
2251 = (SAVE_INTEGER
+ (SAVE_TYPE_INT_INT
<< SAVE_SLOT_BITS
)),
2252 SAVE_TYPE_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2253 SAVE_TYPE_OBJ_OBJ_OBJ
= SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2254 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2255 = SAVE_OBJECT
+ (SAVE_TYPE_OBJ_OBJ_OBJ
<< SAVE_SLOT_BITS
),
2256 SAVE_TYPE_PTR_INT
= SAVE_POINTER
+ (SAVE_INTEGER
<< SAVE_SLOT_BITS
),
2257 SAVE_TYPE_PTR_OBJ
= SAVE_POINTER
+ (SAVE_OBJECT
<< SAVE_SLOT_BITS
),
2258 SAVE_TYPE_PTR_PTR
= SAVE_POINTER
+ (SAVE_POINTER
<< SAVE_SLOT_BITS
),
2259 SAVE_TYPE_FUNCPTR_PTR_OBJ
2260 = SAVE_FUNCPOINTER
+ (SAVE_TYPE_PTR_OBJ
<< SAVE_SLOT_BITS
),
2262 /* This has an extra bit indicating it's raw memory. */
2263 SAVE_TYPE_MEMORY
= SAVE_TYPE_PTR_INT
+ (1 << (SAVE_TYPE_BITS
- 1))
2266 /* SAVE_SLOT_BITS must be large enough to represent these values. */
2267 verify (((SAVE_UNUSED
| SAVE_INTEGER
| SAVE_FUNCPOINTER
2268 | SAVE_POINTER
| SAVE_OBJECT
)
2272 /* Special object used to hold a different values for later use.
2274 This is mostly used to package C integers and pointers to call
2275 record_unwind_protect when two or more values need to be saved.
2279 struct my_data *md = get_my_data ();
2280 ptrdiff_t mi = get_my_integer ();
2281 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2284 Lisp_Object my_unwind (Lisp_Object arg)
2286 struct my_data *md = XSAVE_POINTER (arg, 0);
2287 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2291 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2292 saved objects and raise eassert if type of the saved object doesn't match
2293 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2294 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2295 slot 0 is a pointer. */
2297 typedef void (*voidfuncptr
) (void);
2299 struct Lisp_Save_Value
2301 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Save_Value */
2302 bool_bf gcmarkbit
: 1;
2303 unsigned spacer
: 32 - (16 + 1 + SAVE_TYPE_BITS
);
2305 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2306 V's data entries are determined by V->save_type. E.g., if
2307 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2308 V->data[1] is an integer, and V's other data entries are unused.
2310 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2311 a memory area containing V->data[1].integer potential Lisp_Objects. */
2312 ENUM_BF (Lisp_Save_Type
) save_type
: SAVE_TYPE_BITS
;
2315 voidfuncptr funcpointer
;
2318 } data
[SAVE_VALUE_SLOTS
];
2322 SAVE_VALUEP (Lisp_Object x
)
2324 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Save_Value
;
2327 INLINE
struct Lisp_Save_Value
*
2328 XSAVE_VALUE (Lisp_Object a
)
2330 eassert (SAVE_VALUEP (a
));
2331 return XUNTAG (a
, Lisp_Misc
);
2334 /* Return the type of V's Nth saved value. */
2336 save_type (struct Lisp_Save_Value
*v
, int n
)
2338 eassert (0 <= n
&& n
< SAVE_VALUE_SLOTS
);
2339 return (v
->save_type
>> (SAVE_SLOT_BITS
* n
) & ((1 << SAVE_SLOT_BITS
) - 1));
2342 /* Get and set the Nth saved pointer. */
2345 XSAVE_POINTER (Lisp_Object obj
, int n
)
2347 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2348 return XSAVE_VALUE (obj
)->data
[n
].pointer
;
2351 set_save_pointer (Lisp_Object obj
, int n
, void *val
)
2353 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_POINTER
);
2354 XSAVE_VALUE (obj
)->data
[n
].pointer
= val
;
2357 XSAVE_FUNCPOINTER (Lisp_Object obj
, int n
)
2359 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_FUNCPOINTER
);
2360 return XSAVE_VALUE (obj
)->data
[n
].funcpointer
;
2363 /* Likewise for the saved integer. */
2366 XSAVE_INTEGER (Lisp_Object obj
, int n
)
2368 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2369 return XSAVE_VALUE (obj
)->data
[n
].integer
;
2372 set_save_integer (Lisp_Object obj
, int n
, ptrdiff_t val
)
2374 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_INTEGER
);
2375 XSAVE_VALUE (obj
)->data
[n
].integer
= val
;
2378 /* Extract Nth saved object. */
2381 XSAVE_OBJECT (Lisp_Object obj
, int n
)
2383 eassert (save_type (XSAVE_VALUE (obj
), n
) == SAVE_OBJECT
);
2384 return XSAVE_VALUE (obj
)->data
[n
].object
;
2388 struct Lisp_User_Ptr
2390 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_User_Ptr */
2391 bool_bf gcmarkbit
: 1;
2392 unsigned spacer
: 15;
2394 void (*finalizer
) (void *);
2399 /* A finalizer sentinel. */
2400 struct Lisp_Finalizer
2402 struct Lisp_Misc_Any base
;
2404 /* Circular list of all active weak references. */
2405 struct Lisp_Finalizer
*prev
;
2406 struct Lisp_Finalizer
*next
;
2408 /* Call FUNCTION when the finalizer becomes unreachable, even if
2409 FUNCTION contains a reference to the finalizer; i.e., call
2410 FUNCTION when it is reachable _only_ through finalizers. */
2411 Lisp_Object function
;
2415 FINALIZERP (Lisp_Object x
)
2417 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Finalizer
;
2420 INLINE
struct Lisp_Finalizer
*
2421 XFINALIZER (Lisp_Object a
)
2423 eassert (FINALIZERP (a
));
2424 return XUNTAG (a
, Lisp_Misc
);
2427 /* A miscellaneous object, when it's on the free list. */
2430 ENUM_BF (Lisp_Misc_Type
) type
: 16; /* = Lisp_Misc_Free */
2431 bool_bf gcmarkbit
: 1;
2432 unsigned spacer
: 15;
2433 union Lisp_Misc
*chain
;
2436 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2437 It uses one of these struct subtypes to get the type field. */
2441 struct Lisp_Misc_Any u_any
; /* Supertype of all Misc types. */
2442 struct Lisp_Free u_free
;
2443 struct Lisp_Marker u_marker
;
2444 struct Lisp_Overlay u_overlay
;
2445 struct Lisp_Save_Value u_save_value
;
2446 struct Lisp_Finalizer u_finalizer
;
2448 struct Lisp_User_Ptr u_user_ptr
;
2452 INLINE
union Lisp_Misc
*
2453 XMISC (Lisp_Object a
)
2455 return XUNTAG (a
, Lisp_Misc
);
2459 (MARKERP
) (Lisp_Object x
)
2461 return lisp_h_MARKERP (x
);
2464 INLINE
struct Lisp_Marker
*
2465 XMARKER (Lisp_Object a
)
2467 eassert (MARKERP (a
));
2468 return XUNTAG (a
, Lisp_Misc
);
2472 OVERLAYP (Lisp_Object x
)
2474 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_Overlay
;
2477 INLINE
struct Lisp_Overlay
*
2478 XOVERLAY (Lisp_Object a
)
2480 eassert (OVERLAYP (a
));
2481 return XUNTAG (a
, Lisp_Misc
);
2486 USER_PTRP (Lisp_Object x
)
2488 return MISCP (x
) && XMISCTYPE (x
) == Lisp_Misc_User_Ptr
;
2491 INLINE
struct Lisp_User_Ptr
*
2492 XUSER_PTR (Lisp_Object a
)
2494 eassert (USER_PTRP (a
));
2495 return XUNTAG (a
, Lisp_Misc
);
2500 /* Forwarding pointer to an int variable.
2501 This is allowed only in the value cell of a symbol,
2502 and it means that the symbol's value really lives in the
2503 specified int variable. */
2506 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Int */
2510 /* Boolean forwarding pointer to an int variable.
2511 This is like Lisp_Intfwd except that the ostensible
2512 "value" of the symbol is t if the bool variable is true,
2513 nil if it is false. */
2516 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Bool */
2520 /* Forwarding pointer to a Lisp_Object variable.
2521 This is allowed only in the value cell of a symbol,
2522 and it means that the symbol's value really lives in the
2523 specified variable. */
2526 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Obj */
2527 Lisp_Object
*objvar
;
2530 /* Like Lisp_Objfwd except that value lives in a slot in the
2531 current buffer. Value is byte index of slot within buffer. */
2532 struct Lisp_Buffer_Objfwd
2534 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Buffer_Obj */
2536 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2537 Lisp_Object predicate
;
2540 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2541 the symbol has buffer-local bindings. (Exception:
2542 some buffer-local variables are built-in, with their values stored
2543 in the buffer structure itself. They are handled differently,
2544 using struct Lisp_Buffer_Objfwd.)
2546 The `realvalue' slot holds the variable's current value, or a
2547 forwarding pointer to where that value is kept. This value is the
2548 one that corresponds to the loaded binding. To read or set the
2549 variable, you must first make sure the right binding is loaded;
2550 then you can access the value in (or through) `realvalue'.
2552 `buffer' and `frame' are the buffer and frame for which the loaded
2553 binding was found. If those have changed, to make sure the right
2554 binding is loaded it is necessary to find which binding goes with
2555 the current buffer and selected frame, then load it. To load it,
2556 first unload the previous binding, then copy the value of the new
2557 binding into `realvalue' (or through it). Also update
2558 LOADED-BINDING to point to the newly loaded binding.
2560 `local_if_set' indicates that merely setting the variable creates a
2561 local binding for the current buffer. Otherwise the latter, setting
2562 the variable does not do that; only make-local-variable does that. */
2564 struct Lisp_Buffer_Local_Value
2566 /* True means that merely setting the variable creates a local
2567 binding for the current buffer. */
2568 bool_bf local_if_set
: 1;
2569 /* True means that the binding now loaded was found.
2570 Presumably equivalent to (defcell!=valcell). */
2572 /* If non-NULL, a forwarding to the C var where it should also be set. */
2573 union Lisp_Fwd
*fwd
; /* Should never be (Buffer|Kboard)_Objfwd. */
2574 /* The buffer or frame for which the loaded binding was found. */
2576 /* A cons cell that holds the default value. It has the form
2577 (SYMBOL . DEFAULT-VALUE). */
2578 Lisp_Object defcell
;
2579 /* The cons cell from `where's parameter alist.
2580 It always has the form (SYMBOL . VALUE)
2581 Note that if `forward' is non-nil, VALUE may be out of date.
2582 Also if the currently loaded binding is the default binding, then
2583 this is `eq'ual to defcell. */
2584 Lisp_Object valcell
;
2587 /* Like Lisp_Objfwd except that value lives in a slot in the
2589 struct Lisp_Kboard_Objfwd
2591 enum Lisp_Fwd_Type type
; /* = Lisp_Fwd_Kboard_Obj */
2597 struct Lisp_Intfwd u_intfwd
;
2598 struct Lisp_Boolfwd u_boolfwd
;
2599 struct Lisp_Objfwd u_objfwd
;
2600 struct Lisp_Buffer_Objfwd u_buffer_objfwd
;
2601 struct Lisp_Kboard_Objfwd u_kboard_objfwd
;
2604 INLINE
enum Lisp_Fwd_Type
2605 XFWDTYPE (union Lisp_Fwd
*a
)
2607 return a
->u_intfwd
.type
;
2611 BUFFER_OBJFWDP (union Lisp_Fwd
*a
)
2613 return XFWDTYPE (a
) == Lisp_Fwd_Buffer_Obj
;
2616 INLINE
struct Lisp_Buffer_Objfwd
*
2617 XBUFFER_OBJFWD (union Lisp_Fwd
*a
)
2619 eassert (BUFFER_OBJFWDP (a
));
2620 return &a
->u_buffer_objfwd
;
2623 /* Lisp floating point type. */
2629 struct Lisp_Float
*chain
;
2634 (FLOATP
) (Lisp_Object x
)
2636 return lisp_h_FLOATP (x
);
2639 INLINE
struct Lisp_Float
*
2640 XFLOAT (Lisp_Object a
)
2642 eassert (FLOATP (a
));
2643 return XUNTAG (a
, Lisp_Float
);
2647 XFLOAT_DATA (Lisp_Object f
)
2649 return XFLOAT (f
)->u
.data
;
2652 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2653 representations, have infinities and NaNs, and do not trap on
2654 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2655 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2656 wanted here, but is not quite right because Emacs does not require
2657 all the features of C11 Annex F (and does not require C11 at all,
2658 for that matter). */
2662 = (FLT_RADIX
== 2 && FLT_MANT_DIG
== 24
2663 && FLT_MIN_EXP
== -125 && FLT_MAX_EXP
== 128)
2666 /* A character, declared with the following typedef, is a member
2667 of some character set associated with the current buffer. */
2668 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2670 typedef unsigned char UCHAR
;
2673 /* Meanings of slots in a Lisp_Compiled: */
2677 COMPILED_ARGLIST
= 0,
2678 COMPILED_BYTECODE
= 1,
2679 COMPILED_CONSTANTS
= 2,
2680 COMPILED_STACK_DEPTH
= 3,
2681 COMPILED_DOC_STRING
= 4,
2682 COMPILED_INTERACTIVE
= 5
2685 /* Flag bits in a character. These also get used in termhooks.h.
2686 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2687 (MUlti-Lingual Emacs) might need 22 bits for the character value
2688 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2691 CHAR_ALT
= 0x0400000,
2692 CHAR_SUPER
= 0x0800000,
2693 CHAR_HYPER
= 0x1000000,
2694 CHAR_SHIFT
= 0x2000000,
2695 CHAR_CTL
= 0x4000000,
2696 CHAR_META
= 0x8000000,
2698 CHAR_MODIFIER_MASK
=
2699 CHAR_ALT
| CHAR_SUPER
| CHAR_HYPER
| CHAR_SHIFT
| CHAR_CTL
| CHAR_META
,
2701 /* Actually, the current Emacs uses 22 bits for the character value
2706 /* Data type checking. */
2709 NUMBERP (Lisp_Object x
)
2711 return INTEGERP (x
) || FLOATP (x
);
2714 NATNUMP (Lisp_Object x
)
2716 return INTEGERP (x
) && 0 <= XINT (x
);
2720 RANGED_INTEGERP (intmax_t lo
, Lisp_Object x
, intmax_t hi
)
2722 return INTEGERP (x
) && lo
<= XINT (x
) && XINT (x
) <= hi
;
2725 #define TYPE_RANGED_INTEGERP(type, x) \
2727 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2728 && XINT (x) <= TYPE_MAXIMUM (type))
2731 AUTOLOADP (Lisp_Object x
)
2733 return CONSP (x
) && EQ (Qautoload
, XCAR (x
));
2737 /* Test for specific pseudovector types. */
2740 WINDOW_CONFIGURATIONP (Lisp_Object a
)
2742 return PSEUDOVECTORP (a
, PVEC_WINDOW_CONFIGURATION
);
2746 COMPILEDP (Lisp_Object a
)
2748 return PSEUDOVECTORP (a
, PVEC_COMPILED
);
2752 FRAMEP (Lisp_Object a
)
2754 return PSEUDOVECTORP (a
, PVEC_FRAME
);
2758 RECORDP (Lisp_Object a
)
2760 return PSEUDOVECTORP (a
, PVEC_RECORD
);
2764 CHECK_RECORD (Lisp_Object x
)
2766 CHECK_TYPE (RECORDP (x
), Qrecordp
, x
);
2769 /* Test for image (image . spec) */
2771 IMAGEP (Lisp_Object x
)
2773 return CONSP (x
) && EQ (XCAR (x
), Qimage
);
2778 ARRAYP (Lisp_Object x
)
2780 return VECTORP (x
) || STRINGP (x
) || CHAR_TABLE_P (x
) || BOOL_VECTOR_P (x
);
2784 CHECK_LIST (Lisp_Object x
)
2786 CHECK_TYPE (CONSP (x
) || NILP (x
), Qlistp
, x
);
2790 CHECK_LIST_END (Lisp_Object x
, Lisp_Object y
)
2792 CHECK_TYPE (NILP (x
), Qlistp
, y
);
2796 (CHECK_NUMBER
) (Lisp_Object x
)
2798 lisp_h_CHECK_NUMBER (x
);
2802 CHECK_STRING_CAR (Lisp_Object x
)
2804 CHECK_TYPE (STRINGP (XCAR (x
)), Qstringp
, XCAR (x
));
2806 /* This is a bit special because we always need size afterwards. */
2808 CHECK_VECTOR_OR_STRING (Lisp_Object x
)
2814 wrong_type_argument (Qarrayp
, x
);
2817 CHECK_ARRAY (Lisp_Object x
, Lisp_Object predicate
)
2819 CHECK_TYPE (ARRAYP (x
), predicate
, x
);
2822 CHECK_NATNUM (Lisp_Object x
)
2824 CHECK_TYPE (NATNUMP (x
), Qwholenump
, x
);
2827 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2830 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2831 args_out_of_range_3 \
2833 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2834 ? MOST_NEGATIVE_FIXNUM \
2836 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2838 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2840 if (TYPE_SIGNED (type)) \
2841 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2843 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2846 #define CHECK_NUMBER_COERCE_MARKER(x) \
2848 if (MARKERP ((x))) \
2849 XSETFASTINT (x, marker_position (x)); \
2851 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2855 XFLOATINT (Lisp_Object n
)
2857 return FLOATP (n
) ? XFLOAT_DATA (n
) : XINT (n
);
2861 CHECK_NUMBER_OR_FLOAT (Lisp_Object x
)
2863 CHECK_TYPE (NUMBERP (x
), Qnumberp
, x
);
2866 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2869 XSETFASTINT (x, marker_position (x)); \
2871 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2874 /* Since we can't assign directly to the CAR or CDR fields of a cons
2875 cell, use these when checking that those fields contain numbers. */
2877 CHECK_NUMBER_CAR (Lisp_Object x
)
2879 Lisp_Object tmp
= XCAR (x
);
2885 CHECK_NUMBER_CDR (Lisp_Object x
)
2887 Lisp_Object tmp
= XCDR (x
);
2892 /* Define a built-in function for calling from Lisp.
2893 `lname' should be the name to give the function in Lisp,
2894 as a null-terminated C string.
2895 `fnname' should be the name of the function in C.
2896 By convention, it starts with F.
2897 `sname' should be the name for the C constant structure
2898 that records information on this function for internal use.
2899 By convention, it should be the same as `fnname' but with S instead of F.
2900 It's too bad that C macros can't compute this from `fnname'.
2901 `minargs' should be a number, the minimum number of arguments allowed.
2902 `maxargs' should be a number, the maximum number of arguments allowed,
2903 or else MANY or UNEVALLED.
2904 MANY means pass a vector of evaluated arguments,
2905 in the form of an integer number-of-arguments
2906 followed by the address of a vector of Lisp_Objects
2907 which contains the argument values.
2908 UNEVALLED means pass the list of unevaluated arguments
2909 `intspec' says how interactive arguments are to be fetched.
2910 If the string starts with a `(', `intspec' is evaluated and the resulting
2911 list is the list of arguments.
2912 If it's a string that doesn't start with `(', the value should follow
2913 the one of the doc string for `interactive'.
2914 A null string means call interactively with no arguments.
2915 `doc' is documentation for the user. */
2917 /* This version of DEFUN declares a function prototype with the right
2918 arguments, so we can catch errors with maxargs at compile-time. */
2920 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2921 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2922 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2923 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2924 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2925 { (Lisp_Object (__cdecl *)(void))fnname }, \
2926 minargs, maxargs, lname, intspec, 0}; \
2928 #else /* not _MSC_VER */
2929 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2930 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2931 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2932 { .a ## maxargs = fnname }, \
2933 minargs, maxargs, lname, intspec, 0}; \
2938 is how we define the symbol for function `name' at start-up time. */
2939 extern void defsubr (struct Lisp_Subr
*);
2947 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2948 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2950 /* Call a function F that accepts many args, passing it the remaining args,
2951 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2952 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2953 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2954 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2956 extern void defvar_lisp (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2957 extern void defvar_lisp_nopro (struct Lisp_Objfwd
*, const char *, Lisp_Object
*);
2958 extern void defvar_bool (struct Lisp_Boolfwd
*, const char *, bool *);
2959 extern void defvar_int (struct Lisp_Intfwd
*, const char *, EMACS_INT
*);
2960 extern void defvar_kboard (struct Lisp_Kboard_Objfwd
*, const char *, int);
2962 /* Macros we use to define forwarded Lisp variables.
2963 These are used in the syms_of_FILENAME functions.
2965 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
2966 lisp variable is actually a field in `struct emacs_globals'. The
2967 field's name begins with "f_", which is a convention enforced by
2968 these macros. Each such global has a corresponding #define in
2969 globals.h; the plain name should be used in the code.
2971 E.g., the global "cons_cells_consed" is declared as "int
2972 f_cons_cells_consed" in globals.h, but there is a define:
2974 #define cons_cells_consed globals.f_cons_cells_consed
2976 All C code uses the `cons_cells_consed' name. This is all done
2977 this way to support indirection for multi-threaded Emacs. */
2979 #define DEFVAR_LISP(lname, vname, doc) \
2981 static struct Lisp_Objfwd o_fwd; \
2982 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
2984 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
2986 static struct Lisp_Objfwd o_fwd; \
2987 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
2989 #define DEFVAR_BOOL(lname, vname, doc) \
2991 static struct Lisp_Boolfwd b_fwd; \
2992 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
2994 #define DEFVAR_INT(lname, vname, doc) \
2996 static struct Lisp_Intfwd i_fwd; \
2997 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3000 #define DEFVAR_KBOARD(lname, vname, doc) \
3002 static struct Lisp_Kboard_Objfwd ko_fwd; \
3003 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3006 /* Save and restore the instruction and environment pointers,
3007 without affecting the signal mask. */
3010 typedef jmp_buf sys_jmp_buf
;
3011 # define sys_setjmp(j) _setjmp (j)
3012 # define sys_longjmp(j, v) _longjmp (j, v)
3013 #elif defined HAVE_SIGSETJMP
3014 typedef sigjmp_buf sys_jmp_buf
;
3015 # define sys_setjmp(j) sigsetjmp (j, 0)
3016 # define sys_longjmp(j, v) siglongjmp (j, v)
3018 /* A platform that uses neither _longjmp nor siglongjmp; assume
3019 longjmp does not affect the sigmask. */
3020 typedef jmp_buf sys_jmp_buf
;
3021 # define sys_setjmp(j) setjmp (j)
3022 # define sys_longjmp(j, v) longjmp (j, v)
3026 /* Elisp uses several stacks:
3028 - the bytecode stack: used internally by the bytecode interpreter.
3029 Allocated from the C stack.
3030 - The specpdl stack: keeps track of active unwind-protect and
3031 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3033 - The handler stack: keeps track of active catch tags and condition-case
3034 handlers. Allocated in a manually managed stack implemented by a
3035 doubly-linked list allocated via xmalloc and never freed. */
3037 /* Structure for recording Lisp call stack for backtrace purposes. */
3039 /* The special binding stack holds the outer values of variables while
3040 they are bound by a function application or a let form, stores the
3041 code to be executed for unwind-protect forms.
3043 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3044 used all over the place, needs to be fast, and needs to know the size of
3045 union specbinding. But only eval.c should access it. */
3048 SPECPDL_UNWIND
, /* An unwind_protect function on Lisp_Object. */
3049 SPECPDL_UNWIND_PTR
, /* Likewise, on void *. */
3050 SPECPDL_UNWIND_INT
, /* Likewise, on int. */
3051 SPECPDL_UNWIND_VOID
, /* Likewise, with no arg. */
3052 SPECPDL_BACKTRACE
, /* An element of the backtrace. */
3053 SPECPDL_LET
, /* A plain and simple dynamic let-binding. */
3054 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3055 SPECPDL_LET_LOCAL
, /* A buffer-local let-binding. */
3056 SPECPDL_LET_DEFAULT
/* A global binding for a localized var. */
3061 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3063 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3064 void (*func
) (Lisp_Object
);
3068 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3069 void (*func
) (void *);
3073 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3078 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3079 void (*func
) (void);
3082 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3083 /* `where' is not used in the case of SPECPDL_LET. */
3084 Lisp_Object symbol
, old_value
, where
;
3085 /* Normally this is unused; but it is set to the symbol's
3086 current value when a thread is swapped out. */
3087 Lisp_Object saved_value
;
3090 ENUM_BF (specbind_tag
) kind
: CHAR_BIT
;
3091 bool_bf debug_on_exit
: 1;
3092 Lisp_Object function
;
3098 /* These 3 are defined as macros in thread.h. */
3099 /* extern union specbinding *specpdl; */
3100 /* extern union specbinding *specpdl_ptr; */
3101 /* extern ptrdiff_t specpdl_size; */
3104 SPECPDL_INDEX (void)
3106 return specpdl_ptr
- specpdl
;
3109 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3110 control structures. A struct handler contains all the information needed to
3111 restore the state of the interpreter after a non-local jump.
3113 handler structures are chained together in a doubly linked list; the `next'
3114 member points to the next outer catchtag and the `nextfree' member points in
3115 the other direction to the next inner element (which is typically the next
3116 free element since we mostly use it on the deepest handler).
3118 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3119 member is TAG, and then unbinds to it. The `val' member is used to
3120 hold VAL while the stack is unwound; `val' is returned as the value
3121 of the catch form. If there is a handler of type CATCHER_ALL, it will
3122 be treated as a handler for all invocations of `throw'; in this case
3123 `val' will be set to (TAG . VAL).
3125 All the other members are concerned with restoring the interpreter
3128 Members are volatile if their values need to survive _longjmp when
3129 a 'struct handler' is a local variable. */
3131 enum handlertype
{ CATCHER
, CONDITION_CASE
, CATCHER_ALL
};
3135 enum handlertype type
;
3136 Lisp_Object tag_or_ch
;
3138 struct handler
*next
;
3139 struct handler
*nextfree
;
3141 /* The bytecode interpreter can have several handlers active at the same
3142 time, so when we longjmp to one of them, it needs to know which handler
3143 this was and what was the corresponding internal state. This is stored
3144 here, and when we longjmp we make sure that handlerlist points to the
3146 Lisp_Object
*bytecode_top
;
3149 /* Most global vars are reset to their value via the specpdl mechanism,
3150 but a few others are handled by storing their value here. */
3152 EMACS_INT f_lisp_eval_depth
;
3154 int poll_suppress_count
;
3155 int interrupt_input_blocked
;
3158 extern Lisp_Object memory_signal_data
;
3160 extern void maybe_quit (void);
3162 /* True if ought to quit now. */
3164 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3166 /* Process a quit rarely, based on a counter COUNT, for efficiency.
3167 "Rarely" means once per USHRT_MAX + 1 times; this is somewhat
3168 arbitrary, but efficient. */
3171 rarely_quit (unsigned short int count
)
3177 extern Lisp_Object Vascii_downcase_table
;
3178 extern Lisp_Object Vascii_canon_table
;
3180 /* Call staticpro (&var) to protect static variable `var'. */
3182 void staticpro (Lisp_Object
*);
3184 /* Forward declarations for prototypes. */
3188 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3191 vcopy (Lisp_Object v
, ptrdiff_t offset
, Lisp_Object
*args
, ptrdiff_t count
)
3193 eassert (0 <= offset
&& 0 <= count
&& offset
+ count
<= ASIZE (v
));
3194 memcpy (XVECTOR (v
)->contents
+ offset
, args
, count
* sizeof *args
);
3197 /* Functions to modify hash tables. */
3200 set_hash_key_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3202 gc_aset (h
->key_and_value
, 2 * idx
, val
);
3206 set_hash_value_slot (struct Lisp_Hash_Table
*h
, ptrdiff_t idx
, Lisp_Object val
)
3208 gc_aset (h
->key_and_value
, 2 * idx
+ 1, val
);
3211 /* Use these functions to set Lisp_Object
3212 or pointer slots of struct Lisp_Symbol. */
3215 set_symbol_function (Lisp_Object sym
, Lisp_Object function
)
3217 XSYMBOL (sym
)->function
= function
;
3221 set_symbol_plist (Lisp_Object sym
, Lisp_Object plist
)
3223 XSYMBOL (sym
)->plist
= plist
;
3227 set_symbol_next (Lisp_Object sym
, struct Lisp_Symbol
*next
)
3229 XSYMBOL (sym
)->next
= next
;
3233 make_symbol_constant (Lisp_Object sym
)
3235 XSYMBOL (sym
)->trapped_write
= SYMBOL_NOWRITE
;
3238 /* Buffer-local variable access functions. */
3241 blv_found (struct Lisp_Buffer_Local_Value
*blv
)
3243 eassert (blv
->found
== !EQ (blv
->defcell
, blv
->valcell
));
3247 /* Set overlay's property list. */
3250 set_overlay_plist (Lisp_Object overlay
, Lisp_Object plist
)
3252 XOVERLAY (overlay
)->plist
= plist
;
3255 /* Get text properties of S. */
3258 string_intervals (Lisp_Object s
)
3260 return XSTRING (s
)->intervals
;
3263 /* Set text properties of S to I. */
3266 set_string_intervals (Lisp_Object s
, INTERVAL i
)
3268 XSTRING (s
)->intervals
= i
;
3271 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3272 of setting slots directly. */
3275 set_char_table_defalt (Lisp_Object table
, Lisp_Object val
)
3277 XCHAR_TABLE (table
)->defalt
= val
;
3280 set_char_table_purpose (Lisp_Object table
, Lisp_Object val
)
3282 XCHAR_TABLE (table
)->purpose
= val
;
3285 /* Set different slots in (sub)character tables. */
3288 set_char_table_extras (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3290 eassert (0 <= idx
&& idx
< CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table
)));
3291 XCHAR_TABLE (table
)->extras
[idx
] = val
;
3295 set_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3297 eassert (0 <= idx
&& idx
< (1 << CHARTAB_SIZE_BITS_0
));
3298 XCHAR_TABLE (table
)->contents
[idx
] = val
;
3302 set_sub_char_table_contents (Lisp_Object table
, ptrdiff_t idx
, Lisp_Object val
)
3304 XSUB_CHAR_TABLE (table
)->contents
[idx
] = val
;
3307 /* Defined in data.c. */
3308 extern _Noreturn
void wrong_choice (Lisp_Object
, Lisp_Object
);
3309 extern void notify_variable_watchers (Lisp_Object
, Lisp_Object
,
3310 Lisp_Object
, Lisp_Object
);
3311 extern Lisp_Object
indirect_function (Lisp_Object
);
3312 extern Lisp_Object
find_symbol_value (Lisp_Object
);
3313 enum Arith_Comparison
{
3318 ARITH_LESS_OR_EQUAL
,
3321 extern Lisp_Object
arithcompare (Lisp_Object num1
, Lisp_Object num2
,
3322 enum Arith_Comparison comparison
);
3324 /* Convert the integer I to an Emacs representation, either the integer
3325 itself, or a cons of two or three integers, or if all else fails a float.
3326 I should not have side effects. */
3327 #define INTEGER_TO_CONS(i) \
3328 (! FIXNUM_OVERFLOW_P (i) \
3330 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3331 extern Lisp_Object
intbig_to_lisp (intmax_t);
3332 extern Lisp_Object
uintbig_to_lisp (uintmax_t);
3334 /* Convert the Emacs representation CONS back to an integer of type
3335 TYPE, storing the result the variable VAR. Signal an error if CONS
3336 is not a valid representation or is out of range for TYPE. */
3337 #define CONS_TO_INTEGER(cons, type, var) \
3338 (TYPE_SIGNED (type) \
3339 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3340 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3341 extern intmax_t cons_to_signed (Lisp_Object
, intmax_t, intmax_t);
3342 extern uintmax_t cons_to_unsigned (Lisp_Object
, uintmax_t);
3344 extern struct Lisp_Symbol
*indirect_variable (struct Lisp_Symbol
*);
3345 extern _Noreturn
void args_out_of_range (Lisp_Object
, Lisp_Object
);
3346 extern _Noreturn
void args_out_of_range_3 (Lisp_Object
, Lisp_Object
,
3348 extern _Noreturn
void circular_list (Lisp_Object
);
3349 extern Lisp_Object
do_symval_forwarding (union Lisp_Fwd
*);
3350 enum Set_Internal_Bind
{
3353 SET_INTERNAL_UNBIND
,
3354 SET_INTERNAL_THREAD_SWITCH
3356 extern void set_internal (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3357 enum Set_Internal_Bind
);
3358 extern void set_default_internal (Lisp_Object
, Lisp_Object
,
3359 enum Set_Internal_Bind bindflag
);
3361 extern void syms_of_data (void);
3362 extern void swap_in_global_binding (struct Lisp_Symbol
*);
3364 /* Defined in cmds.c */
3365 extern void syms_of_cmds (void);
3366 extern void keys_of_cmds (void);
3368 /* Defined in coding.c. */
3369 extern Lisp_Object
detect_coding_system (const unsigned char *, ptrdiff_t,
3370 ptrdiff_t, bool, bool, Lisp_Object
);
3371 extern void init_coding (void);
3372 extern void init_coding_once (void);
3373 extern void syms_of_coding (void);
3375 /* Defined in character.c. */
3376 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3377 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3378 extern void syms_of_character (void);
3380 /* Defined in charset.c. */
3381 extern void init_charset (void);
3382 extern void init_charset_once (void);
3383 extern void syms_of_charset (void);
3384 /* Structure forward declarations. */
3387 /* Defined in syntax.c. */
3388 extern void init_syntax_once (void);
3389 extern void syms_of_syntax (void);
3391 /* Defined in fns.c. */
3392 enum { NEXT_ALMOST_PRIME_LIMIT
= 11 };
3393 extern EMACS_INT
next_almost_prime (EMACS_INT
) ATTRIBUTE_CONST
;
3394 extern Lisp_Object
larger_vector (Lisp_Object
, ptrdiff_t, ptrdiff_t);
3395 extern void sweep_weak_hash_tables (void);
3396 extern char *extract_data_from_object (Lisp_Object
, ptrdiff_t *, ptrdiff_t *);
3397 EMACS_UINT
hash_string (char const *, ptrdiff_t);
3398 EMACS_UINT
sxhash (Lisp_Object
, int);
3399 Lisp_Object
make_hash_table (struct hash_table_test
, EMACS_INT
, float, float,
3401 ptrdiff_t hash_lookup (struct Lisp_Hash_Table
*, Lisp_Object
, EMACS_UINT
*);
3402 ptrdiff_t hash_put (struct Lisp_Hash_Table
*, Lisp_Object
, Lisp_Object
,
3404 void hash_remove_from_table (struct Lisp_Hash_Table
*, Lisp_Object
);
3405 extern struct hash_table_test
const hashtest_eq
, hashtest_eql
, hashtest_equal
;
3406 extern void validate_subarray (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3407 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3408 extern Lisp_Object
substring_both (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3409 ptrdiff_t, ptrdiff_t);
3410 extern Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3411 extern Lisp_Object
do_yes_or_no_p (Lisp_Object
);
3412 extern Lisp_Object
concat2 (Lisp_Object
, Lisp_Object
);
3413 extern Lisp_Object
concat3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3414 extern bool equal_no_quit (Lisp_Object
, Lisp_Object
);
3415 extern Lisp_Object
nconc2 (Lisp_Object
, Lisp_Object
);
3416 extern Lisp_Object
assq_no_quit (Lisp_Object
, Lisp_Object
);
3417 extern Lisp_Object
assoc_no_quit (Lisp_Object
, Lisp_Object
);
3418 extern void clear_string_char_byte_cache (void);
3419 extern ptrdiff_t string_char_to_byte (Lisp_Object
, ptrdiff_t);
3420 extern ptrdiff_t string_byte_to_char (Lisp_Object
, ptrdiff_t);
3421 extern Lisp_Object
string_to_multibyte (Lisp_Object
);
3422 extern Lisp_Object
string_make_unibyte (Lisp_Object
);
3423 extern void syms_of_fns (void);
3425 /* Defined in floatfns.c. */
3426 extern void syms_of_floatfns (void);
3427 extern Lisp_Object
fmod_float (Lisp_Object x
, Lisp_Object y
);
3429 /* Defined in fringe.c. */
3430 extern void syms_of_fringe (void);
3431 extern void init_fringe (void);
3432 #ifdef HAVE_WINDOW_SYSTEM
3433 extern void mark_fringe_data (void);
3434 extern void init_fringe_once (void);
3435 #endif /* HAVE_WINDOW_SYSTEM */
3437 /* Defined in image.c. */
3438 extern int x_bitmap_mask (struct frame
*, ptrdiff_t);
3439 extern void reset_image_types (void);
3440 extern void syms_of_image (void);
3442 /* Defined in insdel.c. */
3443 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3444 extern _Noreturn
void buffer_overflow (void);
3445 extern void make_gap (ptrdiff_t);
3446 extern void make_gap_1 (struct buffer
*, ptrdiff_t);
3447 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3448 ptrdiff_t, bool, bool);
3449 extern int count_combining_before (const unsigned char *,
3450 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3451 extern int count_combining_after (const unsigned char *,
3452 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3453 extern void insert (const char *, ptrdiff_t);
3454 extern void insert_and_inherit (const char *, ptrdiff_t);
3455 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3457 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail
);
3458 extern void insert_from_string (Lisp_Object
, ptrdiff_t, ptrdiff_t,
3459 ptrdiff_t, ptrdiff_t, bool);
3460 extern void insert_from_buffer (struct buffer
*, ptrdiff_t, ptrdiff_t, bool);
3461 extern void insert_char (int);
3462 extern void insert_string (const char *);
3463 extern void insert_before_markers (const char *, ptrdiff_t);
3464 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3465 extern void insert_from_string_before_markers (Lisp_Object
, ptrdiff_t,
3466 ptrdiff_t, ptrdiff_t,
3468 extern void del_range (ptrdiff_t, ptrdiff_t);
3469 extern Lisp_Object
del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3470 extern void del_range_byte (ptrdiff_t, ptrdiff_t);
3471 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3472 extern Lisp_Object
del_range_2 (ptrdiff_t, ptrdiff_t,
3473 ptrdiff_t, ptrdiff_t, bool);
3474 extern void modify_text (ptrdiff_t, ptrdiff_t);
3475 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3476 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3477 extern void invalidate_buffer_caches (struct buffer
*, ptrdiff_t, ptrdiff_t);
3478 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3479 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3480 ptrdiff_t, ptrdiff_t);
3481 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3482 ptrdiff_t, ptrdiff_t);
3483 extern void adjust_markers_bytepos (ptrdiff_t, ptrdiff_t,
3484 ptrdiff_t, ptrdiff_t, int);
3485 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object
, bool, bool, bool, bool);
3486 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3487 const char *, ptrdiff_t, ptrdiff_t, bool);
3488 extern void syms_of_insdel (void);
3490 /* Defined in dispnew.c. */
3491 #if (defined PROFILING \
3492 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3493 _Noreturn
void __executable_start (void);
3495 extern Lisp_Object Vwindow_system
;
3496 extern Lisp_Object
sit_for (Lisp_Object
, bool, int);
3498 /* Defined in xdisp.c. */
3499 extern bool noninteractive_need_newline
;
3500 extern Lisp_Object echo_area_buffer
[2];
3501 extern void add_to_log (char const *, ...);
3502 extern void vadd_to_log (char const *, va_list);
3503 extern void check_message_stack (void);
3504 extern void setup_echo_area_for_printing (bool);
3505 extern bool push_message (void);
3506 extern void pop_message_unwind (void);
3507 extern Lisp_Object
restore_message_unwind (Lisp_Object
);
3508 extern void restore_message (void);
3509 extern Lisp_Object
current_message (void);
3510 extern void clear_message (bool, bool);
3511 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3512 extern void message1 (const char *);
3513 extern void message1_nolog (const char *);
3514 extern void message3 (Lisp_Object
);
3515 extern void message3_nolog (Lisp_Object
);
3516 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3517 extern void message_with_string (const char *, Lisp_Object
, bool);
3518 extern void message_log_maybe_newline (void);
3519 extern void update_echo_area (void);
3520 extern void truncate_echo_area (ptrdiff_t);
3521 extern void redisplay (void);
3523 void set_frame_cursor_types (struct frame
*, Lisp_Object
);
3524 extern void syms_of_xdisp (void);
3525 extern void init_xdisp (void);
3526 extern Lisp_Object
safe_eval (Lisp_Object
);
3527 extern bool pos_visible_p (struct window
*, ptrdiff_t, int *,
3528 int *, int *, int *, int *, int *);
3530 /* Defined in xsettings.c. */
3531 extern void syms_of_xsettings (void);
3533 /* Defined in vm-limit.c. */
3534 extern void memory_warnings (void *, void (*warnfun
) (const char *));
3536 /* Defined in character.c. */
3537 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3538 ptrdiff_t *, ptrdiff_t *);
3540 /* Defined in alloc.c. */
3541 extern void *my_heap_start (void);
3542 extern void check_pure_size (void);
3543 extern void free_misc (Lisp_Object
);
3544 extern void allocate_string_data (struct Lisp_String
*, EMACS_INT
, EMACS_INT
);
3545 extern void malloc_warning (const char *);
3546 extern _Noreturn
void memory_full (size_t);
3547 extern _Noreturn
void buffer_memory_full (ptrdiff_t);
3548 extern bool survives_gc_p (Lisp_Object
);
3549 extern void mark_object (Lisp_Object
);
3550 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3551 extern void refill_memory_reserve (void);
3553 extern void alloc_unexec_pre (void);
3554 extern void alloc_unexec_post (void);
3555 extern void mark_stack (char *, char *);
3556 extern void flush_stack_call_func (void (*func
) (void *arg
), void *arg
);
3557 extern const char *pending_malloc_warning
;
3558 extern Lisp_Object zero_vector
;
3559 extern EMACS_INT consing_since_gc
;
3560 extern EMACS_INT gc_relative_threshold
;
3561 extern EMACS_INT memory_full_cons_threshold
;
3562 extern Lisp_Object
list1 (Lisp_Object
);
3563 extern Lisp_Object
list2 (Lisp_Object
, Lisp_Object
);
3564 extern Lisp_Object
list3 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3565 extern Lisp_Object
list4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3566 extern Lisp_Object
list5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
,
3568 enum constype
{CONSTYPE_HEAP
, CONSTYPE_PURE
};
3569 extern Lisp_Object
listn (enum constype
, ptrdiff_t, Lisp_Object
, ...);
3571 /* Build a frequently used 2/3/4-integer lists. */
3574 list2i (EMACS_INT x
, EMACS_INT y
)
3576 return list2 (make_number (x
), make_number (y
));
3580 list3i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
)
3582 return list3 (make_number (x
), make_number (y
), make_number (w
));
3586 list4i (EMACS_INT x
, EMACS_INT y
, EMACS_INT w
, EMACS_INT h
)
3588 return list4 (make_number (x
), make_number (y
),
3589 make_number (w
), make_number (h
));
3592 extern Lisp_Object
make_uninit_bool_vector (EMACS_INT
);
3593 extern Lisp_Object
bool_vector_fill (Lisp_Object
, Lisp_Object
);
3594 extern _Noreturn
void string_overflow (void);
3595 extern Lisp_Object
make_string (const char *, ptrdiff_t);
3596 extern Lisp_Object
make_formatted_string (char *, const char *, ...)
3597 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3598 extern Lisp_Object
make_unibyte_string (const char *, ptrdiff_t);
3600 /* Make unibyte string from C string when the length isn't known. */
3603 build_unibyte_string (const char *str
)
3605 return make_unibyte_string (str
, strlen (str
));
3608 extern Lisp_Object
make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3609 extern Lisp_Object
make_event_array (ptrdiff_t, Lisp_Object
*);
3610 extern Lisp_Object
make_uninit_string (EMACS_INT
);
3611 extern Lisp_Object
make_uninit_multibyte_string (EMACS_INT
, EMACS_INT
);
3612 extern Lisp_Object
make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3613 extern Lisp_Object
make_specified_string (const char *,
3614 ptrdiff_t, ptrdiff_t, bool);
3615 extern Lisp_Object
make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3616 extern Lisp_Object
make_pure_c_string (const char *, ptrdiff_t);
3618 /* Make a string allocated in pure space, use STR as string data. */
3621 build_pure_c_string (const char *str
)
3623 return make_pure_c_string (str
, strlen (str
));
3626 /* Make a string from the data at STR, treating it as multibyte if the
3630 build_string (const char *str
)
3632 return make_string (str
, strlen (str
));
3635 extern Lisp_Object
pure_cons (Lisp_Object
, Lisp_Object
);
3636 extern void make_byte_code (struct Lisp_Vector
*);
3637 extern struct Lisp_Vector
*allocate_vector (EMACS_INT
);
3639 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3640 be sure that GC cannot happen until the vector is completely
3641 initialized. E.g. the following code is likely to crash:
3643 v = make_uninit_vector (3);
3645 ASET (v, 1, Ffunction_can_gc ());
3646 ASET (v, 2, obj1); */
3649 make_uninit_vector (ptrdiff_t size
)
3652 struct Lisp_Vector
*p
;
3654 p
= allocate_vector (size
);
3659 /* Like above, but special for sub char-tables. */
3662 make_uninit_sub_char_table (int depth
, int min_char
)
3664 int slots
= SUB_CHAR_TABLE_OFFSET
+ chartab_size
[depth
];
3665 Lisp_Object v
= make_uninit_vector (slots
);
3667 XSETPVECTYPE (XVECTOR (v
), PVEC_SUB_CHAR_TABLE
);
3668 XSUB_CHAR_TABLE (v
)->depth
= depth
;
3669 XSUB_CHAR_TABLE (v
)->min_char
= min_char
;
3673 extern struct Lisp_Vector
*allocate_pseudovector (int, int, int,
3676 /* Allocate partially initialized pseudovector where all Lisp_Object
3677 slots are set to Qnil but the rest (if any) is left uninitialized. */
3679 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3680 ((type *) allocate_pseudovector (VECSIZE (type), \
3681 PSEUDOVECSIZE (type, field), \
3682 PSEUDOVECSIZE (type, field), tag))
3684 /* Allocate fully initialized pseudovector where all Lisp_Object
3685 slots are set to Qnil and the rest (if any) is zeroed. */
3687 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3688 ((type *) allocate_pseudovector (VECSIZE (type), \
3689 PSEUDOVECSIZE (type, field), \
3690 VECSIZE (type), tag))
3692 extern bool gc_in_progress
;
3693 extern Lisp_Object
make_float (double);
3694 extern void display_malloc_warning (void);
3695 extern ptrdiff_t inhibit_garbage_collection (void);
3696 extern Lisp_Object
make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3697 extern Lisp_Object
make_save_obj_obj_obj_obj (Lisp_Object
, Lisp_Object
,
3698 Lisp_Object
, Lisp_Object
);
3699 extern Lisp_Object
make_save_ptr (void *);
3700 extern Lisp_Object
make_save_ptr_int (void *, ptrdiff_t);
3701 extern Lisp_Object
make_save_ptr_ptr (void *, void *);
3702 extern Lisp_Object
make_save_funcptr_ptr_obj (void (*) (void), void *,
3704 extern Lisp_Object
make_save_memory (Lisp_Object
*, ptrdiff_t);
3705 extern void free_save_value (Lisp_Object
);
3706 extern Lisp_Object
build_overlay (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3707 extern void free_marker (Lisp_Object
);
3708 extern void free_cons (struct Lisp_Cons
*);
3709 extern void init_alloc_once (void);
3710 extern void init_alloc (void);
3711 extern void syms_of_alloc (void);
3712 extern struct buffer
* allocate_buffer (void);
3713 extern int valid_lisp_object_p (Lisp_Object
);
3714 #ifdef GC_CHECK_CONS_LIST
3715 extern void check_cons_list (void);
3717 INLINE
void (check_cons_list
) (void) { lisp_h_check_cons_list (); }
3720 /* Defined in gmalloc.c. */
3721 #if !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC && !defined SYSTEM_MALLOC
3722 extern size_t __malloc_extra_blocks
;
3724 #if !HAVE_DECL_ALIGNED_ALLOC
3725 extern void *aligned_alloc (size_t, size_t) ATTRIBUTE_MALLOC_SIZE ((2));
3727 extern void malloc_enable_thread (void);
3730 /* Defined in ralloc.c. */
3731 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3732 extern void r_alloc_free (void **);
3733 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3734 extern void r_alloc_reset_variable (void **, void **);
3735 extern void r_alloc_inhibit_buffer_relocation (int);
3738 /* Defined in chartab.c. */
3739 extern Lisp_Object
copy_char_table (Lisp_Object
);
3740 extern Lisp_Object
char_table_ref_and_range (Lisp_Object
, int,
3742 extern void char_table_set_range (Lisp_Object
, int, int, Lisp_Object
);
3743 extern void map_char_table (void (*) (Lisp_Object
, Lisp_Object
,
3745 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3746 extern void map_char_table_for_charset (void (*c_function
) (Lisp_Object
, Lisp_Object
),
3747 Lisp_Object
, Lisp_Object
,
3748 Lisp_Object
, struct charset
*,
3749 unsigned, unsigned);
3750 extern Lisp_Object
uniprop_table (Lisp_Object
);
3751 extern void syms_of_chartab (void);
3753 /* Defined in print.c. */
3754 extern Lisp_Object Vprin1_to_string_buffer
;
3755 extern void debug_print (Lisp_Object
) EXTERNALLY_VISIBLE
;
3756 extern void temp_output_buffer_setup (const char *);
3757 extern int print_level
;
3758 extern void print_error_message (Lisp_Object
, Lisp_Object
, const char *,
3760 extern Lisp_Object internal_with_output_to_temp_buffer
3761 (const char *, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3762 #define FLOAT_TO_STRING_BUFSIZE 350
3763 extern int float_to_string (char *, double);
3764 extern void init_print_once (void);
3765 extern void syms_of_print (void);
3767 /* Defined in doprnt.c. */
3768 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3770 extern ptrdiff_t esprintf (char *, char const *, ...)
3771 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3772 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3774 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3775 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3776 char const *, va_list)
3777 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3779 /* Defined in lread.c. */
3780 extern Lisp_Object
check_obarray (Lisp_Object
);
3781 extern Lisp_Object
intern_1 (const char *, ptrdiff_t);
3782 extern Lisp_Object
intern_c_string_1 (const char *, ptrdiff_t);
3783 extern Lisp_Object
intern_driver (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3784 extern void init_symbol (Lisp_Object
, Lisp_Object
);
3785 extern Lisp_Object
oblookup (Lisp_Object
, const char *, ptrdiff_t, ptrdiff_t);
3787 LOADHIST_ATTACH (Lisp_Object x
)
3790 Vcurrent_load_list
= Fcons (x
, Vcurrent_load_list
);
3792 extern int openp (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3793 Lisp_Object
*, Lisp_Object
, bool);
3794 extern Lisp_Object
string_to_number (char const *, int, bool);
3795 extern void map_obarray (Lisp_Object
, void (*) (Lisp_Object
, Lisp_Object
),
3797 extern void dir_warning (const char *, Lisp_Object
);
3798 extern void init_obarray (void);
3799 extern void init_lread (void);
3800 extern void syms_of_lread (void);
3803 intern (const char *str
)
3805 return intern_1 (str
, strlen (str
));
3809 intern_c_string (const char *str
)
3811 return intern_c_string_1 (str
, strlen (str
));
3814 /* Defined in eval.c. */
3815 extern Lisp_Object Vautoload_queue
;
3816 extern Lisp_Object Vrun_hooks
;
3817 extern Lisp_Object Vsignaling_function
;
3818 extern Lisp_Object inhibit_lisp_code
;
3820 /* To run a normal hook, use the appropriate function from the list below.
3821 The calling convention:
3823 if (!NILP (Vrun_hooks))
3824 call1 (Vrun_hooks, Qmy_funny_hook);
3826 should no longer be used. */
3827 extern void run_hook (Lisp_Object
);
3828 extern void run_hook_with_args_2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3829 extern Lisp_Object
run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
3830 Lisp_Object (*funcall
)
3831 (ptrdiff_t nargs
, Lisp_Object
*args
));
3832 extern Lisp_Object
quit (void);
3833 INLINE _Noreturn
void
3834 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
3836 Fsignal (error_symbol
, data
);
3838 extern _Noreturn
void xsignal0 (Lisp_Object
);
3839 extern _Noreturn
void xsignal1 (Lisp_Object
, Lisp_Object
);
3840 extern _Noreturn
void xsignal2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3841 extern _Noreturn
void xsignal3 (Lisp_Object
, Lisp_Object
, Lisp_Object
,
3843 extern _Noreturn
void signal_error (const char *, Lisp_Object
);
3844 extern bool FUNCTIONP (Lisp_Object
);
3845 extern Lisp_Object
funcall_subr (struct Lisp_Subr
*subr
, ptrdiff_t numargs
, Lisp_Object
*arg_vector
);
3846 extern Lisp_Object
eval_sub (Lisp_Object form
);
3847 extern Lisp_Object
apply1 (Lisp_Object
, Lisp_Object
);
3848 extern Lisp_Object
call0 (Lisp_Object
);
3849 extern Lisp_Object
call1 (Lisp_Object
, Lisp_Object
);
3850 extern Lisp_Object
call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3851 extern Lisp_Object
call3 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3852 extern Lisp_Object
call4 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3853 extern Lisp_Object
call5 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3854 extern Lisp_Object
call6 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3855 extern Lisp_Object
call7 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3856 extern Lisp_Object
call8 (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
3857 extern Lisp_Object
internal_catch (Lisp_Object
, Lisp_Object (*) (Lisp_Object
), Lisp_Object
);
3858 extern Lisp_Object
internal_lisp_condition_case (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3859 extern Lisp_Object
internal_condition_case (Lisp_Object (*) (void), Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3860 extern Lisp_Object
internal_condition_case_1 (Lisp_Object (*) (Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3861 extern Lisp_Object
internal_condition_case_2 (Lisp_Object (*) (Lisp_Object
, Lisp_Object
), Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object (*) (Lisp_Object
));
3862 extern Lisp_Object internal_condition_case_n
3863 (Lisp_Object (*) (ptrdiff_t, Lisp_Object
*), ptrdiff_t, Lisp_Object
*,
3864 Lisp_Object
, Lisp_Object (*) (Lisp_Object
, ptrdiff_t, Lisp_Object
*));
3865 extern struct handler
*push_handler (Lisp_Object
, enum handlertype
);
3866 extern struct handler
*push_handler_nosignal (Lisp_Object
, enum handlertype
);
3867 extern void specbind (Lisp_Object
, Lisp_Object
);
3868 extern void record_unwind_protect (void (*) (Lisp_Object
), Lisp_Object
);
3869 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3870 extern void record_unwind_protect_int (void (*) (int), int);
3871 extern void record_unwind_protect_void (void (*) (void));
3872 extern void record_unwind_protect_nothing (void);
3873 extern void clear_unwind_protect (ptrdiff_t);
3874 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object
), Lisp_Object
);
3875 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3876 extern Lisp_Object
unbind_to (ptrdiff_t, Lisp_Object
);
3877 extern void rebind_for_thread_switch (void);
3878 extern void unbind_for_thread_switch (struct thread_state
*);
3879 extern _Noreturn
void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3880 extern _Noreturn
void verror (const char *, va_list)
3881 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3882 extern Lisp_Object
vformat_string (const char *, va_list)
3883 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3884 extern void un_autoload (Lisp_Object
);
3885 extern Lisp_Object
call_debugger (Lisp_Object arg
);
3886 extern void init_eval_once (void);
3887 extern Lisp_Object
safe_call (ptrdiff_t, Lisp_Object
, ...);
3888 extern Lisp_Object
safe_call1 (Lisp_Object
, Lisp_Object
);
3889 extern Lisp_Object
safe_call2 (Lisp_Object
, Lisp_Object
, Lisp_Object
);
3890 extern void init_eval (void);
3891 extern void syms_of_eval (void);
3892 extern void prog_ignore (Lisp_Object
);
3893 extern ptrdiff_t record_in_backtrace (Lisp_Object
, Lisp_Object
*, ptrdiff_t);
3894 extern void mark_specpdl (union specbinding
*first
, union specbinding
*ptr
);
3895 extern void get_backtrace (Lisp_Object array
);
3896 Lisp_Object
backtrace_top_function (void);
3897 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol
*symbol
);
3899 /* Defined in unexmacosx.c. */
3900 #if defined DARWIN_OS && !defined CANNOT_DUMP
3901 extern void unexec_init_emacs_zone (void);
3902 extern void *unexec_malloc (size_t);
3903 extern void *unexec_realloc (void *, size_t);
3904 extern void unexec_free (void *);
3907 #include "emacs-module.h"
3909 /* Function prototype for the module Lisp functions. */
3910 typedef emacs_value (*emacs_subr
) (emacs_env
*, ptrdiff_t,
3911 emacs_value
[], void *);
3913 /* Module function. */
3915 /* A function environment is an auxiliary structure returned by
3916 `module_make_function' to store information about a module
3917 function. It is stored in a pseudovector. Its members correspond
3918 to the arguments given to `module_make_function'. */
3920 struct Lisp_Module_Function
3922 struct vectorlike_header header
;
3924 /* Fields traced by GC; these must come first. */
3925 Lisp_Object documentation
;
3927 /* Fields ignored by GC. */
3928 ptrdiff_t min_arity
, max_arity
;
3934 MODULE_FUNCTIONP (Lisp_Object o
)
3936 return PSEUDOVECTORP (o
, PVEC_MODULE_FUNCTION
);
3939 INLINE
struct Lisp_Module_Function
*
3940 XMODULE_FUNCTION (Lisp_Object o
)
3942 eassert (MODULE_FUNCTIONP (o
));
3943 return XUNTAG (o
, Lisp_Vectorlike
);
3947 /* Defined in alloc.c. */
3948 extern Lisp_Object
make_user_ptr (void (*finalizer
) (void *), void *p
);
3950 /* Defined in emacs-module.c. */
3951 extern Lisp_Object
funcall_module (Lisp_Object
, ptrdiff_t, Lisp_Object
*);
3952 extern Lisp_Object
module_function_arity (const struct Lisp_Module_Function
*);
3953 extern void mark_modules (void);
3954 extern void init_module_assertions (bool);
3955 extern void syms_of_module (void);
3958 /* Defined in thread.c. */
3959 extern void mark_threads (void);
3961 /* Defined in editfns.c. */
3962 extern void insert1 (Lisp_Object
);
3963 extern Lisp_Object
save_excursion_save (void);
3964 extern Lisp_Object
save_restriction_save (void);
3965 extern void save_excursion_restore (Lisp_Object
);
3966 extern void save_restriction_restore (Lisp_Object
);
3967 extern _Noreturn
void time_overflow (void);
3968 extern Lisp_Object
make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3969 extern Lisp_Object
make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3971 extern void init_editfns (bool);
3972 extern void syms_of_editfns (void);
3974 /* Defined in buffer.c. */
3975 extern bool mouse_face_overlay_overlaps (Lisp_Object
);
3976 extern Lisp_Object
disable_line_numbers_overlay_at_eob (void);
3977 extern _Noreturn
void nsberror (Lisp_Object
);
3978 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3979 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3980 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3981 extern void report_overlay_modification (Lisp_Object
, Lisp_Object
, bool,
3982 Lisp_Object
, Lisp_Object
, Lisp_Object
);
3983 extern bool overlay_touches_p (ptrdiff_t);
3984 extern Lisp_Object
other_buffer_safely (Lisp_Object
);
3985 extern Lisp_Object
get_truename_buffer (Lisp_Object
);
3986 extern void init_buffer_once (void);
3987 extern void init_buffer (int);
3988 extern void syms_of_buffer (void);
3989 extern void keys_of_buffer (void);
3991 /* Defined in marker.c. */
3993 extern ptrdiff_t marker_position (Lisp_Object
);
3994 extern ptrdiff_t marker_byte_position (Lisp_Object
);
3995 extern void clear_charpos_cache (struct buffer
*);
3996 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer
*, ptrdiff_t);
3997 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer
*, ptrdiff_t);
3998 extern void unchain_marker (struct Lisp_Marker
*marker
);
3999 extern Lisp_Object
set_marker_restricted (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4000 extern Lisp_Object
set_marker_both (Lisp_Object
, Lisp_Object
, ptrdiff_t, ptrdiff_t);
4001 extern Lisp_Object
set_marker_restricted_both (Lisp_Object
, Lisp_Object
,
4002 ptrdiff_t, ptrdiff_t);
4003 extern Lisp_Object
build_marker (struct buffer
*, ptrdiff_t, ptrdiff_t);
4004 extern void syms_of_marker (void);
4006 /* Defined in fileio.c. */
4008 extern Lisp_Object
expand_and_dir_to_file (Lisp_Object
);
4009 extern Lisp_Object
write_region (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4010 Lisp_Object
, Lisp_Object
, Lisp_Object
,
4012 extern void close_file_unwind (int);
4013 extern void fclose_unwind (void *);
4014 extern void restore_point_unwind (Lisp_Object
);
4015 extern _Noreturn
void report_file_errno (const char *, Lisp_Object
, int);
4016 extern _Noreturn
void report_file_error (const char *, Lisp_Object
);
4017 extern _Noreturn
void report_file_notify_error (const char *, Lisp_Object
);
4018 extern bool internal_delete_file (Lisp_Object
);
4019 extern Lisp_Object
emacs_readlinkat (int, const char *);
4020 extern bool file_directory_p (const char *);
4021 extern bool file_accessible_directory_p (Lisp_Object
);
4022 extern void init_fileio (void);
4023 extern void syms_of_fileio (void);
4025 /* Defined in search.c. */
4026 extern void shrink_regexp_cache (void);
4027 extern void restore_search_regs (void);
4028 extern void update_search_regs (ptrdiff_t oldstart
,
4029 ptrdiff_t oldend
, ptrdiff_t newend
);
4030 extern void record_unwind_save_match_data (void);
4031 struct re_registers
;
4032 extern struct re_pattern_buffer
*compile_pattern (Lisp_Object
,
4033 struct re_registers
*,
4034 Lisp_Object
, bool, bool);
4035 extern ptrdiff_t fast_string_match_internal (Lisp_Object
, Lisp_Object
,
4039 fast_string_match (Lisp_Object regexp
, Lisp_Object string
)
4041 return fast_string_match_internal (regexp
, string
, Qnil
);
4045 fast_string_match_ignore_case (Lisp_Object regexp
, Lisp_Object string
)
4047 return fast_string_match_internal (regexp
, string
, Vascii_canon_table
);
4050 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object
, const char *,
4052 extern ptrdiff_t fast_looking_at (Lisp_Object
, ptrdiff_t, ptrdiff_t,
4053 ptrdiff_t, ptrdiff_t, Lisp_Object
);
4054 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4055 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4056 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4058 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4059 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4060 ptrdiff_t, ptrdiff_t *);
4061 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4062 ptrdiff_t, ptrdiff_t *);
4063 extern void syms_of_search (void);
4064 extern void clear_regexp_cache (void);
4066 /* Defined in minibuf.c. */
4068 extern Lisp_Object Vminibuffer_list
;
4069 extern Lisp_Object last_minibuf_string
;
4070 extern Lisp_Object
get_minibuffer (EMACS_INT
);
4071 extern void init_minibuf_once (void);
4072 extern void syms_of_minibuf (void);
4074 /* Defined in callint.c. */
4076 extern void syms_of_callint (void);
4078 /* Defined in casefiddle.c. */
4080 extern void syms_of_casefiddle (void);
4081 extern void keys_of_casefiddle (void);
4083 /* Defined in casetab.c. */
4085 extern void init_casetab_once (void);
4086 extern void syms_of_casetab (void);
4088 /* Defined in keyboard.c. */
4090 extern Lisp_Object echo_message_buffer
;
4091 extern struct kboard
*echo_kboard
;
4092 extern void cancel_echoing (void);
4093 extern bool input_pending
;
4094 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4095 extern sigjmp_buf return_to_command_loop
;
4097 extern Lisp_Object
menu_bar_items (Lisp_Object
);
4098 extern Lisp_Object
tool_bar_items (Lisp_Object
, int *);
4099 extern void discard_mouse_events (void);
4101 void handle_input_available_signal (int);
4103 extern Lisp_Object pending_funcalls
;
4104 extern bool detect_input_pending (void);
4105 extern bool detect_input_pending_ignore_squeezables (void);
4106 extern bool detect_input_pending_run_timers (bool);
4107 extern void safe_run_hooks (Lisp_Object
);
4108 extern void cmd_error_internal (Lisp_Object
, const char *);
4109 extern Lisp_Object
command_loop_1 (void);
4110 extern Lisp_Object
read_menu_command (void);
4111 extern Lisp_Object
recursive_edit_1 (void);
4112 extern void record_auto_save (void);
4113 extern void force_auto_save_soon (void);
4114 extern void init_keyboard (void);
4115 extern void syms_of_keyboard (void);
4116 extern void keys_of_keyboard (void);
4118 /* Defined in indent.c. */
4119 extern ptrdiff_t current_column (void);
4120 extern void invalidate_current_column (void);
4121 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT
);
4122 extern void syms_of_indent (void);
4124 /* Defined in frame.c. */
4125 extern void store_frame_param (struct frame
*, Lisp_Object
, Lisp_Object
);
4126 extern void store_in_alist (Lisp_Object
*, Lisp_Object
, Lisp_Object
);
4127 extern Lisp_Object
do_switch_frame (Lisp_Object
, int, int, Lisp_Object
);
4128 extern Lisp_Object
get_frame_param (struct frame
*, Lisp_Object
);
4129 extern void frames_discard_buffer (Lisp_Object
);
4130 extern void syms_of_frame (void);
4132 /* Defined in emacs.c. */
4133 extern char **initial_argv
;
4134 extern int initial_argc
;
4135 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4136 extern bool display_arg
;
4138 extern Lisp_Object
decode_env_path (const char *, const char *, bool);
4139 extern Lisp_Object empty_unibyte_string
, empty_multibyte_string
;
4140 extern _Noreturn
void terminate_due_to_signal (int, int);
4142 extern Lisp_Object Vlibrary_cache
;
4145 void fixup_locale (void);
4146 void synchronize_system_messages_locale (void);
4147 void synchronize_system_time_locale (void);
4149 INLINE
void fixup_locale (void) {}
4150 INLINE
void synchronize_system_messages_locale (void) {}
4151 INLINE
void synchronize_system_time_locale (void) {}
4153 extern char *emacs_strerror (int);
4154 extern void shut_down_emacs (int, Lisp_Object
);
4156 /* True means don't do interactive redisplay and don't change tty modes. */
4157 extern bool noninteractive
;
4159 /* True means remove site-lisp directories from load-path. */
4160 extern bool no_site_lisp
;
4162 /* True means put details like time stamps into builds. */
4163 extern bool build_details
;
4166 /* 0 not a daemon, 1 foreground daemon, 2 background daemon. */
4167 extern int daemon_type
;
4168 #define IS_DAEMON (daemon_type != 0)
4169 #define DAEMON_RUNNING (daemon_type >= 0)
4170 #else /* WINDOWSNT */
4171 extern void *w32_daemon_event
;
4172 #define IS_DAEMON (w32_daemon_event != NULL)
4173 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4176 /* True if handling a fatal error already. */
4177 extern bool fatal_error_in_progress
;
4179 /* True means don't do use window-system-specific display code. */
4180 extern bool inhibit_window_system
;
4181 /* True means that a filter or a sentinel is running. */
4182 extern bool running_asynch_code
;
4184 /* Defined in process.c. */
4185 struct Lisp_Process
;
4186 extern void kill_buffer_processes (Lisp_Object
);
4187 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object
,
4188 struct Lisp_Process
*, int);
4189 /* Max value for the first argument of wait_reading_process_output. */
4190 #if GNUC_PREREQ (3, 0, 0) && ! GNUC_PREREQ (4, 6, 0)
4191 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.0.
4192 The bug merely causes a bogus warning, but the warning is annoying. */
4193 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4195 # define WAIT_READING_MAX INTMAX_MAX
4198 extern void add_timer_wait_descriptor (int);
4200 extern void add_keyboard_wait_descriptor (int);
4201 extern void delete_keyboard_wait_descriptor (int);
4203 extern void add_gpm_wait_descriptor (int);
4204 extern void delete_gpm_wait_descriptor (int);
4206 extern void init_process_emacs (int);
4207 extern void syms_of_process (void);
4208 extern void setup_process_coding_systems (Lisp_Object
);
4210 /* Defined in callproc.c. */
4212 # define CHILD_SETUP_TYPE _Noreturn void
4214 # define CHILD_SETUP_TYPE int
4216 extern CHILD_SETUP_TYPE
child_setup (int, int, int, char **, bool, Lisp_Object
);
4217 extern void init_callproc_1 (void);
4218 extern void init_callproc (void);
4219 extern void set_initial_environment (void);
4220 extern void syms_of_callproc (void);
4222 /* Defined in doc.c. */
4223 enum text_quoting_style
4225 /* Use curved single quotes ‘like this’. */
4226 CURVE_QUOTING_STYLE
,
4228 /* Use grave accent and apostrophe `like this'. */
4229 GRAVE_QUOTING_STYLE
,
4231 /* Use apostrophes 'like this'. */
4232 STRAIGHT_QUOTING_STYLE
4234 extern enum text_quoting_style
text_quoting_style (void);
4235 extern Lisp_Object
read_doc_string (Lisp_Object
);
4236 extern Lisp_Object
get_doc_string (Lisp_Object
, bool, bool);
4237 extern void syms_of_doc (void);
4238 extern int read_bytecode_char (bool);
4240 /* Defined in bytecode.c. */
4241 extern void syms_of_bytecode (void);
4242 extern Lisp_Object
exec_byte_code (Lisp_Object
, Lisp_Object
, Lisp_Object
,
4243 Lisp_Object
, ptrdiff_t, Lisp_Object
*);
4244 extern Lisp_Object
get_byte_code_arity (Lisp_Object
);
4246 /* Defined in macros.c. */
4247 extern void init_macros (void);
4248 extern void syms_of_macros (void);
4250 /* Defined in undo.c. */
4251 extern void truncate_undo_list (struct buffer
*);
4252 extern void record_insert (ptrdiff_t, ptrdiff_t);
4253 extern void record_delete (ptrdiff_t, Lisp_Object
, bool);
4254 extern void record_first_change (void);
4255 extern void record_change (ptrdiff_t, ptrdiff_t);
4256 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4257 Lisp_Object
, Lisp_Object
,
4259 extern void syms_of_undo (void);
4261 /* Defined in textprop.c. */
4262 extern void report_interval_modification (Lisp_Object
, Lisp_Object
);
4264 /* Defined in menu.c. */
4265 extern void syms_of_menu (void);
4267 /* Defined in xmenu.c. */
4268 extern void syms_of_xmenu (void);
4270 /* Defined in termchar.h. */
4271 struct tty_display_info
;
4273 /* Defined in sysdep.c. */
4274 #ifdef HAVE_PERSONALITY_ADDR_NO_RANDOMIZE
4275 extern bool disable_address_randomization (void);
4277 INLINE
bool disable_address_randomization (void) { return false; }
4279 extern int emacs_exec_file (char const *, char *const *, char *const *);
4280 extern void init_standard_fds (void);
4281 extern char *emacs_get_current_dir_name (void);
4282 extern void stuff_char (char c
);
4283 extern void init_foreground_group (void);
4284 extern void sys_subshell (void);
4285 extern void sys_suspend (void);
4286 extern void discard_tty_input (void);
4287 extern void init_sys_modes (struct tty_display_info
*);
4288 extern void reset_sys_modes (struct tty_display_info
*);
4289 extern void init_all_sys_modes (void);
4290 extern void reset_all_sys_modes (void);
4291 extern void child_setup_tty (int);
4292 extern void setup_pty (int);
4293 extern int set_window_size (int, int, int);
4294 extern EMACS_INT
get_random (void);
4295 extern void seed_random (void *, ptrdiff_t);
4296 extern void init_random (void);
4297 extern void emacs_backtrace (int);
4298 extern _Noreturn
void emacs_abort (void) NO_INLINE
;
4299 extern int emacs_open (const char *, int, int);
4300 extern int emacs_pipe (int[2]);
4301 extern int emacs_close (int);
4302 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4303 extern ptrdiff_t emacs_read_quit (int, void *, ptrdiff_t);
4304 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4305 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4306 extern ptrdiff_t emacs_write_quit (int, void const *, ptrdiff_t);
4307 extern void emacs_perror (char const *);
4308 extern int renameat_noreplace (int, char const *, int, char const *);
4309 extern int str_collate (Lisp_Object
, Lisp_Object
, Lisp_Object
, Lisp_Object
);
4311 /* Defined in filelock.c. */
4312 extern void lock_file (Lisp_Object
);
4313 extern void unlock_file (Lisp_Object
);
4314 extern void unlock_all_files (void);
4315 extern void unlock_buffer (struct buffer
*);
4316 extern void syms_of_filelock (void);
4318 /* Defined in sound.c. */
4319 extern void syms_of_sound (void);
4321 /* Defined in category.c. */
4322 extern void init_category_once (void);
4323 extern Lisp_Object
char_category_set (int);
4324 extern void syms_of_category (void);
4326 /* Defined in ccl.c. */
4327 extern void syms_of_ccl (void);
4329 /* Defined in dired.c. */
4330 extern void syms_of_dired (void);
4331 extern Lisp_Object
directory_files_internal (Lisp_Object
, Lisp_Object
,
4332 Lisp_Object
, Lisp_Object
,
4335 /* Defined in term.c. */
4336 extern int *char_ins_del_vector
;
4337 extern void syms_of_term (void);
4338 extern _Noreturn
void fatal (const char *msgid
, ...)
4339 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4341 /* Defined in terminal.c. */
4342 extern void syms_of_terminal (void);
4344 /* Defined in font.c. */
4345 extern void syms_of_font (void);
4346 extern void init_font (void);
4348 #ifdef HAVE_WINDOW_SYSTEM
4349 /* Defined in fontset.c. */
4350 extern void syms_of_fontset (void);
4353 /* Defined in inotify.c */
4355 extern void syms_of_inotify (void);
4358 /* Defined in kqueue.c */
4360 extern void globals_of_kqueue (void);
4361 extern void syms_of_kqueue (void);
4364 /* Defined in gfilenotify.c */
4365 #ifdef HAVE_GFILENOTIFY
4366 extern void globals_of_gfilenotify (void);
4367 extern void syms_of_gfilenotify (void);
4370 #ifdef HAVE_W32NOTIFY
4371 /* Defined on w32notify.c. */
4372 extern void syms_of_w32notify (void);
4375 /* Defined in xfaces.c. */
4376 extern Lisp_Object Vface_alternative_font_family_alist
;
4377 extern Lisp_Object Vface_alternative_font_registry_alist
;
4378 extern void syms_of_xfaces (void);
4380 #ifdef HAVE_X_WINDOWS
4381 /* Defined in xfns.c. */
4382 extern void syms_of_xfns (void);
4384 /* Defined in xsmfns.c. */
4385 extern void syms_of_xsmfns (void);
4387 /* Defined in xselect.c. */
4388 extern void syms_of_xselect (void);
4390 /* Defined in xterm.c. */
4391 extern void init_xterm (void);
4392 extern void syms_of_xterm (void);
4393 #endif /* HAVE_X_WINDOWS */
4395 #ifdef HAVE_WINDOW_SYSTEM
4396 /* Defined in xterm.c, nsterm.m, w32term.c. */
4397 extern char *x_get_keysym_name (int);
4398 #endif /* HAVE_WINDOW_SYSTEM */
4401 /* Defined in xml.c. */
4402 extern void syms_of_xml (void);
4403 extern void xml_cleanup_parser (void);
4407 /* Defined in lcms.c. */
4408 extern void syms_of_lcms2 (void);
4412 /* Defined in decompress.c. */
4413 extern void syms_of_decompress (void);
4417 /* Defined in dbusbind.c. */
4418 void init_dbusbind (void);
4419 void syms_of_dbusbind (void);
4423 /* Defined in profiler.c. */
4424 extern bool profiler_memory_running
;
4425 extern void malloc_probe (size_t);
4426 extern void syms_of_profiler (void);
4430 /* Defined in msdos.c, w32.c. */
4431 extern char *emacs_root_dir (void);
4434 /* Defined in lastfile.c. */
4435 extern char my_edata
[];
4436 extern char my_endbss
[];
4437 extern char *my_endbss_static
;
4439 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4440 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4441 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4442 extern void xfree (void *);
4443 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4444 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4445 ATTRIBUTE_ALLOC_SIZE ((2,3));
4446 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4448 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
4449 extern char *xlispstrdup (Lisp_Object
) ATTRIBUTE_MALLOC
;
4450 extern void dupstring (char **, char const *);
4452 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4453 null byte. This is like stpcpy, except the source is a Lisp string. */
4456 lispstpcpy (char *dest
, Lisp_Object string
)
4458 ptrdiff_t len
= SBYTES (string
);
4459 memcpy (dest
, SDATA (string
), len
+ 1);
4463 extern void xputenv (const char *);
4465 extern char *egetenv_internal (const char *, ptrdiff_t);
4468 egetenv (const char *var
)
4470 /* When VAR is a string literal, strlen can be optimized away. */
4471 return egetenv_internal (var
, strlen (var
));
4474 /* Set up the name of the machine we're running on. */
4475 extern void init_system_name (void);
4477 /* Return the absolute value of X. X should be a signed integer
4478 expression without side effects, and X's absolute value should not
4479 exceed the maximum for its promoted type. This is called 'eabs'
4480 because 'abs' is reserved by the C standard. */
4481 #define eabs(x) ((x) < 0 ? -(x) : (x))
4483 /* Return a fixnum or float, depending on whether the integer VAL fits
4484 in a Lisp fixnum. */
4486 #define make_fixnum_or_float(val) \
4487 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4489 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4490 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4492 enum MAX_ALLOCA
{ MAX_ALLOCA
= 16 * 1024 };
4494 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4496 #define USE_SAFE_ALLOCA \
4497 ptrdiff_t sa_avail = MAX_ALLOCA; \
4498 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4500 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4502 /* SAFE_ALLOCA allocates a simple buffer. */
4504 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4505 ? AVAIL_ALLOCA (size) \
4506 : (sa_must_free = true, record_xmalloc (size)))
4508 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4509 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4510 positive. The code is tuned for MULTIPLIER being a constant. */
4512 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4514 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4515 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4518 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4519 sa_must_free = true; \
4520 record_unwind_protect_ptr (xfree, buf); \
4524 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4526 #define SAFE_ALLOCA_STRING(ptr, string) \
4528 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4529 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4532 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4534 #define SAFE_FREE() \
4536 if (sa_must_free) { \
4537 sa_must_free = false; \
4538 unbind_to (sa_count, Qnil); \
4542 /* Set BUF to point to an allocated array of NELT Lisp_Objects,
4543 immediately followed by EXTRA spare bytes. */
4545 #define SAFE_ALLOCA_LISP_EXTRA(buf, nelt, extra) \
4547 ptrdiff_t alloca_nbytes; \
4548 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4549 || INT_ADD_WRAPV (alloca_nbytes, extra, &alloca_nbytes) \
4550 || SIZE_MAX < alloca_nbytes) \
4551 memory_full (SIZE_MAX); \
4552 else if (alloca_nbytes <= sa_avail) \
4553 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4557 (buf) = xmalloc (alloca_nbytes); \
4558 arg_ = make_save_memory (buf, nelt); \
4559 sa_must_free = true; \
4560 record_unwind_protect (free_save_value, arg_); \
4564 /* Set BUF to point to an allocated array of NELT Lisp_Objects. */
4566 #define SAFE_ALLOCA_LISP(buf, nelt) SAFE_ALLOCA_LISP_EXTRA (buf, nelt, 0)
4569 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4570 block-scoped conses and strings. These objects are not
4571 managed by the garbage collector, so they are dangerous: passing them
4572 out of their scope (e.g., to user code) results in undefined behavior.
4573 Conversely, they have better performance because GC is not involved.
4575 This feature is experimental and requires careful debugging.
4576 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4578 #if (!defined USE_STACK_LISP_OBJECTS \
4579 && defined __GNUC__ && !defined __clang__ && ! GNUC_PREREQ (4, 3, 2))
4580 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4581 # define USE_STACK_LISP_OBJECTS false
4583 #ifndef USE_STACK_LISP_OBJECTS
4584 # define USE_STACK_LISP_OBJECTS true
4587 #ifdef GC_CHECK_STRING_BYTES
4588 enum { defined_GC_CHECK_STRING_BYTES
= true };
4590 enum { defined_GC_CHECK_STRING_BYTES
= false };
4593 /* Struct inside unions that are typically no larger and aligned enough. */
4598 double d
; intmax_t i
; void *p
;
4601 union Aligned_String
4603 struct Lisp_String s
;
4604 double d
; intmax_t i
; void *p
;
4607 /* True for stack-based cons and string implementations, respectively.
4608 Use stack-based strings only if stack-based cons also works.
4609 Otherwise, STACK_CONS would create heap-based cons cells that
4610 could point to stack-based strings, which is a no-no. */
4614 USE_STACK_CONS
= (USE_STACK_LISP_OBJECTS
4615 && alignof (union Aligned_Cons
) % GCALIGNMENT
== 0),
4616 USE_STACK_STRING
= (USE_STACK_CONS
4617 && !defined_GC_CHECK_STRING_BYTES
4618 && alignof (union Aligned_String
) % GCALIGNMENT
== 0)
4621 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4622 use these only in macros like AUTO_CONS that declare a local
4623 variable whose lifetime will be clear to the programmer. */
4624 #define STACK_CONS(a, b) \
4625 make_lisp_ptr (&((union Aligned_Cons) { { a, { b } } }).s, Lisp_Cons)
4626 #define AUTO_CONS_EXPR(a, b) \
4627 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4629 /* Declare NAME as an auto Lisp cons or short list if possible, a
4630 GC-based one otherwise. This is in the sense of the C keyword
4631 'auto'; i.e., the object has the lifetime of the containing block.
4632 The resulting object should not be made visible to user Lisp code. */
4634 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4635 #define AUTO_LIST1(name, a) \
4636 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4637 #define AUTO_LIST2(name, a, b) \
4638 Lisp_Object name = (USE_STACK_CONS \
4639 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4641 #define AUTO_LIST3(name, a, b, c) \
4642 Lisp_Object name = (USE_STACK_CONS \
4643 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4645 #define AUTO_LIST4(name, a, b, c, d) \
4648 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4649 STACK_CONS (d, Qnil)))) \
4650 : list4 (a, b, c, d))
4652 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4653 Take its unibyte value from the null-terminated string STR,
4654 an expression that should not have side effects.
4655 STR's value is not necessarily copied. The resulting Lisp string
4656 should not be modified or made visible to user code. */
4658 #define AUTO_STRING(name, str) \
4659 AUTO_STRING_WITH_LEN (name, str, strlen (str))
4661 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4662 Take its unibyte value from the null-terminated string STR with length LEN.
4663 STR may have side effects and may contain null bytes.
4664 STR's value is not necessarily copied. The resulting Lisp string
4665 should not be modified or made visible to user code. */
4667 #define AUTO_STRING_WITH_LEN(name, str, len) \
4668 Lisp_Object name = \
4671 ((&((union Aligned_String) {{len, -1, 0, (unsigned char *) (str)}}).s), \
4673 : make_unibyte_string (str, len))
4675 /* Loop over conses of the list TAIL, signaling if a cycle is found,
4676 and possibly quitting after each loop iteration. In the loop body,
4677 set TAIL to the current cons. If the loop exits normally,
4678 set TAIL to the terminating non-cons, typically nil. The loop body
4679 should not modify the list’s top level structure other than by
4680 perhaps deleting the current cons. */
4682 #define FOR_EACH_TAIL(tail) \
4683 FOR_EACH_TAIL_INTERNAL (tail, circular_list (tail), true)
4685 /* Like FOR_EACH_TAIL (LIST), except do not signal or quit.
4686 If the loop exits due to a cycle, TAIL’s value is undefined. */
4688 #define FOR_EACH_TAIL_SAFE(tail) \
4689 FOR_EACH_TAIL_INTERNAL (tail, (void) ((tail) = Qnil), false)
4691 /* Iterator intended for use only within FOR_EACH_TAIL_INTERNAL. */
4692 struct for_each_tail_internal
4694 Lisp_Object tortoise
;
4696 unsigned short int q
;
4699 /* Like FOR_EACH_TAIL (LIST), except evaluate CYCLE if a cycle is
4700 found, and check for quit if CHECK_QUIT. This is an internal macro
4701 intended for use only by the above macros.
4703 Use Brent’s teleporting tortoise-hare algorithm. See:
4704 Brent RP. BIT. 1980;20(2):176-84. doi:10.1007/BF01933190
4705 http://maths-people.anu.edu.au/~brent/pd/rpb051i.pdf
4707 This macro uses maybe_quit because of an excess of caution. The
4708 call to maybe_quit should not be needed in practice, as a very long
4709 list, whether circular or not, will cause Emacs to be so slow in
4710 other uninterruptible areas (e.g., garbage collection) that there
4711 is little point to calling maybe_quit here. */
4713 #define FOR_EACH_TAIL_INTERNAL(tail, cycle, check_quit) \
4714 for (struct for_each_tail_internal li = { tail, 2, 0, 2 }; \
4716 ((tail) = XCDR (tail), \
4718 || ((check_quit) ? maybe_quit () : (void) 0, 0 < --li.n) \
4719 || (li.q = li.n = li.max <<= 1, li.n >>= USHRT_WIDTH, \
4720 li.tortoise = (tail), false)) \
4721 && EQ (tail, li.tortoise)) \
4722 ? (cycle) : (void) 0))
4724 /* Do a `for' loop over alist values. */
4726 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4727 for ((list_var) = (head_var); \
4728 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4729 (list_var) = XCDR (list_var))
4731 /* Check whether it's time for GC, and run it if so. */
4736 if ((consing_since_gc
> gc_cons_threshold
4737 && consing_since_gc
> gc_relative_threshold
)
4738 || (!NILP (Vmemory_full
)
4739 && consing_since_gc
> memory_full_cons_threshold
))
4740 Fgarbage_collect ();
4745 #endif /* EMACS_LISP_H */