lisp.h 132 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2 3

Copyright (C) 1985-1987, 1993-1995, 1997-2012 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 <setjmp.h>
24
#include <stdalign.h>
25
#include <stdarg.h>
26
#include <stdbool.h>
27
#include <stddef.h>
28
#include <float.h>
29
#include <inttypes.h>
30
#include <limits.h>
31

32 33
#include <intprops.h>

34 35 36 37 38
INLINE_HEADER_BEGIN
#ifndef LISP_INLINE
# define LISP_INLINE INLINE
#endif

39 40 41 42 43 44
/* The ubiquitous max and min macros.  */
#undef min
#undef max
#define max(a, b) ((a) > (b) ? (a) : (b))
#define min(a, b) ((a) < (b) ? (a) : (b))

Paul Eggert's avatar
Paul Eggert committed
45 46 47 48
/* EMACS_INT - signed integer wide enough to hold an Emacs value
   EMACS_INT_MAX - maximum value of EMACS_INT; can be used in #if
   pI - printf length modifier for EMACS_INT
   EMACS_UINT - unsigned variant of EMACS_INT */
49
#ifndef EMACS_INT_MAX
Paul Eggert's avatar
Paul Eggert committed
50
# if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
51 52
typedef long long int EMACS_INT;
typedef unsigned long long int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
53
#  define EMACS_INT_MAX LLONG_MAX
54
#  define pI "ll"
Paul Eggert's avatar
Paul Eggert committed
55
# elif INT_MAX < LONG_MAX
56 57
typedef long int EMACS_INT;
typedef unsigned long int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
58
#  define EMACS_INT_MAX LONG_MAX
59 60
#  define pI "l"
# else
61 62
typedef int EMACS_INT;
typedef unsigned int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
63
#  define EMACS_INT_MAX INT_MAX
64 65
#  define pI ""
# endif
66
#endif
Paul Eggert's avatar
Paul Eggert committed
67 68 69 70 71 72 73 74 75 76

/* Number of bits in some machine integer types.  */
enum
  {
    BITS_PER_CHAR      = CHAR_BIT,
    BITS_PER_SHORT     = CHAR_BIT * sizeof (short),
    BITS_PER_INT       = CHAR_BIT * sizeof (int),
    BITS_PER_LONG      = CHAR_BIT * sizeof (long int),
    BITS_PER_EMACS_INT = CHAR_BIT * sizeof (EMACS_INT)
  };
77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
/* 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

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
/* 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

110
/* Extra internal type checking?  */
111

112 113 114 115 116 117
/* Define an Emacs version of 'assert (COND)', since some
   system-defined 'assert's are flaky.  COND should be free of side
   effects; it may or may not be evaluated.  */
#ifndef ENABLE_CHECKING
# define eassert(X) ((void) (0 && (X))) /* Check that X compiles.  */
#else /* ENABLE_CHECKING */
118

119
extern _Noreturn void die (const char *, const char *, int);
120

121 122 123 124 125
/* 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.

   In some cases, a good compiler may be able to optimize away the
126
   eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
127 128
   STRINGP (x), but a particular use of XSTRING is invoked only after
   testing that STRINGP (x) is true, making the test redundant.  */
129
extern bool suppress_checking EXTERNALLY_VISIBLE;
130

