lisp.h 52 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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

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

    /* Vector of Lisp objects.  XVECTOR(object) points to a struct Lisp_Vector.
       The length of the vector, and its contents, are stored therein. */
    Lisp_Vector,

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

73
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
74
    /* Pointer to a vector-like object describing a display frame
75 76 77
       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
78
    Lisp_Frame,
79
#endif
Jim Blandy's avatar
Jim Blandy committed
80 81

    /* Used in a symbol value cell when the symbol's value is per-buffer.
Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
       The actual contents are a cons cell which starts a list like this:
       (REALVALUE BUFFER CURRENT-ALIST-ELEMENT . DEFAULT-VALUE).

       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
108 109 110 111
       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.  */
Jim Blandy's avatar
Jim Blandy committed
112 113 114
    Lisp_Buffer_Local_Value,

    /* Like Lisp_Buffer_Local_Value with one difference:
Richard M. Stallman's avatar
Richard M. Stallman committed
115 116 117
       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.  */
Jim Blandy's avatar
Jim Blandy committed
118 119 120 121 122 123 124
    Lisp_Some_Buffer_Local_Value,

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

    /* Used by save,set,restore-window-configuration */
Jim Blandy's avatar
Jim Blandy committed
125
    Lisp_Window_Configuration,
Jim Blandy's avatar
Jim Blandy committed
126 127

#ifdef LISP_FLOAT_TYPE
Jim Blandy's avatar
Jim Blandy committed
128
    Lisp_Float,
Jim Blandy's avatar
Jim Blandy committed
129
#endif /* LISP_FLOAT_TYPE */
Jim Blandy's avatar
Jim Blandy committed
130 131 132 133 134 135 136 137

    /* The overlay type.
       An overlay values is actually a retagged cons, the first in a
       list of the form
           ((START . END) nil . PLIST)
       where START and END are markers in the overlay's buffer, and
       PLIST is the overlay's property list.  */
    Lisp_Overlay
Jim Blandy's avatar
Jim Blandy committed
138 139
  };

140
/* This is the set of datatypes that share a common structure.
Karl Heuer's avatar
Karl Heuer committed
141 142 143
   The first member of the structure is a type code from this set.  */
enum Lisp_Misc_Type
  {
144
    Lisp_Misc_Free,
145
    Lisp_Misc_Marker,
146 147 148 149
    Lisp_Misc_Intfwd,
    Lisp_Misc_Boolfwd,
    Lisp_Misc_Objfwd,
    Lisp_Misc_Buffer_Objfwd
Karl Heuer's avatar
Karl Heuer committed
150 151
  };

Jim Blandy's avatar
Jim Blandy committed
152 153
#ifndef NO_UNION_TYPE

154
#ifndef WORDS_BIG_ENDIAN
Jim Blandy's avatar
Jim Blandy committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

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

186
#else /* If WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

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;

216
#endif /* WORDS_BIG_ENDIAN */
Jim Blandy's avatar
Jim Blandy committed
217 218 219 220 221 222 223 224 225

#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

226
#define Lisp_Object EMACS_INT
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230 231 232 233 234 235 236 237

/* 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
238
#define VALMASK ((((EMACS_INT) 1)<<VALBITS) - 1)
Jim Blandy's avatar
Jim Blandy committed
239
#endif
240
#define GCTYPEMASK ((((EMACS_INT) 1)<<GCTYPEBITS) - 1)
241 242 243 244 245 246 247 248 249 250 251 252 253

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

254
#ifndef MARKBIT
Jim Blandy's avatar
Jim Blandy committed
255
#define MARKBIT (1 << (VALBITS + GCTYPEBITS))
256
#endif /*MARKBIT */
Jim Blandy's avatar
Jim Blandy committed
257

258 259 260 261 262 263 264 265 266 267 268
/* In the size word of a vector, this bit means the vector has been marked.
   In the size word of a large string, likewise.  */

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

#if ARRAY_MARK_FLAG == MARKBIT
you lose
#endif

