lisp.h 55.1 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

Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33 34 35 36 37 38 39 40
/* Define the fundamental Lisp data structures */

/* This is the set of Lisp data types */

enum Lisp_Type
  {
    /* Integer.  XINT(obj) is the integer value. */
    Lisp_Int,

    /* Symbol.  XSYMBOL (object) points to a struct Lisp_Symbol. */
    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 46 47 48

    /* String.  XSTRING (object) points to a struct Lisp_String.
       The length of the string, and its contents, are stored therein. */
    Lisp_String,

49 50 51 52 53
    /* Vector of Lisp objects, or something resembling it.
       XVECTOR(object) points to a struct Lisp_Vector, which contains
       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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

    /* Cons.  XCONS (object) points to a struct Lisp_Cons. */
    Lisp_Cons,

    /* Byte-compiled function.  A vector of 4 to 6 elements which are the
       arglist, bytecode-string, constant vector, stack size,
       (optional) doc string, and (optional) interactive spec.  */
    Lisp_Compiled,

    /* Editor buffer.  XBUFFER(obj) points to a struct buffer.  */
    Lisp_Buffer,

    /* Built-in function.  XSUBR(obj) points to a struct Lisp_Subr
       which describes how to call the function, and its documentation,
       as well as pointing to the code. */
    Lisp_Subr,

    /* Object describing a connection to a subprocess.
       It points to storage of type  struct Lisp_Process  */
    Lisp_Process,

75
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
76
    /* Pointer to a vector-like object describing a display frame
77 78 79
       on which Emacs can display a window hierarchy.  We don't define
       this unless MULTI_FRAME is defined; this helps the compiler catch
       code that won't work on a non-MULTI_FRAME configuration.  */
Jim Blandy's avatar
Jim Blandy committed
80
    Lisp_Frame,
81
#endif
Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86 87

    /* Window used for Emacs display.
       Data inside looks like a Lisp_Vector.  */
    Lisp_Window,

    /* Used by save,set,restore-window-configuration */
88
    OBSOLETE_Lisp_Window_Configuration,
Jim Blandy's avatar
Jim Blandy committed
89 90

#ifdef LISP_FLOAT_TYPE
Jim Blandy's avatar
Jim Blandy committed
91
    Lisp_Float,
Jim Blandy's avatar
Jim Blandy committed
92 93 94
#endif /* LISP_FLOAT_TYPE */
  };

95
/* This is the set of datatypes that share a common structure.
Karl Heuer's avatar
Karl Heuer committed
96 97 98
   The first member of the structure is a type code from this set.  */
enum Lisp_Misc_Type
  {
99
    Lisp_Misc_Free,
100
    Lisp_Misc_Marker,
101 102 103
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
104 105
    Lisp_Misc_Buffer_Objfwd,
    Lisp_Misc_Buffer_Local_Value,
106 107
    Lisp_Misc_Some_Buffer_Local_Value,
    Lisp_Misc_Overlay
Karl Heuer's avatar
Karl Heuer committed
108 109
  };

Jim Blandy's avatar
Jim Blandy committed
110 111
#ifndef NO_UNION_TYPE

112
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

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

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
       also, positive integers can be accessed fast this way. */
    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;

144
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