131 132 133 134
# define eassert(cond)						\
   ((cond) || suppress_checking					\
    ? (void) 0							\
    : die ("assertion failed: " # cond, __FILE__, __LINE__))
135
#endif /* ENABLE_CHECKING */
136

137 138 139
/* Use the configure flag --enable-check-lisp-object-type to make
   Lisp_Object use a struct type instead of the default int.  The flag
   causes CHECK_LISP_OBJECT_TYPE to be defined.  */
Eli Zaretskii's avatar
Eli Zaretskii committed
140

141
/***** Select the tagging scheme.  *****/
142
/* The following option controls the tagging scheme:
143 144 145 146
   - 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.

147 148
   If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
   restricting our possible address range.
149 150 151 152 153 154

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

Paul Eggert's avatar
Paul Eggert committed
155 156 157 158 159
enum Lisp_Bits
  {
    /* Number of bits in a Lisp_Object tag.  This can be used in #if,
       and for GDB's sake also as a regular symbol.  */
    GCTYPEBITS =
160
#define GCTYPEBITS 3
Paul Eggert's avatar
Paul Eggert committed
161 162
	GCTYPEBITS,

163 164 165 166 167 168
    /* 2**GCTYPEBITS.  This must also be a macro that expands to a
       literal integer constant, for MSVC.  */
    GCALIGNMENT =
#define GCALIGNMENT 8
	GCALIGNMENT,

Paul Eggert's avatar
Paul Eggert committed
169 170
    /* Number of bits in a Lisp_Object value, not counting the tag.  */
    VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS,
171

Paul Eggert's avatar
Paul Eggert committed
172 173 174 175 176 177
    /* Number of bits in a Lisp fixnum tag.  */
    INTTYPEBITS = GCTYPEBITS - 1,

    /* Number of bits in a Lisp fixnum value, not counting the tag.  */
    FIXNUM_BITS = VALBITS + 1
  };
Paul Eggert's avatar
Paul Eggert committed
178

179 180 181 182
#if GCALIGNMENT != 1 << GCTYPEBITS
# error "GCALIGNMENT and GCTYPEBITS are inconsistent"
#endif

Paul Eggert's avatar
Paul Eggert committed
183 184 185 186
/* The maximum value that can be stored in a EMACS_INT, assuming all
   bits other than the type bits contribute to a nonnegative signed value.
   This can be used in #if, e.g., '#if VAL_MAX < UINTPTR_MAX' below.  */
#define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
187

188 189 190 191 192 193
/* Unless otherwise specified, use USE_LSB_TAG on systems where:  */
#ifndef USE_LSB_TAG
/* 1.  We know malloc returns a multiple of 8.  */
# if (defined GNU_MALLOC || defined DOUG_LEA_MALLOC || defined __GLIBC__ \
      || defined DARWIN_OS || defined __sun)
/* 2.  We can specify multiple-of-8 alignment on static variables.  */
194
#  ifdef alignas
195 196
/* 3.  Pointers-as-ints exceed VAL_MAX.
   On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
197 198
    a. unnecessary, because the top bits of an EMACS_INT are unused, and
    b. slower, because it typically requires extra masking.
199 200 201 202
   So, default USE_LSB_TAG to 1 only on hosts where it might be useful.  */
#   if VAL_MAX < UINTPTR_MAX
#    define USE_LSB_TAG 1
#   endif
203
#  endif
204 205
# endif
#endif
Paul Eggert's avatar
Paul Eggert committed
206 207
#ifdef USE_LSB_TAG
# undef USE_LSB_TAG
Paul Eggert's avatar
Paul Eggert committed
208
enum enum_USE_LSB_TAG { USE_LSB_TAG = 1 };
Paul Eggert's avatar
Paul Eggert committed
209 210
# define USE_LSB_TAG 1
#else
Paul Eggert's avatar
Paul Eggert committed
211
enum enum_USE_LSB_TAG { USE_LSB_TAG = 0 };
212 213
# define USE_LSB_TAG 0
#endif
214

215 216
#ifndef alignas
# define alignas(alignment) /* empty */
217
# if USE_LSB_TAG
218
#  error "USE_LSB_TAG requires alignas"
219 220 221
# endif
#endif

222

223
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
224

225 226 227
/* This is the set of Lisp data types.  If you want to define a new
   data type, read the comments after Lisp_Fwd_Type definition
   below.  */
Jim Blandy's avatar
Jim Blandy committed
228

229 230
/* 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.  */
231
static EMACS_INT const INTMASK = EMACS_INT_MAX >> (INTTYPEBITS - 1);
232
#define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
233
#define LISP_INT_TAG_P(x) (((x) & ~Lisp_Int1) == 0)
234

235 236 237 238 239 240 241 242 243
/* 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
244 245
enum Lisp_Type
  {
246
    /* Integer.  XINT (obj) is the integer value.  */
247
    Lisp_Int0 = 0,
248
    Lisp_Int1 = USE_LSB_TAG ? 1 << INTTYPEBITS : 1,
Jim Blandy's avatar
Jim Blandy committed
249

250
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
251
    Lisp_Symbol = 2,
Jim Blandy's avatar
Jim Blandy committed
252

253 254
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
255
    Lisp_Misc = 3,
