lisp.h 101 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
2 3
   Copyright (C) 1985,86,87,93,94,95,97,98,1999,2000
     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

Jim Blandy's avatar
Jim Blandy committed
29

30
/* These are default choices for the types to use.  */
31 32 33 34 35 36 37 38 39
#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 */
40 41
#ifndef EMACS_INT
#define EMACS_INT int
Richard M. Stallman's avatar
Richard M. Stallman committed
42
#define BITS_PER_EMACS_INT BITS_PER_INT
43 44 45 46
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif
47
#endif
48

49 50 51
/* Extra internal type checking?  */
extern int suppress_checking;
extern void die P_((const char *, const char *, int));
52 53 54 55 56 57 58 59 60 61 62

#ifdef ENABLE_CHECKING

#define CHECK(check,msg) ((check || suppress_checking		\
			   ? 0					\
			   : die (msg, __FILE__, __LINE__)),	\
			  0)

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

63
#else
64

65 66
/* Produce same side effects and result, but don't complain.  */
#define CHECK(check,msg) ((check),0)
67

68
#endif
69

70 71 72 73 74 75 76 77
/* Define an Emacs version of "assert", since some system ones are
   flaky.  */
#if defined (__GNUC__) && __GNUC__ >= 2 && defined (__STDC__)
#define eassert(cond) CHECK(cond,"assertion failed: " #cond)
#else
#define eassert(cond) CHECK(cond,"assertion failed")
#endif

78
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
79

80
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
81 82 83

enum Lisp_Type
  {
84
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
85 86
    Lisp_Int,

87
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
88 89
    Lisp_Symbol,

90 91 92
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
93 94

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

98
    /* Vector of Lisp objects, or something resembling it.
99
       XVECTOR (object) points to a struct Lisp_Vector, which contains
100 101 102
       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
103

104
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
105 106
    Lisp_Cons,

Jim Blandy's avatar
Jim Blandy committed
107
    Lisp_Float,
108 109

    /* This is not a type code.  It is for range checking.  */
110
    Lisp_Type_Limit
Jim Blandy's avatar
Jim Blandy committed
111 112
  };

113
/* This is the set of datatypes that share a common structure.
114 115 116 117
   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
118 119
enum Lisp_Misc_Type
  {
120
    Lisp_Misc_Free = 0x5eab,
121
    Lisp_Misc_Marker,
122 123 124
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
125 126
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
127
    Lisp_Misc_Some_Buffer_Local_Value,
128
    Lisp_Misc_Overlay,
129
    Lisp_Misc_Kboard_Objfwd,
130 131 132 133 134
    /* 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
135 136
  };

137 138
/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
139
#define VALBITS (BITS_PER_EMACS_INT - 4)
140 141 142 143 144 145
#endif

#ifndef GCTYPEBITS
#define GCTYPEBITS 3
#endif

146 147 148 149
#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
150 151 152 153 154 155
/* Make these values available in GDB, which sees enums but not macros.  */

enum gdb_lisp_params
{
  gdb_valbits = VALBITS,
  gdb_gctypebits = GCTYPEBITS,
156
  gdb_emacs_intbits = sizeof (EMACS_INT) * BITS_PER_CHAR,
Karl Heuer's avatar
Karl Heuer committed
157 158 159 160 161 162 163
#ifdef DATA_SEG_BITS
  gdb_data_seg_bits = DATA_SEG_BITS
#else
  gdb_data_seg_bits = 0
#endif
};

164 165
#endif /* 0 */

Jim Blandy's avatar
Jim Blandy committed
166 167
#ifndef NO_UNION_TYPE

