lisp.h 127 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985-1987, 1993-1995, 1997-2011
Glenn Morris's avatar
Glenn Morris committed
3
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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

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

23
#include <stdarg.h>
24
#include <stddef.h>
25

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

29
#ifdef GC_CHECK_CONS_LIST
30 31
extern void check_cons_list (void);
#define CHECK_CONS_LIST() check_cons_list ()
32
#else
33
#define CHECK_CONS_LIST() ((void) 0)
34
#endif
Jim Blandy's avatar
Jim Blandy committed
35

36
/* These are default choices for the types to use.  */
37 38 39 40
#ifdef _LP64
#ifndef EMACS_INT
#define EMACS_INT long
#define BITS_PER_EMACS_INT BITS_PER_LONG
41
#define pEd "ld"
42 43 44 45 46
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned long
#endif
#else /* not _LP64 */
47 48
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
49
#define BITS_PER_EMACS_INT BITS_PER_INT
50
#define pEd "d"
51 52 53 54
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
55
#endif
56

57 58
/* Extra internal type checking?  */
extern int suppress_checking;
Jan D's avatar
Jan D committed
59
extern void die (const char *, const char *, int) NO_RETURN;
60 61 62

#ifdef ENABLE_CHECKING

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

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

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

86
#endif
87

88 89
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
90
#ifndef ENABLE_CHECKING
91
#define eassert(X) ((void) (0 && (X))) /* Check that X compiles.  */
92
#else /* ENABLE_CHECKING */
93 94 95 96 97
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
98
#endif /* ENABLE_CHECKING */
99

100 101 102
/* 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
103

104 105
/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Eli Zaretskii's avatar
Eli Zaretskii committed
106 107
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
   - 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
127
#  if HAVE_ATTRIBUTE_ALIGNED
128 129
#   define DECL_ALIGN(type, var) \
     type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
130 131
#  else
     /* What directives do other compilers use?  */
132 133 134 135 136
#  endif
# endif
#endif

/* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8.  */
137 138
#if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
     || defined DARWIN_OS || defined __sun)
139 140
/* We also need to be able to specify mult-of-8 alignment on static vars.  */
# if defined DECL_ALIGN
141
#  define USE_LSB_TAG
142 143 144 145 146 147 148 149 150 151 152
# 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

153

154
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
155

156 157 158 159 160 161 162 163 164 165
/* 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

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

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
#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
187 188
enum Lisp_Type
  {
189
    /* Integer.  XINT (obj) is the integer value.  */
190 191 192 193 194 195
#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
196

197
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
198
    Lisp_Symbol = 2,
Jim Blandy's avatar
Jim Blandy committed
199

200 201
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
202
    Lisp_Misc = 3,
Jim Blandy's avatar
Jim Blandy committed
203 204

    /* String.  XSTRING (object) points to a struct Lisp_String.
205
       The length of the string, and its contents, are stored therein.  */
206
    Lisp_String = LISP_STRING_TAG,
Jim Blandy's avatar
Jim Blandy committed
207

208
    /* Vector of Lisp objects, or something resembling it.
209
       XVECTOR (object) points to a struct Lisp_Vector, which contains
210 211
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
212
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
213

214
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
215
    Lisp_Cons = 6,
216

217
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
218 219
  };

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

238 239 240 241 242 243 244 245 246 247 248 249
/* 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.  */
  };

250 251 252 253
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

254 255
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
Kenichi Handa's avatar
Kenichi Handa committed
256
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
257 258
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
259
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
260

261
#ifndef WORDS_BIGENDIAN
Jim Blandy's avatar
Jim Blandy committed
262 263 264 265 266 267 268

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

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

    struct
      {
Andreas Schwab's avatar
Andreas Schwab committed
274 275 276
	/* Use explict signed, the signedness of a bit-field of type
	   int is implementation defined.  */
	signed EMACS_INT val  : VALBITS;
Kenichi Handa's avatar
Kenichi Handa committed
277
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
278 279 280
      } s;
    struct
      {
281
	EMACS_UINT val : VALBITS;
Kenichi Handa's avatar
Kenichi Handa committed
282
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286
      } u;
  }
