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