lisp.h 61.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985,86,87,93,94,95 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21 22 23 24 25 26 27 28
/* These are default choices for the types to use.  */
#ifndef EMACS_INT
#define EMACS_INT int
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif

29
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
30

31
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
32 33 34

enum Lisp_Type
  {
35
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
36 37
    Lisp_Int,

38
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
39 40
    Lisp_Symbol,

41 42 43
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
44 45

    /* String.  XSTRING (object) points to a struct Lisp_String.
46
       The length of the string, and its contents, are stored therein.  */
Jim Blandy's avatar
Jim Blandy committed
47 48
    Lisp_String,

49
    /* Vector of Lisp objects, or something resembling it.
50
       XVECTOR (object) points to a struct Lisp_Vector, which contains
51 52 53
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
    Lisp_Vectorlike,
Jim Blandy's avatar
Jim Blandy committed
54

55
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
56 57 58
    Lisp_Cons,

#ifdef LISP_FLOAT_TYPE
Jim Blandy's avatar
Jim Blandy committed
59
    Lisp_Float,
Jim Blandy's avatar
Jim Blandy committed
60
#endif /* LISP_FLOAT_TYPE */
61 62

    /* This is not a type code.  It is for range checking.  */
63
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
64 65
  };

66
/* This is the set of datatypes that share a common structure.
67 68 69 70
   The first member of the structure is a type code from this set.
   The enum values are arbitrary, but we'll use large numbers to make it
   more likely that we'll spot the error if a random word in memory is
   mistakenly interpreted as a Lisp_Misc.  */
Karl Heuer's avatar
Karl Heuer committed
71 72
enum Lisp_Misc_Type
  {
73
    Lisp_Misc_Free = 0x5eab,
74
    Lisp_Misc_Marker,
75 76 77
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
78 79
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
80
    Lisp_Misc_Some_Buffer_Local_Value,
81
    Lisp_Misc_Overlay,
82
    Lisp_Misc_Display_Objfwd,
83 84 85 86 87
    /* Currently floats are not a misc type,
       but let's define this in case we want to change that.  */
    Lisp_Misc_Float,
    /* This is not a type code.  It is for range checking.  */
    Lisp_Misc_Limit
Karl Heuer's avatar
Karl Heuer committed
88 89
  };

90 91 92 93 94 95 96 97 98
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
#define VALBITS 28
#endif

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

Jim Blandy's avatar
Jim Blandy committed
99 100
#ifndef NO_UNION_TYPE

101
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108

/* Definition of Lisp_Object for little-endian machines.  */

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
109
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
110 111 112 113
    int i;

    struct
      {
114 115
	int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
116 117 118
      } s;
    struct
      {
119 120
	unsigned int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
121 122 123
      } u;
    struct
      {
124 125
	unsigned int val: VALBITS;
	enum Lisp_Type type: GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
	unsigned int markbit: 1;
      } gu;
  }
Lisp_Object;

133
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
134 135 136 137 138

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
139
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143
    int i;

    struct
      {
144 145
	int type: GCTYPEBITS+1;
	int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
146 147 148
      } s;
    struct
      {
149 150
	int type: GCTYPEBITS+1;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156
      } u;
    struct
      {
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
	unsigned int markbit: 1;
157 158
	enum Lisp_Type type: GCTYPEBITS;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
159 160 161 162
      } gu;
  }
Lisp_Object;

163
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
164 165 166 167 168 169 170 171 172

#endif /* NO_UNION_TYPE */


/* If union type is not wanted, define Lisp_Object as just a number
   and define the macros below to extract fields by shifting */

#ifdef NO_UNION_TYPE

173
#define Lisp_Object EMACS_INT
Jim Blandy's avatar
Jim Blandy committed
174 175

#ifndef VALMASK
176
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
177
#endif
178
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
179 180 181 182 183 184 185 186 187 188 189 190 191

/* Two flags that are set during GC.  On some machines, these flags
   are defined differently by the m- file.  */

/* This is set in the car of a cons and in the plist slot of a symbol
   to indicate it is marked.  Likewise in the plist slot of an interval,
   the chain slot of a marker, the type slot of a float, and the name
   slot of a buffer.

   In strings, this bit in the size field indicates that the string
   is a "large" one, one which was separately malloc'd
   rather than being part of a string block.  */

