lisp.h 55.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fundamental definitions for GNU Emacs Lisp interpreter.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21 22 23 24 25 26 27 28
/* These are default choices for the types to use.  */
#ifndef EMACS_INT
#define EMACS_INT int
#endif
#ifndef EMACS_UINT
#define EMACS_UINT unsigned int
#endif

29
/* Define the fundamental Lisp data structures.  */
Jim Blandy's avatar
Jim Blandy committed
30

31
/* This is the set of Lisp data types.  */
Jim Blandy's avatar
Jim Blandy committed
32 33 34

enum Lisp_Type
  {
35
    /* Integer.  XINT (obj) is the integer value.  */
Jim Blandy's avatar
Jim Blandy committed
36 37
    Lisp_Int,

38
    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol.  */
Jim Blandy's avatar
Jim Blandy committed
39 40
    Lisp_Symbol,

41 42 43
    /* Miscellaneous.  XMISC (object) points to a union Lisp_Misc,
       whose first member indicates the subtype.  */
    Lisp_Misc,
Jim Blandy's avatar
Jim Blandy committed
44 45

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

49
    /* Vector of Lisp objects, or something resembling it.
50
       XVECTOR (object) points to a struct Lisp_Vector, which contains
51 52 53
       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
54

55
    /* Cons.  XCONS (object) points to a struct Lisp_Cons.  */
Jim Blandy's avatar
Jim Blandy committed
56 57 58
    Lisp_Cons,

#ifdef LISP_FLOAT_TYPE
Jim Blandy's avatar
Jim Blandy committed
59
    Lisp_Float,
Jim Blandy's avatar
Jim Blandy committed
60
#endif /* LISP_FLOAT_TYPE */
61 62

    /* This is not a type code.  It is for range checking.  */
63
    Lisp_Type_Limit,
Jim Blandy's avatar
Jim Blandy committed
64 65
  };

66
/* This is the set of datatypes that share a common structure.
Karl Heuer's avatar
Karl Heuer committed
67 68 69
   The first member of the structure is a type code from this set.  */
enum Lisp_Misc_Type
  {
70
    Lisp_Misc_Free,
71
    Lisp_Misc_Marker,
72 73 74
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
75 76
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
77
    Lisp_Misc_Some_Buffer_Local_Value,
78 79 80 81 82 83
    Lisp_Misc_Overlay,
    /* 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
84 85
  };

Jim Blandy's avatar
Jim Blandy committed
86 87
#ifndef NO_UNION_TYPE

88
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93 94 95

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
96
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    int i;

    struct
      {
	int val: 24;
	char type;
      } s;
    struct
      {
	unsigned int val: 24;
	char type;
      } u;
    struct
      {
	unsigned int val: 24;
	enum Lisp_Type type: 7;
	/* 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;

120
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
126
       also, positive integers can be accessed fast this way.  */
Jim Blandy's avatar
Jim Blandy committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
    int i;

    struct
      {
	char type;
	int val: 24;
      } s;
    struct
      {
	char type;
	unsigned int val: 24;
      } 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;
	enum Lisp_Type type: 7;
	unsigned int val: 24;
      } gu;
  }
Lisp_Object;

150
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157 158 159

#endif /* NO_UNION_TYPE */


/* If union type is not wanted, define Lisp_Object as just a number
   and define the macros below to extract fields by shifting */

#ifdef NO_UNION_TYPE

160
#define Lisp_Object EMACS_INT
Jim Blandy's avatar
Jim Blandy committed
161 162 163

/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
164
#define VALBITS 28
Jim Blandy's avatar
Jim Blandy committed
165 166 167
#endif

#ifndef GCTYPEBITS
168
#define GCTYPEBITS 3
Jim Blandy's avatar
Jim Blandy committed
169 170 171
#endif

#ifndef VALMASK
172
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
173
#endif
174
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
175 176 177 178 179 180 181 182 183 184 185 186 187

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

188
#ifndef MARKBIT
Jim Blandy's avatar
Jim Blandy committed
189
#define MARKBIT (1 << (VALBITS + GCTYPEBITS))
190
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
191

