lisp.h 66.6 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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22 23 24
/* These are default choices for the types to use.  */
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
25
#define BITS_PER_EMACS_INT BITS_PER_INT
26 27 28 29 30
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif

31
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
32

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

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

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

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

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

51
    /* Vector of Lisp objects, or something resembling it.
52
       XVECTOR (object) points to a struct Lisp_Vector, which contains
53 54 55
       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
56

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

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

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

68
/* This is the set of datatypes that share a common structure.
69 70 71 72
   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
73 74
enum Lisp_Misc_Type
  {
75
    Lisp_Misc_Free = 0x5eab,
76
    Lisp_Misc_Marker,
77 78 79
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
80 81
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
82
    Lisp_Misc_Some_Buffer_Local_Value,
83
    Lisp_Misc_Overlay,
84
    Lisp_Misc_Kboard_Objfwd,
85 86 87 88 89
    /* 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
90 91
  };

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

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

Karl Heuer's avatar
Karl Heuer committed
101 102 103 104 105 106
/* Make these values available in GDB, which sees enums but not macros.  */

enum gdb_lisp_params
{
  gdb_valbits = VALBITS,
  gdb_gctypebits = GCTYPEBITS,
107
  gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
Karl Heuer's avatar
Karl Heuer committed
108 109 110 111 112 113 114
#ifdef DATA_SEG_BITS
  gdb_data_seg_bits = DATA_SEG_BITS
#else
  gdb_data_seg_bits = 0
#endif
};

Jim Blandy's avatar
Jim Blandy committed
115 116
#ifndef NO_UNION_TYPE

117
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
118 119 120 121 122 123 124

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
125
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129
    int i;

    struct
      {
130 131
	int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
132 133 134
      } s;
    struct
      {
135 136
	unsigned int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
137 138 139
      } u;
    struct
      {
140 141
	unsigned int val: VALBITS;
	enum Lisp_Type type: GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148
	/* 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;

149
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
150 151 152 153 154

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
155
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
156 157 158 159
    int i;

    struct
      {
160 161
	int type: GCTYPEBITS+1;
	int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
162 163 164
      } s;
    struct
      {
165 166
	int type: GCTYPEBITS+1;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
167 168 169 170 171 172
      } 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;
173 174
	enum Lisp_Type type: GCTYPEBITS;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178
      } gu;
  }
Lisp_Object;

179
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
180 181 182 183 184 185 186 187 188

#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

189
#define Lisp_Object EMACS_INT
Jim Blandy's avatar
Jim Blandy committed
190 191

#ifndef VALMASK
192
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
193
#endif
194
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
195 196 197 198 199 200 201 202 203 204 205 206 207

/* 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.  */

208
#ifndef MARKBIT
209
#define MARKBIT ((int) ((unsigned int) 1 << (VALBITS + GCTYPEBITS)))
210
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
211

212 213 214 215 216 217 218
/* 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 */

219 220 221 222 223 224
/* 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

225
/* In a pseudovector, the size field actually contains a word with one
226 227
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
228 229 230 231 232 233 234 235 236
enum pvec_type
{
  PVEC_NORMAL_VECTOR = 0,
  PVEC_PROCESS = 0x200,
  PVEC_FRAME = 0x400,
  PVEC_COMPILED = 0x800,
  PVEC_WINDOW = 0x1000,
  PVEC_WINDOW_CONFIGURATION = 0x2000,
  PVEC_SUBR = 0x4000,
237 238 239
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
240
  PVEC_TYPE_MASK = 0x3fe00,
241
  PVEC_FLAG = PSEUDOVECTOR_FLAG
242
};
243 244

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

Jim Blandy's avatar
Jim Blandy committed
247 248 249 250
#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,
251
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
252 253 254 255 256 257 258 259 260 261 262 263

#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
264
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
265 266
#endif

Karl Heuer's avatar
Karl Heuer committed
267 268 269
/* 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.  */
270
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
271
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275

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

#ifndef XINT   /* Some machines need to do this differently.  */
276
#define XINT(a) (((a) << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280 281 282 283 284 285 286 287 288
#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
289
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
290
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
291
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
#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) \
308
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
309 310
#endif

311 312 313 314 315
/* Convert a C integer into a Lisp_Object integer.  */

#define make_number(N)		\
  ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)

Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321 322 323 324 325
/* 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

Richard M. Stallman's avatar
Richard M. Stallman committed
326
#if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
Jim Blandy's avatar
Jim Blandy committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
/* 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
356 357 358
/* 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.  */
359
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
360
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
361 362 363

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
364
#define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
#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 */