192
#ifndef MARKBIT
Jim Blandy's avatar
Jim Blandy committed
193
#define MARKBIT (1 << (VALBITS + GCTYPEBITS))
194
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
195

196 197 198 199 200 201 202
/* In the size word of a vector, this bit means the vector has been marked.
   In the size word of a large string, likewise.  */

#ifndef ARRAY_MARK_FLAG
#define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
#endif /* no ARRAY_MARK_FLAG */

203 204 205 206 207 208
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
#ifndef PSEUDOVECTOR_FLAG
#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
#endif

209
/* In a pseudovector, the size field actually contains a word with one
210 211
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
212 213 214 215 216 217 218 219 220 221 222 223 224
enum pvec_type
{
  PVEC_NORMAL_VECTOR = 0,
  PVEC_BUFFER = 0x100,
  PVEC_PROCESS = 0x200,
  PVEC_FRAME = 0x400,
  PVEC_COMPILED = 0x800,
  PVEC_WINDOW = 0x1000,
  PVEC_WINDOW_CONFIGURATION = 0x2000,
  PVEC_SUBR = 0x4000,
  PVEC_TYPE_MASK = 0x7f00,
  PVEC_FLAG = PSEUDOVECTOR_FLAG,
};
225 226 227 228 229

/* For convenience, we also store the number of elements in these bits.  */
#define PSEUDOVECTOR_SIZE_MASK 0xff

#if ARRAY_MARK_FLAG == MARKBIT || PSEUDOVECTOR_FLAG == ARRAY_MARK_FLAG || PSEUDOVECTOR_FLAG == MARKBIT
230 231 232
you lose
#endif

Jim Blandy's avatar
Jim Blandy committed
233 234 235 236
#endif /* NO_UNION_TYPE */

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
237
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
238 239 240 241 242 243 244 245 246 247 248 249

#ifdef NO_UNION_TYPE

/* One need to override this if there must be high bits set in data space
   (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
    on all machines, but would penalise machines which don't need it)
 */
#ifndef XTYPE
#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
#endif

#ifndef XSETTYPE
250
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
251 252
#endif

Karl Heuer's avatar
Karl Heuer committed
253 254 255
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
   fact that Lisp_Int is 0.  */
256
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
257
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
258 259 260 261

/* Extract the value of a Lisp_Object as a signed integer.  */

#ifndef XINT   /* Some machines need to do this differently.  */
Jim Blandy's avatar
Jim Blandy committed
262
#define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266 267 268 269 270 271 272 273 274
#endif

/* Extract the value as an unsigned integer.  This is a basis
   for extracting it as a pointer to a structure in storage.  */

#ifndef XUINT
#define XUINT(a) ((a) & VALMASK)
#endif

#ifndef XPNTR
#ifdef HAVE_SHM
/* In this representation, data is found in two widely separated segments.  */
Jim Blandy's avatar
Jim Blandy committed
275
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
276
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
277
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
#else /* not HAVE_SHM */
#ifdef DATA_SEG_BITS
/* This case is used for the rt-pc.
   In the diffs I was given, it checked for ptr = 0
   and did not adjust it in that case.
   But I don't think that zero should ever be found
   in a Lisp object whose data type says it points to something.  */
#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
#else
#define XPNTR(a) XUINT (a)
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

#ifndef XSET
#define XSET(var, type, ptr) \
294
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
#endif

/* During garbage collection, XGCTYPE must be used for extracting types
 so that the mark bit is ignored.  XMARKBIT accesses the markbit.
 Markbits are used only in particular slots of particular structure types.
 Other markbits are always zero.
 Outside of garbage collection, all mark bits are always zero.  */

#ifndef XGCTYPE
#define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
#endif

#if VALBITS + GCTYPEBITS == INTBITS - 1
/* Make XMARKBIT faster if mark bit is sign bit.  */
#ifndef XMARKBIT
#define XMARKBIT(a) ((a) < 0)
#endif
#endif /* markbit is sign bit */

#ifndef XMARKBIT
#define XMARKBIT(a) ((a) & MARKBIT)
#endif

#ifndef XSETMARKBIT
#define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
#endif

#ifndef XMARK
#define XMARK(a) ((a) |= MARKBIT)
#endif

#ifndef XUNMARK
#define XUNMARK(a) ((a) &= ~MARKBIT)
#endif

