eval.c 87.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2 3
   Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24
#include "lisp.h"
25
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
28
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33 34 35 36 37 38
#include <setjmp.h>

/* This definition is duplicated in alloc.c and keyboard.c */
/* Putting it in lisp.h makes cc bomb out! */

struct backtrace
  {
    struct backtrace *next;
    Lisp_Object *function;
    Lisp_Object *args;	/* Points to vector of args. */
Jim Blandy's avatar
Jim Blandy committed
39 40 41
    int nargs;		/* Length of vector.
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
Jim Blandy's avatar
Jim Blandy committed
42 43 44 45 46 47 48
    char evalargs;
    /* Nonzero means call value of debugger when done with this operation. */
    char debug_on_exit;
  };

struct backtrace *backtrace_list;

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/* This structure helps implement the `catch' and `throw' control
   structure.  A struct catchtag contains all the information needed
   to restore the state of the interpreter after a non-local jump.

   Handlers for error conditions (represented by `struct handler'
   structures) just point to a catch tag to do the cleanup required
   for their jumps.

   catchtag structures are chained together in the C calling stack;
   the `next' member points to the next outer catchtag.

   A call like (throw TAG VAL) searches for a catchtag whose `tag'
   member is TAG, and then unbinds to it.  The `val' member is used to
   hold VAL while the stack is unwound; `val' is returned as the value
   of the catch form.

   All the other members are concerned with restoring the interpreter
   state.  */
Jim Blandy's avatar
Jim Blandy committed
67 68 69 70 71 72 73 74 75 76 77 78
struct catchtag
  {
    Lisp_Object tag;
    Lisp_Object val;
    struct catchtag *next;
    struct gcpro *gcpro;
    jmp_buf jmp;
    struct backtrace *backlist;
    struct handler *handlerlist;
    int lisp_eval_depth;
    int pdlcount;
    int poll_suppress_count;
79
    struct byte_stack *byte_stack;
Jim Blandy's avatar
Jim Blandy committed
80 81 82 83
  };

struct catchtag *catchlist;

84 85 86 87 88
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

Jim Blandy's avatar
Jim Blandy committed
89
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
90
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
91 92 93 94
Lisp_Object Qmocklisp_arguments, Vmocklisp_arguments, Qmocklisp;
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;

95 96 97
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
Jim Blandy's avatar
Jim Blandy committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
Lisp_Object Vrun_hooks;

/* Non-nil means record all fset's and provide's, to be undone
   if the file being autoloaded is not fully loaded.
   They are recorded by being consed onto the front of Vautoload_queue:
   (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide.  */

Lisp_Object Vautoload_queue;

/* Current number of specbindings allocated in specpdl.  */
int specpdl_size;

/* Pointer to beginning of specpdl.  */
struct specbinding *specpdl;

/* Pointer to first unused element in specpdl.  */
struct specbinding *specpdl_ptr;

/* Maximum size allowed for specpdl allocation */
int max_specpdl_size;

/* Depth in Lisp evaluations and function calls.  */
int lisp_eval_depth;

/* Maximum allowed depth in Lisp evaluations and function calls.  */
int max_lisp_eval_depth;

/* Nonzero means enter debugger before next function call */
int debug_on_next_call;

128 129 130 131 132 133
/* Non-zero means debuffer may continue.  This is zero when the
   debugger is called during redisplay, where it might not be safe to
   continue the interrupted redisplay. */

int debugger_may_continue;

Roland McGrath's avatar
Roland McGrath committed
134
/* List of conditions (non-nil atom means all) which cause a backtrace
135
   if an error is handled by the command loop's error handler.  */
Roland McGrath's avatar
Roland McGrath committed
136
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
137

Roland McGrath's avatar
Roland McGrath committed
138
/* List of conditions (non-nil atom means all) which enter the debugger
139
   if an error is handled by the command loop's error handler.  */
Roland McGrath's avatar
Roland McGrath committed
140
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
141

Karl Heuer's avatar
Karl Heuer committed
142 143 144 145
/* List of conditions and regexps specifying error messages which
   do not enter the debugger even if Vdebug_on_errors says they should.  */
Lisp_Object Vdebug_ignored_errors;

146
/* Non-nil means call the debugger even if the error will be handled.  */
147
Lisp_Object Vdebug_on_signal;
148 149 150 151

/* Hook for edebug to use.  */
Lisp_Object Vsignal_hook_function;

