lisp.h 129 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 <stdalign.h>
24
#include <stdarg.h>
25
#include <stdbool.h>
26
#include <stddef.h>
27
#include <inttypes.h>
28
#include <limits.h>
29

30 31
#include <intprops.h>

32 33 34 35 36
INLINE_HEADER_BEGIN
#ifndef LISP_INLINE
# define LISP_INLINE INLINE
#endif

37 38 39 40 41 42
/* 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
43 44 45 46
/* 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 */
47
#ifndef EMACS_INT_MAX
Paul Eggert's avatar
Paul Eggert committed
48
# if LONG_MAX < LLONG_MAX && defined WIDE_EMACS_INT
49 50
typedef long long int EMACS_INT;
typedef unsigned long long int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
51
#  define EMACS_INT_MAX LLONG_MAX
52
#  define pI "ll"
Paul Eggert's avatar
Paul Eggert committed
53
# elif INT_MAX < LONG_MAX
54 55
typedef long int EMACS_INT;
typedef unsigned long int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
56
#  define EMACS_INT_MAX LONG_MAX
57 58
#  define pI "l"
# else
59 60
typedef int EMACS_INT;
typedef unsigned int EMACS_UINT;
Paul Eggert's avatar
Paul Eggert committed
61
#  define EMACS_INT_MAX INT_MAX
62 63
#  define pI ""
# endif
64
#endif
Paul Eggert's avatar
Paul Eggert committed
65 66 67 68 69 70 71 72 73 74

/* 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)
  };
75

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

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

108
/* Extra internal type checking?  */
109

110 111 112 113 114 115
/* 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 */
116

117
extern _Noreturn void die (const char *, const char *, int);
118

119 120 121 122 123
/* 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
124
   eassert macro altogether, e.g., if XSTRING (x) uses eassert to test
125 126
   STRINGP (x), but a particular use of XSTRING is invoked only after
   testing that STRINGP (x) is true, making the test redundant.  */
127
extern bool suppress_checking EXTERNALLY_VISIBLE;
128

129 130 131 132
# define eassert(cond)						\
   ((cond) || suppress_checking					\
    ? (void) 0							\
    : die ("assertion failed: " # cond, __FILE__, __LINE__))
133
#endif /* ENABLE_CHECKING */
134

135 136 137
/* 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
138

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

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

   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
153 154 155 156 157
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 =
158
#define GCTYPEBITS 3
Paul Eggert's avatar
Paul Eggert committed
159 160
	GCTYPEBITS,

161 162 163 164 165 166
    /* 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
167 168
    /* Number of bits in a Lisp_Object value, not counting the tag.  */
    VALBITS = BITS_PER_EMACS_INT - GCTYPEBITS,
169

Paul Eggert's avatar
Paul Eggert committed
170 171 172 173 174 175
    /* 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
176

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

Paul Eggert's avatar
Paul Eggert committed
181 182 183 184
/* 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))
185

186 187 188 189 190 191
/* 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.  */
192
#  ifdef alignas
193 194
/* 3.  Pointers-as-ints exceed VAL_MAX.
   On hosts where pointers-as-ints do not exceed VAL_MAX, USE_LSB_TAG is:
195 196
    a. unnecessary, because the top bits of an EMACS_INT are unused, and
    b. slower, because it typically requires extra masking.
197 198 199 200
   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
201
#  endif
202 203
# endif
#endif
Paul Eggert's avatar
Paul Eggert committed
204 205
#ifdef USE_LSB_TAG
# undef USE_LSB_TAG
Paul Eggert's avatar
Paul Eggert committed
206
enum enum_USE_LSB_TAG { USE_LSB_TAG = 1 };
Paul Eggert's avatar
Paul Eggert committed
207 208
# define USE_LSB_TAG 1
#else
Paul Eggert's avatar
Paul Eggert committed
209
enum enum_USE_LSB_TAG { USE_LSB_TAG = 0 };
210 211
# define USE_LSB_TAG 0
#endif
212

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

220

221
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
222

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

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

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

246
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
247
    Lisp_Symbol = 2,
Jim Blandy's avatar
Jim Blandy committed
248

249 250
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
251
    Lisp_Misc = 3,
Jim Blandy's avatar
Jim Blandy committed
252 253

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

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

263
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
264
    Lisp_Cons = 6,
265

266
    Lisp_Float = 7,
Jim Blandy's avatar
Jim Blandy committed
267 268
  };

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

287 288 289 290 291 292 293 294 295 296 297 298
/* 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.  */
  };

299
#ifdef CHECK_LISP_OBJECT_TYPE
Jim Blandy's avatar
Jim Blandy committed
300

301 302 303
typedef struct { EMACS_INT i; } Lisp_Object;

#define XLI(o) (o).i
304
LISP_INLINE Lisp_Object
305 306 307 308 309
XIL (EMACS_INT i)
{
  Lisp_Object o = { i };
  return o;
}
Jim Blandy's avatar
Jim Blandy committed
310

311
LISP_INLINE Lisp_Object
312 313 314 315
LISP_MAKE_RVALUE (Lisp_Object o)
{
    return o;
}
316 317

#define LISP_INITIALLY_ZERO {0}
318

Paul Eggert's avatar
Paul Eggert committed
319 320
#undef CHECK_LISP_OBJECT_TYPE
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 1 };
321
#else /* CHECK_LISP_OBJECT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
322

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

