lisp.h 103 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985,86,87,93,94,95,97,98,1999,2000, 2001
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

Gerd Moellmann's avatar
Gerd Moellmann committed
22
/* Declare the prototype for a general external function.  */
23
#if defined (PROTOTYPES) || defined (WINDOWSNT)
Gerd Moellmann's avatar
Gerd Moellmann committed
24 25 26 27 28
#define P_(proto) proto
#else
#define P_(proto) ()
#endif

29 30 31 32 33 34
/* Define this temporarily to hunt a bug.  If defined, the size of
   strings is redundantly recorded in sdata structures so that it can
   be compared to the sizes recorded in Lisp strings.  */

#define GC_CHECK_STRING_BYTES 1

Jim Blandy's avatar
Jim Blandy committed
35

36
/* These are default choices for the types to use.  */
37 38 39 40 41 42 43 44 45
#ifdef _LP64
#ifndef EMACS_INT
#define EMACS_INT long
#define BITS_PER_EMACS_INT BITS_PER_LONG
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned long
#endif
#else /* not _LP64 */
46 47
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
48
#define BITS_PER_EMACS_INT BITS_PER_INT
49 50 51 52
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
53
#endif
54

55 56 57
/* Extra internal type checking?  */
extern int suppress_checking;
extern void die P_((const char *, const char *, int));
58 59 60 61

#ifdef ENABLE_CHECKING

#define CHECK(check,msg) ((check || suppress_checking		\
62
			   ? (void) 0				\
63 64 65 66 67 68
			   : die (msg, __FILE__, __LINE__)),	\
			  0)

/* Let's get some compile-time checking too.  */
#undef NO_UNION_TYPE

69
#else
70

71 72
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
73

74
#endif
75

76 77 78 79 80 81 82
/* Used for making sure that Emacs is compilable in all
   conigurations.  */

#ifdef USE_LISP_UNION_TYPE
#undef NO_UNION_TYPE
#endif

83 84
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
85 86 87
#ifndef ENABLE_CHECKING
#define eassert(X)	(void) 0
#else /* ENABLE_CHECKING */
88 89 90 91 92
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif
93
#endif /* ENABLE_CHECKING */
94

95
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
96

97
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
98 99 100

enum Lisp_Type
  {
101
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
102 103
    Lisp_Int,

104
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
105 106
    Lisp_Symbol,

107 108 109
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
110 111

    /* String.  XSTRING (object) points to a struct Lisp_String.
112
       The length of the string, and its contents, are stored therein.  */
Jim Blandy's avatar
Jim Blandy committed
113 114
    Lisp_String,

115
    /* Vector of Lisp objects, or something resembling it.
116
       XVECTOR (object) points to a struct Lisp_Vector, which contains
117 118 119
       the size and contents.  The size field also contains the type
       information, if it's not a real vector object.  */
    Lisp_Vectorlike,
Jim Blandy's avatar
Jim Blandy committed
120

121
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
122 123
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
124
    Lisp_Float,
125 126

    /* This is not a type code.  It is for range checking.  */
127
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
128 129
  };

130
/* This is the set of datatypes that share a common structure.
131 132 133 134
   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
135 136
enum Lisp_Misc_Type
  {
137
    Lisp_Misc_Free = 0x5eab,
138
    Lisp_Misc_Marker,
139 140 141
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
142 143
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
144
    Lisp_Misc_Some_Buffer_Local_Value,
145
    Lisp_Misc_Overlay,
146
    Lisp_Misc_Kboard_Objfwd,
147 148 149 150 151
    /* 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
152 153
  };

154 155
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
156
#define VALBITS (BITS_PER_EMACS_INT - 4)
157 158 159 160 161 162
#endif

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

163 164 165 166
#if 0  /* This doesn't work on some systems that don't allow enumerators
	  > INT_MAX, and it won't work for long long EMACS_INT.  These
	  values are now found in emacs.c as EMACS_INT variables.  */

Karl Heuer's avatar
Karl Heuer committed
167 168 169 170 171 172
/* Make these values available in GDB, which sees enums but not macros.  */

enum gdb_lisp_params
{
  gdb_valbits = VALBITS,
  gdb_gctypebits = GCTYPEBITS,
173
  gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
Karl Heuer's avatar
Karl Heuer committed
174 175 176 177 178 179 180
#ifdef DATA_SEG_BITS
  gdb_data_seg_bits = DATA_SEG_BITS
#else
  gdb_data_seg_bits = 0
#endif
};

181 182
#endif /* 0 */

Jim Blandy's avatar
Jim Blandy committed
183 184
#ifndef NO_UNION_TYPE

185
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
186 187 188 189 190 191 192

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
193
       also, positive integers can be accessed fast this way.  */