Jim Blandy's avatar
Jim Blandy committed
256 257

    /* String.  XSTRING (object) points to a struct Lisp_String.
258
       The length of the string, and its contents, are stored therein.  */
259
    Lisp_String = USE_LSB_TAG ? 1 : 1 << INTTYPEBITS,
Jim Blandy's avatar
Jim Blandy committed
260

261
    /* Vector of Lisp objects, or something resembling it.
262
       XVECTOR (object) points to a struct Lisp_Vector, which contains
263 264
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
265
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
266

267
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
268
    Lisp_Cons = 6,
269

270
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
271 272
  };

273
/* This is the set of data types that share a common structure.
274 275 276 277
   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
278 279
enum Lisp_Misc_Type
  {
280
    Lisp_Misc_Free = 0x5eab,
281
    Lisp_Misc_Marker,
282
    Lisp_Misc_Overlay,
283
    Lisp_Misc_Save_Value,
284 285 286 287 288
    /* 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
289 290
  };

291 292 293 294 295 296 297 298 299 300 301 302
/* 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.  */
  };

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
/* If you want to define a new Lisp data type, here are some
   instructions.  See the thread at
   http://lists.gnu.org/archive/html/emacs-devel/2012-10/msg00561.html
   for more info.

   First, there are already a couple of Lisp types that can be used if
   your new type does not need to be exposed to Lisp programs nor
   displayed to users.  These are Lisp_Save_Value, a Lisp_Misc
   subtype, and PVEC_OTHER, a kind of vectorlike object.  The former
   is suitable for temporarily stashing away pointers and integers in
   a Lisp object (see the existing uses of make_save_value and
   XSAVE_VALUE).  The latter is useful for vector-like Lisp objects
   that need to be used as part of other objects, but which are never
   shown to users or Lisp code (search for PVEC_OTHER in xterm.c for
   an example).

   These two types don't look pretty when printed, so they are
   unsuitable for Lisp objects that can be exposed to users.

   To define a new data type, add one more Lisp_Misc subtype or one
   more pseudovector subtype.  Pseudovectors are more suitable for
   objects with several slots that need to support fast random access,
   whil Lisp_Misc types are foreverything else.  A pseudovector object
   provides one or more slots for Lisp objects, followed by struct
   members that are accessible only from C.  A Lisp_Misc object is a
   wrapper for a C struct that can contain anything you like.

   To add a new pseudovector type, extend the pvec_type enumeration;
   to add a new Lisp_Misc, extend the Lisp_Misc_Type enumeration.

   For a Lisp_Misc, you will also need to add your entry to union
   Lisp_Misc (but make sure the first word has the same structure as
   the others, starting with a 16-bit member of the Lisp_Misc_Type
   enumeration and a 1-bit GC markbit) and make sure the overall size
   of the union is not increased by your addition.

   Then you will need to add switch branches in print.c (in
   print_object, to print your object, and possibly also in
   print_preprocess) and to alloc.c, to mark your object (in
   mark_object) and to free it (in gc_sweep).  The latter is also the
   right place to call any code specific to your data type that needs
   to run when the object is recycled -- e.g., free any additional
   resources allocated for it that are not Lisp objects.  You can even
   make a pointer to the function that frees the resources a slot in
   your object -- this way, the same object could be used to represent
   several disparate C structures.  */

350
#ifdef CHECK_LISP_OBJECT_TYPE
Jim Blandy's avatar
Jim Blandy committed
351

352 353 354
typedef struct { EMACS_INT i; } Lisp_Object;

#define XLI(o) (o).i
355
LISP_INLINE Lisp_Object
356 357 358 359 360
XIL (EMACS_INT i)
{
  Lisp_Object o = { i };
  return o;
}
Jim Blandy's avatar
Jim Blandy committed
361

362
LISP_INLINE Lisp_Object
363 364 365 366
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
367 368

#define LISP_INITIALLY_ZERO {0}
369

Paul Eggert's avatar
Paul Eggert committed
370 371
#undef CHECK_LISP_OBJECT_TYPE
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 1 };
372
#else /* CHECK_LISP_OBJECT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
373

374
/* If a struct type is not wanted, define Lisp_Object as just a number.  */
Jim Blandy's avatar
Jim Blandy committed
375