325
typedef EMACS_INT Lisp_Object;
326 327
#define XLI(o) (o)
#define XIL(i) (i)
328
#define LISP_MAKE_RVALUE(o) (0+(o))
329
#define LISP_INITIALLY_ZERO 0
Paul Eggert's avatar
Paul Eggert committed
330
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = 0 };
331
#endif /* CHECK_LISP_OBJECT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
332

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

335 336 337
static ptrdiff_t const ARRAY_MARK_FLAG
#define ARRAY_MARK_FLAG PTRDIFF_MIN
      = ARRAY_MARK_FLAG;
338

339 340
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
341 342 343
static ptrdiff_t const PSEUDOVECTOR_FLAG
#define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
      = PSEUDOVECTOR_FLAG;
344

345
/* In a pseudovector, the size field actually contains a word with one
346
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
347
   indicate the actual type.
348 349 350 351
   We use a bitset, even tho only one of the bits can be set at any
   particular time just so as to be able to use micro-optimizations such as
   testing membership of a particular subset of pseudovectors in Fequal.
   It is not crucial, but there are plenty of bits here, so why not do it?  */
352 353
enum pvec_type
{
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  PVEC_NORMAL_VECTOR = 0,	/* Unused!  */
  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
374
};
375

Paul Eggert's avatar
Paul Eggert committed
376 377 378 379 380 381 382 383 384
/* 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
385
  {
Paul Eggert's avatar
Paul Eggert committed
386 387 388 389 390 391 392
    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.  */
393 394
    PSEUDOVECTOR_SIZE_BITS = 16,
    PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1,
Paul Eggert's avatar
Paul Eggert committed
395
    PVEC_TYPE_MASK = 0x0fff << PSEUDOVECTOR_SIZE_BITS,
396

Paul Eggert's avatar
Paul Eggert committed
397 398 399 400
    /* 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
401 402 403

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
404
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
405

406
/* Return a perfect hash of the Lisp_Object representation.  */
407
#define XHASH(a) XLI (a)
408

409
#if USE_LSB_TAG
Kenichi Handa's avatar
Kenichi Handa committed
410

411 412 413 414 415
enum lsb_bits
  {
    TYPEMASK = (1 << GCTYPEBITS) - 1,
    VALMASK = ~ TYPEMASK
  };
416 417 418 419
#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)
420
#define XSET(var, type, ptr)						   \
421 422
  (eassert (XTYPE (XIL ((intptr_t) (ptr))) == 0), /* Check alignment.  */  \
   (var) = XIL ((type) | (intptr_t) (ptr)))
Kenichi Handa's avatar
Kenichi Handa committed
423

424 425
#define XPNTR(a) ((intptr_t) (XLI (a) & ~TYPEMASK))
#define XUNTAG(a, type) ((intptr_t) (XLI (a) - (type)))
Kenichi Handa's avatar
Kenichi Handa committed
426 427 428

#else  /* not USE_LSB_TAG */

429 430 431
static EMACS_INT const VALMASK
#define VALMASK VAL_MAX
      = VALMASK;
Kenichi Handa's avatar
Kenichi Handa committed
432

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

Karl Heuer's avatar
Karl Heuer committed
435 436
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
437 438 439
   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
440

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

443 444 445
#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
446

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

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

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

