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_begin(d) Dynarr_atp (d, 0)
74 #define Dynarr_end(d) Dynarr_atp (d, Dynarr_length (d))
75 #define Dynarr_sizeof(d) ((d)->cur * (d)->elsize)
76 #define Dynarr_length(d) ((d)->cur)
77 #define Dynarr_largest(d) ((d)->largest)
78 #define Dynarr_reset(d) ((d)->cur = 0)
79 #define Dynarr_add_many(d, el, len) Dynarr_insert_many (d, el, len, (d)->cur)
80 #define Dynarr_insert_many_at_start(d, el, len) \
81 Dynarr_insert_many (d, el, len, 0)
82 #define Dynarr_add_literal_string(d, s) Dynarr_add_many (d, s, sizeof (s) - 1)
83 #define Dynarr_add_lisp_string(d, s) do { \
84 Lisp_String *dyna_ls_s = XSTRING (s); \
85 Dynarr_add_many (d, (char *) string_data (dyna_ls_s), \
86 string_length (dyna_ls_s)); \
89 #define Dynarr_add(d, el) ( \
90 (d)->cur >= (d)->max ? Dynarr_resize ((d), (d)->cur+1) : (void) 0, \
91 ((d)->base)[(d)->cur++] = (el), \
92 (d)->cur > (d)->largest ? (d)->largest = (d)->cur : (int) 0)
94 /* The following defines will get you into real trouble if you aren't
95 careful. But they can save a lot of execution time when used wisely. */
96 #define Dynarr_increment(d) ((d)->cur++)
97 #define Dynarr_set_size(d, n) ((d)->cur = n)
99 #ifdef MEMORY_USAGE_STATS
100 struct overhead_stats;
101 size_t Dynarr_memory_usage (void *d, struct overhead_stats *stats);
104 /* Also define min() and max(). (Some compilers put them in strange
105 places that won't be referenced by the above include files, such
106 as 'macros.h' under Solaris.) */
109 #define min(a,b) (((a) <= (b)) ? (a) : (b))
112 #define max(a,b) (((a) > (b)) ? (a) : (b))
115 /* Memory allocation */
116 void malloc_warning (const char *);
117 void *xmalloc (size_t size);
118 void *xmalloc_and_zero (size_t size);
119 void *xrealloc (void *, size_t size);
120 char *xstrdup (const char *);
121 /* generally useful */
122 #define countof(x) ((int) (sizeof(x)/sizeof((x)[0])))
123 #define xnew(type) ((type *) xmalloc (sizeof (type)))
124 #define xnew_array(type, len) ((type *) xmalloc ((len) * sizeof (type)))
125 #define xnew_and_zero(type) ((type *) xmalloc_and_zero (sizeof (type)))
126 #define xzero(lvalue) ((void) memset (&(lvalue), '\0', sizeof (lvalue)))
127 #define xnew_array_and_zero(type, len) ((type *) xmalloc_and_zero ((len) * sizeof (type)))
128 #define XREALLOC_ARRAY(ptr, type, len) ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
129 #define alloca_array(type, len) ((type *) alloca ((len) * sizeof (type)))
131 /* also generally useful if you want to avoid arbitrary size limits
132 but don't need a full dynamic array. Assumes that BASEVAR points
133 to a malloced array of TYPE objects (or possibly a NULL pointer,
134 if SIZEVAR is 0), with the total size stored in SIZEVAR. This
135 macro will realloc BASEVAR as necessary so that it can hold at
136 least NEEDED_SIZE objects. The reallocing is done by doubling,
137 which ensures constant amortized time per element. */
138 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
139 size_t do_realloc_needed_size = (needed_size); \
140 if ((sizevar) < do_realloc_needed_size) \
142 if ((sizevar) < 32) \
144 while ((sizevar) < do_realloc_needed_size) \
146 XREALLOC_ARRAY (basevar, type, (sizevar)); \
150 #ifdef ERROR_CHECK_MALLOC
151 void xfree_1 (void *);
152 #define xfree(lvalue) do \
154 void **xfree_ptr = (void **) &(lvalue); \
155 xfree_1 (*xfree_ptr); \
156 *xfree_ptr = (void *) 0xDEADBEEF; \
160 #endif /* ERROR_CHECK_MALLOC */
163 # if defined (__GNUC__) && (__GNUC__ >= 2)
164 # define PRINTF_ARGS(string_index,first_to_check) \
165 __attribute__ ((format (printf, string_index, first_to_check)))
167 # define PRINTF_ARGS(string_index,first_to_check)
171 #ifndef DOESNT_RETURN
172 # if defined __GNUC__
173 # if ((__GNUC__ > 2) || (__GNUC__ == 2) && (__GNUC_MINOR__ >= 5))
174 # define DOESNT_RETURN void
175 # define DECLARE_DOESNT_RETURN(decl) \
176 extern void decl __attribute__ ((noreturn))
177 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
178 /* Should be able to state multiple independent __attribute__s, but \
179 the losing syntax doesn't work that way, and screws losing cpp */ \
181 __attribute__ ((noreturn, format (printf, str, idx)))
183 # define DOESNT_RETURN void volatile
184 # define DECLARE_DOESNT_RETURN(decl) extern void volatile decl
185 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
186 extern void volatile decl PRINTF_ARGS(str,idx)
187 # endif /* GNUC 2.5 */
189 # define DOESNT_RETURN void
190 # define DECLARE_DOESNT_RETURN(decl) extern void decl
191 # define DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(decl,str,idx) \
192 extern void decl PRINTF_ARGS(str,idx)
196 /* No type has a greater alignment requirement than max_align_t.
197 (except perhaps for types we don't use, like long double) */
200 struct { long l; } l;
201 struct { void *p; } p;
202 struct { void (*f)(void); } f;
203 struct { double d; } d;
207 # if defined (__GNUC__) && (__GNUC__ >= 2)
208 /* gcc has an extension that gives us exactly what we want. */
209 # define ALIGNOF(type) __alignof__ (type)
210 # elif ! defined (__cplusplus)
211 /* The following is mostly portable, except that:
212 - it doesn't work for inside out declarations like void (*) (void).
213 (so just call ALIGNOF with a typedef'ed name)
214 - it doesn't work with C++. The C++ committee has decided,
215 in its infinite wisdom, that:
216 "Types must be declared in declarations, not in expressions." */
217 # define ALIGNOF(type) offsetof (struct { char c; type member; }, member)
219 /* The following should be completely portable, but might give values
220 that are larger than necessary. But never larger than the maximum
221 possible alignment. */
222 # define ALIGNOF(type) \
223 ((sizeof (type) % sizeof (max_align_t)) == 0 ? \
224 sizeof (max_align_t) : \
225 (sizeof (type) % sizeof (max_align_t)))
229 #define ALIGN_SIZE(len, unit) \
230 ((((len) + (unit) - 1) / (unit)) * (unit))
232 /* #### Yuck, this is kind of evil */
233 #define ALIGN_PTR(ptr, unit) \
234 ((void *) ALIGN_SIZE ((size_t) (ptr), unit))
237 #define DO_NOTHING do {} while (0)
240 #ifndef DECLARE_NOTHING
241 #define DECLARE_NOTHING struct nosuchstruct
244 /* We define assert iff USE_ASSERTIONS or DEBUG_XEMACS is defined.
245 Otherwise we define it to be empty. Quantify has shown that the
246 time the assert checks take is measurable so let's not include them
247 in production binaries. */
249 #ifdef USE_ASSERTIONS
250 /* Highly dubious kludge */
251 /* (thanks, Jamie, I feel better now -- ben) */
252 void assert_failed (const char *, int, const char *);
253 # define abort() (assert_failed (__FILE__, __LINE__, "abort()"))
254 # define assert(x) ((x) ? (void) 0 : assert_failed (__FILE__, __LINE__, #x))
257 # define assert(x) ((x) ? (void) 0 : (void) abort ())
263 /*#ifdef DEBUG_XEMACS*/
267 /*#define REGISTER register*/
271 /* EMACS_INT is the underlying integral type into which a Lisp_Object must fit.
272 In particular, it must be large enough to contain a pointer.
273 config.h can override this, e.g. to use `long long' for bigger lisp ints. */
275 #ifndef SIZEOF_EMACS_INT
276 # define SIZEOF_EMACS_INT SIZEOF_VOID_P
280 # if SIZEOF_EMACS_INT == SIZEOF_LONG
281 # define EMACS_INT long
282 # elif SIZEOF_EMACS_INT == SIZEOF_INT
283 # define EMACS_INT int
284 # elif SIZEOF_EMACS_INT == SIZEOF_LONG_LONG
285 # define EMACS_INT long long
287 # error Unable to determine suitable type for EMACS_INT
292 # define EMACS_UINT unsigned EMACS_INT
295 #define BITS_PER_EMACS_INT (SIZEOF_EMACS_INT * BITS_PER_CHAR)
298 /************************************************************************/
300 /************************************************************************/
302 /* We put typedefs here so that prototype declarations don't choke.
303 Note that we don't actually declare the structures here (except
304 maybe for simple structures like Dynarrs); that keeps them private
305 to the routines that actually use them. */
307 /* ------------------------------- */
308 /* basic char/int typedefs */
309 /* ------------------------------- */
311 /* The definitions we put here use typedefs to attribute specific meaning
312 to types that by themselves are pretty general. Stuff pointed to by a
313 char * or unsigned char * will nearly always be one of four types:
314 a) pointer to internally-formatted text; b) pointer to text in some
315 external format, which can be defined as all formats other than the
316 internal one; c) pure ASCII text; d) binary data that is not meant to
317 be interpreted as text. [A fifth possible type "e) a general pointer
318 to memory" should be replaced with void *.] Using these more specific
319 types rather than the general ones helps avoid the confusions that
320 occur when the semantics of a char * argument being studied are unclear. */
322 typedef unsigned char UChar;
324 /* The data representing the text in a buffer is logically a set
325 of Bufbytes, declared as follows. */
327 typedef UChar Bufbyte;
329 /* Explicitly signed or unsigned versions: */
330 typedef UChar UBufbyte;
331 typedef char SBufbyte;
333 /* The data representing a string in "external" format (binary or any
334 external encoding) is logically a set of Extbytes, declared as
335 follows. Extbyte is guaranteed to be just a char, so for example
336 strlen (Extbyte *) is OK. Extbyte is only a documentation device
337 for referring to external text. */
339 typedef char Extbyte;
341 /* A byte in a string in binary format: */
342 typedef char Char_Binary;
343 typedef UChar UChar_Binary;
345 /* A byte in a string in entirely US-ASCII format: (Nothing outside
346 the range 00 - 7F) */
348 typedef char Char_ASCII;
349 typedef UChar UChar_ASCII;
352 /* To the user, a buffer is made up of characters, declared as follows.
353 In the non-Mule world, characters and Bufbytes are equivalent.
354 In the Mule world, a character requires (typically) 1 to 4
355 Bufbytes for its representation in a buffer. */
359 /* Different ways of referring to a position in a buffer. We use
360 the typedefs in preference to 'int' to make it clearer what
361 sort of position is being used. See extents.c for a description
362 of the different positions. We put them here instead of in
363 buffer.h (where they rightfully belong) to avoid syntax errors
364 in function prototypes. */
366 typedef EMACS_INT Bufpos;
367 typedef EMACS_INT Bytind;
368 typedef EMACS_INT Memind;
370 /* Counts of bytes or chars */
372 typedef EMACS_INT Bytecount;
373 typedef EMACS_INT Charcount;
375 /* Length in bytes of a string in external format */
376 typedef EMACS_INT Extcount;
378 /* ------------------------------- */
379 /* structure/other typedefs */
380 /* ------------------------------- */
382 typedef struct lstream Lstream;
384 typedef unsigned int face_index;
388 Dynarr_declare (struct face_cachel);
389 } face_cachel_dynarr;
391 typedef unsigned int glyph_index;
393 /* This is shared by process.h, events.h and others in future.
394 See events.h for description */
395 typedef unsigned int USID;
399 Dynarr_declare (struct glyph_cachel);
400 } glyph_cachel_dynarr;
402 struct buffer; /* "buffer.h" */
403 struct console; /* "console.h" */
404 struct device; /* "device.h" */
405 struct extent_fragment;
407 typedef struct extent *EXTENT;
408 struct frame; /* "frame.h" */
409 struct window; /* "window.h" */
410 typedef struct Lisp_Event Lisp_Event; /* "events.h" */
411 typedef struct Lisp_Face Lisp_Face; /* "faces.h" */
412 typedef struct Lisp_Process Lisp_Process; /* "procimpl.h" */
413 struct stat; /* <sys/stat.h> */
414 typedef struct Lisp_Color_Instance Lisp_Color_Instance;
415 typedef struct Lisp_Font_Instance Lisp_Font_Instance;
416 typedef struct Lisp_Image_Instance Lisp_Image_Instance;
417 typedef struct Lisp_Gui_Item Lisp_Gui_Item;
419 struct display_glyph_area;
421 struct redisplay_info;
422 struct window_mirror;
423 struct scrollbar_instance;
424 struct font_metric_info;
426 struct console_type_entry;
430 Dynarr_declare (Bufbyte);
435 Dynarr_declare (Extbyte);
440 Dynarr_declare (Emchar);
445 Dynarr_declare (char);
448 typedef unsigned char unsigned_char;
451 Dynarr_declare (unsigned char);
452 } unsigned_char_dynarr;
454 typedef unsigned long unsigned_long;
457 Dynarr_declare (unsigned long);
458 } unsigned_long_dynarr;
462 Dynarr_declare (int);
467 Dynarr_declare (Bufpos);
472 Dynarr_declare (Bytind);
477 Dynarr_declare (Charcount);
482 Dynarr_declare (Bytecount);
487 Dynarr_declare (struct console_type_entry);
488 } console_type_entry_dynarr;
490 enum run_hooks_condition
492 RUN_HOOKS_TO_COMPLETION,
493 RUN_HOOKS_UNTIL_SUCCESS,
494 RUN_HOOKS_UNTIL_FAILURE
515 #ifndef ERROR_CHECK_TYPECHECK
517 typedef enum error_behavior
524 #define ERRB_EQ(a, b) ((a) == (b))
528 /* By defining it like this, we provide strict type-checking
529 for code that lazily uses ints. */
531 typedef struct _error_behavior_struct_
533 int really_unlikely_name_to_have_accidentally_in_a_non_errb_structure;
536 extern Error_behavior ERROR_ME;
537 extern Error_behavior ERROR_ME_NOT;
538 extern Error_behavior ERROR_ME_WARN;
540 #define ERRB_EQ(a, b) \
541 ((a).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure == \
542 (b).really_unlikely_name_to_have_accidentally_in_a_non_errb_structure)
546 enum munge_me_out_the_door
548 MUNGE_ME_FUNCTION_KEY,
549 MUNGE_ME_KEY_TRANSLATION
553 /************************************************************************/
554 /* Definition of Lisp_Object data type */
555 /************************************************************************/
557 /* Define the fundamental Lisp data structures */
559 /* This is the set of Lisp data types */
569 #define POINTER_TYPE_P(type) ((type) == Lisp_Type_Record)
571 /* Overridden by m/next.h */
572 #ifndef ASSERT_VALID_POINTER
573 # define ASSERT_VALID_POINTER(pnt) (assert ((((EMACS_UINT) pnt) & 3) == 0))
581 #define INT_VALBITS (BITS_PER_EMACS_INT - INT_GCBITS)
582 #define VALBITS (BITS_PER_EMACS_INT - GCBITS)
583 #define EMACS_INT_MAX ((EMACS_INT) ((1UL << INT_VALBITS) -1UL))
584 #define EMACS_INT_MIN (-(EMACS_INT_MAX) - 1)
586 #ifdef USE_UNION_TYPE
587 # include "lisp-union.h"
588 #else /* !USE_UNION_TYPE */
589 # include "lisp-disunion.h"
590 #endif /* !USE_UNION_TYPE */
592 #define XPNTR(x) ((void *) XPNTRVAL(x))
594 /* WARNING WARNING WARNING. You must ensure on your own that proper
595 GC protection is provided for the elements in this array. */
598 Dynarr_declare (Lisp_Object);
599 } Lisp_Object_dynarr;
603 Dynarr_declare (Lisp_Object *);
604 } Lisp_Object_ptr_dynarr;
606 /* Close your eyes now lest you vomit or spontaneously combust ... */
608 #define HACKEQ_UNSAFE(obj1, obj2) \
609 (EQ (obj1, obj2) || (!POINTER_TYPE_P (XTYPE (obj1)) \
610 && !POINTER_TYPE_P (XTYPE (obj2)) \
611 && XCHAR_OR_INT (obj1) == XCHAR_OR_INT (obj2)))
614 extern int debug_issue_ebola_notices;
615 int eq_with_ebola_notice (Lisp_Object, Lisp_Object);
616 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2) \
617 (debug_issue_ebola_notices ? eq_with_ebola_notice (obj1, obj2) \
620 #define EQ_WITH_EBOLA_NOTICE(obj1, obj2) EQ (obj1, obj2)
623 /* OK, you can open them again */
626 /************************************************************************/
627 /** Definitions of basic Lisp objects **/
628 /************************************************************************/
632 /*------------------------------ unbound -------------------------------*/
634 /* Qunbound is a special Lisp_Object (actually of type
635 symbol-value-forward), that can never be visible to
636 the Lisp caller and thus can be used in the C code
637 to mean "no such value". */
639 #define UNBOUNDP(val) EQ (val, Qunbound)
641 /*------------------------------- cons ---------------------------------*/
643 /* In a cons, the markbit of the car is the gc mark bit */
647 struct lrecord_header lheader;
648 Lisp_Object car, cdr;
650 typedef struct Lisp_Cons Lisp_Cons;
653 /* Like a cons, but records info on where the text lives that it was read from */
654 /* This is not really in use now */
656 struct Lisp_Buffer_Cons
658 Lisp_Object car, cdr;
659 struct buffer *buffer;
664 DECLARE_LRECORD (cons, Lisp_Cons);
665 #define XCONS(x) XRECORD (x, cons, Lisp_Cons)
666 #define XSETCONS(x, p) XSETRECORD (x, p, cons)
667 #define CONSP(x) RECORDP (x, cons)
668 #define CHECK_CONS(x) CHECK_RECORD (x, cons)
669 #define CONCHECK_CONS(x) CONCHECK_RECORD (x, cons)
671 #define CONS_MARKED_P(c) MARKED_RECORD_HEADER_P(&((c)->lheader))
672 #define MARK_CONS(c) MARK_RECORD_HEADER (&((c)->lheader))
674 extern Lisp_Object Qnil;
676 #define NILP(x) EQ (x, Qnil)
677 #define XCAR(a) (XCONS (a)->car)
678 #define XCDR(a) (XCONS (a)->cdr)
679 #define LISTP(x) (CONSP(x) || NILP(x))
681 #define CHECK_LIST(x) do { \
683 dead_wrong_type_argument (Qlistp, x); \
686 #define CONCHECK_LIST(x) do { \
688 x = wrong_type_argument (Qlistp, x); \
691 /*---------------------- list traversal macros -------------------------*/
693 /* Note: These macros are for traversing through a list in some format,
694 and executing code that you specify on each member of the list.
696 There are two kinds of macros, those requiring surrounding braces, and
697 those not requiring this. Which type of macro will be indicated.
698 The general format for using a brace-requiring macro is
701 LIST_LOOP_3 (elt, list, tail)
708 LIST_LOOP_3 (elt, list, tail)
714 You can put variable declarations between the brace and beginning of
715 macro, but NOTHING ELSE.
717 The brace-requiring macros typically declare themselves any arguments
718 that are initialized and iterated by the macros. If for some reason
719 you need to declare these arguments yourself (e.g. to do something on
720 them before the iteration starts, use the _NO_DECLARE versions of the
724 /* There are two basic kinds of macros: those that handle "internal" lists
725 that are known to be correctly structured (i.e. first element is a cons
726 or nil, and the car of each cons is also a cons or nil, and there are
727 no circularities), and those that handle "external" lists, where the
728 list may have any sort of invalid formation. This is reflected in
729 the names: those with "EXTERNAL_" work with external lists, and those
730 without this prefix work with internal lists. The internal-list
731 macros will hit an assertion failure if the structure is ill-formed;
732 the external-list macros will signal an error in this case, either a
733 malformed-list error or a circular-list error.
735 Note also that the simplest external list iterator, EXTERNAL_LIST_LOOP,
736 does *NOT* check for circularities. Therefore, make sure you call
737 QUIT each iteration or so. However, it's probably easier just to use
738 EXTERNAL_LIST_LOOP_2, which is easier to use in any case.
741 /* LIST_LOOP and EXTERNAL_LIST_LOOP are the simplest macros. They don't
742 require brace surrounding, and iterate through a list, which may or may
743 not known to be syntactically correct. EXTERNAL_LIST_LOOP is for those
744 not known to be correct, and it detects and signals a malformed list
745 error when encountering a problem. Circularities, however, are not
746 handled, and cause looping forever, so make sure to include a QUIT.
747 These functions also accept two args, TAIL (set progressively to each
748 cons starting with the first), and LIST, the list to iterate over.
749 TAIL needs to be defined by the program.
751 In each iteration, you can retrieve the current list item using XCAR
752 (tail), or destructively modify the list using XSETCAR (tail,
755 #define LIST_LOOP(tail, list) \
760 #define EXTERNAL_LIST_LOOP(tail, list) \
761 for (tail = list; !NILP (tail); tail = XCDR (tail)) \
763 signal_malformed_list_error (list); \
766 /* The following macros are the "core" macros for list traversal.
768 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
770 LIST_LOOP_2 and EXTERNAL_LIST_LOOP_2 are the standard, most-often used
771 macros. They take two arguments, an element variable ELT and the list
772 LIST. ELT is automatically declared, and set to each element in turn
775 LIST_LOOP_3 and EXTERNAL_LIST_LOOP_3 are the same, but they have a third
776 argument TAIL, another automatically-declared variable. At each iteration,
777 this one points to the cons cell for which ELT is the car.
779 EXTERNAL_LIST_LOOP_4 is like EXTERNAL_LIST_LOOP_3 but takes an additional
780 LEN argument, again automatically declared, which counts the number of
781 iterations gone by. It is 0 during the first iteration.
783 EXTERNAL_LIST_LOOP_4_NO_DECLARE is like EXTERNAL_LIST_LOOP_4 but none
784 of the variables are automatically declared, and so you need to declare
785 them yourself. (ELT and TAIL are Lisp_Objects, and LEN is an EMACS_INT.)
788 #define LIST_LOOP_2(elt, list) \
789 LIST_LOOP_3(elt, list, unused_tail_##elt)
791 #define LIST_LOOP_3(elt, list, tail) \
792 Lisp_Object elt, tail; \
795 0 : (elt = XCAR (tail), 1); \
798 /* The following macros are for traversing lisp lists.
799 Signal an error if LIST is not properly acyclic and nil-terminated.
801 Use tortoise/hare algorithm to check for cycles, but only if it
802 looks like the list is getting too long. Not only is the hare
803 faster than the tortoise; it even gets a head start! */
805 /* Optimized and safe macros for looping over external lists. */
806 #define CIRCULAR_LIST_SUSPICION_LENGTH 1024
808 #define EXTERNAL_LIST_LOOP_1(list) \
809 Lisp_Object ELL1_elt, ELL1_hare, ELL1_tortoise; \
810 EMACS_INT ELL1_len; \
811 PRIVATE_EXTERNAL_LIST_LOOP_6 (ELL1_elt, list, ELL1_len, ELL1_hare, \
812 ELL1_tortoise, CIRCULAR_LIST_SUSPICION_LENGTH)
814 #define EXTERNAL_LIST_LOOP_2(elt, list) \
815 Lisp_Object elt, hare_##elt, tortoise_##elt; \
816 EMACS_INT len_##elt; \
817 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, hare_##elt, \
818 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
820 #define EXTERNAL_LIST_LOOP_3(elt, list, tail) \
821 Lisp_Object elt, tail, tortoise_##elt; \
822 EMACS_INT len_##elt; \
823 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len_##elt, tail, \
824 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
826 #define EXTERNAL_LIST_LOOP_4_NO_DECLARE(elt, list, tail, len) \
827 Lisp_Object tortoise_##elt; \
828 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail, \
829 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
831 #define EXTERNAL_LIST_LOOP_4(elt, list, tail, len) \
832 Lisp_Object elt, tail, tortoise_##elt; \
834 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, tail, \
835 tortoise_##elt, CIRCULAR_LIST_SUSPICION_LENGTH)
838 #define PRIVATE_EXTERNAL_LIST_LOOP_6(elt, list, len, hare, \
839 tortoise, suspicion_length) \
840 for (tortoise = hare = list, len = 0; \
842 (CONSP (hare) ? ((elt = XCAR (hare)), 1) : \
844 (signal_malformed_list_error (list), 0))); \
846 hare = XCDR (hare), \
848 ((++len > suspicion_length) \
850 ((((len & 1) != 0) && (tortoise = XCDR (tortoise), 0)), \
851 (EQ (hare, tortoise) && (signal_circular_list_error (list), 0)))))
853 /* GET_LIST_LENGTH and GET_EXTERNAL_LIST_LENGTH:
855 These two macros return the length of LIST (either an internal or external
856 list, according to which macro is used), stored into LEN (which must
857 be declared by the caller). Circularities are trapped in external lists
858 (and cause errors). Neither macro need be declared inside brackets. */
860 #define GET_LIST_LENGTH(list, len) do { \
861 Lisp_Object GLL_tail; \
862 for (GLL_tail = list, len = 0; \
864 GLL_tail = XCDR (GLL_tail), ++len) \
868 #define GET_EXTERNAL_LIST_LENGTH(list, len) \
870 Lisp_Object GELL_elt, GELL_tail; \
871 EXTERNAL_LIST_LOOP_4_NO_DECLARE (GELL_elt, list, GELL_tail, len) \
875 /* For a list that's known to be in valid list format, where we may
876 be deleting the current element out of the list --
877 will abort() if the list is not in valid format */
878 #define LIST_LOOP_DELETING(consvar, nextconsvar, list) \
879 for (consvar = list; \
880 !NILP (consvar) ? (nextconsvar = XCDR (consvar), 1) :0; \
881 consvar = nextconsvar)
883 /* LIST_LOOP_DELETE_IF and EXTERNAL_LIST_LOOP_DELETE_IF:
885 These two macros delete all elements of LIST (either an internal or
886 external list, according to which macro is used) satisfying
887 CONDITION, a C expression referring to variable ELT. ELT is
888 automatically declared. Circularities are trapped in external
889 lists (and cause errors). Neither macro need be declared inside
892 #define LIST_LOOP_DELETE_IF(elt, list, condition) do { \
893 /* Do not use ##list when creating new variables because \
894 that may not be just a variable name. */ \
895 Lisp_Object prev_tail_##elt = Qnil; \
896 LIST_LOOP_3 (elt, list, tail_##elt) \
900 if (NILP (prev_tail_##elt)) \
901 list = XCDR (tail_##elt); \
903 XCDR (prev_tail_##elt) = XCDR (tail_##elt); \
906 prev_tail_##elt = tail_##elt; \
910 #define EXTERNAL_LIST_LOOP_DELETE_IF(elt, list, condition) do { \
911 Lisp_Object prev_tail_##elt = Qnil; \
912 EXTERNAL_LIST_LOOP_4 (elt, list, tail_##elt, len_##elt) \
916 if (NILP (prev_tail_##elt)) \
917 list = XCDR (tail_##elt); \
919 XCDR (prev_tail_##elt) = XCDR (tail_##elt); \
920 /* Keep tortoise from ever passing hare. */ \
924 prev_tail_##elt = tail_##elt; \
929 /* Macros for looping over external alists.
931 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
933 EXTERNAL_ALIST_LOOP_4 is similar to EXTERNAL_LIST_LOOP_2, but it
934 assumes the elements are aconses (the elements in an alist) and
935 sets two additional argument variables ELT_CAR and ELT_CDR to the
936 car and cdr of the acons. All of the variables ELT, ELT_CAR and
937 ELT_CDR are automatically declared.
939 EXTERNAL_ALIST_LOOP_5 adds a TAIL argument to EXTERNAL_ALIST_LOOP_4,
940 just like EXTERNAL_LIST_LOOP_3 does, and again TAIL is automatically
943 EXTERNAL_ALIST_LOOP_6 adds a LEN argument to EXTERNAL_ALIST_LOOP_5,
944 just like EXTERNAL_LIST_LOOP_4 does, and again LEN is automatically
947 EXTERNAL_ALIST_LOOP_6_NO_DECLARE does not declare any of its arguments,
948 just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these must be declared
952 /* Optimized and safe macros for looping over external alists. */
953 #define EXTERNAL_ALIST_LOOP_4(elt, elt_car, elt_cdr, list) \
954 Lisp_Object elt, elt_car, elt_cdr; \
955 Lisp_Object hare_##elt, tortoise_##elt; \
956 EMACS_INT len_##elt; \
957 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
958 len_##elt, hare_##elt, tortoise_##elt, \
959 CIRCULAR_LIST_SUSPICION_LENGTH)
961 #define EXTERNAL_ALIST_LOOP_5(elt, elt_car, elt_cdr, list, tail) \
962 Lisp_Object elt, elt_car, elt_cdr, tail; \
963 Lisp_Object tortoise_##elt; \
964 EMACS_INT len_##elt; \
965 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
966 len_##elt, tail, tortoise_##elt, \
967 CIRCULAR_LIST_SUSPICION_LENGTH) \
969 #define EXTERNAL_ALIST_LOOP_6(elt, elt_car, elt_cdr, list, tail, len) \
970 Lisp_Object elt, elt_car, elt_cdr, tail; \
972 Lisp_Object tortoise_##elt; \
973 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
974 len, tail, tortoise_##elt, \
975 CIRCULAR_LIST_SUSPICION_LENGTH)
977 #define EXTERNAL_ALIST_LOOP_6_NO_DECLARE(elt, elt_car, elt_cdr, list, \
979 Lisp_Object tortoise_##elt; \
980 PRIVATE_EXTERNAL_ALIST_LOOP_8 (elt, elt_car, elt_cdr, list, \
981 len, tail, tortoise_##elt, \
982 CIRCULAR_LIST_SUSPICION_LENGTH)
985 #define PRIVATE_EXTERNAL_ALIST_LOOP_8(elt, elt_car, elt_cdr, list, len, \
986 hare, tortoise, suspicion_length) \
987 PRIVATE_EXTERNAL_LIST_LOOP_6 (elt, list, len, hare, tortoise, \
989 if (CONSP (elt) ? (elt_car = XCAR (elt), elt_cdr = XCDR (elt), 0) :1) \
993 /* Macros for looping over external property lists.
995 *** ALL OF THESE MACROS MUST BE DECLARED INSIDE BRACES -- SEE ABOVE. ***
997 EXTERNAL_PROPERTY_LIST_LOOP_3 maps over an external list assumed to
998 be a property list, consisting of alternating pairs of keys
999 (typically symbols or keywords) and values. Each iteration
1000 processes one such pair out of LIST, assigning the two elements to
1001 KEY and VALUE respectively. Malformed lists and circularities are
1002 trapped as usual, and in addition, property lists with an odd number
1003 of elements also signal an error.
1005 EXTERNAL_PROPERTY_LIST_LOOP_4 adds a TAIL argument to
1006 EXTERNAL_PROPERTY_LIST_LOOP_3, just like EXTERNAL_LIST_LOOP_3 does,
1007 and again TAIL is automatically declared.
1009 EXTERNAL_PROPERTY_LIST_LOOP_5 adds a LEN argument to
1010 EXTERNAL_PROPERTY_LIST_LOOP_4, just like EXTERNAL_LIST_LOOP_4 does,
1011 and again LEN is automatically declared. Note that in this case,
1012 LEN counts the iterations, NOT the total number of list elements
1013 processed, which is 2 * LEN.
1015 EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE does not declare any of its
1016 arguments, just like EXTERNAL_LIST_LOOP_4_NO_DECLARE, and so these
1017 must be declared manually. */
1019 /* Optimized and safe macros for looping over external property lists. */
1020 #define EXTERNAL_PROPERTY_LIST_LOOP_3(key, value, list) \
1021 Lisp_Object key, value, hare_##key, tortoise_##key; \
1022 EMACS_INT len_##key; \
1023 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, hare_##key, \
1024 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1026 #define EXTERNAL_PROPERTY_LIST_LOOP_4(key, value, list, tail) \
1027 Lisp_Object key, value, tail, tortoise_##key; \
1028 EMACS_INT len_##key; \
1029 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len_##key, tail, \
1030 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1032 #define EXTERNAL_PROPERTY_LIST_LOOP_5(key, value, list, tail, len) \
1033 Lisp_Object key, value, tail, tortoise_##key; \
1035 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail, \
1036 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1038 #define EXTERNAL_PROPERTY_LIST_LOOP_5_NO_DECLARE(key, value, list, \
1040 Lisp_Object tortoise_##key; \
1041 EXTERNAL_PROPERTY_LIST_LOOP_7 (key, value, list, len, tail, \
1042 tortoise_##key, CIRCULAR_LIST_SUSPICION_LENGTH)
1045 #define EXTERNAL_PROPERTY_LIST_LOOP_7(key, value, list, len, hare, \
1046 tortoise, suspicion_length) \
1047 for (tortoise = hare = list, len = 0; \
1050 (key = XCAR (hare), \
1051 hare = XCDR (hare), \
1052 (CONSP (hare) ? 1 : \
1053 (signal_malformed_property_list_error (list), 0)))) ? \
1054 (value = XCAR (hare), 1) : \
1055 (NILP (hare) ? 0 : \
1056 (signal_malformed_property_list_error (list), 0))); \
1058 hare = XCDR (hare), \
1059 ((++len < suspicion_length) ? \
1062 ((void) (tortoise = XCDR (XCDR (tortoise)))) : \
1065 (EQ (hare, tortoise) ? \
1066 ((void) signal_circular_property_list_error (list)) : \
1069 /* For a property list (alternating keywords/values) that may not be
1070 in valid list format -- will signal an error if the list is not in
1071 valid format. CONSVAR is used to keep track of the iterations
1072 without modifying PLIST.
1074 We have to be tricky to still keep the same C format.*/
1075 #define EXTERNAL_PROPERTY_LIST_LOOP(tail, key, value, plist) \
1076 for (tail = plist; \
1077 (CONSP (tail) && CONSP (XCDR (tail)) ? \
1078 (key = XCAR (tail), value = XCAR (XCDR (tail))) : \
1079 (key = Qunbound, value = Qunbound)), \
1081 tail = XCDR (XCDR (tail))) \
1082 if (UNBOUNDP (key)) \
1083 Fsignal (Qmalformed_property_list, list1 (plist)); \
1086 #define PROPERTY_LIST_LOOP(tail, key, value, plist) \
1087 for (tail = plist; \
1089 (key = XCAR (tail), tail = XCDR (tail), \
1090 value = XCAR (tail), tail = XCDR (tail), 1); \
1093 /* Return 1 if LIST is properly acyclic and nil-terminated, else 0. */
1094 INLINE_HEADER int TRUE_LIST_P (Lisp_Object object);
1096 TRUE_LIST_P (Lisp_Object object)
1098 Lisp_Object hare, tortoise;
1101 for (hare = tortoise = object, len = 0;
1103 hare = XCDR (hare), len++)
1105 if (len < CIRCULAR_LIST_SUSPICION_LENGTH)
1109 tortoise = XCDR (tortoise);
1110 else if (EQ (hare, tortoise))
1117 /* Signal an error if LIST is not properly acyclic and nil-terminated. */
1118 #define CHECK_TRUE_LIST(list) do { \
1119 Lisp_Object CTL_list = (list); \
1120 Lisp_Object CTL_hare, CTL_tortoise; \
1121 EMACS_INT CTL_len; \
1123 for (CTL_hare = CTL_tortoise = CTL_list, CTL_len = 0; \
1125 CTL_hare = XCDR (CTL_hare), CTL_len++) \
1127 if (CTL_len < CIRCULAR_LIST_SUSPICION_LENGTH) \
1131 CTL_tortoise = XCDR (CTL_tortoise); \
1132 else if (EQ (CTL_hare, CTL_tortoise)) \
1133 Fsignal (Qcircular_list, list1 (CTL_list)); \
1136 if (! NILP (CTL_hare)) \
1137 signal_malformed_list_error (CTL_list); \
1140 /*------------------------------ string --------------------------------*/
1144 struct lrecord_header lheader;
1149 typedef struct Lisp_String Lisp_String;
1151 DECLARE_LRECORD (string, Lisp_String);
1152 #define XSTRING(x) XRECORD (x, string, Lisp_String)
1153 #define XSETSTRING(x, p) XSETRECORD (x, p, string)
1154 #define STRINGP(x) RECORDP (x, string)
1155 #define CHECK_STRING(x) CHECK_RECORD (x, string)
1156 #define CONCHECK_STRING(x) CONCHECK_RECORD (x, string)
1160 Charcount bytecount_to_charcount (const Bufbyte *ptr, Bytecount len);
1161 Bytecount charcount_to_bytecount (const Bufbyte *ptr, Charcount len);
1163 #else /* not MULE */
1165 # define bytecount_to_charcount(ptr, len) (len)
1166 # define charcount_to_bytecount(ptr, len) (len)
1168 #endif /* not MULE */
1170 #define string_length(s) ((s)->size)
1171 #define XSTRING_LENGTH(s) string_length (XSTRING (s))
1172 #define XSTRING_CHAR_LENGTH(s) string_char_length (XSTRING (s))
1173 #define string_data(s) ((s)->data + 0)
1174 #define XSTRING_DATA(s) string_data (XSTRING (s))
1175 #define string_byte(s, i) ((s)->data[i] + 0)
1176 #define XSTRING_BYTE(s, i) string_byte (XSTRING (s), i)
1177 #define string_byte_addr(s, i) (&((s)->data[i]))
1178 #define set_string_length(s, len) ((void) ((s)->size = (len)))
1179 #define set_string_data(s, ptr) ((void) ((s)->data = (ptr)))
1180 #define set_string_byte(s, i, b) ((void) ((s)->data[i] = (b)))
1182 void resize_string (Lisp_String *s, Bytecount pos, Bytecount delta);
1186 INLINE_HEADER Charcount string_char_length (Lisp_String *s);
1187 INLINE_HEADER Charcount
1188 string_char_length (Lisp_String *s)
1190 return bytecount_to_charcount (string_data (s), string_length (s));
1193 # define string_char(s, i) charptr_emchar_n (string_data (s), i)
1194 # define string_char_addr(s, i) charptr_n_addr (string_data (s), i)
1195 void set_string_char (Lisp_String *s, Charcount i, Emchar c);
1197 #else /* not MULE */
1199 # define string_char_length(s) string_length (s)
1200 # define string_char(s, i) ((Emchar) string_byte (s, i))
1201 # define string_char_addr(s, i) string_byte_addr (s, i)
1202 # define set_string_char(s, i, c) set_string_byte (s, i, (Bufbyte)c)
1204 #endif /* not MULE */
1206 /* Return the true size of a struct with a variable-length array field. */
1207 #define FLEXIBLE_ARRAY_STRUCT_SIZEOF(flexible_array_structtype, \
1208 flexible_array_field, \
1209 flexible_array_length) \
1210 (offsetof (flexible_array_structtype, flexible_array_field) + \
1211 (offsetof (flexible_array_structtype, flexible_array_field[1]) - \
1212 offsetof (flexible_array_structtype, flexible_array_field[0])) * \
1213 (flexible_array_length))
1215 /*------------------------------ vector --------------------------------*/
1219 struct lcrecord_header header;
1221 /* next is now chained through v->contents[size], terminated by Qzero.
1222 This means that pure vectors don't need a "next" */
1223 /* struct Lisp_Vector *next; */
1224 Lisp_Object contents[1];
1226 typedef struct Lisp_Vector Lisp_Vector;
1228 DECLARE_LRECORD (vector, Lisp_Vector);
1229 #define XVECTOR(x) XRECORD (x, vector, Lisp_Vector)
1230 #define XSETVECTOR(x, p) XSETRECORD (x, p, vector)
1231 #define VECTORP(x) RECORDP (x, vector)
1232 #define CHECK_VECTOR(x) CHECK_RECORD (x, vector)
1233 #define CONCHECK_VECTOR(x) CONCHECK_RECORD (x, vector)
1235 #define vector_length(v) ((v)->size)
1236 #define XVECTOR_LENGTH(s) vector_length (XVECTOR (s))
1237 #define vector_data(v) ((v)->contents)
1238 #define XVECTOR_DATA(s) vector_data (XVECTOR (s))
1240 /*---------------------------- bit vectors -----------------------------*/
1243 #error What the hell?!
1244 #elif (LONGBITS < 32)
1245 # define LONGBITS_LOG2 4
1246 # define LONGBITS_POWER_OF_2 16
1247 #elif (LONGBITS < 64)
1248 # define LONGBITS_LOG2 5
1249 # define LONGBITS_POWER_OF_2 32
1250 #elif (LONGBITS < 128)
1251 # define LONGBITS_LOG2 6
1252 # define LONGBITS_POWER_OF_2 64
1254 #error You really have 128-bit integers?!
1257 struct Lisp_Bit_Vector
1259 struct lrecord_header lheader;
1262 unsigned long bits[1];
1264 typedef struct Lisp_Bit_Vector Lisp_Bit_Vector;
1266 DECLARE_LRECORD (bit_vector, Lisp_Bit_Vector);
1267 #define XBIT_VECTOR(x) XRECORD (x, bit_vector, Lisp_Bit_Vector)
1268 #define XSETBIT_VECTOR(x, p) XSETRECORD (x, p, bit_vector)
1269 #define BIT_VECTORP(x) RECORDP (x, bit_vector)
1270 #define CHECK_BIT_VECTOR(x) CHECK_RECORD (x, bit_vector)
1271 #define CONCHECK_BIT_VECTOR(x) CONCHECK_RECORD (x, bit_vector)
1273 #define BITP(x) (INTP (x) && (XINT (x) == 0 || XINT (x) == 1))
1275 #define CHECK_BIT(x) do { \
1277 dead_wrong_type_argument (Qbitp, x);\
1280 #define CONCHECK_BIT(x) do { \
1282 x = wrong_type_argument (Qbitp, x); \
1285 #define bit_vector_length(v) ((v)->size)
1286 #define bit_vector_next(v) ((v)->next)
1288 INLINE_HEADER int bit_vector_bit (Lisp_Bit_Vector *v, size_t n);
1290 bit_vector_bit (Lisp_Bit_Vector *v, size_t n)
1292 return ((v->bits[n >> LONGBITS_LOG2] >> (n & (LONGBITS_POWER_OF_2 - 1)))
1296 INLINE_HEADER void set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value);
1298 set_bit_vector_bit (Lisp_Bit_Vector *v, size_t n, int value)
1301 v->bits[n >> LONGBITS_LOG2] |= (1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1303 v->bits[n >> LONGBITS_LOG2] &= ~(1UL << (n & (LONGBITS_POWER_OF_2 - 1)));
1306 /* Number of longs required to hold LEN bits */
1307 #define BIT_VECTOR_LONG_STORAGE(len) \
1308 (((len) + LONGBITS_POWER_OF_2 - 1) >> LONGBITS_LOG2)
1310 /*------------------------------ symbol --------------------------------*/
1312 typedef struct Lisp_Symbol Lisp_Symbol;
1315 struct lrecord_header lheader;
1316 /* next symbol in this obarray bucket */
1320 Lisp_Object function;
1324 #define SYMBOL_IS_KEYWORD(sym) \
1325 ((string_byte (symbol_name (XSYMBOL (sym)), 0) == ':') \
1326 && EQ (sym, oblookup (Vobarray, \
1327 string_data (symbol_name (XSYMBOL (sym))), \
1328 string_length (symbol_name (XSYMBOL (sym))))))
1329 #define KEYWORDP(obj) (SYMBOLP (obj) && SYMBOL_IS_KEYWORD (obj))
1331 DECLARE_LRECORD (symbol, Lisp_Symbol);
1332 #define XSYMBOL(x) XRECORD (x, symbol, Lisp_Symbol)
1333 #define XSETSYMBOL(x, p) XSETRECORD (x, p, symbol)
1334 #define SYMBOLP(x) RECORDP (x, symbol)
1335 #define CHECK_SYMBOL(x) CHECK_RECORD (x, symbol)
1336 #define CONCHECK_SYMBOL(x) CONCHECK_RECORD (x, symbol)
1338 #define symbol_next(s) ((s)->next)
1339 #define symbol_name(s) ((s)->name)
1340 #define symbol_value(s) ((s)->value)
1341 #define symbol_function(s) ((s)->function)
1342 #define symbol_plist(s) ((s)->plist)
1344 /*------------------------------- subr ---------------------------------*/
1346 typedef Lisp_Object (*lisp_fn_t) (void);
1350 struct lrecord_header lheader;
1358 typedef struct Lisp_Subr Lisp_Subr;
1360 DECLARE_LRECORD (subr, Lisp_Subr);
1361 #define XSUBR(x) XRECORD (x, subr, Lisp_Subr)
1362 #define XSETSUBR(x, p) XSETRECORD (x, p, subr)
1363 #define SUBRP(x) RECORDP (x, subr)
1364 #define CHECK_SUBR(x) CHECK_RECORD (x, subr)
1365 #define CONCHECK_SUBR(x) CONCHECK_RECORD (x, subr)
1367 #define subr_function(subr) ((subr)->subr_fn)
1368 #define SUBR_FUNCTION(subr,max_args) \
1369 ((Lisp_Object (*) (EXFUN_##max_args)) (subr)->subr_fn)
1370 #define subr_name(subr) ((subr)->name)
1372 /*------------------------------ marker --------------------------------*/
1375 typedef struct Lisp_Marker Lisp_Marker;
1378 struct lrecord_header lheader;
1381 struct buffer *buffer;
1383 char insertion_type;
1386 DECLARE_LRECORD (marker, Lisp_Marker);
1387 #define XMARKER(x) XRECORD (x, marker, Lisp_Marker)
1388 #define XSETMARKER(x, p) XSETRECORD (x, p, marker)
1389 #define MARKERP(x) RECORDP (x, marker)
1390 #define CHECK_MARKER(x) CHECK_RECORD (x, marker)
1391 #define CONCHECK_MARKER(x) CONCHECK_RECORD (x, marker)
1393 /* The second check was looking for GCed markers still in use */
1394 /* if (INTP (XMARKER (x)->lheader.next.v)) abort (); */
1396 #define marker_next(m) ((m)->next)
1397 #define marker_prev(m) ((m)->prev)
1399 /*------------------------------- char ---------------------------------*/
1401 #define CHARP(x) (XTYPE (x) == Lisp_Type_Char)
1403 #ifdef ERROR_CHECK_TYPECHECK
1405 INLINE_HEADER Emchar XCHAR (Lisp_Object obj);
1406 INLINE_HEADER Emchar
1407 XCHAR (Lisp_Object obj)
1409 assert (CHARP (obj));
1410 return XCHARVAL (obj);
1415 #define XCHAR(x) ((Emchar)XCHARVAL (x))
1419 #define CHECK_CHAR(x) CHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1420 #define CONCHECK_CHAR(x) CONCHECK_NONRECORD (x, Lisp_Type_Char, Qcharacterp)
1423 /*------------------------------ float ---------------------------------*/
1425 #ifdef LISP_FLOAT_TYPE
1427 /* Note: the 'unused_next_' field exists only to ensure that the
1428 `next' pointer fits within the structure, for the purposes of the
1429 free list. This makes a difference in the unlikely case of
1430 sizeof(double) being smaller than sizeof(void *). */
1434 struct lrecord_header lheader;
1435 union { double d; struct Lisp_Float *unused_next_; } data;
1437 typedef struct Lisp_Float Lisp_Float;
1439 DECLARE_LRECORD (float, Lisp_Float);
1440 #define XFLOAT(x) XRECORD (x, float, Lisp_Float)
1441 #define XSETFLOAT(x, p) XSETRECORD (x, p, float)
1442 #define FLOATP(x) RECORDP (x, float)
1443 #define CHECK_FLOAT(x) CHECK_RECORD (x, float)
1444 #define CONCHECK_FLOAT(x) CONCHECK_RECORD (x, float)
1446 #define float_data(f) ((f)->data.d)
1447 #define XFLOAT_DATA(x) float_data (XFLOAT (x))
1449 #define XFLOATINT(n) extract_float (n)
1451 #define CHECK_INT_OR_FLOAT(x) do { \
1452 if (!INT_OR_FLOATP (x)) \
1453 dead_wrong_type_argument (Qnumberp, x); \
1456 #define CONCHECK_INT_OR_FLOAT(x) do { \
1457 if (!INT_OR_FLOATP (x)) \
1458 x = wrong_type_argument (Qnumberp, x); \
1461 # define INT_OR_FLOATP(x) (INTP (x) || FLOATP (x))
1463 #else /* not LISP_FLOAT_TYPE */
1465 #define XFLOAT(x) --- error! No float support. ---
1466 #define XSETFLOAT(x, p) --- error! No float support. ---
1468 #define CHECK_FLOAT(x) --- error! No float support. ---
1469 #define CONCHECK_FLOAT(x) --- error! No float support. ---
1471 #define XFLOATINT(n) XINT(n)
1472 #define CHECK_INT_OR_FLOAT CHECK_INT
1473 #define CONCHECK_INT_OR_FLOAT CONCHECK_INT
1474 #define INT_OR_FLOATP(x) INTP (x)
1476 #endif /* not LISP_FLOAT_TYPE */
1478 /*-------------------------------- int ---------------------------------*/
1480 #define ZEROP(x) EQ (x, Qzero)
1482 #ifdef ERROR_CHECK_TYPECHECK
1484 INLINE_HEADER EMACS_INT XINT (Lisp_Object obj);
1485 INLINE_HEADER EMACS_INT
1486 XINT (Lisp_Object obj)
1488 assert (INTP (obj));
1489 return XREALINT (obj);
1492 INLINE_HEADER EMACS_INT XCHAR_OR_INT (Lisp_Object obj);
1493 INLINE_HEADER EMACS_INT
1494 XCHAR_OR_INT (Lisp_Object obj)
1496 assert (INTP (obj) || CHARP (obj));
1497 return CHARP (obj) ? XCHAR (obj) : XINT (obj);
1500 #else /* no error checking */
1502 #define XINT(obj) XREALINT (obj)
1503 #define XCHAR_OR_INT(obj) (CHARP (obj) ? XCHAR (obj) : XINT (obj))
1505 #endif /* no error checking */
1507 #define CHECK_INT(x) do { \
1509 dead_wrong_type_argument (Qintegerp, x); \
1512 #define CONCHECK_INT(x) do { \
1514 x = wrong_type_argument (Qintegerp, x); \
1517 #define NATNUMP(x) (INTP (x) && XINT (x) >= 0)
1519 #define CHECK_NATNUM(x) do { \
1521 dead_wrong_type_argument (Qnatnump, x); \
1524 #define CONCHECK_NATNUM(x) do { \
1526 x = wrong_type_argument (Qnatnump, x); \
1529 /* next three always continuable because they coerce their arguments. */
1530 #define CHECK_INT_COERCE_CHAR(x) do { \
1533 else if (CHARP (x)) \
1534 x = make_int (XCHAR (x)); \
1536 x = wrong_type_argument (Qinteger_or_char_p, x); \
1539 #define CHECK_INT_COERCE_MARKER(x) do { \
1542 else if (MARKERP (x)) \
1543 x = make_int (marker_position (x)); \
1545 x = wrong_type_argument (Qinteger_or_marker_p, x); \
1548 #define CHECK_INT_COERCE_CHAR_OR_MARKER(x) do { \
1551 else if (CHARP (x)) \
1552 x = make_int (XCHAR (x)); \
1553 else if (MARKERP (x)) \
1554 x = make_int (marker_position (x)); \
1556 x = wrong_type_argument (Qinteger_char_or_marker_p, x); \
1560 /*--------------------------- readonly objects -------------------------*/
1562 #define CHECK_C_WRITEABLE(obj) \
1563 do { if (c_readonly (obj)) c_write_error (obj); } while (0)
1565 #define CHECK_LISP_WRITEABLE(obj) \
1566 do { if (lisp_readonly (obj)) lisp_write_error (obj); } while (0)
1568 #define C_READONLY(obj) (C_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1569 #define LISP_READONLY(obj) (LISP_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1571 /*----------------------------- structrures ----------------------------*/
1573 typedef struct structure_keyword_entry structure_keyword_entry;
1574 struct structure_keyword_entry
1576 Lisp_Object keyword;
1577 int (*validate) (Lisp_Object keyword, Lisp_Object value,
1578 Error_behavior errb);
1583 Dynarr_declare (structure_keyword_entry);
1584 } structure_keyword_entry_dynarr;
1586 typedef struct structure_type structure_type;
1587 struct structure_type
1590 structure_keyword_entry_dynarr *keywords;
1591 int (*validate) (Lisp_Object data, Error_behavior errb);
1592 Lisp_Object (*instantiate) (Lisp_Object data);
1597 Dynarr_declare (structure_type);
1598 } structure_type_dynarr;
1600 struct structure_type *define_structure_type (Lisp_Object type,
1603 Error_behavior errb),
1604 Lisp_Object (*instantiate)
1605 (Lisp_Object data));
1606 void define_structure_type_keyword (struct structure_type *st,
1607 Lisp_Object keyword,
1608 int (*validate) (Lisp_Object keyword,
1610 Error_behavior errb));
1612 /*---------------------------- weak lists ------------------------------*/
1616 /* element disappears if it's unmarked. */
1618 /* element disappears if it's a cons and either its car or
1621 /* element disappears if it's a cons and its car is unmarked. */
1622 WEAK_LIST_KEY_ASSOC,
1623 /* element disappears if it's a cons and its cdr is unmarked. */
1624 WEAK_LIST_VALUE_ASSOC,
1625 /* element disappears if it's a cons and neither its car nor
1626 its cdr is marked. */
1627 WEAK_LIST_FULL_ASSOC
1632 struct lcrecord_header header;
1633 Lisp_Object list; /* don't mark through this! */
1634 enum weak_list_type type;
1635 Lisp_Object next_weak; /* don't mark through this! */
1638 DECLARE_LRECORD (weak_list, struct weak_list);
1639 #define XWEAK_LIST(x) XRECORD (x, weak_list, struct weak_list)
1640 #define XSETWEAK_LIST(x, p) XSETRECORD (x, p, weak_list)
1641 #define WEAK_LISTP(x) RECORDP (x, weak_list)
1642 #define CHECK_WEAK_LIST(x) CHECK_RECORD (x, weak_list)
1643 #define CONCHECK_WEAK_LIST(x) CONCHECK_RECORD (x, weak_list)
1645 #define weak_list_list(w) ((w)->list)
1646 #define XWEAK_LIST_LIST(w) (XWEAK_LIST (w)->list)
1648 Lisp_Object make_weak_list (enum weak_list_type type);
1649 /* The following two are only called by the garbage collector */
1650 int finish_marking_weak_lists (void);
1651 void prune_weak_lists (void);
1653 /*-------------------------- lcrecord-list -----------------------------*/
1655 struct lcrecord_list
1657 struct lcrecord_header header;
1660 const struct lrecord_implementation *implementation;
1663 DECLARE_LRECORD (lcrecord_list, struct lcrecord_list);
1664 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list)
1665 #define XSETLCRECORD_LIST(x, p) XSETRECORD (x, p, lcrecord_list)
1666 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list)
1667 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list)
1668 Lcrecord lists should never escape to the Lisp level, so
1669 functions should not be doing this. */
1671 Lisp_Object make_lcrecord_list (size_t size,
1672 const struct lrecord_implementation
1674 Lisp_Object allocate_managed_lcrecord (Lisp_Object lcrecord_list);
1675 void free_managed_lcrecord (Lisp_Object lcrecord_list, Lisp_Object lcrecord);
1678 /************************************************************************/
1679 /* Definitions of primitive Lisp functions and variables */
1680 /************************************************************************/
1683 /* DEFUN - Define a built-in Lisp-visible C function or `subr'.
1684 `lname' should be the name to give the function in Lisp,
1685 as a null-terminated C string.
1686 `Fname' should be the C equivalent of `lname', using only characters
1687 valid in a C identifier, with an "F" prepended.
1688 The name of the C constant structure that records information
1689 on this function for internal use is "S" concatenated with Fname.
1690 `min_args' should be a number, the minimum number of arguments allowed.
1691 `max_args' should be a number, the maximum number of arguments allowed,
1692 or else MANY or UNEVALLED.
1693 MANY means pass a vector of evaluated arguments,
1694 in the form of an integer number-of-arguments
1695 followed by the address of a vector of Lisp_Objects
1696 which contains the argument values.
1697 UNEVALLED means pass the list of unevaluated arguments.
1698 `prompt' says how to read arguments for an interactive call.
1699 See the doc string for `interactive'.
1700 A null string means call interactively with no arguments.
1701 `arglist' are the comma-separated arguments (always Lisp_Objects) for
1703 The docstring for the function is placed as a "C" comment between
1704 the prompt and the `args' argument. make-docfile reads the
1705 comment and creates the DOC file from it.
1708 #define EXFUN_0 void
1709 #define EXFUN_1 Lisp_Object
1710 #define EXFUN_2 Lisp_Object,Lisp_Object
1711 #define EXFUN_3 Lisp_Object,Lisp_Object,Lisp_Object
1712 #define EXFUN_4 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1713 #define EXFUN_5 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1714 #define EXFUN_6 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1716 #define EXFUN_7 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1717 Lisp_Object,Lisp_Object
1718 #define EXFUN_8 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1719 Lisp_Object,Lisp_Object,Lisp_Object
1720 #define EXFUN_MANY int, Lisp_Object*
1721 #define EXFUN_UNEVALLED Lisp_Object
1722 #define EXFUN(sym, max_args) Lisp_Object sym (EXFUN_##max_args)
1724 #define SUBR_MAX_ARGS 8
1726 #define UNEVALLED -1
1728 /* Can't be const, because then subr->doc is read-only and
1729 Snarf_documentation chokes */
1731 #define DEFUN(lname, Fname, min_args, max_args, prompt, arglist) \
1732 Lisp_Object Fname (EXFUN_##max_args); \
1733 static struct Lisp_Subr S##Fname = \
1735 { /* struct lrecord_header */ \
1736 lrecord_type_subr, /* lrecord_type_index */ \
1738 1, /* c_readonly bit */ \
1739 1 /* lisp_readonly bit */ \
1744 0, /* doc string */ \
1748 Lisp_Object Fname (DEFUN_##max_args arglist)
1750 /* Heavy ANSI C preprocessor hackery to get DEFUN to declare a
1751 prototype that matches max_args, and add the obligatory
1752 `Lisp_Object' type declaration to the formal C arguments. */
1754 #define DEFUN_MANY(named_int, named_Lisp_Object) named_int, named_Lisp_Object
1755 #define DEFUN_UNEVALLED(args) Lisp_Object args
1756 #define DEFUN_0() void
1757 #define DEFUN_1(a) Lisp_Object a
1758 #define DEFUN_2(a,b) DEFUN_1(a), Lisp_Object b
1759 #define DEFUN_3(a,b,c) DEFUN_2(a,b), Lisp_Object c
1760 #define DEFUN_4(a,b,c,d) DEFUN_3(a,b,c), Lisp_Object d
1761 #define DEFUN_5(a,b,c,d,e) DEFUN_4(a,b,c,d), Lisp_Object e
1762 #define DEFUN_6(a,b,c,d,e,f) DEFUN_5(a,b,c,d,e), Lisp_Object f
1763 #define DEFUN_7(a,b,c,d,e,f,g) DEFUN_6(a,b,c,d,e,f), Lisp_Object g
1764 #define DEFUN_8(a,b,c,d,e,f,g,h) DEFUN_7(a,b,c,d,e,f,g),Lisp_Object h
1766 /* WARNING: If you add defines here for higher values of max_args,
1767 make sure to also fix the clauses in PRIMITIVE_FUNCALL(),
1768 and change the define of SUBR_MAX_ARGS above. */
1770 #include "symeval.h"
1772 /* `specpdl' is the special binding/unwind-protect stack.
1774 Knuth says (see the Jargon File):
1775 At MIT, `pdl' [abbreviation for `Push Down List'] used to
1776 be a more common synonym for `stack'.
1777 Everywhere else `stack' seems to be the preferred term.
1779 specpdl_depth is the current depth of `specpdl'.
1780 Save this for use later as arg to `unbind_to'. */
1781 extern int specpdl_depth_counter;
1782 #define specpdl_depth() specpdl_depth_counter
1785 #define CHECK_FUNCTION(fun) do { \
1786 while (NILP (Ffunctionp (fun))) \
1787 signal_invalid_function_error (fun); \
1791 /************************************************************************/
1792 /* Checking for QUIT */
1793 /************************************************************************/
1795 /* Asynchronous events set something_happened, and then are processed
1796 within the QUIT macro. At this point, we are guaranteed to not be in
1797 any sensitive code. */
1799 extern volatile int something_happened;
1800 int check_what_happened (void);
1802 extern volatile int quit_check_signal_happened;
1803 extern volatile int quit_check_signal_tick_count;
1804 int check_quit (void);
1806 void signal_quit (void);
1808 /* Nonzero if ought to quit now. */
1810 ((quit_check_signal_happened ? check_quit () : 0), \
1811 (!NILP (Vquit_flag) && (NILP (Vinhibit_quit) \
1812 || EQ (Vquit_flag, Qcritical))))
1814 /* QUIT used to call QUITP, but there are some places where QUITP
1815 is called directly, and check_what_happened() should only be called
1816 when Emacs is actually ready to quit because it could do things
1817 like switch threads. */
1818 #define INTERNAL_QUITP \
1819 ((something_happened ? check_what_happened () : 0), \
1820 (!NILP (Vquit_flag) && \
1821 (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1823 #define INTERNAL_REALLY_QUITP \
1824 (check_what_happened (), \
1825 (!NILP (Vquit_flag) && \
1826 (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1828 /* Check quit-flag and quit if it is non-nil. Also do any other things
1829 that might have gotten queued until it was safe. */
1830 #define QUIT do { if (INTERNAL_QUITP) signal_quit (); } while (0)
1832 #define REALLY_QUIT do { if (INTERNAL_REALLY_QUITP) signal_quit (); } while (0)
1835 /************************************************************************/
1837 /************************************************************************/
1839 /* #### for a 64-bit machine, we should substitute a prime just over 2^32 */
1840 #define GOOD_HASH 65599 /* prime number just over 2^16; Dragon book, p. 435 */
1841 #define HASH2(a,b) (GOOD_HASH * (a) + (b))
1842 #define HASH3(a,b,c) (GOOD_HASH * HASH2 (a,b) + (c))
1843 #define HASH4(a,b,c,d) (GOOD_HASH * HASH3 (a,b,c) + (d))
1844 #define HASH5(a,b,c,d,e) (GOOD_HASH * HASH4 (a,b,c,d) + (e))
1845 #define HASH6(a,b,c,d,e,f) (GOOD_HASH * HASH5 (a,b,c,d,e) + (f))
1846 #define HASH7(a,b,c,d,e,f,g) (GOOD_HASH * HASH6 (a,b,c,d,e,f) + (g))
1847 #define HASH8(a,b,c,d,e,f,g,h) (GOOD_HASH * HASH7 (a,b,c,d,e,f,g) + (h))
1848 #define HASH9(a,b,c,d,e,f,g,h,i) (GOOD_HASH * HASH8 (a,b,c,d,e,f,g,h) + (i))
1850 #define LISP_HASH(obj) ((unsigned long) LISP_TO_VOID (obj))
1851 unsigned long string_hash (const char *xv);
1852 unsigned long memory_hash (const void *xv, size_t size);
1853 unsigned long internal_hash (Lisp_Object obj, int depth);
1854 unsigned long internal_array_hash (Lisp_Object *arr, int size, int depth);
1857 /************************************************************************/
1858 /* String translation */
1859 /************************************************************************/
1862 #ifdef HAVE_LIBINTL_H
1863 #include <libintl.h>
1865 char *dgettext (const char *, const char *);
1866 char *gettext (const char *);
1867 char *textdomain (const char *);
1868 char *bindtextdomain (const char *, const char *);
1869 #endif /* HAVE_LIBINTL_H */
1871 #define GETTEXT(x) gettext(x)
1872 #define LISP_GETTEXT(x) Fgettext (x)
1874 #define GETTEXT(x) (x)
1875 #define LISP_GETTEXT(x) (x)
1878 /* DEFER_GETTEXT is used to identify strings which are translated when
1879 they are referenced instead of when they are defined.
1880 These include Qerror_messages and initialized arrays of strings.
1882 #define DEFER_GETTEXT(x) (x)
1885 /************************************************************************/
1886 /* Garbage collection / GC-protection */
1887 /************************************************************************/
1889 /* number of bytes of structure consed since last GC */
1891 extern EMACS_INT consing_since_gc;
1893 /* threshold for doing another gc */
1895 extern EMACS_INT gc_cons_threshold;
1897 /* Structure for recording stack slots that need marking */
1899 /* This is a chain of structures, each of which points at a Lisp_Object
1900 variable whose value should be marked in garbage collection.
1901 Normally every link of the chain is an automatic variable of a function,
1902 and its `val' points to some argument or local variable of the function.
1903 On exit to the function, the chain is set back to the value it had on
1904 entry. This way, no link remains in the chain when the stack frame
1905 containing the link disappears.
1907 Every function that can call Feval must protect in this fashion all
1908 Lisp_Object variables whose contents will be used again. */
1910 extern struct gcpro *gcprolist;
1915 Lisp_Object *var; /* Address of first protected variable */
1916 int nvars; /* Number of consecutive protected variables */
1919 /* Normally, you declare variables gcpro1, gcpro2, ... and use the
1920 GCPROn() macros. However, if you need to have nested gcpro's,
1921 declare ngcpro1, ngcpro2, ... and use NGCPROn(). If you need
1922 to nest another level, use nngcpro1, nngcpro2, ... and use
1923 NNGCPROn(). If you need to nest yet another level, create
1924 the appropriate macros. */
1928 void debug_gcpro1 (char *, int, struct gcpro *, Lisp_Object *);
1929 void debug_gcpro2 (char *, int, struct gcpro *, struct gcpro *,
1930 Lisp_Object *, Lisp_Object *);
1931 void debug_gcpro3 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1932 Lisp_Object *, Lisp_Object *, Lisp_Object *);
1933 void debug_gcpro4 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1934 struct gcpro *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
1936 void debug_gcpro5 (char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
1937 struct gcpro *, struct gcpro *, Lisp_Object *, Lisp_Object *,
1938 Lisp_Object *, Lisp_Object *, Lisp_Object *);
1939 void debug_ungcpro(char *, int, struct gcpro *);
1942 debug_gcpro1 (__FILE__, __LINE__,&gcpro1,&v)
1943 #define GCPRO2(v1,v2) \
1944 debug_gcpro2 (__FILE__, __LINE__,&gcpro1,&gcpro2,&v1,&v2)
1945 #define GCPRO3(v1,v2,v3) \
1946 debug_gcpro3 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&v1,&v2,&v3)
1947 #define GCPRO4(v1,v2,v3,v4) \
1948 debug_gcpro4 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,\
1950 #define GCPRO5(v1,v2,v3,v4,v5) \
1951 debug_gcpro5 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,\
1952 &v1,&v2,&v3,&v4,&v5)
1954 debug_ungcpro(__FILE__, __LINE__,&gcpro1)
1956 #define NGCPRO1(v) \
1957 debug_gcpro1 (__FILE__, __LINE__,&ngcpro1,&v)
1958 #define NGCPRO2(v1,v2) \
1959 debug_gcpro2 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&v1,&v2)
1960 #define NGCPRO3(v1,v2,v3) \
1961 debug_gcpro3 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&v1,&v2,&v3)
1962 #define NGCPRO4(v1,v2,v3,v4) \
1963 debug_gcpro4 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1965 #define NGCPRO5(v1,v2,v3,v4,v5) \
1966 debug_gcpro5 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
1967 &ngcpro5,&v1,&v2,&v3,&v4,&v5)
1969 debug_ungcpro(__FILE__, __LINE__,&ngcpro1)
1971 #define NNGCPRO1(v) \
1972 debug_gcpro1 (__FILE__, __LINE__,&nngcpro1,&v)
1973 #define NNGCPRO2(v1,v2) \
1974 debug_gcpro2 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&v1,&v2)
1975 #define NNGCPRO3(v1,v2,v3) \
1976 debug_gcpro3 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&v1,&v2,&v3)
1977 #define NNGCPRO4(v1,v2,v3,v4) \
1978 debug_gcpro4 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1980 #define NNGCPRO5(v1,v2,v3,v4,v5) \
1981 debug_gcpro5 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
1982 &nngcpro5,&v1,&v2,&v3,&v4,&v5)
1984 debug_ungcpro(__FILE__, __LINE__,&nngcpro1)
1986 #else /* ! DEBUG_GCPRO */
1988 #define GCPRO1(var1) ((void) ( \
1989 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1990 gcprolist = &gcpro1 ))
1992 #define GCPRO2(var1, var2) ((void) ( \
1993 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1994 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
1995 gcprolist = &gcpro2 ))
1997 #define GCPRO3(var1, var2, var3) ((void) ( \
1998 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
1999 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
2000 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
2001 gcprolist = &gcpro3 ))
2003 #define GCPRO4(var1, var2, var3, var4) ((void) ( \
2004 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
2005 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
2006 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
2007 gcpro4.next = &gcpro3, gcpro4.var = &var4, gcpro4.nvars = 1, \
2008 gcprolist = &gcpro4 ))
2010 #define GCPRO5(var1, var2, var3, var4, var5) ((void) ( \
2011 gcpro1.next = gcprolist, gcpro1.var = &var1, gcpro1.nvars = 1, \
2012 gcpro2.next = &gcpro1, gcpro2.var = &var2, gcpro2.nvars = 1, \
2013 gcpro3.next = &gcpro2, gcpro3.var = &var3, gcpro3.nvars = 1, \
2014 gcpro4.next = &gcpro3, gcpro4.var = &var4, gcpro4.nvars = 1, \
2015 gcpro5.next = &gcpro4, gcpro5.var = &var5, gcpro5.nvars = 1, \
2016 gcprolist = &gcpro5 ))
2018 #define UNGCPRO ((void) (gcprolist = gcpro1.next))
2020 #define NGCPRO1(var1) ((void) ( \
2021 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2022 gcprolist = &ngcpro1 ))
2024 #define NGCPRO2(var1, var2) ((void) ( \
2025 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2026 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2027 gcprolist = &ngcpro2 ))
2029 #define NGCPRO3(var1, var2, var3) ((void) ( \
2030 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2031 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2032 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2033 gcprolist = &ngcpro3 ))
2035 #define NGCPRO4(var1, var2, var3, var4) ((void) ( \
2036 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2037 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2038 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2039 ngcpro4.next = &ngcpro3, ngcpro4.var = &var4, ngcpro4.nvars = 1, \
2040 gcprolist = &ngcpro4 ))
2042 #define NGCPRO5(var1, var2, var3, var4, var5) ((void) ( \
2043 ngcpro1.next = gcprolist, ngcpro1.var = &var1, ngcpro1.nvars = 1, \
2044 ngcpro2.next = &ngcpro1, ngcpro2.var = &var2, ngcpro2.nvars = 1, \
2045 ngcpro3.next = &ngcpro2, ngcpro3.var = &var3, ngcpro3.nvars = 1, \
2046 ngcpro4.next = &ngcpro3, ngcpro4.var = &var4, ngcpro4.nvars = 1, \
2047 ngcpro5.next = &ngcpro4, ngcpro5.var = &var5, ngcpro5.nvars = 1, \
2048 gcprolist = &ngcpro5 ))
2050 #define NUNGCPRO ((void) (gcprolist = ngcpro1.next))
2052 #define NNGCPRO1(var1) ((void) ( \
2053 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2054 gcprolist = &nngcpro1 ))
2056 #define NNGCPRO2(var1, var2) ((void) ( \
2057 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2058 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2059 gcprolist = &nngcpro2 ))
2061 #define NNGCPRO3(var1, var2, var3) ((void) ( \
2062 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2063 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2064 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2065 gcprolist = &nngcpro3 ))
2067 #define NNGCPRO4(var1, var2, var3, var4) ((void) ( \
2068 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2069 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2070 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2071 nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1, \
2072 gcprolist = &nngcpro4 ))
2074 #define NNGCPRO5(var1, var2, var3, var4, var5) ((void) ( \
2075 nngcpro1.next = gcprolist, nngcpro1.var = &var1, nngcpro1.nvars = 1, \
2076 nngcpro2.next = &nngcpro1, nngcpro2.var = &var2, nngcpro2.nvars = 1, \
2077 nngcpro3.next = &nngcpro2, nngcpro3.var = &var3, nngcpro3.nvars = 1, \
2078 nngcpro4.next = &nngcpro3, nngcpro4.var = &var4, nngcpro4.nvars = 1, \
2079 nngcpro5.next = &nngcpro4, nngcpro5.var = &var5, nngcpro5.nvars = 1, \
2080 gcprolist = &nngcpro5 ))
2082 #define NNUNGCPRO ((void) (gcprolist = nngcpro1.next))
2084 #endif /* ! DEBUG_GCPRO */
2086 /* Another try to fix SunPro C compiler warnings */
2087 /* "end-of-loop code not reached" */
2088 /* "statement not reached */
2089 #if defined __SUNPRO_C || defined __USLC__
2090 #define RETURN_SANS_WARNINGS if (1) return
2091 #define RETURN_NOT_REACHED(value)
2093 #define RETURN_SANS_WARNINGS return
2094 #define RETURN_NOT_REACHED(value) return value;
2097 /* Evaluate expr, UNGCPRO, and then return the value of expr. */
2098 #define RETURN_UNGCPRO(expr) do \
2100 Lisp_Object ret_ungc_val = (expr); \
2102 RETURN_SANS_WARNINGS ret_ungc_val; \
2105 /* Evaluate expr, NUNGCPRO, UNGCPRO, and then return the value of expr. */
2106 #define RETURN_NUNGCPRO(expr) do \
2108 Lisp_Object ret_ungc_val = (expr); \
2111 RETURN_SANS_WARNINGS ret_ungc_val; \
2114 /* Evaluate expr, NNUNGCPRO, NUNGCPRO, UNGCPRO, and then return the
2116 #define RETURN_NNUNGCPRO(expr) do \
2118 Lisp_Object ret_ungc_val = (expr); \
2122 RETURN_SANS_WARNINGS ret_ungc_val; \
2125 /* Evaluate expr, return it if it's not Qunbound. */
2126 #define RETURN_IF_NOT_UNBOUND(expr) do \
2128 Lisp_Object ret_nunb_val = (expr); \
2129 if (!UNBOUNDP (ret_nunb_val)) \
2130 RETURN_SANS_WARNINGS ret_nunb_val; \
2133 extern Lisp_Object_ptr_dynarr *staticpros;
2135 /* Call staticpro (&var) to protect static variable `var'. */
2136 void staticpro (Lisp_Object *);
2138 /* Call staticpro_nodump (&var) to protect static variable `var'. */
2139 /* var will not be saved at dump time */
2140 void staticpro_nodump (Lisp_Object *);
2142 /* Call dump_add_root_struct_ptr (&var, &desc) to dump the structure pointed to by `var'. */
2144 void dump_add_root_struct_ptr (void *, const struct struct_description *);
2146 #define dump_add_root_struct_ptr(varaddr,descaddr) DO_NOTHING
2149 /* Call dump_add_opaque (&var, size) to dump the opaque static structure `var'. */
2151 void dump_add_opaque (void *, size_t);
2153 #define dump_add_opaque(varaddr,size) DO_NOTHING
2156 /* Call dump_add_root_object (&var) to ensure that var is properly updated after pdump. */
2158 void dump_add_root_object (Lisp_Object *);
2160 #define dump_add_root_object(varaddr) DO_NOTHING
2163 /* Call dump_add_root_object (&var) to ensure that var is properly updated after
2164 pdump. var must point to a linked list of objects out of which
2165 some may not be dumped */
2167 void dump_add_weak_object_chain (Lisp_Object *);
2169 #define dump_add_weak_object_chain(varaddr) DO_NOTHING
2172 /* Nonzero means Emacs has already been initialized.
2173 Used during startup to detect startup of dumped Emacs. */
2174 extern int initialized;
2176 #ifdef MEMORY_USAGE_STATS
2178 /* This structure is used to keep statistics on the amount of memory
2181 WAS_REQUESTED stores the actual amount of memory that was requested
2182 of the allocation function. The *_OVERHEAD fields store the
2183 additional amount of memory that was grabbed by the functions to
2184 facilitate allocation, reallocation, etc. MALLOC_OVERHEAD is for
2185 memory allocated with malloc(); DYNARR_OVERHEAD is for dynamic
2186 arrays; GAP_OVERHEAD is for gap arrays. Note that for (e.g.)
2187 dynamic arrays, there is both MALLOC_OVERHEAD and DYNARR_OVERHEAD
2188 memory: The dynamic array allocates memory above and beyond what
2189 was asked of it, and when it in turns allocates memory using
2190 malloc(), malloc() allocates memory beyond what it was asked
2193 Functions that accept a structure of this sort do not initialize
2194 the fields to 0, and add any existing values to whatever was there
2195 before; this way, you can get a cumulative effect. */
2197 struct overhead_stats
2200 int malloc_overhead;
2201 int dynarr_overhead;
2205 #endif /* MEMORY_USAGE_STATS */
2207 #ifndef DIRECTORY_SEP
2208 #define DIRECTORY_SEP '/'
2210 #ifndef IS_DIRECTORY_SEP
2211 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
2213 #ifndef IS_DEVICE_SEP
2215 #define IS_DEVICE_SEP(c) 0
2217 #define IS_DEVICE_SEP(c) ((c) == DEVICE_SEP)
2221 #define IS_ANY_SEP(c) IS_DIRECTORY_SEP (c)
2224 #ifdef HAVE_INTTYPES_H
2225 #include <inttypes.h>
2226 #elif SIZEOF_VOID_P == SIZEOF_INT
2227 typedef int intptr_t;
2228 typedef unsigned int uintptr_t;
2229 #elif SIZEOF_VOID_P == SIZEOF_LONG
2230 typedef long intptr_t;
2231 typedef unsigned long uintptr_t;
2232 #elif defined(SIZEOF_LONG_LONG) && SIZEOF_VOID_P == SIZEOF_LONG_LONG
2233 typedef long long intptr_t;
2234 typedef unsigned long long uintptr_t;
2236 /* Just pray. May break, may not. */
2237 typedef long intptr_t;
2238 typedef unsigned long uintptr_t;
2242 /************************************************************************/
2244 /************************************************************************/
2246 /* NOTE: Prototypes should go HERE, not in various header files, unless
2247 they specifically reference a type that's not defined in lisp.h.
2248 (And even then, you might consider adding the type to lisp.h.)
2250 The idea is that header files typically contain the innards of objects,
2251 and we want to minimize the number of "dependencies" of one file on
2252 the specifics of such objects. Putting prototypes here minimizes the
2253 number of header files that need to be included -- good for a number
2254 of reasons. --ben */
2256 /*--------------- prototypes for various public c functions ------------*/
2258 /* Prototypes for all init/syms_of/vars_of initialization functions. */
2259 #include "symsinit.h"
2261 /* Defined in alloc.c */
2262 void release_breathing_space (void);
2263 Lisp_Object noseeum_cons (Lisp_Object, Lisp_Object);
2264 Lisp_Object make_vector (size_t, Lisp_Object);
2266 Lisp_Object make_older_vector (size_t, Lisp_Object);
2267 void make_vector_newer (Lisp_Object);
2269 Lisp_Object vector1 (Lisp_Object);
2270 Lisp_Object vector2 (Lisp_Object, Lisp_Object);
2271 Lisp_Object vector3 (Lisp_Object, Lisp_Object, Lisp_Object);
2272 Lisp_Object make_bit_vector (size_t, Lisp_Object);
2273 Lisp_Object make_bit_vector_from_byte_vector (unsigned char *, size_t);
2274 Lisp_Object noseeum_make_marker (void);
2275 void garbage_collect_1 (void);
2276 Lisp_Object acons (Lisp_Object, Lisp_Object, Lisp_Object);
2277 Lisp_Object cons3 (Lisp_Object, Lisp_Object, Lisp_Object);
2278 Lisp_Object list1 (Lisp_Object);
2279 Lisp_Object list2 (Lisp_Object, Lisp_Object);
2280 Lisp_Object list3 (Lisp_Object, Lisp_Object, Lisp_Object);
2281 Lisp_Object list4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2282 Lisp_Object list5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2284 Lisp_Object list6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2285 Lisp_Object, Lisp_Object);
2286 DECLARE_DOESNT_RETURN (memory_full (void));
2287 void disksave_object_finalization (void);
2288 extern int purify_flag;
2289 extern int gc_currently_forbidden;
2290 Lisp_Object restore_gc_inhibit (Lisp_Object);
2291 extern EMACS_INT gc_generation_number[1];
2292 int c_readonly (Lisp_Object);
2293 int lisp_readonly (Lisp_Object);
2294 Lisp_Object build_string (const char *);
2295 Lisp_Object build_ext_string (const char *, Lisp_Object);
2296 Lisp_Object build_translated_string (const char *);
2297 Lisp_Object make_string (const Bufbyte *, Bytecount);
2298 Lisp_Object make_ext_string (const Extbyte *, EMACS_INT, Lisp_Object);
2299 Lisp_Object make_uninit_string (Bytecount);
2300 Lisp_Object make_float (double);
2301 Lisp_Object make_string_nocopy (const Bufbyte *, Bytecount);
2302 void free_cons (Lisp_Cons *);
2303 void free_list (Lisp_Object);
2304 void free_alist (Lisp_Object);
2305 void mark_conses_in_list (Lisp_Object);
2306 void free_marker (Lisp_Marker *);
2307 int object_dead_p (Lisp_Object);
2308 void mark_object (Lisp_Object obj);
2309 int marked_p (Lisp_Object obj);
2311 #ifdef MEMORY_USAGE_STATS
2312 size_t malloced_storage_size (void *, size_t, struct overhead_stats *);
2313 size_t fixed_type_block_overhead (size_t);
2317 int pdump_load (const char *);
2319 extern char *pdump_start, *pdump_end;
2320 #define DUMPEDP(adr) ((((char *)(adr)) < pdump_end) && (((char *)(adr)) >= pdump_start))
2322 #define DUMPEDP(adr) 0
2325 /* Defined in buffer.c */
2326 Lisp_Object make_buffer (struct buffer *);
2327 Lisp_Object get_truename_buffer (Lisp_Object);
2328 void switch_to_buffer (Lisp_Object, Lisp_Object);
2329 extern int find_file_compare_truenames;
2330 extern int find_file_use_truenames;
2332 /* Defined in callproc.c */
2333 char *egetenv (const char *);
2335 /* Defined in console.c */
2336 void stuff_buffered_input (Lisp_Object);
2338 /* Defined in console-msw.c */
2339 EXFUN (Fmswindows_message_box, 3);
2340 extern int mswindows_message_outputted;
2342 /* Defined in data.c */
2343 DECLARE_DOESNT_RETURN (c_write_error (Lisp_Object));
2344 DECLARE_DOESNT_RETURN (lisp_write_error (Lisp_Object));
2345 DECLARE_DOESNT_RETURN (args_out_of_range (Lisp_Object, Lisp_Object));
2346 DECLARE_DOESNT_RETURN (args_out_of_range_3 (Lisp_Object, Lisp_Object,
2348 Lisp_Object wrong_type_argument (Lisp_Object, Lisp_Object);
2349 DECLARE_DOESNT_RETURN (dead_wrong_type_argument (Lisp_Object, Lisp_Object));
2350 void check_int_range (EMACS_INT, EMACS_INT, EMACS_INT);
2352 enum arith_comparison {
2357 arith_less_or_equal,
2358 arith_grtr_or_equal };
2359 Lisp_Object arithcompare (Lisp_Object, Lisp_Object, enum arith_comparison);
2361 Lisp_Object word_to_lisp (unsigned int);
2362 unsigned int lisp_to_word (Lisp_Object);
2364 /* Defined in dired.c */
2365 Lisp_Object make_directory_hash_table (const char *);
2366 Lisp_Object wasteful_word_to_lisp (unsigned int);
2368 /* Defined in doc.c */
2369 Lisp_Object unparesseuxify_doc_string (int, EMACS_INT, char *, Lisp_Object);
2370 Lisp_Object read_doc_string (Lisp_Object);
2372 /* Defined in doprnt.c */
2373 Bytecount emacs_doprnt_c (Lisp_Object, const Bufbyte *, Lisp_Object,
2375 Bytecount emacs_doprnt_va (Lisp_Object, const Bufbyte *, Lisp_Object,
2376 Bytecount, va_list);
2377 Bytecount emacs_doprnt_lisp (Lisp_Object, const Bufbyte *, Lisp_Object,
2378 Bytecount, int, const Lisp_Object *);
2379 Bytecount emacs_doprnt_lisp_2 (Lisp_Object, const Bufbyte *, Lisp_Object,
2380 Bytecount, int, ...);
2381 Lisp_Object emacs_doprnt_string_c (const Bufbyte *, Lisp_Object,
2383 Lisp_Object emacs_doprnt_string_va (const Bufbyte *, Lisp_Object,
2384 Bytecount, va_list);
2385 Lisp_Object emacs_doprnt_string_lisp (const Bufbyte *, Lisp_Object,
2386 Bytecount, int, const Lisp_Object *);
2387 Lisp_Object emacs_doprnt_string_lisp_2 (const Bufbyte *, Lisp_Object,
2388 Bytecount, int, ...);
2390 /* Defined in editfns.c */
2391 void uncache_home_directory (void);
2392 Extbyte *get_home_directory (void);
2393 char *user_login_name (uid_t *);
2394 Bufpos bufpos_clip_to_bounds (Bufpos, Bufpos, Bufpos);
2395 Bytind bytind_clip_to_bounds (Bytind, Bytind, Bytind);
2396 void buffer_insert1 (struct buffer *, Lisp_Object);
2397 Lisp_Object make_string_from_buffer (struct buffer *, Bufpos, Charcount);
2398 Lisp_Object make_string_from_buffer_no_extents (struct buffer *, Bufpos, Charcount);
2399 Lisp_Object save_excursion_save (void);
2400 Lisp_Object save_restriction_save (void);
2401 Lisp_Object save_excursion_restore (Lisp_Object);
2402 Lisp_Object save_restriction_restore (Lisp_Object);
2404 /* Defined in emacsfns.c */
2405 Lisp_Object save_current_buffer_restore (Lisp_Object);
2407 /* Defined in emacs.c */
2408 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (fatal (const char *,
2410 int stderr_out (const char *, ...) PRINTF_ARGS (1, 2);
2411 int stdout_out (const char *, ...) PRINTF_ARGS (1, 2);
2412 SIGTYPE fatal_error_signal (int);
2413 Lisp_Object make_arg_list (int, Extbyte **);
2414 void make_argc_argv (Lisp_Object, int *, Extbyte ***);
2415 void free_argc_argv (Extbyte **);
2416 Lisp_Object decode_env_path (const char *, const char *);
2417 Lisp_Object decode_path (const char *);
2418 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2419 extern int noninteractive, noninteractive1;
2420 extern int fatal_error_in_progress;
2421 extern int preparing_for_armageddon;
2422 extern int emacs_priority;
2423 extern int running_asynch_code;
2424 extern int suppress_early_error_handler_backtrace;
2426 /* Defined in eval.c */
2427 DECLARE_DOESNT_RETURN (signal_error (Lisp_Object, Lisp_Object));
2428 void maybe_signal_error (Lisp_Object, Lisp_Object, Lisp_Object,
2430 Lisp_Object maybe_signal_continuable_error (Lisp_Object, Lisp_Object,
2431 Lisp_Object, Error_behavior);
2432 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (type_error (Lisp_Object,
2435 void maybe_type_error (Lisp_Object, Lisp_Object, Error_behavior, const char *,
2436 ...) PRINTF_ARGS (4, 5);
2437 Lisp_Object continuable_type_error (Lisp_Object, const char *, ...)
2439 Lisp_Object maybe_continuable_type_error (Lisp_Object, Lisp_Object,
2443 DECLARE_DOESNT_RETURN (signal_type_error (Lisp_Object, const char *,
2445 void maybe_signal_type_error (Lisp_Object, const char *, Lisp_Object,
2446 Lisp_Object, Error_behavior);
2447 Lisp_Object signal_type_continuable_error (Lisp_Object, const char *,
2449 Lisp_Object maybe_signal_type_continuable_error (Lisp_Object, const char *,
2451 Lisp_Object, Error_behavior);
2452 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (type_error_with_frob
2453 (Lisp_Object, Lisp_Object,
2456 void maybe_type_error_with_frob (Lisp_Object, Lisp_Object, Lisp_Object,
2458 const char *, ...) PRINTF_ARGS (5, 6);
2459 Lisp_Object continuable_type_error_with_frob (Lisp_Object, Lisp_Object,
2461 ...) PRINTF_ARGS (3, 4);
2462 Lisp_Object maybe_continuable_type_error_with_frob
2463 (Lisp_Object, Lisp_Object, Lisp_Object, Error_behavior, const char *, ...)
2465 DECLARE_DOESNT_RETURN (signal_type_error_2 (Lisp_Object, const char *,
2466 Lisp_Object, Lisp_Object));
2467 void maybe_signal_type_error_2 (Lisp_Object, const char *, Lisp_Object,
2468 Lisp_Object, Lisp_Object, Error_behavior);
2469 Lisp_Object signal_type_continuable_error_2 (Lisp_Object, const char *,
2470 Lisp_Object, Lisp_Object);
2471 Lisp_Object maybe_signal_type_continuable_error_2 (Lisp_Object, const char *,
2472 Lisp_Object, Lisp_Object,
2475 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error (const char *,
2477 void maybe_error (Lisp_Object, Error_behavior, const char *,
2478 ...) PRINTF_ARGS (3, 4);
2479 Lisp_Object continuable_error (const char *, ...) PRINTF_ARGS (1, 2);
2480 Lisp_Object maybe_continuable_error (Lisp_Object, Error_behavior,
2481 const char *, ...) PRINTF_ARGS (3, 4);
2482 DECLARE_DOESNT_RETURN (signal_simple_error (const char *, Lisp_Object));
2483 void maybe_signal_simple_error (const char *, Lisp_Object,
2484 Lisp_Object, Error_behavior);
2485 Lisp_Object signal_simple_continuable_error (const char *, Lisp_Object);
2486 Lisp_Object maybe_signal_simple_continuable_error (const char *, Lisp_Object,
2487 Lisp_Object, Error_behavior);
2488 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS (error_with_frob
2489 (Lisp_Object, const char *,
2491 void maybe_error_with_frob (Lisp_Object, Lisp_Object, Error_behavior,
2492 const char *, ...) PRINTF_ARGS (4, 5);
2493 Lisp_Object continuable_error_with_frob (Lisp_Object, const char *,
2494 ...) PRINTF_ARGS (2, 3);
2495 Lisp_Object maybe_continuable_error_with_frob
2496 (Lisp_Object, Lisp_Object, Error_behavior, const char *, ...) PRINTF_ARGS (4, 5);
2497 DECLARE_DOESNT_RETURN (signal_simple_error_2 (const char *,
2498 Lisp_Object, Lisp_Object));
2499 void maybe_signal_simple_error_2 (const char *, Lisp_Object, Lisp_Object,
2500 Lisp_Object, Error_behavior);
2501 Lisp_Object signal_simple_continuable_error_2 (const char *,
2502 Lisp_Object, Lisp_Object);
2503 Lisp_Object maybe_signal_simple_continuable_error_2 (const char *, Lisp_Object,
2504 Lisp_Object, Lisp_Object,
2506 DECLARE_DOESNT_RETURN (signal_malformed_list_error (Lisp_Object));
2507 DECLARE_DOESNT_RETURN (signal_malformed_property_list_error (Lisp_Object));
2508 DECLARE_DOESNT_RETURN (signal_circular_list_error (Lisp_Object));
2509 DECLARE_DOESNT_RETURN (signal_circular_property_list_error (Lisp_Object));
2511 DECLARE_DOESNT_RETURN (syntax_error (const char *reason, Lisp_Object frob));
2512 DECLARE_DOESNT_RETURN (syntax_error_2 (const char *reason, Lisp_Object frob1,
2513 Lisp_Object frob2));
2514 DECLARE_DOESNT_RETURN (invalid_argument (const char *reason,
2516 DECLARE_DOESNT_RETURN (invalid_argument_2 (const char *reason,
2518 Lisp_Object frob2));
2519 DECLARE_DOESNT_RETURN (invalid_operation (const char *reason,
2521 DECLARE_DOESNT_RETURN (invalid_operation_2 (const char *reason,
2523 Lisp_Object frob2));
2524 DECLARE_DOESNT_RETURN (invalid_change (const char *reason,
2526 DECLARE_DOESNT_RETURN (invalid_change_2 (const char *reason,
2528 Lisp_Object frob2));
2530 Lisp_Object signal_void_function_error (Lisp_Object);
2531 Lisp_Object signal_invalid_function_error (Lisp_Object);
2532 Lisp_Object signal_wrong_number_of_arguments_error (Lisp_Object, int);
2534 Lisp_Object run_hook_with_args_in_buffer (struct buffer *, int, Lisp_Object *,
2535 enum run_hooks_condition);
2536 Lisp_Object run_hook_with_args (int, Lisp_Object *, enum run_hooks_condition);
2537 void va_run_hook_with_args (Lisp_Object, int, ...);
2538 void va_run_hook_with_args_in_buffer (struct buffer *, Lisp_Object, int, ...);
2539 Lisp_Object run_hook (Lisp_Object);
2540 Lisp_Object apply1 (Lisp_Object, Lisp_Object);
2541 Lisp_Object call0 (Lisp_Object);
2542 Lisp_Object call1 (Lisp_Object, Lisp_Object);
2543 Lisp_Object call2 (Lisp_Object, Lisp_Object, Lisp_Object);
2544 Lisp_Object call3 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2545 Lisp_Object call4 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2547 Lisp_Object call5 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2548 Lisp_Object, Lisp_Object);
2549 Lisp_Object call6 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2550 Lisp_Object, Lisp_Object, Lisp_Object);
2551 Lisp_Object call7 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2552 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2553 Lisp_Object call8 (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2554 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2556 Lisp_Object call0_in_buffer (struct buffer *, Lisp_Object);
2557 Lisp_Object call1_in_buffer (struct buffer *, Lisp_Object, Lisp_Object);
2558 Lisp_Object call2_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2560 Lisp_Object call3_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2561 Lisp_Object, Lisp_Object);
2562 Lisp_Object call4_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2563 Lisp_Object, Lisp_Object, Lisp_Object);
2564 Lisp_Object call5_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2565 Lisp_Object, Lisp_Object, Lisp_Object,
2567 Lisp_Object call6_in_buffer (struct buffer *, Lisp_Object, Lisp_Object,
2568 Lisp_Object, Lisp_Object, Lisp_Object,
2569 Lisp_Object, Lisp_Object);
2570 Lisp_Object eval_in_buffer (struct buffer *, Lisp_Object);
2571 Lisp_Object call0_with_handler (Lisp_Object, Lisp_Object);
2572 Lisp_Object call1_with_handler (Lisp_Object, Lisp_Object, Lisp_Object);
2573 Lisp_Object eval_in_buffer_trapping_errors (const char *, struct buffer *,
2575 Lisp_Object run_hook_trapping_errors (const char *, Lisp_Object);
2576 Lisp_Object safe_run_hook_trapping_errors (const char *, Lisp_Object, int);
2577 Lisp_Object call0_trapping_errors (const char *, Lisp_Object);
2578 Lisp_Object call1_trapping_errors (const char *, Lisp_Object, Lisp_Object);
2579 Lisp_Object call2_trapping_errors (const char *,
2580 Lisp_Object, Lisp_Object, Lisp_Object);
2581 Lisp_Object call_with_suspended_errors (lisp_fn_t, volatile Lisp_Object, Lisp_Object,
2582 Error_behavior, int, ...);
2583 /* C Code should be using internal_catch, record_unwind_p, condition_case_1 */
2584 Lisp_Object internal_catch (Lisp_Object, Lisp_Object (*) (Lisp_Object),
2585 Lisp_Object, int * volatile);
2586 Lisp_Object condition_case_1 (Lisp_Object,
2587 Lisp_Object (*) (Lisp_Object),
2589 Lisp_Object (*) (Lisp_Object, Lisp_Object),
2591 Lisp_Object condition_case_3 (Lisp_Object, Lisp_Object, Lisp_Object);
2592 Lisp_Object unbind_to (int, Lisp_Object);
2593 void specbind (Lisp_Object, Lisp_Object);
2594 void record_unwind_protect (Lisp_Object (*) (Lisp_Object), Lisp_Object);
2595 void do_autoload (Lisp_Object, Lisp_Object);
2596 Lisp_Object un_autoload (Lisp_Object);
2597 void warn_when_safe_lispobj (Lisp_Object, Lisp_Object, Lisp_Object);
2598 void warn_when_safe (Lisp_Object, Lisp_Object, const char *,
2599 ...) PRINTF_ARGS (3, 4);
2602 /* Defined in event-stream.c */
2603 void wait_delaying_user_input (int (*) (void *), void *);
2604 int detect_input_pending (void);
2605 void reset_this_command_keys (Lisp_Object, int);
2606 Lisp_Object enqueue_misc_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2607 Lisp_Object enqueue_misc_user_event_pos (Lisp_Object, Lisp_Object,
2608 Lisp_Object, int, int, int, int);
2609 extern int modifier_keys_are_sticky;
2611 /* Defined in event-Xt.c */
2612 void enqueue_Xt_dispatch_event (Lisp_Object event);
2613 void signal_special_Xt_user_event (Lisp_Object, Lisp_Object, Lisp_Object);
2616 /* Defined in events.c */
2617 void clear_event_resource (void);
2618 Lisp_Object allocate_event (void);
2620 /* Defined in fileio.c */
2621 void record_auto_save (void);
2622 void force_auto_save_soon (void);
2623 DECLARE_DOESNT_RETURN (report_file_error (const char *, Lisp_Object));
2624 void maybe_report_file_error (const char *, Lisp_Object,
2625 Lisp_Object, Error_behavior);
2626 DECLARE_DOESNT_RETURN (signal_file_error (const char *, Lisp_Object));
2627 void maybe_signal_file_error (const char *, Lisp_Object,
2628 Lisp_Object, Error_behavior);
2629 DECLARE_DOESNT_RETURN (signal_double_file_error (const char *, const char *,
2631 void maybe_signal_double_file_error (const char *, const char *,
2632 Lisp_Object, Lisp_Object, Error_behavior);
2633 DECLARE_DOESNT_RETURN (signal_double_file_error_2 (const char *, const char *,
2634 Lisp_Object, Lisp_Object));
2635 void maybe_signal_double_file_error_2 (const char *, const char *,
2636 Lisp_Object, Lisp_Object, Lisp_Object,
2638 Lisp_Object lisp_strerror (int);
2639 Lisp_Object expand_and_dir_to_file (Lisp_Object, Lisp_Object);
2640 ssize_t read_allowing_quit (int, void *, size_t);
2641 ssize_t write_allowing_quit (int, const void *, size_t);
2642 int internal_delete_file (Lisp_Object);
2644 /* Defined in filelock.c */
2645 void lock_file (Lisp_Object);
2646 void unlock_file (Lisp_Object);
2647 void unlock_all_files (void);
2648 void unlock_buffer (struct buffer *);
2650 /* Defined in filemode.c */
2651 void filemodestring (struct stat *, char *);
2653 /* Defined in floatfns.c */
2654 double extract_float (Lisp_Object);
2656 /* Defined in fns.c */
2657 Lisp_Object list_sort (Lisp_Object, Lisp_Object,
2658 int (*) (Lisp_Object, Lisp_Object, Lisp_Object));
2659 Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
2661 void bump_string_modiff (Lisp_Object);
2662 Lisp_Object memq_no_quit (Lisp_Object, Lisp_Object);
2663 Lisp_Object assoc_no_quit (Lisp_Object, Lisp_Object);
2664 Lisp_Object assq_no_quit (Lisp_Object, Lisp_Object);
2665 Lisp_Object rassq_no_quit (Lisp_Object, Lisp_Object);
2666 Lisp_Object delq_no_quit (Lisp_Object, Lisp_Object);
2667 Lisp_Object delq_no_quit_and_free_cons (Lisp_Object, Lisp_Object);
2668 Lisp_Object remassoc_no_quit (Lisp_Object, Lisp_Object);
2669 Lisp_Object remassq_no_quit (Lisp_Object, Lisp_Object);
2670 Lisp_Object remrassq_no_quit (Lisp_Object, Lisp_Object);
2672 int plists_differ (Lisp_Object, Lisp_Object, int, int, int);
2673 Lisp_Object internal_plist_get (Lisp_Object, Lisp_Object);
2674 void internal_plist_put (Lisp_Object *, Lisp_Object, Lisp_Object);
2675 int internal_remprop (Lisp_Object *, Lisp_Object);
2676 Lisp_Object external_plist_get (Lisp_Object *, Lisp_Object,
2677 int, Error_behavior);
2678 void external_plist_put (Lisp_Object *, Lisp_Object,
2679 Lisp_Object, int, Error_behavior);
2680 int external_remprop (Lisp_Object *, Lisp_Object, int, Error_behavior);
2681 int internal_equal (Lisp_Object, Lisp_Object, int);
2682 Lisp_Object concat2 (Lisp_Object, Lisp_Object);
2683 Lisp_Object concat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2684 Lisp_Object vconcat2 (Lisp_Object, Lisp_Object);
2685 Lisp_Object vconcat3 (Lisp_Object, Lisp_Object, Lisp_Object);
2686 Lisp_Object nconc2 (Lisp_Object, Lisp_Object);
2687 Lisp_Object bytecode_nconc2 (Lisp_Object *);
2688 void check_losing_bytecode (const char *, Lisp_Object);
2690 /* Defined in glyphs.c */
2691 Error_behavior decode_error_behavior_flag (Lisp_Object);
2692 Lisp_Object encode_error_behavior_flag (Error_behavior);
2694 /* Defined in indent.c */
2695 int bi_spaces_at_point (struct buffer *, Bytind);
2696 int column_at_point (struct buffer *, Bufpos, int);
2697 int string_column_at_point (Lisp_String *, Bufpos, int);
2698 int current_column (struct buffer *);
2699 void invalidate_current_column (void);
2700 Bufpos vmotion (struct window *, Bufpos, int, int *);
2701 Bufpos vmotion_pixels (Lisp_Object, Bufpos, int, int, int *);
2703 /* Defined in keymap.c */
2704 void where_is_to_char (Lisp_Object, char *);
2706 /* Defined in lread.c */
2707 void ebolify_bytecode_constants (Lisp_Object);
2708 void close_load_descs (void);
2709 int locate_file (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object *, int);
2710 EXFUN (Flocate_file_clear_hashing, 1);
2711 int isfloat_string (const char *);
2713 /* Well, I've decided to enable this. -- ben */
2714 /* And I've decided to make it work right. -- sb */
2716 /* Define the following symbol to enable load history of dumped files */
2717 #define LOADHIST_DUMPED
2718 /* Define the following symbol to enable load history of C source */
2719 #define LOADHIST_BUILTIN
2721 #ifdef LOADHIST /* this is just a stupid idea */
2722 #define LOADHIST_ATTACH(x) \
2723 do { if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); } \
2725 #else /*! LOADHIST */
2726 # define LOADHIST_ATTACH(x)
2727 #endif /*! LOADHIST */
2729 /* Defined in marker.c */
2730 Bytind bi_marker_position (Lisp_Object);
2731 Bufpos marker_position (Lisp_Object);
2732 void set_bi_marker_position (Lisp_Object, Bytind);
2733 void set_marker_position (Lisp_Object, Bufpos);
2734 void unchain_marker (Lisp_Object);
2735 Lisp_Object noseeum_copy_marker (Lisp_Object, Lisp_Object);
2736 Lisp_Object set_marker_restricted (Lisp_Object, Lisp_Object, Lisp_Object);
2737 #ifdef MEMORY_USAGE_STATS
2738 int compute_buffer_marker_usage (struct buffer *, struct overhead_stats *);
2741 /* Defined in menubar.c */
2742 extern int popup_menu_up_p;
2743 extern int menubar_show_keybindings;
2744 extern int popup_menu_titles;
2746 /* Defined in minibuf.c */
2747 extern int minibuf_level;
2748 Charcount scmp_1 (const Bufbyte *, const Bufbyte *, Charcount, int);
2749 #define scmp(s1, s2, len) scmp_1 (s1, s2, len, completion_ignore_case)
2750 extern int completion_ignore_case;
2751 int regexp_ignore_completion_p (const Bufbyte *, Lisp_Object,
2752 Bytecount, Bytecount);
2753 Lisp_Object clear_echo_area (struct frame *, Lisp_Object, int);
2754 Lisp_Object clear_echo_area_from_print (struct frame *, Lisp_Object, int);
2755 void echo_area_append (struct frame *, const Bufbyte *, Lisp_Object,
2756 Bytecount, Bytecount, Lisp_Object);
2757 void echo_area_message (struct frame *, const Bufbyte *, Lisp_Object,
2758 Bytecount, Bytecount, Lisp_Object);
2759 Lisp_Object echo_area_status (struct frame *);
2760 int echo_area_active (struct frame *);
2761 Lisp_Object echo_area_contents (struct frame *);
2762 void message_internal (const Bufbyte *, Lisp_Object, Bytecount, Bytecount);
2763 void message_append_internal (const Bufbyte *, Lisp_Object,
2764 Bytecount, Bytecount);
2765 void message (const char *, ...) PRINTF_ARGS (1, 2);
2766 void message_append (const char *, ...) PRINTF_ARGS (1, 2);
2767 void message_no_translate (const char *, ...) PRINTF_ARGS (1, 2);
2768 void clear_message (void);
2770 /* Defined in print.c */
2771 void write_string_to_stdio_stream (FILE *, struct console *,
2772 const Bufbyte *, Bytecount, Bytecount,
2774 void debug_print (Lisp_Object);
2775 void debug_short_backtrace (int);
2776 void temp_output_buffer_setup (Lisp_Object);
2777 void temp_output_buffer_show (Lisp_Object, Lisp_Object);
2778 /* NOTE: Do not call this with the data of a Lisp_String. Use princ.
2779 * Note: stream should be defaulted before calling
2780 * (eg Qnil means stdout, not Vstandard_output, etc) */
2781 void write_c_string (const char *, Lisp_Object);
2782 /* Same goes for this function. */
2783 void write_string_1 (const Bufbyte *, Bytecount, Lisp_Object);
2784 void print_cons (Lisp_Object, Lisp_Object, int);
2785 void print_vector (Lisp_Object, Lisp_Object, int);
2786 void print_string (Lisp_Object, Lisp_Object, int);
2787 char *long_to_string (char *, long);
2788 void print_internal (Lisp_Object, Lisp_Object, int);
2789 void print_symbol (Lisp_Object, Lisp_Object, int);
2790 void print_float (Lisp_Object, Lisp_Object, int);
2791 extern int print_escape_newlines;
2792 extern int print_readably;
2793 Lisp_Object internal_with_output_to_temp_buffer (Lisp_Object,
2794 Lisp_Object (*) (Lisp_Object),
2795 Lisp_Object, Lisp_Object);
2796 void float_to_string (char *, double);
2797 void internal_object_printer (Lisp_Object, Lisp_Object, int);
2799 /* Defined in profile.c */
2800 void mark_profiling_info (void);
2801 void profile_increase_call_count (Lisp_Object);
2802 extern int profiling_active;
2803 extern int profiling_redisplay_flag;
2805 /* Defined in rangetab.c */
2806 void put_range_table (Lisp_Object, EMACS_INT, EMACS_INT, Lisp_Object);
2807 int unified_range_table_bytes_needed (Lisp_Object);
2808 int unified_range_table_bytes_used (void *);
2809 void unified_range_table_copy_data (Lisp_Object, void *);
2810 Lisp_Object unified_range_table_lookup (void *, EMACS_INT, Lisp_Object);
2811 int unified_range_table_nentries (void *);
2812 void unified_range_table_get_range (void *, int, EMACS_INT *, EMACS_INT *,
2815 /* Defined in search.c */
2816 struct re_pattern_buffer;
2817 struct re_registers;
2818 Bufpos scan_buffer (struct buffer *, Emchar, Bufpos, Bufpos, EMACS_INT, EMACS_INT *, int);
2819 Bufpos find_next_newline (struct buffer *, Bufpos, int);
2820 Bufpos find_next_newline_no_quit (struct buffer *, Bufpos, int);
2821 Bytind bi_find_next_newline_no_quit (struct buffer *, Bytind, int);
2822 Bytind bi_find_next_emchar_in_string (Lisp_String*, Emchar, Bytind, EMACS_INT);
2823 Bufpos find_before_next_newline (struct buffer *, Bufpos, Bufpos, int);
2824 struct re_pattern_buffer *compile_pattern (Lisp_Object, struct re_registers *,
2825 Lisp_Object, int, Error_behavior);
2826 Bytecount fast_string_match (Lisp_Object, const Bufbyte *,
2827 Lisp_Object, Bytecount,
2828 Bytecount, int, Error_behavior, int);
2829 Bytecount fast_lisp_string_match (Lisp_Object, Lisp_Object);
2830 void restore_match_data (void);
2832 /* Defined in signal.c */
2833 void init_interrupts_late (void);
2834 extern int dont_check_for_quit;
2835 void begin_dont_check_for_quit (void);
2836 void emacs_sleep (int);
2838 /* Defined in sound.c */
2839 void init_device_sound (struct device *);
2841 /* Defined in specifier.c */
2842 Lisp_Object specifier_instance (Lisp_Object, Lisp_Object, Lisp_Object,
2843 Error_behavior, int, int, Lisp_Object);
2844 Lisp_Object specifier_instance_no_quit (Lisp_Object, Lisp_Object, Lisp_Object,
2845 Error_behavior, int, Lisp_Object);
2847 /* Defined in symbols.c */
2848 int hash_string (const Bufbyte *, Bytecount);
2849 Lisp_Object intern (const char *);
2850 Lisp_Object oblookup (Lisp_Object, const Bufbyte *, Bytecount);
2851 void map_obarray (Lisp_Object, int (*) (Lisp_Object, void *), void *);
2852 Lisp_Object indirect_function (Lisp_Object, int);
2853 Lisp_Object symbol_value_in_buffer (Lisp_Object, Lisp_Object);
2854 void kill_buffer_local_variables (struct buffer *);
2855 int symbol_value_buffer_local_info (Lisp_Object, struct buffer *);
2856 Lisp_Object find_symbol_value (Lisp_Object);
2857 Lisp_Object find_symbol_value_quickly (Lisp_Object, int);
2858 Lisp_Object top_level_value (Lisp_Object);
2859 void reject_constant_symbols (Lisp_Object sym, Lisp_Object newval,
2861 Lisp_Object follow_past_lisp_magic);
2863 /* Defined in syntax.c */
2864 Bufpos scan_words (struct buffer *, Bufpos, int);
2866 /* Defined in undo.c */
2867 Lisp_Object truncate_undo_list (Lisp_Object, int, int);
2868 void record_extent (Lisp_Object, int);
2869 void record_insert (struct buffer *, Bufpos, Charcount);
2870 void record_delete (struct buffer *, Bufpos, Charcount);
2871 void record_change (struct buffer *, Bufpos, Charcount);
2873 /* Defined in unex*.c */
2874 int unexec (char *, char *, uintptr_t, uintptr_t, uintptr_t);
2875 #ifdef RUN_TIME_REMAP
2876 int run_time_remap (char *);
2879 /* Defined in vm-limit.c */
2880 void memory_warnings (void *, void (*) (const char *));
2882 /* Defined in window.c */
2883 Lisp_Object save_window_excursion_unwind (Lisp_Object);
2884 Lisp_Object display_buffer (Lisp_Object, Lisp_Object, Lisp_Object);
2886 /*--------------- prototypes for Lisp primitives in C ------------*/
2888 /* The following were machine generated 19980312 */
2890 EXFUN (Faccept_process_output, 3);
2892 EXFUN (Fadd_spec_to_specifier, 5);
2893 EXFUN (Fadd_timeout, 4);
2894 EXFUN (Fappend, MANY);
2895 EXFUN (Fapply, MANY);
2900 EXFUN (Fbacktrace, 2);
2901 EXFUN (Fbeginning_of_line, 2);
2905 EXFUN (Fbuffer_substring, 3);
2906 EXFUN (Fbuilt_in_variable_type, 1);
2907 EXFUN (Fbyte_code, 3);
2908 EXFUN (Fcall_interactively, 3);
2909 EXFUN (Fcanonicalize_lax_plist, 2);
2910 EXFUN (Fcanonicalize_plist, 2);
2912 EXFUN (Fcar_safe, 1);
2914 EXFUN (Fchar_after, 2);
2915 EXFUN (Fchar_to_string, 1);
2916 EXFUN (Fcheck_valid_plist, 1);
2917 EXFUN (Fvalid_plist_p, 1);
2918 EXFUN (Fclear_range_table, 1);
2919 EXFUN (Fcoding_category_list, 0);
2920 EXFUN (Fcoding_category_system, 1);
2921 EXFUN (Fcoding_priority_list, 0);
2922 EXFUN (Fcoding_system_charset, 2);
2923 EXFUN (Fcoding_system_doc_string, 1);
2924 EXFUN (Fcoding_system_list, 0);
2925 EXFUN (Fcoding_system_name, 1);
2926 EXFUN (Fcoding_system_p, 1);
2927 EXFUN (Fcoding_system_property, 2);
2928 EXFUN (Fcoding_system_type, 1);
2929 EXFUN (Fcommand_execute, 3);
2930 EXFUN (Fcommandp, 1);
2931 EXFUN (Fconcat, MANY);
2933 EXFUN (Fcopy_alist, 1);
2934 EXFUN (Fcopy_coding_system, 2);
2935 EXFUN (Fcopy_event, 2);
2936 EXFUN (Fcopy_list, 1);
2937 EXFUN (Fcopy_marker, 2);
2938 EXFUN (Fcopy_sequence, 1);
2939 EXFUN (Fcopy_tree, 2);
2940 EXFUN (Fcurrent_window_configuration, 1);
2941 EXFUN (Fdecode_big5_char, 1);
2942 EXFUN (Fdecode_coding_region, 4);
2943 EXFUN (Fdecode_shift_jis_char, 1);
2944 EXFUN (Fdefault_boundp, 1);
2945 EXFUN (Fdefault_value, 1);
2946 EXFUN (Fdefine_key, 3);
2948 EXFUN (Fdelete_region, 3);
2949 EXFUN (Fdelete_process, 1);
2951 EXFUN (Fdestructive_alist_to_plist, 1);
2952 EXFUN (Fdetect_coding_region, 3);
2953 EXFUN (Fdgettext, 2);
2955 EXFUN (Fdirectory_file_name, 1);
2956 EXFUN (Fdisable_timeout, 1);
2957 EXFUN (Fdiscard_input, 0);
2958 EXFUN (Fdispatch_event, 1);
2959 EXFUN (Fdisplay_error, 2);
2960 EXFUN (Fdo_auto_save, 2);
2961 EXFUN (Fdowncase, 2);
2963 EXFUN (Fencode_big5_char, 1);
2964 EXFUN (Fencode_coding_region, 4);
2965 EXFUN (Fencode_shift_jis_char, 1);
2966 EXFUN (Fend_of_line, 2);
2967 EXFUN (Fenqueue_eval_event, 2);
2971 EXFUN (Ferror_message_string, 1);
2973 EXFUN (Fevent_to_character, 4);
2974 EXFUN (Fexecute_kbd_macro, 2);
2975 EXFUN (Fexpand_abbrev, 0);
2976 EXFUN (Fexpand_file_name, 2);
2977 EXFUN (Fextent_at, 5);
2978 EXFUN (Fextent_property, 3);
2979 EXFUN (Ffboundp, 1);
2980 EXFUN (Ffile_accessible_directory_p, 1);
2981 EXFUN (Ffile_directory_p, 1);
2982 EXFUN (Ffile_executable_p, 1);
2983 EXFUN (Ffile_exists_p, 1);
2984 EXFUN (Ffile_name_absolute_p, 1);
2985 EXFUN (Ffile_name_as_directory, 1);
2986 EXFUN (Ffile_name_directory, 1);
2987 EXFUN (Ffile_name_nondirectory, 1);
2988 EXFUN (Ffile_readable_p, 1);
2989 EXFUN (Ffile_symlink_p, 1);
2990 EXFUN (Ffile_truename, 2);
2991 EXFUN (Ffind_coding_system, 1);
2992 EXFUN (Ffind_file_name_handler, 2);
2993 EXFUN (Ffollowing_char, 1);
2994 EXFUN (Fformat, MANY);
2995 EXFUN (Fforward_char, 2);
2996 EXFUN (Fforward_line, 2);
2998 EXFUN (Ffuncall, MANY);
2999 EXFUN (Ffunctionp, 1);
3002 EXFUN (Fget_buffer_process, 1);
3003 EXFUN (Fget_coding_system, 1);
3004 EXFUN (Fget_process, 1);
3005 EXFUN (Fget_range_table, 3);
3006 EXFUN (Fgettext, 1);
3007 EXFUN (Fgoto_char, 2);
3009 EXFUN (Findent_to, 3);
3010 EXFUN (Findirect_function, 1);
3011 EXFUN (Finsert, MANY);
3012 EXFUN (Finsert_buffer_substring, 3);
3013 EXFUN (Finsert_char, 4);
3014 EXFUN (Finsert_file_contents_internal, 7);
3015 EXFUN (Finteractive_p, 0);
3017 EXFUN (Fintern_soft, 2);
3018 EXFUN (Fkey_description, 1);
3019 EXFUN (Fkill_emacs, 1);
3020 EXFUN (Fkill_local_variable, 1);
3022 EXFUN (Flax_plist_get, 3);
3023 EXFUN (Flax_plist_remprop, 2);
3026 EXFUN (Flist, MANY);
3028 EXFUN (Flist_modules, 0);
3029 EXFUN (Fload_module, 3);
3030 EXFUN (Flookup_key, 3);
3032 EXFUN (Fmake_byte_code, MANY);
3033 EXFUN (Fmake_coding_system, 4);
3034 EXFUN (Fmake_glyph_internal, 1);
3035 EXFUN (Fmake_list, 2);
3036 EXFUN (Fmake_marker, 0);
3037 EXFUN (Fmake_range_table, 0);
3038 EXFUN (Fmake_sparse_keymap, 1);
3039 EXFUN (Fmake_string, 2);
3040 EXFUN (Fmake_symbol, 1);
3041 EXFUN (Fmake_vector, 2);
3043 EXFUN (Fmarker_buffer, 1);
3044 EXFUN (Fmarker_position, 1);
3045 EXFUN (Fmatch_beginning, 1);
3046 EXFUN (Fmatch_end, 1);
3051 EXFUN (Fminus, MANY);
3052 EXFUN (Fnarrow_to_region, 3);
3053 EXFUN (Fnconc, MANY);
3054 EXFUN (Fnext_event, 2);
3055 EXFUN (Fnreverse, 1);
3057 EXFUN (Fnumber_to_string, 1);
3058 EXFUN (Fold_assq, 2);
3059 EXFUN (Fold_equal, 2);
3060 EXFUN (Fold_member, 2);
3061 EXFUN (Fold_memq, 2);
3062 EXFUN (Fplist_get, 3);
3063 EXFUN (Fplist_member, 2);
3064 EXFUN (Fplist_put, 3);
3065 EXFUN (Fplus, MANY);
3067 EXFUN (Fpoint_marker, 2);
3068 EXFUN (Fpoint_max, 1);
3069 EXFUN (Fpoint_min, 1);
3070 EXFUN (Fpreceding_char, 1);
3071 EXFUN (Fprefix_numeric_value, 1);
3073 EXFUN (Fprin1_to_string, 2);
3076 EXFUN (Fprocess_status, 1);
3077 EXFUN (Fprogn, UNEVALLED);
3078 EXFUN (Fprovide, 1);
3080 EXFUN (Fput_range_table, 4);
3081 EXFUN (Fput_text_property, 5);
3085 EXFUN (Fread_key_sequence, 3);
3086 EXFUN (Freally_free, 1);
3088 EXFUN (Fremassq, 2);
3089 EXFUN (Freplace_list, 2);
3090 EXFUN (Fselected_frame, 1);
3092 EXFUN (Fset_coding_category_system, 2);
3093 EXFUN (Fset_coding_priority_list, 1);
3094 EXFUN (Fset_default, 2);
3095 EXFUN (Fset_marker, 3);
3096 EXFUN (Fset_standard_case_table, 1);
3100 EXFUN (Fsit_for, 2);
3101 EXFUN (Fskip_chars_backward, 3);
3102 EXFUN (Fskip_chars_forward, 3);
3103 EXFUN (Fsleep_for, 1);
3105 EXFUN (Fspecifier_spec_list, 4);
3106 EXFUN (Fstring_equal, 2);
3107 EXFUN (Fstring_lessp, 2);
3108 EXFUN (Fstring_match, 4);
3110 EXFUN (Fsubr_max_args, 1);
3111 EXFUN (Fsubr_min_args, 1);
3112 EXFUN (Fsubsidiary_coding_system, 2);
3113 EXFUN (Fsubstitute_command_keys, 1);
3114 EXFUN (Fsubstitute_in_file_name, 1);
3115 EXFUN (Fsubstring, 3);
3116 EXFUN (Fsymbol_function, 1);
3117 EXFUN (Fsymbol_name, 1);
3118 EXFUN (Fsymbol_plist, 1);
3119 EXFUN (Fsymbol_value, 1);
3120 EXFUN (Fsystem_name, 0);
3122 EXFUN (Ftimes, MANY);
3123 EXFUN (Ftruncate, 1);
3124 EXFUN (Fundo_boundary, 0);
3125 EXFUN (Funhandled_file_name_directory, 1);
3126 EXFUN (Funlock_buffer, 0);
3128 EXFUN (Fupcase_initials, 2);
3129 EXFUN (Fupcase_initials_region, 3);
3130 EXFUN (Fupcase_region, 3);
3131 EXFUN (Fuser_home_directory, 0);
3132 EXFUN (Fuser_login_name, 1);
3133 EXFUN (Fvector, MANY);
3134 EXFUN (Fverify_visited_file_modtime, 1);
3135 EXFUN (Fvertical_motion, 3);
3138 /*--------------- prototypes for constant symbols ------------*/
3140 extern Lisp_Object Q_style;
3141 extern Lisp_Object Qactivate_menubar_hook;
3142 extern Lisp_Object Qarith_error;
3143 extern Lisp_Object Qarrayp, Qautoload;
3144 extern Lisp_Object Qbackground, Qbackground_pixmap;
3145 extern Lisp_Object Qbeginning_of_buffer, Qbig5;
3146 extern Lisp_Object Qbitp, Qblinking;
3147 extern Lisp_Object Qbuffer_glyph_p, Qbuffer_live_p, Qbuffer_read_only;
3148 extern Lisp_Object Qbyte_code, Qcall_interactively;
3149 extern Lisp_Object Qcategory_designator_p, Qcategory_table_value_p, Qccl, Qcdr;
3150 extern Lisp_Object Qchar_or_string_p, Qcharacterp;
3151 extern Lisp_Object Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
3152 extern Lisp_Object Qcircular_list, Qcircular_property_list;
3153 extern Lisp_Object Qcoding_system_error;
3154 extern Lisp_Object Qcolor_pixmap_image_instance_p;
3155 extern Lisp_Object Qcommandp, Qcompletion_ignore_case;
3156 extern Lisp_Object Qconsole_live_p, Qconst_specifier, Qcr;
3157 extern Lisp_Object Qcrlf, Qcurrent_menubar, Qctext;
3158 extern Lisp_Object Qcyclic_variable_indirection, Qdecode;
3159 extern Lisp_Object Qdefun, Qdevice_live_p;
3160 extern Lisp_Object Qdim, Qdisabled, Qdisplay_table;
3161 extern Lisp_Object Qdomain_error;
3162 extern Lisp_Object Qediting_error;
3163 extern Lisp_Object Qencode, Qend_of_buffer, Qend_of_file, Qend_open;
3164 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type;
3165 extern Lisp_Object Qerror, Qerror_conditions, Qerror_message, Qescape_quoted;
3166 extern Lisp_Object Qevent_live_p, Qexit, Qextent_live_p;
3167 extern Lisp_Object Qexternal_debugging_output, Qfeaturep;
3168 extern Lisp_Object Qfile_error;
3169 extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
3170 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output, Qforeground;
3171 extern Lisp_Object Qformat, Qframe_live_p;
3172 extern Lisp_Object Qicon_glyph_p, Qidentity;
3173 extern Lisp_Object Qinhibit_quit, Qinhibit_read_only;
3174 extern Lisp_Object Qinput_charset_conversion;
3175 extern Lisp_Object Qinteger_char_or_marker_p, Qinteger_or_char_p;
3176 extern Lisp_Object Qinteger_or_marker_p, Qintegerp, Qinteractive;
3177 extern Lisp_Object Qinternal_error, Qinvalid_argument;
3178 extern Lisp_Object Qinvalid_change, Qinvalid_function, Qinvalid_operation;
3179 extern Lisp_Object Qinvalid_read_syntax, Qinvalid_state;
3180 extern Lisp_Object Qio_error;
3181 extern Lisp_Object Qiso2022;
3182 extern Lisp_Object Qlambda, Qlayout;
3183 extern Lisp_Object Qlf;
3184 extern Lisp_Object Qlist_formation_error;
3185 extern Lisp_Object Qlistp, Qload, Qlock_shift, Qmacro;
3186 extern Lisp_Object Qmakunbound, Qmalformed_list, Qmalformed_property_list;
3187 extern Lisp_Object Qmark;
3188 extern Lisp_Object Qmnemonic;
3189 extern Lisp_Object Qmono_pixmap_image_instance_p;
3190 extern Lisp_Object Qmouse_leave_buffer_hook;
3191 extern Lisp_Object Qnas, Qnatnump, Qnative_layout;
3192 extern Lisp_Object Qno_ascii_cntl, Qno_ascii_eol, Qno_catch;
3193 extern Lisp_Object Qno_conversion, Qno_iso6429;
3194 extern Lisp_Object Qnothing_image_instance_p;
3195 extern Lisp_Object Qnumber_char_or_marker_p, Qnumberp;
3196 extern Lisp_Object Qoutput_charset_conversion;
3197 extern Lisp_Object Qoverflow_error, Qpoint, Qpointer_glyph_p;
3198 extern Lisp_Object Qpointer_image_instance_p, Qpost_read_conversion;
3199 extern Lisp_Object Qpre_write_conversion, Qprint_length;
3200 extern Lisp_Object Qprint_string_length, Qprogn, Qquit;
3201 extern Lisp_Object Qquote, Qrange_error, Qread_char;
3202 extern Lisp_Object Qread_from_minibuffer, Qreally_early_error_handler;
3203 extern Lisp_Object Qregion_beginning, Qregion_end;
3204 extern Lisp_Object Qrun_hooks, Qsans_modifiers;
3205 extern Lisp_Object Qsave_buffers_kill_emacs;
3206 extern Lisp_Object Qself_insert_command, Qself_insert_defer_undo;
3207 extern Lisp_Object Qsequencep, Qset, Qsetting_constant;
3208 extern Lisp_Object Qseven, Qshift_jis, Qshort;
3209 extern Lisp_Object Qsingularity_error;
3210 extern Lisp_Object Qstandard_input, Qstandard_output;
3211 extern Lisp_Object Qstart_open;
3212 extern Lisp_Object Qstring_lessp, Qsubwindow;
3213 extern Lisp_Object Qsubwindow_image_instance_p;
3214 extern Lisp_Object Qsyntax_error, Qt;
3215 extern Lisp_Object Qtext_image_instance_p;
3216 extern Lisp_Object Qtop_level;
3217 extern Lisp_Object Qtrue_list_p;
3218 extern Lisp_Object Qunbound, Qunderflow_error;
3219 extern Lisp_Object Qunderline, Quser_files_and_directories;
3220 extern Lisp_Object Qvalues;
3221 extern Lisp_Object Qvariable_documentation, Qvariable_domain;
3222 extern Lisp_Object Qvoid_function, Qvoid_variable;
3223 extern Lisp_Object Qwindow_live_p, Qwrong_number_of_arguments;
3224 extern Lisp_Object Qwrong_type_argument, Qyes_or_no_p;
3226 #define SYMBOL(fou) extern Lisp_Object fou
3227 #define SYMBOL_KEYWORD(la_cle_est_fou) extern Lisp_Object la_cle_est_fou
3228 #define SYMBOL_GENERAL(tout_le_monde, est_fou) \
3229 extern Lisp_Object tout_le_monde
3231 #include "general-slots.h"
3234 #undef SYMBOL_KEYWORD
3235 #undef SYMBOL_GENERAL
3237 /*--------------- prototypes for variables of type Lisp_Object ------------*/
3239 extern Lisp_Object Vactivate_menubar_hook;
3240 extern Lisp_Object Vautoload_queue, Vblank_menubar;
3241 extern Lisp_Object Vcharset_ascii, Vcharset_composite, Vcharset_control_1;
3242 extern Lisp_Object Vcharset_latin_iso8859_1, Vcharset_greek_iso8859_7;
3243 extern Lisp_Object Vcharset_cyrillic_iso8859_5, Vcharset_hebrew_iso8859_8;
3244 extern Lisp_Object Vcharset_thai_tis620, Vcharset_katakana_jisx0201;
3245 extern Lisp_Object Vcoding_system_for_read, Vcoding_system_for_write;
3246 extern Lisp_Object Vcoding_system_hash_table, Vcommand_history;
3247 extern Lisp_Object Vcommand_line_args, Vconfigure_info_directory;
3248 extern Lisp_Object Vconfigure_site_directory, Vconfigure_site_module_directory;
3249 extern Lisp_Object Vconsole_list, Vcontrolling_terminal;
3250 extern Lisp_Object Vcurrent_compiled_function_annotation, Vcurrent_load_list;
3251 extern Lisp_Object Vcurrent_mouse_event, Vcurrent_prefix_arg, Vdata_directory;
3252 extern Lisp_Object Vdirectory_sep_char, Vdisabled_command_hook;
3253 extern Lisp_Object Vdoc_directory, Vinternal_doc_file_name;
3254 extern Lisp_Object Vecho_area_buffer, Vemacs_major_version;
3255 extern Lisp_Object Vemacs_minor_version, Vexec_directory, Vexec_path;
3256 extern Lisp_Object Vexecuting_macro, Vfeatures, Vfile_domain;
3257 extern Lisp_Object Vfile_name_coding_system, Vinhibit_quit;
3258 extern Lisp_Object Vinvocation_directory, Vinvocation_name;
3259 extern Lisp_Object Vkeyboard_coding_system, Vlast_command, Vlast_command_char;
3260 extern Lisp_Object Vlast_command_event, Vlast_input_event;
3261 extern Lisp_Object Vload_file_name_internal;
3262 extern Lisp_Object Vload_file_name_internal_the_purecopy, Vload_history;
3263 extern Lisp_Object Vload_path, Vmark_even_if_inactive, Vmenubar_configuration;
3264 extern Lisp_Object Vminibuf_preprompt, Vminibuf_prompt, Vminibuffer_zero;
3265 extern Lisp_Object Vmodule_directory, Vmswindows_downcase_file_names;
3266 extern Lisp_Object Vmswindows_get_true_file_attributes, Vobarray;
3267 extern Lisp_Object Vprint_length, Vprint_level, Vprocess_environment;
3268 extern Lisp_Object Vquit_flag;
3269 extern Lisp_Object Vrecent_keys_ring, Vshell_file_name, Vsite_directory;
3270 extern Lisp_Object Vsite_module_directory;
3271 extern Lisp_Object Vstandard_input, Vstandard_output, Vstdio_str;
3272 extern Lisp_Object Vsynchronous_sounds, Vsystem_name, Vterminal_coding_system;
3273 extern Lisp_Object Vthis_command_keys, Vunread_command_event;
3274 extern Lisp_Object Vx_initial_argv_list;
3276 #endif /* INCLUDED_lisp_h_ */