194
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
195 196 197

    struct
      {
198 199
	EMACS_INT val  : VALBITS;
	EMACS_INT type : GCTYPEBITS + 1;
Jim Blandy's avatar
Jim Blandy committed
200 201 202
      } s;
    struct
      {
203 204
	EMACS_UINT val : VALBITS;
	EMACS_INT type : GCTYPEBITS + 1;
Jim Blandy's avatar
Jim Blandy committed
205 206 207
      } u;
    struct
      {
208 209
	EMACS_UINT val		: VALBITS;
	enum Lisp_Type type	: GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
210 211
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
212
	EMACS_UINT markbit	: 1;
Jim Blandy's avatar
Jim Blandy committed
213 214 215 216
      } gu;
  }
Lisp_Object;

217
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
218 219 220 221 222

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
223
       also, positive integers can be accessed fast this way.  */
224
    EMACS_INT i;
Jim Blandy's avatar
Jim Blandy committed
225 226 227

    struct
      {
228 229
	EMACS_INT type : GCTYPEBITS+1;
	EMACS_INT val  : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
230 231 232
      } s;
    struct
      {
233 234
	EMACS_INT type : GCTYPEBITS+1;
	EMACS_UINT val : VALBITS;
Jim Blandy's avatar
Jim Blandy committed
235 236 237 238 239
      } u;
    struct
      {
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
240 241 242
	EMACS_UINT markbit	: 1;
	enum Lisp_Type type	: GCTYPEBITS;
	EMACS_UINT val		: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246
      } gu;
  }
Lisp_Object;

247
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251

#endif /* NO_UNION_TYPE */


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

#ifdef NO_UNION_TYPE
255
#define Lisp_Object EMACS_INT
256
#endif /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
257 258

#ifndef VALMASK
259
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
260
#endif
261
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
262 263 264 265 266 267 268 269 270 271 272 273 274

/* Two flags that are set during GC.  On some machines, these flags
   are defined differently by the m- file.  */

/* This is set in the car of a cons and in the plist slot of a symbol
   to indicate it is marked.  Likewise in the plist slot of an interval,
   the chain slot of a marker, the type slot of a float, and the name
   slot of a buffer.

   In strings, this bit in the size field indicates that the string
   is a "large" one, one which was separately malloc'd
   rather than being part of a string block.  */

275
#ifndef MARKBIT
276
#define MARKBIT ((EMACS_INT) ((EMACS_UINT) 1 << (VALBITS + GCTYPEBITS)))
277
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
278

279 280 281 282 283 284 285
/* In the size word of a vector, this bit means the vector has been marked.
   In the size word of a large string, likewise.  */

#ifndef ARRAY_MARK_FLAG
#define ARRAY_MARK_FLAG ((MARKBIT >> 1) & ~MARKBIT)
#endif /* no ARRAY_MARK_FLAG */

286 287 288 289 290 291
/* In the size word of a struct Lisp_Vector, this bit means it's really
   some other vector-like object.  */
#ifndef PSEUDOVECTOR_FLAG
#define PSEUDOVECTOR_FLAG ((ARRAY_MARK_FLAG >> 1) & ~ARRAY_MARK_FLAG)
#endif

292
/* In a pseudovector, the size field actually contains a word with one
293 294
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
295 296 297 298 299 300 301 302 303
enum pvec_type
{
  PVEC_NORMAL_VECTOR = 0,
  PVEC_PROCESS = 0x200,
  PVEC_FRAME = 0x400,
  PVEC_COMPILED = 0x800,
  PVEC_WINDOW = 0x1000,
  PVEC_WINDOW_CONFIGURATION = 0x2000,
  PVEC_SUBR = 0x4000,
304 305 306
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
307
  PVEC_HASH_TABLE = 0x40000,
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310 311 312
  PVEC_TYPE_MASK = 0x7fe00
  
#if 0 /* This is used to make the value of PSEUDOVECTOR_FLAG available to
	 GDB.  It doesn't work on OS Alpha.  Moved to a variable in
	 emacs.c.  */
313
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
314
#endif
315
};
316 317

/* For convenience, we also store the number of elements in these bits.  */
318
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
Jim Blandy's avatar
Jim Blandy committed
319 320 321

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
322
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328 329 330 331 332 333 334

#ifdef NO_UNION_TYPE

/* One need to override this if there must be high bits set in data space
   (doing the result of the below & ((1 << (GCTYPE + 1)) - 1) would work
    on all machines, but would penalise machines which don't need it)
 */
#ifndef XTYPE
#define XTYPE(a) ((enum Lisp_Type) ((a) >> VALBITS))
#endif

#ifndef XSETTYPE
335
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
336 337
#endif

Karl Heuer's avatar
Karl Heuer committed
338 339 340
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
   fact that Lisp_Int is 0.  */
341
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
342
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346

/* Extract the value of a Lisp_Object as a signed integer.  */

