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