Lisp_Object;

287
#else /* If WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291 292

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
293
       also, positive integers can be accessed fast this way.  */
294
    EMACS_UINT i;
Jim Blandy's avatar
Jim Blandy committed
295 296 297

    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
298
	enum Lisp_Type type : GCTYPEBITS;
Andreas Schwab's avatar
Andreas Schwab committed
299 300 301
	/* Use explict signed, the signedness of a bit-field of type
	   int is implementation defined.  */
	signed EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
302 303 304
      } s;
    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
305
	enum Lisp_Type type : GCTYPEBITS;
306
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
307 308 309 310
      } u;
  }
Lisp_Object;

311
#endif /* WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
312

313 314 315 316 317 318 319
#ifdef __GNUC__
static __inline__ Lisp_Object
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
320 321 322 323
/* 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))
324 325
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
326
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
327

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

330
typedef EMACS_INT Lisp_Object;
331
#define LISP_MAKE_RVALUE(o) (0+(o))
Eli Zaretskii's avatar
Eli Zaretskii committed
332
#endif /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
333

334 335
/* In the size word of a vector, this bit means the vector has been marked.
   (Shift -1 left, not 1, to avoid provoking overflow diagnostics.)  */
336

337
#define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
338

339 340
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
341
#define PSEUDOVECTOR_FLAG ((EMACS_INT) 1 << (BITS_PER_EMACS_INT - 2))
342

343
/* In a pseudovector, the size field actually contains a word with one
344
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
345
   indicate the actual type.
346 347 348 349
   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?  */
350 351 352 353 354 355 356 357 358
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,
359 360 361
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
362
  PVEC_HASH_TABLE = 0x40000,
363
  PVEC_TERMINAL = 0x80000,
Miles Bader's avatar
Miles Bader committed
364
  PVEC_SUB_CHAR_TABLE = 0x100000,
365 366 367
  PVEC_FONT = 0x200000,
  PVEC_OTHER = 0x400000,
  PVEC_TYPE_MASK = 0x7ffe00
368

Gerd Moellmann's avatar
Gerd Moellmann committed
369 370 371
#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.  */
372
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
373
#endif
374
};
375

376 377 378 379 380
/* 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.  */
381
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
382 383 384 385

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

Eli Zaretskii's avatar
Eli Zaretskii committed
391
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
392

393 394 395
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

Kenichi Handa's avatar
Kenichi Handa committed
396 397 398 399
#ifdef USE_LSB_TAG

#define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) & TYPEMASK))
400 401 402 403 404 405 406 407 408
#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
409 410 411 412 413 414 415 416 417 418
#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
419 420
/* 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
421
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
422
 */
Kenichi Handa's avatar
Kenichi Handa committed
423
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
424

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

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

433 434 435 436 437 438
#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
439
		 >> (BITS_PER_EMACS_INT - VALBITS))
440 441 442
# 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
443 444
#endif

445 446 447
#define XSET(var, type, ptr)				  \
   ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
	     + ((EMACS_INT) (ptr) & VALMASK)))
448

449 450 451 452 453
#ifdef DATA_SEG_BITS
/* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
   which were stored in a Lisp_Object */
#define XPNTR(a) ((EMACS_UINT) (((a) & VALMASK) | DATA_SEG_BITS))
#else
454
#define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
455
#endif
456

Kenichi Handa's avatar
Kenichi Handa committed
457
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
458

Eli Zaretskii's avatar
Eli Zaretskii committed
459
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
460

461 462 463 464
#ifdef USE_2_TAGS_FOR_INTS
# error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
#endif

465
#define XHASH(a) ((a).i)
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469
#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
#define XINT(a) ((a).s.val)
#define XUINT(a) ((a).u.val)

470 471 472 473 474 475 476
#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)))

