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