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