typedef
union Lisp_Object
  {
    /* Used for comparing two Lisp_Objects;
       also, positive integers can be accessed fast this way. */
    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;

174
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181 182 183

#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

184
#define Lisp_Object EMACS_INT
Jim Blandy's avatar
Jim Blandy committed
185 186 187 188 189 190 191 192 193 194 195

/* These values are overridden by the m- file on some machines.  */
#ifndef VALBITS
#define VALBITS 24
#endif

#ifndef GCTYPEBITS
#define GCTYPEBITS 7
#endif

#ifndef VALMASK
196
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
197
#endif
198
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
199 200 201 202 203 204 205 206 207 208 209 210 211

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

212
#ifndef MARKBIT
Jim Blandy's avatar
Jim Blandy committed
213
#define MARKBIT (1 << (VALBITS + GCTYPEBITS))
214
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
215

216 217 218 219 220 221 222
/* 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 */

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
/* 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.  */
#define PVEC_BUFFER	0x100
#define PVEC_PROCESS	0x200
#define PVEC_FRAME	0x400
#define PVEC_COMPILED	0x800
#define PVEC_WINDOW	0x1000
#define PVEC_WINDOW_CONFIGURATION	0x2000

/* 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
243 244 245
you lose
#endif

Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
#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,
 XCONS (tem) is the struct Lisp_Cons * pointing to the memory for that cons. */

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

Karl Heuer's avatar
Karl Heuer committed
266 267 268
/* 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.  */
269
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
270
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274

/* 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
275
#define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280 281 282 283 284 285 286 287
#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
288
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
289
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
290
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
#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) \
307
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
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 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
#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
350 351 352
/* 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.  */
353
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
354
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

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


#define XCONS(a) ((struct Lisp_Cons *) XPNTR(a))
#define XBUFFER(a) ((struct buffer *) XPNTR(a))
#define XVECTOR(a) ((struct Lisp_Vector *) XPNTR(a))
#define XSUBR(a) ((struct Lisp_Subr *) XPNTR(a))
#define XSTRING(a) ((struct Lisp_String *) XPNTR(a))
#define XSYMBOL(a) ((struct Lisp_Symbol *) XPNTR(a))
390
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Jim Blandy's avatar
Jim Blandy committed
391 392 393
#define XWINDOW(a) ((struct window *) XPNTR(a))
#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
394
#define XMARKER(a) (&(XMISC(a)->u_marker))
395 396 397 398
#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))
399
#define XBUFFER_LOCAL_VALUE(a) (&(XMISC(a)->u_buffer_local_value))
400
#define XOVERLAY(a) (&(XMISC(a)->u_overlay))
Jim Blandy's avatar
Jim Blandy committed
401

402 403 404
#define XSETINT(a, b) XSET (a, Lisp_Int, b)
#define XSETCONS(a, b) XSET (a, Lisp_Cons, b)
#define XSETBUFFER(a, b) XSET (a, Lisp_Buffer, b)
405
#define XSETVECTOR(a, b) XSET (a, Lisp_Vectorlike, b)
406 407 408
#define XSETSUBR(a, b) XSET (a, Lisp_Subr, b)
#define XSETSTRING(a, b) XSET (a, Lisp_String, b)
#define XSETSYMBOL(a, b) XSET (a, Lisp_Symbol, b)
409
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
410 411 412
#define XSETWINDOW(a, b) XSET (a, Lisp_Window, b)
#define XSETPROCESS(a, b) XSET (a, Lisp_Process, b)
#define XSETFLOAT(a, b) XSET (a, Lisp_Float, b)
413 414
#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))
Karl Heuer's avatar
Karl Heuer committed
415
#define XSETCOMPILED(a, b) XSET (a, Lisp_Compiled, b)
416
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISC (a)->type = Lisp_Misc_Marker)
Jim Blandy's avatar
Jim Blandy committed
417

418 419 420 421 422 423 424 425 426 427 428
#ifdef USE_TEXT_PROPERTIES
/* Basic data type for use of intervals.  See the macros in intervals.h */

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

  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. */
429 430 431 432 433 434 435 436 437 438 439 440

  /* 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;
441 442 443 444 445 446 447

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

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

452 453 454 455 456
  /* 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;
457 458 459 460 461 462
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
463
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
464 465 466 467 468 469
      x = wrong_type_argument (Qbuffer_or_string_p, (x)); }

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

470
/* Macro used to conditionally compile interval initialization into
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
   certain code.  See, e.g., alloc.c. */
#define INITIALIZE_INTERVAL(ptr,val) ptr->intervals = val

#else  /* No text properties */

/* If no intervals are used, make the above definitions go away. */

#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
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/* 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
  {
507
    EMACS_INT size;
508
    DECLARE_INTERVALS		/* `data' field must be last. */
Jim Blandy's avatar
Jim Blandy committed
509 510 511
    unsigned char data[1];
  };

Karl Heuer's avatar
Karl Heuer committed
512 513 514 515 516 517
/* 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
518 519
struct Lisp_Vector
  {
520
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
    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 */
  };

struct Lisp_Subr
  {
    Lisp_Object (*function) ();
    short min_args, max_args;
    char *symbol_name;
    char *prompt;
    char *doc;
  };
544 545 546 547 548 549 550

/* 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
551 552 553 554

/* 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
555
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Marker */
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559 560
    struct buffer *buffer;
    Lisp_Object chain;
    int bufpos;
  };

561 562 563 564 565
/* 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
566
  {
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    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;
597 598
  };

599 600 601 602
/* 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).

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

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
   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,
   we just examine or set REALVALUE. If BUFFER is not current, we
   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;
  };

646 647 648 649 650 651 652 653
/* 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;
  };
654 655 656 657 658
union Lisp_Misc
  {
    enum Lisp_Misc_Type type;
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
659 660 661 662
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
663
    struct Lisp_Buffer_Local_Value u_buffer_local_value;
664
    struct Lisp_Overlay u_overlay;
665 666
  };

Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671 672 673 674 675 676 677 678
#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
   of some character set associated with the current buffer. */
