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