lisp.h 124 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, 2010
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

24 25
/* Use the configure flag --enable-checking[=LIST] to enable various
   types of run time checks for Lisp objects.  */
26

27 28 29
#ifdef GC_CHECK_CONS_LIST
#define CHECK_CONS_LIST() check_cons_list()
#else
30
#define CHECK_CONS_LIST() ((void)0)
31
#endif
Jim Blandy's avatar
Jim Blandy committed
32

33
/* These are default choices for the types to use.  */
34 35 36 37 38 39 40 41 42
#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 */
43 44
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
45
#define BITS_PER_EMACS_INT BITS_PER_INT
46 47 48 49
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
50
#endif
51

52 53
/* Extra internal type checking?  */
extern int suppress_checking;
Jan D's avatar
Jan D committed
54
extern void die (const char *, const char *, int) NO_RETURN;
55 56 57

#ifdef ENABLE_CHECKING

58 59 60 61 62 63 64 65 66 67 68 69 70 71
/* 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.  */

72
#define CHECK(check,msg) (((check) || suppress_checking		\
73
			   ? (void) 0				\
74
			   : die ((msg), __FILE__, __LINE__)),	\
75
			  0)
76
#else
77

78 79
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
80

81
#endif
82

83 84
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
85 86 87
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
88 89 90 91 92
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
93
#endif /* ENABLE_CHECKING */
94

95 96 97
/* Use the configure flag --enable-use-lisp-union-type to make
   Lisp_Object use a union type instead of the default int.  The flag
   causes USE_LISP_UNION_TYPE to be defined.  */
Eli Zaretskii's avatar
Eli Zaretskii committed
98

99 100
/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Eli Zaretskii's avatar
Eli Zaretskii committed
101 102
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
   - 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.  */
131
#if defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ || defined DARWIN_OS
132 133
/* We also need to be able to specify mult-of-8 alignment on static vars.  */
# if defined DECL_ALIGN
134
#  define USE_LSB_TAG
135 136 137 138 139 140 141 142 143 144 145
# 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

146

147
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
148

149 150 151 152 153 154 155 156 157 158
/* If USE_2_TAGBITS_FOR_INTS is defined, then Lisp integers use
   2 tags, to give them one extra bit, thus extending their range from
   e.g -2^28..2^28-1 to -2^29..2^29-1.  */
#define USE_2_TAGS_FOR_INTS

/* Making it work for the union case is too much trouble.  */
#ifdef USE_LISP_UNION_TYPE
# undef USE_2_TAGS_FOR_INTS
#endif

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

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
#if !defined USE_2_TAGS_FOR_INTS
# define LISP_INT_TAG Lisp_Int
# define case_Lisp_Int case Lisp_Int
# define LISP_STRING_TAG 4
# define LISP_INT_TAG_P(x) ((x) == Lisp_Int)
#else
# define LISP_INT_TAG Lisp_Int0
# define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
# ifdef USE_LSB_TAG
#  define LISP_INT1_TAG 4
#  define LISP_STRING_TAG 1
#  define LISP_INT_TAG_P(x) (((x) & 3) == 0)
# else
#  define LISP_INT1_TAG 1
#  define LISP_STRING_TAG 4
#  define LISP_INT_TAG_P(x) (((x) & 6) == 0)
# endif
#endif

