lisp.h 130 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
#include <inttypes.h>
26
#include <limits.h>
27

28 29
#include <intprops.h>

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

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

40 41 42 43
/* Temporarily disable wider-than-pointer integers until they're tested more.
   Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
/* #undef WIDE_EMACS_INT */

44
/* These are default choices for the types to use.  */
45
#ifndef EMACS_INT
46
# if BITS_PER_LONG < BITS_PER_LONG_LONG && defined WIDE_EMACS_INT
47 48 49 50 51 52 53 54 55 56 57 58
#  define EMACS_INT long long
#  define BITS_PER_EMACS_INT BITS_PER_LONG_LONG
#  define pI "ll"
# elif BITS_PER_INT < BITS_PER_LONG
#  define EMACS_INT long
#  define BITS_PER_EMACS_INT BITS_PER_LONG
#  define pI "l"
# else
#  define EMACS_INT int
#  define BITS_PER_EMACS_INT BITS_PER_INT
#  define pI ""
# endif
59 60
#endif
#ifndef EMACS_UINT
61
# define EMACS_UINT unsigned EMACS_INT
62
#endif
63

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
/* printmax_t and uprintmax_t are types for printing large integers.
   These are the widest integers that are supported for printing.
   pMd etc. are conversions for printing them.
   On C99 hosts, there's no problem, as even the widest integers work.
   Fall back on EMACS_INT on pre-C99 hosts.  */
#ifdef PRIdMAX
typedef intmax_t printmax_t;
typedef uintmax_t uprintmax_t;
# define pMd PRIdMAX
# define pMu PRIuMAX
#else
typedef EMACS_INT printmax_t;
typedef EMACS_UINT uprintmax_t;
# define pMd pI"d"
# define pMu pI"u"
#endif

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
/* Use pD to format ptrdiff_t values, which suffice for indexes into
   buffers and strings.  Emacs never allocates objects larger than
   PTRDIFF_MAX bytes, as they cause problems with pointer subtraction.
   In C99, pD can always be "t"; configure it here for the sake of
   pre-C99 libraries such as glibc 2.0 and Solaris 8.  */
#if PTRDIFF_MAX == INT_MAX
# define pD ""
#elif PTRDIFF_MAX == LONG_MAX
# define pD "l"
#elif PTRDIFF_MAX == LLONG_MAX
# define pD "ll"
#else
# define pD "t"
#endif

96
/* Extra internal type checking?  */
97 98 99

#ifdef ENABLE_CHECKING

100 101
extern void die (const char *, const char *, int) NO_RETURN;

102 103 104 105 106 107 108 109 110 111 112 113 114 115
/* 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.  */

116 117
extern int suppress_checking EXTERNALLY_VISIBLE;

118
#define CHECK(check,msg) (((check) || suppress_checking		\
119
			   ? (void) 0				\
120
			   : die ((msg), __FILE__, __LINE__)),	\
121
			  0)
122
#else
123

124 125
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
126

127
#endif
128

129 130
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
131
#ifndef ENABLE_CHECKING
132
#define eassert(X) ((void) (0 && (X))) /* Check that X compiles.  */
133
#else /* ENABLE_CHECKING */
134
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
Juanma Barranquero's avatar
Juanma Barranquero committed
135
#define eassert(cond) CHECK (cond, "assertion failed: " #cond)
136
#else
Juanma Barranquero's avatar
Juanma Barranquero committed
137
#define eassert(cond) CHECK (cond, "assertion failed")
138
#endif
139
#endif /* ENABLE_CHECKING */
140

141 142 143
/* 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
144

145 146
/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Eli Zaretskii's avatar
Eli Zaretskii committed
147 148
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
   - 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
165
   TYPEBITS-aligned.  */
166 167 168 169 170

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

171 172
#ifndef NO_DECL_ALIGN
# ifndef DECL_ALIGN
173
#  if HAVE_ATTRIBUTE_ALIGNED
174 175
#   define DECL_ALIGN(type, var) \
     type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
176
#  elif defined(_MSC_VER)
177 178 179 180
#   define ALIGN_GCTYPEBITS 8
#   if (1 << GCTYPEBITS) != ALIGN_GCTYPEBITS
#    error ALIGN_GCTYPEBITS is wrong!
#   endif
181
#   define DECL_ALIGN(type, var) \
182
     type __declspec(align(ALIGN_GCTYPEBITS)) var
183 184
#  else
     /* What directives do other compilers use?  */
185 186 187 188 189
#  endif
# endif
#endif

/* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8.  */
190 191
#if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
     || defined DARWIN_OS || defined __sun)
