lisp.h 121 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 4
                 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

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

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

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

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

55
#endif /* 0 */
56

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

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

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

#ifdef ENABLE_CHECKING

88 89 90 91 92 93 94 95 96 97 98 99 100 101
/* The suppress_checking variable is initialized to 0 in alloc.c.  Set
   it to 1 using a debugger to temporarily disable aborting on
   detected internal inconsistencies or error conditions.

   Testing suppress_checking after the supplied condition ensures that
   the side effects produced by CHECK will be consistent, independent
   of whether ENABLE_CHECKING is defined, or whether the checks are
   suppressed at run time.

   In some cases, a good compiler may be able to optimize away the
   CHECK macro altogether, e.g., if XSTRING (x) uses CHECK to test
   STRINGP (x), but a particular use of XSTRING is invoked only after
   testing that STRINGP (x) is true, making the test redundant.  */

Dan Nicolaescu's avatar
Dan Nicolaescu committed
102 103 104
#define CHECK(check,msg) (((check) || suppress_checking		\
			   ? (void) 0				\
			   : die ((msg), __FILE__, __LINE__)),	\
105
			  0)
106
#else
107

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

111
#endif
112

113
/* Used for making sure that Emacs is compilable in all
114
   configurations.  */
115 116 117 118 119

#ifdef USE_LISP_UNION_TYPE
#undef NO_UNION_TYPE
#endif

120 121
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
122 123 124
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
125 126 127 128 129
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
130
#endif /* ENABLE_CHECKING */
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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

/***** 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

182

183
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
184

185
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
186 187 188

enum Lisp_Type
  {
189
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
190 191
    Lisp_Int,

192
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
193 194
    Lisp_Symbol,

195 196 197
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
198 199

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

203
    /* Vector of Lisp objects, or something resembling it.
204
       XVECTOR (object) points to a struct Lisp_Vector, which contains
205 206 207
       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
208

209
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
210 211
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
212
    Lisp_Float,
213 214

    /* This is not a type code.  It is for range checking.  */
215
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
216 217
  };

218
/* This is the set of data types that share a common structure.
219 220 221 222
   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
223 224
enum Lisp_Misc_Type
  {
225
    Lisp_Misc_Free = 0x5eab,
226
    Lisp_Misc_Marker,
227 228 229
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
230 231
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
232
    Lisp_Misc_Overlay,
233
    Lisp_Misc_Kboard_Objfwd,
234
    Lisp_Misc_Save_Value,
235 236 237 238 239
    /* 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
240 241
  };

242 243 244 245
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

246 247
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
248
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
249 250
#endif

Jim Blandy's avatar
Jim Blandy committed
251 252
#ifndef NO_UNION_TYPE

253
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257 258 259 260

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
261
       also, positive integers can be accessed fast this way.  */
262
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
263 264 265

    struct
      {
266
	EMACS_INT val  : VALBITS;
267
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
268 269 270
      } s;
    struct
      {
271
	EMACS_UINT val : VALBITS;
272
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276
      } u;
  }
Lisp_Object;

277
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281 282

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
283
       also, positive integers can be accessed fast this way.  */
284
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
285 286 287

    struct
      {
288
	enum Lisp_Type type : GCTYPEBITS;
289
	EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
290 291 292
      } s;
    struct
      {
293
	enum Lisp_Type type : GCTYPEBITS;
294
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298
      } u;
  }
Lisp_Object;

299
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
300

301 302 303 304 305 306 307
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
308 309 310 311 312
/* 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)
313 314
#endif

315
#else /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
316

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

319
typedef EMACS_INT Lisp_Object;
320
#define LISP_MAKE_RVALUE(o) (0+(o))
321
#endif /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
322

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

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

327 328
/* 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
329
#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
330

331
/* In a pseudovector, the size field actually contains a word with one
332
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
333
   indicate the actual type.
334 335 336 337
   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?  */
338 339 340 341 342 343 344 345 346
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,
347 348 349
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
350
  PVEC_HASH_TABLE = 0x40000,
351
  PVEC_TERMINAL = 0x80000,
352 353
  PVEC_OTHER = 0x100000,
  PVEC_TYPE_MASK = 0x1ffe00
354

Gerd Moellmann's avatar
Gerd Moellmann committed
355 356 357
#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.  */
358
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
359
#endif
360
};
361

362 363 364 365 366
/* 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.  */
367
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
368 369 370 371

/* 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
372 373 374

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
375
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
376 377 378

#ifdef NO_UNION_TYPE

379 380 381
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
#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 */

403 404
#define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)

Jim Blandy's avatar
Jim Blandy committed
405 406
/* 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
407
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
408
 */
409
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
410

Karl Heuer's avatar
Karl Heuer committed
411 412
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
413
   fact that Lisp_Int is 0.  */
414
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
415
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419

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

#ifndef XINT   /* Some machines need to do this differently.  */
420 421
#define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS))	\
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427
#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
428
#define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432
#endif

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

436 437 438 439 440
/* Convert a C integer into a Lisp_Object integer.  */

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

