XEmacs 21.2.32 "Kastor & Polydeukes".
[chise/xemacs-chise.git.1] / src / lisp.h
1 /* Fundamental definitions for XEmacs Lisp interpreter.
2    Copyright (C) 1985-1987, 1992-1995 Free Software Foundation, Inc.
3    Copyright (C) 1993-1996 Richard Mlynarik.
4    Copyright (C) 1995, 1996 Ben Wing.
5
6 This file is part of XEmacs.
7
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
11 later version.
12
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING.  If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA.  */
22
23 /* Synched up with: FSF 19.30. */
24
25 #ifndef INCLUDED_lisp_h_
26 #define INCLUDED_lisp_h_
27
28 /************************************************************************/
29 /*                        general definitions                           */
30 /************************************************************************/
31
32 /* We include the following generally useful header files so that you
33    don't have to worry about prototypes when using the standard C
34    library functions and macros.  These files shouldn't be excessively
35    large so they shouldn't cause that much of a slowdown. */
36
37 #include <stdlib.h>
38 #include <string.h>             /* primarily for memcpy, etc. */
39 #include <stdio.h>              /* NULL, etc. */
40 #include <ctype.h>
41 #include <stdarg.h>
42 #include <stddef.h>             /* offsetof */
43 #include <sys/types.h>
44
45 /* ---- Dynamic arrays ---- */
46
47 #define Dynarr_declare(type)    \
48   type *base;                   \
49   int elsize;                   \
50   int cur;                      \
51   int largest;                  \
52   int max
53
54 typedef struct dynarr
55 {
56   Dynarr_declare (void);
57 } Dynarr;
58
59 void *Dynarr_newf (int elsize);
60 void Dynarr_resize (void *dy, int size);
61 void Dynarr_insert_many (void *d, const void *el, int len, int start);
62 void Dynarr_delete_many (void *d, int start, int len);
63 void Dynarr_free (void *d);
64
65 #define Dynarr_new(type) ((type##_dynarr *) Dynarr_newf (sizeof (type)))
66 #define Dynarr_at(d, pos) ((d)->base[pos])
67 #define Dynarr_atp(d, pos) (&Dynarr_at (d, pos))
68 #define Dynarr_length(d) ((d)->cur)
69 #define Dynarr_largest(d) ((d)->largest)
70 #define Dynarr_reset(d) ((d)->cur = 0)
71 #define Dynarr_add_many(d, el, len) Dynarr_insert_many (d, el, len, (d)->cur)
72 #define Dynarr_insert_many_at_start(d, el, len) \
73   Dynarr_insert_many (d, el, len, 0)
74 #define Dynarr_add_literal_string(d, s) Dynarr_add_many (d, s, sizeof (s) - 1)
75 #define Dynarr_add_lisp_string(d, s) do {               \
76   Lisp_String *dyna_ls_s = XSTRING (s);                 \
77   Dynarr_add_many (d, (char *) string_data (dyna_ls_s), \
78                    string_length (dyna_ls_s));          \
79 } while (0)
80
81 #define Dynarr_add(d, el) (                                             \
82   (d)->cur >= (d)->max ? Dynarr_resize ((d), (d)->cur+1) : (void) 0,    \
83   ((d)->base)[(d)->cur++] = (el),                                       \
84   (d)->cur > (d)->largest ? (d)->largest = (d)->cur : (int) 0)
85
86 /* The following defines will get you into real trouble if you aren't
87    careful.  But they can save a lot of execution time when used wisely. */
88 #define Dynarr_increment(d) ((d)->cur++)
89 #define Dynarr_set_size(d, n) ((d)->cur = n)
90
91 #ifdef MEMORY_USAGE_STATS
92 struct overhead_stats;
93 size_t Dynarr_memory_usage (void *d, struct overhead_stats *stats);
94 #endif
95
96 #include "symsinit.h"           /* compiler warning suppression */
97
98 /* Also define min() and max(). (Some compilers put them in strange
99    places that won't be referenced by the above include files, such
100    as 'macros.h' under Solaris.) */
101
102 #ifndef min
103 #define min(a,b) (((a) <= (b)) ? (a) : (b))
104 #endif
105 #ifndef max
106 #define max(a,b) (((a) > (b)) ? (a) : (b))
107 #endif
108
109 /* Memory allocation */
110 void malloc_warning (const char *);
111 void *xmalloc (size_t size);
112 void *xmalloc_and_zero (size_t size);
113 void *xrealloc (void *, size_t size);
114 char *xstrdup (const char *);
115 /* generally useful */
116 #define countof(x) ((int) (sizeof(x)/sizeof((x)[0])))
117 #define xnew(type) ((type *) xmalloc (sizeof (type)))
118 #define xnew_array(type, len) ((type *) xmalloc ((len) * sizeof (type)))
119 #define xnew_and_zero(type) ((type *) xmalloc_and_zero (sizeof (type)))
120 #define xzero(lvalue) ((void) memset (&(lvalue), '\0', sizeof (lvalue)))
121 #define xnew_array_and_zero(type, len) ((type *) xmalloc_and_zero ((len) * sizeof (type)))
122 #define XREALLOC_ARRAY(ptr, type, len) ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
123 #define alloca_array(type, len) ((type *) alloca ((len) * sizeof (type)))
124
125 /* also generally useful if you want to avoid arbitrary size limits
126    but don't need a full dynamic array.  Assumes that BASEVAR points
127    to a malloced array of TYPE objects (or possibly a NULL pointer,
128    if SIZEVAR is 0), with the total size stored in SIZEVAR.  This
129    macro will realloc BASEVAR as necessary so that it can hold at
130    least NEEDED_SIZE objects.  The reallocing is done by doubling,
131    which ensures constant amortized time per element. */
132 #define DO_REALLOC(basevar, sizevar, needed_size, type) do {    \
133   size_t do_realloc_needed_size = (needed_size);                \
134   if ((sizevar) < do_realloc_needed_size)                       \
135     {                                                           \
136       if ((sizevar) < 32)                                       \
137         (sizevar) = 32;                                         \
138       while ((sizevar) < do_realloc_needed_size)                \
139         (sizevar) *= 2;                                         \
140       XREALLOC_ARRAY (basevar, type, (sizevar));                \
141     }                                                           \
142 } while (0)
143
144 #ifdef ERROR_CHECK_MALLOC
145 void xfree_1 (void *);
146 #define xfree(lvalue) do                        \
147 {                                               \
148   void **xfree_ptr = (void **) &(lvalue);       \
149   xfree_1 (*xfree_ptr);                         \
150   *xfree_ptr = (void *) 0xDEADBEEF;             \
151 } while (0)
152 #else
153 void xfree (void *);
154 #endif /* ERROR_CHECK_MALLOC */
155
156 #ifndef PRINTF_ARGS
157 # if defined (__GNUC__) && (__GNUC__ >= 2)
158 #  define PRINTF_ARGS(string_index,first_to_check) \
159           __attribute__ ((format (printf, string_index, first_to_check)))
160 # else
161 #  define PRINTF_ARGS(string_index,first_to_check)
162 # endif /* GNUC */
163 #endif
164
165 #ifndef DOESNT_RETURN
166 # if defined __GNUC__
167 #  if ((__GNUC__ > 2) || (__GNUC__ == 2) && (__GNUC_MINOR__ >= 5))
168 #   define DOESNT_RETURN void volatile
169 #   define DECLARE_DOESNT_RETURN(decl) \
170            extern void volatile decl __attribute__ ((noreturn))
171 #   define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
172      /* Should be able to state multiple independent __attribute__s, but  \
173         the losing syntax doesn't work that way, and screws losing cpp */ \
174            extern void volatile decl \
175                   __attribute__ ((noreturn, format (printf, str, idx)))
176 #  else
177 #   define DOESNT_RETURN void volatile
178 #   define DECLARE_DOESNT_RETURN(decl) extern void volatile decl
179 #   define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
180            extern void volatile decl PRINTF_ARGS(str,idx)
181 #  endif /* GNUC 2.5 */
182 # else
183 #  define DOESNT_RETURN void
184 #  define DECLARE_DOESNT_RETURN(decl) extern void decl
185 #  define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
186           extern void decl PRINTF_ARGS(str,idx)
187 # endif /* GNUC */
188 #endif
189
190 #ifndef ALIGNOF
191 # if defined (__GNUC__) && (__GNUC__ >= 2)
192 #  define ALIGNOF(x) __alignof__ (x)
193 # else
194 #  define ALIGNOF(x) sizeof (x)
195 # endif
196 #endif
197
198 #define ALIGN_SIZE(len, unit) \
199   ((((len) + (unit) - 1) / (unit)) * (unit))
200
201 /* #### Yuck, this is kind of evil */
202 #define ALIGN_PTR(ptr, unit) \
203   ((void *) ALIGN_SIZE ((long) (ptr), unit))
204
205 #ifndef DO_NOTHING
206 #define DO_NOTHING do {} while (0)
207 #endif
208
209 #ifndef DECLARE_NOTHING
210 #define DECLARE_NOTHING struct nosuchstruct
211 #endif
212
213 /* We define assert iff USE_ASSERTIONS or DEBUG_XEMACS is defined.
214    Otherwise we define it to be empty.  Quantify has shown that the
215    time the assert checks take is measurable so let's not include them
216    in production binaries. */
217
218 #ifdef USE_ASSERTIONS
219 /* Highly dubious kludge */
220 /*   (thanks, Jamie, I feel better now -- ben) */
221 DECLARE_DOESNT_RETURN (assert_failed (const char *, int, const char *));
222 # define abort() (assert_failed (__FILE__, __LINE__, "abort()"))
223 # define assert(x) ((x) ? (void) 0 : assert_failed (__FILE__, __LINE__, #x))
224 #else
225 # ifdef DEBUG_XEMACS
226 #  define assert(x) ((x) ? (void) 0 : (void) abort ())
227 # else
228 #  define assert(x)
229 # endif
230 #endif
231
232 /*#ifdef DEBUG_XEMACS*/
233 #define REGISTER
234 #define register
235 /*#else*/
236 /*#define REGISTER register*/
237 /*#endif*/
238
239
240 /* EMACS_INT is the underlying integral type into which a Lisp_Object must fit.
241    In particular, it must be large enough to contain a pointer.
242    config.h can override this, e.g. to use `long long' for bigger lisp ints. */
243
244 #ifndef SIZEOF_EMACS_INT
245 # define SIZEOF_EMACS_INT SIZEOF_VOID_P
246 #endif
247
248 #ifndef EMACS_INT
249 # if   SIZEOF_EMACS_INT == SIZEOF_LONG
250 #  define EMACS_INT long
251 # elif SIZEOF_EMACS_INT == SIZEOF_INT
252 #  define EMACS_INT int
253 # elif SIZEOF_EMACS_INT == SIZEOF_LONG_LONG
254 #  define EMACS_INT long long
255 # else
256 #  error Unable to determine suitable type for EMACS_INT
257 # endif
258 #endif
259
260 #ifndef EMACS_UINT
261 # define EMACS_UINT unsigned EMACS_INT
262 #endif
263
264 #define BITS_PER_EMACS_INT (SIZEOF_EMACS_INT * BITS_PER_CHAR)
265
266 \f
267 /************************************************************************/
268 /*                                typedefs                              */
269 /************************************************************************/
270
271 /* We put typedefs here so that prototype declarations don't choke.
272    Note that we don't actually declare the structures here (except
273    maybe for simple structures like Dynarrs); that keeps them private
274    to the routines that actually use them. */
275
276 /* The data representing the text in a buffer is logically a set
277    of Bufbytes, declared as follows. */
278
279 typedef unsigned char Bufbyte;
280
281 /* The data representing a string in "external" format (simple
282    binary format) is logically a set of Extbytes, declared as follows. */
283
284 typedef unsigned char Extbyte;
285
286 /* To the user, a buffer is made up of characters, declared as follows.
287    In the non-Mule world, characters and Bufbytes are equivalent.
288    In the Mule world, a character requires (typically) 1 to 4
289    Bufbytes for its representation in a buffer. */
290
291 typedef int Emchar;
292
293 /* Different ways of referring to a position in a buffer.  We use
294    the typedefs in preference to 'int' to make it clearer what
295    sort of position is being used.  See extents.c for a description
296    of the different positions.  We put them here instead of in
297    buffer.h (where they rightfully belong) to avoid syntax errors
298    in function prototypes. */
299
300 typedef EMACS_INT Bufpos;
301 typedef EMACS_INT Bytind;
302 typedef EMACS_INT Memind;
303
304 /* Counts of bytes or chars */
305
306 typedef EMACS_INT Bytecount;
307 typedef EMACS_INT Charcount;
308
309 /* Length in bytes of a string in external format */
310 typedef EMACS_INT Extcount;
311
312 typedef struct lstream Lstream;
313
314 typedef unsigned int face_index;
315
316 typedef struct
317 {
318   Dynarr_declare (struct face_cachel);
319 } face_cachel_dynarr;
320
321 typedef unsigned int glyph_index;
322
323 /* This is shared by process.h, events.h and others in future.
324    See events.h for description */
325 typedef unsigned int USID;
326
327 typedef struct
328 {
329   Dynarr_declare (struct glyph_cachel);
330 } glyph_cachel_dynarr;
331
332 struct buffer;                  /* "buffer.h" */
333 struct console;                 /* "console.h" */
334 struct device;                  /* "device.h" */
335 struct extent_fragment;
336 struct extent;
337 typedef struct extent *EXTENT;
338 struct frame;                   /* "frame.h" */
339 struct window;                  /* "window.h" */
340 typedef struct Lisp_Event Lisp_Event; /* "events.h" */
341 typedef struct Lisp_Face Lisp_Face;   /* "faces.h" */
342 typedef struct Lisp_Process Lisp_Process; /* "procimpl.h" */
343 struct stat;                    /* <sys/stat.h> */
344 typedef struct Lisp_Color_Instance Lisp_Color_Instance;
345 typedef struct Lisp_Font_Instance Lisp_Font_Instance;
346 typedef struct Lisp_Image_Instance Lisp_Image_Instance;
347 typedef struct Lisp_Gui_Item Lisp_Gui_Item;
348 struct display_line;
349 struct display_glyph_area;
350 struct display_box;
351 struct redisplay_info;
352 struct window_mirror;
353 struct scrollbar_instance;
354 struct font_metric_info;
355 struct face_cachel;
356 struct console_type_entry;
357
358 typedef struct
359 {
360   Dynarr_declare (Bufbyte);
361 } Bufbyte_dynarr;
362
363 typedef struct
364 {
365   Dynarr_declare (Extbyte);
366 } Extbyte_dynarr;
367
368 typedef struct
369 {
370   Dynarr_declare (Emchar);
371 } Emchar_dynarr;
372
373 typedef struct
374 {
375   Dynarr_declare (char);
376 } char_dynarr;
377
378 typedef unsigned char unsigned_char;
379 typedef struct
380 {
381   Dynarr_declare (unsigned char);
382 } unsigned_char_dynarr;
383
384 typedef unsigned long unsigned_long;
385 typedef struct
386 {
387   Dynarr_declare (unsigned long);
388 } unsigned_long_dynarr;
389
390 typedef struct
391 {
392   Dynarr_declare (int);
393 } int_dynarr;
394
395 typedef struct
396 {
397   Dynarr_declare (Bufpos);
398 } Bufpos_dynarr;
399
400 typedef struct
401 {
402   Dynarr_declare (Bytind);
403 } Bytind_dynarr;
404
405 typedef struct
406 {
407   Dynarr_declare (Charcount);
408 } Charcount_dynarr;
409
410 typedef struct
411 {
412   Dynarr_declare (Bytecount);
413 } Bytecount_dynarr;
414
415 typedef struct
416 {
417   Dynarr_declare (struct console_type_entry);
418 } console_type_entry_dynarr;
419
420 enum run_hooks_condition
421 {
422   RUN_HOOKS_TO_COMPLETION,
423   RUN_HOOKS_UNTIL_SUCCESS,
424   RUN_HOOKS_UNTIL_FAILURE
425 };
426
427 #ifdef HAVE_TOOLBARS
428 enum toolbar_pos
429 {
430   TOP_TOOLBAR,
431   BOTTOM_TOOLBAR,
432   LEFT_TOOLBAR,
433   RIGHT_TOOLBAR
434 };
435 #endif
436
437 enum edge_style
438 {
439   EDGE_ETCHED_IN,
440   EDGE_ETCHED_OUT,
441   EDGE_BEVEL_IN,
442   EDGE_BEVEL_OUT
443 };
444
445 #ifndef ERROR_CHECK_TYPECHECK
446
447 typedef enum error_behavior
448 {
449   ERROR_ME,
450   ERROR_ME_NOT,
451   ERROR_ME_WARN
452 } Error_behavior;
453
454 #define ERRB_EQ(a, b) ((a) == (b))
455
456 #else
457
458 /* By defining it like this, we provide strict type-checking
459    for code that lazily uses ints. */
460
461 typedef struct _error_behavior_struct_
462 {
463   int really_unlikely_name_to_have_accidentally_in_a_non_errb_structure;
464 } Error_behavior;
465
466 extern Error_behavior ERROR_ME;
467 extern Error_behavior ERROR_ME_NOT;
468 extern Error_behavior ERROR_ME_WARN;
469
470 #define ERRB_EQ(a, b)                                                      \
471  ((a).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure == \
472   (b).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure)
473
474 #endif
475
476 enum munge_me_out_the_door
477 {
478   MUNGE_ME_FUNCTION_KEY,
479   MUNGE_ME_KEY_TRANSLATION
480 };
481
482 \f
483 /************************************************************************/
484 /*                   Definition of Lisp_Object data type                */
485 /************************************************************************/
486
487 /* Define the fundamental Lisp data structures */
488
489 /* This is the set of Lisp data types */
490
491 enum Lisp_Type
492 {
493   Lisp_Type_Record,
494   Lisp_Type_Int_Even,
495   Lisp_Type_Char,
496   Lisp_Type_Int_Odd
497 };
498
499 #define POINTER_TYPE_P(type) ((type) == Lisp_Type_Record)
500
501 /* Overridden by m/next.h */
502 #ifndef ASSERT_VALID_POINTER
503 # define ASSERT_VALID_POINTER(pnt) (assert ((((EMACS_UINT) pnt) & 3) == 0))
504 #endif
505
506 #define GCMARKBITS  0
507 #define GCTYPEBITS  2
508 #define GCBITS      2
509 #define INT_GCBITS  1
510
511 #define INT_VALBITS (BITS_PER_EMACS_INT - INT_GCBITS)
512 #define VALBITS (BITS_PER_EMACS_INT - GCBITS)
513 #define EMACS_INT_MAX ((EMACS_INT) ((1UL << INT_VALBITS) -1UL))
514 #define EMACS_INT_MIN (-(EMACS_INT_MAX) - 1)
515
516 #ifdef USE_UNION_TYPE
517 # include "lisp-union.h"
518 #else /* !USE_UNION_TYPE */
519 # include "lisp-disunion.h"
520 #endif /* !USE_UNION_TYPE */
521
522 #define XPNTR(x) ((void *) XPNTRVAL(x))
523
524 /* WARNING WARNING WARNING.  You must ensure on your own that proper
525    GC protection is provided for the elements in this array. */
526 typedef struct
527 {
528   Dynarr_declare (Lisp_Object);
529 } Lisp_Object_dynarr;
530
531 /* Close your eyes now lest you vomit or spontaneously combust ... */
532
533 #define HACKEQ_UNSAFE(obj1, obj2)                               \
534   (EQ (obj1, obj2) || (!POINTER_TYPE_P (XTYPE (obj1))           \
535                        && !POINTER_TYPE_P (XTYPE (obj2))        \
536                        && XCHAR_OR_INT (obj1) == XCHAR_OR_INT (obj2)))
537
538 #ifdef DEBUG_XEMACS
539 extern int debug_issue_ebola_notices;
540 int eq_with_ebola_notice (Lisp_Object, Lisp_Object);
541 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2)                                \
542   (debug_issue_ebola_notices ? eq_with_ebola_notice (obj1, obj2)        \
543    : EQ (obj1, obj2))
544 #else
545 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2) EQ (obj1, obj2)
546 #endif
547
548 /* OK, you can open them again */
549
550 \f
551 /************************************************************************/
552 /*                   Definitions of basic Lisp objects                  */
553 /************************************************************************/
554
555 #include "lrecord.h"
556
557 /*********** unbound ***********/
558
559 /* Qunbound is a special Lisp_Object (actually of type
560    symbol-value-forward), that can never be visible to
561    the Lisp caller and thus can be used in the C code
562    to mean "no such value". */
563
564 #define UNBOUNDP(val) EQ (val, Qunbound)
565
566 /*********** cons ***********/
567
568 /* In a cons, the markbit of the car is the gc mark bit */
569
570 struct Lisp_Cons
571 {
572   struct lrecord_header lheader;
573   Lisp_Object car, cdr;
574 };
575 typedef struct Lisp_Cons Lisp_Cons;
576
577 #if 0 /* FSFmacs */
578 /* Like a cons, but records info on where the text lives that it was read from */
579 /* This is not really in use now */
580
581 struct Lisp_Buffer_Cons
582 {
583   Lisp_Object car, cdr;
584   struct buffer *buffer;
585   int bufpos;
586 };
587 #endif
588
589 DECLARE_LRECORD (cons, Lisp_Cons);
590 #define XCONS(x) XRECORD (x, cons, Lisp_Cons)
591 #define XSETCONS(x, p) XSETRECORD (x, p, cons)
592 #define CONSP(x) RECORDP (x, cons)
593 #define CHECK_CONS(x) CHECK_RECORD (x, cons)
594 #define CONCHECK_CONS(x) CONCHECK_RECORD (x, cons)
595
596 #define CONS_MARKED_P(c) MARKED_RECORD_HEADER_P(&((c)->lheader))
597 #define MARK_CONS(c) MARK_RECORD_HEADER (&((c)->lheader))
598
599 extern Lisp_Object Qnil;
600
601 #define NILP(x)  EQ (x, Qnil)
602 #define XCAR(a) (XCONS (a)->car)
603 #define XCDR(a) (XCONS (a)->cdr)
604 #define LISTP(x) (CONSP(x) || NILP(x))
605
606 #define CHECK_LIST(x) do {                      \
607   if (!LISTP (x))                               \
608     dead_wrong_type_argument (Qlistp, x);       \
609 } while (0)
610
611 #define CONCHECK_LIST(x) do {                   \
612   if (!LISTP (x))                               \
613     x = wrong_type_argument (Qlistp, x);        \
614 } while (0)
615
616 /* For a list that's known to be in valid list format --
617    will abort() if the list is not in valid format */
618 #define LIST_LOOP(tail, list)           \
619   for (tail = list;                     \
620        !NILP (tail);                    \
621        tail = XCDR (tail))
622
623 #define LIST_LOOP_2(elt, list)          \
624   Lisp_Object tail##elt;                \
625   LIST_LOOP_3(elt, list, tail##elt)
626
627 #define LIST_LOOP_3(elt, list, tail)    \
628   for (tail = list;                     \
629        NILP (tail) ?                    \
630          0 : (elt = XCAR (tail), 1);    \
631        tail = XCDR (tail))
632
633 #define GET_LIST_LENGTH(list, len) do {         \
634   Lisp_Object GLL_tail;                         \
635   for (GLL_tail = list, len = 0;                \
636        !NILP (GLL_tail);                        \
637        GLL_tail = XCDR (GLL_tail), ++len)       \
638     DO_NOTHING;                                 \
639 } while (0)
640
641 #define GET_EXTERNAL_LIST_LENGTH(list, len)             \
642 do {                                                    \
643   Lisp_Object GELL_elt, GELL_tail;                      \
644   EXTERNAL_LIST_LOOP_4 (GELL_elt, list, GELL_tail, len) \
645     ;                                                   \
646 } while (0)
647
648 /* For a list that's known to be in valid list format, where we may
649    be deleting the current element out of the list --
650    will abort() if the list is not in valid format */
651 #define LIST_LOOP_DELETING(consvar, nextconsvar, list)          \
652   for (consvar = list;                                          \
653        !NILP (consvar) ? (nextconsvar = XCDR (consvar), 1) :0;  \
654        consvar = nextconsvar)
655
656 /* Delete all elements of external list LIST
657    satisfying CONDITION, an expression referring to variable ELT */
658 #define EXTERNAL_LIST_LOOP_DELETE_IF(elt, list, condition) do { \
659   Lisp_Object prev_tail_##list = Qnil;                          \
660   Lisp_Object tail_##list;                                      \
661   EMACS_INT len_##list;                                         \
662   EXTERNAL_LIST_LOOP_4 (elt, list, tail_##list, len_##list)     \
663     {                                                           \
664       if (condition)                                            \
665         {                                                       \
666           if (NILP (prev_tail_##list))                          \
667             list = XCDR (tail_##list);                          \
668           else                                                  \
669             XCDR (prev_tail_##list) = XCDR (tail_##list);       \
670           /* Keep tortoise from ever passing hare. */           \
671           len_##list = 0;                                       \
672         }                                                       \
673       else                                                      \
674         prev_tail_##list = tail_##list;                         \
675     }                                                           \
676 } while (0)
677
678 /* Delete all elements of true non-circular list LIST
679    satisfying CONDITION, an expression referring to variable ELT */
680 #define LIST_LOOP_DELETE_IF(elt, list, condition) do {          \
681   Lisp_Object prev_tail_##list = Qnil;                          \
682   Lisp_Object tail_##list;                                      \
683   LIST_LOOP_3 (elt, list, tail_##list)                          \
684     {                                                           \
685       if (condition)                                            \
686         {                                                       \
687           if (NILP (prev_tail_##list))                          \
688             list = XCDR (tail_##list);                          \
689           else                                                  \
690             XCDR (prev_tail_##list) = XCDR (tail_##list);       \
691         }                                                       \
692       else                                                      \
693         prev_tail_##list = tail_##list;                         \
694     }                                                           \
695 } while (0)
696
697 /* For a list that may not be in valid list format --
698    will signal an error if the list is not in valid format */
699 #define EXTERNAL_LIST_LOOP(tail, list)                  \
700   for (tail = list; !NILP (tail); tail = XCDR (tail))   \
701      if (!CONSP (tail))                                 \
702        signal_malformed_list_error (list);              \
703      else
704
705
706 /* The following macros are for traversing lisp lists.
707    Signal an error if LIST is not properly acyclic and nil-terminated.
708
709    Use tortoise/hare algorithm to check for cycles, but only if it
710    looks like the list is getting too long.  Not only is the hare
711    faster than the tortoise; it even gets a head start! */
712
713 /* Optimized and safe macros for looping over external lists.  */
714 #define CIRCULAR_LIST_SUSPICION_LENGTH 1024
715
716 #define EXTERNAL_LIST_LOOP_1(list)                                      \
717 Lisp_Object ELL1_elt, ELL1_hare, ELL1_tortoise;                         \
718 EMACS_INT ELL1_len;                                                     \
719 EXTERNAL_LIST_LOOP_6 (ELL1_elt, list, ELL1_len, ELL1_hare,              \
720                       ELL1_tortoise, CIRCULAR_LIST_SUSPICION_LENGTH)
721
722 #define EXTERNAL_LIST_LOOP_2(elt, list)                                 \
723 Lisp_Object hare_##elt, tortoise_##elt;                                 \
724 EMACS_INT len_##elt;                                                    \
725 EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt,                 \
726                       tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
727
728 #define EXTERNAL_LIST_LOOP_3(elt, list, tail)                           \
729 Lisp_Object tortoise_##elt;                                             \
730 EMACS_INT len_##elt;                                                    \
731 EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, tail,                       \
732                       tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
733
734 #define EXTERNAL_LIST_LOOP_4(elt, list, tail, len)                      \
735 Lisp_Object tortoise_##elt;                                             \
736 EXTERNAL_LIST_LOOP_6 (elt, list, len, tail,                             \
737                       tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
738
739
740 #define EXTERNAL_LIST_LOOP_6(elt, list, len, hare,              \
741                              tortoise, suspicion_length)        \
742   for (tortoise = hare = list, len = 0;                         \
743                                                                 \
744        (CONSP (hare) ? ((elt = XCAR (hare)), 1) :               \
745         (NILP (hare) ? 0 :                                      \
746          (signal_malformed_list_error (list), 0)));             \
747                                                                 \
748        hare = XCDR (hare),                                      \
749          ((++len < suspicion_length) ?                          \
750           ((void) 0) :                                          \
751           (((len & 1) ?                                         \
752             ((void) (tortoise = XCDR (tortoise))) :             \
753             ((void) 0))                                         \
754            ,                                                    \
755            (EQ (hare, tortoise) ?                               \
756             ((void) signal_circular_list_error (list)) :        \
757             ((void) 0)))))
758
759
760
761 /* Optimized and safe macros for looping over external alists. */
762 #define EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, list)      \
763 Lisp_Object hare_##elt, tortoise_##elt;                         \
764 EMACS_INT len_##elt;                                            \
765 EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,             \
766                        len_##elt, hare_##elt, tortoise_##elt,   \
767                        CIRCULAR_LIST_SUSPICION_LENGTH)
768
769 #define EXTERNAL_ALIST_LOOP_5(elt, elt_car, elt_cdr, list, tail)        \
770 Lisp_Object tortoise_##elt;                                             \
771 EMACS_INT len_##elt;                                                    \
772 EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,                     \
773                        len_##elt, tail, tortoise_##elt,                 \
774                        CIRCULAR_LIST_SUSPICION_LENGTH)                  \
775
776 #define EXTERNAL_ALIST_LOOP_6(elt, elt_car, elt_cdr, list, tail, len)   \
777 Lisp_Object tortoise_##elt;                                             \
778 EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list,                     \
779                        len, tail, tortoise_##elt,                       \
780                        CIRCULAR_LIST_SUSPICION_LENGTH)
781
782
783 #define EXTERNAL_ALIST_LOOP_8(elt, elt_car, elt_cdr, list, len, hare,   \
784                              tortoise, suspicion_length)                \
785 EXTERNAL_LIST_LOOP_6 (elt, list, len, hare, tortoise, suspicion_length) \
786   if (CONSP (elt) ? (elt_car = XCAR (elt), elt_cdr = XCDR (elt), 0) :1) \
787     continue;                                                           \
788   else
789
790
791 /* Optimized and safe macros for looping over external property lists. */
792 #define EXTERNAL_PROPERTY_LIST_LOOP_3(key, value, list)                 \
793 Lisp_Object key, value, hare_##key, tortoise_##key;                     \
794 EMACS_INT len_##key;                                                    \
795 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, hare_##key, \
796                      tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
797
798 #define EXTERNAL_PROPERTY_LIST_LOOP_4(key, value, list, tail)           \
799 Lisp_Object key, value, tail, tortoise_##key;                           \
800 EMACS_INT len_##key;                                                    \
801 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, tail,       \
802                      tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
803
804 #define EXTERNAL_PROPERTY_LIST_LOOP_5(key, value, list, tail, len)      \
805 Lisp_Object key, value, tail, tortoise_##key;                           \
806 EMACS_INT len;                                                          \
807 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail,             \
808                      tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
809
810
811 #define EXTERNAL_PROPERTY_LIST_LOOP_7(key, value, list, len, hare,      \
812                              tortoise, suspicion_length)                \
813   for (tortoise = hare = list, len = 0;                                 \
814                                                                         \
815        ((CONSP (hare) &&                                                \
816          (key = XCAR (hare),                                            \
817           hare = XCDR (hare),                                           \
818           CONSP (hare))) ?                                              \
819         (value = XCAR (hare), 1) :                                      \
820         (NILP (hare) ? 0 :                                              \
821          (signal_malformed_property_list_error (list), 0)));            \
822                                                                         \
823        hare = XCDR (hare),                                              \
824          ((++len < suspicion_length) ?                                  \
825           ((void) 0) :                                                  \
826           (((len & 1) ?                                                 \
827             ((void) (tortoise = XCDR (XCDR (tortoise)))) :              \
828             ((void) 0))                                                 \
829            ,                                                            \
830            (EQ (hare, tortoise) ?                                       \
831             ((void) signal_circular_property_list_error (list)) :       \
832             ((void) 0)))))
833
834 /* For a property list (alternating keywords/values) that may not be
835    in valid list format -- will signal an error if the list is not in
836    valid format.  CONSVAR is used to keep track of the iterations
837    without modifying PLIST.
838
839    We have to be tricky to still keep the same C format.*/
840 #define EXTERNAL_PROPERTY_LIST_LOOP(tail, key, value, plist)    \
841   for (tail = plist;                                            \
842        (CONSP (tail) && CONSP (XCDR (tail)) ?                   \
843         (key = XCAR (tail), value = XCAR (XCDR (tail))) :       \
844         (key = Qunbound,    value = Qunbound)),                 \
845        !NILP (tail);                                            \
846        tail = XCDR (XCDR (tail)))                               \
847     if (UNBOUNDP (key))                                         \
848       Fsignal (Qmalformed_property_list, list1 (plist));        \
849     else
850
851 #define PROPERTY_LIST_LOOP(tail, key, value, plist)     \
852   for (tail = plist;                                    \
853        NILP (tail) ? 0 :                                \
854          (key   = XCAR (tail), tail = XCDR (tail),      \
855           value = XCAR (tail), tail = XCDR (tail), 1);  \
856        )
857
858 /* Return 1 if LIST is properly acyclic and nil-terminated, else 0. */
859 INLINE_HEADER int TRUE_LIST_P (Lisp_Object object);
860 INLINE_HEADER int
861 TRUE_LIST_P (Lisp_Object object)
862 {
863   Lisp_Object hare, tortoise;
864   EMACS_INT len;
865
866   for (hare = tortoise = object, len = 0;
867        CONSP (hare);
868        hare = XCDR (hare), len++)
869     {
870       if (len < CIRCULAR_LIST_SUSPICION_LENGTH)
871         continue;
872
873       if (len & 1)
874         tortoise = XCDR (tortoise);
875       else if (EQ (hare, tortoise))
876         return 0;
877     }
878
879   return NILP (hare);
880 }
881
882 /* Signal an error if LIST is not properly acyclic and nil-terminated. */
883 #define CHECK_TRUE_LIST(list) do {                      \
884   Lisp_Object CTL_list = (list);                        \
885   Lisp_Object CTL_hare, CTL_tortoise;                   \
886   EMACS_INT CTL_len;                                    \
887                                                         \
888   for (CTL_hare = CTL_tortoise = CTL_list, CTL_len = 0; \
889        CONSP (CTL_hare);                                \
890        CTL_hare = XCDR (CTL_hare), CTL_len++)           \
891     {                                                   \
892       if (CTL_len < CIRCULAR_LIST_SUSPICION_LENGTH)     \
893         continue;                                       \
894                                                         \
895       if (CTL_len & 1)                                  \
896         CTL_tortoise = XCDR (CTL_tortoise);             \
897       else if (EQ (CTL_hare, CTL_tortoise))             \
898         Fsignal (Qcircular_list, list1 (CTL_list));     \
899     }                                                   \
900                                                         \
901   if (! NILP (CTL_hare))                                \
902     signal_malformed_list_error (CTL_list);             \
903 } while (0)
904
905 /*********** string ***********/
906
907 struct Lisp_String
908 {
909   struct lrecord_header lheader;
910   Bytecount size;
911   Bufbyte *data;
912   Lisp_Object plist;
913 };
914 typedef struct Lisp_String Lisp_String;
915
916 DECLARE_LRECORD (string, Lisp_String);
917 #define XSTRING(x) XRECORD (x, string, Lisp_String)
918 #define XSETSTRING(x, p) XSETRECORD (x, p, string)
919 #define STRINGP(x) RECORDP (x, string)
920 #define CHECK_STRING(x) CHECK_RECORD (x, string)
921 #define CONCHECK_STRING(x) CONCHECK_RECORD (x, string)
922
923 #ifdef MULE
924
925 Charcount bytecount_to_charcount (const Bufbyte *ptr, Bytecount len);
926 Bytecount charcount_to_bytecount (const Bufbyte *ptr, Charcount len);
927
928 #else /* not MULE */
929
930 # define bytecount_to_charcount(ptr, len) (len)
931 # define charcount_to_bytecount(ptr, len) (len)
932
933 #endif /* not MULE */
934
935 #define string_length(s) ((s)->size)
936 #define XSTRING_LENGTH(s) string_length (XSTRING (s))
937 #define XSTRING_CHAR_LENGTH(s) string_char_length (XSTRING (s))
938 #define string_data(s) ((s)->data + 0)
939 #define XSTRING_DATA(s) string_data (XSTRING (s))
940 #define string_byte(s, i) ((s)->data[i] + 0)
941 #define XSTRING_BYTE(s, i) string_byte (XSTRING (s), i)
942 #define string_byte_addr(s, i) (&((s)->data[i]))
943 #define set_string_length(s, len) ((void) ((s)->size = (len)))
944 #define set_string_data(s, ptr) ((void) ((s)->data = (ptr)))
945 #define set_string_byte(s, i, c) ((void) ((s)->data[i] = (c)))
946
947 void resize_string (Lisp_String *s, Bytecount pos, Bytecount delta);
948
949 #ifdef MULE
950
951 INLINE_HEADER Charcount string_char_length (Lisp_String *s);
952 INLINE_HEADER Charcount
953 string_char_length (Lisp_String *s)
954 {
955   return bytecount_to_charcount (string_data (s), string_length (s));
956 }
957
958 # define string_char(s, i) charptr_emchar_n (string_data (s), i)
959 # define string_char_addr(s, i) charptr_n_addr (string_data (s), i)
960 void set_string_char (Lisp_String *s, Charcount i, Emchar c);
961
962 #else /* not MULE */
963
964 # define string_char_length(s) string_length (s)
965 # define string_char(s, i) ((Emchar) string_byte (s, i))
966 # define string_char_addr(s, i) string_byte_addr (s, i)
967 # define set_string_char(s, i, c) set_string_byte (s, i, c)
968
969 #endif /* not MULE */
970
971 /*********** vector ***********/
972
973 struct Lisp_Vector
974 {
975   struct lcrecord_header header;
976   long size;
977   /* next is now chained through v->contents[size], terminated by Qzero.
978      This means that pure vectors don't need a "next" */
979   /* struct Lisp_Vector *next; */
980   Lisp_Object contents[1];
981 };
982 typedef struct Lisp_Vector Lisp_Vector;
983
984 DECLARE_LRECORD (vector, Lisp_Vector);
985 #define XVECTOR(x) XRECORD (x, vector, Lisp_Vector)
986 #define XSETVECTOR(x, p) XSETRECORD (x, p, vector)
987 #define VECTORP(x) RECORDP (x, vector)
988 #define CHECK_VECTOR(x) CHECK_RECORD (x, vector)
989 #define CONCHECK_VECTOR(x) CONCHECK_RECORD (x, vector)
990
991 #define vector_length(v) ((v)->size)
992 #define XVECTOR_LENGTH(s) vector_length (XVECTOR (s))
993 #define vector_data(v) ((v)->contents)
994 #define XVECTOR_DATA(s) vector_data (XVECTOR (s))
995
996 /*********** bit vector ***********/
997
998 #if (LONGBITS < 16)
999 #error What the hell?!
1000 #elif (LONGBITS < 32)
1001 # define LONGBITS_LOG2 4
1002 # define LONGBITS_POWER_OF_2 16
1003 #elif (LONGBITS < 64)
1004 # define LONGBITS_LOG2 5
1005 # define LONGBITS_POWER_OF_2 32
1006 #elif (LONGBITS < 128)
1007 # define LONGBITS_LOG2 6
1008 # define LONGBITS_POWER_OF_2 64
1009 #else
1010 #error You really have 128-bit integers?!
1011 #endif
1012
1013 struct Lisp_Bit_Vector
1014 {
1015   struct lrecord_header lheader;
1016   Lisp_Object next;
1017   size_t size;
1018   unsigned long bits[1];
1019 };
1020 typedef struct Lisp_Bit_Vector Lisp_Bit_Vector;
1021
1022 DECLARE_LRECORD (bit_vector, Lisp_Bit_Vector);
1023 #define XBIT_VECTOR(x) XRECORD (x, bit_vector, Lisp_Bit_Vector)
1024 #define XSETBIT_VECTOR(x, p) XSETRECORD (x, p, bit_vector)
1025 #define BIT_VECTORP(x) RECORDP (x, bit_vector)
1026 #define CHECK_BIT_VECTOR(x) CHECK_RECORD (x, bit_vector)
1027 #define CONCHECK_BIT_VECTOR(x) CONCHECK_RECORD (x, bit_vector)
1028
1029 #define BITP(x) (INTP (x) && (XINT (x) == 0 || XINT (x) == 1))
1030
1031 #define CHECK_BIT(x) do {               \
1032   if (!BITP (x))                        \
1033     dead_wrong_type_argument (Qbitp, x);\
1034 } while (0)
1035
1036 #define CONCHECK_BIT(x) do {            \
1037   if (!BITP (x))                        \
1038     x = wrong_type_argument (Qbitp, x); \
1039 } while (0)
1040
1041 #define bit_vector_length(v) ((v)->size)
1042 #define bit_vector_next(v) ((v)->next)
1043
1044 INLINE_HEADER int bit_vector_bit (Lisp_Bit_Vector *v, size_t n);
1045 INLINE_HEADER int
1046 bit_vector_bit (Lisp_Bit_Vector *v, size_t n)
1047 {
1048   return ((v->bits[n >> LONGBITS_LOG2] >> (n & (LONGBITS_POWER_OF_2 - 1)))
1049           & 1);
1050 }
1051
1052 INLINE_HEADER void set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value);
1053 INLINE_HEADER void
1054 set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value)
1055 {
1056   if (value)
1057     v->bits[n >> LONGBITS_LOG2] |= (1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1058   else
1059     v->bits[n >> LONGBITS_LOG2] &= ~(1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1060 }
1061
1062 /* Number of longs required to hold LEN bits */
1063 #define BIT_VECTOR_LONG_STORAGE(len) \
1064   (((len) + LONGBITS_POWER_OF_2 - 1) >> LONGBITS_LOG2)
1065
1066
1067 /*********** symbol ***********/
1068
1069 typedef struct Lisp_Symbol Lisp_Symbol;
1070 struct Lisp_Symbol
1071 {
1072   struct lrecord_header lheader;
1073   /* next symbol in this obarray bucket */
1074   Lisp_Symbol *next;
1075   Lisp_String *name;
1076   Lisp_Object value;
1077   Lisp_Object function;
1078   Lisp_Object plist;
1079 };
1080
1081 #define SYMBOL_IS_KEYWORD(sym)                                          \
1082   ((string_byte (symbol_name (XSYMBOL (sym)), 0) == ':')                \
1083    && EQ (sym, oblookup (Vobarray,                                      \
1084                          string_data (symbol_name (XSYMBOL (sym))),     \
1085                          string_length (symbol_name (XSYMBOL (sym))))))
1086 #define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj))
1087
1088 DECLARE_LRECORD (symbol, Lisp_Symbol);
1089 #define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol)
1090 #define XSETSYMBOL(x, p) XSETRECORD (x, p, symbol)
1091 #define SYMBOLP(x) RECORDP (x, symbol)
1092 #define CHECK_SYMBOL(x) CHECK_RECORD (x, symbol)
1093 #define CONCHECK_SYMBOL(x) CONCHECK_RECORD (x, symbol)
1094
1095 #define symbol_next(s) ((s)->next)
1096 #define symbol_name(s) ((s)->name)
1097 #define symbol_value(s) ((s)->value)
1098 #define symbol_function(s) ((s)->function)
1099 #define symbol_plist(s) ((s)->plist)
1100
1101 /*********** subr ***********/
1102
1103 typedef Lisp_Object (*lisp_fn_t) (void);
1104
1105 struct Lisp_Subr
1106 {
1107   struct lrecord_header lheader;
1108   short min_args;
1109   short max_args;
1110   const char *prompt;
1111   const char *doc;
1112   const char *name;
1113   lisp_fn_t subr_fn;
1114 };
1115 typedef struct Lisp_Subr Lisp_Subr;
1116
1117 DECLARE_LRECORD (subr, Lisp_Subr);
1118 #define XSUBR(x) XRECORD (x, subr, Lisp_Subr)
1119 #define XSETSUBR(x, p) XSETRECORD (x, p, subr)
1120 #define SUBRP(x) RECORDP (x, subr)
1121 #define CHECK_SUBR(x) CHECK_RECORD (x, subr)
1122 #define CONCHECK_SUBR(x) CONCHECK_RECORD (x, subr)
1123
1124 #define subr_function(subr) ((subr)->subr_fn)
1125 #define SUBR_FUNCTION(subr,max_args) \
1126   ((Lisp_Object (*) (EXFUN_##max_args)) (subr)->subr_fn)
1127 #define subr_name(subr) ((subr)->name)
1128
1129 /*********** marker ***********/
1130
1131 typedef struct Lisp_Marker Lisp_Marker;
1132 struct Lisp_Marker
1133 {
1134   struct lrecord_header lheader;
1135   Lisp_Marker *next;
1136   Lisp_Marker *prev;
1137   struct buffer *buffer;
1138   Memind memind;
1139   char insertion_type;
1140 };
1141
1142 DECLARE_LRECORD (marker, Lisp_Marker);
1143 #define XMARKER(x) XRECORD (x, marker, Lisp_Marker)
1144 #define XSETMARKER(x, p) XSETRECORD (x, p, marker)
1145 #define MARKERP(x) RECORDP (x, marker)
1146 #define CHECK_MARKER(x) CHECK_RECORD (x, marker)
1147 #define CONCHECK_MARKER(x) CONCHECK_RECORD (x, marker)
1148
1149 /* The second check was looking for GCed markers still in use */
1150 /* if (INTP (XMARKER (x)->lheader.next.v)) abort (); */
1151
1152 #define marker_next(m) ((m)->next)
1153 #define marker_prev(m) ((m)->prev)
1154
1155 /*********** char ***********/
1156
1157 #define CHARP(x) (XTYPE (x) == Lisp_Type_Char)
1158
1159 #ifdef ERROR_CHECK_TYPECHECK
1160
1161 INLINE_HEADER Emchar XCHAR (Lisp_Object obj);
1162 INLINE_HEADER Emchar
1163 XCHAR (Lisp_Object obj)
1164 {
1165   assert (CHARP (obj));
1166   return XCHARVAL (obj);
1167 }
1168
1169 #else
1170
1171 #define XCHAR(x) XCHARVAL (x)
1172
1173 #endif
1174
1175 #define CHECK_CHAR(x) CHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1176 #define CONCHECK_CHAR(x) CONCHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1177
1178
1179 /*********** float ***********/
1180
1181 #ifdef LISP_FLOAT_TYPE
1182
1183 /* Note: the 'unused_next_' field exists only to ensure that the
1184    `next' pointer fits within the structure, for the purposes of the
1185    free list.  This makes a difference in the unlikely case of
1186    sizeof(double) being smaller than sizeof(void *). */
1187
1188 struct Lisp_Float
1189 {
1190   struct lrecord_header lheader;
1191   union { double d; struct Lisp_Float *unused_next_; } data;
1192 };
1193 typedef struct Lisp_Float Lisp_Float;
1194
1195 DECLARE_LRECORD (float, Lisp_Float);
1196 #define XFLOAT(x) XRECORD (x, float, Lisp_Float)
1197 #define XSETFLOAT(x, p) XSETRECORD (x, p, float)
1198 #define FLOATP(x) RECORDP (x, float)
1199 #define CHECK_FLOAT(x) CHECK_RECORD (x, float)
1200 #define CONCHECK_FLOAT(x) CONCHECK_RECORD (x, float)
1201
1202 #define float_data(f) ((f)->data.d)
1203 #define XFLOAT_DATA(x) float_data (XFLOAT (x))
1204
1205 #define XFLOATINT(n) extract_float (n)
1206
1207 #define CHECK_INT_OR_FLOAT(x) do {              \
1208   if (!INT_OR_FLOATP (x))                       \
1209     dead_wrong_type_argument (Qnumberp, x);     \
1210 } while (0)
1211
1212 #define CONCHECK_INT_OR_FLOAT(x) do {           \
1213   if (!INT_OR_FLOATP (x))                       \
1214     x = wrong_type_argument (Qnumberp, x);      \
1215 } while (0)
1216
1217 # define INT_OR_FLOATP(x) (INTP (x) || FLOATP (x))
1218
1219 #else /* not LISP_FLOAT_TYPE */
1220
1221 #define XFLOAT(x) --- error!  No float support. ---
1222 #define XSETFLOAT(x, p) --- error!  No float support. ---
1223 #define FLOATP(x) 0
1224 #define CHECK_FLOAT(x) --- error!  No float support. ---
1225 #define CONCHECK_FLOAT(x) --- error!  No float support. ---
1226
1227 #define XFLOATINT(n) XINT(n)
1228 #define CHECK_INT_OR_FLOAT CHECK_INT
1229 #define CONCHECK_INT_OR_FLOAT CONCHECK_INT
1230 #define INT_OR_FLOATP(x) INTP (x)
1231
1232 #endif /* not LISP_FLOAT_TYPE */
1233
1234 /*********** int ***********/
1235
1236 #define ZEROP(x) EQ (x, Qzero)
1237
1238 #ifdef ERROR_CHECK_TYPECHECK
1239
1240 INLINE_HEADER EMACS_INT XINT (Lisp_Object obj);
1241 INLINE_HEADER EMACS_INT
1242 XINT (Lisp_Object obj)
1243 {
1244   assert (INTP (obj));
1245   return XREALINT (obj);
1246 }
1247
1248 INLINE_HEADER EMACS_INT XCHAR_OR_INT (Lisp_Object obj);
1249 INLINE_HEADER EMACS_INT
1250 XCHAR_OR_INT (Lisp_Object obj)
1251 {
1252   assert (INTP (obj) || CHARP (obj));
1253   return CHARP (obj) ? XCHAR (obj) : XINT (obj);
1254 }
1255
1256 #else /* no error checking */
1257
1258 #define XINT(obj) XREALINT (obj)
1259 #define XCHAR_OR_INT(obj) (CHARP (obj) ? XCHAR (obj) : XINT (obj))
1260
1261 #endif /* no error checking */
1262
1263 #define CHECK_INT(x) do {                       \
1264   if (!INTP (x))                                \
1265     dead_wrong_type_argument (Qintegerp, x);    \
1266 } while (0)
1267
1268 #define CONCHECK_INT(x) do {                    \
1269   if (!INTP (x))                                \
1270     x = wrong_type_argument (Qintegerp, x);     \
1271 } while (0)
1272
1273 #define NATNUMP(x) (INTP (x) && XINT (x) >= 0)
1274
1275 #define CHECK_NATNUM(x) do {                    \
1276   if (!NATNUMP (x))                             \
1277     dead_wrong_type_argument (Qnatnump, x);     \
1278 } while (0)
1279
1280 #define CONCHECK_NATNUM(x) do {                 \
1281   if (!NATNUMP (x))                             \
1282     x = wrong_type_argument (Qnatnump, x);      \
1283 } while (0)
1284
1285 /* next three always continuable because they coerce their arguments. */
1286 #define CHECK_INT_COERCE_CHAR(x) do {                   \
1287   if (INTP (x))                                         \
1288     ;                                                   \
1289   else if (CHARP (x))                                   \
1290     x = make_int (XCHAR (x));                           \
1291   else                                                  \
1292     x = wrong_type_argument (Qinteger_or_char_p, x);    \
1293 } while (0)
1294
1295 #define CHECK_INT_COERCE_MARKER(x) do {                 \
1296   if (INTP (x))                                         \
1297     ;                                                   \
1298   else if (MARKERP (x))                                 \
1299     x = make_int (marker_position (x));                 \
1300   else                                                  \
1301     x = wrong_type_argument (Qinteger_or_marker_p, x);  \
1302 } while (0)
1303
1304 #define CHECK_INT_COERCE_CHAR_OR_MARKER(x) do {                 \
1305   if (INTP (x))                                                 \
1306     ;                                                           \
1307   else if (CHARP (x))                                           \
1308     x = make_int (XCHAR (x));                                   \
1309   else if (MARKERP (x))                                         \
1310     x = make_int (marker_position (x));                         \
1311   else                                                          \
1312     x = wrong_type_argument (Qinteger_char_or_marker_p, x);     \
1313 } while (0)
1314
1315
1316 /*********** readonly objects ***********/
1317
1318 #define CHECK_C_WRITEABLE(obj)                                  \
1319   do { if (c_readonly (obj)) c_write_error (obj); } while (0)
1320
1321 #define CHECK_LISP_WRITEABLE(obj)                                       \
1322   do { if (lisp_readonly (obj)) lisp_write_error (obj); } while (0)
1323
1324 #define C_READONLY(obj) (C_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1325 #define LISP_READONLY(obj) (LISP_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1326
1327 /*********** structures ***********/
1328
1329 typedef struct structure_keyword_entry structure_keyword_entry;
1330 struct structure_keyword_entry
1331 {
1332   Lisp_Object keyword;
1333   int (*validate) (Lisp_Object keyword, Lisp_Object value,
1334                    Error_behavior errb);
1335 };
1336
1337 typedef struct
1338 {
1339   Dynarr_declare (structure_keyword_entry);
1340 } structure_keyword_entry_dynarr;
1341
1342 typedef struct structure_type structure_type;
1343 struct structure_type
1344 {
1345   Lisp_Object type;
1346   structure_keyword_entry_dynarr *keywords;
1347   int (*validate) (Lisp_Object data, Error_behavior errb);
1348   Lisp_Object (*instantiate) (Lisp_Object data);
1349 };
1350
1351 typedef struct
1352 {
1353   Dynarr_declare (structure_type);
1354 } structure_type_dynarr;
1355
1356 struct structure_type *define_structure_type (Lisp_Object type,
1357                                               int (*validate)
1358                                               (Lisp_Object data,
1359                                                Error_behavior errb),
1360                                               Lisp_Object (*instantiate)
1361                                               (Lisp_Object data));
1362 void define_structure_type_keyword (struct structure_type *st,
1363                                     Lisp_Object keyword,
1364                                     int (*validate) (Lisp_Object keyword,
1365                                                      Lisp_Object value,
1366                                                      Error_behavior errb));
1367
1368 /*********** weak lists ***********/
1369
1370 enum weak_list_type
1371 {
1372   /* element disappears if it's unmarked. */
1373   WEAK_LIST_SIMPLE,
1374   /* element disappears if it's a cons and either its car or
1375      cdr is unmarked. */
1376   WEAK_LIST_ASSOC,
1377   /* element disappears if it's a cons and its car is unmarked. */
1378   WEAK_LIST_KEY_ASSOC,
1379   /* element disappears if it's a cons and its cdr is unmarked. */
1380   WEAK_LIST_VALUE_ASSOC
1381 };
1382
1383 struct weak_list
1384 {
1385   struct lcrecord_header header;
1386   Lisp_Object list; /* don't mark through this! */
1387   enum weak_list_type type;
1388   Lisp_Object next_weak; /* don't mark through this! */
1389 };
1390
1391 DECLARE_LRECORD (weak_list, struct weak_list);
1392 #define XWEAK_LIST(x) XRECORD (x, weak_list, struct weak_list)
1393 #define XSETWEAK_LIST(x, p) XSETRECORD (x, p, weak_list)
1394 #define WEAK_LISTP(x) RECORDP (x, weak_list)
1395 #define CHECK_WEAK_LIST(x) CHECK_RECORD (x, weak_list)
1396 #define CONCHECK_WEAK_LIST(x) CONCHECK_RECORD (x, weak_list)
1397
1398 #define weak_list_list(w) ((w)->list)
1399 #define XWEAK_LIST_LIST(w) (XWEAK_LIST (w)->list)
1400
1401 Lisp_Object make_weak_list (enum weak_list_type type);
1402 /* The following two are only called by the garbage collector */
1403 int finish_marking_weak_lists (void);
1404 void prune_weak_lists (void);
1405
1406 /*********** lcrecord lists ***********/
1407
1408 struct lcrecord_list
1409 {
1410   struct lcrecord_header header;
1411   Lisp_Object free;
1412   size_t size;
1413   const struct lrecord_implementation *implementation;
1414 };
1415
1416 DECLARE_LRECORD (lcrecord_list, struct lcrecord_list);
1417 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list)
1418 #define XSETLCRECORD_LIST(x, p) XSETRECORD (x, p, lcrecord_list)
1419 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list)
1420 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list)
1421    Lcrecord lists should never escape to the Lisp level, so
1422    functions should not be doing this. */
1423
1424 Lisp_Object make_lcrecord_list (size_t size,
1425                                 const struct lrecord_implementation
1426                                 *implementation);
1427 Lisp_Object allocate_managed_lcrecord (Lisp_Object lcrecord_list);
1428 void free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord);
1429
1430 \f
1431 /************************************************************************/
1432 /*         Definitions of primitive Lisp functions and variables        */
1433 /************************************************************************/
1434
1435
1436 /* DEFUN - Define a built-in Lisp-visible C function or `subr'.
1437  `lname' should be the name to give the function in Lisp,
1438     as a null-terminated C string.
1439  `Fname' should be the C equivalent of `lname', using only characters
1440     valid in a C identifier, with an "F" prepended.
1441     The name of the C constant structure that records information
1442     on this function for internal use is "S" concatenated with Fname.
1443  `min_args' should be a number, the minimum number of arguments allowed.
1444  `max_args' should be a number, the maximum number of arguments allowed,
1445     or else MANY or UNEVALLED.
1446     MANY means pass a vector of evaluated arguments,
1447          in the form of an integer number-of-arguments
1448          followed by the address of a vector of Lisp_Objects
1449          which contains the argument values.
1450     UNEVALLED means pass the list of unevaluated arguments.
1451  `prompt' says how to read arguments for an interactive call.
1452     See the doc string for `interactive'.
1453     A null string means call interactively with no arguments.
1454  `arglist' are the comma-separated arguments (always Lisp_Objects) for
1455     the function.
1456   The docstring for the function is placed as a "C" comment between
1457     the prompt and the `args' argument.  make-docfile reads the
1458     comment and creates the DOC file from it.
1459 */
1460
1461 #define EXFUN_0 void
1462 #define EXFUN_1 Lisp_Object
1463 #define EXFUN_2 Lisp_Object,Lisp_Object
1464 #define EXFUN_3 Lisp_Object,Lisp_Object,Lisp_Object
1465 #define EXFUN_4 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1466 #define EXFUN_5 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1467 #define EXFUN_6 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1468 Lisp_Object
1469 #define EXFUN_7 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1470 Lisp_Object,Lisp_Object
1471 #define EXFUN_8 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1472 Lisp_Object,Lisp_Object,Lisp_Object
1473 #define EXFUN_MANY int, Lisp_Object*
1474 #define EXFUN_UNEVALLED Lisp_Object
1475 #define EXFUN(sym, max_args) Lisp_Object sym (EXFUN_##max_args)
1476
1477 #define SUBR_MAX_ARGS 8
1478 #define MANY -2
1479 #define UNEVALLED -1
1480
1481 /* Can't be const, because then subr->doc is read-only and
1482    Snarf_documentation chokes */
1483
1484 #define DEFUN(lname, Fname, min_args, max_args, prompt, arglist)        \
1485   Lisp_Object Fname (EXFUN_##max_args);                                 \
1486   static struct Lisp_Subr S##Fname =                                    \
1487   {                                                                     \
1488     { /* struct lrecord_header */                                       \
1489       lrecord_type_subr, /* lrecord_type_index */                       \
1490       1, /* mark bit */                                                 \
1491       1, /* c_readonly bit */                                           \
1492       1  /* lisp_readonly bit */                                        \
1493     },                                                                  \
1494     min_args,                                                           \
1495     max_args,                                                           \
1496     prompt,                                                             \
1497     0,  /* doc string */                                                \
1498     lname,                                                              \
1499     (lisp_fn_t) Fname                                                   \
1500   };                                                                    \
1501   Lisp_Object Fname (DEFUN_##max_args arglist)
1502
1503 /* Heavy ANSI C preprocessor hackery to get DEFUN to declare a
1504    prototype that matches max_args, and add the obligatory
1505    `Lisp_Object' type declaration to the formal C arguments.  */
1506
1507 #define DEFUN_MANY(named_int, named_Lisp_Object) named_int, named_Lisp_Object
1508 #define DEFUN_UNEVALLED(args) Lisp_Object args
1509 #define DEFUN_0() void
1510 #define DEFUN_1(a)                                      Lisp_Object a
1511 #define DEFUN_2(a,b)             DEFUN_1(a),            Lisp_Object b
1512 #define DEFUN_3(a,b,c)           DEFUN_2(a,b),          Lisp_Object c
1513 #define DEFUN_4(a,b,c,d)         DEFUN_3(a,b,c),        Lisp_Object d
1514 #define DEFUN_5(a,b,c,d,e)       DEFUN_4(a,b,c,d),      Lisp_Object e
1515 #define DEFUN_6(a,b,c,d,e,f)     DEFUN_5(a,b,c,d,e),    Lisp_Object f
1516 #define DEFUN_7(a,b,c,d,e,f,g)   DEFUN_6(a,b,c,d,e,f),  Lisp_Object g
1517 #define DEFUN_8(a,b,c,d,e,f,g,h) DEFUN_7(a,b,c,d,e,f,g),Lisp_Object h
1518
1519 /* WARNING: If you add defines here for higher values of max_args,
1520    make sure to also fix the clauses in PRIMITIVE_FUNCALL(),
1521    and change the define of SUBR_MAX_ARGS above.  */
1522
1523 #include "symeval.h"
1524
1525 /* `specpdl' is the special binding/unwind-protect stack.
1526
1527    Knuth says (see the Jargon File):
1528    At MIT, `pdl' [abbreviation for `Push Down List'] used to
1529    be a more common synonym for `stack'.
1530    Everywhere else `stack' seems to be the preferred term.
1531
1532    specpdl_depth is the current depth of `specpdl'.
1533    Save this for use later as arg to `unbind_to'.  */
1534 extern int specpdl_depth_counter;
1535 #define specpdl_depth() specpdl_depth_counter
1536
1537 \f
1538 /************************************************************************/
1539 /*                         Checking for QUIT                            */
1540 /************************************************************************/
1541
1542 /* Asynchronous events set something_happened, and then are processed
1543    within the QUIT macro.  At this point, we are guaranteed to not be in
1544    any sensitive code. */
1545
1546 extern volatile int something_happened;
1547 int check_what_happened (void);
1548
1549 extern volatile int quit_check_signal_happened;
1550 extern volatile int quit_check_signal_tick_count;
1551 int check_quit (void);
1552
1553 void signal_quit (void);
1554
1555 /* Nonzero if ought to quit now.  */
1556 #define QUITP                                                   \
1557   ((quit_check_signal_happened ? check_quit () : 0),            \
1558    (!NILP (Vquit_flag) && (NILP (Vinhibit_quit)                 \
1559                            || EQ (Vquit_flag, Qcritical))))
1560
1561 /* QUIT used to call QUITP, but there are some places where QUITP
1562    is called directly, and check_what_happened() should only be called
1563    when Emacs is actually ready to quit because it could do things
1564    like switch threads. */
1565 #define INTERNAL_QUITP                                          \
1566   ((something_happened ? check_what_happened () : 0),           \
1567    (!NILP (Vquit_flag) &&                                       \
1568     (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1569
1570 #define INTERNAL_REALLY_QUITP                                   \
1571   (check_what_happened (),                                      \
1572    (!NILP (Vquit_flag) &&                                       \
1573     (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1574
1575 /* Check quit-flag and quit if it is non-nil.  Also do any other things
1576    that might have gotten queued until it was safe. */
1577 #define QUIT do { if (INTERNAL_QUITP) signal_quit (); } while (0)
1578
1579 #define REALLY_QUIT do { if (INTERNAL_REALLY_QUITP) signal_quit (); } while (0)
1580
1581 \f
1582 /************************************************************************/
1583 /*                               hashing                                */
1584 /************************************************************************/
1585
1586 /* #### for a 64-bit machine, we should substitute a prime just over 2^32 */
1587 #define GOOD_HASH 65599 /* prime number just over 2^16; Dragon book, p. 435 */
1588 #define HASH2(a,b)               (GOOD_HASH * (a)                     + (b))
1589 #define HASH3(a,b,c)             (GOOD_HASH * HASH2 (a,b)             + (c))
1590 #define HASH4(a,b,c,d)           (GOOD_HASH * HASH3 (a,b,c)           + (d))
1591 #define HASH5(a,b,c,d,e)         (GOOD_HASH * HASH4 (a,b,c,d)         + (e))
1592 #define HASH6(a,b,c,d,e,f)       (GOOD_HASH * HASH5 (a,b,c,d,e)       + (f))
1593 #define HASH7(a,b,c,d,e,f,g)     (GOOD_HASH * HASH6 (a,b,c,d,e,f)     + (g))
1594 #define HASH8(a,b,c,d,e,f,g,h)   (GOOD_HASH * HASH7 (a,b,c,d,e,f,g)   + (h))
1595 #define HASH9(a,b,c,d,e,f,g,h,i) (GOOD_HASH * HASH8 (a,b,c,d,e,f,g,h) + (i))
1596
1597 #define LISP_HASH(obj) ((unsigned long) LISP_TO_VOID (obj))
1598 unsigned long string_hash (const void *xv);
1599 unsigned long memory_hash (const void *xv, size_t size);
1600 unsigned long internal_hash (Lisp_Object obj, int depth);
1601 unsigned long internal_array_hash (Lisp_Object *arr, int size, int depth);
1602
1603 \f
1604 /************************************************************************/
1605 /*                       String translation                             */
1606 /************************************************************************/
1607
1608 #ifdef I18N3
1609 #ifdef HAVE_LIBINTL_H
1610 #include <libintl.h>
1611 #else
1612 char *dgettext       (const char *, const char *);
1613 char *gettext        (const char *);
1614 char *textdomain     (const char *);
1615 char *bindtextdomain (const char *, const char *);
1616 #endif /* HAVE_LIBINTL_H */
1617
1618 #define GETTEXT(x)  gettext(x)
1619 #define LISP_GETTEXT(x)  Fgettext (x)
1620 #else /* !I18N3 */
1621 #define GETTEXT(x)  (x)
1622 #define LISP_GETTEXT(x)  (x)
1623 #endif /* !I18N3 */
1624
1625 /* DEFER_GETTEXT is used to identify strings which are translated when
1626    they are referenced instead of when they are defined.
1627    These include Qerror_messages and initialized arrays of strings.
1628 */
1629 #define DEFER_GETTEXT(x) (x)
1630
1631 \f
1632 /************************************************************************/
1633 /*                   Garbage collection / GC-protection                 */
1634 /************************************************************************/
1635
1636 /* number of bytes of structure consed since last GC */
1637
1638 extern EMACS_INT consing_since_gc;
1639
1640 /* threshold for doing another gc */
1641
1642 extern EMACS_INT gc_cons_threshold;
1643
1644 /* Structure for recording stack slots that need marking */
1645
1646 /* This is a chain of structures, each of which points at a Lisp_Object
1647    variable whose value should be marked in garbage collection.
1648    Normally every link of the chain is an automatic variable of a function,
1649    and its `val' points to some argument or local variable of the function.
1650    On exit to the function, the chain is set back to the value it had on
1651    entry.  This way, no link remains in the chain when the stack frame
1652    containing the link disappears.
1653
1654    Every function that can call Feval must protect in this fashion all
1655    Lisp_Object variables whose contents will be used again. */
1656
1657 extern struct gcpro *gcprolist;
1658
1659 struct gcpro
1660 {
1661   struct gcpro *next;
1662   Lisp_Object *var;             /* Address of first protected variable */
1663   int nvars;                    /* Number of consecutive protected variables */
1664 };
1665
1666 /* Normally, you declare variables gcpro1, gcpro2, ... and use the
1667    GCPROn() macros.  However, if you need to have nested gcpro's,
1668    declare ngcpro1, ngcpro2, ... and use NGCPROn().  If you need
1669    to nest another level, use nngcpro1, nngcpro2, ... and use
1670    NNGCPROn().  If you need to nest yet another level, create
1671    the appropriate macros. */
1672
1673 #ifdef DEBUG_GCPRO
1674
1675 void debug_gcpro1 (char *, int, struct gcpro *, Lisp_Object *);
1676 void debug_gcpro2 (char *, int, struct gcpro *, struct gcpro *,
1677                    Lisp_Object *, Lisp_Object *);
1678 void debug_gcpro3 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1679                    Lisp_Object *, Lisp_Object *, Lisp_Object *);
1680 void debug_gcpro4 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1681                    struct gcpro *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
1682                    Lisp_Object *);
1683 void debug_gcpro5 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1684                    struct gcpro *, struct gcpro *, Lisp_Object *, Lisp_Object *,
1685                    Lisp_Object *, Lisp_Object *, Lisp_Object *);
1686 void debug_ungcpro(char *, int, struct gcpro *);
1687
1688 #define GCPRO1(v) \
1689  debug_gcpro1 (__FILE__, __LINE__,&gcpro1,&v)
1690 #define GCPRO2(v1,v2) \
1691  debug_gcpro2 (__FILE__, __LINE__,&gcpro1,&gcpro2,&v1,&v2)
1692 #define GCPRO3(v1,v2,v3) \
1693  debug_gcpro3 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&v1,&v2,&v3)
1694 #define GCPRO4(v1,v2,v3,v4) \
1695  debug_gcpro4 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,\
1696                &v1,&v2,&v3,&v4)
1697 #define GCPRO5(v1,v2,v3,v4,v5) \
1698  debug_gcpro5 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,\
1699                &v1,&v2,&v3,&v4,&v5)
1700 #define UNGCPRO \
1701  debug_ungcpro(__FILE__, __LINE__,&gcpro1)
1702
1703 #define NGCPRO1(v) \
1704  debug_gcpro1 (__FILE__, __LINE__,&ngcpro1,&v)
1705 #define NGCPRO2(v1,v2) \
1706  debug_gcpro2 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&v1,&v2)
1707 #define NGCPRO3(v1,v2,v3) \
1708  debug_gcpro3 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&v1,&v2,&v3)
1709 #define NGCPRO4(v1,v2,v3,v4) \
1710  debug_gcpro4 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1711                &v1,&v2,&v3,&v4)
1712 #define NGCPRO5(v1,v2,v3,v4,v5) \
1713  debug_gcpro5 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1714                &ngcpro5,&v1,&v2,&v3,&v4,&v5)
1715 #define NUNGCPRO \
1716  debug_ungcpro(__FILE__, __LINE__,&ngcpro1)
1717
1718 #define NNGCPRO1(v) \
1719  debug_gcpro1 (__FILE__, __LINE__,&nngcpro1,&v)
1720 #define NNGCPRO2(v1,v2) \
1721  debug_gcpro2 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&v1,&v2)
1722 #define NNGCPRO3(v1,v2,v3) \
1723  debug_gcpro3 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&v1,&v2,&v3)
1724 #define NNGCPRO4(v1,v2,v3,v4) \
1725  debug_gcpro4 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1726                &v1,&v2,&v3,&v4)
1727 #define NNGCPRO5(v1,v2,v3,v4,v5) \
1728  debug_gcpro5 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1729                &nngcpro5,&v1,&v2,&v3,&v4,&v5)
1730 #define NNUNGCPRO \
1731  debug_ungcpro(__FILE__, __LINE__,&nngcpro1)
1732
1733 #else /* ! DEBUG_GCPRO */
1734
1735 #define GCPRO1(var1) ((void) (                                          \
1736   gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1,        \
1737   gcprolist = &gcpro1 ))
1738
1739 #define GCPRO2(var1, var2) ((void) (                                    \
1740   gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1,        \
1741   gcpro2.next = &gcpro1,   gcpro2.var = &var2, gcpro2.nvars = 1,        \
1742   gcprolist = &gcpro2 ))
1743
1744 #define GCPRO3(var1, var2, var3) ((void) (                              \
1745   gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1,        \
1746   gcpro2.next = &gcpro1,   gcpro2.var = &var2, gcpro2.nvars = 1,        \
1747   gcpro3.next = &gcpro2,   gcpro3.var = &var3, gcpro3.nvars = 1,        \
1748   gcprolist = &gcpro3 ))
1749
1750 #define GCPRO4(var1, var2, var3, var4) ((void) (                        \
1751   gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1,        \
1752   gcpro2.next = &gcpro1,   gcpro2.var = &var2, gcpro2.nvars = 1,        \
1753   gcpro3.next = &gcpro2,   gcpro3.var = &var3, gcpro3.nvars = 1,        \
1754   gcpro4.next = &gcpro3,   gcpro4.var = &var4, gcpro4.nvars = 1,        \
1755   gcprolist = &gcpro4 ))
1756
1757 #define GCPRO5(var1, var2, var3, var4, var5) ((void) (                  \
1758   gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1,        \
1759   gcpro2.next = &gcpro1,   gcpro2.var = &var2, gcpro2.nvars = 1,        \
1760   gcpro3.next = &gcpro2,   gcpro3.var = &var3, gcpro3.nvars = 1,        \
1761   gcpro4.next = &gcpro3,   gcpro4.var = &var4, gcpro4.nvars = 1,        \
1762   gcpro5.next = &gcpro4,   gcpro5.var = &var5, gcpro5.nvars = 1,        \
1763   gcprolist = &gcpro5 ))
1764
1765 #define UNGCPRO ((void) (gcprolist = gcpro1.next))
1766
1767 #define NGCPRO1(var1) ((void) (                                         \
1768   ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1,     \
1769   gcprolist = &ngcpro1 ))
1770
1771 #define NGCPRO2(var1, var2) ((void) (                                   \
1772   ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1,     \
1773   ngcpro2.next = &ngcpro1,  ngcpro2.var = &var2, ngcpro2.nvars = 1,     \
1774   gcprolist = &ngcpro2 ))
1775
1776 #define NGCPRO3(var1, var2, var3) ((void) (                             \
1777   ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1,     \
1778   ngcpro2.next = &ngcpro1,  ngcpro2.var = &var2, ngcpro2.nvars = 1,     \
1779   ngcpro3.next = &ngcpro2,  ngcpro3.var = &var3, ngcpro3.nvars = 1,     \
1780   gcprolist = &ngcpro3 ))
1781
1782 #define NGCPRO4(var1, var2, var3, var4) ((void) (                       \
1783   ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1,     \
1784   ngcpro2.next = &ngcpro1,  ngcpro2.var = &var2, ngcpro2.nvars = 1,     \
1785   ngcpro3.next = &ngcpro2,  ngcpro3.var = &var3, ngcpro3.nvars = 1,     \
1786   ngcpro4.next = &ngcpro3,  ngcpro4.var = &var4, ngcpro4.nvars = 1,     \
1787   gcprolist = &ngcpro4 ))
1788
1789 #define NGCPRO5(var1, var2, var3, var4, var5) ((void) (                 \
1790   ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1,     \
1791   ngcpro2.next = &ngcpro1,  ngcpro2.var = &var2, ngcpro2.nvars = 1,     \
1792   ngcpro3.next = &ngcpro2,  ngcpro3.var = &var3, ngcpro3.nvars = 1,     \
1793   ngcpro4.next = &ngcpro3,  ngcpro4.var = &var4, ngcpro4.nvars = 1,     \
1794   ngcpro5.next = &ngcpro4,  ngcpro5.var = &var5, ngcpro5.nvars = 1,     \
1795   gcprolist = &ngcpro5 ))
1796
1797 #define NUNGCPRO ((void) (gcprolist = ngcpro1.next))
1798
1799 #define NNGCPRO1(var1) ((void) (                                        \
1800   nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1,  \
1801   gcprolist = &nngcpro1 ))
1802
1803 #define NNGCPRO2(var1, var2) ((void) (                                  \
1804   nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1,  \
1805   nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1,  \
1806   gcprolist = &nngcpro2 ))
1807
1808 #define NNGCPRO3(var1, var2, var3) ((void) (                            \
1809   nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1,  \
1810   nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1,  \
1811   nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1,  \
1812   gcprolist = &nngcpro3 ))
1813
1814 #define NNGCPRO4(var1, var2, var3, var4)  ((void) (                     \
1815   nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1,  \
1816   nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1,  \
1817   nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1,  \
1818   nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1,  \
1819   gcprolist = &nngcpro4 ))
1820
1821 #define NNGCPRO5(var1, var2, var3, var4, var5) ((void) (                \
1822   nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1,  \
1823   nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1,  \
1824   nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1,  \
1825   nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1,  \
1826   nngcpro5.next = &nngcpro4, nngcpro5.var = &var5, nngcpro5.nvars = 1,  \
1827   gcprolist = &nngcpro5 ))
1828
1829 #define NNUNGCPRO ((void) (gcprolist = nngcpro1.next))
1830
1831 #endif /* ! DEBUG_GCPRO */
1832
1833 /* Another try to fix SunPro C compiler warnings */
1834 /* "end-of-loop code not reached" */
1835 /* "statement not reached */
1836 #ifdef __SUNPRO_C
1837 #define RETURN_SANS_WARNINGS if (1) return
1838 #define RETURN_NOT_REACHED(value)
1839 #else
1840 #define RETURN_SANS_WARNINGS return
1841 #define RETURN_NOT_REACHED(value) return value;
1842 #endif
1843
1844 /* Evaluate expr, UNGCPRO, and then return the value of expr.  */
1845 #define RETURN_UNGCPRO(expr) do         \
1846 {                                       \
1847   Lisp_Object ret_ungc_val = (expr);    \
1848   UNGCPRO;                              \
1849   RETURN_SANS_WARNINGS ret_ungc_val;    \
1850 } while (0)
1851
1852 /* Evaluate expr, NUNGCPRO, UNGCPRO, and then return the value of expr.  */
1853 #define RETURN_NUNGCPRO(expr) do        \
1854 {                                       \
1855   Lisp_Object ret_ungc_val = (expr);    \
1856   NUNGCPRO;                             \
1857   UNGCPRO;                              \
1858   RETURN_SANS_WARNINGS ret_ungc_val;    \
1859 } while (0)
1860
1861 /* Evaluate expr, NNUNGCPRO, NUNGCPRO, UNGCPRO, and then return the
1862    value of expr.  */
1863 #define RETURN_NNUNGCPRO(expr) do       \
1864 {                                       \
1865   Lisp_Object ret_ungc_val = (expr);    \
1866   NNUNGCPRO;                            \
1867   NUNGCPRO;                             \
1868   UNGCPRO;                              \
1869   RETURN_SANS_WARNINGS ret_ungc_val;    \
1870 } while (0)
1871
1872 /* Evaluate expr, return it if it's not Qunbound. */
1873 #define RETURN_IF_NOT_UNBOUND(expr) do  \
1874 {                                       \
1875   Lisp_Object ret_nunb_val = (expr);    \
1876   if (!UNBOUNDP (ret_nunb_val))         \
1877     RETURN_SANS_WARNINGS ret_nunb_val;  \
1878 } while (0)
1879
1880 /* Call staticpro (&var) to protect static variable `var'. */
1881 void staticpro (Lisp_Object *);
1882
1883 /* Call staticpro_nodump (&var) to protect static variable `var'. */
1884 /* var will not be saved at dump time */
1885 void staticpro_nodump (Lisp_Object *);
1886
1887 /* Call dumpstruct(&var, &desc) to dump the structure pointed to by `var'. */
1888 void dumpstruct (void *, const struct struct_description *);
1889
1890 /* Call dumpopaque(&var, size) to dump the opaque static structure `var'. */
1891 void dumpopaque (void *, size_t);
1892
1893 /* Call pdump_wire(&var) to ensure that var is properly updated after pdump. */
1894 void pdump_wire (Lisp_Object *);
1895
1896 /* Call pdump_wire(&var) to ensure that var  is properly updated after
1897    pdump.  var  must point to  a linked list  of  objects out of which
1898    some may not be dumped */
1899 void pdump_wire_list (Lisp_Object *);
1900
1901 /* Nonzero means Emacs has already been initialized.
1902    Used during startup to detect startup of dumped Emacs.  */
1903 extern int initialized;
1904
1905 #ifdef MEMORY_USAGE_STATS
1906
1907 /* This structure is used to keep statistics on the amount of memory
1908    in use.
1909
1910    WAS_REQUESTED stores the actual amount of memory that was requested
1911    of the allocation function.  The *_OVERHEAD fields store the
1912    additional amount of memory that was grabbed by the functions to
1913    facilitate allocation, reallocation, etc.  MALLOC_OVERHEAD is for
1914    memory allocated with malloc(); DYNARR_OVERHEAD is for dynamic
1915    arrays; GAP_OVERHEAD is for gap arrays.  Note that for (e.g.)
1916    dynamic arrays, there is both MALLOC_OVERHEAD and DYNARR_OVERHEAD
1917    memory: The dynamic array allocates memory above and beyond what
1918    was asked of it, and when it in turns allocates memory using
1919    malloc(), malloc() allocates memory beyond what it was asked
1920    to allocate.
1921
1922    Functions that accept a structure of this sort do not initialize
1923    the fields to 0, and add any existing values to whatever was there
1924    before; this way, you can get a cumulative effect. */
1925
1926 struct overhead_stats
1927 {
1928   int was_requested;
1929   int malloc_overhead;
1930   int dynarr_overhead;
1931   int gap_overhead;
1932 };
1933
1934 #endif /* MEMORY_USAGE_STATS */
1935
1936 #ifndef DIRECTORY_SEP
1937 #define DIRECTORY_SEP '/'
1938 #endif
1939 #ifndef IS_DIRECTORY_SEP
1940 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
1941 #endif
1942 #ifndef IS_DEVICE_SEP
1943 #ifndef DEVICE_SEP
1944 #define IS_DEVICE_SEP(c) 0
1945 #else
1946 #define IS_DEVICE_SEP(c) ((c) == DEVICE_SEP)
1947 #endif
1948 #endif
1949 #ifndef IS_ANY_SEP
1950 #define IS_ANY_SEP(c) IS_DIRECTORY_SEP (c)
1951 #endif
1952
1953 #ifdef HAVE_INTTYPES_H
1954 #include <inttypes.h>
1955 #elif SIZEOF_VOID_P == SIZEOF_INT
1956 typedef int intptr_t;
1957 typedef unsigned int uintptr_t;
1958 #elif SIZEOF_VOID_P == SIZEOF_LONG
1959 typedef long intptr_t;
1960 typedef unsigned long uintptr_t;
1961 #elif defined(SIZEOF_LONG_LONG) && SIZEOF_VOID_P == SIZEOF_LONG_LONG
1962 typedef long long intptr_t;
1963 typedef unsigned long long uintptr_t;
1964 #else
1965 /* Just pray. May break, may not. */
1966 typedef long intptr_t;
1967 typedef unsigned long uintptr_t;
1968 #endif
1969
1970 /* Defined in alloc.c */
1971 void release_breathing_space (void);
1972 Lisp_Object noseeum_cons (Lisp_Object, Lisp_Object);
1973 Lisp_Object make_vector (size_t, Lisp_Object);
1974 Lisp_Object vector1 (Lisp_Object);
1975 Lisp_Object vector2 (Lisp_Object, Lisp_Object);
1976 Lisp_Object vector3 (Lisp_Object, Lisp_Object, Lisp_Object);
1977 Lisp_Object make_bit_vector (size_t, Lisp_Object);
1978 Lisp_Object make_bit_vector_from_byte_vector (unsigned char *, size_t);
1979 Lisp_Object noseeum_make_marker (void);
1980 void garbage_collect_1 (void);
1981 Lisp_Object acons (Lisp_Object, Lisp_Object, Lisp_Object);
1982 Lisp_Object cons3 (Lisp_Object, Lisp_Object, Lisp_Object);
1983 Lisp_Object list1 (Lisp_Object);
1984 Lisp_Object list2 (Lisp_Object, Lisp_Object);
1985 Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
1986 Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
1987 Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
1988                    Lisp_Object);
1989 Lisp_Object list6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
1990                    Lisp_Object, Lisp_Object);
1991 DECLARE_DOESNT_RETURN (memory_full (void));
1992 void disksave_object_finalization (void);
1993 extern int purify_flag;
1994 extern int gc_currently_forbidden;
1995 Lisp_Object restore_gc_inhibit (Lisp_Object);
1996 extern EMACS_INT gc_generation_number[1];
1997 int c_readonly (Lisp_Object);
1998 int lisp_readonly (Lisp_Object);
1999 Lisp_Object build_string (const char *);
2000 Lisp_Object build_ext_string (const char *, Lisp_Object);
2001 Lisp_Object build_translated_string (const char *);
2002 Lisp_Object make_string (const Bufbyte *, Bytecount);
2003 Lisp_Object make_ext_string (const Extbyte *, EMACS_INT, Lisp_Object);
2004 Lisp_Object make_uninit_string (Bytecount);
2005 Lisp_Object make_float (double);
2006 Lisp_Object make_string_nocopy (const Bufbyte *, Bytecount);
2007 void free_cons (Lisp_Cons *);
2008 void free_list (Lisp_Object);
2009 void free_alist (Lisp_Object);
2010 void mark_conses_in_list (Lisp_Object);
2011 void free_marker (Lisp_Marker *);
2012 int object_dead_p (Lisp_Object);
2013 void mark_object (Lisp_Object obj);
2014 int marked_p (Lisp_Object obj);
2015
2016 #ifdef MEMORY_USAGE_STATS
2017 size_t malloced_storage_size (void *, size_t, struct overhead_stats *);
2018 size_t fixed_type_block_overhead (size_t);
2019 #endif
2020 #ifdef PDUMP
2021 void pdump (void);
2022 int pdump_load (const char *);
2023
2024 extern char *pdump_start, *pdump_end;
2025 #define DUMPEDP(adr) ((((char *)(adr)) < pdump_end) && (((char *)(adr)) >= pdump_start))
2026 #else
2027 #define DUMPEDP(adr) 0
2028 #endif
2029
2030 /* Defined in buffer.c */
2031 Lisp_Object make_buffer (struct buffer *);
2032 Lisp_Object get_truename_buffer (Lisp_Object);
2033 void switch_to_buffer (Lisp_Object, Lisp_Object);
2034 extern int find_file_compare_truenames;
2035 extern int find_file_use_truenames;
2036
2037 /* Defined in callproc.c */
2038 char *egetenv (const char *);
2039
2040 /* Defined in console.c */
2041 void stuff_buffered_input (Lisp_Object);
2042
2043 /* Defined in data.c */
2044 DECLARE_DOESNT_RETURN (c_write_error (Lisp_Object));
2045 DECLARE_DOESNT_RETURN (lisp_write_error (Lisp_Object));
2046 DECLARE_DOESNT_RETURN (args_out_of_range (Lisp_Object, Lisp_Object));
2047 DECLARE_DOESNT_RETURN (args_out_of_range_3 (Lisp_Object, Lisp_Object,
2048                                             Lisp_Object));
2049 Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
2050 DECLARE_DOESNT_RETURN (dead_wrong_type_argument (Lisp_Object, Lisp_Object));
2051 void check_int_range (EMACS_INT, EMACS_INT, EMACS_INT);
2052
2053 enum arith_comparison {
2054   arith_equal,
2055   arith_notequal,
2056   arith_less,
2057   arith_grtr,
2058   arith_less_or_equal,
2059   arith_grtr_or_equal };
2060 Lisp_Object arithcompare (Lisp_Object, Lisp_Object, enum arith_comparison);
2061
2062 Lisp_Object word_to_lisp (unsigned int);
2063 unsigned int lisp_to_word (Lisp_Object);
2064
2065 /* Defined in dired.c */
2066 Lisp_Object make_directory_hash_table (const char *);
2067 Lisp_Object wasteful_word_to_lisp (unsigned int);
2068
2069 /* Defined in doc.c */
2070 Lisp_Object unparesseuxify_doc_string (int, EMACS_INT, char *, Lisp_Object);
2071 Lisp_Object read_doc_string (Lisp_Object);
2072
2073 /* Defined in doprnt.c */
2074 Bytecount emacs_doprnt_c (Lisp_Object, const Bufbyte *, Lisp_Object,
2075                           Bytecount, ...);
2076 Bytecount emacs_doprnt_va (Lisp_Object, const Bufbyte *, Lisp_Object,
2077                            Bytecount, va_list);
2078 Bytecount emacs_doprnt_lisp (Lisp_Object, const Bufbyte *, Lisp_Object,
2079                              Bytecount, int, const Lisp_Object *);
2080 Bytecount emacs_doprnt_lisp_2 (Lisp_Object, const Bufbyte *, Lisp_Object,
2081                                Bytecount, int, ...);
2082 Lisp_Object emacs_doprnt_string_c (const Bufbyte *, Lisp_Object,
2083                                    Bytecount, ...);
2084 Lisp_Object emacs_doprnt_string_va (const Bufbyte *, Lisp_Object,
2085                                     Bytecount, va_list);
2086 Lisp_Object emacs_doprnt_string_lisp (const Bufbyte *, Lisp_Object,
2087                                       Bytecount, int, const Lisp_Object *);
2088 Lisp_Object emacs_doprnt_string_lisp_2 (const Bufbyte *, Lisp_Object,
2089                                         Bytecount, int, ...);
2090
2091 /* Defined in editfns.c */
2092 void uncache_home_directory (void);
2093 Extbyte *get_home_directory (void);
2094 char *user_login_name (uid_t *);
2095 Bufpos bufpos_clip_to_bounds (Bufpos, Bufpos, Bufpos);
2096 Bytind bytind_clip_to_bounds (Bytind, Bytind, Bytind);
2097 void buffer_insert1 (struct buffer *, Lisp_Object);
2098 Lisp_Object make_string_from_buffer (struct buffer *, Bufpos, Charcount);
2099 Lisp_Object make_string_from_buffer_no_extents (struct buffer *, Bufpos, Charcount);
2100 Lisp_Object save_excursion_save (void);
2101 Lisp_Object save_restriction_save (void);
2102 Lisp_Object save_excursion_restore (Lisp_Object);
2103 Lisp_Object save_restriction_restore (Lisp_Object);
2104
2105 /* Defined in emacsfns.c */
2106 Lisp_Object save_current_buffer_restore (Lisp_Object);
2107
2108 /* Defined in emacs.c */
2109 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (fatal (const char *,
2110                                                            ...), 1, 2);
2111 int stderr_out (const char *, ...) PRINTF_ARGS (1, 2);
2112 int stdout_out (const char *, ...) PRINTF_ARGS (1, 2);
2113 SIGTYPE fatal_error_signal (int);
2114 Lisp_Object make_arg_list (int, char **);
2115 void make_argc_argv (Lisp_Object, int *, char ***);
2116 void free_argc_argv (char **);
2117 Lisp_Object decode_env_path (const char *, const char *);
2118 Lisp_Object decode_path (const char *);
2119 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2120 extern int noninteractive, noninteractive1;
2121 extern int preparing_for_armageddon;
2122 extern int emacs_priority;
2123 extern int running_asynch_code;
2124 extern int suppress_early_error_handler_backtrace;
2125
2126 /* Defined in eval.c */
2127 DECLARE_DOESNT_RETURN (signal_error (Lisp_Object, Lisp_Object));
2128 void maybe_signal_error (Lisp_Object, Lisp_Object, Lisp_Object, Error_behavior);
2129 Lisp_Object maybe_signal_continuable_error (Lisp_Object, Lisp_Object,
2130                                             Lisp_Object, Error_behavior);
2131 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error (const char *,
2132                                                            ...), 1, 2);
2133 void maybe_error (Lisp_Object, Error_behavior, const char *,
2134                   ...) PRINTF_ARGS (3, 4);
2135 Lisp_Object continuable_error (const char *, ...) PRINTF_ARGS (1, 2);
2136 Lisp_Object maybe_continuable_error (Lisp_Object, Error_behavior,
2137                                      const char *, ...) PRINTF_ARGS (3, 4);
2138 DECLARE_DOESNT_RETURN (signal_simple_error (const char *, Lisp_Object));
2139 void maybe_signal_simple_error (const char *, Lisp_Object,
2140                                 Lisp_Object, Error_behavior);
2141 Lisp_Object signal_simple_continuable_error (const char *, Lisp_Object);
2142 Lisp_Object maybe_signal_simple_continuable_error (const char *, Lisp_Object,
2143                                                    Lisp_Object, Error_behavior);
2144 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error_with_frob
2145                                                     (Lisp_Object, const char *,
2146                                                      ...), 2, 3);
2147 void maybe_error_with_frob (Lisp_Object, Lisp_Object, Error_behavior,
2148                             const char *, ...) PRINTF_ARGS (4, 5);
2149 Lisp_Object continuable_error_with_frob (Lisp_Object, const char *,
2150                                          ...) PRINTF_ARGS (2, 3);
2151 Lisp_Object maybe_continuable_error_with_frob
2152 (Lisp_Object, Lisp_Object, Error_behavior, const char *, ...) PRINTF_ARGS (4, 5);
2153 DECLARE_DOESNT_RETURN (signal_simple_error_2 (const char *,
2154                                               Lisp_Object, Lisp_Object));
2155 void maybe_signal_simple_error_2 (const char *, Lisp_Object, Lisp_Object,
2156                                   Lisp_Object, Error_behavior);
2157 Lisp_Object signal_simple_continuable_error_2 (const char *,
2158                                                Lisp_Object, Lisp_Object);
2159 Lisp_Object maybe_signal_simple_continuable_error_2 (const char *, Lisp_Object,
2160                                                      Lisp_Object, Lisp_Object,
2161                                                      Error_behavior);
2162 DECLARE_DOESNT_RETURN (signal_malformed_list_error (Lisp_Object));
2163 DECLARE_DOESNT_RETURN (signal_malformed_property_list_error (Lisp_Object));
2164 DECLARE_DOESNT_RETURN (signal_circular_list_error (Lisp_Object));
2165 DECLARE_DOESNT_RETURN (signal_circular_property_list_error (Lisp_Object));
2166
2167 Lisp_Object signal_void_function_error (Lisp_Object);
2168 Lisp_Object signal_invalid_function_error (Lisp_Object);
2169 Lisp_Object signal_wrong_number_of_arguments_error (Lisp_Object, int);
2170
2171 Lisp_Object run_hook_with_args_in_buffer (struct buffer *, int, Lisp_Object *,
2172                                           enum run_hooks_condition);
2173 Lisp_Object run_hook_with_args (int, Lisp_Object *, enum run_hooks_condition);
2174 void va_run_hook_with_args (Lisp_Object, int, ...);
2175 void va_run_hook_with_args_in_buffer (struct buffer *, Lisp_Object, int, ...);
2176 Lisp_Object run_hook (Lisp_Object);
2177 Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2178 Lisp_Object call0 (Lisp_Object);
2179 Lisp_Object call1 (Lisp_Object, Lisp_Object);
2180 Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2181 Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2182 Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2183                    Lisp_Object);
2184 Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2185                    Lisp_Object, Lisp_Object);
2186 Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2187                    Lisp_Object, Lisp_Object, Lisp_Object);
2188 Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2189                    Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2190 Lisp_Object call8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2191                    Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2192                    Lisp_Object);
2193 Lisp_Object call0_in_buffer (struct buffer *, Lisp_Object);
2194 Lisp_Object call1_in_buffer (struct buffer *, Lisp_Object, Lisp_Object);
2195 Lisp_Object call2_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2196                              Lisp_Object);
2197 Lisp_Object call3_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2198                              Lisp_Object, Lisp_Object);
2199 Lisp_Object call4_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2200                              Lisp_Object, Lisp_Object, Lisp_Object);
2201 Lisp_Object call5_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2202                              Lisp_Object, Lisp_Object, Lisp_Object,
2203                              Lisp_Object);
2204 Lisp_Object call6_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2205                              Lisp_Object, Lisp_Object, Lisp_Object,
2206                              Lisp_Object, Lisp_Object);
2207 Lisp_Object eval_in_buffer (struct buffer *, Lisp_Object);
2208 Lisp_Object call0_with_handler (Lisp_Object, Lisp_Object);
2209 Lisp_Object call1_with_handler (Lisp_Object, Lisp_Object, Lisp_Object);
2210 Lisp_Object eval_in_buffer_trapping_errors (const char *, struct buffer *,
2211                                             Lisp_Object);
2212 Lisp_Object run_hook_trapping_errors (const char *, Lisp_Object);
2213 Lisp_Object safe_run_hook_trapping_errors (const char *, Lisp_Object, int);
2214 Lisp_Object call0_trapping_errors (const char *, Lisp_Object);
2215 Lisp_Object call1_trapping_errors (const char *, Lisp_Object, Lisp_Object);
2216 Lisp_Object call2_trapping_errors (const char *,
2217                                    Lisp_Object, Lisp_Object, Lisp_Object);
2218 Lisp_Object call_with_suspended_errors (lisp_fn_t, volatile Lisp_Object, Lisp_Object,
2219                                         Error_behavior, int, ...);
2220 /* C Code should be using internal_catch, record_unwind_p, condition_case_1 */
2221 Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object),
2222                             Lisp_Object, int * volatile);
2223 Lisp_Object condition_case_1 (Lisp_Object,
2224                               Lisp_Object (*) (Lisp_Object),
2225                               Lisp_Object,
2226                               Lisp_Object (*) (Lisp_Object, Lisp_Object),
2227                               Lisp_Object);
2228 Lisp_Object condition_case_3 (Lisp_Object, Lisp_Object, Lisp_Object);
2229 Lisp_Object unbind_to (int, Lisp_Object);
2230 void specbind (Lisp_Object, Lisp_Object);
2231 void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2232 void do_autoload (Lisp_Object, Lisp_Object);
2233 Lisp_Object un_autoload (Lisp_Object);
2234 void warn_when_safe_lispobj (Lisp_Object, Lisp_Object, Lisp_Object);
2235 void warn_when_safe (Lisp_Object, Lisp_Object, const char *,
2236                      ...) PRINTF_ARGS (3, 4);
2237
2238
2239 /* Defined in event-stream.c */
2240 void wait_delaying_user_input (int (*) (void *), void *);
2241 int detect_input_pending (void);
2242 void reset_this_command_keys (Lisp_Object, int);
2243 Lisp_Object enqueue_misc_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2244 Lisp_Object enqueue_misc_user_event_pos (Lisp_Object, Lisp_Object,
2245                                          Lisp_Object, int, int, int, int);
2246
2247 /* Defined in event-Xt.c */
2248 void signal_special_Xt_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2249
2250
2251 /* Defined in events.c */
2252 void clear_event_resource (void);
2253 Lisp_Object allocate_event (void);
2254
2255 /* Defined in fileio.c */
2256 void record_auto_save (void);
2257 void force_auto_save_soon (void);
2258 DECLARE_DOESNT_RETURN (report_file_error (const char *, Lisp_Object));
2259 void maybe_report_file_error (const char *, Lisp_Object,
2260                               Lisp_Object, Error_behavior);
2261 DECLARE_DOESNT_RETURN (signal_file_error (const char *, Lisp_Object));
2262 void maybe_signal_file_error (const char *, Lisp_Object,
2263                               Lisp_Object, Error_behavior);
2264 DECLARE_DOESNT_RETURN (signal_double_file_error (const char *, const char *,
2265                                                  Lisp_Object));
2266 void maybe_signal_double_file_error (const char *, const char *,
2267                                      Lisp_Object, Lisp_Object, Error_behavior);
2268 DECLARE_DOESNT_RETURN (signal_double_file_error_2 (const char *, const char *,
2269                                                    Lisp_Object, Lisp_Object));
2270 void maybe_signal_double_file_error_2 (const char *, const char *,
2271                                        Lisp_Object, Lisp_Object, Lisp_Object,
2272                                        Error_behavior);
2273 Lisp_Object lisp_strerror (int);
2274 Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
2275 ssize_t read_allowing_quit (int, void *, size_t);
2276 ssize_t write_allowing_quit (int, const void *, size_t);
2277 int internal_delete_file (Lisp_Object);
2278
2279 /* Defined in filelock.c */
2280 void lock_file (Lisp_Object);
2281 void unlock_file (Lisp_Object);
2282 void unlock_all_files (void);
2283 void unlock_buffer (struct buffer *);
2284
2285 /* Defined in filemode.c */
2286 void filemodestring (struct stat *, char *);
2287
2288 /* Defined in floatfns.c */
2289 double extract_float (Lisp_Object);
2290
2291 /* Defined in fns.c */
2292 Lisp_Object list_sort (Lisp_Object, Lisp_Object,
2293                        int (*) (Lisp_Object, Lisp_Object, Lisp_Object));
2294 Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
2295
2296 void bump_string_modiff (Lisp_Object);
2297 Lisp_Object memq_no_quit (Lisp_Object, Lisp_Object);
2298 Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2299 Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2300 Lisp_Object rassq_no_quit (Lisp_Object, Lisp_Object);
2301 Lisp_Object delq_no_quit (Lisp_Object, Lisp_Object);
2302 Lisp_Object delq_no_quit_and_free_cons (Lisp_Object, Lisp_Object);
2303 Lisp_Object remassoc_no_quit (Lisp_Object, Lisp_Object);
2304 Lisp_Object remassq_no_quit (Lisp_Object, Lisp_Object);
2305 Lisp_Object remrassq_no_quit (Lisp_Object, Lisp_Object);
2306
2307 int plists_differ (Lisp_Object, Lisp_Object, int, int, int);
2308 Lisp_Object internal_plist_get (Lisp_Object, Lisp_Object);
2309 void internal_plist_put (Lisp_Object *, Lisp_Object, Lisp_Object);
2310 int internal_remprop (Lisp_Object *, Lisp_Object);
2311 Lisp_Object external_plist_get (Lisp_Object *, Lisp_Object,
2312                                 int, Error_behavior);
2313 void external_plist_put (Lisp_Object *, Lisp_Object,
2314                          Lisp_Object, int, Error_behavior);
2315 int external_remprop (Lisp_Object *, Lisp_Object, int, Error_behavior);
2316 int internal_equal (Lisp_Object, Lisp_Object, int);
2317 Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2318 Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2319 Lisp_Object vconcat2 (Lisp_Object, Lisp_Object);
2320 Lisp_Object vconcat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2321 Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2322 Lisp_Object bytecode_nconc2 (Lisp_Object *);
2323 void check_losing_bytecode (const char *, Lisp_Object);
2324
2325 /* Defined in getloadavg.c */
2326 int getloadavg (double[], int);
2327
2328 /* Defined in glyphs.c */
2329 Error_behavior decode_error_behavior_flag (Lisp_Object);
2330 Lisp_Object encode_error_behavior_flag (Error_behavior);
2331
2332 /* Defined in indent.c */
2333 int bi_spaces_at_point (struct buffer *, Bytind);
2334 int column_at_point (struct buffer *, Bufpos, int);
2335 int string_column_at_point (Lisp_String *, Bufpos, int);
2336 int current_column (struct buffer *);
2337 void invalidate_current_column (void);
2338 Bufpos vmotion (struct window *, Bufpos, int, int *);
2339 Bufpos vmotion_pixels (Lisp_Object, Bufpos, int, int, int *);
2340
2341 /* Defined in keymap.c */
2342 void where_is_to_char (Lisp_Object, char *);
2343
2344 /* Defined in lread.c */
2345 void ebolify_bytecode_constants (Lisp_Object);
2346 void close_load_descs (void);
2347 int locate_file (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object *, int);
2348 EXFUN (Flocate_file_clear_hashing, 1);
2349 int isfloat_string (const char *);
2350
2351 /* Well, I've decided to enable this. -- ben */
2352 /* And I've decided to make it work right.  -- sb */
2353 #define LOADHIST
2354 /* Define the following symbol to enable load history of dumped files */
2355 #define LOADHIST_DUMPED
2356 /* Define the following symbol to enable load history of C source */
2357 #define LOADHIST_BUILTIN
2358
2359 #ifdef LOADHIST /* this is just a stupid idea */
2360 #define LOADHIST_ATTACH(x) \
2361  do { if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); } \
2362  while (0)
2363 #else /*! LOADHIST */
2364 # define LOADHIST_ATTACH(x)
2365 #endif /*! LOADHIST */
2366
2367 /* Defined in marker.c */
2368 Bytind bi_marker_position (Lisp_Object);
2369 Bufpos marker_position (Lisp_Object);
2370 void set_bi_marker_position (Lisp_Object, Bytind);
2371 void set_marker_position (Lisp_Object, Bufpos);
2372 void unchain_marker (Lisp_Object);
2373 Lisp_Object noseeum_copy_marker (Lisp_Object, Lisp_Object);
2374 Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
2375 #ifdef MEMORY_USAGE_STATS
2376 int compute_buffer_marker_usage (struct buffer *, struct overhead_stats *);
2377 #endif
2378
2379 /* Defined in menubar.c */
2380 extern int popup_menu_up_p;
2381 extern int menubar_show_keybindings;
2382 extern int popup_menu_titles;
2383
2384 /* Defined in minibuf.c */
2385 extern int minibuf_level;
2386 Charcount scmp_1 (const Bufbyte *, const Bufbyte *, Charcount, int);
2387 #define scmp(s1, s2, len) scmp_1 (s1, s2, len, completion_ignore_case)
2388 extern int completion_ignore_case;
2389 int regexp_ignore_completion_p (const Bufbyte *, Lisp_Object,
2390                                 Bytecount, Bytecount);
2391 Lisp_Object clear_echo_area (struct frame *, Lisp_Object, int);
2392 Lisp_Object clear_echo_area_from_print (struct frame *, Lisp_Object, int);
2393 void echo_area_append (struct frame *, const Bufbyte *, Lisp_Object,
2394                        Bytecount, Bytecount, Lisp_Object);
2395 void echo_area_message (struct frame *, const Bufbyte *, Lisp_Object,
2396                         Bytecount, Bytecount, Lisp_Object);
2397 Lisp_Object echo_area_status (struct frame *);
2398 int echo_area_active (struct frame *);
2399 Lisp_Object echo_area_contents (struct frame *);
2400 void message_internal (const Bufbyte *, Lisp_Object, Bytecount, Bytecount);
2401 void message_append_internal (const Bufbyte *, Lisp_Object,
2402                               Bytecount, Bytecount);
2403 void message (const char *, ...) PRINTF_ARGS (1, 2);
2404 void message_append (const char *, ...) PRINTF_ARGS (1, 2);
2405 void message_no_translate (const char *, ...) PRINTF_ARGS (1, 2);
2406 void clear_message (void);
2407
2408 /* Defined in print.c */
2409 void write_string_to_stdio_stream (FILE *, struct console *,
2410                                    const Bufbyte *, Bytecount, Bytecount,
2411                                    Lisp_Object, int);
2412 void debug_print (Lisp_Object);
2413 void debug_short_backtrace (int);
2414 void temp_output_buffer_setup (Lisp_Object);
2415 void temp_output_buffer_show (Lisp_Object, Lisp_Object);
2416 /* NOTE: Do not call this with the data of a Lisp_String.  Use princ.
2417  * Note: stream should be defaulted before calling
2418  *  (eg Qnil means stdout, not Vstandard_output, etc) */
2419 void write_c_string (const char *, Lisp_Object);
2420 /* Same goes for this function. */
2421 void write_string_1 (const Bufbyte *, Bytecount, Lisp_Object);
2422 void print_cons (Lisp_Object, Lisp_Object, int);
2423 void print_vector (Lisp_Object, Lisp_Object, int);
2424 void print_string (Lisp_Object, Lisp_Object, int);
2425 void long_to_string (char *, long);
2426 void print_internal (Lisp_Object, Lisp_Object, int);
2427 void print_symbol (Lisp_Object, Lisp_Object, int);
2428 void print_float (Lisp_Object, Lisp_Object, int);
2429 extern int print_escape_newlines;
2430 extern int print_readably;
2431 Lisp_Object internal_with_output_to_temp_buffer (Lisp_Object,
2432                                                  Lisp_Object (*) (Lisp_Object),
2433                                                  Lisp_Object, Lisp_Object);
2434 void float_to_string (char *, double);
2435 void internal_object_printer (Lisp_Object, Lisp_Object, int);
2436
2437 /* Defined in profile.c */
2438 void mark_profiling_info (void);
2439 void profile_increase_call_count (Lisp_Object);
2440 extern int profiling_active;
2441 extern int profiling_redisplay_flag;
2442
2443 /* Defined in rangetab.c */
2444 void put_range_table (Lisp_Object, EMACS_INT, EMACS_INT, Lisp_Object);
2445 int unified_range_table_bytes_needed (Lisp_Object);
2446 int unified_range_table_bytes_used (void *);
2447 void unified_range_table_copy_data (Lisp_Object, void *);
2448 Lisp_Object unified_range_table_lookup (void *, EMACS_INT, Lisp_Object);
2449 int unified_range_table_nentries (void *);
2450 void unified_range_table_get_range (void *, int, EMACS_INT *, EMACS_INT *,
2451                                     Lisp_Object *);
2452
2453 /* Defined in search.c */
2454 struct re_pattern_buffer;
2455 struct re_registers;
2456 Bufpos scan_buffer (struct buffer *, Emchar, Bufpos, Bufpos, EMACS_INT, EMACS_INT *, int);
2457 Bufpos find_next_newline (struct buffer *, Bufpos, int);
2458 Bufpos find_next_newline_no_quit (struct buffer *, Bufpos, int);
2459 Bytind bi_find_next_newline_no_quit (struct buffer *, Bytind, int);
2460 Bytind bi_find_next_emchar_in_string (Lisp_String*, Emchar, Bytind, EMACS_INT);
2461 Bufpos find_before_next_newline (struct buffer *, Bufpos, Bufpos, int);
2462 struct re_pattern_buffer *compile_pattern (Lisp_Object, struct re_registers *,
2463                                            char *, int, Error_behavior);
2464 Bytecount fast_string_match (Lisp_Object,  const Bufbyte *,
2465                              Lisp_Object, Bytecount,
2466                              Bytecount, int, Error_behavior, int);
2467 Bytecount fast_lisp_string_match (Lisp_Object, Lisp_Object);
2468 void restore_match_data (void);
2469
2470 /* Defined in signal.c */
2471 void init_interrupts_late (void);
2472 extern int dont_check_for_quit;
2473 void begin_dont_check_for_quit (void);
2474 void emacs_sleep (int);
2475
2476 /* Defined in sound.c */
2477 void init_device_sound (struct device *);
2478
2479 /* Defined in specifier.c */
2480 Lisp_Object specifier_instance (Lisp_Object, Lisp_Object, Lisp_Object,
2481                                 Error_behavior, int, int, Lisp_Object);
2482 Lisp_Object specifier_instance_no_quit (Lisp_Object, Lisp_Object, Lisp_Object,
2483                                         Error_behavior, int, Lisp_Object);
2484
2485 /* Defined in symbols.c */
2486 int hash_string (const Bufbyte *, Bytecount);
2487 Lisp_Object intern (const char *);
2488 Lisp_Object oblookup (Lisp_Object, const Bufbyte *, Bytecount);
2489 void map_obarray (Lisp_Object, int (*) (Lisp_Object, void *), void *);
2490 Lisp_Object indirect_function (Lisp_Object, int);
2491 Lisp_Object symbol_value_in_buffer (Lisp_Object, Lisp_Object);
2492 void kill_buffer_local_variables (struct buffer *);
2493 int symbol_value_buffer_local_info (Lisp_Object, struct buffer *);
2494 Lisp_Object find_symbol_value (Lisp_Object);
2495 Lisp_Object find_symbol_value_quickly (Lisp_Object, int);
2496 Lisp_Object top_level_value (Lisp_Object);
2497 void reject_constant_symbols (Lisp_Object sym, Lisp_Object newval,
2498                               int function_p,
2499                               Lisp_Object follow_past_lisp_magic);
2500
2501 /* Defined in syntax.c */
2502 Bufpos scan_words (struct buffer *, Bufpos, int);
2503
2504 /* Defined in undo.c */
2505 Lisp_Object truncate_undo_list (Lisp_Object, int, int);
2506 void record_extent (Lisp_Object, int);
2507 void record_insert (struct buffer *, Bufpos, Charcount);
2508 void record_delete (struct buffer *, Bufpos, Charcount);
2509 void record_change (struct buffer *, Bufpos, Charcount);
2510
2511 /* Defined in unex*.c */
2512 int unexec (char *, char *, uintptr_t, uintptr_t, uintptr_t);
2513 #ifdef RUN_TIME_REMAP
2514 int run_time_remap (char *);
2515 #endif
2516
2517 /* Defined in vm-limit.c */
2518 void memory_warnings (void *, void (*) (const char *));
2519
2520 /* Defined in window.c */
2521 Lisp_Object save_window_excursion_unwind (Lisp_Object);
2522 Lisp_Object display_buffer (Lisp_Object, Lisp_Object, Lisp_Object);
2523
2524 /* The following were machine generated 19980312 */
2525
2526
2527 EXFUN (Faccept_process_output, 3);
2528 EXFUN (Fadd1, 1);
2529 EXFUN (Fadd_spec_to_specifier, 5);
2530 EXFUN (Fadd_timeout, 4);
2531 EXFUN (Fappend, MANY);
2532 EXFUN (Fapply, MANY);
2533 EXFUN (Faref, 2);
2534 EXFUN (Faset, 3);
2535 EXFUN (Fassoc, 2);
2536 EXFUN (Fassq, 2);
2537 EXFUN (Fbacktrace, 2);
2538 EXFUN (Fbeginning_of_line, 2);
2539 EXFUN (Fbobp, 1);
2540 EXFUN (Fbolp, 1);
2541 EXFUN (Fboundp, 1);
2542 EXFUN (Fbuffer_substring, 3);
2543 EXFUN (Fbuilt_in_variable_type, 1);
2544 EXFUN (Fbyte_code, 3);
2545 EXFUN (Fcall_interactively, 3);
2546 EXFUN (Fcanonicalize_lax_plist, 2);
2547 EXFUN (Fcanonicalize_plist, 2);
2548 EXFUN (Fcar, 1);
2549 EXFUN (Fcar_safe, 1);
2550 EXFUN (Fcdr, 1);
2551 EXFUN (Fchar_after, 2);
2552 EXFUN (Fchar_to_string, 1);
2553 EXFUN (Fcheck_valid_plist, 1);
2554 EXFUN (Fvalid_plist_p, 1);
2555 EXFUN (Fclear_range_table, 1);
2556 EXFUN (Fcoding_category_list, 0);
2557 EXFUN (Fcoding_category_system, 1);
2558 EXFUN (Fcoding_priority_list, 0);
2559 EXFUN (Fcoding_system_charset, 2);
2560 EXFUN (Fcoding_system_doc_string, 1);
2561 EXFUN (Fcoding_system_list, 0);
2562 EXFUN (Fcoding_system_name, 1);
2563 EXFUN (Fcoding_system_p, 1);
2564 EXFUN (Fcoding_system_property, 2);
2565 EXFUN (Fcoding_system_type, 1);
2566 EXFUN (Fcommand_execute, 3);
2567 EXFUN (Fcommandp, 1);
2568 EXFUN (Fconcat, MANY);
2569 EXFUN (Fcons, 2);
2570 EXFUN (Fcopy_alist, 1);
2571 EXFUN (Fcopy_coding_system, 2);
2572 EXFUN (Fcopy_event, 2);
2573 EXFUN (Fcopy_list, 1);
2574 EXFUN (Fcopy_marker, 2);
2575 EXFUN (Fcopy_sequence, 1);
2576 EXFUN (Fcopy_tree, 2);
2577 EXFUN (Fcurrent_window_configuration, 1);
2578 EXFUN (Fdecode_big5_char, 1);
2579 EXFUN (Fdecode_coding_region, 4);
2580 EXFUN (Fdecode_shift_jis_char, 1);
2581 EXFUN (Fdefault_boundp, 1);
2582 EXFUN (Fdefault_value, 1);
2583 EXFUN (Fdefine_key, 3);
2584 EXFUN (Fdelete_region, 3);
2585 EXFUN (Fdelete_process, 1);
2586 EXFUN (Fdelq, 2);
2587 EXFUN (Fdestructive_alist_to_plist, 1);
2588 EXFUN (Fdetect_coding_region, 3);
2589 EXFUN (Fdgettext, 2);
2590 EXFUN (Fding, 3);
2591 EXFUN (Fdirectory_file_name, 1);
2592 EXFUN (Fdisable_timeout, 1);
2593 EXFUN (Fdiscard_input, 0);
2594 EXFUN (Fdispatch_event, 1);
2595 EXFUN (Fdisplay_error, 2);
2596 EXFUN (Fdo_auto_save, 2);
2597 EXFUN (Fdowncase, 2);
2598 EXFUN (Felt, 2);
2599 EXFUN (Fencode_big5_char, 1);
2600 EXFUN (Fencode_coding_region, 4);
2601 EXFUN (Fencode_shift_jis_char, 1);
2602 EXFUN (Fend_of_line, 2);
2603 EXFUN (Fenqueue_eval_event, 2);
2604 EXFUN (Feobp, 1);
2605 EXFUN (Feolp, 1);
2606 EXFUN (Fequal, 2);
2607 EXFUN (Ferror_message_string, 1);
2608 EXFUN (Feval, 1);
2609 EXFUN (Fevent_to_character, 4);
2610 EXFUN (Fexecute_kbd_macro, 2);
2611 EXFUN (Fexpand_abbrev, 0);
2612 EXFUN (Fexpand_file_name, 2);
2613 EXFUN (Fextent_at, 5);
2614 EXFUN (Fextent_property, 3);
2615 EXFUN (Ffboundp, 1);
2616 EXFUN (Ffile_accessible_directory_p, 1);
2617 EXFUN (Ffile_directory_p, 1);
2618 EXFUN (Ffile_executable_p, 1);
2619 EXFUN (Ffile_exists_p, 1);
2620 EXFUN (Ffile_name_absolute_p, 1);
2621 EXFUN (Ffile_name_as_directory, 1);
2622 EXFUN (Ffile_name_directory, 1);
2623 EXFUN (Ffile_name_nondirectory, 1);
2624 EXFUN (Ffile_readable_p, 1);
2625 EXFUN (Ffile_symlink_p, 1);
2626 EXFUN (Ffile_truename, 2);
2627 EXFUN (Ffind_coding_system, 1);
2628 EXFUN (Ffind_file_name_handler, 2);
2629 EXFUN (Ffollowing_char, 1);
2630 EXFUN (Fformat, MANY);
2631 EXFUN (Fforward_char, 2);
2632 EXFUN (Fforward_line, 2);
2633 EXFUN (Ffset, 2);
2634 EXFUN (Ffuncall, MANY);
2635 EXFUN (Fgeq, MANY);
2636 EXFUN (Fget, 3);
2637 EXFUN (Fget_buffer_process, 1);
2638 EXFUN (Fget_coding_system, 1);
2639 EXFUN (Fget_process, 1);
2640 EXFUN (Fget_range_table, 3);
2641 EXFUN (Fgettext, 1);
2642 EXFUN (Fgoto_char, 2);
2643 EXFUN (Fgtr, MANY);
2644 EXFUN (Findent_to, 3);
2645 EXFUN (Findirect_function, 1);
2646 EXFUN (Finsert, MANY);
2647 EXFUN (Finsert_buffer_substring, 3);
2648 EXFUN (Finsert_char, 4);
2649 EXFUN (Finsert_file_contents_internal, 7);
2650 EXFUN (Finteractive_p, 0);
2651 EXFUN (Fintern, 2);
2652 EXFUN (Fintern_soft, 2);
2653 EXFUN (Fkey_description, 1);
2654 EXFUN (Fkill_emacs, 1);
2655 EXFUN (Fkill_local_variable, 1);
2656 EXFUN (Flax_plist_get, 3);
2657 EXFUN (Flax_plist_remprop, 2);
2658 EXFUN (Flength, 1);
2659 EXFUN (Fleq, MANY);
2660 EXFUN (Flist, MANY);
2661 EXFUN (Flistp, 1);
2662 EXFUN (Flist_modules, 0);
2663 EXFUN (Fload_module, 3);
2664 EXFUN (Flookup_key, 3);
2665 EXFUN (Flss, MANY);
2666 EXFUN (Fmake_byte_code, MANY);
2667 EXFUN (Fmake_coding_system, 4);
2668 EXFUN (Fmake_glyph_internal, 1);
2669 EXFUN (Fmake_list, 2);
2670 EXFUN (Fmake_marker, 0);
2671 EXFUN (Fmake_range_table, 0);
2672 EXFUN (Fmake_sparse_keymap, 1);
2673 EXFUN (Fmake_string, 2);
2674 EXFUN (Fmake_symbol, 1);
2675 EXFUN (Fmake_vector, 2);
2676 EXFUN (Fmapcar, 2);
2677 EXFUN (Fmarker_buffer, 1);
2678 EXFUN (Fmarker_position, 1);
2679 EXFUN (Fmatch_beginning, 1);
2680 EXFUN (Fmatch_end, 1);
2681 EXFUN (Fmax, MANY);
2682 EXFUN (Fmember, 2);
2683 EXFUN (Fmemq, 2);
2684 EXFUN (Fmin, MANY);
2685 EXFUN (Fminus, MANY);
2686 EXFUN (Fnarrow_to_region, 3);
2687 EXFUN (Fnconc, MANY);
2688 EXFUN (Fnext_event, 2);
2689 EXFUN (Fnreverse, 1);
2690 EXFUN (Fnthcdr, 2);
2691 EXFUN (Fnumber_to_string, 1);
2692 EXFUN (Fold_assq, 2);
2693 EXFUN (Fold_equal, 2);
2694 EXFUN (Fold_member, 2);
2695 EXFUN (Fold_memq, 2);
2696 EXFUN (Fplist_get, 3);
2697 EXFUN (Fplist_member, 2);
2698 EXFUN (Fplist_put, 3);
2699 EXFUN (Fplus, MANY);
2700 EXFUN (Fpoint, 1);
2701 EXFUN (Fpoint_marker, 2);
2702 EXFUN (Fpoint_max, 1);
2703 EXFUN (Fpoint_min, 1);
2704 EXFUN (Fpreceding_char, 1);
2705 EXFUN (Fprefix_numeric_value, 1);
2706 EXFUN (Fprin1, 2);
2707 EXFUN (Fprin1_to_string, 2);
2708 EXFUN (Fprinc, 2);
2709 EXFUN (Fprint, 2);
2710 EXFUN (Fprocess_status, 1);
2711 EXFUN (Fprogn, UNEVALLED);
2712 EXFUN (Fprovide, 1);
2713 EXFUN (Fput, 3);
2714 EXFUN (Fput_range_table, 4);
2715 EXFUN (Fput_text_property, 5);
2716 EXFUN (Fquo, MANY);
2717 EXFUN (Frassq, 2);
2718 EXFUN (Fread, 1);
2719 EXFUN (Fread_key_sequence, 3);
2720 EXFUN (Freally_free, 1);
2721 EXFUN (Frem, 2);
2722 EXFUN (Fremassq, 2);
2723 EXFUN (Fselected_frame, 1);
2724 EXFUN (Fset, 2);
2725 EXFUN (Fset_coding_category_system, 2);
2726 EXFUN (Fset_coding_priority_list, 1);
2727 EXFUN (Fset_default, 2);
2728 EXFUN (Fset_marker, 3);
2729 EXFUN (Fset_standard_case_table, 1);
2730 EXFUN (Fsetcar, 2);
2731 EXFUN (Fsetcdr, 2);
2732 EXFUN (Fsignal, 2);
2733 EXFUN (Fsit_for, 2);
2734 EXFUN (Fskip_chars_backward, 3);
2735 EXFUN (Fskip_chars_forward, 3);
2736 EXFUN (Fsleep_for, 1);
2737 EXFUN (Fsort, 2);
2738 EXFUN (Fspecifier_spec_list, 4);
2739 EXFUN (Fstring_equal, 2);
2740 EXFUN (Fstring_lessp, 2);
2741 EXFUN (Fstring_match, 4);
2742 EXFUN (Fsub1, 1);
2743 EXFUN (Fsubr_max_args, 1);
2744 EXFUN (Fsubr_min_args, 1);
2745 EXFUN (Fsubsidiary_coding_system, 2);
2746 EXFUN (Fsubstitute_command_keys, 1);
2747 EXFUN (Fsubstitute_in_file_name, 1);
2748 EXFUN (Fsubstring, 3);
2749 EXFUN (Fsymbol_function, 1);
2750 EXFUN (Fsymbol_name, 1);
2751 EXFUN (Fsymbol_plist, 1);
2752 EXFUN (Fsymbol_value, 1);
2753 EXFUN (Fsystem_name, 0);
2754 EXFUN (Fthrow, 2);
2755 EXFUN (Ftimes, MANY);
2756 EXFUN (Ftruncate, 1);
2757 EXFUN (Fundo_boundary, 0);
2758 EXFUN (Funhandled_file_name_directory, 1);
2759 EXFUN (Funlock_buffer, 0);
2760 EXFUN (Fupcase, 2);
2761 EXFUN (Fupcase_initials, 2);
2762 EXFUN (Fupcase_initials_region, 3);
2763 EXFUN (Fupcase_region, 3);
2764 EXFUN (Fuser_home_directory, 0);
2765 EXFUN (Fuser_login_name, 1);
2766 EXFUN (Fvector, MANY);
2767 EXFUN (Fverify_visited_file_modtime, 1);
2768 EXFUN (Fvertical_motion, 3);
2769 EXFUN (Fwiden, 1);
2770
2771
2772 extern Lisp_Object Q_style, Qactually_requested, Qactivate_menubar_hook;
2773 extern Lisp_Object Qafter, Qall, Qand;
2774 extern Lisp_Object Qarith_error, Qarrayp, Qassoc, Qat, Qautodetect, Qautoload;
2775 extern Lisp_Object Qbackground, Qbackground_pixmap, Qbad_variable, Qbefore;
2776 extern Lisp_Object Qbeginning_of_buffer, Qbig5, Qbinary;
2777 extern Lisp_Object Qbitmap, Qbitp, Qblinking;
2778 extern Lisp_Object Qboolean, Qbottom, Qbottom_margin, Qbuffer;
2779 extern Lisp_Object Qbuffer_glyph_p, Qbuffer_live_p, Qbuffer_read_only, Qbutton;
2780 extern Lisp_Object Qbyte_code, Qcall_interactively, Qcategory;
2781 extern Lisp_Object Qcategory_designator_p, Qcategory_table_value_p, Qccl, Qcdr;
2782 extern Lisp_Object Qchannel, Qchar, Qchar_or_string_p, Qcharacter, Qcharacterp;
2783 extern Lisp_Object Qchars, Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
2784 extern Lisp_Object Qcenter, Qcircular_list, Qcircular_property_list;
2785 extern Lisp_Object Qcoding_system_error;
2786 extern Lisp_Object Qcolor, Qcolor_pixmap_image_instance_p;
2787 extern Lisp_Object Qcolumns, Qcommand, Qcommandp, Qcompletion_ignore_case;
2788 extern Lisp_Object Qconsole, Qconsole_live_p, Qconst_specifier, Qcr, Qcritical;
2789 extern Lisp_Object Qcrlf, Qctext, Qcurrent_menubar, Qctext, Qcursor;
2790 extern Lisp_Object Qcyclic_variable_indirection, Qdata, Qdead, Qdecode;
2791 extern Lisp_Object Qdefault, Qdefun, Qdelete, Qdelq, Qdevice, Qdevice_live_p;
2792 extern Lisp_Object Qdim, Qdimension, Qdisabled, Qdisplay, Qdisplay_table;
2793 extern Lisp_Object Qdoc_string, Qdomain_error, Qduplex, Qdynarr_overhead;
2794 extern Lisp_Object Qempty, Qencode, Qend_of_buffer, Qend_of_file, Qend_open;
2795 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type, Qeq, Qeql, Qequal;
2796 extern Lisp_Object Qerror, Qerror_conditions, Qerror_message, Qescape_quoted;
2797 extern Lisp_Object Qeval, Qevent_live_p, Qexit, Qextent_live_p, Qextents;
2798 extern Lisp_Object Qexternal_debugging_output, Qface, Qfeaturep;
2799 extern Lisp_Object Qfile_name, Qfile_error;
2800 extern Lisp_Object Qfont, Qforce_g0_on_output, Qforce_g1_on_output;
2801 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output, Qforeground;
2802 extern Lisp_Object Qformat, Qframe, Qframe_live_p, Qfunction, Qgap_overhead;
2803 extern Lisp_Object Qgeneric, Qgeometry, Qglobal, Qheight;
2804 extern Lisp_Object Qhighlight, Qhorizontal, Qicon;
2805 extern Lisp_Object Qicon_glyph_p, Qid, Qidentity, Qimage, Qinfo, Qinherit;
2806 extern Lisp_Object Qinhibit_quit, Qinhibit_read_only;
2807 extern Lisp_Object Qinput_charset_conversion, Qinteger;
2808 extern Lisp_Object Qinteger_char_or_marker_p, Qinteger_or_char_p;
2809 extern Lisp_Object Qinteger_or_marker_p, Qintegerp, Qinteractive, Qinternal;
2810 extern Lisp_Object Qinvalid_function, Qinvalid_read_syntax, Qio_error;
2811 extern Lisp_Object Qiso2022, Qkey, Qkey_assoc, Qkeyboard, Qkeymap;
2812 extern Lisp_Object Qlambda, Qlayout, Qlandscape, Qleft, Qleft_margin, Qlf;
2813 extern Lisp_Object Qlist, Qlistp, Qload, Qlock_shift, Qmacro, Qmagic;
2814 extern Lisp_Object Qmakunbound, Qmalformed_list, Qmalformed_property_list;
2815 extern Lisp_Object Qmalloc_overhead, Qmark, Qmarkers;
2816 extern Lisp_Object Qmax, Qmemory, Qmessage, Qminus, Qmnemonic, Qmodifiers;
2817 extern Lisp_Object Qmono_pixmap_image_instance_p, Qmotion;
2818 extern Lisp_Object Qmouse_leave_buffer_hook, Qmsprinter, Qmswindows;
2819 extern Lisp_Object Qname, Qnas, Qnatnump;
2820 extern Lisp_Object Qno_ascii_cntl, Qno_ascii_eol, Qno_catch;
2821 extern Lisp_Object Qno_conversion, Qno_iso6429, Qnone, Qnot, Qnothing;
2822 extern Lisp_Object Qnothing_image_instance_p, Qnotice;
2823 extern Lisp_Object Qnumber_char_or_marker_p, Qnumberp;
2824 extern Lisp_Object Qobject, Qold_assoc, Qold_delete, Qold_delq, Qold_rassoc;
2825 extern Lisp_Object Qold_rassq, Qonly, Qor, Qother;
2826 extern Lisp_Object Qorientation, Qoutput_charset_conversion;
2827 extern Lisp_Object Qoverflow_error, Qpoint, Qpointer, Qpointer_glyph_p;
2828 extern Lisp_Object Qpointer_image_instance_p, Qportrait, Qpost_read_conversion;
2829 extern Lisp_Object Qpre_write_conversion, Qprint, Qprinter, Qprint_length;
2830 extern Lisp_Object Qprint_string_length, Qprocess, Qprogn, Qprovide, Qquit;
2831 extern Lisp_Object Qquote, Qrange_error, Qrassoc, Qrassq, Qread_char;
2832 extern Lisp_Object Qread_from_minibuffer, Qreally_early_error_handler;
2833 extern Lisp_Object Qregion_beginning, Qregion_end, Qrequire, Qresource;
2834 extern Lisp_Object Qreturn, Qreverse, Qright, Qright_margin;
2835 extern Lisp_Object Qrun_hooks, Qsans_modifiers;
2836 extern Lisp_Object Qsave_buffers_kill_emacs, Qsearch, Qselected;
2837 extern Lisp_Object Qself_insert_command, Qself_insert_defer_undo;
2838 extern Lisp_Object Qsequencep, Qset, Qsetting_constant;
2839 extern Lisp_Object Qseven, Qshift_jis, Qshort;
2840 extern Lisp_Object Qsignal, Qsimple, Qsingularity_error, Qsize, Qspace;
2841 extern Lisp_Object Qspecifier, Qstandard_input, Qstandard_output, Qstart_open;
2842 extern Lisp_Object Qstream, Qstring, Qstring_lessp, Qsubwindow;
2843 extern Lisp_Object Qsubwindow_image_instance_p;
2844 extern Lisp_Object Qsymbol, Qsyntax, Qt, Qterminal, Qtest;
2845 extern Lisp_Object Qtext, Qtext_image_instance_p, Qtimeout, Qtimestamp;
2846 extern Lisp_Object Qtoolbar, Qtop, Qtop_margin, Qtop_level;
2847 extern Lisp_Object Qtrue_list_p, Qtty, Qtype;
2848 extern Lisp_Object Qunbound, Qundecided, Qundefined, Qunderflow_error;
2849 extern Lisp_Object Qunderline, Qunimplemented, Quser_files_and_directories;
2850 extern Lisp_Object Qvalue_assoc, Qvalues;
2851 extern Lisp_Object Qvariable_documentation, Qvariable_domain, Qvertical;
2852 extern Lisp_Object Qvoid_function, Qvoid_variable, Qwarning;
2853 extern Lisp_Object Qwidth, Qwidget, Qwindow;
2854 extern Lisp_Object Qwindow_live_p, Qwindow_system, Qwrong_number_of_arguments;
2855 extern Lisp_Object Qwrong_type_argument, Qx, Qy, Qyes_or_no_p;
2856 extern Lisp_Object Vactivate_menubar_hook, Vascii_canon_table;
2857 extern Lisp_Object Vascii_downcase_table, Vascii_eqv_table;
2858 extern Lisp_Object Vascii_upcase_table, Vautoload_queue, Vblank_menubar;
2859 extern Lisp_Object Vcharset_ascii, Vcharset_composite, Vcharset_control_1;
2860 extern Lisp_Object Vcoding_system_for_read, Vcoding_system_for_write;
2861 extern Lisp_Object Vcoding_system_hash_table, Vcommand_history;
2862 extern Lisp_Object Vcommand_line_args, Vconfigure_info_directory;
2863 extern Lisp_Object Vconfigure_site_directory, Vconfigure_site_module_directory;
2864 extern Lisp_Object Vconsole_list, Vcontrolling_terminal;
2865 extern Lisp_Object Vcurrent_compiled_function_annotation, Vcurrent_load_list;
2866 extern Lisp_Object Vcurrent_mouse_event, Vcurrent_prefix_arg, Vdata_directory;
2867 extern Lisp_Object Vdirectory_sep_char, Vdisabled_command_hook;
2868 extern Lisp_Object Vdoc_directory, Vinternal_doc_file_name;
2869 extern Lisp_Object Vecho_area_buffer, Vemacs_major_version;
2870 extern Lisp_Object Vemacs_minor_version, Vexec_directory, Vexec_path;
2871 extern Lisp_Object Vexecuting_macro, Vfeatures, Vfile_domain;
2872 extern Lisp_Object Vfile_name_coding_system, Vinhibit_quit;
2873 extern Lisp_Object Vinvocation_directory, Vinvocation_name;
2874 extern Lisp_Object Vkeyboard_coding_system, Vlast_command, Vlast_command_char;
2875 extern Lisp_Object Vlast_command_event, Vlast_input_event;
2876 extern Lisp_Object Vload_file_name_internal;
2877 extern Lisp_Object Vload_file_name_internal_the_purecopy, Vload_history;
2878 extern Lisp_Object Vload_path, Vmark_even_if_inactive, Vmenubar_configuration;
2879 extern Lisp_Object Vminibuf_preprompt, Vminibuf_prompt, Vminibuffer_zero;
2880 extern Lisp_Object Vmirror_ascii_canon_table, Vmirror_ascii_downcase_table;
2881 extern Lisp_Object Vmirror_ascii_eqv_table, Vmirror_ascii_upcase_table;
2882 extern Lisp_Object Vmodule_directory, Vmswindows_downcase_file_names;
2883 extern Lisp_Object Vmswindows_get_true_file_attributes, Vobarray;
2884 extern Lisp_Object Vprint_length, Vprint_level, Vprocess_environment;
2885 extern Lisp_Object Vquit_flag;
2886 extern Lisp_Object Vrecent_keys_ring, Vshell_file_name, Vsite_directory;
2887 extern Lisp_Object Vsite_module_directory;
2888 extern Lisp_Object Vstandard_input, Vstandard_output, Vstdio_str;
2889 extern Lisp_Object Vsynchronous_sounds, Vsystem_name, Vterminal_coding_system;
2890 extern Lisp_Object Vthis_command_keys, Vunread_command_event;
2891 extern Lisp_Object Vx_initial_argv_list;
2892
2893 #endif /* INCLUDED_lisp_h_ */