lisp.h 148 KB
Newer Older
1
/* Fundamental definitions for GNU Emacs Lisp interpreter. -*- coding: utf-8 -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1993-1995, 1997-2017 Free Software Foundation,
4
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

Kenichi Handa's avatar
Kenichi Handa committed
21 22 23
#ifndef EMACS_LISP_H
#define EMACS_LISP_H

Paul Eggert's avatar
Paul Eggert committed
24
#include <alloca.h>
25
#include <setjmp.h>
26
#include <stdalign.h>
27
#include <stdarg.h>
28
#include <stddef.h>
Paul Eggert's avatar
Paul Eggert committed
29
#include <string.h>
30
#include <float.h>
31
#include <inttypes.h>
32
#include <limits.h>
33

34
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
35
#include <verify.h>
36

37 38
INLINE_HEADER_BEGIN

39 40 41
/* Define a TYPE constant ID as an externally visible name.  Use like this:

      DEFINE_GDB_SYMBOL_BEGIN (TYPE, ID)
42
      # define ID (some integer preprocessor expression of type TYPE)
43 44 45
      DEFINE_GDB_SYMBOL_END (ID)

   This hack is for the benefit of compilers that do not make macro
46 47
   definitions or enums visible to the debugger.  It's used for symbols
   that .gdbinit needs.  */
48

49
#define DECLARE_GDB_SYM(type, id) type const id EXTERNALLY_VISIBLE
50
#ifdef MAIN_PROGRAM
51
# define DEFINE_GDB_SYMBOL_BEGIN(type, id) DECLARE_GDB_SYM (type, id)
52 53
# define DEFINE_GDB_SYMBOL_END(id) = id;
#else
54 55
# define DEFINE_GDB_SYMBOL_BEGIN(type, id) extern DECLARE_GDB_SYM (type, id)
# define DEFINE_GDB_SYMBOL_END(val) ;
56 57
#endif

58 59 60 61 62
/* 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))
63

64 65
/* Number of elements in an array.  */
#define ARRAYELTS(arr) (sizeof (arr) / sizeof (arr)[0])
66

Paul Eggert's avatar
Paul Eggert committed
67 68 69 70 71
/* Number of bits in a Lisp_Object tag.  */
DEFINE_GDB_SYMBOL_BEGIN (int, GCTYPEBITS)
#define GCTYPEBITS 3
DEFINE_GDB_SYMBOL_END (GCTYPEBITS)

Paul Eggert's avatar
Paul Eggert committed
72
/* EMACS_INT - signed integer wide enough to hold an Emacs value
73
   EMACS_INT_WIDTH - width in bits of EMACS_INT
Paul Eggert's avatar
Paul Eggert committed
74 75 76
   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 */
77
#ifndef EMACS_INT_MAX
78 79
# if INTPTR_MAX <= 0
#  error "INTPTR_MAX misconfigured"
Paul Eggert's avatar
Paul Eggert committed
80
# elif INTPTR_MAX <= INT_MAX && !defined WIDE_EMACS_INT
81 82
typedef int EMACS_INT;
typedef unsigned int EMACS_UINT;
83
enum { EMACS_INT_WIDTH = INT_WIDTH };
84 85
#  define EMACS_INT_MAX INT_MAX
#  define pI ""
Paul Eggert's avatar
Paul Eggert committed
86
# elif INTPTR_MAX <= LONG_MAX && !defined WIDE_EMACS_INT
87
typedef long int EMACS_INT;
88
typedef unsigned long EMACS_UINT;
89
enum { EMACS_INT_WIDTH = LONG_WIDTH };
Paul Eggert's avatar
Paul Eggert committed
90
#  define EMACS_INT_MAX LONG_MAX
91
#  define pI "l"
92
# elif INTPTR_MAX <= LLONG_MAX
93 94
typedef long long int EMACS_INT;
typedef unsigned long long int EMACS_UINT;
95
enum { EMACS_INT_WIDTH = LLONG_WIDTH };
Paul Eggert's avatar
Paul Eggert committed
96
#  define EMACS_INT_MAX LLONG_MAX
97 98 99 100 101
#  ifdef __MINGW32__
#   define pI "I64"
#  else
#   define pI "ll"
#  endif
102
# else
103
#  error "INTPTR_MAX too large"
104
# endif
105
#endif
Paul Eggert's avatar
Paul Eggert committed
106

107 108 109 110 111 112 113
/* Number of bits to put in each character in the internal representation
   of bool vectors.  This should not vary across implementations.  */
enum {  BOOL_VECTOR_BITS_PER_CHAR =
#define BOOL_VECTOR_BITS_PER_CHAR 8
        BOOL_VECTOR_BITS_PER_CHAR
};

114
/* An unsigned integer type representing a fixed-length bit sequence,
Paul Eggert's avatar
Paul Eggert committed
115
   suitable for bool vector words, GC mark bits, etc.  Normally it is size_t
116 117
   for speed, but on weird platforms it is unsigned char and not all
   its bits are used.  */
118
#if BOOL_VECTOR_BITS_PER_CHAR == CHAR_BIT
119
typedef size_t bits_word;
120
# define BITS_WORD_MAX SIZE_MAX
121
enum { BITS_PER_BITS_WORD = SIZE_WIDTH };
122 123
#else
typedef unsigned char bits_word;
124
# define BITS_WORD_MAX ((1u << BOOL_VECTOR_BITS_PER_CHAR) - 1)
125 126
enum { BITS_PER_BITS_WORD = BOOL_VECTOR_BITS_PER_CHAR };
#endif
127
verify (BITS_WORD_MAX >> (BITS_PER_BITS_WORD - 1) == 1);
128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
/* 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

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/* 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

161
/* Extra internal type checking?  */
162