Jim Blandy's avatar
Jim Blandy committed
180 181
enum Lisp_Type
  {
182
    /* Integer.  XINT (obj) is the integer value.  */
183 184 185 186 187 188
#ifdef USE_2_TAGS_FOR_INTS
    Lisp_Int0 = 0,
    Lisp_Int1 = LISP_INT1_TAG,
#else
    Lisp_Int = 0,
#endif
Jim Blandy's avatar
Jim Blandy committed
189

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

193 194
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
195
    Lisp_Misc = 3,
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.  */
199
    Lisp_String = LISP_STRING_TAG,
Jim Blandy's avatar
Jim Blandy committed
200

201
    /* Vector of Lisp objects, or something resembling it.
202
       XVECTOR (object) points to a struct Lisp_Vector, which contains
203 204
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
205
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
206

207
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
208
    Lisp_Cons = 6,
209

210
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
211 212
  };

213
/* This is the set of data types that share a common structure.
214 215 216 217
   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
218 219
enum Lisp_Misc_Type
  {
220
    Lisp_Misc_Free = 0x5eab,
221
    Lisp_Misc_Marker,
222
    Lisp_Misc_Overlay,
223
    Lisp_Misc_Save_Value,
224 225 226 227 228
    /* 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
229 230
  };

231 232 233 234 235 236 237 238 239 240 241 242
/* These are the types of forwarding objects used in the value slot
   of symbols for special built-in variables whose value is stored in
   C variables.  */
enum Lisp_Fwd_Type
  {
    Lisp_Fwd_Int,		/* Fwd to a C `int' variable.  */
    Lisp_Fwd_Bool,		/* Fwd to a C boolean var.  */
    Lisp_Fwd_Obj,		/* Fwd to a C Lisp_Object variable.  */
    Lisp_Fwd_Buffer_Obj,	/* Fwd to a Lisp_Object field of buffers.  */
    Lisp_Fwd_Kboard_Obj,	/* Fwd to a Lisp_Object field of kboards.  */
  };

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

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

Eli Zaretskii's avatar
Eli Zaretskii committed
252
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
253

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

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

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

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

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

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

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

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

302 303 304 305 306 307 308
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
309 310 311 312
/* This is more portable to pre-C99 non-GCC compilers, but for
   backwards compatibility GCC still accepts an old GNU extension
   which caused this to only generate a warning.  */
#define LISP_MAKE_RVALUE(o) (0 ? (o) : (o))
313 314
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
315
#else /* USE_LISP_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))
Eli Zaretskii's avatar
Eli Zaretskii committed
321
#endif /* USE_LISP_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,
Miles Bader's avatar
Miles Bader committed
352
  PVEC_SUB_CHAR_TABLE = 0x100000,
353 354 355
  PVEC_FONT = 0x200000,
  PVEC_OTHER = 0x400000,
  PVEC_TYPE_MASK = 0x7ffe00
356

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

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

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

Eli Zaretskii's avatar
Eli Zaretskii committed
379
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
380

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

Kenichi Handa's avatar
Kenichi Handa committed
384 385 386 387
#ifdef USE_LSB_TAG

#define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
388 389 390 391 392 393 394 395 396
#ifdef USE_2_TAGS_FOR_INTS
# define XINT(a) (((EMACS_INT) (a)) >> (GCTYPEBITS - 1))
# define XUINT(a) (((EMACS_UINT) (a)) >> (GCTYPEBITS - 1))
# define make_number(N) (((EMACS_INT) (N)) << (GCTYPEBITS - 1))
#else
# define XINT(a) (((EMACS_INT) (a)) >> GCTYPEBITS)
# define XUINT(a) (((EMACS_UINT) (a)) >> GCTYPEBITS)
# define make_number(N) (((EMACS_INT) (N)) << GCTYPEBITS)
#endif
Kenichi Handa's avatar
Kenichi Handa committed
397 398 399 400 401 402 403 404 405 406
#define XSET(var, type, ptr)					\
    (eassert (XTYPE (ptr) == 0), /* Check alignment.  */	\
     (var) = ((EMACS_INT) (type)) | ((EMACS_INT) (ptr)))

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

Karl Heuer's avatar
Karl Heuer committed
413 414
/* 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
415
   fact that Lisp_Int is 0.  */
416
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
417
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
418

419
/* Extract the value of a Lisp_Object as a (un)signed integer.  */
Jim Blandy's avatar
Jim Blandy committed
420

421 422 423 424 425 426
#ifdef USE_2_TAGS_FOR_INTS
# define XINT(a) ((((EMACS_INT) (a)) << (GCTYPEBITS - 1)) >> (GCTYPEBITS - 1))
# define XUINT(a) ((EMACS_UINT) ((a) & (1 + (VALMASK << 1))))
# define make_number(N) ((((EMACS_INT) (N)) & (1 + (VALMASK << 1))))
#else
# define XINT(a) ((((EMACS_INT) (a)) << (BITS_PER_EMACS_INT - VALBITS))	\
Kenichi Handa's avatar
Kenichi Handa committed
427
		 >> (BITS_PER_EMACS_INT - VALBITS))
