lisp.h 119 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2000,
Glenn Morris's avatar
Glenn Morris committed
3
                 2001, 2002, 2003, 2004, 2005, 2006, 2007 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
9
the Free Software Foundation; either version 3, 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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

Dave Love's avatar
Dave Love committed
22 23 24
#ifndef EMACS_LISP_H
#define EMACS_LISP_H

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

32
#if 0
33 34 35 36 37
/* 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
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

/* Define this to check for short string overrun.  */

#define GC_CHECK_STRING_OVERRUN 1

/* Define this to check the string free list.  */

#define GC_CHECK_STRING_FREE_LIST 1

/* Define this to check for malloc buffer overrun.  */

#define XMALLOC_OVERRUN_CHECK 1

/* Define this to check for errors in cons list.  */
/* #define GC_CHECK_CONS_LIST 1 */

54
#endif /* 0 */
55

56 57 58
#ifdef GC_CHECK_CONS_LIST
#define CHECK_CONS_LIST() check_cons_list()
#else
59
#define CHECK_CONS_LIST() ((void)0)
60
#endif
Jim Blandy's avatar
Jim Blandy committed
61

62
/* These are default choices for the types to use.  */
63 64 65 66 67 68 69 70 71
#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 */
72 73
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
74
#define BITS_PER_EMACS_INT BITS_PER_INT
75 76 77 78
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
79
#endif
80

81 82
/* Extra internal type checking?  */
extern int suppress_checking;
83
extern void die P_((const char *, const char *, int)) NO_RETURN;
84 85 86

#ifdef ENABLE_CHECKING

Dan Nicolaescu's avatar
Dan Nicolaescu committed
87 88 89
#define CHECK(check,msg) (((check) || suppress_checking		\
			   ? (void) 0				\
			   : die ((msg), __FILE__, __LINE__)),	\
90
			  0)
91
#else
92

93
/* Produce same side effects and result, but don't complain.  */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
94
#define CHECK(check,msg) ((check),0)
95

96
#endif
97

98
/* Used for making sure that Emacs is compilable in all
99
   configurations.  */
100 101 102 103 104

#ifdef USE_LISP_UNION_TYPE
#undef NO_UNION_TYPE
#endif

105 106
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
107 108 109
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
110 111 112 113 114
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
115
#endif /* ENABLE_CHECKING */
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166

/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
   - NO_UNION_TYPE says that Lisp_Object should be an integer instead
     of a union.
   - USE_LSB_TAG means that we can assume the least 3 bits of pointers are
     always 0, and we can thus use them to hold tag bits, without
     restricting our addressing space.

   If USE_LSB_TAG is not set, then we use the top 3 bits for tagging, thus
   restricting our possible address range.  Currently USE_LSB_TAG is not
   allowed together with a union.  This is not due to any fundamental
   technical (or political ;-) problem: nobody wrote the code to do it yet.

   USE_LSB_TAG not only requires the least 3 bits of pointers returned by
   malloc to be 0 but also needs to be able to impose a mult-of-8 alignment
   on the few static Lisp_Objects used: all the defsubr as well
   as the two special buffers buffer_defaults and buffer_local_symbols.  */

/* First, try and define DECL_ALIGN(type,var) which declares a static
   variable VAR of type TYPE with the added requirement that it be
   TYPEBITS-aligned. */
#ifndef NO_DECL_ALIGN
# ifndef DECL_ALIGN
/* What compiler directive should we use for non-gcc compilers?  -stef  */
#  if defined (__GNUC__)
#   define DECL_ALIGN(type, var) \
     type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
#  endif
# endif
#endif

/* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8.  */
#if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined MAC_OSX
/* We also need to be able to specify mult-of-8 alignment on static vars.  */
# if defined DECL_ALIGN
/* We currently do not support USE_LSB_TAG with a union Lisp_Object.  */
#  if defined NO_UNION_TYPE
#   define USE_LSB_TAG
#  endif
# endif
#endif

/* If we cannot use 8-byte alignment, make DECL_ALIGN a no-op.  */
#ifndef DECL_ALIGN
# ifdef USE_LSB_TAG
#  error "USE_LSB_TAG used without defining DECL_ALIGN"
# endif
# define DECL_ALIGN(type, var) type var
#endif

167

168
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
169

170
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
171 172 173