192 193
/* We also need to be able to specify mult-of-8 alignment on static vars.  */
# if defined DECL_ALIGN
194
#  define USE_LSB_TAG
195 196 197 198 199 200 201 202 203 204 205
# 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

206

207
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
208

209 210 211 212 213 214 215 216 217 218
/* 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

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

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
#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

240 241 242 243 244 245 246 247 248
/* Stolen from GDB.  The only known compiler that doesn't support
   enums in bitfields is MSVC.  */
#ifdef _MSC_VER
#define ENUM_BF(TYPE) unsigned int
#else
#define ENUM_BF(TYPE) enum TYPE
#endif


Jim Blandy's avatar
Jim Blandy committed
249 250
enum Lisp_Type
  {
251
    /* Integer.  XINT (obj) is the integer value.  */
252 253 254 255 256 257
#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
258

259
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
260
    Lisp_Symbol = 2,
Jim Blandy's avatar
Jim Blandy committed
261

262 263
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
264
    Lisp_Misc = 3,
Jim Blandy's avatar
Jim Blandy committed
265 266

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

270
    /* Vector of Lisp objects, or something resembling it.
271
       XVECTOR (object) points to a struct Lisp_Vector, which contains
272 273
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
274
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
275

276
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
277
    Lisp_Cons = 6,
278

279
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
280 281
  };

282
/* This is the set of data types that share a common structure.
283 284 285 286
   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
287 288
enum Lisp_Misc_Type
  {
289
    Lisp_Misc_Free = 0x5eab,
290
    Lisp_Misc_Marker,
291
    Lisp_Misc_Overlay,
292
    Lisp_Misc_Save_Value,
293 294 295 296 297
    /* 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
298 299
  };

300 301 302 303 304 305 306 307 308 309 310 311
/* 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.  */
  };

312 313
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
Kenichi Handa's avatar
Kenichi Handa committed
314
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
315 316
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
317
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
318

319
#ifndef WORDS_BIGENDIAN
Jim Blandy's avatar
Jim Blandy committed
320 321 322 323 324 325 326

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
327
       also, positive integers can be accessed fast this way.  */
328
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
329 330 331

    struct
      {
Paul Eggert's avatar
Paul Eggert committed
332
	/* Use explicit signed, the signedness of a bit-field of type
Andreas Schwab's avatar
Andreas Schwab committed
333 334
	   int is implementation defined.  */
	signed EMACS_INT val  : VALBITS;
335
	ENUM_BF (Lisp_Type) type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
336 337 338
      } s;
    struct
      {
339
	EMACS_UINT val : VALBITS;
340
	ENUM_BF (Lisp_Type) type : GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
341 342 343 344
      } u;
  }
Lisp_Object;

345
#else /* If WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
351
       also, positive integers can be accessed fast this way.  */
352
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
353 354 355

    struct
      {
356
	ENUM_BF (Lisp_Type) type : GCTYPEBITS;
Paul Eggert's avatar
Paul Eggert committed
357
	/* Use explicit signed, the signedness of a bit-field of type
Andreas Schwab's avatar
Andreas Schwab committed
358 359
	   int is implementation defined.  */
	signed EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
360 361 362
      } s;
    struct
      {
363
	ENUM_BF (Lisp_Type) type : GCTYPEBITS;
364
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368
      } u;
  }
Lisp_Object;

369
#endif /* WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
370

371
#ifdef __GNUC__
Paul Eggert's avatar
Paul Eggert committed
372
static inline Lisp_Object
373 374 375 376 377
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
378 379 380 381
/* 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))
382 383
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
384
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
385

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

388
typedef EMACS_INT Lisp_Object;
389
#define LISP_MAKE_RVALUE(o) (0+(o))
Eli Zaretskii's avatar
Eli Zaretskii committed
390
#endif /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
391

392 393
/* 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.)  */
394

395
#define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
396

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

401
/* In a pseudovector, the size field actually contains a word with one
402
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
403
   indicate the actual type.
404 405 406 407
   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?  */
408 409 410 411 412 413 414 415 416
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,
417 418 419
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
420
  PVEC_HASH_TABLE = 0x40000,
421
  PVEC_TERMINAL = 0x80000,
Miles Bader's avatar
Miles Bader committed
422
  PVEC_SUB_CHAR_TABLE = 0x100000,
423 424 425
  PVEC_FONT = 0x200000,
  PVEC_OTHER = 0x400000,
  PVEC_TYPE_MASK = 0x7ffe00
426

Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429
#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.  */
430
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
431
#endif
432
};
433