389
/* Extract a value or address from a Lisp_Object.  */
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395

#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))
396 397 398

/* Misc types.  */
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Richard M. Stallman's avatar
Richard M. Stallman committed
399
#define XMISCTYPE(a)   (XMARKER (a)->type)
400
#define XMARKER(a) (&(XMISC(a)->u_marker))
401 402 403 404
#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))
405
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
406
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
407
#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
408

409 410 411 412
/* 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))
413
#define XBUFFER(a) ((struct buffer *) XPNTR(a))
414 415
#define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
416 417 418


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

420 421
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
422
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
423 424 425
#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)
426 427 428

/* Misc types.  */
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
429
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
430 431 432 433 434 435 436 437 438 439

/* 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))
440
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
441 442
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
Jim Blandy's avatar
Jim Blandy committed
443

444
#ifdef USE_TEXT_PROPERTIES
445
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
446 447 448

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

451 452 453 454
  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.  */
455 456 457 458 459 460 461 462 463 464 465 466

  /* 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;
467 468 469

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

  unsigned char write_protect;	    /* Non-zero means can't modify.  */
473
  unsigned char visible;	    /* Zero means don't display.  */
474
  unsigned char front_sticky;	    /* Non-zero means text inserted just
475 476
				       before this interval goes into it.  */
  unsigned char rear_sticky;	    /* Likewise for just after it.  */
477

478 479 480 481 482
  /* 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;
483 484 485 486 487 488
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
489
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
490 491 492
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

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

496
/* Macro used to conditionally compile interval initialization into
497
   certain code.  See, e.g., alloc.c.  */
498 499 500 501
#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val

#else  /* No text properties */

502
/* If no intervals are used, make the above definitions go away.  */
503 504 505 506 507 508 509 510 511

#define CHECK_STRING_OR_BUFFER(x, i)

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

#endif /* USE_TEXT_PROPERTIES */

Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516 517 518
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
    Lisp_Object car, cdr;
  };

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
/* Take the car or cdr of something known to be a cons cell.  */
#define XCAR(c) (XCONS ((c))->car)
#define XCDR(c) (XCONS ((c))->cdr)

/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
  : wrong_type_argument (Qlistp, (c)))

#define CDR(c)					\
 (CONSP ((c)) ? XCDR ((c))			\
  : NILP ((c)) ? Qnil				\
  : wrong_type_argument (Qlistp, (c)))

Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547
/* 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
  {
548
    EMACS_INT size;
549
    DECLARE_INTERVALS		/* `data' field must be last.  */
Jim Blandy's avatar
Jim Blandy committed
550 551 552
    unsigned char data[1];
  };

Karl Heuer's avatar
Karl Heuer committed
553
/* If a struct is made to look like a vector, this macro returns the length
554 555 556 557
   of the shortest vector that would hold that struct.  */
#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector)  \
                                         - sizeof (Lisp_Object))      \
                        + sizeof(Lisp_Object) - 1) /* round up */     \
