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