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