461 462 463 464 465 466 467 468
/* 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

469 470 471 472 473 474 475
/* 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

476 477
#define EQ(x, y) (XHASH (x) == XHASH (y))

478
/* Largest and smallest representable fixnum values.  These are the C
479 480 481
   values.  They are macros for use in static initializers, and
   constants for visibility to GDB.  */
static EMACS_INT const MOST_POSITIVE_FIXNUM =
482
#define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
483 484
	MOST_POSITIVE_FIXNUM;
static EMACS_INT const MOST_NEGATIVE_FIXNUM =
485
#define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
486
	MOST_NEGATIVE_FIXNUM;
487

488 489
/* 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
490
   type or if I is a NaN.  */
491 492

#define FIXNUM_OVERFLOW_P(i) \
493
  (! ((0 <= (i) || MOST_NEGATIVE_FIXNUM <= (i)) && (i) <= MOST_POSITIVE_FIXNUM))
494

495
LISP_INLINE ptrdiff_t
496 497 498 499 500
clip_to_bounds (ptrdiff_t lower, EMACS_INT num, ptrdiff_t upper)
{
  return num < lower ? lower : num <= upper ? num : upper;
}

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

503 504 505 506 507 508 509 510 511 512
#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))
513 514

/* Misc types.  */
515

516
#define XMISC(a)	((union Lisp_Misc *) XUNTAG (a, Lisp_Misc))
Juanma Barranquero's avatar
Juanma Barranquero committed
517
#define XMISCANY(a)	(eassert (MISCP (a)), &(XMISC (a)->u_any))
518
#define XMISCTYPE(a)   (XMISCANY (a)->type)
Juanma Barranquero's avatar
Juanma Barranquero committed
519 520 521
#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))
522 523 524 525 526 527 528

/* 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))
529
#define XBUFFER_OBJFWD(a) \
530
  (eassert (BUFFER_OBJFWDP (a)), &((a)->u_buffer_objfwd))
531
#define XKBOARD_OBJFWD(a) \
532
  (eassert (KBOARD_OBJFWDP (a)), &((a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
533

534
/* Pseudovector types.  */
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
#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)))
554 555

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

557
#define XSETINT(a, b) (a) = make_number (b)
558
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
559
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
560 561 562
#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)
563 564

/* Misc types.  */
565

566
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
567
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
568 569

/* Pseudovector types.  */
570

Juanma Barranquero's avatar
Juanma Barranquero committed
571
#define XSETPVECTYPE(v, code) XSETTYPED_PVECTYPE (v, header.size, code)
572
#define XSETTYPED_PVECTYPE(v, size_member, code) \
573
  ((v)->size_member |= PSEUDOVECTOR_FLAG | ((code) << PSEUDOVECTOR_SIZE_BITS))
574
#define XSETPVECTYPESIZE(v, code, sizeval) \
575 576 577
  ((v)->header.size = (PSEUDOVECTOR_FLAG			\
		       | ((code) << PSEUDOVECTOR_SIZE_BITS)	\
		       | (sizeval)))
578 579

/* The cast to struct vectorlike_header * avoids aliasing issues.  */
580
#define XSETPSEUDOVECTOR(a, b, code) \
581 582 583 584 585
  XSETTYPED_PSEUDOVECTOR (a, b,					\
			  (((struct vectorlike_header *)	\
			    XUNTAG (a, Lisp_Vectorlike))	\
			   ->size),				\
			  code)
586
#define XSETTYPED_PSEUDOVECTOR(a, b, size, code)			\
587
  (XSETVECTOR (a, b),							\
588
   eassert ((size & (PSEUDOVECTOR_FLAG | PVEC_TYPE_MASK))		\
589
	    == (PSEUDOVECTOR_FLAG | (code << PSEUDOVECTOR_SIZE_BITS))))
590

591 592 593 594
#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))
595
#define XSETTERMINAL(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_TERMINAL))
596
/* XSETSUBR is special since Lisp_Subr lacks struct vectorlike_header.  */
597 598
#define XSETSUBR(a, b) \
  XSETTYPED_PSEUDOVECTOR (a, b, XSUBR (a)->size, PVEC_SUBR)
599
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
600
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
601 602
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
603
#define XSETSUB_CHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUB_CHAR_TABLE))
604 605 606

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