enum Lisp_Type
  {
174
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
175 176
    Lisp_Int,

177
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
178 179
    Lisp_Symbol,

180 181 182
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
183 184

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

188
    /* Vector of Lisp objects, or something resembling it.
189
       XVECTOR (object) points to a struct Lisp_Vector, which contains
190 191 192
       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
193

194
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
195 196
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
197
    Lisp_Float,
198 199

    /* This is not a type code.  It is for range checking.  */
200
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
201 202
  };

203
/* This is the set of data types that share a common structure.
204 205 206 207
   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
208 209
enum Lisp_Misc_Type
  {
210
    Lisp_Misc_Free = 0x5eab,
211
    Lisp_Misc_Marker,
212 213 214
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
215 216
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
217
    Lisp_Misc_Some_Buffer_Local_Value,
218
    Lisp_Misc_Overlay,
219
    Lisp_Misc_Kboard_Objfwd,
220
    Lisp_Misc_Save_Value,
221 222 223 224 225
    /* 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
226 227
  };

228 229 230 231
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

232 233
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
234
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
235 236
#endif

Jim Blandy's avatar
Jim Blandy committed
237 238
#ifndef NO_UNION_TYPE

239
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243 244 245 246

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
247
       also, positive integers can be accessed fast this way.  */
248
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
249 250 251

    struct
      {
252
	EMACS_INT val  : VALBITS;
253
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
254 255 256
      } s;
    struct
      {
257
	EMACS_UINT val : VALBITS;
258
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262
      } u;
  }
Lisp_Object;

263
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
269
       also, positive integers can be accessed fast this way.  */
270
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
271 272 273

    struct
      {
274
	enum Lisp_Type type : GCTYPEBITS;
275
	EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
276 277 278
      } s;
    struct
      {
279
	enum Lisp_Type type : GCTYPEBITS;
280
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
281 282 283 284
      } u;
  }
Lisp_Object;

285
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
286

287 288 289 290 291 292 293
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
294 295 296 297 298
/* 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)
299 300
#endif

301
#else /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
302

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

305
typedef EMACS_INT Lisp_Object;
306
#define LISP_MAKE_RVALUE(o) (0+(o))
307
#endif /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
308

Stefan Monnier's avatar
Stefan Monnier committed
309
/* In the size word of a vector, this bit means the vector has been marked.  */
310

Stefan Monnier's avatar
Stefan Monnier committed
311
#define ARRAY_MARK_FLAG ((EMACS_UINT) 1 << (BITS_PER_EMACS_INT - 1))
312

313 314
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
Stefan Monnier's avatar
Stefan Monnier committed
315
#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
316

317
/* In a pseudovector, the size field actually contains a word with one
318
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
319
   indicate the actual type.
320 321 322 323
   We use a bitset, even tho only one of the bits can be set at any
   particular time just so as to be able to use micro-optimizations such as
   testing membership of a particular subset of pseudovectors in Fequal.
   It is not crucial, but there are plenty of bits here, so why not do it?  */
324 325 326 327 328 329 330 331 332
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,
333 334 335
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
336
  PVEC_HASH_TABLE = 0x40000,
337 338
  PVEC_TERMINAL = 0x80000,
  PVEC_TYPE_MASK = 0xffe00
339

Gerd Moellmann's avatar
Gerd Moellmann committed
340 341 342
#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.  */
343
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
344
#endif
345
};
346

347 348 349 350 351
/* For convenience, we also store the number of elements in these bits.
   Note that this size is not necessarily the memory-footprint size, but
   only the number of Lisp_Object fields (that need to be traced by the GC).
   The distinction is used e.g. by Lisp_Process which places extra
   non-Lisp_Object fields at the end of the structure.  */
352
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
353 354 355 356

/* Number of bits to put in each character in the internal representation
   of bool vectors.  This should not vary across implementations.  */
#define BOOL_VECTOR_BITS_PER_CHAR 8
Jim Blandy's avatar
Jim Blandy committed
357 358 359

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
360
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
361 362 363

#ifdef NO_UNION_TYPE

364 365 366
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
#ifdef USE_LSB_TAG

#define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
#define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
#define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
#define XSET(var, type, ptr)					\
    (eassert (XTYPE (ptr) == 0), /* Check alignment.  */	\
     (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))
#define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)

/* XFASTINT and XSETFASTINT are for use when the integer is known to be
   positive, in which case the implementation can sometimes be faster
   depending on the tagging scheme.  With USE_LSB_TAG, there's no benefit.  */
