lisp.h 113 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985,86,87,93,94,95,97,98,1999,2000, 2001, 2002, 2003
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

Gerd Moellmann's avatar
Gerd Moellmann committed
22
/* Declare the prototype for a general external function.  */
23
#if defined (PROTOTYPES) || defined (WINDOWSNT)
Gerd Moellmann's avatar
Gerd Moellmann committed
24 25 26 27 28
#define P_(proto) proto
#else
#define P_(proto) ()
#endif

29
#if 0
30 31 32 33 34
/* Define this temporarily to hunt a bug.  If defined, the size of
   strings is redundantly recorded in sdata structures so that it can
   be compared to the sizes recorded in Lisp strings.  */

#define GC_CHECK_STRING_BYTES 1
35
#endif /* 0*/
36

Jim Blandy's avatar
Jim Blandy committed
37

38
/* These are default choices for the types to use.  */
39 40 41 42 43 44 45 46 47
#ifdef _LP64
#ifndef EMACS_INT
#define EMACS_INT long
#define BITS_PER_EMACS_INT BITS_PER_LONG
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned long
#endif
#else /* not _LP64 */
48 49
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
50
#define BITS_PER_EMACS_INT BITS_PER_INT
51 52 53 54
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
55
#endif
56

57 58 59
/* Extra internal type checking?  */
extern int suppress_checking;
extern void die P_((const char *, const char *, int));
60 61 62 63

#ifdef ENABLE_CHECKING

#define CHECK(check,msg) ((check || suppress_checking		\
64
			   ? (void) 0				\
65 66 67 68 69 70
			   : die (msg, __FILE__, __LINE__)),	\
			  0)

/* Let's get some compile-time checking too.  */
#undef NO_UNION_TYPE

71
#else
72

73 74
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
75

76
#endif
77

78
/* Used for making sure that Emacs is compilable in all
79
   configurations.  */
80 81 82 83 84

#ifdef USE_LISP_UNION_TYPE
#undef NO_UNION_TYPE
#endif

85 86
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
87 88 89
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
90 91 92 93 94
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
95
#endif /* ENABLE_CHECKING */
96

97
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
98

99
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
100 101 102

enum Lisp_Type
  {
103
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
104 105
    Lisp_Int,

106
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
107 108
    Lisp_Symbol,

109 110 111
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
112 113

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

117
    /* Vector of Lisp objects, or something resembling it.
118
       XVECTOR (object) points to a struct Lisp_Vector, which contains
119 120 121
       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
122

123
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
124 125
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
126
    Lisp_Float,
127 128

    /* This is not a type code.  It is for range checking.  */
129
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
130 131
  };

132
/* This is the set of data types that share a common structure.
133 134 135 136
   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
137 138
enum Lisp_Misc_Type
  {
139
    Lisp_Misc_Free = 0x5eab,
140
    Lisp_Misc_Marker,
141 142 143
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
144 145
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
146
    Lisp_Misc_Some_Buffer_Local_Value,
147
    Lisp_Misc_Overlay,
148
    Lisp_Misc_Kboard_Objfwd,
149
    Lisp_Misc_Save_Value,
150 151 152 153 154
    /* 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
155 156
  };

157 158
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
159
#define VALBITS (BITS_PER_EMACS_INT - 4)
160 161 162 163 164 165
#endif

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

Jim Blandy's avatar
Jim Blandy committed
166 167
#ifndef NO_UNION_TYPE

168
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
176
       also, positive integers can be accessed fast this way.  */
177
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
178 179 180

    struct
      {
181 182
	EMACS_INT val  : VALBITS;
	EMACS_INT type : GCTYPEBITS + 1;
Jim Blandy's avatar
Jim Blandy committed
183 184 185
      } s;
    struct
      {
186 187
	EMACS_UINT val : VALBITS;
	EMACS_INT type : GCTYPEBITS + 1;
Jim Blandy's avatar
Jim Blandy committed
188 189 190
      } u;
    struct
      {
191 192
	EMACS_UINT val		: VALBITS;
	enum Lisp_Type type	: GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
193 194
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
195
	EMACS_UINT markbit	: 1;
Jim Blandy's avatar
Jim Blandy committed
196 197 198 199
      } gu;
  }
