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