* editfns.c (general_insert_function): Adjust to insdel.c changes.
[bpt/emacs.git] / src / lisp.h
1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21 #ifndef EMACS_LISP_H
22 #define EMACS_LISP_H
23
24 /* Declare the prototype for a general external function. */
25 #if defined (PROTOTYPES) || defined (WINDOWSNT)
26 #define P_(proto) proto
27 #else
28 #define P_(proto) ()
29 #endif
30
31 #if 0
32 /* Define this temporarily to hunt a bug. If defined, the size of
33 strings is redundantly recorded in sdata structures so that it can
34 be compared to the sizes recorded in Lisp strings. */
35
36 #define GC_CHECK_STRING_BYTES 1
37
38 /* Define this to check for short string overrun. */
39
40 #define GC_CHECK_STRING_OVERRUN 1
41
42 /* Define this to check the string free list. */
43
44 #define GC_CHECK_STRING_FREE_LIST 1
45
46 /* Define this to check for malloc buffer overrun. */
47
48 #define XMALLOC_OVERRUN_CHECK 1
49
50 /* Define this to check for errors in cons list. */
51 /* #define GC_CHECK_CONS_LIST 1 */
52
53 #endif /* 0 */
54
55 #ifdef GC_CHECK_CONS_LIST
56 #define CHECK_CONS_LIST() check_cons_list()
57 #else
58 #define CHECK_CONS_LIST() ((void)0)
59 #endif
60
61 /* These are default choices for the types to use. */
62 #ifdef _LP64
63 #ifndef EMACS_INT
64 #define EMACS_INT long
65 #define BITS_PER_EMACS_INT BITS_PER_LONG
66 #endif
67 #ifndef EMACS_UINT
68 #define EMACS_UINT unsigned long
69 #endif
70 #else /* not _LP64 */
71 #ifndef EMACS_INT
72 #define EMACS_INT int
73 #define BITS_PER_EMACS_INT BITS_PER_INT
74 #endif
75 #ifndef EMACS_UINT
76 #define EMACS_UINT unsigned int
77 #endif
78 #endif
79
80 /* Extra internal type checking? */
81 extern int suppress_checking;
82 extern void die P_((const char *, const char *, int)) NO_RETURN;
83
84 #ifdef ENABLE_CHECKING
85
86 /* The suppress_checking variable is initialized to 0 in alloc.c. Set
87 it to 1 using a debugger to temporarily disable aborting on
88 detected internal inconsistencies or error conditions.
89
90 Testing suppress_checking after the supplied condition ensures that
91 the side effects produced by CHECK will be consistent, independent
92 of whether ENABLE_CHECKING is defined, or whether the checks are
93 suppressed at run time.
94
95 In some cases, a good compiler may be able to optimize away the
96 CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
97 STRINGP (x), but a particular use of XSTRING is invoked only after
98 testing that STRINGP (x) is true, making the test redundant. */
99
100 #define CHECK(check,msg) (((check) || suppress_checking \
101 ? (void) 0 \
102 : die ((msg), __FILE__, __LINE__)), \
103 0)
104 #else
105
106 /* Produce same side effects and result, but don't complain. */
107 #define CHECK(check,msg) ((check),0)
108
109 #endif
110
111 /* Define an Emacs version of "assert", since some system ones are
112 flaky. */
113 #ifndef ENABLE_CHECKING
114 #define eassert(X) (void) 0
115 #else /* ENABLE_CHECKING */
116 #if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
117 #define eassert(cond) CHECK(cond,"assertion failed: " #cond)
118 #else
119 #define eassert(cond) CHECK(cond,"assertion failed")
120 #endif
121 #endif /* ENABLE_CHECKING */
122 \f
123 /* Define this to make Lisp_Object use a union type instead of the
124 default int. FIXME: It might be better to add a flag to configure
125 to do this. */
126 /* #define USE_LISP_UNION_TYPE */
127
128 /***** Select the tagging scheme. *****/
129 /* There are basically two options that control the tagging scheme:
130 - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
131 of an integer.
132 - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
133 always 0, and we can thus use them to hold tag bits, without
134 restricting our addressing space.
135
136 If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
137 restricting our possible address range. Currently USE_LSB_TAG is not
138 allowed together with a union. This is not due to any fundamental
139 technical (or political ;-) problem: nobody wrote the code to do it yet.
140
141 USE_LSB_TAG not only requires the least 3 bits of pointers returned by
142 malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
143 on the few static Lisp_Objects used: all the defsubr as well
144 as the two special buffers buffer_defaults and buffer_local_symbols. */
145
146 /* First, try and define DECL_ALIGN(type,var) which declares a static
147 variable VAR of type TYPE with the added requirement that it be
148 TYPEBITS-aligned. */
149 #ifndef NO_DECL_ALIGN
150 # ifndef DECL_ALIGN
151 /* What compiler directive should we use for non-gcc compilers? -stef */
152 # if defined (__GNUC__)
153 # define DECL_ALIGN(type, var) \
154 type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
155 # endif
156 # endif
157 #endif
158
159 /* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8. */
160 #if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined DARWIN_OS
161 /* We also need to be able to specify mult-of-8 alignment on static vars. */
162 # if defined DECL_ALIGN
163 /* We currently do not support USE_LSB_TAG with a union Lisp_Object. */
164 # ifndef USE_LISP_UNION_TYPE
165 # define USE_LSB_TAG
166 # endif
167 # endif
168 #endif
169
170 /* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op. */
171 #ifndef DECL_ALIGN
172 # ifdef USE_LSB_TAG
173 # error "USE_LSB_TAG used without defining DECL_ALIGN"
174 # endif
175 # define DECL_ALIGN(type, var) type var
176 #endif
177
178
179 /* Define the fundamental Lisp data structures. */
180
181 /* This is the set of Lisp data types. */
182
183 enum Lisp_Type
184 {
185 /* Integer. XINT (obj) is the integer value. */
186 Lisp_Int,
187
188 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
189 Lisp_Symbol,
190
191 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
192 whose first member indicates the subtype. */
193 Lisp_Misc,
194
195 /* String. XSTRING (object) points to a struct Lisp_String.
196 The length of the string, and its contents, are stored therein. */
197 Lisp_String,
198
199 /* Vector of Lisp objects, or something resembling it.
200 XVECTOR (object) points to a struct Lisp_Vector, which contains
201 the size and contents. The size field also contains the type
202 information, if it's not a real vector object. */
203 Lisp_Vectorlike,
204
205 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
206 Lisp_Cons,
207
208 Lisp_Float,
209
210 /* This is not a type code. It is for range checking. */
211 Lisp_Type_Limit
212 };
213
214 /* This is the set of data types that share a common structure.
215 The first member of the structure is a type code from this set.
216 The enum values are arbitrary, but we'll use large numbers to make it
217 more likely that we'll spot the error if a random word in memory is
218 mistakenly interpreted as a Lisp_Misc. */
219 enum Lisp_Misc_Type
220 {
221 Lisp_Misc_Free = 0x5eab,
222 Lisp_Misc_Marker,
223 Lisp_Misc_Intfwd,
224 Lisp_Misc_Boolfwd,
225 Lisp_Misc_Objfwd,
226 Lisp_Misc_Buffer_Objfwd,
227 Lisp_Misc_Buffer_Local_Value,
228 Lisp_Misc_Overlay,
229 Lisp_Misc_Kboard_Objfwd,
230 Lisp_Misc_Save_Value,
231 /* Currently floats are not a misc type,
232 but let's define this in case we want to change that. */
233 Lisp_Misc_Float,
234 /* This is not a type code. It is for range checking. */
235 Lisp_Misc_Limit
236 };
237
238 #ifndef GCTYPEBITS
239 #define GCTYPEBITS 3
240 #endif
241
242 /* These values are overridden by the m- file on some machines. */
243 #ifndef VALBITS
244 #define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
245 #endif
246
247 #ifdef USE_LISP_UNION_TYPE
248
249 #ifndef WORDS_BIG_ENDIAN
250
251 /* Definition of Lisp_Object for little-endian machines. */
252
253 typedef
254 union Lisp_Object
255 {
256 /* Used for comparing two Lisp_Objects;
257 also, positive integers can be accessed fast this way. */
258 EMACS_UINT i;
259
260 struct
261 {
262 EMACS_INT val : VALBITS;
263 enum Lisp_Type type : GCTYPEBITS;
264 } s;
265 struct
266 {
267 EMACS_UINT val : VALBITS;
268 enum Lisp_Type type : GCTYPEBITS;
269 } u;
270 }
271 Lisp_Object;
272
273 #else /* If WORDS_BIG_ENDIAN */
274
275 typedef
276 union Lisp_Object
277 {
278 /* Used for comparing two Lisp_Objects;
279 also, positive integers can be accessed fast this way. */
280 EMACS_UINT i;
281
282 struct
283 {
284 enum Lisp_Type type : GCTYPEBITS;
285 EMACS_INT val : VALBITS;
286 } s;
287 struct
288 {
289 enum Lisp_Type type : GCTYPEBITS;
290 EMACS_UINT val : VALBITS;
291 } u;
292 }
293 Lisp_Object;
294
295 #endif /* WORDS_BIG_ENDIAN */
296
297 #ifdef __GNUC__
298 static __inline__ Lisp_Object
299 LISP_MAKE_RVALUE (Lisp_Object o)
300 {
301 return o;
302 }
303 #else
304 /* This isn't quite right - it keeps the argument as an lvalue.
305 Making it const via casting would help avoid code actually
306 modifying the location in question, but the casting could cover
307 other type-related bugs. */
308 #define LISP_MAKE_RVALUE(o) (o)
309 #endif
310
311 #else /* USE_LISP_UNION_TYPE */
312
313 /* If union type is not wanted, define Lisp_Object as just a number. */
314
315 typedef EMACS_INT Lisp_Object;
316 #define LISP_MAKE_RVALUE(o) (0+(o))
317 #endif /* USE_LISP_UNION_TYPE */
318
319 /* In the size word of a vector, this bit means the vector has been marked. */
320
321 #define ARRAY_MARK_FLAG ((EMACS_UINT) 1 << (BITS_PER_EMACS_INT - 1))
322
323 /* In the size word of a struct Lisp_Vector, this bit means it's really
324 some other vector-like object. */
325 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
326
327 /* In a pseudovector, the size field actually contains a word with one
328 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
329 indicate the actual type.
330 We use a bitset, even tho only one of the bits can be set at any
331 particular time just so as to be able to use micro-optimizations such as
332 testing membership of a particular subset of pseudovectors in Fequal.
333 It is not crucial, but there are plenty of bits here, so why not do it? */
334 enum pvec_type
335 {
336 PVEC_NORMAL_VECTOR = 0,
337 PVEC_PROCESS = 0x200,
338 PVEC_FRAME = 0x400,
339 PVEC_COMPILED = 0x800,
340 PVEC_WINDOW = 0x1000,
341 PVEC_WINDOW_CONFIGURATION = 0x2000,
342 PVEC_SUBR = 0x4000,
343 PVEC_CHAR_TABLE = 0x8000,
344 PVEC_BOOL_VECTOR = 0x10000,
345 PVEC_BUFFER = 0x20000,
346 PVEC_HASH_TABLE = 0x40000,
347 PVEC_TERMINAL = 0x80000,
348 PVEC_SUB_CHAR_TABLE = 0x100000,
349 PVEC_FONT = 0x200000,
350 PVEC_OTHER = 0x400000,
351 PVEC_TYPE_MASK = 0x7ffe00
352
353 #if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
354 GDB. It doesn't work on OS Alpha. Moved to a variable in
355 emacs.c. */
356 PVEC_FLAG = PSEUDOVECTOR_FLAG
357 #endif
358 };
359
360 /* For convenience, we also store the number of elements in these bits.
361 Note that this size is not necessarily the memory-footprint size, but
362 only the number of Lisp_Object fields (that need to be traced by the GC).
363 The distinction is used e.g. by Lisp_Process which places extra
364 non-Lisp_Object fields at the end of the structure. */
365 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
366
367 /* Number of bits to put in each character in the internal representation
368 of bool vectors. This should not vary across implementations. */
369 #define BOOL_VECTOR_BITS_PER_CHAR 8
370 \f
371 /* These macros extract various sorts of values from a Lisp_Object.
372 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
373 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
374
375 #ifndef USE_LISP_UNION_TYPE
376
377 /* Return a perfect hash of the Lisp_Object representation. */
378 #define XHASH(a) (a)
379
380 #ifdef USE_LSB_TAG
381
382 #define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
383 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
384 #define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
385 #define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
386 #define XSET(var, type, ptr) \
387 (eassert (XTYPE (ptr) == 0), /* Check alignment. */ \
388 (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
389 #define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
390
391 /* XFASTINT and XSETFASTINT are for use when the integer is known to be
392 positive, in which case the implementation can sometimes be faster
393 depending on the tagging scheme. With USE_LSB_TAG, there's no benefit. */
394 #define XFASTINT(a) XINT (a)
395 #define XSETFASTINT(a, b) ((a) = make_number (b))
396
397 #define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))
398
399 #else /* not USE_LSB_TAG */
400
401 #define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)
402
403 /* One need to override this if there must be high bits set in data space
404 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
405 on all machines, but would penalize machines which don't need it)
406 */
407 #define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
408
409 /* For integers known to be positive, XFASTINT provides fast retrieval
410 and XSETFASTINT provides fast storage. This takes advantage of the
411 fact that Lisp_Int is 0. */
412 #define XFASTINT(a) ((a) + 0)
413 #define XSETFASTINT(a, b) ((a) = (b))
414
415 /* Extract the value of a Lisp_Object as a signed integer. */
416
417 #ifndef XINT /* Some machines need to do this differently. */
418 #define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS)) \
419 >> (BITS_PER_EMACS_INT - VALBITS))
420 #endif
421
422 /* Extract the value as an unsigned integer. This is a basis
423 for extracting it as a pointer to a structure in storage. */
424
425 #ifndef XUINT
426 #define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
427 #endif
428
429 #ifndef XSET
430 #define XSET(var, type, ptr) \
431 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
432 #endif
433
434 /* Convert a C integer into a Lisp_Object integer. */
435
436 #define make_number(N) \
437 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
438
439 #endif /* not USE_LSB_TAG */
440
441 #else /* USE_LISP_UNION_TYPE */
442
443 #define XHASH(a) ((a).i)
444
445 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
446
447 /* For integers known to be positive, XFASTINT provides fast retrieval
448 and XSETFASTINT provides fast storage. This takes advantage of the
449 fact that Lisp_Int is 0. */
450 #define XFASTINT(a) ((a).i + 0)
451 #define XSETFASTINT(a, b) ((a).i = (b))
452
453 #ifdef EXPLICIT_SIGN_EXTEND
454 /* Make sure we sign-extend; compilers have been known to fail to do so. */
455 #define XINT(a) (((a).s.val << (BITS_PER_EMACS_INT - VALBITS)) \
456 >> (BITS_PER_EMACS_INT - VALBITS))
457 #else
458 #define XINT(a) ((a).s.val)
459 #endif /* EXPLICIT_SIGN_EXTEND */
460
461 #define XUINT(a) ((a).u.val)
462
463 #define XSET(var, vartype, ptr) \
464 (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
465
466 #if __GNUC__ >= 2 && defined (__OPTIMIZE__)
467 #define make_number(N) \
468 (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
469 #else
470 extern Lisp_Object make_number P_ ((EMACS_INT));
471 #endif
472
473 #endif /* USE_LISP_UNION_TYPE */
474
475 #define EQ(x, y) (XHASH (x) == XHASH (y))
476
477 #ifndef XPNTR
478 #ifdef HAVE_SHM
479 /* In this representation, data is found in two widely separated segments. */
480 extern size_t pure_size;
481 #define XPNTR(a) \
482 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
483 #else /* not HAVE_SHM */
484 #ifdef DATA_SEG_BITS
485 /* This case is used for the rt-pc.
486 In the diffs I was given, it checked for ptr = 0
487 and did not adjust it in that case.
488 But I don't think that zero should ever be found
489 in a Lisp object whose data type says it points to something. */
490 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
491 #else
492 /* Some versions of gcc seem to consider the bitfield width when
493 issuing the "cast to pointer from integer of different size"
494 warning, so the cast is here to widen the value back to its natural
495 size. */
496 #define XPNTR(a) ((EMACS_INT) XUINT (a))
497 #endif
498 #endif /* not HAVE_SHM */
499 #endif /* no XPNTR */
500
501 /* Largest and smallest representable fixnum values. These are the C
502 values. */
503
504 #define MOST_NEGATIVE_FIXNUM - ((EMACS_INT) 1 << (VALBITS - 1))
505 #define MOST_POSITIVE_FIXNUM (((EMACS_INT) 1 << (VALBITS - 1)) - 1)
506 /* Mask indicating the significant bits of a Lisp_Int.
507 I.e. (x & INTMASK) == XUINT (make_number (x)). */
508 #define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
509
510 /* Value is non-zero if C integer I doesn't fit into a Lisp fixnum. */
511
512 #define FIXNUM_OVERFLOW_P(i) \
513 ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
514 || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
515
516 /* Extract a value or address from a Lisp_Object. */
517
518 #define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
519 #define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
520 #define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
521 #define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
522 #define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
523
524 /* Misc types. */
525
526 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
527 #define XMISCANY(a) (eassert (MISCP (a)), &(XMISC(a)->u_any))
528 #define XMISCTYPE(a) (XMISCANY (a)->type)
529 #define XMARKER(a) (eassert (MARKERP (a)), &(XMISC(a)->u_marker))
530 #define XINTFWD(a) (eassert (INTFWDP (a)), &(XMISC(a)->u_intfwd))
531 #define XBOOLFWD(a) (eassert (BOOLFWDP (a)), &(XMISC(a)->u_boolfwd))
532 #define XOBJFWD(a) (eassert (OBJFWDP (a)), &(XMISC(a)->u_objfwd))
533 #define XOVERLAY(a) (eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
534 #define XSAVE_VALUE(a) (eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
535 #define XBUFFER_OBJFWD(a) \
536 (eassert (BUFFER_OBJFWDP (a)), &(XMISC(a)->u_buffer_objfwd))
537 #define XBUFFER_LOCAL_VALUE(a) \
538 (eassert (BUFFER_LOCAL_VALUEP (a)), &(XMISC(a)->u_buffer_local_value))
539 #define XKBOARD_OBJFWD(a) \
540 (eassert (KBOARD_OBJFWDP (a)), &(XMISC(a)->u_kboard_objfwd))
541
542 /* Pseudovector types. */
543
544 #define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
545 #define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
546 #define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
547 #define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
548 #define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
549 #define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
550 #define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
551 #define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
552
553 /* Construct a Lisp_Object from a value or address. */
554
555 #define XSETINT(a, b) (a) = make_number (b)
556 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
557 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
558 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
559 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
560 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
561
562 /* Misc types. */
563
564 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
565 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
566
567 /* Pseudovector types. */
568
569 #define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
570 #define XSETPSEUDOVECTOR(a, b, code) \
571 (XSETVECTOR (a, b), \
572 eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK)) \
573 == (PSEUDOVECTOR_FLAG | (code))))
574 #define XSETWINDOW_CONFIGURATION(a, b) \
575 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
576 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
577 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
578 #define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
579 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
580 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
581 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
582 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
583 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
584 #define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
585
586 /* Convenience macros for dealing with Lisp arrays. */
587
588 #define AREF(ARRAY, IDX) XVECTOR ((ARRAY))->contents[IDX]
589 #define ASIZE(ARRAY) XVECTOR ((ARRAY))->size
590 /* The IDX==IDX tries to detect when the macro argument is side-effecting. */
591 #define ASET(ARRAY, IDX, VAL) \
592 (eassert ((IDX) == (IDX)), \
593 eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)), \
594 AREF ((ARRAY), (IDX)) = (VAL))
595
596 /* Convenience macros for dealing with Lisp strings. */
597
598 #define SDATA(string) (XSTRING (string)->data + 0)
599 #define SREF(string, index) (SDATA (string)[index] + 0)
600 #define SSET(string, index, new) (SDATA (string)[index] = (new))
601 #define SCHARS(string) (XSTRING (string)->size + 0)
602 #define SBYTES(string) (STRING_BYTES (XSTRING (string)) + 0)
603
604 #define STRING_SET_CHARS(string, newsize) \
605 (XSTRING (string)->size = (newsize))
606
607 #define STRING_COPYIN(string, index, new, count) \
608 bcopy (new, SDATA (string) + index, count)
609
610 /* Type checking. */
611
612 #define CHECK_TYPE(ok, Qxxxp, x) \
613 do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)
614
615
616 \f
617 /* See the macros in intervals.h. */
618
619 typedef struct interval *INTERVAL;
620
621 /* Complain if object is not string or buffer type */
622 #define CHECK_STRING_OR_BUFFER(x) \
623 CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)
624
625 \f
626 /* In a cons, the markbit of the car is the gc mark bit */
627
628 struct Lisp_Cons
629 {
630 /* Please do not use the names of these elements in code other
631 than the core lisp implementation. Use XCAR and XCDR below. */
632 #ifdef HIDE_LISP_IMPLEMENTATION
633 Lisp_Object car_;
634 union
635 {
636 Lisp_Object cdr_;
637 struct Lisp_Cons *chain;
638 } u;
639 #else
640 Lisp_Object car;
641 union
642 {
643 Lisp_Object cdr;
644 struct Lisp_Cons *chain;
645 } u;
646 #endif
647 };
648
649 /* Take the car or cdr of something known to be a cons cell. */
650 /* The _AS_LVALUE macros shouldn't be used outside of the minimal set
651 of code that has to know what a cons cell looks like. Other code not
652 part of the basic lisp implementation should assume that the car and cdr
653 fields are not accessible as lvalues. (What if we want to switch to
654 a copying collector someday? Cached cons cell field addresses may be
655 invalidated at arbitrary points.) */
656 #ifdef HIDE_LISP_IMPLEMENTATION
657 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
658 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
659 #else
660 #define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
661 #define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
662 #endif
663
664 /* Use these from normal code. */
665 #define XCAR(c) LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
666 #define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))
667
668 /* Use these to set the fields of a cons cell.
669
670 Note that both arguments may refer to the same object, so 'n'
671 should not be read after 'c' is first modified. Also, neither
672 argument should be evaluated more than once; side effects are
673 especially common in the second argument. */
674 #define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
675 #define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))
676
677 /* For performance: Fast storage of positive integers into the
678 fields of a cons cell. See above caveats. */
679 #define XSETCARFASTINT(c,n) XSETFASTINT(XCAR_AS_LVALUE(c),(n))
680 #define XSETCDRFASTINT(c,n) XSETFASTINT(XCDR_AS_LVALUE(c),(n))
681
682 /* Take the car or cdr of something whose type is not known. */
683 #define CAR(c) \
684 (CONSP ((c)) ? XCAR ((c)) \
685 : NILP ((c)) ? Qnil \
686 : wrong_type_argument (Qlistp, (c)))
687
688 #define CDR(c) \
689 (CONSP ((c)) ? XCDR ((c)) \
690 : NILP ((c)) ? Qnil \
691 : wrong_type_argument (Qlistp, (c)))
692
693 /* Take the car or cdr of something whose type is not known. */
694 #define CAR_SAFE(c) \
695 (CONSP ((c)) ? XCAR ((c)) : Qnil)
696
697 #define CDR_SAFE(c) \
698 (CONSP ((c)) ? XCDR ((c)) : Qnil)
699
700 /* Nonzero if STR is a multibyte string. */
701 #define STRING_MULTIBYTE(STR) \
702 (XSTRING (STR)->size_byte >= 0)
703
704 /* Return the length in bytes of STR. */
705
706 #ifdef GC_CHECK_STRING_BYTES
707
708 struct Lisp_String;
709 extern int string_bytes P_ ((struct Lisp_String *));
710 #define STRING_BYTES(S) string_bytes ((S))
711
712 #else /* not GC_CHECK_STRING_BYTES */
713
714 #define STRING_BYTES(STR) \
715 ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)
716
717 #endif /* not GC_CHECK_STRING_BYTES */
718
719 /* Mark STR as a unibyte string. */
720 #define STRING_SET_UNIBYTE(STR) \
721 do { if (EQ (STR, empty_multibyte_string)) \
722 (STR) = empty_unibyte_string; \
723 else XSTRING (STR)->size_byte = -1; } while (0)
724
725 /* Mark STR as a multibyte string. Assure that STR contains only
726 ASCII characters in advance. */
727 #define STRING_SET_MULTIBYTE(STR) \
728 do { if (EQ (STR, empty_unibyte_string)) \
729 (STR) = empty_multibyte_string; \
730 else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)
731
732 /* Get text properties. */
733 #define STRING_INTERVALS(STR) (XSTRING (STR)->intervals + 0)
734
735 /* Set text properties. */
736 #define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
737
738 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
739
740 struct Lisp_String
741 {
742 EMACS_INT size;
743 EMACS_INT size_byte;
744 INTERVAL intervals; /* text properties in this string */
745 unsigned char *data;
746 };
747
748 #ifdef offsetof
749 #define OFFSETOF(type,field) offsetof(type,field)
750 #else
751 #define OFFSETOF(type,field) \
752 ((int)((char*)&((type*)0)->field - (char*)0))
753 #endif
754
755 struct Lisp_Vector
756 {
757 EMACS_UINT size;
758 struct Lisp_Vector *next;
759 Lisp_Object contents[1];
760 };
761
762 /* If a struct is made to look like a vector, this macro returns the length
763 of the shortest vector that would hold that struct. */
764 #define VECSIZE(type) ((sizeof (type) \
765 - OFFSETOF (struct Lisp_Vector, contents[0]) \
766 + sizeof(Lisp_Object) - 1) /* round up */ \
767 / sizeof (Lisp_Object))
768
769 /* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
770 at the end and we need to compute the number of Lisp_Object fields (the
771 ones that the GC needs to trace). */
772 #define PSEUDOVECSIZE(type, nonlispfield) \
773 ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
774 / sizeof (Lisp_Object))
775
776 /* A char-table is a kind of vectorlike, with contents are like a
777 vector but with a few other slots. For some purposes, it makes
778 sense to handle a char-table with type struct Lisp_Vector. An
779 element of a char table can be any Lisp objects, but if it is a sub
780 char-table, we treat it a table that contains information of a
781 specific range of characters. A sub char-table has the same
782 structure as a vector. A sub char table appears only in an element
783 of a char-table, and there's no way to access it directly from
784 Emacs Lisp program. */
785
786 /* This is the number of slots that every char table must have. This
787 counts the ordinary slots and the top, defalt, parent, and purpose
788 slots. */
789 #define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
790
791 /* Return the number of "extra" slots in the char table CT. */
792
793 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
794 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
795
796 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
797 characters. Do not check validity of CT. */
798 #define CHAR_TABLE_REF(CT, IDX) \
799 ((ASCII_CHAR_P (IDX) \
800 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii) \
801 && !NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX])) \
802 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] \
803 : char_table_ref ((CT), (IDX)))
804
805 /* Almost equivalent to Faref (CT, IDX). However, if the result is
806 not a character, return IDX.
807
808 For these characters, do not check validity of CT
809 and do not follow parent. */
810 #define CHAR_TABLE_TRANSLATE(CT, IDX) \
811 char_table_translate (CT, IDX)
812
813 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
814 8-bit European characters. Do not check validity of CT. */
815 #define CHAR_TABLE_SET(CT, IDX, VAL) \
816 (((IDX) >= 0 && ASCII_CHAR_P (IDX) \
817 && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)) \
818 ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL \
819 : char_table_set (CT, IDX, VAL))
820
821 #define CHARTAB_SIZE_BITS_0 6
822 #define CHARTAB_SIZE_BITS_1 4
823 #define CHARTAB_SIZE_BITS_2 5
824 #define CHARTAB_SIZE_BITS_3 7
825
826 extern const int chartab_size[4];
827
828 struct Lisp_Sub_Char_Table;
829
830 struct Lisp_Char_Table
831 {
832 /* This is the vector's size field, which also holds the
833 pseudovector type information. It holds the size, too.
834 The size counts the defalt, parent, purpose, ascii,
835 contents, and extras slots. */
836 EMACS_UINT size;
837 struct Lisp_Vector *next;
838
839 /* This holds a default value,
840 which is used whenever the value for a specific character is nil. */
841 Lisp_Object defalt;
842
843 /* This points to another char table, which we inherit from when the
844 value for a specific character is nil. The `defalt' slot takes
845 precedence over this. */
846 Lisp_Object parent;
847
848 /* This is a symbol which says what kind of use this char-table is
849 meant for. */
850 Lisp_Object purpose;
851
852 /* The bottom sub char-table for characters of the range 0..127. It
853 is nil if none of ASCII character has a specific value. */
854 Lisp_Object ascii;
855
856 Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
857
858 /* These hold additional data. It is a vector. */
859 Lisp_Object extras[1];
860 };
861
862 struct Lisp_Sub_Char_Table
863 {
864 /* This is the vector's size field, which also holds the
865 pseudovector type information. It holds the size, too. */
866 EMACS_INT size;
867 struct Lisp_Vector *next;
868
869 /* Depth of this sub char-table. It should be 1, 2, or 3. A sub
870 char-table of depth 1 contains 16 elments, and each element
871 covers 4096 (128*32) characters. A sub char-table of depth 2
872 contains 32 elements, and each element covers 128 characters. A
873 sub char-table of depth 3 contains 128 elements, and each element
874 is for one character. */
875 Lisp_Object depth;
876
877 /* Minimum character covered by the sub char-table. */
878 Lisp_Object min_char;
879
880 Lisp_Object contents[1];
881 };
882
883 /* A boolvector is a kind of vectorlike, with contents are like a string. */
884 struct Lisp_Bool_Vector
885 {
886 /* This is the vector's size field. It doesn't have the real size,
887 just the subtype information. */
888 EMACS_UINT vector_size;
889 struct Lisp_Vector *next;
890 /* This is the size in bits. */
891 EMACS_UINT size;
892 /* This contains the actual bits, packed into bytes. */
893 unsigned char data[1];
894 };
895
896 /* This structure describes a built-in function.
897 It is generated by the DEFUN macro only.
898 defsubr makes it into a Lisp object.
899
900 This type is treated in most respects as a pseudovector,
901 but since we never dynamically allocate or free them,
902 we don't need a next-vector field. */
903
904 struct Lisp_Subr
905 {
906 EMACS_UINT size;
907 Lisp_Object (*function) ();
908 short min_args, max_args;
909 char *symbol_name;
910 char *intspec;
911 char *doc;
912 };
913
914 \f
915 /***********************************************************************
916 Symbols
917 ***********************************************************************/
918
919 /* Interned state of a symbol. */
920
921 enum symbol_interned
922 {
923 SYMBOL_UNINTERNED = 0,
924 SYMBOL_INTERNED = 1,
925 SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
926 };
927
928 /* In a symbol, the markbit of the plist is used as the gc mark bit */
929
930 struct Lisp_Symbol
931 {
932 unsigned gcmarkbit : 1;
933
934 /* Non-zero means symbol serves as a variable alias. The symbol
935 holding the real value is found in the value slot. */
936 unsigned indirect_variable : 1;
937
938 /* Non-zero means symbol is constant, i.e. changing its value
939 should signal an error. */
940 unsigned constant : 1;
941
942 /* Interned state of the symbol. This is an enumerator from
943 enum symbol_interned. */
944 unsigned interned : 2;
945
946 /* The symbol's name, as a Lisp string.
947
948 The name "xname" is used to intentionally break code referring to
949 the old field "name" of type pointer to struct Lisp_String. */
950 Lisp_Object xname;
951
952 /* Value of the symbol or Qunbound if unbound. If this symbol is a
953 defvaralias, `value' contains the symbol for which it is an
954 alias. Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
955 and set a symbol's value, to take defvaralias into account. */
956 Lisp_Object value;
957
958 /* Function value of the symbol or Qunbound if not fboundp. */
959 Lisp_Object function;
960
961 /* The symbol's property list. */
962 Lisp_Object plist;
963
964 /* Next symbol in obarray bucket, if the symbol is interned. */
965 struct Lisp_Symbol *next;
966 };
967
968 /* Value is name of symbol. */
969
970 #define SYMBOL_NAME(sym) \
971 LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)
972
973 /* Value is non-zero if SYM is an interned symbol. */
974
975 #define SYMBOL_INTERNED_P(sym) \
976 (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)
977
978 /* Value is non-zero if SYM is interned in initial_obarray. */
979
980 #define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
981 (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)
982
983 /* Value is non-zero if symbol is considered a constant, i.e. its
984 value cannot be changed (there is an exception for keyword symbols,
985 whose value can be set to the keyword symbol itself). */
986
987 #define SYMBOL_CONSTANT_P(sym) XSYMBOL (sym)->constant
988
989 /* Value is the value of SYM, with defvaralias taken into
990 account. */
991
992 #define SYMBOL_VALUE(sym) \
993 (XSYMBOL (sym)->indirect_variable \
994 ? indirect_variable (XSYMBOL (sym))->value \
995 : XSYMBOL (sym)->value)
996
997 /* Set SYM's value to VAL, taking defvaralias into account. */
998
999 #define SET_SYMBOL_VALUE(sym, val) \
1000 do { \
1001 if (XSYMBOL (sym)->indirect_variable) \
1002 indirect_variable (XSYMBOL (sym))->value = (val); \
1003 else \
1004 XSYMBOL (sym)->value = (val); \
1005 } while (0)
1006
1007 \f
1008 /***********************************************************************
1009 Hash Tables
1010 ***********************************************************************/
1011
1012 /* The structure of a Lisp hash table. */
1013
1014 struct Lisp_Hash_Table
1015 {
1016 /* Vector fields. The hash table code doesn't refer to these. */
1017 EMACS_UINT size;
1018 struct Lisp_Vector *vec_next;
1019
1020 /* Function used to compare keys. */
1021 Lisp_Object test;
1022
1023 /* Nil if table is non-weak. Otherwise a symbol describing the
1024 weakness of the table. */
1025 Lisp_Object weak;
1026
1027 /* When the table is resized, and this is an integer, compute the
1028 new size by adding this to the old size. If a float, compute the
1029 new size by multiplying the old size with this factor. */
1030 Lisp_Object rehash_size;
1031
1032 /* Resize hash table when number of entries/ table size is >= this
1033 ratio, a float. */
1034 Lisp_Object rehash_threshold;
1035
1036 /* Vector of hash codes.. If hash[I] is nil, this means that that
1037 entry I is unused. */
1038 Lisp_Object hash;
1039
1040 /* Vector used to chain entries. If entry I is free, next[I] is the
1041 entry number of the next free item. If entry I is non-free,
1042 next[I] is the index of the next entry in the collision chain. */
1043 Lisp_Object next;
1044
1045 /* Index of first free entry in free list. */
1046 Lisp_Object next_free;
1047
1048 /* Bucket vector. A non-nil entry is the index of the first item in
1049 a collision chain. This vector's size can be larger than the
1050 hash table size to reduce collisions. */
1051 Lisp_Object index;
1052
1053 /* User-supplied hash function, or nil. */
1054 Lisp_Object user_hash_function;
1055
1056 /* User-supplied key comparison function, or nil. */
1057 Lisp_Object user_cmp_function;
1058
1059 /* Only the fields above are traced normally by the GC. The ones below
1060 `count'. are special and are either ignored by the GC or traced in
1061 a special way (e.g. because of weakness). */
1062
1063 /* Number of key/value entries in the table. */
1064 unsigned int count;
1065
1066 /* Vector of keys and values. The key of item I is found at index
1067 2 * I, the value is found at index 2 * I + 1.
1068 This is gc_marked specially if the table is weak. */
1069 Lisp_Object key_and_value;
1070
1071 /* Next weak hash table if this is a weak hash table. The head
1072 of the list is in weak_hash_tables. */
1073 struct Lisp_Hash_Table *next_weak;
1074
1075 /* C function to compare two keys. */
1076 int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
1077 unsigned, Lisp_Object, unsigned));
1078
1079 /* C function to compute hash code. */
1080 unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
1081 };
1082
1083
1084 #define XHASH_TABLE(OBJ) \
1085 ((struct Lisp_Hash_Table *) XPNTR (OBJ))
1086
1087 #define XSET_HASH_TABLE(VAR, PTR) \
1088 (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))
1089
1090 #define HASH_TABLE_P(OBJ) PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
1091
1092 #define CHECK_HASH_TABLE(x) \
1093 CHECK_TYPE (HASH_TABLE_P (x), Qhash_table_p, x)
1094
1095 /* Value is the key part of entry IDX in hash table H. */
1096
1097 #define HASH_KEY(H, IDX) AREF ((H)->key_and_value, 2 * (IDX))
1098
1099 /* Value is the value part of entry IDX in hash table H. */
1100
1101 #define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)
1102
1103 /* Value is the index of the next entry following the one at IDX
1104 in hash table H. */
1105
1106 #define HASH_NEXT(H, IDX) AREF ((H)->next, (IDX))
1107
1108 /* Value is the hash code computed for entry IDX in hash table H. */
1109
1110 #define HASH_HASH(H, IDX) AREF ((H)->hash, (IDX))
1111
1112 /* Value is the index of the element in hash table H that is the
1113 start of the collision list at index IDX in the index vector of H. */
1114
1115 #define HASH_INDEX(H, IDX) AREF ((H)->index, (IDX))
1116
1117 /* Value is the size of hash table H. */
1118
1119 #define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size
1120
1121 /* Default size for hash tables if not specified. */
1122
1123 #define DEFAULT_HASH_SIZE 65
1124
1125 /* Default threshold specifying when to resize a hash table. The
1126 value gives the ratio of current entries in the hash table and the
1127 size of the hash table. */
1128
1129 #define DEFAULT_REHASH_THRESHOLD 0.8
1130
1131 /* Default factor by which to increase the size of a hash table. */
1132
1133 #define DEFAULT_REHASH_SIZE 1.5
1134
1135 \f
1136 /* These structures are used for various misc types. */
1137
1138 struct Lisp_Misc_Any /* Supertype of all Misc types. */
1139 {
1140 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1141 unsigned gcmarkbit : 1;
1142 int spacer : 15;
1143 };
1144
1145 struct Lisp_Marker
1146 {
1147 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Marker */
1148 unsigned gcmarkbit : 1;
1149 int spacer : 13;
1150 /* This flag is temporarily used in the functions
1151 decode/encode_coding_object to record that the marker position
1152 must be adjusted after the conversion. */
1153 unsigned int need_adjustment : 1;
1154 /* 1 means normal insertion at the marker's position
1155 leaves the marker after the inserted text. */
1156 unsigned int insertion_type : 1;
1157 /* This is the buffer that the marker points into, or 0 if it points nowhere.
1158 Note: a chain of markers can contain markers pointing into different
1159 buffers (the chain is per buffer_text rather than per buffer, so it's
1160 shared between indirect buffers). */
1161 /* This is used for (other than NULL-checking):
1162 - Fmarker_buffer
1163 - Fset_marker: check eq(oldbuf, newbuf) to avoid unchain+rechain.
1164 - unchain_marker: to find the list from which to unchain.
1165 - Fkill_buffer: to unchain the markers of current indirect buffer.
1166 */
1167 struct buffer *buffer;
1168
1169 /* The remaining fields are meaningless in a marker that
1170 does not point anywhere. */
1171
1172 /* For markers that point somewhere,
1173 this is used to chain of all the markers in a given buffer. */
1174 /* We could remove it and use an array in buffer_text instead.
1175 That would also allow to preserve it ordered. */
1176 struct Lisp_Marker *next;
1177 /* This is the char position where the marker points. */
1178 EMACS_INT charpos;
1179 /* This is the byte position. */
1180 EMACS_INT bytepos;
1181 };
1182
1183 /* Forwarding pointer to an int variable.
1184 This is allowed only in the value cell of a symbol,
1185 and it means that the symbol's value really lives in the
1186 specified int variable. */
1187 struct Lisp_Intfwd
1188 {
1189 int type : 16; /* = Lisp_Misc_Intfwd */
1190 unsigned gcmarkbit : 1;
1191 int spacer : 15;
1192 EMACS_INT *intvar;
1193 };
1194
1195 /* Boolean forwarding pointer to an int variable.
1196 This is like Lisp_Intfwd except that the ostensible
1197 "value" of the symbol is t if the int variable is nonzero,
1198 nil if it is zero. */
1199 struct Lisp_Boolfwd
1200 {
1201 int type : 16; /* = Lisp_Misc_Boolfwd */
1202 unsigned gcmarkbit : 1;
1203 int spacer : 15;
1204 int *boolvar;
1205 };
1206
1207 /* Forwarding pointer to a Lisp_Object variable.
1208 This is allowed only in the value cell of a symbol,
1209 and it means that the symbol's value really lives in the
1210 specified variable. */
1211 struct Lisp_Objfwd
1212 {
1213 int type : 16; /* = Lisp_Misc_Objfwd */
1214 unsigned gcmarkbit : 1;
1215 int spacer : 15;
1216 Lisp_Object *objvar;
1217 };
1218
1219 /* Like Lisp_Objfwd except that value lives in a slot in the
1220 current buffer. Value is byte index of slot within buffer. */
1221 struct Lisp_Buffer_Objfwd
1222 {
1223 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
1224 unsigned gcmarkbit : 1;
1225 int spacer : 15;
1226 Lisp_Object slottype; /* Qnil, Lisp_Int, Lisp_Symbol, or Lisp_String. */
1227 int offset;
1228 };
1229
1230 /* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
1231 the symbol has buffer-local or frame-local bindings. (Exception:
1232 some buffer-local variables are built-in, with their values stored
1233 in the buffer structure itself. They are handled differently,
1234 using struct Lisp_Buffer_Objfwd.)
1235
1236 The `realvalue' slot holds the variable's current value, or a
1237 forwarding pointer to where that value is kept. This value is the
1238 one that corresponds to the loaded binding. To read or set the
1239 variable, you must first make sure the right binding is loaded;
1240 then you can access the value in (or through) `realvalue'.
1241
1242 `buffer' and `frame' are the buffer and frame for which the loaded
1243 binding was found. If those have changed, to make sure the right
1244 binding is loaded it is necessary to find which binding goes with
1245 the current buffer and selected frame, then load it. To load it,
1246 first unload the previous binding, then copy the value of the new
1247 binding into `realvalue' (or through it). Also update
1248 LOADED-BINDING to point to the newly loaded binding.
1249
1250 `local_if_set' indicates that merely setting the variable creates a local
1251 binding for the current buffer. Otherwise the latter, setting the
1252 variable does not do that; only make-local-variable does that. */
1253
1254 struct Lisp_Buffer_Local_Value
1255 {
1256 int type : 16; /* = Lisp_Misc_Buffer_Local_Value */
1257 unsigned gcmarkbit : 1;
1258 int spacer : 11;
1259
1260 /* 1 means that merely setting the variable creates a local
1261 binding for the current buffer */
1262 unsigned int local_if_set : 1;
1263 /* 1 means this variable is allowed to have frame-local bindings,
1264 so check for them when looking for the proper binding. */
1265 unsigned int check_frame : 1;
1266 /* 1 means that the binding now loaded was found
1267 as a local binding for the buffer in the `buffer' slot. */
1268 unsigned int found_for_buffer : 1;
1269 /* 1 means that the binding now loaded was found
1270 as a local binding for the frame in the `frame' slot. */
1271 unsigned int found_for_frame : 1;
1272 Lisp_Object realvalue;
1273 /* The buffer and frame for which the loaded binding was found. */
1274 /* Having both is only needed if we want to allow variables that are
1275 both buffer local and frame local (in which case, we currently give
1276 precedence to the buffer-local binding). I don't think such
1277 a combination is desirable. --Stef */
1278 Lisp_Object buffer, frame;
1279
1280 /* A cons cell, (LOADED-BINDING . DEFAULT-VALUE).
1281
1282 LOADED-BINDING is the binding now loaded. It is a cons cell
1283 whose cdr is the binding's value. The cons cell may be an
1284 element of a buffer's local-variable alist, or an element of a
1285 frame's parameter alist, or it may be this cons cell.
1286
1287 DEFAULT-VALUE is the variable's default value, seen when the
1288 current buffer and selected frame do not have their own
1289 bindings for the variable. When the default binding is loaded,
1290 LOADED-BINDING is actually this very cons cell; thus, its car
1291 points to itself. */
1292 Lisp_Object cdr;
1293 };
1294
1295 /* START and END are markers in the overlay's buffer, and
1296 PLIST is the overlay's property list. */
1297 struct Lisp_Overlay
1298 {
1299 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Overlay */
1300 unsigned gcmarkbit : 1;
1301 int spacer : 15;
1302 struct Lisp_Overlay *next;
1303 Lisp_Object start, end, plist;
1304 };
1305
1306 /* Like Lisp_Objfwd except that value lives in a slot in the
1307 current kboard. */
1308 struct Lisp_Kboard_Objfwd
1309 {
1310 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Kboard_Objfwd */
1311 unsigned gcmarkbit : 1;
1312 int spacer : 15;
1313 int offset;
1314 };
1315
1316 /* Hold a C pointer for later use.
1317 This type of object is used in the arg to record_unwind_protect. */
1318 struct Lisp_Save_Value
1319 {
1320 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Save_Value */
1321 unsigned gcmarkbit : 1;
1322 int spacer : 14;
1323 /* If DOGC is set, POINTER is the address of a memory
1324 area containing INTEGER potential Lisp_Objects. */
1325 unsigned int dogc : 1;
1326 void *pointer;
1327 int integer;
1328 };
1329
1330
1331 /* A miscellaneous object, when it's on the free list. */
1332 struct Lisp_Free
1333 {
1334 enum Lisp_Misc_Type type : 16; /* = Lisp_Misc_Free */
1335 unsigned gcmarkbit : 1;
1336 int spacer : 15;
1337 union Lisp_Misc *chain;
1338 #ifdef USE_LSB_TAG
1339 /* Try to make sure that sizeof(Lisp_Misc) preserves TYPEBITS-alignment.
1340 This assumes that Lisp_Marker is the largest of the alternatives and
1341 that Lisp_Intfwd has the same size as "Lisp_Free w/o padding". */
1342 char padding[((((sizeof (struct Lisp_Marker) - 1) >> GCTYPEBITS) + 1)
1343 << GCTYPEBITS) - sizeof (struct Lisp_Intfwd)];
1344 #endif
1345 };
1346
1347 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
1348 It uses one of these struct subtypes to get the type field. */
1349
1350 union Lisp_Misc
1351 {
1352 struct Lisp_Misc_Any u_any; /* Supertype of all Misc types. */
1353 struct Lisp_Free u_free; /* Includes padding to force alignment. */
1354 struct Lisp_Marker u_marker;
1355 struct Lisp_Intfwd u_intfwd;
1356 struct Lisp_Boolfwd u_boolfwd;
1357 struct Lisp_Objfwd u_objfwd;
1358 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1359 struct Lisp_Buffer_Local_Value u_buffer_local_value;
1360 struct Lisp_Overlay u_overlay;
1361 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1362 struct Lisp_Save_Value u_save_value;
1363 };
1364 \f
1365 /* Lisp floating point type */
1366 struct Lisp_Float
1367 {
1368 union
1369 {
1370 #ifdef HIDE_LISP_IMPLEMENTATION
1371 double data_;
1372 #else
1373 double data;
1374 #endif
1375 struct Lisp_Float *chain;
1376 } u;
1377 };
1378
1379 #ifdef HIDE_LISP_IMPLEMENTATION
1380 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data_)
1381 #else
1382 #define XFLOAT_DATA(f) (XFLOAT (f)->u.data)
1383 #endif
1384
1385 /* A character, declared with the following typedef, is a member
1386 of some character set associated with the current buffer. */
1387 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
1388 #define _UCHAR_T
1389 typedef unsigned char UCHAR;
1390 #endif
1391
1392 /* Meanings of slots in a Lisp_Compiled: */
1393
1394 #define COMPILED_ARGLIST 0
1395 #define COMPILED_BYTECODE 1
1396 #define COMPILED_CONSTANTS 2
1397 #define COMPILED_STACK_DEPTH 3
1398 #define COMPILED_DOC_STRING 4
1399 #define COMPILED_INTERACTIVE 5
1400
1401 /* Flag bits in a character. These also get used in termhooks.h.
1402 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1403 (MUlti-Lingual Emacs) might need 22 bits for the character value
1404 itself, so we probably shouldn't use any bits lower than 0x0400000. */
1405 #define CHAR_ALT (0x0400000)
1406 #define CHAR_SUPER (0x0800000)
1407 #define CHAR_HYPER (0x1000000)
1408 #define CHAR_SHIFT (0x2000000)
1409 #define CHAR_CTL (0x4000000)
1410 #define CHAR_META (0x8000000)
1411
1412 #define CHAR_MODIFIER_MASK \
1413 (CHAR_ALT | CHAR_SUPER | CHAR_HYPER | CHAR_SHIFT | CHAR_CTL | CHAR_META)
1414
1415
1416 /* Actually, the current Emacs uses 22 bits for the character value
1417 itself. */
1418 #define CHARACTERBITS 22
1419
1420 /* The maximum byte size consumed by push_key_description.
1421 All callers should assure that at least this size of memory is
1422 allocated at the place pointed by the second argument.
1423
1424 There are 6 modifiers, each consumes 2 chars.
1425 The octal form of a character code consumes
1426 (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
1427 We need one more byte for string terminator `\0'. */
1428 #define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)
1429
1430 \f
1431 /* The glyph datatype, used to represent characters on the display.
1432 It consists of a char code and a face id. */
1433
1434 typedef struct {
1435 int ch;
1436 int face_id;
1437 } GLYPH;
1438
1439 /* Return a glyph's character code. */
1440 #define GLYPH_CHAR(glyph) ((glyph).ch)
1441
1442 /* Return a glyph's face ID. */
1443 #define GLYPH_FACE(glyph) ((glyph).face_id)
1444
1445 #define SET_GLYPH_CHAR(glyph, char) ((glyph).ch = (char))
1446 #define SET_GLYPH_FACE(glyph, face) ((glyph).face_id = (face))
1447 #define SET_GLYPH(glyph, char, face) ((glyph).ch = (char), (glyph).face_id = (face))
1448
1449 /* Return 1 if GLYPH contains valid character code. */
1450 #define GLYPH_CHAR_VALID_P(glyph) CHAR_VALID_P (GLYPH_CHAR (glyph), 1)
1451
1452
1453 /* Glyph Code from a display vector may either be an integer which
1454 encodes a char code in the lower CHARACTERBITS bits and a (very small)
1455 face-id in the upper bits, or it may be a cons (CHAR . FACE-ID). */
1456
1457 #define GLYPH_CODE_CHAR(gc) \
1458 (CONSP (gc) ? XINT (XCAR (gc)) : INTEGERP (gc) ? (XINT (gc) & ((1 << CHARACTERBITS)-1)) : 0)
1459
1460 #define GLYPH_CODE_FACE(gc) \
1461 (CONSP (gc) ? XINT (XCDR (gc)) : INTEGERP (gc) ? (XINT (gc) >> CHARACTERBITS) : DEFAULT_FACE_ID)
1462
1463 /* Return 1 if glyph code from display vector contains valid character code. */
1464 #define GLYPH_CODE_CHAR_VALID_P(gc) CHAR_VALID_P (GLYPH_CODE_CHAR (gc), 1)
1465
1466 #define GLYPH_CODE_P(gc) ((CONSP (gc) && INTEGERP (XCAR (gc)) && INTEGERP (XCDR (gc))) || INTEGERP (gc))
1467
1468 /* Only called when GLYPH_CODE_P (gc) is true. */
1469 #define SET_GLYPH_FROM_GLYPH_CODE(glyph, gc) \
1470 do \
1471 { \
1472 if (CONSP (gc)) \
1473 SET_GLYPH (glyph, XINT (XCAR (gc)), XINT (XCDR (gc))); \
1474 else \
1475 SET_GLYPH (glyph, (XINT (gc) & ((1 << CHARACTERBITS)-1)), \
1476 (XINT (gc) >> CHARACTERBITS)); \
1477 } \
1478 while (0)
1479
1480 /* The ID of the mode line highlighting face. */
1481 #define GLYPH_MODE_LINE_FACE 1
1482 \f
1483 /* Data type checking */
1484
1485 #define NILP(x) EQ (x, Qnil)
1486
1487 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
1488 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
1489
1490 #define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
1491 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
1492 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
1493 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
1494 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
1495 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
1496
1497 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
1498 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
1499 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
1500 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
1501 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
1502 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
1503 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
1504 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
1505 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
1506 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1507 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1508 #define SAVE_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Save_Value)
1509
1510
1511 /* True if object X is a pseudovector whose code is CODE. */
1512 #define PSEUDOVECTORP(x, code) \
1513 (VECTORLIKEP (x) \
1514 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1515 == (PSEUDOVECTOR_FLAG | (code))))
1516
1517 /* Test for specific pseudovector types. */
1518 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1519 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1520 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1521 #define TERMINALP(x) PSEUDOVECTORP (x, PVEC_TERMINAL)
1522 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1523 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1524 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1525 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1526 #define SUB_CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_SUB_CHAR_TABLE)
1527 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1528 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1529
1530 /* Test for image (image . spec) */
1531 #define IMAGEP(x) (CONSP (x) && EQ (XCAR (x), Qimage))
1532
1533 /* Array types. */
1534
1535 #define ARRAYP(x) \
1536 (VECTORP (x) || STRINGP (x) || CHAR_TABLE_P (x) || BOOL_VECTOR_P (x))
1537 \f
1538 #define CHECK_LIST(x) \
1539 CHECK_TYPE (CONSP (x) || NILP (x), Qlistp, x)
1540
1541 #define CHECK_LIST_CONS(x, y) \
1542 CHECK_TYPE (CONSP (x), Qlistp, y)
1543
1544 #define CHECK_LIST_END(x, y) \
1545 CHECK_TYPE (NILP (x), Qlistp, y)
1546
1547 #define CHECK_STRING(x) \
1548 CHECK_TYPE (STRINGP (x), Qstringp, x)
1549
1550 #define CHECK_STRING_CAR(x) \
1551 CHECK_TYPE (STRINGP (XCAR (x)), Qstringp, XCAR (x))
1552
1553 #define CHECK_CONS(x) \
1554 CHECK_TYPE (CONSP (x), Qconsp, x)
1555
1556 #define CHECK_SYMBOL(x) \
1557 CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
1558
1559 #define CHECK_CHAR_TABLE(x) \
1560 CHECK_TYPE (CHAR_TABLE_P (x), Qchar_table_p, x)
1561
1562 #define CHECK_VECTOR(x) \
1563 CHECK_TYPE (VECTORP (x), Qvectorp, x)
1564
1565 #define CHECK_VECTOR_OR_STRING(x) \
1566 CHECK_TYPE (VECTORP (x) || STRINGP (x), Qarrayp, x)
1567
1568 #define CHECK_ARRAY(x, Qxxxp) \
1569 CHECK_TYPE (ARRAYP (x), Qxxxp, x)
1570
1571 #define CHECK_VECTOR_OR_CHAR_TABLE(x) \
1572 CHECK_TYPE (VECTORP (x) || CHAR_TABLE_P (x), Qvector_or_char_table_p, x)
1573
1574 #define CHECK_BUFFER(x) \
1575 CHECK_TYPE (BUFFERP (x), Qbufferp, x)
1576
1577 #define CHECK_WINDOW(x) \
1578 CHECK_TYPE (WINDOWP (x), Qwindowp, x)
1579
1580 #define CHECK_WINDOW_CONFIGURATION(x) \
1581 CHECK_TYPE (WINDOW_CONFIGURATIONP (x), Qwindow_configuration_p, x)
1582
1583 /* This macro rejects windows on the interior of the window tree as
1584 "dead", which is what we want; this is an argument-checking macro, and
1585 the user should never get access to interior windows.
1586
1587 A window of any sort, leaf or interior, is dead if the buffer,
1588 vchild, and hchild members are all nil. */
1589
1590 #define CHECK_LIVE_WINDOW(x) \
1591 CHECK_TYPE (WINDOWP (x) && !NILP (XWINDOW (x)->buffer), Qwindow_live_p, x)
1592
1593 #define CHECK_PROCESS(x) \
1594 CHECK_TYPE (PROCESSP (x), Qprocessp, x)
1595
1596 #define CHECK_SUBR(x) \
1597 CHECK_TYPE (SUBRP (x), Qsubrp, x)
1598
1599 #define CHECK_NUMBER(x) \
1600 CHECK_TYPE (INTEGERP (x), Qintegerp, x)
1601
1602 #define CHECK_NATNUM(x) \
1603 CHECK_TYPE (NATNUMP (x), Qwholenump, x)
1604
1605 #define CHECK_MARKER(x) \
1606 CHECK_TYPE (MARKERP (x), Qmarkerp, x)
1607
1608 #define CHECK_NUMBER_COERCE_MARKER(x) \
1609 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1610 else CHECK_TYPE (INTEGERP (x), Qinteger_or_marker_p, x); } while (0)
1611
1612 #define XFLOATINT(n) extract_float((n))
1613
1614 #define CHECK_FLOAT(x) \
1615 CHECK_TYPE (FLOATP (x), Qfloatp, x)
1616
1617 #define CHECK_NUMBER_OR_FLOAT(x) \
1618 CHECK_TYPE (FLOATP (x) || INTEGERP (x), Qnumberp, x)
1619
1620 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x) \
1621 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1622 else CHECK_TYPE (INTEGERP (x) || FLOATP (x), Qnumber_or_marker_p, x); } while (0)
1623
1624 #define CHECK_OVERLAY(x) \
1625 CHECK_TYPE (OVERLAYP (x), Qoverlayp, x)
1626
1627 /* Since we can't assign directly to the CAR or CDR fields of a cons
1628 cell, use these when checking that those fields contain numbers. */
1629 #define CHECK_NUMBER_CAR(x) \
1630 do { \
1631 Lisp_Object tmp = XCAR (x); \
1632 CHECK_NUMBER (tmp); \
1633 XSETCAR ((x), tmp); \
1634 } while (0)
1635
1636 #define CHECK_NUMBER_CDR(x) \
1637 do { \
1638 Lisp_Object tmp = XCDR (x); \
1639 CHECK_NUMBER (tmp); \
1640 XSETCDR ((x), tmp); \
1641 } while (0)
1642
1643 #define CHECK_NATNUM_CAR(x) \
1644 do { \
1645 Lisp_Object tmp = XCAR (x); \
1646 CHECK_NATNUM (tmp); \
1647 XSETCAR ((x), tmp); \
1648 } while (0)
1649
1650 #define CHECK_NATNUM_CDR(x) \
1651 do { \
1652 Lisp_Object tmp = XCDR (x); \
1653 CHECK_NATNUM (tmp); \
1654 XSETCDR ((x), tmp); \
1655 } while (0)
1656
1657 /* Cast pointers to this type to compare them. Some machines want int. */
1658 #define PNTR_COMPARISON_TYPE EMACS_UINT
1659 \f
1660 /* Define a built-in function for calling from Lisp.
1661 `lname' should be the name to give the function in Lisp,
1662 as a null-terminated C string.
1663 `fnname' should be the name of the function in C.
1664 By convention, it starts with F.
1665 `sname' should be the name for the C constant structure
1666 that records information on this function for internal use.
1667 By convention, it should be the same as `fnname' but with S instead of F.
1668 It's too bad that C macros can't compute this from `fnname'.
1669 `minargs' should be a number, the minimum number of arguments allowed.
1670 `maxargs' should be a number, the maximum number of arguments allowed,
1671 or else MANY or UNEVALLED.
1672 MANY means pass a vector of evaluated arguments,
1673 in the form of an integer number-of-arguments
1674 followed by the address of a vector of Lisp_Objects
1675 which contains the argument values.
1676 UNEVALLED means pass the list of unevaluated arguments
1677 `intspec' says how interactive arguments are to be fetched.
1678 If the string starts with a `(', `intspec' is evaluated and the resulting
1679 list is the list of arguments.
1680 If it's a string that doesn't start with `(', the value should follow
1681 the one of the doc string for `interactive'.
1682 A null string means call interactively with no arguments.
1683 `doc' is documentation for the user. */
1684
1685 #if (!defined (__STDC__) && !defined (PROTOTYPES))
1686
1687 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1688 Lisp_Object fnname (); \
1689 DECL_ALIGN (struct Lisp_Subr, sname) = \
1690 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1691 fnname, minargs, maxargs, lname, intspec, 0}; \
1692 Lisp_Object fnname
1693
1694 #else
1695
1696 /* This version of DEFUN declares a function prototype with the right
1697 arguments, so we can catch errors with maxargs at compile-time. */
1698 #define DEFUN(lname, fnname, sname, minargs, maxargs, intspec, doc) \
1699 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1700 DECL_ALIGN (struct Lisp_Subr, sname) = \
1701 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1702 fnname, minargs, maxargs, lname, intspec, 0}; \
1703 Lisp_Object fnname
1704
1705 /* Note that the weird token-substitution semantics of ANSI C makes
1706 this work for MANY and UNEVALLED. */
1707 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1708 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1709 #define DEFUN_ARGS_0 (void)
1710 #define DEFUN_ARGS_1 (Lisp_Object)
1711 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1712 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1713 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1714 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1715 Lisp_Object)
1716 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1717 Lisp_Object, Lisp_Object)
1718 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1719 Lisp_Object, Lisp_Object, Lisp_Object)
1720 #define DEFUN_ARGS_8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1721 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1722 #endif
1723
1724 /* Non-zero if OBJ is a Lisp function. */
1725
1726 #define FUNCTIONP(OBJ) \
1727 ((CONSP (OBJ) && EQ (XCAR (OBJ), Qlambda)) \
1728 || (SYMBOLP (OBJ) && !NILP (Ffboundp (OBJ))) \
1729 || COMPILEDP (OBJ) \
1730 || SUBRP (OBJ))
1731
1732 /* defsubr (Sname);
1733 is how we define the symbol for function `name' at start-up time. */
1734 extern void defsubr P_ ((struct Lisp_Subr *));
1735
1736 #define MANY -2
1737 #define UNEVALLED -1
1738
1739 extern void defvar_lisp P_ ((char *, Lisp_Object *));
1740 extern void defvar_lisp_nopro P_ ((char *, Lisp_Object *));
1741 extern void defvar_bool P_ ((char *, int *));
1742 extern void defvar_int P_ ((char *, EMACS_INT *));
1743 extern void defvar_kboard P_ ((char *, int));
1744
1745 /* Macros we use to define forwarded Lisp variables.
1746 These are used in the syms_of_FILENAME functions. */
1747
1748 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1749 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1750 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1751 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1752
1753 #define DEFVAR_KBOARD(lname, vname, doc) \
1754 defvar_kboard (lname, \
1755 (int)((char *)(&current_kboard->vname) \
1756 - (char *)current_kboard))
1757
1758
1759 \f
1760 /* Structure for recording Lisp call stack for backtrace purposes. */
1761
1762 /* The special binding stack holds the outer values of variables while
1763 they are bound by a function application or a let form, stores the
1764 code to be executed for Lisp unwind-protect forms, and stores the C
1765 functions to be called for record_unwind_protect.
1766
1767 If func is non-zero, undoing this binding applies func to old_value;
1768 This implements record_unwind_protect.
1769
1770 Otherwise, the element is a variable binding.
1771
1772 If the symbol field is a symbol, it is an ordinary variable binding.
1773
1774 Otherwise, it should be a structure (SYMBOL WHERE
1775 . CURRENT-BUFFER), which means having bound a local value while
1776 CURRENT-BUFFER was active. If WHERE is nil this means we saw the
1777 default value when binding SYMBOL. WHERE being a buffer or frame
1778 means we saw a buffer-local or frame-local value. Other values of
1779 WHERE mean an internal error. */
1780
1781 typedef Lisp_Object (*specbinding_func) P_ ((Lisp_Object));
1782
1783 struct specbinding
1784 {
1785 Lisp_Object symbol, old_value;
1786 specbinding_func func;
1787 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1788 };
1789
1790 extern struct specbinding *specpdl;
1791 extern struct specbinding *specpdl_ptr;
1792 extern int specpdl_size;
1793
1794 extern EMACS_INT max_specpdl_size;
1795
1796 #define SPECPDL_INDEX() (specpdl_ptr - specpdl)
1797
1798 /* Everything needed to describe an active condition case. */
1799 struct handler
1800 {
1801 /* The handler clauses and variable from the condition-case form. */
1802 /* For a handler set up in Lisp code, this is always a list.
1803 For an internal handler set up by internal_condition_case*,
1804 this can instead be the symbol t or `error'.
1805 t: handle all conditions.
1806 error: handle all conditions, and errors can run the debugger
1807 or display a backtrace. */
1808 Lisp_Object handler;
1809 Lisp_Object var;
1810 /* Fsignal stores here the condition-case clause that applies,
1811 and Fcondition_case thus knows which clause to run. */
1812 Lisp_Object chosen_clause;
1813
1814 /* Used to effect the longjump out to the handler. */
1815 struct catchtag *tag;
1816
1817 /* The next enclosing handler. */
1818 struct handler *next;
1819 };
1820
1821 extern struct handler *handlerlist;
1822
1823 extern struct catchtag *catchlist;
1824 extern struct backtrace *backtrace_list;
1825
1826 extern Lisp_Object memory_signal_data;
1827
1828 /* An address near the bottom of the stack.
1829 Tells GC how to save a copy of the stack. */
1830 extern char *stack_bottom;
1831
1832 /* Check quit-flag and quit if it is non-nil.
1833 Typing C-g does not directly cause a quit; it only sets Vquit_flag.
1834 So the program needs to do QUIT at times when it is safe to quit.
1835 Every loop that might run for a long time or might not exit
1836 ought to do QUIT at least once, at a safe place.
1837 Unless that is impossible, of course.
1838 But it is very desirable to avoid creating loops where QUIT is impossible.
1839
1840 Exception: if you set immediate_quit to nonzero,
1841 then the handler that responds to the C-g does the quit itself.
1842 This is a good thing to do around a loop that has no side effects
1843 and (in particular) cannot call arbitrary Lisp code. */
1844
1845 #ifdef SYNC_INPUT
1846 extern void process_pending_signals P_ ((void));
1847 extern int pending_signals;
1848
1849 #define QUIT \
1850 do { \
1851 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1852 { \
1853 Lisp_Object flag = Vquit_flag; \
1854 Vquit_flag = Qnil; \
1855 if (EQ (Vthrow_on_input, flag)) \
1856 Fthrow (Vthrow_on_input, Qt); \
1857 Fsignal (Qquit, Qnil); \
1858 } \
1859 else if (pending_signals) \
1860 process_pending_signals (); \
1861 } while (0)
1862
1863 #else /* not SYNC_INPUT */
1864
1865 #define QUIT \
1866 do { \
1867 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1868 { \
1869 Lisp_Object flag = Vquit_flag; \
1870 Vquit_flag = Qnil; \
1871 if (EQ (Vthrow_on_input, flag)) \
1872 Fthrow (Vthrow_on_input, Qt); \
1873 Fsignal (Qquit, Qnil); \
1874 } \
1875 } while (0)
1876
1877 #endif /* not SYNC_INPUT */
1878
1879
1880 /* Nonzero if ought to quit now. */
1881
1882 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1883 \f
1884 /* Variables used locally in the following case handling macros. */
1885 extern int case_temp1;
1886 extern Lisp_Object case_temp2;
1887
1888 /* Current buffer's map from characters to lower-case characters. */
1889
1890 #define DOWNCASE_TABLE current_buffer->downcase_table
1891
1892 /* Current buffer's map from characters to upper-case characters. */
1893
1894 #define UPCASE_TABLE current_buffer->upcase_table
1895
1896 /* Downcase a character, or make no change if that cannot be done. */
1897
1898 #define DOWNCASE(CH) \
1899 ((case_temp1 = (CH), \
1900 case_temp2 = CHAR_TABLE_REF (DOWNCASE_TABLE, case_temp1), \
1901 NATNUMP (case_temp2)) \
1902 ? XFASTINT (case_temp2) : case_temp1)
1903
1904 /* 1 if CH is upper case. */
1905
1906 #define UPPERCASEP(CH) (DOWNCASE (CH) != (CH))
1907
1908 /* 1 if CH is neither upper nor lower case. */
1909
1910 #define NOCASEP(CH) (UPCASE1 (CH) == (CH))
1911
1912 /* 1 if CH is lower case. */
1913
1914 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
1915
1916 /* Upcase a character, or make no change if that cannot be done. */
1917
1918 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
1919
1920 /* Upcase a character known to be not upper case. */
1921
1922 #define UPCASE1(CH) \
1923 ((case_temp1 = (CH), \
1924 case_temp2 = CHAR_TABLE_REF (UPCASE_TABLE, case_temp1), \
1925 NATNUMP (case_temp2)) \
1926 ? XFASTINT (case_temp2) : case_temp1)
1927
1928 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
1929 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
1930 \f
1931 /* Number of bytes of structure consed since last GC. */
1932
1933 extern int consing_since_gc;
1934
1935 /* Thresholds for doing another gc. */
1936
1937 extern EMACS_INT gc_cons_threshold;
1938
1939 extern EMACS_INT gc_relative_threshold;
1940
1941 extern EMACS_INT memory_full_cons_threshold;
1942
1943 /* Structure for recording stack slots that need marking. */
1944
1945 /* This is a chain of structures, each of which points at a Lisp_Object variable
1946 whose value should be marked in garbage collection.
1947 Normally every link of the chain is an automatic variable of a function,
1948 and its `val' points to some argument or local variable of the function.
1949 On exit to the function, the chain is set back to the value it had on entry.
1950 This way, no link remains in the chain when the stack frame containing the
1951 link disappears.
1952
1953 Every function that can call Feval must protect in this fashion all
1954 Lisp_Object variables whose contents will be used again. */
1955
1956 extern struct gcpro *gcprolist;
1957
1958 struct gcpro
1959 {
1960 struct gcpro *next;
1961
1962 /* Address of first protected variable. */
1963 volatile Lisp_Object *var;
1964
1965 /* Number of consecutive protected variables. */
1966 int nvars;
1967
1968 #ifdef DEBUG_GCPRO
1969 int level;
1970 #endif
1971 };
1972
1973 /* Values of GC_MARK_STACK during compilation:
1974
1975 0 Use GCPRO as before
1976 1 Do the real thing, make GCPROs and UNGCPRO no-ops.
1977 2 Mark the stack, and check that everything GCPRO'd is
1978 marked.
1979 3 Mark using GCPRO's, mark stack last, and count how many
1980 dead objects are kept alive. */
1981
1982
1983 #define GC_USE_GCPROS_AS_BEFORE 0
1984 #define GC_MAKE_GCPROS_NOOPS 1
1985 #define GC_MARK_STACK_CHECK_GCPROS 2
1986 #define GC_USE_GCPROS_CHECK_ZOMBIES 3
1987
1988 #ifndef GC_MARK_STACK
1989 #define GC_MARK_STACK GC_USE_GCPROS_AS_BEFORE
1990 #endif
1991
1992 #if GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS
1993
1994 /* Do something silly with gcproN vars just so gcc shuts up. */
1995 /* You get warnings from MIPSPro... */
1996
1997 #define GCPRO1(varname) ((void) gcpro1)
1998 #define GCPRO2(varname1, varname2)(((void) gcpro2, (void) gcpro1))
1999 #define GCPRO3(varname1, varname2, varname3) \
2000 (((void) gcpro3, (void) gcpro2, (void) gcpro1))
2001 #define GCPRO4(varname1, varname2, varname3, varname4) \
2002 (((void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2003 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2004 (((void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2005 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2006 (((void) gcpro6, (void) gcpro5, (void) gcpro4, (void) gcpro3, (void) gcpro2, (void) gcpro1))
2007 #define UNGCPRO ((void) 0)
2008
2009 #else /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2010
2011 #ifndef DEBUG_GCPRO
2012
2013 #define GCPRO1(varname) \
2014 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2015 gcprolist = &gcpro1; }
2016
2017 #define GCPRO2(varname1, varname2) \
2018 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2019 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2020 gcprolist = &gcpro2; }
2021
2022 #define GCPRO3(varname1, varname2, varname3) \
2023 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2024 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2025 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2026 gcprolist = &gcpro3; }
2027
2028 #define GCPRO4(varname1, varname2, varname3, varname4) \
2029 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2030 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2031 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2032 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2033 gcprolist = &gcpro4; }
2034
2035 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2036 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2037 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2038 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2039 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2040 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2041 gcprolist = &gcpro5; }
2042
2043 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2044 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2045 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2046 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2047 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2048 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2049 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2050 gcprolist = &gcpro6; }
2051
2052 #define UNGCPRO (gcprolist = gcpro1.next)
2053
2054 #else
2055
2056 extern int gcpro_level;
2057
2058 #define GCPRO1(varname) \
2059 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
2060 gcpro1.level = gcpro_level++; \
2061 gcprolist = &gcpro1; }
2062
2063 #define GCPRO2(varname1, varname2) \
2064 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2065 gcpro1.level = gcpro_level; \
2066 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2067 gcpro2.level = gcpro_level++; \
2068 gcprolist = &gcpro2; }
2069
2070 #define GCPRO3(varname1, varname2, varname3) \
2071 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2072 gcpro1.level = gcpro_level; \
2073 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2074 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2075 gcpro3.level = gcpro_level++; \
2076 gcprolist = &gcpro3; }
2077
2078 #define GCPRO4(varname1, varname2, varname3, varname4) \
2079 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2080 gcpro1.level = gcpro_level; \
2081 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2082 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2083 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2084 gcpro4.level = gcpro_level++; \
2085 gcprolist = &gcpro4; }
2086
2087 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
2088 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2089 gcpro1.level = gcpro_level; \
2090 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2091 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2092 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2093 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2094 gcpro5.level = gcpro_level++; \
2095 gcprolist = &gcpro5; }
2096
2097 #define GCPRO6(varname1, varname2, varname3, varname4, varname5, varname6) \
2098 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
2099 gcpro1.level = gcpro_level; \
2100 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
2101 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
2102 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
2103 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
2104 gcpro6.next = &gcpro5; gcpro6.var = &varname6; gcpro6.nvars = 1; \
2105 gcpro6.level = gcpro_level++; \
2106 gcprolist = &gcpro6; }
2107
2108 #define UNGCPRO \
2109 ((--gcpro_level != gcpro1.level) \
2110 ? (abort (), 0) \
2111 : ((gcprolist = gcpro1.next), 0))
2112
2113 #endif /* DEBUG_GCPRO */
2114 #endif /* GC_MARK_STACK != GC_MAKE_GCPROS_NOOPS */
2115
2116
2117 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2118 #define RETURN_UNGCPRO(expr) \
2119 do \
2120 { \
2121 Lisp_Object ret_ungc_val; \
2122 ret_ungc_val = (expr); \
2123 UNGCPRO; \
2124 return ret_ungc_val; \
2125 } \
2126 while (0)
2127
2128 /* Call staticpro (&var) to protect static variable `var'. */
2129
2130 void staticpro P_ ((Lisp_Object *));
2131 \f
2132 /* Declare a Lisp-callable function. The MAXARGS parameter has the same
2133 meaning as in the DEFUN macro, and is used to construct a prototype. */
2134 #if (!defined (__STDC__) && !defined (PROTOTYPES))
2135 #define EXFUN(fnname, maxargs) \
2136 extern Lisp_Object fnname ()
2137 #else
2138 /* We can use the same trick as in the DEFUN macro to generate the
2139 appropriate prototype. */
2140 #define EXFUN(fnname, maxargs) \
2141 extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs
2142 #endif
2143
2144 /* Forward declarations for prototypes. */
2145 struct window;
2146 struct frame;
2147
2148 /* Defined in data.c */
2149 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
2150 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
2151 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
2152 extern Lisp_Object Qvoid_variable, Qvoid_function;
2153 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
2154 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
2155 extern Lisp_Object Qend_of_file, Qarith_error, Qmark_inactive;
2156 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
2157 extern Lisp_Object Qtext_read_only;
2158
2159 extern Lisp_Object Qintegerp, Qnatnump, Qwholenump, Qsymbolp, Qlistp, Qconsp;
2160 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
2161 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qinteger_or_marker_p, Qvectorp;
2162 extern Lisp_Object Qbuffer_or_string_p;
2163 extern Lisp_Object Qboundp, Qfboundp;
2164 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
2165
2166 extern Lisp_Object Qcdr;
2167
2168 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
2169 extern Lisp_Object Qoverflow_error, Qunderflow_error;
2170
2171 extern Lisp_Object Qfloatp;
2172 extern Lisp_Object Qnumberp, Qnumber_or_marker_p;
2173
2174 extern Lisp_Object Qinteger;
2175
2176 extern Lisp_Object Qfont_spec, Qfont_entity, Qfont_object;
2177
2178 extern void circular_list_error P_ ((Lisp_Object)) NO_RETURN;
2179 EXFUN (Finteractive_form, 1);
2180
2181 /* Defined in frame.c */
2182 extern Lisp_Object Qframep;
2183
2184 EXFUN (Feq, 2);
2185 EXFUN (Fnull, 1);
2186 EXFUN (Flistp, 1);
2187 EXFUN (Fconsp, 1);
2188 EXFUN (Fatom, 1);
2189 EXFUN (Fnlistp, 1);
2190 EXFUN (Fintegerp, 1);
2191 EXFUN (Fnatnump, 1);
2192 EXFUN (Fsymbolp, 1);
2193 EXFUN (Fvectorp, 1);
2194 EXFUN (Fstringp, 1);
2195 EXFUN (Fmultibyte_string_p, 1);
2196 EXFUN (Farrayp, 1);
2197 EXFUN (Fsequencep, 1);
2198 EXFUN (Fbufferp, 1);
2199 EXFUN (Fmarkerp, 1);
2200 EXFUN (Fsubrp, 1);
2201 EXFUN (Fchar_or_string_p, 1);
2202 EXFUN (Finteger_or_marker_p, 1);
2203 EXFUN (Ffloatp, 1);
2204 EXFUN (Finteger_or_floatp, 1);
2205 EXFUN (Finteger_or_float_or_marker_p, 1);
2206
2207 EXFUN (Fcar, 1);
2208 EXFUN (Fcar_safe, 1);
2209 EXFUN (Fcdr, 1);
2210 EXFUN (Fcdr_safe, 1);
2211 EXFUN (Fsetcar, 2);
2212 EXFUN (Fsetcdr, 2);
2213 EXFUN (Fboundp, 1);
2214 EXFUN (Ffboundp, 1);
2215 EXFUN (Fmakunbound, 1);
2216 EXFUN (Ffmakunbound, 1);
2217 EXFUN (Fsymbol_function, 1);
2218 EXFUN (Fsymbol_plist, 1);
2219 EXFUN (Fsymbol_name, 1);
2220 extern Lisp_Object indirect_function P_ ((Lisp_Object));
2221 EXFUN (Findirect_function, 2);
2222 EXFUN (Ffset, 2);
2223 EXFUN (Fsetplist, 2);
2224 EXFUN (Fsymbol_value, 1);
2225 extern Lisp_Object find_symbol_value P_ ((Lisp_Object));
2226 EXFUN (Fset, 2);
2227 EXFUN (Fdefault_value, 1);
2228 EXFUN (Fset_default, 2);
2229 EXFUN (Fdefault_boundp, 1);
2230 EXFUN (Fmake_local_variable, 1);
2231 EXFUN (Flocal_variable_p, 2);
2232 EXFUN (Flocal_variable_if_set_p, 2);
2233
2234 EXFUN (Faref, 2);
2235 EXFUN (Faset, 3);
2236
2237 EXFUN (Fstring_to_number, 2);
2238 EXFUN (Fnumber_to_string, 1);
2239 EXFUN (Feqlsign, 2);
2240 EXFUN (Fgtr, 2);
2241 EXFUN (Flss, 2);
2242 EXFUN (Fgeq, 2);
2243 EXFUN (Fleq, 2);
2244 EXFUN (Fneq, 2);
2245 EXFUN (Fzerop, 1);
2246 EXFUN (Fplus, MANY);
2247 EXFUN (Fminus, MANY);
2248 EXFUN (Ftimes, MANY);
2249 EXFUN (Fquo, MANY);
2250 EXFUN (Frem, 2);
2251 EXFUN (Fmax, MANY);
2252 EXFUN (Fmin, MANY);
2253 EXFUN (Flogand, MANY);
2254 EXFUN (Flogior, MANY);
2255 EXFUN (Flogxor, MANY);
2256 EXFUN (Flognot, 1);
2257 EXFUN (Flsh, 2);
2258 EXFUN (Fash, 2);
2259
2260 EXFUN (Fadd1, 1);
2261 EXFUN (Fsub1, 1);
2262 EXFUN (Fmake_variable_buffer_local, 1);
2263
2264 extern struct Lisp_Symbol *indirect_variable (struct Lisp_Symbol *);
2265 extern Lisp_Object long_to_cons P_ ((unsigned long));
2266 extern unsigned long cons_to_long P_ ((Lisp_Object));
2267 extern void args_out_of_range P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2268 extern void args_out_of_range_3 P_ ((Lisp_Object, Lisp_Object,
2269 Lisp_Object)) NO_RETURN;
2270 extern Lisp_Object wrong_type_argument P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2271 extern void store_symval_forwarding P_ ((Lisp_Object, Lisp_Object,
2272 Lisp_Object, struct buffer *));
2273 extern Lisp_Object do_symval_forwarding P_ ((Lisp_Object));
2274 extern Lisp_Object set_internal P_ ((Lisp_Object, Lisp_Object, struct buffer *, int));
2275 extern void syms_of_data P_ ((void));
2276 extern void init_data P_ ((void));
2277 extern void swap_in_global_binding P_ ((Lisp_Object));
2278
2279 /* Defined in cmds.c */
2280 EXFUN (Fend_of_line, 1);
2281 EXFUN (Fforward_char, 1);
2282 EXFUN (Fforward_line, 1);
2283 extern int internal_self_insert P_ ((int, int));
2284 extern void syms_of_cmds P_ ((void));
2285 extern void keys_of_cmds P_ ((void));
2286
2287 /* Defined in coding.c */
2288 EXFUN (Fcoding_system_p, 1);
2289 EXFUN (Fcoding_system_base, 1);
2290 EXFUN (Fcoding_system_eol_type, 1);
2291 EXFUN (Fcheck_coding_system, 1);
2292 EXFUN (Fcheck_coding_system, 1);
2293 EXFUN (Fread_coding_system, 2);
2294 EXFUN (Fread_non_nil_coding_system, 1);
2295 EXFUN (Ffind_operation_coding_system, MANY);
2296 EXFUN (Fupdate_coding_systems_internal, 0);
2297 EXFUN (Fencode_coding_string, 4);
2298 EXFUN (Fdecode_coding_string, 4);
2299 extern Lisp_Object detect_coding_system P_ ((const unsigned char *, EMACS_INT,
2300 EMACS_INT, int, int, Lisp_Object));
2301 extern void init_coding P_ ((void));
2302 extern void init_coding_once P_ ((void));
2303 extern void syms_of_coding P_ ((void));
2304
2305 /* Defined in character.c */
2306 extern void init_character_once P_ ((void));
2307 extern void syms_of_character P_ ((void));
2308 EXFUN (Funibyte_char_to_multibyte, 1);
2309
2310 /* Defined in charset.c */
2311 EXFUN (Fchar_bytes, 1);
2312 EXFUN (Fchar_width, 1);
2313 EXFUN (Fstring, MANY);
2314 extern EMACS_INT chars_in_text P_ ((const unsigned char *, EMACS_INT));
2315 extern EMACS_INT multibyte_chars_in_text P_ ((const unsigned char *, EMACS_INT));
2316 extern int multibyte_char_to_unibyte P_ ((int, Lisp_Object));
2317 extern int multibyte_char_to_unibyte_safe P_ ((int));
2318 extern Lisp_Object Qcharset;
2319 extern void init_charset P_ ((void));
2320 extern void init_charset_once P_ ((void));
2321 extern void syms_of_charset P_ ((void));
2322 /* Structure forward declarations. */
2323 struct charset;
2324
2325 /* Defined in composite.c */
2326 extern void syms_of_composite P_ ((void));
2327
2328 /* Defined in syntax.c */
2329 EXFUN (Fforward_word, 1);
2330 EXFUN (Fskip_chars_forward, 2);
2331 EXFUN (Fskip_chars_backward, 2);
2332 EXFUN (Fsyntax_table_p, 1);
2333 EXFUN (Fsyntax_table, 0);
2334 EXFUN (Fset_syntax_table, 1);
2335 extern void init_syntax_once P_ ((void));
2336 extern void syms_of_syntax P_ ((void));
2337
2338 /* Defined in fns.c */
2339 extern int use_dialog_box;
2340 extern int next_almost_prime P_ ((int));
2341 extern Lisp_Object larger_vector P_ ((Lisp_Object, int, Lisp_Object));
2342 extern void sweep_weak_hash_tables P_ ((void));
2343 extern Lisp_Object Qstring_lessp;
2344 extern Lisp_Object Vfeatures;
2345 extern Lisp_Object QCtest, QCweakness, Qequal, Qeq;
2346 unsigned sxhash P_ ((Lisp_Object, int));
2347 Lisp_Object make_hash_table P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2348 Lisp_Object, Lisp_Object, Lisp_Object,
2349 Lisp_Object));
2350 Lisp_Object copy_hash_table P_ ((struct Lisp_Hash_Table *));
2351 int hash_lookup P_ ((struct Lisp_Hash_Table *, Lisp_Object, unsigned *));
2352 int hash_put P_ ((struct Lisp_Hash_Table *, Lisp_Object, Lisp_Object,
2353 unsigned));
2354 void hash_clear P_ ((struct Lisp_Hash_Table *));
2355 void init_weak_hash_tables P_ ((void));
2356 extern void init_fns P_ ((void));
2357 EXFUN (Fsxhash, 1);
2358 EXFUN (Fmake_hash_table, MANY);
2359 EXFUN (Fmakehash, 1);
2360 EXFUN (Fcopy_hash_table, 1);
2361 EXFUN (Fhash_table_count, 1);
2362 EXFUN (Fhash_table_rehash_size, 1);
2363 EXFUN (Fhash_table_rehash_threshold, 1);
2364 EXFUN (Fhash_table_size, 1);
2365 EXFUN (Fhash_table_test, 1);
2366 EXFUN (Fhash_table_weak, 1);
2367 EXFUN (Fhash_table_p, 1);
2368 EXFUN (Fclrhash, 1);
2369 EXFUN (Fgethash, 3);
2370 EXFUN (Fputhash, 3);
2371 EXFUN (Fremhash, 2);
2372 EXFUN (Fmaphash, 2);
2373 EXFUN (Fdefine_hash_table_test, 3);
2374
2375 EXFUN (Fidentity, 1);
2376 EXFUN (Frandom, 1);
2377 EXFUN (Flength, 1);
2378 EXFUN (Fsafe_length, 1);
2379 EXFUN (Fappend, MANY);
2380 EXFUN (Fconcat, MANY);
2381 EXFUN (Fvconcat, MANY);
2382 EXFUN (Fcopy_sequence, 1);
2383 EXFUN (Fstring_make_multibyte, 1);
2384 EXFUN (Fstring_make_unibyte, 1);
2385 EXFUN (Fstring_as_multibyte, 1);
2386 EXFUN (Fstring_as_unibyte, 1);
2387 EXFUN (Fstring_to_multibyte, 1);
2388 EXFUN (Fstring_to_unibyte, 1);
2389 EXFUN (Fsubstring, 3);
2390 extern Lisp_Object substring_both P_ ((Lisp_Object, int, int, int, int));
2391 EXFUN (Fnth, 2);
2392 EXFUN (Fnthcdr, 2);
2393 EXFUN (Fmemq, 2);
2394 EXFUN (Fassq, 2);
2395 EXFUN (Fassoc, 2);
2396 EXFUN (Felt, 2);
2397 EXFUN (Fmember, 2);
2398 EXFUN (Frassq, 2);
2399 EXFUN (Fdelq, 2);
2400 EXFUN (Fdelete, 2);
2401 EXFUN (Fsort, 2);
2402 EXFUN (Freverse, 1);
2403 EXFUN (Fnreverse, 1);
2404 EXFUN (Fget, 2);
2405 EXFUN (Fput, 3);
2406 EXFUN (Fequal, 2);
2407 EXFUN (Ffillarray, 2);
2408 EXFUN (Fnconc, MANY);
2409 EXFUN (Fmapcar, 2);
2410 EXFUN (Fmapconcat, 3);
2411 EXFUN (Fy_or_n_p, 1);
2412 extern Lisp_Object do_yes_or_no_p P_ ((Lisp_Object));
2413 EXFUN (Frequire, 3);
2414 EXFUN (Fprovide, 2);
2415 extern Lisp_Object concat2 P_ ((Lisp_Object, Lisp_Object));
2416 extern Lisp_Object concat3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2417 extern Lisp_Object nconc2 P_ ((Lisp_Object, Lisp_Object));
2418 extern Lisp_Object assq_no_quit P_ ((Lisp_Object, Lisp_Object));
2419 extern Lisp_Object assoc_no_quit P_ ((Lisp_Object, Lisp_Object));
2420 extern void clear_string_char_byte_cache P_ ((void));
2421 extern EMACS_INT string_char_to_byte P_ ((Lisp_Object, EMACS_INT));
2422 extern EMACS_INT string_byte_to_char P_ ((Lisp_Object, EMACS_INT));
2423 extern Lisp_Object string_make_multibyte P_ ((Lisp_Object));
2424 extern Lisp_Object string_to_multibyte P_ ((Lisp_Object));
2425 extern Lisp_Object string_make_unibyte P_ ((Lisp_Object));
2426 EXFUN (Fcopy_alist, 1);
2427 EXFUN (Fplist_get, 2);
2428 EXFUN (Fplist_put, 3);
2429 EXFUN (Fplist_member, 2);
2430 EXFUN (Frassoc, 2);
2431 EXFUN (Fstring_equal, 2);
2432 EXFUN (Fcompare_strings, 7);
2433 EXFUN (Fstring_lessp, 2);
2434 extern void syms_of_fns P_ ((void));
2435
2436 /* Defined in floatfns.c */
2437 extern double extract_float P_ ((Lisp_Object));
2438 EXFUN (Ffloat, 1);
2439 EXFUN (Ftruncate, 2);
2440 extern void init_floatfns P_ ((void));
2441 extern void syms_of_floatfns P_ ((void));
2442
2443 /* Defined in fringe.c */
2444 extern void syms_of_fringe P_ ((void));
2445 extern void init_fringe P_ ((void));
2446 extern void init_fringe_once P_ ((void));
2447
2448 /* Defined in image.c */
2449 EXFUN (Finit_image_library, 2);
2450 extern void syms_of_image P_ ((void));
2451 extern void init_image P_ ((void));
2452
2453 /* Defined in insdel.c */
2454 extern Lisp_Object Qinhibit_modification_hooks;
2455 extern void move_gap (EMACS_INT);
2456 extern void move_gap_both (EMACS_INT, EMACS_INT);
2457 extern void make_gap (EMACS_INT);
2458 extern EMACS_INT copy_text (const unsigned char *, unsigned char *,
2459 EMACS_INT, int, int);
2460 extern EMACS_INT count_size_as_multibyte (const unsigned char *, EMACS_INT);
2461 extern int count_combining_before (const unsigned char *,
2462 EMACS_INT, EMACS_INT, EMACS_INT);
2463 extern int count_combining_after (const unsigned char *,
2464 EMACS_INT, EMACS_INT, EMACS_INT);
2465 extern void insert (const unsigned char *, EMACS_INT);
2466 extern void insert_and_inherit (const unsigned char *, EMACS_INT);
2467 extern void insert_1 (const unsigned char *, EMACS_INT, int, int, int);
2468 extern void insert_1_both (const unsigned char *, EMACS_INT, EMACS_INT,
2469 int, int, int);
2470 extern void insert_from_gap (EMACS_INT, EMACS_INT);
2471 extern void insert_from_string (Lisp_Object, EMACS_INT, EMACS_INT,
2472 EMACS_INT, EMACS_INT, int);
2473 extern void insert_from_buffer (struct buffer *, EMACS_INT, EMACS_INT, int);
2474 extern void insert_char (int);
2475 extern void insert_string (const char *);
2476 extern void insert_before_markers (const unsigned char *, EMACS_INT);
2477 extern void insert_before_markers_and_inherit (const unsigned char *,
2478 EMACS_INT);
2479 extern void insert_from_string_before_markers (Lisp_Object, EMACS_INT,
2480 EMACS_INT, EMACS_INT,
2481 EMACS_INT, int);
2482 extern void del_range (EMACS_INT, EMACS_INT);
2483 extern Lisp_Object del_range_1 (EMACS_INT, EMACS_INT, int, int);
2484 extern void del_range_byte (EMACS_INT, EMACS_INT, int);
2485 extern void del_range_both (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT, int);
2486 extern Lisp_Object del_range_2 (EMACS_INT, EMACS_INT,
2487 EMACS_INT, EMACS_INT, int);
2488 extern void modify_region (struct buffer *, EMACS_INT, EMACS_INT, int);
2489 extern void prepare_to_modify_buffer (EMACS_INT, EMACS_INT, EMACS_INT *);
2490 extern void signal_before_change (EMACS_INT, EMACS_INT, EMACS_INT *);
2491 extern void signal_after_change (EMACS_INT, EMACS_INT, EMACS_INT);
2492 extern void adjust_after_replace (EMACS_INT, EMACS_INT, Lisp_Object,
2493 EMACS_INT, EMACS_INT);
2494 extern void adjust_after_replace_noundo (EMACS_INT, EMACS_INT, EMACS_INT,
2495 EMACS_INT, EMACS_INT, EMACS_INT);
2496 extern void adjust_after_insert (EMACS_INT, EMACS_INT, EMACS_INT,
2497 EMACS_INT, EMACS_INT);
2498 extern void adjust_markers_for_delete (EMACS_INT, EMACS_INT,
2499 EMACS_INT, EMACS_INT);
2500 extern void replace_range (EMACS_INT, EMACS_INT, Lisp_Object, int, int, int);
2501 extern void replace_range_2 (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
2502 char *, EMACS_INT, EMACS_INT, int);
2503 extern void syms_of_insdel (void);
2504
2505 /* Defined in dispnew.c */
2506 extern Lisp_Object selected_frame;
2507 extern EMACS_INT baud_rate;
2508 EXFUN (Fding, 1);
2509 EXFUN (Fredraw_frame, 1);
2510 EXFUN (Fredraw_display, 0);
2511 EXFUN (Fsleep_for, 2);
2512 EXFUN (Fredisplay, 1);
2513 extern Lisp_Object sit_for P_ ((Lisp_Object, int, int));
2514 extern void init_display P_ ((void));
2515 extern void syms_of_display P_ ((void));
2516 extern void safe_bcopy P_ ((const char *, char *, int));
2517
2518 /* Defined in xdisp.c */
2519 extern Lisp_Object Qinhibit_point_motion_hooks;
2520 extern Lisp_Object Qinhibit_redisplay, Qdisplay;
2521 extern Lisp_Object Qinhibit_eval_during_redisplay;
2522 extern Lisp_Object Qmessage_truncate_lines;
2523 extern Lisp_Object Qimage;
2524 extern Lisp_Object Vmessage_log_max;
2525 extern int message_enable_multibyte;
2526 extern Lisp_Object echo_area_buffer[2];
2527 extern void check_message_stack P_ ((void));
2528 extern void setup_echo_area_for_printing P_ ((int));
2529 extern int push_message P_ ((void));
2530 extern Lisp_Object pop_message_unwind P_ ((Lisp_Object));
2531 extern Lisp_Object restore_message_unwind P_ ((Lisp_Object));
2532 extern void pop_message P_ ((void));
2533 extern void restore_message P_ ((void));
2534 extern Lisp_Object current_message P_ ((void));
2535 extern void set_message P_ ((const char *s, Lisp_Object, int, int));
2536 extern void clear_message P_ ((int, int));
2537 extern void message P_ ((/* char *, ... */));
2538 extern void message_nolog P_ ((/* char *, ... */));
2539 extern void message1 P_ ((char *));
2540 extern void message1_nolog P_ ((char *));
2541 extern void message2 P_ ((const char *, int, int));
2542 extern void message2_nolog P_ ((const char *, int, int));
2543 extern void message3 P_ ((Lisp_Object, int, int));
2544 extern void message3_nolog P_ ((Lisp_Object, int, int));
2545 extern void message_dolog P_ ((const char *, int, int, int));
2546 extern void message_with_string P_ ((char *, Lisp_Object, int));
2547 extern void message_log_maybe_newline P_ ((void));
2548 extern void update_echo_area P_ ((void));
2549 extern void truncate_echo_area P_ ((int));
2550 extern void redisplay P_ ((void));
2551 extern int check_point_in_composition
2552 P_ ((struct buffer *, int, struct buffer *, int));
2553 extern void redisplay_preserve_echo_area P_ ((int));
2554 extern void prepare_menu_bars P_ ((void));
2555
2556 void set_frame_cursor_types P_ ((struct frame *, Lisp_Object));
2557 extern void syms_of_xdisp P_ ((void));
2558 extern void init_xdisp P_ ((void));
2559 extern Lisp_Object safe_eval P_ ((Lisp_Object));
2560 extern int pos_visible_p P_ ((struct window *, int, int *,
2561 int *, int *, int *, int *, int *));
2562
2563 /* Defined in vm-limit.c. */
2564 extern void memory_warnings P_ ((POINTER_TYPE *, void (*warnfun) ()));
2565
2566 /* Defined in alloc.c */
2567 extern void check_pure_size P_ ((void));
2568 extern void allocate_string_data P_ ((struct Lisp_String *, int, int));
2569 extern void reset_malloc_hooks P_ ((void));
2570 extern void uninterrupt_malloc P_ ((void));
2571 extern void malloc_warning P_ ((char *));
2572 extern void memory_full P_ ((void)) NO_RETURN;
2573 extern void buffer_memory_full P_ ((void)) NO_RETURN;
2574 extern int survives_gc_p P_ ((Lisp_Object));
2575 extern void mark_object P_ ((Lisp_Object));
2576 extern Lisp_Object Vpurify_flag;
2577 extern Lisp_Object Vmemory_full;
2578 EXFUN (Fcons, 2);
2579 EXFUN (list1, 1);
2580 EXFUN (list2, 2);
2581 EXFUN (list3, 3);
2582 EXFUN (list4, 4);
2583 EXFUN (list5, 5);
2584 EXFUN (Flist, MANY);
2585 EXFUN (Fmake_list, 2);
2586 extern Lisp_Object allocate_misc P_ ((void));
2587 EXFUN (Fmake_vector, 2);
2588 EXFUN (Fvector, MANY);
2589 EXFUN (Fmake_symbol, 1);
2590 EXFUN (Fmake_marker, 0);
2591 EXFUN (Fmake_string, 2);
2592 extern Lisp_Object build_string P_ ((const char *));
2593 extern Lisp_Object make_string P_ ((const char *, int));
2594 extern Lisp_Object make_unibyte_string P_ ((const char *, int));
2595 extern Lisp_Object make_multibyte_string P_ ((const char *, int, int));
2596 extern Lisp_Object make_event_array P_ ((int, Lisp_Object *));
2597 extern Lisp_Object make_uninit_string P_ ((int));
2598 extern Lisp_Object make_uninit_multibyte_string P_ ((int, int));
2599 extern Lisp_Object make_string_from_bytes P_ ((const char *, int, int));
2600 extern Lisp_Object make_specified_string P_ ((const char *, int, int, int));
2601 EXFUN (Fpurecopy, 1);
2602 extern Lisp_Object make_pure_string P_ ((char *, int, int, int));
2603 extern Lisp_Object pure_cons P_ ((Lisp_Object, Lisp_Object));
2604 extern Lisp_Object make_pure_vector P_ ((EMACS_INT));
2605 EXFUN (Fgarbage_collect, 0);
2606 EXFUN (Fmake_byte_code, MANY);
2607 EXFUN (Fmake_bool_vector, 2);
2608 extern Lisp_Object Qchar_table_extra_slots;
2609 extern struct Lisp_Vector *allocate_vector P_ ((EMACS_INT));
2610 extern struct Lisp_Vector *allocate_pseudovector P_ ((int memlen, int lisplen, EMACS_INT tag));
2611 #define ALLOCATE_PSEUDOVECTOR(typ,field,tag) \
2612 ((typ*) \
2613 allocate_pseudovector \
2614 (VECSIZE (typ), PSEUDOVECSIZE (typ, field), tag))
2615 extern struct Lisp_Hash_Table *allocate_hash_table P_ ((void));
2616 extern struct window *allocate_window P_ ((void));
2617 extern struct frame *allocate_frame P_ ((void));
2618 extern struct Lisp_Process *allocate_process P_ ((void));
2619 extern struct terminal *allocate_terminal P_ ((void));
2620 extern int gc_in_progress;
2621 extern int abort_on_gc;
2622 extern Lisp_Object make_float P_ ((double));
2623 extern void display_malloc_warning P_ ((void));
2624 extern int inhibit_garbage_collection P_ ((void));
2625 extern Lisp_Object make_save_value P_ ((void *, int));
2626 extern void free_misc P_ ((Lisp_Object));
2627 extern void free_marker P_ ((Lisp_Object));
2628 extern void free_cons P_ ((struct Lisp_Cons *));
2629 extern void init_alloc_once P_ ((void));
2630 extern void init_alloc P_ ((void));
2631 extern void syms_of_alloc P_ ((void));
2632 extern struct buffer * allocate_buffer P_ ((void));
2633 extern int valid_lisp_object_p P_ ((Lisp_Object));
2634
2635 /* Defined in chartab.c */
2636 EXFUN (Fmake_char_table, 2);
2637 EXFUN (Fchar_table_parent, 1);
2638 EXFUN (Fset_char_table_parent, 2);
2639 EXFUN (Fchar_table_extra_slot, 2);
2640 EXFUN (Fset_char_table_extra_slot, 3);
2641 EXFUN (Fchar_table_range, 2);
2642 EXFUN (Fset_char_table_range, 3);
2643 EXFUN (Fset_char_table_default, 3);
2644 EXFUN (Foptimize_char_table, 2);
2645 EXFUN (Fmap_char_table, 2);
2646 extern Lisp_Object copy_char_table P_ ((Lisp_Object));
2647 extern Lisp_Object sub_char_table_ref P_ ((Lisp_Object, int));
2648 extern Lisp_Object char_table_ref P_ ((Lisp_Object, int));
2649 extern Lisp_Object char_table_ref_and_range P_ ((Lisp_Object, int,
2650 int *, int *));
2651 extern Lisp_Object char_table_set P_ ((Lisp_Object, int, Lisp_Object));
2652 extern Lisp_Object char_table_set_range P_ ((Lisp_Object, int, int,
2653 Lisp_Object));
2654 extern int char_table_translate P_ ((Lisp_Object, int));
2655 extern void map_char_table P_ ((void (*) (Lisp_Object, Lisp_Object,
2656 Lisp_Object),
2657 Lisp_Object, Lisp_Object, Lisp_Object));
2658 extern void syms_of_chartab P_ ((void));
2659
2660 /* Defined in print.c */
2661 extern Lisp_Object Vprin1_to_string_buffer;
2662 extern void debug_print P_ ((Lisp_Object));
2663 EXFUN (Fprin1, 2);
2664 EXFUN (Fprin1_to_string, 2);
2665 EXFUN (Fprinc, 2);
2666 EXFUN (Fterpri, 1);
2667 EXFUN (Fprint, 2);
2668 EXFUN (Ferror_message_string, 1);
2669 extern Lisp_Object Vstandard_output, Qstandard_output;
2670 extern Lisp_Object Qexternal_debugging_output;
2671 extern void temp_output_buffer_setup P_ ((const char *));
2672 extern int print_level, print_escape_newlines;
2673 extern Lisp_Object Qprint_escape_newlines;
2674 extern void write_string P_ ((char *, int));
2675 extern void write_string_1 P_ ((char *, int, Lisp_Object));
2676 extern void print_error_message P_ ((Lisp_Object, Lisp_Object, char *, Lisp_Object));
2677 extern Lisp_Object internal_with_output_to_temp_buffer
2678 P_ ((const char *, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2679 extern void float_to_string P_ ((unsigned char *, double));
2680 extern void syms_of_print P_ ((void));
2681
2682 /* Defined in doprnt.c */
2683 extern int doprnt P_ ((char *, int, char *, char *, int, char **));
2684 extern int doprnt_lisp P_ ((char *, int, char *, char *, int, char **));
2685
2686 /* Defined in lread.c */
2687 extern Lisp_Object Qvariable_documentation, Qstandard_input;
2688 extern Lisp_Object Vobarray, initial_obarray, Vstandard_input;
2689 EXFUN (Fread, 1);
2690 EXFUN (Fread_from_string, 3);
2691 EXFUN (Fintern, 2);
2692 EXFUN (Fintern_soft, 2);
2693 EXFUN (Fload, 5);
2694 EXFUN (Fget_load_suffixes, 0);
2695 EXFUN (Fget_file_char, 0);
2696 EXFUN (Fread_char, 3);
2697 EXFUN (Fread_event, 3);
2698 extern Lisp_Object read_filtered_event P_ ((int, int, int, int, Lisp_Object));
2699 EXFUN (Feval_region, 4);
2700 extern Lisp_Object check_obarray P_ ((Lisp_Object));
2701 extern Lisp_Object intern P_ ((const char *));
2702 extern Lisp_Object make_symbol P_ ((char *));
2703 extern Lisp_Object oblookup P_ ((Lisp_Object, const char *, int, int));
2704 #define LOADHIST_ATTACH(x) \
2705 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
2706 extern Lisp_Object Vcurrent_load_list;
2707 extern Lisp_Object Vload_history, Vload_suffixes, Vload_file_rep_suffixes;
2708 extern int openp P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
2709 Lisp_Object *, Lisp_Object));
2710 extern int isfloat_string P_ ((char *));
2711 extern void map_obarray P_ ((Lisp_Object, void (*) (Lisp_Object, Lisp_Object),
2712 Lisp_Object));
2713 extern void dir_warning P_ ((char *, Lisp_Object));
2714 extern void close_load_descs P_ ((void));
2715 extern void init_obarray P_ ((void));
2716 extern void init_lread P_ ((void));
2717 extern void syms_of_lread P_ ((void));
2718
2719 /* Defined in eval.c */
2720 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
2721 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
2722 extern Lisp_Object Vautoload_queue;
2723 extern Lisp_Object Vdebug_on_error;
2724 extern Lisp_Object Vsignaling_function;
2725 extern int handling_signal;
2726 extern int interactive_p P_ ((int));
2727
2728 /* To run a normal hook, use the appropriate function from the list below.
2729 The calling convention:
2730
2731 if (!NILP (Vrun_hooks))
2732 call1 (Vrun_hooks, Qmy_funny_hook);
2733
2734 should no longer be used. */
2735 extern Lisp_Object Vrun_hooks;
2736 EXFUN (Frun_hooks, MANY);
2737 EXFUN (Frun_hook_with_args, MANY);
2738 EXFUN (Frun_hook_with_args_until_success, MANY);
2739 EXFUN (Frun_hook_with_args_until_failure, MANY);
2740 extern Lisp_Object run_hook_list_with_args P_ ((Lisp_Object, int, Lisp_Object *));
2741 extern void run_hook_with_args_2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2742 EXFUN (Fand, UNEVALLED);
2743 EXFUN (For, UNEVALLED);
2744 EXFUN (Fif, UNEVALLED);
2745 EXFUN (Fprogn, UNEVALLED);
2746 EXFUN (Fprog1, UNEVALLED);
2747 EXFUN (Fprog2, UNEVALLED);
2748 EXFUN (Fsetq, UNEVALLED);
2749 EXFUN (Fquote, UNEVALLED);
2750 EXFUN (Fuser_variable_p, 1);
2751 EXFUN (Finteractive_p, 0);
2752 EXFUN (Fdefun, UNEVALLED);
2753 EXFUN (Flet, UNEVALLED);
2754 EXFUN (FletX, UNEVALLED);
2755 EXFUN (Fwhile, UNEVALLED);
2756 EXFUN (Fcatch, UNEVALLED);
2757 EXFUN (Fthrow, 2) NO_RETURN;
2758 EXFUN (Funwind_protect, UNEVALLED);
2759 EXFUN (Fcondition_case, UNEVALLED);
2760 EXFUN (Fsignal, 2);
2761 extern void xsignal P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2762 extern void xsignal0 P_ ((Lisp_Object)) NO_RETURN;
2763 extern void xsignal1 P_ ((Lisp_Object, Lisp_Object)) NO_RETURN;
2764 extern void xsignal2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2765 extern void xsignal3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)) NO_RETURN;
2766 extern void signal_error P_ ((char *, Lisp_Object)) NO_RETURN;
2767 EXFUN (Fautoload, 5);
2768 EXFUN (Fcommandp, 2);
2769 EXFUN (Feval, 1);
2770 EXFUN (Fapply, MANY);
2771 EXFUN (Ffuncall, MANY);
2772 EXFUN (Fbacktrace, 0);
2773 extern Lisp_Object apply1 P_ ((Lisp_Object, Lisp_Object));
2774 extern Lisp_Object call0 P_ ((Lisp_Object));
2775 extern Lisp_Object call1 P_ ((Lisp_Object, Lisp_Object));
2776 extern Lisp_Object call2 P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2777 extern Lisp_Object call3 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2778 extern Lisp_Object call4 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2779 extern Lisp_Object call5 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2780 extern Lisp_Object call6 P_ ((Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object));
2781 EXFUN (Fdo_auto_save, 2);
2782 extern Lisp_Object apply_lambda P_ ((Lisp_Object, Lisp_Object, int));
2783 extern Lisp_Object internal_catch P_ ((Lisp_Object, Lisp_Object (*) (Lisp_Object), Lisp_Object));
2784 extern Lisp_Object internal_lisp_condition_case P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2785 extern Lisp_Object internal_condition_case P_ ((Lisp_Object (*) (void), Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2786 extern Lisp_Object internal_condition_case_1 P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2787 extern Lisp_Object internal_condition_case_2 P_ ((Lisp_Object (*) (int, Lisp_Object *), int, Lisp_Object *, Lisp_Object, Lisp_Object (*) (Lisp_Object)));
2788 extern void specbind P_ ((Lisp_Object, Lisp_Object));
2789 extern void record_unwind_protect P_ ((Lisp_Object (*) (Lisp_Object), Lisp_Object));
2790 extern Lisp_Object unbind_to P_ ((int, Lisp_Object));
2791 extern void error P_ ((/* char *, ... */)) NO_RETURN;
2792 extern void do_autoload P_ ((Lisp_Object, Lisp_Object));
2793 extern Lisp_Object un_autoload P_ ((Lisp_Object));
2794 EXFUN (Ffetch_bytecode, 1);
2795 extern void init_eval_once P_ ((void));
2796 extern Lisp_Object safe_call P_ ((int, Lisp_Object *));
2797 extern Lisp_Object safe_call1 P_ ((Lisp_Object, Lisp_Object));
2798 extern Lisp_Object safe_call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2799 extern void init_eval P_ ((void));
2800 extern void syms_of_eval P_ ((void));
2801
2802 /* Defined in editfns.c */
2803 EXFUN (Fpropertize, MANY);
2804 EXFUN (Fcurrent_message, 0);
2805 EXFUN (Fgoto_char, 1);
2806 EXFUN (Fpoint_min_marker, 0);
2807 EXFUN (Fpoint_max_marker, 0);
2808 EXFUN (Fpoint_min, 0);
2809 EXFUN (Fpoint_max, 0);
2810 EXFUN (Fpoint, 0);
2811 EXFUN (Fpoint_marker, 0);
2812 EXFUN (Fmark_marker, 0);
2813 EXFUN (Fline_beginning_position, 1);
2814 EXFUN (Fline_end_position, 1);
2815 EXFUN (Ffollowing_char, 0);
2816 EXFUN (Fprevious_char, 0);
2817 EXFUN (Fchar_after, 1);
2818 EXFUN (Finsert, MANY);
2819 EXFUN (Finsert_and_inherit, MANY);
2820 EXFUN (Finsert_before_markers, MANY);
2821 EXFUN (Finsert_buffer_substring, 3);
2822 EXFUN (Finsert_char, 3);
2823 extern void insert1 P_ ((Lisp_Object));
2824 EXFUN (Feolp, 0);
2825 EXFUN (Feobp, 0);
2826 EXFUN (Fbolp, 0);
2827 EXFUN (Fbobp, 0);
2828 EXFUN (Fformat, MANY);
2829 EXFUN (Fmessage, MANY);
2830 extern Lisp_Object format2 P_ ((char *, Lisp_Object, Lisp_Object));
2831 EXFUN (Fbuffer_substring, 2);
2832 EXFUN (Fbuffer_string, 0);
2833 extern Lisp_Object save_excursion_save P_ ((void));
2834 extern Lisp_Object save_restriction_save P_ ((void));
2835 extern Lisp_Object save_excursion_restore P_ ((Lisp_Object));
2836 extern Lisp_Object save_restriction_restore P_ ((Lisp_Object));
2837 EXFUN (Fchar_to_string, 1);
2838 EXFUN (Fdelete_region, 2);
2839 EXFUN (Fnarrow_to_region, 2);
2840 EXFUN (Fwiden, 0);
2841 EXFUN (Fuser_login_name, 1);
2842 EXFUN (Fsystem_name, 0);
2843 EXFUN (Fcurrent_time, 0);
2844 extern int clip_to_bounds P_ ((int, int, int));
2845 extern Lisp_Object make_buffer_string P_ ((int, int, int));
2846 extern Lisp_Object make_buffer_string_both P_ ((int, int, int, int, int));
2847 extern void init_editfns P_ ((void));
2848 extern void syms_of_editfns P_ ((void));
2849 extern Lisp_Object Vinhibit_field_text_motion;
2850 EXFUN (Fconstrain_to_field, 5);
2851 EXFUN (Ffield_string, 1);
2852 EXFUN (Fdelete_field, 1);
2853 EXFUN (Ffield_beginning, 3);
2854 EXFUN (Ffield_end, 3);
2855 EXFUN (Ffield_string_no_properties, 1);
2856 extern void set_time_zone_rule P_ ((char *));
2857
2858 /* defined in buffer.c */
2859 extern int mouse_face_overlay_overlaps P_ ((Lisp_Object));
2860 extern void nsberror P_ ((Lisp_Object)) NO_RETURN;
2861 EXFUN (Fset_buffer_multibyte, 1);
2862 EXFUN (Foverlay_start, 1);
2863 EXFUN (Foverlay_end, 1);
2864 EXFUN (Foverlay_buffer, 1);
2865 extern void adjust_overlays_for_insert P_ ((EMACS_INT, EMACS_INT));
2866 extern void adjust_overlays_for_delete P_ ((EMACS_INT, EMACS_INT));
2867 extern void fix_start_end_in_overlays P_ ((int, int));
2868 extern void report_overlay_modification P_ ((Lisp_Object, Lisp_Object, int,
2869 Lisp_Object, Lisp_Object, Lisp_Object));
2870 extern int overlay_touches_p P_ ((int));
2871 extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
2872 EXFUN (Fbuffer_list, 1);
2873 EXFUN (Fget_buffer, 1);
2874 EXFUN (Fget_buffer_create, 1);
2875 EXFUN (Fgenerate_new_buffer_name, 2);
2876 EXFUN (Fset_buffer, 1);
2877 EXFUN (set_buffer_if_live, 1);
2878 EXFUN (Fbarf_if_buffer_read_only, 0);
2879 EXFUN (Fcurrent_buffer, 0);
2880 EXFUN (Fswitch_to_buffer, 2);
2881 EXFUN (Fother_buffer, 3);
2882 EXFUN (Foverlay_get, 2);
2883 EXFUN (Fbuffer_modified_p, 1);
2884 EXFUN (Fset_buffer_modified_p, 1);
2885 EXFUN (Fkill_buffer, 1);
2886 EXFUN (Fkill_all_local_variables, 0);
2887 EXFUN (Fbuffer_disable_undo, 1);
2888 EXFUN (Fbuffer_enable_undo, 1);
2889 EXFUN (Ferase_buffer, 0);
2890 extern Lisp_Object Qoverlayp;
2891 extern Lisp_Object Qevaporate;
2892 extern Lisp_Object get_truename_buffer P_ ((Lisp_Object));
2893 extern struct buffer *all_buffers;
2894 EXFUN (Fprevious_overlay_change, 1);
2895 EXFUN (Fbuffer_file_name, 1);
2896 extern void init_buffer_once P_ ((void));
2897 extern void init_buffer P_ ((void));
2898 extern void syms_of_buffer P_ ((void));
2899 extern void keys_of_buffer P_ ((void));
2900
2901 /* defined in marker.c */
2902
2903 EXFUN (Fmarker_position, 1);
2904 EXFUN (Fmarker_buffer, 1);
2905 EXFUN (Fcopy_marker, 2);
2906 EXFUN (Fset_marker, 3);
2907 extern int marker_position P_ ((Lisp_Object));
2908 extern int marker_byte_position P_ ((Lisp_Object));
2909 extern void clear_charpos_cache P_ ((struct buffer *));
2910 extern int charpos_to_bytepos P_ ((int));
2911 extern int buf_charpos_to_bytepos P_ ((struct buffer *, int));
2912 extern int buf_bytepos_to_charpos P_ ((struct buffer *, int));
2913 extern void unchain_marker P_ ((struct Lisp_Marker *marker));
2914 extern Lisp_Object set_marker_restricted P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
2915 extern Lisp_Object set_marker_both P_ ((Lisp_Object, Lisp_Object, int, int));
2916 extern Lisp_Object set_marker_restricted_both P_ ((Lisp_Object, Lisp_Object,
2917 int, int));
2918 extern void syms_of_marker P_ ((void));
2919
2920 /* Defined in fileio.c */
2921
2922 extern Lisp_Object Qfile_error;
2923 EXFUN (Ffind_file_name_handler, 2);
2924 EXFUN (Ffile_name_as_directory, 1);
2925 EXFUN (Fmake_temp_name, 1);
2926 EXFUN (Fexpand_file_name, 2);
2927 EXFUN (Ffile_name_nondirectory, 1);
2928 EXFUN (Fsubstitute_in_file_name, 1);
2929 EXFUN (Ffile_symlink_p, 1);
2930 EXFUN (Fverify_visited_file_modtime, 1);
2931 EXFUN (Ffile_exists_p, 1);
2932 EXFUN (Ffile_name_absolute_p, 1);
2933 EXFUN (Fdirectory_file_name, 1);
2934 EXFUN (Ffile_name_directory, 1);
2935 extern Lisp_Object expand_and_dir_to_file P_ ((Lisp_Object, Lisp_Object));
2936 EXFUN (Ffile_accessible_directory_p, 1);
2937 EXFUN (Funhandled_file_name_directory, 1);
2938 EXFUN (Ffile_directory_p, 1);
2939 EXFUN (Fwrite_region, 7);
2940 EXFUN (Ffile_readable_p, 1);
2941 EXFUN (Ffile_executable_p, 1);
2942 EXFUN (Fread_file_name, 6);
2943 extern Lisp_Object close_file_unwind P_ ((Lisp_Object));
2944 extern void report_file_error P_ ((const char *, Lisp_Object)) NO_RETURN;
2945 extern int internal_delete_file P_ ((Lisp_Object));
2946 extern void syms_of_fileio P_ ((void));
2947 extern void init_fileio_once P_ ((void));
2948 extern Lisp_Object make_temp_name P_ ((Lisp_Object, int));
2949 EXFUN (Fmake_symbolic_link, 3);
2950 extern Lisp_Object Qdelete_directory;
2951 extern Lisp_Object Qdelete_file;
2952
2953 /* Defined in abbrev.c */
2954
2955 extern void syms_of_abbrev P_ ((void));
2956
2957 /* defined in search.c */
2958 extern void shrink_regexp_cache P_ ((void));
2959 EXFUN (Fstring_match, 3);
2960 extern void restore_search_regs P_ ((void));
2961 EXFUN (Fmatch_data, 3);
2962 EXFUN (Fset_match_data, 2);
2963 EXFUN (Fmatch_beginning, 1);
2964 EXFUN (Fmatch_end, 1);
2965 extern void record_unwind_save_match_data P_ ((void));
2966 EXFUN (Flooking_at, 1);
2967 extern int fast_string_match P_ ((Lisp_Object, Lisp_Object));
2968 extern int fast_c_string_match_ignore_case P_ ((Lisp_Object, const char *));
2969 extern int fast_string_match_ignore_case P_ ((Lisp_Object, Lisp_Object));
2970 extern EMACS_INT fast_looking_at P_ ((Lisp_Object, EMACS_INT, EMACS_INT,
2971 EMACS_INT, EMACS_INT, Lisp_Object));
2972 extern int scan_buffer P_ ((int, int, int, int, int *, int));
2973 extern int scan_newline P_ ((int, int, int, int, int, int));
2974 extern int find_next_newline P_ ((int, int));
2975 extern int find_next_newline_no_quit P_ ((int, int));
2976 extern int find_before_next_newline P_ ((int, int, int));
2977 extern void syms_of_search P_ ((void));
2978 extern void clear_regexp_cache P_ ((void));
2979
2980 /* defined in minibuf.c */
2981
2982 extern Lisp_Object last_minibuf_string;
2983 extern void choose_minibuf_frame P_ ((void));
2984 EXFUN (Fcompleting_read, 8);
2985 EXFUN (Fread_from_minibuffer, 7);
2986 EXFUN (Fread_variable, 2);
2987 EXFUN (Fread_buffer, 3);
2988 EXFUN (Fread_minibuffer, 2);
2989 EXFUN (Feval_minibuffer, 2);
2990 EXFUN (Fread_string, 5);
2991 EXFUN (Fread_no_blanks_input, 3);
2992 EXFUN (Fassoc_string, 3);
2993 extern Lisp_Object get_minibuffer P_ ((int));
2994 extern void temp_echo_area_glyphs P_ ((Lisp_Object));
2995 extern void init_minibuf_once P_ ((void));
2996 extern void syms_of_minibuf P_ ((void));
2997
2998 /* Defined in callint.c */
2999
3000 extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
3001 extern Lisp_Object Vcommand_history;
3002 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
3003 EXFUN (Fcall_interactively, 3);
3004 EXFUN (Fprefix_numeric_value, 1);
3005 extern void syms_of_callint P_ ((void));
3006
3007 /* defined in casefiddle.c */
3008
3009 EXFUN (Fdowncase, 1);
3010 EXFUN (Fupcase, 1);
3011 EXFUN (Fcapitalize, 1);
3012 EXFUN (Fupcase_region, 2);
3013 EXFUN (Fupcase_initials, 1);
3014 EXFUN (Fupcase_initials_region, 2);
3015 extern void syms_of_casefiddle P_ ((void));
3016 extern void keys_of_casefiddle P_ ((void));
3017
3018 /* defined in casetab.c */
3019
3020 EXFUN (Fset_case_table, 1);
3021 EXFUN (Fset_standard_case_table, 1);
3022 extern void init_casetab_once P_ ((void));
3023 extern void syms_of_casetab P_ ((void));
3024
3025 /* defined in keyboard.c */
3026
3027 extern int echoing;
3028 extern Lisp_Object echo_message_buffer;
3029 extern struct kboard *echo_kboard;
3030 extern void cancel_echoing P_ ((void));
3031 extern Lisp_Object Qdisabled, QCfilter;
3032 extern Lisp_Object Vtty_erase_char, Vhelp_form, Vtop_level;
3033 extern Lisp_Object Vthrow_on_input;
3034 extern int input_pending;
3035 EXFUN (Fdiscard_input, 0);
3036 EXFUN (Frecursive_edit, 0);
3037 EXFUN (Ftop_level, 0);
3038 EXFUN (Fcommand_execute, 4);
3039 EXFUN (Finput_pending_p, 0);
3040 extern Lisp_Object menu_bar_items P_ ((Lisp_Object));
3041 extern Lisp_Object tool_bar_items P_ ((Lisp_Object, int *));
3042 extern Lisp_Object Qvertical_scroll_bar;
3043 extern void discard_mouse_events P_ ((void));
3044 EXFUN (Fevent_convert_list, 1);
3045 EXFUN (Fread_key_sequence, 5);
3046 EXFUN (Fset_input_interrupt_mode, 1);
3047 EXFUN (Fset_output_flow_control, 2);
3048 EXFUN (Fset_input_meta_mode, 2);
3049 EXFUN (Fset_quit_char, 1);
3050 EXFUN (Fset_input_mode, 4);
3051 extern Lisp_Object pending_funcalls;
3052 extern int detect_input_pending P_ ((void));
3053 extern int detect_input_pending_ignore_squeezables P_ ((void));
3054 extern int detect_input_pending_run_timers P_ ((int));
3055 extern void safe_run_hooks P_ ((Lisp_Object));
3056 extern void cmd_error_internal P_ ((Lisp_Object, char *));
3057 extern Lisp_Object command_loop_1 P_ ((void));
3058 extern Lisp_Object recursive_edit_1 P_ ((void));
3059 extern void record_auto_save P_ ((void));
3060 extern void init_keyboard P_ ((void));
3061 extern void syms_of_keyboard P_ ((void));
3062 extern void keys_of_keyboard P_ ((void));
3063 extern char *push_key_description P_ ((unsigned int, char *, int));
3064 extern void add_user_signal P_ ((int sig, const char *name));
3065
3066
3067 /* defined in indent.c */
3068 EXFUN (Fvertical_motion, 2);
3069 EXFUN (Findent_to, 2);
3070 EXFUN (Fcurrent_column, 0);
3071 EXFUN (Fmove_to_column, 2);
3072 extern double current_column P_ ((void));
3073 extern void invalidate_current_column P_ ((void));
3074 extern int indented_beyond_p P_ ((int, int, double));
3075 extern void syms_of_indent P_ ((void));
3076
3077 /* defined in frame.c */
3078 #ifdef HAVE_WINDOW_SYSTEM
3079 extern Lisp_Object Vx_resource_name;
3080 extern Lisp_Object Vx_resource_class;
3081 #endif /* HAVE_WINDOW_SYSTEM */
3082 extern Lisp_Object Qvisible;
3083 extern void store_frame_param P_ ((struct frame *, Lisp_Object, Lisp_Object));
3084 extern void store_in_alist P_ ((Lisp_Object *, Lisp_Object, Lisp_Object));
3085 extern Lisp_Object do_switch_frame P_ ((Lisp_Object, int, int, Lisp_Object));
3086 extern Lisp_Object get_frame_param P_ ((struct frame *, Lisp_Object));
3087 extern Lisp_Object frame_buffer_predicate P_ ((Lisp_Object));
3088 EXFUN (Fframep, 1);
3089 EXFUN (Fselect_frame, 2);
3090 EXFUN (Fselected_frame, 0);
3091 EXFUN (Fwindow_frame, 1);
3092 EXFUN (Fframe_root_window, 1);
3093 EXFUN (Fframe_first_window, 1);
3094 EXFUN (Fframe_selected_window, 1);
3095 EXFUN (Fframe_list, 0);
3096 EXFUN (Fnext_frame, 2);
3097 EXFUN (Fdelete_frame, 2);
3098 EXFUN (Fset_mouse_position, 3);
3099 EXFUN (Fmake_frame_visible, 1);
3100 EXFUN (Fmake_frame_invisible, 2);
3101 EXFUN (Ficonify_frame, 1);
3102 EXFUN (Fframe_visible_p, 1);
3103 EXFUN (Fvisible_frame_list, 0);
3104 EXFUN (Fframe_parameter, 2);
3105 EXFUN (Fframe_parameters, 1);
3106 EXFUN (Fmodify_frame_parameters, 2);
3107 EXFUN (Fset_frame_height, 3);
3108 EXFUN (Fset_frame_width, 3);
3109 EXFUN (Fset_frame_size, 3);
3110 EXFUN (Fset_frame_position, 3);
3111 EXFUN (Fraise_frame, 1);
3112 EXFUN (Fredirect_frame_focus, 2);
3113 EXFUN (Fset_frame_selected_window, 3);
3114 extern Lisp_Object frame_buffer_list P_ ((Lisp_Object));
3115 extern void frames_discard_buffer P_ ((Lisp_Object));
3116 extern void set_frame_buffer_list P_ ((Lisp_Object, Lisp_Object));
3117 extern void frames_bury_buffer P_ ((Lisp_Object));
3118 extern void syms_of_frame P_ ((void));
3119
3120 /* defined in emacs.c */
3121 extern Lisp_Object decode_env_path P_ ((char *, char *));
3122 extern Lisp_Object Vinvocation_name, Vinvocation_directory;
3123 extern Lisp_Object Vbefore_init_time, Vafter_init_time;
3124 extern Lisp_Object Vinstallation_directory;
3125 extern Lisp_Object empty_unibyte_string, empty_multibyte_string;
3126 EXFUN (Fkill_emacs, 1);
3127 #if HAVE_SETLOCALE
3128 void fixup_locale P_ ((void));
3129 void synchronize_system_messages_locale P_ ((void));
3130 void synchronize_system_time_locale P_ ((void));
3131 #else
3132 #define setlocale(category, locale)
3133 #define fixup_locale()
3134 #define synchronize_system_messages_locale()
3135 #define synchronize_system_time_locale()
3136 #endif
3137 void shut_down_emacs P_ ((int, int, Lisp_Object));
3138 /* Nonzero means don't do interactive redisplay and don't change tty modes */
3139 extern int noninteractive;
3140
3141 /* Pipe used to send exit notification to the daemon parent at
3142 startup. */
3143 extern int daemon_pipe[2];
3144 #define IS_DAEMON (daemon_pipe[1] != 0)
3145
3146 /* Nonzero means don't do use window-system-specific display code */
3147 extern int inhibit_window_system;
3148 /* Nonzero means that a filter or a sentinel is running. */
3149 extern int running_asynch_code;
3150
3151 /* defined in process.c */
3152 EXFUN (Fget_process, 1);
3153 EXFUN (Fget_buffer_process, 1);
3154 EXFUN (Fprocessp, 1);
3155 EXFUN (Fprocess_status, 1);
3156 EXFUN (Fkill_process, 2);
3157 EXFUN (Fprocess_send_eof, 1);
3158 EXFUN (Fwaiting_for_user_input_p, 0);
3159 extern Lisp_Object Qprocessp;
3160 extern void kill_buffer_processes P_ ((Lisp_Object));
3161 extern int wait_reading_process_output P_ ((int, int, int, int,
3162 Lisp_Object,
3163 struct Lisp_Process *,
3164 int));
3165 extern void add_keyboard_wait_descriptor P_ ((int));
3166 extern void delete_keyboard_wait_descriptor P_ ((int));
3167 extern void add_gpm_wait_descriptor P_ ((int));
3168 extern void delete_gpm_wait_descriptor P_ ((int));
3169 extern void close_process_descs P_ ((void));
3170 extern void init_process P_ ((void));
3171 extern void syms_of_process P_ ((void));
3172 extern void setup_process_coding_systems P_ ((Lisp_Object));
3173
3174 /* defined in callproc.c */
3175 extern Lisp_Object Vexec_path, Vexec_suffixes,
3176 Vexec_directory, Vdata_directory;
3177 extern Lisp_Object Vdoc_directory;
3178 EXFUN (Fcall_process, MANY);
3179 extern int child_setup P_ ((int, int, int, char **, int, Lisp_Object));
3180 extern void init_callproc_1 P_ ((void));
3181 extern void init_callproc P_ ((void));
3182 extern void set_initial_environment P_ ((void));
3183 extern void syms_of_callproc P_ ((void));
3184
3185 /* defined in doc.c */
3186 extern Lisp_Object Vdoc_file_name;
3187 EXFUN (Fsubstitute_command_keys, 1);
3188 EXFUN (Fdocumentation, 2);
3189 EXFUN (Fdocumentation_property, 3);
3190 extern Lisp_Object read_doc_string P_ ((Lisp_Object));
3191 extern Lisp_Object get_doc_string P_ ((Lisp_Object, int, int));
3192 extern void syms_of_doc P_ ((void));
3193 extern int read_bytecode_char P_ ((int));
3194
3195 /* defined in bytecode.c */
3196 extern Lisp_Object Qbytecode;
3197 EXFUN (Fbyte_code, 3);
3198 extern void syms_of_bytecode P_ ((void));
3199 extern struct byte_stack *byte_stack_list;
3200 extern void mark_byte_stack P_ ((void));
3201 extern void unmark_byte_stack P_ ((void));
3202
3203 /* defined in macros.c */
3204 extern Lisp_Object Qexecute_kbd_macro;
3205 EXFUN (Fexecute_kbd_macro, 3);
3206 EXFUN (Fcancel_kbd_macro_events, 0);
3207 extern void init_macros P_ ((void));
3208 extern void syms_of_macros P_ ((void));
3209
3210 /* defined in undo.c */
3211 extern Lisp_Object Qinhibit_read_only;
3212 EXFUN (Fundo_boundary, 0);
3213 extern void truncate_undo_list P_ ((struct buffer *));
3214 extern void record_marker_adjustment P_ ((Lisp_Object, int));
3215 extern void record_insert P_ ((int, int));
3216 extern void record_delete P_ ((int, Lisp_Object));
3217 extern void record_first_change P_ ((void));
3218 extern void record_change P_ ((int, int));
3219 extern void record_property_change P_ ((int, int, Lisp_Object, Lisp_Object,
3220 Lisp_Object));
3221 extern void syms_of_undo P_ ((void));
3222 extern Lisp_Object Vundo_outer_limit;
3223
3224 /* defined in textprop.c */
3225 extern Lisp_Object Qfont, Qmouse_face;
3226 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
3227 EXFUN (Fnext_single_property_change, 4);
3228 EXFUN (Fnext_single_char_property_change, 4);
3229 EXFUN (Fprevious_single_property_change, 4);
3230 EXFUN (Fget_text_property, 3);
3231 EXFUN (Fput_text_property, 5);
3232 EXFUN (Fget_text_property, 3);
3233 EXFUN (Fprevious_char_property_change, 2);
3234 EXFUN (Fnext_char_property_change, 2);
3235 extern void report_interval_modification P_ ((Lisp_Object, Lisp_Object));
3236 extern Lisp_Object next_single_char_property_change P_ ((Lisp_Object,
3237 Lisp_Object,
3238 Lisp_Object,
3239 Lisp_Object));
3240
3241 /* defined in menu.c */
3242 extern void syms_of_menu P_ ((void));
3243
3244 /* defined in xmenu.c */
3245 EXFUN (Fx_popup_menu, 2);
3246 EXFUN (Fx_popup_dialog, 3);
3247 extern void syms_of_xmenu P_ ((void));
3248
3249 /* defined in termchar.h */
3250 struct tty_display_info;
3251
3252 /* defined in termhooks.h */
3253 struct terminal;
3254
3255 /* defined in sysdep.c */
3256 #ifndef HAVE_GET_CURRENT_DIR_NAME
3257 extern char *get_current_dir_name P_ ((void));
3258 #endif
3259 extern void stuff_char P_ ((char c));
3260 extern void init_sigio P_ ((int));
3261 extern void sys_subshell P_ ((void));
3262 extern void sys_suspend P_ ((void));
3263 extern void discard_tty_input P_ ((void));
3264 extern void init_sys_modes P_ ((struct tty_display_info *));
3265 extern void reset_sys_modes P_ ((struct tty_display_info *));
3266 extern void init_all_sys_modes P_ ((void));
3267 extern void reset_all_sys_modes P_ ((void));
3268 extern void wait_for_termination P_ ((int));
3269 extern void flush_pending_output P_ ((int));
3270 extern void child_setup_tty P_ ((int));
3271 extern void setup_pty P_ ((int));
3272 extern int set_window_size P_ ((int, int, int));
3273 extern void create_process P_ ((Lisp_Object, char **, Lisp_Object));
3274 extern int emacs_open P_ ((const char *, int, int));
3275 extern int emacs_close P_ ((int));
3276 extern int emacs_read P_ ((int, char *, unsigned int));
3277 extern int emacs_write P_ ((int, const char *, unsigned int));
3278
3279 /* defined in filelock.c */
3280 EXFUN (Funlock_buffer, 0);
3281 EXFUN (Ffile_locked_p, 1);
3282 extern void unlock_all_files P_ ((void));
3283 extern void lock_file P_ ((Lisp_Object));
3284 extern void unlock_file P_ ((Lisp_Object));
3285 extern void unlock_buffer P_ ((struct buffer *));
3286 extern void syms_of_filelock P_ ((void));
3287 extern void init_filelock P_ ((void));
3288
3289 /* Defined in sound.c */
3290 extern void syms_of_sound P_ ((void));
3291 extern void init_sound P_ ((void));
3292
3293 /* Defined in category.c */
3294 extern void init_category_once P_ ((void));
3295 extern Lisp_Object char_category_set P_ ((int));
3296 extern void syms_of_category P_ ((void));
3297
3298 /* Defined in ccl.c */
3299 extern void syms_of_ccl P_ ((void));
3300
3301 /* Defined in dired.c */
3302 EXFUN (Ffile_attributes, 2);
3303 extern void syms_of_dired P_ ((void));
3304 extern Lisp_Object directory_files_internal P_ ((Lisp_Object, Lisp_Object,
3305 Lisp_Object, Lisp_Object,
3306 int, Lisp_Object));
3307
3308 /* Defined in term.c */
3309 extern void syms_of_term P_ ((void));
3310 extern void fatal P_ ((const char *msgid, ...)) NO_RETURN;
3311
3312 /* Defined in terminal.c */
3313 EXFUN (Fdelete_terminal, 2);
3314 extern void syms_of_terminal P_ ((void));
3315
3316 /* Defined in font.c */
3317 extern void syms_of_font P_ ((void));
3318
3319 #ifdef HAVE_WINDOW_SYSTEM
3320 /* Defined in fontset.c */
3321 extern void syms_of_fontset P_ ((void));
3322 EXFUN (Fset_fontset_font, 5);
3323 EXFUN (Fnew_fontset, 2);
3324
3325 /* Defined in xfns.c, w32fns.c, or macfns.c */
3326 EXFUN (Fxw_display_color_p, 1);
3327 EXFUN (Fx_file_dialog, 5);
3328 EXFUN (Fx_focus_frame, 1);
3329 #endif
3330
3331 /* Defined in xfaces.c */
3332 EXFUN (Fclear_face_cache, 1);
3333 extern void syms_of_xfaces P_ ((void));
3334
3335 #ifndef HAVE_GETLOADAVG
3336 /* Defined in getloadavg.c */
3337 extern int getloadavg P_ ((double *, int));
3338 #endif
3339
3340 #ifdef HAVE_X_WINDOWS
3341 /* Defined in xfns.c */
3342 extern void syms_of_xfns P_ ((void));
3343
3344 /* Defined in xsmfns.c */
3345 extern void syms_of_xsmfns P_ ((void));
3346
3347 /* Defined in xselect.c */
3348 EXFUN (Fx_send_client_event, 6);
3349 extern void syms_of_xselect P_ ((void));
3350
3351 /* Defined in xterm.c */
3352 extern void syms_of_xterm P_ ((void));
3353 #endif /* HAVE_X_WINDOWS */
3354
3355 #ifdef MSDOS
3356 /* Defined in msdos.c */
3357 EXFUN (Fmsdos_downcase_filename, 1);
3358 #endif
3359
3360 #ifdef HAVE_MENUS
3361 /* Defined in (x|w32)fns.c, nsfns.m... */
3362 extern int have_menus_p P_ ((void));
3363 #endif
3364
3365 #ifdef HAVE_DBUS
3366 /* Defined in dbusbind.c */
3367 void xd_read_queued_messages P_ ((void));
3368 void syms_of_dbusbind P_ ((void));
3369 #endif
3370 \f
3371 /* Nonzero means Emacs has already been initialized.
3372 Used during startup to detect startup of dumped Emacs. */
3373 extern int initialized;
3374
3375 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
3376
3377 extern POINTER_TYPE *xmalloc P_ ((size_t));
3378 extern POINTER_TYPE *xrealloc P_ ((POINTER_TYPE *, size_t));
3379 extern void xfree P_ ((POINTER_TYPE *));
3380
3381 extern char *xstrdup P_ ((const char *));
3382
3383 extern char *egetenv P_ ((char *));
3384
3385 /* Set up the name of the machine we're running on. */
3386 extern void init_system_name P_ ((void));
3387
3388 /* Some systems (e.g., NT) use a different path separator than Unix,
3389 in addition to a device separator. Default the path separator
3390 to '/', and don't test for a device separator in IS_ANY_SEP. */
3391
3392 #ifdef WINDOWSNT
3393 extern Lisp_Object Vdirectory_sep_char;
3394 #endif
3395
3396 #ifndef DIRECTORY_SEP
3397 #define DIRECTORY_SEP '/'
3398 #endif
3399 #ifndef IS_DIRECTORY_SEP
3400 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
3401 #endif
3402 #ifndef IS_DEVICE_SEP
3403 #ifndef DEVICE_SEP
3404 #define IS_DEVICE_SEP(_c_) 0
3405 #else
3406 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
3407 #endif
3408 #endif
3409 #ifndef IS_ANY_SEP
3410 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
3411 #endif
3412
3413 #define SWITCH_ENUM_CAST(x) (x)
3414
3415 /* Loop over Lisp list LIST. Signal an error if LIST is not a proper
3416 list, or if it contains circles.
3417
3418 HARE and TORTOISE should be the names of Lisp_Object variables, and
3419 N should be the name of an EMACS_INT variable declared in the
3420 function where the macro is used. Each nested loop should use
3421 its own variables.
3422
3423 In the loop body, HARE is set to each cons of LIST, and N is the
3424 length of the list processed so far. */
3425
3426 #define LIST_END_P(list, obj) \
3427 (NILP (obj) \
3428 ? 1 \
3429 : (CONSP (obj) \
3430 ? 0 \
3431 : (wrong_type_argument (Qlistp, (list))), 1))
3432
3433 #define FOREACH(hare, list, tortoise, n) \
3434 for (tortoise = hare = (list), n = 0; \
3435 !LIST_END_P (list, hare); \
3436 (hare = XCDR (hare), ++n, \
3437 ((n & 1) != 0 \
3438 ? (tortoise = XCDR (tortoise), \
3439 (EQ (hare, tortoise) \
3440 && (circular_list_error ((list)), 1))) \
3441 : 0)))
3442
3443 /* The ubiquitous min and max macros. */
3444
3445 #ifdef max
3446 #undef max
3447 #undef min
3448 #endif
3449 #define min(a, b) ((a) < (b) ? (a) : (b))
3450 #define max(a, b) ((a) > (b) ? (a) : (b))
3451
3452 /* We used to use `abs', but that clashes with system headers on some
3453 platforms, and using a name reserved by Standard C is a bad idea
3454 anyway. */
3455 #if !defined(eabs)
3456 #define eabs(x) ((x) < 0 ? -(x) : (x))
3457 #endif
3458
3459 /* Return a fixnum or float, depending on whether VAL fits in a Lisp
3460 fixnum. */
3461
3462 #define make_fixnum_or_float(val) \
3463 (FIXNUM_OVERFLOW_P (val) \
3464 ? make_float (val) \
3465 : make_number ((EMACS_INT)(val)))
3466
3467
3468 /* Checks the `cycle check' variable CHECK to see if it indicates that
3469 EL is part of a cycle; CHECK must be either Qnil or a value returned
3470 by an earlier use of CYCLE_CHECK. SUSPICIOUS is the number of
3471 elements after which a cycle might be suspected; after that many
3472 elements, this macro begins consing in order to keep more precise
3473 track of elements.
3474
3475 Returns nil if a cycle was detected, otherwise a new value for CHECK
3476 that includes EL.
3477
3478 CHECK is evaluated multiple times, EL and SUSPICIOUS 0 or 1 times, so
3479 the caller should make sure that's ok. */
3480
3481 #define CYCLE_CHECK(check, el, suspicious) \
3482 (NILP (check) \
3483 ? make_number (0) \
3484 : (INTEGERP (check) \
3485 ? (XFASTINT (check) < (suspicious) \
3486 ? make_number (XFASTINT (check) + 1) \
3487 : Fcons (el, Qnil)) \
3488 : (!NILP (Fmemq ((el), (check))) \
3489 ? Qnil \
3490 : Fcons ((el), (check)))))
3491
3492
3493 /* SAFE_ALLOCA normally allocates memory on the stack, but if size is
3494 larger than MAX_ALLOCA, use xmalloc to avoid overflowing the stack. */
3495
3496 #define MAX_ALLOCA 16*1024
3497
3498 extern Lisp_Object safe_alloca_unwind (Lisp_Object);
3499
3500 #define USE_SAFE_ALLOCA \
3501 int sa_count = SPECPDL_INDEX (), sa_must_free = 0
3502
3503 /* SAFE_ALLOCA allocates a simple buffer. */
3504
3505 #define SAFE_ALLOCA(buf, type, size) \
3506 do { \
3507 if ((size) < MAX_ALLOCA) \
3508 buf = (type) alloca (size); \
3509 else \
3510 { \
3511 buf = (type) xmalloc (size); \
3512 sa_must_free++; \
3513 record_unwind_protect (safe_alloca_unwind, \
3514 make_save_value (buf, 0)); \
3515 } \
3516 } while (0)
3517
3518 /* SAFE_FREE frees xmalloced memory and enables GC as needed. */
3519
3520 #define SAFE_FREE() \
3521 do { \
3522 if (sa_must_free) { \
3523 sa_must_free = 0; \
3524 unbind_to (sa_count, Qnil); \
3525 } \
3526 } while (0)
3527
3528
3529 /* SAFE_ALLOCA_LISP allocates an array of Lisp_Objects. */
3530
3531 #define SAFE_ALLOCA_LISP(buf, nelt) \
3532 do { \
3533 int size_ = (nelt) * sizeof (Lisp_Object); \
3534 if (size_ < MAX_ALLOCA) \
3535 buf = (Lisp_Object *) alloca (size_); \
3536 else \
3537 { \
3538 Lisp_Object arg_; \
3539 buf = (Lisp_Object *) xmalloc (size_); \
3540 arg_ = make_save_value (buf, nelt); \
3541 XSAVE_VALUE (arg_)->dogc = 1; \
3542 sa_must_free++; \
3543 record_unwind_protect (safe_alloca_unwind, arg_); \
3544 } \
3545 } while (0)
3546
3547
3548 #endif /* EMACS_LISP_H */
3549
3550 /* arch-tag: 9b2ed020-70eb-47ac-94ee-e1c2a5107d5e
3551 (do not change this comment) */