441 442
#endif /* not USE_LSB_TAG */

443
#else /* not NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
444

445 446
#define XHASH(a) ((a).i)

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

Karl Heuer's avatar
Karl Heuer committed
449 450 451
/* 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.  */
452
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
453
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
454 455 456

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
457
#define XINT(a) (((a).s.val << (BITS_PER_EMACS_INT - VALBITS)) \
458
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
459 460 461 462 463 464 465
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

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

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

468 469 470 471
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
472
extern Lisp_Object make_number P_ ((EMACS_INT));
473
#endif
474

Stefan Monnier's avatar
Stefan Monnier committed
475 476
#endif /* NO_UNION_TYPE */

477 478
#define EQ(x, y) (XHASH (x) == XHASH (y))

Jim Blandy's avatar
Jim Blandy committed
479
/* During garbage collection, XGCTYPE must be used for extracting types
Stefan Monnier's avatar
Stefan Monnier committed
480
 so that the mark bit is ignored.  XMARKBIT accesses the markbit.
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484
 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
485 486
#ifndef XGCTYPE
/* The distinction does not exist now that the MARKBIT has been eliminated.  */
487
#define XGCTYPE(a) XTYPE (a)
Stefan Monnier's avatar
Stefan Monnier committed
488
#endif
Jim Blandy's avatar
Jim Blandy committed
489

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
#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
505 506 507 508 509
/* 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))
510 511 512 513
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

Gerd Moellmann's avatar
Gerd Moellmann committed
514 515
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
516

Gerd Moellmann's avatar
Gerd Moellmann committed
517 518
#define MOST_NEGATIVE_FIXNUM	- ((EMACS_INT) 1 << (VALBITS - 1))
#define MOST_POSITIVE_FIXNUM	(((EMACS_INT) 1 << (VALBITS - 1)) - 1)
519 520 521
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
#define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
522 523 524 525

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

#define FIXNUM_OVERFLOW_P(i) \
526 527
  ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
   || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
528

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

531
#define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
532
#define XVECTOR(a) (eassert (GC_VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
533 534 535
#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))
536 537

/* Misc types.  */
538

539
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
540
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
541
#define XMISCTYPE(a)   (XMISCANY (a)->type)
542 543 544 545 546 547 548 549 550 551 552 553
#define XMARKER(a)	(eassert (MARKERP (a)), &(XMISC(a)->u_marker))
#define XINTFWD(a)	(eassert (INTFWDP (a)), &(XMISC(a)->u_intfwd))
#define XBOOLFWD(a)	(eassert (BOOLFWDP (a)), &(XMISC(a)->u_boolfwd))
#define XOBJFWD(a)	(eassert (OBJFWDP (a)), &(XMISC(a)->u_objfwd))
#define XOVERLAY(a)	(eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
#define XSAVE_VALUE(a)	(eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
#define XBUFFER_OBJFWD(a) \
  (eassert (BUFFER_OBJFWDP (a)), &(XMISC(a)->u_buffer_objfwd))
#define XBUFFER_LOCAL_VALUE(a) \
  (eassert (BUFFER_LOCAL_VALUEP (a)), &(XMISC(a)->u_buffer_local_value))
#define XKBOARD_OBJFWD(a) \
  (eassert (KBOARD_OBJFWDP (a)), &(XMISC(a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
554

555
/* Pseudovector types.  */
556

557 558
#define XPROCESS(a) (eassert (GC_PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) (eassert (GC_WINDOWP(a)),(struct window *) XPNTR(a))
559
#define XTERMINAL(a) (eassert (GC_TERMINALP(a)),(struct terminal *) XPNTR(a))
560 561
#define XSUBR(a) (eassert (GC_SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
#define XBUFFER(a) (eassert (GC_BUFFERP(a)),(struct buffer *) XPNTR(a))
562 563
#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))
564 565

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

567
#define XSETINT(a, b) (a) = make_number (b)
568
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
569
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
570 571 572
#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)
573 574

/* Misc types.  */
575

576
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
577
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
578 579

/* Pseudovector types.  */
580

581
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
582
#define XSETPSEUDOVECTOR(a, b, code) \
583 584 585
  (XSETVECTOR (a, b),							\
   eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))	\
	    == (PSEUDOVECTOR_FLAG | (code))))
586 587 588 589
#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))
590
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
591 592
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
593
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
594 595
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
596 597 598 599 600 601 602

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

603 604
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
605
#define SDATA(string)		(XSTRING (string)->data + 0)
606 607
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
608 609 610 611 612
#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))
613

Ken Raeburn's avatar
Ken Raeburn committed
614
#define STRING_COPYIN(string, index, new, count) \
615
    bcopy (new, SDATA (string) + index, count)
Ken Raeburn's avatar
Ken Raeburn committed
616

617 618 619 620 621 622
/* 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
623

624
/* See the macros in intervals.h.  */
625 626 627 628

typedef struct interval *INTERVAL;

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

632