477 478 479 480
/* 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)
481 482 483 484 485 486 487 488 489 490

#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) \
491
   (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
Jim Blandy's avatar
Jim Blandy committed
492

493 494 495 496 497 498 499 500
#ifdef DATA_SEG_BITS
/* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
   which were stored in a Lisp_Object */
#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
#else
#define XPNTR(a) ((EMACS_INT) XUINT (a))
#endif

501 502
#endif	/* !USE_LSB_TAG */

503 504 505 506
#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
507
extern Lisp_Object make_number (EMACS_INT);
508
#endif
509

Eli Zaretskii's avatar
Eli Zaretskii committed
510
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
511

512 513 514 515 516 517 518 519
/* 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

520 521
#define EQ(x, y) (XHASH (x) == XHASH (y))

Gerd Moellmann's avatar
Gerd Moellmann committed
522 523
/* Largest and smallest representable fixnum values.  These are the C
   values.  */
524

525 526 527
#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
528 529
/* Mask indicating the significant bits of a Lisp_Int.
   I.e. (x & INTMASK) == XUINT (make_number (x)).  */
530 531 532 533 534 535 536 537
# 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
538

539 540 541
/* 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.  */
542 543

#define FIXNUM_OVERFLOW_P(i) \
544
  ((i) > MOST_POSITIVE_FIXNUM \
545
   || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
546

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

549 550 551 552 553
#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))
554 555

/* Misc types.  */
556

557
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
558
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
559
#define XMISCTYPE(a)   (XMISCANY (a)->type)
560 561 562
#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))
563 564 565 566 567 568 569

/* 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))
570
#define XBUFFER_OBJFWD(a) \
571
  (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
572
#define XKBOARD_OBJFWD(a) \
573
  (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
574

575
/* Pseudovector types.  */
576

577 578
#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
579
#define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
580 581
#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
582 583 584
#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))
585 586

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

588
#define XSETINT(a, b) (a) = make_number (b)
589
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
590
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
591 592 593
#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)
594 595

/* Misc types.  */
596

597
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
598
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
599 600

/* Pseudovector types.  */
601

602
#define XSETPVECTYPE(v,code) ((v)->size |= PSEUDOVECTOR_FLAG | (code))
603
#define XSETPSEUDOVECTOR(a, b, code) \
604 605 606
  (XSETVECTOR (a, b),							\
   eassert ((XVECTOR (a)->size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))	\
	    == (PSEUDOVECTOR_FLAG | (code))))
607 608 609 610
#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))
611
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
612 613
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
614
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
615 616
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
617
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
618 619 620

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

621
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
622
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size
623
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
624 625 626
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
627
   AREF ((ARRAY), (IDX)) = (VAL))
628

629 630
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
631
#define SDATA(string)		(XSTRING (string)->data + 0)
632 633
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
634 635 636
#define SCHARS(string)		(XSTRING (string)->size + 0)
#define SBYTES(string)		(STRING_BYTES (XSTRING (string)) + 0)

637 638 639
/* Avoid "differ in sign" warnings.  */
#define SSDATA(x)  ((char *) SDATA (x))

640 641
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
642

Ken Raeburn's avatar
Ken Raeburn committed
643
#define STRING_COPYIN(string, index, new, count) \
644
    memcpy (SDATA (string) + index, new, count)
Ken Raeburn's avatar
Ken Raeburn committed
645

646 647 648 649 650 651
/* 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
652

653
/* See the macros in intervals.h.  */
654 655 656 657

typedef struct interval *INTERVAL;

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

661

Jim Blandy's avatar
Jim Blandy committed
662 663 664 665
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
666 667 668
    /* 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
669 670 671 672 673 674
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
675
#else
676 677 678 679 680 681
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
682
#endif
Jim Blandy's avatar
Jim Blandy committed
683 684
  };

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

700 701 702 703 704 705 706 707 708 709 710 711 712
/* 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))

713 714 715 716
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
717
  : wrong_type_argument (Qlistp, (c)))
718 719 720 721

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

724 725 726 727 728 729 730
/* 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
731 732 733 734 735
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
736 737 738 739

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
740
extern EMACS_INT string_bytes (struct Lisp_String *);
741 742 743 744
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
745 746 747
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

748 749
#endif /* not GC_CHECK_STRING_BYTES */