168
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
169 170 171 172 173 174 175

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
176
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180
    int i;

    struct
      {
181 182
	int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
183 184 185
      } s;
    struct
      {
186 187
	unsigned int val: VALBITS;
	int type: GCTYPEBITS+1;
Jim Blandy's avatar
Jim Blandy committed
188 189 190
      } u;
    struct
      {
191 192
	unsigned int val: VALBITS;
	enum Lisp_Type type: GCTYPEBITS;
Jim Blandy's avatar
Jim Blandy committed
193 194 195 196 197 198 199
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
	unsigned int markbit: 1;
      } gu;
  }
Lisp_Object;

200
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
206
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
207 208 209 210
    int i;

    struct
      {
211 212
	int type: GCTYPEBITS+1;
	int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
213 214 215
      } s;
    struct
      {
216 217
	int type: GCTYPEBITS+1;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
218 219 220 221 222 223
      } u;
    struct
      {
	/* The markbit is not really part of the value of a Lisp_Object,
	   and is always zero except during garbage collection.  */
	unsigned int markbit: 1;
224 225
	enum Lisp_Type type: GCTYPEBITS;
	unsigned int val: VALBITS;
Jim Blandy's avatar
Jim Blandy committed
226 227 228 229
      } gu;
  }
Lisp_Object;

230
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234

#endif /* NO_UNION_TYPE */


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

#ifdef NO_UNION_TYPE
238
#define Lisp_Object EMACS_INT
239
#endif /* NO_UNION_TYPE */
Jim Blandy's avatar
Jim Blandy committed
240 241

#ifndef VALMASK
242
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
243
#endif
244
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
245 246 247 248 249 250 251 252 253 254 255 256 257

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

258
#ifndef MARKBIT
259
#define MARKBIT ((EMACS_INT) ((EMACS_UINT) 1 << (VALBITS + GCTYPEBITS)))
260
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
261

262 263 264 265 266 267 268
/* 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 */

269 270 271 272 273 274
/* 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

275
/* In a pseudovector, the size field actually contains a word with one
276 277
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
278 279 280 281 282 283 284 285 286
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,
287 288 289
  PVEC_CHAR_TABLE = 0x8000,
  PVEC_BOOL_VECTOR = 0x10000,
  PVEC_BUFFER = 0x20000,
Gerd Moellmann's avatar
Gerd Moellmann committed
290
  PVEC_HASH_TABLE = 0x40000,
Gerd Moellmann's avatar
Gerd Moellmann committed
291 292 293 294 295
  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.  */
296
  PVEC_FLAG = PSEUDOVECTOR_FLAG
Gerd Moellmann's avatar
Gerd Moellmann committed
297
#endif
298
};
299 300

/* For convenience, we also store the number of elements in these bits.  */
301
#define PSEUDOVECTOR_SIZE_MASK 0x1ff
Jim Blandy's avatar
Jim Blandy committed
302 303 304

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
305
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
306 307 308 309 310 311 312 313 314 315 316 317

#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
318
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
319 320
#endif

Karl Heuer's avatar
Karl Heuer committed
321 322 323
/* 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.  */
324
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
325
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329

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

#ifndef XINT   /* Some machines need to do this differently.  */
330
#define XINT(a) (((a) << (BITS_PER_EMACS_INT-VALBITS)) >> (BITS_PER_EMACS_INT-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 338 339 340 341 342
#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
#define XUINT(a) ((a) & VALMASK)
#endif

#ifndef XPNTR
#ifdef HAVE_SHM
/* In this representation, data is found in two widely separated segments.  */
Jim Blandy's avatar
Jim Blandy committed
343
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
344
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
345
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
#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) \
362
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
363 364
#endif

365 366 367 368 369
/* 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
370 371 372 373 374 375 376 377 378 379
/* 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
380
#if VALBITS + GCTYPEBITS == BITS_PER_EMACS_INT - 1
Jim Blandy's avatar
Jim Blandy committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/* 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
410 411 412
/* 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.  */
413
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
414
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
415 416 417

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
418
#define XINT(a) (((a).i << (BITS_PER_INT-VALBITS)) >> (BITS_PER_INT-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
419 420 421 422 423 424 425 426
#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) \
427
   (((var).s.val = ((int) (ptr))), ((var).s.type = ((char) (vartype))))