Lisp_Object;

200
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
206
       also, positive integers can be accessed fast this way.  */
207
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
208 209 210

    struct
      {
211 212
	EMACS_INT type : GCTYPEBITS+1;
	EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
213 214 215
      } s;
    struct
      {
216 217
	EMACS_INT type : GCTYPEBITS+1;
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
218 219 220 221 222
      } u;
    struct
      {
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
223 224 225
	EMACS_UINT markbit	: 1;
	enum Lisp_Type type	: GCTYPEBITS;
	EMACS_UINT val		: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
226 227 228 229
      } gu;
  }
Lisp_Object;

230
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
231

232 233 234 235 236 237 238
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
239 240 241 242 243
/* This isn't quite right - it keeps the argument as an lvalue.
   Making it const via casting would help avoid code actually
   modifying the location in question, but the casting could cover
   other type-related bugs.  */
#define LISP_MAKE_RVALUE(o) (o)
244 245
#endif

Jim Blandy's avatar
Jim Blandy committed
246 247 248
#endif /* NO_UNION_TYPE */


249
/* If union type is not wanted, define Lisp_Object as just a number.  */
Jim Blandy's avatar
Jim Blandy committed
250 251

#ifdef NO_UNION_TYPE
252
#define Lisp_Object EMACS_INT
253
#define LISP_MAKE_RVALUE(o) (0+(o))
254
#endif /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
255 256

#ifndef VALMASK
257
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
258
#endif
259
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
260 261 262 263 264 265 266 267 268 269 270 271 272

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

273
#ifndef MARKBIT
274
#define MARKBIT ((EMACS_INT) ((EMACS_UINT) 1 << (VALBITS + GCTYPEBITS)))
275
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
276

277 278 279 280 281 282 283
/* 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 */

284 285 286 287 288 289
/* 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

290
/* In a pseudovector, the size field actually contains a word with one
291 292
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
293 294 295 296 297 298 299 300 301
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,
302 303 304
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
305
  PVEC_HASH_TABLE = 0x40000,
Gerd Moellmann's avatar
Gerd Moellmann committed
306
  PVEC_TYPE_MASK = 0x7fe00
307

Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310
#if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
	 GDB.  It doesn't work on OS Alpha.  Moved to a variable in
	 emacs.c.  */
311
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
312
#endif
313
};
314 315

/* For convenience, we also store the number of elements in these bits.  */
316
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
Jim Blandy's avatar
Jim Blandy committed
317 318 319

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
320
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
321 322 323 324 325

#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
326
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
327 328 329 330 331 332
 */
#ifndef XTYPE
#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
#endif

#ifndef XSETTYPE
333
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
334 335
#endif

Karl Heuer's avatar
Karl Heuer committed
336 337 338
/* 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.  */
339
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
340
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
341 342 343 344

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

#ifndef XINT   /* Some machines need to do this differently.  */
345 346
#define XINT(a) ((EMACS_INT) (((a) << (BITS_PER_EMACS_INT - VALBITS)) \
			      >> (BITS_PER_EMACS_INT - VALBITS)))
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352
#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
353
#define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
354 355 356 357
#endif

#ifndef XSET
#define XSET(var, type, ptr) \
358
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
359 360
#endif

361 362 363 364 365
/* 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
366 367 368 369 370 371 372 373 374 375
/* 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
376
#if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
Jim Blandy's avatar
Jim Blandy committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
/* 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
406 407 408
/* 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.  */
409
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
410
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
411 412 413

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
414 415
#define XINT(a) (((a).i << (BITS_PER_EMACS_INT - VALBITS)) \
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419 420 421 422
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

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