376
typedef EMACS_INT Lisp_Object;
377 378
#define XLI(o) (o)
#define XIL(i) (i)
379
#define LISP_MAKE_RVALUE(o) (0 + (o))
380
#define LISP_INITIALLY_ZERO 0
Paul Eggert's avatar
Paul Eggert committed
381
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 0 };
382
#endif /* CHECK_LISP_OBJECT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
383

384
/* In the size word of a vector, this bit means the vector has been marked.  */
385

386 387 388
static ptrdiff_t const ARRAY_MARK_FLAG
#define ARRAY_MARK_FLAG PTRDIFF_MIN
      = ARRAY_MARK_FLAG;
389

390 391
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
392 393 394
static ptrdiff_t const PSEUDOVECTOR_FLAG
#define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
      = PSEUDOVECTOR_FLAG;
395

396
/* In a pseudovector, the size field actually contains a word with one
397 398
   PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
   with PVEC_TYPE_MASK to indicate the actual type.  */
399 400
enum pvec_type
{
401
  PVEC_NORMAL_VECTOR,
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  PVEC_FREE,
  PVEC_PROCESS,
  PVEC_FRAME,
  PVEC_WINDOW,
  PVEC_BOOL_VECTOR,
  PVEC_BUFFER,
  PVEC_HASH_TABLE,
  PVEC_TERMINAL,
  PVEC_WINDOW_CONFIGURATION,
  PVEC_SUBR,
  PVEC_OTHER,
  /* These last 4 are special because we OR them in fns.c:internal_equal,
     so they have to use a disjoint bit pattern:
     if (!(size & (PVEC_COMPILED | PVEC_CHAR_TABLE
                   | PVEC_SUB_CHAR_TABLE | PVEC_FONT))) */
  PVEC_COMPILED			= 0x10,
  PVEC_CHAR_TABLE		= 0x20,
  PVEC_SUB_CHAR_TABLE		= 0x30,
  PVEC_FONT			= 0x40
421
};
422

Paul Eggert's avatar
Paul Eggert committed
423 424 425 426 427 428 429 430 431
/* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
   which were stored in a Lisp_Object.  */
#ifndef DATA_SEG_BITS
# define DATA_SEG_BITS 0
#endif
enum { gdb_DATA_SEG_BITS = DATA_SEG_BITS };
#undef DATA_SEG_BITS

enum More_Lisp_Bits
432
  {
Paul Eggert's avatar
Paul Eggert committed
433 434 435 436 437 438 439
    DATA_SEG_BITS = gdb_DATA_SEG_BITS,

    /* 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 GC).
       The distinction is used, e.g., by Lisp_Process, which places extra
       non-Lisp_Object fields at the end of the structure.  */
440 441
    PSEUDOVECTOR_SIZE_BITS = 16,
    PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1,
Paul Eggert's avatar
Paul Eggert committed
442
    PVEC_TYPE_MASK = 0x0fff << PSEUDOVECTOR_SIZE_BITS,
443

Paul Eggert's avatar
Paul Eggert committed
444 445 446 447
    /* Number of bits to put in each character in the internal representation
       of bool vectors.  This should not vary across implementations.  */
    BOOL_VECTOR_BITS_PER_CHAR = 8
  };
Jim Blandy's avatar
Jim Blandy committed
448 449 450

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
451
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
452

453
/* Return a perfect hash of the Lisp_Object representation.  */
454
#define XHASH(a) XLI (a)
455

456
#if USE_LSB_TAG
Kenichi Handa's avatar
Kenichi Handa committed
457

458 459 460 461 462
enum lsb_bits
  {
    TYPEMASK = (1 << GCTYPEBITS) - 1,
    VALMASK = ~ TYPEMASK
  };
463 464 465 466
#define XTYPE(a) ((enum Lisp_Type) (XLI (a) & TYPEMASK))
#define XINT(a) (XLI (a) >> INTTYPEBITS)
#define XUINT(a) ((EMACS_UINT) XLI (a) >> INTTYPEBITS)
#define make_number(N) XIL ((EMACS_INT) (N) << INTTYPEBITS)
467
#define make_lisp_ptr(ptr, type) \
468
  (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment.  */  \
469
   XIL ((type) | (intptr_t) (ptr)))