Jim Blandy's avatar
Jim Blandy committed
428

429 430 431 432
#if __GNUC__ >= 2 && defined (__OPTIMIZE__)
#define make_number(N) \
  (__extension__ ({ Lisp_Object _l; _l.s.val = (N); _l.s.type = Lisp_Int; _l; }))
#else
433
extern Lisp_Object make_number ();
434
#endif
435

Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449
/* 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 */

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

452
#define XCONS(a) (eassert (GC_CONSP(a)),(struct Lisp_Cons *) XPNTR(a))
Jim Blandy's avatar
Jim Blandy committed
453
#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
454 455 456
#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))
457 458 459

/* Misc types.  */
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Richard M. Stallman's avatar
Richard M. Stallman committed
460
#define XMISCTYPE(a)   (XMARKER (a)->type)
461
#define XMARKER(a) (&(XMISC(a)->u_marker))
462 463 464 465
#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))
466
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
467
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
468
#define XKBOARD_OBJFWD(a) (&(XMISC(a)->u_kboard_objfwd))
Jim Blandy's avatar
Jim Blandy committed
469

470
/* Pseudovector types.  */
471 472 473 474
#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))
475 476
#define XCHAR_TABLE(a) ((struct Lisp_Char_Table *) XPNTR(a))
#define XBOOL_VECTOR(a) ((struct Lisp_Bool_Vector *) XPNTR(a))
477 478 479


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

481 482
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
483
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
484 485 486
#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)
487 488 489

/* Misc types.  */
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
Richard M. Stallman's avatar
Richard M. Stallman committed
490
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISCTYPE (a) = Lisp_Misc_Marker)
491 492 493 494 495 496 497 498 499 500

/* Pseudovector types.  */
#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))
501
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
502 503
#define XSETCHAR_TABLE(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_CHAR_TABLE))
#define XSETBOOL_VECTOR(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BOOL_VECTOR))
Jim Blandy's avatar
Jim Blandy committed
504

505
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
506 507 508

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

511 512
  unsigned int total_length;	/* Length of myself and both children.  */
  unsigned int position;	/* Cache of interval's character position.  */
513 514 515 516 517
				/* This field is usually updated
				   simultaneously with an interval
				   traversal, there is no guaranty
				   that it is valid for a random
				   interval.  */
518 519
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */
520 521 522 523 524 525 526 527 528 529 530

  /* 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.  */
531 532 533 534 535 536
  union
  {
    struct interval *interval;
    Lisp_Object obj;
  } up;
  unsigned int up_obj : 1;
537 538 539

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

542 543 544
  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
545
				       before this interval goes into it.  */
546
  unsigned int rear_sticky : 1;	    /* Likewise for just after it.  */
547

548 549 550 551 552
  /* 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;
553 554 555 556 557 558
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
559
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
560 561 562
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

/* Macro used to conditionally compile intervals into certain data
563
   structures.  See, e.g., struct Lisp_String below.  */
564 565
#define DECLARE_INTERVALS INTERVAL intervals;

566
/* Macro used to conditionally compile interval initialization into
567
   certain code.  See, e.g., alloc.c.  */
568 569 570
#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val


Jim Blandy's avatar
Jim Blandy committed
571 572 573 574
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
575 576 577 578 579
    /* 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
580
    Lisp_Object car, cdr;
581
#endif
Jim Blandy's avatar
Jim Blandy committed
582 583
  };

584
/* Take the car or cdr of something known to be a cons cell.  */
585 586 587 588
#ifdef HIDE_LISP_IMPLEMENTATION
#define XCAR(c) (XCONS ((c))->car_)
#define XCDR(c) (XCONS ((c))->cdr_)
#else
589 590
#define XCAR(c) (XCONS ((c))->car)
#define XCDR(c) (XCONS ((c))->cdr)
591
#endif
592 593 594 595 596 597 598 599 600 601 602 603