#define XFASTINT(a) XINT (a)
#define XSETFASTINT(a, b) ((a) = make_number (b))

#define XPNTR(a) ((EMACS_INT) ((a) & ~TYPEMASK))

#else  /* not USE_LSB_TAG */

388 389
#define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)

Jim Blandy's avatar
Jim Blandy committed
390 391
/* 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
392
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
393
 */
394
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
395

Karl Heuer's avatar
Karl Heuer committed
396 397
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
398
   fact that Lisp_Int is 0.  */
399
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
400
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
401 402 403 404

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

#ifndef XINT   /* Some machines need to do this differently.  */
405 406
#define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS))	\
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412
#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
413
#define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417
#endif

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

421 422 423 424 425
/* Convert a C integer into a Lisp_Object integer.  */

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

426 427
#endif /* not USE_LSB_TAG */

428
#else /* not NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
429

430 431
#define XHASH(a) ((a).i)

Jim Blandy's avatar
Jim Blandy committed
432 433
#define XTYPE(a) ((enum Lisp_Type) (a).u.type)

Karl Heuer's avatar
Karl Heuer committed
434 435 436
/* 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.  */
437
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
438
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
439 440 441

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
442
#define XINT(a) (((a).s.val << (BITS_PER_EMACS_INT - VALBITS)) \
443
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449 450
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

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

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

453 454 455 456
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
457
extern Lisp_Object make_number P_ ((EMACS_INT));
458
#endif
459

Stefan Monnier's avatar
Stefan Monnier committed
460 461
#endif /* NO_UNION_TYPE */

462 463
#define EQ(x, y) (XHASH (x) == XHASH (y))

Jim Blandy's avatar
Jim Blandy committed
464
/* During garbage collection, XGCTYPE must be used for extracting types
Stefan Monnier's avatar
Stefan Monnier committed
465
 so that the mark bit is ignored.  XMARKBIT accesses the markbit.
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
 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.  */

Stefan Monnier's avatar
Stefan Monnier committed
470 471
#ifndef XGCTYPE
/* The distinction does not exist now that the MARKBIT has been eliminated.  */
472
#define XGCTYPE(a) XTYPE (a)
Stefan Monnier's avatar
Stefan Monnier committed
473
#endif
Jim Blandy's avatar
Jim Blandy committed
474

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
#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
490 491 492 493 494
/* Some versions of gcc seem to consider the bitfield width when
   issuing the "cast to pointer from integer of different size"
   warning, so the cast is here to widen the value back to its natural
   size.  */
#define XPNTR(a) ((EMACS_INT) XUINT (a))
495 496 497 498
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

Gerd Moellmann's avatar
Gerd Moellmann committed
499 500
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
501

Gerd Moellmann's avatar
Gerd Moellmann committed
502 503
#define MOST_NEGATIVE_FIXNUM	- ((EMACS_INT) 1 << (VALBITS - 1))
#define MOST_POSITIVE_FIXNUM	(((EMACS_INT) 1 << (VALBITS - 1)) - 1)
504 505 506
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
#define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
507 508 509 510

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

#define FIXNUM_OVERFLOW_P(i) \
511 512
  ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
   || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
513

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

516
#define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
517
#define XVECTOR(a) (eassert (GC_VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
518 519 520
#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))
521 522

/* Misc types.  */
523

524
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Richard M. Stallman's avatar
Richard M. Stallman committed
525
#define XMISCTYPE(a)   (XMARKER (a)->type)
526
#define XMARKER(a) (&(XMISC(a)->u_marker))
527 528 529 530
#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))
531
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
532
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
533
#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
534
#define XSAVE_VALUE(a) (&(XMISC(a)->u_save_value))
Jim Blandy's avatar
Jim Blandy committed
535

536
/* Pseudovector types.  */
537

538 539
#define XPROCESS(a) (eassert (GC_PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) (eassert (GC_WINDOWP(a)),(struct window *) XPNTR(a))
540
#define XTERMINAL(a) (eassert (GC_TERMINALP(a)),(struct terminal *) XPNTR(a))
541 542
#define XSUBR(a) (eassert (GC_SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
#define XBUFFER(a) (eassert (GC_BUFFERP(a)),(struct buffer *) XPNTR(a))
543 544
#define XCHAR_TABLE(a) (eassert (GC_CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) (eassert (GC_BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
545 546

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

