lisp.h 129 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
/* 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

79
/* Extra internal type checking?  */
80 81 82

#ifdef ENABLE_CHECKING

83 84
extern void die (const char *, const char *, int) NO_RETURN;

85 86 87 88 89 90 91 92 93 94 95 96 97 98
/* 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.  */

99 100
extern int suppress_checking EXTERNALLY_VISIBLE;

101
#define CHECK(check,msg) (((check) || suppress_checking		\
102
			   ? (void) 0				\
103
			   : die ((msg), __FILE__, __LINE__)),	\
104
			  0)
105
#else
106

107 108
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
109

110
#endif
111

112 113
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
114
#ifndef ENABLE_CHECKING
115
#define eassert(X) ((void) (0 && (X))) /* Check that X compiles.  */
116
#else /* ENABLE_CHECKING */
117 118 119 120 121
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
122
#endif /* ENABLE_CHECKING */
123

124 125 126
/* 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
127

128 129
/***** Select the tagging scheme.  *****/
/* There are basically two options that control the tagging scheme:
Eli Zaretskii's avatar
Eli Zaretskii committed
130 131
   - USE_LISP_UNION_TYPE says that Lisp_Object should be a union instead
     of an integer.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
   - 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
151
#  if HAVE_ATTRIBUTE_ALIGNED
152 153
#   define DECL_ALIGN(type, var) \
     type __attribute__ ((__aligned__ (1 << GCTYPEBITS))) var
154 155
#  else
     /* What directives do other compilers use?  */
156 157 158 159 160
#  endif
# endif
#endif

/* Let's USE_LSB_TAG on systems where we know malloc returns mult-of-8.  */
161 162
#if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
     || defined DARWIN_OS || defined __sun)
163 164
/* We also need to be able to specify mult-of-8 alignment on static vars.  */
# if defined DECL_ALIGN
165
#  define USE_LSB_TAG
166 167 168 169 170 171 172 173 174 175 176
# 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

177

178
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
179

180 181 182 183 184 185 186 187 188 189
/* 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

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

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
#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
211 212
enum Lisp_Type
  {
213
    /* Integer.  XINT (obj) is the integer value.  */
214 215 216 217 218 219
#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
220

221
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
222
    Lisp_Symbol = 2,
Jim Blandy's avatar
Jim Blandy committed
223

224 225
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
226
    Lisp_Misc = 3,
Jim Blandy's avatar
Jim Blandy committed
227 228

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

232
    /* Vector of Lisp objects, or something resembling it.
233
       XVECTOR (object) points to a struct Lisp_Vector, which contains
234 235
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
236
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
237

238
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
239
    Lisp_Cons = 6,
240

241
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
242 243
  };

244
/* This is the set of data types that share a common structure.
245 246 247 248
   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
249 250
enum Lisp_Misc_Type
  {
251
    Lisp_Misc_Free = 0x5eab,
252
    Lisp_Misc_Marker,
253
    Lisp_Misc_Overlay,
254
    Lisp_Misc_Save_Value,
255 256 257 258 259
    /* 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
260 261
  };

262 263 264 265 266 267 268 269 270 271 272 273
/* 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.  */
  };

274 275 276 277
#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

278 279
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
Kenichi Handa's avatar
Kenichi Handa committed
280
#define VALBITS (BITS_PER_EMACS_INT - GCTYPEBITS)
281 282
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
283
#ifdef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
284

285
#ifndef WORDS_BIGENDIAN
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292

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

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

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

311
#else /* If WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
312 313 314 315 316

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
317
       also, positive integers can be accessed fast this way.  */
318
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
319 320 321

    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
322
	enum Lisp_Type type : GCTYPEBITS;
Andreas Schwab's avatar
Andreas Schwab committed
323 324 325
	/* 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
326 327 328
      } s;
    struct
      {
Kenichi Handa's avatar
Kenichi Handa committed
329
	enum Lisp_Type type : GCTYPEBITS;
330
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334
      } u;
  }
Lisp_Object;

335
#endif /* WORDS_BIGENDIAN */
Jim Blandy's avatar
Jim Blandy committed
336

337
#ifdef __GNUC__
Paul Eggert's avatar
Paul Eggert committed
338
static inline Lisp_Object
339 340 341 342 343
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
#else
344 345 346 347
/* 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))
348 349
#endif

Eli Zaretskii's avatar
Eli Zaretskii committed
350
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
351

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

354
typedef EMACS_INT Lisp_Object;
355
#define LISP_MAKE_RVALUE(o) (0+(o))
Eli Zaretskii's avatar
Eli Zaretskii committed
356
#endif /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
357

358 359
/* 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.)  */
360