Jim Blandy's avatar
Jim Blandy committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
#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
286
#define XSETTYPE(a, b) ((a)  =  XUINT (a) | ((EMACS_INT)(b) << VALBITS))
Jim Blandy's avatar
Jim Blandy committed
287 288
#endif

Karl Heuer's avatar
Karl Heuer committed
289 290 291
/* 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.  */
292
#define XFASTINT(a) ((a) + 0)
Karl Heuer's avatar
Karl Heuer committed
293
#define XSETFASTINT(a, b) ((a) = (b))
Jim Blandy's avatar
Jim Blandy committed
294 295 296 297

/* 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
298
#define XINT(a) (((a) << (INTBITS-VALBITS)) >> (INTBITS-VALBITS))
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302 303 304 305 306 307 308 309 310
#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
311
extern int pure_size;
Jim Blandy's avatar
Jim Blandy committed
312
#define XPNTR(a) \
Jim Blandy's avatar
Jim Blandy committed
313
  (XUINT (a) | (XUINT (a) > pure_size ? DATA_SEG_BITS : PURE_SEG_BITS))
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
#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) \
330
   ((var) = ((EMACS_INT)(type) << VALBITS) + ((EMACS_INT) (ptr) & VALMASK))
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 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 366 367 368 369 370 371 372
#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
373 374 375
/* 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.  */
376
#define XFASTINT(a) ((a).i + 0)
Karl Heuer's avatar
Karl Heuer committed
377
#define XSETFASTINT(a, b) ((a).i = (b))
Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

#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))
413
#define XMISC(a)   ((union Lisp_Misc *) XPNTR(a))
Jim Blandy's avatar
Jim Blandy committed
414 415 416
#define XWINDOW(a) ((struct window *) XPNTR(a))
#define XPROCESS(a) ((struct Lisp_Process *) XPNTR(a))
#define XFLOAT(a) ((struct Lisp_Float *) XPNTR(a))
417
#define XMARKER(a) (&(XMISC(a)->u_marker))
418 419 420 421
#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))
Jim Blandy's avatar
Jim Blandy committed
422

423 424 425 426 427 428 429
#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)
#define XSETVECTOR(a, b) XSET (a, Lisp_Vector, b)
#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)
430
#define XSETMISC(a, b) XSET (a, Lisp_Misc, b)
431 432 433 434
#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)
#define XSETWINDOW_CONFIGURATION(a, b) XSET (a, Lisp_Window_Configuration, b)
435
#define XSETMARKER(a, b) (XSETMISC (a, b), XMISC (a)->type = Lisp_Misc_Marker)
Jim Blandy's avatar
Jim Blandy committed
436

437 438 439 440 441 442 443 444 445 446 447
#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. */
448 449 450 451 452 453 454 455 456 457 458 459

  /* 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;
460 461 462 463 464 465 466

  /* 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. */
467
  unsigned char front_sticky;	    /* Non-zero means text inserted just
468
				       before this interval goes into it. */
469
  unsigned char rear_sticky;	    /* Likewise for just after it. */
470

471 472 473 474 475
  /* 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;
476 477 478 479 480 481
};

typedef struct interval *INTERVAL;

/* Complain if object is not string or buffer type */
#define CHECK_STRING_OR_BUFFER(x, i) \
482
  { if (!STRINGP ((x)) && !BUFFERP ((x))) \
483 484 485 486 487 488
      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;

489
/* Macro used to conditionally compile interval initialization into
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
   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
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
/* 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
  {
526
    EMACS_INT size;
527
    DECLARE_INTERVALS		/* `data' field must be last. */
Jim Blandy's avatar
Jim Blandy committed
528 529 530 531 532
    unsigned char data[1];
  };

struct Lisp_Vector
  {
533
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
    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;
  };
557 558 559 560 561 562 563

/* 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
564 565 566 567

/* 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
568
    enum Lisp_Misc_Type type;	/* = Lisp_Misc_Marker */
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572 573
    struct buffer *buffer;
    Lisp_Object chain;
    int bufpos;
  };