548
#define XSETINT(a, b) (a) = make_number (b)
549
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
550
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
551 552 553
#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)
554 555

/* Misc types.  */
556

557
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
558
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
559 560

/* Pseudovector types.  */
561

562
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
563
#define XSETPSEUDOVECTOR(a, b, code) \
564
  (XSETVECTOR (a, b), XSETPVECTYPE (XVECTOR (a), code))
565 566 567 568
#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))
569
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
570 571
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
572
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
573 574
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
575 576 577 578 579 580 581

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

582 583
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
584
#define SDATA(string)		(XSTRING (string)->data + 0)
585 586
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
587 588 589 590 591
#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))
592

Ken Raeburn's avatar
Ken Raeburn committed
593
#define STRING_COPYIN(string, index, new, count) \
594
    bcopy (new, SDATA (string) + index, count)
Ken Raeburn's avatar
Ken Raeburn committed
595

596 597 598 599 600 601
/* Type checking.  */

#define CHECK_TYPE(ok, Qxxxp, x) \
  do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)


Jim Blandy's avatar
Jim Blandy committed
602

603
/* See the macros in intervals.h.  */
604 605 606 607

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
608
#define CHECK_STRING_OR_BUFFER(x) \
609 610
  CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)

611

Jim Blandy's avatar
Jim Blandy committed
612 613 614 615
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
616 617 618
    /* 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
619 620 621 622 623 624
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
625
#else
626 627 628 629 630 631
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
632
#endif
Jim Blandy's avatar
Jim Blandy committed
633 634
  };

635
/* Take the car or cdr of something known to be a cons cell.  */
636 637 638 639 640 641
/* 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.)  */
642
#ifdef HIDE_LISP_IMPLEMENTATION
643
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
644
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
645
#else
646
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
647
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
648
#endif
649

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
/* 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))

668 669 670 671 672 673 674 675 676 677 678
/* 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)))

679 680 681 682 683 684 685
/* Take the car or cdr of something whose type is not known.  */
#define CAR_SAFE(c)				\
  (CONSP ((c)) ? XCAR ((c)) : Qnil)

#define CDR_SAFE(c)				\
  (CONSP ((c)) ? XCDR ((c)) : Qnil)

Kenichi Handa's avatar
Kenichi Handa committed
686 687 688 689 690
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
691 692 693 694 695 696 697 698 699

#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
700 701 702
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

703 704
#endif /* not GC_CHECK_STRING_BYTES */

705
/* Mark STR as a unibyte string.  */
706 707 708 709
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
710 711

/* Get text properties.  */
712 713 714 715
#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
716

Jim Blandy's avatar
Jim Blandy committed
717 718 719 720
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
721
    EMACS_INT size;
722
    EMACS_INT size_byte;
723
    INTERVAL intervals;		/* text properties in this string */
724
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
725 726
  };

727 728 729 730 731 732
#ifdef offsetof
#define OFFSETOF(type,field) offsetof(type,field)
#else
#define OFFSETOF(type,field) \
  ((int)((char*)&((type*)0)->field - (char*)0))
#endif
Karl Heuer's avatar
Karl Heuer committed
733

Jim Blandy's avatar
Jim Blandy committed
734 735
struct Lisp_Vector
  {
Stefan Monnier's avatar
Stefan Monnier committed
736
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
737 738 739 740
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
741
/* If a struct is made to look like a vector, this macro returns the length
742
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
743 744 745
#define VECSIZE(type) ((sizeof (type)					  \
			- OFFSETOF (struct Lisp_Vector, contents[0])      \
                        + sizeof(Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
746 747
		       / sizeof (Lisp_Object))

748 749 750 751
/* Like VECSIZE, but used when the pseudo-vector has non-Lisp_Object fields
   at the end and we need to compute the number of Lisp_Object fields (the
   ones that the GC needs to trace).  */
#define PSEUDOVECSIZE(type, nonlispfield) \
752
  ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
753 754
   / sizeof (Lisp_Object))

755 756 757 758 759 760 761 762 763 764
/* 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.  */
765

766 767
/* 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
768 769 770
   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).  */
771 772
#define CHAR_TABLE_ORDINARY_SLOTS 384

773 774 775 776 777 778 779 780
/* These are the slot of the default values for single byte
   characters.  As 0x9A is never be a charset-id, it is safe to use
   that slot for ASCII.  0x9E and 0x80 are charset-ids of
   eight-bit-control and eight-bit-graphic respectively.  */