679 680
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
681
typedef unsigned char UCHAR;
682
#endif
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688 689 690 691

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

693 694 695 696 697 698 699 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
   (MUlti-Lingual Emacs) might need 18 bits for the character value
   itself, so we probably shouldn't use any bits lower than 0x040000.  */
#define CHAR_ALT   (0x040000)
#define CHAR_SUPER (0x080000)
#define CHAR_HYPER (0x100000)
#define CHAR_SHIFT (0x200000)
#define CHAR_CTL   (0x400000)
#define CHAR_META  (0x800000)
703

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
#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 */

732 733 734 735 736 737 738 739 740 741 742 743

/* 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
744
#ifdef HAVE_FACES
745 746
/* The FAST macros assume that we already know we're in an X window.  */

747
/* Given a character code and a face ID, return the appropriate glyph.  */
748
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
749 750

/* Return a glyph's character code.  */
751
#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
752 753

/* Return a glyph's face ID.  */
754 755 756 757 758 759 760
#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
761
#else /* not HAVE_FACES */
762 763 764
#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
765
#endif /* not HAVE_FACES */
766

767 768
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
769 770 771

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
772
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
773
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
774

Jim Blandy's avatar
Jim Blandy committed
775
#ifdef LISP_FLOAT_TYPE
776
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
777
#define GC_NUMBERP(x) (GC_INTEGERP (x) || GC_FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
778
#else
779
#define NUMBERP(x) (INTEGERP (x))
780
#define GC_NUMBERP(x) (GC_INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
781
#endif
Karl Heuer's avatar
Karl Heuer committed
782
#define NATNUMP(x) (INTEGERP (x) && XINT (x) >= 0)
783
#define GC_NATNUMP(x) (GC_INTEGERP (x) && XINT (x) >= 0)
Jim Blandy's avatar
Jim Blandy committed
784

785
#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
786
#define GC_INTEGERP(x) (XGCTYPE ((x)) == Lisp_Int)
787
#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
788
#define GC_SYMBOLP(x) (XGCTYPE ((x)) == Lisp_Symbol)
789
#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
790
#define GC_MISCP(x) (XGCTYPE ((x)) == Lisp_Misc)
791 792
#define VECTORLIKEP(x) (XTYPE ((x)) == Lisp_Vectorlike)
#define GC_VECTORLIKEP(x) (XGCTYPE ((x)) == Lisp_Vectorlike)
793
#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
794
#define GC_STRINGP(x) (XGCTYPE ((x)) == Lisp_String)
Jim Blandy's avatar
Jim Blandy committed
795
#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
796
#define GC_CONSP(x) (XGCTYPE ((x)) == Lisp_Cons)
797
#define COMPILEDP(x) (XTYPE ((x)) == Lisp_Compiled)
798
#define GC_COMPILEDP(x) (XGCTYPE ((x)) == Lisp_Compiled)
799
#define BUFFERP(x) (XTYPE ((x)) == Lisp_Buffer)
800
#define GC_BUFFERP(x) (XGCTYPE ((x)) == Lisp_Buffer)
801
#define SUBRP(x) (XTYPE ((x)) == Lisp_Subr)
802
#define GC_SUBRP(x) (XGCTYPE ((x)) == Lisp_Subr)
803
#define PROCESSP(x) (XTYPE ((x)) == Lisp_Process)
804
#define GC_PROCESSP(x) (XGCTYPE ((x)) == Lisp_Process)
Morten Welinder's avatar
Morten Welinder committed
805
#ifdef MULTI_FRAME
806
#define FRAMEP(x) (XTYPE ((x)) == Lisp_Frame)
807
#define GC_FRAMEP(x) (XGCTYPE ((x)) == Lisp_Frame)
Morten Welinder's avatar
Morten Welinder committed
808
#else
809
#ifdef HAVE_MOUSE
810
/* We could use this in the !HAVE_MOUSE case also, but we prefer a compile-time
Morten Welinder's avatar
Morten Welinder committed
811 812
   error message in case FRAMEP is used.  */