#ifndef XINT   /* Some machines need to do this differently.  */
347 348
#define XINT(a) ((EMACS_INT) (((a) << (BITS_PER_EMACS_INT - VALBITS)) \
			      >> (BITS_PER_EMACS_INT - VALBITS)))
Jim Blandy's avatar
Jim Blandy committed
349 350 351 352 353 354
#endif

/* Extract the value as an unsigned integer.  This is a basis
   for extracting it as a pointer to a structure in storage.  */

#ifndef XUINT
355
#define XUINT(a) ((EMACS_UINT) ((a) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
356 357 358 359 360
#endif

#ifndef XPNTR
#ifdef HAVE_SHM
/* In this representation, data is found in two widely separated segments.  */
Jim Blandy's avatar
Jim Blandy committed
361
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
362
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
363
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
#else /* not HAVE_SHM */
#ifdef DATA_SEG_BITS
/* This case is used for the rt-pc.
   In the diffs I was given, it checked for ptr = 0
   and did not adjust it in that case.
   But I don't think that zero should ever be found
   in a Lisp object whose data type says it points to something.  */
#define XPNTR(a) (XUINT (a) | DATA_SEG_BITS)
#else
#define XPNTR(a) XUINT (a)
#endif
#endif /* not HAVE_SHM */
#endif /* no XPNTR */

#ifndef XSET
#define XSET(var, type, ptr) \
380
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
381 382
#endif

383 384 385 386 387
/* Convert a C integer into a Lisp_Object integer.  */

#define make_number(N)		\
  ((((EMACS_INT) (N)) & VALMASK) | ((EMACS_INT) Lisp_Int) << VALBITS)

Jim Blandy's avatar
Jim Blandy committed
388 389 390 391 392 393 394 395 396 397
/* During garbage collection, XGCTYPE must be used for extracting types
 so that the mark bit is ignored.  XMARKBIT accesses the markbit.
 Markbits are used only in particular slots of particular structure types.
 Other markbits are always zero.
 Outside of garbage collection, all mark bits are always zero.  */

#ifndef XGCTYPE
#define XGCTYPE(a) ((enum Lisp_Type) (((a) >> VALBITS) & GCTYPEMASK))
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
398
#if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/* Make XMARKBIT faster if mark bit is sign bit.  */
#ifndef XMARKBIT
#define XMARKBIT(a) ((a) < 0)
#endif
#endif /* markbit is sign bit */

#ifndef XMARKBIT
#define XMARKBIT(a) ((a) & MARKBIT)
#endif

#ifndef XSETMARKBIT
#define XSETMARKBIT(a,b) ((a) = ((a) & ~MARKBIT) | ((b) ? MARKBIT : 0))
#endif

#ifndef XMARK
#define XMARK(a) ((a) |= MARKBIT)
#endif

#ifndef XUNMARK
#define XUNMARK(a) ((a) &= ~MARKBIT)
#endif

#endif /* NO_UNION_TYPE */

#ifndef NO_UNION_TYPE

#define XTYPE(a) ((enum Lisp_Type) (a).u.type)
#define XSETTYPE(a, b) ((a).u.type = (char) (b))

Karl Heuer's avatar
Karl Heuer committed
428 429 430
/* For integers known to be positive, XFASTINT provides fast retrieval
   and XSETFASTINT provides fast storage.  This takes advantage of the
   fact that Lisp_Int is 0.  */
431
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
432
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
433 434 435

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
436 437
#define XINT(a) (((a).i << (BITS_PER_EMACS_INT - VALBITS)) \
		 >> (BITS_PER_EMACS_INT - VALBITS))
Jim Blandy's avatar
Jim Blandy committed
438 439 440 441 442 443 444 445
#else
#define XINT(a) ((a).s.val)
#endif /* EXPLICIT_SIGN_EXTEND */

#define XUINT(a) ((a).u.val)
#define XPNTR(a) ((a).u.val)

#define XSET(var, vartype, ptr) \
446
   (((var).s.val = ((EMACS_INT) (ptr))), ((var).s.type = ((char) (vartype))))
Jim Blandy's avatar
Jim Blandy committed
447

448 449 450 451
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
452
extern Lisp_Object make_number ();
453
#endif
454

Jim Blandy's avatar
Jim Blandy committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468
/* During garbage collection, XGCTYPE must be used for extracting types
 so that the mark bit is ignored.  XMARKBIT access the markbit.
 Markbits are used only in particular slots of particular structure types.
 Other markbits are always zero.
 Outside of garbage collection, all mark bits are always zero.  */

#define XGCTYPE(a) ((a).gu.type)
#define XMARKBIT(a) ((a).gu.markbit)
#define XSETMARKBIT(a,b) (XMARKBIT(a) = (b))
#define XMARK(a) (XMARKBIT(a) = 1)
#define XUNMARK(a) (XMARKBIT(a) = 0)