Paul Eggert's avatar
Paul Eggert committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
/* Define Emacs versions of <assert.h>'s 'assert (COND)' and <verify.h>'s
   'assume (COND)'.  COND should be free of side effects, as it may or
   may not be evaluated.

   'eassert (COND)' checks COND at runtime if ENABLE_CHECKING is
   defined and suppress_checking is false, and does nothing otherwise.
   Emacs dies if COND is checked and is false.  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
   eassert macro even if ENABLE_CHECKING is true, e.g., if XSTRING (x)
   uses eassert to test STRINGP (x), but a particular use of XSTRING
   is invoked only after testing that STRINGP (x) is true, making the
   test redundant.

   eassume is like eassert except that it also causes the compiler to
   assume that COND is true afterwards, regardless of whether runtime
   checking is enabled.  This can improve performance in some cases,
   though it can degrade performance in others.  It's often suboptimal
   for COND to call external functions or access volatile storage.  */

186
#ifndef ENABLE_CHECKING
187
# define eassert(cond) ((void) (false && (cond))) /* Check COND compiles.  */
Paul Eggert's avatar
Paul Eggert committed
188
# define eassume(cond) assume (cond)
189
#else /* ENABLE_CHECKING */
190

191
extern _Noreturn void die (const char *, const char *, int);
192

193
extern bool suppress_checking EXTERNALLY_VISIBLE;
194

