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
                 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
4
                 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 32
/* Use the configure flag --enable-checking[=LIST] to enable various
   types of run time checks for Lisp objects.  */
33

34 35 36
#ifdef GC_CHECK_CONS_LIST
#define CHECK_CONS_LIST() check_cons_list()
#else
37
#define CHECK_CONS_LIST() ((void)0)
38
#endif
Jim Blandy's avatar
Jim Blandy committed
39

40
/* These are default choices for the types to use.  */
41 42 43 44 45 46 47 48 49
#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 */
50 51
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
52
#define BITS_PER_EMACS_INT BITS_PER_INT
53 54 55 56
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
57
#endif
58

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

#ifdef ENABLE_CHECKING

65 66 67 68 69 70 71 72 73 74 75 76 77 78
/* 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.  */

79
#define CHECK(check,msg) (((check) || suppress_checking		\
80
			   ? (void) 0				\
81
			   : die ((msg), __FILE__, __LINE__)),	\
82
			  0)
83
#else
84

85 86
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
87

88
#endif
89

90 91
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
92 93 94
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
95 96 97 98 99
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
100
#endif /* ENABLE_CHECKING */
101

Eli Zaretskii's avatar
Eli Zaretskii committed
102 103 104 105 106
/* Define this to make Lisp_Object use a union type instead of the
   default int.  FIXME: It might be better to add a flag to configure
   to do this.  */
/* #define USE_LISP_UNION_TYPE */

107 108
/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Eli Zaretskii's avatar
Eli Zaretskii committed
109 110
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
   - 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.  */
139
#if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined DARWIN_OS
140 141 142
/* 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.  */
Eli Zaretskii's avatar
Eli Zaretskii committed
143
#  ifndef USE_LISP_UNION_TYPE
144 145 146 147 148 149 150 151 152 153 154 155 156
#   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

157

158
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
159

160
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
161 162 163

enum Lisp_Type
  {
164
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
165 166
    Lisp_Int,

167
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
168 169
    Lisp_Symbol,

170 171 172
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
173 174

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

178
    /* Vector of Lisp objects, or something resembling it.
179
       XVECTOR (object) points to a struct Lisp_Vector, which contains
180 181 182
       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
183

184
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
185 186
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
187
    Lisp_Float,
188 189

    /* This is not a type code.  It is for range checking.  */
190
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
191 192
  };

193
/* This is the set of data types that share a common structure.
194 195 196 197
   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
198 199
enum Lisp_Misc_Type
  {
200
    Lisp_Misc_Free = 0x5eab,
201
    Lisp_Misc_Marker,
202 203 204
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
205 206
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
207
    Lisp_Misc_Overlay,
208
    Lisp_Misc_Kboard_Objfwd,
209
    Lisp_Misc_Save_Value,
210 211 212 213 214
    /* 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
215 216
  };

217 218 219 220
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

221 222
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
Kenichi Handa's avatar
Kenichi Handa committed
223
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
224 225
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
226
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
227

228
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232 233 234 235

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
236
       also, positive integers can be accessed fast this way.  */
237
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
238 239 240

    struct
      {
241
	EMACS_INT val  : VALBITS;
Kenichi Handa's avatar
Kenichi Handa committed
242
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
243 244 245
      } s;
    struct
      {
246
	EMACS_UINT val : VALBITS;
Kenichi Handa's avatar
Kenichi Handa committed
247
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251
      } u;
  }
Lisp_Object;

252
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257

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

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

274
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
275

276 277 278 279 280 281 282
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
283 284 285 286 287
/* 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)
288 289
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
290
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
291

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

294
typedef EMACS_INT Lisp_Object;
295
#define LISP_MAKE_RVALUE(o) (0+(o))
Eli Zaretskii's avatar
Eli Zaretskii committed
296
#endif /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
297

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

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

302 303
/* 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
304
#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1))
305

306
/* In a pseudovector, the size field actually contains a word with one
307
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
308
   indicate the actual type.
309 310 311 312
   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?  */
313 314 315 316 317 318 319 320 321
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,
322 323 324
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
325
  PVEC_HASH_TABLE = 0x40000,
326
  PVEC_TERMINAL = 0x80000,
Miles Bader's avatar
Miles Bader committed
327
  PVEC_SUB_CHAR_TABLE = 0x100000,
328 329 330
  PVEC_FONT = 0x200000,
  PVEC_OTHER = 0x400000,
  PVEC_TYPE_MASK = 0x7ffe00
331

Gerd Moellmann's avatar
Gerd Moellmann committed
332 333 334
#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.  */
335
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
336
#endif
337
};
338

339 340 341 342 343
/* 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.  */
344
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
345 346 347 348

/* 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
349 350 351

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
352
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
353

Eli Zaretskii's avatar
Eli Zaretskii committed
354
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
355

356 357 358
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

Kenichi Handa's avatar
Kenichi Handa committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
#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
382 383
/* 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
384
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
385
 */
Kenichi Handa's avatar
Kenichi Handa committed
386
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
387

Karl Heuer's avatar
Karl Heuer committed
388 389
/* 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
390
   fact that Lisp_Int is 0.  */
391
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
392
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396

/* 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
397 398
#define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS))	\
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404
#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
405
#define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409
#endif

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

413 414 415 416 417
/* 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
418
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
419

Eli Zaretskii's avatar
Eli Zaretskii committed
420
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
421

422 423
#define XHASH(a) ((a).i)

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

Karl Heuer's avatar
Karl Heuer committed
426 427 428
/* 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.  */
429
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
430
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
431 432 433

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
434
#define XINT(a) (((a).s.val << (BITS_PER_EMACS_INT - VALBITS)) \
435
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

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

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