434 435 436 437 438
/* 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.  */
439
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
440 441 442 443

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

Eli Zaretskii's avatar
Eli Zaretskii committed
449
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
450

451 452 453
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

Kenichi Handa's avatar
Kenichi Handa committed
454 455 456
#ifdef USE_LSB_TAG

#define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
457
#define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
458 459 460 461 462 463 464 465 466
#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
467
#define XSET(var, type, ptr)						\
468 469
    (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment.  */ \
     (var) = (type) | (intptr_t) (ptr))
Kenichi Handa's avatar
Kenichi Handa committed
470

471
#define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
Kenichi Handa's avatar
Kenichi Handa committed
472 473 474 475 476

#else  /* not USE_LSB_TAG */

#define VALMASK ((((EMACS_INT) 1) << VALBITS) - 1)

Jim Blandy's avatar
Jim Blandy committed
477 478
/* 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
479
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
480
 */
Kenichi Handa's avatar
Kenichi Handa committed
481
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
482

Karl Heuer's avatar
Karl Heuer committed
483 484
/* 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
485
   fact that Lisp_Int is 0.  */
486
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
487
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
488

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

491 492 493 494 495 496
#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
497
		 >> (BITS_PER_EMACS_INT - VALBITS))
498 499 500
# 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
501 502
#endif

503 504
#define XSET(var, type, ptr)				  \
   ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
505
	     + ((intptr_t) (ptr) & VALMASK)))
506

507 508 509
#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 */
510
#define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
511
#else
512
#define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
513
#endif
514

Kenichi Handa's avatar
Kenichi Handa committed
515
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
516

Eli Zaretskii's avatar
Eli Zaretskii committed
517
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
518

519 520 521 522
#ifdef USE_2_TAGS_FOR_INTS
# error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
#endif

523
#define XHASH(a) ((a).i)
Jim Blandy's avatar
Jim Blandy committed
524
#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
525 526
#define XINT(a) ((EMACS_INT) (a).s.val)
#define XUINT(a) ((EMACS_UINT) (a).u.val)
Jim Blandy's avatar
Jim Blandy committed
527

528 529 530
#ifdef USE_LSB_TAG

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

535 536 537
/* 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.  */
538
# define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
539 540 541 542 543 544 545 546 547 548

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

551 552 553
#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 */
554
#define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
555
#else
556
#define XPNTR(a) ((intptr_t) XUINT (a))
557 558
#endif

559 560
#endif	/* !USE_LSB_TAG */

561 562 563 564
#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
565
extern Lisp_Object make_number (EMACS_INT);
566
#endif
567

Eli Zaretskii's avatar
Eli Zaretskii committed
568
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
569

570 571 572 573 574 575 576 577
/* 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

578 579
#define EQ(x, y) (XHASH (x) == XHASH (y))

580
/* Number of bits in a fixnum, including the sign bit.  */
581
#ifdef USE_2_TAGS_FOR_INTS
582
# define FIXNUM_BITS (VALBITS + 1)
583
#else
584
# define FIXNUM_BITS VALBITS
585
#endif
586

587 588 589 590 591 592 593 594
/* Mask indicating the significant bits of a fixnum.  */
#define INTMASK (((EMACS_INT) 1 << FIXNUM_BITS) - 1)

/* Largest and smallest representable fixnum values.  These are the C
   values.  */
#define MOST_POSITIVE_FIXNUM (INTMASK / 2)
#define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)

595 596
/* 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
597
   type or if I is a NaN.  */
598 599

#define FIXNUM_OVERFLOW_P(i) \
600
  (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
601

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

Juanma Barranquero's avatar
Juanma Barranquero committed
604 605 606 607 608
#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))
609 610

/* Misc types.  */
611

Juanma Barranquero's avatar
Juanma Barranquero committed
612 613
#define XMISC(a)   ((union Lisp_Misc *) XPNTR (a))
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC (a)->u_any))
614
#define XMISCTYPE(a)   (XMISCANY (a)->type)
Juanma Barranquero's avatar
Juanma Barranquero committed
615 616 617
#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))
618 619 620 621 622 623 624

/* 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))
625
#define XBUFFER_OBJFWD(a) \
626
  (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
627
#define XKBOARD_OBJFWD(a) \
628
  (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
629

630
/* Pseudovector types.  */
631

