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