Jim Blandy's avatar
Jim Blandy committed
152
/* Nonzero means enter debugger if a quit signal
Roland McGrath's avatar
Roland McGrath committed
153
   is handled by the command loop's error handler. */
Jim Blandy's avatar
Jim Blandy committed
154 155
int debug_on_quit;

156
/* The value of num_nonmacro_input_events as of the last time we
157
   started to enter the debugger.  If we decide to enter the debugger
158
   again when this is still equal to num_nonmacro_input_events, then we
159 160 161 162
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
163 164 165

Lisp_Object Vdebugger;

166 167 168 169 170
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

Jim Blandy's avatar
Jim Blandy committed
171 172
void specbind (), record_unwind_protect ();

173 174
Lisp_Object run_hook_with_args ();

Jim Blandy's avatar
Jim Blandy committed
175 176 177
Lisp_Object funcall_lambda ();
extern Lisp_Object ml_apply (); /* Apply a mocklisp function to unevaluated argument list */

Andreas Schwab's avatar
Andreas Schwab committed
178
void
Jim Blandy's avatar
Jim Blandy committed
179 180 181
init_eval_once ()
{
  specpdl_size = 50;
182
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
183
  specpdl_ptr = specpdl;
Jim Blandy's avatar
Jim Blandy committed
184
  max_specpdl_size = 600;
185
  max_lisp_eval_depth = 300;
186 187

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
188 189
}

Andreas Schwab's avatar
Andreas Schwab committed
190
void
Jim Blandy's avatar
Jim Blandy committed
191 192 193 194 195 196 197 198 199
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
200
#ifdef DEBUG_GCPRO
201
  gcpro_level = 0;
202
#endif
203
  /* This is less than the initial value of num_nonmacro_input_events.  */
204
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
205 206 207 208 209 210
}

Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
211
  int debug_while_redisplaying;
212
  int count = specpdl_ptr - specpdl;
213 214
  Lisp_Object val;
  
Jim Blandy's avatar
Jim Blandy committed
215 216
  if (lisp_eval_depth + 20 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 20;
217
  
Jim Blandy's avatar
Jim Blandy committed
218 219
  if (specpdl_size + 40 > max_specpdl_size)
    max_specpdl_size = specpdl_size + 40;
220
  
221 222 223 224 225
#ifdef HAVE_X_WINDOWS
  if (display_busy_cursor_p)
    cancel_busy_cursor ();
#endif

Jim Blandy's avatar
Jim Blandy committed
226
  debug_on_next_call = 0;
227
  when_entered_debugger = num_nonmacro_input_events;
228 229 230 231 232

  /* Resetting redisplaying_p to 0 makes sure that debug output is
     displayed if the debugger is invoked during redisplay.  */
  debug_while_redisplaying = redisplaying_p;
  redisplaying_p = 0;
233 234
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
235 236 237 238 239 240 241 242 243
  
  val = apply1 (Vdebugger, arg);

  /* Interrupting redisplay and resuming it later is not safe under
     all circumstances.  So, when the debugger returns, abort the
     interupted redisplay by going back to the top-level.  */
  if (debug_while_redisplaying)
    Ftop_level ();

244
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
245 246
}

Andreas Schwab's avatar
Andreas Schwab committed
247
void
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
do_debug_on_call (code)
     Lisp_Object code;
{
  debug_on_next_call = 0;
  backtrace_list->debug_on_exit = 1;
  call_debugger (Fcons (code, Qnil));
}

/* NOTE!!! Every function that can call EVAL must protect its args
   and temporaries from garbage collection while it needs them.
   The definition of `For' shows what you have to do.  */

DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
  "Eval args until one of them yields non-nil, then return that value.\n\
The remaining args are not evalled at all.\n\
If all args return nil, return nil.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  Lisp_Object args_left;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
271
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275 276 277 278 279
    return Qnil;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
280
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
281 282 283
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
284
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
  "Eval args until one of them yields nil, then return nil.\n\
The remaining args are not evalled at all.\n\
If no arg yields nil, return the last arg's value.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  Lisp_Object args_left;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
301
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
302 303 304 305 306 307 308 309
    return Qt;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