Kenichi Handa's avatar
Kenichi Handa committed
470

471 472
#define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
#define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
Kenichi Handa's avatar
Kenichi Handa committed
473 474 475

#else  /* not USE_LSB_TAG */

476 477 478
static EMACS_INT const VALMASK
#define VALMASK VAL_MAX
      = VALMASK;
Kenichi Handa's avatar
Kenichi Handa committed
479

480
#define XTYPE(a) ((enum Lisp_Type) ((EMACS_UINT) XLI (a) >> VALBITS))
Jim Blandy's avatar
Jim Blandy committed
481

Karl Heuer's avatar
Karl Heuer committed
482 483
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
484 485 486
   fact that Lisp integers have zero-bits in their tags.  */
#define XFASTINT(a) (XLI (a) + 0)
#define XSETFASTINT(a, b) ((a) = XIL (b))
Jim Blandy's avatar
Jim Blandy committed
487

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

490 491 492
#define XINT(a) (XLI (a) << INTTYPEBITS >> INTTYPEBITS)
#define XUINT(a) ((EMACS_UINT) (XLI (a) & INTMASK))
#define make_number(N) XIL ((EMACS_INT) (N) & INTMASK)
Jim Blandy's avatar
Jim Blandy committed
493

494 495 496
#define make_lisp_ptr(ptr, type) \
  (XIL ((EMACS_INT) ((EMACS_UINT) (type) << VALBITS)  \
	+ ((intptr_t) (ptr) & VALMASK)))
497

498
#if DATA_SEG_BITS
499
/* DATA_SEG_BITS forces extra bits to be or'd in with any pointers
500
   which were stored in a Lisp_Object.  */
501
#define XPNTR(a) ((uintptr_t) ((XLI (a) & VALMASK)) | DATA_SEG_BITS))
502
#else
503
#define XPNTR(a) ((uintptr_t) (XLI (a) & VALMASK))
504
#endif
505

Kenichi Handa's avatar
Kenichi Handa committed
506
#endif /* not USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
507

508 509 510 511 512 513 514 515
/* 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

516 517 518 519 520 521 522
/* Extract the pointer value of the Lisp object A, under the
   assumption that A's type is TYPE.  This is a fallback
   implementation if nothing faster is available.  */
#ifndef XUNTAG
# define XUNTAG(a, type) XPNTR (a)
#endif

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

525
/* Largest and smallest representable fixnum values.  These are the C
526 527 528
   values.  They are macros for use in static initializers, and
   constants for visibility to GDB.  */
static EMACS_INT const MOST_POSITIVE_FIXNUM =
529
#define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
530 531
	MOST_POSITIVE_FIXNUM;
static EMACS_INT const MOST_NEGATIVE_FIXNUM =
532
#define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
533
	MOST_NEGATIVE_FIXNUM;
534

535 536
/* 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
537
   type or if I is a NaN.  */
538 539

#define FIXNUM_OVERFLOW_P(i) \
540
  (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
541

542
LISP_INLINE ptrdiff_t
543 544 545 546 547
clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper)
{
  return num < lower ? lower : num <= upper ? num : upper;
}

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

550 551 552 553 554 555 556 557 558 559
#define XCONS(a)   (eassert (CONSP (a)), \
		    (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
#define XVECTOR(a) (eassert (VECTORLIKEP (a)), \
		    (struct Lisp_Vector *) XUNTAG (a, Lisp_Vectorlike))
#define XSTRING(a) (eassert (STRINGP (a)), \
		    (struct Lisp_String *) XUNTAG (a, Lisp_String))
#define XSYMBOL(a) (eassert (SYMBOLP (a)), \
		    (struct Lisp_Symbol *) XUNTAG (a, Lisp_Symbol))
#define XFLOAT(a)  (eassert (FLOATP (a)), \
		    (struct Lisp_Float *) XUNTAG (a, Lisp_Float))
560 561

/* Misc types.  */
562

563
#define XMISC(a)	((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
Juanma Barranquero's avatar
Juanma Barranquero committed
564
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC (a)->u_any))
565
#define XMISCTYPE(a)   (XMISCANY (a)->type)
Juanma Barranquero's avatar
Juanma Barranquero committed
566 567 568
#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))
569 570 571 572 573 574 575

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