750
/* Mark STR as a unibyte string.  */
751 752 753 754
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
755

756 757 758 759 760 761 762
/* 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)

763
/* Get text properties.  */
764 765 766 767
#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
768

Jim Blandy's avatar
Jim Blandy committed
769 770 771 772
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
773
    EMACS_INT size;
774
    EMACS_INT size_byte;
775
    INTERVAL intervals;		/* text properties in this string */
776
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780
  };

struct Lisp_Vector
  {
Stefan Monnier's avatar
Stefan Monnier committed
781
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
782 783 784 785
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
786
/* If a struct is made to look like a vector, this macro returns the length
787
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
788
#define VECSIZE(type) ((sizeof (type)					  \
789
			- offsetof (struct Lisp_Vector, contents[0])      \
Andreas Schwab's avatar
Andreas Schwab committed
790
                        + sizeof(Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
791 792
		       / sizeof (Lisp_Object))

793 794 795 796
/* 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) \
797
  ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
798 799
   / sizeof (Lisp_Object))

800
/* A char-table is a kind of vectorlike, with contents are like a
801
   vector but with a few other slots.  For some purposes, it makes
802
   sense to handle a char-table with type struct Lisp_Vector.  An
803 804
   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
805 806 807 808
   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.  */
809

810 811 812
/* 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.  */
813
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
814 815 816 817 818 819

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

820 821 822 823 824 825 826 827 828 829 830 831 832
#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; })
833

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

847 848 849
/* Nonzero iff C is an ASCII character.  */
#define ASCII_CHAR_P(c) ((unsigned) (c) < 0x80)

850
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
851
   characters.  Do not check validity of CT.  */
852 853
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
854
   : char_table_ref ((CT), (IDX)))
855

Kenichi Handa's avatar
Kenichi Handa committed
856 857
/* Almost equivalent to Faref (CT, IDX).  However, if the result is
   not a character, return IDX.
858 859 860

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

864
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
865
   8-bit European characters.  Do not check validity of CT.  */
866 867 868 869 870 871 872 873 874 875 876 877 878 879
#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;
880

881 882 883 884
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
885 886
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
Stefan Monnier's avatar
Stefan Monnier committed
887
    EMACS_UINT size;
888
    struct Lisp_Vector *next;
889

890 891 892
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
893

Kenichi Handa's avatar
Kenichi Handa committed
894 895 896
    /* 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.  */
897
    Lisp_Object parent;
898

Kenichi Handa's avatar
Kenichi Handa committed
899 900
    /* This is a symbol which says what kind of use this char-table is
       meant for.  */
901
    Lisp_Object purpose;
902

Kenichi Handa's avatar
Kenichi Handa committed
903 904 905
    /* 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;
906

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

Kenichi Handa's avatar
Kenichi Handa committed
909
    /* These hold additional data.  It is a vector.  */
910 911 912
    Lisp_Object extras[1];
  };

913
struct Lisp_Sub_Char_Table
Kenichi Handa's avatar
Kenichi Handa committed
914 915 916 917 918
  {
    /* 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;
919

Kenichi Handa's avatar
Kenichi Handa committed
920
    /* Depth of this sub char-table.  It should be 1, 2, or 3.  A sub
Juanma Barranquero's avatar
Juanma Barranquero committed
921
       char-table of depth 1 contains 16 elements, and each element
Kenichi Handa's avatar
Kenichi Handa committed
922 923 924 925 926
       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;
927

Kenichi Handa's avatar
Kenichi Handa committed
928 929
    /* Minimum character covered by the sub char-table.  */
    Lisp_Object min_char;
930

Kenichi Handa's avatar
Kenichi Handa committed
931 932
    Lisp_Object contents[1];
  };
933 934 935 936 937 938

/* 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
939
    EMACS_UINT vector_size;
940 941
    struct Lisp_Vector *next;
    /* This is the size in bits.  */