310
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
311 312 313
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
314
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
321
  "If COND yields non-nil, do THEN, else do ELSE...\n\
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328 329 330 331 332 333 334
Returns the value of THEN or the value of the last of the ELSE's.\n\
THEN must be one expression, but ELSE... can be zero or more expressions.\n\
If COND yields nil, and there are no ELSE's, the value is nil.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
  cond = Feval (Fcar (args));
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
335
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340
    return Feval (Fcar (Fcdr (args)));
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
341
  "Try each clause until one succeeds.\n\
Jim Blandy's avatar
Jim Blandy committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
Each clause looks like (CONDITION BODY...).  CONDITION is evaluated\n\
and, if the value is non-nil, this clause succeeds:\n\
then the expressions in BODY are evaluated and the last one's\n\
value is the value of the cond-form.\n\
If no clause succeeds, cond returns nil.\n\
If a clause has one element, as in (CONDITION),\n\
CONDITION's value if non-nil is returned from the cond-form.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
357
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
358 359 360
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
361
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
362
	{
363 364
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
365 366
	  break;
	}
367
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
368 369 370 371 372 373 374
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
375
  "Eval BODY forms sequentially and return value of last one.")
Jim Blandy's avatar
Jim Blandy committed
376 377 378 379 380 381 382 383 384 385 386 387
  (args)
     Lisp_Object args;
{
  register Lisp_Object val, tem;
  Lisp_Object args_left;
  struct gcpro gcpro1;

  /* In Mocklisp code, symbols at the front of the progn arglist
   are to be bound to zero. */
  if (!EQ (Vmocklisp_arguments, Qt))
    {
      val = make_number (0);
388
      while (!NILP (args) && (tem = Fcar (args), SYMBOLP (tem)))
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394
	{
	  QUIT;
	  specbind (tem, val), args = Fcdr (args);
	}
    }

Jim Blandy's avatar
Jim Blandy committed
395
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402 403 404 405
    return Qnil;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
406
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
413
  "Eval FIRST and BODY sequentially; value from FIRST.\n\
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419 420 421 422 423
The value of FIRST is saved during the evaluation of the remaining args,\n\
whose values are discarded.")
  (args)
     Lisp_Object args;
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

Jim Blandy's avatar
Jim Blandy committed
424
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438
    return Qnil;

  args_left = args;
  val = Qnil;
  GCPRO2 (args, val);

  do
    {
      if (!(argnum++))
        val = Feval (Fcar (args_left));
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
439
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
440 441 442 443 444 445

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
446
  "Eval X, Y and BODY sequentially; value from Y.\n\
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452 453 454 455 456 457 458
The value of Y is saved during the evaluation of the remaining args,\n\
whose values are discarded.")
  (args)
     Lisp_Object args;
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = -1;

  val = Qnil;

Richard M. Stallman's avatar
Richard M. Stallman committed
459
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473
    return Qnil;

  args_left = args;
  val = Qnil;
  GCPRO2 (args, val);

  do
    {
      if (!(argnum++))
        val = Feval (Fcar (args_left));
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
474
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
475 476 477 478 479 480

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
481
  "Set each SYM to the value of its VAL.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
482 483 484 485 486
The symbols SYM are variables; they are literal (not evaluated).\n\
The values VAL are expressions; they are evaluated.\n\
Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.\n\
The second VAL is not computed until after the first SYM is set, and so on;\n\
each VAL can use the new value of variables set earlier in the `setq'.\n\
Karl Heuer's avatar
Karl Heuer committed
487
The return value of the `setq' form is the value of the last VAL.")
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493 494
  (args)
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
495
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499 500 501 502 503 504 505 506 507
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
      val = Feval (Fcar (Fcdr (args_left)));
      sym = Fcar (args_left);
      Fset (sym, val);
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
508
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545

  UNGCPRO;
  return val;
}
     
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
  "Return the argument, without evaluating it.  `(quote x)' yields `x'.")
  (args)
     Lisp_Object args;
{
  return Fcar (args);
}
     
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
  "Like `quote', but preferred for objects which are functions.\n\
In byte compilation, `function' causes its argument to be compiled.\n\
`quote' cannot do that.")
  (args)
     Lisp_Object args;
{
  return Fcar (args);
}

DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
  "Return t if function in which this appears was called interactively.\n\
This means that the function was called with call-interactively (which\n\
includes being called as the binding of a key)\n\
and input is currently coming from the keyboard (not in keyboard macro).")
  ()
{
  register struct backtrace *btp;
  register Lisp_Object fun;

  if (!INTERACTIVE)
    return Qnil;

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
546 547 548 549

  /* If this isn't a byte-compiled function, there may be a frame at
     the top for Finteractive_p itself.  If so, skip it.  */
  fun = Findirect_function (*btp->function);
550
  if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
Jim Blandy's avatar
Jim Blandy committed
551
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556 557 558 559 560 561 562 563 564

  /* If we're running an Emacs 18-style byte-compiled function, there
     may be a frame for Fbytecode.  Now, given the strictest
     definition, this function isn't really being called
     interactively, but because that's the way Emacs 18 always builds
     byte-compiled functions, we'll accept it for now.  */
  if (EQ (*btp->function, Qbytecode))
    btp = btp->next;

  /* If this isn't a byte-compiled function, then we may now be
     looking at several frames for special forms.  Skip past them.  */
  while (btp && 
	 btp->nargs == UNEVALLED)
Jim Blandy's avatar
Jim Blandy committed
565 566
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
567 568 569 570
  /* btp now points at the frame of the innermost function that isn't
     a special form, ignoring frames for Finteractive_p and/or
     Fbytecode at the top.  If this frame is for a built-in function
     (such as load or eval-region) return nil.  */
Jim Blandy's avatar
Jim Blandy committed
571
  fun = Findirect_function (*btp->function);
572
  if (SUBRP (fun))
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576 577 578 579 580 581
    return Qnil;
  /* btp points to the frame of a Lisp function that called interactive-p.
     Return t if that function was called interactively.  */
  if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
    return Qt;
  return Qnil;
}

DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
582
  "Define NAME as a function.\n\
Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587 588 589 590 591 592
The definition is (lambda ARGLIST [DOCSTRING] BODY...).\n\
See also the function `interactive'.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
593
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
594 595
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
596
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
601
  "Define NAME as a macro.\n\
Jim Blandy's avatar
Jim Blandy committed
602 603 604 605 606 607 608 609 610 611 612 613 614
The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).\n\
When the macro is called, as in (NAME ARGS...),\n\
the function (lambda ARGLIST BODY...) is applied to\n\
the list ARGS... as it appears in the expression,\n\
and the result should be a form to be evaluated instead of the original.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
  defn = Fcons (Qmacro, Fcons (Qlambda, Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
615
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
616 617
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
618
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
619 620 621 622
  return fn_name;
}

DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
623
  "Define SYMBOL as a variable.\n\
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627
You are not required to define a variable in order to use it,\n\
but the definition can supply documentation and an initial value\n\
in a way that tags can recognize.\n\n\
INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.\n\
628 629
If SYMBOL is buffer-local, its default value is what is set;\n\
 buffer-local values are not affected.\n\
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633 634 635 636
INITVALUE and DOCSTRING are optional.\n\
If DOCSTRING starts with *, this variable is identified as a user option.\n\
 This means that M-x set-variable and M-x edit-options recognize it.\n\
If INITVALUE is missing, SYMBOL's value is not set.")
  (args)
     Lisp_Object args;
{
637
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
638 639

  sym = Fcar (args);
640 641 642 643 644
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
    error ("too many arguments");

  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
645 646
    {
      tem = Fdefault_boundp (sym);
Jim Blandy's avatar
Jim Blandy committed
647
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
648 649
	Fset_default (sym, Feval (Fcar (Fcdr (args))));
    }
650 651
  tail = Fcdr (Fcdr (args));
  if (!NILP (Fcar (tail)))
Jim Blandy's avatar
Jim Blandy committed
652
    {
653
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
654
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
655 656 657
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
658
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
659 660 661 662
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
663
  "Define SYMBOL as a constant variable.\n\
Andreas Schwab's avatar
Andreas Schwab committed
664
The intent is that neither programs nor users should ever change this value.\n\
Jim Blandy's avatar
Jim Blandy committed
665
Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\
666 667
If SYMBOL is buffer-local, its default value is what is set;\n\
 buffer-local values are not affected.\n\
Karl Heuer's avatar
Karl Heuer committed
668
DOCSTRING is optional.")
Jim Blandy's avatar
Jim Blandy committed
669 670 671 672 673 674
  (args)
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
675 676 677
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
    error ("too many arguments");

678 679 680 681
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
682
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
683
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
684
    {
Jim Blandy's avatar
Jim Blandy committed
685
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
686 687 688
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
689
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
690 691 692 693 694 695 696
  return sym;
}

DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
  "Returns t if VARIABLE is intended to be set and modified by users.\n\
\(The alternative is a variable used internally in a Lisp program.)\n\
Determined by whether the first character of the documentation\n\
697 698 699
for the variable is `*' or if the variable is customizable (has a non-nil\n\
value of any of `custom-type', `custom-loads' or `standard-value'\n\
on its property list).")
Jim Blandy's avatar
Jim Blandy committed
700 701 702 703 704
  (variable)
     Lisp_Object variable;
{
  Lisp_Object documentation;
  
705 706 707
  if (!SYMBOLP (variable))
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
708
  documentation = Fget (variable, Qvariable_documentation);
709
  if (INTEGERP (documentation) && XINT (documentation) < 0)
Jim Blandy's avatar
Jim Blandy committed
710
    return Qt;
711 712 713 714 715
  if (STRINGP (documentation)
      && ((unsigned char) XSTRING (documentation)->data[0] == '*'))
    return Qt;
  /* If it is (STRING . INTEGER), a negative integer means a user variable.  */
  if (CONSP (documentation)
716 717 718
      && STRINGP (XCAR (documentation))
      && INTEGERP (XCDR (documentation))
      && XINT (XCDR (documentation)) < 0)
Jim Blandy's avatar
Jim Blandy committed
719
    return Qt;
720 721 722 723 724
  /* Customizable?  */
  if ((!NILP (Fget (variable, intern ("custom-type"))))
      || (!NILP (Fget (variable, intern ("custom-loads"))))
      || (!NILP (Fget (variable, intern ("standard-value")))))
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728
  return Qnil;
}  

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
729
  "Bind variables according to VARLIST then eval BODY.\n\
Jim Blandy's avatar
Jim Blandy committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743
The value of the last form in BODY is returned.\n\
Each element of VARLIST is a symbol (which is bound to nil)\n\
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
Each VALUEFORM can refer to the symbols already bound by this VARLIST.")
  (args)
     Lisp_Object args;
{
  Lisp_Object varlist, val, elt;
  int count = specpdl_ptr - specpdl;
  struct gcpro gcpro1, gcpro2, gcpro3;

  GCPRO3 (args, elt, varlist);

  varlist = Fcar (args);
Jim Blandy's avatar
Jim Blandy committed
744
  while (!NILP (varlist))
Jim Blandy's avatar
Jim Blandy committed
745 746 747
    {
      QUIT;
      elt = Fcar (varlist);
748
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
749
	specbind (elt, Qnil);
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753
      else if (! NILP (Fcdr (Fcdr (elt))))
	Fsignal (Qerror,
		 Fcons (build_string ("`let' bindings can have only one value-form"),
			elt));
Jim Blandy's avatar
Jim Blandy committed
754 755 756 757 758 759 760 761 762 763 764 765 766
      else
	{
	  val = Feval (Fcar (Fcdr (elt)));
	  specbind (Fcar (elt), val);
	}
      varlist = Fcdr (varlist);
    }
  UNGCPRO;
  val = Fprogn (Fcdr (args));
  return unbind_to (count, val);
}

DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
767
  "Bind variables according to VARLIST then eval BODY.\n\
Jim Blandy's avatar
Jim Blandy committed
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
The value of the last form in BODY is returned.\n\
Each element of VARLIST is a symbol (which is bound to nil)\n\
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
All the VALUEFORMs are evalled before any symbols are bound.")
  (args)
     Lisp_Object args;
{
  Lisp_Object *temps, tem;
  register Lisp_Object elt, varlist;
  int count = specpdl_ptr - specpdl;
  register int argnum;
  struct gcpro gcpro1, gcpro2;

  varlist = Fcar (args);

  /* Make space to hold the values to give the bound variables */
  elt = Flength (varlist);
  temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));

  /* Compute the values and store them in `temps' */

  GCPRO2 (args, *temps);
  gcpro2.nvars = 0;

Jim Blandy's avatar
Jim Blandy committed
792
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
793 794 795
    {
      QUIT;
      elt = Fcar (varlist);
796
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
797
	temps [argnum++] = Qnil;
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801
      else if (! NILP (Fcdr (Fcdr (elt))))
	Fsignal (Qerror,
		 Fcons (build_string ("`let' bindings can have only one value-form"),
			elt));
Jim Blandy's avatar
Jim Blandy committed
802 803 804 805 806 807 808
      else
	temps [argnum++] = Feval (Fcar (Fcdr (elt)));
      gcpro2.nvars = argnum;
    }
  UNGCPRO;

  varlist = Fcar (args);
Jim Blandy's avatar
Jim Blandy committed
809
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
810 811 812
    {
      elt = Fcar (varlist);
      tem = temps[argnum++];
813
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
814 815 816 817 818 819 820 821 822 823
	specbind (elt, tem);
      else
	specbind (Fcar (elt), tem);
    }

  elt = Fprogn (Fcdr (args));
  return unbind_to (count, elt);
}

DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
824
  "If TEST yields non-nil, eval BODY... and repeat.\n\
Jim Blandy's avatar
Jim Blandy committed
825 826 827 828 829 830 831 832 833 834 835 836
The order of execution is thus TEST, BODY, TEST, BODY and so on\n\
until TEST returns nil.")
  (args)
     Lisp_Object args;
{
  Lisp_Object test, body, tem;
  struct gcpro gcpro1, gcpro2;

  GCPRO2 (test, body);

  test = Fcar (args);
  body = Fcdr (args);
837 838
  while (tem = Feval (test),
	 (!EQ (Vmocklisp_arguments, Qt) ? XINT (tem) : !NILP (tem)))
Jim Blandy's avatar
Jim Blandy committed
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
    {
      QUIT;
      Fprogn (body);
    }

  UNGCPRO;
  return Qnil;
}

DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
  "Return result of expanding macros at top level of FORM.\n\
If FORM is not a macro call, it is returned unchanged.\n\
Otherwise, the macro is expanded and the expansion is considered\n\
in place of FORM.  When a non-macro-call results, it is returned.\n\n\
The second optional arg ENVIRONMENT species an environment of macro\n\
definitions to shadow the loaded ones for use in file byte-compilation.")
855
  (form, environment)
856
     Lisp_Object form;
857
     Lisp_Object environment;
Jim Blandy's avatar
Jim Blandy committed
858
{
Jim Blandy's avatar
Jim Blandy committed
859
  /* With cleanups from Hallvard Furuseth.  */
Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865
  register Lisp_Object expander, sym, def, tem;

  while (1)
    {
      /* Come back here each time we expand a macro call,
	 in case it expands into another macro call.  */
866
      if (!CONSP (form))
Jim Blandy's avatar
Jim Blandy committed
867
	break;
Jim Blandy's avatar
Jim Blandy committed
868
      /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
869
      def = sym = XCAR (form);
Jim Blandy's avatar
Jim Blandy committed
870
      tem = Qnil;
Jim Blandy's avatar
Jim Blandy committed
871 872
      /* Trace symbols aliases to other symbols
	 until we get a symbol that is not an alias.  */
873
      while (SYMBOLP (def))
Jim Blandy's avatar
Jim Blandy committed
874 875
	{
	  QUIT;
Jim Blandy's avatar
Jim Blandy committed
876
	  sym = def;
877
	  tem = Fassq (sym, environment);
Jim Blandy's avatar
Jim Blandy committed
878
	  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
879 880
	    {
	      def = XSYMBOL (sym)->function;
Jim Blandy's avatar
Jim Blandy committed
881 882
	      if (!EQ (def, Qunbound))
		continue;
Jim Blandy's avatar
Jim Blandy committed
883
	    }
Jim Blandy's avatar
Jim Blandy committed
884
	  break;
Jim Blandy's avatar
Jim Blandy committed
885
	}
886
      /* Right now TEM is the result from SYM in ENVIRONMENT,
Jim Blandy's avatar
Jim Blandy committed
887
	 and if TEM is nil then DEF is SYM's function definition.  */
Jim Blandy's avatar
Jim Blandy committed
888
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
889
	{
890
	  /* SYM is not mentioned in ENVIRONMENT.
Jim Blandy's avatar
Jim Blandy committed
891
	     Look at its function definition.  */
892
	  if (EQ (def, Qunbound) || !CONSP (def))
Jim Blandy's avatar
Jim Blandy committed
893 894
	    /* Not defined or definition not suitable */
	    break;
895
	  if (EQ (XCAR (def), Qautoload))
Jim Blandy's avatar
Jim Blandy committed
896 897
	    {
	      /* Autoloading function: will it be a macro when loaded?  */
898
	      tem = Fnth (make_number (4), def);
899
	      if (EQ (tem, Qt) || EQ (tem, Qmacro))
900 901
		/* Yes, load it and try again.  */
		{
902 903
		  struct gcpro gcpro1;
		  GCPRO1 (form);
904
		  do_autoload (def, sym);
905
		  UNGCPRO;
906 907 908
		  continue;
		}
	      else
Jim Blandy's avatar
Jim Blandy committed
909 910
		break;
	    }
911
	  else if (!EQ (XCAR (def), Qmacro))
Jim Blandy's avatar
Jim Blandy committed
912
	    break;
913
	  else expander = XCDR (def);
Jim Blandy's avatar
Jim Blandy committed
914 915 916
	}
      else
	{
917
	  expander = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
918
	  if (NILP (expander))
Jim Blandy's avatar
Jim Blandy committed
919 920
	    break;
	}
921
      form = apply1 (expander, XCDR (form));
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926
    }
  return form;
}

DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
927
  "Eval BODY allowing nonlocal exits using `throw'.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
928 929 930
TAG is evalled to get the tag to use; it must not be nil.\n\
\n\
Then the BODY is executed.\n\
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.\n\
If no throw happens, `catch' returns the value of the last BODY form.\n\
If a throw happens, it specifies the value to return from `catch'.")
  (args)
     Lisp_Object args;
{
  register Lisp_Object tag;
  struct gcpro gcpro1;

  GCPRO1 (args);
  tag = Feval (Fcar (args));
  UNGCPRO;
  return internal_catch (tag, Fprogn, Fcdr (args));
}

/* Set up a catch, then call C function FUNC on argument ARG.
   FUNC should return a Lisp_Object.
   This is how catches are done from within C code. */

Lisp_Object
internal_catch (tag, func, arg)
     Lisp_Object tag;
     Lisp_Object (*func) ();
     Lisp_Object arg;
{
  /* This structure is made part of the chain `catchlist'.  */
  struct catchtag c;

  /* Fill in the components of c, and put it on the list.  */
  c.next = catchlist;
  c.tag = tag;
  c.val = Qnil;
  c.backlist = backtrace_list;
  c.handlerlist = handlerlist;
  c.lisp_eval_depth = lisp_eval_depth;
  c.pdlcount = specpdl_ptr - specpdl;
  c.poll_suppress_count = poll_suppress_count;
  c.gcpro = gcprolist;
969
  c.byte_stack = byte_stack_list;
Jim Blandy's avatar
Jim Blandy committed
970 971 972 973 974 975 976 977 978 979 980
  catchlist = &c;

  /* Call FUNC.  */
  if (! _setjmp (c.jmp))
    c.val = (*func) (arg);

  /* Throw works by a longjmp that comes right here.  */
  catchlist = c.next;
  return c.val;
}

981 982
/* Unwind the specbind, catch, and handler stacks back to CATCH, and
   jump to that CATCH, returning VALUE as the value of that catch.
Jim Blandy's avatar
Jim Blandy committed
983

984 985 986
   This is the guts Fthrow and Fsignal; they differ only in the way
   they choose the catch tag to throw to.  A catch tag for a
   condition-case form has a TAG of Qnil.
Jim Blandy's avatar
Jim Blandy committed
987

988 989 990 991 992 993 994 995
   Before each catch is discarded, unbind all special bindings and
   execute all unwind-protect clauses made above that catch.  Unwind
   the handler stack as we go, so that the proper handlers are in
   effect for each unwind-protect clause we run.  At the end, restore
   some static info saved in CATCH, and longjmp to the location
   specified in the

   This is used for correct unwinding in Fthrow and Fsignal.  */
Jim Blandy's avatar
Jim Blandy committed
996 997

static void
998
unwind_to_catch (catch, value)
Jim Blandy's avatar
Jim Blandy committed
999
     struct catchtag *catch;
1000
     Lisp_Object value;
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003
{
  register int last_time;

1004 1005 1006
  /* Save the value in the tag.  */
  catch->val = value;

1007
  /* Restore the polling-suppression count.  */
1008
  set_poll_suppress_count (catch->poll_suppress_count);
1009

Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
  do
    {
      last_time = catchlist == catch;
1013 1014 1015

      /* Unwind the specpdl stack, and then restore the proper set of
         handlers.  */
Jim Blandy's avatar
Jim Blandy committed
1016 1017 1018 1019 1020 1021
      unbind_to (catchlist->pdlcount, Qnil);
      handlerlist = catchlist->handlerlist;
      catchlist = catchlist->next;
    }
  while (! last_time);

1022
  byte_stack_list = catch->byte_stack;
Jim Blandy's avatar
Jim Blandy committed
1023
  gcprolist = catch->gcpro;
1024 1025 1026 1027 1028 1029
#ifdef DEBUG_GCPRO
  if (gcprolist != 0)
    gcpro_level = gcprolist->level + 1;
  else
    gcpro_level = 0;
#endif
Jim Blandy's avatar
Jim Blandy committed
1030 1031
  backtrace_list = catch->backlist;
  lisp_eval_depth = catch->lisp_eval_depth;
1032 1033
  
  _longjmp (catch->jmp, 1);
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036
}

DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1037
  "Throw to the catch for TAG and return VALUE from it.\n\
Jim Blandy's avatar
Jim Blandy committed
1038
Both TAG and VALUE are evalled.")
1039 1040
  (tag, value)
     register Lisp_Object tag, value;
Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043 1044 1045
{
  register struct catchtag *c;

  while (1)
    {
Jim Blandy's avatar
Jim Blandy committed
1046
      if (!NILP (tag))
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049
	for (c = catchlist; c; c = c->next)
	  {
	    if (EQ (c->tag, tag))
1050
	      unwind_to_catch (c, value);
Jim Blandy's avatar
Jim Blandy committed
1051
	  }
1052
      tag = Fsignal (Qno_catch, Fcons (tag, Fcons (value, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    }
}


DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
  "Do BODYFORM, protecting with UNWINDFORMS.\n\
If BODYFORM completes normally, its value is returned\n\
after executing the UNWINDFORMS.\n\
If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.")
  (args)
     Lisp_Object args;
{
  Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (0, Fcdr (args));
  val = Feval (Fcar (args));
  return unbind_to (count, val);  
}

/* Chain of condition handlers currently in effect.
   The elements of this chain are contained in the stack frames
   of Fcondition_case and internal_condition_case.
   When an error is signaled (by calling Fsignal, below),
   this chain is searched for an element that applies.  */

struct handler *handlerlist;

DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
  "Regain control when an error is signaled.\n\
executes BODYFORM and returns its value if no error happens.\n\
Each element of HANDLERS looks like (CONDITION-NAME BODY...)\n\
where the BODY is made of Lisp expressions.\n\n\
A handler is applicable to an error\n\
if CONDITION-NAME is one of the error's condition names.\n\
If an error happens, the first applicable handler is run.\n\
\n\
1090 1091 1092
The car of a handler may be a list of condition names\n\
instead of a single condition name.\n\
\n\
Jim Blandy's avatar
Jim Blandy committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
When a handler handles an error,\n\
control returns to the condition-case and the handler BODY... is executed\n\
with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).\n\
VAR may be nil; then you do not get access to the signal information.\n\
\n\
The value of the last BODY form is returned from the condition-case.\n\
See also the function `signal' for more info.")
  (args)
     Lisp_Object args;
{
  Lisp_Object val;
  struct catchtag c;
  struct handler h;
1106
  register Lisp_Object var, bodyform, handlers;
Jim Blandy's avatar
Jim Blandy committed
1107

1108 1109 1110 1111 1112 1113 1114 1115 1116
  var      = Fcar (args);
  bodyform = Fcar (Fcdr (args));
  handlers = Fcdr (Fcdr (args));
  CHECK_SYMBOL (var, 0);

  for (val = handlers; ! NILP (val); val = Fcdr (val))
    {
      Lisp_Object tem;
      tem = Fcar (val);
1117 1118
      if (! (NILP (tem)
	     || (CONSP (tem)
1119 1120
		 && (SYMBOLP (XCAR (tem))
		     || CONSP (XCAR (tem))))))
1121 1122
	error ("Invalid condition handler", tem);
    }
Jim Blandy's avatar
Jim Blandy committed
1123 1124 1125 1126 1127 1128 1129 1130 1131

  c.tag = Qnil;
  c.val = Qnil;
  c.backlist = backtrace_list;
  c.handlerlist = handlerlist;
  c.lisp_eval_depth = lisp_eval_depth;
  c.pdlcount = specpdl_ptr - specpdl;
  c.poll_suppress_count = poll_suppress_count;
  c.gcpro = gcprolist;
1132
  c.byte_stack = byte_stack_list;
Jim Blandy's avatar
Jim Blandy committed
1133 1134
  if (_setjmp (c.jmp))
    {
Jim Blandy's avatar
Jim Blandy committed
1135
      if (!NILP (h.var))
1136 1137
        specbind (h.var, c.val);
      val = Fprogn (Fcdr (h.chosen_clause));
1138 1139 1140 1141

      /* Note that this just undoes the binding of h.var; whoever
	 longjumped to us unwound the stack to c.pdlcount before
	 throwing. */
Jim Blandy's avatar
Jim Blandy committed
1142 1143 1144 1145 1146 1147
      unbind_to (c.pdlcount, Qnil);
      return val;
    }
  c.next = catchlist;
  catchlist = &c;
  
1148 1149
  h.var = var;
  h.handler = handlers;
Jim Blandy's avatar
Jim Blandy committed
1150 1151 1152 1153
  h.next = handlerlist;
  h.tag = &c;
  handlerlist = &h;

Jim Blandy's avatar