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 /* basic integer definitions, used quite a lot */
1317 #include "ent/ent-int.h"
1318
1319 /*--------------------------- readonly objects -------------------------*/
1320
1321 #define CHECK_C_WRITEABLE(obj)                                  \
1322   do { if (c_readonly (obj)) c_write_error (obj); } while (0)
1323
1324 #define CHECK_LISP_WRITEABLE(obj)                                       \
1325   do { if (lisp_readonly (obj)) lisp_write_error (obj); } while (0)
1326
1327 #define C_READONLY(obj) (C_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1328 #define LISP_READONLY(obj) (LISP_READONLY_RECORD_HEADER_P(XRECORD_LHEADER (obj)))
1329
1330 /*----------------------------- structures -----------------------------*/
1331
1332 typedef struct structure_keyword_entry structure_keyword_entry;
1333 struct structure_keyword_entry {
1334         Lisp_Object keyword;
1335         int (*validate) (Lisp_Object keyword, Lisp_Object value,
1336                          Error_behavior errb);
1337 };
1338
1339 typedef struct {
1340         Dynarr_declare(structure_keyword_entry);
1341 } structure_keyword_entry_dynarr;
1342
1343 typedef struct structure_type structure_type;
1344 struct structure_type {
1345         Lisp_Object type;
1346         structure_keyword_entry_dynarr *keywords;
1347         int (*validate) (Lisp_Object data, Error_behavior errb);
1348          Lisp_Object(*instantiate) (Lisp_Object data);
1349 };
1350
1351 typedef struct {
1352         Dynarr_declare(structure_type);
1353 } structure_type_dynarr;
1354
1355 struct structure_type *define_structure_type(Lisp_Object type, int (*validate)
1356                                               (Lisp_Object data,
1357                                                Error_behavior errb),
1358                                              Lisp_Object(*instantiate)
1359                                               (Lisp_Object data));
1360 void define_structure_type_keyword(struct structure_type *st,
1361                                    Lisp_Object keyword,
1362                                    int (*validate) (Lisp_Object keyword,
1363                                                     Lisp_Object value,
1364                                                     Error_behavior errb));
1365
1366 /*---------------------------- weak lists ------------------------------*/
1367
1368 enum weak_list_type {
1369         /* element disappears if it's unmarked. */
1370         WEAK_LIST_SIMPLE,
1371         /* element disappears if it's a cons and either its car or
1372            cdr is unmarked. */
1373         WEAK_LIST_ASSOC,
1374         /* element disappears if it's a cons and its car is unmarked. */
1375         WEAK_LIST_KEY_ASSOC,
1376         /* element disappears if it's a cons and its cdr is unmarked. */
1377         WEAK_LIST_VALUE_ASSOC,
1378         /* element disappears if it's a cons and neither its car nor
1379            its cdr is marked. */
1380         WEAK_LIST_FULL_ASSOC
1381 };
1382
1383 struct weak_list {
1384         struct lcrecord_header header;
1385         Lisp_Object list;       /* don't mark through this! */
1386         enum weak_list_type type;
1387         Lisp_Object next_weak;  /* don't mark through this! */
1388 };
1389
1390 DECLARE_LRECORD(weak_list, struct weak_list);
1391 #define XWEAK_LIST(x) XRECORD (x, weak_list, struct weak_list)
1392 #define XSETWEAK_LIST(x, p) XSETRECORD (x, p, weak_list)
1393 #define WEAK_LISTP(x) RECORDP (x, weak_list)
1394 #define CHECK_WEAK_LIST(x) CHECK_RECORD (x, weak_list)
1395 #define CONCHECK_WEAK_LIST(x) CONCHECK_RECORD (x, weak_list)
1396
1397 #define weak_list_list(w) ((w)->list)
1398 #define XWEAK_LIST_LIST(w) (XWEAK_LIST (w)->list)
1399
1400 Lisp_Object make_weak_list(enum weak_list_type type);
1401 /* The following two are only called by the garbage collector */
1402 int finish_marking_weak_lists(void);
1403 void prune_weak_lists(void);
1404
1405 /*-------------------------- lcrecord-list -----------------------------*/
1406
1407 struct lcrecord_list {
1408         struct lcrecord_header header;
1409         Lisp_Object free;
1410         size_t size;
1411         const struct lrecord_implementation *implementation;
1412 };
1413
1414 DECLARE_LRECORD(lcrecord_list, struct lcrecord_list);
1415 #define XLCRECORD_LIST(x) XRECORD (x, lcrecord_list, struct lcrecord_list)
1416 #define XSETLCRECORD_LIST(x, p) XSETRECORD (x, p, lcrecord_list)
1417 #define LCRECORD_LISTP(x) RECORDP (x, lcrecord_list)
1418 /* #define CHECK_LCRECORD_LIST(x) CHECK_RECORD (x, lcrecord_list)
1419    Lcrecord lists should never escape to the Lisp level, so
1420    functions should not be doing this. */
1421
1422 Lisp_Object make_lcrecord_list(size_t size, const struct lrecord_implementation
1423                                *implementation);
1424 Lisp_Object allocate_managed_lcrecord(Lisp_Object lcrecord_list);
1425 void free_managed_lcrecord(Lisp_Object lcrecord_list, Lisp_Object lcrecord);
1426 \f
1427 /************************************************************************/
1428 /*         Definitions of primitive Lisp functions and variables        */
1429 /************************************************************************/
1430
1431 /* DEFUN - Define a built-in Lisp-visible C function or `subr'.
1432  `lname' should be the name to give the function in Lisp,
1433     as a null-terminated C string.
1434  `Fname' should be the C equivalent of `lname', using only characters
1435     valid in a C identifier, with an "F" prepended.
1436     The name of the C constant structure that records information
1437     on this function for internal use is "S" concatenated with Fname.
1438  `min_args' should be a number, the minimum number of arguments allowed.
1439  `max_args' should be a number, the maximum number of arguments allowed,
1440     or else MANY or UNEVALLED.
1441     MANY means pass a vector of evaluated arguments,
1442          in the form of an integer number-of-arguments
1443          followed by the address of a vector of Lisp_Objects
1444          which contains the argument values.
1445     UNEVALLED means pass the list of unevaluated arguments.
1446  `prompt' says how to read arguments for an interactive call.
1447     See the doc string for `interactive'.
1448     A null string means call interactively with no arguments.
1449  `arglist' are the comma-separated arguments (always Lisp_Objects) for
1450     the function.
1451   The docstring for the function is placed as a "C" comment between
1452     the prompt and the `args' argument.  make-docfile reads the
1453     comment and creates the DOC file from it.
1454 */
1455
1456 #define EXFUN_0 void
1457 #define EXFUN_1 Lisp_Object
1458 #define EXFUN_2 Lisp_Object,Lisp_Object
1459 #define EXFUN_3 Lisp_Object,Lisp_Object,Lisp_Object
1460 #define EXFUN_4 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1461 #define EXFUN_5 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object
1462 #define EXFUN_6 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1463 Lisp_Object
1464 #define EXFUN_7 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1465 Lisp_Object,Lisp_Object
1466 #define EXFUN_8 Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object,Lisp_Object, \
1467 Lisp_Object,Lisp_Object,Lisp_Object
1468 #define EXFUN_MANY int, Lisp_Object*
1469 #define EXFUN_UNEVALLED Lisp_Object
1470 #define EXFUN(sym, max_args) Lisp_Object sym (EXFUN_##max_args)
1471
1472 #define SUBR_MAX_ARGS 8
1473 #define MANY -2
1474 #define UNEVALLED -1
1475
1476 /* Can't be const, because then subr->doc is read-only and
1477    Snarf_documentation chokes */
1478
1479 #define DEFUN(lname, Fname, min_args, max_args, prompt, arglist)        \
1480   Lisp_Object Fname (EXFUN_##max_args);                                 \
1481   static struct Lisp_Subr S##Fname =                                    \
1482   {                                                                     \
1483     { /* struct lrecord_header */                                       \
1484       lrecord_type_subr, /* lrecord_type_index */                       \
1485       1, /* mark bit */                                                 \
1486       1, /* c_readonly bit */                                           \
1487       1  /* lisp_readonly bit */                                        \
1488     },                                                                  \
1489     min_args,                                                           \
1490     max_args,                                                           \
1491     prompt,                                                             \
1492     0,  /* doc string */                                                \
1493     lname,                                                              \
1494     (lisp_fn_t) Fname                                                   \
1495   };                                                                    \
1496   Lisp_Object Fname (DEFUN_##max_args arglist)
1497
1498 /* Heavy ANSI C preprocessor hackery to get DEFUN to declare a
1499    prototype that matches max_args, and add the obligatory
1500    `Lisp_Object' type declaration to the formal C arguments.  */
1501
1502 #define DEFUN_MANY(named_int, named_Lisp_Object) named_int, named_Lisp_Object
1503 #define DEFUN_UNEVALLED(args) Lisp_Object args
1504 #define DEFUN_0() void
1505 #define DEFUN_1(a)                                      Lisp_Object a
1506 #define DEFUN_2(a,b)             DEFUN_1(a),            Lisp_Object b
1507 #define DEFUN_3(a,b,c)           DEFUN_2(a,b),          Lisp_Object c
1508 #define DEFUN_4(a,b,c,d)         DEFUN_3(a,b,c),        Lisp_Object d
1509 #define DEFUN_5(a,b,c,d,e)       DEFUN_4(a,b,c,d),      Lisp_Object e
1510 #define DEFUN_6(a,b,c,d,e,f)     DEFUN_5(a,b,c,d,e),    Lisp_Object f
1511 #define DEFUN_7(a,b,c,d,e,f,g)   DEFUN_6(a,b,c,d,e,f),  Lisp_Object g
1512 #define DEFUN_8(a,b,c,d,e,f,g,h) DEFUN_7(a,b,c,d,e,f,g),Lisp_Object h
1513
1514 /* WARNING: If you add defines here for higher values of max_args,
1515    make sure to also fix the clauses in PRIMITIVE_FUNCALL(),
1516    and change the define of SUBR_MAX_ARGS above.  */
1517
1518 #include "symeval.h"
1519
1520 /* `specpdl' is the special binding/unwind-protect stack.
1521
1522    Knuth says (see the Jargon File):
1523    At MIT, `pdl' [abbreviation for `Push Down List'] used to
1524    be a more common synonym for `stack'.
1525    Everywhere else `stack' seems to be the preferred term.
1526
1527    specpdl_depth is the current depth of `specpdl'.
1528    Save this for use later as arg to `unbind_to'.  */
1529 extern int specpdl_depth_counter;
1530 #define specpdl_depth() specpdl_depth_counter
1531
1532 #define CHECK_FUNCTION(fun) do {                \
1533  while (NILP (Ffunctionp (fun)))                \
1534    signal_invalid_function_error (fun);         \
1535  } while (0)
1536 \f
1537 /************************************************************************/
1538 /*                         Checking for QUIT                            */
1539 /************************************************************************/
1540
1541 /* Asynchronous events set something_happened, and then are processed
1542    within the QUIT macro.  At this point, we are guaranteed to not be in
1543    any sensitive code. */
1544
1545 extern volatile int something_happened;
1546 int check_what_happened(void);
1547
1548 extern volatile int quit_check_signal_happened;
1549 extern volatile int quit_check_signal_tick_count;
1550 int check_quit(void);
1551
1552 void signal_quit(void);
1553
1554 /* Nonzero if ought to quit now.  */
1555 #define QUITP                                                   \
1556   ((quit_check_signal_happened ? check_quit () : 0),            \
1557    (!NILP (Vquit_flag) && (NILP (Vinhibit_quit)                 \
1558                            || EQ (Vquit_flag, Qcritical))))
1559
1560 /* QUIT used to call QUITP, but there are some places where QUITP
1561    is called directly, and check_what_happened() should only be called
1562    when Emacs is actually ready to quit because it could do things
1563    like switch threads. */
1564 #define INTERNAL_QUITP                                          \
1565   ((something_happened ? check_what_happened () : 0),           \
1566    (!NILP (Vquit_flag) &&                                       \
1567     (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1568
1569 #define INTERNAL_REALLY_QUITP                                   \
1570   (check_what_happened (),                                      \
1571    (!NILP (Vquit_flag) &&                                       \
1572     (NILP (Vinhibit_quit) || EQ (Vquit_flag, Qcritical))))
1573
1574 /* Check quit-flag and quit if it is non-nil.  Also do any other things
1575    that might have gotten queued until it was safe. */
1576 #define QUIT do { if (INTERNAL_QUITP) signal_quit (); } while (0)
1577
1578 #define REALLY_QUIT do { if (INTERNAL_REALLY_QUITP) signal_quit (); } while (0)
1579 \f
1580 /************************************************************************/
1581 /*                               hashing                                */
1582 /************************************************************************/
1583 typedef long unsigned int hcode_t;
1584
1585 /* #### for a 64-bit machine, we should substitute a prime just over 2^32 */
1586 #define GOOD_HASH 65599         /* prime number just over 2^16; Dragon book, p. 435 */
1587 #define HASH2(a,b)               (GOOD_HASH * (a)                     + (b))
1588 #define HASH3(a,b,c)             (GOOD_HASH * HASH2 (a,b)             + (c))
1589 #define HASH4(a,b,c,d)           (GOOD_HASH * HASH3 (a,b,c)           + (d))
1590 #define HASH5(a,b,c,d,e)         (GOOD_HASH * HASH4 (a,b,c,d)         + (e))
1591 #define HASH6(a,b,c,d,e,f)       (GOOD_HASH * HASH5 (a,b,c,d,e)       + (f))
1592 #define HASH7(a,b,c,d,e,f,g)     (GOOD_HASH * HASH6 (a,b,c,d,e,f)     + (g))
1593 #define HASH8(a,b,c,d,e,f,g,h)   (GOOD_HASH * HASH7 (a,b,c,d,e,f,g)   + (h))
1594 #define HASH9(a,b,c,d,e,f,g,h,i) (GOOD_HASH * HASH8 (a,b,c,d,e,f,g,h) + (i))
1595
1596 #define LISP_HASH(obj) ((hcode_t)LISP_TO_VOID(obj))
1597 hcode_t string_hash(const char *xv);
1598 hcode_t memory_hash(const void *xv, size_t size);
1599 hcode_t internal_hash(const Lisp_Object obj, int depth);
1600 hcode_t internal_array_hash(const Lisp_Object *arr, size_t size, int depth);
1601 \f
1602 /************************************************************************/
1603 /*                       String translation                             */
1604 /************************************************************************/
1605
1606 #ifdef I18N3
1607 #ifdef HAVE_LIBINTL_H
1608 #include <libintl.h>
1609 #else
1610 char *dgettext(const char *, const char *);
1611 char *gettext(const char *);
1612 char *textdomain(const char *);
1613 char *bindtextdomain(const char *, const char *);
1614 #endif                          /* HAVE_LIBINTL_H */
1615
1616 #define GETTEXT(x)  gettext(x)
1617 #define LISP_GETTEXT(x)  Fgettext (x)
1618 #else                           /* !I18N3 */
1619 #define GETTEXT(x)  (x)
1620 #define LISP_GETTEXT(x)  (x)
1621 #endif                          /* !I18N3 */
1622
1623 /* DEFER_GETTEXT is used to identify strings which are translated when
1624    they are referenced instead of when they are defined.
1625    These include Qerror_messages and initialized arrays of strings.
1626 */
1627 #define DEFER_GETTEXT(x) (x)
1628 \f
1629 /************************************************************************/
1630 /*                   Garbage collection / GC-protection                 */
1631 /************************************************************************/
1632
1633 #include "dllist.h"
1634 #if (defined EF_USE_POM || defined EF_USE_ASYNEQ) &&    \
1635         !(defined HAVE_BDWGC && defined EF_USE_BDWGC)
1636 #include "semaphore.h"
1637 extern sxe_mutex_t cons_mutex;
1638
1639 extern_inline void
1640 lock_allocator(void)
1641         __attribute__((always_inline));
1642 extern_inline void
1643 lock_allocator(void)
1644 {
1645         SXE_DEBUG_GC_PT("locking cons mutex.\n");
1646         SXE_MUTEX_LOCK(&cons_mutex);
1647 }
1648
1649 extern_inline void
1650 unlock_allocator(void)
1651         __attribute__((always_inline));
1652 extern_inline void
1653 unlock_allocator(void)
1654 {
1655         SXE_DEBUG_GC_PT("unlocking cons mutex.\n");
1656         SXE_MUTEX_UNLOCK(&cons_mutex);
1657 }
1658
1659 #else  /* !EF_USE_POM || !BDWGC */
1660
1661 extern_inline void
1662 lock_allocator(void)
1663         __attribute__((always_inline));
1664 extern_inline void
1665 lock_allocator(void)
1666 {
1667 }
1668
1669 extern_inline void
1670 unlock_allocator(void)
1671         __attribute__((always_inline));
1672 extern_inline void
1673 unlock_allocator(void)
1674 {
1675 }
1676 #endif
1677
1678 /* number of bytes of structure consed since last GC */
1679
1680 extern EMACS_INT consing_since_gc;
1681
1682 /* threshold for doing another gc */
1683
1684 extern Fixnum gc_cons_threshold;
1685
1686 /* Structure for recording stack slots that need marking */
1687
1688 /* This is a chain of structures, each of which points at a Lisp_Object
1689    variable whose value should be marked in garbage collection.
1690    Normally every link of the chain is an automatic variable of a function,
1691    and its `val' points to some argument or local variable of the function.
1692    On exit to the function, the chain is set back to the value it had on
1693    entry.  This way, no link remains in the chain when the stack frame
1694    containing the link disappears.
1695
1696    Every function that can call Feval must protect in this fashion all
1697    Lisp_Object variables whose contents will be used again. */
1698
1699 extern struct gcpro *gcprolist;
1700
1701 struct gcpro {
1702         struct gcpro *next;
1703         Lisp_Object *var;       /* Address of first protected variable */
1704         int nvars;              /* Number of consecutive protected variables */
1705 };
1706
1707 #if defined(EF_USE_ASYNEQ)
1708 #include "events/workers.h"
1709
1710 extern void init_threads(int, sxe_thread_f);
1711 extern void fini_threads(int);
1712 extern dllist_t workers;
1713
1714 extern_inline struct gcpro *_get_gcprolist(void);
1715 extern_inline void _set_gcprolist(struct gcpro *provar);
1716
1717 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
1718 extern_inline struct gcpro*
1719 _get_gcprolist(void)
1720 {
1721         return NULL;
1722 }
1723
1724 extern_inline void
1725 _set_gcprolist(struct gcpro *provar)
1726 {
1727         return;
1728 }
1729
1730 #else  /* !BDWGC */
1731
1732 extern_inline struct gcpro*
1733 _get_gcprolist(void)
1734 {
1735         WITH_DLLIST_TRAVERSE(
1736                 workers,
1737                 eq_worker_t eqw = dllist_item;
1738                 sxe_thread_t me = pthread_self();
1739                 if (eq_worker_thread(eqw) == me) {
1740                         RETURN_FROM_DLLIST_TRAVERSE(
1741                                 workers, eq_worker_gcprolist(eqw));
1742                 });
1743         return NULL;
1744 }
1745
1746 extern_inline void
1747 _set_gcprolist(struct gcpro *provar)
1748 {
1749         WITH_DLLIST_TRAVERSE(
1750                 workers,
1751                 eq_worker_t eqw = dllist_item;
1752                 sxe_thread_t me = pthread_self();
1753                 if (eq_worker_thread(eqw) == me) {
1754                         eq_worker_gcprolist(eqw) = provar;
1755                         RETURN_FROM_DLLIST_TRAVERSE(workers, );
1756                 });
1757         return;
1758 }
1759 #endif  /* BDWGC */
1760
1761 #else  /* !EF_USE_ASYNEQ */
1762
1763 #define _get_gcprolist()        gcprolist
1764 #define _set_gcprolist(_var)    gcprolist = (_var)
1765
1766 #endif  /* EF_USE_ASYNEQ */
1767
1768 /* Normally, you declare variables gcpro1, gcpro2, ... and use the
1769    GCPROn() macros.  However, if you need to have nested gcpro's,
1770    declare ngcpro1, ngcpro2, ... and use NGCPROn().  If you need
1771    to nest another level, use nngcpro1, nngcpro2, ... and use
1772    NNGCPROn().  If you need to nest yet another level, create
1773    the appropriate macros. */
1774
1775 #if 1
1776 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
1777
1778 /* tricks to get over a myriad unused variable warnings */
1779 #define gcpro1          gcpro1 __attribute__((unused))
1780 #define gcpro2          gcpro2 __attribute__((unused))
1781 #define gcpro3          gcpro3 __attribute__((unused))
1782 #define gcpro4          gcpro4 __attribute__((unused))
1783 #define gcpro5          gcpro5 __attribute__((unused))
1784 #define gcpro6          gcpro6 __attribute__((unused))
1785 #define gcpro7          gcpro7 __attribute__((unused))
1786 #define gcpro8          gcpro8 __attribute__((unused))
1787
1788 #define ngcpro1         ngcpro1 __attribute__((unused))
1789 #define ngcpro2         ngcpro2 __attribute__((unused))
1790 #define ngcpro3         ngcpro3 __attribute__((unused))
1791 #define ngcpro4         ngcpro4 __attribute__((unused))
1792 #define ngcpro5         ngcpro5 __attribute__((unused))
1793 #define ngcpro6         ngcpro6 __attribute__((unused))
1794 #define ngcpro7         ngcpro7 __attribute__((unused))
1795 #define ngcpro8         ngcpro8 __attribute__((unused))
1796
1797 #define nngcpro1        nngcpro1 __attribute__((unused))
1798 #define nngcpro2        nngcpro2 __attribute__((unused))
1799 #define nngcpro3        nngcpro3 __attribute__((unused))
1800 #define nngcpro4        nngcpro4 __attribute__((unused))
1801 #define nngcpro5        nngcpro5 __attribute__((unused))
1802 #define nngcpro6        nngcpro6 __attribute__((unused))
1803 #define nngcpro7        nngcpro7 __attribute__((unused))
1804 #define nngcpro8        nngcpro8 __attribute__((unused))
1805
1806 #define GCPRO1(args...)
1807 #define GCPRO2(args...)
1808 #define GCPRO3(args...)
1809 #define GCPRO4(args...)
1810 #define GCPRO5(args...)
1811 #define GCPRO6(args...)
1812 #define GCPRO7(args...)
1813 #define GCPRO8(args...)
1814 #define GCPROn(args...)
1815 #define GCPRO1n(args...)
1816 #define GCPRO2n(args...)
1817 #define GCPRO3n(args...)
1818 #define GCPRO1nn(args...)
1819 #define UNGCPRO
1820
1821 #define NGCPRO1(args...)
1822 #define NGCPRO2(args...)
1823 #define NGCPRO3(args...)
1824 #define NGCPRO4(args...)
1825 #define NGCPRO5(args...)
1826 #define NGCPRO6(args...)
1827 #define NGCPRO7(args...)
1828 #define NGCPRO8(args...)
1829 #define NGCPROn(args...)
1830 #define NGCPRO1n(args...)
1831 #define NUNGCPRO
1832
1833 #define NNGCPRO1(args...)
1834 #define NNGCPRO2(args...)
1835 #define NNGCPRO3(args...)
1836 #define NNGCPRO4(args...)
1837 #define NNGCPRO5(args...)
1838 #define NNGCPRO6(args...)
1839 #define NNGCPRO7(args...)
1840 #define NNGCPRO8(args...)
1841 #define NNGCPROn(args...)
1842 #define NNUNGCPRO
1843
1844 #else  /* !BDWGC */
1845
1846 #define GCPRO1(var1)                                                    \
1847         ((void)(                                                        \
1848                 lock_allocator(),                                       \
1849                 gcpro1.next = _get_gcprolist(),                         \
1850                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1851                 _set_gcprolist(&gcpro1),                                \
1852                 unlock_allocator()))
1853
1854 #define GCPRO2(var1, var2)                                              \
1855         ((void)(                                                        \
1856                 lock_allocator(),                                       \
1857                 gcpro1.next = _get_gcprolist(),                         \
1858                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1859                 gcpro2.next = &gcpro1,                                  \
1860                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1861                 _set_gcprolist(&gcpro2),                                \
1862                 unlock_allocator()))
1863
1864 #define GCPRO3(var1, var2, var3)                                        \
1865         ((void)(                                                        \
1866                 lock_allocator(),                                       \
1867                 gcpro1.next = _get_gcprolist(),                         \
1868                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1869                 gcpro2.next = &gcpro1,                                  \
1870                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1871                 gcpro3.next = &gcpro2,                                  \
1872                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1873                 _set_gcprolist(&gcpro3),                                \
1874                 unlock_allocator()))
1875
1876 #define GCPRO4(var1, var2, var3, var4)                                  \
1877         ((void)(                                                        \
1878                 lock_allocator(),                                       \
1879                 gcpro1.next = _get_gcprolist(),                         \
1880                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1881                 gcpro2.next = &gcpro1,                                  \
1882                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1883                 gcpro3.next = &gcpro2,                                  \
1884                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1885                 gcpro4.next = &gcpro3,                                  \
1886                 gcpro4.var = &var4, gcpro4.nvars = 1,                   \
1887                 _set_gcprolist(&gcpro4),                                \
1888                 unlock_allocator()))
1889
1890 #define GCPRO5(var1, var2, var3, var4, var5)                            \
1891         ((void)(                                                        \
1892                 lock_allocator(),                                       \
1893                 gcpro1.next = _get_gcprolist(),                         \
1894                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1895                 gcpro2.next = &gcpro1,                                  \
1896                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1897                 gcpro3.next = &gcpro2,                                  \
1898                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1899                 gcpro4.next = &gcpro3,                                  \
1900                 gcpro4.var = &var4, gcpro4.nvars = 1,                   \
1901                 gcpro5.next = &gcpro4,                                  \
1902                 gcpro5.var = &var5, gcpro5.nvars = 1,                   \
1903                 _set_gcprolist(&gcpro5),                                \
1904                 unlock_allocator()))
1905
1906 #define GCPRO6(var1, var2, var3, var4, var5, var6 )                     \
1907         ((void)(                                                        \
1908                 lock_allocator(),                                       \
1909                 gcpro1.next = _get_gcprolist(),                         \
1910                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1911                 gcpro2.next = &gcpro1,                                  \
1912                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1913                 gcpro3.next = &gcpro2,                                  \
1914                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1915                 gcpro4.next = &gcpro3,                                  \
1916                 gcpro4.var = &var4, gcpro4.nvars = 1,                   \
1917                 gcpro5.next = &gcpro4,                                  \
1918                 gcpro5.var = &var5, gcpro5.nvars = 1,                   \
1919                 gcpro6.next = &gcpro5,                                  \
1920                 gcpro6.var = &var6, gcpro6.nvars = 1,                   \
1921                 _set_gcprolist(&gcpro6),                                \
1922                 unlock_allocator()))
1923
1924 #define GCPRO7(var1, var2, var3, var4, var5, var6, var7)                \
1925         ((void)(                                                        \
1926                 lock_allocator(),                                       \
1927                 gcpro1.next = _get_gcprolist(),                         \
1928                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1929                 gcpro2.next = &gcpro1,                                  \
1930                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1931                 gcpro3.next = &gcpro2,                                  \
1932                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1933                 gcpro4.next = &gcpro3,                                  \
1934                 gcpro4.var = &var4, gcpro4.nvars = 1,                   \
1935                 gcpro5.next = &gcpro4,                                  \
1936                 gcpro5.var = &var5, gcpro5.nvars = 1,                   \
1937                 gcpro6.next = &gcpro5,                                  \
1938                 gcpro6.var = &var6, gcpro6.nvars = 1,                   \
1939                 gcpro7.next = &gcpro6,                                  \
1940                 gcpro7.var = &var7, gcpro7.nvars = 1,                   \
1941                 _set_gcprolist(&gcpro7),                                \
1942                 unlock_allocator()))
1943
1944 #define GCPRO8(var1, var2, var3, var4, var5, var6, var7, var8)          \
1945         ((void)(                                                        \
1946                 lock_allocator(),                                       \
1947                 gcpro1.next = _get_gcprolist(),                         \
1948                 gcpro1.var = &var1, gcpro1.nvars = 1,                   \
1949                 gcpro2.next = &gcpro1,                                  \
1950                 gcpro2.var = &var2, gcpro2.nvars = 1,                   \
1951                 gcpro3.next = &gcpro2,                                  \
1952                 gcpro3.var = &var3, gcpro3.nvars = 1,                   \
1953                 gcpro4.next = &gcpro3,                                  \
1954                 gcpro4.var = &var4, gcpro4.nvars = 1,                   \
1955                 gcpro5.next = &gcpro4,                                  \
1956                 gcpro5.var = &var5, gcpro5.nvars = 1,                   \
1957                 gcpro6.next = &gcpro5,                                  \
1958                 gcpro6.var = &var6, gcpro6.nvars = 1,                   \
1959                 gcpro7.next = &gcpro6,                                  \
1960                 gcpro7.var = &var7, gcpro7.nvars = 1,                   \
1961                 gcpro8.next = &gcpro7,                                  \
1962                 gcpro8.var = &var8, gcpro8.nvars = 1,                   \
1963                 _set_gcprolist(&gcpro8),                                \
1964                 unlock_allocator()))
1965
1966 #define GCPROn(_varp, _nvars)                   \
1967         ((void)(                                \
1968                 lock_allocator(),               \
1969                 gcpro1.next = _get_gcprolist(), \
1970                 gcpro1.var = _varp,             \
1971                 gcpro1.nvars = _nvars,          \
1972                 _set_gcprolist(&gcpro1),        \
1973                 unlock_allocator()))
1974
1975 #define GCPRO1n(_v1, _varp, _nvars)                                     \
1976         ((void)(                                                        \
1977                 lock_allocator(),                                       \
1978                 gcpro1.next = _get_gcprolist(),                         \
1979                 gcpro1.var = &_v1, gcpro1.nvars = 1,                    \
1980                 gcpro2.next = &gcpro1,                                  \
1981                 gcpro2.var = _varp, gcpro2.nvars = _nvars,              \
1982                 _set_gcprolist(&gcpro2),                                \
1983                 unlock_allocator()))
1984
1985 #define GCPRO2n(_v1, _v2, _varp, _nvars)                                \
1986         ((void)(                                                        \
1987                 lock_allocator(),                                       \
1988                 gcpro1.next = _get_gcprolist(),                         \
1989                 gcpro1.var = &_v1, gcpro1.nvars = 1,                    \
1990                 gcpro2.next = &gcpro1,                                  \
1991                 gcpro2.var = &_v2, gcpro2.nvars = 1,                    \
1992                 gcpro3.next = &gcpro2,                                  \
1993                 gcpro3.var = _varp, gcpro3.nvars = _nvars,              \
1994                 _set_gcprolist(&gcpro3),                                \
1995                 unlock_allocator()))
1996
1997 #define GCPRO3n(_v1, _v2, _v3, _varp, _nvars)                           \
1998         ((void)(                                                        \
1999                 lock_allocator(),                                       \
2000                 gcpro1.next = _get_gcprolist(),                         \
2001                 gcpro1.var = &_v1, gcpro1.nvars = 1,                    \
2002                 gcpro2.next = &gcpro1,                                  \
2003                 gcpro2.var = &_v2, gcpro2.nvars = 1,                    \
2004                 gcpro3.next = &gcpro2,                                  \
2005                 gcpro3.var = &_v3, gcpro3.nvars = 1,                    \
2006                 gcpro4.next = &gcpro3,                                  \
2007                 gcpro4.var = _varp, gcpro4.nvars = _nvars,              \
2008                 _set_gcprolist(&gcpro4),                                \
2009                 unlock_allocator()))
2010
2011 #define GCPRO1nn(_v1, _varp1, _nv1, _varp2, _nv2)                       \
2012         ((void)(                                                        \
2013                 lock_allocator(),                                       \
2014                 gcpro1.next = _get_gcprolist(),                         \
2015                 gcpro1.var = &_v1, gcpro1.nvars = 1,                    \
2016                 gcpro2.next = &gcpro1,                                  \
2017                 gcpro2.var = _varp1, gcpro2.nvars = _nv1,               \
2018                 gcpro3.next = &gcpro2,                                  \
2019                 gcpro3.var = _varp2, gcpro3.nvars = _nv2,               \
2020                 _set_gcprolist(&gcpro3),                                \
2021                 unlock_allocator()))
2022
2023 #define UNGCPRO                                         \
2024         ((void)(                                        \
2025                 lock_allocator(),                       \
2026                 _set_gcprolist(gcpro1.next),            \
2027                 unlock_allocator()))
2028
2029 #define NGCPRO1(var1)                                                   \
2030         ((void) (                                                       \
2031                 lock_allocator(),                                       \
2032                 ngcpro1.next = _get_gcprolist(),                        \
2033                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2034                 _set_gcprolist(&ngcpro1),                               \
2035                 unlock_allocator()))
2036
2037 #define NGCPRO2(var1, var2)                                             \
2038         ((void) (                                                       \
2039                 lock_allocator(),                                       \
2040                 ngcpro1.next = _get_gcprolist(),                        \
2041                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2042                 ngcpro2.next = &ngcpro1,                                \
2043                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2044                 _set_gcprolist(&ngcpro2),                               \
2045                 unlock_allocator()))
2046
2047 #define NGCPRO3(var1, var2, var3)                                       \
2048         ((void) (                                                       \
2049                 lock_allocator(),                                       \
2050                 ngcpro1.next = _get_gcprolist(),                        \
2051                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2052                 ngcpro2.next = &ngcpro1,                                \
2053                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2054                 ngcpro3.next = &ngcpro2,                                \
2055                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2056                 _set_gcprolist(&ngcpro3),                               \
2057                 unlock_allocator()))
2058
2059 #define NGCPRO4(var1, var2, var3, var4)                                 \
2060         ((void) (                                                       \
2061                 lock_allocator(),                                       \
2062                 ngcpro1.next = _get_gcprolist(),                        \
2063                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2064                 ngcpro2.next = &ngcpro1,                                \
2065                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2066                 ngcpro3.next = &ngcpro2,                                \
2067                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2068                 ngcpro4.next = &ngcpro3,                                \
2069                 ngcpro4.var = &var4, ngcpro4.nvars = 1,                 \
2070                 _set_gcprolist(&ngcpro4),                               \
2071                 unlock_allocator()))
2072
2073 #define NGCPRO5(var1, var2, var3, var4, var5)                           \
2074         ((void) (                                                       \
2075                 lock_allocator(),                                       \
2076                 ngcpro1.next = _get_gcprolist(),                        \
2077                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2078                 ngcpro2.next = &ngcpro1,                                \
2079                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2080                 ngcpro3.next = &ngcpro2,                                \
2081                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2082                 ngcpro4.next = &ngcpro3,                                \
2083                 ngcpro4.var = &var4, ngcpro4.nvars = 1,                 \
2084                 ngcpro5.next = &ngcpro4,                                \
2085                 ngcpro5.var = &var5, ngcpro5.nvars = 1,                 \
2086                 _set_gcprolist(&ngcpro5),                               \
2087                 unlock_allocator()))
2088
2089 #define NGCPRO6(var1, var2, var3, var4, var5, var6 )                    \
2090         ((void) (                                                       \
2091                 lock_allocator(),                                       \
2092                 ngcpro1.next = _get_gcprolist(),                        \
2093                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2094                 ngcpro2.next = &ngcpro1,                                \
2095                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2096                 ngcpro3.next = &ngcpro2,                                \
2097                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2098                 ngcpro4.next = &ngcpro3,                                \
2099                 ngcpro4.var = &var4, ngcpro4.nvars = 1,                 \
2100                 ngcpro5.next = &ngcpro4,                                \
2101                 ngcpro5.var = &var5, ngcpro5.nvars = 1,                 \
2102                 ngcpro6.next = &ngcpro5,                                \
2103                 ngcpro6.var = &var6, ngcpro6.nvars = 1,                 \
2104                 _set_gcprolist(&ngcpro6),                               \
2105                 unlock_allocator()))
2106
2107 #define NGCPRO7(var1, var2, var3, var4, var5, var6, var7)               \
2108         ((void) (                                                       \
2109                 lock_allocator(),                                       \
2110                 ngcpro1.next = _get_gcprolist(),                        \
2111                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2112                 ngcpro2.next = &ngcpro1,                                \
2113                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2114                 ngcpro3.next = &ngcpro2,                                \
2115                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2116                 ngcpro4.next = &ngcpro3,                                \
2117                 ngcpro4.var = &var4, ngcpro4.nvars = 1,                 \
2118                 ngcpro5.next = &ngcpro4,                                \
2119                 ngcpro5.var = &var5, ngcpro5.nvars = 1,                 \
2120                 ngcpro6.next = &ngcpro5,                                \
2121                 ngcpro6.var = &var6, ngcpro6.nvars = 1,                 \
2122                 ngcpro7.next = &ngcpro6,                                \
2123                 ngcpro7.var = &var7, ngcpro7.nvars = 1,                 \
2124                 _set_gcprolist(&ngcpro7),                               \
2125                 unlock_allocator()))
2126
2127 #define NGCPRO8(var1, var2, var3, var4, var5, var6, var7, var8)         \
2128         ((void) (                                                       \
2129                 lock_allocator(),                                       \
2130                 ngcpro1.next = _get_gcprolist(),                        \
2131                 ngcpro1.var = &var1, ngcpro1.nvars = 1,                 \
2132                 ngcpro2.next = &ngcpro1,                                \
2133                 ngcpro2.var = &var2, ngcpro2.nvars = 1,                 \
2134                 ngcpro3.next = &ngcpro2,                                \
2135                 ngcpro3.var = &var3, ngcpro3.nvars = 1,                 \
2136                 ngcpro4.next = &ngcpro3,                                \
2137                 ngcpro4.var = &var4, ngcpro4.nvars = 1,                 \
2138                 ngcpro5.next = &ngcpro4,                                \
2139                 ngcpro5.var = &var5, ngcpro5.nvars = 1,                 \
2140                 ngcpro6.next = &ngcpro5,                                \
2141                 ngcpro6.var = &var6, ngcpro6.nvars = 1,                 \
2142                 ngcpro7.next = &ngcpro6,                                \
2143                 ngcpro7.var = &var7, ngcpro7.nvars = 1,                 \
2144                 ngcpro8.next = &ngcpro7,                                \
2145                 ngcpro8.var = &var8, ngcpro8.nvars = 1,                 \
2146                 _set_gcprolist(&ngcpro8),                               \
2147                 unlock_allocator()))
2148
2149 #define NGCPROn(_varp, _nvars)                          \
2150         ((void)(                                        \
2151                 lock_allocator(),                       \
2152                 ngcpro1.next = _get_gcprolist(),        \
2153                 ngcpro1.var = _varp,                    \
2154                 ngcpro1.nvars = _nvars,                 \
2155                 _set_gcprolist(&ngcpro1),               \
2156                 unlock_allocator()))
2157
2158 #define NGCPRO1n(_v1, _varp, _nvars)                                    \
2159         ((void)(                                                        \
2160                 lock_allocator(),                                       \
2161                 ngcpro1.next = _get_gcprolist(),                        \
2162                 ngcpro1.var = &_v1, ngcpro1.nvars = 1,                  \
2163                 ngcpro2.next = &ngcpro1,                                \
2164                 ngcpro2.var = _varp, ngcpro2.nvars = _nvars,            \
2165                 _set_gcprolist(&ngcpro2),                               \
2166                 unlock_allocator()))
2167
2168 #define NUNGCPRO                                        \
2169         ((void) (                                       \
2170                 lock_allocator(),                       \
2171                 _set_gcprolist(ngcpro1.next),           \
2172                 unlock_allocator()))
2173
2174 #define NNGCPRO1(var1)                                                  \
2175         ((void) (                                                       \
2176                 lock_allocator(),                                       \
2177                 nngcpro1.next = _get_gcprolist(),                       \
2178                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2179                 _set_gcprolist(&nngcpro1),                              \
2180                 unlock_allocator()))
2181
2182 #define NNGCPRO2(var1, var2)                                            \
2183         ((void) (                                                       \
2184                 lock_allocator(),                                       \
2185                 nngcpro1.next = _get_gcprolist(),                       \
2186                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2187                 nngcpro2.next = &nngcpro1,                              \
2188                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2189                 _set_gcprolist(&nngcpro2),                              \
2190                 unlock_allocator()))
2191
2192 #define NNGCPRO3(var1, var2, var3)                                      \
2193         ((void) (                                                       \
2194                 lock_allocator(),                                       \
2195                 nngcpro1.next = _get_gcprolist(),                       \
2196                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2197                 nngcpro2.next = &nngcpro1,                              \
2198                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2199                 nngcpro3.next = &nngcpro2,                              \
2200                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2201                 _set_gcprolist(&nngcpro3),                              \
2202                 unlock_allocator()))
2203
2204 #define NNGCPRO4(var1, var2, var3, var4)                                \
2205         ((void) (                                                       \
2206                 lock_allocator(),                                       \
2207                 nngcpro1.next = _get_gcprolist(),                       \
2208                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2209                 nngcpro2.next = &nngcpro1,                              \
2210                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2211                 nngcpro3.next = &nngcpro2,                              \
2212                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2213                 nngcpro4.next = &nngcpro3,                              \
2214                 nngcpro4.var = &var4, nngcpro4.nvars = 1,               \
2215                 _set_gcprolist(&nngcpro4),                              \
2216                 unlock_allocator()))
2217
2218 #define NNGCPRO5(var1, var2, var3, var4, var5)                          \
2219         ((void) (                                                       \
2220                 lock_allocator(),                                       \
2221                 nngcpro1.next = _get_gcprolist(),                       \
2222                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2223                 nngcpro2.next = &nngcpro1,                              \
2224                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2225                 nngcpro3.next = &nngcpro2,                              \
2226                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2227                 nngcpro4.next = &nngcpro3,                              \
2228                 nngcpro4.var = &var4, nngcpro4.nvars = 1,               \
2229                 nngcpro5.next = &nngcpro4,                              \
2230                 nngcpro5.var = &var5, nngcpro5.nvars = 1,               \
2231                 _set_gcprolist(&nngcpro5),                              \
2232                 unlock_allocator()))
2233
2234 #define NNGCPRO6(var1, var2, var3, var4, var5, var6 )                   \
2235         ((void) (                                                       \
2236                 lock_allocator(),                                       \
2237                 nngcpro1.next = _get_gcprolist(),                       \
2238                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2239                 nngcpro2.next = &nngcpro1,                              \
2240                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2241                 nngcpro3.next = &nngcpro2,                              \
2242                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2243                 nngcpro4.next = &nngcpro3,                              \
2244                 nngcpro4.var = &var4, nngcpro4.nvars = 1,               \
2245                 nngcpro5.next = &nngcpro4,                              \
2246                 nngcpro5.var = &var5, nngcpro5.nvars = 1,               \
2247                 nngcpro6.next = &nngcpro5,                              \
2248                 nngcpro6.var = &var6, nngcpro6.nvars = 1,               \
2249                 _set_gcprolist(&nngcpro6),                              \
2250                 unlock_allocator()))
2251
2252 #define NNGCPRO7(var1, var2, var3, var4, var5, var6, var7)              \
2253         ((void) (                                                       \
2254                 lock_allocator(),                                       \
2255                 nngcpro1.next = _get_gcprolist(),                       \
2256                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2257                 nngcpro2.next = &nngcpro1,                              \
2258                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2259                 nngcpro3.next = &nngcpro2,                              \
2260                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2261                 nngcpro4.next = &nngcpro3,                              \
2262                 nngcpro4.var = &var4, nngcpro4.nvars = 1,               \
2263                 nngcpro5.next = &nngcpro4,                              \
2264                 nngcpro5.var = &var5, nngcpro5.nvars = 1,               \
2265                 nngcpro6.next = &nngcpro5,                              \
2266                 nngcpro6.var = &var6, nngcpro6.nvars = 1,               \
2267                 nngcpro7.next = &nngcpro6,                              \
2268                 nngcpro7.var = &var7, nngcpro7.nvars = 1,               \
2269                 _set_gcprolist(&nngcpro7),                              \
2270                 unlock_allocator()))
2271
2272 #define NNGCPRO8(var1, var2, var3, var4, var5, var6, var7, var8)        \
2273         ((void) (                                                       \
2274                 lock_allocator(),                                       \
2275                 nngcpro1.next = _get_gcprolist(),                       \
2276                 nngcpro1.var = &var1, nngcpro1.nvars = 1,               \
2277                 nngcpro2.next = &nngcpro1,                              \
2278                 nngcpro2.var = &var2, nngcpro2.nvars = 1,               \
2279                 nngcpro3.next = &nngcpro2,                              \
2280                 nngcpro3.var = &var3, nngcpro3.nvars = 1,               \
2281                 nngcpro4.next = &nngcpro3,                              \
2282                 nngcpro4.var = &var4, nngcpro4.nvars = 1,               \
2283                 nngcpro5.next = &nngcpro4,                              \
2284                 nngcpro5.var = &var5, nngcpro5.nvars = 1,               \
2285                 nngcpro6.next = &nngcpro5,                              \
2286                 nngcpro6.var = &var6, nngcpro6.nvars = 1,               \
2287                 nngcpro7.next = &nngcpro6,                              \
2288                 nngcpro7.var = &var7, nngcpro7.nvars = 1,               \
2289                 nngcpro8.next = &nngcpro7,                              \
2290                 nngcpro8.var = &var8, nngcpro8.nvars = 1,               \
2291                 _set_gcprolist(&nngcpro8),                              \
2292                 unlock_allocator()))
2293
2294 #define NNGCPROn(_varp, _nvars)                         \
2295         ((void)(                                        \
2296                 lock_allocator(),                       \
2297                 nngcpro1.next = _get_gcprolist(),       \
2298                 nngcpro1.var = _varp,                   \
2299                 nngcpro1.nvars = _nvars,                \
2300                 _set_gcprolist(&nngcpro1),              \
2301                 unlock_allocator()))
2302
2303 #define NNUNGCPRO                                       \
2304         ((void) (                                       \
2305                 lock_allocator(),                       \
2306                 _set_gcprolist(nngcpro1.next),          \
2307                 unlock_allocator()))
2308
2309 #endif  /* BDWGC */
2310
2311 #else /* defined(DEBUG_GCPRO) */
2312
2313 void debug_gcpro1(char *, int, struct gcpro *, Lisp_Object *);
2314 void debug_gcpro2(char *, int, struct gcpro *, struct gcpro *,
2315                   Lisp_Object *, Lisp_Object *);
2316 void debug_gcpro3(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2317                   Lisp_Object *, Lisp_Object *, Lisp_Object *);
2318 void debug_gcpro4(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2319                   struct gcpro *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
2320                   Lisp_Object *);
2321 void debug_gcpro5(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2322                   struct gcpro *, struct gcpro *, Lisp_Object *, Lisp_Object *,
2323                   Lisp_Object *, Lisp_Object *, Lisp_Object *);
2324 void debug_gcpro6(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2325                   struct gcpro *, struct gcpro *, struct gcpro *, Lisp_Object *,
2326                   Lisp_Object *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
2327                   Lisp_Object *);
2328 void debug_gcpro7(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2329                   struct gcpro *, struct gcpro *, struct gcpro *, struct gcpro *,
2330                   Lisp_Object *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
2331                   Lisp_Object *, Lisp_Object *, Lisp_Object *);
2332 void debug_gcpro8(char *, int, struct gcpro *, struct gcpro *, struct gcpro *,
2333                   struct gcpro *, struct gcpro *, struct gcpro *, struct gcpro *,
2334                   struct gcpro *, Lisp_Object *, Lisp_Object *,
2335                   Lisp_Object *, Lisp_Object *, Lisp_Object *, Lisp_Object *,
2336                   Lisp_Object *, Lisp_Object *);
2337 void debug_ungcpro(char *, int, struct gcpro *);
2338
2339 #define GCPRO1(v) \
2340  debug_gcpro1 (__FILE__, __LINE__,&gcpro1,&v)
2341 #define GCPRO2(v1,v2) \
2342  debug_gcpro2 (__FILE__, __LINE__,&gcpro1,&gcpro2,&v1,&v2)
2343 #define GCPRO3(v1,v2,v3) \
2344  debug_gcpro3 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&v1,&v2,&v3)
2345 #define GCPRO4(v1,v2,v3,v4) \
2346  debug_gcpro4 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,\
2347                &v1,&v2,&v3,&v4)
2348 #define GCPRO5(v1,v2,v3,v4,v5) \
2349  debug_gcpro5 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,\
2350                &v1,&v2,&v3,&v4,&v5)
2351 #define GCPRO6(v1,v2,v3,v4,v5,v6)                                         \
2352   debug_gcpro6 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,&gcpro6, \
2353                 &v1,&v2,&v3,&v4,&v5,&v6)
2354 #define GCPRO7(v1,v2,v3,v4,v5,v6,v7)                                      \
2355  debug_gcpro7 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,&gcpro6,&gcpro7,\
2356                &v1,&v2,&v3,&v4,&v5,&v6,&v7)
2357 #define GCPRO8(v1,v2,v3,v4,v5,v6,v7,v8)                                   \
2358   debug_gcpro8 (__FILE__, __LINE__,&gcpro1,&gcpro2,&gcpro3,&gcpro4,&gcpro5,&gcpro6,&gcpro7,&gcpro8, \
2359                 &v1,&v2,&v3,&v4,&v5,&v6,&v7,&v8)
2360 #define UNGCPRO \
2361  debug_ungcpro(__FILE__, __LINE__,&gcpro1)
2362
2363 #define NGCPRO1(v) \
2364  debug_gcpro1 (__FILE__, __LINE__,&ngcpro1,&v)
2365 #define NGCPRO2(v1,v2) \
2366  debug_gcpro2 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&v1,&v2)
2367 #define NGCPRO3(v1,v2,v3) \
2368  debug_gcpro3 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&v1,&v2,&v3)
2369 #define NGCPRO4(v1,v2,v3,v4) \
2370  debug_gcpro4 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
2371                &v1,&v2,&v3,&v4)
2372 #define NGCPRO5(v1,v2,v3,v4,v5) \
2373  debug_gcpro5 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,\
2374                &ngcpro5,&v1,&v2,&v3,&v4,&v5)
2375 #define NGCPRO6(v1,v2,v3,v4,v5,v6)                                         \
2376   debug_gcpro6 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,&ngcpro5,&ngcpro6, \
2377                 &v1,&v2,&v3,&v4,&v5,&v6)
2378 #define NGCPRO7(v1,v2,v3,v4,v5,v6,v7)                                     \
2379  debug_gcpro7 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,&ngcpro5,&ngcpro6,&ngcpro7,\
2380                &v1,&v2,&v3,&v4,&v5,&v6,&v7)
2381 #define NGCPRO8(v1,v2,v3,v4,v5,v6,v7,v8)                                  \
2382   debug_gcpro8 (__FILE__, __LINE__,&ngcpro1,&ngcpro2,&ngcpro3,&ngcpro4,&ngcpro5,&ngcpro6,&ngcpro7,&ngcpro8, \
2383                 &v1,&v2,&v3,&v4,&v5,&v6,&v7,&v8)
2384 #define NUNGCPRO \
2385  debug_ungcpro(__FILE__, __LINE__,&ngcpro1)
2386
2387 #define NNGCPRO1(v) \
2388  debug_gcpro1 (__FILE__, __LINE__,&nngcpro1,&v)
2389 #define NNGCPRO2(v1,v2) \
2390  debug_gcpro2 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&v1,&v2)
2391 #define NNGCPRO3(v1,v2,v3) \
2392  debug_gcpro3 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&v1,&v2,&v3)
2393 #define NNGCPRO4(v1,v2,v3,v4) \
2394  debug_gcpro4 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
2395                &v1,&v2,&v3,&v4)
2396 #define NNGCPRO5(v1,v2,v3,v4,v5) \
2397  debug_gcpro5 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,\
2398                &nngcpro5,&v1,&v2,&v3,&v4,&v5)
2399 #define NNGCPRO6(v1,v2,v3,v4,v5,v6)                                         \
2400   debug_gcpro6 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,&nngcpro5,&nngcpro6, \
2401                 &v1,&v2,&v3,&v4,&v5,&v6)
2402 #define NNGCPRO7(v1,v2,v3,v4,v5,v6,v7)                                    \
2403  debug_gcpro7 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,&nngcpro5,&nngcpro6,&nngcpro7,\
2404                &v1,&v2,&v3,&v4,&v5,&v6,&v7)
2405 #define NNGCPRO8(v1,v2,v3,v4,v5,v6,v7,v8)                                 \
2406   debug_gcpro8 (__FILE__, __LINE__,&nngcpro1,&nngcpro2,&nngcpro3,&nngcpro4,&nngcpro5,&nngcpro6,&nngcpro7,&nngcpro8, \
2407                 &v1,&v2,&v3,&v4,&v5,&v6,&v7,&v8)
2408 #define NNUNGCPRO \
2409  debug_ungcpro(__FILE__, __LINE__,&nngcpro1)
2410
2411 #endif                          /* DEBUG_GCPRO */
2412
2413 /* Another try to fix SunPro C compiler warnings */
2414 /* "end-of-loop code not reached" */
2415 /* "statement not reached */
2416 #if defined __SUNPRO_C || defined __USLC__
2417 #define RETURN_SANS_WARNINGS if (1) return
2418 #define RETURN_NOT_REACHED(value)
2419 #else
2420 #define RETURN_SANS_WARNINGS return
2421 #define RETURN_NOT_REACHED(value) return value;
2422 #endif
2423
2424 /* Evaluate expr, UNGCPRO, and then return the value of expr.  */
2425 #define RETURN_UNGCPRO(expr)                            \
2426         do {                                            \
2427                 Lisp_Object ret_ungc_val = (expr);      \
2428                 UNGCPRO;                                \
2429                 RETURN_SANS_WARNINGS ret_ungc_val;      \
2430         } while (0)
2431
2432 /* Evaluate expr, NUNGCPRO, UNGCPRO, and then return the value of expr.  */
2433 #define RETURN_NUNGCPRO(expr)                           \
2434         do {                                            \
2435                 Lisp_Object ret_ungc_val = (expr);      \
2436                 NUNGCPRO;                               \
2437                 UNGCPRO;                                \
2438                 RETURN_SANS_WARNINGS ret_ungc_val;      \
2439         } while (0)
2440
2441 /* Evaluate expr, NNUNGCPRO, NUNGCPRO, UNGCPRO, and then return the
2442    value of expr.  */
2443 #define RETURN_NNUNGCPRO(expr)                          \
2444         do {                                            \
2445                 Lisp_Object ret_ungc_val = (expr);      \
2446                 NNUNGCPRO;                              \
2447                 NUNGCPRO;                               \
2448                 UNGCPRO;                                \
2449                 RETURN_SANS_WARNINGS ret_ungc_val;      \
2450         } while (0)
2451
2452 /* Evaluate expr, return it if it's not Qunbound. */
2453 #define RETURN_IF_NOT_UNBOUND(expr)     \
2454         do {                                                    \
2455                 Lisp_Object ret_nunb_val = (expr);              \
2456                 if (!UNBOUNDP (ret_nunb_val))                   \
2457                         RETURN_SANS_WARNINGS ret_nunb_val;      \
2458         } while (0)
2459
2460 void register_post_gc_action(void (*fun) (void *), void *arg);
2461
2462 /* Call staticpro (&var) to protect static variable `var'. */
2463 void staticpro(Lisp_Object *);
2464
2465 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
2466 #define staticpro_nodump(foo)
2467 #else
2468 /* Call staticpro_nodump (&var) to protect static variable `var'. */
2469 /* var will not be saved at dump time */
2470 void staticpro_nodump(Lisp_Object *);
2471 #endif  /* BDWGC */
2472
2473 /* allocation goodies */
2474 #include "opaque.h"
2475
2476 static inline EMACS_INT
2477 __attribute__((always_inline))
2478 __next_2power(EMACS_INT v)
2479 {
2480 /* compute the next 2-power of in */
2481         v--;
2482         v |= v >> 1;
2483         v |= v >> 2;
2484         v |= v >> 4;
2485         v |= v >> 8;
2486 #if SIZEOF_EMACS_INT >= 4
2487         v |= v >> 16;
2488 #endif  /* sizeof(EMACS_INT) >= 4 */
2489 #if SIZEOF_EMACS_INT >= 8
2490         v |= v >> 32;
2491 #endif  /* sizeof(EMACS_INT) >= 8 */
2492 #if SIZEOF_EMACS_INT >= 16
2493         v |= v >> 64;
2494 #endif  /* sizeof(EMACS_INT) >= 16 */
2495         v++;
2496         return v;
2497 }
2498
2499 /* also generally useful if you want to avoid arbitrary size limits
2500    but don't need a full dynamic array.  Assumes that BASEVAR points
2501    to a malloced array of TYPE objects (or possibly a NULL pointer,
2502    if SIZEVAR is 0), with the total size stored in SIZEVAR.  This
2503    macro will realloc BASEVAR as necessary so that it can hold at
2504    least NEEDED_SIZE objects.  The reallocing is done by doubling,
2505    which ensures constant amortized time per element. */
2506 static inline EMACS_INT
2507 __attribute__((always_inline))
2508 __alloc_size(EMACS_INT sz, EMACS_INT needed)
2509 {
2510         if (UNLIKELY(needed <= 32)) {
2511                 return 32;
2512         }
2513         return __next_2power(needed);
2514 }
2515
2516 #define DO_REALLOC(basevar, sizevar, needed_size, type)                 \
2517         do {                                                            \
2518                 EMACS_INT cache_needed_size = (needed_size);            \
2519                 if (LIKELY((sizevar) >= cache_needed_size)) {           \
2520                         break;                                          \
2521                 }                                                       \
2522                 (sizevar) = __alloc_size((sizevar), cache_needed_size); \
2523                 if (UNLIKELY((basevar) == NULL)) {                      \
2524                         (basevar) = xnew_array(type, (sizevar));        \
2525                 } else {                                                \
2526                         xrealloc_array(basevar, type, (sizevar));       \
2527                 }                                                       \
2528         } while (0)
2529
2530 #define DO_REALLOC_ATOMIC(basevar, sizevar, needed_size, type)          \
2531         do {                                                            \
2532                 EMACS_INT cache_needed_size = (needed_size);            \
2533                 if (LIKELY((sizevar) >= cache_needed_size)) {           \
2534                         break;                                          \
2535                 }                                                       \
2536                 (sizevar) = __alloc_size((sizevar), cache_needed_size); \
2537                 if (UNLIKELY((basevar) == NULL)) {                      \
2538                         (basevar) = xnew_atomic_array(type, (sizevar)); \
2539                 } else {                                                \
2540                         xrealloc_array(basevar, type, (sizevar));       \
2541                 }                                                       \
2542         } while (0)
2543
2544 #if defined HAVE_BDWGC && defined EF_USE_BDWGC && !defined GC_DEBUG_FLAG
2545 #define free_me         __free_me __attribute__((unused))
2546 #endif
2547
2548 static inline Lisp_Object
2549 free_malloced_ptr(Lisp_Object unwind_obj)
2550 {
2551         void *free_me = (void*)get_opaque_ptr(unwind_obj);
2552         xfree(free_me);
2553         free_opaque_ptr(unwind_obj);
2554         return Qnil;
2555 }
2556
2557 /* Don't use alloca for regions larger than this, lest we overflow
2558    the stack.  */
2559 #define MAX_ALLOCA 65536
2560
2561 /* We need to setup proper unwinding, because there is a number of
2562    ways these functions can blow up, and we don't want to have memory
2563    leaks in those cases.  */
2564 #define XMALLOC_OR_ALLOCA(ptr, len, type)                               \
2565         do {                                                            \
2566                 size_t XOA_len = (len);                                 \
2567                 if (XOA_len > MAX_ALLOCA) {                             \
2568                         ptr = xnew_array(type, XOA_len);                \
2569                         record_unwind_protect(free_malloced_ptr,        \
2570                                               make_opaque_ptr((void*)ptr)); \
2571                 } else {                                                \
2572                         ptr = alloca_array(type, XOA_len);              \
2573                 }                                                       \
2574         } while (0)
2575
2576 #define XMALLOC_ATOMIC_OR_ALLOCA(ptr, len, type)                        \
2577         do {                                                            \
2578                 size_t XOA_len = (len);                                 \
2579                 if (XOA_len > MAX_ALLOCA) {                             \
2580                         ptr = xnew_atomic_array(type, XOA_len);         \
2581                         record_unwind_protect(free_malloced_ptr,        \
2582                                               make_opaque_ptr((void*)ptr)); \
2583                 } else {                                                \
2584                         ptr = alloca_array(type, XOA_len);              \
2585                 }                                                       \
2586         } while (0)
2587
2588 #define XMALLOC_UNBIND(ptr, len, speccount)                             \
2589         do {                                                            \
2590                 if ((len) > MAX_ALLOCA) {                               \
2591                         unbind_to (speccount, Qnil);                    \
2592                 }                                                       \
2593         } while (0)
2594
2595 \f
2596 /* dump_add_root_struct_ptr (&var, &desc) dumps the structure pointed to by `var'. */
2597 #ifdef PDUMP
2598 void dump_add_root_struct_ptr(void *, const struct struct_description *);
2599 #else
2600 #define dump_add_root_struct_ptr(varaddr,descaddr) DO_NOTHING
2601 #endif
2602
2603 /* dump_add_opaque (&var, size) dumps the opaque static structure `var'. */
2604 #ifdef PDUMP
2605 void dump_add_opaque(void *, size_t);
2606 #else
2607 #define dump_add_opaque(varaddr,size) DO_NOTHING
2608 #endif
2609
2610 /* Call dump_add_opaque_int (&int_var) to dump `int_var', of type `int'. */
2611 #ifdef PDUMP
2612 #define dump_add_opaque_int(int_varaddr) do {   \
2613   int *dao_ = (int_varaddr); /* type check */   \
2614   dump_add_opaque (dao_, sizeof (*dao_));       \
2615 } while (0)
2616 #else
2617 #define dump_add_opaque_int(int_varaddr) DO_NOTHING
2618 #endif
2619
2620 /* Call dump_add_opaque_fixnum (&fixnum_var) to dump `fixnum_var', of type `Fixnum'. */
2621 #ifdef PDUMP
2622 #define dump_add_opaque_fixnum(fixnum_varaddr) do {     \
2623   Fixnum *dao_ = (fixnum_varaddr); /* type check */     \
2624   dump_add_opaque (dao_, sizeof (*dao_));               \
2625 } while (0)
2626 #else
2627 #define dump_add_opaque_fixnum(fixnum_varaddr) DO_NOTHING
2628 #endif
2629
2630 /* Call dump_add_root_object (&var) to ensure that var is properly updated after pdump. */
2631 #ifdef PDUMP
2632 void dump_add_root_object(Lisp_Object *);
2633 #else
2634 #define dump_add_root_object(varaddr) DO_NOTHING
2635 #endif
2636
2637 /* Call dump_add_root_object (&var) to ensure that var is properly updated after
2638    pdump.  var must point to a linked list of objects out of which
2639    some may not be dumped */
2640 #ifdef PDUMP
2641 void dump_add_weak_object_chain(Lisp_Object *);
2642 #else
2643 #define dump_add_weak_object_chain(varaddr) DO_NOTHING
2644 #endif
2645
2646 /* Nonzero means Emacs has already been initialized.
2647    Used during startup to detect startup of dumped Emacs.  */
2648 extern int initialized;
2649
2650 #ifdef MEMORY_USAGE_STATS
2651
2652 /* This structure is used to keep statistics on the amount of memory
2653    in use.
2654
2655    WAS_REQUESTED stores the actual amount of memory that was requested
2656    of the allocation function.  The *_OVERHEAD fields store the
2657    additional amount of memory that was grabbed by the functions to
2658    facilitate allocation, reallocation, etc.  MALLOC_OVERHEAD is for
2659    memory allocated with malloc(); DYNARR_OVERHEAD is for dynamic
2660    arrays; GAP_OVERHEAD is for gap arrays.  Note that for (e.g.)
2661    dynamic arrays, there is both MALLOC_OVERHEAD and DYNARR_OVERHEAD
2662    memory: The dynamic array allocates memory above and beyond what
2663    was asked of it, and when it in turns allocates memory using
2664    malloc(), malloc() allocates memory beyond what it was asked
2665    to allocate.
2666
2667    Functions that accept a structure of this sort do not initialize
2668    the fields to 0, and add any existing values to whatever was there
2669    before; this way, you can get a cumulative effect. */
2670
2671 struct overhead_stats {
2672         int was_requested;
2673         int malloc_overhead;
2674         int dynarr_overhead;
2675         int gap_overhead;
2676 };
2677
2678 #endif                          /* MEMORY_USAGE_STATS */
2679
2680 #ifndef DIRECTORY_SEP
2681 #define DIRECTORY_SEP '/'
2682 #endif
2683 #ifndef IS_DIRECTORY_SEP
2684 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
2685 #endif
2686 #ifndef IS_DEVICE_SEP
2687 #ifndef DEVICE_SEP
2688 #define IS_DEVICE_SEP(c) 0
2689 #else
2690 #define IS_DEVICE_SEP(c) ((c) == DEVICE_SEP)
2691 #endif
2692 #endif
2693 #ifndef IS_ANY_SEP
2694 #define IS_ANY_SEP(c) IS_DIRECTORY_SEP (c)
2695 #endif
2696
2697 #ifdef HAVE_INTTYPES_H
2698 #include <inttypes.h>
2699 #elif SIZEOF_VOID_P == SIZEOF_INT
2700 typedef int intptr_t;
2701 typedef unsigned int uintptr_t;
2702 #elif SIZEOF_VOID_P == SIZEOF_LONG
2703 typedef long intptr_t;
2704 typedef unsigned long uintptr_t;
2705 #elif SIZEOF_VOID_P == SIZEOF_LONG_LONG_INT
2706 typedef long long intptr_t;
2707 typedef unsigned long long uintptr_t;
2708 #else
2709 /* Just pray. May break, may not. */
2710 typedef long intptr_t;
2711 typedef unsigned long uintptr_t;
2712 #endif
2713 \f
2714 /************************************************************************/
2715 /*                            Misc definitions                  */
2716 /************************************************************************/
2717 #include "dllist.h"
2718 \f
2719 /************************************************************************/
2720 /*                           Other numeric types                        */
2721 /************************************************************************/
2722
2723 /* more allocation goodies, C99 wise */
2724 extern size_t sys_stk_sz;
2725 extern char *stack_bottom;
2726 extern_inline size_t
2727 __sys_stk_free(void)
2728         __attribute__((always_inline));
2729 extern_inline size_t
2730 __sys_stk_free(void)
2731 {
2732         char probe;
2733         return sys_stk_sz - (stack_bottom - &probe);
2734 }
2735
2736 \f
2737 /************************************************************************/
2738 /*                              prototypes                              */
2739 /************************************************************************/
2740
2741 /* NOTE: Prototypes should go HERE, not in various header files, unless
2742    they specifically reference a type that's not defined in lisp.h.
2743    (And even then, you might consider adding the type to lisp.h.)
2744
2745    The idea is that header files typically contain the innards of objects,
2746    and we want to minimize the number of "dependencies" of one file on
2747    the specifics of such objects.  Putting prototypes here minimizes the
2748    number of header files that need to be included -- good for a number
2749    of reasons. --ben */
2750
2751 /*--------------- prototypes for various public c functions ------------*/
2752
2753 /* Prototypes for all init/syms_of/vars_of initialization functions. */
2754 #include "symsinit.h"
2755
2756 /* Defined in alloc.c */
2757 void release_breathing_space(void);
2758 Lisp_Object noseeum_cons(Lisp_Object, Lisp_Object);
2759 Lisp_Object make_vector(size_t, Lisp_Object);
2760 Lisp_Object vector1(Lisp_Object);
2761 Lisp_Object vector2(Lisp_Object, Lisp_Object);
2762 Lisp_Object vector3(Lisp_Object, Lisp_Object, Lisp_Object);
2763 Lisp_Object make_bit_vector(size_t, Lisp_Object);
2764 Lisp_Object make_bit_vector_from_byte_vector(unsigned char *, size_t);
2765 Lisp_Object noseeum_make_marker(void);
2766 void garbage_collect_1(void);
2767 Lisp_Object acons(Lisp_Object, Lisp_Object, Lisp_Object);
2768 Lisp_Object cons3(Lisp_Object, Lisp_Object, Lisp_Object);
2769 Lisp_Object list1(Lisp_Object);
2770 Lisp_Object list2(Lisp_Object, Lisp_Object);
2771 Lisp_Object list3(Lisp_Object, Lisp_Object, Lisp_Object);
2772 Lisp_Object list4(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
2773 Lisp_Object list5(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2774                   Lisp_Object);
2775 Lisp_Object list6(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
2776                   Lisp_Object, Lisp_Object);
2777 DECLARE_DOESNT_RETURN(memory_full(void));
2778 void disksave_object_finalization(void);
2779 extern int purify_flag;
2780 extern int gc_currently_forbidden;
2781 Lisp_Object restore_gc_inhibit(Lisp_Object);
2782 extern EMACS_INT gc_generation_number[1];
2783 int c_readonly(Lisp_Object);
2784 int lisp_readonly(Lisp_Object);
2785 Lisp_Object build_string(const char *);
2786 Lisp_Object build_ext_string(const char*, Lisp_Object);
2787 Lisp_Object build_translated_string(const char*);
2788 Lisp_Object make_string(const Bufbyte*, Bytecount);
2789 Lisp_Object make_ext_string(const Extbyte*, EMACS_INT, Lisp_Object);
2790 Lisp_Object make_uninit_string(Bytecount);
2791 Lisp_Object make_string_nocopy(Bufbyte*, Bytecount);
2792 void free_cons(Lisp_Cons *);
2793 void free_list(Lisp_Object);
2794 void free_alist(Lisp_Object);
2795 void mark_conses_in_list(Lisp_Object);
2796 void free_marker(Lisp_Marker *);
2797 int object_dead_p(Lisp_Object);
2798 void mark_object(Lisp_Object obj);
2799 int marked_p(Lisp_Object obj);
2800
2801 #ifdef MEMORY_USAGE_STATS
2802 size_t malloced_storage_size(void *, size_t, struct overhead_stats *);
2803 size_t fixed_type_block_overhead(size_t);
2804 #endif
2805 #ifdef PDUMP
2806 int pdump_load(const char *);
2807
2808 extern char *pdump_start, *pdump_end;
2809 #define DUMPEDP(adr) ((((char *)(adr)) < pdump_end) && (((char *)(adr)) >= pdump_start))
2810 #else
2811 #define DUMPEDP(adr) 0
2812 #endif
2813
2814 /* Defined in buffer.c */
2815 Lisp_Object make_buffer(struct buffer *);
2816 Lisp_Object get_truename_buffer(Lisp_Object);
2817 void switch_to_buffer(Lisp_Object, Lisp_Object);
2818 extern int find_file_compare_truenames;
2819 extern int find_file_use_truenames;
2820
2821 /* Defined in callproc.c */
2822 char *egetenv(const char *);
2823
2824 /* Defined in console.c */
2825 void stuff_buffered_input(Lisp_Object);
2826
2827 /* Defined in console-msw.c */
2828 EXFUN(Fmswindows_message_box, 3);
2829 extern int mswindows_message_outputted;
2830
2831 /* Defined in data.c */
2832 DECLARE_DOESNT_RETURN(c_write_error(Lisp_Object));
2833 DECLARE_DOESNT_RETURN(lisp_write_error(Lisp_Object));
2834 DECLARE_DOESNT_RETURN(args_out_of_range(Lisp_Object, Lisp_Object));
2835 DECLARE_DOESNT_RETURN(args_out_of_range_3(Lisp_Object, Lisp_Object,
2836                                           Lisp_Object));
2837 Lisp_Object wrong_type_argument(Lisp_Object, Lisp_Object);
2838 DECLARE_DOESNT_RETURN(dead_wrong_type_argument(Lisp_Object, Lisp_Object));
2839 void check_int_range(EMACS_INT, EMACS_INT, EMACS_INT);
2840
2841 #if 0
2842 /* superseded by ent-binary-rel stuff */
2843 enum arith_comparison {
2844         arith_equal,
2845         arith_notequal,
2846         arith_less,
2847         arith_grtr,
2848         arith_less_or_equal,
2849         arith_grtr_or_equal
2850 };
2851 Lisp_Object arithcompare(Lisp_Object, Lisp_Object, enum arith_comparison);
2852 #endif
2853
2854 /* Do NOT use word_to_lisp or wasteful_word_to_lisp to decode time_t's
2855    unless you KNOW arg is non-negative.  They cannot return negative
2856    values!  Use make_time.  */
2857 Lisp_Object word_to_lisp(unsigned int);
2858 unsigned int lisp_to_word(Lisp_Object);
2859
2860 /* Defined in dired.c */
2861 Lisp_Object make_directory_hash_table(const char *);
2862 Lisp_Object wasteful_word_to_lisp(unsigned int);
2863
2864 /* Defined in doc.c */
2865 Lisp_Object unparesseuxify_doc_string(int, EMACS_INT, char *, Lisp_Object);
2866 Lisp_Object read_doc_string(Lisp_Object);
2867
2868 /* Defined in doprnt.c */
2869 Bytecount emacs_doprnt_c(Lisp_Object, const Bufbyte *, Lisp_Object,
2870                          Bytecount, ...);
2871 Bytecount emacs_doprnt_va(Lisp_Object, const Bufbyte *, Lisp_Object,
2872                           Bytecount, va_list);
2873 Bytecount emacs_doprnt_lisp(Lisp_Object, const Bufbyte *, Lisp_Object,
2874                             Bytecount, int, const Lisp_Object *);
2875 Bytecount emacs_doprnt_lisp_2(Lisp_Object, const Bufbyte *, Lisp_Object,
2876                               Bytecount, int, ...);
2877 Lisp_Object emacs_doprnt_string_c(const Bufbyte *, Lisp_Object, Bytecount, ...);
2878 Lisp_Object emacs_doprnt_string_va(const Bufbyte *, Lisp_Object,
2879                                    Bytecount, va_list);
2880 Lisp_Object emacs_doprnt_string_lisp(const Bufbyte *, Lisp_Object,
2881                                      Bytecount, int, const Lisp_Object *);
2882 Lisp_Object emacs_doprnt_string_lisp_2(const Bufbyte *, Lisp_Object,
2883                                        Bytecount, int, ...);
2884
2885 /* Defined in editfns.c */
2886 void uncache_home_directory(void);
2887 Extbyte *get_home_directory(void);
2888 char *user_login_name(uid_t *);
2889 char *user_group_name(gid_t *);
2890 Bufpos bufpos_clip_to_bounds(Bufpos, Bufpos, Bufpos);
2891 Bytind bytind_clip_to_bounds(Bytind, Bytind, Bytind);
2892 void buffer_insert1(struct buffer *, Lisp_Object);
2893 Lisp_Object make_string_from_buffer(struct buffer *, Bufpos, Charcount);
2894 Lisp_Object make_string_from_buffer_no_extents(struct buffer *, Bufpos,
2895                                                Charcount);
2896 Lisp_Object make_time(time_t);
2897 Lisp_Object save_excursion_save(void);
2898 Lisp_Object save_restriction_save(void);
2899 Lisp_Object save_excursion_restore(Lisp_Object);
2900 Lisp_Object save_restriction_restore(Lisp_Object);
2901
2902 /* Defined in emacsfns.c */
2903 Lisp_Object save_current_buffer_restore(Lisp_Object);
2904
2905 /* Defined in emacs.c */
2906 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(fatal(const char *,
2907                                                        ...), 1, 2);
2908 int stderr_out(const char *, ...) PRINTF_ARGS(1, 2);
2909 int stdout_out(const char *, ...) PRINTF_ARGS(1, 2);
2910 SIGTYPE fatal_error_signal(int);
2911 Lisp_Object make_arg_list(int, Extbyte **);
2912 void make_argc_argv(Lisp_Object, int *, Extbyte ***);
2913 void free_argc_argv(Extbyte **);
2914 Lisp_Object decode_env_path(const char *, /*const*/ char *);
2915 Lisp_Object decode_path(/*const*/ char *);
2916 /* Nonzero means don't do interactive redisplay and don't change tty modes */
2917 extern int noninteractive, noninteractive1;
2918 extern int fatal_error_in_progress;
2919 extern int inhibit_non_essential_printing_operations;
2920 extern int preparing_for_armageddon;
2921 extern Fixnum emacs_priority;
2922 extern int running_asynch_code;
2923 extern int suppress_early_error_handler_backtrace;
2924 void debug_break(void);
2925 int debug_can_access_memory(void *ptr, Bytecount len);
2926
2927 /* Defined in eval.c */
2928 DECLARE_DOESNT_RETURN(signal_error(Lisp_Object, Lisp_Object));
2929 void maybe_signal_error(Lisp_Object, Lisp_Object, Lisp_Object, Error_behavior);
2930 Lisp_Object maybe_signal_continuable_error(Lisp_Object, Lisp_Object,
2931                                            Lisp_Object, Error_behavior);
2932 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(type_error(Lisp_Object,
2933                                                             const char *,
2934                                                             ...), 2, 3);
2935 void maybe_type_error(Lisp_Object, Lisp_Object, Error_behavior, const char *,
2936                       ...) PRINTF_ARGS(4, 5);
2937 Lisp_Object continuable_type_error(Lisp_Object, const char *, ...)
2938 PRINTF_ARGS(2, 3);
2939 Lisp_Object maybe_continuable_type_error(Lisp_Object, Lisp_Object,
2940                                          Error_behavior,
2941                                          const char *, ...) PRINTF_ARGS(4, 5);
2942 DECLARE_DOESNT_RETURN(signal_type_error(Lisp_Object, const char *,
2943                                         Lisp_Object));
2944 void maybe_signal_type_error(Lisp_Object, const char *, Lisp_Object,
2945                              Lisp_Object, Error_behavior);
2946 Lisp_Object signal_type_continuable_error(Lisp_Object, const char *,
2947                                           Lisp_Object);
2948 Lisp_Object maybe_signal_type_continuable_error(Lisp_Object, const char *,
2949                                                 Lisp_Object,
2950                                                 Lisp_Object, Error_behavior);
2951 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(type_error_with_frob
2952                                                  (Lisp_Object, Lisp_Object,
2953                                                   const char *, ...), 3, 4);
2954 void maybe_type_error_with_frob(Lisp_Object, Lisp_Object, Lisp_Object,
2955                                 Error_behavior,
2956                                 const char *, ...) PRINTF_ARGS(5, 6);
2957 Lisp_Object continuable_type_error_with_frob(Lisp_Object, Lisp_Object,
2958                                              const char *,
2959                                              ...) PRINTF_ARGS(3, 4);
2960 Lisp_Object maybe_continuable_type_error_with_frob
2961     (Lisp_Object, Lisp_Object, Lisp_Object, Error_behavior, const char *, ...)
2962 PRINTF_ARGS(5, 6);
2963 DECLARE_DOESNT_RETURN(signal_type_error_2(Lisp_Object, const char *,
2964                                           Lisp_Object, Lisp_Object));
2965 void maybe_signal_type_error_2(Lisp_Object, const char *, Lisp_Object,
2966                                Lisp_Object, Lisp_Object, Error_behavior);
2967 Lisp_Object signal_type_continuable_error_2(Lisp_Object, const char *,
2968                                             Lisp_Object, Lisp_Object);
2969 Lisp_Object maybe_signal_type_continuable_error_2(Lisp_Object, const char *,
2970                                                   Lisp_Object, Lisp_Object,
2971                                                   Lisp_Object, Error_behavior);
2972 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(error(const char *,
2973                                                        ...), 1, 2);
2974 void maybe_error(Lisp_Object, Error_behavior, const char *,
2975                  ...) PRINTF_ARGS(3, 4);
2976 Lisp_Object continuable_error(const char *, ...) PRINTF_ARGS(1, 2);
2977 Lisp_Object maybe_continuable_error(Lisp_Object, Error_behavior,
2978                                     const char *, ...) PRINTF_ARGS(3, 4);
2979 DECLARE_DOESNT_RETURN(signal_simple_error(const char *, Lisp_Object));
2980 void maybe_signal_simple_error(const char *, Lisp_Object,
2981                                Lisp_Object, Error_behavior);
2982 Lisp_Object signal_simple_continuable_error(const char *, Lisp_Object);
2983 Lisp_Object maybe_signal_simple_continuable_error(const char *, Lisp_Object,
2984                                                   Lisp_Object, Error_behavior);
2985 DECLARE_DOESNT_RETURN_GCC_ATTRIBUTE_SYNTAX_SUCKS(error_with_frob
2986                                                  (Lisp_Object, const char *,
2987                                                   ...), 2, 3);
2988 void maybe_error_with_frob(Lisp_Object, Lisp_Object, Error_behavior,
2989                            const char *, ...) PRINTF_ARGS(4, 5);
2990 Lisp_Object continuable_error_with_frob(Lisp_Object, const char *,
2991                                         ...) PRINTF_ARGS(2, 3);
2992 Lisp_Object maybe_continuable_error_with_frob
2993     (Lisp_Object, Lisp_Object, Error_behavior, const char *, ...) PRINTF_ARGS(4,
2994                                                                               5);
2995 DECLARE_DOESNT_RETURN(signal_simple_error_2
2996                       (const char *, Lisp_Object, Lisp_Object));
2997 void maybe_signal_simple_error_2(const char *, Lisp_Object, Lisp_Object,
2998                                  Lisp_Object, Error_behavior);
2999 Lisp_Object signal_simple_continuable_error_2(const char *, Lisp_Object,
3000                                               Lisp_Object);
3001 Lisp_Object maybe_signal_simple_continuable_error_2(const char *, Lisp_Object,
3002                                                     Lisp_Object, Lisp_Object,
3003                                                     Error_behavior);
3004 DECLARE_DOESNT_RETURN(signal_malformed_list_error(Lisp_Object));
3005 DECLARE_DOESNT_RETURN(signal_malformed_property_list_error(Lisp_Object));
3006 DECLARE_DOESNT_RETURN(signal_circular_list_error(Lisp_Object));
3007 DECLARE_DOESNT_RETURN(signal_circular_property_list_error(Lisp_Object));
3008
3009 DECLARE_DOESNT_RETURN(syntax_error(const char *reason, Lisp_Object frob));
3010 DECLARE_DOESNT_RETURN(syntax_error_2(const char *reason, Lisp_Object frob1,
3011                                      Lisp_Object frob2));
3012 DECLARE_DOESNT_RETURN(invalid_argument(const char *reason, Lisp_Object frob));
3013 DECLARE_DOESNT_RETURN(invalid_argument_2(const char *reason,
3014                                          Lisp_Object frob1, Lisp_Object frob2));
3015 DECLARE_DOESNT_RETURN(invalid_operation(const char *reason, Lisp_Object frob));
3016 DECLARE_DOESNT_RETURN(invalid_operation_2(const char *reason,
3017                                           Lisp_Object frob1,
3018                                           Lisp_Object frob2));
3019 DECLARE_DOESNT_RETURN(invalid_change(const char *reason, Lisp_Object frob));
3020 DECLARE_DOESNT_RETURN(invalid_change_2(const char *reason,
3021                                        Lisp_Object frob1, Lisp_Object frob2));
3022
3023 Lisp_Object signal_void_function_error(Lisp_Object);
3024 Lisp_Object signal_invalid_function_error(Lisp_Object);
3025 Lisp_Object signal_wrong_number_of_arguments_error(Lisp_Object, int);
3026
3027 Lisp_Object run_hook_with_args_in_buffer(struct buffer *, int, Lisp_Object *,
3028                                          enum run_hooks_condition);
3029 Lisp_Object run_hook_with_args(int, Lisp_Object *, enum run_hooks_condition);
3030 void va_run_hook_with_args(Lisp_Object, int, ...);
3031 void va_run_hook_with_args_in_buffer(struct buffer *, Lisp_Object, int, ...);
3032 Lisp_Object run_hook(Lisp_Object);
3033 Lisp_Object apply1(Lisp_Object, Lisp_Object);
3034 Lisp_Object call0(Lisp_Object);
3035 Lisp_Object call1(Lisp_Object, Lisp_Object);
3036 Lisp_Object call2(Lisp_Object, Lisp_Object, Lisp_Object);
3037 Lisp_Object call3(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3038 Lisp_Object call4(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3039                   Lisp_Object);
3040 Lisp_Object call5(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3041                   Lisp_Object, Lisp_Object);
3042 Lisp_Object call6(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3043                   Lisp_Object, Lisp_Object, Lisp_Object);
3044 Lisp_Object call7(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3045                   Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3046 Lisp_Object call8(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3047                   Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object,
3048                   Lisp_Object);
3049 Lisp_Object call0_in_buffer(struct buffer *, Lisp_Object);
3050 Lisp_Object call1_in_buffer(struct buffer *, Lisp_Object, Lisp_Object);
3051 Lisp_Object call2_in_buffer(struct buffer *, Lisp_Object, Lisp_Object,
3052                             Lisp_Object);
3053 Lisp_Object call3_in_buffer(struct buffer *, Lisp_Object, Lisp_Object,
3054                             Lisp_Object, Lisp_Object);
3055 Lisp_Object call4_in_buffer(struct buffer *, Lisp_Object, Lisp_Object,
3056                             Lisp_Object, Lisp_Object, Lisp_Object);
3057 Lisp_Object call5_in_buffer(struct buffer *, Lisp_Object, Lisp_Object,
3058                             Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object);
3059 Lisp_Object call6_in_buffer(struct buffer *, Lisp_Object, Lisp_Object,
3060                             Lisp_Object, Lisp_Object, Lisp_Object,
3061                             Lisp_Object, Lisp_Object);
3062 Lisp_Object eval_in_buffer(struct buffer *, Lisp_Object);
3063 Lisp_Object call0_with_handler(Lisp_Object, Lisp_Object);
3064 Lisp_Object call1_with_handler(Lisp_Object, Lisp_Object, Lisp_Object);
3065 Lisp_Object eval_in_buffer_trapping_errors(char*, struct buffer *, Lisp_Object);
3066 Lisp_Object run_hook_trapping_errors(char*, Lisp_Object);
3067 Lisp_Object safe_run_hook_trapping_errors(char*, Lisp_Object, int);
3068 Lisp_Object call0_trapping_errors(char*, Lisp_Object);
3069 Lisp_Object call1_trapping_errors(char*, Lisp_Object, Lisp_Object);
3070 Lisp_Object call2_trapping_errors(char*,
3071                                   Lisp_Object, Lisp_Object, Lisp_Object);
3072 Lisp_Object call3_trapping_errors(char*,
3073                                   Lisp_Object, Lisp_Object, Lisp_Object,
3074                                   Lisp_Object);
3075 Lisp_Object call_with_suspended_errors(lisp_fn_t, volatile Lisp_Object,
3076                                        Lisp_Object, Error_behavior, int, ...);
3077 /* C Code should be using internal_catch, record_unwind_p, condition_case_1 */
3078 Lisp_Object internal_catch(Lisp_Object, Lisp_Object(*)(Lisp_Object),
3079                            Lisp_Object, int *volatile);
3080 Lisp_Object condition_case_1(Lisp_Object,
3081                              Lisp_Object(*)(Lisp_Object),
3082                              Lisp_Object,
3083                              Lisp_Object(*)(Lisp_Object, Lisp_Object),
3084                              Lisp_Object);
3085 Lisp_Object condition_case_3(Lisp_Object, Lisp_Object, Lisp_Object);
3086 Lisp_Object unbind_to(int, Lisp_Object);
3087 void specbind(Lisp_Object, Lisp_Object);
3088 void record_unwind_protect(Lisp_Object(*)(Lisp_Object), Lisp_Object);
3089 void do_autoload(Lisp_Object, Lisp_Object);
3090 Lisp_Object un_autoload(Lisp_Object);
3091 void warn_when_safe_lispobj(Lisp_Object, Lisp_Object, Lisp_Object);
3092 void warn_when_safe(Lisp_Object, Lisp_Object, const char *,
3093                     ...) PRINTF_ARGS(3, 4);
3094
3095 /* Defined in event-stream.c */
3096 void wait_delaying_user_input(int (*)(void *), void *);
3097 int detect_input_pending(void);
3098 void reset_this_command_keys(Lisp_Object, int);
3099 Lisp_Object enqueue_misc_user_event(Lisp_Object, Lisp_Object, Lisp_Object);
3100 Lisp_Object enqueue_misc_user_event_pos(Lisp_Object, Lisp_Object,
3101                                         Lisp_Object, int, int, int, int);
3102 extern int modifier_keys_are_sticky;
3103
3104 /* Defined in event-Xt.c */
3105 void enqueue_Xt_dispatch_event(Lisp_Object event);
3106 void signal_special_Xt_user_event(Lisp_Object, Lisp_Object, Lisp_Object);
3107
3108 /* Defined in events.c */
3109 void clear_event_resource(void);
3110 Lisp_Object allocate_event(void);
3111
3112 /* Defined in fileio.c */
3113 void record_auto_save(void);
3114 void force_auto_save_soon(void);
3115 DECLARE_DOESNT_RETURN(report_file_error(const char *, Lisp_Object));
3116 void maybe_report_file_error(const char *, Lisp_Object,
3117                              Lisp_Object, Error_behavior);
3118 DECLARE_DOESNT_RETURN(signal_file_error(const char *, Lisp_Object));
3119 void maybe_signal_file_error(const char *, Lisp_Object,
3120                              Lisp_Object, Error_behavior);
3121 DECLARE_DOESNT_RETURN(signal_double_file_error(const char *, const char *,
3122                                                Lisp_Object));
3123 void maybe_signal_double_file_error(const char *, const char *,
3124                                     Lisp_Object, Lisp_Object, Error_behavior);
3125 DECLARE_DOESNT_RETURN(signal_double_file_error_2(const char *, const char *,
3126                                                  Lisp_Object, Lisp_Object));
3127 void maybe_signal_double_file_error_2(const char *, const char *,
3128                                       Lisp_Object, Lisp_Object, Lisp_Object,
3129                                       Error_behavior);
3130 Lisp_Object lisp_strerror(int);
3131 Lisp_Object expand_and_dir_to_file(Lisp_Object, Lisp_Object);
3132 ssize_t read_allowing_quit(int, void *, size_t);
3133 ssize_t write_allowing_quit(int, const void *, size_t);
3134 int internal_delete_file(Lisp_Object);
3135
3136 /* Defined in filelock.c */
3137 void lock_file(Lisp_Object);
3138 void unlock_file(Lisp_Object);
3139 void unlock_all_files(void);
3140 void unlock_buffer(struct buffer *);
3141
3142 /* Defined in filemode.c */
3143 void filemodestring(struct stat *, char *);
3144
3145 /* Defined in fns.c */
3146 Lisp_Object list_sort(Lisp_Object, Lisp_Object,
3147                       int (*)(Lisp_Object, Lisp_Object, Lisp_Object));
3148 Lisp_Object merge(Lisp_Object, Lisp_Object, Lisp_Object);
3149
3150 void bump_string_modiff(Lisp_Object);
3151 Lisp_Object memq_no_quit(Lisp_Object, Lisp_Object);
3152 Lisp_Object assoc_no_quit(Lisp_Object, Lisp_Object);
3153 Lisp_Object assq_no_quit(Lisp_Object, Lisp_Object);
3154 Lisp_Object rassq_no_quit(Lisp_Object, Lisp_Object);
3155 Lisp_Object delq_no_quit(Lisp_Object, Lisp_Object);
3156 Lisp_Object delq_no_quit_and_free_cons(Lisp_Object, Lisp_Object);
3157 Lisp_Object remassoc_no_quit(Lisp_Object, Lisp_Object);
3158 Lisp_Object remassq_no_quit(Lisp_Object, Lisp_Object);
3159 Lisp_Object remrassq_no_quit(Lisp_Object, Lisp_Object);
3160
3161 int plists_differ(Lisp_Object, Lisp_Object, int, int, int);
3162 Lisp_Object internal_plist_get(Lisp_Object, Lisp_Object);
3163 void internal_plist_put(Lisp_Object *, Lisp_Object, Lisp_Object);
3164 int internal_remprop(Lisp_Object *, Lisp_Object);
3165 Lisp_Object external_plist_get(Lisp_Object *, Lisp_Object, int, Error_behavior);
3166 void external_plist_put(Lisp_Object *, Lisp_Object,
3167                         Lisp_Object, int, Error_behavior);
3168 int external_remprop(Lisp_Object *, Lisp_Object, int, Error_behavior);
3169 int internal_equal(Lisp_Object, Lisp_Object, int);
3170 Lisp_Object concat2(Lisp_Object, Lisp_Object);
3171 Lisp_Object concat3(Lisp_Object, Lisp_Object, Lisp_Object);
3172 Lisp_Object vconcat2(Lisp_Object, Lisp_Object);
3173 Lisp_Object vconcat3(Lisp_Object, Lisp_Object, Lisp_Object);
3174 Lisp_Object nconc2(Lisp_Object, Lisp_Object);
3175 Lisp_Object bytecode_nconc2(Lisp_Object *);
3176 void check_losing_bytecode(const char *, Lisp_Object);
3177
3178 /* Defined in glyphs.c */
3179 Error_behavior decode_error_behavior_flag(Lisp_Object);
3180 Lisp_Object encode_error_behavior_flag(Error_behavior);
3181
3182 /* Defined in indent.c */
3183 int bi_spaces_at_point(struct buffer *, Bytind);
3184 int column_at_point(struct buffer *, Bufpos, int);
3185 int string_column_at_point(Lisp_String *, Bufpos, int);
3186 int current_column(struct buffer *);
3187 void invalidate_current_column(void);
3188 Bufpos vmotion(struct window *, Bufpos, int, int *);
3189 Bufpos vmotion_pixels(Lisp_Object, Bufpos, int, int, int *);
3190
3191 /* Defined in keymap.c */
3192 void where_is_to_char(Lisp_Object, char *);
3193
3194 /* Defined in lread.c */
3195 void ebolify_bytecode_constants(Lisp_Object);
3196 void close_load_descs(void);
3197 int locate_file(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object *, int);
3198 EXFUN(Flocate_file_clear_hashing, 1);
3199 int isfloat_string(const char *);
3200 #if defined HAVE_MPQ && defined WITH_GMP
3201 int isbigq_string(const char *);
3202 #endif
3203 #if defined HAVE_MPC && defined WITH_MPC ||     \
3204         defined HAVE_PSEUC && defined WITH_PSEUC
3205 int isbigc_string(const char *);
3206 #endif
3207 #if defined HAVE_PSEUG && defined WITH_PSEUG
3208 int isgaussian_string(const char *);
3209 #endif
3210
3211 /* Well, I've decided to enable this. -- ben */
3212 /* And I've decided to make it work right.  -- sb */
3213 #define LOADHIST
3214 /* Define the following symbol to enable load history of dumped files */
3215 #define LOADHIST_DUMPED
3216 /* Define the following symbol to enable load history of C source */
3217 #define LOADHIST_BUILTIN
3218
3219 #ifdef LOADHIST                 /* this is just a stupid idea */
3220 #define LOADHIST_ATTACH(x) \
3221  do { if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list); } \
3222  while (0)
3223 #else                           /*! LOADHIST */
3224 # define LOADHIST_ATTACH(x)
3225 #endif                          /*! LOADHIST */
3226
3227 /* Defined in marker.c */
3228 Bytind bi_marker_position(Lisp_Object);
3229 Bufpos marker_position(Lisp_Object);
3230 void set_bi_marker_position(Lisp_Object, Bytind);
3231 void set_marker_position(Lisp_Object, Bufpos);
3232 void unchain_marker(Lisp_Object);
3233 Lisp_Object noseeum_copy_marker(Lisp_Object, Lisp_Object);
3234 Lisp_Object set_marker_restricted(Lisp_Object, Lisp_Object, Lisp_Object);
3235 #ifdef MEMORY_USAGE_STATS
3236 int compute_buffer_marker_usage(struct buffer *, struct overhead_stats *);
3237 #endif
3238
3239 /* Defined in menubar.c */
3240 extern int popup_menu_up_p;
3241 extern int menubar_show_keybindings;
3242 extern int popup_menu_titles;
3243
3244 /* Defined in minibuf.c */
3245 extern int minibuf_level;
3246 Charcount scmp_1(const Bufbyte *, const Bufbyte *, Charcount, int);
3247 #define scmp(s1, s2, len) scmp_1 (s1, s2, len, completion_ignore_case)
3248 extern int completion_ignore_case;
3249 int regexp_ignore_completion_p(const Bufbyte *, Lisp_Object,
3250                                Bytecount, Bytecount);
3251 Lisp_Object clear_echo_area(struct frame *, Lisp_Object, int);
3252 Lisp_Object clear_echo_area_from_print(struct frame *, Lisp_Object, int);
3253 void echo_area_append(struct frame *, const Bufbyte *, Lisp_Object,
3254                       Bytecount, Bytecount, Lisp_Object);
3255 void echo_area_message(struct frame *, const Bufbyte *, Lisp_Object,
3256                        Bytecount, Bytecount, Lisp_Object);
3257 Lisp_Object echo_area_status(struct frame *);
3258 int echo_area_active(struct frame *);
3259 Lisp_Object echo_area_contents(struct frame *);
3260 void message_internal(const Bufbyte *, Lisp_Object, Bytecount, Bytecount);
3261 void message_append_internal(const Bufbyte *, Lisp_Object,
3262                              Bytecount, Bytecount);
3263 void message(const char *, ...) PRINTF_ARGS(1, 2);
3264 void message_append(const char *, ...) PRINTF_ARGS(1, 2);
3265 void message_no_translate(const char *, ...) PRINTF_ARGS(1, 2);
3266 void clear_message(void);
3267
3268 /* Defined in print.c */
3269 void write_string_to_stdio_stream(FILE *, struct console *,
3270                                   const Bufbyte *, Bytecount, Bytecount,
3271                                   Lisp_Object, int);
3272 void debug_print(Lisp_Object);
3273 void debug_short_backtrace(int);
3274 void temp_output_buffer_setup(Lisp_Object);
3275 void temp_output_buffer_show(Lisp_Object, Lisp_Object);
3276 /* NOTE: Do not call this with the data of a Lisp_String.  Use princ.
3277  * Note: stream should be defaulted before calling
3278  *  (eg Qnil means stdout, not Vstandard_output, etc) */
3279 void write_c_string(const char *, Lisp_Object);
3280 void write_hex_ptr(void*, Lisp_Object);
3281 int write_fmt_str(Lisp_Object,const char *,...) PRINTF_ARGS(2, 3);
3282 int write_fmt_string(Lisp_Object,const char *,...) PRINTF_ARGS(2, 3);
3283 /* Same goes for this function. */
3284 void write_string_1(const Bufbyte *, Bytecount, Lisp_Object);
3285 void print_cons(Lisp_Object, Lisp_Object, int);
3286 void print_vector(Lisp_Object, Lisp_Object, int);
3287 void print_string(Lisp_Object, Lisp_Object, int);
3288 char *long_to_string(char *, long, int);
3289 void print_internal(Lisp_Object, Lisp_Object, int);
3290 void print_symbol(Lisp_Object, Lisp_Object, int);
3291 /* The number of bytes required to store the decimal printed
3292  * representation of an integral type.  Add a few bytes for truncation,
3293  * optional sign prefix, and null byte terminator.
3294  * 2.40824 == log (256) / log (10).
3295  *
3296  * We don't use floating point since Sun cc (buggily?) cannot use
3297  * floating point computations to define a compile-time integral
3298  * constant.
3299  */
3300 #define DECIMAL_PRINT_SIZE(integral_type) \
3301 (((2410824 * sizeof (integral_type)) / 1000000) + 3)
3302 extern int print_escape_newlines;
3303 extern int print_readably;
3304 Lisp_Object internal_with_output_to_temp_buffer(Lisp_Object,
3305                                                 Lisp_Object(*)(Lisp_Object),
3306                                                 Lisp_Object, Lisp_Object);
3307 void internal_object_printer(Lisp_Object, Lisp_Object, int);
3308
3309 /* Defined in profile.c */
3310 void mark_profiling_info(void);
3311 void profile_increase_call_count(Lisp_Object);
3312 extern int profiling_active;
3313 extern int profiling_redisplay_flag;
3314
3315 /* Defined in rangetab.c */
3316 void put_range_table(Lisp_Object, EMACS_INT, EMACS_INT, Lisp_Object);
3317 int unified_range_table_bytes_needed(Lisp_Object);
3318 int unified_range_table_bytes_used(const void*);
3319 void unified_range_table_copy_data(Lisp_Object, void *);
3320 Lisp_Object unified_range_table_lookup(void *, EMACS_INT, Lisp_Object);
3321 int unified_range_table_nentries(void*);
3322 void unified_range_table_get_range(void *, int, EMACS_INT *, EMACS_INT *,
3323                                    Lisp_Object *);
3324
3325 /* Defined in search.c */
3326 struct re_pattern_buffer;
3327 struct re_registers;
3328 Bufpos scan_buffer(struct buffer *, Emchar, Bufpos, Bufpos, EMACS_INT,
3329                    EMACS_INT *, int);
3330 Bufpos find_next_newline(struct buffer *, Bufpos, int);
3331 Bufpos find_next_newline_no_quit(struct buffer *, Bufpos, int);
3332 Bytind bi_find_next_newline_no_quit(struct buffer *, Bytind, int);
3333 Bytind bi_find_next_emchar_in_string(Lisp_String *, Emchar, Bytind, EMACS_INT);
3334 Bufpos find_before_next_newline(struct buffer *, Bufpos, Bufpos, int);
3335 struct re_pattern_buffer *compile_pattern(Lisp_Object, struct re_registers *,
3336                                           Lisp_Object, int, Error_behavior);
3337 Bytecount fast_string_match(Lisp_Object, const Bufbyte *,
3338                             Lisp_Object, Bytecount,
3339                             Bytecount, int, Error_behavior, int);
3340 Bytecount fast_lisp_string_match(Lisp_Object, Lisp_Object);
3341 void restore_match_data(void);
3342
3343 /* Defined in signal.c */
3344 void init_interrupts_late(void);
3345 extern int dont_check_for_quit;
3346 void begin_dont_check_for_quit(void);
3347 void emacs_sleep(int);
3348
3349 /* Defined in sound.c */
3350 void init_device_sound(struct device *);
3351
3352 /* Defined in specifier.c */
3353 Lisp_Object specifier_instance(Lisp_Object, Lisp_Object, Lisp_Object,
3354                                Error_behavior, int, int, Lisp_Object);
3355 Lisp_Object specifier_instance_no_quit(Lisp_Object, Lisp_Object, Lisp_Object,
3356                                        Error_behavior, int, Lisp_Object);
3357
3358 /* Defined in symbols.c */
3359 long unsigned int hash_string(const Bufbyte*, Bytecount);
3360 Lisp_Object intern(const char *);
3361 Lisp_Object oblookup(Lisp_Object, const Bufbyte *, Bytecount);
3362 void map_obarray(Lisp_Object, int (*)(Lisp_Object, void *), void *);
3363 Lisp_Object indirect_function(Lisp_Object, int);
3364 Lisp_Object symbol_value_in_buffer(Lisp_Object, Lisp_Object);
3365 void kill_buffer_local_variables(struct buffer *);
3366 int symbol_value_buffer_local_info(Lisp_Object, struct buffer *);
3367 Lisp_Object find_symbol_value(Lisp_Object);
3368 Lisp_Object find_symbol_value_quickly(Lisp_Object, int);
3369 Lisp_Object top_level_value(Lisp_Object);
3370 void reject_constant_symbols(Lisp_Object sym, Lisp_Object newval,
3371                              int function_p,
3372                              Lisp_Object follow_past_lisp_magic);
3373
3374 /* Defined in syntax.c */
3375 Bufpos scan_words(struct buffer *, Bufpos, int);
3376
3377 /* Defined in undo.c */
3378 Lisp_Object truncate_undo_list(Lisp_Object, int, int);
3379 void record_extent(Lisp_Object, int);
3380 void record_insert(struct buffer *, Bufpos, Charcount);
3381 void record_delete(struct buffer *, Bufpos, Charcount);
3382 void record_change(struct buffer *, Bufpos, Charcount);
3383
3384 /* Defined in unex*.c */
3385 int unexec(char *, char *, uintptr_t, uintptr_t, uintptr_t);
3386 #ifdef RUN_TIME_REMAP
3387 int run_time_remap(char *);
3388 #endif
3389
3390 /* Defined in vm-limit.c */
3391 void memory_warnings(void *, void (*)(const char *));
3392
3393 /* Defined in window.c */
3394 Lisp_Object save_window_excursion_unwind(Lisp_Object);
3395 Lisp_Object display_buffer(Lisp_Object, Lisp_Object, Lisp_Object);
3396
3397 /*--------------- prototypes for Lisp primitives in C ------------*/
3398
3399 /* The following were machine generated 19980312 */
3400
3401 EXFUN(Faccept_process_output, 3);
3402 EXFUN(Fadd1, 1);
3403 EXFUN(Fadd_spec_to_specifier, 5);
3404 EXFUN(Fadd_timeout, 4);
3405 EXFUN(Fappend, MANY);
3406 EXFUN(Fapply, MANY);
3407 EXFUN(Faref, 2);
3408 EXFUN(Faset, 3);
3409 EXFUN(Fassoc, 2);
3410 EXFUN(Fassq, 2);
3411 EXFUN(Fbacktrace, 2);
3412 EXFUN(Fbeginning_of_line, 2);
3413 EXFUN(Fbobp, 1);
3414 EXFUN(Fbolp, 1);
3415 EXFUN(Fboundp, 1);
3416 EXFUN(Fbuffer_substring, 3);
3417 EXFUN(Fbuilt_in_variable_type, 1);
3418 EXFUN(Fbyte_code, 3);
3419 EXFUN(Fcall_interactively, 3);
3420 EXFUN(Fcanonicalize_lax_plist, 2);
3421 EXFUN(Fcanonicalize_plist, 2);
3422 EXFUN(Fcar, 1);
3423 EXFUN(Fcar_safe, 1);
3424 EXFUN(Fcdr, 1);
3425 EXFUN (Fcdr_safe, 1);
3426 EXFUN(Fchar_after, 2);
3427 EXFUN(Fchar_to_string, 1);
3428 EXFUN(Fcheck_valid_plist, 1);
3429 EXFUN(Fvalid_plist_p, 1);
3430 EXFUN(Fclear_range_table, 1);
3431 EXFUN(Fcoding_category_list, 0);
3432 EXFUN(Fcoding_category_system, 1);
3433 EXFUN(Fcoding_priority_list, 0);
3434 EXFUN(Fcoding_system_charset, 2);
3435 EXFUN(Fcoding_system_doc_string, 1);
3436 EXFUN(Fcoding_system_list, 0);
3437 EXFUN(Fcoding_system_name, 1);
3438 EXFUN(Fcoding_system_p, 1);
3439 EXFUN(Fcoding_system_property, 2);
3440 EXFUN(Fcoding_system_type, 1);
3441 EXFUN(Fcommand_execute, 3);
3442 EXFUN(Fcommandp, 1);
3443 EXFUN(Fconcat, MANY);
3444 EXFUN(Fcons, 2);
3445 EXFUN(Fcopy_alist, 1);
3446 EXFUN(Fcopy_coding_system, 2);
3447 EXFUN(Fcopy_event, 2);
3448 EXFUN(Fcopy_list, 1);
3449 EXFUN(Fcopy_marker, 2);
3450 EXFUN(Fcopy_sequence, 1);
3451 EXFUN(Fcopy_tree, 2);
3452 EXFUN(Fcurrent_window_configuration, 1);
3453 EXFUN(Fdecode_big5_char, 1);
3454 EXFUN(Fdecode_coding_region, 4);
3455 EXFUN(Fdecode_shift_jis_char, 1);
3456 EXFUN(Fdefault_boundp, 1);
3457 EXFUN(Fdefault_value, 1);
3458 EXFUN(Fdefine_key, 3);
3459 EXFUN(Fdelete, 2);
3460 EXFUN(Fdelete_region, 3);
3461 EXFUN(Fdelete_process, 1);
3462 EXFUN(Fdelq, 2);
3463 EXFUN(Fdestructive_alist_to_plist, 1);
3464 EXFUN(Fdetect_coding_region, 3);
3465 EXFUN(Fdgettext, 2);
3466 EXFUN(Fding, 3);
3467 EXFUN(Fdirectory_file_name, 1);
3468 EXFUN(Fdisable_timeout, 1);
3469 EXFUN(Fdiscard_input, 0);
3470 EXFUN(Fdispatch_event, 1);
3471 EXFUN(Fdisplay_error, 2);
3472 EXFUN(Fdo_auto_save, 2);
3473 EXFUN(Fdowncase, 2);
3474 EXFUN(Felt, 2);
3475 EXFUN(Fencode_big5_char, 1);
3476 EXFUN(Fencode_coding_region, 4);
3477 EXFUN(Fencode_shift_jis_char, 1);
3478 EXFUN(Fend_of_line, 2);
3479 EXFUN(Fenqueue_eval_event, 2);
3480 EXFUN(Feobp, 1);
3481 EXFUN(Feolp, 1);
3482 EXFUN(Fequal, 2);
3483 EXFUN(Ferror_message_string, 1);
3484 EXFUN(Feval, 1);
3485 EXFUN(Fevent_to_character, 4);
3486 EXFUN(Fexecute_kbd_macro, 2);
3487 EXFUN(Fexpand_abbrev, 0);
3488 EXFUN(Fexpand_file_name, 2);
3489 EXFUN(Fextent_at, 5);
3490 EXFUN(Fextent_property, 3);
3491 EXFUN(Ffboundp, 1);
3492 EXFUN(Ffile_accessible_directory_p, 1);
3493 EXFUN(Ffile_directory_p, 1);
3494 EXFUN(Ffile_executable_p, 1);
3495 EXFUN(Ffile_exists_p, 1);
3496 EXFUN(Ffile_name_absolute_p, 1);
3497 EXFUN(Ffile_name_as_directory, 1);
3498 EXFUN(Ffile_name_directory, 1);
3499 EXFUN(Ffile_name_nondirectory, 1);
3500 EXFUN(Ffile_readable_p, 1);
3501 EXFUN(Ffile_symlink_p, 1);
3502 EXFUN(Ffile_truename, 2);
3503 EXFUN(Ffind_coding_system, 1);
3504 EXFUN(Ffind_file_name_handler, 2);
3505 EXFUN(Ffollowing_char, 1);
3506 EXFUN(Fformat, MANY);
3507 EXFUN(Fforward_char, 2);
3508 EXFUN(Fforward_line, 2);
3509 EXFUN(Ffset, 2);
3510 EXFUN(Ffuncall, MANY);
3511 EXFUN(Ffunctionp, 1);
3512 EXFUN(Fgeq, MANY);
3513 EXFUN(Fget, 3);
3514 EXFUN(Fget_buffer_process, 1);
3515 EXFUN(Fget_coding_system, 1);
3516 EXFUN(Fget_process, 1);
3517 EXFUN(Fget_range_table, 3);
3518 EXFUN(Fgettext, 1);
3519 EXFUN(Fgoto_char, 2);
3520 EXFUN(Fgtr, MANY);
3521 EXFUN(Findent_to, 3);
3522 EXFUN(Findirect_function, 1);
3523 EXFUN(Finsert, MANY);
3524 EXFUN(Finsert_buffer_substring, 3);
3525 EXFUN(Finsert_char, 4);
3526 EXFUN(Finsert_file_contents_internal, 7);
3527 EXFUN(Finteractive_p, 0);
3528 EXFUN(Fintern, 2);
3529 EXFUN(Fintern_soft, 2);
3530 EXFUN(Fkey_description, 1);
3531 EXFUN(Fkill_emacs, 1);
3532 EXFUN(Fkill_local_variable, 1);
3533 EXFUN(Flast, 2);
3534 EXFUN(Flax_plist_get, 3);
3535 EXFUN(Flax_plist_remprop, 2);
3536 EXFUN(Flength, 1);
3537 EXFUN(Fleq, MANY);
3538 EXFUN(Flist, MANY);
3539 EXFUN(Flistp, 1);
3540 EXFUN(Flist_modules, 0);
3541 EXFUN(Fload_module, 3);
3542 EXFUN(Flookup_key, 3);
3543 EXFUN(Flss, MANY);
3544 EXFUN(Fmake_byte_code, MANY);
3545 EXFUN(Fmake_coding_system, 4);
3546 EXFUN(Fmake_glyph_internal, 1);
3547 EXFUN(Fmake_list, 2);
3548 EXFUN(Fmake_marker, 0);
3549 EXFUN(Fmake_range_table, 0);
3550 EXFUN(Fmake_sparse_keymap, 1);
3551 EXFUN(Fmake_string, 2);
3552 EXFUN(Fmake_symbol, 1);
3553 EXFUN(Fmake_vector, 2);
3554 EXFUN(Fmapcar, 2);
3555 EXFUN(Fmarker_buffer, 1);
3556 EXFUN(Fmarker_position, 1);
3557 EXFUN(Fmatch_beginning, 1);
3558 EXFUN(Fmatch_end, 1);
3559 EXFUN(Fmax, MANY);
3560 EXFUN(Fmember, 2);
3561 EXFUN(Fmemq, 2);
3562 EXFUN(Fmin, MANY);
3563 EXFUN(Fminus, MANY);
3564 EXFUN(Fnarrow_to_region, 3);
3565 EXFUN(Fnconc, MANY);
3566 EXFUN(Fnext_event, 2);
3567 EXFUN(Fnonnegativep, 1);
3568 EXFUN(Fnreverse, 1);
3569 EXFUN(Fnthcdr, 2);
3570 EXFUN(Fnumber_to_string, 1);
3571 EXFUN(Fold_assq, 2);
3572 EXFUN(Fold_equal, 2);
3573 EXFUN(Fold_member, 2);
3574 EXFUN(Fold_memq, 2);
3575 EXFUN(Fplist_get, 3);
3576 EXFUN(Fplist_member, 2);
3577 EXFUN(Fplist_put, 3);
3578 EXFUN(Fpoint, 1);
3579 EXFUN(Fpoint_marker, 2);
3580 EXFUN(Fpoint_max, 1);
3581 EXFUN(Fpoint_min, 1);
3582 EXFUN(Fpow, 2);
3583 EXFUN(Fpreceding_char, 1);
3584 EXFUN(Fprefix_numeric_value, 1);
3585 EXFUN(Fprin1, 2);
3586 EXFUN(Fprin1_to_string, 2);
3587 EXFUN(Fprinc, 2);
3588 EXFUN(Fprint, 2);
3589 EXFUN(Fprocess_status, 1);
3590 EXFUN(Fprogn, UNEVALLED);
3591 EXFUN(Fprovide, 1);
3592 EXFUN(Fput, 3);
3593 EXFUN(Fput_range_table, 4);
3594 EXFUN(Fput_text_property, 5);
3595 EXFUN(Fquo, MANY);
3596 EXFUN(Frassq, 2);
3597 EXFUN(Fread, 1);
3598 EXFUN(Fread_key_sequence, 3);
3599 EXFUN(Freally_free, 1);
3600 EXFUN(Frem, 2);
3601 EXFUN(Fremassq, 2);
3602 EXFUN(Freplace_list, 2);
3603 EXFUN(Frevoke, 1);
3604 EXFUN(Fselected_frame, 1);
3605 EXFUN(Fset, 2);
3606 EXFUN(Fset_coding_category_system, 2);
3607 EXFUN(Fset_coding_priority_list, 1);
3608 EXFUN(Fset_default, 2);
3609 EXFUN(Fset_marker, 3);
3610 EXFUN(Fset_standard_case_table, 1);
3611 EXFUN(Fsetcar, 2);
3612 EXFUN(Fsetcdr, 2);
3613 EXFUN(Fsignal, 2);
3614 EXFUN(Fsit_for, 2);
3615 EXFUN(Fskip_chars_backward, 3);
3616 EXFUN(Fskip_chars_forward, 3);
3617 EXFUN(Fsleep_for, 1);
3618 EXFUN(Fsort, 2);
3619 EXFUN(Fspecifier_spec_list, 4);
3620 EXFUN(Fstring_equal, 2);
3621 EXFUN(Fstring_lessp, 2);
3622 EXFUN(Fstring_match, 4);
3623 EXFUN(Fsub1, 1);
3624 EXFUN(Fsubr_max_args, 1);
3625 EXFUN(Fsubr_min_args, 1);
3626 EXFUN(Fsubsidiary_coding_system, 2);
3627 EXFUN(Fsubstitute_command_keys, 1);
3628 EXFUN(Fsubstitute_in_file_name, 1);
3629 EXFUN(Fsubstring, 3);
3630 EXFUN(Fsymbol_function, 1);
3631 EXFUN(Fsymbol_name, 1);
3632 EXFUN(Fsymbol_plist, 1);
3633 EXFUN(Fsymbol_value, 1);
3634 EXFUN(Fsystem_name, 0);
3635 EXFUN(Fthrow, 2);
3636 EXFUN(Ftimes, MANY);
3637 EXFUN(Ftruncate, 1);
3638 EXFUN(Fundo_boundary, 0);
3639 EXFUN(Funhandled_file_name_directory, 1);
3640 EXFUN(Funlock_buffer, 0);
3641 EXFUN(Fupcase, 2);
3642 EXFUN(Fupcase_initials, 2);
3643 EXFUN(Fupcase_initials_region, 3);
3644 EXFUN(Fupcase_region, 3);
3645 EXFUN(Fuser_home_directory, 0);
3646 EXFUN(Fuser_login_name, 1);
3647 EXFUN(Fuser_group_name, 1);
3648 EXFUN(Fvector, MANY);
3649 EXFUN(Fverify_visited_file_modtime, 1);
3650 EXFUN(Fvertical_motion, 3);
3651 EXFUN(Fwiden, 1);
3652
3653 /*--------------- prototypes for constant symbols  ------------*/
3654
3655 extern Lisp_Object Q_style;
3656 extern Lisp_Object Qactivate_menubar_hook;
3657 extern Lisp_Object Qafter_change_major_mode_hook;
3658 extern Lisp_Object Qarith_error;
3659 extern Lisp_Object Qarrayp, Qautoload;
3660 extern Lisp_Object Qbackground, Qbackground_pixmap;
3661 extern Lisp_Object Qbeginning_of_buffer, Qbig5;
3662 extern Lisp_Object Qbitp, Qblinking;
3663 extern Lisp_Object Qbuffer_glyph_p, Qbuffer_live_p, Qbuffer_read_only;
3664 extern Lisp_Object Qbyte_code, Qcall_interactively;
3665 extern Lisp_Object Qcategory_designator_p, Qcategory_table_value_p, Qccl, Qcdr;
3666 extern Lisp_Object Qchar_or_string_p, Qcharacterp;
3667 extern Lisp_Object Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
3668 extern Lisp_Object Qcircular_list, Qcircular_property_list;
3669 extern Lisp_Object Qcoding_system_error;
3670 extern Lisp_Object Qcolor_pixmap_image_instance_p;
3671 extern Lisp_Object Qcommandp, Qcompletion_ignore_case;
3672 extern Lisp_Object Qconsole_live_p, Qconst_specifier, Qcr;
3673 extern Lisp_Object Qcrlf, Qcurrent_menubar, Qctext;
3674 extern Lisp_Object Qcyclic_variable_indirection, Qdecode;
3675 extern Lisp_Object Qdefun, Qdevice_live_p;
3676 extern Lisp_Object Qdictp;
3677 extern Lisp_Object Qdim, Qdisabled, Qdisplay_table;
3678 extern Lisp_Object Qdomain_error;
3679 extern Lisp_Object Qediting_error;
3680 extern Lisp_Object Qencode, Qend_of_buffer, Qend_of_file, Qend_open;
3681 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type;
3682 extern Lisp_Object Qerror, Qerror_conditions, Qerror_message, Qescape_quoted;
3683 extern Lisp_Object Qevent_live_p, Qexit, Qextent_live_p;
3684 extern Lisp_Object Qexternal_debugging_output, Qfeaturep;
3685 extern Lisp_Object Qfile_error;
3686 extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
3687 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output, Qforeground;
3688 extern Lisp_Object Qformat, Qframe_live_p;
3689 extern Lisp_Object Qicon_glyph_p, Qidentity;
3690 extern Lisp_Object Qinhibit_quit, Qinhibit_read_only;
3691 extern Lisp_Object Qinput_charset_conversion;
3692 extern Lisp_Object Qinteger_char_or_marker_p, Qinteger_or_char_p;
3693 extern Lisp_Object Qinteger_or_marker_p, Qintegerp, Qinteractive;
3694 extern Lisp_Object Qinternal_error, Qinvalid_argument;
3695 extern Lisp_Object Qinvalid_change, Qinvalid_function, Qinvalid_operation;
3696 extern Lisp_Object Qinvalid_byte_code, Qinvalid_read_syntax, Qinvalid_state;
3697 extern Lisp_Object Qio_error;
3698 extern Lisp_Object Qiso2022;
3699 extern Lisp_Object Qip_any;
3700 extern Lisp_Object Qlambda, Qlayout;
3701 extern Lisp_Object Qlf;
3702 extern Lisp_Object Qlist_formation_error;
3703 extern Lisp_Object Qlistp, Qload, Qlocalhost, Qlock_shift, Qmacro;
3704 extern Lisp_Object Qmakunbound, Qmalformed_list, Qmalformed_property_list;
3705 extern Lisp_Object Qmark;
3706 extern Lisp_Object Qmnemonic;
3707 extern Lisp_Object Qmono_pixmap_image_instance_p;
3708 extern Lisp_Object Qmouse_leave_buffer_hook;
3709 extern Lisp_Object Qnas, Qnatnump, Qnative_layout;
3710 extern Lisp_Object Qno_ascii_cntl, Qno_ascii_eol, Qno_catch;
3711 extern Lisp_Object Qno_conversion, Qno_iso6429;
3712 extern Lisp_Object Qnonnegativep, Qnothing_image_instance_p;
3713 extern Lisp_Object Qnumber_char_or_marker_p, Qnumberp;
3714 extern Lisp_Object Qoutput_charset_conversion;
3715 extern Lisp_Object Qoverflow_error, Qpoint, Qpointer_glyph_p;
3716 extern Lisp_Object Qpointer_image_instance_p, Qpositivep, Qpost_read_conversion;
3717 extern Lisp_Object Qpre_write_conversion, Qprint_length;
3718 extern Lisp_Object Qprint_string_length, Qprogn, Qquit;
3719 extern Lisp_Object Qquote, Qrange_error, Qread_char;
3720 extern Lisp_Object Qread_from_minibuffer, Qreally_early_error_handler;
3721 extern Lisp_Object Qregion_beginning, Qregion_end;
3722 extern Lisp_Object Qrun_hooks, Qsans_modifiers;
3723 extern Lisp_Object Qsave_buffers_kill_emacs;
3724 extern Lisp_Object Qself_insert_command, Qself_insert_defer_undo;
3725 extern Lisp_Object Qsequencep, Qset, Qsetting_constant;
3726 extern Lisp_Object Qseven, Qshift_jis;
3727 extern Lisp_Object Qsingularity_error;
3728 extern Lisp_Object Qstandard_input, Qstandard_output;
3729 extern Lisp_Object Qstart_open;
3730 extern Lisp_Object Qstring_greaterp, Qstring_lessp, Qsubwindow;
3731 extern Lisp_Object Qsubwindow_image_instance_p;
3732 extern Lisp_Object Qsyntax_error, Qt;
3733 extern Lisp_Object Qtext_image_instance_p;
3734 extern Lisp_Object Qtop_level;
3735 extern Lisp_Object Qtrue_list_p;
3736 extern Lisp_Object Qunbound, Qunderflow_error;
3737 extern Lisp_Object Qunderline, Quser_files_and_directories;
3738 extern Lisp_Object Qvalues;
3739 extern Lisp_Object Qvariable_documentation, Qvariable_domain;
3740 extern Lisp_Object Qvoid_function, Qvoid_variable;
3741 extern Lisp_Object Qwindow_live_p, Qwrong_number_of_arguments;
3742 extern Lisp_Object Qwrong_type_argument, Qyes_or_no_p;
3743
3744 #define SYMBOL(fou) extern Lisp_Object fou
3745 #define SYMBOL_KEYWORD(la_cle_est_fou) extern Lisp_Object la_cle_est_fou
3746 #define SYMBOL_GENERAL(tout_le_monde, est_fou) \
3747   extern Lisp_Object tout_le_monde
3748
3749 #include "general-slots.h"
3750
3751 #undef SYMBOL
3752 #undef SYMBOL_KEYWORD
3753 #undef SYMBOL_GENERAL
3754
3755 /*--------------- prototypes for variables of type Lisp_Object  ------------*/
3756
3757 extern Lisp_Object Vactivate_menubar_hook;
3758 extern Lisp_Object Vafter_change_major_mode_hook;
3759 extern Lisp_Object Vautoload_queue, Vblank_menubar;
3760 extern Lisp_Object Vcharset_ascii, Vcharset_composite, Vcharset_control_1;
3761 extern Lisp_Object Vcoding_system_for_read, Vcoding_system_for_write;
3762 extern Lisp_Object Vcoding_system_hash_table, Vcommand_history;
3763 extern Lisp_Object Vcommand_line_args, Vconfigure_info_directory;
3764 extern Lisp_Object Vconfigure_site_module_directory;
3765 extern Lisp_Object Vconsole_list, Vcontrolling_terminal;
3766 extern Lisp_Object Vcurrent_compiled_function_annotation, Vcurrent_load_list;
3767 extern Lisp_Object Vcurrent_mouse_event, Vcurrent_prefix_arg, Vdata_directory;
3768 extern Lisp_Object Vdirectory_sep_char, Vdisabled_command_hook;
3769 extern Lisp_Object Vdoc_directory, Vinternal_doc_file_name;
3770 extern Lisp_Object Vecho_area_buffer, Vemacs_major_version;
3771 extern Lisp_Object Vemacs_minor_version, Vexec_directory, Vexec_path;
3772 extern Lisp_Object Vexecuting_macro, Vfeatures, Vfile_domain;
3773 extern Lisp_Object Vfile_name_coding_system, Vinhibit_quit;
3774 extern Lisp_Object Vinvocation_directory, Vinvocation_name;
3775 extern Lisp_Object Vkeyboard_coding_system, Vlast_command, Vlast_command_char;
3776 extern Lisp_Object Vlast_command_event, Vlast_input_event;
3777 extern Lisp_Object Vload_file_name_internal;
3778 extern Lisp_Object Vload_file_name_internal_the_purecopy, Vload_history;
3779 extern Lisp_Object Vload_path, Vmark_even_if_inactive, Vmenubar_configuration;
3780 extern Lisp_Object Vminibuf_preprompt, Vminibuf_prompt, Vminibuffer_zero;
3781 extern Lisp_Object Vmodule_directory, Vmswindows_downcase_file_names;
3782 extern Lisp_Object Vmswindows_get_true_file_attributes, Vobarray;
3783 extern Lisp_Object Vprint_length, Vprint_level, Vprocess_environment;
3784 extern Lisp_Object Vquit_flag;
3785 extern Lisp_Object Vrecent_keys_ring, Vshell_file_name;
3786 extern Lisp_Object Vsite_module_directory;
3787 extern Lisp_Object Vstandard_input, Vstandard_output, Vstdio_str;
3788 extern Lisp_Object Vsynchronous_sounds, Vsystem_name, Vterminal_coding_system;
3789 extern Lisp_Object Vthis_command_keys, Vunread_command_event;
3790 extern Lisp_Object Vx_initial_argv_list;
3791
3792 #endif                          /* INCLUDED_lisp_h_ */