192 193 194 195 196 197 198
/* 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 */

199 200 201 202 203 204 205 206 207
/* 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

/* In a pseudo-vector, the size field actually contains a word with one
   PSEUDOVECTOR_FLAG bit set, and exactly one of the following bits to
   indicate the actual type.  */
208 209 210 211 212 213 214 215 216 217 218 219 220
enum pvec_type
{
  PVEC_NORMAL_VECTOR = 0,
  PVEC_BUFFER = 0x100,
  PVEC_PROCESS = 0x200,
  PVEC_FRAME = 0x400,
  PVEC_COMPILED = 0x800,
  PVEC_WINDOW = 0x1000,
  PVEC_WINDOW_CONFIGURATION = 0x2000,
  PVEC_SUBR = 0x4000,
  PVEC_TYPE_MASK = 0x7f00,
  PVEC_FLAG = PSEUDOVECTOR_FLAG,
};
221 222 223 224 225

/* For convenience, we also store the number of elements in these bits.  */
#define PSEUDOVECTOR_SIZE_MASK 0xff

#if ARRAY_MARK_FLAG == MARKBIT || PSEUDOVECTOR_FLAG == ARRAY_MARK_FLAG || PSEUDOVECTOR_FLAG == MARKBIT
226 227 228
you lose
#endif

Jim Blandy's avatar
Jim Blandy committed
229 230 231 232
#endif /* NO_UNION_TYPE */

/* These macros extract various sorts of values from a Lisp_Object.
 For example, if tem is a Lisp_Object whose type is Lisp_Cons,
233
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons.  */
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238 239 240 241 242 243 244 245

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

Karl Heuer's avatar
Karl Heuer committed
249 250 251
/* 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.  */
252
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
253
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257

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

#ifndef XINT   /* Some machines need to do this differently.  */
Jim Blandy's avatar
Jim Blandy committed
258
#define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262 263 264 265 266 267 268 269 270
#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
271
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
272
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
273
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
#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) \
290
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
#endif

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

#if VALBITS + GCTYPEBITS == INTBITS - 1
/* 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
333 334 335
/* 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.  */
336
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
337
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

#ifdef EXPLICIT_SIGN_EXTEND
/* Make sure we sign-extend; compilers have been known to fail to do so.  */
#define XINT(a) (((a).i << 8) >> 8)
#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) \
   (((var).s.type = ((char) (vartype))), ((var).s.val = ((int) (ptr))))

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

366
/* Extract a value or address from a Lisp_Object.  */
Jim Blandy's avatar
Jim Blandy committed
367 368 369 370 371 372

#define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
#define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
373 374 375

/* Misc types.  */
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
376
#define XMARKER(a) (&(XMISC(a)->u_marker))
377 378 379 380
#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))
381
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
382
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
Jim Blandy's avatar
Jim Blandy committed
383

384 385 386 387
/* Pseudovector types.  */
#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
#define XWINDOW(a) ((struct window *) XPNTR(a))
#define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
388 389 390 391
#define XBUFFER(a) ((struct buffer *) XPNTR(a))


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

393 394
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
395
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
396 397 398
#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)
399 400 401

/* Misc types.  */
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
402
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISC (a)->type = Lisp_Misc_Marker)
403 404 405 406 407 408 409 410 411 412

/* 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))
413
#define XSETBUFFER(a, b) (XSETPSEUDOVECTOR (a, b, PVEC_BUFFER))
Jim Blandy's avatar
Jim Blandy committed
414

415
#ifdef USE_TEXT_PROPERTIES
416
/* Basic data type for use of intervals.  See the macros in intervals.h.  */
417 418 419

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

422 423 424 425
  unsigned int total_length;	/* Length of myself and both children.  */
  unsigned int position;	/* Cache of interval's character position.  */
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */
426 427 428 429 430 431 432 433 434 435 436 437

  /* 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.  */
  struct interval *parent;
438 439 440

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

  unsigned char write_protect;	    /* Non-zero means can't modify.  */
444
  unsigned char visible;	    /* Zero means don't display.  */