581
/* Pseudovector types.  */
582

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
#define XPROCESS(a) (eassert (PROCESSP (a)), \
		     (struct Lisp_Process *) XUNTAG (a, Lisp_Vectorlike))
#define XWINDOW(a) (eassert (WINDOWP (a)), \
		    (struct window *) XUNTAG (a, Lisp_Vectorlike))
#define XTERMINAL(a) (eassert (TERMINALP (a)), \
		      (struct terminal *) XUNTAG (a, Lisp_Vectorlike))
#define XSUBR(a) (eassert (SUBRP (a)), \
		  (struct Lisp_Subr *) XUNTAG (a, Lisp_Vectorlike))
#define XBUFFER(a) (eassert (BUFFERP (a)), \
		    (struct buffer *) XUNTAG (a, Lisp_Vectorlike))
#define XCHAR_TABLE(a) (eassert (CHAR_TABLE_P (a)), \
			(struct Lisp_Char_Table *) XUNTAG (a, Lisp_Vectorlike))
#define XSUB_CHAR_TABLE(a) (eassert (SUB_CHAR_TABLE_P (a)), \
			    ((struct Lisp_Sub_Char_Table *) \
			     XUNTAG (a, Lisp_Vectorlike)))
#define XBOOL_VECTOR(a) (eassert (BOOL_VECTOR_P (a)), \
			 ((struct Lisp_Bool_Vector *) \
			  XUNTAG (a, Lisp_Vectorlike)))
601 602

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

Paul Eggert's avatar
Paul Eggert committed
604 605 606 607 608 609
#define XSETINT(a, b) ((a) = make_number (b))
#define XSETCONS(a, b) ((a) = make_lisp_ptr (b, Lisp_Cons))
#define XSETVECTOR(a, b) ((a) = make_lisp_ptr (b, Lisp_Vectorlike))
#define XSETSTRING(a, b) ((a) = make_lisp_ptr (b, Lisp_String))
#define XSETSYMBOL(a, b) ((a) = make_lisp_ptr (b, Lisp_Symbol))
#define XSETFLOAT(a, b) ((a) = make_lisp_ptr (b, Lisp_Float))
610 611

/* Misc types.  */
612

Paul Eggert's avatar
Paul Eggert committed
613
#define XSETMISC(a, b) ((a) = make_lisp_ptr (b, Lisp_Misc))
Richard M. Stallman's avatar
Richard M. Stallman committed
614
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
615 616

/* Pseudovector types.  */
617

Juanma Barranquero's avatar
Juanma Barranquero committed
618
#define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
619
#define XSETTYPED_PVECTYPE(v, size_member, code) \
620
  ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
621
#define XSETPVECTYPESIZE(v, code, sizeval) \
622 623 624
  ((v)->header.size = (PSEUDOVECTOR_FLAG			\
		       | ((code) << PSEUDOVECTOR_SIZE_BITS)	\
		       | (sizeval)))
625 626

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

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

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

654
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
655
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->header.size
Stefan Monnier's avatar
Stefan Monnier committed
656
#define ASET(ARRAY, IDX, VAL)	\
657
  (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)),	\
658
   XVECTOR (ARRAY)->contents[IDX] = (VAL))
659

660 661
/* Convenience macros for dealing with Lisp strings.  */

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

668 669 670
/* Avoid "differ in sign" warnings.  */
#define SSDATA(x)  ((char *) SDATA (x))

671 672
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
673

Ken Raeburn's avatar
Ken Raeburn committed
674
#define STRING_COPYIN(string, index, new, count) \
675
    memcpy (SDATA (string) + index, new, count)
Ken Raeburn's avatar
Ken Raeburn committed
676

677 678 679 680 681
/* Type checking.  */

#define CHECK_TYPE(ok, Qxxxp, x) \
  do { if (!(ok)) wrong_type_argument (Qxxxp, (x)); } while (0)

682
/* Deprecated and will be removed soon.  */
683 684

#define INTERNAL_FIELD(field) field ## _
685

686
/* See the macros in intervals.h.  */
687 688 689

typedef struct interval *INTERVAL;

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