607
#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
608
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->header.size
Stefan Monnier's avatar
Stefan Monnier committed
609
#define ASET(ARRAY, IDX, VAL)	\
610
  (eassert (0 <= (IDX) && (IDX) < ASIZE (ARRAY)),	\
611
   XVECTOR (ARRAY)->contents[IDX] = (VAL))
612

613 614
/* Convenience macros for dealing with Lisp strings.  */

Ken Raeburn's avatar
Ken Raeburn committed
615
#define SDATA(string)		(XSTRING (string)->data + 0)
616 617
#define SREF(string, index)	(SDATA (string)[index] + 0)
#define SSET(string, index, new) (SDATA (string)[index] = (new))
618 619 620
#define SCHARS(string)		(XSTRING (string)->size + 0)
#define SBYTES(string)		(STRING_BYTES (XSTRING (string)) + 0)

621 622 623
/* Avoid "differ in sign" warnings.  */
#define SSDATA(x)  ((char *) SDATA (x))

624 625
#define STRING_SET_CHARS(string, newsize) \
    (XSTRING (string)->size = (newsize))
626

Ken Raeburn's avatar
Ken Raeburn committed
627
#define STRING_COPYIN(string, index, new, count) \
628
    memcpy (SDATA (string) + index, new, count)
Ken Raeburn's avatar
Ken Raeburn committed
629

630 631 632 633 634
/* Type checking.  */

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

635
/* Deprecated and will be removed soon.  */
636 637

#define INTERNAL_FIELD(field) field ## _
638

639
/* See the macros in intervals.h.  */
640 641 642

typedef struct interval *INTERVAL;

643
/* Complain if object is not string or buffer type.  */
644
#define CHECK_STRING_OR_BUFFER(x) \
645 646
  CHECK_TYPE (STRINGP (x) || BUFFERP (x), Qbuffer_or_string_p, x)

Jim Blandy's avatar
Jim Blandy committed
647 648
struct Lisp_Cons
  {
649
    /* Car of this cons cell.  */
650
    Lisp_Object car;
651

652 653
    union
    {
654
      /* Cdr of this cons cell.  */
655
      Lisp_Object cdr;
656 657

      /* Used to chain conses on a free list.  */
658 659
      struct Lisp_Cons *chain;
    } u;
Jim Blandy's avatar
Jim Blandy committed
660 661
  };

662
/* Take the car or cdr of something known to be a cons cell.  */
663 664 665 666 667 668
/* 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.)  */
669 670
#define XCAR_AS_LVALUE(c) (XCONS (c)->car)
#define XCDR_AS_LVALUE(c) (XCONS (c)->u.cdr)
671

672
/* Use these from normal code.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
673 674
#define XCAR(c)	LISP_MAKE_RVALUE (XCAR_AS_LVALUE (c))
#define XCDR(c) LISP_MAKE_RVALUE (XCDR_AS_LVALUE (c))
675 676 677 678 679 680 681

/* 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
682 683
#define XSETCAR(c,n) (XCAR_AS_LVALUE (c) = (n))
#define XSETCDR(c,n) (XCDR_AS_LVALUE (c) = (n))
684

685 686 687 688
/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
689
  : wrong_type_argument (Qlistp, (c)))
690 691 692 693

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

696 697 698 699 700 701 702
/* 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)

703
/* True if STR is a multibyte string.  */
Kenichi Handa's avatar
Kenichi Handa committed
704 705 706 707
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
708 709 710 711

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
712
extern ptrdiff_t string_bytes (struct Lisp_String *);
713 714 715 716
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
717 718 719
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

720 721
#endif /* not GC_CHECK_STRING_BYTES */

722 723 724 725 726 727 728 729 730
/* 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
731 732
   private.

733
   This is a macro for use in static initializers, and a constant for
734
   visibility to GDB.  The cast to ptrdiff_t ensures that
735
   the macro is signed.  */
736
static ptrdiff_t const STRING_BYTES_BOUND =
737
#define STRING_BYTES_BOUND  \
738
  ((ptrdiff_t) min (MOST_POSITIVE_FIXNUM, min (SIZE_MAX, PTRDIFF_MAX) - 1))
739
	STRING_BYTES_BOUND;
740

741
/* Mark STR as a unibyte string.  */
742 743 744 745
#define STRING_SET_UNIBYTE(STR)  \
  do { if (EQ (STR, empty_multibyte_string))  \
      (STR) = empty_unibyte_string;  \
    else XSTRING (STR)->size_byte = -1; } while (0)