445
  unsigned char front_sticky;	    /* Non-zero means text inserted just
446 447
				       before this interval goes into it.  */
  unsigned char rear_sticky;	    /* Likewise for just after it.  */
448

449 450 451 452 453
  /* 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;
454 455 456 457 458 459
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
460
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
461 462 463
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

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

467
/* Macro used to conditionally compile interval initialization into
468
   certain code.  See, e.g., alloc.c.  */
469 470 471 472
#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val

#else  /* No text properties */

473
/* If no intervals are used, make the above definitions go away.  */
474 475 476 477 478 479 480 481 482

#define CHECK_STRING_OR_BUFFER(x, i)

#define INTERVAL
#define DECLARE_INTERVALS
#define INITIALIZE_INTERVAL(ptr,val)

#endif /* USE_TEXT_PROPERTIES */

Jim Blandy's avatar
Jim Blandy committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
/* In a cons, the markbit of the car is the gc mark bit */

struct Lisp_Cons
  {
    Lisp_Object car, cdr;
  };

/* Like a cons, but records info on where the text lives that it was read from */
/* This is not really in use now */

struct Lisp_Buffer_Cons
  {
    Lisp_Object car, cdr;
    struct buffer *buffer;
    int bufpos;
  };

/* In a string or vector, the sign bit of the `size' is the gc mark bit */

struct Lisp_String
  {
504
    EMACS_INT size;
505
    DECLARE_INTERVALS		/* `data' field must be last.  */
Jim Blandy's avatar
Jim Blandy committed
506 507 508
    unsigned char data[1];
  };

Karl Heuer's avatar
Karl Heuer committed
509 510 511 512 513 514
/* If a struct is made to look like a vector, this macro returns the length
   of that vector.  */
#define VECSIZE(type) ((sizeof (type) - (sizeof (struct Lisp_Vector)	\
					 - sizeof (Lisp_Object)))	\
		       / sizeof (Lisp_Object))

Jim Blandy's avatar
Jim Blandy committed
515 516
struct Lisp_Vector
  {
517
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    struct Lisp_Vector *next;
    Lisp_Object contents[1];
  };

/* 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;
    struct Lisp_Symbol *next;	/* -> next symbol in this obarray bucket */
  };

533 534 535 536 537 538 539 540
/* 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.  */
   
Jim Blandy's avatar
Jim Blandy committed
541 542
struct Lisp_Subr
  {
543
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
544 545 546 547 548 549
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
550

551 552
/* These structures are used for various misc types.  */

553 554 555 556 557 558
/* A miscellaneous object, when it's on the free list.  */
struct Lisp_Free
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Free */
    union Lisp_Misc *chain;
  };
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562

/* In a marker, the markbit of the chain field is used as the gc mark bit */
struct Lisp_Marker
  {
Karl Heuer's avatar
Karl Heuer committed
563
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Marker */
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568
    struct buffer *buffer;
    Lisp_Object chain;
    int bufpos;
  };

569 570 571 572 573
/* 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
574
  {
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Intfwd */
    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
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Boolfwd */
    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
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Objfwd */
    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
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Buffer_Objfwd */
    int offset;
605 606
  };

607 608 609 610
/* Used in a symbol value cell when the symbol's value is per-buffer.
   The actual contents resemble a cons cell which starts a list like this:
   (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).

611 612 613
   The cons-like structure is for historical reasons; it might be better
   to just put these elements into the struct, now.

614 615 616 617 618 619 620 621 622 623 624 625
   BUFFER is the last buffer for which this symbol's value was
   made up to date.

   CURRENT-ALIST-ELEMENT is a pointer to an element of BUFFER's
   local_var_alist, that being the element whose car is this
   variable.  Or it can be a pointer to the
   (CURRENT-ALIST-ELEMENT . DEFAULT-VALUE),
   if BUFFER does not have an element in its alist for this
   variable (that is, if BUFFER sees the default value of this
   variable).

   If we want to examine or set the value and BUFFER is current,
626
   we just examine or set REALVALUE.  If BUFFER is not current, we
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
   store the current REALVALUE value into CURRENT-ALIST-ELEMENT,
   then find the appropriate alist element for the buffer now
   current and set up CURRENT-ALIST-ELEMENT.  Then we set
   REALVALUE out of that element, and store into BUFFER.

   If we are setting the variable and the current buffer does not
   have an alist entry for this variable, an alist entry is
   created.

   Note that REALVALUE can be a forwarding pointer.  Each time it
   is examined or set, forwarding must be done.  Each time we
   switch buffers, buffer-local variables which forward into C
   variables are swapped immediately, so the C code can assume
   that they are always up to date.

   Lisp_Misc_Buffer_Local_Value and Lisp_Misc_Some_Buffer_Local_Value
   use the same substructure.  The difference is that with the latter,
   merely setting the variable while some buffer is current
   does not cause that buffer to have its own local value of this variable.
   Only make-local-variable does that.  */