#define XSET(var, vartype, ptr) \
423
   (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
Jim Blandy's avatar
Jim Blandy committed
424

425 426 427 428
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
429
extern Lisp_Object make_number ();
430
#endif
431

Jim Blandy's avatar
Jim Blandy committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445
/* 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 */

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
#ifndef XPNTR
#ifdef HAVE_SHM
/* In this representation, data is found in two widely separated segments.  */
extern size_t pure_size;
#define XPNTR(a) \
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
#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 */

Gerd Moellmann's avatar
Gerd Moellmann committed
466 467
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
468

Gerd Moellmann's avatar
Gerd Moellmann committed
469 470
#define MOST_NEGATIVE_FIXNUM	- ((EMACS_INT) 1 << (VALBITS - 1))
#define MOST_POSITIVE_FIXNUM	(((EMACS_INT) 1 << (VALBITS - 1)) - 1)
471 472 473 474

/* Value is non-zero if C integer I doesn't fit into a Lisp fixnum.  */

#define FIXNUM_OVERFLOW_P(i) \
475 476
  ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
   || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
477

478
/* Extract a value or address from a Lisp_Object.  */
Jim Blandy's avatar
Jim Blandy committed
479

480
#define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
481
#define XVECTOR(a) (eassert (GC_VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
482 483 484
#define XSTRING(a) (eassert (GC_STRINGP(a)),(struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) (eassert (GC_SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
#define XFLOAT(a) (eassert (GC_FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
485 486

/* Misc types.  */
487

488
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Richard M. Stallman's avatar
Richard M. Stallman committed
489
#define XMISCTYPE(a)   (XMARKER (a)->type)
490
#define XMARKER(a) (&(XMISC(a)->u_marker))
491 492 493 494
#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))
495
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
496
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
497
#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
498
#define XSAVE_VALUE(a) (&(XMISC(a)->u_save_value))
Jim Blandy's avatar
Jim Blandy committed
499

500
/* Pseudovector types.  */
501

502 503 504 505
#define XPROCESS(a) (eassert (GC_PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) (eassert (GC_WINDOWP(a)),(struct window *) XPNTR(a))
#define XSUBR(a) (eassert (GC_SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
#define XBUFFER(a) (eassert (GC_BUFFERP(a)),(struct buffer *) XPNTR(a))
506 507
#define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
508 509

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

511 512
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
513
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
514 515 516
#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)
517 518

/* Misc types.  */
519

520
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
521
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
522 523

/* Pseudovector types.  */
524

525 526 527 528 529 530 531 532
#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))
533
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
534 535
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
536 537 538 539 540 541 542

/* Convenience macros for dealing with Lisp arrays.  */

#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
#define ASET(ARRAY, IDX, VAL)	(AREF ((ARRAY), (IDX)) = (VAL))
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size

543 544
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
545 546
#define SREF(string, index)	(XSTRING (string)->data[index] + 0)
#define SSET(string, index, new) (XSTRING (string)->data[index] = (new))
Ken Raeburn's avatar
Ken Raeburn committed
547
#define SDATA(string)		(XSTRING (string)->data + 0)
548 549 550 551 552
#define SCHARS(string)		(XSTRING (string)->size + 0)
#define SBYTES(string)		(STRING_BYTES (XSTRING (string)) + 0)

#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
553

Ken Raeburn's avatar
Ken Raeburn committed
554 555 556
#define STRING_COPYIN(string, index, new, count) \
    bcopy (new, XSTRING (string)->data + index, count)

Jim Blandy's avatar
Jim Blandy committed
557

558
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
559 560 561

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

564 565
  unsigned int total_length;	/* Length of myself and both children.  */
  unsigned int position;	/* Cache of interval's character position.  */
566 567
				/* This field is usually updated
				   simultaneously with an interval
Stefan Monnier's avatar
Stefan Monnier committed
568
				   traversal, there is no guarantee
569 570
				   that it is valid for a random
				   interval.  */
571 572
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */
573 574 575 576 577 578 579 580 581 582 583

  /* 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.  */
584 585 586 587 588 589
  union
  {
    struct interval *interval;
    Lisp_Object obj;
  } up;
  unsigned int up_obj : 1;
590 591 592

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

Pavel Janík's avatar
Pavel Janík committed
595
  unsigned int write_protect : 1;   /* Non-zero means can't modify.  */
596 597
  unsigned int visible : 1;	    /* Zero means don't display.  */
  unsigned int front_sticky : 1;    /* Non-zero means text inserted just
598
				       before this interval goes into it.  */
599
  unsigned int rear_sticky : 1;	    /* Likewise for just after it.  */
600

601 602 603 604 605
  /* 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;
606 607 608 609 610
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
611
#define CHECK_STRING_OR_BUFFER(x) \
612
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
613 614
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

Jim Blandy's avatar
Jim Blandy committed
615 616 617 618
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
619 620 621 622 623
    /* Please do not use the names of these elements in code other
       than the core lisp implementation.  Use XCAR and XCDR below.  */
#ifdef HIDE_LISP_IMPLEMENTATION
    Lisp_Object car_, cdr_;
#else
Jim Blandy's avatar
Jim Blandy committed
624
    Lisp_Object car, cdr;
625
#endif
Jim Blandy's avatar
Jim Blandy committed
626 627
  };