574 575 576 577 578
/* 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
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 605 606 607 608 609
    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;
610 611 612 613 614 615 616
  };

union Lisp_Misc
  {
    enum Lisp_Misc_Type type;
    struct Lisp_Free u_free;
    struct Lisp_Marker u_marker;
617 618 619 620
    struct Lisp_Intfwd u_intfwd;
    struct Lisp_Boolfwd u_boolfwd;
    struct Lisp_Objfwd u_objfwd;
    struct Lisp_Buffer_Objfwd u_buffer_objfwd;
621 622
  };

Jim Blandy's avatar
Jim Blandy committed
623 624 625 626 627 628 629 630 631 632 633 634
#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. */
635 636
#ifndef _UCHAR_T  /* Protect against something in ctab.h on AIX.  */
#define _UCHAR_T
Jim Blandy's avatar
Jim Blandy committed
637
typedef unsigned char UCHAR;
638
#endif
Jim Blandy's avatar
Jim Blandy committed
639 640 641 642 643 644 645 646 647

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

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

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
#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 */

688 689 690 691 692 693 694 695 696 697 698 699

/* 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
700
#ifdef HAVE_FACES
701 702
/* The FAST macros assume that we already know we're in an X window.  */

703
/* Given a character code and a face ID, return the appropriate glyph.  */
704
#define FAST_MAKE_GLYPH(char, face) ((char) | ((face) << 8))
705 706

/* Return a glyph's character code.  */
707
#define FAST_GLYPH_CHAR(glyph) ((glyph) & 0xff)
708 709

/* Return a glyph's face ID.  */
710 711 712 713 714 715 716
#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
717
#else /* not HAVE_FACES */
718 719 720
#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
721
#endif /* not HAVE_FACES */
722

723 724
/* The ID of the mode line highlighting face.  */
#define GLYPH_MODE_LINE_FACE 1
Jim Blandy's avatar
Jim Blandy committed
725 726 727

/* Data type checking */

Jim Blandy's avatar
Jim Blandy committed
728
#define NILP(x)  (XFASTINT (x) == XFASTINT (Qnil))
729
#define GC_NILP(x) GC_EQ (x, Qnil)
Jim Blandy's avatar
Jim Blandy committed
730

Jim Blandy's avatar
Jim Blandy committed
731
#ifdef LISP_FLOAT_TYPE
732
#define NUMBERP(x) (INTEGERP (x) || FLOATP (x))
Jim Blandy's avatar
Jim Blandy committed
733
#else
734
#define NUMBERP(x) (INTEGERP (x))
Jim Blandy's avatar
Jim Blandy committed
735 736
#endif

737 738
#define INTEGERP(x) (XTYPE ((x)) == Lisp_Int)
#define SYMBOLP(x) (XTYPE ((x)) == Lisp_Symbol)
739
#define MISCP(x) (XTYPE ((x)) == Lisp_Misc)
740 741
#define STRINGP(x) (XTYPE ((x)) == Lisp_String)
#define VECTORP(x) (XTYPE ((x)) == Lisp_Vector)
Jim Blandy's avatar
Jim Blandy committed
742
#define CONSP(x) (XTYPE ((x)) == Lisp_Cons)
743 744 745 746
#define COMPILEDP(x) (XTYPE ((x)) == Lisp_Compiled)
#define BUFFERP(x) (XTYPE ((x)) == Lisp_Buffer)
#define SUBRP(x) (XTYPE ((x)) == Lisp_Subr)
#define PROCESSP(x) (XTYPE ((x)) == Lisp_Process)
Morten Welinder's avatar
Morten Welinder committed
747
#ifdef MULTI_FRAME
748
#define FRAMEP(x) (XTYPE ((x)) == Lisp_Frame)
Morten Welinder's avatar
Morten Welinder committed
749 750 751 752 753 754 755
#else
#ifdef MSDOS
/* We could use this in the !MSDOS case also, but we prefer a compile-time
   error message in case FRAMEP is used.  */