Karl Heuer's avatar
Karl Heuer committed
558 559
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
560 561
struct Lisp_Vector
  {
562
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
563 564 565 566
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

567 568 569 570
/* A char table is a kind of vectorlike, with contents are like a vector
   but with a few other slots.  For some purposes, it makes sense
   to handle a chartable with type struct Lisp_Vector.  */

571 572 573 574 575 576 577 578
/* This is the number of slots that apply to characters or character
   sets.  The first 128 are for ASCII, the next 128 are for 8-bit
   European characters, and the last 128 are for multibyte characters.  */
#define CHAR_TABLE_ORDINARY_SLOTS 384

/* This is the number of slots that apply to characters of ASCII and
   8-bit Europeans only.  */
#define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
579 580 581

/* This is the number of slots that every char table must have.
   This counts the ordinary slots and the parent and defalt slots.  */
582
#define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 3)
583 584 585 586 587 588

/* Return the number of "extra" slots in the char table CT.  */

#define CHAR_TABLE_EXTRA_SLOTS(CT)	\
  (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)

589 590 591 592 593 594
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
   and 8-bit Europeans characters.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)						\
  (CHAR_TABLE_P (CT) && IDX >= 0 && IDX < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])				\
      ? XCHAR_TABLE (CT)->contents[IDX]					\
595
      : XCHAR_TABLE (CT)->defalt)					\
596 597 598 599 600 601 602 603 604 605 606 607
   : Faref (CT, IDX))

/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
   8-bit Europeans characters.  */
#define CHAR_TABLE_SET(CT, IDX, VAL)					     \
  do {									     \
    if (CHAR_TABLE_P (CT) && IDX >= 0 && IDX < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
      XCHAR_TABLE (CT)->contents[IDX] = VAL;				     \
    else								     \
      Faset (CT, IDX, VAL);						     \
  } while (0)

608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
       The size counts the defalt and parent slots.  */
    EMACS_INT size;
    struct Lisp_Vector *next;
    Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
    /* This points to another char table, which we inherit from
       when the value for a specific character is nil.
       The `defalt' slot takes precedence over this.  */
    Lisp_Object parent;
623 624 625 626
    /* This should be a symbol which says what kind of use
       this char-table is meant for.
       Typically now the values can be `syntax-table' and `display-table'.  */
    Lisp_Object purpose;
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    /* These hold additional data.  */
    Lisp_Object extras[1];
  };

/* A boolvector is a kind of vectorlike, with contents are like a string.  */
struct Lisp_Bool_Vector
  {
    /* This is the vector's size field.  It doesn't have the real size,
       just the subtype information.  */
    EMACS_INT vector_size;
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
    EMACS_INT size;
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648 649 650 651
/* 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;
652
    Lisp_Object obarray;
Jim Blandy's avatar
Jim Blandy committed
653 654 655
    struct Lisp_Symbol *next;	/* -> next symbol in this obarray bucket */
  };

656 657 658 659 660 661 662 663
/* 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
664 665
struct Lisp_Subr
  {
666
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671 672
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
673

674 675
/* These structures are used for various misc types.  */

676 677 678
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
679 680
    int type : 16;	/* = Lisp_Misc_Free */
    int spacer : 16;
681 682
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
683

Erik Naggum's avatar
Erik Naggum committed
684
/* In a marker, the markbit of the chain field is used as the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
685
struct Lisp_Marker
686 687 688 689 690 691 692 693 694 695
{
  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.  */
  unsigned int insertion_type : 1;
  struct buffer *buffer;
  Lisp_Object chain;
  int bufpos;
};
Jim Blandy's avatar
Jim Blandy committed
696

697 698 699 700 701
/* 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
702
  {
703 704
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
705 706 707 708 709 710 711 712 713
    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
  {
714 715
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
716 717 718 719 720 721 722 723 724
    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
  {
725 726
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
727 728 729 730 731 732 733
    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
  {
734 735
    int type : 16;	/* = Lisp_Misc_Buffer_Objfwd */
    int spacer : 16;
736
    int offset;
737 738
  };

739 740 741 742
/* 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).

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

746 747 748 749 750 751 752 753 754 755 756 757
   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,
758
   we just examine or set REALVALUE.  If BUFFER is not current, we
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
   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
  {
781 782 783
    int type : 16; /* = Lisp_Misc_Buffer_Local_Value
				      or Lisp_Misc_Some_Buffer_Local_Value */
    int spacer : 16;