361
#define ARRAY_MARK_FLAG ((EMACS_INT) -1 << (BITS_PER_EMACS_INT - 1))
362

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

367
/* In a pseudovector, the size field actually contains a word with one
368
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
369
   indicate the actual type.
370 371 372 373
   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?  */
374 375 376 377 378 379 380 381 382
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,
383 384 385
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
386
  PVEC_HASH_TABLE = 0x40000,
387
  PVEC_TERMINAL = 0x80000,
Miles Bader's avatar
Miles Bader committed
388
  PVEC_SUB_CHAR_TABLE = 0x100000,
389 390 391
  PVEC_FONT = 0x200000,
  PVEC_OTHER = 0x400000,
  PVEC_TYPE_MASK = 0x7ffe00
392

Gerd Moellmann's avatar
Gerd Moellmann committed
393 394 395
#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.  */
396
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
397
#endif
398
};
399

400 401 402 403 404
/* 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.  */
405
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
406 407 408 409

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

Eli Zaretskii's avatar
Eli Zaretskii committed
415
#ifndef USE_LISP_UNION_TYPE
Jim Blandy's avatar
Jim Blandy committed
416

417 418 419
/* Return a perfect hash of the Lisp_Object representation.  */
#define XHASH(a) (a)

Kenichi Handa's avatar
Kenichi Handa committed
420 421 422
#ifdef USE_LSB_TAG

#define TYPEMASK ((((EMACS_INT) 1) << GCTYPEBITS) - 1)
423
#define XTYPE(a) ((enum Lisp_Type) ((a) & TYPEMASK))
424 425 426 427 428 429 430 431 432
#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
433
#define XSET(var, type, ptr)						\
434 435
    (eassert (XTYPE ((intptr_t) (ptr)) == 0), /* Check alignment.  */ \
     (var) = (type) | (intptr_t) (ptr))
Kenichi Handa's avatar
Kenichi Handa committed
436

437
#define XPNTR(a) ((intptr_t) ((a) & ~TYPEMASK))
Kenichi Handa's avatar
Kenichi Handa committed
438 439 440 441 442

#else  /* not USE_LSB_TAG */

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

Jim Blandy's avatar
Jim Blandy committed
443 444
/* 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
445
    on all machines, but would penalize machines which don't need it)
Jim Blandy's avatar
Jim Blandy committed
446
 */
Kenichi Handa's avatar
Kenichi Handa committed
447
#define XTYPE(a) ((enum Lisp_Type) (((EMACS_UINT) (a)) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
448

Karl Heuer's avatar
Karl Heuer committed
449 450
/* 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
451
   fact that Lisp_Int is 0.  */
452
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
453
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
454

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

457 458 459 460 461 462
#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
463
		 >> (BITS_PER_EMACS_INT - VALBITS))
464 465 466
# 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
467 468
#endif

469 470
#define XSET(var, type, ptr)				  \
   ((var) = ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS) \
471
	     + ((intptr_t) (ptr) & VALMASK)))
472

473 474 475
#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 */
476
#define XPNTR(a) ((uintptr_t) (((a) & VALMASK)) | DATA_SEG_BITS))
477
#else
478
#define XPNTR(a) ((uintptr_t) ((a) & VALMASK))
479
#endif
480

Kenichi Handa's avatar
Kenichi Handa committed
481
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
482

Eli Zaretskii's avatar
Eli Zaretskii committed
483
#else /* USE_LISP_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
484

485 486 487 488
#ifdef USE_2_TAGS_FOR_INTS
# error "USE_2_TAGS_FOR_INTS is not supported with USE_LISP_UNION_TYPE"
#endif

489
#define XHASH(a) ((a).i)
Jim Blandy's avatar
Jim Blandy committed
490
#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
491 492
#define XINT(a) ((EMACS_INT) (a).s.val)
#define XUINT(a) ((EMACS_UINT) (a).u.val)
Jim Blandy's avatar
Jim Blandy committed
493

494 495 496
#ifdef USE_LSB_TAG

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

501 502 503
/* 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.  */
504
# define XPNTR(v) ((intptr_t) (v).s.val << GCTYPEBITS)
505 506 507 508 509 510 511 512 513 514

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