Jim Blandy's avatar
Jim Blandy committed
694 695
struct Lisp_Cons
  {
696
    /* Car of this cons cell.  */
697
    Lisp_Object car;
698

699 700
    union
    {
701
      /* Cdr of this cons cell.  */
702
      Lisp_Object cdr;
703 704

      /* Used to chain conses on a free list.  */
705 706
      struct Lisp_Cons *chain;
    } u;
Jim Blandy's avatar
Jim Blandy committed
707 708
  };

709
/* Take the car or cdr of something known to be a cons cell.  */
710 711 712 713 714 715
/* 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.)  */
716 717
#define XCAR_AS_LVALUE(c) (XCONS (c)->car)
#define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
718

719
/* Use these from normal code.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
720 721
#define XCAR(c)	LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
#define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
722 723 724 725 726 727 728

/* 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
729 730
#define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
#define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
731

732 733 734 735
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
736
  : wrong_type_argument (Qlistp, (c)))
737 738 739 740

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

743 744 745 746 747 748 749
/* 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)

750
/* True if STR is a multibyte string.  */
Kenichi Handa's avatar
Kenichi Handa committed
751 752 753 754
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
755 756 757 758

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
759
extern ptrdiff_t string_bytes (struct Lisp_String *);
760 761 762 763
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
764 765 766
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

767 768
#endif /* not GC_CHECK_STRING_BYTES */

769 770 771 772 773 774 775 776 777
/* 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
778 779
   private.

780
   This is a macro for use in static initializers, and a constant for
781
   visibility to GDB.  The cast to ptrdiff_t ensures that
782
   the macro is signed.  */
783
static ptrdiff_t const STRING_BYTES_BOUND =
784
#define STRING_BYTES_BOUND  \
785
  ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
786
	STRING_BYTES_BOUND;
787

788
/* Mark STR as a unibyte string.  */
789 790 791 792
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
793

794 795 796 797 798 799 800
/* 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)

801
/* In a string or vector, the sign bit of the `size' is the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
802 803 804

struct Lisp_String
  {
805 806
    ptrdiff_t size;
    ptrdiff_t size_byte;
807
    INTERVAL intervals;		/* Text properties in this string.  */
808
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
809 810
  };

811 812 813 814 815 816 817
/* 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>.  */
818
struct vectorlike_header
Jim Blandy's avatar
Jim Blandy committed
819
  {
820 821 822 823 824 825 826 827 828 829 830 831 832 833
    /* This field contains various pieces of information:
       - The MSB (ARRAY_MARK_FLAG) holds the gcmarkbit.
       - The next bit (PSEUDOVECTOR_FLAG) indicates whether this is a plain
         vector (0) or a pseudovector (1).
       - If PSEUDOVECTOR_FLAG is 0, the rest holds the size (number
         of slots) of the vector.
       - If PSEUDOVECTOR_FLAG is 1, the rest is subdivided into
         a "pvec type" tag held in PVEC_TYPE_MASK and a size held in the lowest
         PSEUDOVECTOR_SIZE_BITS.  That size normally indicates the number of
         Lisp_Object slots at the beginning of the object that need to be
         traced by the GC, tho some types use it slightly differently.
       - E.g. if the pvec type is PVEC_FREE it means this is an unallocated
         vector on a free-list and PSEUDOVECTOR_SIZE_BITS indicates its size
         in bytes.  */
834
    ptrdiff_t size;
835

836 837 838
    /* When the vector is allocated from a vector block, NBYTES is used
       if the vector is not on a free list, and VECTOR is used otherwise.
       For large vector-like objects, BUFFER or VECTOR is used as a pointer
839
       to the next vector-like object.  It is generally a buffer or a
840 841 842
       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).  */
843
    union {
844 845 846 847 848
      /* This is only needed for small vectors that are not free because the
	 `size' field only gives us the number of Lisp_Object slots, whereas we
	 need to know the total size, including non-Lisp_Object data.
	 FIXME: figure out a way to store this info elsewhere so we can
	 finally get rid of this extra word of overhead.  */
849
      ptrdiff_t nbytes;
850
      struct buffer *buffer;
851 852 853 854
      /* FIXME: This can be removed: For large vectors, this field could be
	 placed *before* the vector itself.  And for small vectors on a free
	 list, this field could be stored in the vector's bytes, since the
	 empty vector is handled specially anyway.  */
855 856 857 858
      struct Lisp_Vector *vector;
    } next;
  };

