lisp.h 120 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

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

Kenichi Handa's avatar
Kenichi Handa committed
21 22 23
#ifndef EMACS_LISP_H
#define EMACS_LISP_H

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

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

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

53
#endif /* 0 */
54

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

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

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

#ifdef ENABLE_CHECKING

86 87 88 89 90 91 92 93 94 95 96 97 98 99
/* 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.  */

100
#define CHECK(check,msg) (((check) || suppress_checking		\
101
			   ? (void) 0				\
102
			   : die ((msg), __FILE__, __LINE__)),	\
103
			  0)
104
#else
105

106 107
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
108

109
#endif
110

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

#ifdef USE_LISP_UNION_TYPE
#undef NO_UNION_TYPE
#endif

118 119
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
120 121 122
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
123 124 125 126 127
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
128
#endif /* ENABLE_CHECKING */
129 130 131

/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Dan Nicolaescu's avatar
Dan Nicolaescu committed
132 133
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
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
   - 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.  */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
166
#  if defined USE_LISP_UNION_TYPE
167 168 169 170 171 172 173 174 175 176 177 178 179
#   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

180

181
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
182

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
210
    Lisp_Float,
211 212

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

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

240 241 242 243
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

244 245
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
Kenichi Handa's avatar
Kenichi Handa committed
246
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
247 248
#endif

Dan Nicolaescu's avatar
Dan Nicolaescu committed
249
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
250

251
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
252 253 254 255 256 257 258

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

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

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

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

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

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

297
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
298

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
313
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
314

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

317
typedef EMACS_INT Lisp_Object;
318
#define LISP_MAKE_RVALUE(o) (0+(o))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
319
#endif /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
320

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

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

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

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
377
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
378

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

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

#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
 */
Kenichi Handa's avatar
Kenichi Handa committed
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
Kenichi Handa's avatar
Kenichi Handa committed
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.  */
Kenichi Handa's avatar
Kenichi Handa committed
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)

Kenichi Handa's avatar
Kenichi Handa committed
441
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
442

Dan Nicolaescu's avatar
Dan Nicolaescu committed
443
#else /* USE_LISP_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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
475
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
476

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

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
#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
494 495 496 497 498
/* 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))
499 500 501 502
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

Gerd Moellmann's avatar
Gerd Moellmann committed
503 504
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
505

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

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

#define FIXNUM_OVERFLOW_P(i) \
515 516
  ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
   || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
517

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

520 521 522 523 524
#define XCONS(a) (eassert (CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
#define XVECTOR(a) (eassert (VECTORLIKEP(a)),(struct Lisp_Vector *) XPNTR(a))
#define XSTRING(a) (eassert (STRINGP(a)),(struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) (eassert (SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
#define XFLOAT(a) (eassert (FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
525 526

/* Misc types.  */
527

528
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
529
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
530
#define XMISCTYPE(a)   (XMISCANY (a)->type)
531 532 533 534 535 536 537 538 539 540 541 542
#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
543

544
/* Pseudovector types.  */
545

546 547
#define XPROCESS(a) (eassert (PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) (eassert (WINDOWP(a)),(struct window *) XPNTR(a))
Miles Bader's avatar
Miles Bader committed
548
#define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
549 550
#define XSUBR(a) (eassert (SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
#define XBUFFER(a) (eassert (BUFFERP(a)),(struct buffer *) XPNTR(a))
Miles Bader's avatar
Miles Bader committed
551 552 553
#define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), (struct Lisp_Char_Table *) XPNTR(a))
#define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), (struct Lisp_Sub_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), (struct Lisp_Bool_Vector *) XPNTR(a))
554 555

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

557
#define XSETINT(a, b) (a) = make_number (b)
558
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
559
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
560 561 562
#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)
563 564

/* Misc types.  */
565

566
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
567
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
568 569

/* Pseudovector types.  */
570

571
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
572
#define XSETPSEUDOVECTOR(a, b, code) \
573 574 575
  (XSETVECTOR (a, b),							\
   eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))	\
	    == (PSEUDOVECTOR_FLAG | (code))))
576 577 578 579
#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))
580
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
581 582
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
583
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
584 585
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
586
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
587 588 589

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

590
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
591
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size
592
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
593 594 595
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
596
   AREF ((ARRAY), (IDX)) = (VAL))
597

598 599
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
600
#define SDATA(string)		(XSTRING (string)->data + 0)
601 602
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
603 604 605 606 607
#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))
608

Ken Raeburn's avatar
Ken Raeburn committed
609
#define STRING_COPYIN(string, index, new, count) \
610
    bcopy (new, SDATA (string) + index, count)
Ken Raeburn's avatar
Ken Raeburn committed
611

612 613 614 615 616 617
/* 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
618

619
/* See the macros in intervals.h.  */
620 621 622 623

typedef struct interval *INTERVAL;

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

627

Jim Blandy's avatar
Jim Blandy committed
628 629 630 631
/* In a cons, the markbit of the car is the gc mark bit */

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

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

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
/* 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))

684 685 686 687
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
688
  : wrong_type_argument (Qlistp, (c)))
689 690 691 692

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

695 696 697 698 699 700 701
/* 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
702 703 704 705 706
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
707 708 709 710 711 712 713 714 715

#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
716 717 718
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

719 720
#endif /* not GC_CHECK_STRING_BYTES */

721
/* Mark STR as a unibyte string.  */
722 723 724 725
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
726

727 728 729 730 731 732 733
/* Mark STR as a multibyte string.  Assure that STR contains only
   ASCII characters in advance.  */
#define STRING_SET_MULTIBYTE(STR)  \
  do { if (EQ (STR, empty_unibyte_string))  \
      (STR) = empty_multibyte_string;  \
    else XSTRING (STR)->size_byte = XSTRING (STR)->size; } while (0)

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

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

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