746

747 748 749 750 751 752 753
/* 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)

754
/* In a string or vector, the sign bit of the `size' is the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
755 756 757

struct Lisp_String
  {
758 759
    ptrdiff_t size;
    ptrdiff_t size_byte;
760
    INTERVAL intervals;		/* Text properties in this string.  */
761
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
762 763
  };

764 765 766 767 768 769 770
/* 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>.  */
771
struct vectorlike_header
Jim Blandy's avatar
Jim Blandy committed
772
  {
773 774 775 776 777 778 779 780 781 782 783 784 785 786
    /* 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.  */
787
    ptrdiff_t size;
788

789 790 791
    /* 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
792
       to the next vector-like object.  It is generally a buffer or a
793 794 795
       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).  */
796
    union {
797 798 799 800 801
      /* 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.  */
802
      ptrdiff_t nbytes;
803
      struct buffer *buffer;
804 805 806 807
      /* 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.  */
808 809 810 811
      struct Lisp_Vector *vector;
    } next;
  };

812 813
/* Regular vector is just a header plus array of Lisp_Objects.  */

814 815
struct Lisp_Vector
  {
816
    struct vectorlike_header header;
Jim Blandy's avatar
Jim Blandy committed
817 818 819
    Lisp_Object contents[1];
  };

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
/* 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
843
/* If a struct is made to look like a vector, this macro returns the length
844
   of the shortest vector that would hold that struct.  */
845 846 847

#define VECSIZE(type)						\
  ((sizeof (type) - header_size + word_size - 1) / word_size)
Karl Heuer's avatar
Karl Heuer committed
848

849 850 851
/* 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).  */
852 853 854

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

856
/* A char-table is a kind of vectorlike, with contents are like a
857
   vector but with a few other slots.  For some purposes, it makes
858
   sense to handle a char-table with type struct Lisp_Vector.  An
859 860
   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
861 862 863 864
   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.  */
865

866 867 868 869 870 871 872 873 874 875 876 877 878
#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; })
879

880 881 882 883 884 885 886 887 888 889 890 891 892
#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__ */

893 894
/* 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
895
   mathematical comparison; for example, UNSIGNED_CMP (0, <, -1)
896 897 898 899 900 901 902
   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))

903
/* Nonzero iff C is an ASCII character.  */
904
#define ASCII_CHAR_P(c) UNSIGNED_CMP (c, <, 0x80)
905

906
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
907
   characters.  Do not check validity of CT.  */
908 909
#define CHAR_TABLE_REF(CT, IDX)					\
  (ASCII_CHAR_P (IDX) ? CHAR_TABLE_REF_ASCII ((CT), (IDX))	\
910
   : char_table_ref ((CT), (IDX)))
911

Kenichi Handa's avatar
Kenichi Handa committed
912 913
/* Almost equivalent to Faref (CT, IDX).  However, if the result is
   not a character, return IDX.
914 915 916

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

920
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
Dave Love's avatar
Dave Love committed
921
   8-bit European characters.  Do not check validity of CT.  */
922
#define CHAR_TABLE_SET(CT, IDX, VAL)					\
923
  (ASCII_CHAR_P (IDX) && SUB_CHAR_TABLE_P (XCHAR_TABLE (CT)->ascii)	\
924
   ? set_sub_char_table_contents (XCHAR_TABLE (CT)->ascii, IDX, VAL)	\
925 926
   : char_table_set (CT, IDX, VAL))

927 928 929 930 931 932 933
enum CHARTAB_SIZE_BITS
  {
    CHARTAB_SIZE_BITS_0 = 6,
    CHARTAB_SIZE_BITS_1 = 4,
    CHARTAB_SIZE_BITS_2 = 5,
    CHARTAB_SIZE_BITS_3 = 7
  };
934 935 936

extern const int chartab_size[4];

937 938
struct Lisp_Char_Table
  {
939
    /* HEADER.SIZE is the vector's size field, which also holds the
940
       pseudovector type information.  It holds the size, too.
Miles Bader's avatar
Miles Bader committed
941 942
       The size counts the defalt, parent, purpose, ascii,
       contents, and extras slots.  */
943
    struct vectorlike_header header;
944

945 946 947
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
948

Kenichi Handa's avatar
Kenichi Handa committed
949 950 951
    /* 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.  */
952
    Lisp_Object parent;
953

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