]> code.delx.au - gnu-emacs/blob - src/lisp.h
(CHAR_TABLE_REF): Fix syntax error.
[gnu-emacs] / src / lisp.h
1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985,86,87,93,94,95 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21
22 /* These are default choices for the types to use. */
23 #ifndef EMACS_INT
24 #define EMACS_INT int
25 #define BITS_PER_EMACS_INT BITS_PER_INT
26 #endif
27 #ifndef EMACS_UINT
28 #define EMACS_UINT unsigned int
29 #endif
30
31 /* Define the fundamental Lisp data structures. */
32
33 /* This is the set of Lisp data types. */
34
35 enum Lisp_Type
36 {
37 /* Integer. XINT (obj) is the integer value. */
38 Lisp_Int,
39
40 /* Symbol. XSYMBOL (object) points to a struct Lisp_Symbol. */
41 Lisp_Symbol,
42
43 /* Miscellaneous. XMISC (object) points to a union Lisp_Misc,
44 whose first member indicates the subtype. */
45 Lisp_Misc,
46
47 /* String. XSTRING (object) points to a struct Lisp_String.
48 The length of the string, and its contents, are stored therein. */
49 Lisp_String,
50
51 /* Vector of Lisp objects, or something resembling it.
52 XVECTOR (object) points to a struct Lisp_Vector, which contains
53 the size and contents. The size field also contains the type
54 information, if it's not a real vector object. */
55 Lisp_Vectorlike,
56
57 /* Cons. XCONS (object) points to a struct Lisp_Cons. */
58 Lisp_Cons,
59
60 #ifdef LISP_FLOAT_TYPE
61 Lisp_Float,
62 #endif /* LISP_FLOAT_TYPE */
63
64 /* This is not a type code. It is for range checking. */
65 Lisp_Type_Limit
66 };
67
68 /* This is the set of datatypes that share a common structure.
69 The first member of the structure is a type code from this set.
70 The enum values are arbitrary, but we'll use large numbers to make it
71 more likely that we'll spot the error if a random word in memory is
72 mistakenly interpreted as a Lisp_Misc. */
73 enum Lisp_Misc_Type
74 {
75 Lisp_Misc_Free = 0x5eab,
76 Lisp_Misc_Marker,
77 Lisp_Misc_Intfwd,
78 Lisp_Misc_Boolfwd,
79 Lisp_Misc_Objfwd,
80 Lisp_Misc_Buffer_Objfwd,
81 Lisp_Misc_Buffer_Local_Value,
82 Lisp_Misc_Some_Buffer_Local_Value,
83 Lisp_Misc_Overlay,
84 Lisp_Misc_Kboard_Objfwd,
85 /* Currently floats are not a misc type,
86 but let's define this in case we want to change that. */
87 Lisp_Misc_Float,
88 /* This is not a type code. It is for range checking. */
89 Lisp_Misc_Limit
90 };
91
92 /* These values are overridden by the m- file on some machines. */
93 #ifndef VALBITS
94 #define VALBITS 28
95 #endif
96
97 #ifndef GCTYPEBITS
98 #define GCTYPEBITS 3
99 #endif
100
101 /* Make these values available in GDB, which sees enums but not macros. */
102
103 enum gdb_lisp_params
104 {
105 gdb_valbits = VALBITS,
106 gdb_gctypebits = GCTYPEBITS,
107 gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
108 #ifdef DATA_SEG_BITS
109 gdb_data_seg_bits = DATA_SEG_BITS
110 #else
111 gdb_data_seg_bits = 0
112 #endif
113 };
114
115 #ifndef NO_UNION_TYPE
116
117 #ifndef WORDS_BIG_ENDIAN
118
119 /* Definition of Lisp_Object for little-endian machines. */
120
121 typedef
122 union Lisp_Object
123 {
124 /* Used for comparing two Lisp_Objects;
125 also, positive integers can be accessed fast this way. */
126 int i;
127
128 struct
129 {
130 int val: VALBITS;
131 int type: GCTYPEBITS+1;
132 } s;
133 struct
134 {
135 unsigned int val: VALBITS;
136 int type: GCTYPEBITS+1;
137 } u;
138 struct
139 {
140 unsigned int val: VALBITS;
141 enum Lisp_Type type: GCTYPEBITS;
142 /* The markbit is not really part of the value of a Lisp_Object,
143 and is always zero except during garbage collection. */
144 unsigned int markbit: 1;
145 } gu;
146 }
147 Lisp_Object;
148
149 #else /* If WORDS_BIG_ENDIAN */
150
151 typedef
152 union Lisp_Object
153 {
154 /* Used for comparing two Lisp_Objects;
155 also, positive integers can be accessed fast this way. */
156 int i;
157
158 struct
159 {
160 int type: GCTYPEBITS+1;
161 int val: VALBITS;
162 } s;
163 struct
164 {
165 int type: GCTYPEBITS+1;
166 unsigned int val: VALBITS;
167 } u;
168 struct
169 {
170 /* The markbit is not really part of the value of a Lisp_Object,
171 and is always zero except during garbage collection. */
172 unsigned int markbit: 1;
173 enum Lisp_Type type: GCTYPEBITS;
174 unsigned int val: VALBITS;
175 } gu;
176 }
177 Lisp_Object;
178
179 #endif /* WORDS_BIG_ENDIAN */
180
181 #endif /* NO_UNION_TYPE */
182
183
184 /* If union type is not wanted, define Lisp_Object as just a number
185 and define the macros below to extract fields by shifting */
186
187 #ifdef NO_UNION_TYPE
188
189 #define Lisp_Object EMACS_INT
190
191 #ifndef VALMASK
192 #define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
193 #endif
194 #define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
195
196 /* Two flags that are set during GC. On some machines, these flags
197 are defined differently by the m- file. */
198
199 /* This is set in the car of a cons and in the plist slot of a symbol
200 to indicate it is marked. Likewise in the plist slot of an interval,
201 the chain slot of a marker, the type slot of a float, and the name
202 slot of a buffer.
203
204 In strings, this bit in the size field indicates that the string
205 is a "large" one, one which was separately malloc'd
206 rather than being part of a string block. */
207
208 #ifndef MARKBIT
209 #define MARKBIT ((int) ((unsigned int) 1 << (VALBITS + GCTYPEBITS)))
210 #endif /*MARKBIT */
211
212 /* In the size word of a vector, this bit means the vector has been marked.
213 In the size word of a large string, likewise. */
214
215 #ifndef ARRAY_MARK_FLAG
216 #define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
217 #endif /* no ARRAY_MARK_FLAG */
218
219 /* In the size word of a struct Lisp_Vector, this bit means it's really
220 some other vector-like object. */
221 #ifndef PSEUDOVECTOR_FLAG
222 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
223 #endif
224
225 /* In a pseudovector, the size field actually contains a word with one
226 PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
227 indicate the actual type. */
228 enum pvec_type
229 {
230 PVEC_NORMAL_VECTOR = 0,
231 PVEC_PROCESS = 0x200,
232 PVEC_FRAME = 0x400,
233 PVEC_COMPILED = 0x800,
234 PVEC_WINDOW = 0x1000,
235 PVEC_WINDOW_CONFIGURATION = 0x2000,
236 PVEC_SUBR = 0x4000,
237 PVEC_CHAR_TABLE = 0x8000,
238 PVEC_BOOL_VECTOR = 0x10000,
239 PVEC_BUFFER = 0x20000,
240 PVEC_TYPE_MASK = 0x3fe00,
241 PVEC_FLAG = PSEUDOVECTOR_FLAG
242 };
243
244 /* For convenience, we also store the number of elements in these bits. */
245 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
246
247 #endif /* NO_UNION_TYPE */
248 \f
249 /* These macros extract various sorts of values from a Lisp_Object.
250 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
251 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */
252
253 #ifdef NO_UNION_TYPE
254
255 /* One need to override this if there must be high bits set in data space
256 (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
257 on all machines, but would penalise machines which don't need it)
258 */
259 #ifndef XTYPE
260 #define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
261 #endif
262
263 #ifndef XSETTYPE
264 #define XSETTYPE(a, b) ((a) = XUINT (a) | ((EMACS_INT)(b) << VALBITS))
265 #endif
266
267 /* For integers known to be positive, XFASTINT provides fast retrieval
268 and XSETFASTINT provides fast storage. This takes advantage of the
269 fact that Lisp_Int is 0. */
270 #define XFASTINT(a) ((a) + 0)
271 #define XSETFASTINT(a, b) ((a) = (b))
272
273 /* Extract the value of a Lisp_Object as a signed integer. */
274
275 #ifndef XINT /* Some machines need to do this differently. */
276 #define XINT(a) (((a) << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
277 #endif
278
279 /* Extract the value as an unsigned integer. This is a basis
280 for extracting it as a pointer to a structure in storage. */
281
282 #ifndef XUINT
283 #define XUINT(a) ((a) & VALMASK)
284 #endif
285
286 #ifndef XPNTR
287 #ifdef HAVE_SHM
288 /* In this representation, data is found in two widely separated segments. */
289 extern int pure_size;
290 #define XPNTR(a) \
291 (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
292 #else /* not HAVE_SHM */
293 #ifdef DATA_SEG_BITS
294 /* This case is used for the rt-pc.
295 In the diffs I was given, it checked for ptr = 0
296 and did not adjust it in that case.
297 But I don't think that zero should ever be found
298 in a Lisp object whose data type says it points to something. */
299 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
300 #else
301 #define XPNTR(a) XUINT (a)
302 #endif
303 #endif /* not HAVE_SHM */
304 #endif /* no XPNTR */
305
306 #ifndef XSET
307 #define XSET(var, type, ptr) \
308 ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
309 #endif
310
311 /* Convert a C integer into a Lisp_Object integer. */
312
313 #define make_number(N) \
314 ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
315
316 /* During garbage collection, XGCTYPE must be used for extracting types
317 so that the mark bit is ignored. XMARKBIT accesses the markbit.
318 Markbits are used only in particular slots of particular structure types.
319 Other markbits are always zero.
320 Outside of garbage collection, all mark bits are always zero. */
321
322 #ifndef XGCTYPE
323 #define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
324 #endif
325
326 #if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
327 /* Make XMARKBIT faster if mark bit is sign bit. */
328 #ifndef XMARKBIT
329 #define XMARKBIT(a) ((a) < 0)
330 #endif
331 #endif /* markbit is sign bit */
332
333 #ifndef XMARKBIT
334 #define XMARKBIT(a) ((a) & MARKBIT)
335 #endif
336
337 #ifndef XSETMARKBIT
338 #define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
339 #endif
340
341 #ifndef XMARK
342 #define XMARK(a) ((a) |= MARKBIT)
343 #endif
344
345 #ifndef XUNMARK
346 #define XUNMARK(a) ((a) &= ~MARKBIT)
347 #endif
348
349 #endif /* NO_UNION_TYPE */
350
351 #ifndef NO_UNION_TYPE
352
353 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
354 #define XSETTYPE(a, b) ((a).u.type = (char) (b))
355
356 /* For integers known to be positive, XFASTINT provides fast retrieval
357 and XSETFASTINT provides fast storage. This takes advantage of the
358 fact that Lisp_Int is 0. */
359 #define XFASTINT(a) ((a).i + 0)
360 #define XSETFASTINT(a, b) ((a).i = (b))
361
362 #ifdef EXPLICIT_SIGN_EXTEND
363 /* Make sure we sign-extend; compilers have been known to fail to do so. */
364 #define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
365 #else
366 #define XINT(a) ((a).s.val)
367 #endif /* EXPLICIT_SIGN_EXTEND */
368
369 #define XUINT(a) ((a).u.val)
370 #define XPNTR(a) ((a).u.val)
371
372 #define XSET(var, vartype, ptr) \
373 (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
374
375 /* During garbage collection, XGCTYPE must be used for extracting types
376 so that the mark bit is ignored. XMARKBIT access the markbit.
377 Markbits are used only in particular slots of particular structure types.
378 Other markbits are always zero.
379 Outside of garbage collection, all mark bits are always zero. */
380
381 #define XGCTYPE(a) ((a).gu.type)
382 #define XMARKBIT(a) ((a).gu.markbit)
383 #define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
384 #define XMARK(a) (XMARKBIT(a) = 1)
385 #define XUNMARK(a) (XMARKBIT(a) = 0)
386
387 #endif /* NO_UNION_TYPE */
388
389 /* Extract a value or address from a Lisp_Object. */
390
391 #define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
392 #define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
393 #define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
394 #define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
395 #define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
396
397 /* Misc types. */
398 #define XMISC(a) ((union Lisp_Misc *) XPNTR(a))
399 #define XMISCTYPE(a) (XMARKER (a)->type)
400 #define XMARKER(a) (&(XMISC(a)->u_marker))
401 #define XINTFWD(a) (&(XMISC(a)->u_intfwd))
402 #define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
403 #define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
404 #define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
405 #define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
406 #define XOVERLAY(a) (&(XMISC(a)->u_overlay))
407 #define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
408
409 /* Pseudovector types. */
410 #define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
411 #define XWINDOW(a) ((struct window *) XPNTR(a))
412 #define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
413 #define XBUFFER(a) ((struct buffer *) XPNTR(a))
414 #define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
415 #define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
416
417
418 /* Construct a Lisp_Object from a value or address. */
419
420 #define XSETINT(a, b) XSET (a, Lisp_Int, b)
421 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
422 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
423 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
424 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
425 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
426
427 /* Misc types. */
428 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
429 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
430
431 /* Pseudovector types. */
432 #define XSETPSEUDOVECTOR(a, b, code) \
433 (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
434 #define XSETWINDOW_CONFIGURATION(a, b) \
435 (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
436 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
437 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
438 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
439 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
440 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
441 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
442 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
443 \f
444 #ifdef USE_TEXT_PROPERTIES
445 /* Basic data type for use of intervals. See the macros in intervals.h. */
446
447 struct interval
448 {
449 /* The first group of entries deal with the tree structure. */
450
451 unsigned int total_length; /* Length of myself and both children. */
452 unsigned int position; /* Cache of interval's character position. */
453 struct interval *left; /* Intervals which precede me. */
454 struct interval *right; /* Intervals which succeed me. */
455
456 /* Parent in the tree, or the Lisp_Object containing this interval tree.
457
458 The mark bit on the root interval of an interval tree says
459 whether we have started (and possibly finished) marking the
460 tree. If GC comes across an interval tree whose root's parent
461 field has its markbit set, it leaves the tree alone.
462
463 You'd think we could store this information in the parent object
464 somewhere (after all, that should be visited once and then
465 ignored too, right?), but strings are GC'd strangely. */
466 struct interval *parent;
467
468 /* The remaining components are `properties' of the interval.
469 The first four are duplicates for things which can be on the list,
470 for purposes of speed. */
471
472 unsigned char write_protect; /* Non-zero means can't modify. */
473 unsigned char visible; /* Zero means don't display. */
474 unsigned char front_sticky; /* Non-zero means text inserted just
475 before this interval goes into it. */
476 unsigned char rear_sticky; /* Likewise for just after it. */
477
478 /* Properties of this interval.
479 The mark bit on this field says whether this particular interval
480 tree node has been visited. Since intervals should never be
481 shared, GC aborts if it seems to have visited an interval twice. */
482 Lisp_Object plist;
483 };
484
485 typedef struct interval *INTERVAL;
486
487 /* Complain if object is not string or buffer type */
488 #define CHECK_STRING_OR_BUFFER(x, i) \
489 { if (!STRINGP ((x)) && !BUFFERP ((x))) \
490 x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
491
492 /* Macro used to conditionally compile intervals into certain data
493 structures. See, e.g., struct Lisp_String below. */
494 #define DECLARE_INTERVALS INTERVAL intervals;
495
496 /* Macro used to conditionally compile interval initialization into
497 certain code. See, e.g., alloc.c. */
498 #define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val
499
500 #else /* No text properties */
501
502 /* If no intervals are used, make the above definitions go away. */
503
504 #define CHECK_STRING_OR_BUFFER(x, i)
505
506 #define INTERVAL
507 #define DECLARE_INTERVALS
508 #define INITIALIZE_INTERVAL(ptr,val)
509
510 #endif /* USE_TEXT_PROPERTIES */
511 \f
512 /* In a cons, the markbit of the car is the gc mark bit */
513
514 struct Lisp_Cons
515 {
516 Lisp_Object car, cdr;
517 };
518
519 /* Take the car or cdr of something known to be a cons cell. */
520 #define XCAR(c) (XCONS ((c))->car)
521 #define XCDR(c) (XCONS ((c))->cdr)
522
523 /* Take the car or cdr of something whose type is not known. */
524 #define CAR(c) \
525 (CONSP ((c)) ? XCAR ((c)) \
526 : NILP ((c)) ? Qnil \
527 : wrong_type_argument (Qlistp, (c)))
528
529 #define CDR(c) \
530 (CONSP ((c)) ? XCDR ((c)) \
531 : NILP ((c)) ? Qnil \
532 : wrong_type_argument (Qlistp, (c)))
533
534 /* Like a cons, but records info on where the text lives that it was read from */
535 /* This is not really in use now */
536
537 struct Lisp_Buffer_Cons
538 {
539 Lisp_Object car, cdr;
540 struct buffer *buffer;
541 int bufpos;
542 };
543
544 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
545
546 struct Lisp_String
547 {
548 EMACS_INT size;
549 DECLARE_INTERVALS /* `data' field must be last. */
550 unsigned char data[1];
551 };
552
553 /* If a struct is made to look like a vector, this macro returns the length
554 of the shortest vector that would hold that struct. */
555 #define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector) \
556 - sizeof (Lisp_Object)) \
557 + sizeof(Lisp_Object) - 1) /* round up */ \
558 / sizeof (Lisp_Object))
559
560 struct Lisp_Vector
561 {
562 EMACS_INT size;
563 struct Lisp_Vector *next;
564 Lisp_Object contents[1];
565 };
566
567 /* A char table is a kind of vectorlike, with contents are like a vector
568 but with a few other slots. For some purposes, it makes sense
569 to handle a chartable with type struct Lisp_Vector. */
570
571 /* This is the number of slots that apply to characters or character
572 sets. The first 128 are for ASCII, the next 128 are for 8-bit
573 European characters, and the last 128 are for multibyte characters. */
574 #define CHAR_TABLE_ORDINARY_SLOTS 384
575
576 /* This is the number of slots that apply to characters of ASCII and
577 8-bit Europeans only. */
578 #define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
579
580 /* This is the number of slots that every char table must have.
581 This counts the ordinary slots and the parent and defalt slots. */
582 #define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 3)
583
584 /* Return the number of "extra" slots in the char table CT. */
585
586 #define CHAR_TABLE_EXTRA_SLOTS(CT) \
587 (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
588
589 /* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
590 and 8-bit Europeans characters. Do not follow parent. */
591 #define CHAR_TABLE_REF(CT, IDX) \
592 (CHAR_TABLE_P (CT) && IDX >= 0 && IDX < CHAR_TABLE_SINGLE_BYTE_SLOTS \
593 ? (!NILP (XCHAR_TABLE (CT)->contents[IDX]) \
594 ? XCHAR_TABLE (CT)->contents[IDX] \
595 : XCHAR_TABLE (CT)->defalt) \
596 : Faref (CT, IDX))
597
598 /* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
599 8-bit Europeans characters. */
600 #define CHAR_TABLE_SET(CT, IDX, VAL) \
601 do { \
602 if (CHAR_TABLE_P (CT) && IDX >= 0 && IDX < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
603 XCHAR_TABLE (CT)->contents[IDX] = VAL; \
604 else \
605 Faset (CT, IDX, VAL); \
606 } while (0)
607
608 struct Lisp_Char_Table
609 {
610 /* This is the vector's size field, which also holds the
611 pseudovector type information. It holds the size, too.
612 The size counts the defalt and parent slots. */
613 EMACS_INT size;
614 struct Lisp_Vector *next;
615 Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];
616 /* This holds a default value,
617 which is used whenever the value for a specific character is nil. */
618 Lisp_Object defalt;
619 /* This points to another char table, which we inherit from
620 when the value for a specific character is nil.
621 The `defalt' slot takes precedence over this. */
622 Lisp_Object parent;
623 /* This should be a symbol which says what kind of use
624 this char-table is meant for.
625 Typically now the values can be `syntax-table' and `display-table'. */
626 Lisp_Object purpose;
627 /* These hold additional data. */
628 Lisp_Object extras[1];
629 };
630
631 /* A boolvector is a kind of vectorlike, with contents are like a string. */
632 struct Lisp_Bool_Vector
633 {
634 /* This is the vector's size field. It doesn't have the real size,
635 just the subtype information. */
636 EMACS_INT vector_size;
637 struct Lisp_Vector *next;
638 /* This is the size in bits. */
639 EMACS_INT size;
640 /* This contains the actual bits, packed into bytes. */
641 unsigned char data[1];
642 };
643
644 /* In a symbol, the markbit of the plist is used as the gc mark bit */
645
646 struct Lisp_Symbol
647 {
648 struct Lisp_String *name;
649 Lisp_Object value;
650 Lisp_Object function;
651 Lisp_Object plist;
652 Lisp_Object obarray;
653 struct Lisp_Symbol *next; /* -> next symbol in this obarray bucket */
654 };
655
656 /* This structure describes a built-in function.
657 It is generated by the DEFUN macro only.
658 defsubr makes it into a Lisp object.
659
660 This type is treated in most respects as a pseudovector,
661 but since we never dynamically allocate or free them,
662 we don't need a next-vector field. */
663
664 struct Lisp_Subr
665 {
666 EMACS_INT size;
667 Lisp_Object (*function) ();
668 short min_args, max_args;
669 char *symbol_name;
670 char *prompt;
671 char *doc;
672 };
673 \f
674 /* These structures are used for various misc types. */
675
676 /* A miscellaneous object, when it's on the free list. */
677 struct Lisp_Free
678 {
679 int type : 16; /* = Lisp_Misc_Free */
680 int spacer : 16;
681 union Lisp_Misc *chain;
682 };
683
684 /* In a marker, the markbit of the chain field is used as the gc mark bit. */
685 struct Lisp_Marker
686 {
687 int type : 16; /* = Lisp_Misc_Marker */
688 int spacer : 15;
689 /* 1 means normal insertion at the marker's position
690 leaves the marker after the inserted text. */
691 unsigned int insertion_type : 1;
692 struct buffer *buffer;
693 Lisp_Object chain;
694 int bufpos;
695 };
696
697 /* Forwarding pointer to an int variable.
698 This is allowed only in the value cell of a symbol,
699 and it means that the symbol's value really lives in the
700 specified int variable. */
701 struct Lisp_Intfwd
702 {
703 int type : 16; /* = Lisp_Misc_Intfwd */
704 int spacer : 16;
705 int *intvar;
706 };
707
708 /* Boolean forwarding pointer to an int variable.
709 This is like Lisp_Intfwd except that the ostensible
710 "value" of the symbol is t if the int variable is nonzero,
711 nil if it is zero. */
712 struct Lisp_Boolfwd
713 {
714 int type : 16; /* = Lisp_Misc_Boolfwd */
715 int spacer : 16;
716 int *boolvar;
717 };
718
719 /* Forwarding pointer to a Lisp_Object variable.
720 This is allowed only in the value cell of a symbol,
721 and it means that the symbol's value really lives in the
722 specified variable. */
723 struct Lisp_Objfwd
724 {
725 int type : 16; /* = Lisp_Misc_Objfwd */
726 int spacer : 16;
727 Lisp_Object *objvar;
728 };
729
730 /* Like Lisp_Objfwd except that value lives in a slot in the
731 current buffer. Value is byte index of slot within buffer. */
732 struct Lisp_Buffer_Objfwd
733 {
734 int type : 16; /* = Lisp_Misc_Buffer_Objfwd */
735 int spacer : 16;
736 int offset;
737 };
738
739 /* Used in a symbol value cell when the symbol's value is per-buffer.
740 The actual contents resemble a cons cell which starts a list like this:
741 (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
742
743 The cons-like structure is for historical reasons; it might be better
744 to just put these elements into the struct, now.
745
746 BUFFER is the last buffer for which this symbol's value was
747 made up to date.
748
749 CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
750 local_var_alist, that being the element whose car is this
751 variable. Or it can be a pointer to the
752 (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
753 if BUFFER does not have an element in its alist for this
754 variable (that is, if BUFFER sees the default value of this
755 variable).
756
757 If we want to examine or set the value and BUFFER is current,
758 we just examine or set REALVALUE. If BUFFER is not current, we
759 store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
760 then find the appropriate alist element for the buffer now
761 current and set up CURRENT-ALIST-ELEMENT. Then we set
762 REALVALUE out of that element, and store into BUFFER.
763
764 If we are setting the variable and the current buffer does not
765 have an alist entry for this variable, an alist entry is
766 created.
767
768 Note that REALVALUE can be a forwarding pointer. Each time it
769 is examined or set, forwarding must be done. Each time we
770 switch buffers, buffer-local variables which forward into C
771 variables are swapped immediately, so the C code can assume
772 that they are always up to date.
773
774 Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
775 use the same substructure. The difference is that with the latter,
776 merely setting the variable while some buffer is current
777 does not cause that buffer to have its own local value of this variable.
778 Only make-local-variable does that. */
779 struct Lisp_Buffer_Local_Value
780 {
781 int type : 16; /* = Lisp_Misc_Buffer_Local_Value
782 or Lisp_Misc_Some_Buffer_Local_Value */
783 int spacer : 16;
784 Lisp_Object car, cdr;
785 };
786
787 /* In an overlay object, the mark bit of the plist is used as the GC mark.
788 START and END are markers in the overlay's buffer, and
789 PLIST is the overlay's property list. */
790 struct Lisp_Overlay
791 {
792 int type : 16; /* = Lisp_Misc_Overlay */
793 int spacer : 16;
794 Lisp_Object start, end, plist;
795 };
796
797 /* Like Lisp_Objfwd except that value lives in a slot in the
798 current kboard. */
799 struct Lisp_Kboard_Objfwd
800 {
801 int type : 16; /* = Lisp_Misc_Kboard_Objfwd */
802 int spacer : 16;
803 int offset;
804 };
805
806
807 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
808 It uses one of these struct subtypes to get the type field. */
809
810 union Lisp_Misc
811 {
812 struct Lisp_Free u_free;
813 struct Lisp_Marker u_marker;
814 struct Lisp_Intfwd u_intfwd;
815 struct Lisp_Boolfwd u_boolfwd;
816 struct Lisp_Objfwd u_objfwd;
817 struct Lisp_Buffer_Objfwd u_buffer_objfwd;
818 struct Lisp_Buffer_Local_Value u_buffer_local_value;
819 struct Lisp_Overlay u_overlay;
820 struct Lisp_Kboard_Objfwd u_kboard_objfwd;
821 };
822 \f
823 #ifdef LISP_FLOAT_TYPE
824 /* Optional Lisp floating point type */
825 struct Lisp_Float
826 {
827 Lisp_Object type; /* essentially used for mark-bit
828 and chaining when on free-list */
829 double data;
830 };
831 #endif /* LISP_FLOAT_TYPE */
832
833 /* A character, declared with the following typedef, is a member
834 of some character set associated with the current buffer. */
835 #ifndef _UCHAR_T /* Protect against something in ctab.h on AIX. */
836 #define _UCHAR_T
837 typedef unsigned char UCHAR;
838 #endif
839
840 /* Meanings of slots in a Lisp_Compiled: */
841
842 #define COMPILED_ARGLIST 0
843 #define COMPILED_BYTECODE 1
844 #define COMPILED_CONSTANTS 2
845 #define COMPILED_STACK_DEPTH 3
846 #define COMPILED_DOC_STRING 4
847 #define COMPILED_INTERACTIVE 5
848
849 /* Flag bits in a character. These also get used in termhooks.h.
850 Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
851 (MUlti-Lingual Emacs) might need 22 bits for the character value
852 itself, so we probably shouldn't use any bits lower than 0x0400000. */
853 #define CHAR_ALT (0x0400000)
854 #define CHAR_SUPER (0x0800000)
855 #define CHAR_HYPER (0x1000000)
856 #define CHAR_SHIFT (0x2000000)
857 #define CHAR_CTL (0x4000000)
858 #define CHAR_META (0x8000000)
859
860 /* Actually, the current Emacs uses 19 bits for the character value
861 itself. */
862 #define CHARACTERBITS 19
863
864 #ifdef USE_X_TOOLKIT
865 #ifdef NO_UNION_TYPE
866 /* Use this for turning a (void *) into a Lisp_Object, as when the
867 Lisp_Object is passed into a toolkit callback function. */
868 #define VOID_TO_LISP(larg,varg) \
869 do { ((larg) = ((Lisp_Object) (varg))); } while (0)
870 #define CVOID_TO_LISP VOID_TO_LISP
871
872 /* Use this for turning a Lisp_Object into a (void *), as when the
873 Lisp_Object is passed into a toolkit callback function. */
874 #define LISP_TO_VOID(larg) ((void *) (larg))
875 #define LISP_TO_CVOID(varg) ((const void *) (larg))
876
877 #else /* not NO_UNION_TYPE */
878 /* Use this for turning a (void *) into a Lisp_Object, as when the
879 Lisp_Object is passed into a toolkit callback function. */
880 #define VOID_TO_LISP(larg,varg) \
881 do { ((larg).v = (void *) (varg)); } while (0)
882 #define CVOID_TO_LISP(larg,varg) \
883 do { ((larg).cv = (const void *) (varg)); } while (0)
884
885 /* Use this for turning a Lisp_Object into a (void *), as when the
886 Lisp_Object is passed into a toolkit callback function. */
887 #define LISP_TO_VOID(larg) ((larg).v)
888 #define LISP_TO_CVOID(larg) ((larg).cv)
889 #endif /* not NO_UNION_TYPE */
890 #endif /* USE_X_TOOLKIT */
891
892 \f
893 /* The glyph datatype, used to represent characters on the display. */
894
895 /* The low 19 bits (CHARACTERBITS) are the character code, and the
896 bits above them except for the topmost two bits are the numeric
897 face ID. If FID is the face ID of a glyph on a frame F, then
898 F->display.x->faces[FID] contains the description of that face.
899 This is an int instead of a short, so we can support a good bunch
900 of face ID's (i.e. 2^(32 - 19 - 2) = 2048 ID's) ; given that we
901 have no mechanism for tossing unused frame face ID's yet, we'll
902 probably run out of 255 pretty quickly. */
903 #define GLYPH unsigned int
904
905 /* Mask bit for a glyph of a character which should be written from
906 right to left. */
907 #define GLYPH_MASK_REV_DIR 0x80000000
908 /* Mask bit for a padding glyph of a multi-column character. */
909 #define GLYPH_MASK_PADDING 0x40000000
910 /* Mask bits for face. */
911 #define GLYPH_MASK_FACE 0x3FF80000
912 /* Mask bits for character code. */
913 #define GLYPH_MASK_CHAR 0x0007FFFF /* The lowest 19 bits */
914
915 #ifdef HAVE_FACES
916 /* The FAST macros assume that we already know we're in an X window. */
917
918 /* Given a character code and a face ID, return the appropriate glyph. */
919 #define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << CHARACTERBITS))
920
921 /* Return a glyph's character code. */
922 #define FAST_GLYPH_CHAR(glyph) ((glyph) & GLYPH_MASK_CHAR)
923
924 /* Return a glyph's face ID. */
925 #define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
926
927 /* Slower versions that test the frame type first. */
928 #define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
929 : FAST_MAKE_GLYPH (char, face))
930 #define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
931 #define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
932 #else /* not HAVE_FACES */
933 #define MAKE_GLYPH(f, char, face) (char)
934 #define FAST_MAKE_GLYPH(char, face) (char)
935 #define GLYPH_CHAR(f, g) ((g) & GLYPH_MASK_CHAR)
936 #define FAST_GLYPH_CHAR(g) ((g) & GLYPH_MASK_CHAR)
937 #define GLYPH_FACE(f, g) ((g) & GLYPH_MASK_FACE)
938 #define FAST_GLYPH_FACE(g) ((g) & GLYPH_MASK_FACE)
939 #endif /* not HAVE_FACES */
940
941 /* Return 1 iff GLYPH contains valid character code. */
942 #define GLYPH_CHAR_VALID_P(glyph) \
943 ((GLYPH) (FAST_GLYPH_CHAR (glyph)) <= MAX_CHAR)
944
945 /* The ID of the mode line highlighting face. */
946 #define GLYPH_MODE_LINE_FACE 1
947 \f
948 /* Data type checking */
949
950 #define NILP(x) (XFASTINT (x) == XFASTINT (Qnil))
951 #define GC_NILP(x) GC_EQ (x, Qnil)
952
953 #ifdef LISP_FLOAT_TYPE
954 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
955 #define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
956 #else
957 #define NUMBERP(x) (INTEGERP (x))
958 #define GC_NUMBERP(x) (GC_INTEGERP (x))
959 #endif
960 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
961 #define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
962
963 #define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
964 #define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
965 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
966 #define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
967 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
968 #define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
969 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
970 #define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
971 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
972 #define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
973 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
974 #define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
975
976 #ifdef LISP_FLOAT_TYPE
977 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
978 #define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
979 #else
980 #define FLOATP(x) (0)
981 #define GC_FLOATP(x) (0)
982 #endif
983 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
984 #define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
985 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
986 #define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
987 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
988 #define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
989 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
990 #define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
991 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
992 #define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
993 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
994 #define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
995 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
996 #define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
997 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
998 #define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
999 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1000 #define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
1001 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1002 #define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1003
1004
1005 /* True if object X is a pseudovector whose code is CODE. */
1006 #define PSEUDOVECTORP(x, code) \
1007 (VECTORLIKEP (x) \
1008 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1009 == (PSEUDOVECTOR_FLAG | (code))))
1010
1011 /* True if object X is a pseudovector whose code is CODE.
1012 This one works during GC. */
1013 #define GC_PSEUDOVECTORP(x, code) \
1014 (GC_VECTORLIKEP (x) \
1015 && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) \
1016 == (PSEUDOVECTOR_FLAG | (code))))
1017
1018 /* Test for specific pseudovector types. */
1019 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1020 #define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
1021 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
1022 #define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
1023 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
1024 #define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
1025 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
1026 #define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
1027 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
1028 #define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
1029 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
1030 #define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
1031 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1032 #define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
1033 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1034 #define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1035 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
1036 #define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
1037 \f
1038 #define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
1039 #define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
1040
1041 #define CHECK_LIST(x, i) \
1042 do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
1043
1044 #define CHECK_STRING(x, i) \
1045 do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
1046
1047 #define CHECK_CONS(x, i) \
1048 do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
1049
1050 #define CHECK_SYMBOL(x, i) \
1051 do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
1052
1053 #define CHECK_CHAR_TABLE(x, i) \
1054 do { if (!CHAR_TABLE_P ((x))) \
1055 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
1056
1057 #define CHECK_VECTOR(x, i) \
1058 do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
1059
1060 #define CHECK_VECTOR_OR_CHAR_TABLE(x, i) \
1061 do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x))) \
1062 x = wrong_type_argument (Qvector_or_char_table_p, (x)); \
1063 } while (0)
1064
1065 #define CHECK_BUFFER(x, i) \
1066 do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
1067
1068 #define CHECK_WINDOW(x, i) \
1069 do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
1070
1071 /* This macro rejects windows on the interior of the window tree as
1072 "dead", which is what we want; this is an argument-checking macro, and
1073 the user should never get access to interior windows.
1074
1075 A window of any sort, leaf or interior, is dead iff the buffer,
1076 vchild, and hchild members are all nil. */
1077
1078 #define CHECK_LIVE_WINDOW(x, i) \
1079 do { \
1080 if (!WINDOWP ((x)) \
1081 || NILP (XWINDOW ((x))->buffer)) \
1082 x = wrong_type_argument (Qwindow_live_p, (x)); \
1083 } while (0)
1084
1085 #define CHECK_PROCESS(x, i) \
1086 do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
1087
1088 #define CHECK_NUMBER(x, i) \
1089 do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
1090
1091 #define CHECK_NATNUM(x, i) \
1092 do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
1093
1094 #define CHECK_MARKER(x, i) \
1095 do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
1096
1097 #define CHECK_NUMBER_COERCE_MARKER(x, i) \
1098 do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1099 else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
1100
1101 #ifdef LISP_FLOAT_TYPE
1102
1103 #ifndef DBL_DIG
1104 #define DBL_DIG 20
1105 #endif
1106
1107 #define XFLOATINT(n) extract_float((n))
1108
1109 #define CHECK_FLOAT(x, i) \
1110 do { if (!FLOATP (x)) \
1111 x = wrong_type_argument (Qfloatp, (x)); } while (0)
1112
1113 #define CHECK_NUMBER_OR_FLOAT(x, i) \
1114 do { if (!FLOATP (x) && !INTEGERP (x)) \
1115 x = wrong_type_argument (Qnumberp, (x)); } while (0)
1116
1117 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
1118 do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x)); \
1119 else if (!INTEGERP (x) && !FLOATP (x)) \
1120 x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
1121
1122 #else /* Not LISP_FLOAT_TYPE */
1123
1124 #define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
1125
1126 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
1127
1128 #define XFLOATINT(n) XINT((n))
1129 #endif /* LISP_FLOAT_TYPE */
1130
1131 #define CHECK_OVERLAY(x, i) \
1132 do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
1133
1134 /* Cast pointers to this type to compare them. Some machines want int. */
1135 #ifndef PNTR_COMPARISON_TYPE
1136 #define PNTR_COMPARISON_TYPE unsigned int
1137 #endif
1138 \f
1139 /* Define a built-in function for calling from Lisp.
1140 `lname' should be the name to give the function in Lisp,
1141 as a null-terminated C string.
1142 `fnname' should be the name of the function in C.
1143 By convention, it starts with F.
1144 `sname' should be the name for the C constant structure
1145 that records information on this function for internal use.
1146 By convention, it should be the same as `fnname' but with S instead of F.
1147 It's too bad that C macros can't compute this from `fnname'.
1148 `minargs' should be a number, the minimum number of arguments allowed.
1149 `maxargs' should be a number, the maximum number of arguments allowed,
1150 or else MANY or UNEVALLED.
1151 MANY means pass a vector of evaluated arguments,
1152 in the form of an integer number-of-arguments
1153 followed by the address of a vector of Lisp_Objects
1154 which contains the argument values.
1155 UNEVALLED means pass the list of unevaluated arguments
1156 `prompt' says how to read arguments for an interactive call.
1157 See the doc string for `interactive'.
1158 A null string means call interactively with no arguments.
1159 `doc' is documentation for the user. */
1160
1161 #if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1162 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1163 Lisp_Object fnname (); \
1164 struct Lisp_Subr sname = \
1165 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1166 fnname, minargs, maxargs, lname, prompt, 0}; \
1167 Lisp_Object fnname
1168
1169 #else
1170
1171 /* This version of DEFUN declares a function prototype with the right
1172 arguments, so we can catch errors with maxargs at compile-time. */
1173 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
1174 Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
1175 struct Lisp_Subr sname = \
1176 { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)), \
1177 fnname, minargs, maxargs, lname, prompt, 0}; \
1178 Lisp_Object fnname
1179
1180 /* Note that the weird token-substitution semantics of ANSI C makes
1181 this work for MANY and UNEVALLED. */
1182 #define DEFUN_ARGS_MANY (int, Lisp_Object *)
1183 #define DEFUN_ARGS_UNEVALLED (Lisp_Object)
1184 #define DEFUN_ARGS_0 (void)
1185 #define DEFUN_ARGS_1 (Lisp_Object)
1186 #define DEFUN_ARGS_2 (Lisp_Object, Lisp_Object)
1187 #define DEFUN_ARGS_3 (Lisp_Object, Lisp_Object, Lisp_Object)
1188 #define DEFUN_ARGS_4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1189 #define DEFUN_ARGS_5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1190 Lisp_Object)
1191 #define DEFUN_ARGS_6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1192 Lisp_Object, Lisp_Object)
1193 #define DEFUN_ARGS_7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1194 Lisp_Object, Lisp_Object, Lisp_Object)
1195 #endif
1196
1197 /* defsubr (Sname);
1198 is how we define the symbol for function `name' at start-up time. */
1199 extern void defsubr ();
1200
1201 #define MANY -2
1202 #define UNEVALLED -1
1203
1204 extern void defvar_lisp ();
1205 extern void defvar_bool ();
1206 extern void defvar_int ();
1207 extern void defvar_kboard ();
1208
1209 /* Macros we use to define forwarded Lisp variables.
1210 These are used in the syms_of_FILENAME functions. */
1211
1212 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1213 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1214 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1215 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1216 #define DEFVAR_PER_BUFFER(lname, vname, type, doc) \
1217 defvar_per_buffer (lname, vname, type, 0)
1218 #define DEFVAR_KBOARD(lname, vname, doc) \
1219 defvar_kboard (lname, \
1220 (int)((char *)(&current_kboard->vname) \
1221 - (char *)current_kboard))
1222 \f
1223 /* Structure for recording Lisp call stack for backtrace purposes. */
1224
1225 /* The special binding stack holds the outer values of variables while
1226 they are bound by a function application or a let form, stores the
1227 code to be executed for Lisp unwind-protect forms, and stores the C
1228 functions to be called for record_unwind_protect.
1229
1230 If func is non-zero, undoing this binding applies func to old_value;
1231 This implements record_unwind_protect.
1232 If func is zero and symbol is nil, undoing this binding evaluates
1233 the list of forms in old_value; this implements Lisp's unwind-protect
1234 form.
1235 Otherwise, undoing this binding stores old_value as symbol's value; this
1236 undoes the bindings made by a let form or function call. */
1237 struct specbinding
1238 {
1239 Lisp_Object symbol, old_value;
1240 Lisp_Object (*func) ();
1241 Lisp_Object unused; /* Dividing by 16 is faster than by 12 */
1242 };
1243
1244 extern struct specbinding *specpdl;
1245 extern struct specbinding *specpdl_ptr;
1246 extern int specpdl_size;
1247
1248 /* Everything needed to describe an active condition case. */
1249 struct handler
1250 {
1251 /* The handler clauses and variable from the condition-case form. */
1252 Lisp_Object handler;
1253 Lisp_Object var;
1254 /* Fsignal stores here the condition-case clause that applies,
1255 and Fcondition_case thus knows which clause to run. */
1256 Lisp_Object chosen_clause;
1257
1258 /* Used to effect the longjump out to the handler. */
1259 struct catchtag *tag;
1260
1261 /* The next enclosing handler. */
1262 struct handler *next;
1263 };
1264
1265 extern struct handler *handlerlist;
1266
1267 extern struct catchtag *catchlist;
1268 extern struct backtrace *backtrace_list;
1269
1270 extern Lisp_Object memory_signal_data;
1271
1272 /* An address near the bottom of the stack.
1273 Tells GC how to save a copy of the stack. */
1274 extern char *stack_bottom;
1275
1276 /* Check quit-flag and quit if it is non-nil. */
1277
1278 #define QUIT \
1279 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1280 { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
1281
1282 /* Nonzero if ought to quit now. */
1283
1284 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1285 \f
1286 /* 1 if CH is upper case. */
1287
1288 #define UPPERCASEP(CH) \
1289 (XCHAR_TABLE (current_buffer->downcase_table)->contents[CH] != (CH))
1290
1291 /* 1 if CH is lower case. */
1292
1293 #define LOWERCASEP(CH) (!UPPERCASEP (CH) && !NOCASEP(CH))
1294
1295 /* 1 if CH is neither upper nor lower case. */
1296
1297 #define NOCASEP(CH) \
1298 (XCHAR_TABLE (current_buffer->upcase_table)->contents[CH] == (CH))
1299
1300 /* Upcase a character, or make no change if that cannot be done. */
1301
1302 #define UPCASE(CH) (!UPPERCASEP (CH) ? UPCASE1 (CH) : (CH))
1303
1304 /* Upcase a character known to be not upper case. */
1305
1306 #define UPCASE1(CH) (XCHAR_TABLE (current_buffer->upcase_table)->contents[CH])
1307
1308 /* Downcase a character, or make no change if that cannot be done. */
1309
1310 #define DOWNCASE(CH) \
1311 (XCHAR_TABLE (current_buffer->downcase_table)->contents[CH])
1312
1313 /* Current buffer's map from characters to lower-case characters. */
1314
1315 #define DOWNCASE_TABLE XCHAR_TABLE (current_buffer->downcase_table)->contents
1316
1317 extern Lisp_Object Vascii_downcase_table;
1318 \f
1319 /* Number of bytes of structure consed since last GC. */
1320
1321 extern int consing_since_gc;
1322
1323 /* Threshold for doing another gc. */
1324
1325 extern int gc_cons_threshold;
1326
1327 /* Structure for recording stack slots that need marking. */
1328
1329 /* This is a chain of structures, each of which points at a Lisp_Object variable
1330 whose value should be marked in garbage collection.
1331 Normally every link of the chain is an automatic variable of a function,
1332 and its `val' points to some argument or local variable of the function.
1333 On exit to the function, the chain is set back to the value it had on entry.
1334 This way, no link remains in the chain when the stack frame containing the
1335 link disappears.
1336
1337 Every function that can call Feval must protect in this fashion all
1338 Lisp_Object variables whose contents will be used again. */
1339
1340 extern struct gcpro *gcprolist;
1341
1342 struct gcpro
1343 {
1344 struct gcpro *next;
1345 Lisp_Object *var; /* Address of first protected variable */
1346 int nvars; /* Number of consecutive protected variables */
1347 };
1348
1349 #define GCPRO1(varname) \
1350 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1351 gcprolist = &gcpro1; }
1352
1353 #define GCPRO2(varname1, varname2) \
1354 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1355 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1356 gcprolist = &gcpro2; }
1357
1358 #define GCPRO3(varname1, varname2, varname3) \
1359 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1360 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1361 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1362 gcprolist = &gcpro3; }
1363
1364 #define GCPRO4(varname1, varname2, varname3, varname4) \
1365 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1366 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1367 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1368 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1369 gcprolist = &gcpro4; }
1370
1371 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1372 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1373 gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1374 gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1375 gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1376 gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1377 gcprolist = &gcpro5; }
1378
1379 /* Call staticpro (&var) to protect static variable `var'. */
1380
1381 void staticpro();
1382
1383 #define UNGCPRO (gcprolist = gcpro1.next)
1384
1385 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
1386 #define RETURN_UNGCPRO(expr) \
1387 if (1) \
1388 { \
1389 Lisp_Object ret_ungc_val; \
1390 ret_ungc_val = (expr); \
1391 UNGCPRO; \
1392 return ret_ungc_val; \
1393 } \
1394 else
1395 \f
1396 /* Defined in data.c */
1397 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
1398 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
1399 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
1400 extern Lisp_Object Qvoid_variable, Qvoid_function;
1401 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
1402 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
1403 extern Lisp_Object Qend_of_file, Qarith_error;
1404 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
1405 extern Lisp_Object Qmark_inactive;
1406
1407 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
1408 extern Lisp_Object Qoverflow_error, Qunderflow_error;
1409
1410 extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
1411 extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
1412 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
1413 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
1414 extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
1415 extern Lisp_Object Qchar_table_p, Qvector_or_char_table_p;
1416 extern Lisp_Object Qboundp, Qfboundp;
1417 extern Lisp_Object Qbuffer_or_string_p;
1418 extern Lisp_Object Qcdr;
1419
1420 #ifdef LISP_FLOAT_TYPE
1421 extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
1422 #endif /* LISP_FLOAT_TYPE */
1423
1424 extern Lisp_Object Qframep;
1425
1426 extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
1427 extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
1428 extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
1429 extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
1430 extern Lisp_Object Finteger_or_marker_p ();
1431 #ifdef LISP_FLOAT_TYPE
1432 extern Lisp_Object Ffloatp(), Finteger_or_floatp();
1433 extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
1434 #endif /* LISP_FLOAT_TYPE */
1435
1436 extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
1437 extern Lisp_Object Fsetcar (), Fsetcdr ();
1438 extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
1439 extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
1440 extern Lisp_Object indirect_function (), Findirect_function ();
1441 extern Lisp_Object Ffset (), Fsetplist ();
1442 extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
1443 extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
1444 extern Lisp_Object Fmake_local_variable ();
1445
1446 extern Lisp_Object Faref (), Faset ();
1447
1448 extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
1449 extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq ();
1450 extern Lisp_Object Fneq (), Fzerop ();
1451 extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem ();
1452 extern Lisp_Object Fmax (), Fmin ();
1453 extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot ();
1454 extern Lisp_Object Flsh (), Fash ();
1455
1456 extern Lisp_Object Fadd1 (), Fsub1 ();
1457
1458 extern Lisp_Object long_to_cons ();
1459 extern unsigned long cons_to_long ();
1460 extern void args_out_of_range ();
1461 extern void args_out_of_range_3 ();
1462 extern Lisp_Object wrong_type_argument ();
1463 extern void store_symval_forwarding ();
1464 extern Lisp_Object do_symval_forwarding ();
1465 #ifdef LISP_FLOAT_TYPE
1466 extern Lisp_Object Ffloat_to_int(), Fint_to_float();
1467 extern double extract_float();
1468 extern Lisp_Object make_float ();
1469 extern Lisp_Object Ffloat ();
1470 #endif /* LISP_FLOAT_TYPE */
1471
1472 /* Defined in cmds.c */
1473 extern Lisp_Object Fend_of_line (), Fforward_char (), Fforward_line ();
1474
1475 /* Defined in coding.c */
1476 extern Lisp_Object Fcoding_system_p (), Fcheck_coding_system ();
1477 extern Lisp_Object Fread_coding_system (), Fread_non_nil_coding_system ();
1478
1479 /* Defined in syntax.c */
1480 extern Lisp_Object Fforward_word ();
1481
1482 /* Defined in fns.c */
1483 extern Lisp_Object Qstring_lessp;
1484 extern Lisp_Object Vfeatures;
1485 extern Lisp_Object Fidentity (), Frandom ();
1486 extern Lisp_Object Flength (), Fsafe_length ();
1487 extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
1488 extern Lisp_Object Fsubstring ();
1489 extern Lisp_Object Fnth (), Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
1490 extern Lisp_Object Felt (), Fmember (), Frassq (), Fdelq (), Fsort ();
1491 extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
1492 extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
1493 extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
1494 extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
1495 extern Lisp_Object concat2 (), nconc2 ();
1496 extern Lisp_Object assq_no_quit ();
1497 extern Lisp_Object Fcopy_alist ();
1498 extern Lisp_Object Fplist_get ();
1499 extern Lisp_Object Fset_char_table_parent ();
1500
1501 /* Defined in insdel.c */
1502 extern void move_gap ();
1503 extern void make_gap ();
1504 extern void insert ();
1505 extern void insert_and_inherit ();
1506 extern void insert_1 ();
1507 extern void insert_from_string ();
1508 extern void insert_from_buffer ();
1509 extern void insert_char ();
1510 extern void insert_string ();
1511 extern void insert_before_markers ();
1512 extern void insert_before_markers_and_inherit ();
1513 extern void insert_from_string_before_markers ();
1514 extern void del_range ();
1515 extern void del_range_1 ();
1516 extern void modify_region ();
1517 extern void prepare_to_modify_buffer ();
1518 extern void signal_before_change ();
1519 extern void signal_after_change ();
1520
1521 /* Defined in dispnew.c */
1522 extern Lisp_Object Fding (), Fredraw_display ();
1523 extern Lisp_Object Fsleep_for ();
1524
1525 /* Defined in xdisp.c */
1526 extern Lisp_Object Vmessage_log_max;
1527 extern void message ();
1528 extern void message_nolog ();
1529 extern void message1 ();
1530 extern void message1_nolog ();
1531 extern void message2 ();
1532 extern void message2_nolog ();
1533 extern void message_dolog ();
1534 extern void message_log_maybe_newline ();
1535
1536 /* Defined in alloc.c */
1537 extern Lisp_Object Vpurify_flag;
1538 extern Lisp_Object Fcons (), Flist(), Fmake_list (), allocate_misc ();
1539 extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
1540 extern Lisp_Object Fmake_string (), build_string (), make_string ();
1541 extern Lisp_Object make_event_array (), make_uninit_string ();
1542 extern Lisp_Object Fpurecopy (), make_pure_string ();
1543 extern Lisp_Object pure_cons (), make_pure_vector ();
1544 extern Lisp_Object Fgarbage_collect ();
1545 extern Lisp_Object Fmake_byte_code ();
1546 extern Lisp_Object Fmake_bool_vector (), Fmake_char_table ();
1547 extern Lisp_Object Qchar_table_extra_slots;
1548 extern struct Lisp_Vector *allocate_vectorlike ();
1549 extern int gc_in_progress;
1550
1551 /* Defined in print.c */
1552 extern Lisp_Object Vprin1_to_string_buffer;
1553 extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
1554 extern Lisp_Object Fterpri (), Fprint ();
1555 extern Lisp_Object Ferror_message_string ();
1556 extern Lisp_Object Vstandard_output, Qstandard_output;
1557 extern Lisp_Object Qexternal_debugging_output;
1558 extern void temp_output_buffer_setup (), temp_output_buffer_show ();
1559 extern int print_level, print_escape_newlines;
1560 extern Lisp_Object Qprint_escape_newlines;
1561
1562 /* Defined in lread.c */
1563 extern Lisp_Object Qvariable_documentation, Qstandard_input;
1564 extern Lisp_Object Vobarray, Vstandard_input;
1565 extern Lisp_Object Fread (), Fread_from_string ();
1566 extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
1567 extern Lisp_Object Fget_file_char (), Fread_char ();
1568 extern Lisp_Object read_filtered_event ();
1569 extern Lisp_Object Feval_current_buffer (), Feval_region ();
1570 extern Lisp_Object intern (), make_symbol (), oblookup ();
1571 #define LOADHIST_ATTACH(x) \
1572 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1573 extern Lisp_Object Vcurrent_load_list;
1574 extern Lisp_Object Vload_history;
1575
1576 /* Defined in eval.c */
1577 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
1578 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
1579 extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
1580 extern Lisp_Object Vautoload_queue;
1581 extern Lisp_Object Vdebug_on_error;
1582 /* To run a normal hook, use the appropriate function from the list below.
1583 The calling convention:
1584
1585 if (!NILP (Vrun_hooks))
1586 call1 (Vrun_hooks, Qmy_funny_hook);
1587
1588 should no longer be used. */
1589 extern Lisp_Object Vrun_hooks;
1590 extern Lisp_Object Frun_hooks (), Frun_hook_with_args ();
1591 extern Lisp_Object Frun_hook_with_args_until_success ();
1592 extern Lisp_Object Frun_hook_with_args_until_failure ();
1593 extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
1594 extern Lisp_Object Fsetq (), Fquote ();
1595 extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
1596 extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
1597 extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
1598 extern Lisp_Object Fcondition_case (), Fsignal ();
1599 extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
1600 extern Lisp_Object Feval (), Fapply (), Ffuncall ();
1601 extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
1602 extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
1603 extern Lisp_Object call4 (), call5 (), call6 ();
1604 extern Lisp_Object Fkill_emacs (), Fkey_binding (), Fsit_for ();
1605 extern Lisp_Object Fdo_auto_save (), Fset_marker ();
1606 extern Lisp_Object apply_lambda ();
1607 extern Lisp_Object internal_catch ();
1608 extern Lisp_Object internal_condition_case ();
1609 extern Lisp_Object internal_condition_case_1 ();
1610 extern Lisp_Object unbind_to ();
1611 extern void error ();
1612 extern Lisp_Object un_autoload ();
1613 extern Lisp_Object Ffetch_bytecode ();
1614
1615 /* Defined in editfns.c */
1616 extern Lisp_Object Fgoto_char ();
1617 extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
1618 extern Lisp_Object Fpoint_min (), Fpoint_max ();
1619 extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
1620 extern Lisp_Object Fline_beginning_position (), Fline_end_position ();
1621 extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
1622 extern Lisp_Object Finsert (), Finsert_and_inherit ();
1623 extern Lisp_Object Finsert_before_markers ();
1624 extern Lisp_Object Finsert_buffer_substring ();
1625 extern Lisp_Object Finsert_char ();
1626 extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
1627 extern Lisp_Object Fformat (), format1 ();
1628 extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
1629 extern Lisp_Object Fbuffer_string ();
1630 extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
1631 extern Lisp_Object save_excursion_save (), save_restriction_save ();
1632 extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
1633 extern Lisp_Object Fchar_to_string ();
1634 extern Lisp_Object Fdelete_region (), Fnarrow_to_region (), Fwiden ();
1635
1636 /* defined in buffer.c */
1637 extern Lisp_Object Foverlay_start (), Foverlay_end ();
1638 extern void adjust_overlays_for_insert ();
1639 extern void adjust_overlays_for_delete ();
1640 extern void fix_overlays_in_range ();
1641 extern int overlay_touches_p ();
1642 extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
1643 extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
1644 extern Lisp_Object Fbarf_if_buffer_read_only ();
1645 extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
1646 extern Lisp_Object Fother_buffer ();
1647 extern Lisp_Object Foverlay_get ();
1648 extern Lisp_Object Fbuffer_modified_p (), Fset_buffer_modified_p ();
1649 extern Lisp_Object Fkill_buffer (), Fkill_all_local_variables ();
1650 extern Lisp_Object Fbuffer_disable_undo (), Fbuffer_enable_undo ();
1651 extern Lisp_Object Ferase_buffer ();
1652 extern Lisp_Object Qoverlayp;
1653 extern struct buffer *all_buffers;
1654
1655 /* defined in marker.c */
1656
1657 extern Lisp_Object Fmarker_position (), Fmarker_buffer ();
1658 extern Lisp_Object Fcopy_marker ();
1659
1660 /* Defined in fileio.c */
1661
1662 extern Lisp_Object Qfile_error;
1663 extern Lisp_Object Ffind_file_name_handler ();
1664 extern Lisp_Object Ffile_name_as_directory ();
1665 extern Lisp_Object Fexpand_file_name (), Ffile_name_nondirectory ();
1666 extern Lisp_Object Fsubstitute_in_file_name ();
1667 extern Lisp_Object Ffile_symlink_p ();
1668 extern Lisp_Object Fverify_visited_file_modtime ();
1669 extern Lisp_Object Ffile_exists_p ();
1670 extern Lisp_Object Ffile_name_absolute_p ();
1671 extern Lisp_Object Fdirectory_file_name ();
1672 extern Lisp_Object Ffile_name_directory ();
1673 extern Lisp_Object expand_and_dir_to_file ();
1674 extern Lisp_Object Ffile_accessible_directory_p ();
1675 extern Lisp_Object Funhandled_file_name_directory ();
1676 extern Lisp_Object Ffile_directory_p ();
1677 extern Lisp_Object Fwrite_region ();
1678
1679 /* Defined in abbrev.c */
1680
1681 extern Lisp_Object Vfundamental_mode_abbrev_table;
1682
1683 /* defined in search.c */
1684 extern Lisp_Object Fstring_match ();
1685 extern Lisp_Object Fscan_buffer ();
1686 extern void restore_match_data ();
1687 extern Lisp_Object Fmatch_data (), Fstore_match_data ();
1688 extern Lisp_Object Fmatch_beginning (), Fmatch_end ();
1689 extern Lisp_Object Fskip_chars_forward (), Fskip_chars_backward ();
1690
1691 /* defined in minibuf.c */
1692
1693 extern Lisp_Object last_minibuf_string;
1694 extern Lisp_Object read_minibuf (), Fcompleting_read ();
1695 extern Lisp_Object Fread_from_minibuffer ();
1696 extern Lisp_Object Fread_variable (), Fread_buffer (), Fread_key_sequence ();
1697 extern Lisp_Object Fread_minibuffer (), Feval_minibuffer ();
1698 extern Lisp_Object Fread_string (), Fread_file_name ();
1699 extern Lisp_Object Fread_no_blanks_input ();
1700 extern Lisp_Object get_minibuffer ();
1701
1702 /* Defined in callint.c */
1703
1704 extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
1705 extern Lisp_Object Vcommand_history;
1706 extern Lisp_Object Qcall_interactively, Qmouse_leave_buffer_hook;
1707 extern Lisp_Object Fcall_interactively ();
1708 extern Lisp_Object Fprefix_numeric_value ();
1709
1710 /* defined in casefiddle.c */
1711
1712 extern Lisp_Object Fdowncase (), Fupcase (), Fcapitalize ();
1713 extern Lisp_Object Fupcase_region ();
1714 extern Lisp_Object Fupcase_initials (), Fupcase_initials_region ();
1715
1716 /* defined in casetab.c */
1717
1718 extern Lisp_Object Fset_case_table ();
1719 extern Lisp_Object Fset_standard_case_table ();
1720
1721 /* defined in keyboard.c */
1722
1723 extern Lisp_Object Qdisabled;
1724 extern Lisp_Object Vhelp_form, Vtop_level;
1725 extern Lisp_Object Fdiscard_input (), Frecursive_edit ();
1726 extern Lisp_Object Fcommand_execute (), Finput_pending_p ();
1727 extern Lisp_Object menu_bar_items ();
1728 extern Lisp_Object Qvertical_scroll_bar;
1729 extern Lisp_Object Fevent_convert_list ();
1730 #ifdef MULTI_KBOARD
1731 extern void delete_kboard ();
1732 #endif
1733
1734 /* defined in keymap.c */
1735
1736 extern Lisp_Object Qkeymap, Qmenu_bar;
1737 extern Lisp_Object current_global_map;
1738 extern Lisp_Object Fdefine_key ();
1739 extern Lisp_Object Fkey_description (), Fsingle_key_description ();
1740 extern Lisp_Object Fwhere_is_internal ();
1741 extern Lisp_Object access_keymap (), store_in_keymap ();
1742 extern Lisp_Object get_keyelt (), get_keymap (), get_keymap_1 ();
1743 extern void describe_map_tree ();
1744
1745 /* defined in indent.c */
1746 extern Lisp_Object Fvertical_motion (), Findent_to (), Fcurrent_column ();
1747
1748 /* defined in window.c */
1749 extern Lisp_Object Qwindowp, Qwindow_live_p;
1750 extern Lisp_Object Fselected_window ();
1751 extern Lisp_Object Fget_buffer_window ();
1752 extern Lisp_Object Fsave_window_excursion ();
1753 extern Lisp_Object Fset_window_configuration (), Fcurrent_window_configuration ();
1754 extern Lisp_Object Fcoordinates_in_window_p ();
1755 extern Lisp_Object Fwindow_at ();
1756 extern Lisp_Object Fpos_visible_in_window_p ();
1757 extern int window_internal_height (), window_internal_width ();
1758 extern Lisp_Object Frecenter ();
1759 extern Lisp_Object Fscroll_other_window ();
1760 extern Lisp_Object Fset_window_start ();
1761
1762 /* defined in frame.c */
1763 extern Lisp_Object Qvisible;
1764 extern void store_frame_param (), store_in_alist ();
1765 extern Lisp_Object do_switch_frame ();
1766 extern Lisp_Object get_frame_param();
1767 extern Lisp_Object frame_buffer_predicate ();
1768 extern Lisp_Object Fframep ();
1769 extern Lisp_Object Fselect_frame ();
1770 extern Lisp_Object Fselected_frame ();
1771 extern Lisp_Object Fwindow_frame ();
1772 extern Lisp_Object Fframe_root_window ();
1773 extern Lisp_Object Fframe_first_window ();
1774 extern Lisp_Object Fframe_selected_window ();
1775 extern Lisp_Object Fframe_list ();
1776 extern Lisp_Object Fnext_frame ();
1777 extern Lisp_Object Fdelete_frame ();
1778 extern Lisp_Object Fread_mouse_position ();
1779 extern Lisp_Object Fset_mouse_position ();
1780 extern Lisp_Object Fmake_frame_visible ();
1781 extern Lisp_Object Fmake_frame_invisible ();
1782 extern Lisp_Object Ficonify_frame ();
1783 extern Lisp_Object Fdeiconify_frame ();
1784 extern Lisp_Object Fframe_visible_p ();
1785 extern Lisp_Object Fvisible_frame_list ();
1786 extern Lisp_Object Fframe_parameters ();
1787 extern Lisp_Object Fmodify_frame_parameters ();
1788 extern Lisp_Object Fframe_pixel_size ();
1789 extern Lisp_Object Fframe_height ();
1790 extern Lisp_Object Fframe_width ();
1791 extern Lisp_Object Fset_frame_height ();
1792 extern Lisp_Object Fset_frame_width ();
1793 extern Lisp_Object Fset_frame_size ();
1794 extern Lisp_Object Fset_frame_position ();
1795 extern Lisp_Object Fraise_frame ();
1796 extern Lisp_Object Fredirect_frame_focus ();
1797
1798 /* defined in emacs.c */
1799 extern Lisp_Object decode_env_path ();
1800 extern Lisp_Object Vinvocation_name, Vinvocation_directory;
1801 extern Lisp_Object Vinstallation_directory;
1802 void shut_down_emacs ( /* int signal, int no_x, Lisp_Object stuff */ );
1803 /* Nonzero means don't do interactive redisplay and don't change tty modes */
1804 extern int noninteractive;
1805 /* Nonzero means don't do use window-system-specific display code */
1806 extern int inhibit_window_system;
1807 /* Nonzero means that a filter or a sentinel is running. */
1808 extern int running_asynch_code;
1809
1810 /* defined in process.c */
1811 extern Lisp_Object Fget_process (), Fget_buffer_process (), Fprocessp ();
1812 extern Lisp_Object Fprocess_status (), Fkill_process ();
1813 extern Lisp_Object Fprocess_send_eof ();
1814 extern Lisp_Object Fwaiting_for_user_input_p ();
1815 extern Lisp_Object Qprocessp;
1816
1817 /* defined in callproc.c */
1818 extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
1819 extern Lisp_Object Vdoc_directory;
1820
1821 /* defined in doc.c */
1822 extern Lisp_Object Vdoc_file_name;
1823 extern Lisp_Object Fsubstitute_command_keys ();
1824 extern Lisp_Object Fdocumentation (), Fdocumentation_property ();
1825 extern Lisp_Object read_doc_string ();
1826
1827 /* defined in bytecode.c */
1828 extern Lisp_Object Qbytecode;
1829 extern Lisp_Object Fbyte_code ();
1830
1831 /* defined in macros.c */
1832 extern Lisp_Object Qexecute_kbd_macro;
1833 extern Lisp_Object Fexecute_kbd_macro ();
1834
1835 /* defined in undo.c */
1836 extern Lisp_Object Qinhibit_read_only;
1837 extern Lisp_Object Fundo_boundary ();
1838 extern Lisp_Object truncate_undo_list ();
1839
1840 /* defined in textprop.c */
1841 extern Lisp_Object Qmodification_hooks;
1842 extern Lisp_Object Qrear_nonsticky, Qfont;
1843 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
1844 extern Lisp_Object Fnext_property_change ();
1845 extern Lisp_Object Fnext_single_property_change ();
1846 extern Lisp_Object Fprevious_single_property_change ();
1847 extern Lisp_Object Fget_text_property (), Fput_text_property ();
1848 extern Lisp_Object Fset_text_properties ();
1849 extern Lisp_Object Ftext_property_not_all ();
1850
1851 /* defined in intervals.c */
1852 extern Lisp_Object get_local_map ();
1853
1854 /* defined in xmenu.c */
1855 extern Lisp_Object Fx_popup_menu (), Fx_popup_dialog ();
1856 \f
1857 /* Nonzero means Emacs has already been initialized.
1858 Used during startup to detect startup of dumped Emacs. */
1859 extern int initialized;
1860
1861 extern int immediate_quit; /* Nonzero means ^G can quit instantly */
1862
1863 extern void debugger ();
1864
1865 extern char *getenv (), *ctime (), *getwd ();
1866 extern long *xmalloc (), *xrealloc ();
1867 extern void xfree ();
1868
1869 extern char *egetenv ();
1870
1871 /* Set up the name of the machine we're running on. */
1872 extern void init_system_name ();
1873
1874 /* Some systems (e.g., NT) use a different path separator than Unix,
1875 in addition to a device separator. Default the path separator
1876 to '/', and don't test for a device separator in IS_ANY_SEP. */
1877
1878 #ifdef WINDOWSNT
1879 extern Lisp_Object Vdirectory_sep_char;
1880 #endif
1881
1882 #ifndef DIRECTORY_SEP
1883 #define DIRECTORY_SEP '/'
1884 #endif
1885 #ifndef IS_DIRECTORY_SEP
1886 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
1887 #endif
1888 #ifndef IS_DEVICE_SEP
1889 #ifndef DEVICE_SEP
1890 #define IS_DEVICE_SEP(_c_) 0
1891 #else
1892 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
1893 #endif
1894 #endif
1895 #ifndef IS_ANY_SEP
1896 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
1897 #endif
1898
1899 #ifdef SWITCH_ENUM_BUG
1900 #define SWITCH_ENUM_CAST(x) ((int)(x))
1901 #else
1902 #define SWITCH_ENUM_CAST(x) (x)
1903 #endif