#define FRAMEP(x) (EQ (x, Fselected_frame ()))
813
#define GC_FRAMEP(x) (GC_EQ (x, Fselected_frame ()))
Morten Welinder's avatar
Morten Welinder committed
814 815
#endif
#endif
816
#define WINDOWP(x) (XTYPE ((x)) == Lisp_Window)
817
#define GC_WINDOWP(x) (XGCTYPE ((x)) == Lisp_Window)
818 819 820 821
#define PSEUDOVECTORP(x, code) (VECTORLIKEP (x) && ((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) == PSEUDOVECTOR_FLAG | (code))
#define GC_PSEUDOVECTORP(x, code) (GC_VECTORLIKEP (x) && ((XVECTOR (x)->size & (PSEUDOVECTOR_FLAG | (code)))) == PSEUDOVECTOR_FLAG | (code))
#define WINDOW_CONFIGURATIONP(x) PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
#define GC_WINDOW_CONFIGURATIONP(x) GC_PSEUDOVECTORP (x, PVEC_WINDOW_CONFIGURATION)
Jim Blandy's avatar
Jim Blandy committed
822
#ifdef LISP_FLOAT_TYPE
823
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
824
#define GC_FLOATP(x) (XGCTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
825 826
#else
#define FLOATP(x) (0)
827
#define GC_FLOATP(x) (0)
Jim Blandy's avatar
Jim Blandy committed
828
#endif
829 830
#define VECTORP(x) (VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
#define GC_VECTORP(x) (GC_VECTORLIKEP (x) && !(XVECTOR (x)->size & PSEUDOVECTOR_FLAG))
831
#define OVERLAYP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
832
#define GC_OVERLAYP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Overlay)
833
#define MARKERP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
834
#define GC_MARKERP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
835
#define INTFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
836
#define GC_INTFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
837
#define BOOLFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
838
#define GC_BOOLFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
839
#define OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
840
#define GC_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
841
#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
842
#define GC_BUFFER_OBJFWDP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
843
#define BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
844
#define GC_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Local_Value)
845
#define SOME_BUFFER_LOCAL_VALUEP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
846
#define GC_SOME_BUFFER_LOCAL_VALUEP(x) (GC_MISCP (x) && XMISC (x)->type == Lisp_Misc_Some_Buffer_Local_Value)
847

Jim Blandy's avatar
Jim Blandy committed
848
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
849
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
850

Jim Blandy's avatar
Jim Blandy committed
851
#define CHECK_LIST(x, i) \
852
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
853 854

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

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

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

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

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

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

872 873 874 875 876 877 878 879
/* 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)				\
880
  do {							\
881
    if (!WINDOWP ((x))					\
882
	|| NILP (XWINDOW ((x))->buffer))		\
883
      x = wrong_type_argument (Qwindow_live_p, (x));	\
884
  } while (0)
885

Jim Blandy's avatar
Jim Blandy committed
886
#define CHECK_PROCESS(x, i) \
887
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
888 889

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

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

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

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
899
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
900
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
901 902 903 904 905 906 907 908 909 910

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

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

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

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

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
919
  do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));	\
920
  else if (!INTEGERP (x) && !FLOATP (x))		\
921
    x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926 927 928 929 930 931

#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
932
#define CHECK_OVERLAY(x, i) \
933
  do { if (!OVERLAYP ((x))) x = wrong_type_argument (Qoverlayp, (x));} while (0)
Jim Blandy's avatar
Jim Blandy committed
934

Jim Blandy's avatar
Jim Blandy committed
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/* 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
958
    See the doc string for `interactive'.
Jim Blandy's avatar
Jim Blandy committed
959
    A null string means call interactively with no arguments.
Richard M. Stallman's avatar
Richard M. Stallman committed
960
 `doc' is documentation for the user.  */
Jim Blandy's avatar
Jim Blandy committed
961

962
#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
Jim Blandy's avatar
Jim Blandy committed
963 964 965 966 967
#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
  Lisp_Object fnname (); \
  struct Lisp_Subr sname = {fnname, minargs, maxargs, lname, prompt, 0}; \
  Lisp_Object fnname

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
#else

/* This version of DEFUN declares a function prototype with the right
   arguments, so we can catch errors with maxargs at compile-time. */
#define DEFUN(lname, fnname, sname, minargs, maxargs, prompt, doc) \
  Lisp_Object fnname DEFUN_ARGS_ ## maxargs ; \
  struct Lisp_Subr sname = {fnname, minargs, maxargs, lname, prompt, 0}; \
  Lisp_Object fnname

/* Note that the weird token-substitution semantics of ANSI C makes
   this work for MANY and UNEVALLED. */
