Commit | Line | Data |
---|---|---|
3cfe6dfd | 1 | /* Fundamental definitions for GNU Emacs Lisp interpreter. |
e2017fe2 | 2 | |
ba318903 PE |
3 | Copyright (C) 1985-1987, 1993-1995, 1997-2014 Free Software Foundation, |
4 | Inc. | |
3cfe6dfd JB |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
b9b1cc14 | 8 | GNU Emacs is free software: you can redistribute it and/or modify |
3cfe6dfd | 9 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
3cfe6dfd JB |
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 | |
b9b1cc14 | 19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
3cfe6dfd | 20 | |
6b61353c KH |
21 | #ifndef EMACS_LISP_H |
22 | #define EMACS_LISP_H | |
23 | ||
0328b6de | 24 | #include <setjmp.h> |
e32a5799 | 25 | #include <stdalign.h> |
6a8033e1 | 26 | #include <stdarg.h> |
89887d67 | 27 | #include <stddef.h> |
4d7e6e51 | 28 | #include <float.h> |
8ac068ac | 29 | #include <inttypes.h> |
dd3482fe | 30 | #include <limits.h> |
be44ca6c | 31 | #include <intprops.h> |
b9ff995e | 32 | #include <verify.h> |
49609976 | 33 | #include <libguile.h> |
be44ca6c | 34 | |
f162bcc3 | 35 | INLINE_HEADER_BEGIN |
f162bcc3 | 36 | |
bb9937df PE |
37 | /* Define a TYPE constant ID as an externally visible name. Use like this: |
38 | ||
bba89481 PE |
39 | #define ID_val (some integer preprocessor expression) |
40 | #if ENUMABLE (ID_val) | |
41 | DEFINE_GDB_SYMBOL_ENUM (ID) | |
42 | #else | |
bb9937df | 43 | DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID) |
bba89481 | 44 | # define ID ID_val |
bb9937df | 45 | DEFINE_GDB_SYMBOL_END (ID) |
bba89481 | 46 | #endif |
bb9937df PE |
47 | |
48 | This hack is for the benefit of compilers that do not make macro | |
49 | definitions visible to the debugger. It's used for symbols that | |
50 | .gdbinit needs, symbols whose values may not fit in 'int' (where an | |
bba89481 PE |
51 | enum would suffice). |
52 | ||
53 | Some GCC versions before GCC 4.2 omit enums in debugging output; | |
54 | see GCC bug 23336. So don't use enums with older GCC. */ | |
55 | ||
56 | #if !defined __GNUC__ || 4 < __GNUC__ + (2 <= __GNUC_MINOR__) | |
57 | # define ENUMABLE(val) (INT_MIN <= (val) && (val) <= INT_MAX) | |
58 | #else | |
59 | # define ENUMABLE(val) 0 | |
60 | #endif | |
61 | ||
bba89481 | 62 | #define DEFINE_GDB_SYMBOL_ENUM(id) enum { id = id##_val }; |
0f679e86 | 63 | #if defined MAIN_PROGRAM |
bb9937df PE |
64 | # define DEFINE_GDB_SYMBOL_BEGIN(type, id) type const id EXTERNALLY_VISIBLE |
65 | # define DEFINE_GDB_SYMBOL_END(id) = id; | |
66 | #else | |
67 | # define DEFINE_GDB_SYMBOL_BEGIN(type, id) | |
68 | # define DEFINE_GDB_SYMBOL_END(val) | |
69 | #endif | |
70 | ||
03a660a6 PE |
71 | /* The ubiquitous max and min macros. */ |
72 | #undef min | |
73 | #undef max | |
74 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
75 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
76 | ||
faa52174 PE |
77 | /* Number of elements in an array. */ |
78 | #define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0]) | |
01ae0fbf | 79 | |
5403b2d3 PE |
80 | /* Number of bits in a Lisp_Object tag. */ |
81 | DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS) | |
82 | #define GCTYPEBITS 3 | |
83 | DEFINE_GDB_SYMBOL_END (GCTYPEBITS) | |
84 | ||
85 | /* The number of bits needed in an EMACS_INT over and above the number | |
86 | of bits in a pointer. This is 0 on systems where: | |
87 | 1. We can specify multiple-of-8 alignment on static variables. | |
88 | 2. We know malloc returns a multiple of 8. */ | |
89 | #if (defined alignas \ | |
90 | && (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \ | |
587fd086 | 91 | || defined DARWIN_OS || defined __sun || defined __MINGW32__)) |
5403b2d3 PE |
92 | # define NONPOINTER_BITS 0 |
93 | #else | |
94 | # define NONPOINTER_BITS GCTYPEBITS | |
95 | #endif | |
96 | ||
34374650 PE |
97 | /* EMACS_INT - signed integer wide enough to hold an Emacs value |
98 | EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if | |
99 | pI - printf length modifier for EMACS_INT | |
100 | EMACS_UINT - unsigned variant of EMACS_INT */ | |
49609976 BT |
101 | |
102 | typedef scm_t_signed_bits EMACS_INT; | |
103 | typedef scm_t_bits EMACS_UINT; | |
104 | #define EMACS_INT_MAX SCM_T_SIGNED_BITS_MAX | |
105 | ||
106 | #if INTPTR_MAX == INT_MAX | |
107 | #define pI "" | |
108 | #elif INTPTR_MAX == LONG_MAX | |
109 | #define pI "l" | |
110 | #elif INTPTR_MAX == LLONG_MAX | |
111 | #define pI "ll" | |
112 | #elif INTPTR_MAX == INTMAX_MAX | |
113 | #define pI "j" | |
114 | #else | |
115 | #error "Cannot determine length modifier for EMACS_INT" | |
68c45bf0 | 116 | #endif |
34374650 | 117 | |
df5b4930 PE |
118 | /* Number of bits to put in each character in the internal representation |
119 | of bool vectors. This should not vary across implementations. */ | |
120 | enum { BOOL_VECTOR_BITS_PER_CHAR = | |
121 | #define BOOL_VECTOR_BITS_PER_CHAR 8 | |
122 | BOOL_VECTOR_BITS_PER_CHAR | |
123 | }; | |
124 | ||
87c4314d | 125 | /* An unsigned integer type representing a fixed-length bit sequence, |
9c23779a | 126 | suitable for bool vector words, GC mark bits, etc. Normally it is size_t |
df5b4930 | 127 | for speed, but it is unsigned char on weird platforms. */ |
2cf00efc | 128 | #if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT |
87c4314d | 129 | typedef size_t bits_word; |
2cf00efc | 130 | # define BITS_WORD_MAX SIZE_MAX |
df5b4930 PE |
131 | enum { BITS_PER_BITS_WORD = CHAR_BIT * sizeof (bits_word) }; |
132 | #else | |
133 | typedef unsigned char bits_word; | |
2cf00efc | 134 | # define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1) |
df5b4930 PE |
135 | enum { BITS_PER_BITS_WORD = BOOL_VECTOR_BITS_PER_CHAR }; |
136 | #endif | |
2cf00efc | 137 | verify (BITS_WORD_MAX >> (BITS_PER_BITS_WORD - 1) == 1); |
87c4314d | 138 | |
34374650 PE |
139 | /* Number of bits in some machine integer types. */ |
140 | enum | |
141 | { | |
142 | BITS_PER_CHAR = CHAR_BIT, | |
143 | BITS_PER_SHORT = CHAR_BIT * sizeof (short), | |
34374650 PE |
144 | BITS_PER_LONG = CHAR_BIT * sizeof (long int), |
145 | BITS_PER_EMACS_INT = CHAR_BIT * sizeof (EMACS_INT) | |
146 | }; | |
ce99fd65 | 147 | |
a81d11a3 PE |
148 | /* printmax_t and uprintmax_t are types for printing large integers. |
149 | These are the widest integers that are supported for printing. | |
150 | pMd etc. are conversions for printing them. | |
151 | On C99 hosts, there's no problem, as even the widest integers work. | |
152 | Fall back on EMACS_INT on pre-C99 hosts. */ | |
153 | #ifdef PRIdMAX | |
154 | typedef intmax_t printmax_t; | |
155 | typedef uintmax_t uprintmax_t; | |
156 | # define pMd PRIdMAX | |
157 | # define pMu PRIuMAX | |
158 | #else | |
159 | typedef EMACS_INT printmax_t; | |
160 | typedef EMACS_UINT uprintmax_t; | |
161 | # define pMd pI"d" | |
162 | # define pMu pI"u" | |
163 | #endif | |
164 | ||
9c4c5f81 PE |
165 | /* Use pD to format ptrdiff_t values, which suffice for indexes into |
166 | buffers and strings. Emacs never allocates objects larger than | |
167 | PTRDIFF_MAX bytes, as they cause problems with pointer subtraction. | |
168 | In C99, pD can always be "t"; configure it here for the sake of | |
169 | pre-C99 libraries such as glibc 2.0 and Solaris 8. */ | |
170 | #if PTRDIFF_MAX == INT_MAX | |
171 | # define pD "" | |
172 | #elif PTRDIFF_MAX == LONG_MAX | |
173 | # define pD "l" | |
174 | #elif PTRDIFF_MAX == LLONG_MAX | |
175 | # define pD "ll" | |
176 | #else | |
177 | # define pD "t" | |
178 | #endif | |
179 | ||
e0b8c689 | 180 | /* Extra internal type checking? */ |
c6129d7e | 181 | |
b9ff995e PE |
182 | /* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s |
183 | 'assume (COND)'. COND should be free of side effects, as it may or | |
184 | may not be evaluated. | |
185 | ||
186 | 'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is | |
187 | defined and suppress_checking is false, and does nothing otherwise. | |
188 | Emacs dies if COND is checked and is false. The suppress_checking | |
189 | variable is initialized to 0 in alloc.c. Set it to 1 using a | |
190 | debugger to temporarily disable aborting on detected internal | |
191 | inconsistencies or error conditions. | |
192 | ||
193 | In some cases, a good compiler may be able to optimize away the | |
194 | eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x) | |
195 | uses eassert to test STRINGP (x), but a particular use of XSTRING | |
196 | is invoked only after testing that STRINGP (x) is true, making the | |
197 | test redundant. | |
198 | ||
199 | eassume is like eassert except that it also causes the compiler to | |
200 | assume that COND is true afterwards, regardless of whether runtime | |
201 | checking is enabled. This can improve performance in some cases, | |
202 | though it can degrade performance in others. It's often suboptimal | |
203 | for COND to call external functions or access volatile storage. */ | |
204 | ||
310fbfa8 | 205 | #ifndef ENABLE_CHECKING |
96c06863 | 206 | # define eassert(cond) ((void) (false && (cond))) /* Check COND compiles. */ |
b9ff995e | 207 | # define eassume(cond) assume (cond) |
310fbfa8 | 208 | #else /* ENABLE_CHECKING */ |
c6129d7e | 209 | |
845ca893 | 210 | extern _Noreturn void die (const char *, const char *, int); |
244ed907 | 211 | |
fce31d69 | 212 | extern bool suppress_checking EXTERNALLY_VISIBLE; |
244ed907 | 213 | |
310fbfa8 | 214 | # define eassert(cond) \ |
5013fc08 | 215 | (suppress_checking || (cond) \ |
0d5d3029 | 216 | ? (void) 0 \ |
5013fc08 | 217 | : die (# cond, __FILE__, __LINE__)) |
b9ff995e PE |
218 | # define eassume(cond) \ |
219 | (suppress_checking \ | |
220 | ? assume (cond) \ | |
221 | : (cond) \ | |
222 | ? (void) 0 \ | |
223 | : die (# cond, __FILE__, __LINE__)) | |
3694b4ab | 224 | #endif /* ENABLE_CHECKING */ |
3e0b94e7 | 225 | |
b9466edb | 226 | \f |
4706125e PE |
227 | enum Lisp_Bits |
228 | { | |
b6b3b294 PE |
229 | /* 2**GCTYPEBITS. This must be a macro that expands to a literal |
230 | integer constant, for MSVC. */ | |
e32a5799 | 231 | #define GCALIGNMENT 8 |
e32a5799 | 232 | |
4706125e | 233 | /* Number of bits in a Lisp fixnum value, not counting the tag. */ |
49609976 | 234 | FIXNUM_BITS = SCM_I_FIXNUM_BIT |
4706125e | 235 | }; |
34374650 | 236 | |
e32a5799 PE |
237 | #if GCALIGNMENT != 1 << GCTYPEBITS |
238 | # error "GCALIGNMENT and GCTYPEBITS are inconsistent" | |
239 | #endif | |
240 | ||
5403b2d3 | 241 | DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG) |
ee52e81d | 242 | #define USE_LSB_TAG 1 |
5403b2d3 PE |
243 | DEFINE_GDB_SYMBOL_END (USE_LSB_TAG) |
244 | ||
e32a5799 PE |
245 | #ifndef alignas |
246 | # define alignas(alignment) /* empty */ | |
bfe3e0a2 | 247 | # if USE_LSB_TAG |
e32a5799 | 248 | # error "USE_LSB_TAG requires alignas" |
b9466edb | 249 | # endif |
b9466edb SM |
250 | #endif |
251 | ||
84575e67 PE |
252 | /* Some operations are so commonly executed that they are implemented |
253 | as macros, not functions, because otherwise runtime performance would | |
254 | suffer too much when compiling with GCC without optimization. | |
255 | There's no need to inline everything, just the operations that | |
256 | would otherwise cause a serious performance problem. | |
257 | ||
258 | For each such operation OP, define a macro lisp_h_OP that contains | |
5ebb1ee6 | 259 | the operation's implementation. That way, OP can be implemented |
84575e67 PE |
260 | via a macro definition like this: |
261 | ||
262 | #define OP(x) lisp_h_OP (x) | |
263 | ||
264 | and/or via a function definition like this: | |
265 | ||
266 | LISP_MACRO_DEFUN (OP, Lisp_Object, (Lisp_Object x), (x)) | |
267 | ||
268 | which macro-expands to this: | |
269 | ||
270 | Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); } | |
271 | ||
272 | without worrying about the implementations diverging, since | |
273 | lisp_h_OP defines the actual implementation. The lisp_h_OP macros | |
274 | are intended to be private to this include file, and should not be | |
275 | used elsewhere. | |
276 | ||
277 | FIXME: Remove the lisp_h_OP macros, and define just the inline OP | |
278 | functions, once most developers have access to GCC 4.8 or later and | |
279 | can use "gcc -Og" to debug. Maybe in the year 2016. See | |
280 | Bug#11935. | |
281 | ||
282 | Commentary for these macros can be found near their corresponding | |
283 | functions, below. */ | |
284 | ||
49609976 BT |
285 | #define SMOB_PTR(a) ((void *) SCM_SMOB_DATA (a)) |
286 | #define SMOB_TYPEP(x, tag) (x && SCM_SMOB_PREDICATE (tag, x)) | |
287 | #define lisp_h_XLI(o) (SCM_UNPACK (o)) | |
288 | #define lisp_h_XIL(i) (SCM_PACK (i)) | |
84575e67 PE |
289 | #define lisp_h_CHECK_LIST_CONS(x, y) CHECK_TYPE (CONSP (x), Qlistp, y) |
290 | #define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x) | |
291 | #define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x) | |
40f5d4b7 PE |
292 | #define lisp_h_CHECK_TYPE(ok, predicate, x) \ |
293 | ((ok) ? (void) 0 : (void) wrong_type_argument (predicate, x)) | |
49609976 BT |
294 | #define lisp_h_CONSP(x) (SMOB_TYPEP (x, lisp_cons_tag)) |
295 | #define lisp_h_EQ(x, y) (scm_is_eq (x, y)) | |
296 | #define lisp_h_FLOATP(x) (SMOB_TYPEP (x, lisp_float_tag)) | |
297 | #define lisp_h_INTEGERP(x) (SCM_I_INUMP (x)) | |
84575e67 | 298 | #define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker) |
49609976 | 299 | #define lisp_h_MISCP(x) (SMOB_TYPEP (x, lisp_misc_tag)) |
84575e67 PE |
300 | #define lisp_h_NILP(x) EQ (x, Qnil) |
301 | #define lisp_h_SET_SYMBOL_VAL(sym, v) \ | |
302 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v)) | |
303 | #define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->constant) | |
304 | #define lisp_h_SYMBOL_VAL(sym) \ | |
305 | (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value) | |
49609976 BT |
306 | #define lisp_h_SYMBOLP(x) (SMOB_TYPEP (x, lisp_symbol_tag)) |
307 | #define lisp_h_VECTORLIKEP(x) (SMOB_TYPEP (x, lisp_vectorlike_tag)) | |
84575e67 | 308 | #define lisp_h_XCAR(c) XCONS (c)->car |
a6b3ad10 | 309 | #define lisp_h_XCDR(c) XCONS (c)->cdr |
49609976 | 310 | #define lisp_h_XHASH(a) (SCM_UNPACK (a)) |
84575e67 | 311 | #define lisp_h_XSYMBOL(a) \ |
49609976 | 312 | (eassert (SYMBOLP (a)), (struct Lisp_Symbol *) SMOB_PTR (a)) |
84575e67 PE |
313 | |
314 | /* When compiling via gcc -O0, define the key operations as macros, as | |
315 | Emacs is too slow otherwise. To disable this optimization, compile | |
96c06863 | 316 | with -DINLINING=false. */ |
9c53af1f | 317 | #if 0 |
84575e67 PE |
318 | #if (defined __NO_INLINE__ \ |
319 | && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \ | |
320 | && ! (defined INLINING && ! INLINING)) | |
321 | # define XLI(o) lisp_h_XLI (o) | |
322 | # define XIL(i) lisp_h_XIL (i) | |
323 | # define CHECK_LIST_CONS(x, y) lisp_h_CHECK_LIST_CONS (x, y) | |
324 | # define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x) | |
325 | # define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x) | |
40f5d4b7 | 326 | # define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x) |
84575e67 PE |
327 | # define CONSP(x) lisp_h_CONSP (x) |
328 | # define EQ(x, y) lisp_h_EQ (x, y) | |
329 | # define FLOATP(x) lisp_h_FLOATP (x) | |
330 | # define INTEGERP(x) lisp_h_INTEGERP (x) | |
331 | # define MARKERP(x) lisp_h_MARKERP (x) | |
332 | # define MISCP(x) lisp_h_MISCP (x) | |
333 | # define NILP(x) lisp_h_NILP (x) | |
334 | # define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v) | |
335 | # define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym) | |
336 | # define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym) | |
337 | # define SYMBOLP(x) lisp_h_SYMBOLP (x) | |
338 | # define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x) | |
339 | # define XCAR(c) lisp_h_XCAR (c) | |
340 | # define XCDR(c) lisp_h_XCDR (c) | |
341 | # define XCONS(a) lisp_h_XCONS (a) | |
342 | # define XHASH(a) lisp_h_XHASH (a) | |
84575e67 | 343 | # define XSYMBOL(a) lisp_h_XSYMBOL (a) |
84575e67 | 344 | #endif |
9c53af1f | 345 | #endif |
84575e67 PE |
346 | |
347 | /* Define NAME as a lisp.h inline function that returns TYPE and has | |
348 | arguments declared as ARGDECLS and passed as ARGS. ARGDECLS and | |
349 | ARGS should be parenthesized. Implement the function by calling | |
350 | lisp_h_NAME ARGS. */ | |
351 | #define LISP_MACRO_DEFUN(name, type, argdecls, args) \ | |
00382e8b | 352 | INLINE type (name) argdecls { return lisp_h_##name args; } |
84575e67 PE |
353 | |
354 | /* like LISP_MACRO_DEFUN, except NAME returns void. */ | |
355 | #define LISP_MACRO_DEFUN_VOID(name, argdecls, args) \ | |
00382e8b | 356 | INLINE void (name) argdecls { lisp_h_##name args; } |
84575e67 PE |
357 | |
358 | ||
99a3d506 | 359 | /* Define the fundamental Lisp data structures. */ |
3cfe6dfd | 360 | |
c95a4266 EZ |
361 | /* This is the set of Lisp data types. If you want to define a new |
362 | data type, read the comments after Lisp_Fwd_Type definition | |
363 | below. */ | |
3cfe6dfd | 364 | |
49609976 BT |
365 | #define INTMASK SCM_MOST_POSITIVE_FIXNUM |
366 | #define case_Lisp_Int case Lisp_Int | |
2de9f71c | 367 | |
29abe551 | 368 | /* Idea stolen from GDB. Pedantic GCC complains about enum bitfields, |
91f2d272 PE |
369 | MSVC doesn't support them, and xlc and Oracle Studio c99 complain |
370 | vociferously about them. */ | |
371 | #if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \ | |
372 | || (defined __SUNPRO_C && __STDC__)) | |
a6fc3b5c EZ |
373 | #define ENUM_BF(TYPE) unsigned int |
374 | #else | |
375 | #define ENUM_BF(TYPE) enum TYPE | |
376 | #endif | |
377 | ||
49609976 BT |
378 | scm_t_bits lisp_symbol_tag; |
379 | scm_t_bits lisp_misc_tag; | |
380 | scm_t_bits lisp_string_tag; | |
381 | scm_t_bits lisp_vectorlike_tag; | |
382 | scm_t_bits lisp_cons_tag; | |
383 | scm_t_bits lisp_float_tag; | |
a6fc3b5c | 384 | |
3cfe6dfd JB |
385 | enum Lisp_Type |
386 | { | |
99a3d506 | 387 | /* Integer. XINT (obj) is the integer value. */ |
49609976 | 388 | Lisp_Int, |
3cfe6dfd | 389 | |
99a3d506 | 390 | /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */ |
49609976 | 391 | Lisp_Symbol, |
3cfe6dfd | 392 | |
84d1833e KH |
393 | /* Miscellaneous. XMISC (object) points to a union Lisp_Misc, |
394 | whose first member indicates the subtype. */ | |
49609976 | 395 | Lisp_Misc, |
3cfe6dfd JB |
396 | |
397 | /* String. XSTRING (object) points to a struct Lisp_String. | |
99a3d506 | 398 | The length of the string, and its contents, are stored therein. */ |
49609976 | 399 | Lisp_String, |
3cfe6dfd | 400 | |
b5088f80 | 401 | /* Vector of Lisp objects, or something resembling it. |
7c06ac2b | 402 | XVECTOR (object) points to a struct Lisp_Vector, which contains |
b5088f80 KH |
403 | the size and contents. The size field also contains the type |
404 | information, if it's not a real vector object. */ | |
49609976 | 405 | Lisp_Vectorlike, |
3cfe6dfd | 406 | |
99a3d506 | 407 | /* Cons. XCONS (object) points to a struct Lisp_Cons. */ |
49609976 | 408 | Lisp_Cons, |
4d1207f6 | 409 | |
49609976 | 410 | Lisp_Float |
3cfe6dfd JB |
411 | }; |
412 | ||
a32fa736 | 413 | /* This is the set of data types that share a common structure. |
c98adc1b KH |
414 | The first member of the structure is a type code from this set. |
415 | The enum values are arbitrary, but we'll use large numbers to make it | |
416 | more likely that we'll spot the error if a random word in memory is | |
417 | mistakenly interpreted as a Lisp_Misc. */ | |
1c4ca5a3 KH |
418 | enum Lisp_Misc_Type |
419 | { | |
c98adc1b | 420 | Lisp_Misc_Free = 0x5eab, |
84d1833e | 421 | Lisp_Misc_Marker, |
99a3d506 | 422 | Lisp_Misc_Overlay, |
222151aa | 423 | Lisp_Misc_Save_Value, |
99a3d506 RS |
424 | /* Currently floats are not a misc type, |
425 | but let's define this in case we want to change that. */ | |
426 | Lisp_Misc_Float, | |
427 | /* This is not a type code. It is for range checking. */ | |
428 | Lisp_Misc_Limit | |
1c4ca5a3 KH |
429 | }; |
430 | ||
ce5b453a SM |
431 | /* These are the types of forwarding objects used in the value slot |
432 | of symbols for special built-in variables whose value is stored in | |
433 | C variables. */ | |
434 | enum Lisp_Fwd_Type | |
435 | { | |
436 | Lisp_Fwd_Int, /* Fwd to a C `int' variable. */ | |
437 | Lisp_Fwd_Bool, /* Fwd to a C boolean var. */ | |
438 | Lisp_Fwd_Obj, /* Fwd to a C Lisp_Object variable. */ | |
439 | Lisp_Fwd_Buffer_Obj, /* Fwd to a Lisp_Object field of buffers. */ | |
29abe551 | 440 | Lisp_Fwd_Kboard_Obj /* Fwd to a Lisp_Object field of kboards. */ |
ce5b453a SM |
441 | }; |
442 | ||
49609976 BT |
443 | typedef SCM Lisp_Object; |
444 | ||
445 | #define LISP_INITIALLY_ZERO SCM_INUM0 | |
3cfe6dfd | 446 | |
84575e67 PE |
447 | /* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa. |
448 | At the machine level, these operations are no-ops. */ | |
449 | LISP_MACRO_DEFUN (XLI, EMACS_INT, (Lisp_Object o), (o)) | |
450 | LISP_MACRO_DEFUN (XIL, Lisp_Object, (EMACS_INT i), (i)) | |
451 | ||
b5088f80 KH |
452 | /* In the size word of a struct Lisp_Vector, this bit means it's really |
453 | some other vector-like object. */ | |
bba89481 PE |
454 | #define PSEUDOVECTOR_FLAG_val (PTRDIFF_MAX - PTRDIFF_MAX / 2) |
455 | #if ENUMABLE (PSEUDOVECTOR_FLAG_val) | |
456 | DEFINE_GDB_SYMBOL_ENUM (PSEUDOVECTOR_FLAG) | |
457 | #else | |
bb9937df | 458 | DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG) |
bba89481 | 459 | # define PSEUDOVECTOR_FLAG PSEUDOVECTOR_FLAG_val |
bb9937df | 460 | DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG) |
bba89481 | 461 | #endif |
b5088f80 | 462 | |
303a5c93 | 463 | /* In a pseudovector, the size field actually contains a word with one |
6aea7528 DA |
464 | PSEUDOVECTOR_FLAG bit set, and one of the following values extracted |
465 | with PVEC_TYPE_MASK to indicate the actual type. */ | |
99a3d506 RS |
466 | enum pvec_type |
467 | { | |
6aea7528 | 468 | PVEC_NORMAL_VECTOR, |
ee28be33 SM |
469 | PVEC_FREE, |
470 | PVEC_PROCESS, | |
471 | PVEC_FRAME, | |
472 | PVEC_WINDOW, | |
473 | PVEC_BOOL_VECTOR, | |
474 | PVEC_BUFFER, | |
475 | PVEC_HASH_TABLE, | |
476 | PVEC_TERMINAL, | |
477 | PVEC_WINDOW_CONFIGURATION, | |
478 | PVEC_SUBR, | |
479 | PVEC_OTHER, | |
914adc42 DA |
480 | /* These should be last, check internal_equal to see why. */ |
481 | PVEC_COMPILED, | |
482 | PVEC_CHAR_TABLE, | |
483 | PVEC_SUB_CHAR_TABLE, | |
484 | PVEC_FONT /* Should be last because it's used for range checking. */ | |
99a3d506 | 485 | }; |
b5088f80 | 486 | |
4706125e | 487 | enum More_Lisp_Bits |
1781b9e9 | 488 | { |
4706125e PE |
489 | /* For convenience, we also store the number of elements in these bits. |
490 | Note that this size is not necessarily the memory-footprint size, but | |
491 | only the number of Lisp_Object fields (that need to be traced by GC). | |
492 | The distinction is used, e.g., by Lisp_Process, which places extra | |
493 | non-Lisp_Object fields at the end of the structure. */ | |
914adc42 | 494 | PSEUDOVECTOR_SIZE_BITS = 12, |
1781b9e9 | 495 | PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1, |
914adc42 DA |
496 | |
497 | /* To calculate the memory footprint of the pseudovector, it's useful | |
498 | to store the size of non-Lisp area in word_size units here. */ | |
499 | PSEUDOVECTOR_REST_BITS = 12, | |
04a2d0d3 | 500 | PSEUDOVECTOR_REST_MASK = (((1 << PSEUDOVECTOR_REST_BITS) - 1) |
914adc42 DA |
501 | << PSEUDOVECTOR_SIZE_BITS), |
502 | ||
503 | /* Used to extract pseudovector subtype information. */ | |
504 | PSEUDOVECTOR_AREA_BITS = PSEUDOVECTOR_SIZE_BITS + PSEUDOVECTOR_REST_BITS, | |
56a0e352 | 505 | PVEC_TYPE_MASK = 0x3f << PSEUDOVECTOR_AREA_BITS |
4706125e | 506 | }; |
3cfe6dfd | 507 | \f |
84575e67 | 508 | /* These functions extract various sorts of values from a Lisp_Object. |
bb9937df PE |
509 | For example, if tem is a Lisp_Object whose type is Lisp_Cons, |
510 | XCONS (tem) is the struct Lisp_Cons * pointing to the memory for | |
511 | that cons. */ | |
3cfe6dfd | 512 | |
84575e67 PE |
513 | /* Largest and smallest representable fixnum values. These are the C |
514 | values. They are macros for use in static initializers. */ | |
49609976 BT |
515 | #define MOST_POSITIVE_FIXNUM SCM_MOST_POSITIVE_FIXNUM |
516 | #define MOST_NEGATIVE_FIXNUM SCM_MOST_NEGATIVE_FIXNUM | |
3cfe6dfd | 517 | |
84575e67 PE |
518 | /* Make a Lisp integer representing the value of the low order |
519 | bits of N. */ | |
00382e8b | 520 | INLINE Lisp_Object |
84575e67 PE |
521 | make_number (EMACS_INT n) |
522 | { | |
49609976 | 523 | return SCM_I_MAKINUM (n); |
84575e67 | 524 | } |
3cfe6dfd | 525 | |
84575e67 | 526 | /* Extract A's value as a signed integer. */ |
00382e8b | 527 | INLINE EMACS_INT |
84575e67 PE |
528 | XINT (Lisp_Object a) |
529 | { | |
49609976 | 530 | return SCM_I_INUM (a); |
84575e67 | 531 | } |
3cfe6dfd | 532 | |
84575e67 PE |
533 | /* Like XINT (A), but may be faster. A must be nonnegative. |
534 | If ! USE_LSB_TAG, this takes advantage of the fact that Lisp | |
535 | integers have zero-bits in their tags. */ | |
00382e8b | 536 | INLINE EMACS_INT |
84575e67 PE |
537 | XFASTINT (Lisp_Object a) |
538 | { | |
49609976 | 539 | EMACS_INT n = XINT (a); |
84575e67 PE |
540 | eassert (0 <= n); |
541 | return n; | |
542 | } | |
b7acde90 | 543 | |
84575e67 | 544 | /* Extract A's value as an unsigned integer. */ |
00382e8b | 545 | INLINE EMACS_UINT |
84575e67 PE |
546 | XUINT (Lisp_Object a) |
547 | { | |
49609976 | 548 | return SCM_I_INUM (a); |
84575e67 | 549 | } |
b349d111 | 550 | |
84575e67 PE |
551 | /* Return A's (Lisp-integer sized) hash. Happens to be like XUINT |
552 | right now, but XUINT should only be applied to objects we know are | |
553 | integers. */ | |
554 | LISP_MACRO_DEFUN (XHASH, EMACS_INT, (Lisp_Object a), (a)) | |
b263a6b0 | 555 | |
84575e67 | 556 | /* Like make_number (N), but may be faster. N must be in nonnegative range. */ |
00382e8b | 557 | INLINE Lisp_Object |
84575e67 PE |
558 | make_natnum (EMACS_INT n) |
559 | { | |
560 | eassert (0 <= n && n <= MOST_POSITIVE_FIXNUM); | |
49609976 | 561 | return make_number (n); |
84575e67 | 562 | } |
b9466edb | 563 | |
84575e67 PE |
564 | /* Return true if X and Y are the same object. */ |
565 | LISP_MACRO_DEFUN (EQ, bool, (Lisp_Object x, Lisp_Object y), (x, y)) | |
0de4bb68 | 566 | |
96c06863 | 567 | /* Value is true if I doesn't fit into a Lisp fixnum. It is |
987c9327 | 568 | written this way so that it also works if I is of unsigned |
2e6578fb | 569 | type or if I is a NaN. */ |
dc8e8b07 GM |
570 | |
571 | #define FIXNUM_OVERFLOW_P(i) \ | |
7216e43b | 572 | (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM)) |
dc8e8b07 | 573 | |
00382e8b | 574 | INLINE ptrdiff_t |
d311d28c PE |
575 | clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper) |
576 | { | |
577 | return num < lower ? lower : num <= upper ? num : upper; | |
578 | } | |
84575e67 PE |
579 | \f |
580 | /* Forward declarations. */ | |
581 | ||
582 | /* Defined in this file. */ | |
583 | union Lisp_Fwd; | |
00382e8b PE |
584 | INLINE bool BOOL_VECTOR_P (Lisp_Object); |
585 | INLINE bool BUFFER_OBJFWDP (union Lisp_Fwd *); | |
586 | INLINE bool BUFFERP (Lisp_Object); | |
587 | INLINE bool CHAR_TABLE_P (Lisp_Object); | |
588 | INLINE Lisp_Object CHAR_TABLE_REF_ASCII (Lisp_Object, ptrdiff_t); | |
589 | INLINE bool (CONSP) (Lisp_Object); | |
590 | INLINE bool (FLOATP) (Lisp_Object); | |
591 | INLINE bool functionp (Lisp_Object); | |
592 | INLINE bool (INTEGERP) (Lisp_Object); | |
593 | INLINE bool (MARKERP) (Lisp_Object); | |
594 | INLINE bool (MISCP) (Lisp_Object); | |
595 | INLINE bool (NILP) (Lisp_Object); | |
596 | INLINE bool OVERLAYP (Lisp_Object); | |
597 | INLINE bool PROCESSP (Lisp_Object); | |
598 | INLINE bool PSEUDOVECTORP (Lisp_Object, int); | |
599 | INLINE bool SAVE_VALUEP (Lisp_Object); | |
600 | INLINE void set_sub_char_table_contents (Lisp_Object, ptrdiff_t, | |
84575e67 | 601 | Lisp_Object); |
00382e8b PE |
602 | INLINE bool STRINGP (Lisp_Object); |
603 | INLINE bool SUB_CHAR_TABLE_P (Lisp_Object); | |
604 | INLINE bool SUBRP (Lisp_Object); | |
605 | INLINE bool (SYMBOLP) (Lisp_Object); | |
606 | INLINE bool (VECTORLIKEP) (Lisp_Object); | |
607 | INLINE bool WINDOWP (Lisp_Object); | |
608 | INLINE struct Lisp_Save_Value *XSAVE_VALUE (Lisp_Object); | |
d311d28c | 609 | |
84575e67 PE |
610 | /* Defined in chartab.c. */ |
611 | extern Lisp_Object char_table_ref (Lisp_Object, int); | |
612 | extern void char_table_set (Lisp_Object, int, Lisp_Object); | |
613 | extern int char_table_translate (Lisp_Object, int); | |
614 | ||
615 | /* Defined in data.c. */ | |
616 | extern Lisp_Object Qarrayp, Qbufferp, Qbuffer_or_string_p, Qchar_table_p; | |
617 | extern Lisp_Object Qconsp, Qfloatp, Qintegerp, Qlambda, Qlistp, Qmarkerp, Qnil; | |
2f1205e0 | 618 | extern Lisp_Object Qnumberp, Qstringp, Qsymbolp, Qt, Qvectorp; |
3e0b94e7 | 619 | extern Lisp_Object Qbool_vector_p; |
84575e67 | 620 | extern Lisp_Object Qvector_or_char_table_p, Qwholenump; |
8f3a2c26 | 621 | extern Lisp_Object Qwindow; |
84575e67 PE |
622 | extern _Noreturn Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object); |
623 | ||
624 | /* Defined in emacs.c. */ | |
f58269c4 | 625 | extern bool might_dump; |
73bfe891 PE |
626 | /* True means Emacs has already been initialized. |
627 | Used during startup to detect startup of dumped Emacs. */ | |
628 | extern bool initialized; | |
84575e67 PE |
629 | |
630 | /* Defined in eval.c. */ | |
631 | extern Lisp_Object Qautoload; | |
632 | ||
633 | /* Defined in floatfns.c. */ | |
634 | extern double extract_float (Lisp_Object); | |
635 | ||
636 | /* Defined in process.c. */ | |
637 | extern Lisp_Object Qprocessp; | |
638 | ||
639 | /* Defined in window.c. */ | |
640 | extern Lisp_Object Qwindowp; | |
641 | ||
642 | /* Defined in xdisp.c. */ | |
643 | extern Lisp_Object Qimage; | |
7b1123d8 | 644 | \f |
49609976 BT |
645 | /* Extract A's type. */ |
646 | INLINE enum Lisp_Type | |
647 | XTYPE (Lisp_Object o) | |
648 | { | |
649 | if (INTEGERP (o)) | |
650 | return Lisp_Int; | |
651 | else if (SYMBOLP (o)) | |
652 | return Lisp_Symbol; | |
653 | else if (MISCP (o)) | |
654 | return Lisp_Misc; | |
655 | else if (STRINGP (o)) | |
656 | return Lisp_String; | |
657 | else if (VECTORLIKEP (o)) | |
658 | return Lisp_Vectorlike; | |
659 | else if (CONSP (o)) | |
660 | return Lisp_Cons; | |
661 | else if (FLOATP (o)) | |
662 | return Lisp_Float; | |
663 | else | |
664 | abort (); | |
665 | } | |
84575e67 | 666 | |
99a3d506 | 667 | /* Extract a value or address from a Lisp_Object. */ |
3cfe6dfd | 668 | |
49609976 BT |
669 | INLINE struct Lisp_Cons * |
670 | XCONS (Lisp_Object a) | |
671 | { | |
672 | eassert (CONSP (a)); | |
673 | return SMOB_PTR (a); | |
674 | } | |
7c06ac2b | 675 | |
00382e8b | 676 | INLINE struct Lisp_Vector * |
84575e67 PE |
677 | XVECTOR (Lisp_Object a) |
678 | { | |
679 | eassert (VECTORLIKEP (a)); | |
49609976 | 680 | return SMOB_PTR (a); |
84575e67 | 681 | } |
c9f6631c | 682 | |
00382e8b | 683 | INLINE struct Lisp_String * |
84575e67 PE |
684 | XSTRING (Lisp_Object a) |
685 | { | |
686 | eassert (STRINGP (a)); | |
49609976 | 687 | return SMOB_PTR (a); |
84575e67 | 688 | } |
ce5b453a | 689 | |
84575e67 | 690 | LISP_MACRO_DEFUN (XSYMBOL, struct Lisp_Symbol *, (Lisp_Object a), (a)) |
ce5b453a | 691 | |
00382e8b | 692 | INLINE struct Lisp_Float * |
84575e67 PE |
693 | XFLOAT (Lisp_Object a) |
694 | { | |
695 | eassert (FLOATP (a)); | |
49609976 | 696 | return SMOB_PTR (a); |
84575e67 | 697 | } |
3cfe6dfd | 698 | |
7c06ac2b | 699 | /* Pseudovector types. */ |
84575e67 | 700 | |
00382e8b | 701 | INLINE struct Lisp_Process * |
84575e67 PE |
702 | XPROCESS (Lisp_Object a) |
703 | { | |
704 | eassert (PROCESSP (a)); | |
49609976 | 705 | return SMOB_PTR (a); |
84575e67 PE |
706 | } |
707 | ||
00382e8b | 708 | INLINE struct window * |
84575e67 PE |
709 | XWINDOW (Lisp_Object a) |
710 | { | |
711 | eassert (WINDOWP (a)); | |
49609976 | 712 | return SMOB_PTR (a); |
84575e67 PE |
713 | } |
714 | ||
00382e8b | 715 | INLINE struct terminal * |
84575e67 PE |
716 | XTERMINAL (Lisp_Object a) |
717 | { | |
49609976 | 718 | return SMOB_PTR (a); |
84575e67 PE |
719 | } |
720 | ||
00382e8b | 721 | INLINE struct Lisp_Subr * |
84575e67 PE |
722 | XSUBR (Lisp_Object a) |
723 | { | |
724 | eassert (SUBRP (a)); | |
49609976 | 725 | return SMOB_PTR (a); |
84575e67 PE |
726 | } |
727 | ||
00382e8b | 728 | INLINE struct buffer * |
84575e67 PE |
729 | XBUFFER (Lisp_Object a) |
730 | { | |
731 | eassert (BUFFERP (a)); | |
49609976 | 732 | return SMOB_PTR (a); |
84575e67 PE |
733 | } |
734 | ||
00382e8b | 735 | INLINE struct Lisp_Char_Table * |
84575e67 PE |
736 | XCHAR_TABLE (Lisp_Object a) |
737 | { | |
738 | eassert (CHAR_TABLE_P (a)); | |
49609976 | 739 | return SMOB_PTR (a); |
84575e67 PE |
740 | } |
741 | ||
00382e8b | 742 | INLINE struct Lisp_Sub_Char_Table * |
84575e67 PE |
743 | XSUB_CHAR_TABLE (Lisp_Object a) |
744 | { | |
745 | eassert (SUB_CHAR_TABLE_P (a)); | |
49609976 | 746 | return SMOB_PTR (a); |
84575e67 PE |
747 | } |
748 | ||
00382e8b | 749 | INLINE struct Lisp_Bool_Vector * |
84575e67 PE |
750 | XBOOL_VECTOR (Lisp_Object a) |
751 | { | |
752 | eassert (BOOL_VECTOR_P (a)); | |
49609976 | 753 | return SMOB_PTR (a); |
84575e67 PE |
754 | } |
755 | ||
00382e8b | 756 | INLINE Lisp_Object |
84575e67 PE |
757 | make_lisp_proc (struct Lisp_Process *p) |
758 | { | |
49609976 | 759 | return scm_new_smob (lisp_vectorlike_tag, (scm_t_bits) p); |
84575e67 PE |
760 | } |
761 | ||
ff55dfe8 | 762 | #define XSETINT(a, b) ((a) = make_number (b)) |
84575e67 | 763 | #define XSETFASTINT(a, b) ((a) = make_natnum (b)) |
49609976 BT |
764 | #define XSETCONS(a, b) ((a) = (b)->self) |
765 | #define XSETVECTOR(a, b) ((a) = (b)->header.self) | |
766 | #define XSETSTRING(a, b) ((a) = (b)->self) | |
767 | #define XSETSYMBOL(a, b) ((a) = (b)->self) | |
768 | #define XSETFLOAT(a, b) ((a) = (b)->self) | |
769 | #define XSETMISC(a, b) (a) = ((union Lisp_Misc *) (b))->u_any.self | |
7c06ac2b RS |
770 | |
771 | /* Pseudovector types. */ | |
c9f6631c | 772 | |
914adc42 DA |
773 | #define XSETPVECTYPE(v, code) \ |
774 | ((v)->header.size |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_AREA_BITS)) | |
775 | #define XSETPVECTYPESIZE(v, code, lispsize, restsize) \ | |
ee28be33 | 776 | ((v)->header.size = (PSEUDOVECTOR_FLAG \ |
914adc42 DA |
777 | | ((code) << PSEUDOVECTOR_AREA_BITS) \ |
778 | | ((restsize) << PSEUDOVECTOR_SIZE_BITS) \ | |
779 | | (lispsize))) | |
aa0b0087 PE |
780 | |
781 | /* The cast to struct vectorlike_header * avoids aliasing issues. */ | |
7c06ac2b | 782 | #define XSETPSEUDOVECTOR(a, b, code) \ |
7555c33f SM |
783 | XSETTYPED_PSEUDOVECTOR (a, b, \ |
784 | (((struct vectorlike_header *) \ | |
49609976 | 785 | SCM_SMOB_DATA (a)) \ |
7555c33f SM |
786 | ->size), \ |
787 | code) | |
eab3844f | 788 | #define XSETTYPED_PSEUDOVECTOR(a, b, size, code) \ |
beb9f745 | 789 | (XSETVECTOR (a, b), \ |
eab3844f | 790 | eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \ |
914adc42 | 791 | == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS)))) |
aa0b0087 | 792 | |
7c06ac2b RS |
793 | #define XSETWINDOW_CONFIGURATION(a, b) \ |
794 | (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION)) | |
795 | #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS)) | |
796 | #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW)) | |
49e49fb5 | 797 | #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL)) |
914adc42 | 798 | #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR)) |
7c06ac2b | 799 | #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED)) |
99a3d506 | 800 | #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER)) |
608ff985 RS |
801 | #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE)) |
802 | #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR)) | |
1842abb2 | 803 | #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE)) |
c9f6631c | 804 | |
c8a39089 KS |
805 | /* Type checking. */ |
806 | ||
40f5d4b7 PE |
807 | LISP_MACRO_DEFUN_VOID (CHECK_TYPE, |
808 | (int ok, Lisp_Object predicate, Lisp_Object x), | |
809 | (ok, predicate, x)) | |
c8a39089 | 810 | |
c644523b | 811 | /* Deprecated and will be removed soon. */ |
e34f7f79 DA |
812 | |
813 | #define INTERNAL_FIELD(field) field ## _ | |
c8a39089 | 814 | |
5f6bf5fe | 815 | /* See the macros in intervals.h. */ |
e221eae3 JA |
816 | |
817 | typedef struct interval *INTERVAL; | |
818 | ||
3cfe6dfd JB |
819 | struct Lisp_Cons |
820 | { | |
49609976 BT |
821 | Lisp_Object self; |
822 | ||
d8a05828 | 823 | /* Car of this cons cell. */ |
c644523b | 824 | Lisp_Object car; |
d8a05828 | 825 | |
a6b3ad10 BT |
826 | /* Cdr of this cons cell. */ |
827 | Lisp_Object cdr; | |
3cfe6dfd JB |
828 | }; |
829 | ||
b7acde90 | 830 | /* Take the car or cdr of something known to be a cons cell. */ |
84575e67 | 831 | /* The _addr functions shouldn't be used outside of the minimal set |
f3fbd155 KR |
832 | of code that has to know what a cons cell looks like. Other code not |
833 | part of the basic lisp implementation should assume that the car and cdr | |
84575e67 | 834 | fields are not accessible. (What if we want to switch to |
f3fbd155 KR |
835 | a copying collector someday? Cached cons cell field addresses may be |
836 | invalidated at arbitrary points.) */ | |
00382e8b | 837 | INLINE Lisp_Object * |
84575e67 PE |
838 | xcar_addr (Lisp_Object c) |
839 | { | |
840 | return &XCONS (c)->car; | |
841 | } | |
00382e8b | 842 | INLINE Lisp_Object * |
84575e67 PE |
843 | xcdr_addr (Lisp_Object c) |
844 | { | |
a6b3ad10 | 845 | return &XCONS (c)->cdr; |
84575e67 | 846 | } |
b7acde90 | 847 | |
f3fbd155 | 848 | /* Use these from normal code. */ |
84575e67 PE |
849 | LISP_MACRO_DEFUN (XCAR, Lisp_Object, (Lisp_Object c), (c)) |
850 | LISP_MACRO_DEFUN (XCDR, Lisp_Object, (Lisp_Object c), (c)) | |
f3fbd155 KR |
851 | |
852 | /* Use these to set the fields of a cons cell. | |
853 | ||
854 | Note that both arguments may refer to the same object, so 'n' | |
84575e67 | 855 | should not be read after 'c' is first modified. */ |
00382e8b | 856 | INLINE void |
84575e67 PE |
857 | XSETCAR (Lisp_Object c, Lisp_Object n) |
858 | { | |
859 | *xcar_addr (c) = n; | |
860 | } | |
00382e8b | 861 | INLINE void |
84575e67 PE |
862 | XSETCDR (Lisp_Object c, Lisp_Object n) |
863 | { | |
864 | *xcdr_addr (c) = n; | |
865 | } | |
f3fbd155 | 866 | |
b7acde90 | 867 | /* Take the car or cdr of something whose type is not known. */ |
00382e8b | 868 | INLINE Lisp_Object |
84575e67 PE |
869 | CAR (Lisp_Object c) |
870 | { | |
871 | return (CONSP (c) ? XCAR (c) | |
872 | : NILP (c) ? Qnil | |
873 | : wrong_type_argument (Qlistp, c)); | |
874 | } | |
00382e8b | 875 | INLINE Lisp_Object |
84575e67 PE |
876 | CDR (Lisp_Object c) |
877 | { | |
878 | return (CONSP (c) ? XCDR (c) | |
879 | : NILP (c) ? Qnil | |
880 | : wrong_type_argument (Qlistp, c)); | |
881 | } | |
b7acde90 | 882 | |
c8a39089 | 883 | /* Take the car or cdr of something whose type is not known. */ |
00382e8b | 884 | INLINE Lisp_Object |
84575e67 PE |
885 | CAR_SAFE (Lisp_Object c) |
886 | { | |
887 | return CONSP (c) ? XCAR (c) : Qnil; | |
888 | } | |
00382e8b | 889 | INLINE Lisp_Object |
84575e67 PE |
890 | CDR_SAFE (Lisp_Object c) |
891 | { | |
892 | return CONSP (c) ? XCDR (c) : Qnil; | |
893 | } | |
35f464a7 | 894 | |
84575e67 | 895 | /* In a string or vector, the sign bit of the `size' is the gc mark bit. */ |
35f464a7 | 896 | |
84575e67 PE |
897 | struct Lisp_String |
898 | { | |
49609976 | 899 | Lisp_Object self; |
84575e67 PE |
900 | ptrdiff_t size; |
901 | ptrdiff_t size_byte; | |
902 | INTERVAL intervals; /* Text properties in this string. */ | |
903 | unsigned char *data; | |
904 | }; | |
d8fc7ce4 | 905 | |
84575e67 | 906 | /* True if STR is a multibyte string. */ |
00382e8b | 907 | INLINE bool |
84575e67 PE |
908 | STRING_MULTIBYTE (Lisp_Object str) |
909 | { | |
910 | return 0 <= XSTRING (str)->size_byte; | |
911 | } | |
35f464a7 | 912 | |
c9d624c6 PE |
913 | /* An upper bound on the number of bytes in a Lisp string, not |
914 | counting the terminating null. This a tight enough bound to | |
915 | prevent integer overflow errors that would otherwise occur during | |
916 | string size calculations. A string cannot contain more bytes than | |
917 | a fixnum can represent, nor can it be so long that C pointer | |
918 | arithmetic stops working on the string plus its terminating null. | |
919 | Although the actual size limit (see STRING_BYTES_MAX in alloc.c) | |
920 | may be a bit smaller than STRING_BYTES_BOUND, calculating it here | |
921 | would expose alloc.c internal details that we'd rather keep | |
03a660a6 PE |
922 | private. |
923 | ||
7b1123d8 PE |
924 | This is a macro for use in static initializers. The cast to |
925 | ptrdiff_t ensures that the macro is signed. */ | |
c9d624c6 | 926 | #define STRING_BYTES_BOUND \ |
88fb40b4 | 927 | ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1)) |
d1f3d2af | 928 | |
491c2516 | 929 | /* Mark STR as a unibyte string. */ |
96c06863 PE |
930 | #define STRING_SET_UNIBYTE(STR) \ |
931 | do { \ | |
932 | if (EQ (STR, empty_multibyte_string)) \ | |
933 | (STR) = empty_unibyte_string; \ | |
934 | else \ | |
935 | XSTRING (STR)->size_byte = -1; \ | |
936 | } while (false) | |
491c2516 | 937 | |
94ef4d69 KH |
938 | /* Mark STR as a multibyte string. Assure that STR contains only |
939 | ASCII characters in advance. */ | |
96c06863 PE |
940 | #define STRING_SET_MULTIBYTE(STR) \ |
941 | do { \ | |
942 | if (EQ (STR, empty_unibyte_string)) \ | |
943 | (STR) = empty_multibyte_string; \ | |
944 | else \ | |
945 | XSTRING (STR)->size_byte = XSTRING (STR)->size; \ | |
946 | } while (false) | |
94ef4d69 | 947 | |
84575e67 | 948 | /* Convenience functions for dealing with Lisp strings. */ |
3cfe6dfd | 949 | |
00382e8b | 950 | INLINE unsigned char * |
84575e67 PE |
951 | SDATA (Lisp_Object string) |
952 | { | |
953 | return XSTRING (string)->data; | |
954 | } | |
00382e8b | 955 | INLINE char * |
84575e67 PE |
956 | SSDATA (Lisp_Object string) |
957 | { | |
958 | /* Avoid "differ in sign" warnings. */ | |
959 | return (char *) SDATA (string); | |
960 | } | |
00382e8b | 961 | INLINE unsigned char |
84575e67 PE |
962 | SREF (Lisp_Object string, ptrdiff_t index) |
963 | { | |
964 | return SDATA (string)[index]; | |
965 | } | |
00382e8b | 966 | INLINE void |
84575e67 PE |
967 | SSET (Lisp_Object string, ptrdiff_t index, unsigned char new) |
968 | { | |
969 | SDATA (string)[index] = new; | |
970 | } | |
00382e8b | 971 | INLINE ptrdiff_t |
84575e67 PE |
972 | SCHARS (Lisp_Object string) |
973 | { | |
974 | return XSTRING (string)->size; | |
975 | } | |
fbe9e0b9 | 976 | |
00382e8b | 977 | INLINE ptrdiff_t |
84575e67 PE |
978 | STRING_BYTES (struct Lisp_String *s) |
979 | { | |
84575e67 | 980 | return s->size_byte < 0 ? s->size : s->size_byte; |
84575e67 | 981 | } |
fbe9e0b9 | 982 | |
00382e8b | 983 | INLINE ptrdiff_t |
84575e67 PE |
984 | SBYTES (Lisp_Object string) |
985 | { | |
986 | return STRING_BYTES (XSTRING (string)); | |
987 | } | |
00382e8b | 988 | INLINE void |
84575e67 PE |
989 | STRING_SET_CHARS (Lisp_Object string, ptrdiff_t newsize) |
990 | { | |
991 | XSTRING (string)->size = newsize; | |
992 | } | |
3cfe6dfd | 993 | |
aa0b0087 | 994 | /* Header of vector-like objects. This documents the layout constraints on |
914adc42 | 995 | vectors and pseudovectors (objects of PVEC_xxx subtype). It also prevents |
84575e67 PE |
996 | compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR |
997 | and PSEUDOVECTORP cast their pointers to struct vectorlike_header *, | |
aa0b0087 PE |
998 | because when two such pointers potentially alias, a compiler won't |
999 | incorrectly reorder loads and stores to their size fields. See | |
df5b4930 | 1000 | Bug#8546. */ |
b102ceb1 | 1001 | struct vectorlike_header |
3cfe6dfd | 1002 | { |
49609976 BT |
1003 | Lisp_Object self; |
1004 | ||
1005 | /* This field contains various pieces of information: | |
2bdeb39a | 1006 | - The second bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain |
ee28be33 SM |
1007 | vector (0) or a pseudovector (1). |
1008 | - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number | |
1009 | of slots) of the vector. | |
914adc42 DA |
1010 | - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into three fields: |
1011 | - a) pseudovector subtype held in PVEC_TYPE_MASK field; | |
1012 | - b) number of Lisp_Objects slots at the beginning of the object | |
1013 | held in PSEUDOVECTOR_SIZE_MASK field. These objects are always | |
1014 | traced by the GC; | |
1015 | - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and | |
1016 | measured in word_size units. Rest fields may also include | |
1017 | Lisp_Objects, but these objects usually needs some special treatment | |
1018 | during GC. | |
1019 | There are some exceptions. For PVEC_FREE, b) is always zero. For | |
1020 | PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero. | |
1021 | Current layout limits the pseudovectors to 63 PVEC_xxx subtypes, | |
1022 | 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots. */ | |
d311d28c | 1023 | ptrdiff_t size; |
eab3844f PE |
1024 | }; |
1025 | ||
91f2d272 | 1026 | /* A regular vector is just a header plus an array of Lisp_Objects. */ |
663e2b3f | 1027 | |
eab3844f PE |
1028 | struct Lisp_Vector |
1029 | { | |
b102ceb1 | 1030 | struct vectorlike_header header; |
91f2d272 PE |
1031 | Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER]; |
1032 | }; | |
0a858ebf | 1033 | |
91f2d272 PE |
1034 | /* C11 prohibits alignof (struct Lisp_Vector), so compute it manually. */ |
1035 | enum | |
1036 | { | |
1037 | ALIGNOF_STRUCT_LISP_VECTOR | |
1038 | = alignof (union { struct vectorlike_header a; Lisp_Object b; }) | |
3cfe6dfd JB |
1039 | }; |
1040 | ||
91f2d272 | 1041 | /* A boolvector is a kind of vectorlike, with contents like a string. */ |
663e2b3f DA |
1042 | |
1043 | struct Lisp_Bool_Vector | |
1044 | { | |
1045 | /* HEADER.SIZE is the vector's size field. It doesn't have the real size, | |
1046 | just the subtype information. */ | |
1047 | struct vectorlike_header header; | |
1048 | /* This is the size in bits. */ | |
1049 | EMACS_INT size; | |
2cf00efc | 1050 | /* The actual bits, packed into bytes. |
75360f19 | 1051 | Zeros fill out the last word if needed. |
2cf00efc PE |
1052 | The bits are in little-endian order in the bytes, and |
1053 | the bytes are in little-endian order in the words. */ | |
df5b4930 | 1054 | bits_word data[FLEXIBLE_ARRAY_MEMBER]; |
663e2b3f DA |
1055 | }; |
1056 | ||
1c0a7493 PE |
1057 | INLINE EMACS_INT |
1058 | bool_vector_size (Lisp_Object a) | |
1059 | { | |
1060 | EMACS_INT size = XBOOL_VECTOR (a)->size; | |
1061 | eassume (0 <= size); | |
1062 | return size; | |
1063 | } | |
1064 | ||
df5b4930 PE |
1065 | INLINE bits_word * |
1066 | bool_vector_data (Lisp_Object a) | |
1067 | { | |
1068 | return XBOOL_VECTOR (a)->data; | |
1069 | } | |
1070 | ||
1071 | INLINE unsigned char * | |
1072 | bool_vector_uchar_data (Lisp_Object a) | |
1073 | { | |
1074 | return (unsigned char *) bool_vector_data (a); | |
1075 | } | |
1076 | ||
2cf00efc | 1077 | /* The number of data words and bytes in a bool vector with SIZE bits. */ |
df5b4930 PE |
1078 | |
1079 | INLINE EMACS_INT | |
1080 | bool_vector_words (EMACS_INT size) | |
1081 | { | |
1082 | eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1)); | |
1083 | return (size + BITS_PER_BITS_WORD - 1) / BITS_PER_BITS_WORD; | |
1084 | } | |
1085 | ||
2cf00efc PE |
1086 | INLINE EMACS_INT |
1087 | bool_vector_bytes (EMACS_INT size) | |
1088 | { | |
1089 | eassume (0 <= size && size <= EMACS_INT_MAX - (BITS_PER_BITS_WORD - 1)); | |
1090 | return (size + BOOL_VECTOR_BITS_PER_CHAR - 1) / BOOL_VECTOR_BITS_PER_CHAR; | |
1091 | } | |
1092 | ||
df5b4930 PE |
1093 | /* True if A's Ith bit is set. */ |
1094 | ||
1095 | INLINE bool | |
1096 | bool_vector_bitref (Lisp_Object a, EMACS_INT i) | |
1097 | { | |
1098 | eassume (0 <= i && i < bool_vector_size (a)); | |
1099 | return !! (bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR] | |
1100 | & (1 << (i % BOOL_VECTOR_BITS_PER_CHAR))); | |
1101 | } | |
1102 | ||
1103 | INLINE Lisp_Object | |
1104 | bool_vector_ref (Lisp_Object a, EMACS_INT i) | |
1105 | { | |
1106 | return bool_vector_bitref (a, i) ? Qt : Qnil; | |
1107 | } | |
1108 | ||
1109 | /* Set A's Ith bit to B. */ | |
1110 | ||
1111 | INLINE void | |
1112 | bool_vector_set (Lisp_Object a, EMACS_INT i, bool b) | |
1113 | { | |
1114 | unsigned char *addr; | |
1115 | ||
1116 | eassume (0 <= i && i < bool_vector_size (a)); | |
1117 | addr = &bool_vector_uchar_data (a)[i / BOOL_VECTOR_BITS_PER_CHAR]; | |
1118 | ||
1119 | if (b) | |
1120 | *addr |= 1 << (i % BOOL_VECTOR_BITS_PER_CHAR); | |
1121 | else | |
1122 | *addr &= ~ (1 << (i % BOOL_VECTOR_BITS_PER_CHAR)); | |
1123 | } | |
1124 | ||
663e2b3f DA |
1125 | /* Some handy constants for calculating sizes |
1126 | and offsets, mostly of vectorlike objects. */ | |
1127 | ||
1128 | enum | |
1129 | { | |
91f2d272 | 1130 | header_size = offsetof (struct Lisp_Vector, contents), |
663e2b3f DA |
1131 | bool_header_size = offsetof (struct Lisp_Bool_Vector, data), |
1132 | word_size = sizeof (Lisp_Object) | |
1133 | }; | |
1134 | ||
84575e67 PE |
1135 | /* Conveniences for dealing with Lisp arrays. */ |
1136 | ||
00382e8b | 1137 | INLINE Lisp_Object |
84575e67 PE |
1138 | AREF (Lisp_Object array, ptrdiff_t idx) |
1139 | { | |
91f2d272 | 1140 | return XVECTOR (array)->contents[idx]; |
84575e67 PE |
1141 | } |
1142 | ||
00382e8b | 1143 | INLINE Lisp_Object * |
84575e67 PE |
1144 | aref_addr (Lisp_Object array, ptrdiff_t idx) |
1145 | { | |
91f2d272 | 1146 | return & XVECTOR (array)->contents[idx]; |
84575e67 PE |
1147 | } |
1148 | ||
00382e8b | 1149 | INLINE ptrdiff_t |
84575e67 PE |
1150 | ASIZE (Lisp_Object array) |
1151 | { | |
1152 | return XVECTOR (array)->header.size; | |
1153 | } | |
1154 | ||
00382e8b | 1155 | INLINE void |
84575e67 PE |
1156 | ASET (Lisp_Object array, ptrdiff_t idx, Lisp_Object val) |
1157 | { | |
1158 | eassert (0 <= idx && idx < ASIZE (array)); | |
91f2d272 | 1159 | XVECTOR (array)->contents[idx] = val; |
84575e67 PE |
1160 | } |
1161 | ||
00382e8b | 1162 | INLINE void |
84575e67 PE |
1163 | gc_aset (Lisp_Object array, ptrdiff_t idx, Lisp_Object val) |
1164 | { | |
1165 | /* Like ASET, but also can be used in the garbage collector: | |
1166 | sweep_weak_table calls set_hash_key etc. while the table is marked. */ | |
f2b0b0d1 | 1167 | eassert (0 <= idx && idx < (ASIZE (array))); |
91f2d272 | 1168 | XVECTOR (array)->contents[idx] = val; |
84575e67 PE |
1169 | } |
1170 | ||
94225242 | 1171 | /* If a struct is made to look like a vector, this macro returns the length |
4115d3f7 | 1172 | of the shortest vector that would hold that struct. */ |
663e2b3f DA |
1173 | |
1174 | #define VECSIZE(type) \ | |
1175 | ((sizeof (type) - header_size + word_size - 1) / word_size) | |
94225242 | 1176 | |
d0ebe33a SM |
1177 | /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields |
1178 | at the end and we need to compute the number of Lisp_Object fields (the | |
1179 | ones that the GC needs to trace). */ | |
663e2b3f DA |
1180 | |
1181 | #define PSEUDOVECSIZE(type, nonlispfield) \ | |
1182 | ((offsetof (type, nonlispfield) - header_size) / word_size) | |
d0ebe33a | 1183 | |
ea204efb PE |
1184 | /* Compute A OP B, using the unsigned comparison operator OP. A and B |
1185 | should be integer expressions. This is not the same as | |
53964682 | 1186 | mathematical comparison; for example, UNSIGNED_CMP (0, <, -1) |
96c06863 | 1187 | returns true. For efficiency, prefer plain unsigned comparison if A |
ea204efb PE |
1188 | and B's sizes both fit (after integer promotion). */ |
1189 | #define UNSIGNED_CMP(a, op, b) \ | |
1190 | (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned) \ | |
1191 | ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0) \ | |
1192 | : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0)) | |
1193 | ||
96c06863 | 1194 | /* True iff C is an ASCII character. */ |
ea204efb | 1195 | #define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80) |
15206ed9 | 1196 | |
84575e67 PE |
1197 | /* A char-table is a kind of vectorlike, with contents are like a |
1198 | vector but with a few other slots. For some purposes, it makes | |
1199 | sense to handle a char-table with type struct Lisp_Vector. An | |
1200 | element of a char table can be any Lisp objects, but if it is a sub | |
1201 | char-table, we treat it a table that contains information of a | |
1202 | specific range of characters. A sub char-table has the same | |
1203 | structure as a vector. A sub char table appears only in an element | |
1204 | of a char-table, and there's no way to access it directly from | |
1205 | Emacs Lisp program. */ | |
1842abb2 | 1206 | |
03a660a6 PE |
1207 | enum CHARTAB_SIZE_BITS |
1208 | { | |
1209 | CHARTAB_SIZE_BITS_0 = 6, | |
1210 | CHARTAB_SIZE_BITS_1 = 4, | |
1211 | CHARTAB_SIZE_BITS_2 = 5, | |
1212 | CHARTAB_SIZE_BITS_3 = 7 | |
1213 | }; | |
1842abb2 KH |
1214 | |
1215 | extern const int chartab_size[4]; | |
1216 | ||
608ff985 RS |
1217 | struct Lisp_Char_Table |
1218 | { | |
eab3844f | 1219 | /* HEADER.SIZE is the vector's size field, which also holds the |
608ff985 | 1220 | pseudovector type information. It holds the size, too. |
c73bd236 MB |
1221 | The size counts the defalt, parent, purpose, ascii, |
1222 | contents, and extras slots. */ | |
b102ceb1 | 1223 | struct vectorlike_header header; |
1842abb2 | 1224 | |
608ff985 RS |
1225 | /* This holds a default value, |
1226 | which is used whenever the value for a specific character is nil. */ | |
1227 | Lisp_Object defalt; | |
ea724a01 | 1228 | |
8f924df7 KH |
1229 | /* This points to another char table, which we inherit from when the |
1230 | value for a specific character is nil. The `defalt' slot takes | |
1231 | precedence over this. */ | |
608ff985 | 1232 | Lisp_Object parent; |
1842abb2 | 1233 | |
8f924df7 KH |
1234 | /* This is a symbol which says what kind of use this char-table is |
1235 | meant for. */ | |
7f73dc9d | 1236 | Lisp_Object purpose; |
1842abb2 | 1237 | |
8f924df7 KH |
1238 | /* The bottom sub char-table for characters of the range 0..127. It |
1239 | is nil if none of ASCII character has a specific value. */ | |
1240 | Lisp_Object ascii; | |
1842abb2 | 1241 | |
8f924df7 | 1242 | Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)]; |
1842abb2 | 1243 | |
8f924df7 | 1244 | /* These hold additional data. It is a vector. */ |
fbe9e0b9 | 1245 | Lisp_Object extras[FLEXIBLE_ARRAY_MEMBER]; |
608ff985 RS |
1246 | }; |
1247 | ||
1842abb2 | 1248 | struct Lisp_Sub_Char_Table |
8f924df7 | 1249 | { |
eab3844f | 1250 | /* HEADER.SIZE is the vector's size field, which also holds the |
8f924df7 | 1251 | pseudovector type information. It holds the size, too. */ |
b102ceb1 | 1252 | struct vectorlike_header header; |
1842abb2 | 1253 | |
8f924df7 | 1254 | /* Depth of this sub char-table. It should be 1, 2, or 3. A sub |
78edd3b7 | 1255 | char-table of depth 1 contains 16 elements, and each element |
8f924df7 KH |
1256 | covers 4096 (128*32) characters. A sub char-table of depth 2 |
1257 | contains 32 elements, and each element covers 128 characters. A | |
1258 | sub char-table of depth 3 contains 128 elements, and each element | |
1259 | is for one character. */ | |
1260 | Lisp_Object depth; | |
1842abb2 | 1261 | |
8f924df7 KH |
1262 | /* Minimum character covered by the sub char-table. */ |
1263 | Lisp_Object min_char; | |
1842abb2 | 1264 | |
34dabdb7 | 1265 | /* Use set_sub_char_table_contents to set this. */ |
fbe9e0b9 | 1266 | Lisp_Object contents[FLEXIBLE_ARRAY_MEMBER]; |
8f924df7 | 1267 | }; |
608ff985 | 1268 | |
00382e8b | 1269 | INLINE Lisp_Object |
84575e67 PE |
1270 | CHAR_TABLE_REF_ASCII (Lisp_Object ct, ptrdiff_t idx) |
1271 | { | |
1272 | struct Lisp_Char_Table *tbl = NULL; | |
1273 | Lisp_Object val; | |
1274 | do | |
1275 | { | |
1276 | tbl = tbl ? XCHAR_TABLE (tbl->parent) : XCHAR_TABLE (ct); | |
1277 | val = (! SUB_CHAR_TABLE_P (tbl->ascii) ? tbl->ascii | |
1278 | : XSUB_CHAR_TABLE (tbl->ascii)->contents[idx]); | |
1279 | if (NILP (val)) | |
1280 | val = tbl->defalt; | |
1281 | } | |
1282 | while (NILP (val) && ! NILP (tbl->parent)); | |
1283 | ||
1284 | return val; | |
1285 | } | |
1286 | ||
1287 | /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII | |
1288 | characters. Do not check validity of CT. */ | |
00382e8b | 1289 | INLINE Lisp_Object |
84575e67 PE |
1290 | CHAR_TABLE_REF (Lisp_Object ct, int idx) |
1291 | { | |
1292 | return (ASCII_CHAR_P (idx) | |
1293 | ? CHAR_TABLE_REF_ASCII (ct, idx) | |
1294 | : char_table_ref (ct, idx)); | |
1295 | } | |
1296 | ||
1297 | /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and | |
1298 | 8-bit European characters. Do not check validity of CT. */ | |
00382e8b | 1299 | INLINE void |
84575e67 PE |
1300 | CHAR_TABLE_SET (Lisp_Object ct, int idx, Lisp_Object val) |
1301 | { | |
1302 | if (ASCII_CHAR_P (idx) && SUB_CHAR_TABLE_P (XCHAR_TABLE (ct)->ascii)) | |
1303 | set_sub_char_table_contents (XCHAR_TABLE (ct)->ascii, idx, val); | |
1304 | else | |
1305 | char_table_set (ct, idx, val); | |
1306 | } | |
1307 | ||
7c06ac2b RS |
1308 | /* This structure describes a built-in function. |
1309 | It is generated by the DEFUN macro only. | |
914adc42 | 1310 | defsubr makes it into a Lisp object. */ |
e98227af | 1311 | |
3cfe6dfd JB |
1312 | struct Lisp_Subr |
1313 | { | |
914adc42 | 1314 | struct vectorlike_header header; |
c0f2f16b DN |
1315 | union { |
1316 | Lisp_Object (*a0) (void); | |
1317 | Lisp_Object (*a1) (Lisp_Object); | |
1318 | Lisp_Object (*a2) (Lisp_Object, Lisp_Object); | |
1319 | Lisp_Object (*a3) (Lisp_Object, Lisp_Object, Lisp_Object); | |
1320 | Lisp_Object (*a4) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1321 | Lisp_Object (*a5) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1322 | Lisp_Object (*a6) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1323 | Lisp_Object (*a7) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
1324 | Lisp_Object (*a8) (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
d5273788 | 1325 | Lisp_Object (*aUNEVALLED) (Lisp_Object args); |
f66c7cf8 | 1326 | Lisp_Object (*aMANY) (ptrdiff_t, Lisp_Object *); |
c0f2f16b | 1327 | } function; |
3cfe6dfd | 1328 | short min_args, max_args; |
5e2327cf | 1329 | const char *symbol_name; |
89dc303e DN |
1330 | const char *intspec; |
1331 | const char *doc; | |
3cfe6dfd | 1332 | }; |
5010d3b8 | 1333 | |
03a660a6 PE |
1334 | /* This is the number of slots that every char table must have. This |
1335 | counts the ordinary slots and the top, defalt, parent, and purpose | |
1336 | slots. */ | |
1337 | enum CHAR_TABLE_STANDARD_SLOTS | |
1338 | { | |
fbe9e0b9 | 1339 | CHAR_TABLE_STANDARD_SLOTS = PSEUDOVECSIZE (struct Lisp_Char_Table, extras) |
03a660a6 PE |
1340 | }; |
1341 | ||
1342 | /* Return the number of "extra" slots in the char table CT. */ | |
1343 | ||
00382e8b | 1344 | INLINE int |
84575e67 PE |
1345 | CHAR_TABLE_EXTRA_SLOTS (struct Lisp_Char_Table *ct) |
1346 | { | |
1347 | return ((ct->header.size & PSEUDOVECTOR_SIZE_MASK) | |
1348 | - CHAR_TABLE_STANDARD_SLOTS); | |
1349 | } | |
03a660a6 | 1350 | |
5010d3b8 | 1351 | \f |
a32fa736 GM |
1352 | /*********************************************************************** |
1353 | Symbols | |
1354 | ***********************************************************************/ | |
1355 | ||
1356 | /* Interned state of a symbol. */ | |
1357 | ||
1358 | enum symbol_interned | |
1359 | { | |
1360 | SYMBOL_UNINTERNED = 0, | |
1361 | SYMBOL_INTERNED = 1, | |
1362 | SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2 | |
1363 | }; | |
1364 | ||
ce5b453a SM |
1365 | enum symbol_redirect |
1366 | { | |
1367 | SYMBOL_PLAINVAL = 4, | |
1368 | SYMBOL_VARALIAS = 1, | |
1369 | SYMBOL_LOCALIZED = 2, | |
9aba6043 | 1370 | SYMBOL_FORWARDED = 3 |
ce5b453a SM |
1371 | }; |
1372 | ||
a32fa736 GM |
1373 | struct Lisp_Symbol |
1374 | { | |
49609976 BT |
1375 | Lisp_Object self; |
1376 | ||
ce5b453a SM |
1377 | /* Indicates where the value can be found: |
1378 | 0 : it's a plain var, the value is in the `value' field. | |
1379 | 1 : it's a varalias, the value is really in the `alias' symbol. | |
1380 | 2 : it's a localized var, the value is in the `blv' object. | |
9aba6043 | 1381 | 3 : it's a forwarding variable, the value is in `forward'. */ |
a6fc3b5c | 1382 | ENUM_BF (symbol_redirect) redirect : 3; |
a32fa736 GM |
1383 | |
1384 | /* Non-zero means symbol is constant, i.e. changing its value | |
ce5b453a SM |
1385 | should signal an error. If the value is 3, then the var |
1386 | can be changed, but only by `defconst'. */ | |
1387 | unsigned constant : 2; | |
a32fa736 GM |
1388 | |
1389 | /* Interned state of the symbol. This is an enumerator from | |
1390 | enum symbol_interned. */ | |
1391 | unsigned interned : 2; | |
1e973bc7 | 1392 | |
96c06863 | 1393 | /* True means that this variable has been explicitly declared |
b9598260 | 1394 | special (with `defvar' etc), and shouldn't be lexically bound. */ |
96c06863 | 1395 | bool_bf declared_special : 1; |
a32fa736 | 1396 | |
e3b83880 SM |
1397 | /* True if pointed to from purespace and hence can't be GC'd. */ |
1398 | bool_bf pinned : 1; | |
1399 | ||
c644523b DA |
1400 | /* The symbol's name, as a Lisp string. */ |
1401 | Lisp_Object name; | |
a32fa736 | 1402 | |
9aba6043 SM |
1403 | /* Value of the symbol or Qunbound if unbound. Which alternative of the |
1404 | union is used depends on the `redirect' field above. */ | |
ce5b453a | 1405 | union { |
c644523b | 1406 | Lisp_Object value; |
ce5b453a SM |
1407 | struct Lisp_Symbol *alias; |
1408 | struct Lisp_Buffer_Local_Value *blv; | |
1409 | union Lisp_Fwd *fwd; | |
1410 | } val; | |
a32fa736 | 1411 | |
eadf1faa | 1412 | /* Function value of the symbol or Qnil if not fboundp. */ |
c644523b | 1413 | Lisp_Object function; |
a32fa736 GM |
1414 | |
1415 | /* The symbol's property list. */ | |
c644523b | 1416 | Lisp_Object plist; |
e2c0561e | 1417 | |
a32fa736 GM |
1418 | /* Next symbol in obarray bucket, if the symbol is interned. */ |
1419 | struct Lisp_Symbol *next; | |
1420 | }; | |
1421 | ||
74d70085 KR |
1422 | /* Value is name of symbol. */ |
1423 | ||
84575e67 | 1424 | LISP_MACRO_DEFUN (SYMBOL_VAL, Lisp_Object, (struct Lisp_Symbol *sym), (sym)) |
ce5b453a | 1425 | |
00382e8b | 1426 | INLINE struct Lisp_Symbol * |
84575e67 PE |
1427 | SYMBOL_ALIAS (struct Lisp_Symbol *sym) |
1428 | { | |
1429 | eassert (sym->redirect == SYMBOL_VARALIAS); | |
1430 | return sym->val.alias; | |
1431 | } | |
00382e8b | 1432 | INLINE struct Lisp_Buffer_Local_Value * |
84575e67 PE |
1433 | SYMBOL_BLV (struct Lisp_Symbol *sym) |
1434 | { | |
1435 | eassert (sym->redirect == SYMBOL_LOCALIZED); | |
1436 | return sym->val.blv; | |
1437 | } | |
00382e8b | 1438 | INLINE union Lisp_Fwd * |
84575e67 PE |
1439 | SYMBOL_FWD (struct Lisp_Symbol *sym) |
1440 | { | |
1441 | eassert (sym->redirect == SYMBOL_FORWARDED); | |
1442 | return sym->val.fwd; | |
1443 | } | |
74d70085 | 1444 | |
84575e67 PE |
1445 | LISP_MACRO_DEFUN_VOID (SET_SYMBOL_VAL, |
1446 | (struct Lisp_Symbol *sym, Lisp_Object v), (sym, v)) | |
a32fa736 | 1447 | |
00382e8b | 1448 | INLINE void |
84575e67 PE |
1449 | SET_SYMBOL_ALIAS (struct Lisp_Symbol *sym, struct Lisp_Symbol *v) |
1450 | { | |
1451 | eassert (sym->redirect == SYMBOL_VARALIAS); | |
1452 | sym->val.alias = v; | |
1453 | } | |
00382e8b | 1454 | INLINE void |
84575e67 PE |
1455 | SET_SYMBOL_BLV (struct Lisp_Symbol *sym, struct Lisp_Buffer_Local_Value *v) |
1456 | { | |
1457 | eassert (sym->redirect == SYMBOL_LOCALIZED); | |
1458 | sym->val.blv = v; | |
1459 | } | |
00382e8b | 1460 | INLINE void |
84575e67 PE |
1461 | SET_SYMBOL_FWD (struct Lisp_Symbol *sym, union Lisp_Fwd *v) |
1462 | { | |
1463 | eassert (sym->redirect == SYMBOL_FORWARDED); | |
1464 | sym->val.fwd = v; | |
1465 | } | |
1466 | ||
00382e8b | 1467 | INLINE Lisp_Object |
84575e67 PE |
1468 | SYMBOL_NAME (Lisp_Object sym) |
1469 | { | |
1470 | return XSYMBOL (sym)->name; | |
1471 | } | |
1472 | ||
1473 | /* Value is true if SYM is an interned symbol. */ | |
1474 | ||
00382e8b | 1475 | INLINE bool |
84575e67 PE |
1476 | SYMBOL_INTERNED_P (Lisp_Object sym) |
1477 | { | |
1478 | return XSYMBOL (sym)->interned != SYMBOL_UNINTERNED; | |
1479 | } | |
a32fa736 | 1480 | |
84575e67 | 1481 | /* Value is true if SYM is interned in initial_obarray. */ |
a32fa736 | 1482 | |
00382e8b | 1483 | INLINE bool |
84575e67 PE |
1484 | SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P (Lisp_Object sym) |
1485 | { | |
1486 | return XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY; | |
1487 | } | |
a32fa736 GM |
1488 | |
1489 | /* Value is non-zero if symbol is considered a constant, i.e. its | |
1490 | value cannot be changed (there is an exception for keyword symbols, | |
1491 | whose value can be set to the keyword symbol itself). */ | |
1492 | ||
84575e67 | 1493 | LISP_MACRO_DEFUN (SYMBOL_CONSTANT_P, int, (Lisp_Object sym), (sym)) |
a32fa736 | 1494 | |
c644523b | 1495 | #define DEFSYM(sym, name) \ |
96c06863 | 1496 | do { (sym) = intern_c_string ((name)); staticpro (&(sym)); } while (false) |
cd3520a4 | 1497 | |
a32fa736 | 1498 | \f |
5010d3b8 GM |
1499 | /*********************************************************************** |
1500 | Hash Tables | |
1501 | ***********************************************************************/ | |
1502 | ||
1503 | /* The structure of a Lisp hash table. */ | |
1504 | ||
b7432bb2 SM |
1505 | struct hash_table_test |
1506 | { | |
1507 | /* Name of the function used to compare keys. */ | |
1508 | Lisp_Object name; | |
1509 | ||
1510 | /* User-supplied hash function, or nil. */ | |
1511 | Lisp_Object user_hash_function; | |
1512 | ||
1513 | /* User-supplied key comparison function, or nil. */ | |
1514 | Lisp_Object user_cmp_function; | |
1515 | ||
1516 | /* C function to compare two keys. */ | |
1517 | bool (*cmpfn) (struct hash_table_test *t, Lisp_Object, Lisp_Object); | |
1518 | ||
1519 | /* C function to compute hash code. */ | |
1520 | EMACS_UINT (*hashfn) (struct hash_table_test *t, Lisp_Object); | |
1521 | }; | |
1522 | ||
5010d3b8 GM |
1523 | struct Lisp_Hash_Table |
1524 | { | |
eab3844f | 1525 | /* This is for Lisp; the hash table code does not refer to it. */ |
b102ceb1 | 1526 | struct vectorlike_header header; |
e2c0561e | 1527 | |
5010d3b8 GM |
1528 | /* Nil if table is non-weak. Otherwise a symbol describing the |
1529 | weakness of the table. */ | |
1530 | Lisp_Object weak; | |
e2c0561e | 1531 | |
5010d3b8 GM |
1532 | /* When the table is resized, and this is an integer, compute the |
1533 | new size by adding this to the old size. If a float, compute the | |
1534 | new size by multiplying the old size with this factor. */ | |
1535 | Lisp_Object rehash_size; | |
1536 | ||
1537 | /* Resize hash table when number of entries/ table size is >= this | |
1538 | ratio, a float. */ | |
1539 | Lisp_Object rehash_threshold; | |
1540 | ||
5833dd93 EZ |
1541 | /* Vector of hash codes. If hash[I] is nil, this means that the |
1542 | I-th entry is unused. */ | |
5010d3b8 GM |
1543 | Lisp_Object hash; |
1544 | ||
1545 | /* Vector used to chain entries. If entry I is free, next[I] is the | |
1546 | entry number of the next free item. If entry I is non-free, | |
1547 | next[I] is the index of the next entry in the collision chain. */ | |
1548 | Lisp_Object next; | |
1549 | ||
1550 | /* Index of first free entry in free list. */ | |
1551 | Lisp_Object next_free; | |
1552 | ||
1553 | /* Bucket vector. A non-nil entry is the index of the first item in | |
1554 | a collision chain. This vector's size can be larger than the | |
1555 | hash table size to reduce collisions. */ | |
1556 | Lisp_Object index; | |
1557 | ||
878f97ff | 1558 | /* Only the fields above are traced normally by the GC. The ones below |
78edd3b7 | 1559 | `count' are special and are either ignored by the GC or traced in |
878f97ff SM |
1560 | a special way (e.g. because of weakness). */ |
1561 | ||
1562 | /* Number of key/value entries in the table. */ | |
d311d28c | 1563 | ptrdiff_t count; |
878f97ff SM |
1564 | |
1565 | /* Vector of keys and values. The key of item I is found at index | |
1566 | 2 * I, the value is found at index 2 * I + 1. | |
1567 | This is gc_marked specially if the table is weak. */ | |
1568 | Lisp_Object key_and_value; | |
1569 | ||
b7432bb2 SM |
1570 | /* The comparison and hash functions. */ |
1571 | struct hash_table_test test; | |
1572 | ||
6c661ec9 SM |
1573 | /* Next weak hash table if this is a weak hash table. The head |
1574 | of the list is in weak_hash_tables. */ | |
1575 | struct Lisp_Hash_Table *next_weak; | |
5010d3b8 GM |
1576 | }; |
1577 | ||
1578 | ||
00382e8b | 1579 | INLINE struct Lisp_Hash_Table * |
84575e67 PE |
1580 | XHASH_TABLE (Lisp_Object a) |
1581 | { | |
49609976 | 1582 | return SMOB_PTR (a); |
84575e67 | 1583 | } |
5010d3b8 GM |
1584 | |
1585 | #define XSET_HASH_TABLE(VAR, PTR) \ | |
1586 | (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE)) | |
1587 | ||
00382e8b | 1588 | INLINE bool |
84575e67 PE |
1589 | HASH_TABLE_P (Lisp_Object a) |
1590 | { | |
1591 | return PSEUDOVECTORP (a, PVEC_HASH_TABLE); | |
1592 | } | |
5010d3b8 | 1593 | |
141788b5 | 1594 | /* Value is the key part of entry IDX in hash table H. */ |
00382e8b | 1595 | INLINE Lisp_Object |
84575e67 PE |
1596 | HASH_KEY (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1597 | { | |
1598 | return AREF (h->key_and_value, 2 * idx); | |
1599 | } | |
141788b5 SM |
1600 | |
1601 | /* Value is the value part of entry IDX in hash table H. */ | |
00382e8b | 1602 | INLINE Lisp_Object |
84575e67 PE |
1603 | HASH_VALUE (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1604 | { | |
1605 | return AREF (h->key_and_value, 2 * idx + 1); | |
1606 | } | |
141788b5 SM |
1607 | |
1608 | /* Value is the index of the next entry following the one at IDX | |
1609 | in hash table H. */ | |
00382e8b | 1610 | INLINE Lisp_Object |
84575e67 PE |
1611 | HASH_NEXT (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1612 | { | |
1613 | return AREF (h->next, idx); | |
1614 | } | |
141788b5 SM |
1615 | |
1616 | /* Value is the hash code computed for entry IDX in hash table H. */ | |
00382e8b | 1617 | INLINE Lisp_Object |
84575e67 PE |
1618 | HASH_HASH (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1619 | { | |
1620 | return AREF (h->hash, idx); | |
1621 | } | |
141788b5 SM |
1622 | |
1623 | /* Value is the index of the element in hash table H that is the | |
1624 | start of the collision list at index IDX in the index vector of H. */ | |
00382e8b | 1625 | INLINE Lisp_Object |
84575e67 PE |
1626 | HASH_INDEX (struct Lisp_Hash_Table *h, ptrdiff_t idx) |
1627 | { | |
1628 | return AREF (h->index, idx); | |
1629 | } | |
141788b5 SM |
1630 | |
1631 | /* Value is the size of hash table H. */ | |
00382e8b | 1632 | INLINE ptrdiff_t |
84575e67 PE |
1633 | HASH_TABLE_SIZE (struct Lisp_Hash_Table *h) |
1634 | { | |
1635 | return ASIZE (h->next); | |
1636 | } | |
141788b5 | 1637 | |
5010d3b8 GM |
1638 | /* Default size for hash tables if not specified. */ |
1639 | ||
03a660a6 | 1640 | enum DEFAULT_HASH_SIZE { DEFAULT_HASH_SIZE = 65 }; |
5010d3b8 GM |
1641 | |
1642 | /* Default threshold specifying when to resize a hash table. The | |
1643 | value gives the ratio of current entries in the hash table and the | |
1644 | size of the hash table. */ | |
1645 | ||
185ee146 | 1646 | static double const DEFAULT_REHASH_THRESHOLD = 0.8; |
5010d3b8 GM |
1647 | |
1648 | /* Default factor by which to increase the size of a hash table. */ | |
1649 | ||
185ee146 | 1650 | static double const DEFAULT_REHASH_SIZE = 1.5; |
5010d3b8 | 1651 | |
04a2d0d3 PE |
1652 | /* Combine two integers X and Y for hashing. The result might not fit |
1653 | into a Lisp integer. */ | |
1654 | ||
00382e8b | 1655 | INLINE EMACS_UINT |
04a2d0d3 PE |
1656 | sxhash_combine (EMACS_UINT x, EMACS_UINT y) |
1657 | { | |
1658 | return (x << 4) + (x >> (BITS_PER_EMACS_INT - 4)) + y; | |
1659 | } | |
1660 | ||
eff1c190 PE |
1661 | /* Hash X, returning a value that fits into a fixnum. */ |
1662 | ||
00382e8b | 1663 | INLINE EMACS_UINT |
eff1c190 PE |
1664 | SXHASH_REDUCE (EMACS_UINT x) |
1665 | { | |
49609976 | 1666 | return (x ^ x >> (BITS_PER_EMACS_INT - FIXNUM_BITS + 1)) & INTMASK; |
eff1c190 PE |
1667 | } |
1668 | ||
7c06ac2b RS |
1669 | /* These structures are used for various misc types. */ |
1670 | ||
67ee9f6e SM |
1671 | struct Lisp_Misc_Any /* Supertype of all Misc types. */ |
1672 | { | |
49609976 | 1673 | Lisp_Object self; |
a6fc3b5c | 1674 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_??? */ |
67ee9f6e SM |
1675 | }; |
1676 | ||
3cfe6dfd | 1677 | struct Lisp_Marker |
308e97d0 | 1678 | { |
49609976 | 1679 | Lisp_Object self; |
a6fc3b5c | 1680 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Marker */ |
9bb13d08 KH |
1681 | /* This flag is temporarily used in the functions |
1682 | decode/encode_coding_object to record that the marker position | |
1683 | must be adjusted after the conversion. */ | |
96c06863 PE |
1684 | bool_bf need_adjustment : 1; |
1685 | /* True means normal insertion at the marker's position | |
308e97d0 | 1686 | leaves the marker after the inserted text. */ |
96c06863 | 1687 | bool_bf insertion_type : 1; |
b9466edb SM |
1688 | /* This is the buffer that the marker points into, or 0 if it points nowhere. |
1689 | Note: a chain of markers can contain markers pointing into different | |
1690 | buffers (the chain is per buffer_text rather than per buffer, so it's | |
1691 | shared between indirect buffers). */ | |
1692 | /* This is used for (other than NULL-checking): | |
1693 | - Fmarker_buffer | |
1694 | - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain. | |
1695 | - unchain_marker: to find the list from which to unchain. | |
ce5b453a | 1696 | - Fkill_buffer: to only unchain the markers of current indirect buffer. |
b9466edb | 1697 | */ |
308e97d0 | 1698 | struct buffer *buffer; |
4ed24bf3 RS |
1699 | |
1700 | /* The remaining fields are meaningless in a marker that | |
1701 | does not point anywhere. */ | |
1702 | ||
1703 | /* For markers that point somewhere, | |
1704 | this is used to chain of all the markers in a given buffer. */ | |
d6aa1876 SM |
1705 | /* We could remove it and use an array in buffer_text instead. |
1706 | That would also allow to preserve it ordered. */ | |
c0ac2f4a | 1707 | struct Lisp_Marker *next; |
4ed24bf3 | 1708 | /* This is the char position where the marker points. */ |
d311d28c | 1709 | ptrdiff_t charpos; |
ce5b453a SM |
1710 | /* This is the byte position. |
1711 | It's mostly used as a charpos<->bytepos cache (i.e. it's not directly | |
1712 | used to implement the functionality of markers, but rather to (ab)use | |
1713 | markers as a cache for char<->byte mappings). */ | |
d311d28c | 1714 | ptrdiff_t bytepos; |
308e97d0 | 1715 | }; |
3cfe6dfd | 1716 | |
7555c33f SM |
1717 | /* START and END are markers in the overlay's buffer, and |
1718 | PLIST is the overlay's property list. */ | |
1719 | struct Lisp_Overlay | |
fa691a83 DA |
1720 | /* An overlay's real data content is: |
1721 | - plist | |
1722 | - buffer (really there are two buffer pointers, one per marker, | |
1723 | and both points to the same buffer) | |
1724 | - insertion type of both ends (per-marker fields) | |
1725 | - start & start byte (of start marker) | |
1726 | - end & end byte (of end marker) | |
1727 | - next (singly linked list of overlays) | |
1728 | - next fields of start and end markers (singly linked list of markers). | |
1729 | I.e. 9words plus 2 bits, 3words of which are for external linked lists. | |
1730 | */ | |
7555c33f | 1731 | { |
49609976 | 1732 | Lisp_Object self; |
7555c33f | 1733 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Overlay */ |
7555c33f | 1734 | struct Lisp_Overlay *next; |
c644523b DA |
1735 | Lisp_Object start; |
1736 | Lisp_Object end; | |
1737 | Lisp_Object plist; | |
7555c33f SM |
1738 | }; |
1739 | ||
73ebd38f DA |
1740 | /* Types of data which may be saved in a Lisp_Save_Value. */ |
1741 | ||
1742 | enum | |
1743 | { | |
1744 | SAVE_UNUSED, | |
1745 | SAVE_INTEGER, | |
52a9bcae | 1746 | SAVE_FUNCPOINTER, |
73ebd38f DA |
1747 | SAVE_POINTER, |
1748 | SAVE_OBJECT | |
1749 | }; | |
1750 | ||
7b1123d8 | 1751 | /* Number of bits needed to store one of the above values. */ |
52a9bcae | 1752 | enum { SAVE_SLOT_BITS = 3 }; |
7b1123d8 PE |
1753 | |
1754 | /* Number of slots in a save value where save_type is nonzero. */ | |
1755 | enum { SAVE_VALUE_SLOTS = 4 }; | |
1756 | ||
1757 | /* Bit-width and values for struct Lisp_Save_Value's save_type member. */ | |
1758 | ||
1759 | enum { SAVE_TYPE_BITS = SAVE_VALUE_SLOTS * SAVE_SLOT_BITS + 1 }; | |
1760 | ||
1761 | enum Lisp_Save_Type | |
1762 | { | |
1763 | SAVE_TYPE_INT_INT = SAVE_INTEGER + (SAVE_INTEGER << SAVE_SLOT_BITS), | |
1764 | SAVE_TYPE_INT_INT_INT | |
1765 | = (SAVE_INTEGER + (SAVE_TYPE_INT_INT << SAVE_SLOT_BITS)), | |
1766 | SAVE_TYPE_OBJ_OBJ = SAVE_OBJECT + (SAVE_OBJECT << SAVE_SLOT_BITS), | |
1767 | SAVE_TYPE_OBJ_OBJ_OBJ = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ << SAVE_SLOT_BITS), | |
1768 | SAVE_TYPE_OBJ_OBJ_OBJ_OBJ | |
1769 | = SAVE_OBJECT + (SAVE_TYPE_OBJ_OBJ_OBJ << SAVE_SLOT_BITS), | |
1770 | SAVE_TYPE_PTR_INT = SAVE_POINTER + (SAVE_INTEGER << SAVE_SLOT_BITS), | |
1771 | SAVE_TYPE_PTR_OBJ = SAVE_POINTER + (SAVE_OBJECT << SAVE_SLOT_BITS), | |
1772 | SAVE_TYPE_PTR_PTR = SAVE_POINTER + (SAVE_POINTER << SAVE_SLOT_BITS), | |
52a9bcae PE |
1773 | SAVE_TYPE_FUNCPTR_PTR_OBJ |
1774 | = SAVE_FUNCPOINTER + (SAVE_TYPE_PTR_OBJ << SAVE_SLOT_BITS), | |
7b1123d8 PE |
1775 | |
1776 | /* This has an extra bit indicating it's raw memory. */ | |
1777 | SAVE_TYPE_MEMORY = SAVE_TYPE_PTR_INT + (1 << (SAVE_TYPE_BITS - 1)) | |
1778 | }; | |
1779 | ||
468afbac DA |
1780 | /* Special object used to hold a different values for later use. |
1781 | ||
1782 | This is mostly used to package C integers and pointers to call | |
27e498e6 | 1783 | record_unwind_protect when two or more values need to be saved. |
1396ac86 | 1784 | For example: |
468afbac DA |
1785 | |
1786 | ... | |
1787 | struct my_data *md = get_my_data (); | |
1396ac86 PE |
1788 | ptrdiff_t mi = get_my_integer (); |
1789 | record_unwind_protect (my_unwind, make_save_ptr_int (md, mi)); | |
468afbac DA |
1790 | ... |
1791 | ||
1792 | Lisp_Object my_unwind (Lisp_Object arg) | |
1793 | { | |
1794 | struct my_data *md = XSAVE_POINTER (arg, 0); | |
1396ac86 | 1795 | ptrdiff_t mi = XSAVE_INTEGER (arg, 1); |
468afbac DA |
1796 | ... |
1797 | } | |
1798 | ||
1799 | If ENABLE_CHECKING is in effect, XSAVE_xxx macros do type checking of the | |
1800 | saved objects and raise eassert if type of the saved object doesn't match | |
1801 | the type which is extracted. In the example above, XSAVE_INTEGER (arg, 2) | |
1396ac86 PE |
1802 | and XSAVE_OBJECT (arg, 0) are wrong because nothing was saved in slot 2 and |
1803 | slot 0 is a pointer. */ | |
73ebd38f | 1804 | |
52a9bcae PE |
1805 | typedef void (*voidfuncptr) (void); |
1806 | ||
7555c33f SM |
1807 | struct Lisp_Save_Value |
1808 | { | |
49609976 | 1809 | Lisp_Object self; |
7555c33f | 1810 | ENUM_BF (Lisp_Misc_Type) type : 16; /* = Lisp_Misc_Save_Value */ |
2bdeb39a | 1811 | unsigned spacer : 32 - (16 + SAVE_TYPE_BITS); |
7b1123d8 | 1812 | |
1396ac86 PE |
1813 | /* V->data may hold up to SAVE_VALUE_SLOTS entries. The type of |
1814 | V's data entries are determined by V->save_type. E.g., if | |
1815 | V->save_type == SAVE_TYPE_PTR_OBJ, V->data[0] is a pointer, | |
1816 | V->data[1] is an integer, and V's other data entries are unused. | |
7b1123d8 | 1817 | |
1396ac86 PE |
1818 | If V->save_type == SAVE_TYPE_MEMORY, V->data[0].pointer is the address of |
1819 | a memory area containing V->data[1].integer potential Lisp_Objects. */ | |
7b1123d8 | 1820 | ENUM_BF (Lisp_Save_Type) save_type : SAVE_TYPE_BITS; |
73ebd38f DA |
1821 | union { |
1822 | void *pointer; | |
52a9bcae | 1823 | voidfuncptr funcpointer; |
73ebd38f DA |
1824 | ptrdiff_t integer; |
1825 | Lisp_Object object; | |
7b1123d8 | 1826 | } data[SAVE_VALUE_SLOTS]; |
7555c33f SM |
1827 | }; |
1828 | ||
84575e67 | 1829 | /* Return the type of V's Nth saved value. */ |
00382e8b | 1830 | INLINE int |
84575e67 PE |
1831 | save_type (struct Lisp_Save_Value *v, int n) |
1832 | { | |
1833 | eassert (0 <= n && n < SAVE_VALUE_SLOTS); | |
1834 | return (v->save_type >> (SAVE_SLOT_BITS * n) & ((1 << SAVE_SLOT_BITS) - 1)); | |
1835 | } | |
1836 | ||
1837 | /* Get and set the Nth saved pointer. */ | |
1838 | ||
00382e8b | 1839 | INLINE void * |
84575e67 PE |
1840 | XSAVE_POINTER (Lisp_Object obj, int n) |
1841 | { | |
1842 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER); | |
52a9bcae | 1843 | return XSAVE_VALUE (obj)->data[n].pointer; |
84575e67 | 1844 | } |
00382e8b | 1845 | INLINE void |
84575e67 PE |
1846 | set_save_pointer (Lisp_Object obj, int n, void *val) |
1847 | { | |
1848 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_POINTER); | |
1849 | XSAVE_VALUE (obj)->data[n].pointer = val; | |
1850 | } | |
00382e8b | 1851 | INLINE voidfuncptr |
52a9bcae PE |
1852 | XSAVE_FUNCPOINTER (Lisp_Object obj, int n) |
1853 | { | |
1854 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_FUNCPOINTER); | |
1855 | return XSAVE_VALUE (obj)->data[n].funcpointer; | |
1856 | } | |
84575e67 PE |
1857 | |
1858 | /* Likewise for the saved integer. */ | |
1859 | ||
00382e8b | 1860 | INLINE ptrdiff_t |
84575e67 PE |
1861 | XSAVE_INTEGER (Lisp_Object obj, int n) |
1862 | { | |
1863 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER); | |
1864 | return XSAVE_VALUE (obj)->data[n].integer; | |
1865 | } | |
00382e8b | 1866 | INLINE void |
84575e67 PE |
1867 | set_save_integer (Lisp_Object obj, int n, ptrdiff_t val) |
1868 | { | |
1869 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_INTEGER); | |
1870 | XSAVE_VALUE (obj)->data[n].integer = val; | |
1871 | } | |
1872 | ||
1873 | /* Extract Nth saved object. */ | |
1874 | ||
00382e8b | 1875 | INLINE Lisp_Object |
84575e67 PE |
1876 | XSAVE_OBJECT (Lisp_Object obj, int n) |
1877 | { | |
1878 | eassert (save_type (XSAVE_VALUE (obj), n) == SAVE_OBJECT); | |
1879 | return XSAVE_VALUE (obj)->data[n].object; | |
1880 | } | |
1881 | ||
7555c33f SM |
1882 | /* To get the type field of a union Lisp_Misc, use XMISCTYPE. |
1883 | It uses one of these struct subtypes to get the type field. */ | |
1884 | ||
1885 | union Lisp_Misc | |
1886 | { | |
1887 | struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */ | |
7555c33f SM |
1888 | struct Lisp_Marker u_marker; |
1889 | struct Lisp_Overlay u_overlay; | |
1890 | struct Lisp_Save_Value u_save_value; | |
1891 | }; | |
1892 | ||
00382e8b | 1893 | INLINE union Lisp_Misc * |
84575e67 PE |
1894 | XMISC (Lisp_Object a) |
1895 | { | |
49609976 | 1896 | return SMOB_PTR (a); |
84575e67 PE |
1897 | } |
1898 | ||
00382e8b | 1899 | INLINE struct Lisp_Misc_Any * |
84575e67 PE |
1900 | XMISCANY (Lisp_Object a) |
1901 | { | |
1902 | eassert (MISCP (a)); | |
1903 | return & XMISC (a)->u_any; | |
1904 | } | |
1905 | ||
00382e8b | 1906 | INLINE enum Lisp_Misc_Type |
84575e67 PE |
1907 | XMISCTYPE (Lisp_Object a) |
1908 | { | |
1909 | return XMISCANY (a)->type; | |
1910 | } | |
1911 | ||
00382e8b | 1912 | INLINE struct Lisp_Marker * |
84575e67 PE |
1913 | XMARKER (Lisp_Object a) |
1914 | { | |
1915 | eassert (MARKERP (a)); | |
1916 | return & XMISC (a)->u_marker; | |
1917 | } | |
1918 | ||
00382e8b | 1919 | INLINE struct Lisp_Overlay * |
84575e67 PE |
1920 | XOVERLAY (Lisp_Object a) |
1921 | { | |
1922 | eassert (OVERLAYP (a)); | |
1923 | return & XMISC (a)->u_overlay; | |
1924 | } | |
1925 | ||
00382e8b | 1926 | INLINE struct Lisp_Save_Value * |
84575e67 PE |
1927 | XSAVE_VALUE (Lisp_Object a) |
1928 | { | |
1929 | eassert (SAVE_VALUEP (a)); | |
1930 | return & XMISC (a)->u_save_value; | |
1931 | } | |
1932 | \f | |
ee4c9ce4 KH |
1933 | /* Forwarding pointer to an int variable. |
1934 | This is allowed only in the value cell of a symbol, | |
1935 | and it means that the symbol's value really lives in the | |
1936 | specified int variable. */ | |
1937 | struct Lisp_Intfwd | |
84d1833e | 1938 | { |
ce5b453a | 1939 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Int */ |
31ade731 | 1940 | EMACS_INT *intvar; |
ee4c9ce4 KH |
1941 | }; |
1942 | ||
1943 | /* Boolean forwarding pointer to an int variable. | |
1944 | This is like Lisp_Intfwd except that the ostensible | |
96c06863 PE |
1945 | "value" of the symbol is t if the bool variable is true, |
1946 | nil if it is false. */ | |
ee4c9ce4 KH |
1947 | struct Lisp_Boolfwd |
1948 | { | |
ce5b453a | 1949 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Bool */ |
f5d9e83a | 1950 | bool *boolvar; |
ee4c9ce4 KH |
1951 | }; |
1952 | ||
1953 | /* Forwarding pointer to a Lisp_Object variable. | |
1954 | This is allowed only in the value cell of a symbol, | |
1955 | and it means that the symbol's value really lives in the | |
1956 | specified variable. */ | |
1957 | struct Lisp_Objfwd | |
1958 | { | |
ce5b453a | 1959 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Obj */ |
ee4c9ce4 KH |
1960 | Lisp_Object *objvar; |
1961 | }; | |
1962 | ||
1963 | /* Like Lisp_Objfwd except that value lives in a slot in the | |
1964 | current buffer. Value is byte index of slot within buffer. */ | |
1965 | struct Lisp_Buffer_Objfwd | |
1966 | { | |
ce5b453a | 1967 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Buffer_Obj */ |
ee4c9ce4 | 1968 | int offset; |
58cc0a01 DA |
1969 | /* One of Qnil, Qintegerp, Qsymbolp, Qstringp, Qfloatp or Qnumberp. */ |
1970 | Lisp_Object predicate; | |
84d1833e KH |
1971 | }; |
1972 | ||
65d0110b RS |
1973 | /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when |
1974 | the symbol has buffer-local or frame-local bindings. (Exception: | |
1975 | some buffer-local variables are built-in, with their values stored | |
1976 | in the buffer structure itself. They are handled differently, | |
1977 | using struct Lisp_Buffer_Objfwd.) | |
1978 | ||
1979 | The `realvalue' slot holds the variable's current value, or a | |
1980 | forwarding pointer to where that value is kept. This value is the | |
1981 | one that corresponds to the loaded binding. To read or set the | |
1982 | variable, you must first make sure the right binding is loaded; | |
1983 | then you can access the value in (or through) `realvalue'. | |
e2c0561e | 1984 | |
65d0110b RS |
1985 | `buffer' and `frame' are the buffer and frame for which the loaded |
1986 | binding was found. If those have changed, to make sure the right | |
1987 | binding is loaded it is necessary to find which binding goes with | |
1988 | the current buffer and selected frame, then load it. To load it, | |
1989 | first unload the previous binding, then copy the value of the new | |
1990 | binding into `realvalue' (or through it). Also update | |
1991 | LOADED-BINDING to point to the newly loaded binding. | |
7d65f1c2 | 1992 | |
78edd3b7 JB |
1993 | `local_if_set' indicates that merely setting the variable creates a |
1994 | local binding for the current buffer. Otherwise the latter, setting | |
1995 | the variable does not do that; only make-local-variable does that. */ | |
65d0110b | 1996 | |
7d65f1c2 KH |
1997 | struct Lisp_Buffer_Local_Value |
1998 | { | |
96c06863 | 1999 | /* True means that merely setting the variable creates a local |
7555c33f | 2000 | binding for the current buffer. */ |
96c06863 PE |
2001 | bool_bf local_if_set : 1; |
2002 | /* True means this variable can have frame-local bindings, otherwise, it is | |
ce5b453a | 2003 | can have buffer-local bindings. The two cannot be combined. */ |
96c06863 PE |
2004 | bool_bf frame_local : 1; |
2005 | /* True means that the binding now loaded was found. | |
7555c33f | 2006 | Presumably equivalent to (defcell!=valcell). */ |
96c06863 | 2007 | bool_bf found : 1; |
ce5b453a SM |
2008 | /* If non-NULL, a forwarding to the C var where it should also be set. */ |
2009 | union Lisp_Fwd *fwd; /* Should never be (Buffer|Kboard)_Objfwd. */ | |
2010 | /* The buffer or frame for which the loaded binding was found. */ | |
2011 | Lisp_Object where; | |
2012 | /* A cons cell that holds the default value. It has the form | |
2013 | (SYMBOL . DEFAULT-VALUE). */ | |
2014 | Lisp_Object defcell; | |
2015 | /* The cons cell from `where's parameter alist. | |
2016 | It always has the form (SYMBOL . VALUE) | |
2017 | Note that if `forward' is non-nil, VALUE may be out of date. | |
2018 | Also if the currently loaded binding is the default binding, then | |
2019 | this is `eq'ual to defcell. */ | |
2020 | Lisp_Object valcell; | |
7d65f1c2 KH |
2021 | }; |
2022 | ||
f334de0e | 2023 | /* Like Lisp_Objfwd except that value lives in a slot in the |
32462604 KH |
2024 | current kboard. */ |
2025 | struct Lisp_Kboard_Objfwd | |
f334de0e | 2026 | { |
ce5b453a | 2027 | enum Lisp_Fwd_Type type; /* = Lisp_Fwd_Kboard_Obj */ |
f334de0e KH |
2028 | int offset; |
2029 | }; | |
2030 | ||
ce5b453a SM |
2031 | union Lisp_Fwd |
2032 | { | |
d55c12ed AS |
2033 | struct Lisp_Intfwd u_intfwd; |
2034 | struct Lisp_Boolfwd u_boolfwd; | |
2035 | struct Lisp_Objfwd u_objfwd; | |
2036 | struct Lisp_Buffer_Objfwd u_buffer_objfwd; | |
2037 | struct Lisp_Kboard_Objfwd u_kboard_objfwd; | |
84d1833e | 2038 | }; |
84575e67 | 2039 | |
00382e8b | 2040 | INLINE enum Lisp_Fwd_Type |
84575e67 PE |
2041 | XFWDTYPE (union Lisp_Fwd *a) |
2042 | { | |
2043 | return a->u_intfwd.type; | |
2044 | } | |
2045 | ||
00382e8b | 2046 | INLINE struct Lisp_Buffer_Objfwd * |
84575e67 PE |
2047 | XBUFFER_OBJFWD (union Lisp_Fwd *a) |
2048 | { | |
2049 | eassert (BUFFER_OBJFWDP (a)); | |
2050 | return &a->u_buffer_objfwd; | |
2051 | } | |
7c06ac2b | 2052 | \f |
7555c33f | 2053 | /* Lisp floating point type. */ |
3cfe6dfd JB |
2054 | struct Lisp_Float |
2055 | { | |
49609976 | 2056 | Lisp_Object self; |
cb42294c | 2057 | double data; |
3cfe6dfd | 2058 | }; |
8f34f70a | 2059 | |
00382e8b | 2060 | INLINE double |
84575e67 PE |
2061 | XFLOAT_DATA (Lisp_Object f) |
2062 | { | |
cb42294c | 2063 | return XFLOAT (f)->data; |
84575e67 | 2064 | } |
3cfe6dfd | 2065 | |
4d7e6e51 PE |
2066 | /* Most hosts nowadays use IEEE floating point, so they use IEC 60559 |
2067 | representations, have infinities and NaNs, and do not trap on | |
2068 | exceptions. Define IEEE_FLOATING_POINT if this host is one of the | |
2069 | typical ones. The C11 macro __STDC_IEC_559__ is close to what is | |
2070 | wanted here, but is not quite right because Emacs does not require | |
2071 | all the features of C11 Annex F (and does not require C11 at all, | |
2072 | for that matter). */ | |
84575e67 PE |
2073 | enum |
2074 | { | |
2075 | IEEE_FLOATING_POINT | |
2076 | = (FLT_RADIX == 2 && FLT_MANT_DIG == 24 | |
2077 | && FLT_MIN_EXP == -125 && FLT_MAX_EXP == 128) | |
2078 | }; | |
4d7e6e51 | 2079 | |
3cfe6dfd | 2080 | /* A character, declared with the following typedef, is a member |
99a3d506 | 2081 | of some character set associated with the current buffer. */ |
b2ba7b00 RS |
2082 | #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */ |
2083 | #define _UCHAR_T | |
3cfe6dfd | 2084 | typedef unsigned char UCHAR; |
b2ba7b00 | 2085 | #endif |
3cfe6dfd JB |
2086 | |
2087 | /* Meanings of slots in a Lisp_Compiled: */ | |
2088 | ||
03a660a6 PE |
2089 | enum Lisp_Compiled |
2090 | { | |
2091 | COMPILED_ARGLIST = 0, | |
2092 | COMPILED_BYTECODE = 1, | |
2093 | COMPILED_CONSTANTS = 2, | |
2094 | COMPILED_STACK_DEPTH = 3, | |
2095 | COMPILED_DOC_STRING = 4, | |
2096 | COMPILED_INTERACTIVE = 5 | |
2097 | }; | |
88dbfee5 | 2098 | |
d03f79ef JB |
2099 | /* Flag bits in a character. These also get used in termhooks.h. |
2100 | Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE | |
7c06ac2b RS |
2101 | (MUlti-Lingual Emacs) might need 22 bits for the character value |
2102 | itself, so we probably shouldn't use any bits lower than 0x0400000. */ | |
03a660a6 PE |
2103 | enum char_bits |
2104 | { | |
2105 | CHAR_ALT = 0x0400000, | |
2106 | CHAR_SUPER = 0x0800000, | |
2107 | CHAR_HYPER = 0x1000000, | |
2108 | CHAR_SHIFT = 0x2000000, | |
2109 | CHAR_CTL = 0x4000000, | |
2110 | CHAR_META = 0x8000000, | |
2111 | ||
2112 | CHAR_MODIFIER_MASK = | |
88fb40b4 | 2113 | CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META, |
03a660a6 PE |
2114 | |
2115 | /* Actually, the current Emacs uses 22 bits for the character value | |
2116 | itself. */ | |
2117 | CHARACTERBITS = 22 | |
2118 | }; | |
3cfe6dfd | 2119 | \f |
e7032e7c | 2120 | /* Data type checking. */ |
3cfe6dfd | 2121 | |
84575e67 | 2122 | LISP_MACRO_DEFUN (NILP, bool, (Lisp_Object x), (x)) |
3cfe6dfd | 2123 | |
00382e8b | 2124 | INLINE bool |
84575e67 PE |
2125 | NUMBERP (Lisp_Object x) |
2126 | { | |
2127 | return INTEGERP (x) || FLOATP (x); | |
2128 | } | |
00382e8b | 2129 | INLINE bool |
84575e67 PE |
2130 | NATNUMP (Lisp_Object x) |
2131 | { | |
2132 | return INTEGERP (x) && 0 <= XINT (x); | |
2133 | } | |
2134 | ||
00382e8b | 2135 | INLINE bool |
84575e67 PE |
2136 | RANGED_INTEGERP (intmax_t lo, Lisp_Object x, intmax_t hi) |
2137 | { | |
2138 | return INTEGERP (x) && lo <= XINT (x) && XINT (x) <= hi; | |
2139 | } | |
4746118a | 2140 | |
ca9ce8f2 | 2141 | #define TYPE_RANGED_INTEGERP(type, x) \ |
84575e67 PE |
2142 | (INTEGERP (x) \ |
2143 | && (TYPE_SIGNED (type) ? TYPE_MINIMUM (type) <= XINT (x) : 0 <= XINT (x)) \ | |
2144 | && XINT (x) <= TYPE_MAXIMUM (type)) | |
2145 | ||
2146 | LISP_MACRO_DEFUN (CONSP, bool, (Lisp_Object x), (x)) | |
2147 | LISP_MACRO_DEFUN (FLOATP, bool, (Lisp_Object x), (x)) | |
2148 | LISP_MACRO_DEFUN (MISCP, bool, (Lisp_Object x), (x)) | |
2149 | LISP_MACRO_DEFUN (SYMBOLP, bool, (Lisp_Object x), (x)) | |
2150 | LISP_MACRO_DEFUN (INTEGERP, bool, (Lisp_Object x), (x)) | |
2151 | LISP_MACRO_DEFUN (VECTORLIKEP, bool, (Lisp_Object x), (x)) | |
2152 | LISP_MACRO_DEFUN (MARKERP, bool, (Lisp_Object x), (x)) | |
2153 | ||
00382e8b | 2154 | INLINE bool |
84575e67 PE |
2155 | STRINGP (Lisp_Object x) |
2156 | { | |
49609976 | 2157 | return SMOB_TYPEP (x, lisp_string_tag); |
84575e67 | 2158 | } |
00382e8b | 2159 | INLINE bool |
84575e67 PE |
2160 | VECTORP (Lisp_Object x) |
2161 | { | |
2162 | return VECTORLIKEP (x) && ! (ASIZE (x) & PSEUDOVECTOR_FLAG); | |
2163 | } | |
00382e8b | 2164 | INLINE bool |
84575e67 PE |
2165 | OVERLAYP (Lisp_Object x) |
2166 | { | |
2167 | return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay; | |
2168 | } | |
00382e8b | 2169 | INLINE bool |
84575e67 PE |
2170 | SAVE_VALUEP (Lisp_Object x) |
2171 | { | |
2172 | return MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value; | |
2173 | } | |
2174 | ||
00382e8b | 2175 | INLINE bool |
84575e67 PE |
2176 | AUTOLOADP (Lisp_Object x) |
2177 | { | |
2178 | return CONSP (x) && EQ (Qautoload, XCAR (x)); | |
2179 | } | |
7b1123d8 | 2180 | |
00382e8b | 2181 | INLINE bool |
84575e67 | 2182 | BUFFER_OBJFWDP (union Lisp_Fwd *a) |
7b1123d8 | 2183 | { |
84575e67 | 2184 | return XFWDTYPE (a) == Lisp_Fwd_Buffer_Obj; |
7b1123d8 | 2185 | } |
edfa9106 | 2186 | |
00382e8b | 2187 | INLINE bool |
84575e67 | 2188 | PSEUDOVECTOR_TYPEP (struct vectorlike_header *a, int code) |
717b8bcd | 2189 | { |
84575e67 PE |
2190 | return ((a->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) |
2191 | == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_AREA_BITS))); | |
717b8bcd SM |
2192 | } |
2193 | ||
84575e67 | 2194 | /* True if A is a pseudovector whose code is CODE. */ |
00382e8b | 2195 | INLINE bool |
84575e67 | 2196 | PSEUDOVECTORP (Lisp_Object a, int code) |
717b8bcd | 2197 | { |
84575e67 | 2198 | if (! VECTORLIKEP (a)) |
96c06863 | 2199 | return false; |
84575e67 PE |
2200 | else |
2201 | { | |
2202 | /* Converting to struct vectorlike_header * avoids aliasing issues. */ | |
49609976 | 2203 | struct vectorlike_header *h = SMOB_PTR (a); |
84575e67 PE |
2204 | return PSEUDOVECTOR_TYPEP (h, code); |
2205 | } | |
717b8bcd SM |
2206 | } |
2207 | ||
84575e67 PE |
2208 | /* Test for specific pseudovector types. */ |
2209 | ||
00382e8b | 2210 | INLINE bool |
84575e67 | 2211 | WINDOW_CONFIGURATIONP (Lisp_Object a) |
717b8bcd | 2212 | { |
84575e67 | 2213 | return PSEUDOVECTORP (a, PVEC_WINDOW_CONFIGURATION); |
717b8bcd | 2214 | } |
84575e67 | 2215 | |
00382e8b | 2216 | INLINE bool |
84575e67 | 2217 | PROCESSP (Lisp_Object a) |
717b8bcd | 2218 | { |
84575e67 | 2219 | return PSEUDOVECTORP (a, PVEC_PROCESS); |
717b8bcd SM |
2220 | } |
2221 | ||
00382e8b | 2222 | INLINE bool |
84575e67 | 2223 | WINDOWP (Lisp_Object a) |
717b8bcd | 2224 | { |
84575e67 | 2225 | return PSEUDOVECTORP (a, PVEC_WINDOW); |
717b8bcd | 2226 | } |
84575e67 | 2227 | |
00382e8b | 2228 | INLINE bool |
84575e67 | 2229 | TERMINALP (Lisp_Object a) |
717b8bcd | 2230 | { |
84575e67 | 2231 | return PSEUDOVECTORP (a, PVEC_TERMINAL); |
717b8bcd SM |
2232 | } |
2233 | ||
00382e8b | 2234 | INLINE bool |
84575e67 | 2235 | SUBRP (Lisp_Object a) |
717b8bcd | 2236 | { |
84575e67 | 2237 | return PSEUDOVECTORP (a, PVEC_SUBR); |
717b8bcd SM |
2238 | } |
2239 | ||
00382e8b | 2240 | INLINE bool |
84575e67 PE |
2241 | COMPILEDP (Lisp_Object a) |
2242 | { | |
2243 | return PSEUDOVECTORP (a, PVEC_COMPILED); | |
2244 | } | |
32e5c58c | 2245 | |
00382e8b | 2246 | INLINE bool |
84575e67 PE |
2247 | BUFFERP (Lisp_Object a) |
2248 | { | |
2249 | return PSEUDOVECTORP (a, PVEC_BUFFER); | |
2250 | } | |
7c06ac2b | 2251 | |
00382e8b | 2252 | INLINE bool |
84575e67 PE |
2253 | CHAR_TABLE_P (Lisp_Object a) |
2254 | { | |
2255 | return PSEUDOVECTORP (a, PVEC_CHAR_TABLE); | |
2256 | } | |
ee28be33 | 2257 | |
00382e8b | 2258 | INLINE bool |
84575e67 PE |
2259 | SUB_CHAR_TABLE_P (Lisp_Object a) |
2260 | { | |
2261 | return PSEUDOVECTORP (a, PVEC_SUB_CHAR_TABLE); | |
2262 | } | |
eab3844f | 2263 | |
00382e8b | 2264 | INLINE bool |
84575e67 PE |
2265 | BOOL_VECTOR_P (Lisp_Object a) |
2266 | { | |
2267 | return PSEUDOVECTORP (a, PVEC_BOOL_VECTOR); | |
2268 | } | |
7c06ac2b | 2269 | |
00382e8b | 2270 | INLINE bool |
84575e67 PE |
2271 | FRAMEP (Lisp_Object a) |
2272 | { | |
2273 | return PSEUDOVECTORP (a, PVEC_FRAME); | |
2274 | } | |
ea724a01 | 2275 | |
6b61353c | 2276 | /* Test for image (image . spec) */ |
00382e8b | 2277 | INLINE bool |
84575e67 PE |
2278 | IMAGEP (Lisp_Object x) |
2279 | { | |
2280 | return CONSP (x) && EQ (XCAR (x), Qimage); | |
2281 | } | |
6b61353c | 2282 | |
c8a39089 | 2283 | /* Array types. */ |
00382e8b | 2284 | INLINE bool |
84575e67 PE |
2285 | ARRAYP (Lisp_Object x) |
2286 | { | |
2287 | return VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x); | |
2288 | } | |
7c06ac2b | 2289 | \f |
00382e8b | 2290 | INLINE void |
84575e67 PE |
2291 | CHECK_LIST (Lisp_Object x) |
2292 | { | |
2293 | CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x); | |
2294 | } | |
3cfe6dfd | 2295 | |
84575e67 PE |
2296 | LISP_MACRO_DEFUN_VOID (CHECK_LIST_CONS, (Lisp_Object x, Lisp_Object y), (x, y)) |
2297 | LISP_MACRO_DEFUN_VOID (CHECK_SYMBOL, (Lisp_Object x), (x)) | |
2298 | LISP_MACRO_DEFUN_VOID (CHECK_NUMBER, (Lisp_Object x), (x)) | |
3cfe6dfd | 2299 | |
00382e8b | 2300 | INLINE void |
84575e67 PE |
2301 | CHECK_STRING (Lisp_Object x) |
2302 | { | |
2303 | CHECK_TYPE (STRINGP (x), Qstringp, x); | |
2304 | } | |
00382e8b | 2305 | INLINE void |
84575e67 PE |
2306 | CHECK_STRING_CAR (Lisp_Object x) |
2307 | { | |
2308 | CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x)); | |
2309 | } | |
00382e8b | 2310 | INLINE void |
84575e67 PE |
2311 | CHECK_CONS (Lisp_Object x) |
2312 | { | |
2313 | CHECK_TYPE (CONSP (x), Qconsp, x); | |
2314 | } | |
00382e8b | 2315 | INLINE void |
84575e67 PE |
2316 | CHECK_VECTOR (Lisp_Object x) |
2317 | { | |
2318 | CHECK_TYPE (VECTORP (x), Qvectorp, x); | |
2319 | } | |
00382e8b | 2320 | INLINE void |
3e0b94e7 DC |
2321 | CHECK_BOOL_VECTOR (Lisp_Object x) |
2322 | { | |
2323 | CHECK_TYPE (BOOL_VECTOR_P (x), Qbool_vector_p, x); | |
2324 | } | |
2325 | INLINE void | |
84575e67 PE |
2326 | CHECK_VECTOR_OR_STRING (Lisp_Object x) |
2327 | { | |
2328 | CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x); | |
2329 | } | |
00382e8b | 2330 | INLINE void |
40f5d4b7 | 2331 | CHECK_ARRAY (Lisp_Object x, Lisp_Object predicate) |
84575e67 | 2332 | { |
40f5d4b7 | 2333 | CHECK_TYPE (ARRAYP (x), predicate, x); |
84575e67 | 2334 | } |
00382e8b | 2335 | INLINE void |
84575e67 PE |
2336 | CHECK_BUFFER (Lisp_Object x) |
2337 | { | |
2338 | CHECK_TYPE (BUFFERP (x), Qbufferp, x); | |
2339 | } | |
00382e8b | 2340 | INLINE void |
84575e67 PE |
2341 | CHECK_WINDOW (Lisp_Object x) |
2342 | { | |
2343 | CHECK_TYPE (WINDOWP (x), Qwindowp, x); | |
2344 | } | |
bf6b4923 | 2345 | #ifdef subprocesses |
00382e8b | 2346 | INLINE void |
84575e67 PE |
2347 | CHECK_PROCESS (Lisp_Object x) |
2348 | { | |
2349 | CHECK_TYPE (PROCESSP (x), Qprocessp, x); | |
2350 | } | |
bf6b4923 | 2351 | #endif |
00382e8b | 2352 | INLINE void |
84575e67 PE |
2353 | CHECK_NATNUM (Lisp_Object x) |
2354 | { | |
2355 | CHECK_TYPE (NATNUMP (x), Qwholenump, x); | |
2356 | } | |
3cfe6dfd | 2357 | |
af5a5a98 | 2358 | #define CHECK_RANGED_INTEGER(x, lo, hi) \ |
d311d28c PE |
2359 | do { \ |
2360 | CHECK_NUMBER (x); \ | |
2361 | if (! ((lo) <= XINT (x) && XINT (x) <= (hi))) \ | |
2362 | args_out_of_range_3 \ | |
2363 | (x, \ | |
2364 | make_number ((lo) < 0 && (lo) < MOST_NEGATIVE_FIXNUM \ | |
2365 | ? MOST_NEGATIVE_FIXNUM \ | |
2366 | : (lo)), \ | |
2367 | make_number (min (hi, MOST_POSITIVE_FIXNUM))); \ | |
96c06863 | 2368 | } while (false) |
d311d28c PE |
2369 | #define CHECK_TYPE_RANGED_INTEGER(type, x) \ |
2370 | do { \ | |
2371 | if (TYPE_SIGNED (type)) \ | |
af5a5a98 | 2372 | CHECK_RANGED_INTEGER (x, TYPE_MINIMUM (type), TYPE_MAXIMUM (type)); \ |
d311d28c | 2373 | else \ |
af5a5a98 | 2374 | CHECK_RANGED_INTEGER (x, 0, TYPE_MAXIMUM (type)); \ |
96c06863 | 2375 | } while (false) |
d311d28c | 2376 | |
96c06863 PE |
2377 | #define CHECK_NUMBER_COERCE_MARKER(x) \ |
2378 | do { \ | |
2379 | if (MARKERP ((x))) \ | |
2380 | XSETFASTINT (x, marker_position (x)); \ | |
2381 | else \ | |
2382 | CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); \ | |
2383 | } while (false) | |
3cfe6dfd | 2384 | |
00382e8b | 2385 | INLINE double |
84575e67 PE |
2386 | XFLOATINT (Lisp_Object n) |
2387 | { | |
2388 | return extract_float (n); | |
2389 | } | |
3cfe6dfd | 2390 | |
00382e8b | 2391 | INLINE void |
84575e67 PE |
2392 | CHECK_NUMBER_OR_FLOAT (Lisp_Object x) |
2393 | { | |
2394 | CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x); | |
2395 | } | |
3cfe6dfd | 2396 | |
96c06863 PE |
2397 | #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \ |
2398 | do { \ | |
2399 | if (MARKERP (x)) \ | |
2400 | XSETFASTINT (x, marker_position (x)); \ | |
2401 | else \ | |
2402 | CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); \ | |
2403 | } while (false) | |
3cfe6dfd | 2404 | |
f3fbd155 KR |
2405 | /* Since we can't assign directly to the CAR or CDR fields of a cons |
2406 | cell, use these when checking that those fields contain numbers. */ | |
00382e8b | 2407 | INLINE void |
84575e67 PE |
2408 | CHECK_NUMBER_CAR (Lisp_Object x) |
2409 | { | |
2410 | Lisp_Object tmp = XCAR (x); | |
2411 | CHECK_NUMBER (tmp); | |
2412 | XSETCAR (x, tmp); | |
2413 | } | |
8f924df7 | 2414 | |
00382e8b | 2415 | INLINE void |
84575e67 PE |
2416 | CHECK_NUMBER_CDR (Lisp_Object x) |
2417 | { | |
2418 | Lisp_Object tmp = XCDR (x); | |
2419 | CHECK_NUMBER (tmp); | |
2420 | XSETCDR (x, tmp); | |
2421 | } | |
3cfe6dfd JB |
2422 | \f |
2423 | /* Define a built-in function for calling from Lisp. | |
2424 | `lname' should be the name to give the function in Lisp, | |
2425 | as a null-terminated C string. | |
2426 | `fnname' should be the name of the function in C. | |
2427 | By convention, it starts with F. | |
2428 | `sname' should be the name for the C constant structure | |
2429 | that records information on this function for internal use. | |
2430 | By convention, it should be the same as `fnname' but with S instead of F. | |
2431 | It's too bad that C macros can't compute this from `fnname'. | |
2432 | `minargs' should be a number, the minimum number of arguments allowed. | |
2433 | `maxargs' should be a number, the maximum number of arguments allowed, | |
2434 | or else MANY or UNEVALLED. | |
2435 | MANY means pass a vector of evaluated arguments, | |
2436 | in the form of an integer number-of-arguments | |
2437 | followed by the address of a vector of Lisp_Objects | |
2438 | which contains the argument values. | |
2439 | UNEVALLED means pass the list of unevaluated arguments | |
4bca9161 MC |
2440 | `intspec' says how interactive arguments are to be fetched. |
2441 | If the string starts with a `(', `intspec' is evaluated and the resulting | |
2442 | list is the list of arguments. | |
2443 | If it's a string that doesn't start with `(', the value should follow | |
2444 | the one of the doc string for `interactive'. | |
3cfe6dfd | 2445 | A null string means call interactively with no arguments. |
eab9d423 | 2446 | `doc' is documentation for the user. */ |
3cfe6dfd | 2447 | |
c451d7b1 | 2448 | /* This version of DEFUN declares a function prototype with the right |
99a3d506 | 2449 | arguments, so we can catch errors with maxargs at compile-time. */ |
a6fc3b5c EZ |
2450 | #ifdef _MSC_VER |
2451 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ | |
2452 | Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \ | |
e32a5799 | 2453 | static struct Lisp_Subr alignas (GCALIGNMENT) sname = \ |
49609976 BT |
2454 | { { NULL, \ |
2455 | (PVEC_SUBR << PSEUDOVECTOR_AREA_BITS) \ | |
914adc42 | 2456 | | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)) }, \ |
49609976 BT |
2457 | { (Lisp_Object (__cdecl *)(void))fnname }, \ |
2458 | minargs, maxargs, lname, intspec, 0}; \ | |
a6fc3b5c EZ |
2459 | Lisp_Object fnname |
2460 | #else /* not _MSC_VER */ | |
2461 | #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \ | |
e32a5799 | 2462 | static struct Lisp_Subr alignas (GCALIGNMENT) sname = \ |
49609976 BT |
2463 | { { .self = NULL, \ |
2464 | .size = PVEC_SUBR << PSEUDOVECTOR_AREA_BITS }, \ | |
2465 | { .a ## maxargs = fnname }, \ | |
2466 | minargs, maxargs, lname, intspec, 0}; \ | |
a6fc3b5c EZ |
2467 | Lisp_Object fnname |
2468 | #endif | |
c451d7b1 RS |
2469 | |
2470 | /* Note that the weird token-substitution semantics of ANSI C makes | |
99a3d506 | 2471 | this work for MANY and UNEVALLED. */ |
f66c7cf8 | 2472 | #define DEFUN_ARGS_MANY (ptrdiff_t, Lisp_Object *) |
c451d7b1 RS |
2473 | #define DEFUN_ARGS_UNEVALLED (Lisp_Object) |
2474 | #define DEFUN_ARGS_0 (void) | |
2475 | #define DEFUN_ARGS_1 (Lisp_Object) | |
2476 | #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object) | |
2477 | #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object) | |
2478 | #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
2479 | #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2480 | Lisp_Object) | |
2481 | #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2482 | Lisp_Object, Lisp_Object) | |
2483 | #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ | |
2484 | Lisp_Object, Lisp_Object, Lisp_Object) | |
5593f7e3 KH |
2485 | #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \ |
2486 | Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object) | |
276680c4 | 2487 | |
84575e67 | 2488 | /* True if OBJ is a Lisp function. */ |
00382e8b | 2489 | INLINE bool |
84575e67 PE |
2490 | FUNCTIONP (Lisp_Object obj) |
2491 | { | |
2492 | return functionp (obj); | |
2493 | } | |
e2c0561e | 2494 | |
3cfe6dfd | 2495 | /* defsubr (Sname); |
d19b9aa8 | 2496 | is how we define the symbol for function `name' at start-up time. */ |
383e0970 | 2497 | extern void defsubr (struct Lisp_Subr *); |
3cfe6dfd | 2498 | |
03a660a6 PE |
2499 | enum maxargs |
2500 | { | |
2501 | MANY = -2, | |
2502 | UNEVALLED = -1 | |
2503 | }; | |
3cfe6dfd | 2504 | |
ce5b453a SM |
2505 | extern void defvar_lisp (struct Lisp_Objfwd *, const char *, Lisp_Object *); |
2506 | extern void defvar_lisp_nopro (struct Lisp_Objfwd *, const char *, Lisp_Object *); | |
f5d9e83a | 2507 | extern void defvar_bool (struct Lisp_Boolfwd *, const char *, bool *); |
ce5b453a SM |
2508 | extern void defvar_int (struct Lisp_Intfwd *, const char *, EMACS_INT *); |
2509 | extern void defvar_kboard (struct Lisp_Kboard_Objfwd *, const char *, int); | |
3cfe6dfd JB |
2510 | |
2511 | /* Macros we use to define forwarded Lisp variables. | |
29208e82 | 2512 | These are used in the syms_of_FILENAME functions. |
51b59d79 | 2513 | |
29208e82 TT |
2514 | An ordinary (not in buffer_defaults, per-buffer, or per-keyboard) |
2515 | lisp variable is actually a field in `struct emacs_globals'. The | |
2516 | field's name begins with "f_", which is a convention enforced by | |
2517 | these macros. Each such global has a corresponding #define in | |
2518 | globals.h; the plain name should be used in the code. | |
2519 | ||
2520 | E.g., the global "cons_cells_consed" is declared as "int | |
2521 | f_cons_cells_consed" in globals.h, but there is a define: | |
2522 | ||
2523 | #define cons_cells_consed globals.f_cons_cells_consed | |
2524 | ||
2525 | All C code uses the `cons_cells_consed' name. This is all done | |
2526 | this way to support indirection for multi-threaded Emacs. */ | |
3cfe6dfd | 2527 | |
ce5b453a SM |
2528 | #define DEFVAR_LISP(lname, vname, doc) \ |
2529 | do { \ | |
2530 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 2531 | defvar_lisp (&o_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2532 | } while (false) |
ce5b453a SM |
2533 | #define DEFVAR_LISP_NOPRO(lname, vname, doc) \ |
2534 | do { \ | |
2535 | static struct Lisp_Objfwd o_fwd; \ | |
29208e82 | 2536 | defvar_lisp_nopro (&o_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2537 | } while (false) |
ce5b453a SM |
2538 | #define DEFVAR_BOOL(lname, vname, doc) \ |
2539 | do { \ | |
2540 | static struct Lisp_Boolfwd b_fwd; \ | |
29208e82 | 2541 | defvar_bool (&b_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2542 | } while (false) |
ce5b453a SM |
2543 | #define DEFVAR_INT(lname, vname, doc) \ |
2544 | do { \ | |
2545 | static struct Lisp_Intfwd i_fwd; \ | |
29208e82 | 2546 | defvar_int (&i_fwd, lname, &globals.f_ ## vname); \ |
96c06863 | 2547 | } while (false) |
92d2947b | 2548 | |
422745d0 TT |
2549 | #define DEFVAR_BUFFER_DEFAULTS(lname, vname, doc) \ |
2550 | do { \ | |
2551 | static struct Lisp_Objfwd o_fwd; \ | |
eb4916d7 | 2552 | defvar_lisp_nopro (&o_fwd, lname, &BVAR (&buffer_defaults, vname)); \ |
96c06863 | 2553 | } while (false) |
422745d0 | 2554 | |
ce5b453a SM |
2555 | #define DEFVAR_KBOARD(lname, vname, doc) \ |
2556 | do { \ | |
2557 | static struct Lisp_Kboard_Objfwd ko_fwd; \ | |
437b2cb4 | 2558 | defvar_kboard (&ko_fwd, lname, offsetof (KBOARD, vname ## _)); \ |
96c06863 | 2559 | } while (false) |
0328b6de PE |
2560 | \f |
2561 | /* Save and restore the instruction and environment pointers, | |
2562 | without affecting the signal mask. */ | |
2563 | ||
2564 | #ifdef HAVE__SETJMP | |
2565 | typedef jmp_buf sys_jmp_buf; | |
2566 | # define sys_setjmp(j) _setjmp (j) | |
2567 | # define sys_longjmp(j, v) _longjmp (j, v) | |
2568 | #elif defined HAVE_SIGSETJMP | |
2569 | typedef sigjmp_buf sys_jmp_buf; | |
2570 | # define sys_setjmp(j) sigsetjmp (j, 0) | |
2571 | # define sys_longjmp(j, v) siglongjmp (j, v) | |
2572 | #else | |
7105c8cb EZ |
2573 | /* A platform that uses neither _longjmp nor siglongjmp; assume |
2574 | longjmp does not affect the sigmask. */ | |
0328b6de PE |
2575 | typedef jmp_buf sys_jmp_buf; |
2576 | # define sys_setjmp(j) setjmp (j) | |
2577 | # define sys_longjmp(j, v) longjmp (j, v) | |
2578 | #endif | |
df7cd53b | 2579 | |
3cfe6dfd | 2580 | \f |
2f592f95 SM |
2581 | /* Elisp uses several stacks: |
2582 | - the C stack. | |
2583 | - the bytecode stack: used internally by the bytecode interpreter. | |
2584 | Allocated from the C stack. | |
2585 | - The specpdl stack: keeps track of active unwind-protect and | |
2586 | dynamic-let-bindings. Allocated from the `specpdl' array, a manually | |
2587 | managed stack. | |
adf2aa61 SM |
2588 | - The handler stack: keeps track of active catch tags and condition-case |
2589 | handlers. Allocated in a manually managed stack implemented by a | |
2590 | doubly-linked list allocated via xmalloc and never freed. */ | |
2f592f95 | 2591 | |
78ca380c JB |
2592 | /* Structure for recording Lisp call stack for backtrace purposes. */ |
2593 | ||
2594 | /* The special binding stack holds the outer values of variables while | |
2595 | they are bound by a function application or a let form, stores the | |
2f592f95 | 2596 | code to be executed for unwind-protect forms. |
78ca380c | 2597 | |
9349e5f7 | 2598 | NOTE: The specbinding union is defined here, because SPECPDL_INDEX is |
2f592f95 | 2599 | used all over the place, needs to be fast, and needs to know the size of |
9349e5f7 | 2600 | union specbinding. But only eval.c should access it. */ |
5fd6e274 | 2601 | |
2f592f95 | 2602 | enum specbind_tag { |
27e498e6 PE |
2603 | SPECPDL_UNWIND, /* An unwind_protect function on Lisp_Object. */ |
2604 | SPECPDL_UNWIND_PTR, /* Likewise, on void *. */ | |
2605 | SPECPDL_UNWIND_INT, /* Likewise, on int. */ | |
2606 | SPECPDL_UNWIND_VOID, /* Likewise, with no arg. */ | |
2f592f95 SM |
2607 | SPECPDL_BACKTRACE, /* An element of the backtrace. */ |
2608 | SPECPDL_LET, /* A plain and simple dynamic let-binding. */ | |
2609 | /* Tags greater than SPECPDL_LET must be "subkinds" of LET. */ | |
2610 | SPECPDL_LET_LOCAL, /* A buffer-local let-binding. */ | |
2611 | SPECPDL_LET_DEFAULT /* A global binding for a localized var. */ | |
2612 | }; | |
2613 | ||
9349e5f7 | 2614 | union specbinding |
3cfe6dfd | 2615 | { |
9349e5f7 PE |
2616 | ENUM_BF (specbind_tag) kind : CHAR_BIT; |
2617 | struct { | |
2618 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
27e498e6 | 2619 | void (*func) (Lisp_Object); |
9349e5f7 | 2620 | Lisp_Object arg; |
9349e5f7 | 2621 | } unwind; |
27e498e6 PE |
2622 | struct { |
2623 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2624 | void (*func) (void *); | |
2625 | void *arg; | |
2626 | } unwind_ptr; | |
2627 | struct { | |
2628 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2629 | void (*func) (int); | |
2630 | int arg; | |
2631 | } unwind_int; | |
2632 | struct { | |
2633 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2634 | void (*func) (void); | |
2635 | } unwind_void; | |
9349e5f7 PE |
2636 | struct { |
2637 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
2638 | /* `where' is not used in the case of SPECPDL_LET. */ | |
2639 | Lisp_Object symbol, old_value, where; | |
2640 | } let; | |
2641 | struct { | |
2642 | ENUM_BF (specbind_tag) kind : CHAR_BIT; | |
96c06863 | 2643 | bool_bf debug_on_exit : 1; |
9349e5f7 PE |
2644 | Lisp_Object function; |
2645 | Lisp_Object *args; | |
2646 | ptrdiff_t nargs; | |
2647 | } bt; | |
3cfe6dfd JB |
2648 | }; |
2649 | ||
9349e5f7 PE |
2650 | extern union specbinding *specpdl; |
2651 | extern union specbinding *specpdl_ptr; | |
d311d28c | 2652 | extern ptrdiff_t specpdl_size; |
3cfe6dfd | 2653 | |
00382e8b | 2654 | INLINE ptrdiff_t |
84575e67 PE |
2655 | SPECPDL_INDEX (void) |
2656 | { | |
2657 | return specpdl_ptr - specpdl; | |
2658 | } | |
acb8dc44 | 2659 | |
adf2aa61 SM |
2660 | /* This structure helps implement the `catch/throw' and `condition-case/signal' |
2661 | control structures. A struct handler contains all the information needed to | |
2662 | restore the state of the interpreter after a non-local jump. | |
50f2e553 | 2663 | |
adf2aa61 SM |
2664 | handler structures are chained together in a doubly linked list; the `next' |
2665 | member points to the next outer catchtag and the `nextfree' member points in | |
2666 | the other direction to the next inner element (which is typically the next | |
2667 | free element since we mostly use it on the deepest handler). | |
3cfe6dfd | 2668 | |
adf2aa61 | 2669 | A call like (throw TAG VAL) searches for a catchtag whose `tag_or_ch' |
d7306fe6 DN |
2670 | member is TAG, and then unbinds to it. The `val' member is used to |
2671 | hold VAL while the stack is unwound; `val' is returned as the value | |
2672 | of the catch form. | |
2673 | ||
2674 | All the other members are concerned with restoring the interpreter | |
50f2e553 | 2675 | state. |
d7306fe6 | 2676 | |
50f2e553 | 2677 | Members are volatile if their values need to survive _longjmp when |
adf2aa61 SM |
2678 | a 'struct handler' is a local variable. */ |
2679 | ||
2680 | enum handlertype { CATCHER, CONDITION_CASE }; | |
2681 | ||
2682 | struct handler | |
d7306fe6 | 2683 | { |
adf2aa61 SM |
2684 | enum handlertype type; |
2685 | Lisp_Object tag_or_ch; | |
2686 | Lisp_Object val; | |
2687 | struct handler *next; | |
2688 | struct handler *nextfree; | |
2689 | ||
2690 | /* The bytecode interpreter can have several handlers active at the same | |
2691 | time, so when we longjmp to one of them, it needs to know which handler | |
2692 | this was and what was the corresponding internal state. This is stored | |
2693 | here, and when we longjmp we make sure that handlerlist points to the | |
2694 | proper handler. */ | |
2695 | Lisp_Object *bytecode_top; | |
2696 | int bytecode_dest; | |
2697 | ||
2698 | /* Most global vars are reset to their value via the specpdl mechanism, | |
2699 | but a few others are handled by storing their value here. */ | |
96c06863 | 2700 | #if true /* GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS, but defined later. */ |
d7306fe6 | 2701 | struct gcpro *gcpro; |
2f592f95 | 2702 | #endif |
0328b6de | 2703 | sys_jmp_buf jmp; |
d311d28c | 2704 | EMACS_INT lisp_eval_depth; |
adf2aa61 | 2705 | ptrdiff_t pdlcount; |
d7306fe6 DN |
2706 | int poll_suppress_count; |
2707 | int interrupt_input_blocked; | |
d7306fe6 DN |
2708 | }; |
2709 | ||
adf2aa61 SM |
2710 | /* Fill in the components of c, and put it on the list. */ |
2711 | #define PUSH_HANDLER(c, tag_ch_val, handlertype) \ | |
70de5e86 | 2712 | if (handlerlist->nextfree) \ |
adf2aa61 SM |
2713 | (c) = handlerlist->nextfree; \ |
2714 | else \ | |
2715 | { \ | |
2716 | (c) = xmalloc (sizeof (struct handler)); \ | |
2717 | (c)->nextfree = NULL; \ | |
70de5e86 | 2718 | handlerlist->nextfree = (c); \ |
adf2aa61 SM |
2719 | } \ |
2720 | (c)->type = (handlertype); \ | |
2721 | (c)->tag_or_ch = (tag_ch_val); \ | |
2722 | (c)->val = Qnil; \ | |
2723 | (c)->next = handlerlist; \ | |
2724 | (c)->lisp_eval_depth = lisp_eval_depth; \ | |
2725 | (c)->pdlcount = SPECPDL_INDEX (); \ | |
2726 | (c)->poll_suppress_count = poll_suppress_count; \ | |
2727 | (c)->interrupt_input_blocked = interrupt_input_blocked;\ | |
2728 | (c)->gcpro = gcprolist; \ | |
adf2aa61 SM |
2729 | handlerlist = (c); |
2730 | ||
2731 | ||
22bbbd42 RS |
2732 | extern Lisp_Object memory_signal_data; |
2733 | ||
4742f524 RS |
2734 | /* Check quit-flag and quit if it is non-nil. |
2735 | Typing C-g does not directly cause a quit; it only sets Vquit_flag. | |
2736 | So the program needs to do QUIT at times when it is safe to quit. | |
2737 | Every loop that might run for a long time or might not exit | |
2738 | ought to do QUIT at least once, at a safe place. | |
2739 | Unless that is impossible, of course. | |
2740 | But it is very desirable to avoid creating loops where QUIT is impossible. | |
2741 | ||
96c06863 | 2742 | Exception: if you set immediate_quit to true, |
4742f524 RS |
2743 | then the handler that responds to the C-g does the quit itself. |
2744 | This is a good thing to do around a loop that has no side effects | |
6c07aac2 AS |
2745 | and (in particular) cannot call arbitrary Lisp code. |
2746 | ||
2747 | If quit-flag is set to `kill-emacs' the SIGINT handler has received | |
2748 | a request to exit Emacs when it is safe to do. */ | |
3cfe6dfd | 2749 | |
383e0970 | 2750 | extern void process_pending_signals (void); |
88d69b7d | 2751 | extern bool volatile pending_signals; |
6b61353c | 2752 | |
7dbda6df | 2753 | extern void process_quit_flag (void); |
a69a6e61 GM |
2754 | #define QUIT \ |
2755 | do { \ | |
2756 | if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \ | |
6d5eb5b0 | 2757 | process_quit_flag (); \ |
0caaedb1 PE |
2758 | else if (pending_signals) \ |
2759 | process_pending_signals (); \ | |
96c06863 | 2760 | } while (false) |
3cfe6dfd | 2761 | |
6b61353c | 2762 | |
96c06863 | 2763 | /* True if ought to quit now. */ |
3cfe6dfd | 2764 | |
efb859b4 | 2765 | #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) |
3cfe6dfd | 2766 | \f |
31cd66f3 PE |
2767 | extern Lisp_Object Vascii_downcase_table; |
2768 | extern Lisp_Object Vascii_canon_table; | |
3cfe6dfd | 2769 | \f |
99a3d506 | 2770 | /* Structure for recording stack slots that need marking. */ |
3cfe6dfd | 2771 | |
78edd3b7 JB |
2772 | /* This is a chain of structures, each of which points at a Lisp_Object |
2773 | variable whose value should be marked in garbage collection. | |
2774 | Normally every link of the chain is an automatic variable of a function, | |
2775 | and its `val' points to some argument or local variable of the function. | |
2776 | On exit to the function, the chain is set back to the value it had on entry. | |
2777 | This way, no link remains in the chain when the stack frame containing the | |
2778 | link disappears. | |
3cfe6dfd | 2779 | |
78edd3b7 JB |
2780 | Every function that can call Feval must protect in this fashion all |
2781 | Lisp_Object variables whose contents will be used again. */ | |
3cfe6dfd JB |
2782 | |
2783 | extern struct gcpro *gcprolist; | |
2784 | ||
2785 | struct gcpro | |
834168ef GM |
2786 | { |
2787 | struct gcpro *next; | |
e2c0561e | 2788 | |
834168ef GM |
2789 | /* Address of first protected variable. */ |
2790 | volatile Lisp_Object *var; | |
e2c0561e | 2791 | |
834168ef | 2792 | /* Number of consecutive protected variables. */ |
f66c7cf8 | 2793 | ptrdiff_t nvars; |
e2c0561e | 2794 | |
4742f524 | 2795 | #ifdef DEBUG_GCPRO |
834168ef | 2796 | int level; |
4742f524 | 2797 | #endif |
834168ef | 2798 | }; |
3cfe6dfd | 2799 | |
9f0443f9 | 2800 | /* Do something silly with gcproN vars just so gcc shuts up. */ |
656c33dc | 2801 | /* You get warnings from MIPSPro... */ |
9f0443f9 | 2802 | |
dbf31225 PE |
2803 | #define GCPRO1(varname) ((void) gcpro1) |
2804 | #define GCPRO2(varname1, varname2) ((void) gcpro2, (void) gcpro1) | |
2805 | #define GCPRO3(varname1, varname2, varname3) \ | |
2806 | ((void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2807 | #define GCPRO4(varname1, varname2, varname3, varname4) \ | |
2808 | ((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2809 | #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \ | |
2810 | ((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1) | |
2811 | #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \ | |
2812 | ((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, \ | |
2813 | (void) gcpro1) | |
518c40a2 | 2814 | #define GCPRO7(a, b, c, d, e, f, g) (GCPRO6 (a, b, c, d, e, f), (void) gcpro7) |
dbf31225 | 2815 | #define UNGCPRO ((void) 0) |
1216f5e4 | 2816 | |
5db82c9d | 2817 | /* Evaluate expr, UNGCPRO, and then return the value of expr. */ |
c47b8d02 | 2818 | #define RETURN_UNGCPRO(expr) \ |
96c06863 | 2819 | do \ |
c47b8d02 RS |
2820 | { \ |
2821 | Lisp_Object ret_ungc_val; \ | |
2822 | ret_ungc_val = (expr); \ | |
2823 | UNGCPRO; \ | |
2824 | return ret_ungc_val; \ | |
2825 | } \ | |
96c06863 | 2826 | while (false) |
4742f524 RS |
2827 | |
2828 | /* Call staticpro (&var) to protect static variable `var'. */ | |
2829 | ||
383e0970 | 2830 | void staticpro (Lisp_Object *); |
3cfe6dfd | 2831 | \f |
2f69f2ec RS |
2832 | /* Declare a Lisp-callable function. The MAXARGS parameter has the same |
2833 | meaning as in the DEFUN macro, and is used to construct a prototype. */ | |
2f69f2ec RS |
2834 | /* We can use the same trick as in the DEFUN macro to generate the |
2835 | appropriate prototype. */ | |
2836 | #define EXFUN(fnname, maxargs) \ | |
2837 | extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs | |
2f69f2ec | 2838 | |
84575e67 PE |
2839 | #include "globals.h" |
2840 | ||
526a2be7 AS |
2841 | /* Forward declarations for prototypes. */ |
2842 | struct window; | |
2843 | struct frame; | |
2f69f2ec | 2844 | |
086ca913 DA |
2845 | /* Copy COUNT Lisp_Objects from ARGS to contents of V starting from OFFSET. */ |
2846 | ||
00382e8b | 2847 | INLINE void |
086ca913 DA |
2848 | vcopy (Lisp_Object v, ptrdiff_t offset, Lisp_Object *args, ptrdiff_t count) |
2849 | { | |
7216e43b | 2850 | eassert (0 <= offset && 0 <= count && offset + count <= ASIZE (v)); |
91f2d272 | 2851 | memcpy (XVECTOR (v)->contents + offset, args, count * sizeof *args); |
086ca913 DA |
2852 | } |
2853 | ||
2854 | /* Functions to modify hash tables. */ | |
2855 | ||
00382e8b | 2856 | INLINE void |
e83064be | 2857 | set_hash_key_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val) |
4939150c | 2858 | { |
8834c57a | 2859 | gc_aset (h->key_and_value, 2 * idx, val); |
4939150c PE |
2860 | } |
2861 | ||
00382e8b | 2862 | INLINE void |
e83064be | 2863 | set_hash_value_slot (struct Lisp_Hash_Table *h, ptrdiff_t idx, Lisp_Object val) |
4939150c | 2864 | { |
8834c57a | 2865 | gc_aset (h->key_and_value, 2 * idx + 1, val); |
4939150c PE |
2866 | } |
2867 | ||
c644523b DA |
2868 | /* Use these functions to set Lisp_Object |
2869 | or pointer slots of struct Lisp_Symbol. */ | |
2870 | ||
00382e8b | 2871 | INLINE void |
c644523b DA |
2872 | set_symbol_function (Lisp_Object sym, Lisp_Object function) |
2873 | { | |
2874 | XSYMBOL (sym)->function = function; | |
2875 | } | |
2876 | ||
00382e8b | 2877 | INLINE void |
c644523b DA |
2878 | set_symbol_plist (Lisp_Object sym, Lisp_Object plist) |
2879 | { | |
2880 | XSYMBOL (sym)->plist = plist; | |
2881 | } | |
2882 | ||
00382e8b | 2883 | INLINE void |
c644523b DA |
2884 | set_symbol_next (Lisp_Object sym, struct Lisp_Symbol *next) |
2885 | { | |
2886 | XSYMBOL (sym)->next = next; | |
2887 | } | |
2888 | ||
a04e2c62 DA |
2889 | /* Buffer-local (also frame-local) variable access functions. */ |
2890 | ||
00382e8b | 2891 | INLINE int |
a04e2c62 DA |
2892 | blv_found (struct Lisp_Buffer_Local_Value *blv) |
2893 | { | |
2894 | eassert (blv->found == !EQ (blv->defcell, blv->valcell)); | |
2895 | return blv->found; | |
2896 | } | |
2897 | ||
c644523b DA |
2898 | /* Set overlay's property list. */ |
2899 | ||
00382e8b | 2900 | INLINE void |
c644523b DA |
2901 | set_overlay_plist (Lisp_Object overlay, Lisp_Object plist) |
2902 | { | |
2903 | XOVERLAY (overlay)->plist = plist; | |
2904 | } | |
2905 | ||
ad8c997f DA |
2906 | /* Get text properties of S. */ |
2907 | ||
00382e8b | 2908 | INLINE INTERVAL |
0c94c8d6 | 2909 | string_intervals (Lisp_Object s) |
ad8c997f DA |
2910 | { |
2911 | return XSTRING (s)->intervals; | |
2912 | } | |
2913 | ||
2914 | /* Set text properties of S to I. */ | |
2915 | ||
00382e8b | 2916 | INLINE void |
0c94c8d6 | 2917 | set_string_intervals (Lisp_Object s, INTERVAL i) |
ad8c997f DA |
2918 | { |
2919 | XSTRING (s)->intervals = i; | |
2920 | } | |
2921 | ||
742af32f PE |
2922 | /* Set a Lisp slot in TABLE to VAL. Most code should use this instead |
2923 | of setting slots directly. */ | |
2924 | ||
00382e8b | 2925 | INLINE void |
742af32f PE |
2926 | set_char_table_defalt (Lisp_Object table, Lisp_Object val) |
2927 | { | |
2928 | XCHAR_TABLE (table)->defalt = val; | |
2929 | } | |
00382e8b | 2930 | INLINE void |
742af32f PE |
2931 | set_char_table_purpose (Lisp_Object table, Lisp_Object val) |
2932 | { | |
2933 | XCHAR_TABLE (table)->purpose = val; | |
2934 | } | |
2935 | ||
a098c930 DA |
2936 | /* Set different slots in (sub)character tables. */ |
2937 | ||
00382e8b | 2938 | INLINE void |
34dabdb7 | 2939 | set_char_table_extras (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
2940 | { |
2941 | eassert (0 <= idx && idx < CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (table))); | |
2942 | XCHAR_TABLE (table)->extras[idx] = val; | |
2943 | } | |
2944 | ||
00382e8b | 2945 | INLINE void |
34dabdb7 | 2946 | set_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
2947 | { |
2948 | eassert (0 <= idx && idx < (1 << CHARTAB_SIZE_BITS_0)); | |
2949 | XCHAR_TABLE (table)->contents[idx] = val; | |
2950 | } | |
2951 | ||
00382e8b | 2952 | INLINE void |
34dabdb7 | 2953 | set_sub_char_table_contents (Lisp_Object table, ptrdiff_t idx, Lisp_Object val) |
a098c930 DA |
2954 | { |
2955 | XSUB_CHAR_TABLE (table)->contents[idx] = val; | |
2956 | } | |
2957 | ||
f6d62986 | 2958 | /* Defined in data.c. */ |
73bfe891 | 2959 | extern Lisp_Object Qquote, Qunbound; |
3cfe6dfd | 2960 | extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level; |
955cbe7b | 2961 | extern Lisp_Object Qerror, Qquit, Qargs_out_of_range; |
3cfe6dfd | 2962 | extern Lisp_Object Qvoid_variable, Qvoid_function; |
955cbe7b | 2963 | extern Lisp_Object Qinvalid_read_syntax; |
3cfe6dfd | 2964 | extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch; |
71873e2b | 2965 | extern Lisp_Object Quser_error, Qend_of_file, Qarith_error, Qmark_inactive; |
3cfe6dfd | 2966 | extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only; |
6b61353c | 2967 | extern Lisp_Object Qtext_read_only; |
e6cba650 | 2968 | extern Lisp_Object Qinteractive_form; |
99f3388e | 2969 | extern Lisp_Object Qcircular_list; |
73bfe891 PE |
2970 | extern Lisp_Object Qsequencep; |
2971 | extern Lisp_Object Qchar_or_string_p, Qinteger_or_marker_p; | |
955cbe7b | 2972 | extern Lisp_Object Qfboundp; |
6b61353c | 2973 | |
3cfe6dfd JB |
2974 | extern Lisp_Object Qcdr; |
2975 | ||
c990426a | 2976 | extern Lisp_Object Qrange_error, Qoverflow_error; |
3cfe6dfd | 2977 | |
73bfe891 | 2978 | extern Lisp_Object Qnumber_or_marker_p; |
6b61353c | 2979 | |
b52d6985 | 2980 | extern Lisp_Object Qbuffer, Qinteger, Qsymbol; |
3cfe6dfd | 2981 | |
e7032e7c | 2982 | /* Defined in data.c. */ |
383e0970 | 2983 | extern Lisp_Object indirect_function (Lisp_Object); |
383e0970 | 2984 | extern Lisp_Object find_symbol_value (Lisp_Object); |
ebb99847 BR |
2985 | enum Arith_Comparison { |
2986 | ARITH_EQUAL, | |
2987 | ARITH_NOTEQUAL, | |
2988 | ARITH_LESS, | |
2989 | ARITH_GRTR, | |
2990 | ARITH_LESS_OR_EQUAL, | |
2991 | ARITH_GRTR_OR_EQUAL | |
2992 | }; | |
2993 | extern Lisp_Object arithcompare (Lisp_Object num1, Lisp_Object num2, | |
2994 | enum Arith_Comparison comparison); | |
2f69f2ec | 2995 | |
be44ca6c PE |
2996 | /* Convert the integer I to an Emacs representation, either the integer |
2997 | itself, or a cons of two or three integers, or if all else fails a float. | |
2998 | I should not have side effects. */ | |
2999 | #define INTEGER_TO_CONS(i) \ | |
3000 | (! FIXNUM_OVERFLOW_P (i) \ | |
3001 | ? make_number (i) \ | |
3002 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16) \ | |
3003 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16)) \ | |
3004 | && FIXNUM_OVERFLOW_P ((i) >> 16)) \ | |
3005 | ? Fcons (make_number ((i) >> 16), make_number ((i) & 0xffff)) \ | |
3006 | : ! ((FIXNUM_OVERFLOW_P (INTMAX_MIN >> 16 >> 24) \ | |
3007 | || FIXNUM_OVERFLOW_P (UINTMAX_MAX >> 16 >> 24)) \ | |
3008 | && FIXNUM_OVERFLOW_P ((i) >> 16 >> 24)) \ | |
3009 | ? Fcons (make_number ((i) >> 16 >> 24), \ | |
3010 | Fcons (make_number ((i) >> 16 & 0xffffff), \ | |
3011 | make_number ((i) & 0xffff))) \ | |
3012 | : make_float (i)) | |
3013 | ||
3014 | /* Convert the Emacs representation CONS back to an integer of type | |
3015 | TYPE, storing the result the variable VAR. Signal an error if CONS | |
3016 | is not a valid representation or is out of range for TYPE. */ | |
3017 | #define CONS_TO_INTEGER(cons, type, var) \ | |
3018 | (TYPE_SIGNED (type) \ | |
3019 | ? ((var) = cons_to_signed (cons, TYPE_MINIMUM (type), TYPE_MAXIMUM (type))) \ | |
3020 | : ((var) = cons_to_unsigned (cons, TYPE_MAXIMUM (type)))) | |
3021 | extern intmax_t cons_to_signed (Lisp_Object, intmax_t, intmax_t); | |
3022 | extern uintmax_t cons_to_unsigned (Lisp_Object, uintmax_t); | |
3023 | ||
ad97b375 | 3024 | extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *); |
845ca893 PE |
3025 | extern _Noreturn void args_out_of_range (Lisp_Object, Lisp_Object); |
3026 | extern _Noreturn void args_out_of_range_3 (Lisp_Object, Lisp_Object, | |
3027 | Lisp_Object); | |
ce5b453a | 3028 | extern Lisp_Object do_symval_forwarding (union Lisp_Fwd *); |
de1339b0 | 3029 | extern void set_internal (Lisp_Object, Lisp_Object, Lisp_Object, bool); |
383e0970 | 3030 | extern void syms_of_data (void); |
383e0970 | 3031 | extern void swap_in_global_binding (struct Lisp_Symbol *); |
3cfe6dfd | 3032 | |
a37e10f9 | 3033 | /* Defined in cmds.c */ |
383e0970 J |
3034 | extern void syms_of_cmds (void); |
3035 | extern void keys_of_cmds (void); | |
a37e10f9 | 3036 | |
e7032e7c | 3037 | /* Defined in coding.c. */ |
2f7c71a1 | 3038 | extern Lisp_Object Qcharset; |
d311d28c | 3039 | extern Lisp_Object detect_coding_system (const unsigned char *, ptrdiff_t, |
f10fe38f | 3040 | ptrdiff_t, bool, bool, Lisp_Object); |
383e0970 J |
3041 | extern void init_coding (void); |
3042 | extern void init_coding_once (void); | |
3043 | extern void syms_of_coding (void); | |
1842abb2 | 3044 | |
e7032e7c | 3045 | /* Defined in character.c. */ |
d311d28c PE |
3046 | extern ptrdiff_t chars_in_text (const unsigned char *, ptrdiff_t); |
3047 | extern ptrdiff_t multibyte_chars_in_text (const unsigned char *, ptrdiff_t); | |
2f7c71a1 AS |
3048 | extern void syms_of_character (void); |
3049 | ||
e7032e7c | 3050 | /* Defined in charset.c. */ |
383e0970 J |
3051 | extern void init_charset (void); |
3052 | extern void init_charset_once (void); | |
3053 | extern void syms_of_charset (void); | |
8f924df7 KH |
3054 | /* Structure forward declarations. */ |
3055 | struct charset; | |
5e741a41 | 3056 | |
e7032e7c | 3057 | /* Defined in syntax.c. */ |
383e0970 J |
3058 | extern void init_syntax_once (void); |
3059 | extern void syms_of_syntax (void); | |
a37e10f9 | 3060 | |
e7032e7c | 3061 | /* Defined in fns.c. */ |
99f3388e | 3062 | extern Lisp_Object QCrehash_size, QCrehash_threshold; |
ca9ce8f2 | 3063 | enum { NEXT_ALMOST_PRIME_LIMIT = 11 }; |
5994c183 | 3064 | extern EMACS_INT next_almost_prime (EMACS_INT) ATTRIBUTE_CONST; |
d311d28c | 3065 | extern Lisp_Object larger_vector (Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 3066 | extern void sweep_weak_hash_tables (void); |
e6cba650 | 3067 | extern Lisp_Object Qcursor_in_echo_area; |
3cfe6dfd | 3068 | extern Lisp_Object Qstring_lessp; |
53371430 | 3069 | extern Lisp_Object QCsize, QCtest, QCweakness, Qequal, Qeq; |
3cc5a532 | 3070 | EMACS_UINT hash_string (char const *, ptrdiff_t); |
0de4bb68 | 3071 | EMACS_UINT sxhash (Lisp_Object, int); |
b7432bb2 SM |
3072 | Lisp_Object make_hash_table (struct hash_table_test, Lisp_Object, Lisp_Object, |
3073 | Lisp_Object, Lisp_Object); | |
d3411f89 PE |
3074 | ptrdiff_t hash_lookup (struct Lisp_Hash_Table *, Lisp_Object, EMACS_UINT *); |
3075 | ptrdiff_t hash_put (struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object, | |
0de4bb68 | 3076 | EMACS_UINT); |
53371430 | 3077 | extern struct hash_table_test hashtest_eql, hashtest_equal; |
51e12e8e DA |
3078 | extern void validate_subarray (Lisp_Object, Lisp_Object, Lisp_Object, |
3079 | ptrdiff_t, ptrdiff_t *, ptrdiff_t *); | |
d311d28c PE |
3080 | extern Lisp_Object substring_both (Lisp_Object, ptrdiff_t, ptrdiff_t, |
3081 | ptrdiff_t, ptrdiff_t); | |
6318cde0 | 3082 | extern Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 | 3083 | extern Lisp_Object do_yes_or_no_p (Lisp_Object); |
383e0970 J |
3084 | extern Lisp_Object concat2 (Lisp_Object, Lisp_Object); |
3085 | extern Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3086 | extern Lisp_Object nconc2 (Lisp_Object, Lisp_Object); | |
3087 | extern Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object); | |
3088 | extern Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object); | |
3089 | extern void clear_string_char_byte_cache (void); | |
d311d28c PE |
3090 | extern ptrdiff_t string_char_to_byte (Lisp_Object, ptrdiff_t); |
3091 | extern ptrdiff_t string_byte_to_char (Lisp_Object, ptrdiff_t); | |
383e0970 J |
3092 | extern Lisp_Object string_to_multibyte (Lisp_Object); |
3093 | extern Lisp_Object string_make_unibyte (Lisp_Object); | |
383e0970 | 3094 | extern void syms_of_fns (void); |
2f69f2ec | 3095 | |
e7032e7c | 3096 | /* Defined in floatfns.c. */ |
383e0970 | 3097 | extern void syms_of_floatfns (void); |
3d608a86 | 3098 | extern Lisp_Object fmod_float (Lisp_Object x, Lisp_Object y); |
3cfe6dfd | 3099 | |
e7032e7c | 3100 | /* Defined in fringe.c. */ |
383e0970 J |
3101 | extern void syms_of_fringe (void); |
3102 | extern void init_fringe (void); | |
524c7aa6 PE |
3103 | #ifdef HAVE_WINDOW_SYSTEM |
3104 | extern void mark_fringe_data (void); | |
383e0970 | 3105 | extern void init_fringe_once (void); |
524c7aa6 | 3106 | #endif /* HAVE_WINDOW_SYSTEM */ |
6b61353c | 3107 | |
e7032e7c | 3108 | /* Defined in image.c. */ |
955cbe7b PE |
3109 | extern Lisp_Object QCascent, QCmargin, QCrelief; |
3110 | extern Lisp_Object QCconversion; | |
0766b489 | 3111 | extern int x_bitmap_mask (struct frame *, ptrdiff_t); |
aa15c6bb | 3112 | extern void reset_image_types (void); |
383e0970 | 3113 | extern void syms_of_image (void); |
6b61353c | 3114 | |
e7032e7c | 3115 | /* Defined in insdel.c. */ |
b8b31967 | 3116 | extern Lisp_Object Qinhibit_modification_hooks; |
73bfe891 | 3117 | extern Lisp_Object Qregion_extract_function; |
d311d28c | 3118 | extern void move_gap_both (ptrdiff_t, ptrdiff_t); |
845ca893 | 3119 | extern _Noreturn void buffer_overflow (void); |
d311d28c | 3120 | extern void make_gap (ptrdiff_t); |
eefd7278 | 3121 | extern void make_gap_1 (struct buffer *, ptrdiff_t); |
d311d28c | 3122 | extern ptrdiff_t copy_text (const unsigned char *, unsigned char *, |
a08d4ba7 | 3123 | ptrdiff_t, bool, bool); |
ae19ba7c | 3124 | extern int count_combining_before (const unsigned char *, |
d311d28c | 3125 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
ae19ba7c | 3126 | extern int count_combining_after (const unsigned char *, |
d311d28c PE |
3127 | ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3128 | extern void insert (const char *, ptrdiff_t); | |
3129 | extern void insert_and_inherit (const char *, ptrdiff_t); | |
d311d28c | 3130 | extern void insert_1_both (const char *, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3131 | bool, bool, bool); |
8a44e6d1 | 3132 | extern void insert_from_gap (ptrdiff_t, ptrdiff_t, bool text_at_gap_tail); |
d311d28c | 3133 | extern void insert_from_string (Lisp_Object, ptrdiff_t, ptrdiff_t, |
a08d4ba7 PE |
3134 | ptrdiff_t, ptrdiff_t, bool); |
3135 | extern void insert_from_buffer (struct buffer *, ptrdiff_t, ptrdiff_t, bool); | |
ae19ba7c SM |
3136 | extern void insert_char (int); |
3137 | extern void insert_string (const char *); | |
d311d28c PE |
3138 | extern void insert_before_markers (const char *, ptrdiff_t); |
3139 | extern void insert_before_markers_and_inherit (const char *, ptrdiff_t); | |
3140 | extern void insert_from_string_before_markers (Lisp_Object, ptrdiff_t, | |
3141 | ptrdiff_t, ptrdiff_t, | |
a08d4ba7 | 3142 | ptrdiff_t, bool); |
d311d28c | 3143 | extern void del_range (ptrdiff_t, ptrdiff_t); |
a08d4ba7 PE |
3144 | extern Lisp_Object del_range_1 (ptrdiff_t, ptrdiff_t, bool, bool); |
3145 | extern void del_range_byte (ptrdiff_t, ptrdiff_t, bool); | |
3146 | extern void del_range_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, bool); | |
d311d28c | 3147 | extern Lisp_Object del_range_2 (ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3148 | ptrdiff_t, ptrdiff_t, bool); |
00012b86 | 3149 | extern void modify_text (ptrdiff_t, ptrdiff_t); |
d311d28c | 3150 | extern void prepare_to_modify_buffer (ptrdiff_t, ptrdiff_t, ptrdiff_t *); |
00012b86 | 3151 | extern void prepare_to_modify_buffer_1 (ptrdiff_t, ptrdiff_t, ptrdiff_t *); |
37c790b3 | 3152 | extern void invalidate_buffer_caches (struct buffer *, ptrdiff_t, ptrdiff_t); |
d311d28c PE |
3153 | extern void signal_after_change (ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3154 | extern void adjust_after_insert (ptrdiff_t, ptrdiff_t, ptrdiff_t, | |
3155 | ptrdiff_t, ptrdiff_t); | |
3156 | extern void adjust_markers_for_delete (ptrdiff_t, ptrdiff_t, | |
3157 | ptrdiff_t, ptrdiff_t); | |
a08d4ba7 | 3158 | extern void replace_range (ptrdiff_t, ptrdiff_t, Lisp_Object, bool, bool, bool); |
d311d28c | 3159 | extern void replace_range_2 (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3160 | const char *, ptrdiff_t, ptrdiff_t, bool); |
ae19ba7c | 3161 | extern void syms_of_insdel (void); |
c98adc1b | 3162 | |
e7032e7c | 3163 | /* Defined in dispnew.c. */ |
9e4bf381 PE |
3164 | #if (defined PROFILING \ |
3165 | && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__)) | |
845ca893 | 3166 | _Noreturn void __executable_start (void); |
9e4bf381 | 3167 | #endif |
7684e57b | 3168 | extern Lisp_Object Vwindow_system; |
59ea14cd | 3169 | extern Lisp_Object sit_for (Lisp_Object, bool, int); |
1747fb16 | 3170 | |
e7032e7c | 3171 | /* Defined in xdisp.c. */ |
c6ae41f3 | 3172 | extern Lisp_Object Qinhibit_point_motion_hooks; |
73bfe891 | 3173 | extern Lisp_Object Qinhibit_redisplay; |
99f3388e | 3174 | extern Lisp_Object Qmenu_bar_update_hook; |
29208e82 | 3175 | extern Lisp_Object Qwindow_scroll_functions; |
99f3388e | 3176 | extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map; |
73bfe891 | 3177 | extern Lisp_Object Qtext, Qboth, Qboth_horiz, Qtext_image_horiz; |
89dc303e | 3178 | extern Lisp_Object Qspace, Qcenter, QCalign_to; |
73bfe891 | 3179 | extern Lisp_Object Qbar, Qhbar, Qhollow; |
99f3388e | 3180 | extern Lisp_Object Qleft_margin, Qright_margin; |
89dc303e | 3181 | extern Lisp_Object QCdata, QCfile; |
99f3388e | 3182 | extern Lisp_Object QCmap; |
e6cba650 | 3183 | extern Lisp_Object Qrisky_local_variable; |
e08813d0 | 3184 | extern bool noninteractive_need_newline; |
986113df | 3185 | extern Lisp_Object echo_area_buffer[2]; |
89dc303e | 3186 | extern void add_to_log (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
3187 | extern void check_message_stack (void); |
3188 | extern void setup_echo_area_for_printing (int); | |
fce31d69 | 3189 | extern bool push_message (void); |
27e498e6 | 3190 | extern void pop_message_unwind (void); |
383e0970 | 3191 | extern Lisp_Object restore_message_unwind (Lisp_Object); |
383e0970 J |
3192 | extern void restore_message (void); |
3193 | extern Lisp_Object current_message (void); | |
44ad1cf7 | 3194 | extern void clear_message (bool, bool); |
1e973bc7 | 3195 | extern void message (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
a8fe7202 AS |
3196 | extern void message1 (const char *); |
3197 | extern void message1_nolog (const char *); | |
b09cca6a SM |
3198 | extern void message3 (Lisp_Object); |
3199 | extern void message3_nolog (Lisp_Object); | |
0063fdb1 | 3200 | extern void message_dolog (const char *, ptrdiff_t, bool, bool); |
a8fe7202 | 3201 | extern void message_with_string (const char *, Lisp_Object, int); |
383e0970 J |
3202 | extern void message_log_maybe_newline (void); |
3203 | extern void update_echo_area (void); | |
d311d28c | 3204 | extern void truncate_echo_area (ptrdiff_t); |
383e0970 | 3205 | extern void redisplay (void); |
c4bf5bc3 | 3206 | |
383e0970 J |
3207 | void set_frame_cursor_types (struct frame *, Lisp_Object); |
3208 | extern void syms_of_xdisp (void); | |
3209 | extern void init_xdisp (void); | |
3210 | extern Lisp_Object safe_eval (Lisp_Object); | |
d311d28c | 3211 | extern int pos_visible_p (struct window *, ptrdiff_t, int *, |
383e0970 | 3212 | int *, int *, int *, int *, int *); |
c98adc1b | 3213 | |
e7032e7c | 3214 | /* Defined in xsettings.c. */ |
383e0970 | 3215 | extern void syms_of_xsettings (void); |
637fa988 | 3216 | |
15b0ced5 | 3217 | /* Defined in vm-limit.c. */ |
261cb4bb | 3218 | extern void memory_warnings (void *, void (*warnfun) (const char *)); |
9043c90a | 3219 | |
e7032e7c | 3220 | /* Defined in alloc.c. */ |
383e0970 | 3221 | extern void check_pure_size (void); |
73ebd38f | 3222 | extern void free_misc (Lisp_Object); |
413d18e7 | 3223 | extern void allocate_string_data (struct Lisp_String *, EMACS_INT, EMACS_INT); |
a8fe7202 | 3224 | extern void malloc_warning (const char *); |
845ca893 PE |
3225 | extern _Noreturn void memory_full (size_t); |
3226 | extern _Noreturn void buffer_memory_full (ptrdiff_t); | |
69003fd8 | 3227 | #if defined REL_ALLOC && !defined SYSTEM_MALLOC |
84dfc8a7 | 3228 | extern void refill_memory_reserve (void); |
69003fd8 | 3229 | #endif |
50c77428 | 3230 | extern const char *pending_malloc_warning; |
9730daca | 3231 | extern Lisp_Object zero_vector; |
2f7c71a1 AS |
3232 | extern Lisp_Object list1 (Lisp_Object); |
3233 | extern Lisp_Object list2 (Lisp_Object, Lisp_Object); | |
3234 | extern Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3235 | extern Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3236 | extern Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, | |
3237 | Lisp_Object); | |
3438fe21 | 3238 | enum constype {CONSTYPE_HEAP, CONSTYPE_PURE}; |
694b6c97 | 3239 | extern Lisp_Object listn (enum constype, ptrdiff_t, Lisp_Object, ...); |
3de717bd DA |
3240 | |
3241 | /* Build a frequently used 2/3/4-integer lists. */ | |
3242 | ||
00382e8b | 3243 | INLINE Lisp_Object |
3de717bd DA |
3244 | list2i (EMACS_INT x, EMACS_INT y) |
3245 | { | |
3246 | return list2 (make_number (x), make_number (y)); | |
3247 | } | |
3248 | ||
00382e8b | 3249 | INLINE Lisp_Object |
3de717bd DA |
3250 | list3i (EMACS_INT x, EMACS_INT y, EMACS_INT w) |
3251 | { | |
3252 | return list3 (make_number (x), make_number (y), make_number (w)); | |
3253 | } | |
3254 | ||
00382e8b | 3255 | INLINE Lisp_Object |
3de717bd DA |
3256 | list4i (EMACS_INT x, EMACS_INT y, EMACS_INT w, EMACS_INT h) |
3257 | { | |
3258 | return list4 (make_number (x), make_number (y), | |
3259 | make_number (w), make_number (h)); | |
3260 | } | |
3261 | ||
2cf00efc PE |
3262 | extern Lisp_Object make_uninit_bool_vector (EMACS_INT); |
3263 | extern Lisp_Object bool_vector_fill (Lisp_Object, Lisp_Object); | |
845ca893 | 3264 | extern _Noreturn void string_overflow (void); |
d311d28c | 3265 | extern Lisp_Object make_string (const char *, ptrdiff_t); |
26bccfae PE |
3266 | extern Lisp_Object make_formatted_string (char *, const char *, ...) |
3267 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
d311d28c | 3268 | extern Lisp_Object make_unibyte_string (const char *, ptrdiff_t); |
d7ea76b4 DA |
3269 | |
3270 | /* Make unibyte string from C string when the length isn't known. */ | |
3271 | ||
00382e8b | 3272 | INLINE Lisp_Object |
d7ea76b4 DA |
3273 | build_unibyte_string (const char *str) |
3274 | { | |
3275 | return make_unibyte_string (str, strlen (str)); | |
3276 | } | |
3277 | ||
d311d28c | 3278 | extern Lisp_Object make_multibyte_string (const char *, ptrdiff_t, ptrdiff_t); |
0c90b9ee | 3279 | extern Lisp_Object make_event_array (ptrdiff_t, Lisp_Object *); |
413d18e7 EZ |
3280 | extern Lisp_Object make_uninit_string (EMACS_INT); |
3281 | extern Lisp_Object make_uninit_multibyte_string (EMACS_INT, EMACS_INT); | |
d311d28c | 3282 | extern Lisp_Object make_string_from_bytes (const char *, ptrdiff_t, ptrdiff_t); |
14162469 | 3283 | extern Lisp_Object make_specified_string (const char *, |
fce31d69 PE |
3284 | ptrdiff_t, ptrdiff_t, bool); |
3285 | extern Lisp_Object make_pure_string (const char *, ptrdiff_t, ptrdiff_t, bool); | |
2a0213a6 DA |
3286 | extern Lisp_Object make_pure_c_string (const char *, ptrdiff_t); |
3287 | ||
3288 | /* Make a string allocated in pure space, use STR as string data. */ | |
3289 | ||
00382e8b | 3290 | INLINE Lisp_Object |
2a0213a6 DA |
3291 | build_pure_c_string (const char *str) |
3292 | { | |
3293 | return make_pure_c_string (str, strlen (str)); | |
3294 | } | |
1130ecfc DA |
3295 | |
3296 | /* Make a string from the data at STR, treating it as multibyte if the | |
3297 | data warrants. */ | |
3298 | ||
00382e8b | 3299 | INLINE Lisp_Object |
1130ecfc DA |
3300 | build_string (const char *str) |
3301 | { | |
3302 | return make_string (str, strlen (str)); | |
3303 | } | |
3304 | ||
383e0970 | 3305 | extern Lisp_Object pure_cons (Lisp_Object, Lisp_Object); |
3017f87f | 3306 | extern void make_byte_code (struct Lisp_Vector *); |
7f73dc9d | 3307 | extern Lisp_Object Qchar_table_extra_slots; |
383e0970 | 3308 | extern struct Lisp_Vector *allocate_vector (EMACS_INT); |
25721f5b | 3309 | |
8b17a8b9 | 3310 | /* Make an uninitialized vector for SIZE objects. NOTE: you must |
25721f5b DA |
3311 | be sure that GC cannot happen until the vector is completely |
3312 | initialized. E.g. the following code is likely to crash: | |
3313 | ||
3314 | v = make_uninit_vector (3); | |
3315 | ASET (v, 0, obj0); | |
3316 | ASET (v, 1, Ffunction_can_gc ()); | |
3317 | ASET (v, 2, obj1); */ | |
3318 | ||
00382e8b | 3319 | INLINE Lisp_Object |
25721f5b DA |
3320 | make_uninit_vector (ptrdiff_t size) |
3321 | { | |
3322 | Lisp_Object v; | |
3323 | struct Lisp_Vector *p; | |
3324 | ||
3325 | p = allocate_vector (size); | |
3326 | XSETVECTOR (v, p); | |
3327 | return v; | |
3328 | } | |
3329 | ||
914adc42 | 3330 | extern struct Lisp_Vector *allocate_pseudovector (int, int, enum pvec_type); |
30f95089 SM |
3331 | #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \ |
3332 | ((typ*) \ | |
3333 | allocate_pseudovector \ | |
3334 | (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag)) | |
383e0970 J |
3335 | extern struct Lisp_Hash_Table *allocate_hash_table (void); |
3336 | extern struct window *allocate_window (void); | |
3337 | extern struct frame *allocate_frame (void); | |
3338 | extern struct Lisp_Process *allocate_process (void); | |
3339 | extern struct terminal *allocate_terminal (void); | |
383e0970 J |
3340 | extern Lisp_Object make_float (double); |
3341 | extern void display_malloc_warning (void); | |
1396ac86 PE |
3342 | extern Lisp_Object make_save_int_int_int (ptrdiff_t, ptrdiff_t, ptrdiff_t); |
3343 | extern Lisp_Object make_save_obj_obj_obj_obj (Lisp_Object, Lisp_Object, | |
3344 | Lisp_Object, Lisp_Object); | |
3345 | extern Lisp_Object make_save_ptr (void *); | |
3346 | extern Lisp_Object make_save_ptr_int (void *, ptrdiff_t); | |
3347 | extern Lisp_Object make_save_ptr_ptr (void *, void *); | |
3348 | extern Lisp_Object make_save_funcptr_ptr_obj (void (*) (void), void *, | |
3349 | Lisp_Object); | |
3350 | extern Lisp_Object make_save_memory (Lisp_Object *, ptrdiff_t); | |
27e498e6 | 3351 | extern void free_save_value (Lisp_Object); |
d7a7fda3 | 3352 | extern Lisp_Object build_overlay (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
3353 | extern void init_alloc_once (void); |
3354 | extern void init_alloc (void); | |
3355 | extern void syms_of_alloc (void); | |
3356 | extern struct buffer * allocate_buffer (void); | |
3357 | extern int valid_lisp_object_p (Lisp_Object); | |
8d3103b1 | 3358 | extern int relocatable_string_data_p (const char *); |
3cfe6dfd | 3359 | |
a041960a | 3360 | #ifdef REL_ALLOC |
e7032e7c | 3361 | /* Defined in ralloc.c. */ |
74fde0f4 | 3362 | extern void *r_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2)); |
a041960a | 3363 | extern void r_alloc_free (void **); |
74fde0f4 | 3364 | extern void *r_re_alloc (void **, size_t) ATTRIBUTE_ALLOC_SIZE ((2)); |
a041960a | 3365 | extern void r_alloc_reset_variable (void **, void **); |
57b81a9f | 3366 | extern void r_alloc_inhibit_buffer_relocation (int); |
a041960a PE |
3367 | #endif |
3368 | ||
e7032e7c | 3369 | /* Defined in chartab.c. */ |
383e0970 | 3370 | extern Lisp_Object copy_char_table (Lisp_Object); |
383e0970 J |
3371 | extern Lisp_Object char_table_ref_and_range (Lisp_Object, int, |
3372 | int *, int *); | |
e757f1c6 | 3373 | extern void char_table_set_range (Lisp_Object, int, int, Lisp_Object); |
383e0970 J |
3374 | extern void map_char_table (void (*) (Lisp_Object, Lisp_Object, |
3375 | Lisp_Object), | |
3376 | Lisp_Object, Lisp_Object, Lisp_Object); | |
e6cba650 DN |
3377 | extern void map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object), |
3378 | Lisp_Object, Lisp_Object, | |
3379 | Lisp_Object, struct charset *, | |
3380 | unsigned, unsigned); | |
5cc7f7af | 3381 | extern Lisp_Object uniprop_table (Lisp_Object); |
383e0970 | 3382 | extern void syms_of_chartab (void); |
1842abb2 | 3383 | |
e7032e7c | 3384 | /* Defined in print.c. */ |
3cfe6dfd | 3385 | extern Lisp_Object Vprin1_to_string_buffer; |
42c8bc9b | 3386 | extern void debug_print (Lisp_Object) EXTERNALLY_VISIBLE; |
29208e82 | 3387 | extern Lisp_Object Qstandard_output; |
9453ea7b | 3388 | extern Lisp_Object Qexternal_debugging_output; |
383e0970 | 3389 | extern void temp_output_buffer_setup (const char *); |
29208e82 | 3390 | extern int print_level; |
3cfe6dfd | 3391 | extern Lisp_Object Qprint_escape_newlines; |
a8fe7202 | 3392 | extern void write_string (const char *, int); |
a8fe7202 AS |
3393 | extern void print_error_message (Lisp_Object, Lisp_Object, const char *, |
3394 | Lisp_Object); | |
526a2be7 | 3395 | extern Lisp_Object internal_with_output_to_temp_buffer |
383e0970 | 3396 | (const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
1915d8d6 | 3397 | #define FLOAT_TO_STRING_BUFSIZE 350 |
99027bdd | 3398 | extern int float_to_string (char *, double); |
cf4bb06d | 3399 | extern void init_print_once (void); |
383e0970 | 3400 | extern void syms_of_print (void); |
526a2be7 | 3401 | |
e7032e7c | 3402 | /* Defined in doprnt.c. */ |
c2d1e36d PE |
3403 | extern ptrdiff_t doprnt (char *, ptrdiff_t, const char *, const char *, |
3404 | va_list); | |
62f19c19 PE |
3405 | extern ptrdiff_t esprintf (char *, char const *, ...) |
3406 | ATTRIBUTE_FORMAT_PRINTF (2, 3); | |
62f19c19 PE |
3407 | extern ptrdiff_t exprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, |
3408 | char const *, ...) | |
3409 | ATTRIBUTE_FORMAT_PRINTF (5, 6); | |
3410 | extern ptrdiff_t evxprintf (char **, ptrdiff_t *, char const *, ptrdiff_t, | |
3411 | char const *, va_list) | |
3412 | ATTRIBUTE_FORMAT_PRINTF (5, 0); | |
e6c3da20 | 3413 | |
ea6c7ae6 | 3414 | /* Defined in lread.c. */ |
3cfe6dfd | 3415 | extern Lisp_Object Qvariable_documentation, Qstandard_input; |
99f3388e | 3416 | extern Lisp_Object Qbackquote, Qcomma, Qcomma_at, Qcomma_dot, Qfunction; |
a411ac43 | 3417 | extern Lisp_Object Qlexical_binding; |
383e0970 | 3418 | extern Lisp_Object check_obarray (Lisp_Object); |
e8df9267 DA |
3419 | extern Lisp_Object intern_1 (const char *, ptrdiff_t); |
3420 | extern Lisp_Object intern_c_string_1 (const char *, ptrdiff_t); | |
d311d28c | 3421 | extern Lisp_Object oblookup (Lisp_Object, const char *, ptrdiff_t, ptrdiff_t); |
00382e8b | 3422 | INLINE void |
84575e67 PE |
3423 | LOADHIST_ATTACH (Lisp_Object x) |
3424 | { | |
3425 | if (initialized) | |
3426 | Vcurrent_load_list = Fcons (x, Vcurrent_load_list); | |
3427 | } | |
383e0970 | 3428 | extern int openp (Lisp_Object, Lisp_Object, Lisp_Object, |
518c40a2 | 3429 | Lisp_Object *, Lisp_Object, bool); |
7cded46f | 3430 | extern Lisp_Object string_to_number (char const *, int, bool); |
383e0970 J |
3431 | extern void map_obarray (Lisp_Object, void (*) (Lisp_Object, Lisp_Object), |
3432 | Lisp_Object); | |
a8fe7202 | 3433 | extern void dir_warning (const char *, Lisp_Object); |
383e0970 J |
3434 | extern void init_obarray (void); |
3435 | extern void init_lread (void); | |
3436 | extern void syms_of_lread (void); | |
3cfe6dfd | 3437 | |
00382e8b | 3438 | INLINE Lisp_Object |
e8df9267 DA |
3439 | intern (const char *str) |
3440 | { | |
3441 | return intern_1 (str, strlen (str)); | |
3442 | } | |
3443 | ||
00382e8b | 3444 | INLINE Lisp_Object |
e8df9267 DA |
3445 | intern_c_string (const char *str) |
3446 | { | |
3447 | return intern_c_string_1 (str, strlen (str)); | |
3448 | } | |
3449 | ||
f6d62986 | 3450 | /* Defined in eval.c. */ |
73bfe891 | 3451 | extern Lisp_Object Qexit, Qinteractive, Qcommandp, Qmacro; |
a411ac43 | 3452 | extern Lisp_Object Qinhibit_quit, Qinternal_interpreter_environment, Qclosure; |
955cbe7b | 3453 | extern Lisp_Object Qand_rest; |
3cfe6dfd | 3454 | extern Lisp_Object Vautoload_queue; |
fab88cb7 | 3455 | extern Lisp_Object Vsignaling_function; |
d1f55f16 | 3456 | extern Lisp_Object inhibit_lisp_code; |
244ed907 | 3457 | extern struct handler *handlerlist; |
adf2aa61 | 3458 | |
f1b6e5fc SM |
3459 | /* To run a normal hook, use the appropriate function from the list below. |
3460 | The calling convention: | |
3461 | ||
846d69ac | 3462 | if (!NILP (Vrun_hooks)) |
f1b6e5fc SM |
3463 | call1 (Vrun_hooks, Qmy_funny_hook); |
3464 | ||
3465 | should no longer be used. */ | |
3cfe6dfd | 3466 | extern Lisp_Object Vrun_hooks; |
383e0970 | 3467 | extern void run_hook_with_args_2 (Lisp_Object, Lisp_Object, Lisp_Object); |
f66c7cf8 | 3468 | extern Lisp_Object run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args, |
f6d62986 | 3469 | Lisp_Object (*funcall) |
f66c7cf8 | 3470 | (ptrdiff_t nargs, Lisp_Object *args)); |
845ca893 PE |
3471 | extern _Noreturn void xsignal (Lisp_Object, Lisp_Object); |
3472 | extern _Noreturn void xsignal0 (Lisp_Object); | |
3473 | extern _Noreturn void xsignal1 (Lisp_Object, Lisp_Object); | |
3474 | extern _Noreturn void xsignal2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3475 | extern _Noreturn void xsignal3 (Lisp_Object, Lisp_Object, Lisp_Object, | |
3476 | Lisp_Object); | |
3477 | extern _Noreturn void signal_error (const char *, Lisp_Object); | |
defb1411 | 3478 | extern Lisp_Object eval_sub (Lisp_Object form); |
383e0970 J |
3479 | extern Lisp_Object apply1 (Lisp_Object, Lisp_Object); |
3480 | extern Lisp_Object call0 (Lisp_Object); | |
3481 | extern Lisp_Object call1 (Lisp_Object, Lisp_Object); | |
3482 | extern Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object); | |
3483 | extern Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3484 | extern Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3485 | extern Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3486 | extern Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
3487 | extern Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object); | |
383e0970 J |
3488 | extern Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object); |
3489 | extern Lisp_Object internal_lisp_condition_case (Lisp_Object, Lisp_Object, Lisp_Object); | |
3490 | extern Lisp_Object internal_condition_case (Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
3491 | extern Lisp_Object internal_condition_case_1 (Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
3492 | extern Lisp_Object internal_condition_case_2 (Lisp_Object (*) (Lisp_Object, Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)); | |
cc92c454 SM |
3493 | extern Lisp_Object internal_condition_case_n |
3494 | (Lisp_Object (*) (ptrdiff_t, Lisp_Object *), ptrdiff_t, Lisp_Object *, | |
3495 | Lisp_Object, Lisp_Object (*) (Lisp_Object, ptrdiff_t, Lisp_Object *)); | |
383e0970 | 3496 | extern void specbind (Lisp_Object, Lisp_Object); |
27e498e6 | 3497 | extern void record_unwind_protect (void (*) (Lisp_Object), Lisp_Object); |
27e498e6 | 3498 | extern void record_unwind_protect_ptr (void (*) (void *), void *); |
94fcd171 | 3499 | extern void record_unwind_protect_int (void (*) (int), int); |
27e498e6 | 3500 | extern void record_unwind_protect_void (void (*) (void)); |
f4b1eb36 | 3501 | extern void record_unwind_protect_nothing (void); |
a0931322 | 3502 | extern void clear_unwind_protect (ptrdiff_t); |
94fcd171 | 3503 | extern void set_unwind_protect (ptrdiff_t, void (*) (Lisp_Object), Lisp_Object); |
a0931322 | 3504 | extern void set_unwind_protect_ptr (ptrdiff_t, void (*) (void *), void *); |
d311d28c | 3505 | extern Lisp_Object unbind_to (ptrdiff_t, Lisp_Object); |
845ca893 PE |
3506 | extern _Noreturn void error (const char *, ...) ATTRIBUTE_FORMAT_PRINTF (1, 2); |
3507 | extern _Noreturn void verror (const char *, va_list) | |
3508 | ATTRIBUTE_FORMAT_PRINTF (1, 0); | |
27e498e6 | 3509 | extern void un_autoload (Lisp_Object); |
7f7e0167 | 3510 | extern Lisp_Object call_debugger (Lisp_Object arg); |
383e0970 | 3511 | extern void init_eval_once (void); |
6cd7a139 | 3512 | extern Lisp_Object safe_call (ptrdiff_t, Lisp_Object, ...); |
383e0970 | 3513 | extern Lisp_Object safe_call1 (Lisp_Object, Lisp_Object); |
58555d81 | 3514 | extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
3515 | extern void init_eval (void); |
3516 | extern void syms_of_eval (void); | |
27e498e6 | 3517 | extern void unwind_body (Lisp_Object); |
2f592f95 SM |
3518 | extern void record_in_backtrace (Lisp_Object function, |
3519 | Lisp_Object *args, ptrdiff_t nargs); | |
3520 | extern void mark_specpdl (void); | |
3521 | extern void get_backtrace (Lisp_Object array); | |
3522 | Lisp_Object backtrace_top_function (void); | |
3523 | extern bool let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol); | |
3524 | extern bool let_shadows_global_binding_p (Lisp_Object symbol); | |
3525 | ||
3cfe6dfd | 3526 | |
7abaf5cc | 3527 | /* Defined in editfns.c. */ |
e6cba650 | 3528 | extern Lisp_Object Qfield; |
383e0970 | 3529 | extern void insert1 (Lisp_Object); |
a8fe7202 | 3530 | extern Lisp_Object format2 (const char *, Lisp_Object, Lisp_Object); |
383e0970 J |
3531 | extern Lisp_Object save_excursion_save (void); |
3532 | extern Lisp_Object save_restriction_save (void); | |
27e498e6 PE |
3533 | extern void save_excursion_restore (Lisp_Object); |
3534 | extern void save_restriction_restore (Lisp_Object); | |
845ca893 | 3535 | extern _Noreturn void time_overflow (void); |
a08d4ba7 | 3536 | extern Lisp_Object make_buffer_string (ptrdiff_t, ptrdiff_t, bool); |
d311d28c | 3537 | extern Lisp_Object make_buffer_string_both (ptrdiff_t, ptrdiff_t, ptrdiff_t, |
a08d4ba7 | 3538 | ptrdiff_t, bool); |
383e0970 J |
3539 | extern void init_editfns (void); |
3540 | extern void syms_of_editfns (void); | |
a8fe7202 | 3541 | extern void set_time_zone_rule (const char *); |
3cfe6dfd | 3542 | |
7abaf5cc | 3543 | /* Defined in buffer.c. */ |
37ef52bb | 3544 | extern bool mouse_face_overlay_overlaps (Lisp_Object); |
845ca893 | 3545 | extern _Noreturn void nsberror (Lisp_Object); |
d311d28c PE |
3546 | extern void adjust_overlays_for_insert (ptrdiff_t, ptrdiff_t); |
3547 | extern void adjust_overlays_for_delete (ptrdiff_t, ptrdiff_t); | |
3548 | extern void fix_start_end_in_overlays (ptrdiff_t, ptrdiff_t); | |
37ef52bb | 3549 | extern void report_overlay_modification (Lisp_Object, Lisp_Object, bool, |
383e0970 | 3550 | Lisp_Object, Lisp_Object, Lisp_Object); |
37ef52bb | 3551 | extern bool overlay_touches_p (ptrdiff_t); |
9397e56f | 3552 | extern Lisp_Object other_buffer_safely (Lisp_Object); |
383e0970 | 3553 | extern Lisp_Object get_truename_buffer (Lisp_Object); |
383e0970 | 3554 | extern void init_buffer_once (void); |
0bbb27fc | 3555 | extern void init_buffer (int); |
383e0970 J |
3556 | extern void syms_of_buffer (void); |
3557 | extern void keys_of_buffer (void); | |
3cfe6dfd | 3558 | |
7abaf5cc | 3559 | /* Defined in marker.c. */ |
3cfe6dfd | 3560 | |
d311d28c PE |
3561 | extern ptrdiff_t marker_position (Lisp_Object); |
3562 | extern ptrdiff_t marker_byte_position (Lisp_Object); | |
383e0970 | 3563 | extern void clear_charpos_cache (struct buffer *); |
d311d28c PE |
3564 | extern ptrdiff_t buf_charpos_to_bytepos (struct buffer *, ptrdiff_t); |
3565 | extern ptrdiff_t buf_bytepos_to_charpos (struct buffer *, ptrdiff_t); | |
eeaea515 | 3566 | extern void unchain_marker (struct Lisp_Marker *marker); |
383e0970 | 3567 | extern Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object); |
d311d28c | 3568 | extern Lisp_Object set_marker_both (Lisp_Object, Lisp_Object, ptrdiff_t, ptrdiff_t); |
383e0970 | 3569 | extern Lisp_Object set_marker_restricted_both (Lisp_Object, Lisp_Object, |
eeaea515 | 3570 | ptrdiff_t, ptrdiff_t); |
657924ff | 3571 | extern Lisp_Object build_marker (struct buffer *, ptrdiff_t, ptrdiff_t); |
383e0970 | 3572 | extern void syms_of_marker (void); |
3cfe6dfd | 3573 | |
e7032e7c | 3574 | /* Defined in fileio.c. */ |
3cfe6dfd JB |
3575 | |
3576 | extern Lisp_Object Qfile_error; | |
86dfb7a8 | 3577 | extern Lisp_Object Qfile_notify_error; |
99f3388e | 3578 | extern Lisp_Object Qfile_exists_p; |
e6cba650 DN |
3579 | extern Lisp_Object Qfile_directory_p; |
3580 | extern Lisp_Object Qinsert_file_contents; | |
7684e57b | 3581 | extern Lisp_Object Qfile_name_history; |
383e0970 | 3582 | extern Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object); |
94fcd171 PE |
3583 | extern Lisp_Object write_region (Lisp_Object, Lisp_Object, Lisp_Object, |
3584 | Lisp_Object, Lisp_Object, Lisp_Object, | |
3585 | Lisp_Object, int); | |
27e498e6 | 3586 | extern void close_file_unwind (int); |
f4b1eb36 | 3587 | extern void fclose_unwind (void *); |
27e498e6 | 3588 | extern void restore_point_unwind (Lisp_Object); |
a773ed9a | 3589 | extern _Noreturn void report_file_errno (const char *, Lisp_Object, int); |
845ca893 | 3590 | extern _Noreturn void report_file_error (const char *, Lisp_Object); |
7d80ea23 | 3591 | extern bool internal_delete_file (Lisp_Object); |
8654f9d7 | 3592 | extern Lisp_Object emacs_readlinkat (int, const char *); |
73dcdb9f PE |
3593 | extern bool file_directory_p (const char *); |
3594 | extern bool file_accessible_directory_p (const char *); | |
9fe43ff6 | 3595 | extern void init_fileio (void); |
383e0970 | 3596 | extern void syms_of_fileio (void); |
f75d7a91 | 3597 | extern Lisp_Object make_temp_name (Lisp_Object, bool); |
b86cfd28 | 3598 | extern Lisp_Object Qdelete_file; |
3cfe6dfd | 3599 | |
e7032e7c | 3600 | /* Defined in search.c. */ |
383e0970 | 3601 | extern void shrink_regexp_cache (void); |
383e0970 | 3602 | extern void restore_search_regs (void); |
383e0970 | 3603 | extern void record_unwind_save_match_data (void); |
dbd37a95 PE |
3604 | struct re_registers; |
3605 | extern struct re_pattern_buffer *compile_pattern (Lisp_Object, | |
3606 | struct re_registers *, | |
457882c2 | 3607 | Lisp_Object, bool, bool); |
d311d28c | 3608 | extern ptrdiff_t fast_string_match (Lisp_Object, Lisp_Object); |
d923b542 DA |
3609 | extern ptrdiff_t fast_c_string_match_ignore_case (Lisp_Object, const char *, |
3610 | ptrdiff_t); | |
d311d28c PE |
3611 | extern ptrdiff_t fast_string_match_ignore_case (Lisp_Object, Lisp_Object); |
3612 | extern ptrdiff_t fast_looking_at (Lisp_Object, ptrdiff_t, ptrdiff_t, | |
3613 | ptrdiff_t, ptrdiff_t, Lisp_Object); | |
b5426561 DA |
3614 | extern ptrdiff_t find_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
3615 | ptrdiff_t, ptrdiff_t *, ptrdiff_t *, bool); | |
d2b36813 DA |
3616 | extern ptrdiff_t scan_newline (ptrdiff_t, ptrdiff_t, ptrdiff_t, ptrdiff_t, |
3617 | ptrdiff_t, bool); | |
b5426561 DA |
3618 | extern ptrdiff_t find_newline_no_quit (ptrdiff_t, ptrdiff_t, |
3619 | ptrdiff_t, ptrdiff_t *); | |
2a14a4f1 DA |
3620 | extern ptrdiff_t find_before_next_newline (ptrdiff_t, ptrdiff_t, |
3621 | ptrdiff_t, ptrdiff_t *); | |
383e0970 J |
3622 | extern void syms_of_search (void); |
3623 | extern void clear_regexp_cache (void); | |
3cfe6dfd | 3624 | |
464d5a5e | 3625 | /* Defined in minibuf.c. */ |
3cfe6dfd | 3626 | |
e6cba650 | 3627 | extern Lisp_Object Qcompletion_ignore_case; |
99f3388e | 3628 | extern Lisp_Object Vminibuffer_list; |
3cfe6dfd | 3629 | extern Lisp_Object last_minibuf_string; |
62f19c19 | 3630 | extern Lisp_Object get_minibuffer (EMACS_INT); |
383e0970 J |
3631 | extern void init_minibuf_once (void); |
3632 | extern void syms_of_minibuf (void); | |
3cfe6dfd | 3633 | |
464d5a5e | 3634 | /* Defined in callint.c. */ |
3cfe6dfd | 3635 | |
29208e82 | 3636 | extern Lisp_Object Qminus, Qplus; |
12b1389c | 3637 | extern Lisp_Object Qprogn; |
99f3388e | 3638 | extern Lisp_Object Qwhen; |
6e65b9cc | 3639 | extern Lisp_Object Qmouse_leave_buffer_hook; |
383e0970 | 3640 | extern void syms_of_callint (void); |
3cfe6dfd | 3641 | |
464d5a5e | 3642 | /* Defined in casefiddle.c. */ |
3cfe6dfd | 3643 | |
99f3388e | 3644 | extern Lisp_Object Qidentity; |
383e0970 J |
3645 | extern void syms_of_casefiddle (void); |
3646 | extern void keys_of_casefiddle (void); | |
3cfe6dfd | 3647 | |
464d5a5e | 3648 | /* Defined in casetab.c. */ |
1747fb16 | 3649 | |
383e0970 J |
3650 | extern void init_casetab_once (void); |
3651 | extern void syms_of_casetab (void); | |
1747fb16 | 3652 | |
464d5a5e | 3653 | /* Defined in keyboard.c. */ |
3cfe6dfd | 3654 | |
54cd1651 | 3655 | extern Lisp_Object echo_message_buffer; |
417750de | 3656 | extern struct kboard *echo_kboard; |
383e0970 | 3657 | extern void cancel_echoing (void); |
1425dcb6 | 3658 | extern Lisp_Object Qdisabled, QCfilter; |
73bfe891 | 3659 | extern Lisp_Object Qup, Qdown; |
464d5a5e | 3660 | extern Lisp_Object last_undo_boundary; |
9fa1de30 | 3661 | extern bool input_pending; |
383e0970 J |
3662 | extern Lisp_Object menu_bar_items (Lisp_Object); |
3663 | extern Lisp_Object tool_bar_items (Lisp_Object, int *); | |
383e0970 | 3664 | extern void discard_mouse_events (void); |
4d7e6e51 PE |
3665 | #ifdef USABLE_SIGIO |
3666 | void handle_input_available_signal (int); | |
3667 | #endif | |
58555d81 | 3668 | extern Lisp_Object pending_funcalls; |
9fa1de30 PE |
3669 | extern bool detect_input_pending (void); |
3670 | extern bool detect_input_pending_ignore_squeezables (void); | |
3671 | extern bool detect_input_pending_run_timers (bool); | |
383e0970 | 3672 | extern void safe_run_hooks (Lisp_Object); |
a8fe7202 | 3673 | extern void cmd_error_internal (Lisp_Object, const char *); |
383e0970 | 3674 | extern Lisp_Object command_loop_1 (void); |
3b158d11 | 3675 | extern Lisp_Object read_menu_command (void); |
383e0970 J |
3676 | extern Lisp_Object recursive_edit_1 (void); |
3677 | extern void record_auto_save (void); | |
4752793e | 3678 | extern void force_auto_save_soon (void); |
383e0970 J |
3679 | extern void init_keyboard (void); |
3680 | extern void syms_of_keyboard (void); | |
3681 | extern void keys_of_keyboard (void); | |
3cfe6dfd | 3682 | |
464d5a5e | 3683 | /* Defined in indent.c. */ |
d311d28c | 3684 | extern ptrdiff_t current_column (void); |
383e0970 | 3685 | extern void invalidate_current_column (void); |
578098f3 | 3686 | extern bool indented_beyond_p (ptrdiff_t, ptrdiff_t, EMACS_INT); |
383e0970 | 3687 | extern void syms_of_indent (void); |
3cfe6dfd | 3688 | |
464d5a5e | 3689 | /* Defined in frame.c. */ |
9fb0c957 | 3690 | extern Lisp_Object Qonly, Qnone; |
880e6158 | 3691 | extern void set_frame_param (struct frame *, Lisp_Object, Lisp_Object); |
383e0970 J |
3692 | extern void store_frame_param (struct frame *, Lisp_Object, Lisp_Object); |
3693 | extern void store_in_alist (Lisp_Object *, Lisp_Object, Lisp_Object); | |
3694 | extern Lisp_Object do_switch_frame (Lisp_Object, int, int, Lisp_Object); | |
3695 | extern Lisp_Object get_frame_param (struct frame *, Lisp_Object); | |
383e0970 | 3696 | extern void frames_discard_buffer (Lisp_Object); |
383e0970 | 3697 | extern void syms_of_frame (void); |
3cfe6dfd | 3698 | |
464d5a5e | 3699 | /* Defined in emacs.c. */ |
99f3388e DN |
3700 | extern char **initial_argv; |
3701 | extern int initial_argc; | |
5e617bc2 | 3702 | #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS) |
1882aa38 | 3703 | extern bool display_arg; |
89dc303e | 3704 | #endif |
17e0445b | 3705 | extern Lisp_Object decode_env_path (const char *, const char *, bool); |
2c668b9a | 3706 | extern Lisp_Object empty_unibyte_string, empty_multibyte_string; |
e6cba650 | 3707 | extern Lisp_Object Qfile_name_handler_alist; |
4d7e6e51 | 3708 | extern _Noreturn void terminate_due_to_signal (int, int); |
6c07aac2 | 3709 | extern Lisp_Object Qkill_emacs; |
aa15c6bb JB |
3710 | #ifdef WINDOWSNT |
3711 | extern Lisp_Object Vlibrary_cache; | |
3712 | #endif | |
68c45bf0 | 3713 | #if HAVE_SETLOCALE |
383e0970 J |
3714 | void fixup_locale (void); |
3715 | void synchronize_system_messages_locale (void); | |
3716 | void synchronize_system_time_locale (void); | |
68c45bf0 | 3717 | #else |
00382e8b PE |
3718 | INLINE void fixup_locale (void) {} |
3719 | INLINE void synchronize_system_messages_locale (void) {} | |
3720 | INLINE void synchronize_system_time_locale (void) {} | |
68c45bf0 | 3721 | #endif |
1882aa38 | 3722 | extern void shut_down_emacs (int, Lisp_Object); |
ff808935 | 3723 | |
1882aa38 PE |
3724 | /* True means don't do interactive redisplay and don't change tty modes. */ |
3725 | extern bool noninteractive; | |
3726 | ||
3727 | /* True means remove site-lisp directories from load-path. */ | |
3728 | extern bool no_site_lisp; | |
66b7b0fe | 3729 | |
ff808935 DN |
3730 | /* Pipe used to send exit notification to the daemon parent at |
3731 | startup. */ | |
3732 | extern int daemon_pipe[2]; | |
3733 | #define IS_DAEMON (daemon_pipe[1] != 0) | |
3734 | ||
1882aa38 PE |
3735 | /* True if handling a fatal error already. */ |
3736 | extern bool fatal_error_in_progress; | |
3737 | ||
3738 | /* True means don't do use window-system-specific display code. */ | |
3739 | extern bool inhibit_window_system; | |
3740 | /* True means that a filter or a sentinel is running. */ | |
3741 | extern bool running_asynch_code; | |
3cfe6dfd | 3742 | |
6c60eb9f | 3743 | /* Defined in process.c. */ |
89dc303e | 3744 | extern Lisp_Object QCtype, Qlocal; |
383e0970 | 3745 | extern void kill_buffer_processes (Lisp_Object); |
05d28210 PE |
3746 | extern int wait_reading_process_output (intmax_t, int, int, bool, Lisp_Object, |
3747 | struct Lisp_Process *, int); | |
f1dd8073 PE |
3748 | /* Max value for the first argument of wait_reading_process_output. */ |
3749 | #if __GNUC__ == 3 || (__GNUC__ == 4 && __GNUC_MINOR__ <= 5) | |
3750 | /* Work around a bug in GCC 3.4.2, known to be fixed in GCC 4.6.3. | |
3751 | The bug merely causes a bogus warning, but the warning is annoying. */ | |
3752 | # define WAIT_READING_MAX min (TYPE_MAXIMUM (time_t), INTMAX_MAX) | |
3753 | #else | |
3754 | # define WAIT_READING_MAX INTMAX_MAX | |
3755 | #endif | |
383e0970 J |
3756 | extern void add_keyboard_wait_descriptor (int); |
3757 | extern void delete_keyboard_wait_descriptor (int); | |
4475bec4 | 3758 | #ifdef HAVE_GPM |
383e0970 J |
3759 | extern void add_gpm_wait_descriptor (int); |
3760 | extern void delete_gpm_wait_descriptor (int); | |
4475bec4 | 3761 | #endif |
b82da769 | 3762 | extern void init_process_emacs (void); |
383e0970 J |
3763 | extern void syms_of_process (void); |
3764 | extern void setup_process_coding_systems (Lisp_Object); | |
3cfe6dfd | 3765 | |
4ebbdd67 | 3766 | /* Defined in callproc.c. */ |
6bd8c144 | 3767 | #ifndef DOS_NT |
845ca893 | 3768 | _Noreturn |
6bd8c144 | 3769 | #endif |
2f221583 | 3770 | extern int child_setup (int, int, int, char **, bool, Lisp_Object); |
383e0970 J |
3771 | extern void init_callproc_1 (void); |
3772 | extern void init_callproc (void); | |
3773 | extern void set_initial_environment (void); | |
3774 | extern void syms_of_callproc (void); | |
3cfe6dfd | 3775 | |
e7032e7c | 3776 | /* Defined in doc.c. */ |
99f3388e | 3777 | extern Lisp_Object Qfunction_documentation; |
383e0970 | 3778 | extern Lisp_Object read_doc_string (Lisp_Object); |
a08d4ba7 | 3779 | extern Lisp_Object get_doc_string (Lisp_Object, bool, bool); |
383e0970 | 3780 | extern void syms_of_doc (void); |
a08d4ba7 | 3781 | extern int read_bytecode_char (bool); |
3cfe6dfd | 3782 | |
e7032e7c | 3783 | /* Defined in bytecode.c. */ |
383e0970 | 3784 | extern void syms_of_bytecode (void); |
0ee81a0c | 3785 | extern Lisp_Object exec_byte_code (Lisp_Object, Lisp_Object, Lisp_Object, |
f66c7cf8 | 3786 | Lisp_Object, ptrdiff_t, Lisp_Object *); |
3cfe6dfd | 3787 | |
e7032e7c | 3788 | /* Defined in macros.c. */ |
383e0970 J |
3789 | extern void init_macros (void); |
3790 | extern void syms_of_macros (void); | |
3cfe6dfd | 3791 | |
e7032e7c | 3792 | /* Defined in undo.c. */ |
89dc303e | 3793 | extern Lisp_Object Qapply; |
a387611b | 3794 | extern Lisp_Object Qinhibit_read_only; |
383e0970 | 3795 | extern void truncate_undo_list (struct buffer *); |
d311d28c | 3796 | extern void record_insert (ptrdiff_t, ptrdiff_t); |
37ea8275 | 3797 | extern void record_delete (ptrdiff_t, Lisp_Object, bool); |
383e0970 | 3798 | extern void record_first_change (void); |
d311d28c PE |
3799 | extern void record_change (ptrdiff_t, ptrdiff_t); |
3800 | extern void record_property_change (ptrdiff_t, ptrdiff_t, | |
c8a66ab8 | 3801 | Lisp_Object, Lisp_Object, |
383e0970 J |
3802 | Lisp_Object); |
3803 | extern void syms_of_undo (void); | |
e7032e7c | 3804 | /* Defined in textprop.c. */ |
73bfe891 | 3805 | extern Lisp_Object Qmouse_face; |
c2d8811c | 3806 | extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks; |
e6cba650 DN |
3807 | extern Lisp_Object Qminibuffer_prompt; |
3808 | ||
383e0970 | 3809 | extern void report_interval_modification (Lisp_Object, Lisp_Object); |
8537f1cb | 3810 | |
e7032e7c | 3811 | /* Defined in menu.c. */ |
383e0970 | 3812 | extern void syms_of_menu (void); |
febcacdd | 3813 | |
e7032e7c | 3814 | /* Defined in xmenu.c. */ |
383e0970 | 3815 | extern void syms_of_xmenu (void); |
526a2be7 | 3816 | |
e7032e7c | 3817 | /* Defined in termchar.h. */ |
28d7d09f KL |
3818 | struct tty_display_info; |
3819 | ||
e7032e7c | 3820 | /* Defined in termhooks.h. */ |
6ed8eeff | 3821 | struct terminal; |
28d440ab | 3822 | |
e7032e7c | 3823 | /* Defined in sysdep.c. */ |
2412f586 | 3824 | #ifndef HAVE_GET_CURRENT_DIR_NAME |
383e0970 | 3825 | extern char *get_current_dir_name (void); |
2b94e598 | 3826 | #endif |
383e0970 | 3827 | extern void stuff_char (char c); |
322aea6d | 3828 | extern void init_foreground_group (void); |
383e0970 J |
3829 | extern void sys_subshell (void); |
3830 | extern void sys_suspend (void); | |
3831 | extern void discard_tty_input (void); | |
3832 | extern void init_sys_modes (struct tty_display_info *); | |
3833 | extern void reset_sys_modes (struct tty_display_info *); | |
3834 | extern void init_all_sys_modes (void); | |
3835 | extern void reset_all_sys_modes (void); | |
383e0970 J |
3836 | extern void child_setup_tty (int); |
3837 | extern void setup_pty (int); | |
3838 | extern int set_window_size (int, int, int); | |
ede49d71 | 3839 | extern EMACS_INT get_random (void); |
0e23ef9d PE |
3840 | extern void seed_random (void *, ptrdiff_t); |
3841 | extern void init_random (void); | |
cf29dd84 | 3842 | extern void emacs_backtrace (int); |
1088b922 | 3843 | extern _Noreturn void emacs_abort (void) NO_INLINE; |
383e0970 | 3844 | extern int emacs_open (const char *, int, int); |
c7ddc792 | 3845 | extern int emacs_pipe (int[2]); |
383e0970 | 3846 | extern int emacs_close (int); |
223752d7 PE |
3847 | extern ptrdiff_t emacs_read (int, void *, ptrdiff_t); |
3848 | extern ptrdiff_t emacs_write (int, void const *, ptrdiff_t); | |
3849 | extern ptrdiff_t emacs_write_sig (int, void const *, ptrdiff_t); | |
4ebbdd67 | 3850 | extern void emacs_perror (char const *); |
526a2be7 | 3851 | |
383e0970 J |
3852 | extern void unlock_all_files (void); |
3853 | extern void lock_file (Lisp_Object); | |
3854 | extern void unlock_file (Lisp_Object); | |
3855 | extern void unlock_buffer (struct buffer *); | |
3856 | extern void syms_of_filelock (void); | |
15b0ced5 | 3857 | |
e7032e7c | 3858 | /* Defined in sound.c. */ |
383e0970 | 3859 | extern void syms_of_sound (void); |
46abf440 | 3860 | |
e7032e7c | 3861 | /* Defined in category.c. */ |
383e0970 J |
3862 | extern void init_category_once (void); |
3863 | extern Lisp_Object char_category_set (int); | |
3864 | extern void syms_of_category (void); | |
46abf440 | 3865 | |
e7032e7c | 3866 | /* Defined in ccl.c. */ |
383e0970 | 3867 | extern void syms_of_ccl (void); |
46abf440 | 3868 | |
e7032e7c | 3869 | /* Defined in dired.c. */ |
383e0970 J |
3870 | extern void syms_of_dired (void); |
3871 | extern Lisp_Object directory_files_internal (Lisp_Object, Lisp_Object, | |
3872 | Lisp_Object, Lisp_Object, | |
86ec63ba | 3873 | bool, Lisp_Object); |
46abf440 | 3874 | |
e7032e7c | 3875 | /* Defined in term.c. */ |
e6cba650 | 3876 | extern int *char_ins_del_vector; |
383e0970 | 3877 | extern void syms_of_term (void); |
845ca893 PE |
3878 | extern _Noreturn void fatal (const char *msgid, ...) |
3879 | ATTRIBUTE_FORMAT_PRINTF (1, 2); | |
46abf440 | 3880 | |
e7032e7c | 3881 | /* Defined in terminal.c. */ |
383e0970 | 3882 | extern void syms_of_terminal (void); |
ed8dad6b | 3883 | |
e7032e7c | 3884 | /* Defined in font.c. */ |
383e0970 J |
3885 | extern void syms_of_font (void); |
3886 | extern void init_font (void); | |
b86cfd28 | 3887 | |
4f48f1ab | 3888 | #ifdef HAVE_WINDOW_SYSTEM |
e7032e7c | 3889 | /* Defined in fontset.c. */ |
383e0970 | 3890 | extern void syms_of_fontset (void); |
4f48f1ab | 3891 | |
e7032e7c | 3892 | /* Defined in xfns.c, w32fns.c, or macfns.c. */ |
99f3388e | 3893 | extern Lisp_Object Qfont_param; |
46abf440 AS |
3894 | #endif |
3895 | ||
c9628c79 MA |
3896 | /* Defined in gfilenotify.c */ |
3897 | #ifdef HAVE_GFILENOTIFY | |
90db8702 | 3898 | extern void globals_of_gfilenotify (void); |
c9628c79 | 3899 | extern void syms_of_gfilenotify (void); |
477f1e50 EZ |
3900 | #endif |
3901 | ||
81606b10 RS |
3902 | /* Defined in inotify.c */ |
3903 | #ifdef HAVE_INOTIFY | |
3904 | extern void syms_of_inotify (void); | |
3905 | #endif | |
3906 | ||
c9628c79 MA |
3907 | #ifdef HAVE_W32NOTIFY |
3908 | /* Defined on w32notify.c. */ | |
3909 | extern void syms_of_w32notify (void); | |
3910 | #endif | |
3911 | ||
e7032e7c | 3912 | /* Defined in xfaces.c. */ |
73bfe891 PE |
3913 | extern Lisp_Object Qdefault, Qfringe; |
3914 | extern Lisp_Object Qscroll_bar, Qcursor; | |
955cbe7b | 3915 | extern Lisp_Object Qmode_line_inactive; |
e6cba650 | 3916 | extern Lisp_Object Qface; |
89dc303e | 3917 | extern Lisp_Object Qnormal; |
0e9c8657 JB |
3918 | extern Lisp_Object QCfamily, QCweight, QCslant; |
3919 | extern Lisp_Object QCheight, QCname, QCwidth, QCforeground, QCbackground; | |
a411ac43 PE |
3920 | extern Lisp_Object Qextra_light, Qlight, Qsemi_light, Qsemi_bold; |
3921 | extern Lisp_Object Qbold, Qextra_bold, Qultra_bold; | |
3922 | extern Lisp_Object Qoblique, Qitalic; | |
99f3388e | 3923 | extern Lisp_Object Vface_alternative_font_family_alist; |
99f3388e | 3924 | extern Lisp_Object Vface_alternative_font_registry_alist; |
383e0970 | 3925 | extern void syms_of_xfaces (void); |
46abf440 AS |
3926 | |
3927 | #ifdef HAVE_X_WINDOWS | |
e7032e7c | 3928 | /* Defined in xfns.c. */ |
383e0970 | 3929 | extern void syms_of_xfns (void); |
46abf440 | 3930 | |
e7032e7c | 3931 | /* Defined in xsmfns.c. */ |
383e0970 | 3932 | extern void syms_of_xsmfns (void); |
e02207d4 | 3933 | |
e7032e7c | 3934 | /* Defined in xselect.c. */ |
383e0970 | 3935 | extern void syms_of_xselect (void); |
46abf440 | 3936 | |
e7032e7c | 3937 | /* Defined in xterm.c. */ |
383e0970 | 3938 | extern void syms_of_xterm (void); |
4f48f1ab | 3939 | #endif /* HAVE_X_WINDOWS */ |
4baa6f88 | 3940 | |
7af07b96 | 3941 | #ifdef HAVE_WINDOW_SYSTEM |
e7032e7c | 3942 | /* Defined in xterm.c, nsterm.m, w32term.c. */ |
7af07b96 AS |
3943 | extern char *x_get_keysym_name (int); |
3944 | #endif /* HAVE_WINDOW_SYSTEM */ | |
3945 | ||
381408e2 | 3946 | #ifdef HAVE_LIBXML2 |
e7032e7c | 3947 | /* Defined in xml.c. */ |
381408e2 | 3948 | extern void syms_of_xml (void); |
9078ead6 | 3949 | extern void xml_cleanup_parser (void); |
381408e2 LMI |
3950 | #endif |
3951 | ||
313546eb LMI |
3952 | #ifdef HAVE_ZLIB |
3953 | /* Defined in decompress.c. */ | |
3954 | extern void syms_of_decompress (void); | |
3955 | #endif | |
3956 | ||
b86cfd28 | 3957 | #ifdef HAVE_DBUS |
e7032e7c | 3958 | /* Defined in dbusbind.c. */ |
383e0970 | 3959 | void syms_of_dbusbind (void); |
b86cfd28 | 3960 | #endif |
36e053eb | 3961 | |
ad942b63 SM |
3962 | |
3963 | /* Defined in profiler.c. */ | |
6521894d | 3964 | extern bool profiler_memory_running; |
c2d7786e | 3965 | extern void malloc_probe (size_t); |
c2d7786e TM |
3966 | extern void syms_of_profiler (void); |
3967 | ||
ad942b63 | 3968 | |
36e053eb | 3969 | #ifdef DOS_NT |
e7032e7c | 3970 | /* Defined in msdos.c, w32.c. */ |
36e053eb DN |
3971 | extern char *emacs_root_dir (void); |
3972 | #endif /* DOS_NT */ | |
3cfe6dfd | 3973 | |
9fa1de30 PE |
3974 | /* True means ^G can quit instantly. */ |
3975 | extern bool immediate_quit; | |
3cfe6dfd | 3976 | |
74fde0f4 PE |
3977 | extern void *xmalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); |
3978 | extern void *xzalloc (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); | |
3979 | extern void *xrealloc (void *, size_t) ATTRIBUTE_ALLOC_SIZE ((2)); | |
261cb4bb | 3980 | extern void xfree (void *); |
f11db2f4 | 3981 | extern void *xmalloc_uncollectable (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); |
0a38955b | 3982 | extern void *xmalloc_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); |
74fde0f4 PE |
3983 | extern void *xnmalloc (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2)); |
3984 | extern void *xnrealloc (void *, ptrdiff_t, ptrdiff_t) | |
3985 | ATTRIBUTE_ALLOC_SIZE ((2,3)); | |
0065d054 | 3986 | extern void *xpalloc (void *, ptrdiff_t *, ptrdiff_t, ptrdiff_t, ptrdiff_t); |
143439dd RT |
3987 | extern void *xmalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); |
3988 | extern void *xzalloc_atomic (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); | |
3989 | extern void *xmalloc_atomic_unsafe (size_t) ATTRIBUTE_MALLOC_SIZE ((1)); | |
3990 | extern void *xnmalloc_atomic (ptrdiff_t, ptrdiff_t) ATTRIBUTE_MALLOC_SIZE ((1,2)); | |
074b6efe | 3991 | |
74fde0f4 PE |
3992 | extern char *xstrdup (const char *) ATTRIBUTE_MALLOC; |
3993 | extern char *xlispstrdup (Lisp_Object) ATTRIBUTE_MALLOC; | |
8268febf | 3994 | extern void dupstring (char **, char const *); |
5745a7df | 3995 | extern void xputenv (const char *); |
3cfe6dfd | 3996 | |
a8fe7202 | 3997 | extern char *egetenv (const char *); |
e98227af | 3998 | |
5b71542d DA |
3999 | /* Copy Lisp string to temporary (allocated on stack) C string. */ |
4000 | ||
4001 | #define xlispstrdupa(string) \ | |
4002 | memcpy (alloca (SBYTES (string) + 1), \ | |
4003 | SSDATA (string), SBYTES (string) + 1) | |
4004 | ||
5d6be39f | 4005 | /* Set up the name of the machine we're running on. */ |
383e0970 | 4006 | extern void init_system_name (void); |
881a5a80 | 4007 | |
d7a0a7c9 PE |
4008 | /* Return the absolute value of X. X should be a signed integer |
4009 | expression without side effects, and X's absolute value should not | |
4010 | exceed the maximum for its promoted type. This is called 'eabs' | |
4011 | because 'abs' is reserved by the C standard. */ | |
555b10b0 | 4012 | #define eabs(x) ((x) < 0 ? -(x) : (x)) |
096e8667 | 4013 | |
53ede3f4 GM |
4014 | /* Return a fixnum or float, depending on whether VAL fits in a Lisp |
4015 | fixnum. */ | |
4016 | ||
4017 | #define make_fixnum_or_float(val) \ | |
cbeff735 | 4018 | (FIXNUM_OVERFLOW_P (val) ? make_float (val) : make_number (val)) |
6b61353c | 4019 | |
79518a8d KS |
4020 | /* SAFE_ALLOCA normally allocates memory on the stack, but if size is |
4021 | larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */ | |
4022 | ||
e7032e7c | 4023 | enum MAX_ALLOCA { MAX_ALLOCA = 16 * 1024 }; |
79518a8d | 4024 | |
74fde0f4 | 4025 | extern void *record_xmalloc (size_t) ATTRIBUTE_ALLOC_SIZE ((1)); |
79518a8d KS |
4026 | |
4027 | #define USE_SAFE_ALLOCA \ | |
96c06863 | 4028 | ptrdiff_t sa_count = SPECPDL_INDEX (); bool sa_must_free = false |
79518a8d | 4029 | |
a9e6bacc KS |
4030 | /* SAFE_ALLOCA allocates a simple buffer. */ |
4031 | ||
98c6f1e3 PE |
4032 | #define SAFE_ALLOCA(size) ((size) < MAX_ALLOCA \ |
4033 | ? alloca (size) \ | |
96c06863 | 4034 | : (sa_must_free = true, record_xmalloc (size))) |
79518a8d | 4035 | |
0065d054 PE |
4036 | /* SAFE_NALLOCA sets BUF to a newly allocated array of MULTIPLIER * |
4037 | NITEMS items, each of the same type as *BUF. MULTIPLIER must | |
4038 | positive. The code is tuned for MULTIPLIER being a constant. */ | |
4039 | ||
468afbac DA |
4040 | #define SAFE_NALLOCA(buf, multiplier, nitems) \ |
4041 | do { \ | |
4042 | if ((nitems) <= MAX_ALLOCA / sizeof *(buf) / (multiplier)) \ | |
4043 | (buf) = alloca (sizeof *(buf) * (multiplier) * (nitems)); \ | |
4044 | else \ | |
0065d054 PE |
4045 | { \ |
4046 | (buf) = xnmalloc (nitems, sizeof *(buf) * (multiplier)); \ | |
96c06863 | 4047 | sa_must_free = true; \ |
27e498e6 | 4048 | record_unwind_protect_ptr (xfree, buf); \ |
0065d054 | 4049 | } \ |
96c06863 | 4050 | } while (false) |
0065d054 | 4051 | |
a9e6bacc KS |
4052 | /* SAFE_FREE frees xmalloced memory and enables GC as needed. */ |
4053 | ||
c33188d9 | 4054 | #define SAFE_FREE() \ |
79518a8d | 4055 | do { \ |
c33188d9 | 4056 | if (sa_must_free) { \ |
96c06863 | 4057 | sa_must_free = false; \ |
79518a8d | 4058 | unbind_to (sa_count, Qnil); \ |
c33188d9 | 4059 | } \ |
96c06863 | 4060 | } while (false) |
79518a8d KS |
4061 | |
4062 | ||
5f5d6c62 KS |
4063 | /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */ |
4064 | ||
663e2b3f DA |
4065 | #define SAFE_ALLOCA_LISP(buf, nelt) \ |
4066 | do { \ | |
4067 | if ((nelt) < MAX_ALLOCA / word_size) \ | |
96c06863 | 4068 | (buf) = alloca ((nelt) * word_size); \ |
663e2b3f DA |
4069 | else if ((nelt) < min (PTRDIFF_MAX, SIZE_MAX) / word_size) \ |
4070 | { \ | |
4071 | Lisp_Object arg_; \ | |
96c06863 | 4072 | (buf) = xmalloc ((nelt) * word_size); \ |
1396ac86 | 4073 | arg_ = make_save_memory (buf, nelt); \ |
96c06863 | 4074 | sa_must_free = true; \ |
27e498e6 | 4075 | record_unwind_protect (free_save_value, arg_); \ |
663e2b3f DA |
4076 | } \ |
4077 | else \ | |
4078 | memory_full (SIZE_MAX); \ | |
96c06863 | 4079 | } while (false) |
5f5d6c62 | 4080 | |
105324ce SM |
4081 | /* Loop over all tails of a list, checking for cycles. |
4082 | FIXME: Make tortoise and n internal declarations. | |
4083 | FIXME: Unroll the loop body so we don't need `n'. */ | |
4084 | #define FOR_EACH_TAIL(hare, list, tortoise, n) \ | |
96c06863 | 4085 | for ((tortoise) = (hare) = (list), (n) = true; \ |
105324ce | 4086 | CONSP (hare); \ |
96c06863 PE |
4087 | (hare = XCDR (hare), (n) = !(n), \ |
4088 | ((n) \ | |
4089 | ? (EQ (hare, tortoise) \ | |
4090 | ? xsignal1 (Qcircular_list, list) \ | |
4091 | : (void) 0) \ | |
105324ce SM |
4092 | /* Move tortoise before the next iteration, in case */ \ |
4093 | /* the next iteration does an Fsetcdr. */ \ | |
96c06863 | 4094 | : (void) ((tortoise) = XCDR (tortoise))))) |
105324ce | 4095 | |
d5a1acfa DA |
4096 | /* Do a `for' loop over alist values. */ |
4097 | ||
4098 | #define FOR_EACH_ALIST_VALUE(head_var, list_var, value_var) \ | |
96c06863 PE |
4099 | for ((list_var) = (head_var); \ |
4100 | (CONSP (list_var) && ((value_var) = XCDR (XCAR (list_var)), true)); \ | |
4101 | (list_var) = XCDR (list_var)) | |
79518a8d | 4102 | |
dac616ff DA |
4103 | /* Check whether it's time for GC, and run it if so. */ |
4104 | ||
00382e8b | 4105 | INLINE void |
dac616ff DA |
4106 | maybe_gc (void) |
4107 | { | |
b782773b | 4108 | return; |
dac616ff DA |
4109 | } |
4110 | ||
00382e8b | 4111 | INLINE bool |
e1f29348 BR |
4112 | functionp (Lisp_Object object) |
4113 | { | |
4114 | if (SYMBOLP (object) && !NILP (Ffboundp (object))) | |
4115 | { | |
4116 | object = Findirect_function (object, Qt); | |
4117 | ||
4118 | if (CONSP (object) && EQ (XCAR (object), Qautoload)) | |
4119 | { | |
4120 | /* Autoloaded symbols are functions, except if they load | |
4121 | macros or keymaps. */ | |
4122 | int i; | |
4123 | for (i = 0; i < 4 && CONSP (object); i++) | |
4124 | object = XCDR (object); | |
4125 | ||
4126 | return ! (CONSP (object) && !NILP (XCAR (object))); | |
4127 | } | |
4128 | } | |
4129 | ||
4130 | if (SUBRP (object)) | |
4131 | return XSUBR (object)->max_args != UNEVALLED; | |
4132 | else if (COMPILEDP (object)) | |
96c06863 | 4133 | return true; |
e1f29348 BR |
4134 | else if (CONSP (object)) |
4135 | { | |
4136 | Lisp_Object car = XCAR (object); | |
4137 | return EQ (car, Qlambda) || EQ (car, Qclosure); | |
4138 | } | |
4139 | else | |
96c06863 | 4140 | return false; |
e1f29348 BR |
4141 | } |
4142 | ||
f162bcc3 PE |
4143 | INLINE_HEADER_END |
4144 | ||
6b61353c | 4145 | #endif /* EMACS_LISP_H */ |