628
/* Take the car or cdr of something known to be a cons cell.  */
629 630 631 632 633 634
/* The _AS_LVALUE macros shouldn't be used outside of the minimal set
   of code that has to know what a cons cell looks like.  Other code not
   part of the basic lisp implementation should assume that the car and cdr
   fields are not accessible as lvalues.  (What if we want to switch to
   a copying collector someday?  Cached cons cell field addresses may be
   invalidated at arbitrary points.)  */
635
#ifdef HIDE_LISP_IMPLEMENTATION
636 637
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
#define XCDR_AS_LVALUE(c) (XCONS ((c))->cdr_)
638
#else
639 640
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
#define XCDR_AS_LVALUE(c) (XCONS ((c))->cdr)
641
#endif
642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
/* Use these from normal code.  */
#define XCAR(c)	LISP_MAKE_RVALUE(XCAR_AS_LVALUE(c))
#define XCDR(c) LISP_MAKE_RVALUE(XCDR_AS_LVALUE(c))

/* Use these to set the fields of a cons cell.

   Note that both arguments may refer to the same object, so 'n'
   should not be read after 'c' is first modified.  Also, neither
   argument should be evaluated more than once; side effects are
   especially common in the second argument.  */
#define XSETCAR(c,n) (XCAR_AS_LVALUE(c) = (n))
#define XSETCDR(c,n) (XCDR_AS_LVALUE(c) = (n))

/* For performance: Fast storage of positive integers into the
   fields of a cons cell.  See above caveats.  */
#define XSETCARFASTINT(c,n)  XSETFASTINT(XCAR_AS_LVALUE(c),(n))
#define XSETCDRFASTINT(c,n)  XSETFASTINT(XCDR_AS_LVALUE(c),(n))

661 662 663 664 665 666 667 668 669 670 671
/* 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)))

Kenichi Handa's avatar
Kenichi Handa committed
672 673 674 675 676
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
677 678 679 680 681 682 683 684 685

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
extern int string_bytes P_ ((struct Lisp_String *));
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
686 687 688
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

689 690
#endif /* not GC_CHECK_STRING_BYTES */

691 692 693 694
/* Mark STR as a unibyte string.  */
#define STRING_SET_UNIBYTE(STR)      (XSTRING (STR)->size_byte = -1)

/* Get text properties.  */
695 696 697 698
#define STRING_INTERVALS(STR)  (XSTRING (STR)->intervals + 0)

/* Set text properties.  */
#define STRING_SET_INTERVALS(STR, INT) (XSTRING (STR)->intervals = (INT))
Kenichi Handa's avatar
Kenichi Handa committed
699

Jim Blandy's avatar
Jim Blandy committed
700 701 702 703
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
704
    EMACS_INT size;
705
    EMACS_INT size_byte;
706
    INTERVAL intervals;		/* text properties in this string */
707
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
708 709
  };

Karl Heuer's avatar
Karl Heuer committed
710
/* If a struct is made to look like a vector, this macro returns the length
711 712 713 714
   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
715 716
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
717 718
struct Lisp_Vector
  {
719
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
720 721 722 723
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

724 725 726 727 728 729 730 731 732 733
/* 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.  An
   element of a char table can be any Lisp objects, but if it is a sub
   char-table, we treat it a table that contains information of a
   group of characters of the same charsets or a specific character of
   a charset.  A sub char-table has the same structure as a char table
   except for that the former omits several slots at the tail.  A sub
   char table appears only in an element of a char table, and there's
   no way to access it directly from Emacs Lisp program.  */