195
# define eassert(cond)						\
196
   (suppress_checking || (cond) 				\
197
    ? (void) 0							\
198
    : die (# cond, __FILE__, __LINE__))
Paul Eggert's avatar
Paul Eggert committed
199 200 201 202 203 204
# define eassume(cond)						\
   (suppress_checking						\
    ? assume (cond)						\
    : (cond)							\
    ? (void) 0							\
    : die (# cond, __FILE__, __LINE__))
205
#endif /* ENABLE_CHECKING */
206

207

208 209 210
/* 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
211

212
/***** Select the tagging scheme.  *****/
213
/* The following option controls the tagging scheme:
214 215 216 217
   - 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.

218 219
   If ! USE_LSB_TAG, then use the top 3 bits for tagging, thus
   restricting our possible address range.
220 221 222

   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
Paul Eggert's avatar
Paul Eggert committed
223 224
   on the few static Lisp_Objects used: lispsym, all the defsubr, and
   the two special buffers buffer_defaults and buffer_local_symbols.  */
225

Paul Eggert's avatar
Paul Eggert committed
226 227
enum Lisp_Bits
  {
228 229
    /* 2**GCTYPEBITS.  This must be a macro that expands to a literal
       integer constant, for MSVC.  */
230
#define GCALIGNMENT 8
231

Paul Eggert's avatar
Paul Eggert committed
232
    /* Number of bits in a Lisp_Object value, not counting the tag.  */
233
    VALBITS = EMACS_INT_WIDTH - GCTYPEBITS,
234

Paul Eggert's avatar
Paul Eggert committed
235 236 237 238 239 240
    /* 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
241

242 243 244
#if GCALIGNMENT != 1 << GCTYPEBITS
# error "GCALIGNMENT and GCTYPEBITS are inconsistent"
#endif
Paul Eggert's avatar
Paul Eggert committed
245 246 247

/* 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.
248
   This can be used in #if, e.g., '#if USE_LSB_TAG' below expands to an
249
   expression involving VAL_MAX.  */
Paul Eggert's avatar
Paul Eggert committed
250
#define VAL_MAX (EMACS_INT_MAX >> (GCTYPEBITS - 1))
251

Paul Eggert's avatar
Paul Eggert committed
252
/* Whether the least-significant bits of an EMACS_INT contain the tag.
253
   On hosts where pointers-as-ints do not exceed VAL_MAX / 2, USE_LSB_TAG is:
254 255
    a. unnecessary, because the top bits of an EMACS_INT are unused, and
    b. slower, because it typically requires extra masking.
Paul Eggert's avatar
Paul Eggert committed
256 257
   So, USE_LSB_TAG is true only on hosts where it might be useful.  */
DEFINE_GDB_SYMBOL_BEGIN (bool, USE_LSB_TAG)
258
#define USE_LSB_TAG (VAL_MAX / 2 < INTPTR_MAX)
Paul Eggert's avatar
Paul Eggert committed
259 260
DEFINE_GDB_SYMBOL_END (USE_LSB_TAG)

261 262 263 264 265
/* Mask for the value (as opposed to the type bits) of a Lisp object.  */
DEFINE_GDB_SYMBOL_BEGIN (EMACS_INT, VALMASK)
# define VALMASK (USE_LSB_TAG ? - (1 << GCTYPEBITS) : VAL_MAX)
DEFINE_GDB_SYMBOL_END (VALMASK)

Paul Eggert's avatar
Paul Eggert committed
266 267 268 269
#if !USE_LSB_TAG && !defined WIDE_EMACS_INT
# error "USE_LSB_TAG not supported on this platform; please report this." \
	"Try 'configure --with-wide-int' to work around the problem."
error !;
270
#endif
271

272
#ifdef HAVE_STRUCT_ATTRIBUTE_ALIGNED
273
# define GCALIGNED __attribute__ ((aligned (GCALIGNMENT)))
274
#else
275
# define GCALIGNED /* empty */
276
#endif
277

278 279 280 281 282 283 284
/* Some operations are so commonly executed that they are implemented
   as macros, not functions, because otherwise runtime performance would
   suffer too much when compiling with GCC without optimization.
   There's no need to inline everything, just the operations that
   would otherwise cause a serious performance problem.

   For each such operation OP, define a macro lisp_h_OP that contains
Paul Eggert's avatar
Paul Eggert committed
285
   the operation's implementation.  That way, OP can be implemented
286 287 288 289 290 291 292 293 294 295 296 297 298 299
   via a macro definition like this:

     #define OP(x) lisp_h_OP (x)

   and/or via a function definition like this:

     Lisp_Object (OP) (Lisp_Object x) { return lisp_h_OP (x); }

   without worrying about the implementations diverging, since
   lisp_h_OP defines the actual implementation.  The lisp_h_OP macros
   are intended to be private to this include file, and should not be
   used elsewhere.

   FIXME: Remove the lisp_h_OP macros, and define just the inline OP
300 301
   functions, once "gcc -Og" (new to GCC 4.8) works well enough for
   Emacs developers.  Maybe in the year 2020.  See Bug#11935.
302 303

   Commentary for these macros can be found near their corresponding
304
   functions, below.  */
305 306 307 308 309 310 311 312 313 314

#if CHECK_LISP_OBJECT_TYPE
# define lisp_h_XLI(o) ((o).i)
# define lisp_h_XIL(i) ((Lisp_Object) { i })
#else
# define lisp_h_XLI(o) (o)
# define lisp_h_XIL(i) (i)
#endif
#define lisp_h_CHECK_NUMBER(x) CHECK_TYPE (INTEGERP (x), Qintegerp, x)
#define lisp_h_CHECK_SYMBOL(x) CHECK_TYPE (SYMBOLP (x), Qsymbolp, x)
315
#define lisp_h_CHECK_TYPE(ok, predicate, x) \
316
   ((ok) ? (void) 0 : wrong_type_argument (predicate, x))
317 318 319
#define lisp_h_CONSP(x) (XTYPE (x) == Lisp_Cons)
#define lisp_h_EQ(x, y) (XLI (x) == XLI (y))
#define lisp_h_FLOATP(x) (XTYPE (x) == Lisp_Float)
320
#define lisp_h_INTEGERP(x) ((XTYPE (x) & (Lisp_Int0 | ~Lisp_Int1)) == Lisp_Int0)
321 322 323 324 325
#define lisp_h_MARKERP(x) (MISCP (x) && XMISCTYPE (x) == Lisp_Misc_Marker)
#define lisp_h_MISCP(x) (XTYPE (x) == Lisp_Misc)
#define lisp_h_NILP(x) EQ (x, Qnil)
#define lisp_h_SET_SYMBOL_VAL(sym, v) \
   (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value = (v))
Noam Postavsky's avatar
Noam Postavsky committed
326 327
#define lisp_h_SYMBOL_CONSTANT_P(sym) (XSYMBOL (sym)->trapped_write == SYMBOL_NOWRITE)
#define lisp_h_SYMBOL_TRAPPED_WRITE_P(sym) (XSYMBOL (sym)->trapped_write)
328 329 330 331 332 333 334 335 336 337 338 339 340
#define lisp_h_SYMBOL_VAL(sym) \
   (eassert ((sym)->redirect == SYMBOL_PLAINVAL), (sym)->val.value)
#define lisp_h_SYMBOLP(x) (XTYPE (x) == Lisp_Symbol)
#define lisp_h_VECTORLIKEP(x) (XTYPE (x) == Lisp_Vectorlike)
#define lisp_h_XCAR(c) XCONS (c)->car
#define lisp_h_XCDR(c) XCONS (c)->u.cdr
#define lisp_h_XCONS(a) \
   (eassert (CONSP (a)), (struct Lisp_Cons *) XUNTAG (a, Lisp_Cons))
#define lisp_h_XHASH(a) XUINT (a)
#ifndef GC_CHECK_CONS_LIST
# define lisp_h_check_cons_list() ((void) 0)
#endif
#if USE_LSB_TAG
341
# define lisp_h_make_number(n) \
342
    XIL ((EMACS_INT) (((EMACS_UINT) (n) << INTTYPEBITS) + Lisp_Int0))
343 344
# define lisp_h_XFASTINT(a) XINT (a)
# define lisp_h_XINT(a) (XLI (a) >> INTTYPEBITS)
345 346
# define lisp_h_XSYMBOL(a) \
    (eassert (SYMBOLP (a)), \
347
     (struct Lisp_Symbol *) ((intptr_t) XLI (a) - Lisp_Symbol \
348
			     + (char *) lispsym))
349
# define lisp_h_XTYPE(a) ((enum Lisp_Type) (XLI (a) & ~VALMASK))
350 351 352
# define lisp_h_XUNTAG(a, type) \
    __builtin_assume_aligned ((void *) (intptr_t) (XLI (a) - (type)), \
			      GCALIGNMENT)
353 354 355 356
#endif

/* When compiling via gcc -O0, define the key operations as macros, as
   Emacs is too slow otherwise.  To disable this optimization, compile
357
   with -DINLINING=false.  */
358 359 360
#if (defined __NO_INLINE__ \
     && ! defined __OPTIMIZE__ && ! defined __OPTIMIZE_SIZE__ \
     && ! (defined INLINING && ! INLINING))
361 362 363 364 365 366
# define DEFINE_KEY_OPS_AS_MACROS true
#else
# define DEFINE_KEY_OPS_AS_MACROS false
#endif

#if DEFINE_KEY_OPS_AS_MACROS
367 368 369 370
# define XLI(o) lisp_h_XLI (o)
# define XIL(i) lisp_h_XIL (i)
# define CHECK_NUMBER(x) lisp_h_CHECK_NUMBER (x)
# define CHECK_SYMBOL(x) lisp_h_CHECK_SYMBOL (x)
371
# define CHECK_TYPE(ok, predicate, x) lisp_h_CHECK_TYPE (ok, predicate, x)
372 373 374 375 376 377 378 379 380
# define CONSP(x) lisp_h_CONSP (x)
# define EQ(x, y) lisp_h_EQ (x, y)
# define FLOATP(x) lisp_h_FLOATP (x)
# define INTEGERP(x) lisp_h_INTEGERP (x)
# define MARKERP(x) lisp_h_MARKERP (x)
# define MISCP(x) lisp_h_MISCP (x)
# define NILP(x) lisp_h_NILP (x)
# define SET_SYMBOL_VAL(sym, v) lisp_h_SET_SYMBOL_VAL (sym, v)
# define SYMBOL_CONSTANT_P(sym) lisp_h_SYMBOL_CONSTANT_P (sym)
Noam Postavsky's avatar
Noam Postavsky committed
381
# define SYMBOL_TRAPPED_WRITE_P(sym) lisp_h_SYMBOL_TRAPPED_WRITE_P (sym)
382 383 384 385 386 387 388 389 390 391 392 393 394 395
# define SYMBOL_VAL(sym) lisp_h_SYMBOL_VAL (sym)
# define SYMBOLP(x) lisp_h_SYMBOLP (x)
# define VECTORLIKEP(x) lisp_h_VECTORLIKEP (x)
# define XCAR(c) lisp_h_XCAR (c)
# define XCDR(c) lisp_h_XCDR (c)
# define XCONS(a) lisp_h_XCONS (a)
# define XHASH(a) lisp_h_XHASH (a)
# ifndef GC_CHECK_CONS_LIST
#  define check_cons_list() lisp_h_check_cons_list ()
# endif
# if USE_LSB_TAG
#  define make_number(n) lisp_h_make_number (n)
#  define XFASTINT(a) lisp_h_XFASTINT (a)
#  define XINT(a) lisp_h_XINT (a)
396
#  define XSYMBOL(a) lisp_h_XSYMBOL (a)
397 398 399 400 401 402
#  define XTYPE(a) lisp_h_XTYPE (a)
#  define XUNTAG(a, type) lisp_h_XUNTAG (a, type)
# endif
#endif


403
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
404

405 406 407
/* 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
408

409 410
/* 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.  */
Paul Eggert's avatar
Paul Eggert committed
411
#define INTMASK (EMACS_INT_MAX >> (INTTYPEBITS - 1))
412
#define case_Lisp_Int case Lisp_Int0: case Lisp_Int1
413

Paul Eggert's avatar
Paul Eggert committed
414
/* Idea stolen from GDB.  Pedantic GCC complains about enum bitfields,
Paul Eggert's avatar
Paul Eggert committed
415 416 417 418
   MSVC doesn't support them, and xlc and Oracle Studio c99 complain
   vociferously about them.  */
#if (defined __STRICT_ANSI__ || defined _MSC_VER || defined __IBMC__ \
     || (defined __SUNPRO_C && __STDC__))
419 420 421 422 423 424
#define ENUM_BF(TYPE) unsigned int
#else
#define ENUM_BF(TYPE) enum TYPE
#endif


Jim Blandy's avatar
Jim Blandy committed
425 426
enum Lisp_Type
  {
427
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Paul Eggert's avatar
Paul Eggert committed
428
    Lisp_Symbol = 0,
Jim Blandy's avatar
Jim Blandy committed
429

430 431
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
Paul Eggert's avatar
Paul Eggert committed
432 433 434 435 436
    Lisp_Misc = 1,

    /* Integer.  XINT (obj) is the integer value.  */
    Lisp_Int0 = 2,
    Lisp_Int1 = USE_LSB_TAG ? 6 : 3,
Jim Blandy's avatar
Jim Blandy committed
437 438

    /* String.  XSTRING (object) points to a struct Lisp_String.
439
       The length of the string, and its contents, are stored therein.  */
Paul Eggert's avatar
Paul Eggert committed
440
    Lisp_String = 4,
Jim Blandy's avatar
Jim Blandy committed
441

442
    /* Vector of Lisp objects, or something resembling it.
443
       XVECTOR (object) points to a struct Lisp_Vector, which contains
444 445
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
446
    Lisp_Vectorlike = 5,
Jim Blandy's avatar
Jim Blandy committed
447

448
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Paul Eggert's avatar
Paul Eggert committed
449
    Lisp_Cons = USE_LSB_TAG ? 3 : 6,
450

Paul Eggert's avatar
Paul Eggert committed
451
    Lisp_Float = 7
Jim Blandy's avatar
Jim Blandy committed
452 453
  };

454
/* This is the set of data types that share a common structure.
455 456 457 458
   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
459 460
enum Lisp_Misc_Type
  {
461
    Lisp_Misc_Free = 0x5eab,
462
    Lisp_Misc_Marker,
463
    Lisp_Misc_Overlay,
464
    Lisp_Misc_Save_Value,
Daniel Colascione's avatar
Daniel Colascione committed
465
    Lisp_Misc_Finalizer,
466 467 468
#ifdef HAVE_MODULES
    Lisp_Misc_User_Ptr,
#endif
469 470 471 472 473
    /* 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
474 475
  };

476 477 478 479 480 481 482 483 484
/* 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.  */
Paul Eggert's avatar
Paul Eggert committed
485
    Lisp_Fwd_Kboard_Obj		/* Fwd to a Lisp_Object field of kboards.  */
486 487
  };

488 489 490 491 492 493 494 495
/* 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
Paul Eggert's avatar
Paul Eggert committed
496
   subtype; and PVEC_OTHER, a kind of vectorlike object.  The former
497
   is suitable for temporarily stashing away pointers and integers in
498
   a Lisp object.  The latter is useful for vector-like Lisp objects
499 500 501 502 503 504 505 506 507 508
   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,
Paul Eggert's avatar
Paul Eggert committed
509
   while Lisp_Misc types are for everything else.  A pseudovector object
510 511 512 513
   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.

514 515 516 517
   Explicit freeing is discouraged for Lisp objects in general.  But if
   you really need to exploit this, use Lisp_Misc (check free_misc in
   alloc.c to see why).  There is no way to free a vectorlike object.

518 519 520 521 522 523 524 525 526
   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.

527 528 529 530
   For a new pseudovector, it's highly desirable to limit the size
   of your data type by VBLOCK_BYTES_MAX bytes (defined in alloc.c).
   Otherwise you will need to change sweep_vectors (also in alloc.c).

531 532 533 534 535 536 537 538 539 540 541
   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.  */

542
#ifdef CHECK_LISP_OBJECT_TYPE
Jim Blandy's avatar
Jim Blandy committed
543

544
typedef struct { EMACS_INT i; } Lisp_Object;
Jim Blandy's avatar
Jim Blandy committed
545

546
#define LISP_INITIALLY(i) {i}
Jim Blandy's avatar
Jim Blandy committed
547

Paul Eggert's avatar
Paul Eggert committed
548
#undef CHECK_LISP_OBJECT_TYPE
549
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = true };
550
#else /* CHECK_LISP_OBJECT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
551

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

554
typedef EMACS_INT Lisp_Object;
555
#define LISP_INITIALLY(i) (i)
556
enum CHECK_LISP_OBJECT_TYPE { CHECK_LISP_OBJECT_TYPE = false };
557
#endif /* CHECK_LISP_OBJECT_TYPE */
558 559

/* Forward declarations.  */
Jim Blandy's avatar
Jim Blandy committed
560

561 562 563 564 565 566 567
/* Defined in this file.  */
INLINE void set_sub_char_table_contents (Lisp_Object, ptrdiff_t,
					      Lisp_Object);

/* Defined in chartab.c.  */
extern Lisp_Object char_table_ref (Lisp_Object, int);
extern void char_table_set (Lisp_Object, int, Lisp_Object);
Jim Blandy's avatar
Jim Blandy committed
568

569
/* Defined in data.c.  */
570
extern _Noreturn void wrong_type_argument (Lisp_Object, Lisp_Object);
Noam Postavsky's avatar
Noam Postavsky committed
571

572

Paul Eggert's avatar
Paul Eggert committed
573 574 575
#ifdef CANNOT_DUMP
enum { might_dump = false };
#elif defined DOUG_LEA_MALLOC
576 577
/* Defined in emacs.c.  */
extern bool might_dump;
578
#endif
579 580 581 582
/* True means Emacs has already been initialized.
   Used during startup to detect startup of dumped Emacs.  */
extern bool initialized;

583 584
extern bool generating_ldefs_boot;

585 586 587
/* Defined in floatfns.c.  */
extern double extract_float (Lisp_Object);

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

/* Low-level conversion and type checking.  */

/* Convert a Lisp_Object to the corresponding EMACS_INT and vice versa.
   At the machine level, these operations are no-ops.  */

INLINE EMACS_INT
(XLI) (Lisp_Object o)
{
  return lisp_h_XLI (o);
}

INLINE Lisp_Object
(XIL) (EMACS_INT i)
{
  return lisp_h_XIL (i);
}

/* Extract A's type.  */

INLINE enum Lisp_Type
(XTYPE) (Lisp_Object a)
{
#if USE_LSB_TAG
  return lisp_h_XTYPE (a);
#else
  EMACS_UINT i = XLI (a);
  return USE_LSB_TAG ? i & ~VALMASK : i >> VALBITS;
#endif
}

INLINE void
(CHECK_TYPE) (int ok, Lisp_Object predicate, Lisp_Object x)
{
  lisp_h_CHECK_TYPE (ok, predicate, x);
}

/* Extract A's pointer value, assuming A's type is TYPE.  */

INLINE void *
(XUNTAG) (Lisp_Object a, int type)
{
#if USE_LSB_TAG
  return lisp_h_XUNTAG (a, type);
#else
  intptr_t i = USE_LSB_TAG ? XLI (a) - type : XLI (a) & VALMASK;
  return (void *) i;
#endif
}

638 639

/* Interned state of a symbol.  */
640

641 642 643 644 645 646
enum symbol_interned
{
  SYMBOL_UNINTERNED = 0,
  SYMBOL_INTERNED = 1,
  SYMBOL_INTERNED_IN_INITIAL_OBARRAY = 2
};
647

648 649 650 651 652 653 654 655
enum symbol_redirect
{
  SYMBOL_PLAINVAL  = 4,
  SYMBOL_VARALIAS  = 1,
  SYMBOL_LOCALIZED = 2,
  SYMBOL_FORWARDED = 3
};

Noam Postavsky's avatar
Noam Postavsky committed
656 657 658 659 660 661 662
enum symbol_trapped_write
{
  SYMBOL_UNTRAPPED_WRITE = 0,
  SYMBOL_NOWRITE = 1,
  SYMBOL_TRAPPED_WRITE = 2
};

663 664 665 666 667 668 669 670 671 672 673
struct Lisp_Symbol
{
  bool_bf gcmarkbit : 1;

  /* Indicates where the value can be found:
     0 : it's a plain var, the value is in the `value' field.
     1 : it's a varalias, the value is really in the `alias' symbol.
     2 : it's a localized var, the value is in the `blv' object.
     3 : it's a forwarding variable, the value is in `forward'.  */
  ENUM_BF (symbol_redirect) redirect : 3;

Noam Postavsky's avatar
Noam Postavsky committed
674 675 676 677
  /* 0 : normal case, just set the value
     1 : constant, cannot set, e.g. nil, t, :keywords.
     2 : trap the write, call watcher functions.  */
  ENUM_BF (symbol_trapped_write) trapped_write : 2;
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

  /* Interned state of the symbol.  This is an enumerator from
     enum symbol_interned.  */
  unsigned interned : 2;

  /* True means that this variable has been explicitly declared
     special (with `defvar' etc), and shouldn't be lexically bound.  */
  bool_bf declared_special : 1;

  /* True if pointed to from purespace and hence can't be GC'd.  */
  bool_bf pinned : 1;

  /* The symbol's name, as a Lisp string.  */
  Lisp_Object name;

  /* Value of the symbol or Qunbound if unbound.  Which alternative of the
     union is used depends on the `redirect' field above.  */
  union {
    Lisp_Object value;
    struct Lisp_Symbol *alias;
    struct Lisp_Buffer_Local_Value *blv;
    union Lisp_Fwd *fwd;
  } val;

  /* Function value of the symbol or Qnil if not fboundp.  */
  Lisp_Object function;

  /* The symbol's property list.  */
  Lisp_Object plist;

  /* Next symbol in obarray bucket, if the symbol is interned.  */
  struct Lisp_Symbol *next;
};

/* Declare a Lisp-callable function.  The MAXARGS parameter has the same
   meaning as in the DEFUN macro, and is used to construct a prototype.  */
/* We can use the same trick as in the DEFUN macro to generate the
   appropriate prototype.  */
#define EXFUN(fnname, maxargs) \
  extern Lisp_Object fnname DEFUN_ARGS_ ## maxargs

/* Note that the weird token-substitution semantics of ANSI C makes
   this work for MANY and UNEVALLED.  */
#define DEFUN_ARGS_MANY		(ptrdiff_t, Lisp_Object *)
#define DEFUN_ARGS_UNEVALLED	(Lisp_Object)
#define DEFUN_ARGS_0	(void)
#define DEFUN_ARGS_1	(Lisp_Object)
#define DEFUN_ARGS_2	(Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_3	(Lisp_Object, Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_4	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_5	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object)
#define DEFUN_ARGS_6	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_7	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object, Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_8	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)

737 738 739 740 741
/* Yield a signed integer that contains TAG along with PTR.

   Sign-extend pointers when USE_LSB_TAG (this simplifies emacs-module.c),
   and zero-extend otherwise (that’s a bit faster here).
   Sign extension matters only when EMACS_INT is wider than a pointer.  */
742
#define TAG_PTR(tag, ptr) \
743 744 745
  (USE_LSB_TAG \
   ? (intptr_t) (ptr) + (tag) \
   : (EMACS_INT) (((EMACS_UINT) (tag) << VALBITS) + (uintptr_t) (ptr)))
746

Paul Eggert's avatar
Paul Eggert committed
747 748
/* Yield an integer that contains a symbol tag along with OFFSET.
   OFFSET should be the offset in bytes from 'lispsym' to the symbol.  */
749
#define TAG_SYMOFFSET(offset) TAG_PTR (Lisp_Symbol, offset)
Paul Eggert's avatar
Paul Eggert committed
750

751 752 753 754 755
/* XLI_BUILTIN_LISPSYM (iQwhatever) is equivalent to
   XLI (builtin_lisp_symbol (Qwhatever)),
   except the former expands to an integer constant expression.  */
#define XLI_BUILTIN_LISPSYM(iname) TAG_SYMOFFSET ((iname) * sizeof *lispsym)

756 757 758 759
/* LISPSYM_INITIALLY (Qfoo) is equivalent to Qfoo except it is
   designed for use as an initializer, even for a constant initializer.  */
#define LISPSYM_INITIALLY(name) LISP_INITIALLY (XLI_BUILTIN_LISPSYM (i##name))

760 761
/* Declare extern constants for Lisp symbols.  These can be helpful
   when using a debugger like GDB, on older platforms where the debug
Paul Eggert's avatar
Paul Eggert committed
762
   format does not represent C macros.  */
763 764
#define DEFINE_LISP_SYMBOL(name) \
  DEFINE_GDB_SYMBOL_BEGIN (Lisp_Object, name) \
765
  DEFINE_GDB_SYMBOL_END (LISPSYM_INITIALLY (name))
766

767 768 769 770
/* The index of the C-defined Lisp symbol SYM.
   This can be used in a static initializer.  */
#define SYMBOL_INDEX(sym) i##sym

771 772
/* By default, define macros for Qt, etc., as this leads to a bit
   better performance in the core Emacs interpreter.  A plugin can
Paul Eggert's avatar
Paul Eggert committed
773
   define DEFINE_NON_NIL_Q_SYMBOL_MACROS to be false, to be portable to
774
   other Emacs instances that assign different values to Qt, etc.  */
Paul Eggert's avatar
Paul Eggert committed
775 776
#ifndef DEFINE_NON_NIL_Q_SYMBOL_MACROS
# define DEFINE_NON_NIL_Q_SYMBOL_MACROS true
777 778
#endif

779
#include "globals.h"
780

Tom Tromey's avatar
Tom Tromey committed
781 782 783 784 785 786
/* Header of vector-like objects.  This documents the layout constraints on
   vectors and pseudovectors (objects of PVEC_xxx subtype).  It also prevents
   compilers from being fooled by Emacs's type punning: XSETPSEUDOVECTOR
   and PSEUDOVECTORP 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
Ken Raeburn's avatar
Ken Raeburn committed
787
   Bug#8546.  */
Tom Tromey's avatar
Tom Tromey committed
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
struct vectorlike_header
  {
    /* The only 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 three fields:
	 - a) pseudovector subtype held in PVEC_TYPE_MASK field;
	 - b) number of Lisp_Objects slots at the beginning of the object
	   held in PSEUDOVECTOR_SIZE_MASK field.  These objects are always
	   traced by the GC;
	 - c) size of the rest fields held in PSEUDOVECTOR_REST_MASK and
	   measured in word_size units.  Rest fields may also include
	   Lisp_Objects, but these objects usually needs some special treatment
	   during GC.
	 There are some exceptions.  For PVEC_FREE, b) is always zero.  For
	 PVEC_BOOL_VECTOR and PVEC_SUBR, both b) and c) are always zero.
	 Current layout limits the pseudovectors to 63 PVEC_xxx subtypes,
	 4095 Lisp_Objects in GC-ed area and 4095 word-sized other slots.  */
    ptrdiff_t size;
  };

812 813 814 815 816
INLINE bool
(SYMBOLP) (Lisp_Object x)
{
  return lisp_h_SYMBOLP (x);
}
Tom Tromey's avatar
Tom Tromey committed
817

818 819 820 821 822 823 824 825 826 827 828 829
INLINE struct Lisp_Symbol *
(XSYMBOL) (Lisp_Object a)
{
#if USE_LSB_TAG
  return lisp_h_XSYMBOL (a);
#else
  eassert (SYMBOLP (a));
  intptr_t i = (intptr_t) XUNTAG (a, Lisp_Symbol);
  void *p = (char *) lispsym + i;
  return p;
#endif
}
830

831 832
INLINE Lisp_Object
make_lisp_symbol (struct Lisp_Symbol *sym)
833
{
834 835 836
  Lisp_Object a = XIL (TAG_SYMOFFSET ((char *) sym - (char *) lispsym));
  eassert (XSYMBOL (a) == sym);
  return a;
837 838 839
}

INLINE Lisp_Object
840
builtin_lisp_symbol (int index)
841
{
842 843 844 845 846 847 848
  return make_lisp_symbol (lispsym + index);
}

INLINE void
(CHECK_SYMBOL) (Lisp_Object x)
{
 lisp_h_CHECK_SYMBOL (x);
849
}
850

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

853
DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, ARRAY_MARK_FLAG)
854
# define ARRAY_MARK_FLAG PTRDIFF_MIN
855
DEFINE_GDB_SYMBOL_END (ARRAY_MARK_FLAG)
856

857 858
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
859
DEFINE_GDB_SYMBOL_BEGIN (ptrdiff_t, PSEUDOVECTOR_FLAG)
860
# define PSEUDOVECTOR_FLAG (PTRDIFF_MAX - PTRDIFF_MAX / 2)
861
DEFINE_GDB_SYMBOL_END (PSEUDOVECTOR_FLAG)
862

863
/* In a pseudovector, the size field actually contains a word with one
864 865
   PSEUDOVECTOR_FLAG bit set, and one of the following values extracted
   with PVEC_TYPE_MASK to indicate the actual type.  */
866 867
enum pvec_type
{
868
  PVEC_NORMAL_VECTOR,
869 870 871 872 873 874 875 876 877 878 879
  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,
880 881
  PVEC_XWIDGET,
  PVEC_XWIDGET_VIEW,
882
  PVEC_THREAD,
883
  PVEC_MUTEX,
Tom Tromey's avatar
Tom Tromey committed
884
  PVEC_CONDVAR,
885

886 887 888 889 890
  /* These should be last, check internal_equal to see why.  */
  PVEC_COMPILED,
  PVEC_CHAR_TABLE,
  PVEC_SUB_CHAR_TABLE,
  PVEC_FONT /* Should be last because it's used for range checking.  */
891
};
892

Paul Eggert's avatar
Paul Eggert committed
893
enum More_Lisp_Bits
894
  {
Paul Eggert's avatar
Paul Eggert committed
895 896 897 898 899
    /* 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.  */
900
    PSEUDOVECTOR_SIZE_BITS = 12,
901
    PSEUDOVECTOR_SIZE_MASK = (1 << PSEUDOVECTOR_SIZE_BITS) - 1,
902 903 904 905

    /* To calculate the memory footprint of the pseudovector, it's useful
       to store the size of non-Lisp area in word_size units here.  */
    PSEUDOVECTOR_REST_BITS = 12,
906
    PSEUDOVECTOR_REST_MASK = (((1 << PSEUDOVECTOR_REST_BITS) - 1)
907 908 909 910
			      << PSEUDOVECTOR_SIZE_BITS),

    /* Used to extract pseudovector subtype information.  */
    PSEUDOVECTOR_AREA_BITS = PSEUDOVECTOR_SIZE_BITS + PSEUDOVECTOR_REST_BITS,
Paul Eggert's avatar
Paul Eggert committed
911
    PVEC_TYPE_MASK = 0x3f << PSEUDOVECTOR_AREA_BITS
Paul Eggert's avatar
Paul Eggert committed
912
  };
Jim Blandy's avatar
Jim Blandy committed
913

914
/* These functions extract various sorts of values from a Lisp_Object.
915 916 917
   For example, if tem is a Lisp_Object whose type is Lisp_Cons,
   XCONS (tem) is the struct Lisp_Cons * pointing to the memory for
   that cons.  */
Jim Blandy's avatar
Jim Blandy committed
918

919 920 921 922
/* Largest and smallest representable fixnum values.  These are the C
   values.  They are macros for use in static initializers.  */
#define MOST_POSITIVE_FIXNUM (EMACS_INT_MAX >> INTTYPEBITS)
#define MOST_NEGATIVE_FIXNUM (-1 - MOST_POSITIVE_FIXNUM)
Kenichi Handa's avatar
Kenichi Handa committed
923

924
#if USE_LSB_TAG
Kenichi Handa's avatar
Kenichi Handa committed
925

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
INLINE Lisp_Object
(make_number) (EMACS_INT n)
{
  return lisp_h_make_number (n);
}

INLINE EMACS_INT
(XINT) (Lisp_Object a)
{
  return lisp_h_XINT (a);
}

INLINE EMACS_INT
(XFASTINT) (Lisp_Object a)
{
941 942 943
  EMACS_INT n = lisp_h_XFASTINT (a);
  eassume (0 <= n);
  return n;
944 945
}

946
#else /* ! USE_LSB_TAG */
Jim Blandy's avatar
Jim Blandy committed
947

948 949 950
/* Although compiled only if ! USE_LSB_TAG, the following functions
   also work when USE_LSB_TAG; this is to aid future maintenance when
   the lisp_h_* macros are eventually removed.  */
Jim Blandy's avatar
Jim Blandy committed
951

952 953
/* Make a Lisp integer representing the value of the low order
   bits of N.  */
Paul Eggert's avatar
Paul Eggert committed
954
INLINE Lisp_Object
955 956
make_number (EMACS_INT n)
{
957
  EMACS_INT int0 = Lisp_Int0;
958 959 960 961
  if (USE_LSB_TAG)
    {
      EMACS_UINT u = n;
      n = u << INTTYPEBITS;
962
      n += int0;
963 964
    }
  else
965 966 967 968
    {
      n &= INTMASK;
      n += (int0 << VALBITS);
    }
969
  return XIL (n);
970
}
Jim Blandy's avatar
Jim Blandy committed
971

972
/* Extract A's value as a signed integer.  */
Paul Eggert's avatar
Paul Eggert committed
973
INLINE EMACS_INT
974 975 976
XINT (Lisp_Object a)
{
  EMACS_INT i = XLI (a);
977 978 979 980 981 982
  if (! USE_LSB_TAG)
    {
      EMACS_UINT u = i;
      i = u << INTTYPEBITS;
    }
  return i >> INTTYPEBITS;
983
}
Jim Blandy's avatar
Jim Blandy committed
984

985 986 987
/* Like XINT (A), but may be faster.  A must be nonnegative.
   If ! USE_LSB_TAG, this takes advantage of the fact that Lisp
   integers have zero-bits in their tags.  */
Paul Eggert's avatar
Paul Eggert committed
988
INLINE EMACS_INT
989 990
XFASTINT (Lisp_Object a)
{
991 992
  EMACS_INT int0 = Lisp_Int0;
  EMACS_INT n = USE_LSB_TAG ? XINT (a) : XLI (a) - (int0 << VALBITS);
993
  eassume (0 <= n);
994 995
  return n;
}
996

997
#endif /* ! USE_LSB_TAG */
998

999
/* Extract A's value as an unsigned integer.  */
Paul Eggert's avatar
Paul Eggert committed
1000
INLINE EMACS_UINT
1001 1002 1003 1004 1005
XUINT (Lisp_Object a)
{
  EMACS_UINT i = XLI (a);
  return USE_LSB_TAG ? i >> INTTYPEBITS : i & INTMASK;
}
1006

1007 1008 1009
/* Return A's (Lisp-integer sized) hash.  Happens to be like XUINT
   right now, but XUINT should only be applied to objects we know are
   integers.  */
1010 1011 1012 1013 1014 1015

INLINE EMACS_INT
(XHASH) (Lisp_Object a)
{
  return lisp_h_XHASH (a);
}