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