784 785 786
    Lisp_Object car, cdr;
  };

787 788 789 790 791
/* 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
  {
792 793
    int type : 16;	/* = Lisp_Misc_Overlay */
    int spacer : 16;
794 795
    Lisp_Object start, end, plist;
  };
796

797
/* Like Lisp_Objfwd except that value lives in a slot in the
798 799
   current kboard.  */
struct Lisp_Kboard_Objfwd
800
  {
801
    int type : 16;	/* = Lisp_Misc_Kboard_Objfwd */
802 803 804 805
    int spacer : 16;
    int offset;
  };

806

Richard M. Stallman's avatar
Richard M. Stallman committed
807 808 809
/* To get the type field of a union Lisp_Misc, use XMISCTYPE.
   It uses one of these struct subtypes to get the type field.  */

810 811 812 813
union Lisp_Misc
  {
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
814 815 816 817
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
818
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
819
    struct Lisp_Overlay u_overlay;
820
    struct Lisp_Kboard_Objfwd u_kboard_objfwd;
821
  };
822

Jim Blandy's avatar
Jim Blandy committed
823 824 825 826 827 828 829 830 831 832 833
#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
834
   of some character set associated with the current buffer.  */
835 836
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
837
typedef unsigned char UCHAR;
838
#endif
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842 843 844 845 846 847

/* 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
848

849 850
/* Flag bits in a character.  These also get used in termhooks.h.
   Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
851 852 853 854 855 856 857 858
   (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)
859

860 861 862 863
/* Actually, the current Emacs uses 19 bits for the character value
   itself.  */
#define CHARACTERBITS 19

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
#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 */

892 893 894

/* The glyph datatype, used to represent characters on the display.  */

895 896 897 898 899 900 901 902
/* The low 19 bits (CHARACTERBITS) are the character code, and the
   bits above them except for the topmost two bits 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 (i.e. 2^(32 - 19 - 2) = 2048 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.  */
903 904
#define GLYPH unsigned int

905 906 907 908 909 910 911 912 913 914
/* Mask bit for a glyph of a character which should be written from
   right to left.  */
#define GLYPH_MASK_REV_DIR 0x80000000
/* Mask bit for a padding glyph of a multi-column character.  */
#define GLYPH_MASK_PADDING 0x40000000
/* Mask bits for face.  */
#define GLYPH_MASK_FACE    0x3FF80000
/* Mask bits for character code.  */
#define GLYPH_MASK_CHAR    0x0007FFFF /* The lowest 19 bits */

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

918
/* Given a character code and a face ID, return the appropriate glyph.  */
919
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << CHARACTERBITS))
920 921

/* Return a glyph's character code.  */
922
#define FAST_GLYPH_CHAR(glyph) ((glyph) & GLYPH_MASK_CHAR)
923 924

/* Return a glyph's face ID.  */
925
#define FAST_GLYPH_FACE(glyph) (((glyph) & GLYPH_MASK_FACE) >> CHARACTERBITS)
926 927 928 929 930 931

/* 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
932
#else /* not HAVE_FACES */
933
#define MAKE_GLYPH(f, char, face) (char)
934 935 936 937 938
#define FAST_MAKE_GLYPH(char, face) (char)
#define GLYPH_CHAR(f, g) ((g) & GLYPH_MASK_CHAR)
#define FAST_GLYPH_CHAR(g) ((g) & GLYPH_MASK_CHAR)
#define GLYPH_FACE(f, g) ((g) & GLYPH_MASK_FACE)
#define FAST_GLYPH_FACE(g) ((g) & GLYPH_MASK_FACE)
Morten Welinder's avatar
Morten Welinder committed
939
#endif /* not HAVE_FACES */
940

