src/lisp.h

   1 /* Fundamental definitions for GNU Emacs Lisp interpreter.
   2    Copyright (C) 1985,86,87,93,94,95 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20
  21 /* These are default choices for the types to use.  */
  22 #ifndef EMACS_INT
  23 #define EMACS_INT int
  24 #endif
  25 #ifndef EMACS_UINT
  26 #define EMACS_UINT unsigned int
  27 #endif
  28
  29 /* Define the fundamental Lisp data structures.  */
  30
  31 /* This is the set of Lisp data types.  */
  32
  33 enum Lisp_Type
  34   {
  35     /* Integer.  XINT (obj) is the integer value.  */
  36     Lisp_Int,
  37
  38     /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
  39     Lisp_Symbol,
  40
  41     /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
  42        whose first member indicates the subtype.  */
  43     Lisp_Misc,
  44
  45     /* String.  XSTRING (object) points to a struct Lisp_String.
  46        The length of the string, and its contents, are stored therein.  */
  47     Lisp_String,
  48
  49     /* Vector of Lisp objects, or something resembling it.
  50        XVECTOR (object) points to a struct Lisp_Vector, which contains
  51        the size and contents.  The size field also contains the type
  52        information, if it's not a real vector object.  */
  53     Lisp_Vectorlike,
  54
  55     /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
  56     Lisp_Cons,
  57
  58 #ifdef LISP_FLOAT_TYPE
  59     Lisp_Float,
  60 #endif /* LISP_FLOAT_TYPE */
  61
  62     /* This is not a type code.  It is for range checking.  */
  63     Lisp_Type_Limit
  64   };
  65
  66 /* This is the set of datatypes that share a common structure.
  67    The first member of the structure is a type code from this set.
  68    The enum values are arbitrary, but we'll use large numbers to make it
  69    more likely that we'll spot the error if a random word in memory is
  70    mistakenly interpreted as a Lisp_Misc.  */
  71 enum Lisp_Misc_Type
  72   {
  73     Lisp_Misc_Free = 0x5eab,
  74     Lisp_Misc_Marker,
  75     Lisp_Misc_Intfwd,
  76     Lisp_Misc_Boolfwd,
  77     Lisp_Misc_Objfwd,
  78     Lisp_Misc_Buffer_Objfwd,
  79     Lisp_Misc_Buffer_Local_Value,
  80     Lisp_Misc_Some_Buffer_Local_Value,
  81     Lisp_Misc_Overlay,
  82     Lisp_Misc_Kboard_Objfwd,
  83     /* Currently floats are not a misc type,
  84        but let's define this in case we want to change that.  */
  85     Lisp_Misc_Float,
  86     /* This is not a type code.  It is for range checking.  */
  87     Lisp_Misc_Limit
  88   };
  89
  90 /* These values are overridden by the m- file on some machines.  */
  91 #ifndef VALBITS
  92 #define VALBITS 28
  93 #endif
  94
  95 #ifndef GCTYPEBITS
  96 #define GCTYPEBITS 3
  97 #endif
  98
  99 /* Make these values available in GDB, which sees enums but not macros.  */
 100
 101 enum gdb_lisp_params
 102 {
 103   gdb_valbits = VALBITS,
 104   gdb_gctypebits = GCTYPEBITS,
 105   gdb_emacs_intbits = sizeof (EMACS_INT) * INTBITS / sizeof (int),
 106 #ifdef DATA_SEG_BITS
 107   gdb_data_seg_bits = DATA_SEG_BITS
 108 #else
 109   gdb_data_seg_bits = 0
 110 #endif
 111 };
 112
 113 #ifndef NO_UNION_TYPE
 114
 115 #ifndef WORDS_BIG_ENDIAN
 116
 117 /* Definition of Lisp_Object for little-endian machines.  */
 118
 119 typedef
 120 union Lisp_Object
 121   {
 122     /* Used for comparing two Lisp_Objects;
 123        also, positive integers can be accessed fast this way.  */
 124     int i;
 125
 126     struct
 127       {
 128         int val: VALBITS;
 129         int type: GCTYPEBITS+1;
 130       } s;
 131     struct
 132       {
 133         unsigned int val: VALBITS;
 134         int type: GCTYPEBITS+1;
 135       } u;
 136     struct
 137       {
 138         unsigned int val: VALBITS;
 139         enum Lisp_Type type: GCTYPEBITS;
 140         /* The markbit is not really part of the value of a Lisp_Object,
 141            and is always zero except during garbage collection.  */
 142         unsigned int markbit: 1;
 143       } gu;
 144   }
 145 Lisp_Object;
 146
 147 #else /* If WORDS_BIG_ENDIAN */
 148
 149 typedef
 150 union Lisp_Object
 151   {
 152     /* Used for comparing two Lisp_Objects;
 153        also, positive integers can be accessed fast this way.  */
 154     int i;
 155
 156     struct
 157       {
 158         int type: GCTYPEBITS+1;
 159         int val: VALBITS;
 160       } s;
 161     struct
 162       {
 163         int type: GCTYPEBITS+1;
 164         unsigned int val: VALBITS;
 165       } u;
 166     struct
 167       {
 168         /* The markbit is not really part of the value of a Lisp_Object,
 169            and is always zero except during garbage collection.  */
 170         unsigned int markbit: 1;
 171         enum Lisp_Type type: GCTYPEBITS;
 172         unsigned int val: VALBITS;
 173       } gu;
 174   }
 175 Lisp_Object;
 176
 177 #endif /* WORDS_BIG_ENDIAN */
 178
 179 #endif /* NO_UNION_TYPE */
 180
 181
 182 /* If union type is not wanted, define Lisp_Object as just a number
 183    and define the macros below to extract fields by shifting */
 184
 185 #ifdef NO_UNION_TYPE
 186
 187 #define Lisp_Object EMACS_INT
 188
 189 #ifndef VALMASK
 190 #define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
 191 #endif
 192 #define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
 193
 194 /* Two flags that are set during GC.  On some machines, these flags
 195    are defined differently by the m- file.  */
 196
 197 /* This is set in the car of a cons and in the plist slot of a symbol
 198    to indicate it is marked.  Likewise in the plist slot of an interval,
 199    the chain slot of a marker, the type slot of a float, and the name
 200    slot of a buffer.
 201
 202    In strings, this bit in the size field indicates that the string
 203    is a "large" one, one which was separately malloc'd
 204    rather than being part of a string block.  */
 205
 206 #ifndef MARKBIT
 207 #define MARKBIT ((int) ((unsigned int) 1 << (VALBITS + GCTYPEBITS)))
 208 #endif /*MARKBIT */
 209
 210 /* In the size word of a vector, this bit means the vector has been marked.
 211    In the size word of a large string, likewise.  */
 212
 213 #ifndef ARRAY_MARK_FLAG
 214 #define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
 215 #endif /* no ARRAY_MARK_FLAG */
 216
 217 /* In the size word of a struct Lisp_Vector, this bit means it's really
 218    some other vector-like object.  */
 219 #ifndef PSEUDOVECTOR_FLAG
 220 #define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
 221 #endif
 222
 223 /* In a pseudovector, the size field actually contains a word with one
 224    PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
 225    indicate the actual type.  */
 226 enum pvec_type
 227 {
 228   PVEC_NORMAL_VECTOR = 0,
 229   PVEC_PROCESS = 0x200,
 230   PVEC_FRAME = 0x400,
 231   PVEC_COMPILED = 0x800,
 232   PVEC_WINDOW = 0x1000,
 233   PVEC_WINDOW_CONFIGURATION = 0x2000,
 234   PVEC_SUBR = 0x4000,
 235   PVEC_CHAR_TABLE = 0x8000,
 236   PVEC_BOOL_VECTOR = 0x10000,
 237   PVEC_BUFFER = 0x20000,
 238   PVEC_TYPE_MASK = 0x3ff00,
 239   PVEC_FLAG = PSEUDOVECTOR_FLAG
 240 };
 241
 242 /* For convenience, we also store the number of elements in these bits.  */
 243 #define PSEUDOVECTOR_SIZE_MASK 0x1ff
 244
 245 #endif /* NO_UNION_TYPE */
 246 \f
 247 /* These macros extract various sorts of values from a Lisp_Object.
 248  For example, if tem is a Lisp_Object whose type is Lisp_Cons,
 249  XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
 250
 251 #ifdef NO_UNION_TYPE
 252
 253 /* One need to override this if there must be high bits set in data space
 254    (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
 255     on all machines, but would penalise machines which don't need it)
 256  */
 257 #ifndef XTYPE
 258 #define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
 259 #endif
 260
 261 #ifndef XSETTYPE
 262 #define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
 263 #endif
 264
 265 /* For integers known to be positive, XFASTINT provides fast retrieval
 266    and XSETFASTINT provides fast storage.  This takes advantage of the
 267    fact that Lisp_Int is 0.  */
 268 #define XFASTINT(a) ((a) + 0)
 269 #define XSETFASTINT(a, b) ((a) = (b))
 270
 271 /* Extract the value of a Lisp_Object as a signed integer.  */
 272
 273 #ifndef XINT   /* Some machines need to do this differently.  */
 274 #define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
 275 #endif
 276
 277 /* Extract the value as an unsigned integer.  This is a basis
 278    for extracting it as a pointer to a structure in storage.  */
 279
 280 #ifndef XUINT
 281 #define XUINT(a) ((a) & VALMASK)
 282 #endif
 283
 284 #ifndef XPNTR
 285 #ifdef HAVE_SHM
 286 /* In this representation, data is found in two widely separated segments.  */
 287 extern int pure_size;
 288 #define XPNTR(a) \
 289   (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
 290 #else /* not HAVE_SHM */
 291 #ifdef DATA_SEG_BITS
 292 /* This case is used for the rt-pc.
 293    In the diffs I was given, it checked for ptr = 0
 294    and did not adjust it in that case.
 295    But I don't think that zero should ever be found
 296    in a Lisp object whose data type says it points to something.  */
 297 #define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
 298 #else
 299 #define XPNTR(a) XUINT (a)
 300 #endif
 301 #endif /* not HAVE_SHM */
 302 #endif /* no XPNTR */
 303
 304 #ifndef XSET
 305 #define XSET(var, type, ptr) \
 306    ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
 307 #endif
 308
 309 /* During garbage collection, XGCTYPE must be used for extracting types
 310  so that the mark bit is ignored.  XMARKBIT accesses the markbit.
 311  Markbits are used only in particular slots of particular structure types.
 312  Other markbits are always zero.
 313  Outside of garbage collection, all mark bits are always zero.  */
 314
 315 #ifndef XGCTYPE
 316 #define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
 317 #endif
 318
 319 #if VALBITS + GCTYPEBITS == INTBITS - 1
 320 /* Make XMARKBIT faster if mark bit is sign bit.  */
 321 #ifndef XMARKBIT
 322 #define XMARKBIT(a) ((a) < 0)
 323 #endif
 324 #endif /* markbit is sign bit */
 325
 326 #ifndef XMARKBIT
 327 #define XMARKBIT(a) ((a) & MARKBIT)
 328 #endif
 329
 330 #ifndef XSETMARKBIT
 331 #define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
 332 #endif
 333
 334 #ifndef XMARK
 335 #define XMARK(a) ((a) |= MARKBIT)
 336 #endif
 337
 338 #ifndef XUNMARK
 339 #define XUNMARK(a) ((a) &= ~MARKBIT)
 340 #endif
 341
 342 #endif /* NO_UNION_TYPE */
 343
 344 #ifndef NO_UNION_TYPE
 345
 346 #define XTYPE(a) ((enum Lisp_Type) (a).u.type)
 347 #define XSETTYPE(a, b) ((a).u.type = (char) (b))
 348
 349 /* For integers known to be positive, XFASTINT provides fast retrieval
 350    and XSETFASTINT provides fast storage.  This takes advantage of the
 351    fact that Lisp_Int is 0.  */
 352 #define XFASTINT(a) ((a).i + 0)
 353 #define XSETFASTINT(a, b) ((a).i = (b))
 354
 355 #ifdef EXPLICIT_SIGN_EXTEND
 356 /* Make sure we sign-extend; compilers have been known to fail to do so.  */
 357 #define XINT(a) (((a).i << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
 358 #else
 359 #define XINT(a) ((a).s.val)
 360 #endif /* EXPLICIT_SIGN_EXTEND */
 361
 362 #define XUINT(a) ((a).u.val)
 363 #define XPNTR(a) ((a).u.val)
 364
 365 #define XSET(var, vartype, ptr) \
 366    (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))
 367
 368 /* During garbage collection, XGCTYPE must be used for extracting types
 369  so that the mark bit is ignored.  XMARKBIT access the markbit.
 370  Markbits are used only in particular slots of particular structure types.
 371  Other markbits are always zero.
 372  Outside of garbage collection, all mark bits are always zero.  */
 373
 374 #define XGCTYPE(a) ((a).gu.type)
 375 #define XMARKBIT(a) ((a).gu.markbit)
 376 #define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
 377 #define XMARK(a) (XMARKBIT(a) = 1)
 378 #define XUNMARK(a) (XMARKBIT(a) = 0)
 379
 380 #endif /* NO_UNION_TYPE */
 381
 382 /* Extract a value or address from a Lisp_Object.  */
 383
 384 #define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
 385 #define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
 386 #define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
 387 #define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
 388 #define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
 389
 390 /* Misc types.  */
 391 #define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
 392 #define XMISCTYPE(a)   (XMARKER (a)->type)
 393 #define XMARKER(a) (&(XMISC(a)->u_marker))
 394 #define XINTFWD(a) (&(XMISC(a)->u_intfwd))
 395 #define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
 396 #define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
 397 #define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
 398 #define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
 399 #define XOVERLAY(a) (&(XMISC(a)->u_overlay))
 400 #define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
 401
 402 /* Pseudovector types.  */
 403 #define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
 404 #define XWINDOW(a) ((struct window *) XPNTR(a))
 405 #define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
 406 #define XBUFFER(a) ((struct buffer *) XPNTR(a))
 407 #define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
 408 #define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
 409
 410
 411 /* Construct a Lisp_Object from a value or address.  */
 412
 413 #define XSETINT(a, b) XSET (a, Lisp_Int, b)
 414 #define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
 415 #define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
 416 #define XSETSTRING(a, b) XSET (a, Lisp_String, b)
 417 #define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
 418 #define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
 419
 420 /* Misc types.  */
 421 #define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
 422 #define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
 423
 424 /* Pseudovector types.  */
 425 #define XSETPSEUDOVECTOR(a, b, code) \
 426   (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
 427 #define XSETWINDOW_CONFIGURATION(a, b) \
 428   (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
 429 #define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
 430 #define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
 431 #define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
 432 #define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
 433 #define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
 434 #define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
 435 #define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
 436 \f
 437 #ifdef USE_TEXT_PROPERTIES
 438 /* Basic data type for use of intervals.  See the macros in intervals.h.  */
 439
 440 struct interval
 441 {
 442   /* The first group of entries deal with the tree structure.  */
 443
 444   unsigned int total_length;    /* Length of myself and both children.  */
 445   unsigned int position;        /* Cache of interval's character position.  */
 446   struct interval *left;        /* Intervals which precede me.  */
 447   struct interval *right;       /* Intervals which succeed me.  */
 448
 449   /* Parent in the tree, or the Lisp_Object containing this interval tree.
 450
 451      The mark bit on the root interval of an interval tree says
 452      whether we have started (and possibly finished) marking the
 453      tree.  If GC comes across an interval tree whose root's parent
 454      field has its markbit set, it leaves the tree alone.
 455
 456      You'd think we could store this information in the parent object
 457      somewhere (after all, that should be visited once and then
 458      ignored too, right?), but strings are GC'd strangely.  */
 459   struct interval *parent;
 460
 461   /* The remaining components are `properties' of the interval.
 462      The first four are duplicates for things which can be on the list,
 463      for purposes of speed.  */
 464
 465   unsigned char write_protect;      /* Non-zero means can't modify.  */
 466   unsigned char visible;            /* Zero means don't display.  */
 467   unsigned char front_sticky;       /* Non-zero means text inserted just
 468                                        before this interval goes into it.  */
 469   unsigned char rear_sticky;        /* Likewise for just after it.  */
 470
 471   /* Properties of this interval.
 472      The mark bit on this field says whether this particular interval
 473      tree node has been visited.  Since intervals should never be
 474      shared, GC aborts if it seems to have visited an interval twice.  */
 475   Lisp_Object plist;
 476 };
 477
 478 typedef struct interval *INTERVAL;
 479
 480 /* Complain if object is not string or buffer type */
 481 #define CHECK_STRING_OR_BUFFER(x, i) \
 482   { if (!STRINGP ((x)) && !BUFFERP ((x))) \
 483       x = wrong_type_argument (Qbuffer_or_string_p, (x)); }
 484
 485 /* Macro used to conditionally compile intervals into certain data
 486    structures.  See, e.g., struct Lisp_String below.  */
 487 #define DECLARE_INTERVALS INTERVAL intervals;
 488
 489 /* Macro used to conditionally compile interval initialization into
 490    certain code.  See, e.g., alloc.c.  */
 491 #define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val
 492
 493 #else  /* No text properties */
 494
 495 /* If no intervals are used, make the above definitions go away.  */
 496
 497 #define CHECK_STRING_OR_BUFFER(x, i)
 498
 499 #define INTERVAL
 500 #define DECLARE_INTERVALS
 501 #define INITIALIZE_INTERVAL(ptr,val)
 502
 503 #endif /* USE_TEXT_PROPERTIES */
 504 \f
 505 /* In a cons, the markbit of the car is the gc mark bit */
 506
 507 struct Lisp_Cons
 508   {
 509     Lisp_Object car, cdr;
 510   };
 511
 512 /* Like a cons, but records info on where the text lives that it was read from */
 513 /* This is not really in use now */
 514
 515 struct Lisp_Buffer_Cons
 516   {
 517     Lisp_Object car, cdr;
 518     struct buffer *buffer;
 519     int bufpos;
 520   };
 521
 522 /* In a string or vector, the sign bit of the `size' is the gc mark bit */
 523
 524 struct Lisp_String
 525   {
 526     EMACS_INT size;
 527     DECLARE_INTERVALS           /* `data' field must be last.  */
 528     unsigned char data[1];
 529   };
 530
 531 /* If a struct is made to look like a vector, this macro returns the length
 532    of that vector.  */
 533 #define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector)    \
 534                                          - sizeof (Lisp_Object)))       \
 535                        / sizeof (Lisp_Object))
 536
 537 struct Lisp_Vector
 538   {
 539     EMACS_INT size;
 540     struct Lisp_Vector *next;
 541     Lisp_Object contents[1];
 542   };
 543
 544 /* A char table is a kind of vectorlike, with contents are like a vector
 545    but with a few other slots.  For some purposes, it makes sense
 546    to handle a chartable with type struct Lisp_Vector.  */
 547
 548 /* This is the number of slots that apply to characters
 549    or character sets.  */
 550 #define CHAR_TABLE_ORDINARY_SLOTS 256
 551
 552 /* This is the number of slots that every char table must have.
 553    This counts the ordinary slots and the parent and defalt slots.  */
 554 #define CHAR_TABLE_STANDARD_SLOTS (256+2)
 555
 556 /* Return the number of "extra" slots in the char table CT.  */
 557
 558 #define CHAR_TABLE_EXTRA_SLOTS(CT)      \
 559   (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
 560
 561 struct Lisp_Char_Table
 562   {
 563     /* This is the vector's size field, which also holds the
 564        pseudovector type information.  It holds the size, too.
 565        The size counts the defalt and parent slots.  */
 566     EMACS_INT size;
 567     struct Lisp_Vector *next;
 568     Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];
 569     /* This holds a default value,
 570        which is used whenever the value for a specific character is nil.  */
 571     Lisp_Object defalt;
 572     /* This points to another char table, which we inherit from
 573        when the value for a specific character is nil.
 574        The `defalt' slot takes precedence over this.  */
 575     Lisp_Object parent;
 576     /* These hold additional data.  */
 577     Lisp_Object extras[1];
 578   };
 579
 580 /* A boolvector is a kind of vectorlike, with contents are like a string.  */
 581 struct Lisp_Bool_Vector
 582   {
 583     /* This is the vector's size field.  It doesn't have the real size,
 584        just the subtype information.  */
 585     EMACS_INT vector_size;
 586     struct Lisp_Vector *next;
 587     /* This is the size in bits.  */
 588     EMACS_INT size;
 589     /* This contains the actual bits, packed into bytes.  */
 590     unsigned char data[1];
 591   };
 592
 593 /* In a symbol, the markbit of the plist is used as the gc mark bit */
 594
 595 struct Lisp_Symbol
 596   {
 597     struct Lisp_String *name;
 598     Lisp_Object value;
 599     Lisp_Object function;
 600     Lisp_Object plist;
 601     struct Lisp_Symbol *next;   /* -> next symbol in this obarray bucket */
 602   };
 603
 604 /* This structure describes a built-in function.
 605    It is generated by the DEFUN macro only.
 606    defsubr makes it into a Lisp object.
 607
 608    This type is treated in most respects as a pseudovector,
 609    but since we never dynamically allocate or free them,
 610    we don't need a next-vector field.  */
 611
 612 struct Lisp_Subr
 613   {
 614     EMACS_INT size;
 615     Lisp_Object (*function) ();
 616     short min_args, max_args;
 617     char *symbol_name;
 618     char *prompt;
 619     char *doc;
 620   };
 621 \f
 622 /* These structures are used for various misc types.  */
 623
 624 /* A miscellaneous object, when it's on the free list.  */
 625 struct Lisp_Free
 626   {
 627     int type : 16;      /* = Lisp_Misc_Free */
 628     int spacer : 16;
 629     union Lisp_Misc *chain;
 630   };
 631
 632 /* In a marker, the markbit of the chain field is used as the gc mark bit */
 633 struct Lisp_Marker
 634 {
 635   int type : 16;                /* = Lisp_Misc_Marker */
 636   int spacer : 15;
 637   /* 1 means normal insertion at the marker's position
 638      leaves the marker after the inserted text.  */
 639   unsigned int insertion_type : 1;
 640   struct buffer *buffer;
 641   Lisp_Object chain;
 642   int bufpos;
 643 };
 644
 645 /* Forwarding pointer to an int variable.
 646    This is allowed only in the value cell of a symbol,
 647    and it means that the symbol's value really lives in the
 648    specified int variable.  */
 649 struct Lisp_Intfwd
 650   {
 651     int type : 16;      /* = Lisp_Misc_Intfwd */
 652     int spacer : 16;
 653     int *intvar;
 654   };
 655
 656 /* Boolean forwarding pointer to an int variable.
 657    This is like Lisp_Intfwd except that the ostensible
 658    "value" of the symbol is t if the int variable is nonzero,
 659    nil if it is zero.  */
 660 struct Lisp_Boolfwd
 661   {
 662     int type : 16;      /* = Lisp_Misc_Boolfwd */
 663     int spacer : 16;
 664     int *boolvar;
 665   };
 666
 667 /* Forwarding pointer to a Lisp_Object variable.
 668    This is allowed only in the value cell of a symbol,
 669    and it means that the symbol's value really lives in the
 670    specified variable.  */
 671 struct Lisp_Objfwd
 672   {
 673     int type : 16;      /* = Lisp_Misc_Objfwd */
 674     int spacer : 16;
 675     Lisp_Object *objvar;
 676   };
 677
 678 /* Like Lisp_Objfwd except that value lives in a slot in the
 679    current buffer.  Value is byte index of slot within buffer.  */
 680 struct Lisp_Buffer_Objfwd
 681   {
 682     int type : 16;      /* = Lisp_Misc_Buffer_Objfwd */
 683     int spacer : 16;
 684     int offset;
 685   };
 686
 687 /* Used in a symbol value cell when the symbol's value is per-buffer.
 688    The actual contents resemble a cons cell which starts a list like this:
 689    (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).
 690
 691    The cons-like structure is for historical reasons; it might be better
 692    to just put these elements into the struct, now.
 693
 694    BUFFER is the last buffer for which this symbol's value was
 695    made up to date.
 696
 697    CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
 698    local_var_alist, that being the element whose car is this
 699    variable.  Or it can be a pointer to the
 700    (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
 701    if BUFFER does not have an element in its alist for this
 702    variable (that is, if BUFFER sees the default value of this
 703    variable).
 704
 705    If we want to examine or set the value and BUFFER is current,
 706    we just examine or set REALVALUE.  If BUFFER is not current, we
 707    store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
 708    then find the appropriate alist element for the buffer now
 709    current and set up CURRENT-ALIST-ELEMENT.  Then we set
 710    REALVALUE out of that element, and store into BUFFER.
 711
 712    If we are setting the variable and the current buffer does not
 713    have an alist entry for this variable, an alist entry is
 714    created.
 715
 716    Note that REALVALUE can be a forwarding pointer.  Each time it
 717    is examined or set, forwarding must be done.  Each time we
 718    switch buffers, buffer-local variables which forward into C
 719    variables are swapped immediately, so the C code can assume
 720    that they are always up to date.
 721
 722    Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
 723    use the same substructure.  The difference is that with the latter,
 724    merely setting the variable while some buffer is current
 725    does not cause that buffer to have its own local value of this variable.
 726    Only make-local-variable does that.  */
 727 struct Lisp_Buffer_Local_Value
 728   {
 729     int type : 16; /* = Lisp_Misc_Buffer_Local_Value
 730                                       or Lisp_Misc_Some_Buffer_Local_Value */
 731     int spacer : 16;
 732     Lisp_Object car, cdr;
 733   };
 734
 735 /* In an overlay object, the mark bit of the plist is used as the GC mark.
 736    START and END are markers in the overlay's buffer, and
 737    PLIST is the overlay's property list.  */
 738 struct Lisp_Overlay
 739   {
 740     int type : 16;      /* = Lisp_Misc_Overlay */
 741     int spacer : 16;
 742     Lisp_Object start, end, plist;
 743   };
 744
 745 /* Like Lisp_Objfwd except that value lives in a slot in the
 746    current kboard.  */
 747 struct Lisp_Kboard_Objfwd
 748   {
 749     int type : 16;      /* = Lisp_Misc_Kboard_Objfwd */
 750     int spacer : 16;
 751     int offset;
 752   };
 753
 754
 755 /* To get the type field of a union Lisp_Misc, use XMISCTYPE.
 756    It uses one of these struct subtypes to get the type field.  */
 757
 758 union Lisp_Misc
 759   {
 760     struct Lisp_Free u_free;
 761     struct Lisp_Marker u_marker;
 762     struct Lisp_Intfwd u_intfwd;
 763     struct Lisp_Boolfwd u_boolfwd;
 764     struct Lisp_Objfwd u_objfwd;
 765     struct Lisp_Buffer_Objfwd u_buffer_objfwd;
 766     struct Lisp_Buffer_Local_Value u_buffer_local_value;
 767     struct Lisp_Overlay u_overlay;
 768     struct Lisp_Kboard_Objfwd u_kboard_objfwd;
 769   };
 770 \f
 771 #ifdef LISP_FLOAT_TYPE
 772 /* Optional Lisp floating point type */
 773 struct Lisp_Float
 774   {
 775     Lisp_Object type;           /* essentially used for mark-bit
 776                                    and chaining when on free-list */
 777     double data;
 778   };
 779 #endif /* LISP_FLOAT_TYPE */
 780
 781 /* A character, declared with the following typedef, is a member
 782    of some character set associated with the current buffer.  */
 783 #ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
 784 #define _UCHAR_T
 785 typedef unsigned char UCHAR;
 786 #endif
 787
 788 /* Meanings of slots in a Lisp_Compiled:  */
 789
 790 #define COMPILED_ARGLIST 0
 791 #define COMPILED_BYTECODE 1
 792 #define COMPILED_CONSTANTS 2
 793 #define COMPILED_STACK_DEPTH 3
 794 #define COMPILED_DOC_STRING 4
 795 #define COMPILED_INTERACTIVE 5
 796
 797 /* Flag bits in a character.  These also get used in termhooks.h.
 798    Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
 799    (MUlti-Lingual Emacs) might need 22 bits for the character value
 800    itself, so we probably shouldn't use any bits lower than 0x0400000.  */
 801 #define CHAR_ALT   (0x0400000)
 802 #define CHAR_SUPER (0x0800000)
 803 #define CHAR_HYPER (0x1000000)
 804 #define CHAR_SHIFT (0x2000000)
 805 #define CHAR_CTL   (0x4000000)
 806 #define CHAR_META  (0x8000000)
 807
 808 #ifdef USE_X_TOOLKIT
 809 #ifdef NO_UNION_TYPE
 810 /* Use this for turning a (void *) into a Lisp_Object, as when the
 811    Lisp_Object is passed into a toolkit callback function.  */
 812 #define VOID_TO_LISP(larg,varg) \
 813   do { ((larg) = ((Lisp_Object) (varg))); } while (0)
 814 #define CVOID_TO_LISP VOID_TO_LISP
 815
 816 /* Use this for turning a Lisp_Object into a  (void *), as when the
 817    Lisp_Object is passed into a toolkit callback function.  */
 818 #define LISP_TO_VOID(larg) ((void *) (larg))
 819 #define LISP_TO_CVOID(varg) ((const void *) (larg))
 820
 821 #else /* not NO_UNION_TYPE */
 822 /* Use this for turning a (void *) into a Lisp_Object, as when the
 823   Lisp_Object is passed into a toolkit callback function.  */
 824 #define VOID_TO_LISP(larg,varg) \
 825   do { ((larg).v = (void *) (varg)); } while (0)
 826 #define CVOID_TO_LISP(larg,varg) \
 827   do { ((larg).cv = (const void *) (varg)); } while (0)
 828
 829 /* Use this for turning a Lisp_Object into a  (void *), as when the
 830    Lisp_Object is passed into a toolkit callback function.  */
 831 #define LISP_TO_VOID(larg) ((larg).v)
 832 #define LISP_TO_CVOID(larg) ((larg).cv)
 833 #endif /* not NO_UNION_TYPE */
 834 #endif /* USE_X_TOOLKIT */
 835
 836 \f
 837 /* The glyph datatype, used to represent characters on the display.  */
 838
 839 /* The low eight bits are the character code, and the bits above them
 840    are the numeric face ID.  If FID is the face ID of a glyph on a
 841    frame F, then F->display.x->faces[FID] contains the description of
 842    that face.  This is an int instead of a short, so we can support a
 843    good bunch of face ID's; given that we have no mechanism for
 844    tossing unused frame face ID's yet, we'll probably run out of 255
 845    pretty quickly.  */
 846 #define GLYPH unsigned int
 847
 848 #ifdef HAVE_FACES
 849 /* The FAST macros assume that we already know we're in an X window.  */
 850
 851 /* Given a character code and a face ID, return the appropriate glyph.  */
 852 #define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
 853
 854 /* Return a glyph's character code.  */
 855 #define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
 856
 857 /* Return a glyph's face ID.  */
 858 #define FAST_GLYPH_FACE(glyph) (((glyph) >> 8) & ((1 << 24) - 1))
 859
 860 /* Slower versions that test the frame type first.  */
 861 #define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
 862                                    : FAST_MAKE_GLYPH (char, face))
 863 #define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
 864 #define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
 865 #else /* not HAVE_FACES */
 866 #define MAKE_GLYPH(f, char, face) (char)
 867 #define GLYPH_CHAR(f, g) (g)
 868 #define GLYPH_FACE(f, g) (g)
 869 #endif /* not HAVE_FACES */
 870
 871 /* The ID of the mode line highlighting face.  */
 872 #define GLYPH_MODE_LINE_FACE 1
 873 \f
 874 /* Data type checking */
 875
 876 #define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
 877 #define GC_NILP(x) GC_EQ (x, Qnil)
 878
 879 #ifdef LISP_FLOAT_TYPE
 880 #define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
 881 #define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
 882 #else
 883 #define NUMBERP(x) (INTEGERP (x))
 884 #define GC_NUMBERP(x) (GC_INTEGERP (x))
 885 #endif
 886 #define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
 887 #define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
 888
 889 #define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
 890 #define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
 891 #define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
 892 #define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
 893 #define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
 894 #define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
 895 #define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
 896 #define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
 897 #define STRINGP(x) (XTYPE ((x)) == Lisp_String)
 898 #define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
 899 #define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
 900 #define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
 901
 902 #ifdef LISP_FLOAT_TYPE
 903 #define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
 904 #define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
 905 #else
 906 #define FLOATP(x) (0)
 907 #define GC_FLOATP(x) (0)
 908 #endif
 909 #define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
 910 #define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
 911 #define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
 912 #define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
 913 #define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
 914 #define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
 915 #define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
 916 #define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
 917 #define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
 918 #define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
 919 #define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
 920 #define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
 921 #define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
 922 #define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
 923 #define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
 924 #define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
 925 #define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
 926 #define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
 927 #define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
 928 #define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
 929
 930
 931 /* True if object X is a pseudovector whose code is CODE.  */
 932 #define PSEUDOVECTORP(x, code)                                  \
 933   (VECTORLIKEP (x)                                              \
 934    && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))     \
 935        == (PSEUDOVECTOR_FLAG | (code))))
 936
 937 /* True if object X is a pseudovector whose code is CODE.
 938    This one works during GC.  */
 939 #define GC_PSEUDOVECTORP(x, code)                               \
 940   (GC_VECTORLIKEP (x)                                           \
 941    && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))     \
 942        == (PSEUDOVECTOR_FLAG | (code))))
 943
 944 /* Test for specific pseudovector types.  */
 945 #define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
 946 #define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
 947 #define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
 948 #define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
 949 #define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
 950 #define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
 951 #define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
 952 #define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
 953 #define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
 954 #define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
 955 #define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
 956 #define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
 957 #define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
 958 #define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
 959 #define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
 960 #define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
 961
 962 #ifdef MULTI_FRAME
 963 #define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
 964 #define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
 965 #else
 966 #ifdef HAVE_MOUSE
 967 /* We could use this in the !HAVE_MOUSE case also, but we prefer a compile-time
 968    error message in case FRAMEP is used.  */
 969 #define FRAMEP(x) (EQ (x, Fselected_frame ()))
 970 #define GC_FRAMEP(x) (GC_EQ (x, Fselected_frame ()))
 971 #endif
 972 #endif
 973
 974 \f
 975 #define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
 976 #define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
 977
 978 #define CHECK_LIST(x, i) \
 979   do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
 980
 981 #define CHECK_STRING(x, i) \
 982   do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
 983
 984 #define CHECK_CONS(x, i) \
 985   do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
 986
 987 #define CHECK_SYMBOL(x, i) \
 988   do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
 989
 990 #define CHECK_CHAR_TABLE(x, i) \
 991   do { if (!CHAR_TABLE_P ((x)) && !NILP (x))                            \
 992          x = wrong_type_argument (Qchar_table_p, (x)); } while (0)
 993
 994 #define CHECK_VECTOR(x, i) \
 995   do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
 996
 997 #define CHECK_BUFFER(x, i) \
 998   do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
 999
