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-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 pI "l"
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 pI ""
51 52 53 54
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
55
#endif
56

57
/* Extra internal type checking?  */
58 59 60

#ifdef ENABLE_CHECKING

61 62
extern void die (const char *, const char *, int) NO_RETURN;

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 78
extern int suppress_checking EXTERNALLY_VISIBLE;

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
#ifndef ENABLE_CHECKING
93
#define eassert(X) ((void) (0 && (X))) /* Check that X compiles.  */
94
#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

102 103 104
/* 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
105

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

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

155

156
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
157

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

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

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

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

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

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

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

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

219
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
220 221
  };

222
/* This is the set of data types that share a common structure.
223 224 225 226
   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
227 228
enum Lisp_Misc_Type
  {
229
    Lisp_Misc_Free = 0x5eab,
230
    Lisp_Misc_Marker,
231
    Lisp_Misc_Overlay,
232
    Lisp_Misc_Save_Value,
233 234 235 236 237
    /* Currently floats are not a misc type,
       but let's define this in case we want to change that.  */
    Lisp_Misc_Float,
    /* This is not a type code.  It is for range checking.  */
    Lisp_Misc_Limit
Karl Heuer's avatar
Karl Heuer committed
238 239
  };

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

252 253 254 255
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

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

Eli Zaretskii's avatar
Eli Zaretskii committed
261
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
262

263
#ifndef WORDS_BIGENDIAN
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268 269 270

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

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

    struct
      {
Andreas Schwab's avatar
Andreas Schwab committed
276 277 278
	/* 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
279
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
280 281 282
      } s;
    struct
      {
283
	EMACS_UINT val : VALBITS;
Kenichi Handa's avatar
Kenichi Handa committed
284
	enum Lisp_Type type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288
      } u;
  }
Lisp_Object;

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

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

    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
300
	enum Lisp_Type type : GCTYPEBITS;
Andreas Schwab's avatar
Andreas Schwab committed
301 302 303
	/* 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
304 305 306
      } s;
    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
307
	enum Lisp_Type type : GCTYPEBITS;
308
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312
      } u;
  }
Lisp_Object;

313
#endif /* WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
314

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

Eli Zaretskii's avatar
Eli Zaretskii committed
328
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
329

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

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

336 337
/* 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.)  */
338

339
#define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
340

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

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

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

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

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

Eli Zaretskii's avatar
Eli Zaretskii committed
393
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
394

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

Kenichi Handa's avatar
Kenichi Handa committed
398 399 400 401
#ifdef USE_LSB_TAG

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

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

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

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

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

451 452 453 454 455
#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
456
#define XPNTR(a) ((EMACS_UINT) ((a) & VALMASK))
457
#endif
458

Kenichi Handa's avatar
Kenichi Handa committed
459
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
460

Eli Zaretskii's avatar
Eli Zaretskii committed
461
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
462

463 464 465 466
#ifdef USE_2_TAGS_FOR_INTS
# error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
#endif

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

472 473 474 475 476 477 478
#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)))

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

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

495 496 497 498 499 500 501 502
#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

503 504
#endif	/* !USE_LSB_TAG */

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

Eli Zaretskii's avatar
Eli Zaretskii committed
512
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
513

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

522 523
#define EQ(x, y) (XHASH (x) == XHASH (y))

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

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

541 542 543
/* 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.  */
544 545

#define FIXNUM_OVERFLOW_P(i) \
546
  ((i) > MOST_POSITIVE_FIXNUM \
547
   || ((i) < 0 && (i) < MOST_NEGATIVE_FIXNUM))
548

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

551 552 553 554 555
#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))
556 557

/* Misc types.  */
558

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

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

577
/* Pseudovector types.  */
578

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

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

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

/* Misc types.  */
598

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

/* Pseudovector types.  */
603

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

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

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

631 632
/* Convenience macros for dealing with Lisp strings.  */

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

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

642 643
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
644

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

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

typedef struct interval *INTERVAL;

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

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

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

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

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

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

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

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

/* Return the length in bytes of STR.  */
738 739 740 741

#ifdef GC_CHECK_STRING_BYTES

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

#else /* not GC_CHECK_STRING_BYTES */

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

750 751
#endif /* not GC_CHECK_STRING_BYTES */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/* 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
941
    EMACS_UINT vector_size;
Richard M. Stallman's avatar