struct Lisp_Buffer_Local_Value
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Buffer_Local_Value
				   or Lisp_Misc_Some_Buffer_Local_Value */
    Lisp_Object car, cdr;
  };

654 655 656 657 658 659 660 661
/* 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
  {
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Overlay */
    Lisp_Object start, end, plist;
  };
662 663 664 665 666
union Lisp_Misc
  {
    enum Lisp_Misc_Type type;
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
667 668 669 670
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
671
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
672
    struct Lisp_Overlay u_overlay;
673
  };
674

Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680 681 682 683 684 685
#ifdef LISP_FLOAT_TYPE
/* Optional Lisp floating point type */
struct Lisp_Float
  {
    Lisp_Object type;		/* essentially used for mark-bit 
				   and chaining when on free-list */
    double data;  
  };
#endif /* LISP_FLOAT_TYPE */

/* A character, declared with the following typedef, is a member
686
   of some character set associated with the current buffer.  */
687 688
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
689
typedef unsigned char UCHAR;
690
#endif
Jim Blandy's avatar
Jim Blandy committed
691 692 693 694 695 696 697 698 699

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

701 702
/* Flag bits in a character.  These also get used in termhooks.h.
   Richard Stallman <rms@gnu.ai.mit.edu> thinks that MULE
703 704 705 706 707 708 709 710
   (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)
711

712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
#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 */

740 741 742 743 744 745 746 747 748 749 750 751

/* The glyph datatype, used to represent characters on the display.  */

/* The low eight bits are the character code, and the bits above them
   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; given that we have no mechanism for
   tossing unused frame face ID's yet, we'll probably run out of 255
   pretty quickly.  */
#define GLYPH unsigned int

Morten Welinder's avatar
Morten Welinder committed
752
#ifdef HAVE_FACES
753 754
/* The FAST macros assume that we already know we're in an X window.  */

755
/* Given a character code and a face ID, return the appropriate glyph.  */
756
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
757 758

/* Return a glyph's character code.  */
759
#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
760 761

/* Return a glyph's face ID.  */
762 763 764 765 766 767 768
#define FAST_GLYPH_FACE(glyph) (((glyph) >> 8) & ((1 << 24) - 1))

/* Slower versions that test the frame type first.  */
#define MAKE_GLYPH(f, char, face) (FRAME_TERMCAP_P (f) ? (char) \
				   : FAST_MAKE_GLYPH (char, face))
#define GLYPH_CHAR(f, g) (FRAME_TERMCAP_P (f) ? (g) : FAST_GLYPH_CHAR (g))
#define GLYPH_FACE(f, g) (FRAME_TERMCAP_P (f) ? (0) : FAST_GLYPH_FACE (g))
Morten Welinder's avatar
Morten Welinder committed
769
#else /* not HAVE_FACES */
770 771 772
#define MAKE_GLYPH(f, char, face) (char)
#define GLYPH_CHAR(f, g) (g)
#define GLYPH_FACE(f, g) (g)
Morten Welinder's avatar
Morten Welinder committed
773
#endif /* not HAVE_FACES */
774

775 776
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
777 778 779

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
780
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
781
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
782