#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
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
/* defsubr (Sname);
 is how we define the symbol for function `name' at start-up time. */
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
1012 1013
#define DEFVAR_PER_BUFFER(lname, vname, type, doc)  \
 defvar_per_buffer (lname, vname, type, 0)
Jim Blandy's avatar
Jim Blandy committed
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
/* 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
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
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;

1040
/* Everything needed to describe an active condition case.  */
Jim Blandy's avatar
Jim Blandy committed
1041 1042
struct handler
  {
1043
    /* The handler clauses and variable from the condition-case form.  */
Jim Blandy's avatar
Jim Blandy committed
1044 1045
    Lisp_Object handler;
    Lisp_Object var;
1046 1047 1048
    /* Fsignal stores here the condition-case clause that applies,
       and Fcondition_case thus knows which clause to run.  */
    Lisp_Object chosen_clause;
1049 1050

    /* Used to effect the longjump out to the handler.  */
Jim Blandy's avatar
Jim Blandy committed
1051
    struct catchtag *tag;
1052 1053

    /* The next enclosing handler.  */
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057 1058 1059 1060 1061
    struct handler *next;
  };

extern struct handler *handlerlist;

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

1062 1063
extern Lisp_Object memory_signal_data;

Jim Blandy's avatar
Jim Blandy committed
1064 1065 1066 1067 1068 1069 1070
/* An address near the bottom of the stack.
   Tells GC how to save a copy of the stack.  */
extern char *stack_bottom;

/* Check quit-flag and quit if it is non-nil. */

#define QUIT \
Jim Blandy's avatar
Jim Blandy committed
1071
  if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
Jim Blandy's avatar
Jim Blandy committed
1072 1073 1074 1075
    { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }

/* Nonzero if ought to quit now.  */

Jim Blandy's avatar
Jim Blandy committed
1076
#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
Jim Blandy's avatar
Jim Blandy committed
1077 1078 1079

/* 1 if CH is upper case.  */

Jim Blandy's avatar
Jim Blandy committed
1080 1081
#define UPPERCASEP(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1082 1083 1084 1085

/* 1 if CH is lower case.  */

#define LOWERCASEP(CH) \
Jim Blandy's avatar
Jim Blandy committed
1086 1087
  (!UPPERCASEP (CH) \
   && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092 1093 1094

/* 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
1095 1096 1097
#define UPCASE(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
   ? UPCASE1 (CH) : (CH))
Jim Blandy's avatar
Jim Blandy committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115

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

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

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

#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;
1116
extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

/* number of bytes of structure consed since last GC */

extern int consing_since_gc;

/* threshold for doing another gc */

extern int gc_cons_threshold;

/* Structure for recording stack slots that need marking */

/* 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
1133 1134
 This way, no link remains in the chain when the stack frame containing the
 link disappears.
Jim Blandy's avatar
Jim Blandy committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169

 Every function that can call Feval must protect in this fashion all
 Lisp_Object variables whose contents will be used again. */

extern struct gcpro *gcprolist;

struct gcpro
  {
    struct gcpro *next;
    Lisp_Object *var;		/* Address of first protected variable */
    int nvars;			/* Number of consecutive protected variables */
  };

#define GCPRO1(varname) \
 {gcpro1.next = gcprolist; gcpro1.var = &varname; gcpro1.nvars = 1; \
  gcprolist = &gcpro1; }

#define GCPRO2(varname1, varname2) \
 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
  gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
  gcprolist = &gcpro2; }

#define GCPRO3(varname1, varname2, varname3) \
 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
  gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
  gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
  gcprolist = &gcpro3; }

#define GCPRO4(varname1, varname2, varname3, varname4) \
 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
  gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
  gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
  gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
  gcprolist = &gcpro4; }

1170 1171 1172 1173 1174 1175 1176 1177
#define GCPRO5(varname1, varname2, varname3, varname4, varname5) \
 {gcpro1.next = gcprolist; gcpro1.var = &varname1; gcpro1.nvars = 1; \
  gcpro2.next = &gcpro1; gcpro2.var = &varname2; gcpro2.nvars = 1; \
  gcpro3.next = &gcpro2; gcpro3.var = &varname3; gcpro3.nvars = 1; \
  gcpro4.next = &gcpro3; gcpro4.var = &varname4; gcpro4.nvars = 1; \
  gcpro5.next = &gcpro4; gcpro5.var = &varname5; gcpro5.nvars = 1; \
  gcprolist = &gcpro5; }