517 518 519
#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 */
520
#define XPNTR(a) ((intptr_t) (XUINT (a) | DATA_SEG_BITS))
521
#else
522
#define XPNTR(a) ((intptr_t) XUINT (a))
523 524
#endif

525 526
#endif	/* !USE_LSB_TAG */

527 528 529 530
#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
531
extern Lisp_Object make_number (EMACS_INT);
532
#endif
533

Eli Zaretskii's avatar
Eli Zaretskii committed
534
#endif /* USE_LISP_UNION_TYPE */
Kenichi Handa's avatar
Kenichi Handa committed
535

536 537 538 539 540 541 542 543
/* 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

544 545
#define EQ(x, y) (XHASH (x) == XHASH (y))

546
/* Number of bits in a fixnum, including the sign bit.  */
547
#ifdef USE_2_TAGS_FOR_INTS
548
# define FIXNUM_BITS (VALBITS + 1)
549
#else
550
# define FIXNUM_BITS VALBITS
551
#endif
552

553 554 555 556 557 558 559 560
/* 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)

561 562
/* 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
563
   type or if I is a NaN.  */
564 565

#define FIXNUM_OVERFLOW_P(i) \
566
  (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
567

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

570 571 572 573 574
#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))
575 576

/* Misc types.  */
577

578
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
579
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC(a)->u_any))
580
#define XMISCTYPE(a)   (XMISCANY (a)->type)
581 582 583
#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))
584 585 586 587 588 589 590

/* 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))
591
#define XBUFFER_OBJFWD(a) \
592
  (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
593
#define XKBOARD_OBJFWD(a) \
594
  (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
595

596
/* Pseudovector types.  */
597

598 599
#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
600
#define XTERMINAL(a) (eassert (TERMINALP(a)),(struct terminal *) XPNTR(a))
601 602
#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
603 604 605
#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))
606 607

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

609
#define XSETINT(a, b) (a) = make_number (b)
610
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
611
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
612 613 614
#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)
615 616

/* Misc types.  */
617

618
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
619
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
620 621

/* Pseudovector types.  */
622

623 624 625 626 627
#define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE(v, header.size, code)
#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))
628 629

/* The cast to struct vectorlike_header * avoids aliasing issues.  */
630
#define XSETPSEUDOVECTOR(a, b, code) \
631 632 633
  XSETTYPED_PSEUDOVECTOR(a, b,       \
			 ((struct vectorlike_header *) XPNTR (a))->size, \
			 code)
634
#define XSETTYPED_PSEUDOVECTOR(a, b, size, code)			\
635
  (XSETVECTOR (a, b),							\
636
   eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))		\
637
	    == (PSEUDOVECTOR_FLAG | (code))))
638

639 640 641 642
#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))
643
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
644
/* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header.  */
645 646
#define XSETSUBR(a, b) \
  XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
647
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
648
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
649 650
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
651
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
652 653 654

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

655
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
656
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->header.size
657
/* The IDX==IDX tries to detect when the macro argument is side-effecting.  */
Stefan Monnier's avatar
Stefan Monnier committed
658 659 660
#define ASET(ARRAY, IDX, VAL)	\
  (eassert ((IDX) == (IDX)),				\
   eassert ((IDX) >= 0 && (IDX) < ASIZE (ARRAY)),	\
661
   AREF ((ARRAY), (IDX)) = (VAL))
662

663 664
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
665
#define SDATA(string)		(XSTRING (string)->data + 0)
666 667
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
668 669 670
#define SCHARS(string)		(XSTRING (string)->size + 0)
#define SBYTES(string)		(STRING_BYTES (XSTRING (string)) + 0)

671 672 673
/* Avoid "differ in sign" warnings.  */
#define SSDATA(x)  ((char *) SDATA (x))

674 675
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
676

Ken Raeburn's avatar
Ken Raeburn committed
677
#define STRING_COPYIN(string, index, new, count) \
678
    memcpy (SDATA (string) + index, new, count)
Ken Raeburn's avatar
Ken Raeburn committed
679

680 681 682 683 684 685
/* 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
686

687
/* See the macros in intervals.h.  */
688 689 690 691

typedef struct interval *INTERVAL;

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

695