Juanma Barranquero's avatar
Juanma Barranquero committed
632 633 634 635 636 637 638 639
#define XPROCESS(a) (eassert (PROCESSP (a)), (struct Lisp_Process *) XPNTR (a))
#define XWINDOW(a) (eassert (WINDOWP (a)), (struct window *) XPNTR (a))
#define XTERMINAL(a) (eassert (TERMINALP (a)), (struct terminal *) XPNTR (a))
#define XSUBR(a) (eassert (SUBRP (a)), (struct Lisp_Subr *) XPNTR (a))
#define XBUFFER(a) (eassert (BUFFERP (a)), (struct buffer *) XPNTR (a))
#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))
640 641

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

643
#define XSETINT(a, b) (a) = make_number (b)
644
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
645
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
646 647 648
#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)
649 650

/* Misc types.  */
651

652
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
653
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
654 655

/* Pseudovector types.  */
656

Juanma Barranquero's avatar
Juanma Barranquero committed
657
#define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
658 659 660 661
#define XSETTYPED_PVECTYPE(v, size_member, code) \
  ((v)->size_member |= PSEUDOVECTOR_FLAG | (code))
#define XSETPVECTYPESIZE(v, code, sizeval) \
  ((v)->header.size = PSEUDOVECTOR_FLAG | (code) | (sizeval))
662 663

/* The cast to struct vectorlike_header * avoids aliasing issues.  */
664
#define XSETPSEUDOVECTOR(a, b, code) \
665 666 667
  XSETTYPED_PSEUDOVECTOR(a, b,       \
			 ((struct vectorlike_header *) XPNTR (a))->size, \
			 code)
668
#define XSETTYPED_PSEUDOVECTOR(a, b, size, code)			\
669
  (XSETVECTOR (a, b),							\
670
   eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))		\
671
	    == (PSEUDOVECTOR_FLAG | (code))))
672

673 674 675 676
#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))
677
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
678
/* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header.  */
679 680
#define XSETSUBR(a, b) \
  XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
681
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
682
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
683 684
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
685
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
686 687 688

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

689
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
690
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->header.size
691
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
692 693 694
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
695
   AREF ((ARRAY), (IDX)) = (VAL))
696

697 698
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
699
#define SDATA(string)		(XSTRING (string)->data + 0)
700 701
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
702 703 704
#define SCHARS(string)		(XSTRING (string)->size + 0)
#define SBYTES(string)		(STRING_BYTES (XSTRING (string)) + 0)

705 706 707
/* Avoid "differ in sign" warnings.  */
#define SSDATA(x)  ((char *) SDATA (x))

708 709
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
710

Ken Raeburn's avatar
Ken Raeburn committed
711
#define STRING_COPYIN(string, index, new, count) \
712
    memcpy (SDATA (string) + index, new, count)
Ken Raeburn's avatar
Ken Raeburn committed
713

714 715 716 717 718 719
/* 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
720

721
/* See the macros in intervals.h.  */
722 723 724 725

typedef struct interval *INTERVAL;

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

729

Jim Blandy's avatar
Jim Blandy committed
730 731 732 733
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
734 735 736
    /* 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
737 738 739 740 741 742
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
743
#else
744 745 746 747 748 749
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
750
#endif
Jim Blandy's avatar
Jim Blandy committed
751 752
  };

753
/* Take the car or cdr of something known to be a cons cell.  */
754 755 756 757 758 759
/* 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.)  */
760
#ifdef HIDE_LISP_IMPLEMENTATION
761
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
762
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
763
#else
764
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
765
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
766
#endif
767

768
/* Use these from normal code.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
769 770
#define XCAR(c)	LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
#define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
771 772 773 774 775 776 777

/* 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.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
778 779
#define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
#define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
780

781 782 783 784
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
785
  : wrong_type_argument (Qlistp, (c)))
786 787 788 789

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

792 793 794 795 796 797 798
/* 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
799 800 801 802 803
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
804 805 806 807

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
808
extern EMACS_INT string_bytes (struct Lisp_String *);
809 810 811 812
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
813 814 815
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

816 817
#endif /* not GC_CHECK_STRING_BYTES */

818 819 820 821 822 823 824 825 826 827 828 829 830
/* An upper bound on the number of bytes in a Lisp string, not
   counting the terminating null.  This a tight enough bound to
   prevent integer overflow errors that would otherwise occur during
   string size calculations.  A string cannot contain more bytes than
   a fixnum can represent, nor can it be so long that C pointer
   arithmetic stops working on the string plus its terminating null.
   Although the actual size limit (see STRING_BYTES_MAX in alloc.c)
   may be a bit smaller than STRING_BYTES_BOUND, calculating it here
   would expose alloc.c internal details that we'd rather keep
   private.  The cast to ptrdiff_t ensures that STRING_BYTES_BOUND is
   signed.  */