#define CHAR_TABLE_DEFAULT_SLOT_ASCII (0x9A + 128)
#define CHAR_TABLE_DEFAULT_SLOT_8_BIT_CONTROL (0x9E + 128)
#define CHAR_TABLE_DEFAULT_SLOT_8_BIT_GRAPHIC (0x80 + 128)

781 782 783
/* This is the number of slots that apply to characters of ASCII and
   8-bit Europeans only.  */
#define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
784

785 786 787 788 789 790 791 792 793 794 795 796
/* 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.  */
797
#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
798 799 800 801 802 803

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

804
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
805 806 807
   and 8-bit Europeans characters.  For these characters, do not check
   validity of CT.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)				\
808
  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
809 810
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XCHAR_TABLE (CT)->contents[IDX]			\
811
      : XCHAR_TABLE (CT)->defalt)			\
812
   : Faref (CT, make_number (IDX)))
813

814 815 816 817 818 819 820 821 822 823 824 825 826
/* 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))

827
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
828 829 830 831 832 833 834
   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);				\
835 836
  } while (0)

837 838 839 840
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
841 842
       The size counts the top, defalt, purpose, and parent slots.
       The last three are not counted if this is a sub char table.  */
Stefan Monnier's avatar
Stefan Monnier committed
843
    EMACS_UINT size;
844
    struct Lisp_Vector *next;
845 846 847
    /* This holds a flag to tell if this is a top level char table (t)
       or a sub char table (nil).  */
    Lisp_Object top;
848 849 850
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
851 852 853 854 855 856
    /* 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.  */

857 858 859 860
    /* 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;
861 862 863 864
    /* 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;
865 866 867 868 869 870 871 872 873
    /* 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.  */
Stefan Monnier's avatar
Stefan Monnier committed
874
    EMACS_UINT vector_size;
875 876
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
Stefan Monnier's avatar
Stefan Monnier committed
877
    EMACS_UINT size;
878 879 880 881
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

882 883 884 885 886 887 888
/* 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.  */
889

Jim Blandy's avatar
Jim Blandy committed
890 891
struct Lisp_Subr
  {
Stefan Monnier's avatar
Stefan Monnier committed
892
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
893 894 895
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
896
    char *intspec;
Jim Blandy's avatar
Jim Blandy committed
897 898
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
899

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917

/***********************************************************************
			       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
{
918 919
  unsigned gcmarkbit : 1;

920 921 922 923 924 925 926 927 928 929 930 931
  /* 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;

932 933 934 935 936
  /* 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;
937 938 939 940 941 942 943

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

944
  /* Function value of the symbol or Qunbound if not fboundp.  */
945 946 947 948
  Lisp_Object function;

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

950 951 952 953
  /* Next symbol in obarray bucket, if the symbol is interned.  */
  struct Lisp_Symbol *next;
};

954 955 956 957 958
/* Value is name of symbol.  */

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

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
/* 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)
992

Gerd Moellmann's avatar
Gerd Moellmann committed
993 994 995 996 997 998 999 1000 1001 1002

/***********************************************************************
			     Hash Tables
 ***********************************************************************/

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

struct Lisp_Hash_Table
{
  /* Vector fields.  The hash table code doesn't refer to these.  */
Stefan Monnier's avatar
Stefan Monnier committed
1003
  EMACS_UINT size;
Gerd Moellmann's avatar
Gerd Moellmann committed
1004
  struct Lisp_Vector *vec_next;
1005

Gerd Moellmann's avatar
Gerd Moellmann committed
1006 1007 1008 1009 1010 1011
  /* 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;
1012

Gerd Moellmann's avatar
Gerd Moellmann committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  /* 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;

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

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

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

1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  /* Only the fields above are traced normally by the GC.  The ones below
     `count'.  are special and are either ignored by the GC or traced in
     a special way (e.g. because of weakness).  */

  /* Number of key/value entries in the table.  */
  unsigned int 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.
     This is gc_marked specially if the table is weak.  */
  Lisp_Object key_and_value;

1057 1058 1059 1060
  /* Next weak hash table if this is a weak hash table.  The head
     of the list is in weak_hash_tables.  */
  struct Lisp_Hash_Table *next_weak;

Gerd Moellmann's avatar
Gerd Moellmann committed
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
  /* 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)