#endif /* NO_UNION_TYPE */

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

471
#define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
Jim Blandy's avatar
Jim Blandy committed
472
#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
473 474 475
#define XSTRING(a) (eassert (GC_STRINGP(a)),(struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) (eassert (GC_SYMBOLP(a)),(struct Lisp_Symbol *) XPNTR(a))
#define XFLOAT(a) (eassert (GC_FLOATP(a)),(struct Lisp_Float *) XPNTR(a))
476 477

/* Misc types.  */
478

479
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Richard M. Stallman's avatar
Richard M. Stallman committed
480
#define XMISCTYPE(a)   (XMARKER (a)->type)
481
#define XMARKER(a) (&(XMISC(a)->u_marker))
482 483 484 485
#define XINTFWD(a) (&(XMISC(a)->u_intfwd))
#define XBOOLFWD(a) (&(XMISC(a)->u_boolfwd))
#define XOBJFWD(a) (&(XMISC(a)->u_objfwd))
#define XBUFFER_OBJFWD(a) (&(XMISC(a)->u_buffer_objfwd))
486
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
487
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
488
#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
489

490
/* Pseudovector types.  */
491

492 493 494 495
#define XPROCESS(a) (eassert (GC_PROCESSP(a)),(struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) (eassert (GC_WINDOWP(a)),(struct window *) XPNTR(a))
#define XSUBR(a) (eassert (GC_SUBRP(a)),(struct Lisp_Subr *) XPNTR(a))
#define XBUFFER(a) (eassert (GC_BUFFERP(a)),(struct buffer *) XPNTR(a))
496 497
#define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
498 499

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

501 502
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
503
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
504 505 506
#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)
507 508

/* Misc types.  */
509

510
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
511
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
512 513

/* Pseudovector types.  */
514

515 516 517 518 519 520 521 522
#define XSETPSEUDOVECTOR(a, b, code) \
  (XSETVECTOR (a, b), XVECTOR (a)->size |= PSEUDOVECTOR_FLAG | (code))
#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))
#define XSETSUBR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_SUBR))
#define XSETCOMPILED(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_COMPILED))
523
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
524 525
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
526 527 528 529 530 531 532

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

#define AREF(ARRAY, IDX)	XVECTOR ((ARRAY))->contents[IDX]
#define ASET(ARRAY, IDX, VAL)	(AREF ((ARRAY), (IDX)) = (VAL))
#define ASIZE(ARRAY)		XVECTOR ((ARRAY))->size

Jim Blandy's avatar
Jim Blandy committed
533

534
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
535 536 537

struct interval
{
538
  /* The first group of entries deal with the tree structure.  */
539

540 541
  unsigned int total_length;	/* Length of myself and both children.  */
  unsigned int position;	/* Cache of interval's character position.  */
542 543 544 545 546
				/* This field is usually updated
				   simultaneously with an interval
				   traversal, there is no guaranty
				   that it is valid for a random
				   interval.  */
547 548
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */
549 550 551 552 553 554 555 556 557 558 559

  /* Parent in the tree, or the Lisp_Object containing this interval tree.

     The mark bit on the root interval of an interval tree says
     whether we have started (and possibly finished) marking the
     tree.  If GC comes across an interval tree whose root's parent
     field has its markbit set, it leaves the tree alone.

     You'd think we could store this information in the parent object
     somewhere (after all, that should be visited once and then
     ignored too, right?), but strings are GC'd strangely.  */
560 561 562 563 564 565
  union
  {
    struct interval *interval;
    Lisp_Object obj;
  } up;
  unsigned int up_obj : 1;
566 567 568

  /* The remaining components are `properties' of the interval.
     The first four are duplicates for things which can be on the list,
569
     for purposes of speed.  */
570

571 572 573
  unsigned int write_protect : 1;    /* Non-zero means can't modify.  */
  unsigned int visible : 1;	    /* Zero means don't display.  */
  unsigned int front_sticky : 1;    /* Non-zero means text inserted just
574
				       before this interval goes into it.  */
575
  unsigned int rear_sticky : 1;	    /* Likewise for just after it.  */
576

577 578 579 580 581
  /* Properties of this interval.
     The mark bit on this field says whether this particular interval
     tree node has been visited.  Since intervals should never be
     shared, GC aborts if it seems to have visited an interval twice.  */
  Lisp_Object plist;
582 583 584 585 586 587
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
588
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
589 590
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

Jim Blandy's avatar
Jim Blandy committed
591 592 593 594
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
595 596 597 598 599
    /* Please do not use the names of these elements in code other
       than the core lisp implementation.  Use XCAR and XCDR below.  */
#ifdef HIDE_LISP_IMPLEMENTATION
    Lisp_Object car_, cdr_;
#else
Jim Blandy's avatar
Jim Blandy committed
600
    Lisp_Object car, cdr;
601
#endif
Jim Blandy's avatar
Jim Blandy committed
602 603
  };

