git.chise.org Git - chise/xemacs-chise.git-/blob - src/lisp.h

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