Jim Blandy's avatar
Jim Blandy committed
696 697 698 699
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
700 701 702
    /* 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
703 704 705 706 707 708
    Lisp_Object car_;
    union
    {
      Lisp_Object cdr_;
      struct Lisp_Cons *chain;
    } u;
709
#else
710 711 712 713 714 715
    Lisp_Object car;
    union
    {
      Lisp_Object cdr;
      struct Lisp_Cons *chain;
    } u;
716
#endif
Jim Blandy's avatar
Jim Blandy committed
717 718
  };

719
/* Take the car or cdr of something known to be a cons cell.  */
720 721 722 723 724 725
/* 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.)  */
726
#ifdef HIDE_LISP_IMPLEMENTATION
727
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car_)
728
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr_)
729
#else
730
#define XCAR_AS_LVALUE(c) (XCONS ((c))->car)
731
#define XCDR_AS_LVALUE(c) (XCONS ((c))->u.cdr)
732
#endif
733

734 735 736 737 738 739 740 741 742 743 744 745 746
/* 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))

747 748 749 750
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
751
  : wrong_type_argument (Qlistp, (c)))
752 753 754 755

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

758 759 760 761 762 763 764
/* 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
765 766 767 768 769
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
770 771 772 773

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
774
extern EMACS_INT string_bytes (struct Lisp_String *);
775 776 777 778
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
779 780 781
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

782 783
#endif /* not GC_CHECK_STRING_BYTES */

784 785 786 787 788 789 790 791 792 793 794 795 796
/* 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)
797

798
/* Mark STR as a unibyte string.  */
799 800 801 802
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
803

804 805 806 807 808 809 810
/* 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)

811
/* Get text properties.  */
812 813 814 815
#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
816

Jim Blandy's avatar
Jim Blandy committed
817 818 819 820
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
821
    EMACS_INT size;
822
    EMACS_INT size_byte;
823
    INTERVAL intervals;		/* text properties in this string */
824
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
825 826
  };

827 828 829 830 831 832 833
/* 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>.  */
834
struct vectorlike_header
Jim Blandy's avatar
Jim Blandy committed
835
  {
836
    EMACS_INT size;
837 838 839 840 841

    /* 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).  */
842 843 844 845 846 847 848 849
    union {
      struct buffer *buffer;
      struct Lisp_Vector *vector;
    } next;
  };

struct Lisp_Vector
  {
850
    struct vectorlike_header header;
Jim Blandy's avatar
Jim Blandy committed
851 852 853
    Lisp_Object contents[1];
  };

Karl Heuer's avatar
Karl Heuer committed
854
/* If a struct is made to look like a vector, this macro returns the length
855
   of the shortest vector that would hold that struct.  */
Andreas Schwab's avatar
Andreas Schwab committed
856
#define VECSIZE(type) ((sizeof (type)					  \
857
			- offsetof (struct Lisp_Vector, contents[0])      \
Andreas Schwab's avatar
Andreas Schwab committed
858
                        + sizeof(Lisp_Object) - 1) /* round up */	  \
Karl Heuer's avatar
Karl Heuer committed
859 860
		       / sizeof (Lisp_Object))

861 862 863 864
/* 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) \
865
  ((offsetof(type, nonlispfield) - offsetof(struct Lisp_Vector, contents[0])) \
866 867
   / sizeof (Lisp_Object))

868
/* A char-table is a kind of vectorlike, with contents are like a
869
   vector but with a few other slots.  For some purposes, it makes
870
   sense to handle a char-table with type struct Lisp_Vector.  An
871 872
   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
873 874 875 876
   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.  */
877

878 879 880
/* 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.  */
881
#define CHAR_TABLE_STANDARD_SLOTS (VECSIZE (struct Lisp_Char_Table) - 1)
882 883 884 885

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

#define CHAR_TABLE_EXTRA_SLOTS(CT)	\
886
  (((CT)->header.size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)
887

888 889 890 891 892 893 894 895 896 897 898 899 900
#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; })
901

902 903 904 905 906 907 908 909 910 911 912 913 914
#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__ */

915 916 917 918 919 920 921 922 923 924
/* Compute A OP B, using the unsigned comparison operator OP.  A and B
   should be integer expressions.  This is not the same as
   mathemeatical comparison; for example, UNSIGNED_CMP (0, <, -1)
   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))

925
/* Nonzero iff C is an ASCII character.  */
926
#define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
927

928
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
929
   characters.  Do not check validity of CT.  */
Kenichi Handa's avatar