604
/* Take the car or cdr of something known to be a cons cell.  */
605 606 607 608
#ifdef HIDE_LISP_IMPLEMENTATION
#define XCAR(c) (XCONS ((c))->car_)
#define XCDR(c) (XCONS ((c))->cdr_)
#else
609 610
#define XCAR(c) (XCONS ((c))->car)
#define XCDR(c) (XCONS ((c))->cdr)
611
#endif
612 613 614 615 616 617 618 619 620 621 622 623

/* Take the car or cdr of something whose type is not known.  */
#define CAR(c)					\
 (CONSP ((c)) ? XCAR ((c))			\
  : NILP ((c)) ? Qnil				\
  : wrong_type_argument (Qlistp, (c)))

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

Kenichi Handa's avatar
Kenichi Handa committed
624 625 626 627 628
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
629 630 631 632 633 634 635 636 637

#ifdef GC_CHECK_STRING_BYTES

struct Lisp_String;
extern int string_bytes P_ ((struct Lisp_String *));
#define STRING_BYTES(S) string_bytes ((S))

#else /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
638 639 640
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

641 642
#endif /* not GC_CHECK_STRING_BYTES */

Kenichi Handa's avatar
Kenichi Handa committed
643 644 645
/* Set the length in bytes of STR.  */
#define SET_STRING_BYTES(STR, SIZE)  ((STR)->size_byte = (SIZE))

Jim Blandy's avatar
Jim Blandy committed
646 647 648 649
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
650
    EMACS_INT size;
651
    EMACS_INT size_byte;
652
    INTERVAL intervals;		/* text properties in this string */
653
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
654 655
  };

Karl Heuer's avatar
Karl Heuer committed
656
/* If a struct is made to look like a vector, this macro returns the length
657 658 659 660
   of the shortest vector that would hold that struct.  */
#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector)  \
                                         - sizeof (Lisp_Object))      \
                        + sizeof(Lisp_Object) - 1) /* round up */     \
Karl Heuer's avatar
Karl Heuer committed
661 662
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
663 664
struct Lisp_Vector
  {
665
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
666 667 668 669
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

670 671 672 673 674 675 676 677 678 679
/* A char table is a kind of vectorlike, with contents are like a
   vector but with a few other slots.  For some purposes, it makes
   sense to handle a chartable with type struct Lisp_Vector.  An
   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
   group of characters of the same charsets or a specific character of
   a charset.  A sub char-table has the same structure as a char table
   except for that the former omits several slots at the tail.  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.  */
680

681 682
/* This is the number of slots that apply to characters or character
   sets.  The first 128 are for ASCII, the next 128 are for 8-bit
683 684 685
   European characters, and the last 128 are for multibyte characters.
   The first 256 are indexed by the code itself, but the last 128 are
   indexed by (charset-id + 128).  */
686 687 688 689 690
#define CHAR_TABLE_ORDINARY_SLOTS 384

/* This is the number of slots that apply to characters of ASCII and
   8-bit Europeans only.  */
#define CHAR_TABLE_SINGLE_BYTE_SLOTS 256
691

692 693 694 695 696 697 698 699 700 701 702 703
/* This is the number of slots that every char table must have.  This
   counts the ordinary slots and the top, defalt, parent, and purpose
   slots.  */
#define CHAR_TABLE_STANDARD_SLOTS (CHAR_TABLE_ORDINARY_SLOTS + 4)

/* This is the number of slots that apply to position-code-1 and
   position-code-2 of a multibyte character at the 2nd and 3rd level
   sub char tables respectively.  */
#define SUB_CHAR_TABLE_ORDINARY_SLOTS 128

/* This is the number of slots that every sub char table must have.
   This counts the ordinary slots and the top and defalt slot.  */
704
#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
705 706 707 708 709 710

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

#define CHAR_TABLE_EXTRA_SLOTS(CT)	\
  (((CT)->size & PSEUDOVECTOR_SIZE_MASK) - CHAR_TABLE_STANDARD_SLOTS)

711
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
712 713 714
   and 8-bit Europeans characters.  For these characters, do not check
   validity of CT.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)				\
715
  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
716 717
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XCHAR_TABLE (CT)->contents[IDX]			\
718
      : XCHAR_TABLE (CT)->defalt)			\
719
   : Faref (CT, make_number (IDX)))
720

721 722 723 724 725 726 727 728 729 730 731 732 733
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
   and 8-bit Europeans characters.  However, if the result is nil,
   return IDX.

   For these characters, do not check validity of CT
   and do not follow parent.  */
#define CHAR_TABLE_TRANSLATE(CT, IDX)			\
  ((IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS			\
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XINT (XCHAR_TABLE (CT)->contents[IDX])		\
      : IDX)						\
   : char_table_translate (CT, IDX))