Jim Blandy's avatar
Jim Blandy committed
633 634 635 636
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
637 638 639
    /* 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
640 641 642 643 644 645
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
646
#else
647 648 649 650 651 652
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
653
#endif
Jim Blandy's avatar
Jim Blandy committed
654 655
  };

656
/* Take the car or cdr of something known to be a cons cell.  */
657 658 659 660 661 662
/* 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.)  */
663
#ifdef HIDE_LISP_IMPLEMENTATION
664
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
665
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
666
#else
667
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
668
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
669
#endif
670

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
/* 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))

689 690 691 692 693 694 695 696 697 698 699
/* 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)))

700 701 702 703 704 705 706
/* 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
707 708 709 710 711
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
712 713 714 715 716 717 718 719 720

#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
721 722 723
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

724 725
#endif /* not GC_CHECK_STRING_BYTES */

726
/* Mark STR as a unibyte string.  */
727 728 729 730
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
731 732

/* Get text properties.  */
733 734 735 736
#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
737

Jim Blandy's avatar
Jim Blandy committed
738 739 740 741
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
742
    EMACS_INT size;
743
    EMACS_INT size_byte;
744
    INTERVAL intervals;		/* text properties in this string */
745
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
746 747
  };

748 749 750 751 752 753
#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
754

Jim Blandy's avatar
Jim Blandy committed
755 756
struct Lisp_Vector
  {
Stefan Monnier's avatar
Stefan Monnier committed
757
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
758 759 760 761
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
762
/* If a struct is made to look like a vector, this macro returns the length
763
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
764 765 766
#define VECSIZE(type) ((sizeof (type)					  \
			- OFFSETOF (struct Lisp_Vector, contents[0])      \
                        + sizeof(Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
767 768
		       / sizeof (Lisp_Object))

769 770 771 772
/* 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) \
773
  ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
774 775
   / sizeof (Lisp_Object))

776 777 778 779 780 781 782 783 784 785
/* 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.  */
786

787 788
/* 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
789 790 791
   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).  */
792 793
#define CHAR_TABLE_ORDINARY_SLOTS 384

794 795 796 797 798 799 800 801
/* 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)

802 803 804
/* This is the number of slots that apply to characters of ASCII and
   8-bit Europeans only.  */
#define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
805

806 807 808 809 810 811 812 813 814 815 816 817
/* 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.  */
818
#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
819 820 821 822 823 824

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

825
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
826 827 828
   and 8-bit Europeans characters.  For these characters, do not check
   validity of CT.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)				\
829
  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
830 831
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XCHAR_TABLE (CT)->contents[IDX]			\
832
      : XCHAR_TABLE (CT)->defalt)			\
833
   : Faref (CT, make_number (IDX)))
834

835 836 837 838 839 840 841 842 843 844 845 846 847
/* 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))

848
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
849 850 851 852 853 854 855
   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);				\
856 857
  } while (0)

858 859 860 861
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
862 863
       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
864
    EMACS_UINT size;
865
    struct Lisp_Vector *next;
866 867 868
    /* This holds a flag to tell if this is a top level char table (t)
       or a sub char table (nil).  */
    Lisp_Object top;
869 870 871
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
872 873 874 875 876 877
    /* 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.  */

878 879 880 881
    /* 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;
882 883 884 885
    /* 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;
886 887 888 889 890 891 892 893 894
    /* 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
895
    EMACS_UINT vector_size;
896 897
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
Stefan Monnier's avatar
Stefan Monnier committed
898
    EMACS_UINT size;
899 900 901 902
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

903 904 905 906 907 908 909
/* 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.  */
910

Jim Blandy's avatar
Jim Blandy committed
911 912
struct Lisp_Subr
  {
Stefan Monnier's avatar
Stefan Monnier committed
913
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
914 915 916
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
917
    char *intspec;
Jim Blandy's avatar
Jim Blandy committed
918 919
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
920

921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938

/***********************************************************************
			       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
{
939 940
  unsigned gcmarkbit : 1;

941 942 943 944 945 946 947 948 949 950 951 952
  /* 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;

953 954 955 956 957
  /* 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;
958 959 960 961 962 963 964

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

965
  /* Function value of the symbol or Qunbound if not fboundp.  */
966 967 968 969
  Lisp_Object function;

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

971 972 973 974
  /* Next symbol in obarray bucket, if the symbol is interned.  */
  struct Lisp_Symbol *next;
};

975 976 977 978 979
/* Value is name of symbol.  */

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

/***********************************************************************
			     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
1024
  EMACS_UINT size;
Gerd Moellmann's avatar
Gerd Moellmann committed
1025
  struct Lisp_Vector *vec_next;
1026

Gerd Moellmann's avatar
Gerd Moellmann committed
1027 1028 1029 1030 1031 1032
  /* 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;
1033

Gerd Moellmann's avatar
Gerd Moellmann committed
1034 1035 1036 1037 1038 1039 1040 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
  /* 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;

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
  /* 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;

1078 1079 1080 1081
  /* 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
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
  /* C function to compare two keys.  */
  int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
		     unsigned, Lisp_Object, unsigned));