445 446 447 448
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
449
extern Lisp_Object make_number P_ ((EMACS_INT));
450
#endif
451

Eli Zaretskii's avatar
Eli Zaretskii committed
452
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
453

454 455
#define EQ(x, y) (XHASH (x) == XHASH (y))

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
#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
471 472 473 474 475
/* 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))
476 477 478 479
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

Gerd Moellmann's avatar
Gerd Moellmann committed
480 481
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
482

Gerd Moellmann's avatar
Gerd Moellmann committed
483 484
#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
485 486 487
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
#define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
488 489 490 491

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

#define FIXNUM_OVERFLOW_P(i) \
492 493
  ((EMACS_INT)(i) > MOST_POSITIVE_FIXNUM \
   || (EMACS_INT) (i) < MOST_NEGATIVE_FIXNUM)
494

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

497 498 499 500 501
#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))
502 503

/* Misc types.  */
504

505
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
506
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
507
#define XMISCTYPE(a)   (XMISCANY (a)->type)
508 509 510 511 512 513 514 515 516 517 518 519
#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
520

521
/* Pseudovector types.  */
522

523 524
#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
525
#define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
526 527
#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
528 529 530
#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))
531 532

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

534
#define XSETINT(a, b) (a) = make_number (b)
535
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
536
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
537 538 539
#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)
540 541

/* Misc types.  */
542

543
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
544
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
545 546

/* Pseudovector types.  */
547

548
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
549
#define XSETPSEUDOVECTOR(a, b, code) \
550 551 552
  (XSETVECTOR (a, b),							\
   eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))	\
	    == (PSEUDOVECTOR_FLAG | (code))))
553 554 555 556
#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))
557
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
558 559
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
560
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
561 562
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
563
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
564 565 566

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

567
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
568
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size
569
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
570 571 572
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
573
   AREF ((ARRAY), (IDX)) = (VAL))
574

575 576
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
577
#define SDATA(string)		(XSTRING (string)->data + 0)
578 579
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
580 581 582 583 584
#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))
585

Ken Raeburn's avatar
Ken Raeburn committed
586
#define STRING_COPYIN(string, index, new, count) \
587
    bcopy (new, SDATA (string) + index, count)
Ken Raeburn's avatar
Ken Raeburn committed
588

589 590 591 592 593 594
/* 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
595

596
/* See the macros in intervals.h.  */
597 598 599 600

typedef struct interval *INTERVAL;

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

604

Jim Blandy's avatar
Jim Blandy committed
605 606 607 608
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
609 610 611
    /* 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
612 613 614 615 616 617
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
618
#else
619 620 621 622 623 624
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
625
#endif
Jim Blandy's avatar
Jim Blandy committed
626 627
  };

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

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

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

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

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

661 662 663 664
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
665
  : wrong_type_argument (Qlistp, (c)))
666 667 668 669

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

672 673 674 675 676 677 678
/* 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
679 680 681 682 683
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
684 685 686 687 688 689 690 691 692

#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
693 694 695
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

696 697
#endif /* not GC_CHECK_STRING_BYTES */

698
/* Mark STR as a unibyte string.  */
699 700 701 702
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
703

704 705 706 707 708 709 710
/* 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)

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
/* A char-table is a kind of vectorlike, with contents are like a
756
   vector but with a few other slots.  For some purposes, it makes
757
   sense to handle a char-table with type struct Lisp_Vector.  An
758 759
   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
760 761 762 763
   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.  */
764

765 766 767
/* 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.  */
768
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
769 770 771 772 773 774

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

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
#ifdef __GNUC__

#define CHAR_TABLE_REF_ASCII(CT, IDX)					\
  ({struct Lisp_Char_Table *_tbl = NULL;				\
    Lisp_Object _val;							\
    do {								\
      _tbl = _tbl ? XCHAR_TABLE (_tbl->parent) : XCHAR_TABLE (CT);	\
      _val = (! SUB_CHAR_TABLE_P (_tbl->ascii) ? _tbl->ascii		\
	      : XSUB_CHAR_TABLE (_tbl->ascii)->contents[IDX]);		\
      if (NILP (_val))							\
	_val = _tbl->defalt;						\
    } while (NILP (_val) && ! NILP (_tbl->parent));			\
    _val; })
      
#else  /* not __GNUC__ */

#define CHAR_TABLE_REF_ASCII(CT, IDX)					  \
  (! NILP (XCHAR_TABLE (CT)->ascii)					  \
   ? (! SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)			  \
      ? 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)))					  \
   :  char_table_ref ((CT), (IDX)))

#endif	/* not __GNUC__ */

802
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
803
   characters.  Do not check validity of CT.  */
804 805
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
806
   : char_table_ref ((CT), (IDX)))
807

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

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

816
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
817
   8-bit European characters.  Do not check validity of CT.  */
818 819 820 821 822 823 824 825 826 827 828 829 830 831
#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;
832

833 834 835 836
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
837 838
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
Stefan Monnier's avatar
Stefan Monnier committed
839
    EMACS_UINT size;
840
    struct Lisp_Vector *next;
841

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
855 856 857
    /* 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;
858

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

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

865
struct Lisp_Sub_Char_Table
Kenichi Handa's avatar
Kenichi Handa committed
866 867 868 869 870
  {
    /* 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;
871

Kenichi Handa's avatar
Kenichi Handa committed
872 873 874 875 876 877 878
    /* 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;
879

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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