Jim Blandy's avatar
Jim Blandy committed
783
#ifdef LISP_FLOAT_TYPE
784
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
785
#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
786
#else
787
#define NUMBERP(x) (INTEGERP (x))
788
#define GC_NUMBERP(x) (GC_INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
789
#endif
Karl Heuer's avatar
Karl Heuer committed
790
#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
791
#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
Jim Blandy's avatar
Jim Blandy committed
792

793
#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
794
#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
795
#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
796
#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
797
#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
798
#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
799 800
#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
801
#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
802
#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
Jim Blandy's avatar
Jim Blandy committed
803
#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
804
#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
805

Jim Blandy's avatar
Jim Blandy committed
806
#ifdef LISP_FLOAT_TYPE
807
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
808
#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
809 810
#else
#define FLOATP(x) (0)
811
#define GC_FLOATP(x) (0)
Jim Blandy's avatar
Jim Blandy committed
812
#endif
813 814
#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
815
#define OVERLAYP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
816
#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
817
#define MARKERP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
818
#define GC_MARKERP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
819
#define INTFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
820
#define GC_INTFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
821
#define BOOLFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
822
#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
823
#define OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
824
#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
825
#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
826
#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
827
#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
828
#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
829
#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
830
#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
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

/* True if object X is a pseudo vector whose code is CODE.  */
#define PSEUDOVECTORP(x, code)					\
  (VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

/* True if object X is a pseudo vector whose code is CODE.
   This one works during GC.  */
#define GC_PSEUDOVECTORP(x, code)				\
  (GC_VECTORLIKEP (x)						\
   && (((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code))))	\
       == (PSEUDOVECTOR_FLAG | (code))))

/* Test for specific pseudovector types.  */
#define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
#define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
#define PROCESSP(x) PSEUDOVECTORP (x, PVEC_PROCESS)
#define GC_PROCESSP(x) GC_PSEUDOVECTORP (x, PVEC_PROCESS)
#define WINDOWP(x) PSEUDOVECTORP (x, PVEC_WINDOW)
#define GC_WINDOWP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW)
#define SUBRP(x) PSEUDOVECTORP (x, PVEC_SUBR)
#define GC_SUBRP(x) GC_PSEUDOVECTORP (x, PVEC_SUBR)
#define COMPILEDP(x) PSEUDOVECTORP (x, PVEC_COMPILED)
#define GC_COMPILEDP(x) GC_PSEUDOVECTORP (x, PVEC_COMPILED)
857 858
#define BUFFERP(x) PSEUDOVECTORP (x, PVEC_BUFFER)
#define GC_BUFFERP(x) GC_PSEUDOVECTORP (x, PVEC_BUFFER)
859 860 861 862 863 864 865 866 867 868 869 870 871 872

#ifdef MULTI_FRAME
#define FRAMEP(x) PSEUDOVECTORP (x, PVEC_FRAME)
#define GC_FRAMEP(x) GC_PSEUDOVECTORP (x, PVEC_FRAME)
#else
#ifdef HAVE_MOUSE
/* We could use this in the !HAVE_MOUSE case also, but we prefer a compile-time
   error message in case FRAMEP is used.  */
#define FRAMEP(x) (EQ (x, Fselected_frame ()))
#define GC_FRAMEP(x) (GC_EQ (x, Fselected_frame ()))
#endif
#endif


Jim Blandy's avatar
Jim Blandy committed
873
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
874
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
875

Jim Blandy's avatar
Jim Blandy committed
876
#define CHECK_LIST(x, i) \
877
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
878 879