428 429 430
# define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
# define make_number(N)		\
  ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)
Jim Blandy's avatar
Jim Blandy committed
431 432 433
#endif

#define XSET(var, type, ptr) \
434
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
435

436
#define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
437

Kenichi Handa's avatar
Kenichi Handa committed
438
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
439

Eli Zaretskii's avatar
Eli Zaretskii committed
440
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
441

442 443 444 445
#ifdef USE_2_TAGS_FOR_INTS
# error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
#endif

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

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

#ifdef EXPLICIT_SIGN_EXTEND
451 452 453 454 455
/* Make sure we sign-extend; compilers have been known to fail to do so.
   We additionally cast to EMACS_INT since it seems that some compilers
   have been known to fail to do so, even though the bitfield is declared
   as EMACS_INT already.  */
#define XINT(a) ((((EMACS_INT) (a).s.val) << (BITS_PER_EMACS_INT - VALBITS)) \
456
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

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

463 464 465 466 467 468 469
#ifdef USE_LSB_TAG

# define XSET(var, vartype, ptr) \
  (eassert ((((EMACS_UINT) (ptr)) & ((1 << GCTYPEBITS) - 1)) == 0),	\
   (var).u.val = ((EMACS_UINT) (ptr)) >> GCTYPEBITS,			\
   (var).u.type = ((char) (vartype)))

470 471 472 473
/* 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(v) ((EMACS_INT)((v).s.val) << GCTYPEBITS)
474 475 476 477 478 479 480 481 482 483

#else  /* !USE_LSB_TAG */

/* 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.  */
# define XFASTINT(a) ((a).i + 0)
# define XSETFASTINT(a, b) ((a).i = (b))

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

486 487
#endif	/* !USE_LSB_TAG */

488 489 490 491
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
Jan D's avatar
Jan D committed
492
extern Lisp_Object make_number (EMACS_INT);
493
#endif
494

Eli Zaretskii's avatar
Eli Zaretskii committed
495
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
496

497 498 499 500 501 502 503 504
/* For integers known to be positive, XFASTINT sometimes provides
   faster retrieval and XSETFASTINT provides faster storage.
   If not, fallback on the non-accelerated path.  */
#ifndef XFASTINT
# define XFASTINT(a) (XINT (a))
# define XSETFASTINT(a, b) (XSETINT (a, b))
#endif

505 506
#define EQ(x, y) (XHASH (x) == XHASH (y))

507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
#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
522 523 524 525 526
/* 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))
527 528 529 530
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

Gerd Moellmann's avatar
Gerd Moellmann committed
531 532
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
533

534 535 536
#ifdef USE_2_TAGS_FOR_INTS
# define MOST_NEGATIVE_FIXNUM	- ((EMACS_INT) 1 << VALBITS)
# define MOST_POSITIVE_FIXNUM	(((EMACS_INT) 1 << VALBITS) - 1)
Kenichi Handa's avatar
Kenichi Handa committed
537 538
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
539 540 541 542 543 544 545 546
# define INTMASK ((((EMACS_INT) 1) << (VALBITS + 1)) - 1)
#else
# define MOST_NEGATIVE_FIXNUM	- ((EMACS_INT) 1 << (VALBITS - 1))
# define MOST_POSITIVE_FIXNUM	(((EMACS_INT) 1 << (VALBITS - 1)) - 1)
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
# define INTMASK ((((EMACS_INT) 1) << VALBITS) - 1)
#endif
547

548 549 550
/* Value is non-zero if I doesn't fit into a Lisp fixnum.  It is
   written this way so that it also works if I is of unsigned
   type.  */
