lisp.h 63.1 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 25 26 27 28 29
/* 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

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

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

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

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

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

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

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

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

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

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

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

91 92 93 94 95 96 97 98 99
/* 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
100 101 102 103 104 105
/* Make these values available in GDB, which sees enums but not macros.  */

enum gdb_lisp_params
{
  gdb_valbits = VALBITS,
  gdb_gctypebits = GCTYPEBITS,
106
  gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
Karl Heuer's avatar
Karl Heuer committed
107 108 109 110 111 112 113
#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
114 115
#ifndef NO_UNION_TYPE

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

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

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

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

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

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

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

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

#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

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

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

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

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

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

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

224
/* In a pseudovector, the size field actually contains a word with one
225 226
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
227 228 229 230 231 232 233 234 235
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,
236 237 238
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
239
  PVEC_TYPE_MASK = 0x3fe00,
240
  PVEC_FLAG = PSEUDOVECTOR_FLAG
241
};
242 243

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

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

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

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

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

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

310 311 312 313 314
/* 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
315 316 317 318 319 320 321 322 323 324
/* 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

325
#if VALBITS + GCTYPEBITS == BITS_PER_INT - 1
Jim Blandy's avatar
Jim Blandy committed
326 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
/* 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
355 356 357
/* 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.  */
358
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
359
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
360 361 362

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

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

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

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

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


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

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

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

/* 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))
439
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
440 441
#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
442

443
#ifdef USE_TEXT_PROPERTIES
444
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
445 446 447

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

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

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

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

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

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

typedef struct interval *INTERVAL;

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

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

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

#else  /* No text properties */

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

#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
511 512 513 514 515 516 517
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
    Lisp_Object car, cdr;
  };

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
/* 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
533 534 535 536 537 538 539 540 541 542 543 544 545 546
/* 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
  {
547
    EMACS_INT size;
548
    DECLARE_INTERVALS		/* `data' field must be last.  */
Jim Blandy's avatar
Jim Blandy committed
549 550 551
    unsigned char data[1];
  };

Karl Heuer's avatar
Karl Heuer committed
552 553 554 555 556 557
/* 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
558 559
struct Lisp_Vector
  {
560
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

565 566 567 568 569 570 571 572 573 574
/* 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.  */

/* This is the number of slots that apply to characters
   or character sets.  */
#define CHAR_TABLE_ORDINARY_SLOTS 256

/* This is the number of slots that every char table must have.
   This counts the ordinary slots and the parent and defalt slots.  */
575
#define CHAR_TABLE_STANDARD_SLOTS (256+3)
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

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

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;
597 598 599 600
    /* 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;
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
    /* 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
618 619 620 621 622 623 624 625 626 627 628
/* 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 */
  };

629 630 631 632 633 634 635 636
/* 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
637 638
struct Lisp_Subr
  {
639
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
640 641 642 643 644 645
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
646

647 648
/* These structures are used for various misc types.  */

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

/* In a marker, the markbit of the chain field is used as the gc mark bit */
struct Lisp_Marker
659 660 661 662 663 664 665 666 667 668
{
  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
669

670 671 672 673 674
/* 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
675
  {
676 677
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
678 679 680 681 682 683 684 685 686
    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
  {
687 688
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
689 690 691 692 693 694 695 696 697
    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
  {
698 699
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
700 701 702 703 704 705 706
    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
  {
707 708
    int type : 16;	/* = Lisp_Misc_Buffer_Objfwd */
    int spacer : 16;
709
    int offset;
710 711
  };

712 713 714 715
/* 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).

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

719 720 721 722 723 724 725 726 727 728 729 730
   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,
731
   we just examine or set REALVALUE.  If BUFFER is not current, we
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
   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
  {
754 755 756
    int type : 16; /* = Lisp_Misc_Buffer_Local_Value
				      or Lisp_Misc_Some_Buffer_Local_Value */
    int spacer : 16;
757 758 759
    Lisp_Object car, cdr;
  };

760 761 762 763 764
/* 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
  {
765 766
    int type : 16;	/* = Lisp_Misc_Overlay */
    int spacer : 16;
767 768
    Lisp_Object start, end, plist;
  };
769

770
/* Like Lisp_Objfwd except that value lives in a slot in the
771 772
   current kboard.  */
struct Lisp_Kboard_Objfwd
773
  {
774
    int type : 16;	/* = Lisp_Misc_Kboard_Objfwd */
775 776 777 778
    int spacer : 16;
    int offset;
  };

779

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

783 784 785 786
union Lisp_Misc
  {
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
787 788 789 790
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
791
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
792
    struct Lisp_Overlay u_overlay;
793
    struct Lisp_Kboard_Objfwd u_kboard_objfwd;
794
  };
