]> code.delx.au - gnu-emacs/blob - src/lisp.h
Rework C source files to avoid ^(
[gnu-emacs] / src / lisp.h
1 /* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
2
3 Copyright (C) 1985-1987, 1993-1995, 1997-2016 Free Software Foundation,
4 Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21 #ifndef EMACS_LISP_H
22 #define EMACS_LISP_H
23
24 #include <setjmp.h>
25 #include <stdalign.h>
26 #include <stdarg.h>
27 #include <stddef.h>
28 #include <float.h>
29 #include <inttypes.h>
30 #include <limits.h>
31
32 #include <intprops.h>
33 #include <verify.h>
34
35 INLINE_HEADER_BEGIN
36
37 /* Define a TYPE constant ID as an externally visible name. Use like this:
38
39 DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
40 # define ID (some integer preprocessor expression of type TYPE)
41 DEFINE_GDB_SYMBOL_END (ID)
42
43 This hack is for the benefit of compilers that do not make macro
44 definitions or enums visible to the debugger. It's used for symbols
45 that .gdbinit needs. */
46
47 #define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
48 #ifdef MAIN_PROGRAM
49 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
50 # define DEFINE_GDB_SYMBOL_END(id) = id;
51 #else
52 # define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
53 # define DEFINE_GDB_SYMBOL_END(val) ;
54 #endif
55
56 /* The ubiquitous max and min macros. */
57 #undef min
58 #undef max
59 #define max(a, b) ((a) > (b) ? (a) : (b))
60 #define min(a, b) ((a) < (b) ? (a) : (b))
61
62 /* Number of elements in an array. */
63 #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
64
65 /* Number of bits in a Lisp_Object tag. */
66 DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS)
67 #define GCTYPEBITS 3
68 DEFINE_GDB_SYMBOL_END (GCTYPEBITS)
69
70 /* EMACS_INT - signed integer wide enough to hold an Emacs value
71 EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
72 pI - printf length modifier for EMACS_INT
73 EMACS_UINT - unsigned variant of EMACS_INT */
74 #ifndef EMACS_INT_MAX
75 # if INTPTR_MAX <= 0
76 # error "INTPTR_MAX misconfigured"
77 # elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
78 typedef int EMACS_INT;
79 typedef unsigned int EMACS_UINT;
80 # define EMACS_INT_MAX INT_MAX
81 # define pI ""
82 # elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
83 typedef long int EMACS_INT;
84 typedef unsigned long EMACS_UINT;
85 # define EMACS_INT_MAX LONG_MAX
86 # define pI "l"
87 # elif INTPTR_MAX <= LLONG_MAX
88 typedef long long int EMACS_INT;
89 typedef unsigned long long int EMACS_UINT;
90 # define EMACS_INT_MAX LLONG_MAX
91 # define pI "ll"
92 # else
93 # error "INTPTR_MAX too large"
94 # endif
95 #endif
96
97 /* Number of bits to put in each character in the internal representation
98 of bool vectors. This should not vary across implementations. */
99 enum { BOOL_VECTOR_BITS_PER_CHAR =
100 #define BOOL_VECTOR_BITS_PER_CHAR 8
101 BOOL_VECTOR_BITS_PER_CHAR
102 };
103
104 /* An unsigned integer type representing a fixed-length bit sequence,
105 suitable for bool vector words, GC mark bits, etc. Normally it is size_t
106 for speed, but it is unsigned char on weird platforms. */
107 #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
108 typedef size_t bits_word;
109 # define BITS_WORD_MAX SIZE_MAX
110 enum { BITS_PER_BITS_WORD = CHAR_BIT * sizeof (bits_word) };
111 #else
112 typedef unsigned char bits_word;
113 # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
114 enum { BITS_PER_BITS_WORD = BOOL_VECTOR_BITS_PER_CHAR };
115 #endif
116 verify (BITS_WORD_MAX >> (BITS_PER_BITS_WORD - 1) == 1);
117
118 /* Number of bits in some machine integer types. */
119 enum
120 {
121 BITS_PER_CHAR = CHAR_BIT,
122 BITS_PER_SHORT = CHAR_BIT * sizeof (short),
123 BITS_PER_LONG = CHAR_BIT * sizeof (long int),
124 BITS_PER_EMACS_INT = CHAR_BIT * sizeof (EMACS_INT)
125 };
126
127 /* printmax_t and uprintmax_t are types for printing large integers.
128 These are the widest integers that are supported for printing.
129 pMd etc. are conversions for printing them.
130 On C99 hosts, there's no problem, as even the widest integers work.
131 Fall back on EMACS_INT on pre-C99 hosts. */
132 #ifdef PRIdMAX
133 typedef intmax_t printmax_t;
134 typedef uintmax_t uprintmax_t;
135 # define pMd PRIdMAX
136 # define pMu PRIuMAX
137 #else
138 typedef EMACS_INT printmax_t;
139 typedef EMACS_UINT uprintmax_t;
140 # define pMd pI"d"
141 # define pMu pI"u"
142 #endif
143
144 /* Use pD to format ptrdiff_t values, which suffice for indexes into
145 buffers and strings. Emacs never allocates objects larger than
146 PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
147 In C99, pD can always be "t"; configure it here for the sake of
148 pre-C99 libraries such as glibc 2.0 and Solaris 8. */
149 #if PTRDIFF_MAX == INT_MAX
150 # define pD ""
151 #elif PTRDIFF_MAX == LONG_MAX
152 # define pD "l"
153 #elif PTRDIFF_MAX == LLONG_MAX
154 # define pD "ll"
155 #else
156 # define pD "t"
157 #endif
158
159 /* Extra internal type checking? */
160
161 /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
162 'assume (COND)'. COND should be free of side effects, as it may or
163 may not be evaluated.
164
165 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
166 defined and suppress_checking is false, and does nothing otherwise.
167 Emacs dies if COND is checked and is false. The suppress_checking
168 variable is initialized to 0 in alloc.c. Set it to 1 using a
169 debugger to temporarily disable aborting on detected internal
170 inconsistencies or error conditions.
171
172 In some cases, a good compiler may be able to optimize away the
173 eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
174 uses eassert to test STRINGP (x), but a particular use of XSTRING
175 is invoked only after testing that STRINGP (x) is true, making the
176 test redundant.
177
178 eassume is like eassert except that it also causes the compiler to
179 assume that COND is true afterwards, regardless of whether runtime
180 checking is enabled. This can improve performance in some cases,
181 though it can degrade performance in others. It's often suboptimal
182 for COND to call external functions or access volatile storage. */
183
184 #ifndef ENABLE_CHECKING
185 # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */
186 # define eassume(cond) assume (cond)
187 #else /* ENABLE_CHECKING */
188
189 extern _Noreturn void die (const char *, const char *, int);
190
191 extern bool suppress_checking EXTERNALLY_VISIBLE;
192
193 # define eassert(cond) \
194 (suppress_checking || (cond) \
195 ? (void) 0 \
196 : die (# cond, __FILE__, __LINE__))
197 # define eassume(cond) \
198 (suppress_checking \
199 ? assume (cond) \
200 : (cond) \
201 ? (void) 0 \
202 : die (# cond, __FILE__, __LINE__))
203 #endif /* ENABLE_CHECKING */
204
205 \f
206 /* Use the configure flag --enable-check-lisp-object-type to make
207 Lisp_Object use a struct type instead of the default int. The flag
208 causes CHECK_LISP_OBJECT_TYPE to be defined. */
209
210 /***** Select the tagging scheme. *****/
211 /* The following option controls the tagging scheme:
212 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
213 always 0, and we can thus use them to hold tag bits, without
214 restricting our addressing space.
215
216 If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
217 restricting our possible address range.
218
219 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
220 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
221 on the few static Lisp_Objects used: lispsym, all the defsubr, and
222 the two special buffers buffer_defaults and buffer_local_symbols. */
223
224 enum Lisp_Bits
225 {
226 /* 2**GCTYPEBITS. This must be a macro that expands to a literal
227 integer constant, for MSVC. */
228 #define GCALIGNMENT 8
229
230 /* Number of bits in a Lisp_Object value, not counting the tag. */
231 VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS,
232
233 /* Number of bits in a Lisp fixnum tag. */
234 INTTYPEBITS = GCTYPEBITS - 1,
235
236 /* Number of bits in a Lisp fixnum value, not counting the tag. */
237 FIXNUM_BITS = VALBITS + 1
238 };
239
240 #if GCALIGNMENT != 1 << GCTYPEBITS
241 # error "GCALIGNMENT and GCTYPEBITS are inconsistent"
242 #endif
243
244 /* The maximum value that can be stored in a EMACS_INT, assuming all
245 bits other than the type bits contribute to a nonnegative signed value.
246 This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
247 expression involving VAL_MAX. */
248 #define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
249
250 /* Whether the least-significant bits of an EMACS_INT contain the tag.
251 On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
252 a. unnecessary, because the top bits of an EMACS_INT are unused, and
253 b. slower, because it typically requires extra masking.
254 So, USE_LSB_TAG is true only on hosts where it might be useful. */
255 DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG)
256 #define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
257 DEFINE_GDB_SYMBOL_END (USE_LSB_TAG)
258
259 #if !USE_LSB_TAG && !defined WIDE_EMACS_INT
260 # error "USE_LSB_TAG not supported on this platform; please report this." \
261 "Try 'configure --with-wide-int' to work around the problem."
262 error !;
263 #endif
264
265 #ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
266 # define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
267 #else
268 # define GCALIGNED /* empty */
269 #endif
270
271 /* Some operations are so commonly executed that they are implemented
272 as macros, not functions, because otherwise runtime performance would
273 suffer too much when compiling with GCC without optimization.
274 There's no need to inline everything, just the operations that
275 would otherwise cause a serious performance problem.
276
277 For each such operation OP, define a macro lisp_h_OP that contains
278 the operation's implementation. That way, OP can be implemented
279 via a macro definition like this:
280
281 #define OP(x) lisp_h_OP (x)
282
283 and/or via a function definition like this:
284
285 Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }
286
287 without worrying about the implementations diverging, since
288 lisp_h_OP defines the actual implementation. The lisp_h_OP macros
289 are intended to be private to this include file, and should not be
290 used elsewhere.
291
292 FIXME: Remove the lisp_h_OP macros, and define just the inline OP
293 functions, once most developers have access to GCC 4.8 or later and
294 can use "gcc -Og" to debug. Maybe in the year 2016. See
295 Bug#11935.
296
297 Commentary for these macros can be found near their corresponding
298 functions, below. */
299
300 #if CHECK_LISP_OBJECT_TYPE
301 # define lisp_h_XLI(o) ((o).i)
302 # define lisp_h_XIL(i) ((Lisp_Object) { i })
303 #else
304 # define lisp_h_XLI(o) (o)
305 # define lisp_h_XIL(i) (i)
306 #endif
307 #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y)
308 #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
309 #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
310 #define lisp_h_CHECK_TYPE(ok, predicate, x) \
311 ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x))
312 #define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
313 #define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
314 #define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
315 #define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
316 #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
317 #define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
318 #define lisp_h_NILP(x) EQ (x, Qnil)
319 #define lisp_h_SET_SYMBOL_VAL(sym, v) \
320 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
321 #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant)
322 #define lisp_h_SYMBOL_VAL(sym) \
323 (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
324 #define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
325 #define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
326 #define lisp_h_XCAR(c) XCONS (c)->car
327 #define lisp_h_XCDR(c) XCONS (c)->u.cdr
328 #define lisp_h_XCONS(a) \
329 (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
330 #define lisp_h_XHASH(a) XUINT (a)
331 #ifndef GC_CHECK_CONS_LIST
332 # define lisp_h_check_cons_list() ((void) 0)
333 #endif
334 #if USE_LSB_TAG
335 # define lisp_h_make_number(n) \
336 XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
337 # define lisp_h_XFASTINT(a) XINT (a)
338 # define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
339 # define lisp_h_XSYMBOL(a) \
340 (eassert (SYMBOLP (a)), \
341 (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
342 + (char *) lispsym))
343 # define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
344 # define lisp_h_XUNTAG(a, type) ((void *) (intptr_t) (XLI (a) - (type)))
345 #endif
346
347 /* When compiling via gcc -O0, define the key operations as macros, as
348 Emacs is too slow otherwise. To disable this optimization, compile
349 with -DINLINING=false. */
350 #if (defined __NO_INLINE__ \
351 && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
352 && ! (defined INLINING && ! INLINING))
353 # define DEFINE_KEY_OPS_AS_MACROS true
354 #else
355 # define DEFINE_KEY_OPS_AS_MACROS false
356 #endif
357
358 #if DEFINE_KEY_OPS_AS_MACROS
359 # define XLI(o) lisp_h_XLI (o)
360 # define XIL(i) lisp_h_XIL (i)
361 # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y)
362 # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
363 # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
364 # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
365 # define CONSP(x) lisp_h_CONSP (x)
366 # define EQ(x, y) lisp_h_EQ (x, y)
367 # define FLOATP(x) lisp_h_FLOATP (x)
368 # define INTEGERP(x) lisp_h_INTEGERP (x)
369 # define MARKERP(x) lisp_h_MARKERP (x)
370 # define MISCP(x) lisp_h_MISCP (x)
371 # define NILP(x) lisp_h_NILP (x)
372 # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
373 # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
374 # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
375 # define SYMBOLP(x) lisp_h_SYMBOLP (x)
376 # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
377 # define XCAR(c) lisp_h_XCAR (c)
378 # define XCDR(c) lisp_h_XCDR (c)
379 # define XCONS(a) lisp_h_XCONS (a)
380 # define XHASH(a) lisp_h_XHASH (a)
381 # ifndef GC_CHECK_CONS_LIST
382 # define check_cons_list() lisp_h_check_cons_list ()
383 # endif
384 # if USE_LSB_TAG
385 # define make_number(n) lisp_h_make_number (n)
386 # define XFASTINT(a) lisp_h_XFASTINT (a)
387 # define XINT(a) lisp_h_XINT (a)
388 # define XSYMBOL(a) lisp_h_XSYMBOL (a)
389 # define XTYPE(a) lisp_h_XTYPE (a)
390 # define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
391 # endif
392 #endif
393
394
395 /* Define the fundamental Lisp data structures. */
396
397 /* This is the set of Lisp data types. If you want to define a new
398 data type, read the comments after Lisp_Fwd_Type definition
399 below. */
400
401 /* Lisp integers use 2 tags, to give them one extra bit, thus
402 extending their range from, e.g., -2^28..2^28-1 to -2^29..2^29-1. */
403 #define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
404 #define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
405
406 /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields,
407 MSVC doesn't support them, and xlc and Oracle Studio c99 complain
408 vociferously about them. */
409 #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
410 || (defined __SUNPRO_C && __STDC__))
411 #define ENUM_BF(TYPE) unsigned int
412 #else
413 #define ENUM_BF(TYPE) enum TYPE
414 #endif
415
416
417 enum Lisp_Type
418 {
419 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
420 Lisp_Symbol = 0,
421
422 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
423 whose first member indicates the subtype. */
424 Lisp_Misc = 1,
425
426 /* Integer. XINT (obj) is the integer value. */
427 Lisp_Int0 = 2,
428 Lisp_Int1 = USE_LSB_TAG ? 6 : 3,
429
430 /* String. XSTRING (object) points to a struct Lisp_String.
431 The length of the string, and its contents, are stored therein. */
432 Lisp_String = 4,
433
434 /* Vector of Lisp objects, or something resembling it.
435 XVECTOR (object) points to a struct Lisp_Vector, which contains
436 the size and contents. The size field also contains the type
437 information, if it's not a real vector object. */
438 Lisp_Vectorlike = 5,
439
440 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
441 Lisp_Cons = USE_LSB_TAG ? 3 : 6,
442
443 Lisp_Float = 7
444 };
445
446 /* This is the set of data types that share a common structure.
447 The first member of the structure is a type code from this set.
448 The enum values are arbitrary, but we'll use large numbers to make it
449 more likely that we'll spot the error if a random word in memory is
450 mistakenly interpreted as a Lisp_Misc. */
451 enum Lisp_Misc_Type
452 {
453 Lisp_Misc_Free = 0x5eab,
454 Lisp_Misc_Marker,
455 Lisp_Misc_Overlay,
456 Lisp_Misc_Save_Value,
457 Lisp_Misc_Finalizer,
458 #ifdef HAVE_MODULES
459 Lisp_Misc_User_Ptr,
460 #endif
461 /* Currently floats are not a misc type,
462 but let's define this in case we want to change that. */
463 Lisp_Misc_Float,
464 /* This is not a type code. It is for range checking. */
465 Lisp_Misc_Limit
466 };
467
468 /* These are the types of forwarding objects used in the value slot
469 of symbols for special built-in variables whose value is stored in
470 C variables. */
471 enum Lisp_Fwd_Type
472 {
473 Lisp_Fwd_Int, /* Fwd to a C `int' variable. */
474 Lisp_Fwd_Bool, /* Fwd to a C boolean var. */
475 Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */
476 Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */
477 Lisp_Fwd_Kboard_Obj /* Fwd to a Lisp_Object field of kboards. */
478 };
479
480 /* If you want to define a new Lisp data type, here are some
481 instructions. See the thread at
482 http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
483 for more info.
484
485 First, there are already a couple of Lisp types that can be used if
486 your new type does not need to be exposed to Lisp programs nor
487 displayed to users. These are Lisp_Save_Value, a Lisp_Misc
488 subtype; and PVEC_OTHER, a kind of vectorlike object. The former
489 is suitable for temporarily stashing away pointers and integers in
490 a Lisp object. The latter is useful for vector-like Lisp objects
491 that need to be used as part of other objects, but which are never
492 shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
493 an example).
494
495 These two types don't look pretty when printed, so they are
496 unsuitable for Lisp objects that can be exposed to users.
497
498 To define a new data type, add one more Lisp_Misc subtype or one
499 more pseudovector subtype. Pseudovectors are more suitable for
500 objects with several slots that need to support fast random access,
501 while Lisp_Misc types are for everything else. A pseudovector object
502 provides one or more slots for Lisp objects, followed by struct
503 members that are accessible only from C. A Lisp_Misc object is a
504 wrapper for a C struct that can contain anything you like.
505
506 Explicit freeing is discouraged for Lisp objects in general. But if
507 you really need to exploit this, use Lisp_Misc (check free_misc in
508 alloc.c to see why). There is no way to free a vectorlike object.
509
510 To add a new pseudovector type, extend the pvec_type enumeration;
511 to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.
512
513 For a Lisp_Misc, you will also need to add your entry to union
514 Lisp_Misc (but make sure the first word has the same structure as
515 the others, starting with a 16-bit member of the Lisp_Misc_Type
516 enumeration and a 1-bit GC markbit) and make sure the overall size
517 of the union is not increased by your addition.
518
519 For a new pseudovector, it's highly desirable to limit the size
520 of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
521 Otherwise you will need to change sweep_vectors (also in alloc.c).
522
523 Then you will need to add switch branches in print.c (in
524 print_object, to print your object, and possibly also in
525 print_preprocess) and to alloc.c, to mark your object (in
526 mark_object) and to free it (in gc_sweep). The latter is also the
527 right place to call any code specific to your data type that needs
528 to run when the object is recycled -- e.g., free any additional
529 resources allocated for it that are not Lisp objects. You can even
530 make a pointer to the function that frees the resources a slot in
531 your object -- this way, the same object could be used to represent
532 several disparate C structures. */
533
534 #ifdef CHECK_LISP_OBJECT_TYPE
535
536 typedef struct { EMACS_INT i; } Lisp_Object;
537
538 #define LISP_INITIALLY(i) {i}
539
540 #undef CHECK_LISP_OBJECT_TYPE
541 enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = true };
542 #else /* CHECK_LISP_OBJECT_TYPE */
543
544 /* If a struct type is not wanted, define Lisp_Object as just a number. */
545
546 typedef EMACS_INT Lisp_Object;
547 #define LISP_INITIALLY(i) (i)
548 enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = false };
549 #endif /* CHECK_LISP_OBJECT_TYPE */
550
551 #define LISP_INITIALLY_ZERO LISP_INITIALLY (0)
552 \f
553 /* Forward declarations. */
554
555 /* Defined in this file. */
556 union Lisp_Fwd;
557 INLINE bool BOOL_VECTOR_P (Lisp_Object);
558 INLINE bool BUFFER_OBJFWDP (union Lisp_Fwd *);
559 INLINE bool BUFFERP (Lisp_Object);
560 INLINE bool CHAR_TABLE_P (Lisp_Object);
561 INLINE Lisp_Object CHAR_TABLE_REF_ASCII (Lisp_Object, ptrdiff_t);
562 INLINE bool (CONSP) (Lisp_Object);
563 INLINE bool (FLOATP) (Lisp_Object);
564 INLINE bool functionp (Lisp_Object);
565 INLINE bool (INTEGERP) (Lisp_Object);
566 INLINE bool (MARKERP) (Lisp_Object);
567 INLINE bool (MISCP) (Lisp_Object);
568 INLINE bool (NILP) (Lisp_Object);
569 INLINE bool OVERLAYP (Lisp_Object);
570 INLINE bool PROCESSP (Lisp_Object);
571 INLINE bool PSEUDOVECTORP (Lisp_Object, int);
572 INLINE bool SAVE_VALUEP (Lisp_Object);
573 INLINE bool FINALIZERP (Lisp_Object);
574
575 #ifdef HAVE_MODULES
576 INLINE bool USER_PTRP (Lisp_Object);
577 INLINE struct Lisp_User_Ptr *(XUSER_PTR) (Lisp_Object);
578 #endif
579
580 INLINE void set_sub_char_table_contents (Lisp_Object, ptrdiff_t,
581 Lisp_Object);
582 INLINE bool STRINGP (Lisp_Object);
583 INLINE bool SUB_CHAR_TABLE_P (Lisp_Object);
584 INLINE bool SUBRP (Lisp_Object);
585 INLINE bool (SYMBOLP) (Lisp_Object);
586 INLINE bool (VECTORLIKEP) (Lisp_Object);
587 INLINE bool WINDOWP (Lisp_Object);
588 INLINE bool TERMINALP (Lisp_Object);
589 INLINE struct Lisp_Save_Value *XSAVE_VALUE (Lisp_Object);
590 INLINE struct Lisp_Finalizer *XFINALIZER (Lisp_Object);
591 INLINE struct Lisp_Symbol *(XSYMBOL) (Lisp_Object);
592 INLINE void *(XUNTAG) (Lisp_Object, int);
593
594 /* Defined in chartab.c. */
595 extern Lisp_Object char_table_ref (Lisp_Object, int);
596 extern void char_table_set (Lisp_Object, int, Lisp_Object);
597
598 /* Defined in data.c. */
599 extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
600 extern _Noreturn void wrong_choice (Lisp_Object, Lisp_Object);
601
602 /* Defined in emacs.c. */
603 extern bool might_dump;
604 /* True means Emacs has already been initialized.
605 Used during startup to detect startup of dumped Emacs. */
606 extern bool initialized;
607
608 /* Defined in floatfns.c. */
609 extern double extract_float (Lisp_Object);
610
611 \f
612 /* Interned state of a symbol. */
613
614 enum symbol_interned
615 {
616 SYMBOL_UNINTERNED = 0,
617 SYMBOL_INTERNED = 1,
618 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
619 };
620
621 enum symbol_redirect
622 {
623 SYMBOL_PLAINVAL = 4,
624 SYMBOL_VARALIAS = 1,
625 SYMBOL_LOCALIZED = 2,
626 SYMBOL_FORWARDED = 3
627 };
628
629 struct Lisp_Symbol
630 {
631 bool_bf gcmarkbit : 1;
632
633 /* Indicates where the value can be found:
634 0 : it's a plain var, the value is in the `value' field.
635 1 : it's a varalias, the value is really in the `alias' symbol.
636 2 : it's a localized var, the value is in the `blv' object.
637 3 : it's a forwarding variable, the value is in `forward'. */
638 ENUM_BF (symbol_redirect) redirect : 3;
639
640 /* Non-zero means symbol is constant, i.e. changing its value
641 should signal an error. If the value is 3, then the var
642 can be changed, but only by `defconst'. */
643 unsigned constant : 2;
644
645 /* Interned state of the symbol. This is an enumerator from
646 enum symbol_interned. */
647 unsigned interned : 2;
648
649 /* True means that this variable has been explicitly declared
650 special (with `defvar' etc), and shouldn't be lexically bound. */
651 bool_bf declared_special : 1;
652
653 /* True if pointed to from purespace and hence can't be GC'd. */
654 bool_bf pinned : 1;
655
656 /* The symbol's name, as a Lisp string. */
657 Lisp_Object name;
658
659 /* Value of the symbol or Qunbound if unbound. Which alternative of the
660 union is used depends on the `redirect' field above. */
661 union {
662 Lisp_Object value;
663 struct Lisp_Symbol *alias;
664 struct Lisp_Buffer_Local_Value *blv;
665 union Lisp_Fwd *fwd;
666 } val;
667
668 /* Function value of the symbol or Qnil if not fboundp. */
669 Lisp_Object function;
670
671 /* The symbol's property list. */
672 Lisp_Object plist;
673
674 /* Next symbol in obarray bucket, if the symbol is interned. */
675 struct Lisp_Symbol *next;
676 };
677
678 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
679 meaning as in the DEFUN macro, and is used to construct a prototype. */
680 /* We can use the same trick as in the DEFUN macro to generate the
681 appropriate prototype. */
682 #define EXFUN(fnname, maxargs) \
683 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
684
685 /* Note that the weird token-substitution semantics of ANSI C makes
686 this work for MANY and UNEVALLED. */
687 #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *)
688 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
689 #define DEFUN_ARGS_0 (void)
690 #define DEFUN_ARGS_1 (Lisp_Object)
691 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
692 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
693 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
694 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
695 Lisp_Object)
696 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
697 Lisp_Object, Lisp_Object)
698 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
699 Lisp_Object, Lisp_Object, Lisp_Object)
700 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
701 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
702
703 /* Yield a signed integer that contains TAG along with PTR.
704
705 Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
706 and zero-extend otherwise (that’s a bit faster here).
707 Sign extension matters only when EMACS_INT is wider than a pointer. */
708 #define TAG_PTR(tag, ptr) \
709 (USE_LSB_TAG \
710 ? (intptr_t) (ptr) + (tag) \
711 : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
712
713 /* Yield an integer that contains a symbol tag along with OFFSET.
714 OFFSET should be the offset in bytes from 'lispsym' to the symbol. */
715 #define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
716
717 /* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
718 XLI (builtin_lisp_symbol (Qwhatever)),
719 except the former expands to an integer constant expression. */
720 #define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)
721
722 /* Declare extern constants for Lisp symbols. These can be helpful
723 when using a debugger like GDB, on older platforms where the debug
724 format does not represent C macros. */
725 #define DEFINE_LISP_SYMBOL(name) \
726 DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
727 DEFINE_GDB_SYMBOL_END (LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name)))
728
729 /* By default, define macros for Qt, etc., as this leads to a bit
730 better performance in the core Emacs interpreter. A plugin can
731 define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
732 other Emacs instances that assign different values to Qt, etc. */
733 #ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
734 # define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
735 #endif
736
737 #include "globals.h"
738
739 /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
740 At the machine level, these operations are no-ops. */
741
742 INLINE EMACS_INT
743 (XLI) (Lisp_Object o)
744 {
745 return lisp_h_XLI (o);
746 }
747
748 INLINE Lisp_Object
749 (XIL) (EMACS_INT i)
750 {
751 return lisp_h_XIL (i);
752 }
753
754 /* In the size word of a vector, this bit means the vector has been marked. */
755
756 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG)
757 # define ARRAY_MARK_FLAG PTRDIFF_MIN
758 DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG)
759
760 /* In the size word of a struct Lisp_Vector, this bit means it's really
761 some other vector-like object. */
762 DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG)
763 # define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
764 DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG)
765
766 /* In a pseudovector, the size field actually contains a word with one
767 PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
768 with PVEC_TYPE_MASK to indicate the actual type. */
769 enum pvec_type
770 {
771 PVEC_NORMAL_VECTOR,
772 PVEC_FREE,
773 PVEC_PROCESS,
774 PVEC_FRAME,
775 PVEC_WINDOW,
776 PVEC_BOOL_VECTOR,
777 PVEC_BUFFER,
778 PVEC_HASH_TABLE,
779 PVEC_TERMINAL,
780 PVEC_WINDOW_CONFIGURATION,
781 PVEC_SUBR,
782 PVEC_OTHER,
783 PVEC_XWIDGET,
784 PVEC_XWIDGET_VIEW,
785
786 /* These should be last, check internal_equal to see why. */
787 PVEC_COMPILED,
788 PVEC_CHAR_TABLE,
789 PVEC_SUB_CHAR_TABLE,
790 PVEC_FONT /* Should be last because it's used for range checking. */
791 };
792
793 enum More_Lisp_Bits
794 {
795 /* For convenience, we also store the number of elements in these bits.
796 Note that this size is not necessarily the memory-footprint size, but
797 only the number of Lisp_Object fields (that need to be traced by GC).
798 The distinction is used, e.g., by Lisp_Process, which places extra
799 non-Lisp_Object fields at the end of the structure. */
800 PSEUDOVECTOR_SIZE_BITS = 12,
801 PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1,
802
803 /* To calculate the memory footprint of the pseudovector, it's useful
804 to store the size of non-Lisp area in word_size units here. */
805 PSEUDOVECTOR_REST_BITS = 12,
806 PSEUDOVECTOR_REST_MASK = (((1 << PSEUDOVECTOR_REST_BITS) - 1)
807 << PSEUDOVECTOR_SIZE_BITS),
808
809 /* Used to extract pseudovector subtype information. */
810 PSEUDOVECTOR_AREA_BITS = PSEUDOVECTOR_SIZE_BITS + PSEUDOVECTOR_REST_BITS,
811 PVEC_TYPE_MASK = 0x3f << PSEUDOVECTOR_AREA_BITS
812 };
813 \f
814 /* These functions extract various sorts of values from a Lisp_Object.
815 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
816 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
817 that cons. */
818
819 /* Mask for the value (as opposed to the type bits) of a Lisp object. */
820 DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT, VALMASK)
821 # define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
822 DEFINE_GDB_SYMBOL_END (VALMASK)
823
824 /* Largest and smallest representable fixnum values. These are the C
825 values. They are macros for use in static initializers. */
826 #define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
827 #define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
828
829 #if USE_LSB_TAG
830
831 INLINE Lisp_Object
832 (make_number) (EMACS_INT n)
833 {
834 return lisp_h_make_number (n);
835 }
836
837 INLINE EMACS_INT
838 (XINT) (Lisp_Object a)
839 {
840 return lisp_h_XINT (a);
841 }
842
843 INLINE EMACS_INT
844 (XFASTINT) (Lisp_Object a)
845 {
846 EMACS_INT n = lisp_h_XFASTINT (a);
847 eassume (0 <= n);
848 return n;
849 }
850
851 INLINE struct Lisp_Symbol *
852 (XSYMBOL) (Lisp_Object a)
853 {
854 return lisp_h_XSYMBOL (a);
855 }
856
857 INLINE enum Lisp_Type
858 (XTYPE) (Lisp_Object a)
859 {
860 return lisp_h_XTYPE (a);
861 }
862
863 INLINE void *
864 (XUNTAG) (Lisp_Object a, int type)
865 {
866 return lisp_h_XUNTAG (a, type);
867 }
868
869 #else /* ! USE_LSB_TAG */
870
871 /* Although compiled only if ! USE_LSB_TAG, the following functions
872 also work when USE_LSB_TAG; this is to aid future maintenance when
873 the lisp_h_* macros are eventually removed. */
874
875 /* Make a Lisp integer representing the value of the low order
876 bits of N. */
877 INLINE Lisp_Object
878 make_number (EMACS_INT n)
879 {
880 EMACS_INT int0 = Lisp_Int0;
881 if (USE_LSB_TAG)
882 {
883 EMACS_UINT u = n;
884 n = u << INTTYPEBITS;
885 n += int0;
886 }
887 else
888 {
889 n &= INTMASK;
890 n += (int0 << VALBITS);
891 }
892 return XIL (n);
893 }
894
895 /* Extract A's value as a signed integer. */
896 INLINE EMACS_INT
897 XINT (Lisp_Object a)
898 {
899 EMACS_INT i = XLI (a);
900 if (! USE_LSB_TAG)
901 {
902 EMACS_UINT u = i;
903 i = u << INTTYPEBITS;
904 }
905 return i >> INTTYPEBITS;
906 }
907
908 /* Like XINT (A), but may be faster. A must be nonnegative.
909 If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
910 integers have zero-bits in their tags. */
911 INLINE EMACS_INT
912 XFASTINT (Lisp_Object a)
913 {
914 EMACS_INT int0 = Lisp_Int0;
915 EMACS_INT n = USE_LSB_TAG ? XINT (a) : XLI (a) - (int0 << VALBITS);
916 eassume (0 <= n);
917 return n;
918 }
919
920 /* Extract A's type. */
921 INLINE enum Lisp_Type
922 XTYPE (Lisp_Object a)
923 {
924 EMACS_UINT i = XLI (a);
925 return USE_LSB_TAG ? i & ~VALMASK : i >> VALBITS;
926 }
927
928 /* Extract A's value as a symbol. */
929 INLINE struct Lisp_Symbol *
930 XSYMBOL (Lisp_Object a)
931 {
932 eassert (SYMBOLP (a));
933 intptr_t i = (intptr_t) XUNTAG (a, Lisp_Symbol);
934 void *p = (char *) lispsym + i;
935 return p;
936 }
937
938 /* Extract A's pointer value, assuming A's type is TYPE. */
939 INLINE void *
940 XUNTAG (Lisp_Object a, int type)
941 {
942 intptr_t i = USE_LSB_TAG ? XLI (a) - type : XLI (a) & VALMASK;
943 return (void *) i;
944 }
945
946 #endif /* ! USE_LSB_TAG */
947
948 /* Extract A's value as an unsigned integer. */
949 INLINE EMACS_UINT
950 XUINT (Lisp_Object a)
951 {
952 EMACS_UINT i = XLI (a);
953 return USE_LSB_TAG ? i >> INTTYPEBITS : i & INTMASK;
954 }
955
956 /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT
957 right now, but XUINT should only be applied to objects we know are
958 integers. */
959
960 INLINE EMACS_INT
961 (XHASH) (Lisp_Object a)
962 {
963 return lisp_h_XHASH (a);
964 }
965
966 /* Like make_number (N), but may be faster. N must be in nonnegative range. */
967 INLINE Lisp_Object
968 make_natnum (EMACS_INT n)
969 {
970 eassert (0 <= n && n <= MOST_POSITIVE_FIXNUM);
971 EMACS_INT int0 = Lisp_Int0;
972 return USE_LSB_TAG ? make_number (n) : XIL (n + (int0 << VALBITS));
973 }
974
975 /* Return true if X and Y are the same object. */
976
977 INLINE bool
978 (EQ) (Lisp_Object x, Lisp_Object y)
979 {
980 return lisp_h_EQ (x, y);
981 }
982
983 /* Value is true if I doesn't fit into a Lisp fixnum. It is
984 written this way so that it also works if I is of unsigned
985 type or if I is a NaN. */
986
987 #define FIXNUM_OVERFLOW_P(i) \
988 (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
989
990 INLINE ptrdiff_t
991 clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper)
992 {
993 return num < lower ? lower : num <= upper ? num : upper;
994 }
995 \f
996
997 /* Extract a value or address from a Lisp_Object. */
998
999 INLINE struct Lisp_Cons *
1000 (XCONS) (Lisp_Object a)
1001 {
1002 return lisp_h_XCONS (a);
1003 }
1004
1005 INLINE struct Lisp_Vector *
1006 XVECTOR (Lisp_Object a)
1007 {
1008 eassert (VECTORLIKEP (a));
1009 return XUNTAG (a, Lisp_Vectorlike);
1010 }
1011
1012 INLINE struct Lisp_String *
1013 XSTRING (Lisp_Object a)
1014 {
1015 eassert (STRINGP (a));
1016 return XUNTAG (a, Lisp_String);
1017 }
1018
1019 /* The index of the C-defined Lisp symbol SYM.
1020 This can be used in a static initializer. */
1021 #define SYMBOL_INDEX(sym) i##sym
1022
1023 INLINE struct Lisp_Float *
1024 XFLOAT (Lisp_Object a)
1025 {
1026 eassert (FLOATP (a));
1027 return XUNTAG (a, Lisp_Float);
1028 }
1029
1030 /* Pseudovector types. */
1031
1032 INLINE struct Lisp_Process *
1033 XPROCESS (Lisp_Object a)
1034 {
1035 eassert (PROCESSP (a));
1036 return XUNTAG (a, Lisp_Vectorlike);
1037 }
1038
1039 INLINE struct window *
1040 XWINDOW (Lisp_Object a)
1041 {
1042 eassert (WINDOWP (a));
1043 return XUNTAG (a, Lisp_Vectorlike);
1044 }
1045
1046 INLINE struct terminal *
1047 XTERMINAL (Lisp_Object a)
1048 {
1049 eassert (TERMINALP (a));
1050 return XUNTAG (a, Lisp_Vectorlike);
1051 }
1052
1053 INLINE struct Lisp_Subr *
1054 XSUBR (Lisp_Object a)
1055 {
1056 eassert (SUBRP (a));
1057 return XUNTAG (a, Lisp_Vectorlike);
1058 }
1059
1060 INLINE struct buffer *
1061 XBUFFER (Lisp_Object a)
1062 {
1063 eassert (BUFFERP (a));
1064 return XUNTAG (a, Lisp_Vectorlike);
1065 }
1066
1067 INLINE struct Lisp_Char_Table *
1068 XCHAR_TABLE (Lisp_Object a)
1069 {
1070 eassert (CHAR_TABLE_P (a));
1071 return XUNTAG (a, Lisp_Vectorlike);
1072 }
1073
1074 INLINE struct Lisp_Sub_Char_Table *
1075 XSUB_CHAR_TABLE (Lisp_Object a)
1076 {
1077 eassert (SUB_CHAR_TABLE_P (a));
1078 return XUNTAG (a, Lisp_Vectorlike);
1079 }
1080
1081 INLINE struct Lisp_Bool_Vector *
1082 XBOOL_VECTOR (Lisp_Object a)
1083 {
1084 eassert (BOOL_VECTOR_P (a));
1085 return XUNTAG (a, Lisp_Vectorlike);
1086 }
1087
1088 /* Construct a Lisp_Object from a value or address. */
1089
1090 INLINE Lisp_Object
1091 make_lisp_ptr (void *ptr, enum Lisp_Type type)
1092 {
1093 Lisp_Object a = XIL (TAG_PTR (type, ptr));
1094 eassert (XTYPE (a) == type && XUNTAG (a, type) == ptr);
1095 return a;
1096 }
1097
1098 INLINE Lisp_Object
1099 make_lisp_symbol (struct Lisp_Symbol *sym)
1100 {
1101 Lisp_Object a = XIL (TAG_SYMOFFSET ((char *) sym - (char *) lispsym));
1102 eassert (XSYMBOL (a) == sym);
1103 return a;
1104 }
1105
1106 INLINE Lisp_Object
1107 builtin_lisp_symbol (int index)
1108 {
1109 return make_lisp_symbol (lispsym + index);
1110 }
1111
1112 #define XSETINT(a, b) ((a) = make_number (b))
1113 #define XSETFASTINT(a, b) ((a) = make_natnum (b))
1114 #define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
1115 #define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
1116 #define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
1117 #define XSETSYMBOL(a, b) ((a) = make_lisp_symbol (b))
1118 #define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
1119 #define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
1120
1121 /* Pseudovector types. */
1122
1123 #define XSETPVECTYPE(v, code) \
1124 ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS))
1125 #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \
1126 ((v)->header.size = (PSEUDOVECTOR_FLAG \
1127 | ((code) << PSEUDOVECTOR_AREA_BITS) \
1128 | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \
1129 | (lispsize)))
1130
1131 /* The cast to struct vectorlike_header * avoids aliasing issues. */
1132 #define XSETPSEUDOVECTOR(a, b, code) \
1133 XSETTYPED_PSEUDOVECTOR (a, b, \
1134 (((struct vectorlike_header *) \
1135 XUNTAG (a, Lisp_Vectorlike)) \
1136 ->size), \
1137 code)
1138 #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \
1139 (XSETVECTOR (a, b), \
1140 eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
1141 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))))
1142
1143 #define XSETWINDOW_CONFIGURATION(a, b) \
1144 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
1145 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
1146 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
1147 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
1148 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
1149 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
1150 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
1151 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
1152 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
1153 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
1154
1155 /* Efficiently convert a pointer to a Lisp object and back. The
1156 pointer is represented as a Lisp integer, so the garbage collector
1157 does not know about it. The pointer should not have both Lisp_Int1
1158 bits set, which makes this conversion inherently unportable. */
1159
1160 INLINE void *
1161 XINTPTR (Lisp_Object a)
1162 {
1163 return XUNTAG (a, Lisp_Int0);
1164 }
1165
1166 INLINE Lisp_Object
1167 make_pointer_integer (void *p)
1168 {
1169 Lisp_Object a = XIL (TAG_PTR (Lisp_Int0, p));
1170 eassert (INTEGERP (a) && XINTPTR (a) == p);
1171 return a;
1172 }
1173
1174 /* Type checking. */
1175
1176 INLINE void
1177 (CHECK_TYPE) (int ok, Lisp_Object predicate, Lisp_Object x)
1178 {
1179 lisp_h_CHECK_TYPE (ok, predicate, x);
1180 }
1181
1182 /* See the macros in intervals.h. */
1183
1184 typedef struct interval *INTERVAL;
1185
1186 struct GCALIGNED Lisp_Cons
1187 {
1188 /* Car of this cons cell. */
1189 Lisp_Object car;
1190
1191 union
1192 {
1193 /* Cdr of this cons cell. */
1194 Lisp_Object cdr;
1195
1196 /* Used to chain conses on a free list. */
1197 struct Lisp_Cons *chain;
1198 } u;
1199 };
1200
1201 /* Take the car or cdr of something known to be a cons cell. */
1202 /* The _addr functions shouldn't be used outside of the minimal set
1203 of code that has to know what a cons cell looks like. Other code not
1204 part of the basic lisp implementation should assume that the car and cdr
1205 fields are not accessible. (What if we want to switch to
1206 a copying collector someday? Cached cons cell field addresses may be
1207 invalidated at arbitrary points.) */
1208 INLINE Lisp_Object *
1209 xcar_addr (Lisp_Object c)
1210 {
1211 return &XCONS (c)->car;
1212 }
1213 INLINE Lisp_Object *
1214 xcdr_addr (Lisp_Object c)
1215 {
1216 return &XCONS (c)->u.cdr;
1217 }
1218
1219 /* Use these from normal code. */
1220
1221 INLINE Lisp_Object
1222 (XCAR) (Lisp_Object c)
1223 {
1224 return lisp_h_XCAR (c);
1225 }
1226
1227 INLINE Lisp_Object
1228 (XCDR) (Lisp_Object c)
1229 {
1230 return lisp_h_XCDR (c);
1231 }
1232
1233 /* Use these to set the fields of a cons cell.
1234
1235 Note that both arguments may refer to the same object, so 'n'
1236 should not be read after 'c' is first modified. */
1237 INLINE void
1238 XSETCAR (Lisp_Object c, Lisp_Object n)
1239 {
1240 *xcar_addr (c) = n;
1241 }
1242 INLINE void
1243 XSETCDR (Lisp_Object c, Lisp_Object n)
1244 {
1245 *xcdr_addr (c) = n;
1246 }
1247
1248 /* Take the car or cdr of something whose type is not known. */
1249 INLINE Lisp_Object
1250 CAR (Lisp_Object c)
1251 {
1252 return (CONSP (c) ? XCAR (c)
1253 : NILP (c) ? Qnil
1254 : wrong_type_argument (Qlistp, c));
1255 }
1256 INLINE Lisp_Object
1257 CDR (Lisp_Object c)
1258 {
1259 return (CONSP (c) ? XCDR (c)
1260 : NILP (c) ? Qnil
1261 : wrong_type_argument (Qlistp, c));
1262 }
1263
1264 /* Take the car or cdr of something whose type is not known. */
1265 INLINE Lisp_Object
1266 CAR_SAFE (Lisp_Object c)
1267 {
1268 return CONSP (c) ? XCAR (c) : Qnil;
1269 }
1270 INLINE Lisp_Object
1271 CDR_SAFE (Lisp_Object c)
1272 {
1273 return CONSP (c) ? XCDR (c) : Qnil;
1274 }
1275
1276 /* In a string or vector, the sign bit of the `size' is the gc mark bit. */
1277
1278 struct GCALIGNED Lisp_String
1279 {
1280 ptrdiff_t size;
1281 ptrdiff_t size_byte;
1282 INTERVAL intervals; /* Text properties in this string. */
1283 unsigned char *data;
1284 };
1285
1286 /* True if STR is a multibyte string. */
1287 INLINE bool
1288 STRING_MULTIBYTE (Lisp_Object str)
1289 {
1290 return 0 <= XSTRING (str)->size_byte;
1291 }
1292
1293 /* An upper bound on the number of bytes in a Lisp string, not
1294 counting the terminating null. This a tight enough bound to
1295 prevent integer overflow errors that would otherwise occur during
1296 string size calculations. A string cannot contain more bytes than
1297 a fixnum can represent, nor can it be so long that C pointer
1298 arithmetic stops working on the string plus its terminating null.
1299 Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
1300 may be a bit smaller than STRING_BYTES_BOUND, calculating it here
1301 would expose alloc.c internal details that we'd rather keep
1302 private.
1303
1304 This is a macro for use in static initializers. The cast to
1305 ptrdiff_t ensures that the macro is signed. */
1306 #define STRING_BYTES_BOUND \
1307 ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
1308
1309 /* Mark STR as a unibyte string. */
1310 #define STRING_SET_UNIBYTE(STR) \
1311 do { \
1312 if (XSTRING (STR)->size == 0) \
1313 (STR) = empty_unibyte_string; \
1314 else \
1315 XSTRING (STR)->size_byte = -1; \
1316 } while (false)
1317
1318 /* Mark STR as a multibyte string. Assure that STR contains only
1319 ASCII characters in advance. */
1320 #define STRING_SET_MULTIBYTE(STR) \
1321 do { \
1322 if (XSTRING (STR)->size == 0) \
1323 (STR) = empty_multibyte_string; \
1324 else \
1325 XSTRING (STR)->size_byte = XSTRING (STR)->size; \
1326 } while (false)
1327
1328 /* Convenience functions for dealing with Lisp strings. */
1329
1330 INLINE unsigned char *
1331 SDATA (Lisp_Object string)
1332 {
1333 return XSTRING (string)->data;
1334 }
1335 INLINE char *
1336 SSDATA (Lisp_Object string)
1337 {
1338 /* Avoid "differ in sign" warnings. */
1339 return (char *) SDATA (string);
1340 }
1341 INLINE unsigned char
1342 SREF (Lisp_Object string, ptrdiff_t index)
1343 {
1344 return SDATA (string)[index];
1345 }
1346 INLINE void
1347 SSET (Lisp_Object string, ptrdiff_t index, unsigned char new)
1348 {
1349 SDATA (string)[index] = new;
1350 }
1351 INLINE ptrdiff_t
1352 SCHARS (Lisp_Object string)
1353 {
1354 return XSTRING (string)->size;
1355 }
1356
1357 #ifdef GC_CHECK_STRING_BYTES
1358 extern ptrdiff_t string_bytes (struct Lisp_String *);
1359 #endif
1360 INLINE ptrdiff_t
1361 STRING_BYTES (struct Lisp_String *s)
1362 {
1363 #ifdef GC_CHECK_STRING_BYTES
1364 return string_bytes (s);
1365 #else
1366 return s->size_byte < 0 ? s->size : s->size_byte;
1367 #endif
1368 }
1369
1370 INLINE ptrdiff_t
1371 SBYTES (Lisp_Object string)
1372 {
1373 return STRING_BYTES (XSTRING (string));
1374 }
1375 INLINE void
1376 STRING_SET_CHARS (Lisp_Object string, ptrdiff_t newsize)
1377 {
1378 XSTRING (string)->size = newsize;
1379 }
1380
1381 /* Header of vector-like objects. This documents the layout constraints on
1382 vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents
1383 compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
1384 and PSEUDOVECTORP cast their pointers to struct vectorlike_header *,
1385 because when two such pointers potentially alias, a compiler won't
1386 incorrectly reorder loads and stores to their size fields. See
1387 Bug#8546. */
1388 struct vectorlike_header
1389 {
1390 /* The only field contains various pieces of information:
1391 - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
1392 - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
1393 vector (0) or a pseudovector (1).
1394 - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
1395 of slots) of the vector.
1396 - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields:
1397 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
1398 - b) number of Lisp_Objects slots at the beginning of the object
1399 held in PSEUDOVECTOR_SIZE_MASK field. These objects are always
1400 traced by the GC;
1401 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
1402 measured in word_size units. Rest fields may also include
1403 Lisp_Objects, but these objects usually needs some special treatment
1404 during GC.
1405 There are some exceptions. For PVEC_FREE, b) is always zero. For
1406 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
1407 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
1408 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */
1409 ptrdiff_t size;
1410 };
1411
1412 /* A regular vector is just a header plus an array of Lisp_Objects. */
1413
1414 struct Lisp_Vector
1415 {
1416 struct vectorlike_header header;
1417 Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER];
1418 };
1419
1420 /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */
1421 enum
1422 {
1423 ALIGNOF_STRUCT_LISP_VECTOR
1424 = alignof (union { struct vectorlike_header a; Lisp_Object b; })
1425 };
1426
1427 /* A boolvector is a kind of vectorlike, with contents like a string. */
1428
1429 struct Lisp_Bool_Vector
1430 {
1431 /* HEADER.SIZE is the vector's size field. It doesn't have the real size,
1432 just the subtype information. */
1433 struct vectorlike_header header;
1434 /* This is the size in bits. */
1435 EMACS_INT size;
1436 /* The actual bits, packed into bytes.
1437 Zeros fill out the last word if needed.
1438 The bits are in little-endian order in the bytes, and
1439 the bytes are in little-endian order in the words. */
1440 bits_word data[FLEXIBLE_ARRAY_MEMBER];
1441 };
1442
1443 INLINE EMACS_INT
1444 bool_vector_size (Lisp_Object a)
1445 {
1446 EMACS_INT size = XBOOL_VECTOR (a)->size;
1447 eassume (0 <= size);
1448 return size;
1449 }
1450
1451 INLINE bits_word *
1452 bool_vector_data (Lisp_Object a)
1453 {
1454 return XBOOL_VECTOR (a)->data;
1455 }
1456
1457 INLINE unsigned char *
1458 bool_vector_uchar_data (Lisp_Object a)
1459 {
1460 return (unsigned char *) bool_vector_data (a);
1461 }
1462
1463 /* The number of data words and bytes in a bool vector with SIZE bits. */
1464
1465 INLINE EMACS_INT
1466 bool_vector_words (EMACS_INT size)
1467 {
1468 eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1));
1469 return (size + BITS_PER_BITS_WORD - 1) / BITS_PER_BITS_WORD;
1470 }
1471
1472 INLINE EMACS_INT
1473 bool_vector_bytes (EMACS_INT size)
1474 {
1475 eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1));
1476 return (size + BOOL_VECTOR_BITS_PER_CHAR - 1) / BOOL_VECTOR_BITS_PER_CHAR;
1477 }
1478
1479 /* True if A's Ith bit is set. */
1480
1481 INLINE bool
1482 bool_vector_bitref (Lisp_Object a, EMACS_INT i)
1483 {
1484 eassume (0 <= i && i < bool_vector_size (a));
1485 return !! (bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR]
1486 & (1 << (i % BOOL_VECTOR_BITS_PER_CHAR)));
1487 }
1488
1489 INLINE Lisp_Object
1490 bool_vector_ref (Lisp_Object a, EMACS_INT i)
1491 {
1492 return bool_vector_bitref (a, i) ? Qt : Qnil;
1493 }
1494
1495 /* Set A's Ith bit to B. */
1496
1497 INLINE void
1498 bool_vector_set (Lisp_Object a, EMACS_INT i, bool b)
1499 {
1500 unsigned char *addr;
1501
1502 eassume (0 <= i && i < bool_vector_size (a));
1503 addr = &bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR];
1504
1505 if (b)
1506 *addr |= 1 << (i % BOOL_VECTOR_BITS_PER_CHAR);
1507 else
1508 *addr &= ~ (1 << (i % BOOL_VECTOR_BITS_PER_CHAR));
1509 }
1510
1511 /* Some handy constants for calculating sizes
1512 and offsets, mostly of vectorlike objects. */
1513
1514 enum
1515 {
1516 header_size = offsetof (struct Lisp_Vector, contents),
1517 bool_header_size = offsetof (struct Lisp_Bool_Vector, data),
1518 word_size = sizeof (Lisp_Object)
1519 };
1520
1521 /* Conveniences for dealing with Lisp arrays. */
1522
1523 INLINE Lisp_Object
1524 AREF (Lisp_Object array, ptrdiff_t idx)
1525 {
1526 return XVECTOR (array)->contents[idx];
1527 }
1528
1529 INLINE Lisp_Object *
1530 aref_addr (Lisp_Object array, ptrdiff_t idx)
1531 {
1532 return & XVECTOR (array)->contents[idx];
1533 }
1534
1535 INLINE ptrdiff_t
1536 ASIZE (Lisp_Object array)
1537 {
1538 ptrdiff_t size = XVECTOR (array)->header.size;
1539 eassume (0 <= size);
1540 return size;
1541 }
1542
1543 INLINE ptrdiff_t
1544 gc_asize (Lisp_Object array)
1545 {
1546 /* Like ASIZE, but also can be used in the garbage collector. */
1547 return XVECTOR (array)->header.size & ~ARRAY_MARK_FLAG;
1548 }
1549
1550 INLINE void
1551 ASET (Lisp_Object array, ptrdiff_t idx, Lisp_Object val)
1552 {
1553 eassert (0 <= idx && idx < ASIZE (array));
1554 XVECTOR (array)->contents[idx] = val;
1555 }
1556
1557 INLINE void
1558 gc_aset (Lisp_Object array, ptrdiff_t idx, Lisp_Object val)
1559 {
1560 /* Like ASET, but also can be used in the garbage collector:
1561 sweep_weak_table calls set_hash_key etc. while the table is marked. */
1562 eassert (0 <= idx && idx < gc_asize (array));
1563 XVECTOR (array)->contents[idx] = val;
1564 }
1565
1566 /* True, since Qnil's representation is zero. Every place in the code
1567 that assumes Qnil is zero should verify (NIL_IS_ZERO), to make it easy
1568 to find such assumptions later if we change Qnil to be nonzero. */
1569 enum { NIL_IS_ZERO = XLI_BUILTIN_LISPSYM (iQnil) == 0 };
1570
1571 /* Clear the object addressed by P, with size NBYTES, so that all its
1572 bytes are zero and all its Lisp values are nil. */
1573 INLINE void
1574 memclear (void *p, ptrdiff_t nbytes)
1575 {
1576 eassert (0 <= nbytes);
1577 verify (NIL_IS_ZERO);
1578 /* Since Qnil is zero, memset suffices. */
1579 memset (p, 0, nbytes);
1580 }
1581
1582 /* If a struct is made to look like a vector, this macro returns the length
1583 of the shortest vector that would hold that struct. */
1584
1585 #define VECSIZE(type) \
1586 ((sizeof (type) - header_size + word_size - 1) / word_size)
1587
1588 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
1589 at the end and we need to compute the number of Lisp_Object fields (the
1590 ones that the GC needs to trace). */
1591
1592 #define PSEUDOVECSIZE(type, nonlispfield) \
1593 ((offsetof (type, nonlispfield) - header_size) / word_size)
1594
1595 /* Compute A OP B, using the unsigned comparison operator OP. A and B
1596 should be integer expressions. This is not the same as
1597 mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
1598 returns true. For efficiency, prefer plain unsigned comparison if A
1599 and B's sizes both fit (after integer promotion). */
1600 #define UNSIGNED_CMP(a, op, b) \
1601 (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \
1602 ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \
1603 : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))
1604
1605 /* True iff C is an ASCII character. */
1606 #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
1607
1608 /* A char-table is a kind of vectorlike, with contents are like a
1609 vector but with a few other slots. For some purposes, it makes
1610 sense to handle a char-table with type struct Lisp_Vector. An
1611 element of a char table can be any Lisp objects, but if it is a sub
1612 char-table, we treat it a table that contains information of a
1613 specific range of characters. A sub char-table is like a vector but
1614 with two integer fields between the header and Lisp data, which means
1615 that it has to be marked with some precautions (see mark_char_table
1616 in alloc.c). A sub char-table appears only in an element of a char-table,
1617 and there's no way to access it directly from Emacs Lisp program. */
1618
1619 enum CHARTAB_SIZE_BITS
1620 {
1621 CHARTAB_SIZE_BITS_0 = 6,
1622 CHARTAB_SIZE_BITS_1 = 4,
1623 CHARTAB_SIZE_BITS_2 = 5,
1624 CHARTAB_SIZE_BITS_3 = 7
1625 };
1626
1627 extern const int chartab_size[4];
1628
1629 struct Lisp_Char_Table
1630 {
1631 /* HEADER.SIZE is the vector's size field, which also holds the
1632 pseudovector type information. It holds the size, too.
1633 The size counts the defalt, parent, purpose, ascii,
1634 contents, and extras slots. */
1635 struct vectorlike_header header;
1636
1637 /* This holds a default value,
1638 which is used whenever the value for a specific character is nil. */
1639 Lisp_Object defalt;
1640
1641 /* This points to another char table, which we inherit from when the
1642 value for a specific character is nil. The `defalt' slot takes
1643 precedence over this. */
1644 Lisp_Object parent;
1645
1646 /* This is a symbol which says what kind of use this char-table is
1647 meant for. */
1648 Lisp_Object purpose;
1649
1650 /* The bottom sub char-table for characters of the range 0..127. It
1651 is nil if none of ASCII character has a specific value. */
1652 Lisp_Object ascii;
1653
1654 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
1655
1656 /* These hold additional data. It is a vector. */
1657 Lisp_Object extras[FLEXIBLE_ARRAY_MEMBER];
1658 };
1659
1660 struct Lisp_Sub_Char_Table
1661 {
1662 /* HEADER.SIZE is the vector's size field, which also holds the
1663 pseudovector type information. It holds the size, too. */
1664 struct vectorlike_header header;
1665
1666 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
1667 char-table of depth 1 contains 16 elements, and each element
1668 covers 4096 (128*32) characters. A sub char-table of depth 2
1669 contains 32 elements, and each element covers 128 characters. A
1670 sub char-table of depth 3 contains 128 elements, and each element
1671 is for one character. */
1672 int depth;
1673
1674 /* Minimum character covered by the sub char-table. */
1675 int min_char;
1676
1677 /* Use set_sub_char_table_contents to set this. */
1678 Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER];
1679 };
1680
1681 INLINE Lisp_Object
1682 CHAR_TABLE_REF_ASCII (Lisp_Object ct, ptrdiff_t idx)
1683 {
1684 struct Lisp_Char_Table *tbl = NULL;
1685 Lisp_Object val;
1686 do
1687 {
1688 tbl = tbl ? XCHAR_TABLE (tbl->parent) : XCHAR_TABLE (ct);
1689 val = (! SUB_CHAR_TABLE_P (tbl->ascii) ? tbl->ascii
1690 : XSUB_CHAR_TABLE (tbl->ascii)->contents[idx]);
1691 if (NILP (val))
1692 val = tbl->defalt;
1693 }
1694 while (NILP (val) && ! NILP (tbl->parent));
1695
1696 return val;
1697 }
1698
1699 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
1700 characters. Do not check validity of CT. */
1701 INLINE Lisp_Object
1702 CHAR_TABLE_REF (Lisp_Object ct, int idx)
1703 {
1704 return (ASCII_CHAR_P (idx)
1705 ? CHAR_TABLE_REF_ASCII (ct, idx)
1706 : char_table_ref (ct, idx));
1707 }
1708
1709 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
1710 8-bit European characters. Do not check validity of CT. */
1711 INLINE void
1712 CHAR_TABLE_SET (Lisp_Object ct, int idx, Lisp_Object val)
1713 {
1714 if (ASCII_CHAR_P (idx) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct)->ascii))
1715 set_sub_char_table_contents (XCHAR_TABLE (ct)->ascii, idx, val);
1716 else
1717 char_table_set (ct, idx, val);
1718 }
1719
1720 /* This structure describes a built-in function.
1721 It is generated by the DEFUN macro only.
1722 defsubr makes it into a Lisp object. */
1723
1724 struct Lisp_Subr
1725 {
1726 struct vectorlike_header header;
1727 union {
1728 Lisp_Object (*a0) (void);
1729 Lisp_Object (*a1) (Lisp_Object);
1730 Lisp_Object (*a2) (Lisp_Object, Lisp_Object);
1731 Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object);
1732 Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1733 Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1734 Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1735 Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1736 Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1737 Lisp_Object (*aUNEVALLED) (Lisp_Object args);
1738 Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *);
1739 } function;
1740 short min_args, max_args;
1741 const char *symbol_name;
1742 const char *intspec;
1743 const char *doc;
1744 };
1745
1746 enum char_table_specials
1747 {
1748 /* This is the number of slots that every char table must have. This
1749 counts the ordinary slots and the top, defalt, parent, and purpose
1750 slots. */
1751 CHAR_TABLE_STANDARD_SLOTS = PSEUDOVECSIZE (struct Lisp_Char_Table, extras),
1752
1753 /* This is an index of first Lisp_Object field in Lisp_Sub_Char_Table
1754 when the latter is treated as an ordinary Lisp_Vector. */
1755 SUB_CHAR_TABLE_OFFSET = PSEUDOVECSIZE (struct Lisp_Sub_Char_Table, contents)
1756 };
1757
1758 /* Return the number of "extra" slots in the char table CT. */
1759
1760 INLINE int
1761 CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table *ct)
1762 {
1763 return ((ct->header.size & PSEUDOVECTOR_SIZE_MASK)
1764 - CHAR_TABLE_STANDARD_SLOTS);
1765 }
1766
1767 /* Make sure that sub char-table contents slot is where we think it is. */
1768 verify (offsetof (struct Lisp_Sub_Char_Table, contents)
1769 == offsetof (struct Lisp_Vector, contents[SUB_CHAR_TABLE_OFFSET]));
1770
1771 /***********************************************************************
1772 Symbols
1773 ***********************************************************************/
1774
1775 /* Value is name of symbol. */
1776
1777 INLINE Lisp_Object
1778 (SYMBOL_VAL) (struct Lisp_Symbol *sym)
1779 {
1780 return lisp_h_SYMBOL_VAL (sym);
1781 }
1782
1783 INLINE struct Lisp_Symbol *
1784 SYMBOL_ALIAS (struct Lisp_Symbol *sym)
1785 {
1786 eassert (sym->redirect == SYMBOL_VARALIAS);
1787 return sym->val.alias;
1788 }
1789 INLINE struct Lisp_Buffer_Local_Value *
1790 SYMBOL_BLV (struct Lisp_Symbol *sym)
1791 {
1792 eassert (sym->redirect == SYMBOL_LOCALIZED);
1793 return sym->val.blv;
1794 }
1795 INLINE union Lisp_Fwd *
1796 SYMBOL_FWD (struct Lisp_Symbol *sym)
1797 {
1798 eassert (sym->redirect == SYMBOL_FORWARDED);
1799 return sym->val.fwd;
1800 }
1801
1802 INLINE void
1803 (SET_SYMBOL_VAL) (struct Lisp_Symbol *sym, Lisp_Object v)
1804 {
1805 lisp_h_SET_SYMBOL_VAL (sym, v);
1806 }
1807
1808 INLINE void
1809 SET_SYMBOL_ALIAS (struct Lisp_Symbol *sym, struct Lisp_Symbol *v)
1810 {
1811 eassert (sym->redirect == SYMBOL_VARALIAS);
1812 sym->val.alias = v;
1813 }
1814 INLINE void
1815 SET_SYMBOL_BLV (struct Lisp_Symbol *sym, struct Lisp_Buffer_Local_Value *v)
1816 {
1817 eassert (sym->redirect == SYMBOL_LOCALIZED);
1818 sym->val.blv = v;
1819 }
1820 INLINE void
1821 SET_SYMBOL_FWD (struct Lisp_Symbol *sym, union Lisp_Fwd *v)
1822 {
1823 eassert (sym->redirect == SYMBOL_FORWARDED);
1824 sym->val.fwd = v;
1825 }
1826
1827 INLINE Lisp_Object
1828 SYMBOL_NAME (Lisp_Object sym)
1829 {
1830 return XSYMBOL (sym)->name;
1831 }
1832
1833 /* Value is true if SYM is an interned symbol. */
1834
1835 INLINE bool
1836 SYMBOL_INTERNED_P (Lisp_Object sym)
1837 {
1838 return XSYMBOL (sym)->interned != SYMBOL_UNINTERNED;
1839 }
1840
1841 /* Value is true if SYM is interned in initial_obarray. */
1842
1843 INLINE bool
1844 SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym)
1845 {
1846 return XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY;
1847 }
1848
1849 /* Value is non-zero if symbol is considered a constant, i.e. its
1850 value cannot be changed (there is an exception for keyword symbols,
1851 whose value can be set to the keyword symbol itself). */
1852
1853 INLINE int
1854 (SYMBOL_CONSTANT_P) (Lisp_Object sym)
1855 {
1856 return lisp_h_SYMBOL_CONSTANT_P (sym);
1857 }
1858
1859 /* Placeholder for make-docfile to process. The actual symbol
1860 definition is done by lread.c's defsym. */
1861 #define DEFSYM(sym, name) /* empty */
1862
1863 \f
1864 /***********************************************************************
1865 Hash Tables
1866 ***********************************************************************/
1867
1868 /* The structure of a Lisp hash table. */
1869
1870 struct hash_table_test
1871 {
1872 /* Name of the function used to compare keys. */
1873 Lisp_Object name;
1874
1875 /* User-supplied hash function, or nil. */
1876 Lisp_Object user_hash_function;
1877
1878 /* User-supplied key comparison function, or nil. */
1879 Lisp_Object user_cmp_function;
1880
1881 /* C function to compare two keys. */
1882 bool (*cmpfn) (struct hash_table_test *t, Lisp_Object, Lisp_Object);
1883
1884 /* C function to compute hash code. */
1885 EMACS_UINT (*hashfn) (struct hash_table_test *t, Lisp_Object);
1886 };
1887
1888 struct Lisp_Hash_Table
1889 {
1890 /* This is for Lisp; the hash table code does not refer to it. */
1891 struct vectorlike_header header;
1892
1893 /* Nil if table is non-weak. Otherwise a symbol describing the
1894 weakness of the table. */
1895 Lisp_Object weak;
1896
1897 /* When the table is resized, and this is an integer, compute the
1898 new size by adding this to the old size. If a float, compute the
1899 new size by multiplying the old size with this factor. */
1900 Lisp_Object rehash_size;
1901
1902 /* Resize hash table when number of entries/ table size is >= this
1903 ratio, a float. */
1904 Lisp_Object rehash_threshold;
1905
1906 /* Vector of hash codes. If hash[I] is nil, this means that the
1907 I-th entry is unused. */
1908 Lisp_Object hash;
1909
1910 /* Vector used to chain entries. If entry I is free, next[I] is the
1911 entry number of the next free item. If entry I is non-free,
1912 next[I] is the index of the next entry in the collision chain. */
1913 Lisp_Object next;
1914
1915 /* Index of first free entry in free list. */
1916 Lisp_Object next_free;
1917
1918 /* Bucket vector. A non-nil entry is the index of the first item in
1919 a collision chain. This vector's size can be larger than the
1920 hash table size to reduce collisions. */
1921 Lisp_Object index;
1922
1923 /* Only the fields above are traced normally by the GC. The ones below
1924 `count' are special and are either ignored by the GC or traced in
1925 a special way (e.g. because of weakness). */
1926
1927 /* Number of key/value entries in the table. */
1928 ptrdiff_t count;
1929
1930 /* Vector of keys and values. The key of item I is found at index
1931 2 * I, the value is found at index 2 * I + 1.
1932 This is gc_marked specially if the table is weak. */
1933 Lisp_Object key_and_value;
1934
1935 /* The comparison and hash functions. */
1936 struct hash_table_test test;
1937
1938 /* Next weak hash table if this is a weak hash table. The head
1939 of the list is in weak_hash_tables. */
1940 struct Lisp_Hash_Table *next_weak;
1941 };
1942
1943
1944 INLINE bool
1945 HASH_TABLE_P (Lisp_Object a)
1946 {
1947 return PSEUDOVECTORP (a, PVEC_HASH_TABLE);
1948 }
1949
1950 INLINE struct Lisp_Hash_Table *
1951 XHASH_TABLE (Lisp_Object a)
1952 {
1953 eassert (HASH_TABLE_P (a));
1954 return XUNTAG (a, Lisp_Vectorlike);
1955 }
1956
1957 #define XSET_HASH_TABLE(VAR, PTR) \
1958 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1959
1960 /* Value is the key part of entry IDX in hash table H. */
1961 INLINE Lisp_Object
1962 HASH_KEY (struct Lisp_Hash_Table *h, ptrdiff_t idx)
1963 {
1964 return AREF (h->key_and_value, 2 * idx);
1965 }
1966
1967 /* Value is the value part of entry IDX in hash table H. */
1968 INLINE Lisp_Object
1969 HASH_VALUE (struct Lisp_Hash_Table *h, ptrdiff_t idx)
1970 {
1971 return AREF (h->key_and_value, 2 * idx + 1);
1972 }
1973
1974 /* Value is the index of the next entry following the one at IDX
1975 in hash table H. */
1976 INLINE Lisp_Object
1977 HASH_NEXT (struct Lisp_Hash_Table *h, ptrdiff_t idx)
1978 {
1979 return AREF (h->next, idx);
1980 }
1981
1982 /* Value is the hash code computed for entry IDX in hash table H. */
1983 INLINE Lisp_Object
1984 HASH_HASH (struct Lisp_Hash_Table *h, ptrdiff_t idx)
1985 {
1986 return AREF (h->hash, idx);
1987 }
1988
1989 /* Value is the index of the element in hash table H that is the
1990 start of the collision list at index IDX in the index vector of H. */
1991 INLINE Lisp_Object
1992 HASH_INDEX (struct Lisp_Hash_Table *h, ptrdiff_t idx)
1993 {
1994 return AREF (h->index, idx);
1995 }
1996
1997 /* Value is the size of hash table H. */
1998 INLINE ptrdiff_t
1999 HASH_TABLE_SIZE (struct Lisp_Hash_Table *h)
2000 {
2001 return ASIZE (h->next);
2002 }
2003
2004 /* Default size for hash tables if not specified. */
2005
2006 enum DEFAULT_HASH_SIZE { DEFAULT_HASH_SIZE = 65 };
2007
2008 /* Default threshold specifying when to resize a hash table. The
2009 value gives the ratio of current entries in the hash table and the
2010 size of the hash table. */
2011
2012 static double const DEFAULT_REHASH_THRESHOLD = 0.8;
2013
2014 /* Default factor by which to increase the size of a hash table. */
2015
2016 static double const DEFAULT_REHASH_SIZE = 1.5;
2017
2018 /* Combine two integers X and Y for hashing. The result might not fit
2019 into a Lisp integer. */
2020
2021 INLINE EMACS_UINT
2022 sxhash_combine (EMACS_UINT x, EMACS_UINT y)
2023 {
2024 return (x << 4) + (x >> (BITS_PER_EMACS_INT - 4)) + y;
2025 }
2026
2027 /* Hash X, returning a value that fits into a fixnum. */
2028
2029 INLINE EMACS_UINT
2030 SXHASH_REDUCE (EMACS_UINT x)
2031 {
2032 return (x ^ x >> (BITS_PER_EMACS_INT - FIXNUM_BITS)) & INTMASK;
2033 }
2034
2035 /* These structures are used for various misc types. */
2036
2037 struct Lisp_Misc_Any /* Supertype of all Misc types. */
2038 {
2039 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */
2040 bool_bf gcmarkbit : 1;
2041 unsigned spacer : 15;
2042 };
2043
2044 struct Lisp_Marker
2045 {
2046 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */
2047 bool_bf gcmarkbit : 1;
2048 unsigned spacer : 13;
2049 /* This flag is temporarily used in the functions
2050 decode/encode_coding_object to record that the marker position
2051 must be adjusted after the conversion. */
2052 bool_bf need_adjustment : 1;
2053 /* True means normal insertion at the marker's position
2054 leaves the marker after the inserted text. */
2055 bool_bf insertion_type : 1;
2056 /* This is the buffer that the marker points into, or 0 if it points nowhere.
2057 Note: a chain of markers can contain markers pointing into different
2058 buffers (the chain is per buffer_text rather than per buffer, so it's
2059 shared between indirect buffers). */
2060 /* This is used for (other than NULL-checking):
2061 - Fmarker_buffer
2062 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
2063 - unchain_marker: to find the list from which to unchain.
2064 - Fkill_buffer: to only unchain the markers of current indirect buffer.
2065 */
2066 struct buffer *buffer;
2067
2068 /* The remaining fields are meaningless in a marker that
2069 does not point anywhere. */
2070
2071 /* For markers that point somewhere,
2072 this is used to chain of all the markers in a given buffer. */
2073 /* We could remove it and use an array in buffer_text instead.
2074 That would also allow us to preserve it ordered. */
2075 struct Lisp_Marker *next;
2076 /* This is the char position where the marker points. */
2077 ptrdiff_t charpos;
2078 /* This is the byte position.
2079 It's mostly used as a charpos<->bytepos cache (i.e. it's not directly
2080 used to implement the functionality of markers, but rather to (ab)use
2081 markers as a cache for char<->byte mappings). */
2082 ptrdiff_t bytepos;
2083 };
2084
2085 /* START and END are markers in the overlay's buffer, and
2086 PLIST is the overlay's property list. */
2087 struct Lisp_Overlay
2088 /* An overlay's real data content is:
2089 - plist
2090 - buffer (really there are two buffer pointers, one per marker,
2091 and both points to the same buffer)
2092 - insertion type of both ends (per-marker fields)
2093 - start & start byte (of start marker)
2094 - end & end byte (of end marker)
2095 - next (singly linked list of overlays)
2096 - next fields of start and end markers (singly linked list of markers).
2097 I.e. 9words plus 2 bits, 3words of which are for external linked lists.
2098 */
2099 {
2100 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */
2101 bool_bf gcmarkbit : 1;
2102 unsigned spacer : 15;
2103 struct Lisp_Overlay *next;
2104 Lisp_Object start;
2105 Lisp_Object end;
2106 Lisp_Object plist;
2107 };
2108
2109 /* Types of data which may be saved in a Lisp_Save_Value. */
2110
2111 enum
2112 {
2113 SAVE_UNUSED,
2114 SAVE_INTEGER,
2115 SAVE_FUNCPOINTER,
2116 SAVE_POINTER,
2117 SAVE_OBJECT
2118 };
2119
2120 /* Number of bits needed to store one of the above values. */
2121 enum { SAVE_SLOT_BITS = 3 };
2122
2123 /* Number of slots in a save value where save_type is nonzero. */
2124 enum { SAVE_VALUE_SLOTS = 4 };
2125
2126 /* Bit-width and values for struct Lisp_Save_Value's save_type member. */
2127
2128 enum { SAVE_TYPE_BITS = SAVE_VALUE_SLOTS * SAVE_SLOT_BITS + 1 };
2129
2130 enum Lisp_Save_Type
2131 {
2132 SAVE_TYPE_INT_INT = SAVE_INTEGER + (SAVE_INTEGER << SAVE_SLOT_BITS),
2133 SAVE_TYPE_INT_INT_INT
2134 = (SAVE_INTEGER + (SAVE_TYPE_INT_INT << SAVE_SLOT_BITS)),
2135 SAVE_TYPE_OBJ_OBJ = SAVE_OBJECT + (SAVE_OBJECT << SAVE_SLOT_BITS),
2136 SAVE_TYPE_OBJ_OBJ_OBJ = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ << SAVE_SLOT_BITS),
2137 SAVE_TYPE_OBJ_OBJ_OBJ_OBJ
2138 = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ_OBJ << SAVE_SLOT_BITS),
2139 SAVE_TYPE_PTR_INT = SAVE_POINTER + (SAVE_INTEGER << SAVE_SLOT_BITS),
2140 SAVE_TYPE_PTR_OBJ = SAVE_POINTER + (SAVE_OBJECT << SAVE_SLOT_BITS),
2141 SAVE_TYPE_PTR_PTR = SAVE_POINTER + (SAVE_POINTER << SAVE_SLOT_BITS),
2142 SAVE_TYPE_FUNCPTR_PTR_OBJ
2143 = SAVE_FUNCPOINTER + (SAVE_TYPE_PTR_OBJ << SAVE_SLOT_BITS),
2144
2145 /* This has an extra bit indicating it's raw memory. */
2146 SAVE_TYPE_MEMORY = SAVE_TYPE_PTR_INT + (1 << (SAVE_TYPE_BITS - 1))
2147 };
2148
2149 /* Special object used to hold a different values for later use.
2150
2151 This is mostly used to package C integers and pointers to call
2152 record_unwind_protect when two or more values need to be saved.
2153 For example:
2154
2155 ...
2156 struct my_data *md = get_my_data ();
2157 ptrdiff_t mi = get_my_integer ();
2158 record_unwind_protect (my_unwind, make_save_ptr_int (md, mi));
2159 ...
2160
2161 Lisp_Object my_unwind (Lisp_Object arg)
2162 {
2163 struct my_data *md = XSAVE_POINTER (arg, 0);
2164 ptrdiff_t mi = XSAVE_INTEGER (arg, 1);
2165 ...
2166 }
2167
2168 If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the
2169 saved objects and raise eassert if type of the saved object doesn't match
2170 the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2)
2171 and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and
2172 slot 0 is a pointer. */
2173
2174 typedef void (*voidfuncptr) (void);
2175
2176 struct Lisp_Save_Value
2177 {
2178 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */
2179 bool_bf gcmarkbit : 1;
2180 unsigned spacer : 32 - (16 + 1 + SAVE_TYPE_BITS);
2181
2182 /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of
2183 V's data entries are determined by V->save_type. E.g., if
2184 V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer,
2185 V->data[1] is an integer, and V's other data entries are unused.
2186
2187 If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of
2188 a memory area containing V->data[1].integer potential Lisp_Objects. */
2189 ENUM_BF (Lisp_Save_Type) save_type : SAVE_TYPE_BITS;
2190 union {
2191 void *pointer;
2192 voidfuncptr funcpointer;
2193 ptrdiff_t integer;
2194 Lisp_Object object;
2195 } data[SAVE_VALUE_SLOTS];
2196 };
2197
2198 /* Return the type of V's Nth saved value. */
2199 INLINE int
2200 save_type (struct Lisp_Save_Value *v, int n)
2201 {
2202 eassert (0 <= n && n < SAVE_VALUE_SLOTS);
2203 return (v->save_type >> (SAVE_SLOT_BITS * n) & ((1 << SAVE_SLOT_BITS) - 1));
2204 }
2205
2206 /* Get and set the Nth saved pointer. */
2207
2208 INLINE void *
2209 XSAVE_POINTER (Lisp_Object obj, int n)
2210 {
2211 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER);
2212 return XSAVE_VALUE (obj)->data[n].pointer;
2213 }
2214 INLINE void
2215 set_save_pointer (Lisp_Object obj, int n, void *val)
2216 {
2217 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER);
2218 XSAVE_VALUE (obj)->data[n].pointer = val;
2219 }
2220 INLINE voidfuncptr
2221 XSAVE_FUNCPOINTER (Lisp_Object obj, int n)
2222 {
2223 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_FUNCPOINTER);
2224 return XSAVE_VALUE (obj)->data[n].funcpointer;
2225 }
2226
2227 /* Likewise for the saved integer. */
2228
2229 INLINE ptrdiff_t
2230 XSAVE_INTEGER (Lisp_Object obj, int n)
2231 {
2232 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER);
2233 return XSAVE_VALUE (obj)->data[n].integer;
2234 }
2235 INLINE void
2236 set_save_integer (Lisp_Object obj, int n, ptrdiff_t val)
2237 {
2238 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER);
2239 XSAVE_VALUE (obj)->data[n].integer = val;
2240 }
2241
2242 /* Extract Nth saved object. */
2243
2244 INLINE Lisp_Object
2245 XSAVE_OBJECT (Lisp_Object obj, int n)
2246 {
2247 eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_OBJECT);
2248 return XSAVE_VALUE (obj)->data[n].object;
2249 }
2250
2251 #ifdef HAVE_MODULES
2252 struct Lisp_User_Ptr
2253 {
2254 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_User_Ptr */
2255 bool_bf gcmarkbit : 1;
2256 unsigned spacer : 15;
2257
2258 void (*finalizer) (void *);
2259 void *p;
2260 };
2261 #endif
2262
2263 /* A finalizer sentinel. */
2264 struct Lisp_Finalizer
2265 {
2266 struct Lisp_Misc_Any base;
2267
2268 /* Circular list of all active weak references. */
2269 struct Lisp_Finalizer *prev;
2270 struct Lisp_Finalizer *next;
2271
2272 /* Call FUNCTION when the finalizer becomes unreachable, even if
2273 FUNCTION contains a reference to the finalizer; i.e., call
2274 FUNCTION when it is reachable _only_ through finalizers. */
2275 Lisp_Object function;
2276 };
2277
2278 /* A miscellaneous object, when it's on the free list. */
2279 struct Lisp_Free
2280 {
2281 ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Free */
2282 bool_bf gcmarkbit : 1;
2283 unsigned spacer : 15;
2284 union Lisp_Misc *chain;
2285 };
2286
2287 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
2288 It uses one of these struct subtypes to get the type field. */
2289
2290 union Lisp_Misc
2291 {
2292 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
2293 struct Lisp_Free u_free;
2294 struct Lisp_Marker u_marker;
2295 struct Lisp_Overlay u_overlay;
2296 struct Lisp_Save_Value u_save_value;
2297 struct Lisp_Finalizer u_finalizer;
2298 #ifdef HAVE_MODULES
2299 struct Lisp_User_Ptr u_user_ptr;
2300 #endif
2301 };
2302
2303 INLINE union Lisp_Misc *
2304 XMISC (Lisp_Object a)
2305 {
2306 return XUNTAG (a, Lisp_Misc);
2307 }
2308
2309 INLINE struct Lisp_Misc_Any *
2310 XMISCANY (Lisp_Object a)
2311 {
2312 eassert (MISCP (a));
2313 return & XMISC (a)->u_any;
2314 }
2315
2316 INLINE enum Lisp_Misc_Type
2317 XMISCTYPE (Lisp_Object a)
2318 {
2319 return XMISCANY (a)->type;
2320 }
2321
2322 INLINE struct Lisp_Marker *
2323 XMARKER (Lisp_Object a)
2324 {
2325 eassert (MARKERP (a));
2326 return & XMISC (a)->u_marker;
2327 }
2328
2329 INLINE struct Lisp_Overlay *
2330 XOVERLAY (Lisp_Object a)
2331 {
2332 eassert (OVERLAYP (a));
2333 return & XMISC (a)->u_overlay;
2334 }
2335
2336 INLINE struct Lisp_Save_Value *
2337 XSAVE_VALUE (Lisp_Object a)
2338 {
2339 eassert (SAVE_VALUEP (a));
2340 return & XMISC (a)->u_save_value;
2341 }
2342
2343 INLINE struct Lisp_Finalizer *
2344 XFINALIZER (Lisp_Object a)
2345 {
2346 eassert (FINALIZERP (a));
2347 return & XMISC (a)->u_finalizer;
2348 }
2349
2350 #ifdef HAVE_MODULES
2351 INLINE struct Lisp_User_Ptr *
2352 XUSER_PTR (Lisp_Object a)
2353 {
2354 eassert (USER_PTRP (a));
2355 return & XMISC (a)->u_user_ptr;
2356 }
2357 #endif
2358
2359 \f
2360 /* Forwarding pointer to an int variable.
2361 This is allowed only in the value cell of a symbol,
2362 and it means that the symbol's value really lives in the
2363 specified int variable. */
2364 struct Lisp_Intfwd
2365 {
2366 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */
2367 EMACS_INT *intvar;
2368 };
2369
2370 /* Boolean forwarding pointer to an int variable.
2371 This is like Lisp_Intfwd except that the ostensible
2372 "value" of the symbol is t if the bool variable is true,
2373 nil if it is false. */
2374 struct Lisp_Boolfwd
2375 {
2376 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */
2377 bool *boolvar;
2378 };
2379
2380 /* Forwarding pointer to a Lisp_Object variable.
2381 This is allowed only in the value cell of a symbol,
2382 and it means that the symbol's value really lives in the
2383 specified variable. */
2384 struct Lisp_Objfwd
2385 {
2386 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */
2387 Lisp_Object *objvar;
2388 };
2389
2390 /* Like Lisp_Objfwd except that value lives in a slot in the
2391 current buffer. Value is byte index of slot within buffer. */
2392 struct Lisp_Buffer_Objfwd
2393 {
2394 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */
2395 int offset;
2396 /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */
2397 Lisp_Object predicate;
2398 };
2399
2400 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
2401 the symbol has buffer-local or frame-local bindings. (Exception:
2402 some buffer-local variables are built-in, with their values stored
2403 in the buffer structure itself. They are handled differently,
2404 using struct Lisp_Buffer_Objfwd.)
2405
2406 The `realvalue' slot holds the variable's current value, or a
2407 forwarding pointer to where that value is kept. This value is the
2408 one that corresponds to the loaded binding. To read or set the
2409 variable, you must first make sure the right binding is loaded;
2410 then you can access the value in (or through) `realvalue'.
2411
2412 `buffer' and `frame' are the buffer and frame for which the loaded
2413 binding was found. If those have changed, to make sure the right
2414 binding is loaded it is necessary to find which binding goes with
2415 the current buffer and selected frame, then load it. To load it,
2416 first unload the previous binding, then copy the value of the new
2417 binding into `realvalue' (or through it). Also update
2418 LOADED-BINDING to point to the newly loaded binding.
2419
2420 `local_if_set' indicates that merely setting the variable creates a
2421 local binding for the current buffer. Otherwise the latter, setting
2422 the variable does not do that; only make-local-variable does that. */
2423
2424 struct Lisp_Buffer_Local_Value
2425 {
2426 /* True means that merely setting the variable creates a local
2427 binding for the current buffer. */
2428 bool_bf local_if_set : 1;
2429 /* True means this variable can have frame-local bindings, otherwise, it is
2430 can have buffer-local bindings. The two cannot be combined. */
2431 bool_bf frame_local : 1;
2432 /* True means that the binding now loaded was found.
2433 Presumably equivalent to (defcell!=valcell). */
2434 bool_bf found : 1;
2435 /* If non-NULL, a forwarding to the C var where it should also be set. */
2436 union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */
2437 /* The buffer or frame for which the loaded binding was found. */
2438 Lisp_Object where;
2439 /* A cons cell that holds the default value. It has the form
2440 (SYMBOL . DEFAULT-VALUE). */
2441 Lisp_Object defcell;
2442 /* The cons cell from `where's parameter alist.
2443 It always has the form (SYMBOL . VALUE)
2444 Note that if `forward' is non-nil, VALUE may be out of date.
2445 Also if the currently loaded binding is the default binding, then
2446 this is `eq'ual to defcell. */
2447 Lisp_Object valcell;
2448 };
2449
2450 /* Like Lisp_Objfwd except that value lives in a slot in the
2451 current kboard. */
2452 struct Lisp_Kboard_Objfwd
2453 {
2454 enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */
2455 int offset;
2456 };
2457
2458 union Lisp_Fwd
2459 {
2460 struct Lisp_Intfwd u_intfwd;
2461 struct Lisp_Boolfwd u_boolfwd;
2462 struct Lisp_Objfwd u_objfwd;
2463 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
2464 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
2465 };
2466
2467 INLINE enum Lisp_Fwd_Type
2468 XFWDTYPE (union Lisp_Fwd *a)
2469 {
2470 return a->u_intfwd.type;
2471 }
2472
2473 INLINE struct Lisp_Buffer_Objfwd *
2474 XBUFFER_OBJFWD (union Lisp_Fwd *a)
2475 {
2476 eassert (BUFFER_OBJFWDP (a));
2477 return &a->u_buffer_objfwd;
2478 }
2479 \f
2480 /* Lisp floating point type. */
2481 struct Lisp_Float
2482 {
2483 union
2484 {
2485 double data;
2486 struct Lisp_Float *chain;
2487 } u;
2488 };
2489
2490 INLINE double
2491 XFLOAT_DATA (Lisp_Object f)
2492 {
2493 return XFLOAT (f)->u.data;
2494 }
2495
2496 /* Most hosts nowadays use IEEE floating point, so they use IEC 60559
2497 representations, have infinities and NaNs, and do not trap on
2498 exceptions. Define IEEE_FLOATING_POINT if this host is one of the
2499 typical ones. The C11 macro __STDC_IEC_559__ is close to what is
2500 wanted here, but is not quite right because Emacs does not require
2501 all the features of C11 Annex F (and does not require C11 at all,
2502 for that matter). */
2503 enum
2504 {
2505 IEEE_FLOATING_POINT
2506 = (FLT_RADIX == 2 && FLT_MANT_DIG == 24
2507 && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128)
2508 };
2509
2510 /* A character, declared with the following typedef, is a member
2511 of some character set associated with the current buffer. */
2512 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
2513 #define _UCHAR_T
2514 typedef unsigned char UCHAR;
2515 #endif
2516
2517 /* Meanings of slots in a Lisp_Compiled: */
2518
2519 enum Lisp_Compiled
2520 {
2521 COMPILED_ARGLIST = 0,
2522 COMPILED_BYTECODE = 1,
2523 COMPILED_CONSTANTS = 2,
2524 COMPILED_STACK_DEPTH = 3,
2525 COMPILED_DOC_STRING = 4,
2526 COMPILED_INTERACTIVE = 5
2527 };
2528
2529 /* Flag bits in a character. These also get used in termhooks.h.
2530 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
2531 (MUlti-Lingual Emacs) might need 22 bits for the character value
2532 itself, so we probably shouldn't use any bits lower than 0x0400000. */
2533 enum char_bits
2534 {
2535 CHAR_ALT = 0x0400000,
2536 CHAR_SUPER = 0x0800000,
2537 CHAR_HYPER = 0x1000000,
2538 CHAR_SHIFT = 0x2000000,
2539 CHAR_CTL = 0x4000000,
2540 CHAR_META = 0x8000000,
2541
2542 CHAR_MODIFIER_MASK =
2543 CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META,
2544
2545 /* Actually, the current Emacs uses 22 bits for the character value
2546 itself. */
2547 CHARACTERBITS = 22
2548 };
2549 \f
2550 /* Data type checking. */
2551
2552 INLINE bool
2553 (NILP) (Lisp_Object x)
2554 {
2555 return lisp_h_NILP (x);
2556 }
2557
2558 INLINE bool
2559 NUMBERP (Lisp_Object x)
2560 {
2561 return INTEGERP (x) || FLOATP (x);
2562 }
2563 INLINE bool
2564 NATNUMP (Lisp_Object x)
2565 {
2566 return INTEGERP (x) && 0 <= XINT (x);
2567 }
2568
2569 INLINE bool
2570 RANGED_INTEGERP (intmax_t lo, Lisp_Object x, intmax_t hi)
2571 {
2572 return INTEGERP (x) && lo <= XINT (x) && XINT (x) <= hi;
2573 }
2574
2575 #define TYPE_RANGED_INTEGERP(type, x) \
2576 (INTEGERP (x) \
2577 && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \
2578 && XINT (x) <= TYPE_MAXIMUM (type))
2579
2580 INLINE bool
2581 (CONSP) (Lisp_Object x)
2582 {
2583 return lisp_h_CONSP (x);
2584 }
2585 INLINE bool
2586 (FLOATP) (Lisp_Object x)
2587 {
2588 return lisp_h_FLOATP (x);
2589 }
2590 INLINE bool
2591 (MISCP) (Lisp_Object x)
2592 {
2593 return lisp_h_MISCP (x);
2594 }
2595 INLINE bool
2596 (SYMBOLP) (Lisp_Object x)
2597 {
2598 return lisp_h_SYMBOLP (x);
2599 }
2600 INLINE bool
2601 (INTEGERP) (Lisp_Object x)
2602 {
2603 return lisp_h_INTEGERP (x);
2604 }
2605 INLINE bool
2606 (VECTORLIKEP) (Lisp_Object x)
2607 {
2608 return lisp_h_VECTORLIKEP (x);
2609 }
2610 INLINE bool
2611 (MARKERP) (Lisp_Object x)
2612 {
2613 return lisp_h_MARKERP (x);
2614 }
2615
2616 INLINE bool
2617 STRINGP (Lisp_Object x)
2618 {
2619 return XTYPE (x) == Lisp_String;
2620 }
2621 INLINE bool
2622 VECTORP (Lisp_Object x)
2623 {
2624 return VECTORLIKEP (x) && ! (ASIZE (x) & PSEUDOVECTOR_FLAG);
2625 }
2626 INLINE bool
2627 OVERLAYP (Lisp_Object x)
2628 {
2629 return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay;
2630 }
2631 INLINE bool
2632 SAVE_VALUEP (Lisp_Object x)
2633 {
2634 return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value;
2635 }
2636
2637 INLINE bool
2638 FINALIZERP (Lisp_Object x)
2639 {
2640 return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Finalizer;
2641 }
2642
2643 #ifdef HAVE_MODULES
2644 INLINE bool
2645 USER_PTRP (Lisp_Object x)
2646 {
2647 return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_User_Ptr;
2648 }
2649 #endif
2650
2651 INLINE bool
2652 AUTOLOADP (Lisp_Object x)
2653 {
2654 return CONSP (x) && EQ (Qautoload, XCAR (x));
2655 }
2656
2657 INLINE bool
2658 BUFFER_OBJFWDP (union Lisp_Fwd *a)
2659 {
2660 return XFWDTYPE (a) == Lisp_Fwd_Buffer_Obj;
2661 }
2662
2663 INLINE bool
2664 PSEUDOVECTOR_TYPEP (struct vectorlike_header *a, int code)
2665 {
2666 return ((a->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))
2667 == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS)));
2668 }
2669
2670 /* True if A is a pseudovector whose code is CODE. */
2671 INLINE bool
2672 PSEUDOVECTORP (Lisp_Object a, int code)
2673 {
2674 if (! VECTORLIKEP (a))
2675 return false;
2676 else
2677 {
2678 /* Converting to struct vectorlike_header * avoids aliasing issues. */
2679 struct vectorlike_header *h = XUNTAG (a, Lisp_Vectorlike);
2680 return PSEUDOVECTOR_TYPEP (h, code);
2681 }
2682 }
2683
2684
2685 /* Test for specific pseudovector types. */
2686
2687 INLINE bool
2688 WINDOW_CONFIGURATIONP (Lisp_Object a)
2689 {
2690 return PSEUDOVECTORP (a, PVEC_WINDOW_CONFIGURATION);
2691 }
2692
2693 INLINE bool
2694 PROCESSP (Lisp_Object a)
2695 {
2696 return PSEUDOVECTORP (a, PVEC_PROCESS);
2697 }
2698
2699 INLINE bool
2700 WINDOWP (Lisp_Object a)
2701 {
2702 return PSEUDOVECTORP (a, PVEC_WINDOW);
2703 }
2704
2705 INLINE bool
2706 TERMINALP (Lisp_Object a)
2707 {
2708 return PSEUDOVECTORP (a, PVEC_TERMINAL);
2709 }
2710
2711 INLINE bool
2712 SUBRP (Lisp_Object a)
2713 {
2714 return PSEUDOVECTORP (a, PVEC_SUBR);
2715 }
2716
2717 INLINE bool
2718 COMPILEDP (Lisp_Object a)
2719 {
2720 return PSEUDOVECTORP (a, PVEC_COMPILED);
2721 }
2722
2723 INLINE bool
2724 BUFFERP (Lisp_Object a)
2725 {
2726 return PSEUDOVECTORP (a, PVEC_BUFFER);
2727 }
2728
2729 INLINE bool
2730 CHAR_TABLE_P (Lisp_Object a)
2731 {
2732 return PSEUDOVECTORP (a, PVEC_CHAR_TABLE);
2733 }
2734
2735 INLINE bool
2736 SUB_CHAR_TABLE_P (Lisp_Object a)
2737 {
2738 return PSEUDOVECTORP (a, PVEC_SUB_CHAR_TABLE);
2739 }
2740
2741 INLINE bool
2742 BOOL_VECTOR_P (Lisp_Object a)
2743 {
2744 return PSEUDOVECTORP (a, PVEC_BOOL_VECTOR);
2745 }
2746
2747 INLINE bool
2748 FRAMEP (Lisp_Object a)
2749 {
2750 return PSEUDOVECTORP (a, PVEC_FRAME);
2751 }
2752
2753 /* Test for image (image . spec) */
2754 INLINE bool
2755 IMAGEP (Lisp_Object x)
2756 {
2757 return CONSP (x) && EQ (XCAR (x), Qimage);
2758 }
2759
2760 /* Array types. */
2761 INLINE bool
2762 ARRAYP (Lisp_Object x)
2763 {
2764 return VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x);
2765 }
2766 \f
2767 INLINE void
2768 CHECK_LIST (Lisp_Object x)
2769 {
2770 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x);
2771 }
2772
2773 INLINE void
2774 (CHECK_LIST_CONS) (Lisp_Object x, Lisp_Object y)
2775 {
2776 lisp_h_CHECK_LIST_CONS (x, y);
2777 }
2778
2779 INLINE void
2780 (CHECK_SYMBOL) (Lisp_Object x)
2781 {
2782 lisp_h_CHECK_SYMBOL (x);
2783 }
2784
2785 INLINE void
2786 (CHECK_NUMBER) (Lisp_Object x)
2787 {
2788 lisp_h_CHECK_NUMBER (x);
2789 }
2790
2791 INLINE void
2792 CHECK_STRING (Lisp_Object x)
2793 {
2794 CHECK_TYPE (STRINGP (x), Qstringp, x);
2795 }
2796 INLINE void
2797 CHECK_STRING_CAR (Lisp_Object x)
2798 {
2799 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x));
2800 }
2801 INLINE void
2802 CHECK_CONS (Lisp_Object x)
2803 {
2804 CHECK_TYPE (CONSP (x), Qconsp, x);
2805 }
2806 INLINE void
2807 CHECK_VECTOR (Lisp_Object x)
2808 {
2809 CHECK_TYPE (VECTORP (x), Qvectorp, x);
2810 }
2811 INLINE void
2812 CHECK_BOOL_VECTOR (Lisp_Object x)
2813 {
2814 CHECK_TYPE (BOOL_VECTOR_P (x), Qbool_vector_p, x);
2815 }
2816 /* This is a bit special because we always need size afterwards. */
2817 INLINE ptrdiff_t
2818 CHECK_VECTOR_OR_STRING (Lisp_Object x)
2819 {
2820 if (VECTORP (x))
2821 return ASIZE (x);
2822 if (STRINGP (x))
2823 return SCHARS (x);
2824 wrong_type_argument (Qarrayp, x);
2825 }
2826 INLINE void
2827 CHECK_ARRAY (Lisp_Object x, Lisp_Object predicate)
2828 {
2829 CHECK_TYPE (ARRAYP (x), predicate, x);
2830 }
2831 INLINE void
2832 CHECK_BUFFER (Lisp_Object x)
2833 {
2834 CHECK_TYPE (BUFFERP (x), Qbufferp, x);
2835 }
2836 INLINE void
2837 CHECK_WINDOW (Lisp_Object x)
2838 {
2839 CHECK_TYPE (WINDOWP (x), Qwindowp, x);
2840 }
2841 #ifdef subprocesses
2842 INLINE void
2843 CHECK_PROCESS (Lisp_Object x)
2844 {
2845 CHECK_TYPE (PROCESSP (x), Qprocessp, x);
2846 }
2847 #endif
2848 INLINE void
2849 CHECK_NATNUM (Lisp_Object x)
2850 {
2851 CHECK_TYPE (NATNUMP (x), Qwholenump, x);
2852 }
2853
2854 #define CHECK_RANGED_INTEGER(x, lo, hi) \
2855 do { \
2856 CHECK_NUMBER (x); \
2857 if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \
2858 args_out_of_range_3 \
2859 (x, \
2860 make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \
2861 ? MOST_NEGATIVE_FIXNUM \
2862 : (lo)), \
2863 make_number (min (hi, MOST_POSITIVE_FIXNUM))); \
2864 } while (false)
2865 #define CHECK_TYPE_RANGED_INTEGER(type, x) \
2866 do { \
2867 if (TYPE_SIGNED (type)) \
2868 CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \
2869 else \
2870 CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \
2871 } while (false)
2872
2873 #define CHECK_NUMBER_COERCE_MARKER(x) \
2874 do { \
2875 if (MARKERP ((x))) \
2876 XSETFASTINT (x, marker_position (x)); \
2877 else \
2878 CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \
2879 } while (false)
2880
2881 INLINE double
2882 XFLOATINT (Lisp_Object n)
2883 {
2884 return extract_float (n);
2885 }
2886
2887 INLINE void
2888 CHECK_NUMBER_OR_FLOAT (Lisp_Object x)
2889 {
2890 CHECK_TYPE (NUMBERP (x), Qnumberp, x);
2891 }
2892
2893 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
2894 do { \
2895 if (MARKERP (x)) \
2896 XSETFASTINT (x, marker_position (x)); \
2897 else \
2898 CHECK_TYPE (NUMBERP (x), Qnumber_or_marker_p, x); \
2899 } while (false)
2900
2901 /* Since we can't assign directly to the CAR or CDR fields of a cons
2902 cell, use these when checking that those fields contain numbers. */
2903 INLINE void
2904 CHECK_NUMBER_CAR (Lisp_Object x)
2905 {
2906 Lisp_Object tmp = XCAR (x);
2907 CHECK_NUMBER (tmp);
2908 XSETCAR (x, tmp);
2909 }
2910
2911 INLINE void
2912 CHECK_NUMBER_CDR (Lisp_Object x)
2913 {
2914 Lisp_Object tmp = XCDR (x);
2915 CHECK_NUMBER (tmp);
2916 XSETCDR (x, tmp);
2917 }
2918 \f
2919 /* Define a built-in function for calling from Lisp.
2920 `lname' should be the name to give the function in Lisp,
2921 as a null-terminated C string.
2922 `fnname' should be the name of the function in C.
2923 By convention, it starts with F.
2924 `sname' should be the name for the C constant structure
2925 that records information on this function for internal use.
2926 By convention, it should be the same as `fnname' but with S instead of F.
2927 It's too bad that C macros can't compute this from `fnname'.
2928 `minargs' should be a number, the minimum number of arguments allowed.
2929 `maxargs' should be a number, the maximum number of arguments allowed,
2930 or else MANY or UNEVALLED.
2931 MANY means pass a vector of evaluated arguments,
2932 in the form of an integer number-of-arguments
2933 followed by the address of a vector of Lisp_Objects
2934 which contains the argument values.
2935 UNEVALLED means pass the list of unevaluated arguments
2936 `intspec' says how interactive arguments are to be fetched.
2937 If the string starts with a `(', `intspec' is evaluated and the resulting
2938 list is the list of arguments.
2939 If it's a string that doesn't start with `(', the value should follow
2940 the one of the doc string for `interactive'.
2941 A null string means call interactively with no arguments.
2942 `doc' is documentation for the user. */
2943
2944 /* This version of DEFUN declares a function prototype with the right
2945 arguments, so we can catch errors with maxargs at compile-time. */
2946 #ifdef _MSC_VER
2947 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2948 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
2949 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2950 { { (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \
2951 | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \
2952 { (Lisp_Object (__cdecl *)(void))fnname }, \
2953 minargs, maxargs, lname, intspec, 0}; \
2954 Lisp_Object fnname
2955 #else /* not _MSC_VER */
2956 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
2957 static struct Lisp_Subr alignas (GCALIGNMENT) sname = \
2958 { { PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \
2959 { .a ## maxargs = fnname }, \
2960 minargs, maxargs, lname, intspec, 0}; \
2961 Lisp_Object fnname
2962 #endif
2963
2964 /* True if OBJ is a Lisp function. */
2965 INLINE bool
2966 FUNCTIONP (Lisp_Object obj)
2967 {
2968 return functionp (obj);
2969 }
2970
2971 /* defsubr (Sname);
2972 is how we define the symbol for function `name' at start-up time. */
2973 extern void defsubr (struct Lisp_Subr *);
2974
2975 enum maxargs
2976 {
2977 MANY = -2,
2978 UNEVALLED = -1
2979 };
2980
2981 /* Call a function F that accepts many args, passing it ARRAY's elements. */
2982 #define CALLMANY(f, array) (f) (ARRAYELTS (array), array)
2983
2984 /* Call a function F that accepts many args, passing it the remaining args,
2985 E.g., 'return CALLN (Fformat, fmt, text);' is less error-prone than
2986 '{ Lisp_Object a[2]; a[0] = fmt; a[1] = text; return Fformat (2, a); }'.
2987 CALLN is overkill for simple usages like 'Finsert (1, &text);'. */
2988 #define CALLN(f, ...) CALLMANY (f, ((Lisp_Object []) {__VA_ARGS__}))
2989
2990 extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *);
2991 extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *);
2992 extern void defvar_bool (struct Lisp_Boolfwd *, const char *, bool *);
2993 extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *);
2994 extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int);
2995
2996 /* Macros we use to define forwarded Lisp variables.
2997 These are used in the syms_of_FILENAME functions.
2998
2999 An ordinary (not in buffer_defaults, per-buffer, or per-keyboard)
3000 lisp variable is actually a field in `struct emacs_globals'. The
3001 field's name begins with "f_", which is a convention enforced by
3002 these macros. Each such global has a corresponding #define in
3003 globals.h; the plain name should be used in the code.
3004
3005 E.g., the global "cons_cells_consed" is declared as "int
3006 f_cons_cells_consed" in globals.h, but there is a define:
3007
3008 #define cons_cells_consed globals.f_cons_cells_consed
3009
3010 All C code uses the `cons_cells_consed' name. This is all done
3011 this way to support indirection for multi-threaded Emacs. */
3012
3013 #define DEFVAR_LISP(lname, vname, doc) \
3014 do { \
3015 static struct Lisp_Objfwd o_fwd; \
3016 defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \
3017 } while (false)
3018 #define DEFVAR_LISP_NOPRO(lname, vname, doc) \
3019 do { \
3020 static struct Lisp_Objfwd o_fwd; \
3021 defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \
3022 } while (false)
3023 #define DEFVAR_BOOL(lname, vname, doc) \
3024 do { \
3025 static struct Lisp_Boolfwd b_fwd; \
3026 defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \
3027 } while (false)
3028 #define DEFVAR_INT(lname, vname, doc) \
3029 do { \
3030 static struct Lisp_Intfwd i_fwd; \
3031 defvar_int (&i_fwd, lname, &globals.f_ ## vname); \
3032 } while (false)
3033
3034 #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \
3035 do { \
3036 static struct Lisp_Objfwd o_fwd; \
3037 defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \
3038 } while (false)
3039
3040 #define DEFVAR_KBOARD(lname, vname, doc) \
3041 do { \
3042 static struct Lisp_Kboard_Objfwd ko_fwd; \
3043 defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \
3044 } while (false)
3045 \f
3046 /* Save and restore the instruction and environment pointers,
3047 without affecting the signal mask. */
3048
3049 #ifdef HAVE__SETJMP
3050 typedef jmp_buf sys_jmp_buf;
3051 # define sys_setjmp(j) _setjmp (j)
3052 # define sys_longjmp(j, v) _longjmp (j, v)
3053 #elif defined HAVE_SIGSETJMP
3054 typedef sigjmp_buf sys_jmp_buf;
3055 # define sys_setjmp(j) sigsetjmp (j, 0)
3056 # define sys_longjmp(j, v) siglongjmp (j, v)
3057 #else
3058 /* A platform that uses neither _longjmp nor siglongjmp; assume
3059 longjmp does not affect the sigmask. */
3060 typedef jmp_buf sys_jmp_buf;
3061 # define sys_setjmp(j) setjmp (j)
3062 # define sys_longjmp(j, v) longjmp (j, v)
3063 #endif
3064
3065 \f
3066 /* Elisp uses several stacks:
3067 - the C stack.
3068 - the bytecode stack: used internally by the bytecode interpreter.
3069 Allocated from the C stack.
3070 - The specpdl stack: keeps track of active unwind-protect and
3071 dynamic-let-bindings. Allocated from the `specpdl' array, a manually
3072 managed stack.
3073 - The handler stack: keeps track of active catch tags and condition-case
3074 handlers. Allocated in a manually managed stack implemented by a
3075 doubly-linked list allocated via xmalloc and never freed. */
3076
3077 /* Structure for recording Lisp call stack for backtrace purposes. */
3078
3079 /* The special binding stack holds the outer values of variables while
3080 they are bound by a function application or a let form, stores the
3081 code to be executed for unwind-protect forms.
3082
3083 NOTE: The specbinding union is defined here, because SPECPDL_INDEX is
3084 used all over the place, needs to be fast, and needs to know the size of
3085 union specbinding. But only eval.c should access it. */
3086
3087 enum specbind_tag {
3088 SPECPDL_UNWIND, /* An unwind_protect function on Lisp_Object. */
3089 SPECPDL_UNWIND_PTR, /* Likewise, on void *. */
3090 SPECPDL_UNWIND_INT, /* Likewise, on int. */
3091 SPECPDL_UNWIND_VOID, /* Likewise, with no arg. */
3092 SPECPDL_BACKTRACE, /* An element of the backtrace. */
3093 SPECPDL_LET, /* A plain and simple dynamic let-binding. */
3094 /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */
3095 SPECPDL_LET_LOCAL, /* A buffer-local let-binding. */
3096 SPECPDL_LET_DEFAULT /* A global binding for a localized var. */
3097 };
3098
3099 union specbinding
3100 {
3101 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3102 struct {
3103 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3104 void (*func) (Lisp_Object);
3105 Lisp_Object arg;
3106 } unwind;
3107 struct {
3108 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3109 void (*func) (void *);
3110 void *arg;
3111 } unwind_ptr;
3112 struct {
3113 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3114 void (*func) (int);
3115 int arg;
3116 } unwind_int;
3117 struct {
3118 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3119 void (*func) (void);
3120 } unwind_void;
3121 struct {
3122 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3123 /* `where' is not used in the case of SPECPDL_LET. */
3124 Lisp_Object symbol, old_value, where;
3125 } let;
3126 struct {
3127 ENUM_BF (specbind_tag) kind : CHAR_BIT;
3128 bool_bf debug_on_exit : 1;
3129 Lisp_Object function;
3130 Lisp_Object *args;
3131 ptrdiff_t nargs;
3132 } bt;
3133 };
3134
3135 extern union specbinding *specpdl;
3136 extern union specbinding *specpdl_ptr;
3137 extern ptrdiff_t specpdl_size;
3138
3139 INLINE ptrdiff_t
3140 SPECPDL_INDEX (void)
3141 {
3142 return specpdl_ptr - specpdl;
3143 }
3144
3145 /* This structure helps implement the `catch/throw' and `condition-case/signal'
3146 control structures. A struct handler contains all the information needed to
3147 restore the state of the interpreter after a non-local jump.
3148
3149 handler structures are chained together in a doubly linked list; the `next'
3150 member points to the next outer catchtag and the `nextfree' member points in
3151 the other direction to the next inner element (which is typically the next
3152 free element since we mostly use it on the deepest handler).
3153
3154 A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch'
3155 member is TAG, and then unbinds to it. The `val' member is used to
3156 hold VAL while the stack is unwound; `val' is returned as the value
3157 of the catch form. If there is a handler of type CATCHER_ALL, it will
3158 be treated as a handler for all invocations of `throw'; in this case
3159 `val' will be set to (TAG . VAL).
3160
3161 All the other members are concerned with restoring the interpreter
3162 state.
3163
3164 Members are volatile if their values need to survive _longjmp when
3165 a 'struct handler' is a local variable. */
3166
3167 enum handlertype { CATCHER, CONDITION_CASE, CATCHER_ALL };
3168
3169 struct handler
3170 {
3171 enum handlertype type;
3172 Lisp_Object tag_or_ch;
3173 Lisp_Object val;
3174 struct handler *next;
3175 struct handler *nextfree;
3176
3177 /* The bytecode interpreter can have several handlers active at the same
3178 time, so when we longjmp to one of them, it needs to know which handler
3179 this was and what was the corresponding internal state. This is stored
3180 here, and when we longjmp we make sure that handlerlist points to the
3181 proper handler. */
3182 Lisp_Object *bytecode_top;
3183 int bytecode_dest;
3184
3185 /* Most global vars are reset to their value via the specpdl mechanism,
3186 but a few others are handled by storing their value here. */
3187 sys_jmp_buf jmp;
3188 EMACS_INT lisp_eval_depth;
3189 ptrdiff_t pdlcount;
3190 int poll_suppress_count;
3191 int interrupt_input_blocked;
3192 struct byte_stack *byte_stack;
3193 };
3194
3195 extern Lisp_Object memory_signal_data;
3196
3197 /* An address near the bottom of the stack.
3198 Tells GC how to save a copy of the stack. */
3199 extern char *stack_bottom;
3200
3201 /* Check quit-flag and quit if it is non-nil.
3202 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
3203 So the program needs to do QUIT at times when it is safe to quit.
3204 Every loop that might run for a long time or might not exit
3205 ought to do QUIT at least once, at a safe place.
3206 Unless that is impossible, of course.
3207 But it is very desirable to avoid creating loops where QUIT is impossible.
3208
3209 Exception: if you set immediate_quit to true,
3210 then the handler that responds to the C-g does the quit itself.
3211 This is a good thing to do around a loop that has no side effects
3212 and (in particular) cannot call arbitrary Lisp code.
3213
3214 If quit-flag is set to `kill-emacs' the SIGINT handler has received
3215 a request to exit Emacs when it is safe to do. */
3216
3217 extern void process_pending_signals (void);
3218 extern bool volatile pending_signals;
3219
3220 extern void process_quit_flag (void);
3221 #define QUIT \
3222 do { \
3223 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
3224 process_quit_flag (); \
3225 else if (pending_signals) \
3226 process_pending_signals (); \
3227 } while (false)
3228
3229
3230 /* True if ought to quit now. */
3231
3232 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
3233 \f
3234 extern Lisp_Object Vascii_downcase_table;
3235 extern Lisp_Object Vascii_canon_table;
3236 \f
3237 /* Call staticpro (&var) to protect static variable `var'. */
3238
3239 void staticpro (Lisp_Object *);
3240 \f
3241 /* Forward declarations for prototypes. */
3242 struct window;
3243 struct frame;
3244
3245 /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */
3246
3247 INLINE void
3248 vcopy (Lisp_Object v, ptrdiff_t offset, Lisp_Object *args, ptrdiff_t count)
3249 {
3250 eassert (0 <= offset && 0 <= count && offset + count <= ASIZE (v));
3251 memcpy (XVECTOR (v)->contents + offset, args, count * sizeof *args);
3252 }
3253
3254 /* Functions to modify hash tables. */
3255
3256 INLINE void
3257 set_hash_key_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
3258 {
3259 gc_aset (h->key_and_value, 2 * idx, val);
3260 }
3261
3262 INLINE void
3263 set_hash_value_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val)
3264 {
3265 gc_aset (h->key_and_value, 2 * idx + 1, val);
3266 }
3267
3268 /* Use these functions to set Lisp_Object
3269 or pointer slots of struct Lisp_Symbol. */
3270
3271 INLINE void
3272 set_symbol_function (Lisp_Object sym, Lisp_Object function)
3273 {
3274 XSYMBOL (sym)->function = function;
3275 }
3276
3277 INLINE void
3278 set_symbol_plist (Lisp_Object sym, Lisp_Object plist)
3279 {
3280 XSYMBOL (sym)->plist = plist;
3281 }
3282
3283 INLINE void
3284 set_symbol_next (Lisp_Object sym, struct Lisp_Symbol *next)
3285 {
3286 XSYMBOL (sym)->next = next;
3287 }
3288
3289 /* Buffer-local (also frame-local) variable access functions. */
3290
3291 INLINE int
3292 blv_found (struct Lisp_Buffer_Local_Value *blv)
3293 {
3294 eassert (blv->found == !EQ (blv->defcell, blv->valcell));
3295 return blv->found;
3296 }
3297
3298 /* Set overlay's property list. */
3299
3300 INLINE void
3301 set_overlay_plist (Lisp_Object overlay, Lisp_Object plist)
3302 {
3303 XOVERLAY (overlay)->plist = plist;
3304 }
3305
3306 /* Get text properties of S. */
3307
3308 INLINE INTERVAL
3309 string_intervals (Lisp_Object s)
3310 {
3311 return XSTRING (s)->intervals;
3312 }
3313
3314 /* Set text properties of S to I. */
3315
3316 INLINE void
3317 set_string_intervals (Lisp_Object s, INTERVAL i)
3318 {
3319 XSTRING (s)->intervals = i;
3320 }
3321
3322 /* Set a Lisp slot in TABLE to VAL. Most code should use this instead
3323 of setting slots directly. */
3324
3325 INLINE void
3326 set_char_table_defalt (Lisp_Object table, Lisp_Object val)
3327 {
3328 XCHAR_TABLE (table)->defalt = val;
3329 }
3330 INLINE void
3331 set_char_table_purpose (Lisp_Object table, Lisp_Object val)
3332 {
3333 XCHAR_TABLE (table)->purpose = val;
3334 }
3335
3336 /* Set different slots in (sub)character tables. */
3337
3338 INLINE void
3339 set_char_table_extras (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
3340 {
3341 eassert (0 <= idx && idx < CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table)));
3342 XCHAR_TABLE (table)->extras[idx] = val;
3343 }
3344
3345 INLINE void
3346 set_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
3347 {
3348 eassert (0 <= idx && idx < (1 << CHARTAB_SIZE_BITS_0));
3349 XCHAR_TABLE (table)->contents[idx] = val;
3350 }
3351
3352 INLINE void
3353 set_sub_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val)
3354 {
3355 XSUB_CHAR_TABLE (table)->contents[idx] = val;
3356 }
3357
3358 /* Defined in data.c. */
3359 extern Lisp_Object indirect_function (Lisp_Object);
3360 extern Lisp_Object find_symbol_value (Lisp_Object);
3361 enum Arith_Comparison {
3362 ARITH_EQUAL,
3363 ARITH_NOTEQUAL,
3364 ARITH_LESS,
3365 ARITH_GRTR,
3366 ARITH_LESS_OR_EQUAL,
3367 ARITH_GRTR_OR_EQUAL
3368 };
3369 extern Lisp_Object arithcompare (Lisp_Object num1, Lisp_Object num2,
3370 enum Arith_Comparison comparison);
3371
3372 /* Convert the integer I to an Emacs representation, either the integer
3373 itself, or a cons of two or three integers, or if all else fails a float.
3374 I should not have side effects. */
3375 #define INTEGER_TO_CONS(i) \
3376 (! FIXNUM_OVERFLOW_P (i) \
3377 ? make_number (i) \
3378 : EXPR_SIGNED (i) ? intbig_to_lisp (i) : uintbig_to_lisp (i))
3379 extern Lisp_Object intbig_to_lisp (intmax_t);
3380 extern Lisp_Object uintbig_to_lisp (uintmax_t);
3381
3382 /* Convert the Emacs representation CONS back to an integer of type
3383 TYPE, storing the result the variable VAR. Signal an error if CONS
3384 is not a valid representation or is out of range for TYPE. */
3385 #define CONS_TO_INTEGER(cons, type, var) \
3386 (TYPE_SIGNED (type) \
3387 ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \
3388 : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type))))
3389 extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t);
3390 extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t);
3391
3392 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
3393 extern _Noreturn void args_out_of_range (Lisp_Object, Lisp_Object);
3394 extern _Noreturn void args_out_of_range_3 (Lisp_Object, Lisp_Object,
3395 Lisp_Object);
3396 extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *);
3397 extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, bool);
3398 extern void syms_of_data (void);
3399 extern void swap_in_global_binding (struct Lisp_Symbol *);
3400
3401 /* Defined in cmds.c */
3402 extern void syms_of_cmds (void);
3403 extern void keys_of_cmds (void);
3404
3405 /* Defined in coding.c. */
3406 extern Lisp_Object detect_coding_system (const unsigned char *, ptrdiff_t,
3407 ptrdiff_t, bool, bool, Lisp_Object);
3408 extern void init_coding (void);
3409 extern void init_coding_once (void);
3410 extern void syms_of_coding (void);
3411
3412 /* Defined in character.c. */
3413 extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t);
3414 extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t);
3415 extern void syms_of_character (void);
3416
3417 /* Defined in charset.c. */
3418 extern void init_charset (void);
3419 extern void init_charset_once (void);
3420 extern void syms_of_charset (void);
3421 /* Structure forward declarations. */
3422 struct charset;
3423
3424 /* Defined in syntax.c. */
3425 extern void init_syntax_once (void);
3426 extern void syms_of_syntax (void);
3427
3428 /* Defined in fns.c. */
3429 enum { NEXT_ALMOST_PRIME_LIMIT = 11 };
3430 extern EMACS_INT next_almost_prime (EMACS_INT) ATTRIBUTE_CONST;
3431 extern Lisp_Object larger_vector (Lisp_Object, ptrdiff_t, ptrdiff_t);
3432 extern void sweep_weak_hash_tables (void);
3433 EMACS_UINT hash_string (char const *, ptrdiff_t);
3434 EMACS_UINT sxhash (Lisp_Object, int);
3435 Lisp_Object make_hash_table (struct hash_table_test, Lisp_Object, Lisp_Object,
3436 Lisp_Object, Lisp_Object);
3437 ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *);
3438 ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
3439 EMACS_UINT);
3440 void hash_remove_from_table (struct Lisp_Hash_Table *, Lisp_Object);
3441 extern struct hash_table_test hashtest_eq, hashtest_eql, hashtest_equal;
3442 extern void validate_subarray (Lisp_Object, Lisp_Object, Lisp_Object,
3443 ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
3444 extern Lisp_Object substring_both (Lisp_Object, ptrdiff_t, ptrdiff_t,
3445 ptrdiff_t, ptrdiff_t);
3446 extern Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
3447 extern Lisp_Object do_yes_or_no_p (Lisp_Object);
3448 extern Lisp_Object concat2 (Lisp_Object, Lisp_Object);
3449 extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
3450 extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
3451 extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
3452 extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
3453 extern void clear_string_char_byte_cache (void);
3454 extern ptrdiff_t string_char_to_byte (Lisp_Object, ptrdiff_t);
3455 extern ptrdiff_t string_byte_to_char (Lisp_Object, ptrdiff_t);
3456 extern Lisp_Object string_to_multibyte (Lisp_Object);
3457 extern Lisp_Object string_make_unibyte (Lisp_Object);
3458 extern void syms_of_fns (void);
3459
3460 /* Defined in floatfns.c. */
3461 extern void syms_of_floatfns (void);
3462 extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y);
3463
3464 /* Defined in fringe.c. */
3465 extern void syms_of_fringe (void);
3466 extern void init_fringe (void);
3467 #ifdef HAVE_WINDOW_SYSTEM
3468 extern void mark_fringe_data (void);
3469 extern void init_fringe_once (void);
3470 #endif /* HAVE_WINDOW_SYSTEM */
3471
3472 /* Defined in image.c. */
3473 extern int x_bitmap_mask (struct frame *, ptrdiff_t);
3474 extern void reset_image_types (void);
3475 extern void syms_of_image (void);
3476
3477 /* Defined in insdel.c. */
3478 extern void move_gap_both (ptrdiff_t, ptrdiff_t);
3479 extern _Noreturn void buffer_overflow (void);
3480 extern void make_gap (ptrdiff_t);
3481 extern void make_gap_1 (struct buffer *, ptrdiff_t);
3482 extern ptrdiff_t copy_text (const unsigned char *, unsigned char *,
3483 ptrdiff_t, bool, bool);
3484 extern int count_combining_before (const unsigned char *,
3485 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3486 extern int count_combining_after (const unsigned char *,
3487 ptrdiff_t, ptrdiff_t, ptrdiff_t);
3488 extern void insert (const char *, ptrdiff_t);
3489 extern void insert_and_inherit (const char *, ptrdiff_t);
3490 extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t,
3491 bool, bool, bool);
3492 extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail);
3493 extern void insert_from_string (Lisp_Object, ptrdiff_t, ptrdiff_t,
3494 ptrdiff_t, ptrdiff_t, bool);
3495 extern void insert_from_buffer (struct buffer *, ptrdiff_t, ptrdiff_t, bool);
3496 extern void insert_char (int);
3497 extern void insert_string (const char *);
3498 extern void insert_before_markers (const char *, ptrdiff_t);
3499 extern void insert_before_markers_and_inherit (const char *, ptrdiff_t);
3500 extern void insert_from_string_before_markers (Lisp_Object, ptrdiff_t,
3501 ptrdiff_t, ptrdiff_t,
3502 ptrdiff_t, bool);
3503 extern void del_range (ptrdiff_t, ptrdiff_t);
3504 extern Lisp_Object del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool);
3505 extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool);
3506 extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool);
3507 extern Lisp_Object del_range_2 (ptrdiff_t, ptrdiff_t,
3508 ptrdiff_t, ptrdiff_t, bool);
3509 extern void modify_text (ptrdiff_t, ptrdiff_t);
3510 extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3511 extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *);
3512 extern void invalidate_buffer_caches (struct buffer *, ptrdiff_t, ptrdiff_t);
3513 extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3514 extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3515 ptrdiff_t, ptrdiff_t);
3516 extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t,
3517 ptrdiff_t, ptrdiff_t);
3518 extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object, bool, bool, bool);
3519 extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
3520 const char *, ptrdiff_t, ptrdiff_t, bool);
3521 extern void syms_of_insdel (void);
3522
3523 /* Defined in dispnew.c. */
3524 #if (defined PROFILING \
3525 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
3526 _Noreturn void __executable_start (void);
3527 #endif
3528 extern Lisp_Object Vwindow_system;
3529 extern Lisp_Object sit_for (Lisp_Object, bool, int);
3530
3531 /* Defined in xdisp.c. */
3532 extern bool noninteractive_need_newline;
3533 extern Lisp_Object echo_area_buffer[2];
3534 extern void add_to_log (char const *, ...);
3535 extern void vadd_to_log (char const *, va_list);
3536 extern void check_message_stack (void);
3537 extern void setup_echo_area_for_printing (bool);
3538 extern bool push_message (void);
3539 extern void pop_message_unwind (void);
3540 extern Lisp_Object restore_message_unwind (Lisp_Object);
3541 extern void restore_message (void);
3542 extern Lisp_Object current_message (void);
3543 extern void clear_message (bool, bool);
3544 extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3545 extern void message1 (const char *);
3546 extern void message1_nolog (const char *);
3547 extern void message3 (Lisp_Object);
3548 extern void message3_nolog (Lisp_Object);
3549 extern void message_dolog (const char *, ptrdiff_t, bool, bool);
3550 extern void message_with_string (const char *, Lisp_Object, bool);
3551 extern void message_log_maybe_newline (void);
3552 extern void update_echo_area (void);
3553 extern void truncate_echo_area (ptrdiff_t);
3554 extern void redisplay (void);
3555
3556 void set_frame_cursor_types (struct frame *, Lisp_Object);
3557 extern void syms_of_xdisp (void);
3558 extern void init_xdisp (void);
3559 extern Lisp_Object safe_eval (Lisp_Object);
3560 extern bool pos_visible_p (struct window *, ptrdiff_t, int *,
3561 int *, int *, int *, int *, int *);
3562
3563 /* Defined in xsettings.c. */
3564 extern void syms_of_xsettings (void);
3565
3566 /* Defined in vm-limit.c. */
3567 extern void memory_warnings (void *, void (*warnfun) (const char *));
3568
3569 /* Defined in character.c. */
3570 extern void parse_str_as_multibyte (const unsigned char *, ptrdiff_t,
3571 ptrdiff_t *, ptrdiff_t *);
3572
3573 /* Defined in alloc.c. */
3574 extern void *my_heap_start (void);
3575 extern void check_pure_size (void);
3576 extern void free_misc (Lisp_Object);
3577 extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT);
3578 extern void malloc_warning (const char *);
3579 extern _Noreturn void memory_full (size_t);
3580 extern _Noreturn void buffer_memory_full (ptrdiff_t);
3581 extern bool survives_gc_p (Lisp_Object);
3582 extern void mark_object (Lisp_Object);
3583 #if defined REL_ALLOC && !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
3584 extern void refill_memory_reserve (void);
3585 #endif
3586 #ifdef DOUG_LEA_MALLOC
3587 extern void alloc_unexec_pre (void);
3588 extern void alloc_unexec_post (void);
3589 #else
3590 INLINE void alloc_unexec_pre (void) {}
3591 INLINE void alloc_unexec_post (void) {}
3592 #endif
3593 extern const char *pending_malloc_warning;
3594 extern Lisp_Object zero_vector;
3595 extern Lisp_Object *stack_base;
3596 extern EMACS_INT consing_since_gc;
3597 extern EMACS_INT gc_relative_threshold;
3598 extern EMACS_INT memory_full_cons_threshold;
3599 extern Lisp_Object list1 (Lisp_Object);
3600 extern Lisp_Object list2 (Lisp_Object, Lisp_Object);
3601 extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
3602 extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3603 extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3604 Lisp_Object);
3605 enum constype {CONSTYPE_HEAP, CONSTYPE_PURE};
3606 extern Lisp_Object listn (enum constype, ptrdiff_t, Lisp_Object, ...);
3607
3608 /* Build a frequently used 2/3/4-integer lists. */
3609
3610 INLINE Lisp_Object
3611 list2i (EMACS_INT x, EMACS_INT y)
3612 {
3613 return list2 (make_number (x), make_number (y));
3614 }
3615
3616 INLINE Lisp_Object
3617 list3i (EMACS_INT x, EMACS_INT y, EMACS_INT w)
3618 {
3619 return list3 (make_number (x), make_number (y), make_number (w));
3620 }
3621
3622 INLINE Lisp_Object
3623 list4i (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h)
3624 {
3625 return list4 (make_number (x), make_number (y),
3626 make_number (w), make_number (h));
3627 }
3628
3629 extern Lisp_Object make_uninit_bool_vector (EMACS_INT);
3630 extern Lisp_Object bool_vector_fill (Lisp_Object, Lisp_Object);
3631 extern _Noreturn void string_overflow (void);
3632 extern Lisp_Object make_string (const char *, ptrdiff_t);
3633 extern Lisp_Object make_formatted_string (char *, const char *, ...)
3634 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3635 extern Lisp_Object make_unibyte_string (const char *, ptrdiff_t);
3636
3637 /* Make unibyte string from C string when the length isn't known. */
3638
3639 INLINE Lisp_Object
3640 build_unibyte_string (const char *str)
3641 {
3642 return make_unibyte_string (str, strlen (str));
3643 }
3644
3645 extern Lisp_Object make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t);
3646 extern Lisp_Object make_event_array (ptrdiff_t, Lisp_Object *);
3647 extern Lisp_Object make_uninit_string (EMACS_INT);
3648 extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT);
3649 extern Lisp_Object make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t);
3650 extern Lisp_Object make_specified_string (const char *,
3651 ptrdiff_t, ptrdiff_t, bool);
3652 extern Lisp_Object make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool);
3653 extern Lisp_Object make_pure_c_string (const char *, ptrdiff_t);
3654
3655 /* Make a string allocated in pure space, use STR as string data. */
3656
3657 INLINE Lisp_Object
3658 build_pure_c_string (const char *str)
3659 {
3660 return make_pure_c_string (str, strlen (str));
3661 }
3662
3663 /* Make a string from the data at STR, treating it as multibyte if the
3664 data warrants. */
3665
3666 INLINE Lisp_Object
3667 build_string (const char *str)
3668 {
3669 return make_string (str, strlen (str));
3670 }
3671
3672 extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object);
3673 extern void make_byte_code (struct Lisp_Vector *);
3674 extern struct Lisp_Vector *allocate_vector (EMACS_INT);
3675
3676 /* Make an uninitialized vector for SIZE objects. NOTE: you must
3677 be sure that GC cannot happen until the vector is completely
3678 initialized. E.g. the following code is likely to crash:
3679
3680 v = make_uninit_vector (3);
3681 ASET (v, 0, obj0);
3682 ASET (v, 1, Ffunction_can_gc ());
3683 ASET (v, 2, obj1); */
3684
3685 INLINE Lisp_Object
3686 make_uninit_vector (ptrdiff_t size)
3687 {
3688 Lisp_Object v;
3689 struct Lisp_Vector *p;
3690
3691 p = allocate_vector (size);
3692 XSETVECTOR (v, p);
3693 return v;
3694 }
3695
3696 /* Like above, but special for sub char-tables. */
3697
3698 INLINE Lisp_Object
3699 make_uninit_sub_char_table (int depth, int min_char)
3700 {
3701 int slots = SUB_CHAR_TABLE_OFFSET + chartab_size[depth];
3702 Lisp_Object v = make_uninit_vector (slots);
3703
3704 XSETPVECTYPE (XVECTOR (v), PVEC_SUB_CHAR_TABLE);
3705 XSUB_CHAR_TABLE (v)->depth = depth;
3706 XSUB_CHAR_TABLE (v)->min_char = min_char;
3707 return v;
3708 }
3709
3710 extern struct Lisp_Vector *allocate_pseudovector (int, int, int,
3711 enum pvec_type);
3712
3713 /* Allocate partially initialized pseudovector where all Lisp_Object
3714 slots are set to Qnil but the rest (if any) is left uninitialized. */
3715
3716 #define ALLOCATE_PSEUDOVECTOR(type, field, tag) \
3717 ((type *) allocate_pseudovector (VECSIZE (type), \
3718 PSEUDOVECSIZE (type, field), \
3719 PSEUDOVECSIZE (type, field), tag))
3720
3721 /* Allocate fully initialized pseudovector where all Lisp_Object
3722 slots are set to Qnil and the rest (if any) is zeroed. */
3723
3724 #define ALLOCATE_ZEROED_PSEUDOVECTOR(type, field, tag) \
3725 ((type *) allocate_pseudovector (VECSIZE (type), \
3726 PSEUDOVECSIZE (type, field), \
3727 VECSIZE (type), tag))
3728
3729 extern bool gc_in_progress;
3730 extern bool abort_on_gc;
3731 extern Lisp_Object make_float (double);
3732 extern void display_malloc_warning (void);
3733 extern ptrdiff_t inhibit_garbage_collection (void);
3734 extern Lisp_Object make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t);
3735 extern Lisp_Object make_save_obj_obj_obj_obj (Lisp_Object, Lisp_Object,
3736 Lisp_Object, Lisp_Object);
3737 extern Lisp_Object make_save_ptr (void *);
3738 extern Lisp_Object make_save_ptr_int (void *, ptrdiff_t);
3739 extern Lisp_Object make_save_ptr_ptr (void *, void *);
3740 extern Lisp_Object make_save_funcptr_ptr_obj (void (*) (void), void *,
3741 Lisp_Object);
3742 extern Lisp_Object make_save_memory (Lisp_Object *, ptrdiff_t);
3743 extern void free_save_value (Lisp_Object);
3744 extern Lisp_Object build_overlay (Lisp_Object, Lisp_Object, Lisp_Object);
3745 extern void free_marker (Lisp_Object);
3746 extern void free_cons (struct Lisp_Cons *);
3747 extern void init_alloc_once (void);
3748 extern void init_alloc (void);
3749 extern void syms_of_alloc (void);
3750 extern struct buffer * allocate_buffer (void);
3751 extern int valid_lisp_object_p (Lisp_Object);
3752 #ifdef GC_CHECK_CONS_LIST
3753 extern void check_cons_list (void);
3754 #else
3755 INLINE void (check_cons_list) (void) { lisp_h_check_cons_list (); }
3756 #endif
3757
3758 #ifdef REL_ALLOC
3759 /* Defined in ralloc.c. */
3760 extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3761 extern void r_alloc_free (void **);
3762 extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
3763 extern void r_alloc_reset_variable (void **, void **);
3764 extern void r_alloc_inhibit_buffer_relocation (int);
3765 #endif
3766
3767 /* Defined in chartab.c. */
3768 extern Lisp_Object copy_char_table (Lisp_Object);
3769 extern Lisp_Object char_table_ref_and_range (Lisp_Object, int,
3770 int *, int *);
3771 extern void char_table_set_range (Lisp_Object, int, int, Lisp_Object);
3772 extern void map_char_table (void (*) (Lisp_Object, Lisp_Object,
3773 Lisp_Object),
3774 Lisp_Object, Lisp_Object, Lisp_Object);
3775 extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
3776 Lisp_Object, Lisp_Object,
3777 Lisp_Object, struct charset *,
3778 unsigned, unsigned);
3779 extern Lisp_Object uniprop_table (Lisp_Object);
3780 extern void syms_of_chartab (void);
3781
3782 /* Defined in print.c. */
3783 extern Lisp_Object Vprin1_to_string_buffer;
3784 extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE;
3785 extern void temp_output_buffer_setup (const char *);
3786 extern int print_level;
3787 extern void write_string (const char *);
3788 extern void print_error_message (Lisp_Object, Lisp_Object, const char *,
3789 Lisp_Object);
3790 extern Lisp_Object internal_with_output_to_temp_buffer
3791 (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object);
3792 #define FLOAT_TO_STRING_BUFSIZE 350
3793 extern int float_to_string (char *, double);
3794 extern void init_print_once (void);
3795 extern void syms_of_print (void);
3796
3797 /* Defined in doprnt.c. */
3798 extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *,
3799 va_list);
3800 extern ptrdiff_t esprintf (char *, char const *, ...)
3801 ATTRIBUTE_FORMAT_PRINTF (2, 3);
3802 extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3803 char const *, ...)
3804 ATTRIBUTE_FORMAT_PRINTF (5, 6);
3805 extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t,
3806 char const *, va_list)
3807 ATTRIBUTE_FORMAT_PRINTF (5, 0);
3808
3809 /* Defined in lread.c. */
3810 extern Lisp_Object check_obarray (Lisp_Object);
3811 extern Lisp_Object intern_1 (const char *, ptrdiff_t);
3812 extern Lisp_Object intern_c_string_1 (const char *, ptrdiff_t);
3813 extern Lisp_Object intern_driver (Lisp_Object, Lisp_Object, Lisp_Object);
3814 extern void init_symbol (Lisp_Object, Lisp_Object);
3815 extern Lisp_Object oblookup (Lisp_Object, const char *, ptrdiff_t, ptrdiff_t);
3816 INLINE void
3817 LOADHIST_ATTACH (Lisp_Object x)
3818 {
3819 if (initialized)
3820 Vcurrent_load_list = Fcons (x, Vcurrent_load_list);
3821 }
3822 extern int openp (Lisp_Object, Lisp_Object, Lisp_Object,
3823 Lisp_Object *, Lisp_Object, bool);
3824 extern Lisp_Object string_to_number (char const *, int, bool);
3825 extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
3826 Lisp_Object);
3827 extern void dir_warning (const char *, Lisp_Object);
3828 extern void init_obarray (void);
3829 extern void init_lread (void);
3830 extern void syms_of_lread (void);
3831
3832 INLINE Lisp_Object
3833 intern (const char *str)
3834 {
3835 return intern_1 (str, strlen (str));
3836 }
3837
3838 INLINE Lisp_Object
3839 intern_c_string (const char *str)
3840 {
3841 return intern_c_string_1 (str, strlen (str));
3842 }
3843
3844 /* Defined in eval.c. */
3845 extern Lisp_Object Vautoload_queue;
3846 extern Lisp_Object Vrun_hooks;
3847 extern Lisp_Object Vsignaling_function;
3848 extern Lisp_Object inhibit_lisp_code;
3849 extern struct handler *handlerlist;
3850
3851 /* To run a normal hook, use the appropriate function from the list below.
3852 The calling convention:
3853
3854 if (!NILP (Vrun_hooks))
3855 call1 (Vrun_hooks, Qmy_funny_hook);
3856
3857 should no longer be used. */
3858 extern void run_hook (Lisp_Object);
3859 extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object);
3860 extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
3861 Lisp_Object (*funcall)
3862 (ptrdiff_t nargs, Lisp_Object *args));
3863 extern _Noreturn void xsignal (Lisp_Object, Lisp_Object);
3864 extern _Noreturn void xsignal0 (Lisp_Object);
3865 extern _Noreturn void xsignal1 (Lisp_Object, Lisp_Object);
3866 extern _Noreturn void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object);
3867 extern _Noreturn void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object,
3868 Lisp_Object);
3869 extern _Noreturn void signal_error (const char *, Lisp_Object);
3870 extern Lisp_Object eval_sub (Lisp_Object form);
3871 extern Lisp_Object apply1 (Lisp_Object, Lisp_Object);
3872 extern Lisp_Object call0 (Lisp_Object);
3873 extern Lisp_Object call1 (Lisp_Object, Lisp_Object);
3874 extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
3875 extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3876 extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3877 extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3878 extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3879 extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3880 extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object);
3881 extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object);
3882 extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object));
3883 extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
3884 extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object));
3885 extern Lisp_Object internal_condition_case_n
3886 (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *,
3887 Lisp_Object, Lisp_Object (*) (Lisp_Object, ptrdiff_t, Lisp_Object *));
3888 extern struct handler *push_handler (Lisp_Object, enum handlertype);
3889 extern struct handler *push_handler_nosignal (Lisp_Object, enum handlertype);
3890 extern void specbind (Lisp_Object, Lisp_Object);
3891 extern void record_unwind_protect (void (*) (Lisp_Object), Lisp_Object);
3892 extern void record_unwind_protect_ptr (void (*) (void *), void *);
3893 extern void record_unwind_protect_int (void (*) (int), int);
3894 extern void record_unwind_protect_void (void (*) (void));
3895 extern void record_unwind_protect_nothing (void);
3896 extern void clear_unwind_protect (ptrdiff_t);
3897 extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object), Lisp_Object);
3898 extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *);
3899 extern Lisp_Object unbind_to (ptrdiff_t, Lisp_Object);
3900 extern _Noreturn void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2);
3901 extern _Noreturn void verror (const char *, va_list)
3902 ATTRIBUTE_FORMAT_PRINTF (1, 0);
3903 extern void un_autoload (Lisp_Object);
3904 extern Lisp_Object call_debugger (Lisp_Object arg);
3905 extern void *near_C_stack_top (void);
3906 extern void init_eval_once (void);
3907 extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object, ...);
3908 extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object);
3909 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
3910 extern void init_eval (void);
3911 extern void syms_of_eval (void);
3912 extern void unwind_body (Lisp_Object);
3913 extern ptrdiff_t record_in_backtrace (Lisp_Object, Lisp_Object *, ptrdiff_t);
3914 extern void mark_specpdl (void);
3915 extern void get_backtrace (Lisp_Object array);
3916 Lisp_Object backtrace_top_function (void);
3917 extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol);
3918 extern bool let_shadows_global_binding_p (Lisp_Object symbol);
3919
3920 #ifdef HAVE_MODULES
3921 /* Defined in alloc.c. */
3922 extern Lisp_Object make_user_ptr (void (*finalizer) (void *), void *p);
3923
3924 /* Defined in emacs-module.c. */
3925 extern void module_init (void);
3926 extern void syms_of_module (void);
3927 #endif
3928
3929 /* Defined in editfns.c. */
3930 extern void insert1 (Lisp_Object);
3931 extern Lisp_Object save_excursion_save (void);
3932 extern Lisp_Object save_restriction_save (void);
3933 extern void save_excursion_restore (Lisp_Object);
3934 extern void save_restriction_restore (Lisp_Object);
3935 extern _Noreturn void time_overflow (void);
3936 extern Lisp_Object make_buffer_string (ptrdiff_t, ptrdiff_t, bool);
3937 extern Lisp_Object make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t,
3938 ptrdiff_t, bool);
3939 extern void init_editfns (bool);
3940 extern void syms_of_editfns (void);
3941
3942 /* Defined in buffer.c. */
3943 extern bool mouse_face_overlay_overlaps (Lisp_Object);
3944 extern _Noreturn void nsberror (Lisp_Object);
3945 extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t);
3946 extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t);
3947 extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t);
3948 extern void report_overlay_modification (Lisp_Object, Lisp_Object, bool,
3949 Lisp_Object, Lisp_Object, Lisp_Object);
3950 extern bool overlay_touches_p (ptrdiff_t);
3951 extern Lisp_Object other_buffer_safely (Lisp_Object);
3952 extern Lisp_Object get_truename_buffer (Lisp_Object);
3953 extern void init_buffer_once (void);
3954 extern void init_buffer (int);
3955 extern void syms_of_buffer (void);
3956 extern void keys_of_buffer (void);
3957
3958 /* Defined in marker.c. */
3959
3960 extern ptrdiff_t marker_position (Lisp_Object);
3961 extern ptrdiff_t marker_byte_position (Lisp_Object);
3962 extern void clear_charpos_cache (struct buffer *);
3963 extern ptrdiff_t buf_charpos_to_bytepos (struct buffer *, ptrdiff_t);
3964 extern ptrdiff_t buf_bytepos_to_charpos (struct buffer *, ptrdiff_t);
3965 extern void unchain_marker (struct Lisp_Marker *marker);
3966 extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
3967 extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t);
3968 extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object,
3969 ptrdiff_t, ptrdiff_t);
3970 extern Lisp_Object build_marker (struct buffer *, ptrdiff_t, ptrdiff_t);
3971 extern void syms_of_marker (void);
3972
3973 /* Defined in fileio.c. */
3974
3975 extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
3976 extern Lisp_Object write_region (Lisp_Object, Lisp_Object, Lisp_Object,
3977 Lisp_Object, Lisp_Object, Lisp_Object,
3978 Lisp_Object, int);
3979 extern void close_file_unwind (int);
3980 extern void fclose_unwind (void *);
3981 extern void restore_point_unwind (Lisp_Object);
3982 extern _Noreturn void report_file_errno (const char *, Lisp_Object, int);
3983 extern _Noreturn void report_file_error (const char *, Lisp_Object);
3984 extern _Noreturn void report_file_notify_error (const char *, Lisp_Object);
3985 extern bool internal_delete_file (Lisp_Object);
3986 extern Lisp_Object emacs_readlinkat (int, const char *);
3987 extern bool file_directory_p (const char *);
3988 extern bool file_accessible_directory_p (Lisp_Object);
3989 extern void init_fileio (void);
3990 extern void syms_of_fileio (void);
3991 extern Lisp_Object make_temp_name (Lisp_Object, bool);
3992
3993 /* Defined in search.c. */
3994 extern void shrink_regexp_cache (void);
3995 extern void restore_search_regs (void);
3996 extern void record_unwind_save_match_data (void);
3997 struct re_registers;
3998 extern struct re_pattern_buffer *compile_pattern (Lisp_Object,
3999 struct re_registers *,
4000 Lisp_Object, bool, bool);
4001 extern ptrdiff_t fast_string_match_internal (Lisp_Object, Lisp_Object,
4002 Lisp_Object);
4003
4004 INLINE ptrdiff_t
4005 fast_string_match (Lisp_Object regexp, Lisp_Object string)
4006 {
4007 return fast_string_match_internal (regexp, string, Qnil);
4008 }
4009
4010 INLINE ptrdiff_t
4011 fast_string_match_ignore_case (Lisp_Object regexp, Lisp_Object string)
4012 {
4013 return fast_string_match_internal (regexp, string, Vascii_canon_table);
4014 }
4015
4016 extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object, const char *,
4017 ptrdiff_t);
4018 extern ptrdiff_t fast_looking_at (Lisp_Object, ptrdiff_t, ptrdiff_t,
4019 ptrdiff_t, ptrdiff_t, Lisp_Object);
4020 extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4021 ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool);
4022 extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t,
4023 ptrdiff_t, bool);
4024 extern ptrdiff_t scan_newline_from_point (ptrdiff_t, ptrdiff_t *, ptrdiff_t *);
4025 extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t,
4026 ptrdiff_t, ptrdiff_t *);
4027 extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t,
4028 ptrdiff_t, ptrdiff_t *);
4029 extern void syms_of_search (void);
4030 extern void clear_regexp_cache (void);
4031
4032 /* Defined in minibuf.c. */
4033
4034 extern Lisp_Object Vminibuffer_list;
4035 extern Lisp_Object last_minibuf_string;
4036 extern Lisp_Object get_minibuffer (EMACS_INT);
4037 extern void init_minibuf_once (void);
4038 extern void syms_of_minibuf (void);
4039
4040 /* Defined in callint.c. */
4041
4042 extern void syms_of_callint (void);
4043
4044 /* Defined in casefiddle.c. */
4045
4046 extern void syms_of_casefiddle (void);
4047 extern void keys_of_casefiddle (void);
4048
4049 /* Defined in casetab.c. */
4050
4051 extern void init_casetab_once (void);
4052 extern void syms_of_casetab (void);
4053
4054 /* Defined in keyboard.c. */
4055
4056 extern Lisp_Object echo_message_buffer;
4057 extern struct kboard *echo_kboard;
4058 extern void cancel_echoing (void);
4059 extern bool input_pending;
4060 #ifdef HAVE_STACK_OVERFLOW_HANDLING
4061 extern sigjmp_buf return_to_command_loop;
4062 #endif
4063 extern Lisp_Object menu_bar_items (Lisp_Object);
4064 extern Lisp_Object tool_bar_items (Lisp_Object, int *);
4065 extern void discard_mouse_events (void);
4066 #ifdef USABLE_SIGIO
4067 void handle_input_available_signal (int);
4068 #endif
4069 extern Lisp_Object pending_funcalls;
4070 extern bool detect_input_pending (void);
4071 extern bool detect_input_pending_ignore_squeezables (void);
4072 extern bool detect_input_pending_run_timers (bool);
4073 extern void safe_run_hooks (Lisp_Object);
4074 extern void cmd_error_internal (Lisp_Object, const char *);
4075 extern Lisp_Object command_loop_1 (void);
4076 extern Lisp_Object read_menu_command (void);
4077 extern Lisp_Object recursive_edit_1 (void);
4078 extern void record_auto_save (void);
4079 extern void force_auto_save_soon (void);
4080 extern void init_keyboard (void);
4081 extern void syms_of_keyboard (void);
4082 extern void keys_of_keyboard (void);
4083
4084 /* Defined in indent.c. */
4085 extern ptrdiff_t current_column (void);
4086 extern void invalidate_current_column (void);
4087 extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT);
4088 extern void syms_of_indent (void);
4089
4090 /* Defined in frame.c. */
4091 extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object);
4092 extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object);
4093 extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object);
4094 extern Lisp_Object get_frame_param (struct frame *, Lisp_Object);
4095 extern void frames_discard_buffer (Lisp_Object);
4096 extern void syms_of_frame (void);
4097
4098 /* Defined in emacs.c. */
4099 extern char **initial_argv;
4100 extern int initial_argc;
4101 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
4102 extern bool display_arg;
4103 #endif
4104 extern Lisp_Object decode_env_path (const char *, const char *, bool);
4105 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
4106 extern _Noreturn void terminate_due_to_signal (int, int);
4107 #ifdef WINDOWSNT
4108 extern Lisp_Object Vlibrary_cache;
4109 #endif
4110 #if HAVE_SETLOCALE
4111 void fixup_locale (void);
4112 void synchronize_system_messages_locale (void);
4113 void synchronize_system_time_locale (void);
4114 #else
4115 INLINE void fixup_locale (void) {}
4116 INLINE void synchronize_system_messages_locale (void) {}
4117 INLINE void synchronize_system_time_locale (void) {}
4118 #endif
4119 extern void shut_down_emacs (int, Lisp_Object);
4120
4121 /* True means don't do interactive redisplay and don't change tty modes. */
4122 extern bool noninteractive;
4123
4124 /* True means remove site-lisp directories from load-path. */
4125 extern bool no_site_lisp;
4126
4127 /* Pipe used to send exit notification to the daemon parent at
4128 startup. On Windows, we use a kernel event instead. */
4129 #ifndef WINDOWSNT
4130 extern int daemon_pipe[2];
4131 #define IS_DAEMON (daemon_pipe[1] != 0)
4132 #define DAEMON_RUNNING (daemon_pipe[1] >= 0)
4133 #else /* WINDOWSNT */
4134 extern void *w32_daemon_event;
4135 #define IS_DAEMON (w32_daemon_event != NULL)
4136 #define DAEMON_RUNNING (w32_daemon_event != INVALID_HANDLE_VALUE)
4137 #endif
4138
4139 /* True if handling a fatal error already. */
4140 extern bool fatal_error_in_progress;
4141
4142 /* True means don't do use window-system-specific display code. */
4143 extern bool inhibit_window_system;
4144 /* True means that a filter or a sentinel is running. */
4145 extern bool running_asynch_code;
4146
4147 /* Defined in process.c. */
4148 extern void kill_buffer_processes (Lisp_Object);
4149 extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object,
4150 struct Lisp_Process *, int);
4151 /* Max value for the first argument of wait_reading_process_output. */
4152 #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5)
4153 /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3.
4154 The bug merely causes a bogus warning, but the warning is annoying. */
4155 # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX)
4156 #else
4157 # define WAIT_READING_MAX INTMAX_MAX
4158 #endif
4159 #ifdef HAVE_TIMERFD
4160 extern void add_timer_wait_descriptor (int);
4161 #endif
4162 extern void add_keyboard_wait_descriptor (int);
4163 extern void delete_keyboard_wait_descriptor (int);
4164 #ifdef HAVE_GPM
4165 extern void add_gpm_wait_descriptor (int);
4166 extern void delete_gpm_wait_descriptor (int);
4167 #endif
4168 extern void init_process_emacs (void);
4169 extern void syms_of_process (void);
4170 extern void setup_process_coding_systems (Lisp_Object);
4171
4172 /* Defined in callproc.c. */
4173 #ifndef DOS_NT
4174 _Noreturn
4175 #endif
4176 extern int child_setup (int, int, int, char **, bool, Lisp_Object);
4177 extern void init_callproc_1 (void);
4178 extern void init_callproc (void);
4179 extern void set_initial_environment (void);
4180 extern void syms_of_callproc (void);
4181
4182 /* Defined in doc.c. */
4183 enum text_quoting_style
4184 {
4185 /* Use curved single quotes ‘like this’. */
4186 CURVE_QUOTING_STYLE,
4187
4188 /* Use grave accent and apostrophe `like this'. */
4189 GRAVE_QUOTING_STYLE,
4190
4191 /* Use apostrophes 'like this'. */
4192 STRAIGHT_QUOTING_STYLE
4193 };
4194 extern enum text_quoting_style text_quoting_style (void);
4195 extern Lisp_Object read_doc_string (Lisp_Object);
4196 extern Lisp_Object get_doc_string (Lisp_Object, bool, bool);
4197 extern void syms_of_doc (void);
4198 extern int read_bytecode_char (bool);
4199
4200 /* Defined in bytecode.c. */
4201 extern void syms_of_bytecode (void);
4202 extern struct byte_stack *byte_stack_list;
4203 extern void relocate_byte_stack (void);
4204 extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object,
4205 Lisp_Object, ptrdiff_t, Lisp_Object *);
4206
4207 /* Defined in macros.c. */
4208 extern void init_macros (void);
4209 extern void syms_of_macros (void);
4210
4211 /* Defined in undo.c. */
4212 extern void truncate_undo_list (struct buffer *);
4213 extern void record_insert (ptrdiff_t, ptrdiff_t);
4214 extern void record_delete (ptrdiff_t, Lisp_Object, bool);
4215 extern void record_first_change (void);
4216 extern void record_change (ptrdiff_t, ptrdiff_t);
4217 extern void record_property_change (ptrdiff_t, ptrdiff_t,
4218 Lisp_Object, Lisp_Object,
4219 Lisp_Object);
4220 extern void syms_of_undo (void);
4221
4222 /* Defined in textprop.c. */
4223 extern void report_interval_modification (Lisp_Object, Lisp_Object);
4224
4225 /* Defined in menu.c. */
4226 extern void syms_of_menu (void);
4227
4228 /* Defined in xmenu.c. */
4229 extern void syms_of_xmenu (void);
4230
4231 /* Defined in termchar.h. */
4232 struct tty_display_info;
4233
4234 /* Defined in termhooks.h. */
4235 struct terminal;
4236
4237 /* Defined in sysdep.c. */
4238 #ifndef HAVE_GET_CURRENT_DIR_NAME
4239 extern char *get_current_dir_name (void);
4240 #endif
4241 extern void stuff_char (char c);
4242 extern void init_foreground_group (void);
4243 extern void sys_subshell (void);
4244 extern void sys_suspend (void);
4245 extern void discard_tty_input (void);
4246 extern void init_sys_modes (struct tty_display_info *);
4247 extern void reset_sys_modes (struct tty_display_info *);
4248 extern void init_all_sys_modes (void);
4249 extern void reset_all_sys_modes (void);
4250 extern void child_setup_tty (int);
4251 extern void setup_pty (int);
4252 extern int set_window_size (int, int, int);
4253 extern EMACS_INT get_random (void);
4254 extern void seed_random (void *, ptrdiff_t);
4255 extern void init_random (void);
4256 extern void emacs_backtrace (int);
4257 extern _Noreturn void emacs_abort (void) NO_INLINE;
4258 extern int emacs_open (const char *, int, int);
4259 extern int emacs_pipe (int[2]);
4260 extern int emacs_close (int);
4261 extern ptrdiff_t emacs_read (int, void *, ptrdiff_t);
4262 extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t);
4263 extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t);
4264 extern void emacs_perror (char const *);
4265
4266 extern void unlock_all_files (void);
4267 extern void lock_file (Lisp_Object);
4268 extern void unlock_file (Lisp_Object);
4269 extern void unlock_buffer (struct buffer *);
4270 extern void syms_of_filelock (void);
4271 extern int str_collate (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
4272
4273 /* Defined in sound.c. */
4274 extern void syms_of_sound (void);
4275
4276 /* Defined in category.c. */
4277 extern void init_category_once (void);
4278 extern Lisp_Object char_category_set (int);
4279 extern void syms_of_category (void);
4280
4281 /* Defined in ccl.c. */
4282 extern void syms_of_ccl (void);
4283
4284 /* Defined in dired.c. */
4285 extern void syms_of_dired (void);
4286 extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object,
4287 Lisp_Object, Lisp_Object,
4288 bool, Lisp_Object);
4289
4290 /* Defined in term.c. */
4291 extern int *char_ins_del_vector;
4292 extern void syms_of_term (void);
4293 extern _Noreturn void fatal (const char *msgid, ...)
4294 ATTRIBUTE_FORMAT_PRINTF (1, 2);
4295
4296 /* Defined in terminal.c. */
4297 extern void syms_of_terminal (void);
4298
4299 /* Defined in font.c. */
4300 extern void syms_of_font (void);
4301 extern void init_font (void);
4302
4303 #ifdef HAVE_WINDOW_SYSTEM
4304 /* Defined in fontset.c. */
4305 extern void syms_of_fontset (void);
4306 #endif
4307
4308 /* Defined in inotify.c */
4309 #ifdef HAVE_INOTIFY
4310 extern void syms_of_inotify (void);
4311 #endif
4312
4313 /* Defined in kqueue.c */
4314 #ifdef HAVE_KQUEUE
4315 extern void globals_of_kqueue (void);
4316 extern void syms_of_kqueue (void);
4317 #endif
4318
4319 /* Defined in gfilenotify.c */
4320 #ifdef HAVE_GFILENOTIFY
4321 extern void globals_of_gfilenotify (void);
4322 extern void syms_of_gfilenotify (void);
4323 #endif
4324
4325 #ifdef HAVE_W32NOTIFY
4326 /* Defined on w32notify.c. */
4327 extern void syms_of_w32notify (void);
4328 #endif
4329
4330 /* Defined in xfaces.c. */
4331 extern Lisp_Object Vface_alternative_font_family_alist;
4332 extern Lisp_Object Vface_alternative_font_registry_alist;
4333 extern void syms_of_xfaces (void);
4334
4335 #ifdef HAVE_X_WINDOWS
4336 /* Defined in xfns.c. */
4337 extern void syms_of_xfns (void);
4338
4339 /* Defined in xsmfns.c. */
4340 extern void syms_of_xsmfns (void);
4341
4342 /* Defined in xselect.c. */
4343 extern void syms_of_xselect (void);
4344
4345 /* Defined in xterm.c. */
4346 extern void init_xterm (void);
4347 extern void syms_of_xterm (void);
4348 #endif /* HAVE_X_WINDOWS */
4349
4350 #ifdef HAVE_WINDOW_SYSTEM
4351 /* Defined in xterm.c, nsterm.m, w32term.c. */
4352 extern char *x_get_keysym_name (int);
4353 #endif /* HAVE_WINDOW_SYSTEM */
4354
4355 #ifdef HAVE_LIBXML2
4356 /* Defined in xml.c. */
4357 extern void syms_of_xml (void);
4358 extern void xml_cleanup_parser (void);
4359 #endif
4360
4361 #ifdef HAVE_ZLIB
4362 /* Defined in decompress.c. */
4363 extern void syms_of_decompress (void);
4364 #endif
4365
4366 #ifdef HAVE_DBUS
4367 /* Defined in dbusbind.c. */
4368 void init_dbusbind (void);
4369 void syms_of_dbusbind (void);
4370 #endif
4371
4372
4373 /* Defined in profiler.c. */
4374 extern bool profiler_memory_running;
4375 extern void malloc_probe (size_t);
4376 extern void syms_of_profiler (void);
4377
4378
4379 #ifdef DOS_NT
4380 /* Defined in msdos.c, w32.c. */
4381 extern char *emacs_root_dir (void);
4382 #endif /* DOS_NT */
4383
4384 /* Defined in lastfile.c. */
4385 extern char my_edata[];
4386 extern char my_endbss[];
4387 extern char *my_endbss_static;
4388
4389 /* True means ^G can quit instantly. */
4390 extern bool immediate_quit;
4391
4392 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4393 extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1));
4394 extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2));
4395 extern void xfree (void *);
4396 extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2));
4397 extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t)
4398 ATTRIBUTE_ALLOC_SIZE ((2,3));
4399 extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t);
4400
4401 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC;
4402 extern char *xlispstrdup (Lisp_Object) ATTRIBUTE_MALLOC;
4403 extern void dupstring (char **, char const *);
4404
4405 /* Make DEST a copy of STRING's data. Return a pointer to DEST's terminating
4406 null byte. This is like stpcpy, except the source is a Lisp string. */
4407
4408 INLINE char *
4409 lispstpcpy (char *dest, Lisp_Object string)
4410 {
4411 ptrdiff_t len = SBYTES (string);
4412 memcpy (dest, SDATA (string), len + 1);
4413 return dest + len;
4414 }
4415
4416 extern void xputenv (const char *);
4417
4418 extern char *egetenv_internal (const char *, ptrdiff_t);
4419
4420 INLINE char *
4421 egetenv (const char *var)
4422 {
4423 /* When VAR is a string literal, strlen can be optimized away. */
4424 return egetenv_internal (var, strlen (var));
4425 }
4426
4427 /* Set up the name of the machine we're running on. */
4428 extern void init_system_name (void);
4429
4430 /* Return the absolute value of X. X should be a signed integer
4431 expression without side effects, and X's absolute value should not
4432 exceed the maximum for its promoted type. This is called 'eabs'
4433 because 'abs' is reserved by the C standard. */
4434 #define eabs(x) ((x) < 0 ? -(x) : (x))
4435
4436 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
4437 fixnum. */
4438
4439 #define make_fixnum_or_float(val) \
4440 (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val))
4441
4442 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
4443 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
4444
4445 enum MAX_ALLOCA { MAX_ALLOCA = 16 * 1024 };
4446
4447 extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1));
4448
4449 #define USE_SAFE_ALLOCA \
4450 ptrdiff_t sa_avail = MAX_ALLOCA; \
4451 ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false
4452
4453 #define AVAIL_ALLOCA(size) (sa_avail -= (size), alloca (size))
4454
4455 /* SAFE_ALLOCA allocates a simple buffer. */
4456
4457 #define SAFE_ALLOCA(size) ((size) <= sa_avail \
4458 ? AVAIL_ALLOCA (size) \
4459 : (sa_must_free = true, record_xmalloc (size)))
4460
4461 /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER *
4462 NITEMS items, each of the same type as *BUF. MULTIPLIER must
4463 positive. The code is tuned for MULTIPLIER being a constant. */
4464
4465 #define SAFE_NALLOCA(buf, multiplier, nitems) \
4466 do { \
4467 if ((nitems) <= sa_avail / sizeof *(buf) / (multiplier)) \
4468 (buf) = AVAIL_ALLOCA (sizeof *(buf) * (multiplier) * (nitems)); \
4469 else \
4470 { \
4471 (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \
4472 sa_must_free = true; \
4473 record_unwind_protect_ptr (xfree, buf); \
4474 } \
4475 } while (false)
4476
4477 /* SAFE_ALLOCA_STRING allocates a C copy of a Lisp string. */
4478
4479 #define SAFE_ALLOCA_STRING(ptr, string) \
4480 do { \
4481 (ptr) = SAFE_ALLOCA (SBYTES (string) + 1); \
4482 memcpy (ptr, SDATA (string), SBYTES (string) + 1); \
4483 } while (false)
4484
4485 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
4486
4487 #define SAFE_FREE() \
4488 do { \
4489 if (sa_must_free) { \
4490 sa_must_free = false; \
4491 unbind_to (sa_count, Qnil); \
4492 } \
4493 } while (false)
4494
4495 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
4496
4497 #define SAFE_ALLOCA_LISP(buf, nelt) \
4498 do { \
4499 ptrdiff_t alloca_nbytes; \
4500 if (INT_MULTIPLY_WRAPV (nelt, word_size, &alloca_nbytes) \
4501 || SIZE_MAX < alloca_nbytes) \
4502 memory_full (SIZE_MAX); \
4503 else if (alloca_nbytes <= sa_avail) \
4504 (buf) = AVAIL_ALLOCA (alloca_nbytes); \
4505 else \
4506 { \
4507 Lisp_Object arg_; \
4508 (buf) = xmalloc (alloca_nbytes); \
4509 arg_ = make_save_memory (buf, nelt); \
4510 sa_must_free = true; \
4511 record_unwind_protect (free_save_value, arg_); \
4512 } \
4513 } while (false)
4514
4515
4516 /* If USE_STACK_LISP_OBJECTS, define macros that and functions that allocate
4517 block-scoped conses and strings. These objects are not
4518 managed by the garbage collector, so they are dangerous: passing them
4519 out of their scope (e.g., to user code) results in undefined behavior.
4520 Conversely, they have better performance because GC is not involved.
4521
4522 This feature is experimental and requires careful debugging.
4523 Build with CPPFLAGS='-DUSE_STACK_LISP_OBJECTS=0' to disable it. */
4524
4525 #if (!defined USE_STACK_LISP_OBJECTS \
4526 && defined __GNUC__ && !defined __clang__ \
4527 && !(4 < __GNUC__ + (3 < __GNUC_MINOR__ + (2 <= __GNUC_PATCHLEVEL__))))
4528 /* Work around GCC bugs 36584 and 35271, which were fixed in GCC 4.3.2. */
4529 # define USE_STACK_LISP_OBJECTS false
4530 #endif
4531 #ifndef USE_STACK_LISP_OBJECTS
4532 # define USE_STACK_LISP_OBJECTS true
4533 #endif
4534
4535 #ifdef GC_CHECK_STRING_BYTES
4536 enum { defined_GC_CHECK_STRING_BYTES = true };
4537 #else
4538 enum { defined_GC_CHECK_STRING_BYTES = false };
4539 #endif
4540
4541 /* Struct inside unions that are typically no larger and aligned enough. */
4542
4543 union Aligned_Cons
4544 {
4545 struct Lisp_Cons s;
4546 double d; intmax_t i; void *p;
4547 };
4548
4549 union Aligned_String
4550 {
4551 struct Lisp_String s;
4552 double d; intmax_t i; void *p;
4553 };
4554
4555 /* True for stack-based cons and string implementations, respectively.
4556 Use stack-based strings only if stack-based cons also works.
4557 Otherwise, STACK_CONS would create heap-based cons cells that
4558 could point to stack-based strings, which is a no-no. */
4559
4560 enum
4561 {
4562 USE_STACK_CONS = (USE_STACK_LISP_OBJECTS
4563 && alignof (union Aligned_Cons) % GCALIGNMENT == 0),
4564 USE_STACK_STRING = (USE_STACK_CONS
4565 && !defined_GC_CHECK_STRING_BYTES
4566 && alignof (union Aligned_String) % GCALIGNMENT == 0)
4567 };
4568
4569 /* Auxiliary macros used for auto allocation of Lisp objects. Please
4570 use these only in macros like AUTO_CONS that declare a local
4571 variable whose lifetime will be clear to the programmer. */
4572 #define STACK_CONS(a, b) \
4573 make_lisp_ptr (&(union Aligned_Cons) { { a, { b } } }.s, Lisp_Cons)
4574 #define AUTO_CONS_EXPR(a, b) \
4575 (USE_STACK_CONS ? STACK_CONS (a, b) : Fcons (a, b))
4576
4577 /* Declare NAME as an auto Lisp cons or short list if possible, a
4578 GC-based one otherwise. This is in the sense of the C keyword
4579 'auto'; i.e., the object has the lifetime of the containing block.
4580 The resulting object should not be made visible to user Lisp code. */
4581
4582 #define AUTO_CONS(name, a, b) Lisp_Object name = AUTO_CONS_EXPR (a, b)
4583 #define AUTO_LIST1(name, a) \
4584 Lisp_Object name = (USE_STACK_CONS ? STACK_CONS (a, Qnil) : list1 (a))
4585 #define AUTO_LIST2(name, a, b) \
4586 Lisp_Object name = (USE_STACK_CONS \
4587 ? STACK_CONS (a, STACK_CONS (b, Qnil)) \
4588 : list2 (a, b))
4589 #define AUTO_LIST3(name, a, b, c) \
4590 Lisp_Object name = (USE_STACK_CONS \
4591 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, Qnil))) \
4592 : list3 (a, b, c))
4593 #define AUTO_LIST4(name, a, b, c, d) \
4594 Lisp_Object name \
4595 = (USE_STACK_CONS \
4596 ? STACK_CONS (a, STACK_CONS (b, STACK_CONS (c, \
4597 STACK_CONS (d, Qnil)))) \
4598 : list4 (a, b, c, d))
4599
4600 /* Check whether stack-allocated strings are ASCII-only. */
4601
4602 #if defined (ENABLE_CHECKING) && USE_STACK_LISP_OBJECTS
4603 extern const char *verify_ascii (const char *);
4604 #else
4605 # define verify_ascii(str) (str)
4606 #endif
4607
4608 /* Declare NAME as an auto Lisp string if possible, a GC-based one if not.
4609 Take its value from STR. STR is not necessarily copied and should
4610 contain only ASCII characters. The resulting Lisp string should
4611 not be modified or made visible to user code. */
4612
4613 #define AUTO_STRING(name, str) \
4614 Lisp_Object name = \
4615 (USE_STACK_STRING \
4616 ? (make_lisp_ptr \
4617 ((&(union Aligned_String) \
4618 {{strlen (str), -1, 0, (unsigned char *) verify_ascii (str)}}.s), \
4619 Lisp_String)) \
4620 : build_string (verify_ascii (str)))
4621
4622 /* Loop over all tails of a list, checking for cycles.
4623 FIXME: Make tortoise and n internal declarations.
4624 FIXME: Unroll the loop body so we don't need `n'. */
4625 #define FOR_EACH_TAIL(hare, list, tortoise, n) \
4626 for ((tortoise) = (hare) = (list), (n) = true; \
4627 CONSP (hare); \
4628 (hare = XCDR (hare), (n) = !(n), \
4629 ((n) \
4630 ? (EQ (hare, tortoise) \
4631 ? xsignal1 (Qcircular_list, list) \
4632 : (void) 0) \
4633 /* Move tortoise before the next iteration, in case */ \
4634 /* the next iteration does an Fsetcdr. */ \
4635 : (void) ((tortoise) = XCDR (tortoise)))))
4636
4637 /* Do a `for' loop over alist values. */
4638
4639 #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \
4640 for ((list_var) = (head_var); \
4641 (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \
4642 (list_var) = XCDR (list_var))
4643
4644 /* Check whether it's time for GC, and run it if so. */
4645
4646 INLINE void
4647 maybe_gc (void)
4648 {
4649 if ((consing_since_gc > gc_cons_threshold
4650 && consing_since_gc > gc_relative_threshold)
4651 || (!NILP (Vmemory_full)
4652 && consing_since_gc > memory_full_cons_threshold))
4653 Fgarbage_collect ();
4654 }
4655
4656 INLINE bool
4657 functionp (Lisp_Object object)
4658 {
4659 if (SYMBOLP (object) && !NILP (Ffboundp (object)))
4660 {
4661 object = Findirect_function (object, Qt);
4662
4663 if (CONSP (object) && EQ (XCAR (object), Qautoload))
4664 {
4665 /* Autoloaded symbols are functions, except if they load
4666 macros or keymaps. */
4667 int i;
4668 for (i = 0; i < 4 && CONSP (object); i++)
4669 object = XCDR (object);
4670
4671 return ! (CONSP (object) && !NILP (XCAR (object)));
4672 }
4673 }
4674
4675 if (SUBRP (object))
4676 return XSUBR (object)->max_args != UNEVALLED;
4677 else if (COMPILEDP (object))
4678 return true;
4679 else if (CONSP (object))
4680 {
4681 Lisp_Object car = XCAR (object);
4682 return EQ (car, Qlambda) || EQ (car, Qclosure);
4683 }
4684 else
4685 return false;
4686 }
4687
4688 INLINE_HEADER_END
4689
4690 #endif /* EMACS_LISP_H */