#endif /* NO_UNION_TYPE */

#ifndef NO_UNION_TYPE

#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
#define XSETTYPE(a, b) ((a).u.type = (char) (b))

Karl Heuer's avatar
Karl Heuer committed
337 338 339
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
   fact that Lisp_Int is 0.  */
340
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
341
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
342 343 344

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
345
#define XINT(a) (((a).i << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

#define XUINT(a) ((a).u.val)
#define XPNTR(a) ((a).u.val)

#define XSET(var, vartype, ptr) \
   (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))

/* During garbage collection, XGCTYPE must be used for extracting types
 so that the mark bit is ignored.  XMARKBIT access the markbit.
 Markbits are used only in particular slots of particular structure types.
 Other markbits are always zero.
 Outside of garbage collection, all mark bits are always zero.  */

#define XGCTYPE(a) ((a).gu.type)
#define XMARKBIT(a) ((a).gu.markbit)
#define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
#define XMARK(a) (XMARKBIT(a) = 1)
#define XUNMARK(a) (XMARKBIT(a) = 0)

#endif /* NO_UNION_TYPE */

370
/* Extract a value or address from a Lisp_Object.  */
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376

#define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
#define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
377 378 379

/* Misc types.  */
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
380
#define XMARKER(a) (&(XMISC(a)->u_marker))
381 382 383 384
#define XINTFWD(a) (&(XMISC(a)->u_intfwd))
#define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
#define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
#define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
385
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
386
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
387
#define XDISPLAY_OBJFWD(a) (&(XMISC(a)->u_display_objfwd))
Jim Blandy's avatar
Jim Blandy committed
388

389 390 391 392
/* Pseudovector types.  */
#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) ((struct window *) XPNTR(a))
#define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
393 394 395 396
#define XBUFFER(a) ((struct buffer *) XPNTR(a))


/* Construct a Lisp_Object from a value or address.  */
397

398 399
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
400
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
401 402 403
#define XSETSTRING(a, b) XSET (a, Lisp_String, b)
#define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
#define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
404 405 406

/* Misc types.  */
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
407
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISC (a)->type = Lisp_Misc_Marker)
408 409 410 411 412 413 414 415 416 417

/* Pseudovector types.  */
#define XSETPSEUDOVECTOR(a, b, code) \
  (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
#define XSETWINDOW_CONFIGURATION(a, b) \
  (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW_CONFIGURATION))
#define XSETPROCESS(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_PROCESS))
#define XSETWINDOW(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_WINDOW))
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
418
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
Jim Blandy's avatar
Jim Blandy committed
419

420
#ifdef USE_TEXT_PROPERTIES
421
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
422 423 424

struct interval
{
425
  /* The first group of entries deal with the tree structure.  */
426

427 428 429 430
  unsigned int total_length;	/* Length of myself and both children.  */
  unsigned int position;	/* Cache of interval's character position.  */
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */
431 432 433 434 435 436 437 438 439 440 441 442

  /* Parent in the tree, or the Lisp_Object containing this interval tree.

     The mark bit on the root interval of an interval tree says
     whether we have started (and possibly finished) marking the
     tree.  If GC comes across an interval tree whose root's parent
     field has its markbit set, it leaves the tree alone.

     You'd think we could store this information in the parent object
     somewhere (after all, that should be visited once and then
     ignored too, right?), but strings are GC'd strangely.  */
  struct interval *parent;
443 444 445

  /* The remaining components are `properties' of the interval.
     The first four are duplicates for things which can be on the list,
446
     for purposes of speed.  */
447 448