/* 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
604 605 606 607 608 609 610 611 612 613 614
/* Nonzero if STR is a multibyte string.  */
#define STRING_MULTIBYTE(STR)  \
  (XSTRING (STR)->size_byte >= 0)

/* Return the length in bytes of STR.  */
#define STRING_BYTES(STR)  \
  ((STR)->size_byte < 0 ? (STR)->size : (STR)->size_byte)

/* Set the length in bytes of STR.  */
#define SET_STRING_BYTES(STR, SIZE)  ((STR)->size_byte = (SIZE))

Jim Blandy's avatar
Jim Blandy committed
615 616 617 618
/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
619
    EMACS_INT size;
620
    EMACS_INT size_byte;
621
    DECLARE_INTERVALS		/* `data' field must be last.  */
622
    unsigned char *data;
Jim Blandy's avatar
Jim Blandy committed
623 624
  };

Karl Heuer's avatar
Karl Heuer committed
625
/* If a struct is made to look like a vector, this macro returns the length
626 627 628 629
   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
630 631
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
632 633
struct Lisp_Vector
  {
634
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

639 640 641 642 643 644 645 646 647 648
/* 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.  */
649

650 651
/* 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
652 653 654
   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).  */
655 656 657 658 659
#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
660

661 662 663 664 665 666 667 668 669 670 671 672
/* 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.  */
673
#define SUB_CHAR_TABLE_STANDARD_SLOTS (SUB_CHAR_TABLE_ORDINARY_SLOTS + 2)
674 675 676 677 678 679

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

680
/* Almost equivalent to Faref (CT, IDX) with optimization for ASCII
681 682 683
   and 8-bit Europeans characters.  For these characters, do not check
   validity of CT.  Do not follow parent.  */
#define CHAR_TABLE_REF(CT, IDX)				\
684
  ((IDX) >= 0 && (IDX) < CHAR_TABLE_SINGLE_BYTE_SLOTS	\
685 686
   ? (!NILP (XCHAR_TABLE (CT)->contents[IDX])		\
      ? XCHAR_TABLE (CT)->contents[IDX]			\
687
      : XCHAR_TABLE (CT)->defalt)			\
688
   : Faref (CT, make_number (IDX)))
689

690 691 692 693 694 695 696 697 698 699 700 701 702
/* 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))

703
/* Equivalent to Faset (CT, IDX, VAL) with optimization for ASCII and
704 705 706 707 708 709 710
   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);				\
711 712
  } while (0)

713 714 715 716
struct Lisp_Char_Table
  {
    /* This is the vector's size field, which also holds the
       pseudovector type information.  It holds the size, too.
717 718
       The size counts the top, defalt, purpose, and parent slots.
       The last three are not counted if this is a sub char table.  */
719 720
    EMACS_INT size;
    struct Lisp_Vector *next;
721 722 723
    /* This holds a flag to tell if this is a top level char table (t)
       or a sub char table (nil).  */
    Lisp_Object top;
724 725 726
    /* This holds a default value,
       which is used whenever the value for a specific character is nil.  */
    Lisp_Object defalt;
727 728 729 730 731 732
    /* 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.  */

733 734 735 736
    /* 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;
737 738 739 740
    /* 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;
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
    /* 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
758 759 760 761 762 763 764 765
/* 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;
766
    Lisp_Object obarray;
Jim Blandy's avatar
Jim Blandy committed
767 768 769
    struct Lisp_Symbol *next;	/* -> next symbol in this obarray bucket */
  };

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