734

735 736
/* 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
737 738 739
   European characters, and the last 128 are for multibyte characters.
   The first 256 are indexed by the code itself, but the last 128 are
   indexed by (charset-id + 128).  */
740 741 742 743 744
#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
745

746 747 748 749 750 751 752 753 754 755 756 757
/* This is the number of slots that every char table must have.  This
   counts the ordinary slots and the top, defalt, parent, and purpose
   slots.  */
#define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 4)

/* This is the number of slots that apply to position-code-1 and
   position-code-2 of a multibyte character at the 2nd and 3rd level
   sub char tables respectively.  */
#define SUB_CHAR_TABLE_ORDINARY_SLOTS 128

/* This is the number of slots that every sub char table must have.
   This counts the ordinary slots and the top and defalt slot.  */
758
#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
759 760 761 762 763 764

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

765
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
766 767 768
   and 8-bit Europeans characters.  For these characters, do not check
   validity of CT.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)				\
769
  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
770 771
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XCHAR_TABLE (CT)->contents[IDX]			\
772
      : XCHAR_TABLE (CT)->defalt)			\
773
   : Faref (CT, make_number (IDX)))
774

775 776 777 778 779 780 781 782 783 784 785 786 787
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
   and 8-bit Europeans characters.  However, if the result is nil,
   return IDX.

   For these characters, do not check validity of CT
   and do not follow parent.  */
#define CHAR_TABLE_TRANSLATE(CT, IDX)			\
  ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS			\
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XINT (XCHAR_TABLE (CT)->contents[IDX])		\
      : IDX)						\
   : char_table_translate (CT, IDX))

788
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
789 790 791 792 793 794 795
   8-bit Europeans characters.  Do not check validity of CT.  */
#define CHAR_TABLE_SET(CT, IDX, VAL)			\
  do {							\
    if (XFASTINT (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS)	\
      XCHAR_TABLE (CT)->contents[XFASTINT (IDX)] = VAL;	\
    else						\
      Faset (CT, IDX, VAL);				\
796 797
  } while (0)

798 799 800 801
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
802 803
       The size counts the top, defalt, purpose, and parent slots.
       The last three are not counted if this is a sub char table.  */
804 805
    EMACS_INT size;
    struct Lisp_Vector *next;
806 807 808
    /* This holds a flag to tell if this is a top level char table (t)
       or a sub char table (nil).  */
    Lisp_Object top;
809 810 811
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
812 813 814 815 816 817
    /* This holds an actual value of each element.  A sub char table
       has only SUB_CHAR_TABLE_ORDINARY_SLOTS number of elements.  */
    Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];

    /* A sub char table doesn't has the following slots.  */

818 819 820 821
    /* 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;
822 823 824 825
    /* 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;
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    /* 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];
  };

843 844 845 846 847 848 849
/* 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.  */
850