750 751 752 753 754 755
#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
756

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

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

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

778
/* A char-table is a kind of vectorlike, with contents are like a
779
   vector but with a few other slots.  For some purposes, it makes
780
   sense to handle a char-table with type struct Lisp_Vector.  An
781 782
   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
783 784 785 786
   specific range of characters.  A sub char-table has the same
   structure as a vector.  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.  */
787

788 789 790
/* 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.  */
791
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
792 793 794 795 796 797

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

798
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
799 800
   characters.  Do not check validity of CT.  */
#define CHAR_TABLE_REF(CT, IDX)						 \
801
  ((ASCII_CHAR_P (IDX)							 \
802 803 804 805
    && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)			 \
    && !NILP (XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX])) \
   ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX]		 \
   : char_table_ref ((CT), (IDX)))
806

Kenichi Handa's avatar
Kenichi Handa committed
807 808
/* Almost equivalent to Faref (CT, IDX).  However, if the result is
   not a character, return IDX.
809 810 811

   For these characters, do not check validity of CT
   and do not follow parent.  */
812 813
#define CHAR_TABLE_TRANSLATE(CT, IDX)	\
  char_table_translate (CT, IDX)
814

815
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
816
   8-bit European characters.  Do not check validity of CT.  */
817 818 819 820 821 822 823 824 825 826 827 828 829 830
#define CHAR_TABLE_SET(CT, IDX, VAL)					\
  (((IDX) >= 0 && ASCII_CHAR_P (IDX)					\
    && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii))			\
   ? XSUB_CHAR_TABLE (XCHAR_TABLE (CT)->ascii)->contents[IDX] = VAL	\
   : char_table_set (CT, IDX, VAL))

#define CHARTAB_SIZE_BITS_0 6
#define CHARTAB_SIZE_BITS_1 4
#define CHARTAB_SIZE_BITS_2 5
#define CHARTAB_SIZE_BITS_3 7

extern const int chartab_size[4];

struct Lisp_Sub_Char_Table;
831

832 833 834 835
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
Miles Bader's avatar
Miles Bader committed
836 837
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
Stefan Monnier's avatar
Stefan Monnier committed
838
    EMACS_UINT size;
839
    struct Lisp_Vector *next;
840

841 842 843
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
844

Kenichi Handa's avatar
Kenichi Handa committed
845 846 847
    /* 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.  */
848
    Lisp_Object parent;
849

Kenichi Handa's avatar
Kenichi Handa committed
850 851
    /* This is a symbol which says what kind of use this char-table is
       meant for.  */
852
    Lisp_Object purpose;
853

Kenichi Handa's avatar
Kenichi Handa committed
854 855 856
    /* The bottom sub char-table for characters of the range 0..127.  It
       is nil if none of ASCII character has a specific value.  */
    Lisp_Object ascii;
857

Kenichi Handa's avatar
Kenichi Handa committed
858
    Lisp_Object contents[(1 << CHARTAB_SIZE_BITS_0)];
859

Kenichi Handa's avatar
Kenichi Handa committed
860
    /* These hold additional data.  It is a vector.  */
861 862 863
    Lisp_Object extras[1];
  };

864
struct Lisp_Sub_Char_Table
Kenichi Handa's avatar
Kenichi Handa committed
865 866 867 868 869
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.  */
    EMACS_INT size;
    struct Lisp_Vector *next;
870

Kenichi Handa's avatar
Kenichi Handa committed
871 872 873 874 875 876 877
    /* Depth of this sub char-table.  It should be 1, 2, or 3.  A sub
       char-table of depth 1 contains 16 elments, and each element
       covers 4096 (128*32) characters.  A sub char-table of depth 2
       contains 32 elements, and each element covers 128 characters.  A
       sub char-table of depth 3 contains 128 elements, and each element
       is for one character.  */
    Lisp_Object depth;
878

Kenichi Handa's avatar
Kenichi Handa committed
879 880
    /* Minimum character covered by the sub char-table.  */
    Lisp_Object min_char;
881

Kenichi Handa's avatar
Kenichi Handa committed
882 883
    Lisp_Object contents[1];
  };
884 885 886 887 888 889

/* 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
890
    EMACS_UINT vector_size;
891 892
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
Stefan Monnier's avatar
Stefan Monnier committed
893
    EMACS_UINT size;
894 895 896 897
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

898 899 900 901 902 903 904
/* 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.  */
905

Jim Blandy's avatar
Jim Blandy committed
906 907
struct Lisp_Subr
  {
Stefan Monnier's avatar
Stefan Monnier committed
908
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
909 910 911
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
912
    char *intspec;
Jim Blandy's avatar
Jim Blandy committed
913 914
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
915

916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933

/***********************************************************************
			       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
{
934 935
  unsigned gcmarkbit : 1;

936 937 938 939 940 941 942 943 944 945 946 947
  /* 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;

948 949 950 951 952
  /* 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;
953 954 955 956 957 958 959

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

960
  /* Function value of the symbol or Qunbound if not fboundp.  */
961 962 963 964
  Lisp_Object function;

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

966 967 968 969
  /* Next symbol in obarray bucket, if the symbol is interned.  */
  struct Lisp_Symbol *next;
};

970 971 972 973 974
/* Value is name of symbol.  */

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

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
/* 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		\
Stefan Monnier's avatar
Stefan Monnier committed
996
    ? indirect_variable (XSYMBOL (sym))->value	\
997 998 999 1000 1001 1002 1003
    : 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)			\
Stefan Monnier's avatar
Stefan Monnier committed
1004
	 indirect_variable (XSYMBOL (sym))->value = (val);	\