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, 2000 Ben Wing.
6 This file is part of XEmacs.
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
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
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. */
23 /* Synched up with: FSF 19.30. */
25 #ifndef INCLUDED_lisp_h_
26 #define INCLUDED_lisp_h_
28 /************************************************************************/
29 /* general definitions */
30 /************************************************************************/
32 /* ------------------------ include files ------------------- */
34 /* We include the following generally useful header files so that you
35 don't have to worry about prototypes when using the standard C
36 library functions and macros. These files shouldn't be excessively
37 large so they shouldn't cause that much of a slowdown. */
40 #include <string.h> /* primarily for memcpy, etc. */
41 #include <stdio.h> /* NULL, etc. */
44 #include <stddef.h> /* offsetof */
45 #include <sys/types.h>
48 /* ------------------------ dynamic arrays ------------------- */
50 #define Dynarr_declare(type) \
59 Dynarr_declare (void);
62 void *Dynarr_newf (int elsize);
63 void Dynarr_resize (void *dy, int size);
64 void Dynarr_insert_many (void *d, const void *el, int len, int start);
65 void Dynarr_delete_many (void *d, int start, int len);
66 void Dynarr_free (void *d);
68 #define Dynarr_new(type) ((type##_dynarr *) Dynarr_newf (sizeof (type)))
69 #define Dynarr_new2(dynarr_type, type) \
70 ((dynarr_type *) Dynarr_newf (sizeof (type)))
71 #define Dynarr_at(d, pos) ((d)->base[pos])
72 #define Dynarr_atp(d, pos) (&Dynarr_at (d, pos))
73 #define Dynarr_length(d) ((d)->cur)
74 #define Dynarr_largest(d) ((d)->largest)
75 #define Dynarr_reset(d) ((d)->cur = 0)
76 #define Dynarr_add_many(d, el, len) Dynarr_insert_many (d, el, len, (d)->cur)
77 #define Dynarr_insert_many_at_start(d, el, len) \
78 Dynarr_insert_many (d, el, len, 0)
79 #define Dynarr_add_literal_string(d, s) Dynarr_add_many (d, s, sizeof (s) - 1)
80 #define Dynarr_add_lisp_string(d, s) do { \
81 Lisp_String *dyna_ls_s = XSTRING (s); \
82 Dynarr_add_many (d, (char *) string_data (dyna_ls_s), \
83 string_length (dyna_ls_s)); \
86 #define Dynarr_add(d, el) ( \
87 (d)->cur >= (d)->max ? Dynarr_resize ((d), (d)->cur+1) : (void) 0, \
88 ((d)->base)[(d)->cur++] = (el), \
89 (d)->cur > (d)->largest ? (d)->largest = (d)->cur : (int) 0)
91 /* The following defines will get you into real trouble if you aren't
92 careful. But they can save a lot of execution time when used wisely. */
93 #define Dynarr_increment(d) ((d)->cur++)
94 #define Dynarr_set_size(d, n) ((d)->cur = n)
96 #ifdef MEMORY_USAGE_STATS
97 struct overhead_stats;
98 size_t Dynarr_memory_usage (void *d, struct overhead_stats *stats);
101 /* Also define min() and max(). (Some compilers put them in strange
102 places that won't be referenced by the above include files, such
103 as 'macros.h' under Solaris.) */
106 #define min(a,b) (((a) <= (b)) ? (a) : (b))
109 #define max(a,b) (((a) > (b)) ? (a) : (b))
112 /* Memory allocation */
113 void malloc_warning (const char *);
114 void *xmalloc (size_t size);
115 void *xmalloc_and_zero (size_t size);
116 void *xrealloc (void *, size_t size);
117 char *xstrdup (const char *);
118 /* generally useful */
119 #define countof(x) ((int) (sizeof(x)/sizeof((x)[0])))
120 #define xnew(type) ((type *) xmalloc (sizeof (type)))
121 #define xnew_array(type, len) ((type *) xmalloc ((len) * sizeof (type)))
122 #define xnew_and_zero(type) ((type *) xmalloc_and_zero (sizeof (type)))
123 #define xzero(lvalue) ((void) memset (&(lvalue), '\0', sizeof (lvalue)))
124 #define xnew_array_and_zero(type, len) ((type *) xmalloc_and_zero ((len) * sizeof (type)))
125 #define XREALLOC_ARRAY(ptr, type, len) ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
126 #define alloca_array(type, len) ((type *) alloca ((len) * sizeof (type)))
128 /* also generally useful if you want to avoid arbitrary size limits
129 but don't need a full dynamic array. Assumes that BASEVAR points
130 to a malloced array of TYPE objects (or possibly a NULL pointer,
131 if SIZEVAR is 0), with the total size stored in SIZEVAR. This
132 macro will realloc BASEVAR as necessary so that it can hold at
133 least NEEDED_SIZE objects. The reallocing is done by doubling,
134 which ensures constant amortized time per element. */
135 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
136 size_t do_realloc_needed_size = (needed_size); \
137 if ((sizevar) < do_realloc_needed_size) \
139 if ((sizevar) < 32) \
141 while ((sizevar) < do_realloc_needed_size) \
143 XREALLOC_ARRAY (basevar, type, (sizevar)); \
147 #ifdef ERROR_CHECK_MALLOC
148 void xfree_1 (void *);
149 #define xfree(lvalue) do \
151 void **xfree_ptr = (void **) &(lvalue); \
152 xfree_1 (*xfree_ptr); \
153 *xfree_ptr = (void *) 0xDEADBEEF; \
157 #endif /* ERROR_CHECK_MALLOC */
160 # if defined (__GNUC__) && (__GNUC__ >= 2)
161 # define PRINTF_ARGS(string_index,first_to_check) \
162 __attribute__ ((format (printf, string_index, first_to_check)))
164 # define PRINTF_ARGS(string_index,first_to_check)
168 #ifndef DOESNT_RETURN
169 # if defined __GNUC__
170 # if ((__GNUC__ > 2) || (__GNUC__ == 2) && (__GNUC_MINOR__ >= 5))
171 # define DOESNT_RETURN void
172 # define DECLARE_DOESNT_RETURN(decl) \
173 extern void decl __attribute__ ((noreturn))
174 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
175 /* Should be able to state multiple independent __attribute__s, but \
176 the losing syntax doesn't work that way, and screws losing cpp */ \
178 __attribute__ ((noreturn, format (printf, str, idx)))
180 # define DOESNT_RETURN void volatile
181 # define DECLARE_DOESNT_RETURN(decl) extern void volatile decl
182 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
183 extern void volatile decl PRINTF_ARGS(str,idx)
184 # endif /* GNUC 2.5 */
186 # define DOESNT_RETURN void
187 # define DECLARE_DOESNT_RETURN(decl) extern void decl
188 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
189 extern void decl PRINTF_ARGS(str,idx)
194 # if defined (__GNUC__) && (__GNUC__ >= 2)
195 # define ALIGNOF(x) __alignof__ (x)
197 # define ALIGNOF(x) sizeof (x)
201 #define ALIGN_SIZE(len, unit) \
202 ((((len) + (unit) - 1) / (unit)) * (unit))
204 /* #### Yuck, this is kind of evil */
205 #define ALIGN_PTR(ptr, unit) \
206 ((void *) ALIGN_SIZE ((long) (ptr), unit))
209 #define DO_NOTHING do {} while (0)
212 #ifndef DECLARE_NOTHING
213 #define DECLARE_NOTHING struct nosuchstruct
216 /* We define assert iff USE_ASSERTIONS or DEBUG_XEMACS is defined.
217 Otherwise we define it to be empty. Quantify has shown that the
218 time the assert checks take is measurable so let's not include them
219 in production binaries. */
221 #ifdef USE_ASSERTIONS
222 /* Highly dubious kludge */
223 /* (thanks, Jamie, I feel better now -- ben) */
224 void assert_failed (const char *, int, const char *);
225 # define abort() (assert_failed (__FILE__, __LINE__, "abort()"))
226 # define assert(x) ((x) ? (void) 0 : assert_failed (__FILE__, __LINE__, #x))
229 # define assert(x) ((x) ? (void) 0 : (void) abort ())
235 /*#ifdef DEBUG_XEMACS*/
239 /*#define REGISTER register*/
243 /* EMACS_INT is the underlying integral type into which a Lisp_Object must fit.
244 In particular, it must be large enough to contain a pointer.
245 config.h can override this, e.g. to use `long long' for bigger lisp ints. */
247 #ifndef SIZEOF_EMACS_INT
248 # define SIZEOF_EMACS_INT SIZEOF_VOID_P
252 # if SIZEOF_EMACS_INT == SIZEOF_LONG
253 # define EMACS_INT long
254 # elif SIZEOF_EMACS_INT == SIZEOF_INT
255 # define EMACS_INT int
256 # elif SIZEOF_EMACS_INT == SIZEOF_LONG_LONG
257 # define EMACS_INT long long
259 # error Unable to determine suitable type for EMACS_INT
264 # define EMACS_UINT unsigned EMACS_INT
267 #define BITS_PER_EMACS_INT (SIZEOF_EMACS_INT * BITS_PER_CHAR)
270 /************************************************************************/
272 /************************************************************************/
274 /* We put typedefs here so that prototype declarations don't choke.
275 Note that we don't actually declare the structures here (except
276 maybe for simple structures like Dynarrs); that keeps them private
277 to the routines that actually use them. */
279 /* ------------------------------- */
280 /* basic char/int typedefs */
281 /* ------------------------------- */
283 /* The definitions we put here use typedefs to attribute specific meaning
284 to types that by themselves are pretty general. Stuff pointed to by a
285 char * or unsigned char * will nearly always be one of four types:
286 a) pointer to internally-formatted text; b) pointer to text in some
287 external format, which can be defined as all formats other than the
288 internal one; c) pure ASCII text; d) binary data that is not meant to
289 be interpreted as text. [A fifth possible type "e) a general pointer
290 to memory" should be replaced with void *.] Using these more specific
291 types rather than the general ones helps avoid the confusions that
292 occur when the semantics of a char * argument being studied are unclear. */
294 typedef unsigned char UChar;
296 /* The data representing the text in a buffer is logically a set
297 of Bufbytes, declared as follows. */
299 typedef UChar Bufbyte;
301 /* Explicitly signed or unsigned versions: */
302 typedef UChar UBufbyte;
303 typedef char SBufbyte;
305 /* The data representing a string in "external" format (binary or any
306 external encoding) is logically a set of Extbytes, declared as
307 follows. Extbyte is guaranteed to be just a char, so for example
308 strlen (Extbyte *) is OK. Extbyte is only a documentation device
309 for referring to external text. */
311 typedef char Extbyte;
313 /* A byte in a string in binary format: */
314 typedef char Char_Binary;
315 typedef UChar UChar_Binary;
317 /* A byte in a string in entirely US-ASCII format: (Nothing outside
318 the range 00 - 7F) */
320 typedef char Char_ASCII;
321 typedef UChar UChar_ASCII;
324 /* To the user, a buffer is made up of characters, declared as follows.
325 In the non-Mule world, characters and Bufbytes are equivalent.
326 In the Mule world, a character requires (typically) 1 to 4
327 Bufbytes for its representation in a buffer. */
331 /* Different ways of referring to a position in a buffer. We use
332 the typedefs in preference to 'int' to make it clearer what
333 sort of position is being used. See extents.c for a description
334 of the different positions. We put them here instead of in
335 buffer.h (where they rightfully belong) to avoid syntax errors
336 in function prototypes. */
338 typedef EMACS_INT Bufpos;
339 typedef EMACS_INT Bytind;
340 typedef EMACS_INT Memind;
342 /* Counts of bytes or chars */
344 typedef EMACS_INT Bytecount;
345 typedef EMACS_INT Charcount;
347 /* Length in bytes of a string in external format */
348 typedef EMACS_INT Extcount;
350 /* ------------------------------- */
351 /* structure/other typedefs */
352 /* ------------------------------- */
354 typedef struct lstream Lstream;
356 typedef unsigned int face_index;
360 Dynarr_declare (struct face_cachel);
361 } face_cachel_dynarr;
363 typedef unsigned int glyph_index;
365 /* This is shared by process.h, events.h and others in future.
366 See events.h for description */
367 typedef unsigned int USID;
371 Dynarr_declare (struct glyph_cachel);
372 } glyph_cachel_dynarr;
374 struct buffer; /* "buffer.h" */
375 struct console; /* "console.h" */
376 struct device; /* "device.h" */
377 struct extent_fragment;
379 typedef struct extent *EXTENT;
380 struct frame; /* "frame.h" */
381 struct window; /* "window.h" */
382 typedef struct Lisp_Event Lisp_Event; /* "events.h" */
383 typedef struct Lisp_Face Lisp_Face; /* "faces.h" */
384 typedef struct Lisp_Process Lisp_Process; /* "procimpl.h" */
385 struct stat; /* <sys/stat.h> */
386 typedef struct Lisp_Color_Instance Lisp_Color_Instance;
387 typedef struct Lisp_Font_Instance Lisp_Font_Instance;
388 typedef struct Lisp_Image_Instance Lisp_Image_Instance;
389 typedef struct Lisp_Gui_Item Lisp_Gui_Item;
391 struct display_glyph_area;
393 struct redisplay_info;
394 struct window_mirror;
395 struct scrollbar_instance;
396 struct font_metric_info;
398 struct console_type_entry;
402 Dynarr_declare (Bufbyte);
407 Dynarr_declare (Extbyte);
412 Dynarr_declare (Emchar);
417 Dynarr_declare (char);
420 typedef unsigned char unsigned_char;
423 Dynarr_declare (unsigned char);
424 } unsigned_char_dynarr;
426 typedef unsigned long unsigned_long;
429 Dynarr_declare (unsigned long);
430 } unsigned_long_dynarr;
434 Dynarr_declare (int);
439 Dynarr_declare (Bufpos);
444 Dynarr_declare (Bytind);
449 Dynarr_declare (Charcount);
454 Dynarr_declare (Bytecount);
459 Dynarr_declare (struct console_type_entry);
460 } console_type_entry_dynarr;
462 enum run_hooks_condition
464 RUN_HOOKS_TO_COMPLETION,
465 RUN_HOOKS_UNTIL_SUCCESS,
466 RUN_HOOKS_UNTIL_FAILURE
487 #ifndef ERROR_CHECK_TYPECHECK
489 typedef enum error_behavior
496 #define ERRB_EQ(a, b) ((a) == (b))
500 /* By defining it like this, we provide strict type-checking
501 for code that lazily uses ints. */
503 typedef struct _error_behavior_struct_
505 int really_unlikely_name_to_have_accidentally_in_a_non_errb_structure;
508 extern Error_behavior ERROR_ME;
509 extern Error_behavior ERROR_ME_NOT;
510 extern Error_behavior ERROR_ME_WARN;
512 #define ERRB_EQ(a, b) \
513 ((a).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure == \
514 (b).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure)
518 enum munge_me_out_the_door
520 MUNGE_ME_FUNCTION_KEY,
521 MUNGE_ME_KEY_TRANSLATION
525 /************************************************************************/
526 /* Definition of Lisp_Object data type */
527 /************************************************************************/
529 /* Define the fundamental Lisp data structures */
531 /* This is the set of Lisp data types */
541 #define POINTER_TYPE_P(type) ((type) == Lisp_Type_Record)
543 /* Overridden by m/next.h */
544 #ifndef ASSERT_VALID_POINTER
545 # define ASSERT_VALID_POINTER(pnt) (assert ((((EMACS_UINT) pnt) & 3) == 0))
553 #define INT_VALBITS (BITS_PER_EMACS_INT - INT_GCBITS)
554 #define VALBITS (BITS_PER_EMACS_INT - GCBITS)
555 #define EMACS_INT_MAX ((EMACS_INT) ((1UL << INT_VALBITS) -1UL))
556 #define EMACS_INT_MIN (-(EMACS_INT_MAX) - 1)
558 #ifdef USE_UNION_TYPE
559 # include "lisp-union.h"
560 #else /* !USE_UNION_TYPE */
561 # include "lisp-disunion.h"
562 #endif /* !USE_UNION_TYPE */
564 #define XPNTR(x) ((void *) XPNTRVAL(x))
566 /* WARNING WARNING WARNING. You must ensure on your own that proper
567 GC protection is provided for the elements in this array. */
570 Dynarr_declare (Lisp_Object);
571 } Lisp_Object_dynarr;
573 /* Close your eyes now lest you vomit or spontaneously combust ... */
575 #define HACKEQ_UNSAFE(obj1, obj2) \
576 (EQ (obj1, obj2) || (!POINTER_TYPE_P (XTYPE (obj1)) \
577 && !POINTER_TYPE_P (XTYPE (obj2)) \
578 && XCHAR_OR_INT (obj1) == XCHAR_OR_INT (obj2)))
581 extern int debug_issue_ebola_notices;
582 int eq_with_ebola_notice (Lisp_Object, Lisp_Object);
583 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2) \
584 (debug_issue_ebola_notices ? eq_with_ebola_notice (obj1, obj2) \
587 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2) EQ (obj1, obj2)
590 /* OK, you can open them again */
593 /************************************************************************/
594 /** Definitions of basic Lisp objects **/
595 /************************************************************************/
599 /*------------------------------ unbound -------------------------------*/
601 /* Qunbound is a special Lisp_Object (actually of type
602 symbol-value-forward), that can never be visible to
603 the Lisp caller and thus can be used in the C code
604 to mean "no such value". */
606 #define UNBOUNDP(val) EQ (val, Qunbound)
608 /*------------------------------- cons ---------------------------------*/
610 /* In a cons, the markbit of the car is the gc mark bit */
614 struct lrecord_header lheader;
615 Lisp_Object car, cdr;
617 typedef struct Lisp_Cons Lisp_Cons;
620 /* Like a cons, but records info on where the text lives that it was read from */
621 /* This is not really in use now */
623 struct Lisp_Buffer_Cons
625 Lisp_Object car, cdr;
626 struct buffer *buffer;
631 DECLARE_LRECORD (cons, Lisp_Cons);
632 #define XCONS(x) XRECORD (x, cons, Lisp_Cons)
633 #define XSETCONS(x, p) XSETRECORD (x, p, cons)
634 #define CONSP(x) RECORDP (x, cons)
635 #define CHECK_CONS(x) CHECK_RECORD (x, cons)
636 #define CONCHECK_CONS(x) CONCHECK_RECORD (x, cons)
638 #define CONS_MARKED_P(c) MARKED_RECORD_HEADER_P(&((c)->lheader))
639 #define MARK_CONS(c) MARK_RECORD_HEADER (&((c)->lheader))
641 extern Lisp_Object Qnil;
643 #define NILP(x) EQ (x, Qnil)
644 #define XCAR(a) (XCONS (a)->car)
645 #define XCDR(a) (XCONS (a)->cdr)
646 #define LISTP(x) (CONSP(x) || NILP(x))
648 #define CHECK_LIST(x) do { \
650 dead_wrong_type_argument (Qlistp, x); \
653 #define CONCHECK_LIST(x) do { \
655 x = wrong_type_argument (Qlistp, x); \
658 /*---------------------- list traversal macros -------------------------*/
660 /* Note: These macros are for traversing through a list in some format,
661 and executing code that you specify on each member of the list.
663 There are two kinds of macros, those requiring surrounding braces, and
664 those not requiring this. Which type of macro will be indicated.
665 The general format for using a brace-requiring macro is
668 LIST_LOOP_3 (elt, list, tail)
675 LIST_LOOP_3 (elt, list, tail)
681 You can put variable declarations between the brace and beginning of
682 macro, but NOTHING ELSE.
684 The brace-requiring macros typically declare themselves any arguments
685 that are initialized and iterated by the macros. If for some reason
686 you need to declare these arguments yourself (e.g. to do something on
687 them before the iteration starts, use the _NO_DECLARE versions of the
691 /* There are two basic kinds of macros: those that handle "internal" lists
692 that are known to be correctly structured (i.e. first element is a cons
693 or nil, and the car of each cons is also a cons or nil, and there are
694 no circularities), and those that handle "external" lists, where the
695 list may have any sort of invalid formation. This is reflected in
696 the names: those with "EXTERNAL_" work with external lists, and those
697 without this prefix work with internal lists. The internal-list
698 macros will hit an assertion failure if the structure is ill-formed;
699 the external-list macros will signal an error in this case, either a
700 malformed-list error or a circular-list error.
702 Note also that the simplest external list iterator, EXTERNAL_LIST_LOOP,
703 does *NOT* check for circularities. Therefore, make sure you call
704 QUIT each iteration or so. However, it's probably easier just to use
705 EXTERNAL_LIST_LOOP_2, which is easier to use in any case.
708 /* LIST_LOOP and EXTERNAL_LIST_LOOP are the simplest macros. They don't
709 require brace surrounding, and iterate through a list, which may or may
710 not known to be syntactically correct. EXTERNAL_LIST_LOOP is for those
711 not known to be correct, and it detects and signals a malformed list
712 error when encountering a problem. Circularities, however, are not
713 handled, and cause looping forever, so make sure to include a QUIT.
714 These functions also accept two args, TAIL (set progressively to each
715 cons starting with the first), and LIST, the list to iterate over.
716 TAIL needs to be defined by the program.
718 In each iteration, you can retrieve the current list item using XCAR
719 (tail), or destructively modify the list using XSETCAR (tail,
722 #define LIST_LOOP(tail, list) \
727 #define EXTERNAL_LIST_LOOP(tail, list) \
728 for (tail = list; !NILP (tail); tail = XCDR (tail)) \
730 signal_malformed_list_error (list); \
733 /* The following macros are the "core" macros for list traversal.
735 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
737 LIST_LOOP_2 and EXTERNAL_LIST_LOOP_2 are the standard, most-often used
738 macros. They take two arguments, an element variable ELT and the list
739 LIST. ELT is automatically declared, and set to each element in turn
742 LIST_LOOP_3 and EXTERNAL_LIST_LOOP_3 are the same, but they have a third
743 argument TAIL, another automatically-declared variable. At each iteration,
744 this one points to the cons cell for which ELT is the car.
746 EXTERNAL_LIST_LOOP_4 is like EXTERNAL_LIST_LOOP_3 but takes an additional
747 LEN argument, again automatically declared, which counts the number of
748 iterations gone by. It is 0 during the first iteration.
750 EXTERNAL_LIST_LOOP_4_NO_DECLARE is like EXTERNAL_LIST_LOOP_4 but none
751 of the variables are automatically declared, and so you need to declare
752 them yourself. (ELT and TAIL are Lisp_Objects, and LEN is an EMACS_INT.)
755 #define LIST_LOOP_2(elt, list) \
756 LIST_LOOP_3(elt, list, unused_tail_##elt)
758 #define LIST_LOOP_3(elt, list, tail) \
759 Lisp_Object elt, tail; \
762 0 : (elt = XCAR (tail), 1); \
765 /* The following macros are for traversing lisp lists.
766 Signal an error if LIST is not properly acyclic and nil-terminated.
768 Use tortoise/hare algorithm to check for cycles, but only if it
769 looks like the list is getting too long. Not only is the hare
770 faster than the tortoise; it even gets a head start! */
772 /* Optimized and safe macros for looping over external lists. */
773 #define CIRCULAR_LIST_SUSPICION_LENGTH 1024
775 #define EXTERNAL_LIST_LOOP_1(list) \
776 Lisp_Object ELL1_elt, ELL1_hare, ELL1_tortoise; \
777 EMACS_INT ELL1_len; \
778 PRIVATE_EXTERNAL_LIST_LOOP_6 (ELL1_elt, list, ELL1_len, ELL1_hare, \
779 ELL1_tortoise, CIRCULAR_LIST_SUSPICION_LENGTH)
781 #define EXTERNAL_LIST_LOOP_2(elt, list) \
782 Lisp_Object elt, hare_##elt, tortoise_##elt; \
783 EMACS_INT len_##elt; \
784 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt, \
785 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
787 #define EXTERNAL_LIST_LOOP_3(elt, list, tail) \
788 Lisp_Object elt, tail, tortoise_##elt; \
789 EMACS_INT len_##elt; \
790 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, tail, \
791 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
793 #define EXTERNAL_LIST_LOOP_4_NO_DECLARE(elt, list, tail, len) \
794 Lisp_Object tortoise_##elt; \
795 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail, \
796 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
798 #define EXTERNAL_LIST_LOOP_4(elt, list, tail, len) \
799 Lisp_Object elt, tail, tortoise_##elt; \
801 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail, \
802 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
805 #define PRIVATE_EXTERNAL_LIST_LOOP_6(elt, list, len, hare, \
806 tortoise, suspicion_length) \
807 for (tortoise = hare = list, len = 0; \
809 (CONSP (hare) ? ((elt = XCAR (hare)), 1) : \
811 (signal_malformed_list_error (list), 0))); \
813 hare = XCDR (hare), \
815 ((++len > suspicion_length) \
817 ((((len & 1) != 0) && (tortoise = XCDR (tortoise), 0)), \
818 (EQ (hare, tortoise) && (signal_circular_list_error (list), 0)))))
820 /* GET_LIST_LENGTH and GET_EXTERNAL_LIST_LENGTH:
822 These two macros return the length of LIST (either an internal or external
823 list, according to which macro is used), stored into LEN (which must
824 be declared by the caller). Circularities are trapped in external lists
825 (and cause errors). Neither macro need be declared inside brackets. */
827 #define GET_LIST_LENGTH(list, len) do { \
828 Lisp_Object GLL_tail; \
829 for (GLL_tail = list, len = 0; \
831 GLL_tail = XCDR (GLL_tail), ++len) \
835 #define GET_EXTERNAL_LIST_LENGTH(list, len) \
837 Lisp_Object GELL_elt, GELL_tail; \
838 EXTERNAL_LIST_LOOP_4_NO_DECLARE (GELL_elt, list, GELL_tail, len) \
842 /* For a list that's known to be in valid list format, where we may
843 be deleting the current element out of the list --
844 will abort() if the list is not in valid format */
845 #define LIST_LOOP_DELETING(consvar, nextconsvar, list) \
846 for (consvar = list; \
847 !NILP (consvar) ? (nextconsvar = XCDR (consvar), 1) :0; \
848 consvar = nextconsvar)
850 /* LIST_LOOP_DELETE_IF and EXTERNAL_LIST_LOOP_DELETE_IF:
852 These two macros delete all elements of LIST (either an internal or
853 external list, according to which macro is used) satisfying
854 CONDITION, a C expression referring to variable ELT. ELT is
855 automatically declared. Circularities are trapped in external
856 lists (and cause errors). Neither macro need be declared inside
859 #define LIST_LOOP_DELETE_IF(elt, list, condition) do { \
860 /* Do not use ##list when creating new variables because \
861 that may not be just a variable name. */ \
862 Lisp_Object prev_tail_##elt = Qnil; \
863 LIST_LOOP_3 (elt, list, tail_##elt) \
867 if (NILP (prev_tail_##elt)) \
868 list = XCDR (tail_##elt); \
870 XCDR (prev_tail_##elt) = XCDR (tail_##elt); \
873 prev_tail_##elt = tail_##elt; \
877 #define EXTERNAL_LIST_LOOP_DELETE_IF(elt, list, condition) do { \
878 Lisp_Object prev_tail_##elt = Qnil; \
879 EXTERNAL_LIST_LOOP_4 (elt, list, tail_##elt, len_##elt) \
883 if (NILP (prev_tail_##elt)) \
884 list = XCDR (tail_##elt); \
886 XCDR (prev_tail_##elt) = XCDR (tail_##elt); \
887 /* Keep tortoise from ever passing hare. */ \
891 prev_tail_##elt = tail_##elt; \
896 /* Macros for looping over external alists.
898 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
900 EXTERNAL_ALIST_LOOP_4 is similar to EXTERNAL_LIST_LOOP_2, but it
901 assumes the elements are aconses (the elements in an alist) and
902 sets two additional argument variables ELT_CAR and ELT_CDR to the
903 car and cdr of the acons. All of the variables ELT, ELT_CAR and
904 ELT_CDR are automatically declared.
906 EXTERNAL_ALIST_LOOP_5 adds a TAIL argument to EXTERNAL_ALIST_LOOP_4,
907 just like EXTERNAL_LIST_LOOP_3 does, and again TAIL is automatically
910 EXTERNAL_ALIST_LOOP_6 adds a LEN argument to EXTERNAL_ALIST_LOOP_5,
911 just like EXTERNAL_LIST_LOOP_4 does, and again LEN is automatically
914 EXTERNAL_ALIST_LOOP_6_NO_DECLARE does not declare any of its arguments,
915 just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these must be declared
919 /* Optimized and safe macros for looping over external alists. */
920 #define EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, list) \
921 Lisp_Object elt, elt_car, elt_cdr; \
922 Lisp_Object hare_##elt, tortoise_##elt; \
923 EMACS_INT len_##elt; \
924 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
925 len_##elt, hare_##elt, tortoise_##elt, \
926 CIRCULAR_LIST_SUSPICION_LENGTH)
928 #define EXTERNAL_ALIST_LOOP_5(elt, elt_car, elt_cdr, list, tail) \
929 Lisp_Object elt, elt_car, elt_cdr, tail; \
930 Lisp_Object tortoise_##elt; \
931 EMACS_INT len_##elt; \
932 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
933 len_##elt, tail, tortoise_##elt, \
934 CIRCULAR_LIST_SUSPICION_LENGTH) \
936 #define EXTERNAL_ALIST_LOOP_6(elt, elt_car, elt_cdr, list, tail, len) \
937 Lisp_Object elt, elt_car, elt_cdr, tail; \
939 Lisp_Object tortoise_##elt; \
940 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
941 len, tail, tortoise_##elt, \
942 CIRCULAR_LIST_SUSPICION_LENGTH)
944 #define EXTERNAL_ALIST_LOOP_6_NO_DECLARE(elt, elt_car, elt_cdr, list, \
946 Lisp_Object tortoise_##elt; \
947 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
948 len, tail, tortoise_##elt, \
949 CIRCULAR_LIST_SUSPICION_LENGTH)
952 #define PRIVATE_EXTERNAL_ALIST_LOOP_8(elt, elt_car, elt_cdr, list, len, \
953 hare, tortoise, suspicion_length) \
954 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, hare, tortoise, \
956 if (CONSP (elt) ? (elt_car = XCAR (elt), elt_cdr = XCDR (elt), 0) :1) \
960 /* Macros for looping over external property lists.
962 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
964 EXTERNAL_PROPERTY_LIST_LOOP_3 maps over an external list assumed to
965 be a property list, consisting of alternating pairs of keys
966 (typically symbols or keywords) and values. Each iteration
967 processes one such pair out of LIST, assigning the two elements to
968 KEY and VALUE respectively. Malformed lists and circularities are
969 trapped as usual, and in addition, property lists with an odd number
970 of elements also signal an error.
972 EXTERNAL_PROPERTY_LIST_LOOP_4 adds a TAIL argument to
973 EXTERNAL_PROPERTY_LIST_LOOP_3, just like EXTERNAL_LIST_LOOP_3 does,
974 and again TAIL is automatically declared.
976 EXTERNAL_PROPERTY_LIST_LOOP_5 adds a LEN argument to
977 EXTERNAL_PROPERTY_LIST_LOOP_4, just like EXTERNAL_LIST_LOOP_4 does,
978 and again LEN is automatically declared. Note that in this case,
979 LEN counts the iterations, NOT the total number of list elements
980 processed, which is 2 * LEN.
982 EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE does not declare any of its
983 arguments, just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these
984 must be declared manually. */
986 /* Optimized and safe macros for looping over external property lists. */
987 #define EXTERNAL_PROPERTY_LIST_LOOP_3(key, value, list) \
988 Lisp_Object key, value, hare_##key, tortoise_##key; \
989 EMACS_INT len_##key; \
990 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, hare_##key, \
991 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
993 #define EXTERNAL_PROPERTY_LIST_LOOP_4(key, value, list, tail) \
994 Lisp_Object key, value, tail, tortoise_##key; \
995 EMACS_INT len_##key; \
996 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, tail, \
997 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
999 #define EXTERNAL_PROPERTY_LIST_LOOP_5(key, value, list, tail, len) \
1000 Lisp_Object key, value, tail, tortoise_##key; \
1002 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail, \
1003 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1005 #define EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE(key, value, list, \
1007 Lisp_Object tortoise_##key; \
1008 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail, \
1009 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1012 #define EXTERNAL_PROPERTY_LIST_LOOP_7(key, value, list, len, hare, \
1013 tortoise, suspicion_length) \
1014 for (tortoise = hare = list, len = 0; \
1017 (key = XCAR (hare), \
1018 hare = XCDR (hare), \
1019 (CONSP (hare) ? 1 : \
1020 (signal_malformed_property_list_error (list), 0)))) ? \
1021 (value = XCAR (hare), 1) : \
1022 (NILP (hare) ? 0 : \
1023 (signal_malformed_property_list_error (list), 0))); \
1025 hare = XCDR (hare), \
1026 ((++len < suspicion_length) ? \
1029 ((void) (tortoise = XCDR (XCDR (tortoise)))) : \
1032 (EQ (hare, tortoise) ? \
1033 ((void) signal_circular_property_list_error (list)) : \
1036 /* For a property list (alternating keywords/values) that may not be
1037 in valid list format -- will signal an error if the list is not in
1038 valid format. CONSVAR is used to keep track of the iterations
1039 without modifying PLIST.
1041 We have to be tricky to still keep the same C format.*/
1042 #define EXTERNAL_PROPERTY_LIST_LOOP(tail, key, value, plist) \
1043 for (tail = plist; \
1044 (CONSP (tail) && CONSP (XCDR (tail)) ? \
1045 (key = XCAR (tail), value = XCAR (XCDR (tail))) : \
1046 (key = Qunbound, value = Qunbound)), \
1048 tail = XCDR (XCDR (tail))) \
1049 if (UNBOUNDP (key)) \
1050 Fsignal (Qmalformed_property_list, list1 (plist)); \
1053 #define PROPERTY_LIST_LOOP(tail, key, value, plist) \
1054 for (tail = plist; \
1056 (key = XCAR (tail), tail = XCDR (tail), \
1057 value = XCAR (tail), tail = XCDR (tail), 1); \
1060 /* Return 1 if LIST is properly acyclic and nil-terminated, else 0. */
1061 INLINE_HEADER int TRUE_LIST_P (Lisp_Object object);
1063 TRUE_LIST_P (Lisp_Object object)
1065 Lisp_Object hare, tortoise;
1068 for (hare = tortoise = object, len = 0;
1070 hare = XCDR (hare), len++)
1072 if (len < CIRCULAR_LIST_SUSPICION_LENGTH)
1076 tortoise = XCDR (tortoise);
1077 else if (EQ (hare, tortoise))
1084 /* Signal an error if LIST is not properly acyclic and nil-terminated. */
1085 #define CHECK_TRUE_LIST(list) do { \
1086 Lisp_Object CTL_list = (list); \
1087 Lisp_Object CTL_hare, CTL_tortoise; \
1088 EMACS_INT CTL_len; \
1090 for (CTL_hare = CTL_tortoise = CTL_list, CTL_len = 0; \
1092 CTL_hare = XCDR (CTL_hare), CTL_len++) \
1094 if (CTL_len < CIRCULAR_LIST_SUSPICION_LENGTH) \
1098 CTL_tortoise = XCDR (CTL_tortoise); \
1099 else if (EQ (CTL_hare, CTL_tortoise)) \
1100 Fsignal (Qcircular_list, list1 (CTL_list)); \
1103 if (! NILP (CTL_hare)) \
1104 signal_malformed_list_error (CTL_list); \
1107 /*------------------------------ string --------------------------------*/
1111 struct lrecord_header lheader;
1116 typedef struct Lisp_String Lisp_String;
1118 DECLARE_LRECORD (string, Lisp_String);
1119 #define XSTRING(x) XRECORD (x, string, Lisp_String)
1120 #define XSETSTRING(x, p) XSETRECORD (x, p, string)
1121 #define STRINGP(x) RECORDP (x, string)
1122 #define CHECK_STRING(x) CHECK_RECORD (x, string)
1123 #define CONCHECK_STRING(x) CONCHECK_RECORD (x, string)
1127 Charcount bytecount_to_charcount (const Bufbyte *ptr, Bytecount len);
1128 Bytecount charcount_to_bytecount (const Bufbyte *ptr, Charcount len);
1130 #else /* not MULE */
1132 # define bytecount_to_charcount(ptr, len) (len)
1133 # define charcount_to_bytecount(ptr, len) (len)
1135 #endif /* not MULE */
1137 #define string_length(s) ((s)->size)
1138 #define XSTRING_LENGTH(s) string_length (XSTRING (s))
1139 #define XSTRING_CHAR_LENGTH(s) string_char_length (XSTRING (s))
1140 #define string_data(s) ((s)->data + 0)
1141 #define XSTRING_DATA(s) string_data (XSTRING (s))
1142 #define string_byte(s, i) ((s)->data[i] + 0)
1143 #define XSTRING_BYTE(s, i) string_byte (XSTRING (s), i)
1144 #define string_byte_addr(s, i) (&((s)->data[i]))
1145 #define set_string_length(s, len) ((void) ((s)->size = (len)))
1146 #define set_string_data(s, ptr) ((void) ((s)->data = (ptr)))
1147 #define set_string_byte(s, i, b) ((void) ((s)->data[i] = (b)))
1149 void resize_string (Lisp_String *s, Bytecount pos, Bytecount delta);
1153 INLINE_HEADER Charcount string_char_length (Lisp_String *s);
1154 INLINE_HEADER Charcount
1155 string_char_length (Lisp_String *s)
1157 return bytecount_to_charcount (string_data (s), string_length (s));
1160 # define string_char(s, i) charptr_emchar_n (string_data (s), i)
1161 # define string_char_addr(s, i) charptr_n_addr (string_data (s), i)
1162 void set_string_char (Lisp_String *s, Charcount i, Emchar c);
1164 #else /* not MULE */
1166 # define string_char_length(s) string_length (s)
1167 # define string_char(s, i) ((Emchar) string_byte (s, i))
1168 # define string_char_addr(s, i) string_byte_addr (s, i)
1169 # define set_string_char(s, i, c) set_string_byte (s, i, (Bufbyte)c)
1171 #endif /* not MULE */
1173 /* Return the true size of a struct with a variable-length array field. */
1174 #define FLEXIBLE_ARRAY_STRUCT_SIZEOF(flexible_array_structtype, \
1175 flexible_array_field, \
1176 flexible_array_length) \
1177 (offsetof (flexible_array_structtype, flexible_array_field) + \
1178 (offsetof (flexible_array_structtype, flexible_array_field[1]) - \
1179 offsetof (flexible_array_structtype, flexible_array_field[0])) * \
1180 (flexible_array_length))
1182 /*------------------------------ vector --------------------------------*/
1186 struct lcrecord_header header;
1188 /* next is now chained through v->contents[size], terminated by Qzero.
1189 This means that pure vectors don't need a "next" */
1190 /* struct Lisp_Vector *next; */
1191 Lisp_Object contents[1];
1193 typedef struct Lisp_Vector Lisp_Vector;
1195 DECLARE_LRECORD (vector, Lisp_Vector);
1196 #define XVECTOR(x) XRECORD (x, vector, Lisp_Vector)
1197 #define XSETVECTOR(x, p) XSETRECORD (x, p, vector)
1198 #define VECTORP(x) RECORDP (x, vector)
1199 #define CHECK_VECTOR(x) CHECK_RECORD (x, vector)
1200 #define CONCHECK_VECTOR(x) CONCHECK_RECORD (x, vector)
1202 #define vector_length(v) ((v)->size)
1203 #define XVECTOR_LENGTH(s) vector_length (XVECTOR (s))
1204 #define vector_data(v) ((v)->contents)
1205 #define XVECTOR_DATA(s) vector_data (XVECTOR (s))
1207 /*---------------------------- bit vectors -----------------------------*/
1210 #error What the hell?!
1211 #elif (LONGBITS < 32)
1212 # define LONGBITS_LOG2 4
1213 # define LONGBITS_POWER_OF_2 16
1214 #elif (LONGBITS < 64)
1215 # define LONGBITS_LOG2 5
1216 # define LONGBITS_POWER_OF_2 32
1217 #elif (LONGBITS < 128)
1218 # define LONGBITS_LOG2 6
1219 # define LONGBITS_POWER_OF_2 64
1221 #error You really have 128-bit integers?!
1224 struct Lisp_Bit_Vector
1226 struct lrecord_header lheader;
1229 unsigned long bits[1];
1231 typedef struct Lisp_Bit_Vector Lisp_Bit_Vector;
1233 DECLARE_LRECORD (bit_vector, Lisp_Bit_Vector);
1234 #define XBIT_VECTOR(x) XRECORD (x, bit_vector, Lisp_Bit_Vector)
1235 #define XSETBIT_VECTOR(x, p) XSETRECORD (x, p, bit_vector)
1236 #define BIT_VECTORP(x) RECORDP (x, bit_vector)
1237 #define CHECK_BIT_VECTOR(x) CHECK_RECORD (x, bit_vector)
1238 #define CONCHECK_BIT_VECTOR(x) CONCHECK_RECORD (x, bit_vector)
1240 #define BITP(x) (INTP (x) && (XINT (x) == 0 || XINT (x) == 1))
1242 #define CHECK_BIT(x) do { \
1244 dead_wrong_type_argument (Qbitp, x);\
1247 #define CONCHECK_BIT(x) do { \
1249 x = wrong_type_argument (Qbitp, x); \
1252 #define bit_vector_length(v) ((v)->size)
1253 #define bit_vector_next(v) ((v)->next)
1255 INLINE_HEADER int bit_vector_bit (Lisp_Bit_Vector *v, size_t n);
1257 bit_vector_bit (Lisp_Bit_Vector *v, size_t n)
1259 return ((v->bits[n >> LONGBITS_LOG2] >> (n & (LONGBITS_POWER_OF_2 - 1)))
1263 INLINE_HEADER void set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value);
1265 set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value)
1268 v->bits[n >> LONGBITS_LOG2] |= (1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1270 v->bits[n >> LONGBITS_LOG2] &= ~(1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1273 /* Number of longs required to hold LEN bits */
1274 #define BIT_VECTOR_LONG_STORAGE(len) \
1275 (((len) + LONGBITS_POWER_OF_2 - 1) >> LONGBITS_LOG2)
1277 /*------------------------------ symbol --------------------------------*/
1279 typedef struct Lisp_Symbol Lisp_Symbol;
1282 struct lrecord_header lheader;
1283 /* next symbol in this obarray bucket */
1287 Lisp_Object function;
1291 #define SYMBOL_IS_KEYWORD(sym) \
1292 ((string_byte (symbol_name (XSYMBOL (sym)), 0) == ':') \
1293 && EQ (sym, oblookup (Vobarray, \
1294 string_data (symbol_name (XSYMBOL (sym))), \
1295 string_length (symbol_name (XSYMBOL (sym))))))
1296 #define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj))
1298 DECLARE_LRECORD (symbol, Lisp_Symbol);
1299 #define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol)
1300 #define XSETSYMBOL(x, p) XSETRECORD (x, p, symbol)
1301 #define SYMBOLP(x) RECORDP (x, symbol)
1302 #define CHECK_SYMBOL(x) CHECK_RECORD (x, symbol)
1303 #define CONCHECK_SYMBOL(x) CONCHECK_RECORD (x, symbol)
1305 #define symbol_next(s) ((s)->next)
1306 #define symbol_name(s) ((s)->name)
1307 #define symbol_value(s) ((s)->value)
1308 #define symbol_function(s) ((s)->function)
1309 #define symbol_plist(s) ((s)->plist)
1311 /*------------------------------- subr ---------------------------------*/
1313 typedef Lisp_Object (*lisp_fn_t) (void);
1317 struct lrecord_header lheader;
1325 typedef struct Lisp_Subr Lisp_Subr;
1327 DECLARE_LRECORD (subr, Lisp_Subr);
1328 #define XSUBR(x) XRECORD (x, subr, Lisp_Subr)
1329 #define XSETSUBR(x, p) XSETRECORD (x, p, subr)
1330 #define SUBRP(x) RECORDP (x, subr)
1331 #define CHECK_SUBR(x) CHECK_RECORD (x, subr)
1332 #define CONCHECK_SUBR(x) CONCHECK_RECORD (x, subr)
1334 #define subr_function(subr) ((subr)->subr_fn)
1335 #define SUBR_FUNCTION(subr,max_args) \
1336 ((Lisp_Object (*) (EXFUN_##max_args)) (subr)->subr_fn)
1337 #define subr_name(subr) ((subr)->name)
1339 /*------------------------------ marker --------------------------------*/
1342 typedef struct Lisp_Marker Lisp_Marker;
1345 struct lrecord_header lheader;
1348 struct buffer *buffer;
1350 char insertion_type;
1353 DECLARE_LRECORD (marker, Lisp_Marker);
1354 #define XMARKER(x) XRECORD (x, marker, Lisp_Marker)
1355 #define XSETMARKER(x, p) XSETRECORD (x, p, marker)
1356 #define MARKERP(x) RECORDP (x, marker)
1357 #define CHECK_MARKER(x) CHECK_RECORD (x, marker)
1358 #define CONCHECK_MARKER(x) CONCHECK_RECORD (x, marker)
1360 /* The second check was looking for GCed markers still in use */
1361 /* if (INTP (XMARKER (x)->lheader.next.v)) abort (); */
1363 #define marker_next(m) ((m)->next)
1364 #define marker_prev(m) ((m)->prev)
1366 /*------------------------------- char ---------------------------------*/
1368 #define CHARP(x) (XTYPE (x) == Lisp_Type_Char)
1370 #ifdef ERROR_CHECK_TYPECHECK
1372 INLINE_HEADER Emchar XCHAR (Lisp_Object obj);
1373 INLINE_HEADER Emchar
1374 XCHAR (Lisp_Object obj)
1376 assert (CHARP (obj));
1377 return XCHARVAL (obj);
1382 #define XCHAR(x) ((Emchar)XCHARVAL (x))
1386 #define CHECK_CHAR(x) CHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1387 #define CONCHECK_CHAR(x) CONCHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1390 /*------------------------------ float ---------------------------------*/
1392 #ifdef LISP_FLOAT_TYPE
1394 /* Note: the 'unused_next_' field exists only to ensure that the
1395 `next' pointer fits within the structure, for the purposes of the
1396 free list. This makes a difference in the unlikely case of
1397 sizeof(double) being smaller than sizeof(void *). */
1401 struct lrecord_header lheader;
1402 union { double d; struct Lisp_Float *unused_next_; } data;
1404 typedef struct Lisp_Float Lisp_Float;
1406 DECLARE_LRECORD (float, Lisp_Float);
1407 #define XFLOAT(x) XRECORD (x, float, Lisp_Float)
1408 #define XSETFLOAT(x, p) XSETRECORD (x, p, float)
1409 #define FLOATP(x) RECORDP (x, float)
1410 #define CHECK_FLOAT(x) CHECK_RECORD (x, float)
1411 #define CONCHECK_FLOAT(x) CONCHECK_RECORD (x, float)
1413 #define float_data(f) ((f)->data.d)
1414 #define XFLOAT_DATA(x) float_data (XFLOAT (x))
1416 #define XFLOATINT(n) extract_float (n)
1418 #define CHECK_INT_OR_FLOAT(x) do { \
1419 if (!INT_OR_FLOATP (x)) \
1420 dead_wrong_type_argument (Qnumberp, x); \
1423 #define CONCHECK_INT_OR_FLOAT(x) do { \
1424 if (!INT_OR_FLOATP (x)) \
1425 x = wrong_type_argument (Qnumberp, x); \
1428 # define INT_OR_FLOATP(x) (INTP (x) || FLOATP (x))
1430 #else /* not LISP_FLOAT_TYPE */
1432 #define XFLOAT(x) --- error! No float support. ---
1433 #define XSETFLOAT(x, p) --- error! No float support. ---
1435 #define CHECK_FLOAT(x) --- error! No float support. ---
1436 #define CONCHECK_FLOAT(x) --- error! No float support. ---
1438 #define XFLOATINT(n) XINT(n)
1439 #define CHECK_INT_OR_FLOAT CHECK_INT
1440 #define CONCHECK_INT_OR_FLOAT CONCHECK_INT
1441 #define INT_OR_FLOATP(x) INTP (x)
1443 #endif /* not LISP_FLOAT_TYPE */
1445 /*-------------------------------- int ---------------------------------*/
1447 #define ZEROP(x) EQ (x, Qzero)
1449 #ifdef ERROR_CHECK_TYPECHECK
1451 INLINE_HEADER EMACS_INT XINT (Lisp_Object obj);
1452 INLINE_HEADER EMACS_INT
1453 XINT (Lisp_Object obj)
1455 assert (INTP (obj));
1456 return XREALINT (obj);
1459 INLINE_HEADER EMACS_INT XCHAR_OR_INT (Lisp_Object obj);
1460 INLINE_HEADER EMACS_INT
1461 XCHAR_OR_INT (Lisp_Object obj)
1463 assert (INTP (obj) || CHARP (obj));
1464 return CHARP (obj) ? XCHAR (obj) : XINT (obj);
1467 #else /* no error checking */
1469 #define XINT(obj) XREALINT (obj)
1470 #define XCHAR_OR_INT(obj) (CHARP (obj) ? XCHAR (obj) : XINT (obj))
1472 #endif /* no error checking */
1474 #define CHECK_INT(x) do { \
1476 dead_wrong_type_argument (Qintegerp, x); \
1479 #define CONCHECK_INT(x) do { \
1481 x = wrong_type_argument (Qintegerp, x); \
1484 #define NATNUMP(x) (INTP (x) && XINT (x) >= 0)
1486 #define CHECK_NATNUM(x) do { \
1488 dead_wrong_type_argument (Qnatnump, x); \
1491 #define CONCHECK_NATNUM(x) do { \
1493 x = wrong_type_argument (Qnatnump, x); \
1496 /* next three always continuable because they coerce their arguments. */
1497 #define CHECK_INT_COERCE_CHAR(x) do { \
1500 else if (CHARP (x)) \
1501 x = make_int (XCHAR (x)); \
1503 x = wrong_type_argument (Qinteger_or_char_p, x); \
1506 #define CHECK_INT_COERCE_MARKER(x) do { \
1509 else if (MARKERP (x)) \
1510 x = make_int (marker_position (x)); \
1512 x = wrong_type_argument (Qinteger_or_marker_p, x); \
1515 #define CHECK_INT_COERCE_CHAR_OR_MARKER(x) do { \
1518 else if (CHARP (x)) \
1519 x = make_int (XCHAR (x)); \
1520 else if (MARKERP (x)) \
1521 x = make_int (marker_position (x)); \
1523 x = wrong_type_argument (Qinteger_char_or_marker_p, x); \
1527 /*--------------------------- readonly objects -------------------------*/
1529 #define CHECK_C_WRITEABLE(obj) \
1530 do { if (c_readonly (obj)) c_write_error (obj); } while (0)
1532 #define CHECK_LISP_WRITEABLE(obj) \
1533 do { if (lisp_readonly (obj)) lisp_write_error (obj); } while (0)
1535 #define C_READONLY(obj) (C_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1536 #define LISP_READONLY(obj) (LISP_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1538 /*----------------------------- structrures ----------------------------*/
1540 typedef struct structure_keyword_entry structure_keyword_entry;
1541 struct structure_keyword_entry
1543 Lisp_Object keyword;
1544 int (*validate) (Lisp_Object keyword, Lisp_Object value,
1545 Error_behavior errb);
1550 Dynarr_declare (structure_keyword_entry);
1551 } structure_keyword_entry_dynarr;
1553 typedef struct structure_type structure_type;
1554 struct structure_type
1557 structure_keyword_entry_dynarr *keywords;
1558 int (*validate) (Lisp_Object data, Error_behavior errb);
1559 Lisp_Object (*instantiate) (Lisp_Object data);
1564 Dynarr_declare (structure_type);
1565 } structure_type_dynarr;
1567 struct structure_type *define_structure_type (Lisp_Object type,
1570 Error_behavior errb),
1571 Lisp_Object (*instantiate)
1572 (Lisp_Object data));
1573 void define_structure_type_keyword (struct structure_type *st,
1574 Lisp_Object keyword,
1575 int (*validate) (Lisp_Object keyword,
1577 Error_behavior errb));
1579 /*---------------------------- weak lists ------------------------------*/
1583 /* element disappears if it's unmarked. */
1585 /* element disappears if it's a cons and either its car or
1588 /* element disappears if it's a cons and its car is unmarked. */
1589 WEAK_LIST_KEY_ASSOC,
1590 /* element disappears if it's a cons and its cdr is unmarked. */
1591 WEAK_LIST_VALUE_ASSOC,
1592 /* element disappears if it's a cons and neither its car nor
1593 its cdr is marked. */
1594 WEAK_LIST_FULL_ASSOC
1599 struct lcrecord_header header;
1600 Lisp_Object list; /* don't mark through this! */
1601 enum weak_list_type type;
1602 Lisp_Object next_weak; /* don't mark through this! */
1605 DECLARE_LRECORD (weak_list, struct weak_list);
1606 #define XWEAK_LIST(x) XRECORD (x, weak_list, struct weak_list)
1607 #define XSETWEAK_LIST(x, p) XSETRECORD (x, p, weak_list)
1608 #define WEAK_LISTP(x) RECORDP (x, weak_list)
1609 #define CHECK_WEAK_LIST(x) CHECK_RECORD (x, weak_list)
1610 #define CONCHECK_WEAK_LIST(x) CONCHECK_RECORD (x, weak_list)
1612 #define weak_list_list(w) ((w)->list)
1613 #define XWEAK_LIST_LIST(w) (XWEAK_LIST (w)->list)
1615 Lisp_Object make_weak_list (enum weak_list_type type);
1616 /* The following two are only called by the garbage collector */
1617 int finish_marking_weak_lists (void);
1618 void prune_weak_lists (void);
1620 /*-------------------------- lcrecord-list -----------------------------*/
1622 struct lcrecord_list
1624 struct lcrecord_header header;
1627 const struct lrecord_implementation *implementation;
1630 DECLARE_LRECORD (lcrecord_list, struct lcrecord_list);
1631 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list)
1632 #define XSETLCRECORD_LIST(x, p) XSETRECORD (x, p, lcrecord_list)
1633 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list)
1634 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list)
1635 Lcrecord lists should never escape to the Lisp level, so
1636 functions should not be doing this. */
1638 Lisp_Object make_lcrecord_list (size_t size,
1639 const struct lrecord_implementation
1641 Lisp_Object allocate_managed_lcrecord (Lisp_Object lcrecord_list);
1642 void free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord);
1645 /************************************************************************/
1646 /* Definitions of primitive Lisp functions and variables */
1647 /************************************************************************/
1650 /* DEFUN - Define a built-in Lisp-visible C function or `subr'.
1651 `lname' should be the name to give the function in Lisp,
1652 as a null-terminated C string.
1653 `Fname' should be the C equivalent of `lname', using only characters
1654 valid in a C identifier, with an "F" prepended.
1655 The name of the C constant structure that records information
1656 on this function for internal use is "S" concatenated with Fname.
1657 `min_args' should be a number, the minimum number of arguments allowed.
1658 `max_args' should be a number, the maximum number of arguments allowed,
1659 or else MANY or UNEVALLED.
1660 MANY means pass a vector of evaluated arguments,
1661 in the form of an integer number-of-arguments
1662 followed by the address of a vector of Lisp_Objects
1663 which contains the argument values.
1664 UNEVALLED means pass the list of unevaluated arguments.
1665 `prompt' says how to read arguments for an interactive call.
1666 See the doc string for `interactive'.
1667 A null string means call interactively with no arguments.
1668 `arglist' are the comma-separated arguments (always Lisp_Objects) for
1670 The docstring for the function is placed as a "C" comment between
1671 the prompt and the `args' argument. make-docfile reads the
1672 comment and creates the DOC file from it.
1675 #define EXFUN_0 void
1676 #define EXFUN_1 Lisp_Object
1677 #define EXFUN_2 Lisp_Object,Lisp_Object
1678 #define EXFUN_3 Lisp_Object,Lisp_Object,Lisp_Object
1679 #define EXFUN_4 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1680 #define EXFUN_5 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1681 #define EXFUN_6 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1683 #define EXFUN_7 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1684 Lisp_Object,Lisp_Object
1685 #define EXFUN_8 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1686 Lisp_Object,Lisp_Object,Lisp_Object
1687 #define EXFUN_MANY int, Lisp_Object*
1688 #define EXFUN_UNEVALLED Lisp_Object
1689 #define EXFUN(sym, max_args) Lisp_Object sym (EXFUN_##max_args)
1691 #define SUBR_MAX_ARGS 8
1693 #define UNEVALLED -1
1695 /* Can't be const, because then subr->doc is read-only and
1696 Snarf_documentation chokes */
1698 #define DEFUN(lname, Fname, min_args, max_args, prompt, arglist) \
1699 Lisp_Object Fname (EXFUN_##max_args); \
1700 static struct Lisp_Subr S##Fname = \
1702 { /* struct lrecord_header */ \
1703 lrecord_type_subr, /* lrecord_type_index */ \
1705 1, /* c_readonly bit */ \
1706 1 /* lisp_readonly bit */ \
1711 0, /* doc string */ \
1715 Lisp_Object Fname (DEFUN_##max_args arglist)
1717 /* Heavy ANSI C preprocessor hackery to get DEFUN to declare a
1718 prototype that matches max_args, and add the obligatory
1719 `Lisp_Object' type declaration to the formal C arguments. */
1721 #define DEFUN_MANY(named_int, named_Lisp_Object) named_int, named_Lisp_Object
1722 #define DEFUN_UNEVALLED(args) Lisp_Object args
1723 #define DEFUN_0() void
1724 #define DEFUN_1(a) Lisp_Object a
1725 #define DEFUN_2(a,b) DEFUN_1(a), Lisp_Object b
1726 #define DEFUN_3(a,b,c) DEFUN_2(a,b), Lisp_Object c
1727 #define DEFUN_4(a,b,c,d) DEFUN_3(a,b,c), Lisp_Object d
1728 #define DEFUN_5(a,b,c,d,e) DEFUN_4(a,b,c,d), Lisp_Object e
1729 #define DEFUN_6(a,b,c,d,e,f) DEFUN_5(a,b,c,d,e), Lisp_Object f
1730 #define DEFUN_7(a,b,c,d,e,f,g) DEFUN_6(a,b,c,d,e,f), Lisp_Object g
1731 #define DEFUN_8(a,b,c,d,e,f,g,h) DEFUN_7(a,b,c,d,e,f,g),Lisp_Object h
1733 /* WARNING: If you add defines here for higher values of max_args,
1734 make sure to also fix the clauses in PRIMITIVE_FUNCALL(),
1735 and change the define of SUBR_MAX_ARGS above. */
1737 #include "symeval.h"
1739 /* `specpdl' is the special binding/unwind-protect stack.
1741 Knuth says (see the Jargon File):
1742 At MIT, `pdl' [abbreviation for `Push Down List'] used to
1743 be a more common synonym for `stack'.
1744 Everywhere else `stack' seems to be the preferred term.
1746 specpdl_depth is the current depth of `specpdl'.
1747 Save this for use later as arg to `unbind_to'. */
1748 extern int specpdl_depth_counter;
1749 #define specpdl_depth() specpdl_depth_counter
1752 #define CHECK_FUNCTION(fun) do { \
1753 while (NILP (Ffunctionp (fun))) \
1754 signal_invalid_function_error (fun); \
1758 /************************************************************************/
1759 /* Checking for QUIT */
1760 /************************************************************************/
1762 /* Asynchronous events set something_happened, and then are processed
1763 within the QUIT macro. At this point, we are guaranteed to not be in
1764 any sensitive code. */
1766 extern volatile int something_happened;
1767 int check_what_happened (void);
1769 extern volatile int quit_check_signal_happened;
1770 extern volatile int quit_check_signal_tick_count;
1771 int check_quit (void);
1773 void signal_quit (void);
1775 /* Nonzero if ought to quit now. */
1777 ((quit_check_signal_happened ? check_quit () : 0), \
1778 (!NILP (Vquit_flag) && (NILP (Vinhibit_quit) \
1779 || EQ (Vquit_flag, Qcritical))))
1781 /* QUIT used to call QUITP, but there are some places where QUITP
1782 is called directly, and check_what_happened() should only be called
1783 when Emacs is actually ready to quit because it could do things
1784 like switch threads. */
1785 #define INTERNAL_QUITP \
1786 ((something_happened ? check_what_happened () : 0), \
1787 (!NILP (Vquit_flag) && \
1788 (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1790 #define INTERNAL_REALLY_QUITP \
1791 (check_what_happened (), \
1792 (!NILP (Vquit_flag) && \
1793 (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1795 /* Check quit-flag and quit if it is non-nil. Also do any other things
1796 that might have gotten queued until it was safe. */
1797 #define QUIT do { if (INTERNAL_QUITP) signal_quit (); } while (0)
1799 #define REALLY_QUIT do { if (INTERNAL_REALLY_QUITP) signal_quit (); } while (0)
1802 /************************************************************************/
1804 /************************************************************************/
1806 /* #### for a 64-bit machine, we should substitute a prime just over 2^32 */
1807 #define GOOD_HASH 65599 /* prime number just over 2^16; Dragon book, p. 435 */
1808 #define HASH2(a,b) (GOOD_HASH * (a) + (b))
1809 #define HASH3(a,b,c) (GOOD_HASH * HASH2 (a,b) + (c))
1810 #define HASH4(a,b,c,d) (GOOD_HASH * HASH3 (a,b,c) + (d))
1811 #define HASH5(a,b,c,d,e) (GOOD_HASH * HASH4 (a,b,c,d) + (e))
1812 #define HASH6(a,b,c,d,e,f) (GOOD_HASH * HASH5 (a,b,c,d,e) + (f))
1813 #define HASH7(a,b,c,d,e,f,g) (GOOD_HASH * HASH6 (a,b,c,d,e,f) + (g))
1814 #define HASH8(a,b,c,d,e,f,g,h) (GOOD_HASH * HASH7 (a,b,c,d,e,f,g) + (h))
1815 #define HASH9(a,b,c,d,e,f,g,h,i) (GOOD_HASH * HASH8 (a,b,c,d,e,f,g,h) + (i))
1817 #define LISP_HASH(obj) ((unsigned long) LISP_TO_VOID (obj))
1818 unsigned long string_hash (const char *xv);
1819 unsigned long memory_hash (const void *xv, size_t size);
1820 unsigned long internal_hash (Lisp_Object obj, int depth);
1821 unsigned long internal_array_hash (Lisp_Object *arr, int size, int depth);
1824 /************************************************************************/
1825 /* String translation */
1826 /************************************************************************/
1829 #ifdef HAVE_LIBINTL_H
1830 #include <libintl.h>
1832 char *dgettext (const char *, const char *);
1833 char *gettext (const char *);
1834 char *textdomain (const char *);
1835 char *bindtextdomain (const char *, const char *);
1836 #endif /* HAVE_LIBINTL_H */
1838 #define GETTEXT(x) gettext(x)
1839 #define LISP_GETTEXT(x) Fgettext (x)
1841 #define GETTEXT(x) (x)
1842 #define LISP_GETTEXT(x) (x)
1845 /* DEFER_GETTEXT is used to identify strings which are translated when
1846 they are referenced instead of when they are defined.
1847 These include Qerror_messages and initialized arrays of strings.
1849 #define DEFER_GETTEXT(x) (x)
1852 /************************************************************************/
1853 /* Garbage collection / GC-protection */
1854 /************************************************************************/
1856 /* number of bytes of structure consed since last GC */
1858 extern EMACS_INT consing_since_gc;
1860 /* threshold for doing another gc */
1862 extern EMACS_INT gc_cons_threshold;
1864 /* Structure for recording stack slots that need marking */
1866 /* This is a chain of structures, each of which points at a Lisp_Object
1867 variable whose value should be marked in garbage collection.
1868 Normally every link of the chain is an automatic variable of a function,
1869 and its `val' points to some argument or local variable of the function.
1870 On exit to the function, the chain is set back to the value it had on
1871 entry. This way, no link remains in the chain when the stack frame
1872 containing the link disappears.
1874 Every function that can call Feval must protect in this fashion all
1875 Lisp_Object variables whose contents will be used again. */
1877 extern struct gcpro *gcprolist;
1882 Lisp_Object *var; /* Address of first protected variable */
1883 int nvars; /* Number of consecutive protected variables */
1886 /* Normally, you declare variables gcpro1, gcpro2, ... and use the
1887 GCPROn() macros. However, if you need to have nested gcpro's,
1888 declare ngcpro1, ngcpro2, ... and use NGCPROn(). If you need
1889 to nest another level, use nngcpro1, nngcpro2, ... and use
1890 NNGCPROn(). If you need to nest yet another level, create
1891 the appropriate macros. */
1895 void debug_gcpro1 (char *, int, struct gcpro *, Lisp_Object *);
1896 void debug_gcpro2 (char *, int, struct gcpro *, struct gcpro *,
1897 Lisp_Object *, Lisp_Object *);
1898 void debug_gcpro3 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1899 Lisp_Object *, Lisp_Object *, Lisp_Object *);
1900 void debug_gcpro4 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1901 struct gcpro *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
1903 void debug_gcpro5 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1904 struct gcpro *, struct gcpro *, Lisp_Object *, Lisp_Object *,
1905 Lisp_Object *, Lisp_Object *, Lisp_Object *);
1906 void debug_ungcpro(char *, int, struct gcpro *);
1909 debug_gcpro1 (__FILE__, __LINE__,&gcpro1,&v)
1910 #define GCPRO2(v1,v2) \
1911 debug_gcpro2 (__FILE__, __LINE__,&gcpro1,&gcpro2,&v1,&v2)
1912 #define GCPRO3(v1,v2,v3) \
1913 debug_gcpro3 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&v1,&v2,&v3)
1914 #define GCPRO4(v1,v2,v3,v4) \
1915 debug_gcpro4 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,\
1917 #define GCPRO5(v1,v2,v3,v4,v5) \
1918 debug_gcpro5 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,\
1919 &v1,&v2,&v3,&v4,&v5)
1921 debug_ungcpro(__FILE__, __LINE__,&gcpro1)
1923 #define NGCPRO1(v) \
1924 debug_gcpro1 (__FILE__, __LINE__,&ngcpro1,&v)
1925 #define NGCPRO2(v1,v2) \
1926 debug_gcpro2 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&v1,&v2)
1927 #define NGCPRO3(v1,v2,v3) \
1928 debug_gcpro3 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&v1,&v2,&v3)
1929 #define NGCPRO4(v1,v2,v3,v4) \
1930 debug_gcpro4 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1932 #define NGCPRO5(v1,v2,v3,v4,v5) \
1933 debug_gcpro5 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1934 &ngcpro5,&v1,&v2,&v3,&v4,&v5)
1936 debug_ungcpro(__FILE__, __LINE__,&ngcpro1)
1938 #define NNGCPRO1(v) \
1939 debug_gcpro1 (__FILE__, __LINE__,&nngcpro1,&v)
1940 #define NNGCPRO2(v1,v2) \
1941 debug_gcpro2 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&v1,&v2)
1942 #define NNGCPRO3(v1,v2,v3) \
1943 debug_gcpro3 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&v1,&v2,&v3)
1944 #define NNGCPRO4(v1,v2,v3,v4) \
1945 debug_gcpro4 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1947 #define NNGCPRO5(v1,v2,v3,v4,v5) \
1948 debug_gcpro5 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1949 &nngcpro5,&v1,&v2,&v3,&v4,&v5)
1951 debug_ungcpro(__FILE__, __LINE__,&nngcpro1)
1953 #else /* ! DEBUG_GCPRO */
1955 #define GCPRO1(var1) ((void) ( \
1956 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1957 gcprolist = &gcpro1 ))
1959 #define GCPRO2(var1, var2) ((void) ( \
1960 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1961 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
1962 gcprolist = &gcpro2 ))
1964 #define GCPRO3(var1, var2, var3) ((void) ( \
1965 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1966 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
1967 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
1968 gcprolist = &gcpro3 ))
1970 #define GCPRO4(var1, var2, var3, var4) ((void) ( \
1971 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1972 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
1973 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
1974 gcpro4.next = &gcpro3, gcpro4.var = &var4, gcpro4.nvars = 1, \
1975 gcprolist = &gcpro4 ))
1977 #define GCPRO5(var1, var2, var3, var4, var5) ((void) ( \
1978 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1979 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
1980 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
1981 gcpro4.next = &gcpro3, gcpro4.var = &var4, gcpro4.nvars = 1, \
1982 gcpro5.next = &gcpro4, gcpro5.var = &var5, gcpro5.nvars = 1, \
1983 gcprolist = &gcpro5 ))
1985 #define UNGCPRO ((void) (gcprolist = gcpro1.next))
1987 #define NGCPRO1(var1) ((void) ( \
1988 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
1989 gcprolist = &ngcpro1 ))
1991 #define NGCPRO2(var1, var2) ((void) ( \
1992 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
1993 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
1994 gcprolist = &ngcpro2 ))
1996 #define NGCPRO3(var1, var2, var3) ((void) ( \
1997 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
1998 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
1999 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2000 gcprolist = &ngcpro3 ))
2002 #define NGCPRO4(var1, var2, var3, var4) ((void) ( \
2003 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2004 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2005 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2006 ngcpro4.next = &ngcpro3, ngcpro4.var = &var4, ngcpro4.nvars = 1, \
2007 gcprolist = &ngcpro4 ))
2009 #define NGCPRO5(var1, var2, var3, var4, var5) ((void) ( \
2010 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2011 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2012 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2013 ngcpro4.next = &ngcpro3, ngcpro4.var = &var4, ngcpro4.nvars = 1, \
2014 ngcpro5.next = &ngcpro4, ngcpro5.var = &var5, ngcpro5.nvars = 1, \
2015 gcprolist = &ngcpro5 ))
2017 #define NUNGCPRO ((void) (gcprolist = ngcpro1.next))
2019 #define NNGCPRO1(var1) ((void) ( \
2020 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2021 gcprolist = &nngcpro1 ))
2023 #define NNGCPRO2(var1, var2) ((void) ( \
2024 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2025 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2026 gcprolist = &nngcpro2 ))
2028 #define NNGCPRO3(var1, var2, var3) ((void) ( \
2029 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2030 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2031 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2032 gcprolist = &nngcpro3 ))
2034 #define NNGCPRO4(var1, var2, var3, var4) ((void) ( \
2035 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2036 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2037 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2038 nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1, \
2039 gcprolist = &nngcpro4 ))
2041 #define NNGCPRO5(var1, var2, var3, var4, var5) ((void) ( \
2042 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2043 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2044 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2045 nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1, \
2046 nngcpro5.next = &nngcpro4, nngcpro5.var = &var5, nngcpro5.nvars = 1, \
2047 gcprolist = &nngcpro5 ))
2049 #define NNUNGCPRO ((void) (gcprolist = nngcpro1.next))
2051 #endif /* ! DEBUG_GCPRO */
2053 /* Another try to fix SunPro C compiler warnings */
2054 /* "end-of-loop code not reached" */
2055 /* "statement not reached */
2056 #if defined __SUNPRO_C || defined __USLC__
2057 #define RETURN_SANS_WARNINGS if (1) return
2058 #define RETURN_NOT_REACHED(value)
2060 #define RETURN_SANS_WARNINGS return
2061 #define RETURN_NOT_REACHED(value) return value;
2064 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2065 #define RETURN_UNGCPRO(expr) do \
2067 Lisp_Object ret_ungc_val = (expr); \
2069 RETURN_SANS_WARNINGS ret_ungc_val; \
2072 /* Evaluate expr, NUNGCPRO, UNGCPRO, and then return the value of expr. */
2073 #define RETURN_NUNGCPRO(expr) do \
2075 Lisp_Object ret_ungc_val = (expr); \
2078 RETURN_SANS_WARNINGS ret_ungc_val; \
2081 /* Evaluate expr, NNUNGCPRO, NUNGCPRO, UNGCPRO, and then return the
2083 #define RETURN_NNUNGCPRO(expr) do \
2085 Lisp_Object ret_ungc_val = (expr); \
2089 RETURN_SANS_WARNINGS ret_ungc_val; \
2092 /* Evaluate expr, return it if it's not Qunbound. */
2093 #define RETURN_IF_NOT_UNBOUND(expr) do \
2095 Lisp_Object ret_nunb_val = (expr); \
2096 if (!UNBOUNDP (ret_nunb_val)) \
2097 RETURN_SANS_WARNINGS ret_nunb_val; \
2100 /* Call staticpro (&var) to protect static variable `var'. */
2101 void staticpro (Lisp_Object *);
2103 /* Call staticpro_nodump (&var) to protect static variable `var'. */
2104 /* var will not be saved at dump time */
2105 void staticpro_nodump (Lisp_Object *);
2107 /* Call dumpstruct(&var, &desc) to dump the structure pointed to by `var'. */
2108 void dumpstruct (void *, const struct struct_description *);
2110 /* Call dumpopaque(&var, size) to dump the opaque static structure `var'. */
2111 void dumpopaque (void *, size_t);
2113 /* Call pdump_wire(&var) to ensure that var is properly updated after pdump. */
2114 void pdump_wire (Lisp_Object *);
2116 /* Call pdump_wire(&var) to ensure that var is properly updated after
2117 pdump. var must point to a linked list of objects out of which
2118 some may not be dumped */
2119 void pdump_wire_list (Lisp_Object *);
2121 /* Nonzero means Emacs has already been initialized.
2122 Used during startup to detect startup of dumped Emacs. */
2123 extern int initialized;
2125 #ifdef MEMORY_USAGE_STATS
2127 /* This structure is used to keep statistics on the amount of memory
2130 WAS_REQUESTED stores the actual amount of memory that was requested
2131 of the allocation function. The *_OVERHEAD fields store the
2132 additional amount of memory that was grabbed by the functions to
2133 facilitate allocation, reallocation, etc. MALLOC_OVERHEAD is for
2134 memory allocated with malloc(); DYNARR_OVERHEAD is for dynamic
2135 arrays; GAP_OVERHEAD is for gap arrays. Note that for (e.g.)
2136 dynamic arrays, there is both MALLOC_OVERHEAD and DYNARR_OVERHEAD
2137 memory: The dynamic array allocates memory above and beyond what
2138 was asked of it, and when it in turns allocates memory using
2139 malloc(), malloc() allocates memory beyond what it was asked
2142 Functions that accept a structure of this sort do not initialize
2143 the fields to 0, and add any existing values to whatever was there
2144 before; this way, you can get a cumulative effect. */
2146 struct overhead_stats
2149 int malloc_overhead;
2150 int dynarr_overhead;
2154 #endif /* MEMORY_USAGE_STATS */
2156 #ifndef DIRECTORY_SEP
2157 #define DIRECTORY_SEP '/'
2159 #ifndef IS_DIRECTORY_SEP
2160 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
2162 #ifndef IS_DEVICE_SEP
2164 #define IS_DEVICE_SEP(c) 0
2166 #define IS_DEVICE_SEP(c) ((c) == DEVICE_SEP)
2170 #define IS_ANY_SEP(c) IS_DIRECTORY_SEP (c)
2173 #ifdef HAVE_INTTYPES_H
2174 #include <inttypes.h>
2175 #elif SIZEOF_VOID_P == SIZEOF_INT
2176 typedef int intptr_t;
2177 typedef unsigned int uintptr_t;
2178 #elif SIZEOF_VOID_P == SIZEOF_LONG
2179 typedef long intptr_t;
2180 typedef unsigned long uintptr_t;
2181 #elif defined(SIZEOF_LONG_LONG) && SIZEOF_VOID_P == SIZEOF_LONG_LONG
2182 typedef long long intptr_t;
2183 typedef unsigned long long uintptr_t;
2185 /* Just pray. May break, may not. */
2186 typedef long intptr_t;
2187 typedef unsigned long uintptr_t;
2191 /************************************************************************/
2193 /************************************************************************/
2195 /* NOTE: Prototypes should go HERE, not in various header files, unless
2196 they specifically reference a type that's not defined in lisp.h.
2197 (And even then, you might consider adding the type to lisp.h.)
2199 The idea is that header files typically contain the innards of objects,
2200 and we want to minimize the number of "dependencies" of one file on
2201 the specifics of such objects. Putting prototypes here minimizes the
2202 number of header files that need to be included -- good for a number
2203 of reasons. --ben */
2205 /*--------------- prototypes for various public c functions ------------*/
2207 /* Prototypes for all init/syms_of/vars_of initialization functions. */
2208 #include "symsinit.h"
2210 /* Defined in alloc.c */
2211 void release_breathing_space (void);
2212 Lisp_Object noseeum_cons (Lisp_Object, Lisp_Object);
2213 Lisp_Object make_vector (size_t, Lisp_Object);
2215 Lisp_Object make_older_vector (size_t, Lisp_Object);
2216 void make_vector_newer (Lisp_Object);
2218 Lisp_Object vector1 (Lisp_Object);
2219 Lisp_Object vector2 (Lisp_Object, Lisp_Object);
2220 Lisp_Object vector3 (Lisp_Object, Lisp_Object, Lisp_Object);
2221 Lisp_Object make_bit_vector (size_t, Lisp_Object);
2222 Lisp_Object make_bit_vector_from_byte_vector (unsigned char *, size_t);
2223 Lisp_Object noseeum_make_marker (void);
2224 void garbage_collect_1 (void);
2225 Lisp_Object acons (Lisp_Object, Lisp_Object, Lisp_Object);
2226 Lisp_Object cons3 (Lisp_Object, Lisp_Object, Lisp_Object);
2227 Lisp_Object list1 (Lisp_Object);
2228 Lisp_Object list2 (Lisp_Object, Lisp_Object);
2229 Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
2230 Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2231 Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2233 Lisp_Object list6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2234 Lisp_Object, Lisp_Object);
2235 DECLARE_DOESNT_RETURN (memory_full (void));
2236 void disksave_object_finalization (void);
2237 extern int purify_flag;
2238 extern int gc_currently_forbidden;
2239 Lisp_Object restore_gc_inhibit (Lisp_Object);
2240 extern EMACS_INT gc_generation_number[1];
2241 int c_readonly (Lisp_Object);
2242 int lisp_readonly (Lisp_Object);
2243 Lisp_Object build_string (const char *);
2244 Lisp_Object build_ext_string (const char *, Lisp_Object);
2245 Lisp_Object build_translated_string (const char *);
2246 Lisp_Object make_string (const Bufbyte *, Bytecount);
2247 Lisp_Object make_ext_string (const Extbyte *, EMACS_INT, Lisp_Object);
2248 Lisp_Object make_uninit_string (Bytecount);
2249 Lisp_Object make_float (double);
2250 Lisp_Object make_string_nocopy (const Bufbyte *, Bytecount);
2251 void free_cons (Lisp_Cons *);
2252 void free_list (Lisp_Object);
2253 void free_alist (Lisp_Object);
2254 void mark_conses_in_list (Lisp_Object);
2255 void free_marker (Lisp_Marker *);
2256 int object_dead_p (Lisp_Object);
2257 void mark_object (Lisp_Object obj);
2258 int marked_p (Lisp_Object obj);
2260 #ifdef MEMORY_USAGE_STATS
2261 size_t malloced_storage_size (void *, size_t, struct overhead_stats *);
2262 size_t fixed_type_block_overhead (size_t);
2266 int pdump_load (const char *);
2268 extern char *pdump_start, *pdump_end;
2269 #define DUMPEDP(adr) ((((char *)(adr)) < pdump_end) && (((char *)(adr)) >= pdump_start))
2271 #define DUMPEDP(adr) 0
2274 /* Defined in buffer.c */
2275 Lisp_Object make_buffer (struct buffer *);
2276 Lisp_Object get_truename_buffer (Lisp_Object);
2277 void switch_to_buffer (Lisp_Object, Lisp_Object);
2278 extern int find_file_compare_truenames;
2279 extern int find_file_use_truenames;
2281 /* Defined in callproc.c */
2282 char *egetenv (const char *);
2284 /* Defined in console.c */
2285 void stuff_buffered_input (Lisp_Object);
2287 /* Defined in console-msw.c */
2288 EXFUN (Fmswindows_message_box, 3);
2289 extern int mswindows_message_outputted;
2291 /* Defined in data.c */
2292 DECLARE_DOESNT_RETURN (c_write_error (Lisp_Object));
2293 DECLARE_DOESNT_RETURN (lisp_write_error (Lisp_Object));
2294 DECLARE_DOESNT_RETURN (args_out_of_range (Lisp_Object, Lisp_Object));
2295 DECLARE_DOESNT_RETURN (args_out_of_range_3 (Lisp_Object, Lisp_Object,
2297 Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
2298 DECLARE_DOESNT_RETURN (dead_wrong_type_argument (Lisp_Object, Lisp_Object));
2299 void check_int_range (EMACS_INT, EMACS_INT, EMACS_INT);
2301 enum arith_comparison {
2306 arith_less_or_equal,
2307 arith_grtr_or_equal };
2308 Lisp_Object arithcompare (Lisp_Object, Lisp_Object, enum arith_comparison);
2310 Lisp_Object word_to_lisp (unsigned int);
2311 unsigned int lisp_to_word (Lisp_Object);
2313 /* Defined in dired.c */
2314 Lisp_Object make_directory_hash_table (const char *);
2315 Lisp_Object wasteful_word_to_lisp (unsigned int);
2317 /* Defined in doc.c */
2318 Lisp_Object unparesseuxify_doc_string (int, EMACS_INT, char *, Lisp_Object);
2319 Lisp_Object read_doc_string (Lisp_Object);
2321 /* Defined in doprnt.c */
2322 Bytecount emacs_doprnt_c (Lisp_Object, const Bufbyte *, Lisp_Object,
2324 Bytecount emacs_doprnt_va (Lisp_Object, const Bufbyte *, Lisp_Object,
2325 Bytecount, va_list);
2326 Bytecount emacs_doprnt_lisp (Lisp_Object, const Bufbyte *, Lisp_Object,
2327 Bytecount, int, const Lisp_Object *);
2328 Bytecount emacs_doprnt_lisp_2 (Lisp_Object, const Bufbyte *, Lisp_Object,
2329 Bytecount, int, ...);
2330 Lisp_Object emacs_doprnt_string_c (const Bufbyte *, Lisp_Object,
2332 Lisp_Object emacs_doprnt_string_va (const Bufbyte *, Lisp_Object,
2333 Bytecount, va_list);
2334 Lisp_Object emacs_doprnt_string_lisp (const Bufbyte *, Lisp_Object,
2335 Bytecount, int, const Lisp_Object *);
2336 Lisp_Object emacs_doprnt_string_lisp_2 (const Bufbyte *, Lisp_Object,
2337 Bytecount, int, ...);
2339 /* Defined in editfns.c */
2340 void uncache_home_directory (void);
2341 Extbyte *get_home_directory (void);
2342 char *user_login_name (uid_t *);
2343 Bufpos bufpos_clip_to_bounds (Bufpos, Bufpos, Bufpos);
2344 Bytind bytind_clip_to_bounds (Bytind, Bytind, Bytind);
2345 void buffer_insert1 (struct buffer *, Lisp_Object);
2346 Lisp_Object make_string_from_buffer (struct buffer *, Bufpos, Charcount);
2347 Lisp_Object make_string_from_buffer_no_extents (struct buffer *, Bufpos, Charcount);
2348 Lisp_Object save_excursion_save (void);
2349 Lisp_Object save_restriction_save (void);
2350 Lisp_Object save_excursion_restore (Lisp_Object);
2351 Lisp_Object save_restriction_restore (Lisp_Object);
2353 /* Defined in emacsfns.c */
2354 Lisp_Object save_current_buffer_restore (Lisp_Object);
2356 /* Defined in emacs.c */
2357 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (fatal (const char *,
2359 int stderr_out (const char *, ...) PRINTF_ARGS (1, 2);
2360 int stdout_out (const char *, ...) PRINTF_ARGS (1, 2);
2361 SIGTYPE fatal_error_signal (int);
2362 Lisp_Object make_arg_list (int, Extbyte **);
2363 void make_argc_argv (Lisp_Object, int *, Extbyte ***);
2364 void free_argc_argv (Extbyte **);
2365 Lisp_Object decode_env_path (const char *, const char *);
2366 Lisp_Object decode_path (const char *);
2367 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2368 extern int noninteractive, noninteractive1;
2369 extern int fatal_error_in_progress;
2370 extern int preparing_for_armageddon;
2371 extern int emacs_priority;
2372 extern int running_asynch_code;
2373 extern int suppress_early_error_handler_backtrace;
2375 /* Defined in eval.c */
2376 DECLARE_DOESNT_RETURN (signal_error (Lisp_Object, Lisp_Object));
2377 void maybe_signal_error (Lisp_Object, Lisp_Object, Lisp_Object,
2379 Lisp_Object maybe_signal_continuable_error (Lisp_Object, Lisp_Object,
2380 Lisp_Object, Error_behavior);
2381 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (type_error (Lisp_Object,
2384 void maybe_type_error (Lisp_Object, Lisp_Object, Error_behavior, const char *,
2385 ...) PRINTF_ARGS (4, 5);
2386 Lisp_Object continuable_type_error (Lisp_Object, const char *, ...)
2388 Lisp_Object maybe_continuable_type_error (Lisp_Object, Lisp_Object,
2392 DECLARE_DOESNT_RETURN (signal_type_error (Lisp_Object, const char *,
2394 void maybe_signal_type_error (Lisp_Object, const char *, Lisp_Object,
2395 Lisp_Object, Error_behavior);
2396 Lisp_Object signal_type_continuable_error (Lisp_Object, const char *,
2398 Lisp_Object maybe_signal_type_continuable_error (Lisp_Object, const char *,
2400 Lisp_Object, Error_behavior);
2401 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (type_error_with_frob
2402 (Lisp_Object, Lisp_Object,
2405 void maybe_type_error_with_frob (Lisp_Object, Lisp_Object, Lisp_Object,
2407 const char *, ...) PRINTF_ARGS (5, 6);
2408 Lisp_Object continuable_type_error_with_frob (Lisp_Object, Lisp_Object,
2410 ...) PRINTF_ARGS (3, 4);
2411 Lisp_Object maybe_continuable_type_error_with_frob
2412 (Lisp_Object, Lisp_Object, Lisp_Object, Error_behavior, const char *, ...)
2414 DECLARE_DOESNT_RETURN (signal_type_error_2 (Lisp_Object, const char *,
2415 Lisp_Object, Lisp_Object));
2416 void maybe_signal_type_error_2 (Lisp_Object, const char *, Lisp_Object,
2417 Lisp_Object, Lisp_Object, Error_behavior);
2418 Lisp_Object signal_type_continuable_error_2 (Lisp_Object, const char *,
2419 Lisp_Object, Lisp_Object);
2420 Lisp_Object maybe_signal_type_continuable_error_2 (Lisp_Object, const char *,
2421 Lisp_Object, Lisp_Object,
2424 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error (const char *,
2426 void maybe_error (Lisp_Object, Error_behavior, const char *,
2427 ...) PRINTF_ARGS (3, 4);
2428 Lisp_Object continuable_error (const char *, ...) PRINTF_ARGS (1, 2);
2429 Lisp_Object maybe_continuable_error (Lisp_Object, Error_behavior,
2430 const char *, ...) PRINTF_ARGS (3, 4);
2431 DECLARE_DOESNT_RETURN (signal_simple_error (const char *, Lisp_Object));
2432 void maybe_signal_simple_error (const char *, Lisp_Object,
2433 Lisp_Object, Error_behavior);
2434 Lisp_Object signal_simple_continuable_error (const char *, Lisp_Object);
2435 Lisp_Object maybe_signal_simple_continuable_error (const char *, Lisp_Object,
2436 Lisp_Object, Error_behavior);
2437 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error_with_frob
2438 (Lisp_Object, const char *,
2440 void maybe_error_with_frob (Lisp_Object, Lisp_Object, Error_behavior,
2441 const char *, ...) PRINTF_ARGS (4, 5);
2442 Lisp_Object continuable_error_with_frob (Lisp_Object, const char *,
2443 ...) PRINTF_ARGS (2, 3);
2444 Lisp_Object maybe_continuable_error_with_frob
2445 (Lisp_Object, Lisp_Object, Error_behavior, const char *, ...) PRINTF_ARGS (4, 5);
2446 DECLARE_DOESNT_RETURN (signal_simple_error_2 (const char *,
2447 Lisp_Object, Lisp_Object));
2448 void maybe_signal_simple_error_2 (const char *, Lisp_Object, Lisp_Object,
2449 Lisp_Object, Error_behavior);
2450 Lisp_Object signal_simple_continuable_error_2 (const char *,
2451 Lisp_Object, Lisp_Object);
2452 Lisp_Object maybe_signal_simple_continuable_error_2 (const char *, Lisp_Object,
2453 Lisp_Object, Lisp_Object,
2455 DECLARE_DOESNT_RETURN (signal_malformed_list_error (Lisp_Object));
2456 DECLARE_DOESNT_RETURN (signal_malformed_property_list_error (Lisp_Object));
2457 DECLARE_DOESNT_RETURN (signal_circular_list_error (Lisp_Object));
2458 DECLARE_DOESNT_RETURN (signal_circular_property_list_error (Lisp_Object));
2460 DECLARE_DOESNT_RETURN (syntax_error (const char *reason, Lisp_Object frob));
2461 DECLARE_DOESNT_RETURN (syntax_error_2 (const char *reason, Lisp_Object frob1,
2462 Lisp_Object frob2));
2463 DECLARE_DOESNT_RETURN (invalid_argument (const char *reason,
2465 DECLARE_DOESNT_RETURN (invalid_argument_2 (const char *reason,
2467 Lisp_Object frob2));
2468 DECLARE_DOESNT_RETURN (invalid_operation (const char *reason,
2470 DECLARE_DOESNT_RETURN (invalid_operation_2 (const char *reason,
2472 Lisp_Object frob2));
2473 DECLARE_DOESNT_RETURN (invalid_change (const char *reason,
2475 DECLARE_DOESNT_RETURN (invalid_change_2 (const char *reason,
2477 Lisp_Object frob2));
2479 Lisp_Object signal_void_function_error (Lisp_Object);
2480 Lisp_Object signal_invalid_function_error (Lisp_Object);
2481 Lisp_Object signal_wrong_number_of_arguments_error (Lisp_Object, int);
2483 Lisp_Object run_hook_with_args_in_buffer (struct buffer *, int, Lisp_Object *,
2484 enum run_hooks_condition);
2485 Lisp_Object run_hook_with_args (int, Lisp_Object *, enum run_hooks_condition);
2486 void va_run_hook_with_args (Lisp_Object, int, ...);
2487 void va_run_hook_with_args_in_buffer (struct buffer *, Lisp_Object, int, ...);
2488 Lisp_Object run_hook (Lisp_Object);
2489 Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2490 Lisp_Object call0 (Lisp_Object);
2491 Lisp_Object call1 (Lisp_Object, Lisp_Object);
2492 Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2493 Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2494 Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2496 Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2497 Lisp_Object, Lisp_Object);
2498 Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2499 Lisp_Object, Lisp_Object, Lisp_Object);
2500 Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2501 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2502 Lisp_Object call8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2503 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2505 Lisp_Object call0_in_buffer (struct buffer *, Lisp_Object);
2506 Lisp_Object call1_in_buffer (struct buffer *, Lisp_Object, Lisp_Object);
2507 Lisp_Object call2_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2509 Lisp_Object call3_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2510 Lisp_Object, Lisp_Object);
2511 Lisp_Object call4_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2512 Lisp_Object, Lisp_Object, Lisp_Object);
2513 Lisp_Object call5_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2514 Lisp_Object, Lisp_Object, Lisp_Object,
2516 Lisp_Object call6_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2517 Lisp_Object, Lisp_Object, Lisp_Object,
2518 Lisp_Object, Lisp_Object);
2519 Lisp_Object eval_in_buffer (struct buffer *, Lisp_Object);
2520 Lisp_Object call0_with_handler (Lisp_Object, Lisp_Object);
2521 Lisp_Object call1_with_handler (Lisp_Object, Lisp_Object, Lisp_Object);
2522 Lisp_Object eval_in_buffer_trapping_errors (const char *, struct buffer *,
2524 Lisp_Object run_hook_trapping_errors (const char *, Lisp_Object);
2525 Lisp_Object safe_run_hook_trapping_errors (const char *, Lisp_Object, int);
2526 Lisp_Object call0_trapping_errors (const char *, Lisp_Object);
2527 Lisp_Object call1_trapping_errors (const char *, Lisp_Object, Lisp_Object);
2528 Lisp_Object call2_trapping_errors (const char *,
2529 Lisp_Object, Lisp_Object, Lisp_Object);
2530 Lisp_Object call_with_suspended_errors (lisp_fn_t, volatile Lisp_Object, Lisp_Object,
2531 Error_behavior, int, ...);
2532 /* C Code should be using internal_catch, record_unwind_p, condition_case_1 */
2533 Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object),
2534 Lisp_Object, int * volatile);
2535 Lisp_Object condition_case_1 (Lisp_Object,
2536 Lisp_Object (*) (Lisp_Object),
2538 Lisp_Object (*) (Lisp_Object, Lisp_Object),
2540 Lisp_Object condition_case_3 (Lisp_Object, Lisp_Object, Lisp_Object);
2541 Lisp_Object unbind_to (int, Lisp_Object);
2542 void specbind (Lisp_Object, Lisp_Object);
2543 void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2544 void do_autoload (Lisp_Object, Lisp_Object);
2545 Lisp_Object un_autoload (Lisp_Object);
2546 void warn_when_safe_lispobj (Lisp_Object, Lisp_Object, Lisp_Object);
2547 void warn_when_safe (Lisp_Object, Lisp_Object, const char *,
2548 ...) PRINTF_ARGS (3, 4);
2551 /* Defined in event-stream.c */
2552 void wait_delaying_user_input (int (*) (void *), void *);
2553 int detect_input_pending (void);
2554 void reset_this_command_keys (Lisp_Object, int);
2555 Lisp_Object enqueue_misc_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2556 Lisp_Object enqueue_misc_user_event_pos (Lisp_Object, Lisp_Object,
2557 Lisp_Object, int, int, int, int);
2558 extern int modifier_keys_are_sticky;
2560 /* Defined in event-Xt.c */
2561 void enqueue_Xt_dispatch_event (Lisp_Object event);
2562 void signal_special_Xt_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2565 /* Defined in events.c */
2566 void clear_event_resource (void);
2567 Lisp_Object allocate_event (void);
2569 /* Defined in fileio.c */
2570 void record_auto_save (void);
2571 void force_auto_save_soon (void);
2572 DECLARE_DOESNT_RETURN (report_file_error (const char *, Lisp_Object));
2573 void maybe_report_file_error (const char *, Lisp_Object,
2574 Lisp_Object, Error_behavior);
2575 DECLARE_DOESNT_RETURN (signal_file_error (const char *, Lisp_Object));
2576 void maybe_signal_file_error (const char *, Lisp_Object,
2577 Lisp_Object, Error_behavior);
2578 DECLARE_DOESNT_RETURN (signal_double_file_error (const char *, const char *,
2580 void maybe_signal_double_file_error (const char *, const char *,
2581 Lisp_Object, Lisp_Object, Error_behavior);
2582 DECLARE_DOESNT_RETURN (signal_double_file_error_2 (const char *, const char *,
2583 Lisp_Object, Lisp_Object));
2584 void maybe_signal_double_file_error_2 (const char *, const char *,
2585 Lisp_Object, Lisp_Object, Lisp_Object,
2587 Lisp_Object lisp_strerror (int);
2588 Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
2589 ssize_t read_allowing_quit (int, void *, size_t);
2590 ssize_t write_allowing_quit (int, const void *, size_t);
2591 int internal_delete_file (Lisp_Object);
2593 /* Defined in filelock.c */
2594 void lock_file (Lisp_Object);
2595 void unlock_file (Lisp_Object);
2596 void unlock_all_files (void);
2597 void unlock_buffer (struct buffer *);
2599 /* Defined in filemode.c */
2600 void filemodestring (struct stat *, char *);
2602 /* Defined in floatfns.c */
2603 double extract_float (Lisp_Object);
2605 /* Defined in fns.c */
2606 Lisp_Object list_sort (Lisp_Object, Lisp_Object,
2607 int (*) (Lisp_Object, Lisp_Object, Lisp_Object));
2608 Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
2610 void bump_string_modiff (Lisp_Object);
2611 Lisp_Object memq_no_quit (Lisp_Object, Lisp_Object);
2612 Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2613 Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2614 Lisp_Object rassq_no_quit (Lisp_Object, Lisp_Object);
2615 Lisp_Object delq_no_quit (Lisp_Object, Lisp_Object);
2616 Lisp_Object delq_no_quit_and_free_cons (Lisp_Object, Lisp_Object);
2617 Lisp_Object remassoc_no_quit (Lisp_Object, Lisp_Object);
2618 Lisp_Object remassq_no_quit (Lisp_Object, Lisp_Object);
2619 Lisp_Object remrassq_no_quit (Lisp_Object, Lisp_Object);
2621 int plists_differ (Lisp_Object, Lisp_Object, int, int, int);
2622 Lisp_Object internal_plist_get (Lisp_Object, Lisp_Object);
2623 void internal_plist_put (Lisp_Object *, Lisp_Object, Lisp_Object);
2624 int internal_remprop (Lisp_Object *, Lisp_Object);
2625 Lisp_Object external_plist_get (Lisp_Object *, Lisp_Object,
2626 int, Error_behavior);
2627 void external_plist_put (Lisp_Object *, Lisp_Object,
2628 Lisp_Object, int, Error_behavior);
2629 int external_remprop (Lisp_Object *, Lisp_Object, int, Error_behavior);
2630 int internal_equal (Lisp_Object, Lisp_Object, int);
2631 Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2632 Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2633 Lisp_Object vconcat2 (Lisp_Object, Lisp_Object);
2634 Lisp_Object vconcat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2635 Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2636 Lisp_Object bytecode_nconc2 (Lisp_Object *);
2637 void check_losing_bytecode (const char *, Lisp_Object);
2639 /* Defined in glyphs.c */
2640 Error_behavior decode_error_behavior_flag (Lisp_Object);
2641 Lisp_Object encode_error_behavior_flag (Error_behavior);
2643 /* Defined in indent.c */
2644 int bi_spaces_at_point (struct buffer *, Bytind);
2645 int column_at_point (struct buffer *, Bufpos, int);
2646 int string_column_at_point (Lisp_String *, Bufpos, int);
2647 int current_column (struct buffer *);
2648 void invalidate_current_column (void);
2649 Bufpos vmotion (struct window *, Bufpos, int, int *);
2650 Bufpos vmotion_pixels (Lisp_Object, Bufpos, int, int, int *);
2652 /* Defined in keymap.c */
2653 void where_is_to_char (Lisp_Object, char *);
2655 /* Defined in lread.c */
2656 void ebolify_bytecode_constants (Lisp_Object);
2657 void close_load_descs (void);
2658 int locate_file (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object *, int);
2659 EXFUN (Flocate_file_clear_hashing, 1);
2660 int isfloat_string (const char *);
2662 /* Well, I've decided to enable this. -- ben */
2663 /* And I've decided to make it work right. -- sb */
2665 /* Define the following symbol to enable load history of dumped files */
2666 #define LOADHIST_DUMPED
2667 /* Define the following symbol to enable load history of C source */
2668 #define LOADHIST_BUILTIN
2670 #ifdef LOADHIST /* this is just a stupid idea */
2671 #define LOADHIST_ATTACH(x) \
2672 do { if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); } \
2674 #else /*! LOADHIST */
2675 # define LOADHIST_ATTACH(x)
2676 #endif /*! LOADHIST */
2678 /* Defined in marker.c */
2679 Bytind bi_marker_position (Lisp_Object);
2680 Bufpos marker_position (Lisp_Object);
2681 void set_bi_marker_position (Lisp_Object, Bytind);
2682 void set_marker_position (Lisp_Object, Bufpos);
2683 void unchain_marker (Lisp_Object);
2684 Lisp_Object noseeum_copy_marker (Lisp_Object, Lisp_Object);
2685 Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
2686 #ifdef MEMORY_USAGE_STATS
2687 int compute_buffer_marker_usage (struct buffer *, struct overhead_stats *);
2690 /* Defined in menubar.c */
2691 extern int popup_menu_up_p;
2692 extern int menubar_show_keybindings;
2693 extern int popup_menu_titles;
2695 /* Defined in minibuf.c */
2696 extern int minibuf_level;
2697 Charcount scmp_1 (const Bufbyte *, const Bufbyte *, Charcount, int);
2698 #define scmp(s1, s2, len) scmp_1 (s1, s2, len, completion_ignore_case)
2699 extern int completion_ignore_case;
2700 int regexp_ignore_completion_p (const Bufbyte *, Lisp_Object,
2701 Bytecount, Bytecount);
2702 Lisp_Object clear_echo_area (struct frame *, Lisp_Object, int);
2703 Lisp_Object clear_echo_area_from_print (struct frame *, Lisp_Object, int);
2704 void echo_area_append (struct frame *, const Bufbyte *, Lisp_Object,
2705 Bytecount, Bytecount, Lisp_Object);
2706 void echo_area_message (struct frame *, const Bufbyte *, Lisp_Object,
2707 Bytecount, Bytecount, Lisp_Object);
2708 Lisp_Object echo_area_status (struct frame *);
2709 int echo_area_active (struct frame *);
2710 Lisp_Object echo_area_contents (struct frame *);
2711 void message_internal (const Bufbyte *, Lisp_Object, Bytecount, Bytecount);
2712 void message_append_internal (const Bufbyte *, Lisp_Object,
2713 Bytecount, Bytecount);
2714 void message (const char *, ...) PRINTF_ARGS (1, 2);
2715 void message_append (const char *, ...) PRINTF_ARGS (1, 2);
2716 void message_no_translate (const char *, ...) PRINTF_ARGS (1, 2);
2717 void clear_message (void);
2719 /* Defined in print.c */
2720 void write_string_to_stdio_stream (FILE *, struct console *,
2721 const Bufbyte *, Bytecount, Bytecount,
2723 void debug_print (Lisp_Object);
2724 void debug_short_backtrace (int);
2725 void temp_output_buffer_setup (Lisp_Object);
2726 void temp_output_buffer_show (Lisp_Object, Lisp_Object);
2727 /* NOTE: Do not call this with the data of a Lisp_String. Use princ.
2728 * Note: stream should be defaulted before calling
2729 * (eg Qnil means stdout, not Vstandard_output, etc) */
2730 void write_c_string (const char *, Lisp_Object);
2731 /* Same goes for this function. */
2732 void write_string_1 (const Bufbyte *, Bytecount, Lisp_Object);
2733 void print_cons (Lisp_Object, Lisp_Object, int);
2734 void print_vector (Lisp_Object, Lisp_Object, int);
2735 void print_string (Lisp_Object, Lisp_Object, int);
2736 char *long_to_string (char *, long);
2737 void print_internal (Lisp_Object, Lisp_Object, int);
2738 void print_symbol (Lisp_Object, Lisp_Object, int);
2739 void print_float (Lisp_Object, Lisp_Object, int);
2740 extern int print_escape_newlines;
2741 extern int print_readably;
2742 Lisp_Object internal_with_output_to_temp_buffer (Lisp_Object,
2743 Lisp_Object (*) (Lisp_Object),
2744 Lisp_Object, Lisp_Object);
2745 void float_to_string (char *, double);
2746 void internal_object_printer (Lisp_Object, Lisp_Object, int);
2748 /* Defined in profile.c */
2749 void mark_profiling_info (void);
2750 void profile_increase_call_count (Lisp_Object);
2751 extern int profiling_active;
2752 extern int profiling_redisplay_flag;
2754 /* Defined in rangetab.c */
2755 void put_range_table (Lisp_Object, EMACS_INT, EMACS_INT, Lisp_Object);
2756 int unified_range_table_bytes_needed (Lisp_Object);
2757 int unified_range_table_bytes_used (void *);
2758 void unified_range_table_copy_data (Lisp_Object, void *);
2759 Lisp_Object unified_range_table_lookup (void *, EMACS_INT, Lisp_Object);
2760 int unified_range_table_nentries (void *);
2761 void unified_range_table_get_range (void *, int, EMACS_INT *, EMACS_INT *,
2764 /* Defined in search.c */
2765 struct re_pattern_buffer;
2766 struct re_registers;
2767 Bufpos scan_buffer (struct buffer *, Emchar, Bufpos, Bufpos, EMACS_INT, EMACS_INT *, int);
2768 Bufpos find_next_newline (struct buffer *, Bufpos, int);
2769 Bufpos find_next_newline_no_quit (struct buffer *, Bufpos, int);
2770 Bytind bi_find_next_newline_no_quit (struct buffer *, Bytind, int);
2771 Bytind bi_find_next_emchar_in_string (Lisp_String*, Emchar, Bytind, EMACS_INT);
2772 Bufpos find_before_next_newline (struct buffer *, Bufpos, Bufpos, int);
2773 struct re_pattern_buffer *compile_pattern (Lisp_Object, struct re_registers *,
2774 Lisp_Object, int, Error_behavior);
2775 Bytecount fast_string_match (Lisp_Object, const Bufbyte *,
2776 Lisp_Object, Bytecount,
2777 Bytecount, int, Error_behavior, int);
2778 Bytecount fast_lisp_string_match (Lisp_Object, Lisp_Object);
2779 void restore_match_data (void);
2781 /* Defined in signal.c */
2782 void init_interrupts_late (void);
2783 extern int dont_check_for_quit;
2784 void begin_dont_check_for_quit (void);
2785 void emacs_sleep (int);
2787 /* Defined in sound.c */
2788 void init_device_sound (struct device *);
2790 /* Defined in specifier.c */
2791 Lisp_Object specifier_instance (Lisp_Object, Lisp_Object, Lisp_Object,
2792 Error_behavior, int, int, Lisp_Object);
2793 Lisp_Object specifier_instance_no_quit (Lisp_Object, Lisp_Object, Lisp_Object,
2794 Error_behavior, int, Lisp_Object);
2796 /* Defined in symbols.c */
2797 int hash_string (const Bufbyte *, Bytecount);
2798 Lisp_Object intern (const char *);
2799 Lisp_Object oblookup (Lisp_Object, const Bufbyte *, Bytecount);
2800 void map_obarray (Lisp_Object, int (*) (Lisp_Object, void *), void *);
2801 Lisp_Object indirect_function (Lisp_Object, int);
2802 Lisp_Object symbol_value_in_buffer (Lisp_Object, Lisp_Object);
2803 void kill_buffer_local_variables (struct buffer *);
2804 int symbol_value_buffer_local_info (Lisp_Object, struct buffer *);
2805 Lisp_Object find_symbol_value (Lisp_Object);
2806 Lisp_Object find_symbol_value_quickly (Lisp_Object, int);
2807 Lisp_Object top_level_value (Lisp_Object);
2808 void reject_constant_symbols (Lisp_Object sym, Lisp_Object newval,
2810 Lisp_Object follow_past_lisp_magic);
2812 /* Defined in syntax.c */
2813 Bufpos scan_words (struct buffer *, Bufpos, int);
2815 /* Defined in undo.c */
2816 Lisp_Object truncate_undo_list (Lisp_Object, int, int);
2817 void record_extent (Lisp_Object, int);
2818 void record_insert (struct buffer *, Bufpos, Charcount);
2819 void record_delete (struct buffer *, Bufpos, Charcount);
2820 void record_change (struct buffer *, Bufpos, Charcount);
2822 /* Defined in unex*.c */
2823 int unexec (char *, char *, uintptr_t, uintptr_t, uintptr_t);
2824 #ifdef RUN_TIME_REMAP
2825 int run_time_remap (char *);
2828 /* Defined in vm-limit.c */
2829 void memory_warnings (void *, void (*) (const char *));
2831 /* Defined in window.c */
2832 Lisp_Object save_window_excursion_unwind (Lisp_Object);
2833 Lisp_Object display_buffer (Lisp_Object, Lisp_Object, Lisp_Object);
2835 /*--------------- prototypes for Lisp primitives in C ------------*/
2837 /* The following were machine generated 19980312 */
2839 EXFUN (Faccept_process_output, 3);
2841 EXFUN (Fadd_spec_to_specifier, 5);
2842 EXFUN (Fadd_timeout, 4);
2843 EXFUN (Fappend, MANY);
2844 EXFUN (Fapply, MANY);
2849 EXFUN (Fbacktrace, 2);
2850 EXFUN (Fbeginning_of_line, 2);
2854 EXFUN (Fbuffer_substring, 3);
2855 EXFUN (Fbuilt_in_variable_type, 1);
2856 EXFUN (Fbyte_code, 3);
2857 EXFUN (Fcall_interactively, 3);
2858 EXFUN (Fcanonicalize_lax_plist, 2);
2859 EXFUN (Fcanonicalize_plist, 2);
2861 EXFUN (Fcar_safe, 1);
2863 EXFUN (Fchar_after, 2);
2864 EXFUN (Fchar_to_string, 1);
2865 EXFUN (Fcheck_valid_plist, 1);
2866 EXFUN (Fvalid_plist_p, 1);
2867 EXFUN (Fclear_range_table, 1);
2868 EXFUN (Fcoding_category_list, 0);
2869 EXFUN (Fcoding_category_system, 1);
2870 EXFUN (Fcoding_priority_list, 0);
2871 EXFUN (Fcoding_system_charset, 2);
2872 EXFUN (Fcoding_system_doc_string, 1);
2873 EXFUN (Fcoding_system_list, 0);
2874 EXFUN (Fcoding_system_name, 1);
2875 EXFUN (Fcoding_system_p, 1);
2876 EXFUN (Fcoding_system_property, 2);
2877 EXFUN (Fcoding_system_type, 1);
2878 EXFUN (Fcommand_execute, 3);
2879 EXFUN (Fcommandp, 1);
2880 EXFUN (Fconcat, MANY);
2882 EXFUN (Fcopy_alist, 1);
2883 EXFUN (Fcopy_coding_system, 2);
2884 EXFUN (Fcopy_event, 2);
2885 EXFUN (Fcopy_list, 1);
2886 EXFUN (Fcopy_marker, 2);
2887 EXFUN (Fcopy_sequence, 1);
2888 EXFUN (Fcopy_tree, 2);
2889 EXFUN (Fcurrent_window_configuration, 1);
2890 EXFUN (Fdecode_big5_char, 1);
2891 EXFUN (Fdecode_coding_region, 4);
2892 EXFUN (Fdecode_shift_jis_char, 1);
2893 EXFUN (Fdefault_boundp, 1);
2894 EXFUN (Fdefault_value, 1);
2895 EXFUN (Fdefine_key, 3);
2897 EXFUN (Fdelete_region, 3);
2898 EXFUN (Fdelete_process, 1);
2900 EXFUN (Fdestructive_alist_to_plist, 1);
2901 EXFUN (Fdetect_coding_region, 3);
2902 EXFUN (Fdgettext, 2);
2904 EXFUN (Fdirectory_file_name, 1);
2905 EXFUN (Fdisable_timeout, 1);
2906 EXFUN (Fdiscard_input, 0);
2907 EXFUN (Fdispatch_event, 1);
2908 EXFUN (Fdisplay_error, 2);
2909 EXFUN (Fdo_auto_save, 2);
2910 EXFUN (Fdowncase, 2);
2912 EXFUN (Fencode_big5_char, 1);
2913 EXFUN (Fencode_coding_region, 4);
2914 EXFUN (Fencode_shift_jis_char, 1);
2915 EXFUN (Fend_of_line, 2);
2916 EXFUN (Fenqueue_eval_event, 2);
2920 EXFUN (Ferror_message_string, 1);
2922 EXFUN (Fevent_to_character, 4);
2923 EXFUN (Fexecute_kbd_macro, 2);
2924 EXFUN (Fexpand_abbrev, 0);
2925 EXFUN (Fexpand_file_name, 2);
2926 EXFUN (Fextent_at, 5);
2927 EXFUN (Fextent_property, 3);
2928 EXFUN (Ffboundp, 1);
2929 EXFUN (Ffile_accessible_directory_p, 1);
2930 EXFUN (Ffile_directory_p, 1);
2931 EXFUN (Ffile_executable_p, 1);
2932 EXFUN (Ffile_exists_p, 1);
2933 EXFUN (Ffile_name_absolute_p, 1);
2934 EXFUN (Ffile_name_as_directory, 1);
2935 EXFUN (Ffile_name_directory, 1);
2936 EXFUN (Ffile_name_nondirectory, 1);
2937 EXFUN (Ffile_readable_p, 1);
2938 EXFUN (Ffile_symlink_p, 1);
2939 EXFUN (Ffile_truename, 2);
2940 EXFUN (Ffind_coding_system, 1);
2941 EXFUN (Ffind_file_name_handler, 2);
2942 EXFUN (Ffollowing_char, 1);
2943 EXFUN (Fformat, MANY);
2944 EXFUN (Fforward_char, 2);
2945 EXFUN (Fforward_line, 2);
2947 EXFUN (Ffuncall, MANY);
2948 EXFUN (Ffunctionp, 1);
2951 EXFUN (Fget_buffer_process, 1);
2952 EXFUN (Fget_coding_system, 1);
2953 EXFUN (Fget_process, 1);
2954 EXFUN (Fget_range_table, 3);
2955 EXFUN (Fgettext, 1);
2956 EXFUN (Fgoto_char, 2);
2958 EXFUN (Findent_to, 3);
2959 EXFUN (Findirect_function, 1);
2960 EXFUN (Finsert, MANY);
2961 EXFUN (Finsert_buffer_substring, 3);
2962 EXFUN (Finsert_char, 4);
2963 EXFUN (Finsert_file_contents_internal, 7);
2964 EXFUN (Finteractive_p, 0);
2966 EXFUN (Fintern_soft, 2);
2967 EXFUN (Fkey_description, 1);
2968 EXFUN (Fkill_emacs, 1);
2969 EXFUN (Fkill_local_variable, 1);
2971 EXFUN (Flax_plist_get, 3);
2972 EXFUN (Flax_plist_remprop, 2);
2975 EXFUN (Flist, MANY);
2977 EXFUN (Flist_modules, 0);
2978 EXFUN (Fload_module, 3);
2979 EXFUN (Flookup_key, 3);
2981 EXFUN (Fmake_byte_code, MANY);
2982 EXFUN (Fmake_coding_system, 4);
2983 EXFUN (Fmake_glyph_internal, 1);
2984 EXFUN (Fmake_list, 2);
2985 EXFUN (Fmake_marker, 0);
2986 EXFUN (Fmake_range_table, 0);
2987 EXFUN (Fmake_sparse_keymap, 1);
2988 EXFUN (Fmake_string, 2);
2989 EXFUN (Fmake_symbol, 1);
2990 EXFUN (Fmake_vector, 2);
2992 EXFUN (Fmarker_buffer, 1);
2993 EXFUN (Fmarker_position, 1);
2994 EXFUN (Fmatch_beginning, 1);
2995 EXFUN (Fmatch_end, 1);
3000 EXFUN (Fminus, MANY);
3001 EXFUN (Fnarrow_to_region, 3);
3002 EXFUN (Fnconc, MANY);
3003 EXFUN (Fnext_event, 2);
3004 EXFUN (Fnreverse, 1);
3006 EXFUN (Fnumber_to_string, 1);
3007 EXFUN (Fold_assq, 2);
3008 EXFUN (Fold_equal, 2);
3009 EXFUN (Fold_member, 2);
3010 EXFUN (Fold_memq, 2);
3011 EXFUN (Fplist_get, 3);
3012 EXFUN (Fplist_member, 2);
3013 EXFUN (Fplist_put, 3);
3014 EXFUN (Fplus, MANY);
3016 EXFUN (Fpoint_marker, 2);
3017 EXFUN (Fpoint_max, 1);
3018 EXFUN (Fpoint_min, 1);
3019 EXFUN (Fpreceding_char, 1);
3020 EXFUN (Fprefix_numeric_value, 1);
3022 EXFUN (Fprin1_to_string, 2);
3025 EXFUN (Fprocess_status, 1);
3026 EXFUN (Fprogn, UNEVALLED);
3027 EXFUN (Fprovide, 1);
3029 EXFUN (Fput_range_table, 4);
3030 EXFUN (Fput_text_property, 5);
3034 EXFUN (Fread_key_sequence, 3);
3035 EXFUN (Freally_free, 1);
3037 EXFUN (Fremassq, 2);
3038 EXFUN (Freplace_list, 2);
3039 EXFUN (Fselected_frame, 1);
3041 EXFUN (Fset_coding_category_system, 2);
3042 EXFUN (Fset_coding_priority_list, 1);
3043 EXFUN (Fset_default, 2);
3044 EXFUN (Fset_marker, 3);
3045 EXFUN (Fset_standard_case_table, 1);
3049 EXFUN (Fsit_for, 2);
3050 EXFUN (Fskip_chars_backward, 3);
3051 EXFUN (Fskip_chars_forward, 3);
3052 EXFUN (Fsleep_for, 1);
3054 EXFUN (Fspecifier_spec_list, 4);
3055 EXFUN (Fstring_equal, 2);
3056 EXFUN (Fstring_lessp, 2);
3057 EXFUN (Fstring_match, 4);
3059 EXFUN (Fsubr_max_args, 1);
3060 EXFUN (Fsubr_min_args, 1);
3061 EXFUN (Fsubsidiary_coding_system, 2);
3062 EXFUN (Fsubstitute_command_keys, 1);
3063 EXFUN (Fsubstitute_in_file_name, 1);
3064 EXFUN (Fsubstring, 3);
3065 EXFUN (Fsymbol_function, 1);
3066 EXFUN (Fsymbol_name, 1);
3067 EXFUN (Fsymbol_plist, 1);
3068 EXFUN (Fsymbol_value, 1);
3069 EXFUN (Fsystem_name, 0);
3071 EXFUN (Ftimes, MANY);
3072 EXFUN (Ftruncate, 1);
3073 EXFUN (Fundo_boundary, 0);
3074 EXFUN (Funhandled_file_name_directory, 1);
3075 EXFUN (Funlock_buffer, 0);
3077 EXFUN (Fupcase_initials, 2);
3078 EXFUN (Fupcase_initials_region, 3);
3079 EXFUN (Fupcase_region, 3);
3080 EXFUN (Fuser_home_directory, 0);
3081 EXFUN (Fuser_login_name, 1);
3082 EXFUN (Fvector, MANY);
3083 EXFUN (Fverify_visited_file_modtime, 1);
3084 EXFUN (Fvertical_motion, 3);
3087 /*--------------- prototypes for constant symbols ------------*/
3089 extern Lisp_Object Q_style;
3090 extern Lisp_Object Qactivate_menubar_hook;
3091 extern Lisp_Object Qarith_error;
3092 extern Lisp_Object Qarrayp, Qautoload;
3093 extern Lisp_Object Qbackground, Qbackground_pixmap;
3094 extern Lisp_Object Qbeginning_of_buffer, Qbig5;
3095 extern Lisp_Object Qbitp, Qblinking;
3096 extern Lisp_Object Qbuffer_glyph_p, Qbuffer_live_p, Qbuffer_read_only;
3097 extern Lisp_Object Qbyte_code, Qcall_interactively;
3098 extern Lisp_Object Qcategory_designator_p, Qcategory_table_value_p, Qccl, Qcdr;
3099 extern Lisp_Object Qchar_or_string_p, Qcharacterp;
3100 extern Lisp_Object Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
3101 extern Lisp_Object Qcircular_list, Qcircular_property_list;
3102 extern Lisp_Object Qcoding_system_error;
3103 extern Lisp_Object Qcolor_pixmap_image_instance_p;
3104 extern Lisp_Object Qcommandp, Qcompletion_ignore_case;
3105 extern Lisp_Object Qconsole_live_p, Qconst_specifier, Qcr;
3106 extern Lisp_Object Qcrlf, Qcurrent_menubar, Qctext;
3107 extern Lisp_Object Qcyclic_variable_indirection, Qdecode;
3108 extern Lisp_Object Qdefun, Qdevice_live_p;
3109 extern Lisp_Object Qdim, Qdisabled, Qdisplay_table;
3110 extern Lisp_Object Qdomain_error;
3111 extern Lisp_Object Qediting_error;
3112 extern Lisp_Object Qencode, Qend_of_buffer, Qend_of_file, Qend_open;
3113 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type;
3114 extern Lisp_Object Qerror, Qerror_conditions, Qerror_message, Qescape_quoted;
3115 extern Lisp_Object Qevent_live_p, Qexit, Qextent_live_p;
3116 extern Lisp_Object Qexternal_debugging_output, Qfeaturep;
3117 extern Lisp_Object Qfile_error;
3118 extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
3119 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output, Qforeground;
3120 extern Lisp_Object Qformat, Qframe_live_p;
3121 extern Lisp_Object Qicon_glyph_p, Qidentity;
3122 extern Lisp_Object Qinhibit_quit, Qinhibit_read_only;
3123 extern Lisp_Object Qinput_charset_conversion;
3124 extern Lisp_Object Qinteger_char_or_marker_p, Qinteger_or_char_p;
3125 extern Lisp_Object Qinteger_or_marker_p, Qintegerp, Qinteractive;
3126 extern Lisp_Object Qinternal_error, Qinvalid_argument;
3127 extern Lisp_Object Qinvalid_change, Qinvalid_function, Qinvalid_operation;
3128 extern Lisp_Object Qinvalid_read_syntax, Qinvalid_state;
3129 extern Lisp_Object Qio_error;
3130 extern Lisp_Object Qiso2022;
3131 extern Lisp_Object Qlambda, Qlayout;
3132 extern Lisp_Object Qlf;
3133 extern Lisp_Object Qlist_formation_error;
3134 extern Lisp_Object Qlistp, Qload, Qlock_shift, Qmacro;
3135 extern Lisp_Object Qmakunbound, Qmalformed_list, Qmalformed_property_list;
3136 extern Lisp_Object Qmark;
3137 extern Lisp_Object Qmnemonic;
3138 extern Lisp_Object Qmono_pixmap_image_instance_p;
3139 extern Lisp_Object Qmouse_leave_buffer_hook;
3140 extern Lisp_Object Qnas, Qnatnump, Qnative_layout;
3141 extern Lisp_Object Qno_ascii_cntl, Qno_ascii_eol, Qno_catch;
3142 extern Lisp_Object Qno_conversion, Qno_iso6429;
3143 extern Lisp_Object Qnothing_image_instance_p;
3144 extern Lisp_Object Qnumber_char_or_marker_p, Qnumberp;
3145 extern Lisp_Object Qoutput_charset_conversion;
3146 extern Lisp_Object Qoverflow_error, Qpoint, Qpointer_glyph_p;
3147 extern Lisp_Object Qpointer_image_instance_p, Qpost_read_conversion;
3148 extern Lisp_Object Qpre_write_conversion, Qprint_length;
3149 extern Lisp_Object Qprint_string_length, Qprogn, Qquit;
3150 extern Lisp_Object Qquote, Qrange_error, Qread_char;
3151 extern Lisp_Object Qread_from_minibuffer, Qreally_early_error_handler;
3152 extern Lisp_Object Qregion_beginning, Qregion_end;
3153 extern Lisp_Object Qrun_hooks, Qsans_modifiers;
3154 extern Lisp_Object Qsave_buffers_kill_emacs;
3155 extern Lisp_Object Qself_insert_command, Qself_insert_defer_undo;
3156 extern Lisp_Object Qsequencep, Qset, Qsetting_constant;
3157 extern Lisp_Object Qseven, Qshift_jis, Qshort;
3158 extern Lisp_Object Qsingularity_error;
3159 extern Lisp_Object Qstandard_input, Qstandard_output;
3160 extern Lisp_Object Qstart_open;
3161 extern Lisp_Object Qstring_lessp, Qsubwindow;
3162 extern Lisp_Object Qsubwindow_image_instance_p;
3163 extern Lisp_Object Qsyntax_error, Qt;
3164 extern Lisp_Object Qtext_image_instance_p;
3165 extern Lisp_Object Qtop_level;
3166 extern Lisp_Object Qtrue_list_p;
3167 extern Lisp_Object Qunbound, Qunderflow_error;
3168 extern Lisp_Object Qunderline, Quser_files_and_directories;
3169 extern Lisp_Object Qvalues;
3170 extern Lisp_Object Qvariable_documentation, Qvariable_domain;
3171 extern Lisp_Object Qvoid_function, Qvoid_variable;
3172 extern Lisp_Object Qwindow_live_p, Qwrong_number_of_arguments;
3173 extern Lisp_Object Qwrong_type_argument, Qyes_or_no_p;
3175 #define SYMBOL(fou) extern Lisp_Object fou
3176 #define SYMBOL_KEYWORD(la_cle_est_fou) extern Lisp_Object la_cle_est_fou
3177 #define SYMBOL_GENERAL(tout_le_monde, est_fou) \
3178 extern Lisp_Object tout_le_monde
3180 #include "general-slots.h"
3183 #undef SYMBOL_KEYWORD
3184 #undef SYMBOL_GENERAL
3186 /*--------------- prototypes for variables of type Lisp_Object ------------*/
3188 extern Lisp_Object Vactivate_menubar_hook;
3189 extern Lisp_Object Vautoload_queue, Vblank_menubar;
3190 extern Lisp_Object Vcharset_ascii, Vcharset_composite, Vcharset_control_1;
3191 extern Lisp_Object Vcharset_latin_iso8859_1, Vcharset_greek_iso8859_7;
3192 extern Lisp_Object Vcharset_cyrillic_iso8859_5, Vcharset_hebrew_iso8859_8;
3193 extern Lisp_Object Vcharset_thai_tis620, Vcharset_katakana_jisx0201;
3194 extern Lisp_Object Vcoding_system_for_read, Vcoding_system_for_write;
3195 extern Lisp_Object Vcoding_system_hash_table, Vcommand_history;
3196 extern Lisp_Object Vcommand_line_args, Vconfigure_info_directory;
3197 extern Lisp_Object Vconfigure_site_directory, Vconfigure_site_module_directory;
3198 extern Lisp_Object Vconsole_list, Vcontrolling_terminal;
3199 extern Lisp_Object Vcurrent_compiled_function_annotation, Vcurrent_load_list;
3200 extern Lisp_Object Vcurrent_mouse_event, Vcurrent_prefix_arg, Vdata_directory;
3201 extern Lisp_Object Vdirectory_sep_char, Vdisabled_command_hook;
3202 extern Lisp_Object Vdoc_directory, Vinternal_doc_file_name;
3203 extern Lisp_Object Vecho_area_buffer, Vemacs_major_version;
3204 extern Lisp_Object Vemacs_minor_version, Vexec_directory, Vexec_path;
3205 extern Lisp_Object Vexecuting_macro, Vfeatures, Vfile_domain;
3206 extern Lisp_Object Vfile_name_coding_system, Vinhibit_quit;
3207 extern Lisp_Object Vinvocation_directory, Vinvocation_name;
3208 extern Lisp_Object Vkeyboard_coding_system, Vlast_command, Vlast_command_char;
3209 extern Lisp_Object Vlast_command_event, Vlast_input_event;
3210 extern Lisp_Object Vload_file_name_internal;
3211 extern Lisp_Object Vload_file_name_internal_the_purecopy, Vload_history;
3212 extern Lisp_Object Vload_path, Vmark_even_if_inactive, Vmenubar_configuration;
3213 extern Lisp_Object Vminibuf_preprompt, Vminibuf_prompt, Vminibuffer_zero;
3214 extern Lisp_Object Vmodule_directory, Vmswindows_downcase_file_names;
3215 extern Lisp_Object Vmswindows_get_true_file_attributes, Vobarray;
3216 extern Lisp_Object Vprint_length, Vprint_level, Vprocess_environment;
3217 extern Lisp_Object Vquit_flag;
3218 extern Lisp_Object Vrecent_keys_ring, Vshell_file_name, Vsite_directory;
3219 extern Lisp_Object Vsite_module_directory;
3220 extern Lisp_Object Vstandard_input, Vstandard_output, Vstdio_str;
3221 extern Lisp_Object Vsynchronous_sounds, Vsystem_name, Vterminal_coding_system;
3222 extern Lisp_Object Vthis_command_keys, Vunread_command_event;
3223 extern Lisp_Object Vx_initial_argv_list;
3225 #endif /* INCLUDED_lisp_h_ */