Jim Blandy's avatar
Jim Blandy committed
851 852
struct Lisp_Subr
  {
853
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
854 855 856 857 858 859
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
860

861 862 863 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

/***********************************************************************
			       Symbols
 ***********************************************************************/

/* Interned state of a symbol.  */

enum symbol_interned
{
  SYMBOL_UNINTERNED = 0,
  SYMBOL_INTERNED = 1,
  SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
};

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

struct Lisp_Symbol
{
  /* Non-zero means symbol serves as a variable alias.  The symbol
     holding the real value is found in the value slot.  */
  unsigned indirect_variable : 1;

  /* Non-zero means symbol is constant, i.e. changing its value
     should signal an error.  */
  unsigned constant : 1;

  /* Interned state of the symbol.  This is an enumerator from
     enum symbol_interned.  */
  unsigned interned : 2;

891 892 893 894 895
  /* The symbol's name, as a Lisp string.

     The name "xname" is used to intentionally break code referring to
     the old field "name" of type pointer to struct Lisp_String.  */
  Lisp_Object xname;
896 897 898 899 900 901 902

  /* Value of the symbol or Qunbound if unbound.  If this symbol is a
     defvaralias, `value' contains the symbol for which it is an
     alias.  Use the SYMBOL_VALUE and SET_SYMBOL_VALUE macros to get
     and set a symbol's value, to take defvaralias into account.  */
  Lisp_Object value;

903
  /* Function value of the symbol or Qunbound if not fboundp.  */
904 905 906 907
  Lisp_Object function;

  /* The symbol's property list.  */
  Lisp_Object plist;
908

909 910 911 912
  /* Next symbol in obarray bucket, if the symbol is interned.  */
  struct Lisp_Symbol *next;
};

913 914 915 916 917
/* Value is name of symbol.  */

#define SYMBOL_NAME(sym)  \
     LISP_MAKE_RVALUE (XSYMBOL (sym)->xname)

918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
/* Value is non-zero if SYM is an interned symbol.  */

#define SYMBOL_INTERNED_P(sym)  \
     (XSYMBOL (sym)->interned != SYMBOL_UNINTERNED)

/* Value is non-zero if SYM is interned in initial_obarray.  */

#define SYMBOL_INTERNED_IN_INITIAL_OBARRAY_P(sym) \
     (XSYMBOL (sym)->interned == SYMBOL_INTERNED_IN_INITIAL_OBARRAY)

/* Value is non-zero if symbol is considered a constant, i.e. its
   value cannot be changed (there is an exception for keyword symbols,
   whose value can be set to the keyword symbol itself).  */

#define SYMBOL_CONSTANT_P(sym)   XSYMBOL (sym)->constant

/* Value is the value of SYM, with defvaralias taken into
   account.  */

#define SYMBOL_VALUE(sym)			\
   (XSYMBOL (sym)->indirect_variable		\
    ? XSYMBOL (indirect_variable (sym))->value	\
    : XSYMBOL (sym)->value)

/* Set SYM's value to VAL, taking defvaralias into account.  */

#define SET_SYMBOL_VALUE(sym, val)				\
     do {							\
       if (XSYMBOL (sym)->indirect_variable)			\
	 XSYMBOL (indirect_variable ((sym)))->value = (val);	\
       else							\
	 XSYMBOL (sym)->value = (val);				\
     } while (0)
951

Gerd Moellmann's avatar
Gerd Moellmann committed
952 953 954 955 956 957 958 959 960 961 962 963

/***********************************************************************
			     Hash Tables
 ***********************************************************************/

/* The structure of a Lisp hash table.  */

struct Lisp_Hash_Table
{
  /* Vector fields.  The hash table code doesn't refer to these.  */
  EMACS_INT size;
  struct Lisp_Vector *vec_next;
964

Gerd Moellmann's avatar
Gerd Moellmann committed
965 966 967 968 969 970
  /* Function used to compare keys.  */
  Lisp_Object test;

  /* Nil if table is non-weak.  Otherwise a symbol describing the
     weakness of the table.  */
  Lisp_Object weak;
971

Gerd Moellmann's avatar
Gerd Moellmann committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
  /* When the table is resized, and this is an integer, compute the
     new size by adding this to the old size.  If a float, compute the
     new size by multiplying the old size with this factor.  */
  Lisp_Object rehash_size;

  /* Resize hash table when number of entries/ table size is >= this
     ratio, a float.  */
  Lisp_Object rehash_threshold;

  /* Number of key/value entries in the table.  */
  Lisp_Object count;

  /* Vector of keys and values.  The key of item I is found at index
     2 * I, the value is found at index 2 * I + 1.  */
  Lisp_Object key_and_value;

  /* Vector of hash codes.. If hash[I] is nil, this means that that
     entry I is unused.  */
  Lisp_Object hash;

  /* Vector used to chain entries.  If entry I is free, next[I] is the
     entry number of the next free item.  If entry I is non-free,
     next[I] is the index of the next entry in the collision chain.  */
  Lisp_Object next;

  /* Index of first free entry in free list.  */
  Lisp_Object next_free;

  /* Bucket vector.  A non-nil entry is the index of the first item in
     a collision chain.  This vector's size can be larger than the
     hash table size to reduce collisions.  */
  Lisp_Object index;

  /* Next weak hash table if this is a weak hash table.  The head
     of the list is in Vweak_hash_tables.  */
  Lisp_Object next_weak;

  /* User-supplied hash function, or nil.  */
  Lisp_Object user_hash_function;

  /* User-supplied key comparison function, or nil.  */
  Lisp_Object user_cmp_function;

  /* C function to compare two keys.  */
  int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
		     unsigned, Lisp_Object, unsigned));

  /* C function to compute hash code.  */
  unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
};


