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