734
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
735 736 737 738 739 740 741
   8-bit Europeans characters.  Do not check validity of CT.  */
#define CHAR_TABLE_SET(CT, IDX, VAL)			\
  do {							\
    if (XFASTINT (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS)	\
      XCHAR_TABLE (CT)->contents[XFASTINT (IDX)] = VAL;	\
    else						\
      Faset (CT, IDX, VAL);				\
742 743
  } while (0)

744 745 746 747
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
748 749
       The size counts the top, defalt, purpose, and parent slots.
       The last three are not counted if this is a sub char table.  */
750 751
    EMACS_INT size;
    struct Lisp_Vector *next;
752 753 754
    /* This holds a flag to tell if this is a top level char table (t)
       or a sub char table (nil).  */
    Lisp_Object top;
755 756 757
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
758 759 760 761 762 763
    /* This holds an actual value of each element.  A sub char table
       has only SUB_CHAR_TABLE_ORDINARY_SLOTS number of elements.  */
    Lisp_Object contents[CHAR_TABLE_ORDINARY_SLOTS];

    /* A sub char table doesn't has the following slots.  */

764 765 766 767
    /* 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.  */
    Lisp_Object parent;
768 769 770 771
    /* This should be a symbol which says what kind of use
       this char-table is meant for.
       Typically now the values can be `syntax-table' and `display-table'.  */
    Lisp_Object purpose;
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
    /* These hold additional data.  */
    Lisp_Object extras[1];
  };

/* A boolvector is a kind of vectorlike, with contents are like a string.  */
struct Lisp_Bool_Vector
  {
    /* This is the vector's size field.  It doesn't have the real size,
       just the subtype information.  */
    EMACS_INT vector_size;
    struct Lisp_Vector *next;
    /* This is the size in bits.  */
    EMACS_INT size;
    /* This contains the actual bits, packed into bytes.  */
    unsigned char data[1];
  };

Jim Blandy's avatar
Jim Blandy committed
789 790 791 792 793 794 795 796
/* In a symbol, the markbit of the plist is used as the gc mark bit */

struct Lisp_Symbol
  {
    struct Lisp_String *name;
    Lisp_Object value;
    Lisp_Object function;
    Lisp_Object plist;
797
    Lisp_Object obarray;
Jim Blandy's avatar
Jim Blandy committed
798 799 800
    struct Lisp_Symbol *next;	/* -> next symbol in this obarray bucket */
  };

801 802 803 804 805 806 807
/* This structure describes a built-in function.
   It is generated by the DEFUN macro only.
   defsubr makes it into a Lisp object.

   This type is treated in most respects as a pseudovector,
   but since we never dynamically allocate or free them,
   we don't need a next-vector field.  */
808

Jim Blandy's avatar
Jim Blandy committed
809 810
struct Lisp_Subr
  {
811
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
812 813 814 815 816 817
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921


/***********************************************************************
			     Hash Tables
 ***********************************************************************/

/* The structure of a Lisp hash table.  */

struct Lisp_Hash_Table
{
  /* Vector fields.  The hash table code doesn't refer to these.  */
  EMACS_INT size;
  struct Lisp_Vector *vec_next;
  
  /* Function used to compare keys.  */
  Lisp_Object test;

  /* Nil if table is non-weak.  Otherwise a symbol describing the
     weakness of the table.  */
  Lisp_Object weak;
  
  /* When the table is resized, and this is an integer, compute the
     new size by adding this to the old size.  If a float, compute the
     new size by multiplying the old size with this factor.  */
  Lisp_Object rehash_size;

  /* Resize hash table when number of entries/ table size is >= this
     ratio, a float.  */
  Lisp_Object rehash_threshold;

  /* Number of key/value entries in the table.  */
  Lisp_Object count;

  /* Vector of keys and values.  The key of item I is found at index
     2 * I, the value is found at index 2 * I + 1.  */
  Lisp_Object key_and_value;

  /* Vector of hash codes.. If hash[I] is nil, this means that that
     entry I is unused.  */
  Lisp_Object hash;

  /* Vector used to chain entries.  If entry I is free, next[I] is the
     entry number of the next free item.  If entry I is non-free,
     next[I] is the index of the next entry in the collision chain.  */
  Lisp_Object next;

  /* Index of first free entry in free list.  */
  Lisp_Object next_free;

  /* Bucket vector.  A non-nil entry is the index of the first item in
     a collision chain.  This vector's size can be larger than the
     hash table size to reduce collisions.  */
  Lisp_Object index;

  /* Next weak hash table if this is a weak hash table.  The head
     of the list is in Vweak_hash_tables.  */
  Lisp_Object next_weak;

  /* User-supplied hash function, or nil.  */
  Lisp_Object user_hash_function;

  /* User-supplied key comparison function, or nil.  */
  Lisp_Object user_cmp_function;

  /* C function to compare two keys.  */
  int (* cmpfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object,
		     unsigned, Lisp_Object, unsigned));

  /* C function to compute hash code.  */
  unsigned (* hashfn) P_ ((struct Lisp_Hash_Table *, Lisp_Object));
};