795

Jim Blandy's avatar
Jim Blandy committed
796 797 798 799 800 801 802 803 804 805 806
#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
807
   of some character set associated with the current buffer.  */
808 809
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
810
typedef unsigned char UCHAR;
811
#endif
Jim Blandy's avatar
Jim Blandy committed
812 813 814 815 816 817 818 819 820

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

822 823
/* Flag bits in a character.  These also get used in termhooks.h.
   Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
824 825 826 827 828 829 830 831
   (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)
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
#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 */

861 862 863 864 865 866 867 868 869 870 871 872

/* 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
873
#ifdef HAVE_FACES
874 875
/* The FAST macros assume that we already know we're in an X window.  */

876
/* Given a character code and a face ID, return the appropriate glyph.  */
877
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
878 879

/* Return a glyph's character code.  */
880
#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
881 882

/* Return a glyph's face ID.  */
883 884 885 886 887 888 889
#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
890
#else /* not HAVE_FACES */
891 892 893
#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
894
#endif /* not HAVE_FACES */
895

896 897
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
898 899 900

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
901
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
902
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
903

Jim Blandy's avatar
Jim Blandy committed
904
#ifdef LISP_FLOAT_TYPE
905
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
906
#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
907
#else
908
#define NUMBERP(x) (INTEGERP (x))
909
#define GC_NUMBERP(x) (GC_INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
910
#endif
Karl Heuer's avatar
Karl Heuer committed
911
#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
912
#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
Jim Blandy's avatar
Jim Blandy committed
913

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

Jim Blandy's avatar
Jim Blandy committed
927
#ifdef LISP_FLOAT_TYPE
928
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
929
#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
930 931
#else
#define FLOATP(x) (0)
932
#define GC_FLOATP(x) (0)
Jim Blandy's avatar
Jim Blandy committed
933
#endif
934 935
#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
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
#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)
954

955

956
/* True if object X is a pseudovector whose code is CODE.  */
957 958 959 960 961
#define PSEUDOVECTORP(x, code)					\
  (VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

962
/* True if object X is a pseudovector whose code is CODE.
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
   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)
980 981
#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
982 983 984 985
#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)
986 987 988 989 990 991 992 993 994 995 996 997 998 999

#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
1000
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
1001
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
1002

Jim Blandy's avatar
Jim Blandy committed
1003
#define CHECK_LIST(x, i) \
1004
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1005 1006

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

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

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

1015
#define CHECK_CHAR_TABLE(x, i) \
1016
  do { if (!CHAR_TABLE_P ((x)))	\
1017 1018
	 x = wrong_type_argument (Qchar_table_p, (x)); } while (0)

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

1022 1023 1024 1025 1026
#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
1027
#define CHECK_BUFFER(x, i) \
1028
  do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1029 1030

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

1033 1034 1035 1036 1037 1038 1039 1040
/* 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)				\
1041
  do {							\
1042
    if (!WINDOWP ((x))					\
1043
	|| NILP (XWINDOW ((x))->buffer))		\
1044
      x = wrong_type_argument (Qwindow_live_p, (x));	\
1045
  } while (0)
1046

Jim Blandy's avatar
Jim Blandy committed
1047
#define CHECK_PROCESS(x, i) \
1048
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1049 1050

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

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

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

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1060
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
1061
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

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

#define CHECK_FLOAT(x, i)		\
1072
  do { if (!FLOATP (x))			\
1073
    x = wrong_type_argument (Qfloatp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1074 1075

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

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
1080
  do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));	\
1081
  else if (!INTEGERP (x) && !FLOATP (x))		\
1082
    x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092

#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
1093
#define CHECK_OVERLAY(x, i) \
1094
  do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
Jim Blandy's avatar
Jim Blandy committed
1095

Jim Blandy's avatar
Jim Blandy committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
/* 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
1119
    See the doc string for `interactive'.
Jim Blandy's avatar
Jim Blandy committed
1120
    A null string means call interactively with no arguments.
Richard M. Stallman's avatar
Richard M. Stallman committed
1121
 `doc' is documentation for the user.  */
Jim Blandy's avatar
Jim Blandy committed
1122

1123
#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
1124 1125 1126 1127 1128
#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc)	\
  Lisp_Object fnname ();						\
  struct Lisp_Subr sname =						\
    { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)),	\
      fnname, minargs, maxargs, lname, prompt, 0};			\
Jim Blandy's avatar
Jim Blandy committed
1129 1130
  Lisp_Object fnname

1131 1132 1133
#else

/* This version of DEFUN declares a function prototype with the right