Jim Blandy's avatar
Jim Blandy committed
1178 1179 1180 1181 1182 1183
/* Call staticpro (&var) to protect static variable `var'. */

void staticpro();
  
#define UNGCPRO (gcprolist = gcpro1.next)

Richard M. Stallman's avatar
Richard M. Stallman committed
1184
/* Evaluate expr, UNGCPRO, and then return the value of expr.  */
1185
#define RETURN_UNGCPRO(expr)			\
1186
if (1)						\
1187 1188 1189 1190 1191 1192
    {						\
      Lisp_Object ret_ungc_val;			\
      ret_ungc_val = (expr);			\
      UNGCPRO;					\
      return ret_ungc_val;			\
    }						\
1193
else
Jim Blandy's avatar
Jim Blandy committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

/* Defined in data.c */
extern Lisp_Object Qnil, Qt, Qquote, Qlambda, Qsubr, Qunbound;
extern Lisp_Object Qerror_conditions, Qerror_message, Qtop_level;
extern Lisp_Object Qerror, Qquit, Qwrong_type_argument, Qargs_out_of_range;
extern Lisp_Object Qvoid_variable, Qvoid_function;
extern Lisp_Object Qsetting_constant, Qinvalid_read_syntax;
extern Lisp_Object Qinvalid_function, Qwrong_number_of_arguments, Qno_catch;
extern Lisp_Object Qend_of_file, Qarith_error;
extern Lisp_Object Qbeginning_of_buffer, Qend_of_buffer, Qbuffer_read_only;
Roland McGrath's avatar
Roland McGrath committed
1204
extern Lisp_Object Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
1205

1206 1207
extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
extern Lisp_Object Qoverflow_error, Qunderflow_error;
1208

Richard M. Stallman's avatar
Richard M. Stallman committed
1209 1210
extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
1211 1212
extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
1213 1214
extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
extern Lisp_Object Qboundp, Qfboundp;
1215
extern Lisp_Object Qbuffer_or_string_p;
Jim Blandy's avatar
Jim Blandy committed
1216 1217 1218 1219 1220 1221
extern Lisp_Object Qcdr;

#ifdef LISP_FLOAT_TYPE
extern Lisp_Object Qfloatp, Qinteger_or_floatp, Qinteger_or_float_or_marker_p;
#endif /* LISP_FLOAT_TYPE */

Jim Blandy's avatar
Jim Blandy committed
1222
extern Lisp_Object Qframep;
Jim Blandy's avatar
Jim Blandy committed
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237

extern Lisp_Object Feq (), Fnull (), Flistp (), Fconsp (), Fatom (), Fnlistp ();
extern Lisp_Object Fintegerp (), Fnatnump (), Fsymbolp ();
extern Lisp_Object Fvectorp (), Fstringp (), Farrayp (), Fsequencep ();
extern Lisp_Object Fbufferp (), Fmarkerp (), Fsubrp (), Fchar_or_string_p ();
extern Lisp_Object Finteger_or_marker_p ();
#ifdef LISP_FLOAT_TYPE
extern Lisp_Object Ffloatp(), Finteger_or_floatp();
extern Lisp_Object Finteger_or_float_or_marker_p(), Ftruncate();
#endif /* LISP_FLOAT_TYPE */

extern Lisp_Object Fcar (), Fcar_safe(), Fcdr (), Fcdr_safe();
extern Lisp_Object Fsetcar (), Fsetcdr ();
extern Lisp_Object Fboundp (), Ffboundp (), Fmakunbound (), Ffmakunbound ();
extern Lisp_Object Fsymbol_function (), Fsymbol_plist (), Fsymbol_name ();
Jim Blandy's avatar
Jim Blandy committed
1238
extern Lisp_Object indirect_function (), Findirect_function ();
Jim Blandy's avatar
Jim Blandy committed
1239
extern Lisp_Object Ffset (), Fsetplist ();
Jim Blandy's avatar
Jim Blandy committed
1240
extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
1241
extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
Jim Blandy's avatar
Jim Blandy committed
1242

1243
extern Lisp_Object Faref (), Faset ();
Jim Blandy's avatar
Jim Blandy committed
1244

1245
extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
1246 1247 1248 1249 1250 1251 1252
extern Lisp_Object Feqlsign (), Fgtr (), Flss (), Fgeq (), Fleq ();
extern Lisp_Object Fneq (), Fzerop ();
extern Lisp_Object Fplus (), Fminus (), Ftimes (), Fquo (), Frem ();
extern Lisp_Object Fmax (), Fmin