  unsigned char write_protect;	    /* Non-zero means can't modify.  */
449
  unsigned char visible;	    /* Zero means don't display.  */
450
  unsigned char front_sticky;	    /* Non-zero means text inserted just
451 452
				       before this interval goes into it.  */
  unsigned char rear_sticky;	    /* Likewise for just after it.  */
453

454 455 456 457 458
  /* Properties of this interval.
     The mark bit on this field says whether this particular interval
     tree node has been visited.  Since intervals should never be
     shared, GC aborts if it seems to have visited an interval twice.  */
  Lisp_Object plist;
459 460 461 462 463 464
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
465
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
466 467 468
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

/* Macro used to conditionally compile intervals into certain data
469
   structures.  See, e.g., struct Lisp_String below.  */
470 471
#define DECLARE_INTERVALS INTERVAL intervals;

472
/* Macro used to conditionally compile interval initialization into
473
   certain code.  See, e.g., alloc.c.  */
474 475 476 477
#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val

#else  /* No text properties */

478
/* If no intervals are used, make the above definitions go away.  */
479 480 481 482 483 484 485 486 487

#define CHECK_STRING_OR_BUFFER(x, i)

#define INTERVAL
#define DECLARE_INTERVALS
#define INITIALIZE_INTERVAL(ptr,val)

#endif /* USE_TEXT_PROPERTIES */

488
#define ECHOBUFSIZE 300
489 490 491
/* All of the per-display objects, packaged together in a struct.  */
typedef struct
  {
Karl Heuer's avatar
Karl Heuer committed
492 493
    Lisp_Object Vprefix_arg;
    Lisp_Object Vcurrent_prefix_arg;
494 495
    Lisp_Object this_command_keys;
    Lisp_Object internal_last_event_frame;
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522

    /* Vector to GCPRO the frames and windows mentioned in kbd_buffer.

       The interrupt-level event handlers will never enqueue an event on a
       frame which is not in Vframe_list, and once an event is dequeued,
       internal_last_event_frame or the event itself points to the frame.
       So that's all fine.

       But while the event is sitting in the queue, it's completely
       unprotected.  Suppose the user types one command which will run for
       a while and then delete a frame, and then types another event at
       the frame that will be deleted, before the command gets around to
       it.  Suppose there are no references to this frame elsewhere in
       Emacs, and a GC occurs before the second event is dequeued.  Now we
       have an event referring to a freed frame, which will crash Emacs
       when it is dequeued.

       Similar things happen when an event on a scroll bar is enqueued; the
       window may be deleted while the event is in the queue.

       So, we use this vector to protect the frame_or_window field in the
       event queue.  That way, they'll be dequeued as dead frames or
       windows, but still valid lisp objects.

       If perd->kbd_buffer[i].kind != no_event, then
	 (XVECTOR (perd->kbd_buffer_frame_or_window)->contents[i]
	  == perd->kbd_buffer[i].frame_or_window.  */
523
    Lisp_Object kbd_buffer_frame_or_window;
524 525

    /* Circular buffer for pre-read keyboard input.  */
526
    struct input_event *kbd_buffer;
527 528 529 530 531

    /* Pointer to next available character in kbd_buffer.
       If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
       This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
       next available char is in kbd_buffer[0].  */
532
    struct input_event *kbd_fetch_ptr;
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

    /* Pointer to next place to store character in kbd_buffer.  This
       may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
       character should go in kbd_buffer[0].  */
    volatile struct input_event *kbd_store_ptr;

    /* The above pair of variables forms a "queue empty" flag.  When we
       enqueue a non-hook event, we increment kbd_store_ptr.  When we
       dequeue a non-hook event, we increment kbd_fetch_ptr.  We say that
       there is input available iff the two counters are not equal.

       Why not just have a flag set and cleared by the enqueuing and
       dequeuing functions?  Such a flag could be screwed up by interrupts
       at inopportune times.  */

548
    int this_command_key_count;
549 550

    /* Nonzero means echo each character as typed.  */
551
    int immediate_echo;
552 553 554

    /* If we have echoed a prompt string specified by the user,
       this is its length.  Otherwise this is -1.  */
555
    int echo_after_prompt;
556 557

    /* Where to append more text to echobuf if we want to.  */
558
    char *echoptr;
559 560 561 562

    /* The text we're echoing in the modeline - partial key sequences,
       usually.  '\0'-terminated.  This really shouldn't have a fixed size.  */
    char echobuf[ECHOBUFSIZE];
563
  } PERDISPLAY;
564
#ifdef MULTI_PERDISPLAY
Karl Heuer's avatar
Karl Heuer committed
565
/* The perdisplay object associated with a particular frame.  */
566
extern PERDISPLAY *get_perdisplay ();
Karl Heuer's avatar
Karl Heuer committed
567 568 569

/* The perdisplay object associated with the currently executing command.  */
extern PERDISPLAY *current_perdisplay;
570
#else
571
extern PERDISPLAY the_only_perdisplay;
Karl Heuer's avatar
Karl Heuer committed
572
#define current_perdisplay (&the_only_perdisplay)
573
#define get_perdisplay(f) (&the_only_perdisplay)
574
#endif
575

Jim Blandy's avatar
Jim Blandy committed
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
    Lisp_Object car, cdr;
  };