551 552

#define FIXNUM_OVERFLOW_P(i) \
553
  ((i) > MOST_POSITIVE_FIXNUM \
554
   || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
555

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

558 559 560 561 562
#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))
563 564

/* Misc types.  */
565

566
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
567
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
568
#define XMISCTYPE(a)   (XMISCANY (a)->type)
569 570 571
#define XMARKER(a)	(eassert (MARKERP (a)), &(XMISC(a)->u_marker))
#define XOVERLAY(a)	(eassert (OVERLAYP (a)), &(XMISC(a)->u_overlay))
#define XSAVE_VALUE(a)	(eassert (SAVE_VALUEP (a)), &(XMISC(a)->u_save_value))
572 573 574 575 576 577 578

/* Forwarding object types.  */

#define XFWDTYPE(a)     (a->u_intfwd.type)
#define XINTFWD(a)	(eassert (INTFWDP (a)), &((a)->u_intfwd))
#define XBOOLFWD(a)	(eassert (BOOLFWDP (a)), &((a)->u_boolfwd))
#define XOBJFWD(a)	(eassert (OBJFWDP (a)), &((a)->u_objfwd))
579
#define XBUFFER_OBJFWD(a) \
580
  (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
581
#define XKBOARD_OBJFWD(a) \
582
  (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
583

584
/* Pseudovector types.  */
585

586 587
#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
588
#define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
589 590
#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
591 592 593
#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))
594 595

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

597
#define XSETINT(a, b) (a) = make_number (b)
598
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
599
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
600 601 602
#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)
603 604

/* Misc types.  */
605

606
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
607
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
608 609

/* Pseudovector types.  */
610

611
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
612
#define XSETPSEUDOVECTOR(a, b, code) \
613 614 615
  (XSETVECTOR (a, b),							\
   eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))	\
	    == (PSEUDOVECTOR_FLAG | (code))))
616 617 618 619
#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))
620
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
621 622
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
623
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
624 625
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
626
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
627 628 629

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

630
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
631
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size
632
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
633 634 635
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
636
   AREF ((ARRAY), (IDX)) = (VAL))
637

638 639
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
640
#define SDATA(string)		(XSTRING (string)->data + 0)
641 642
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
643 644 645 646 647
#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))
648

Ken Raeburn's avatar
Ken Raeburn committed
649
#define STRING_COPYIN(string, index, new, count) \
650
    bcopy (new, SDATA (string) + index, count)
Ken Raeburn's avatar
Ken Raeburn committed
651

652 653 654 655 656 657
/* 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
658

659
/* See the macros in intervals.h.  */
660 661 662 663

typedef struct interval *INTERVAL;

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

667

Jim Blandy's avatar
Jim Blandy committed
668 669 670 671
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
672 673 674
    /* 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
675 676 677 678 679 680
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
681
#else
682 683 684 685 686 687
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
688
#endif
Jim Blandy's avatar
Jim Blandy committed
689 690
  };

691
/* Take the car or cdr of something known to be a cons cell.  */
692 693 694 695 696 697
/* 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.)  */
698
#ifdef HIDE_LISP_IMPLEMENTATION
699
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
700
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
701
#else
702
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
703
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
704
#endif
705

706 707 708 709 710 711 712 713 714 715 716 717 718
/* 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))

719 720 721 722
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
723
  : wrong_type_argument (Qlistp, (c)))
724 725 726 727

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

730 731 732 733 734 735 736
/* 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
737 738 739 740 741
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
742 743 744 745

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
Jan D's avatar
Jan D committed
746
extern int string_bytes (struct Lisp_String *);
747 748 749 750
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
751 752 753
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

754 755
#endif /* not GC_CHECK_STRING_BYTES */

756
/* Mark STR as a unibyte string.  */
757 758 759 760
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
761

762 763 764 765 766 767 768
/* 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)

769
/* Get text properties.  */
770 771 772 773
#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
774