941 942 943 944
/* Return 1 iff GLYPH contains valid character code.  */
#define GLYPH_CHAR_VALID_P(glyph) \
  ((GLYPH) (FAST_GLYPH_CHAR (glyph)) <= MAX_CHAR)

945 946
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
947 948 949

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
950
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
951
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
952

Jim Blandy's avatar
Jim Blandy committed
953
#ifdef LISP_FLOAT_TYPE
954
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
955
#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
956
#else
957
#define NUMBERP(x) (INTEGERP (x))
958
#define GC_NUMBERP(x) (GC_INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
959
#endif
Karl Heuer's avatar
Karl Heuer committed
960
#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
961
#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
Jim Blandy's avatar
Jim Blandy committed
962

963
#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
964
#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
965
#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
966
#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
967
#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
968
#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
969 970
#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
971
#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
972
#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
Jim Blandy's avatar
Jim Blandy committed
973
#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
974
#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
975

Jim Blandy's avatar
Jim Blandy committed
976
#ifdef LISP_FLOAT_TYPE
977
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
978
#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
979 980
#else
#define FLOATP(x) (0)
981
#define GC_FLOATP(x) (0)
Jim Blandy's avatar
Jim Blandy committed
982
#endif
983 984
#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
Richard M. Stallman's avatar
Richard M. Stallman committed
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
#define OVERLAYP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Overlay)
#define MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
#define GC_MARKERP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
#define INTFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
#define GC_INTFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Intfwd)
#define BOOLFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Boolfwd)
#define OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Objfwd)
#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Objfwd)
#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Buffer_Local_Value)
#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Some_Buffer_Local_Value)
#define KBOARD_OBJFWDP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
#define GC_KBOARD_OBJFWDP(x) (GC_MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Kboard_Objfwd)
1003

1004

1005
/* True if object X is a pseudovector whose code is CODE.  */
1006 1007 1008 1009 1010
#define PSEUDOVECTORP(x, code)					\
  (VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

1011
/* True if object X is a pseudovector whose code is CODE.
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
   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)
1029 1030
#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
1031 1032 1033 1034
#define CHAR_TABLE_P(x) PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
#define GC_CHAR_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_CHAR_TABLE)
#define BOOL_VECTOR_P(x) PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
#define GC_BOOL_VECTOR_P(x) GC_PSEUDOVECTORP (x, PVEC_BOOL_VECTOR)
1035 1036 1037
#define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
#define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)

Jim Blandy's avatar
Jim Blandy committed
1038
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
1039
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
1040

Jim Blandy's avatar
Jim Blandy committed
1041
#define CHECK_LIST(x, i) \
1042
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1043 1044

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

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

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

1053
#define CHECK_CHAR_TABLE(x, i) \
1054
  do { if (!CHAR_TABLE_P ((x)))	\
1055 1056
	 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)

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

1060 1061 1062 1063 1064
#define CHECK_VECTOR_OR_CHAR_TABLE(x, i)				\
  do { if (!VECTORP ((x)) && !CHAR_TABLE_P ((x)))			\
	 x = wrong_type_argument (Qvector_or_char_table_p, (x));	\
     } while (0)

Jim Blandy's avatar
Jim Blandy committed
1065
#define CHECK_BUFFER(x, i) \
1066
  do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1067 1068

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

1071 1072 1073 1074 1075 1076 1077 1078
/* 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)				\
1079
  do {							\
1080
    if (!WINDOWP ((x))					\
1081
	|| NILP (XWINDOW ((x))->buffer))		\
1082
      x = wrong_type_argument (Qwindow_live_p, (x));	\
1083
  } while (0)
1084

Jim Blandy's avatar
Jim Blandy committed
1085
#define CHECK_PROCESS(x, i) \
1086
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1087 1088

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

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

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

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1098
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1099
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

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

#define CHECK_FLOAT(x, i)		\
1110
  do { if (!FLOATP (x))			\
1111
    x = wrong_type_argument (Qfloatp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1112 1113

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