#define STRING_BYTES_BOUND  \
  min (MOST_POSITIVE_FIXNUM, (ptrdiff_t) min (SIZE_MAX, PTRDIFF_MAX) - 1)
831

832
/* Mark STR as a unibyte string.  */
833 834 835 836
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
837

838 839 840 841 842 843 844
/* 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)

845
/* Get text properties.  */
846 847 848 849
#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
850

Jim Blandy's avatar
Jim Blandy committed
851 852 853 854
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
855
    EMACS_INT size;
856
    EMACS_INT size_byte;
857
    INTERVAL intervals;		/* text properties in this string */
858
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
859 860
  };

861 862 863 864 865 866 867
/* Header of vector-like objects.  This documents the layout constraints on
   vectors and pseudovectors other than struct Lisp_Subr.  It also prevents
   compilers from being fooled by Emacs's type punning: the XSETPSEUDOVECTOR
   and PSEUDOVECTORP macros cast their pointers to struct vectorlike_header *,
   because when two such pointers potentially alias, a compiler won't
   incorrectly reorder loads and stores to their size fields.  See
   <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8546>.  */
868
struct vectorlike_header
Jim Blandy's avatar
Jim Blandy committed
869
  {
870
    EMACS_INT size;
871 872 873 874 875

    /* Pointer to the next vector-like object.  It is generally a buffer or a
       Lisp_Vector alias, so for convenience it is a union instead of a
       pointer: this way, one can write P->next.vector instead of ((struct
       Lisp_Vector *) P->next).  */
876 877 878 879 880 881 882 883
    union {
      struct buffer *buffer;
      struct Lisp_Vector *vector;
    } next;
  };

struct Lisp_Vector
  {
884
    struct vectorlike_header header;
Jim Blandy's avatar
Jim Blandy committed
885 886 887
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
888
/* If a struct is made to look like a vector, this macro returns the length
889
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
890
#define VECSIZE(type) ((sizeof (type)					  \
891
			- offsetof (struct Lisp_Vector, contents[0])      \
Juanma Barranquero's avatar
Juanma Barranquero committed
892
                        + sizeof (Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
893 894
		       / sizeof (Lisp_Object))

895 896 897 898
/* 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) \
Juanma Barranquero's avatar
Juanma Barranquero committed
899
  ((offsetof (type, nonlispfield) - offsetof (struct Lisp_Vector, contents[0])) \
900 901
   / sizeof (Lisp_Object))

902
/* A char-table is a kind of vectorlike, with contents are like a
903
   vector but with a few other slots.  For some purposes, it makes
904
   sense to handle a char-table with type struct Lisp_Vector.  An
905 906
   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
907 908 909 910
   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.  */
911

912 913 914
/* 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.  */
915
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
916 917 918 919

/* Return the number of "extra" slots in the char table CT.  */

#define CHAR_TABLE_EXTRA_SLOTS(CT)	\
920
  (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
921

922 923 924 925 926 927 928 929 930 931 932 933 934
#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; })
935

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

949 950
/* Compute A OP B, using the unsigned comparison operator OP.  A and B
   should be integer expressions.  This is not the same as
Paul Eggert's avatar
Paul Eggert committed
951
   mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
952 953 954 955 956 957 958
   returns 1.  For efficiency, prefer plain unsigned comparison if A
   and B's sizes both fit (after integer promotion).  */
#define UNSIGNED_CMP(a, op, b)						\
  (max (sizeof ((a) + 0), sizeof ((b) + 0)) <= sizeof (unsigned)	\
   ? ((a) + (unsigned) 0) op ((b) + (unsigned) 0)			\
   : ((a) + (uintmax_t) 0) op ((b) + (uintmax_t) 0))

959
/* Nonzero iff C is an ASCII character.  */
960
#define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
961

962
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
963
   characters.  Do not check validity of CT.  */
964 965
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
966
   : char_table_ref ((CT), (IDX)))
967

Kenichi Handa's avatar
Kenichi Handa committed
968 969
/* Almost equivalent to Faref (CT, IDX).  However, if the result is
   not a character, return IDX.
970 971 972

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

976
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
977
   8-bit European characters.  Do not check validity of CT.  */
978
#define CHAR_TABLE_SET(CT, IDX, VAL)					\
979
  (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)	\
980 981 982 983 984 985 986 987 988 989 990
   ? 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;
991

992 993
struct Lisp_Char_Table
  {
994
    /* HEADER.SIZE is the vector's size field, which also holds the
995
       pseudovector type information.  It holds the size, too.