Jim Blandy's avatar
Jim Blandy committed
775 776 777 778
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
779
    EMACS_INT size;
780
    EMACS_INT size_byte;
781
    INTERVAL intervals;		/* text properties in this string */
782
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
783 784
  };

785 786 787 788 789 790
#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
791

Jim Blandy's avatar
Jim Blandy committed
792 793
struct Lisp_Vector
  {
Stefan Monnier's avatar
Stefan Monnier committed
794
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
799
/* If a struct is made to look like a vector, this macro returns the length
800
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
801 802 803
#define VECSIZE(type) ((sizeof (type)					  \
			- OFFSETOF (struct Lisp_Vector, contents[0])      \
                        + sizeof(Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
804 805
		       / sizeof (Lisp_Object))

806 807 808 809
/* 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) \
810
  ((OFFSETOF(type, nonlispfield) - OFFSETOF(struct Lisp_Vector, contents[0])) \
811 812
   / sizeof (Lisp_Object))

813
/* A char-table is a kind of vectorlike, with contents are like a
814
   vector but with a few other slots.  For some purposes, it makes
815
   sense to handle a char-table with type struct Lisp_Vector.  An
816 817
   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
818 819 820 821
   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.  */
822

823 824 825
/* 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.  */
826
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
827 828 829 830 831 832

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

833 834 835 836 837 838 839 840 841 842 843 844 845
#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; })
846

847 848 849 850 851 852 853 854 855 856 857 858 859
#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__ */

860
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
861
   characters.  Do not check validity of CT.  */
862 863
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
864
   : char_table_ref ((CT), (IDX)))
865

Kenichi Handa's avatar
Kenichi Handa committed
866 867
/* Almost equivalent to Faref (CT, IDX).  However, if the result is
   not a character, return IDX.
868 869 870

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

874
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
875
   8-bit European characters.  Do not check validity of CT.  */
876 877 878 879 880 881 882 883 884 885 886 887 888 889
#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;
890

891 892 893 894
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
895 896
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
Stefan Monnier's avatar
Stefan Monnier committed
897
    EMACS_UINT size;
898
    struct Lisp_Vector *next;
899

900 901 902
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
903

Kenichi Handa's avatar
Kenichi Handa committed
904 905 906
    /* 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.  */
907
    Lisp_Object parent;
908

Kenichi Handa's avatar
Kenichi Handa committed
909 910
    /* This is a symbol which says what kind of use this char-table is
       meant for.  */
911
    Lisp_Object purpose;
912

Kenichi Handa's avatar
Kenichi Handa committed
913 914 915
    /* 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;
916

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

Kenichi Handa's avatar
Kenichi Handa committed
919
    /* These hold additional data.  It is a vector.  */
920 921 922
    Lisp_Object extras[1];
  };

923
struct Lisp_Sub_Char_Table
Kenichi Handa's avatar
Kenichi Handa committed
924 925 926 927 928
  {
    /* 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;
929

Kenichi Handa's avatar
Kenichi Handa committed
930
    /* Depth of this sub char-table.  It should be 1, 2, or 3.  A sub
Juanma Barranquero's avatar
Juanma Barranquero committed
931
       char-table of depth 1 contains 16 elements, and each element
Kenichi Handa's avatar
Kenichi Handa committed
932 933 934 935 936
       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;
937

Kenichi Handa's avatar
Kenichi Handa committed
938 939
    /* Minimum character covered by the sub char-table.  */
    Lisp_Object min_char;
940

Kenichi Handa's avatar
Kenichi Handa committed
941 942
    Lisp_Object contents[1];
  };
943 944 945 946 947 948

/* 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
949
    EMACS_UINT vector_size;
950 951
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
Stefan Monnier's avatar
Stefan Monnier committed
952
    EMACS_UINT size;
953 954 955 956
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

957 958 959 960 961 962 963
/* 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.  */
964

Jim Blandy's avatar
Jim Blandy committed
965 966
struct Lisp_Subr
  {
Stefan Monnier's avatar
Stefan Monnier committed
967