Jim Blandy's avatar
Jim Blandy committed
778 779
struct Lisp_Subr
  {
780
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784 785 786
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 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

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

891

892 893
/* These structures are used for various misc types.  */

894 895 896
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
897 898
    int type : 16;	/* = Lisp_Misc_Free */
    int spacer : 16;
899 900
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
901

Erik Naggum's avatar
Erik Naggum committed
902
/* In a marker, the markbit of the chain field is used as the gc mark bit.  */
Jim Blandy's avatar
Jim Blandy committed
903
struct Lisp_Marker
904 905 906 907 908 909
{
  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;
910 911
  /* This is the buffer that the marker points into,
     or 0 if it points nowhere.  */
912
  struct buffer *buffer;
913 914 915 916 917 918

  /* 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.  */
919
  Lisp_Object chain;
920 921
  /* This is the char position where the marker points.  */
  int charpos;
922 923
  /* This is the byte position.  */
  int bytepos;
924
};
Jim Blandy's avatar
Jim Blandy committed
925

926 927 928 929 930
/* 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
931
  {
932 933
    int type : 16;	/* = Lisp_Misc_Intfwd */
    int spacer : 16;
934 935 936 937 938 939 940 941 942
    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
  {
943 944
    int type : 16;	/* = Lisp_Misc_Boolfwd */
    int spacer : 16;
945 946 947 948 949 950 951 952 953
    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
  {
954 955
    int type : 16;	/* = Lisp_Misc_Objfwd */
    int spacer : 16;
956 957 958 959 960 961 962
    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
  {
963 964
    int type : 16;	/* = Lisp_Misc_Buffer_Objfwd */
    int spacer : 16;
965
    int offset;
966 967
  };

Richard M. Stallman's avatar
Richard M. Stallman committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
/* 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.
987 988

   Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
Richard M. Stallman's avatar
Richard M. Stallman committed
989 990 991 992 993
   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.  */

994 995
struct Lisp_Buffer_Local_Value
  {
996 997 998
    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
999 1000 1001

    /* 1 means this variable is allowed to have frame-local bindings,
       so check for them when looking for the proper binding.  */
1002
    unsigned int check_frame : 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1003 1004
    /* 1 means that the binding now loaded was found
       as a local binding for the buffer in the `buffer' slot.  */
1005
    unsigned int found_for_buffer : 1;
Richard M. Stallman's avatar
Richard M. Stallman committed
1006 1007
    /* 1 means that the binding now loaded was found
       as a local binding for the frame in the `frame' slot.  */
1008 1009
    unsigned int found_for_frame : 1;
    Lisp_Object realvalue;
Richard M. Stallman's avatar
Richard M. Stallman committed
1010
    /* The buffer and frame for which the loaded binding was found.  */
1011
    Lisp_Object buffer, frame;
Richard M. Stallman's avatar
Richard M. Stallman committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

    /* 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.  */
1025
    Lisp_Object cdr;
1026 1027
  };

1028 1029 1030 1031 1032
/* 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
  {
1033 1034
    int type : 16;	/* = Lisp_Misc_Overlay */
    int spacer : 16;
1035 1036
    Lisp_Object start, end, plist;
  };
1037

1038
/* Like Lisp_Objfwd except that value lives in a slot in the
1039 1040
   current kboard.  */
struct Lisp_Kboard_Objfwd
1041
  {
1042
    int type : 16;	/* = Lisp_Misc_Kboard_Objfwd */
1043 1044 1045 1046
    int spacer : 16;
    int offset;
  };

1047

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

1051 1052 1053 1054
union Lisp_Misc
  {
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
1055 1056 1057 1058
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
1059
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
1060
    struct Lisp_Overlay u_overlay;
1061
    struct Lisp_Kboard_Objfwd u_kboard_objfwd;
1062
  };
1063

1064
/* Lisp floating point type */
Jim Blandy's avatar
Jim Blandy committed
1065 1066
struct Lisp_Float
  {
1067
    Lisp_Object type;		/* essentially used for mark-bit
Jim Blandy's avatar
Jim Blandy committed
1068
				   and chaining when on free-list */
1069 1070 1071
#ifdef HIDE_LISP_IMPLEMENTATION
    double data_;
#else
1072
    double data;
1073
#endif
Jim Blandy's avatar
Jim Blandy committed
1074
  };
1075 1076 1077 1078 1079 1080

#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
1081 1082

/* A character, declared with the following typedef, is a member
1083
   of some character set associated with the current buffer.  */
1084 1085
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
1086
typedef unsigned char UCHAR;
1087
#endif
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092 1093 1094 1095 1096

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

1098 1099
/* Flag bits in a character.  These also get used in termhooks.h.
   Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
1100 1101 1102 1103 1104 1105 1106 1107
   (MUlti-Lingual Emacs) might need 22 bits for the character value
   itself, so we probably shouldn't use any bits lower than 0x0400000.  */
#define CHAR_ALT   (0x0400000)
#define CHAR_SUPER (0x0800000)
#define CHAR_HYPER (0x1000000)
#define CHAR_SHIFT (0x2000000)
#define CHAR_CTL   (0x4000000)
#define CHAR_META  (0x8000000)
1108

1109 1110 1111 1112
#define CHAR_MODIFIER_MASK \
  (CHAR_ALT | CHAR_SUPER | CHAR_HYPER  | CHAR_SHIFT | CHAR_CTL | CHAR_META)


1113 1114 1115 1116
/* Actually, the current Emacs uses 19 bits for the character value
   itself.  */
#define CHARACTERBITS 19

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
/* The maximum byte size consumed by push_key_description.
   All callers should assure that at least this size of memory is
   allocated at the place pointed by the second argument.

   Thers are 6 modifiers, each consumes 2 chars.
   The octal form of a character code consumes
   (1 + CHARACTERBITS / 3 + 1) chars (including backslash at the head).
   We need one more byte for string terminator `\0'.  */
#define KEY_DESCRIPTION_SIZE ((2 * 6) + 1 + (CHARACTERBITS / 3) + 1 + 1)

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
#ifdef USE_X_TOOLKIT
#ifdef NO_UNION_TYPE
/* Use this for turning a (void *) into a Lisp_Object, as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define VOID_TO_LISP(larg,varg) \
  do { ((larg) = ((Lisp_Object) (varg))); } while (0)
#define CVOID_TO_LISP VOID_TO_LISP

/* Use this for turning a Lisp_Object into a  (void *), as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define LISP_TO_VOID(larg) ((void *) (larg))
#define LISP_TO_CVOID(varg) ((const void *) (larg))

#else /* not NO_UNION_TYPE */
/* Use this for turning a (void *) into a Lisp_Object, as when the
  Lisp_Object is passed into a toolkit callback function.  */
#define VOID_TO_LISP(larg,varg) \
  do { ((larg).v = (void *) (varg)); } while (0)
#define CVOID_TO_LISP(larg,varg) \
  do { ((larg).cv = (const void *) (varg)); } while (0)

/* Use this for turning a Lisp_Object into a  (void *), as when the
   Lisp_Object is passed into a toolkit callback function.  */
#define LISP_TO_VOID(larg) ((larg).v)
#define LISP_TO_CVOID(larg) ((larg).cv)
#endif /* not NO_UNION_TYPE */
#endif /* USE_X_TOOLKIT */

1155 1156 1157

/* The glyph datatype, used to represent characters on the display.  */

1158 1159 1160 1161 1162 1163 1164
/* Glyph code to use as an index to the glyph table.  If it is out of
   range for the glyph table, or the corresonding element in the table
   is nil, the low 8 bits are the single byte character code, and the
   bits above are the numeric face ID.  If FID is the face ID of a
   glyph on a frame F, then F->display.x->faces[FID] contains the
   description of that face.  This is an int instead of a short, so we
   can support a good bunch of face ID's (2^(31 - 8)); given that we
1165
   have no mechanism for tossing unused frame face ID's yet, we'll
1166