#define XHASH_TABLE(OBJ) \
     ((struct Lisp_Hash_Table *) XPNTR (OBJ))

#define XSET_HASH_TABLE(VAR, PTR) \
     (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))

#define HASH_TABLE_P(OBJ)  PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
#define GC_HASH_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_HASH_TABLE)

1033
#define CHECK_HASH_TABLE(x)					\
Gerd Moellmann's avatar
Gerd Moellmann committed
1034 1035 1036 1037 1038 1039 1040
     do								\
       {							\
	 if (!HASH_TABLE_P ((x)))				\
	   x = wrong_type_argument (Qhash_table_p, (x));	\
       }							\
     while (0)

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
/* Value is the key part of entry IDX in hash table H.  */

#define HASH_KEY(H, IDX)   AREF ((H)->key_and_value, 2 * (IDX))

/* Value is the value part of entry IDX in hash table H.  */

#define HASH_VALUE(H, IDX) AREF ((H)->key_and_value, 2 * (IDX) + 1)

/* Value is the index of the next entry following the one at IDX
   in hash table H.  */

#define HASH_NEXT(H, IDX)  AREF ((H)->next, (IDX))

/* Value is the hash code computed for entry IDX in hash table H.  */

#define HASH_HASH(H, IDX)  AREF ((H)->hash, (IDX))

/* Value is the index of the element in hash table H that is the
   start of the collision list at index IDX in the index vector of H.  */

#define HASH_INDEX(H, IDX)  AREF ((H)->index, (IDX))

/* Value is the size of hash table H.  */

#define HASH_TABLE_SIZE(H) XVECTOR ((H)->next)->size

Gerd Moellmann's avatar
Gerd Moellmann committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
/* Default size for hash tables if not specified.  */

#define DEFAULT_HASH_SIZE 65

/* Default threshold specifying when to resize a hash table.  The
   value gives the ratio of current entries in the hash table and the
   size of the hash table.  */

#define DEFAULT_REHASH_THRESHOLD 0.8

/* Default factor by which to increase the size of a hash table.  */

#define DEFAULT_REHASH_SIZE 1.5

1081

1082 1083
/* These structures are used for various misc types.  */

1084 1085 1086
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
1087 1088
    int type : 16;	/* = Lisp_Misc_Free */
    int spacer : 16;
1089 1090
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
1091

Erik Naggum's avatar
Erik Naggum committed
1092
/* In a marker, the markbit of the chain field is used as the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
1093
struct Lisp_Marker
1094 1095 1096 1097 1098 1099
{
  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;
1100 1101
  /* This is the buffer that the marker points into,
     or 0 if it points nowhere.  */
1102
  struct buffer *buffer;
1103 1104 1105 1106 1107 1108

  /* The remaining fields are meaningless in a marker that
     does not point anywhere.  */

  /* For markers that point somewhere,
     this is used to chain of all the markers in a given buffer.  */
1109
  Lisp_Object chain;
1110 1111
  /* This is the char position where the marker points.  */
  int charpos;
1112 1113
  /* This is the byte position.  */
  int bytepos;
1114
};
Jim Blandy's avatar
Jim Blandy committed
1115

1116 1117 1118 1119 1120
/* 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
1121
  {
1122 1123
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
1124
    EMACS_INT *intvar;
1125 1126 1127 1128 1129 1130 1131 1132
  };

/* 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
  {
1133 1134
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
1135 1136 1137 1138 1139 1140 1141 1142 1143
    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
  {
1144 1145
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
1146 1147 1148 1149 1150 1151 1152
    Lisp_Object *objvar;
  };

/* Like Lisp_Objfwd except that value lives in a slot in the