#define FRAMEP(x) (EQ (x, Fselected_frame ()))
#endif
#endif
756 757
#define WINDOWP(x) (XTYPE ((x)) == Lisp_Window)
#define WINDOW_CONFIGURATIONP(x) (XTYPE ((x)) == Lisp_Window_Configuration)
Jim Blandy's avatar
Jim Blandy committed
758
#ifdef LISP_FLOAT_TYPE
759
#define FLOATP(x) (XTYPE ((x)) == Lisp_Float)
Jim Blandy's avatar
Jim Blandy committed
760 761 762 763
#else
#define FLOATP(x) (0)
#endif
#define OVERLAYP(x) (XTYPE ((x)) == Lisp_Overlay)
764 765
#define BUFFER_LOCAL_VALUEP(x) (XTYPE ((x)) == Lisp_Buffer_Local_Value)
#define SOME_BUFFER_LOCAL_VALUEP(x) (XTYPE ((x)) == Lisp_Some_Buffer_Local_Value)
766
#define MARKERP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Marker)
767 768 769 770
#define INTFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Intfwd)
#define BOOLFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Boolfwd)
#define OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Objfwd)
#define BUFFER_OBJFWDP(x) (MISCP (x) && XMISC (x)->type == Lisp_Misc_Buffer_Objfwd)
771

Jim Blandy's avatar
Jim Blandy committed
772
#define EQ(x, y) (XFASTINT (x) == XFASTINT (y))
773
#define GC_EQ(x, y) (XGCTYPE (x) == XGCTYPE (y) && XPNTR (x) == XPNTR (y))
Jim Blandy's avatar
Jim Blandy committed
774