/* Like a cons, but records info on where the text lives that it was read from */
/* This is not really in use now */

struct Lisp_Buffer_Cons
  {
    Lisp_Object car, cdr;
    struct buffer *buffer;
    int bufpos;
  };

/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
597
    EMACS_INT size;
598
    DECLARE_INTERVALS		/* `data' field must be last.  */
Jim Blandy's avatar
Jim Blandy committed
599 600 601
    unsigned char data[1];
  };

Karl Heuer's avatar
Karl Heuer committed
602 603 604 605 606 607
/* If a struct is made to look like a vector, this macro returns the length
   of that vector.  */
#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector)	\
					 - sizeof (Lisp_Object)))	\
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
608 609
struct Lisp_Vector
  {
610
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

/* In a symbol, the markbit of the plist is used as the gc mark bit */

struct Lisp_Symbol
  {
    struct Lisp_String *name;
    Lisp_Object value;
    Lisp_Object function;
    Lisp_Object plist;
    struct Lisp_Symbol *next;	/* -> next symbol in this obarray bucket */
  };

626 627 628 629 630 631 632 633
/* This structure describes a built-in function.
   It is generated by the DEFUN macro only.
   defsubr makes it into a Lisp object.

   This type is treated in most respects as a pseudovector,
   but since we never dynamically allocate or free them,
   we don't need a next-vector field.  */
   
Jim Blandy's avatar
Jim Blandy committed
634 635
struct Lisp_Subr
  {
636
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
637 638 639 640 641 642
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
643

644 645
/* These structures are used for various misc types.  */

646 647 648
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
649 650
    int type : 16;	/* = Lisp_Misc_Free */
    int spacer : 16;
651 652
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
653 654 655 656

/* In a marker, the markbit of the chain field is used as the gc mark bit */
struct Lisp_Marker
  {
657 658 659 660 661
    int type : 16;	/* = Lisp_Misc_Marker */
    int spacer : 15;
    /* 1 means normal insertion at the marker's position
       leaves the marker after the inserted text.  */
    int insertion_type : 1;
Jim Blandy's avatar
Jim Blandy committed
662 663 664 665 666
    struct buffer *buffer;
    Lisp_Object chain;
    int bufpos;
  };

667 668 669 670 671
/* Forwarding pointer to an int variable.
   This is allowed only in the value cell of a symbol,
   and it means that the symbol's value really lives in the
   specified int variable.  */
struct Lisp_Intfwd
672
  {
673 674
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
675 676 677 678 679 680 681 682 683
    int *intvar;
  };

/* Boolean forwarding pointer to an int variable.
   This is like Lisp_Intfwd except that the ostensible
   "value" of the symbol is t if the int variable is nonzero,
   nil if it is zero.  */
struct Lisp_Boolfwd
  {
684 685
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
686 687 688 689 690 691 692 693 694
    int *boolvar;
  };

/* Forwarding pointer to a Lisp_Object variable.
   This is allowed only in the value cell of a symbol,
   and it means that the symbol's value really lives in the
   specified variable.  */
struct Lisp_Objfwd
  {
695 696
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
697 698 699 700 701 702 703
    Lisp_Object *objvar;
  };

/* Like Lisp_Objfwd except that value lives in a slot in the
   current buffer.  Value is byte index of slot within buffer.  */
struct Lisp_Buffer_Objfwd
  {
704 705
    int type : 16;	/* = Lisp_Misc_Buffer_Objfwd */
    int spacer : 16;
706
    int offset;
707 708
  };

709 710 711 712
/* Used in a symbol value cell when the symbol's value is per-buffer.
   The actual contents resemble a cons cell which starts a list like this:
   (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).

713 714 715
   The cons-like structure is for historical reasons; it might be better
   to just put these elements into the struct, now.

716 717 718 719 720 721 722 723 724 725 726 727
   BUFFER is the last buffer for which this symbol's value was
   made up to date.

   CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
   local_var_alist, that being the element whose car is this
   variable.  Or it can be a pointer to the
   (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
   if BUFFER does not have an element in its alist for this
   variable (that is, if BUFFER sees the default value of this
   variable).

   If we want to examine or set the value and BUFFER is current,
728
   we just examine or set REALVALUE.  If BUFFER is not current, we
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
   store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
   then find the appropriate alist element for the buffer now
   current and set up CURRENT-ALIST-ELEMENT.  Then we set
   REALVALUE out of that element, and store into BUFFER.

   If we are setting the variable and the current buffer does not
   have an alist entry for this variable, an alist entry is
   created.

   Note that REALVALUE can be a forwarding pointer.  Each time it
   is examined or set, forwarding must be done.  Each time we
   switch buffers, buffer-local variables which forward into C
   variables are swapped immediately, so the C code can assume
   that they are always up to date.

   Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
   use the same substructure.  The difference is that with the latter,
   merely setting the variable while some buffer is current
   does not cause that buffer to have its own local value of this variable.
   Only make-local-variable does that.  */
struct Lisp_Buffer_Local_Value
  {
751 752 753
    int type : 16; /* = Lisp_Misc_Buffer_Local_Value
				      or Lisp_Misc_Some_Buffer_Local_Value */
    int spacer : 16;
754 755 756
    Lisp_Object car, cdr;
  };

757 758 759 760 761
/* In an overlay object, the mark bit of the plist is used as the GC mark.
   START and END are markers in the overlay's buffer, and
   PLIST is the overlay's property list.  */
struct Lisp_Overlay
  {
762 763
    int type : 16;	/* = Lisp_Misc_Overlay */
    int spacer : 16;
764 765
    Lisp_Object start, end, plist;
  };
766

767 768 769 770 771 772 773 774 775
/* Like Lisp_Objfwd except that value lives in a slot in the
   current perdisplay.  */
struct Lisp_Display_Objfwd
  {
    int type : 16;	/* = Lisp_Misc_Display_Objfwd */
    int spacer : 16;
    int offset;
  };

776

777 778
union Lisp_Misc
  {
779
    int type : 16;
780 781
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
782 783 784 785
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
786
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
787
    struct Lisp_Overlay u_overlay;
788
    struct Lisp_Display_Objfwd u_display_objfwd;
789
  };
790

Jim Blandy's avatar
Jim Blandy committed
791 792 793 794 795 796 797 798 799 800 801
#ifdef LISP_FLOAT_TYPE
/* Optional Lisp floating point type */
struct Lisp_Float
  {
    Lisp_Object type;		/* essentially used for mark-bit 
				   and chaining when on free-list */
    double data;  
  };
#endif /* LISP_FLOAT_TYPE */

/* A character, declared with the following typedef, is a member
802
   of some character set associated with the current buffer.  */
803 804
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
805
typedef unsigned char UCHAR;
806
#endif
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810 811 812 813 814 815

/* Meanings of slots in a Lisp_Compiled:  */

#define COMPILED_ARGLIST 0
#define COMPILED_BYTECODE 1
#define COMPILED_CONSTANTS 2
#define COMPILED_STACK_DEPTH 3
#define COMPILED_DOC_STRING 4
#define COMPILED_INTERACTIVE 5
816

817 818
/* Flag bits in a character.  These also get used in termhooks.h.
   Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
819 820 821 822 823 824 825 826
   (MUlti-Lingual Emacs) might need 22 bits for the character value
   itself, so we probably shouldn't use any bits lower than 0x0400000.  */
#define CHAR_ALT   (0x0400000)
#define CHAR_SUPER (0x0800000)
#define CHAR_HYPER (0x1000000)
#define CHAR_SHIFT (0x2000000)
#define CHAR_CTL   (0x4000000)
#define CHAR_META  (0x8000000)
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
#ifdef USE_X_TOOLKIT
#ifdef NO_UNION_TYPE
/* Use this for turning a (void *) into a Lisp_Object, as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define VOID_TO_LISP(larg,varg) \
  do { ((larg) = ((Lisp_Object) (varg))); } while (0)
#define CVOID_TO_LISP VOID_TO_LISP

/* Use this for turning a Lisp_Object into a  (void *), as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define LISP_TO_VOID(larg) ((void *) (larg))
#define LISP_TO_CVOID(varg) ((const void *) (larg))

#else /* not NO_UNION_TYPE */
/* Use this for turning a (void *) into a Lisp_Object, as when the
  Lisp_Object is passed into a toolkit callback function.  */
#define VOID_TO_LISP(larg,varg) \
  do { ((larg).v = (void *) (varg)); } while (0)
#define CVOID_TO_LISP(larg,varg) \
  do { ((larg).cv = (const void *) (varg)); } while (0)

/* Use this for turning a Lisp_Object into a  (void *), as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define LISP_TO_VOID(larg) ((larg).v)
#define LISP_TO_CVOID(larg) ((larg).cv)
#endif /* not NO_UNION_TYPE */
#endif /* USE_X_TOOLKIT */

856 857 858 859 860 861 862 863 864 865 866 867

/* The glyph datatype, used to represent characters on the display.  */

/* The low eight bits are the character code, and the bits above them
   are the numeric face ID.  If FID is the face ID of a glyph on a
   frame F, then F->display.x->faces[FID] contains the description of
   that face.  This is an int instead of a short, so we can support a
   good bunch of face ID's; given that we have no mechanism for
   tossing unused frame face ID's yet, we'll probably run out of 255
   pretty quickly.  */
#define GLYPH unsigned int

Morten Welinder's avatar
Morten Welinder committed
868
#ifdef HAVE_FACES
869 870
/* The FAST macros assume that we already know we're in an X window.  */

871
/* Given a character code and a face ID, return the appropriate glyph.  */
872
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
873 874

/* Return a glyph's character code.  */
875
#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
876 877

/* Return a glyph's face ID.  */
878 879 880 881 882 883 884
#define FAST_GLYPH_FACE(glyph) (((glyph) >> 8) & ((1 << 24) - 1))

/* Slower versions that test the frame type first.  */
#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
				   : FAST_MAKE_GLYPH (char, face))
#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
Morten Welinder's avatar
Morten Welinder committed
885
#else /* not HAVE_FACES */
886 887 888
#define MAKE_GLYPH(f, char, face) (char)
#define GLYPH_CHAR(f, g) (g)
#define GLYPH_FACE(f, g) (g)
Morten Welinder's avatar
Morten Welinder committed
889
#endif /* not HAVE_FACES */
890

891 892
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
893 894 895

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
896
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
897
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
898

Jim Blandy's avatar
Jim Blandy committed
899
#ifdef LISP_FLOAT_TYPE
900
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
901
#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
902
#else
903
#define NUMBERP(x) (INTEGERP (x))
904
#define GC_NUMBERP(x) (GC_INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
905
#endif
Karl Heuer's avatar
Karl Heuer committed
906
#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
907
#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
Jim Blandy's avatar
Jim Blandy committed
908

909
#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
910
#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
911
#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
912
#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
913
#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
914
#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
915 916
#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
917
#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
918
#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
Jim Blandy's avatar
Jim Blandy committed
919
#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
920
#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
921

Jim Blandy's avatar
Jim Blandy committed
922
#ifdef LISP_FLOAT_TYPE
923
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
924
#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
925 926
#else
#define FLOATP(x) (0)
927
#define GC_FLOATP(x) (0)
Jim Blandy's avatar
Jim Blandy committed
928
#endif
929 930
#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
931
#define OVERLAYP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
932
#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
933
#define MARKERP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
934
#define GC_MARKERP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
935
#define INTFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
936
#define GC_INTFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
937
#define BOOLFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
938
#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
939
#define OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
940
#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
941
#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
942
#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
943
#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
944
#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
945
#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
946
#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
947 948
#define DISPLAY_OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Display_Objfwd)
#define GC_DISPLAY_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Display_Objfwd)
949

950

951
/* True if object X is a pseudovector whose code is CODE.  */
952 953 954 955 956
#define PSEUDOVECTORP(x, code)					\
  (VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

957
/* True if object X is a pseudovector whose code is CODE.
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
   This one works during GC.  */
#define GC_PSEUDOVECTORP(x, code)				\
  (GC_VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

/* Test for specific pseudovector types.  */
#define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
#define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
#define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
#define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
#define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
#define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
#define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
#define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
#define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
#define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
975 976
#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
977 978 979 980 981 982 983 984 985 986 987 988 989 990

#ifdef MULTI_FRAME
#define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
#define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
#else
#ifdef HAVE_MOUSE
/* We could use this in the !HAVE_MOUSE case also, but we prefer a compile-time
   error message in case FRAMEP is used.  */
#define FRAMEP(x) (EQ (x, Fselected_frame ()))
#define GC_FRAMEP(x) (GC_EQ (x, Fselected_frame ()))
#endif
#endif


Jim Blandy's avatar
Jim Blandy committed
991
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
992
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
993

Jim Blandy's avatar
Jim Blandy committed
994
#define CHECK_LIST(x, i) \
995
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
996 997

#define CHECK_STRING(x, i) \
998
  do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
999 1000

#define CHECK_CONS(x, i) \
1001
  do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1002 1003

#define CHECK_SYMBOL(x, i) \
1004
  do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1005 1006

#define CHECK_VECTOR(x, i) \
1007
  do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1008 1009

#define CHECK_BUFFER(x, i) \
1010
  do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1011 1012

#define CHECK_WINDOW(x, i) \
1013
  do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1014

1015 1016 1017 1018 1019 1020 1021 1022
/* This macro rejects windows on the interior of the window tree as
   "dead", which is what we want; this is an argument-checking macro, and 
   the user should never get access to interior windows.

   A window of any sort, leaf or interior, is dead iff the buffer,
   vchild, and hchild members are all nil.  */

#define CHECK_LIVE_WINDOW(x, i)				\
1023
  do {							\
1024
    if (!WINDOWP ((x))					\
1025
	|| NILP (XWINDOW ((x))->buffer))		\
1026
      x = wrong_type_argument (Qwindow_live_p, (x));	\
1027
  } while (0)
1028

Jim Blandy's avatar
Jim Blandy committed
1029
#define CHECK_PROCESS(x, i) \
1030
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1031 1032

#define CHECK_NUMBER(x, i) \
1033
  do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1034 1035

#define CHECK_NATNUM(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1036
  do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1037 1038

#define CHECK_MARKER(x, i) \
1039
  do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1040 1041

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1042
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1043
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

#define XFLOATINT(n) extract_float((n))

#define CHECK_FLOAT(x, i)		\
1054
  do { if (!FLOATP (x))			\
1055
    x = wrong_type_argument (Qfloatp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1056 1057

#define CHECK_NUMBER_OR_FLOAT(x, i)	\
1058
  do { if (!FLOATP (x) && !INTEGERP (x))	\
1059
    x = wrong_type_argument (Qnumberp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1060 1061

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1062
  do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));	\
1063
  else if (!INTEGERP (x) && !FLOATP (x))		\
1064
    x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074

#else  /* Not LISP_FLOAT_TYPE */

#define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER

#define XFLOATINT(n) XINT((n))
#endif /* LISP_FLOAT_TYPE */

Jim Blandy's avatar
Jim Blandy committed
1075
#define CHECK_OVERLAY(x, i) \
1076
  do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
Jim Blandy's avatar
Jim Blandy committed
1077

Jim Blandy's avatar
Jim Blandy committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
/* Cast pointers to this type to compare them.  Some machines want int.  */
#ifndef PNTR_COMPARISON_TYPE
#define PNTR_COMPARISON_TYPE unsigned int
#endif

/* Define a built-in function for calling from Lisp.
 `lname' should be the name to give the function in Lisp,
    as a null-terminated C string.
 `fnname' should be the name of the function in C.
    By convention, it starts with F.
 `sname' should be the name for the C constant structure
    that records information on this function for internal use.
    By convention, it should be the same as `fnname' but with S instead of F.
    It's too bad that C macros can't compute this from `fnname'.
 `minargs' should be a number, the minimum number of arguments allowed.
 `maxargs' should be a number, the maximum number of arguments allowed,
    or else MANY or UNEVALLED.
    MANY means pass a vector of evaluated arguments,
	 in the form of an integer number-of-arguments
	 followed by the address of a vector of Lisp_Objects
	 which contains the argument values.
    UNEVALLED means pass the list of unevaluated arguments
 `prompt' says how to read arguments for an interactive call.
Richard M. Stallman's avatar
Richard M. Stallman committed
1101
    See the doc string for `interactive'.
Jim Blandy's avatar
Jim Blandy committed
1102
    A null string means call interactively with no arguments.
Richard M. Stallman's avatar
Richard M. Stallman committed
1103
 `doc' is documentation for the user.  */
Jim Blandy's avatar
Jim Blandy committed
1104

1105
#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)