859 860
/* Regular vector is just a header plus array of Lisp_Objects.  */

861 862
struct Lisp_Vector
  {
863
    struct vectorlike_header header;
Jim Blandy's avatar
Jim Blandy committed
864 865 866
    Lisp_Object contents[1];
  };

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
/* A boolvector is a kind of vectorlike, with contents are like a string.  */

struct Lisp_Bool_Vector
  {
    /* HEADER.SIZE is the vector's size field.  It doesn't have the real size,
       just the subtype information.  */
    struct vectorlike_header header;
    /* This is the size in bits.  */
    EMACS_INT size;
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

/* Some handy constants for calculating sizes
   and offsets, mostly of vectorlike objects.   */

enum
  {
    header_size = offsetof (struct Lisp_Vector, contents),
    bool_header_size = offsetof (struct Lisp_Bool_Vector, data),
    word_size = sizeof (Lisp_Object)
  };

Karl Heuer's avatar
Karl Heuer committed
890
/* If a struct is made to look like a vector, this macro returns the length
891
   of the shortest vector that would hold that struct.  */
892 893 894

#define VECSIZE(type)						\
  ((sizeof (type) - header_size + word_size - 1) / word_size)
Karl Heuer's avatar
Karl Heuer committed
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).  */
899 900 901

#define PSEUDOVECSIZE(type, nonlispfield)			\
  ((offsetof (type, nonlispfield) - header_size) / word_size)
902

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

913 914 915 916 917 918 919 920 921 922 923 924 925
#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; })
926

927 928 929 930 931 932 933 934 935 936 937 938 939
#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__ */

940 941
/* 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
942
   mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
943 944 945 946 947 948 949
   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))

950
/* Nonzero iff C is an ASCII character.  */
951
#define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
952

953
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
954
   characters.  Do not check validity of CT.  */
955 956
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
957
   : char_table_ref ((CT), (IDX)))
958 959

/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
960
   8-bit European characters.  Do not check validity of CT.  */
961
#define CHAR_TABLE_SET(CT, IDX, VAL)					\
962
  (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)	\
963
   ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL)	\
964 965
   : char_table_set (CT, IDX, VAL))

966 967 968 969 970 971 972
enum CHARTAB_SIZE_BITS
  {
    CHARTAB_SIZE_BITS_0 = 6,
    CHARTAB_SIZE_BITS_1 = 4,
    CHARTAB_SIZE_BITS_2 = 5,
    CHARTAB_SIZE_BITS_3 = 7
  };
973 974 975

extern const int chartab_size[4];

976 977
struct Lisp_Char_Table
  {
978
    /* HEADER.SIZE is the vector's size field, which also holds the
979
       pseudovector type information.  It holds the size, too.
Miles Bader's avatar
Miles Bader committed
980 981
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
982
    struct vectorlike_header header;
983

984 985 986
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
987

Kenichi Handa's avatar
Kenichi Handa committed
988 989 990
    /* 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.  */
991
    Lisp_Object parent;
992

Kenichi Handa's avatar
Kenichi Handa committed
993 994
    /* This is a symbol which says what kind of use this char-table is
       meant for.  */
995
    Lisp_Object purpose;
996

Kenichi Handa's avatar
Kenichi Handa committed
997 998 999
    /* 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;
1000

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

Kenichi Handa's avatar
Kenichi Handa committed
1003
    /* These hold additional data.  It is a vector.  */
1004 1005 1006
    Lisp_Object extras[1];
  };

1007
struct Lisp_Sub_Char_Table
Kenichi Handa's avatar
Kenichi Handa committed
1008
  {
1009
    /* HEADER.SIZE is the vector's size field, which also holds the
Kenichi Handa's avatar
Kenichi Handa committed
1010
       pseudovector type information.  It holds the size, too.  */
1011
    struct vectorlike_header header;
1012

Kenichi Handa's avatar
Kenichi Handa committed
1013
    /* Depth of this sub char-table.  It should be 1, 2, or 3.  A sub
Juanma Barranquero's avatar
Juanma Barranquero committed
1014
       char-table of depth 1 contains 16 elements, and each element
Kenichi Handa's avatar