#define XHASH_TABLE(OBJ) \
     ((struct Lisp_Hash_Table *) XPNTR (OBJ))

#define XSET_HASH_TABLE(VAR, PTR) \
     (XSETPSEUDOVECTOR (VAR, PTR, PVEC_HASH_TABLE))

#define HASH_TABLE_P(OBJ)  PSEUDOVECTORP (OBJ, PVEC_HASH_TABLE)
#define GC_HASH_TABLE_P(x) GC_PSEUDOVECTORP (x, PVEC_HASH_TABLE)

#define CHECK_HASH_TABLE(x, i)					\
     do								\
       {							\
	 if (!HASH_TABLE_P ((x)))				\
	   x = wrong_type_argument (Qhash_table_p, (x));	\
       }							\
     while (0)

/* Default size for hash tables if not specified.  */

#define DEFAULT_HASH_SIZE 65

/* Default threshold specifying when to resize a hash table.  The
   value gives the ratio of current entries in the hash table and the
   size of the hash table.  */

#define DEFAULT_REHASH_THRESHOLD 0.8

/* Default factor by which to increase the size of a hash table.  */

#define DEFAULT_REHASH_SIZE 1.5

922

923 924
/* These structures are used for various misc types.  */

925 926 927
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
928 929
    int type : 16;	/* = Lisp_Misc_Free */
    int spacer : 16;
930 931
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
932

Erik Naggum's avatar
Erik Naggum committed
933
/* In a marker, the markbit of the chain field is used as the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
934
struct Lisp_Marker
935 936 937 938 939 940
{
  int type : 16;		/* = Lisp_Misc_Marker */
  int spacer : 15;
  /* 1 means normal insertion at the marker's position
     leaves the marker after the inserted text.  */
  unsigned int insertion_type : 1;
941 942
  /* This is the buffer that the marker points into,
     or 0 if it points nowhere.  */
943
  struct buffer *buffer;
944 945 946 947 948 949

  /* The remaining fields are meaningless in a marker that
     does not point anywhere.  */

  /* For markers that point somewhere,
     this is used to chain of all the markers in a given buffer.  */
950
  Lisp_Object chain;
951 952
  /* This is the char position where the marker points.  */
  int charpos;
953 954
  /* This is the byte position.  */
  int bytepos;
955
};
Jim Blandy's avatar
Jim Blandy committed
956

957 958 959 960 961
/* Forwarding pointer to an int variable.
   This is allowed only in the value cell of a symbol,
   and it means that the symbol's value really lives in the
   specified int variable.  */
struct Lisp_Intfwd
962
  {
963 964
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
965 966 967 968 969 970 971 972 973
    int *intvar;
  };

/* Boolean forwarding pointer to an int variable.
   This is like Lisp_Intfwd except that the ostensible
   "value" of the symbol is t if the int variable is nonzero,
   nil if it is zero.  */
struct Lisp_Boolfwd
  {
974 975
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
976 977 978 979 980 981 982 983 984
    int *boolvar;
  };

/* Forwarding pointer to a Lisp_Object variable.
   This is allowed only in the value cell of a symbol,
   and it means that the symbol's value really lives in the
   specified variable.  */
struct Lisp_Objfwd
  {
985 986
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
987 988 989 990 991 992 993
    Lisp_Object *objvar;
  };

/* Like Lisp_Objfwd except that value lives in a slot in the
   current buffer.  Value is byte index of slot within buffer.  */
struct Lisp_Buffer_Objfwd
  {
994 995
    int type : 16;	/* = Lisp_Misc_Buffer_Objfwd */
    int spacer : 16;
996
    int offset;
997 998
  };

Richard M. Stallman's avatar
Richard M. Stallman committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
/* struct Lisp_Buffer_Local_Value is used in a symbol value cell when
   the symbol has buffer-local or frame-local bindings.  (Exception:
   some buffer-local variables are built-in, with their values stored
   in the buffer structure itself.  They are handled differently,
   using struct Lisp_Buffer_Objfwd.)

   The `realvalue' slot holds the variable's current value, or a
   forwarding pointer to where that value is kept.  This value is the
   one that corresponds to the loaded binding.  To read or set the
   variable, you must first make sure the right binding is loaded;
   then you can access the value in (or through) `realvalue'.
   
   `buffer' and `frame' are the buffer and frame for which the loaded
   binding was found.  If those have changed, to make sure the right
   binding is loaded it is necessary to find which binding goes with
   the current buffer and selected frame, then load it.  To load it,
   first unload the previous binding, then copy the value of the new
   binding into `realvalue' (or through it).  Also update
   LOADED-BINDING to point to the newly loaded binding.
1018 1019

   Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
Richard M. Stallman's avatar
Richard M. Stallman committed
1020 1021 1022 1023 1024
   both use this kind of structure.  With the former, merely setting
   the variable creates a local binding for the current buffer.  With
   the latter, setting the variable does not do that; only
   make-local-variable does that.  */