Jim Blandy's avatar
Jim Blandy committed
775
#define CHECK_LIST(x, i) \
776
  do { if (!CONSP ((x)) && !NILP (x)) x = wrong_type_argument (Qlistp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
777 778

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

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

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

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

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

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

796 797 798 799 800 801 802 803
/* 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)				\
804
  do {							\
805
    if (!WINDOWP ((x))					\
806
	|| NILP (XWINDOW ((x))->buffer))		\
807
      x = wrong_type_argument (Qwindow_live_p, (x));	\
808
  } while (0)
809

Jim Blandy's avatar
Jim Blandy committed
810
#define CHECK_PROCESS(x, i) \
811
  do { if (!PROCESSP ((x))) x = wrong_type_argument (Qprocessp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
812 813

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

#define CHECK_NATNUM(x, i) \
817
  do { if (!INTEGERP ((x)) || XINT ((x)) < 0)	\
Richard M. Stallman's avatar
Richard M. Stallman committed
818
      x = wrong_type_argument (Qwholenump, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
819 820

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

#define CHECK_NUMBER_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
824
  do { if (MARKERP ((x))) XSETFASTINT (x, marker_position (x)); \
825
    else if (!INTEGERP ((x))) x = wrong_type_argument (Qinteger_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830 831 832 833 834 835

#ifdef LISP_FLOAT_TYPE

#ifndef DBL_DIG
#define DBL_DIG 20
#endif

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

#define CHECK_FLOAT(x, i)		\
836
  do { if (!FLOATP (x))			\
837
    x = wrong_type_argument (Qfloatp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
838 839

#define CHECK_NUMBER_OR_FLOAT(x, i)	\
840
  do { if (!FLOATP (x) && !INTEGERP (x))	\
841
    x = wrong_type_argument (Qnumberp, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
842 843

#define CHECK_NUMBER_OR_FLOAT_COERCE_MARKER(x, i) \
Karl Heuer's avatar
Karl Heuer committed
844
  do { if (MARKERP (x)) XSETFASTINT (x, marker_position (x));	\
845
  else if (!INTEGERP (x) && !FLOATP (x))		\
846
    x = wrong_type_argument (Qnumber_or_marker_p, (x)); } while (0)
Jim Blandy's avatar
Jim Blandy committed
847 848 849 850 851 852 853 854 855 856

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

Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
/* 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.
    This can be zero or a C string.
    Zero means that interactive calls are not allowed.
    A string is interpreted in a hairy way:
     it should contain one line for each argument to be read, terminated by \n.
     The first character of the line controls the type of parsing:
       s  --  read a string.
       S  --  read a symbol.
       k  --  read a key sequence and return it as a string.
       a  --  read a function name (symbol) with completion.
       C  --  read a command name (symbol) with completion.
       v  --  read a variable name (symbol) with completion.
       b  --  read a buffer name (a string) with completion.
       B  --  buffer name, may be existing buffer or may not be.
       f  --  read a file name, file must exist.
       F  --  read a file name, file need not exist.
       n  --  read a number.
       c  --  read a character and return it as a number.
       p  --  use the numeric value of the prefix argument.
       P  --  use raw value of prefix - can be nil, -, (NUMBER) or NUMBER.
       x  --  read a Lisp object from the minibuffer.
       X  --  read a Lisp form from the minibuffer and use its value.
    A null string means call interactively with no arguments.
 `doc' is documentation for the user.
*/

908
#if !defined (__STDC__) || defined (USE_NONANSI_DEFUN)
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913
#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

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
#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
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/* 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
958 959
#define DEFVAR_PER_BUFFER(lname, vname, type, doc)  \
 defvar_per_buffer (lname, vname, type, 0)
Jim Blandy's avatar
Jim Blandy committed
960

961 962 963 964 965 966 967 968 969 970 971 972 973 974
/* 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
975 976 977 978 979 980 981 982 983 984 985
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;

986
/* Everything needed to describe an active condition case.  */
Jim Blandy's avatar
Jim Blandy committed
987 988
struct handler
  {
989
    /* The handler clauses and variable from the condition-case form.  */
Jim Blandy's avatar
Jim Blandy committed
990 991
    Lisp_Object handler;
    Lisp_Object var;
992 993 994
    /* Fsignal stores here the condition-case clause that applies,
       and Fcondition_case thus knows which clause to run.  */
    Lisp_Object chosen_clause;
995 996

    /* Used to effect the longjump out to the handler.  */
Jim Blandy's avatar
Jim Blandy committed
997
    struct catchtag *tag;
998 999

    /* The next enclosing handler.  */
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003 1004 1005 1006 1007
    struct handler *next;
  };

extern struct handler *handlerlist;

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

1008 1009
extern Lisp_Object memory_signal_data;

Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012 1013 1014 1015 1016
/* 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
1017
  if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
Jim Blandy's avatar
Jim Blandy committed
1018 1019 1020 1021
    { Vquit_flag = Qnil; Fsignal (Qquit, Qnil); }

/* Nonzero if ought to quit now.  */

Jim Blandy's avatar
Jim Blandy committed
1022
#define QUITP (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
Jim Blandy's avatar
Jim Blandy committed
1023 1024 1025

/* 1 if CH is upper case.  */

Jim Blandy's avatar
Jim Blandy committed
1026 1027
#define UPPERCASEP(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1028 1029 1030 1031

/* 1 if CH is lower case.  */

#define LOWERCASEP(CH) \
Jim Blandy's avatar
Jim Blandy committed
1032 1033
  (!UPPERCASEP (CH) \
   && XSTRING (current_buffer->upcase_table)->data[CH] != (CH))
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036 1037 1038 1039 1040

/* 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
1041 1042 1043
#define UPCASE(CH) \
  (XSTRING (current_buffer->downcase_table)->data[CH] == (CH) \
   ? UPCASE1 (CH) : (CH))
Jim Blandy's avatar
Jim Blandy committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

/* 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;
1062
extern Lisp_Object Vascii_canon_table, Vascii_eqv_table;
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078

/* 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
1079 1080
 This way, no link remains in the chain when the stack frame containing the
 link disappears.
Jim Blandy's avatar
Jim Blandy committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115

 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; }

1116 1117 1118 1119 1120 1121 1122 1123
#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
1124 1125 1126 1127 1128 1129
/* Call staticpro (&var) to protect static variable `var'. */

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

Richard M. Stallman's avatar
Richard M. Stallman committed
1130
/* Evaluate expr, UNGCPRO, and then return the value of expr.  */
1131
#define RETURN_UNGCPRO(expr)			\
1132
if (1)						\
1133 1134 1135 1136 1137 1138
    {						\
      Lisp_Object ret_ungc_val;			\
      ret_ungc_val = (expr);			\
      UNGCPRO;					\
      return ret_ungc_val;			\
    }						\
1139
else
Jim Blandy's avatar
Jim Blandy committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

/* 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
1150
extern Lisp_Object Qmark_inactive;
Jim Blandy's avatar
Jim Blandy committed
1151

1152 1153
extern Lisp_Object Qrange_error, Qdomain_error, Qsingularity_error;
extern Lisp_Object Qoverflow_error, Qunderflow_error;
1154

Richard M. Stallman's avatar
Richard M. Stallman committed
1155 1156
extern Lisp_Object Qintegerp, Qnumberp, Qnatnump, Qwholenump;
extern Lisp_Object Qsymbolp, Qlistp, Qconsp;
Jim Blandy's avatar
Jim Blandy committed
1157 1158
extern Lisp_Object Qstringp, Qarrayp, Qsequencep, Qbufferp;
extern Lisp_Object Qchar_or_string_p, Qmarkerp, Qvectorp;
1159 1160
extern Lisp_Object Qinteger_or_marker_p, Qnumber_or_marker_p;
extern Lisp_Object Qboundp, Qfboundp;
1161
extern Lisp_Object Qbuffer_or_string_p;
Jim Blandy's avatar
Jim Blandy committed
1162 1163 1164 1165 1166 1167
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
1168
extern Lisp_Object Qframep;
Jim Blandy's avatar
Jim Blandy committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183

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
1184
extern Lisp_Object indirect_function (), Findirect_function ();
Jim Blandy's avatar
Jim Blandy committed
1185
extern Lisp_Object Ffset (), Fsetplist ();
Jim Blandy's avatar
Jim Blandy committed
1186
extern Lisp_Object Fsymbol_value (), find_symbol_value (), Fset ();
1187
extern Lisp_Object Fdefault_value (), Fset_default (), Fdefault_boundp ();
Jim Blandy's avatar
Jim Blandy committed
1188 1189 1190

extern Lisp_Object Faref (), Faset (), Farray_length ();

1191
extern Lisp_Object Fstring_to_number (), Fnumber_to_string ();
1192 1193 1194 1195 1196 1197 1198
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 ();
extern Lisp_Object Flogand (), Flogior (), Flogxor (), Flognot ();
extern Lisp_Object Flsh (), Fash ();

Jim Blandy's avatar
Jim Blandy committed
1199 1200 1201
extern Lisp_Object Fadd1 (), Fsub1 ();

extern Lisp_Object make_number ();
1202 1203
extern Lisp_Object   long_to_cons ();
extern unsigned long cons_to_long ();
Jim Blandy's avatar
Jim Blandy committed
1204 1205 1206 1207 1208 1209
extern void args_out_of_range ();
extern void args_out_of_range_3 ();
extern Lisp_Object wrong_type_argument ();
#ifdef LISP_FLOAT_TYPE
extern Lisp_Object Ffloat_to_int(), Fint_to_float();
extern double extract_float();
1210 1211
extern Lisp_Object make_float ();
extern Lisp_Object Ffloat ();
Jim Blandy's avatar
Jim Blandy committed
1212 1213 1214 1215 1216 1217 1218 1219 1220
#endif /* LISP_FLOAT_TYPE */

/* Defined in fns.c */
extern Lisp_Object Qstring_lessp;
extern Lisp_Object Vfeatures;
extern Lisp_Object Fidentity (), Frandom ();
extern Lisp_Object Flength ();
extern Lisp_Object Fappend (), Fconcat (), Fvconcat (), Fcopy_sequence ();
extern Lisp_Object Fsubstring ();
1221
extern Lisp_Object Fnth (), Fnthcdr (), Fmemq (), Fassq (), Fassoc ();
Karl Heuer's avatar
Karl Heuer committed
1222
extern Lisp_Object Fmember (), Frassq (), Fdelq (), Fsort ();
Jim Blandy's avatar
Jim Blandy committed
1223 1224 1225 1226 1227 1228
extern Lisp_Object Freverse (), Fnreverse (), Fget (), Fput (), Fequal ();
extern Lisp_Object Ffillarray (), Fnconc (), Fmapcar (), Fmapconcat ();
extern Lisp_Object Fy_or_n_p (), do_yes_or_no_p ();
extern Lisp_Object Ffeaturep (), Frequire () , Fprovide ();
extern Lisp_Object concat2 (), nconc2 ();
extern Lisp_Object assq_no_quit ();
1229
extern Lisp_Object Fcopy_alist ();
Jim Blandy's avatar
Jim Blandy committed
1230 1231 1232

/* Defined in alloc.c */
extern Lisp_Object Vpurify_flag;
1233
extern Lisp_Object Fcons (), Flist(), Fmake_list (), allocate_misc ();
Jim Blandy's avatar
Jim Blandy committed
1234 1235
extern Lisp_Object Fmake_vector (), Fvector (), Fmake_symbol (), Fmake_marker ();
extern Lisp_Object Fmake_string (), build_string (), make_string ();
1236
extern Lisp_Object make_event_array (), make_uninit_string ();
Jim Blandy's avatar
Jim Blandy committed
1237 1238 1239
extern Lisp_Object Fpurecopy (), make_pure_string ();
extern Lisp_Object pure_cons (), make_pure_vector ();
extern Lisp_Object Fgarbage_collect ();
1240
extern Lisp_Object Fmake_byte_code ();
1241
extern int gc_in_progress;
Jim Blandy's avatar
Jim Blandy committed
1242 1243 1244 1245 1246 1247

/* Defined in print.c */
extern Lisp_Object Vprin1_to_string_buffer;
extern Lisp_Object Fprin1 (), Fprin1_to_string (), Fprinc ();
extern Lisp_Object Fterpri (), Fprint ();
extern Lisp_Object Vstandard_output, Qstandard_output;
Jim Blandy's avatar
Jim Blandy committed
1248
extern Lisp_Object Qexternal_debugging_output;
Jim Blandy's avatar
Jim Blandy committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
extern void temp_output_buffer_setup (), temp_output_buffer_show ();
extern int print_level, print_escape_newlines;
extern Lisp_Object Qprint_escape_newlines;

/* Defined in lread.c */
extern Lisp_Object Qvariable_documentation, Qstandard_input;
extern Lisp_Object Vobarray, Vstandard_input;
extern Lisp_Object Fread (), Fread_from_string ();
extern Lisp_Object Fintern (), Fintern_soft (), Fload ();
extern Lisp_Object Fget_file_char (), Fread_char ();
1259
extern Lisp_Object read_filtered_event ();
Jim Blandy's avatar
Jim Blandy committed
1260 1261
extern Lisp_Object Feval_current_buffer (), Feval_region ();
extern Lisp_Object intern (), oblookup ();
1262 1263 1264 1265
#define LOADHIST_ATTACH(x) \
 if (initialized) Vcurrent_load_list = Fcons (x, Vcurrent_load_list)
extern Lisp_Object Vcurrent_load_list;
extern Lisp_Object Vload_history;
Jim Blandy's avatar
Jim Blandy committed
1266 1267 1268

/* Defined in eval.c */
extern Lisp_Object Qautoload, Qexit, Qinteractive, Qcommandp, Qdefun, Qmacro;
Jim Blandy's avatar
Jim Blandy committed
1269
extern Lisp_Object Vinhibit_quit, Qinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
1270 1271
extern Lisp_Object Vmocklisp_arguments, Qmocklisp, Qmocklisp_arguments;
extern Lisp_Object Vautoload_queue;
1272
extern Lisp_Object Vdebug_on_error;
1273 1274 1275
/* To run a normal hook, do
   if (!NILP (Vrun_hooks))
     call1 (Vrun_hooks, Qmy_funny_hook);  */
Jim Blandy's avatar
Jim Blandy committed
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
extern Lisp_Object Vrun_hooks;
extern Lisp_Object Fand (), For (), Fif (), Fprogn (), Fprog1 (), Fprog2 ();
extern Lisp_Object Fsetq (), Fquote ();
extern Lisp_Object Fuser_variable_p (), Finteractive_p ();
extern Lisp_Object Fdefun (), Flet (), FletX (), Fwhile ();
extern Lisp_Object Fcatch (), Fthrow (), Funwind_protect ();
extern Lisp_Object Fcondition_case (), Fsignal ();
extern Lisp_Object Ffunction_type (), Fautoload (), Fcommandp ();
extern Lisp_Object Feval (), Fapply (), Ffuncall ();
extern Lisp_Object Fglobal_set (), Fglobal_value (), Fbacktrace ();
extern Lisp_Object apply1 (), call0 (), call1 (), call2 (), call3 ();
Karl Heuer's avatar
Karl Heuer committed
1287 1288 1289
extern Lisp_Object call4 (), call5 (), call6 ();
extern Lisp_Object Fkill_emacs (), Fkey_binding (), Fsit_for ();
extern Lisp_Object Fdo_auto_save (), Fset_marker ();
Jim Blandy's avatar
Jim Blandy committed
1290 1291 1292
extern Lisp_Object apply_lambda ();
extern Lisp_Object internal_catch ();
extern Lisp_Object internal_condition_case ();
1293
extern Lisp_Object internal_condition_case_1 ();
Jim Blandy's avatar
Jim Blandy committed
1294 1295 1296 1297 1298 1299 1300 1301 1302
extern Lisp_Object unbind_to ();
extern void error ();
extern Lisp_Object un_autoload ();

/* Defined in editfns.c */
extern Lisp_Object Fgoto_char ();
extern Lisp_Object Fpoint_min_marker (), Fpoint_max_marker ();
extern Lisp_Object Fpoint_min (), Fpoint_max ();
extern Lisp_Object Fpoint (), Fpoint_marker (), Fmark_marker ();
Jim Blandy's avatar
Jim Blandy committed
1303 1304
extern Lisp_Object Ffollowing_char (), Fprevious_char (), Fchar_after ();
extern Lisp_Object Finsert ();
Jim Blandy's avatar
Jim Blandy committed
1305 1306
extern Lisp_Object Feolp (), Feobp (), Fbolp (), Fbobp ();
extern Lisp_Object Fformat (), format1 ();
Jim Blandy's avatar
Jim Blandy committed
1307 1308
extern Lisp_Object make_buffer_string (), Fbuffer_substring ();
extern Lisp_Object Fbuffer_string ();
Jim Blandy's avatar
Jim Blandy committed
1309 1310 1311 1312 1313 1314
extern Lisp_Object Fstring_equal (), Fstring_lessp (), Fbuffer_substring_lessp ();
extern Lisp_Object save_excursion_save (), save_restriction_save ();
extern Lisp_Object save_excursion_restore (), save_restriction_restore ();
extern Lisp_Object Fchar_to_string ();

/* defined in buffer.c */
1315
extern Lisp_Object Vbuffer_alist, Vinhibit_read_only;
Jim Blandy's avatar
Jim Blandy committed
1316 1317 1318 1319
extern Lisp_Object Fget_buffer (), Fget_buffer_create (), Fset_buffer ();
extern Lisp_Object Fbarf_if_buffer_read_only ();
extern Lisp_Object Fcurrent_buffer (), Fswitch_to_buffer (), Fpop_to_buffer ();
extern Lisp_Object Fother_buffer ();