cgit.sxemacs.org Git - sxemacs/blob - src/lisp.h

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