1025 1026
struct Lisp_Buffer_Local_Value
  {
1027 1028 1029
    int type : 16;      /* = Lisp_Misc_Buffer_Local_Value
			   or Lisp_Misc_Some_Buffer_Local_Value */
    int spacer : 13;
Richard M. Stallman's avatar
Richard M. Stallman committed
1030 1031 1032

    /* 1 means this variable is allowed to have frame-local bindings,
       so check for them when looking for the proper binding.  */
1033
    unsigned int check_frame : 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1034 1035
    /* 1 means that the binding now loaded was found
       as a local binding for the buffer in the `buffer' slot.  */
1036
    unsigned int found_for_buffer : 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1037 1038
    /* 1 means that the binding now loaded was found
       as a local binding for the frame in the `frame' slot.  */
1039 1040
    unsigned int found_for_frame : 1;
    Lisp_Object realvalue;
Richard M. Stallman's avatar
Richard M. Stallman committed
1041
    /* The buffer and frame for which the loaded binding was found.  */
1042
    Lisp_Object buffer, frame;
Richard M. Stallman's avatar
Richard M. Stallman committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055

    /* A cons cell, (LOADED-BINDING . DEFAULT-VALUE).

       LOADED-BINDING is the binding now loaded.  It is a cons cell
       whose cdr is the binding's value.  The cons cell may be an
       element of a buffer's local-variable alist, or an element of a
       frame's parameter alist, or it may be this cons cell.

       DEFAULT-VALUE is the variable's default value, seen when the
       current buffer and selected frame do not have their own
       bindings for the variable.  When the default binding is loaded,
       LOADED-BINDING is actually this very cons cell; thus, its car
       points to itself.  */
1056
    Lisp_Object cdr;
1057 1058
  };

1059 1060 1061 1062 1063
/* In an overlay object, the mark bit of the plist is used as the GC mark.
   START and END are markers in the overlay's buffer, and
   PLIST is the overlay's property list.  */
struct Lisp_Overlay
  {
1064 1065
    int type : 16;	/* = Lisp_Misc_Overlay */
    int spacer : 16;
1066 1067
    Lisp_Object start, end, plist;
  };
1068

1069
/* Like Lisp_Objfwd except that value lives in a slot in the
1070 1071
   current kboard.  */
struct Lisp_Kboard_Objfwd
1072
  {
1073
    int type : 16;	/* = Lisp_Misc_Kboard_Objfwd */
1074 1075 1076 1077
    int spacer : 16;
    int offset;
  };

1078

Richard M. Stallman's avatar
Richard M. Stallman committed
1079 1080 1081
/* To get the type field of a union Lisp_Misc, use XMISCTYPE.
   It uses one of these struct subtypes to get the type field.  */

1082 1083 1084 1085
union Lisp_Misc
  {
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
1086 1087 1088 1089
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1090
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
1091
    struct Lisp_Overlay u_overlay;
1092
    struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1093
  };
1094

1095
/* Lisp floating point type */
Jim Blandy's avatar
Jim Blandy committed
1096 1097
struct Lisp_Float
  {
1098
    Lisp_Object type;		/* essentially used for mark-bit
Jim Blandy's avatar
Jim Blandy committed
1099
				   and chaining when on free-list */
1100 1101 1102
#ifdef HIDE_LISP_IMPLEMENTATION
    double data_;
#else
1103
    double data;
1104
#endif
Jim Blandy's avatar
Jim Blandy committed
1105
  };
1106 1107 1108 1109 1110 1111

#ifdef HIDE_LISP_IMPLEMENTATION
#define XFLOAT_DATA(f)	(XFLOAT (f)->data_)
#else
#define XFLOAT_DATA(f)	(XFLOAT (f)->data)
#endif
Jim Blandy's avatar
Jim Blandy committed
1112 1113

/* A character, declared with the following typedef, is a member
1114
   of some character set associated with the current buffer.  */
1115 1116
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
1117
typedef unsigned char UCHAR;
1118
#endif
Jim Blandy's avatar
Jim Blandy committed
1119 1120 1121 1122 1123 1124 1125 1126 1127

/* Meanings of slots in a Lisp_Compiled:  */

#define COMPILED_ARGLIST 0
#define COMPILED_BYTECODE 1
#define COMPILED_CONSTANTS 2
#define COMPILED_STACK_DEPTH 3
#define COMPILED_DOC_STRING 4
#define COMPILED_INTERACTIVE 5
112