#define CHECK_STRING(x, i) \
880
  do { if (!STRINGP ((x))) x = wrong_type_argument (Qstringp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
881 882

#define CHECK_CONS(x, i) \
883
  do { if (!CONSP ((x))) x = wrong_type_argument (Qconsp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
884 885

#define CHECK_SYMBOL(x, i) \
886
  do { if (!SYMBOLP ((x))) x = wrong_type_argument (Qsymbolp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
887 888

#define CHECK_VECTOR(x, i) \
889
  do { if (!VECTORP ((x))) x = wrong_type_argument (Qvectorp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
890 891

#define CHECK_BUFFER(x, i) \
892
  do { if (!BUFFERP ((x))) x = wrong_type_argument (Qbufferp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
893 894

#define CHECK_WINDOW(x, i) \
895
  do { if (!WINDOWP ((x))) x = wrong_type_argument (Qwindowp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
896

897 898 899 900 901 902 903 904
/* This macro rejects windows on the interior of the window tree as
   "dead", which is what we want; this is an argument-checking macro, and 
   the user should never get access to interior windows.

   A window of any sort, leaf or interior, is dead iff the buffer,
   vchild, and hchild members are all nil.  */

#define CHECK_LIVE_WINDOW(x, i)				\
905
  do {							\
906
    if (!WINDOWP ((x))					\
907
	|| NILP (XWINDOW ((x))->buffer))		\
908
      x = wrong_type_argument (Qwindow_live_p, (x));	\
909
  } while (0)
910

Jim Blandy's avatar
Jim Blandy committed
911
#define CHECK_PROCESS(x, i) \
912
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
913 914

#define CHECK_NUMBER(x, i) \
915
  do { if (!INTEGERP ((x))) x = wrong_type_argument (Qintegerp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
916 917

#define CHECK_NATNUM(x, i) \
Karl Heuer's avatar
Karl Heuer committed
918
  do { if (!NATNUMP (x)) x = wrong_type_argument (Qwholenump, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
919 920

#define CHECK_MARKER(x, i) \
921
  do { if (!MARKERP ((x))) x = wrong_type_argument (Qmarkerp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
922 923

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
924
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
925
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
926 927 928 929 930 931 932 933 934 935

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

#define XFLOATINT(n) extract_float((n))

#define CHECK_FLOAT(x, i)		\
936
  do { if (!FLOATP (x))			\
937
    x = wrong_type_argument (Qfloatp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
938 939

#define CHECK_NUMBER_OR_FLOAT(x, i)	\
940
  do { if (!FLOATP (x) && !INTEGERP (x))	\
941
    x = wrong_type_argument (Qnumberp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
942 943

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
944
  do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));	\
945
  else if (!INTEGERP (x) && !FLOATP (x))		\
946
    x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
947 948 949 950 951 952 953 954 955 956

#else  /* Not LISP_FLOAT_TYPE */

#define CHECK_NUMBER_OR_FLOAT CHECK_NUMBER

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER CHECK_NUMBER_COERCE_MARKER

#define XFLOATINT(n) XINT((n))
#endif /* LISP_FLOAT_TYPE */

Jim Blandy's avatar
Jim Blandy committed
957
#define CHECK_OVERLAY(x, i) \
958
  do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
Jim Blandy's avatar
Jim Blandy committed
959

Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
/* Cast pointers to this type to compare them.  Some machines want int.  */
#ifndef PNTR_COMPARISON_TYPE
#define PNTR_COMPARISON_TYPE unsigned int
#endif

/* Define a built-in function for calling from Lisp.
 `lname' should be the name to give the function in Lisp,
    as a null-terminated C string.
 `fnname' should be the name of the function in C.
    By convention, it starts with F.
 `sname' should be the name for the C constant structure
    that records information on this function for internal use.
    By convention, it should be the same as `fnname' but with S instead of F.
    It's too bad that C macros can't compute this from `fnname'.
 `minargs' should be a number, the minimum number of arguments allowed.
 `maxargs' should be a number, the maximum number of arguments allowed,
    or else MANY or UNEVALLED.
    MANY means pass a vector of evaluated arguments,
	 in the form of an integer number-of-arguments
	 followed by the address of a vector of Lisp_Objects
	 which contains the argument values.
    UNEVALLED means pass the list of unevaluated arguments
 `prompt' says how to read arguments for an interactive call.
Richard M. Stallman's avatar
Richard M. Stallman committed
983
    See the doc string for `interactive'.
Jim Blandy's avatar
Jim Blandy committed
984
    A null string means call interactively with no arguments.
Richard M. Stallman's avatar
Richard M. Stallman committed
985
 `doc' is documentation for the user.  */
Jim Blandy's avatar
Jim Blandy committed
986

987
#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
988 989 990 991 992
#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc)	\
  Lisp_Object fnname ();						\
  struct Lisp_Subr sname =						\
    { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)),	\
      fnname, minargs, maxargs, lname, prompt, 0};			\
Jim Blandy's avatar
Jim Blandy committed
993 994
  Lisp_Object fnname

995 996 997
#else

/* This version of DEFUN declares a function prototype with the right
998
   arguments, so we can catch errors with maxargs at compile-time.  */
999 1000 1001 1002 1003
#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc)	\
  Lisp_Object fnname DEFUN_ARGS_ ## maxargs ;				\
  struct Lisp_Subr sname =						\
    { PVEC_SUBR | (sizeof (struct Lisp_Subr) / sizeof (EMACS_INT)),	\
      fnname, minargs, maxargs, lname, prompt, 0};			\
1004 1005 1006
  Lisp_Object fnname

/* Note that the weird token-substitution semantics of ANSI C makes
1007
   this work for MANY and UNEVALLED.  */
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
#define DEFUN_ARGS_MANY		(int, Lisp_Object *)
#define DEFUN_ARGS_UNEVALLED	(Lisp_Object)
#define DEFUN_ARGS_0	(void)
#define DEFUN_ARGS_1	(Lisp_Object)
#define DEFUN_ARGS_2	(Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_3	(Lisp_Object, Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_4	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_5	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object)
#define DEFUN_ARGS_6	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object, Lisp_Object)
#define DEFUN_ARGS_7	(Lisp_Object, Lisp_Object, Lisp_Object, Lisp_Object, \
			 Lisp_Object, Lisp_Object, Lisp_Object)
#endif

Jim Blandy's avatar
Jim Blandy committed
1023
/* defsubr (Sname);
1024
 is how we define the symbol for function `name' at start-up time.  */
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
extern void defsubr ();

#define MANY -2
#define UNEVALLED -1

extern void defvar_lisp ();
extern void defvar_bool ();
extern void defvar_int ();

/* Macros we use to define forwarded Lisp variables.
   These are used in the syms_of_FILENAME functions.  */

#define DEFVAR_LISP(lname, vname, doc) defvar_lisp (lname, vname)
#define DEFVAR_LISP_NOPRO(lname, vname, doc) defvar_lisp_nopro (lname, vname)
#define DEFVAR_BOOL(lname, vname, doc) defvar_bool (lname, vname)
#define DEFVAR_INT(lname, vname, doc) defvar_int (lname, vname)
Jim Blandy's avatar
Jim Blandy committed
1041 1042
#define DEFVAR_PER_BUFFER(lname, vname, type, doc)  \
 defvar_per_buffer (lname, vname, type, 0)
Jim Blandy's avatar
Jim Blandy committed
1043

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
/* Structure for recording Lisp call stack for backtrace purposes.  */

/* The special binding stack holds the outer values of variables while
   they are bound by a function application or a let form, stores the
   code to be executed for Lisp unwind-protect forms, and stores the C
   functions to be called for record_unwind_protect.

   If func is non-zero, undoing this binding applies func to old_value;
      This implements record_unwind_protect.
   If func is zero and symbol is nil, undoing this binding evaluates
      the list of forms in old_value; this implements Lisp's unwind-protect
      form.
   Otherwise, undoing this binding stores old_value as symbol's value; this
      undoes the bindings made by a let form or function call.  */
Jim Blandy's avatar
Jim Blandy committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
struct specbinding
  {
    Lisp_Object symbol, old_value;
    Lisp_Object (*func) ();
    Lisp_Object unused;		/* Dividing by 16 is faster than by 12 */
  };

extern struct specbinding *specpdl;
extern struct specbinding *specpdl_ptr;
extern int specpdl_size;

1069
/* Everything needed to describe an active condition case.  */
Jim Blandy's avatar
Jim Blandy committed
1070 1071
struct handler
  {
1072
    /* The handler clauses and variable from the condition-case form.  */
Jim Blandy's avatar
Jim Blandy committed
1073 1074
    Lisp_Object handler;
    Lisp_Object var;
1075 1076 1077
    /* Fsignal stores here the condition-case clause that applies,
       and Fcondition_case thus knows which clause to run.  */
    Lisp_Object chosen_clause;
1078 1079

    /* Used to effect the longjump out to the handler.  */
Jim Blandy's avatar
Jim Blandy committed
1080
    struct catchtag *tag;
1081 1082

    /* The next enclosing handler.  */
Jim Blandy's avatar
Jim Blandy committed
1083 1084 1085 1086 1087 1088 1089 1090
    struct handler *next;
  };

extern struct handler *handlerlist;

extern struct catchtag *catchlist;
extern struct backtrace *backtrace_list;

1091 1092
extern Lisp_Object memory_signal_data;

Jim Blandy's avatar
Jim Blandy committed
1093 1094 1095 1096
/* An address near the bottom of the stack.
   Tells GC how to save a copy of the stack.  */
extern char *stack_bottom;

1097
/* Check quit-flag and quit if it is non-nil.  */
Jim Blandy's avatar
Jim Blandy committed
1098 1099

#define QUIT \
Jim Blandy's avatar
Jim Blandy committed
1100
  if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
Jim Blandy's avatar
Jim Blandy committed
1101 1102 1103 1104
    { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }

/* Nonzero if ought to quit now.  */

Jim Blandy's avatar
Jim Blandy committed
1105
#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
Jim Blandy's avatar
Jim Blandy committed
1106 1107 1108

/* 1 if CH is upper case.  */

Jim Blandy's avatar
Jim Blandy committed
1109 1110
#define UPPERCASEP(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1111 1112 1113 1114

/* 1 if CH is lower case.  */

#define LOWERCASEP(CH) \
Jim Blandy's avatar
Jim Blandy committed
1115 1116
  (!UPPERCASEP (CH) \
   && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120 1121 1122 1123

/* 1 if CH is neither upper nor lower case.  */

#define NOCASEP(CH) (XSTRING (current_buffer->upcase_table)->data[CH] == (CH))

/* Upcase a character, or make no change if that cannot be done.  */

Jim Blandy's avatar
Jim Blandy committed
1124 1125 1126
#define UPCASE(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
   ? UPCASE1 (CH) : (CH))
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129 1130 1131

/* Upcase a character known to be not upper case.  */

#define UPCASE1(CH) (XSTRING (current_buffer->upcase_table)->data[CH])

1132
/* Downcase a character, or make no change if that cannot be done.  */
Jim Blandy's avatar
Jim Blandy committed
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

#define DOWNCASE(CH) (XSTRING (current_buffer->downcase_table)->data[CH])

/* Current buffer's map from characters to lower-case characters.  */

#define DOWNCASE_TABLE XSTRING (current_buffer->downcase_table)->data

/* Table mapping each char to the next char with the same lowercase version.
   This mapping is a no-op only for characters that don't have case.  */
#define UPCASE_TABLE XSTRING (current_buffer->upcase_table)->data

extern Lisp_Object Vascii_downcase_table, Vascii_upcase_table;
1145
extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
Jim Blandy's avatar
Jim Blandy committed
1146

1147
/* Number of bytes of structure consed since last GC.  */
Jim Blandy's avatar
Jim Blandy committed
1148 1149 1150

extern int consing_since_gc;

1151
/* Threshold for doing another gc.  */
Jim Blandy's avatar
Jim Blandy committed
1152 1153 1154

extern int gc_cons_threshold;

1155
/* Structure for recording stack slots that need marking.  */
Jim Blandy's avatar
Jim Blandy committed
1156 1157 1158 1159 1160 1161

/* This is a chain of structures, each of which points at a Lisp_Object variable
 whose value should be marked in garbage collection.
 Normally every link of the chain is an automatic variable of a function,
 and its `val' points to some argument or local variable of the function.
 On exit to the function, the chain is set back to the value it had on entry.
Brian Fox's avatar
Brian Fox committed
1162 1163
 This way, no link remains in the chain when the stack frame containing the
 link disappears.
Jim Blandy's avatar
Jim Blandy committed
1164 1165

 Every function that can call Feval must protect in this fashion all
1166
 Lisp_Object variables whose contents will be used again.  */
Jim Blandy's avatar
Jim Blandy committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194