1000 #define CHECK_WINDOW(x, i) \
1001   do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
1002
1003 /* This macro rejects windows on the interior of the window tree as
1004    "dead", which is what we want; this is an argument-checking macro, and
1005    the user should never get access to interior windows.
1006
1007    A window of any sort, leaf or interior, is dead iff the buffer,
1008    vchild, and hchild members are all nil.  */
1009
1010 #define CHECK_LIVE_WINDOW(x, i)                         \
1011   do {                                                  \
1012     if (!WINDOWP ((x))                                  \
1013         || NILP (XWINDOW ((x))->buffer))                \
1014       x = wrong_type_argument (Qwindow_live_p, (x));    \
1015   } while (0)
1016
1017 #define CHECK_PROCESS(x, i) \
1018   do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
1019
1020 #define CHECK_NUMBER(x, i) \
1021   do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
1022
1023 #define CHECK_NATNUM(x, i) \
1024   do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
1025
1026 #define CHECK_MARKER(x, i) \
1027   do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
1028
1029 #define CHECK_NUMBER_COERCE_MARKER(x, i) \
1030   do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1031     else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
1032
1033 #ifdef LISP_FLOAT_TYPE
1034
1035 #ifndef DBL_DIG
1036 #define DBL_DIG 20
1037 #endif
1038
1039 #define XFLOATINT(n) extract_float((n))
1040
1041 #define CHECK_FLOAT(x, i)               \
1042   do { if (!FLOATP (x))                 \
1043     x = wrong_type_argument (Qfloatp, (x)); } while (0)
1044
1045 #define CHECK_NUMBER_OR_FLOAT(x, i)     \
1046   do { if (!FLOATP (x) && !INTEGERP (x))        \
1047     x = wrong_type_argument (Qnumberp, (x)); } while (0)
1048
1049 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
1050   do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));   \
1051   else if (!INTEGERP (x) && !FLOATP (x))                \
1052     x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
1053
1054 #else  /* Not LISP_FLOAT_TYPE */
1055
1056 #define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER
1057
1058 #define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER
1059
1060 #define XFLOATINT(n) XINT((n))
1061 #endif /* LISP_FLOAT_TYPE */
1062
1063 #define CHECK_OVERLAY(x, i) \
1064   do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
1065
1066 /* Cast pointers to this type to compare them.  Some machines want int.  */
1067 #ifndef PNTR_COMPARISON_TYPE
1068 #define PNTR_COMPARISON_TYPE unsigned int
1069 #endif
1070 \f
1071 /* Define a built-in function for calling from Lisp.
1072  `lname' should be the name to give the function in Lisp,
1073     as a null-terminated C string.
1074  `fnname' should be the name of the function in C.
1075     By convention, it starts with F.
1076  `sname' should be the name for the C constant structure
1077     that records information on this function for internal use.
1078     By convention, it should be the same as `fnname' but with S instead of F.
1079     It's too bad that C macros can't compute this from `fnname'.
1080  `minargs' should be a number, the minimum number of arguments allowed.
1081  `maxargs' should be a number, the maximum number of arguments allowed,
1082     or else MANY or UNEVALLED.
1083     MANY means pass a vector of evaluated arguments,
1084          in the form of an integer number-of-arguments
1085          followed by the address of a vector of Lisp_Objects
1086          which contains the argument values.
1087     UNEVALLED means pass the list of unevaluated arguments
1088  `prompt' says how to read arguments for an interactive call.
1089     See the doc string for `interactive'.
1090     A null string means call interactively with no arguments.
1091  `doc' is documentation for the user.  */
1092
1093 #if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1094 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc)      \
1095   Lisp_Object fnname ();                                                \
1096   struct Lisp_Subr sname =                                              \
1097     { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)),     \
1098       fnname, minargs, maxargs, lname, prompt, 0};                      \
1099   Lisp_Object fnname
1100
1101 #else
1102
1103 /* This version of DEFUN declares a function prototype with the right
1104    arguments, so we can catch errors with maxargs at compile-time.  */
1105 #define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc)      \
1106   Lisp_Object fnname DEFUN_ARGS_ ## maxargs ;                           \
1107   struct Lisp_Subr sname =                                              \
1108     { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)),     \
1109       fnname, minargs, maxargs, lname, prompt, 0};                      \
1110   Lisp_Object fnname
1111
1112 /* Note that the weird token-substitution semantics of ANSI C makes
1113    this work for MANY and UNEVALLED.  */
1114 #define DEFUN_ARGS_MANY         (int, Lisp_Object *)
1115 #define DEFUN_ARGS_UNEVALLED    (Lisp_Object)
1116 #define DEFUN_ARGS_0    (void)
1117 #define DEFUN_ARGS_1    (Lisp_Object)
1118 #define DEFUN_ARGS_2    (Lisp_Object, Lisp_Object)
1119 #define DEFUN_ARGS_3    (Lisp_Object, Lisp_Object, Lisp_Object)
1120 #define DEFUN_ARGS_4    (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
1121 #define DEFUN_ARGS_5    (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1122                          Lisp_Object)
1123 #define DEFUN_ARGS_6    (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1124                          Lisp_Object, Lisp_Object)
1125 #define DEFUN_ARGS_7    (Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
1126                          Lisp_Object, Lisp_Object, Lisp_Object)
1127 #endif
1128
1129 /* defsubr (Sname);
1130  is how we define the symbol for function `name' at start-up time.  */
1131 extern void defsubr ();
1132
1133 #define MANY -2
1134 #define UNEVALLED -1
1135
1136 extern void defvar_lisp ();
1137 extern void defvar_bool ();
1138 extern void defvar_int ();
1139 extern void defvar_kboard ();
1140
1141 /* Macros we use to define forwarded Lisp variables.
1142    These are used in the syms_of_FILENAME functions.  */
1143
1144 #define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
1145 #define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
1146 #define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
1147 #define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
1148 #define DEFVAR_PER_BUFFER(lname, vname, type, doc)  \
1149  defvar_per_buffer (lname, vname, type, 0)
1150 #define DEFVAR_KBOARD(lname, vname, doc) \
1151  defvar_kboard (lname, \
1152                 (int)((char *)(&current_kboard->vname) \
1153                       - (char *)current_kboard))
1154 \f
1155 /* Structure for recording Lisp call stack for backtrace purposes.  */
1156
1157 /* The special binding stack holds the outer values of variables while
1158    they are bound by a function application or a let form, stores the
1159    code to be executed for Lisp unwind-protect forms, and stores the C
1160    functions to be called for record_unwind_protect.
1161
1162    If func is non-zero, undoing this binding applies func to old_value;
1163       This implements record_unwind_protect.
1164    If func is zero and symbol is nil, undoing this binding evaluates
1165       the list of forms in old_value; this implements Lisp's unwind-protect
1166       form.
1167    Otherwise, undoing this binding stores old_value as symbol's value; this
1168       undoes the bindings made by a let form or function call.  */
1169 struct specbinding
1170   {
1171     Lisp_Object symbol, old_value;
1172     Lisp_Object (*func) ();
1173     Lisp_Object unused;         /* Dividing by 16 is faster than by 12 */
1174   };
1175
1176 extern struct specbinding *specpdl;
1177 extern struct specbinding *specpdl_ptr;
1178 extern int specpdl_size;
1179
1180 /* Everything needed to describe an active condition case.  */
1181 struct handler
1182   {
1183     /* The handler clauses and variable from the condition-case form.  */
1184     Lisp_Object handler;
1185     Lisp_Object var;
1186     /* Fsignal stores here the condition-case clause that applies,
1187        and Fcondition_case thus knows which clause to run.  */
1188     Lisp_Object chosen_clause;
1189
1190     /* Used to effect the longjump out to the handler.  */
1191     struct catchtag *tag;
1192
1193     /* The next enclosing handler.  */
1194     struct handler *next;
1195   };
1196
1197 extern struct handler *handlerlist;
1198
1199 extern struct catchtag *catchlist;
1200 extern struct backtrace *backtrace_list;
1201
1202 extern Lisp_Object memory_signal_data;
1203
1204 /* An address near the bottom of the stack.
1205    Tells GC how to save a copy of the stack.  */
1206 extern char *stack_bottom;
1207
1208 /* Check quit-flag and quit if it is non-nil.  */
1209
1210 #define QUIT \
1211   if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
1212     { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }
1213
1214 /* Nonzero if ought to quit now.  */
1215
1216 #define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
1217 \f
1218 /* 1 if CH is upper case.  */
1219
1220 #define UPPERCASEP(CH) \
1221   (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
1222
1223 /* 1 if CH is lower case.  */
1224
1225 #define LOWERCASEP(CH) \
1226   (!UPPERCASEP (CH) \
1227    && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
1228
1229 /* 1 if CH is neither upper nor lower case.  */
1230
1231 #define NOCASEP(CH) (XSTRING (current_buffer->upcase_table)->data[CH] == (CH))
1232
1233 /* Upcase a character, or make no change if that cannot be done.  */
1234
1235 #define UPCASE(CH) \
1236   (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
1237    ? UPCASE1 (CH) : (CH))
1238
1239 /* Upcase a character known to be not upper case.  */
1240
1241 #define UPCASE1(CH) (XSTRING (current_buffer->upcase_table)->data[CH])
1242
1243 /* Downcase a character, or make no change if that cannot be done.  */
1244
1245 #define DOWNCASE(CH) (XSTRING (current_buffer->downcase_table)->data[CH])
1246
1247 /* Current buffer's map from characters to lower-case characters.  */
1248
1249 #define DOWNCASE_TABLE XSTRING (current_buffer->downcase_table)->data
1250
1251 /* Table mapping each char to the next char with the same lowercase version.
1252    This mapping is a no-op only for characters that don't have case.  */
1253 #define UPCASE_TABLE XSTRING (current_buffer->upcase_table)->data
1254
1255 extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
1256 extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
1257 \f
1258 /* Number of bytes of structure consed since last GC.  */
1259
1260 extern int consing_since_gc;
1261
1262 /* Threshold for doing another gc.  */
1263
1264 extern int gc_cons_threshold;
1265
1266 /* Structure for recording stack slots that need marking.  */
1267
1268 /* This is a chain of structures, each of which points at a Lisp_Object variable
1269  whose value should be marked in garbage collection.
1270  Normally every link of the chain is an automatic variable of a function,
1271  and its `val' points to some argument or local variable of the function.
1272  On exit to the function, the chain is set back to the value it had on entry.
1273  This way, no link remains in the chain when the stack frame containing the
1274  link disappears.
1275
1276  Every function that can call Feval must protect in this fashion all
1277  Lisp_Object variables whose contents will be used again.  */
1278
1279 extern struct gcpro *gcprolist;
1280
1281 struct gcpro
1282   {
1283     struct gcpro *next;
1284     Lisp_Object *var;           /* Address of first protected variable */
1285     int nvars;                  /* Number of consecutive protected variables */
1286   };
1287
1288 #define GCPRO1(varname) \
1289  {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
1290   gcprolist = &gcpro1; }
1291
1292 #define GCPRO2(varname1, varname2) \
1293  {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1294   gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1295   gcprolist = &gcpro2; }
1296
1297 #define GCPRO3(varname1, varname2, varname3) \
1298  {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1299   gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1300   gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1301   gcprolist = &gcpro3; }
1302
1303 #define GCPRO4(varname1, varname2, varname3, varname4) \
1304  {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1305   gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1306   gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1307   gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1308   gcprolist = &gcpro4; }
1309
1310 #define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
1311  {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
1312   gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
1313   gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
1314   gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
1315   gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
1316   gcprolist = &gcpro5; }
1317
1318 /* Call staticpro (&var) to protect static variable `var'.  */
1319
1320 void staticpro();
1321
1322 #define UNGCPRO (gcprolist = gcpro1.next)
1323
1324 /* Evaluate expr, UNGCPRO, and then return the value of expr.  */
1325 #define RETURN_UNGCPRO(expr)                    \
1326 if (1)                                          \
1327     {                                           \
1328       Lisp_Object ret_ungc_val;                 \
1329       ret_ungc_val = (expr);                    \
1330       UNGCPRO;                                  \
1331       return ret_ungc_val;                      \
1332     }                                           \
1333 else
1334 \f
1335 /* Defined in data.c */
1336 extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
1337 extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
1338 extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
1339 extern Lisp_Object Qvoid_variable, Qvoid_function;
1340 extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
1341 extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
1342 extern Lisp_Object Qend_of_file, Qarith_error;
1343 extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
1344 extern Lisp_Object Qmark_inactive;
1345
1346 extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
1347 extern Lisp_Object Qoverflow_error, Qunderflow_error;
1348
1349 extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
1350 extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
1351 extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
1352 extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
1353 extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
1354 extern Lisp_Object Qchar_table_p;
1355 extern Lisp_Object Qboundp, Qfboundp;
1356 extern Lisp_Object Qbuffer_or_string_p;
1357 extern Lisp_Object Qcdr;
1358
1359 #ifdef LISP_FLOAT_TYPE
1360 extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
1361 #endif /* LISP_FLOAT_TYPE */
1362
1363 extern Lisp_Object Qframep;
1364
1365 extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
1366 extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
1367 extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
1368 extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
1369 extern Lisp_Object Finteger_or_marker_p ();
1370 #ifdef LISP_FLOAT_TYPE
1371 extern Lisp_Object Ffloatp(), Finteger_or_floatp();
1372 extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
1373 #endif /* LISP_FLOAT_TYPE */
1374
1375 extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
1376 extern Lisp_Object Fsetcar (), Fsetcdr ();
1377 extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
1378 extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
1379 extern Lisp_Object indirect_function (), Findirect_function ();
1380 extern Lisp_Object Ffset (), Fsetplist ();
1381 extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
1382 extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
1383
1384 extern Lisp_Object Faref (), Faset ();
1385
1386 extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
1387 extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq ();
1388 extern Lisp_Object Fneq (), Fzerop ();
1389 extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem ();
1390 extern Lisp_Object Fmax (), Fmin ();
1391 extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot ();
1392 extern Lisp_Object Flsh (), Fash ();
1393
1394 extern Lisp_Object Fadd1 (), Fsub1 ();
1395
1396 extern Lisp_Object make_number ();
1397 extern Lisp_Object   long_to_cons ();
1398 extern unsigned long cons_to_long ();
1399 extern void args_out_of_range ();
1400 extern void args_out_of_range_3 ();
1401 extern Lisp_Object wrong_type_argument ();
1402 extern void store_symval_forwarding ();
1403 extern Lisp_Object do_symval_forwarding ();
1404 #ifdef LISP_FLOAT_TYPE
1405 extern Lisp_Object Ffloat_to_int(), Fint_to_float();
1406 extern double extract_float();
1407 extern Lisp_Object make_float ();
1408 extern Lisp_Object Ffloat ();
1409 #endif /* LISP_FLOAT_TYPE */
1410
1411 /* Defined in cmds.c */
1412 extern Lisp_Object Fend_of_line (), Fforward_char (), Fforward_line ();
1413
1414 /* Defined in syntax.c */
1415 extern Lisp_Object Fforward_word ();
1416
1417 /* Defined in fns.c */
1418 extern Lisp_Object Qstring_lessp;
1419 extern Lisp_Object Vfeatures;
1420 extern Lisp_Object Fidentity (), Frandom ();
1421 extern Lisp_Object Flength (), Fsafe_length ();
1422 extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
1423 extern Lisp_Object Fsubstring ();
1424 extern Lisp_Object Fnth (), Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
1425 extern Lisp_Object Felt (), Fmember (), Frassq (), Fdelq (), Fsort ();
1426 extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
1427 extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
1428 extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
1429 extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
1430 extern Lisp_Object concat2 (), nconc2 ();
1431 extern Lisp_Object assq_no_quit ();
1432 extern Lisp_Object Fcopy_alist ();
1433 extern Lisp_Object Fplist_get ();
1434
1435 /* Defined in insdel.c */
1436 extern void move_gap ();
1437 extern void make_gap ();
1438 extern void insert ();
1439 extern void insert_and_inherit ();
1440 extern void insert_1 ();
1441 extern void insert_from_string ();
1442 extern void insert_from_buffer ();
1443 extern void insert_char ();
1444 extern void insert_string ();
1445 extern void insert_before_markers ();
1446 extern void insert_before_markers_and_inherit ();
1447 extern void insert_from_string_before_markers ();
1448 extern void del_range ();
1449 extern void del_range_1 ();
1450 extern void modify_region ();
1451 extern void prepare_to_modify_buffer ();
1452 extern void signal_before_change ();
1453 extern void signal_after_change ();
1454
1455 /* Defined in xdisp.c */
1456 extern Lisp_Object Vmessage_log_max;
1457 extern void message ();
1458 extern void message_nolog ();
1459 extern void message1 ();
1460 extern void message1_nolog ();
1461 extern void message2 ();
1462 extern void message2_nolog ();
1463 extern void message_dolog ();
1464 extern void message_log_maybe_newline ();
1465
1466 /* Defined in alloc.c */
1467 extern Lisp_Object Vpurify_flag;
1468 extern Lisp_Object Fcons (), Flist(), Fmake_list (), allocate_misc ();
1469 extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
1470 extern Lisp_Object Fmake_string (), build_string (), make_string ();
1471 extern Lisp_Object make_event_array (), make_uninit_string ();
1472 extern Lisp_Object Fpurecopy (), make_pure_string ();
1473 extern Lisp_Object pure_cons (), make_pure_vector ();
1474 extern Lisp_Object Fgarbage_collect ();
1475 extern Lisp_Object Fmake_byte_code ();
1476 extern struct Lisp_Vector *allocate_vectorlike ();
1477 extern int gc_in_progress;
1478
1479 /* Defined in print.c */
1480 extern Lisp_Object Vprin1_to_string_buffer;
1481 extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
1482 extern Lisp_Object Fterpri (), Fprint ();
1483 extern Lisp_Object Vstandard_output, Qstandard_output;
1484 extern Lisp_Object Qexternal_debugging_output;
1485 extern void temp_output_buffer_setup (), temp_output_buffer_show ();
1486 extern int print_level, print_escape_newlines;
1487 extern Lisp_Object Qprint_escape_newlines;
1488
1489 /* Defined in lread.c */
1490 extern Lisp_Object Qvariable_documentation, Qstandard_input;
1491 extern Lisp_Object Vobarray, Vstandard_input;
1492 extern Lisp_Object Fread (), Fread_from_string ();
1493 extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
1494 extern Lisp_Object Fget_file_char (), Fread_char ();
1495 extern Lisp_Object read_filtered_event ();
1496 extern Lisp_Object Feval_current_buffer (), Feval_region ();
1497 extern Lisp_Object intern (), oblookup ();
1498 #define LOADHIST_ATTACH(x) \
1499  if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
1500 extern Lisp_Object Vcurrent_load_list;
1501 extern Lisp_Object Vload_history;
1502
1503 /* Defined in eval.c */
1504 extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
1505 extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
1506 extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
1507 extern Lisp_Object Vautoload_queue;
1508 extern Lisp_Object Vdebug_on_error;
1509 /* To run a normal hook, use the appropriate function from the list below.
1510    The calling convention:
1511
1512    if (!NILP (Vrun_hooks))
1513      call1 (Vrun_hooks, Qmy_funny_hook);
1514
1515    should no longer be used.  */
1516 extern Lisp_Object Vrun_hooks;
1517 extern Lisp_Object Frun_hooks (), Frun_hook_with_args ();
1518 extern Lisp_Object Frun_hook_with_args_until_success ();
1519 extern Lisp_Object Frun_hook_with_args_until_failure ();
1520 extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
1521 extern Lisp_Object Fsetq (), Fquote ();
1522 extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
1523 extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
1524 extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
1525 extern Lisp_Object Fcondition_case (), Fsignal ();
1526 extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
1527 extern Lisp_Object Feval (), Fapply (), Ffuncall ();
1528 extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
1529 extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
1530 extern Lisp_Object call4 (), call5 (), call6 ();
1531 extern Lisp_Object Fkill_emacs (), Fkey_binding (), Fsit_for ();
1532 extern Lisp_Object Fdo_auto_save (), Fset_marker ();
1533 extern Lisp_Object apply_lambda ();
1534 extern Lisp_Object internal_catch ();
1535 extern Lisp_Object internal_condition_case ();
1536 extern Lisp_Object internal_condition_case_1 ();
1537 extern Lisp_Object unbind_to ();
1538 extern void error ();
1539 extern Lisp_Object un_autoload ();
1540 extern Lisp_Object Ffetch_bytecode ();
1541
1542 /* Defined in editfns.c */
1543 extern Lisp_Object Fgoto_char ();
1544 extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
1545 extern Lisp_Object Fpoint_min (), Fpoint_max ();
1546 extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
1547 extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
1548 extern Lisp_Object Finsert ();
1549 extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
1550 extern Lisp_Object Fformat (), format1 ();
1551 extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
1552 extern Lisp_Object Fbuffer_string ();
1553 extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
1554 extern Lisp_Object save_excursion_save (), save_restriction_save ();
1555 extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
1556 extern Lisp_Object Fchar_to_string ();
1557 extern Lisp_Object Fdelete_region (), Fnarrow_to_region (), Fwiden ();
1558
1559 /* defined in buffer.c */
1560 extern Lisp_Object Foverlay_start (), Foverlay_end ();
1561 extern void adjust_overlays_for_insert ();
1562 extern void adjust_overlays_for_delete ();
1563 extern void fix_overlays_in_range ();
1564 extern int overlay_touches_p ();
1565 extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
1566 extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
1567 extern Lisp_Object Fbarf_if_buffer_read_only ();
1568 extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
1569 extern Lisp_Object Fother_buffer ();
1570 extern Lisp_Object Foverlay_get ();
1571 extern Lisp_Object Qoverlayp;
1572 extern struct buffer *all_buffers;
1573
1574 /* defined in marker.c */
1575
1576 extern Lisp_Object Fmarker_position (), Fmarker_buffer ();
1577 extern Lisp_Object Fcopy_marker ();
1578
1579 /* Defined in fileio.c */
1580
1581 extern Lisp_Object Qfile_error;
1582 extern Lisp_Object Ffind_file_name_handler ();
1583 extern Lisp_Object Ffile_name_as_directory ();
1584 extern Lisp_Object Fexpand_file_name (), Ffile_name_nondirectory ();
1585 extern Lisp_Object Fsubstitute_in_file_name ();
1586 extern Lisp_Object Ffile_symlink_p ();
1587 extern Lisp_Object Fverify_visited_file_modtime ();
1588 extern Lisp_Object Ffile_exists_p ();
1589 extern Lisp_Object Ffile_name_absolute_p ();
1590 extern Lisp_Object Fdirectory_file_name ();
1591 extern Lisp_Object Ffile_name_directory ();
1592 extern Lisp_Object expand_and_dir_to_file ();
1593 extern Lisp_Object Ffile_accessible_directory_p ();
1594 extern Lisp_Object Funhandled_file_name_directory ();
1595
1596 /* Defined in abbrev.c */
1597
1598 extern Lisp_Object Vfundamental_mode_abbrev_table;
1599
1600 /* defined in search.c */
1601 extern Lisp_Object Fstring_match ();
1602 extern Lisp_Object Fscan_buffer ();
1603 extern void restore_match_data ();
1604 extern Lisp_Object Fmatch_data (), Fstore_match_data ();
1605 extern Lisp_Object Fmatch_beginning (), Fmatch_end ();
1606 extern Lisp_Object Fskip_chars_forward (), Fskip_chars_backward ();
1607
1608 /* defined in minibuf.c */
1609
1610 extern Lisp_Object last_minibuf_string;
1611 extern Lisp_Object read_minibuf (), Fcompleting_read ();
1612 extern Lisp_Object Fread_from_minibuffer ();
1613 extern Lisp_Object Fread_variable (), Fread_buffer (), Fread_key_sequence ();
1614 extern Lisp_Object Fread_minibuffer (), Feval_minibuffer ();
1615 extern Lisp_Object Fread_string (), Fread_file_name ();
1616 extern Lisp_Object Fread_no_blanks_input ();
1617
1618 /* Defined in callint.c */
1619
1620 extern Lisp_Object Qminus, Qplus, Vcurrent_prefix_arg;
1621 extern Lisp_Object Vcommand_history;
1622 extern Lisp_Object Qcall_interactively;
1623 extern Lisp_Object Fcall_interactively ();
1624 extern Lisp_Object Fprefix_numeric_value ();
1625
1626 /* defined in casefiddle.c */
1627
1628 extern Lisp_Object Fdowncase (), Fupcase (), Fcapitalize ();
1629 extern Lisp_Object Fupcase_initials (), Fupcase_initials_region ();
1630
1631 /* defined in keyboard.c */
1632
1633 extern Lisp_Object Qdisabled;
1634 extern Lisp_Object Vhelp_form, Vtop_level;
1635 extern Lisp_Object Fdiscard_input (), Frecursive_edit ();
1636 extern Lisp_Object Fcommand_execute (), Finput_pending_p ();
1637 extern Lisp_Object menu_bar_items ();
1638 extern Lisp_Object Qvertical_scroll_bar;
1639 #ifdef MULTI_KBOARD
1640 extern void delete_kboard ();
1641 #endif
1642
1643 /* defined in keymap.c */
1644
1645 extern Lisp_Object Qkeymap, Qmenu_bar;
1646 extern Lisp_Object current_global_map;
1647 extern Lisp_Object Fkey_description (), Fsingle_key_description ();
1648 extern Lisp_Object Fwhere_is_internal ();
1649 extern Lisp_Object access_keymap (), store_in_keymap ();
1650 extern Lisp_Object get_keyelt (), get_keymap (), get_keymap_1 ();
1651 extern void describe_map_tree ();
1652
1653 /* defined in indent.c */
1654 extern Lisp_Object Fvertical_motion (), Findent_to (), Fcurrent_column ();
1655
1656 /* defined in window.c */
1657 extern Lisp_Object Qwindowp, Qwindow_live_p;
1658 extern Lisp_Object Fget_buffer_window ();
1659 extern Lisp_Object Fsave_window_excursion ();
1660 extern Lisp_Object Fset_window_configuration (), Fcurrent_window_configuration ();
1661 extern Lisp_Object Fcoordinates_in_window_p ();
1662 extern Lisp_Object Fwindow_at ();
1663 extern int window_internal_height (), window_internal_width ();
1664
1665 /* defined in frame.c */
1666 extern Lisp_Object Qvisible;
1667 extern void store_frame_param (), store_in_alist ();
1668 extern Lisp_Object do_switch_frame ();
1669 extern Lisp_Object get_frame_param();
1670 extern Lisp_Object frame_buffer_predicate ();
1671 extern Lisp_Object Fframep ();
1672 extern Lisp_Object Fselect_frame ();
1673 extern Lisp_Object Ffocus_frame ();
1674 extern Lisp_Object Funfocus_frame ();
1675 extern Lisp_Object Fselected_frame ();
1676 extern Lisp_Object Fwindow_frame ();
1677 extern Lisp_Object Fframe_root_window ();
1678 extern Lisp_Object Fframe_first_window ();
1679 extern Lisp_Object Fframe_selected_window ();
1680 extern Lisp_Object Fframe_list ();
1681 extern Lisp_Object Fnext_frame ();
1682 extern Lisp_Object Fdelete_frame ();
1683 extern Lisp_Object Fread_mouse_position ();
1684 extern Lisp_Object Fset_mouse_position ();
1685 extern Lisp_Object Fmake_frame_visible ();
1686 extern Lisp_Object Fmake_frame_invisible ();
1687 extern Lisp_Object Ficonify_frame ();
1688 extern Lisp_Object Fdeiconify_frame ();
1689 extern Lisp_Object Fframe_visible_p ();
1690 extern Lisp_Object Fvisible_frame_list ();
1691 extern Lisp_Object Fframe_parameters ();
1692 extern Lisp_Object Fmodify_frame_parameters ();
1693 extern Lisp_Object Fframe_pixel_size ();
1694 extern Lisp_Object Fframe_height ();
1695 extern Lisp_Object Fframe_width ();
1696 extern Lisp_Object Fset_frame_height ();
1697 extern Lisp_Object Fset_frame_width ();
1698 extern Lisp_Object Fset_frame_size ();
1699 extern Lisp_Object Fset_frame_position ();
1700
1701 /* defined in emacs.c */
1702 extern Lisp_Object decode_env_path ();
1703 extern Lisp_Object Vinvocation_name, Vinvocation_directory;
1704 extern Lisp_Object Vinstallation_directory;
1705 void shut_down_emacs ( /* int signal, int no_x, Lisp_Object stuff */ );
1706 /* Nonzero means don't do interactive redisplay and don't change tty modes */
1707 extern int noninteractive;
1708 /* Nonzero means don't do use window-system-specific display code */
1709 extern int inhibit_window_system;
1710 /* Nonzero means that a filter or a sentinel is running.  */
1711 extern int running_asynch_code;
1712
1713 /* defined in process.c */
1714 extern Lisp_Object Fget_process (), Fget_buffer_process (), Fprocessp ();
1715 extern Lisp_Object Fprocess_status (), Fkill_process ();
1716 extern Lisp_Object Fprocess_send_eof ();
1717 extern Lisp_Object Fwaiting_for_user_input_p ();
1718 extern Lisp_Object Qprocessp;
1719
1720 /* defined in callproc.c */
1721 extern Lisp_Object Vexec_path, Vexec_directory, Vdata_directory;
1722 extern Lisp_Object Vdoc_directory;
1723
1724 /* defined in doc.c */
1725 extern Lisp_Object Vdoc_file_name;
1726 extern Lisp_Object Fsubstitute_command_keys ();
1727 extern Lisp_Object Fdocumentation (), Fdocumentation_property ();
1728 extern Lisp_Object read_doc_string ();
1729
1730 /* defined in bytecode.c */
1731 extern Lisp_Object Qbytecode;
1732 extern Lisp_Object Fbyte_code ();
1733
1734 /* defined in macros.c */
1735 extern Lisp_Object Qexecute_kbd_macro;
1736 extern Lisp_Object Fexecute_kbd_macro ();
1737
1738 /* defined in undo.c */
1739 extern Lisp_Object Fundo_boundary ();
1740 extern Lisp_Object truncate_undo_list ();
1741
1742 /* defined in textprop.c */
1743 extern Lisp_Object Qmodification_hooks;
1744 extern Lisp_Object Qrear_nonsticky;
1745 extern Lisp_Object Qinsert_in_front_hooks, Qinsert_behind_hooks;
1746 extern Lisp_Object Fnext_property_change ();
1747 extern Lisp_Object Fnext_single_property_change ();
1748 extern Lisp_Object Fprevious_single_property_change ();
1749
1750 /* defined in intervals.c */
1751 extern Lisp_Object get_local_map ();
1752
1753 /* defined in xmenu.c */
1754 extern Lisp_Object Fx_popup_menu (), Fx_popup_dialog ();
1755 \f
1756 /* Nonzero means Emacs has already been initialized.
1757    Used during startup to detect startup of dumped Emacs.  */
1758 extern int initialized;
1759
1760 extern int immediate_quit;          /* Nonzero means ^G can quit instantly */
1761
1762 extern void debugger ();
1763
1764 extern char *getenv (), *ctime (), *getwd ();
1765 extern long *xmalloc (), *xrealloc ();
1766 extern void xfree ();
1767
1768 extern char *egetenv ();
1769
1770 /* Set up the name of the machine we're running on.  */
1771 extern void init_system_name ();
1772
1773 /* Some systems (e.g., NT) use a different path separator than Unix,
1774    in addition to a device separator.  Default the path separator
1775    to '/', and don't test for a device separator in IS_ANY_SEP.  */
1776
1777 #ifndef DIRECTORY_SEP
1778 #define DIRECTORY_SEP '/'
1779 #endif
1780 #ifndef IS_DIRECTORY_SEP
1781 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
1782 #endif
1783 #ifndef IS_DEVICE_SEP
1784 #ifndef DEVICE_SEP
1785 #define IS_DEVICE_SEP(_c_) 0
1786 #else
1787 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
1788 #endif
1789 #endif
1790 #ifndef IS_ANY_SEP
1791 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
1792 #endif
1793
1794 #ifdef SWITCH_ENUM_BUG
1795 #define SWITCH_ENUM_CAST(x) ((int)(x))
1796 #else
1797 #define SWITCH_ENUM_CAST(x) (x)
1798 #endif