eval.c 82.3 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995 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
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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Andreas Schwab's avatar
Andreas Schwab committed
23 24 25 26 27

#ifdef STDC_HEADERS
#include <stdlib.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
28
#include "lisp.h"
29
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
30 31 32

#ifndef standalone
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47
#else
#define INTERACTIVE 1
#endif

#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
48 49 50
    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
51 52 53 54 55 56 57
    char evalargs;
    /* Nonzero means call value of debugger when done with this operation. */
    char debug_on_exit;
  };

struct backtrace *backtrace_list;

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/* 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
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
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;
  };

struct catchtag *catchlist;

Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
93
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
94 95 96 97
Lisp_Object Qmocklisp_arguments, Vmocklisp_arguments, Qmocklisp;
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;

98 99 100
/* 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
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 128 129 130
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;

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

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

Karl Heuer's avatar
Karl Heuer committed
139 140 141 142
/* 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;

143
/* Non-nil means call the debugger even if the error will be handled.  */
144
Lisp_Object Vdebug_on_signal;
145 146 147 148

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

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

153
/* The value of num_nonmacro_input_events as of the last time we
154
   started to enter the debugger.  If we decide to enter the debugger
155
   again when this is still equal to num_nonmacro_input_events, then we
156 157 158 159
   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
160 161 162 163 164

Lisp_Object Vdebugger;

void specbind (), record_unwind_protect ();

165 166
Lisp_Object run_hook_with_args ();

Jim Blandy's avatar
Jim Blandy committed
167 168 169
Lisp_Object funcall_lambda ();
extern Lisp_Object ml_apply (); /* Apply a mocklisp function to unevaluated argument list */

Andreas Schwab's avatar
Andreas Schwab committed
170
void
Jim Blandy's avatar
Jim Blandy committed
171 172 173
init_eval_once ()
{
  specpdl_size = 50;
174
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
175
  specpdl_ptr = specpdl;
Jim Blandy's avatar
Jim Blandy committed
176
  max_specpdl_size = 600;
177
  max_lisp_eval_depth = 300;
178 179

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
180 181
}

Andreas Schwab's avatar
Andreas Schwab committed
182
void
Jim Blandy's avatar
Jim Blandy committed
183 184 185 186 187 188 189 190 191
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
192
  /* This is less than the initial value of num_nonmacro_input_events.  */
193
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
194 195 196 197 198 199 200 201 202 203 204
}

Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
  if (lisp_eval_depth + 20 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 20;
  if (specpdl_size + 40 > max_specpdl_size)
    max_specpdl_size = specpdl_size + 40;
  debug_on_next_call = 0;
205
  when_entered_debugger = num_nonmacro_input_events;
Jim Blandy's avatar
Jim Blandy committed
206 207 208
  return apply1 (Vdebugger, arg);
}

Andreas Schwab's avatar
Andreas Schwab committed
209
void
Jim Blandy's avatar
Jim Blandy committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
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
233
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238 239 240 241
    return Qnil;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
242
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
243 244 245
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
246
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

  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
263
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268 269 270 271
    return Qt;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
272
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
273 274 275
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
276
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
  "(if COND THEN ELSE...): if COND yields non-nil, do THEN, else do ELSE...\n\
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
297
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
    return Feval (Fcar (Fcdr (args)));
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
  "(cond CLAUSES...): try each clause until one succeeds.\n\
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
319
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
320 321 322
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
323
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
324
	{
325 326
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
327 328
	  break;
	}
329
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
  "(progn BODY...): eval BODY forms sequentially and return value of last one.")
  (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);
350
      while (!NILP (args) && (tem = Fcar (args), SYMBOLP (tem)))
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356
	{
	  QUIT;
	  specbind (tem, val), args = Fcdr (args);
	}
    }

Jim Blandy's avatar
Jim Blandy committed
357
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
358 359 360 361 362 363 364 365 366 367
    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
368
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
  "(prog1 FIRST BODY...): eval FIRST and BODY sequentially; value from FIRST.\n\
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
386
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400
    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
401
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
402 403 404 405 406 407

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
Richard M. Stallman's avatar
Richard M. Stallman committed
408
  "(prog2 X Y BODY...): eval X, Y and BODY sequentially; value from Y.\n\
Jim Blandy's avatar
Jim Blandy committed
409 410 411 412 413 414 415 416 417 418 419 420
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
421
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435
    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
436
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442 443

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
  "(setq SYM VAL SYM VAL ...): set each SYM to the value of its VAL.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
444 445 446 447 448
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
449
The return value of the `setq' form is the value of the last VAL.")
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456
  (args)
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
457
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464 465 466 467 468 469
    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
470
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507

  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
508 509 510 511

  /* 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);
512
  if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
Jim Blandy's avatar
Jim Blandy committed
513
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518 519 520 521 522 523 524 525 526

  /* 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
527 528
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
529 530 531 532
  /* 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
533
  fun = Findirect_function (*btp->function);
534
  if (SUBRP (fun))
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
    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,
  "(defun NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.\n\
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
555
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
556 557
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
558
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
  "(defmacro NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro.\n\
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
577
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
578 579
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
580
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
581 582 583 584 585 586 587 588 589
  return fn_name;
}

DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
  "(defvar SYMBOL INITVALUE DOCSTRING): define SYMBOL as a variable.\n\
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\
590 591
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
592 593 594 595 596 597 598
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;
{
599
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
600 601

  sym = Fcar (args);
602 603 604 605 606
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
    error ("too many arguments");

  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
607 608
    {
      tem = Fdefault_boundp (sym);
Jim Blandy's avatar
Jim Blandy committed
609
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
610 611
	Fset_default (sym, Feval (Fcar (Fcdr (args))));
    }
612 613
  tail = Fcdr (Fcdr (args));
  if (!NILP (Fcar (tail)))
Jim Blandy's avatar
Jim Blandy committed
614
    {
615
      tem = Fcar (tail);
Jim Blandy's avatar
Jim Blandy committed
616
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
617 618 619
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
620
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624 625
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
  "(defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable.\n\
Andreas Schwab's avatar
Andreas Schwab committed
626
The intent is that neither programs nor users should ever change this value.\n\
Jim Blandy's avatar
Jim Blandy committed
627
Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\
628 629
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
630
DOCSTRING is optional.")
Jim Blandy's avatar
Jim Blandy committed
631 632 633 634 635 636
  (args)
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
637 638 639
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
    error ("too many arguments");

Jim Blandy's avatar
Jim Blandy committed
640 641
  Fset_default (sym, Feval (Fcar (Fcdr (args))));
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
642
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
643
    {
Jim Blandy's avatar
Jim Blandy committed
644
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
645 646 647
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
648
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653 654 655
  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\
656
for the variable is `*'.")
Jim Blandy's avatar
Jim Blandy committed
657 658 659 660 661
  (variable)
     Lisp_Object variable;
{
  Lisp_Object documentation;
  
662 663 664
  if (!SYMBOLP (variable))
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
665
  documentation = Fget (variable, Qvariable_documentation);
666
  if (INTEGERP (documentation) && XINT (documentation) < 0)
Jim Blandy's avatar
Jim Blandy committed
667
    return Qt;
668 669 670 671 672
  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)
673 674 675
      && STRINGP (XCAR (documentation))
      && INTEGERP (XCDR (documentation))
      && XINT (XCDR (documentation)) < 0)
Jim Blandy's avatar
Jim Blandy committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
    return Qt;
  return Qnil;
}  

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
  "(let* VARLIST BODY...): bind variables according to VARLIST then eval BODY.\n\
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
696
  while (!NILP (varlist))
Jim Blandy's avatar
Jim Blandy committed
697 698 699
    {
      QUIT;
      elt = Fcar (varlist);
700
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
701
	specbind (elt, Qnil);
Jim Blandy's avatar
Jim Blandy committed
702 703 704 705
      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
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
      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,
  "(let VARLIST BODY...): bind variables according to VARLIST then eval BODY.\n\
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
744
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (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
	temps [argnum++] = 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
      else
	temps [argnum++] = Feval (Fcar (Fcdr (elt)));
      gcpro2.nvars = argnum;
    }
  UNGCPRO;

  varlist = Fcar (args);
Jim Blandy's avatar
Jim Blandy committed
761
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
762 763 764
    {
      elt = Fcar (varlist);
      tem = temps[argnum++];
765
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
	specbind (elt, tem);
      else
	specbind (Fcar (elt), tem);
    }

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

DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
  "(while TEST BODY...): if TEST yields non-nil, eval BODY... and repeat.\n\
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);
789 790
  while (tem = Feval (test),
	 (!EQ (Vmocklisp_arguments, Qt) ? XINT (tem) : !NILP (tem)))
Jim Blandy's avatar
Jim Blandy committed
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    {
      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.")
807
  (form, environment)
808
     Lisp_Object form;
809
     Lisp_Object environment;
Jim Blandy's avatar
Jim Blandy committed
810
{
Jim Blandy's avatar
Jim Blandy committed
811
  /* With cleanups from Hallvard Furuseth.  */
Jim Blandy's avatar
Jim Blandy committed
812 813 814 815 816 817
  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.  */
818
      if (!CONSP (form))
Jim Blandy's avatar
Jim Blandy committed
819
	break;
Jim Blandy's avatar
Jim Blandy committed
820
      /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
821
      def = sym = XCAR (form);
Jim Blandy's avatar
Jim Blandy committed
822
      tem = Qnil;
Jim Blandy's avatar
Jim Blandy committed
823 824
      /* Trace symbols aliases to other symbols
	 until we get a symbol that is not an alias.  */
825
      while (SYMBOLP (def))
Jim Blandy's avatar
Jim Blandy committed
826 827
	{
	  QUIT;
Jim Blandy's avatar
Jim Blandy committed
828
	  sym = def;
829
	  tem = Fassq (sym, environment);
Jim Blandy's avatar
Jim Blandy committed
830
	  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
831 832
	    {
	      def = XSYMBOL (sym)->function;
Jim Blandy's avatar
Jim Blandy committed
833 834
	      if (!EQ (def, Qunbound))
		continue;
Jim Blandy's avatar
Jim Blandy committed
835
	    }
Jim Blandy's avatar
Jim Blandy committed
836
	  break;
Jim Blandy's avatar
Jim Blandy committed
837
	}
838
      /* Right now TEM is the result from SYM in ENVIRONMENT,
Jim Blandy's avatar
Jim Blandy committed
839
	 and if TEM is nil then DEF is SYM's function definition.  */
Jim Blandy's avatar
Jim Blandy committed
840
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
841
	{
842
	  /* SYM is not mentioned in ENVIRONMENT.
Jim Blandy's avatar
Jim Blandy committed
843
	     Look at its function definition.  */
844
	  if (EQ (def, Qunbound) || !CONSP (def))
Jim Blandy's avatar
Jim Blandy committed
845 846
	    /* Not defined or definition not suitable */
	    break;
847
	  if (EQ (XCAR (def), Qautoload))
Jim Blandy's avatar
Jim Blandy committed
848 849
	    {
	      /* Autoloading function: will it be a macro when loaded?  */
850
	      tem = Fnth (make_number (4), def);
851
	      if (EQ (tem, Qt) || EQ (tem, Qmacro))
852 853
		/* Yes, load it and try again.  */
		{
854 855
		  struct gcpro gcpro1;
		  GCPRO1 (form);
856
		  do_autoload (def, sym);
857
		  UNGCPRO;
858 859 860
		  continue;
		}
	      else
Jim Blandy's avatar
Jim Blandy committed
861 862
		break;
	    }
863
	  else if (!EQ (XCAR (def), Qmacro))
Jim Blandy's avatar
Jim Blandy committed
864
	    break;
865
	  else expander = XCDR (def);
Jim Blandy's avatar
Jim Blandy committed
866 867 868
	}
      else
	{
869
	  expander = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
870
	  if (NILP (expander))
Jim Blandy's avatar
Jim Blandy committed
871 872
	    break;
	}
873
      form = apply1 (expander, XCDR (form));
Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879
    }
  return form;
}

DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
  "(catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
880 881 882
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
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 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
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;
  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;
}

932 933
/* 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
934

935 936 937
   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
938

939 940 941 942 943 944 945 946
   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
947 948

static void
949
unwind_to_catch (catch, value)
Jim Blandy's avatar
Jim Blandy committed
950
     struct catchtag *catch;
951
     Lisp_Object value;
Jim Blandy's avatar
Jim Blandy committed
952 953 954
{
  register int last_time;

955 956 957
  /* Save the value in the tag.  */
  catch->val = value;

958
  /* Restore the polling-suppression count.  */
959
  set_poll_suppress_count (catch->poll_suppress_count);
960

Jim Blandy's avatar
Jim Blandy committed
961 962 963
  do
    {
      last_time = catchlist == catch;
964 965 966

      /* Unwind the specpdl stack, and then restore the proper set of
         handlers.  */
Jim Blandy's avatar
Jim Blandy committed
967 968 969 970 971 972 973 974 975
      unbind_to (catchlist->pdlcount, Qnil);
      handlerlist = catchlist->handlerlist;
      catchlist = catchlist->next;
    }
  while (! last_time);

  gcprolist = catch->gcpro;
  backtrace_list = catch->backlist;
  lisp_eval_depth = catch->lisp_eval_depth;
976 977
  
  _longjmp (catch->jmp, 1);
Jim Blandy's avatar
Jim Blandy committed
978 979 980 981 982
}

DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
  "(throw TAG VALUE): throw to the catch for TAG and return VALUE from it.\n\
Both TAG and VALUE are evalled.")
983 984
  (tag, value)
     register Lisp_Object tag, value;
Jim Blandy's avatar
Jim Blandy committed
985 986 987 988 989
{
  register struct catchtag *c;

  while (1)
    {
Jim Blandy's avatar
Jim Blandy committed
990
      if (!NILP (tag))
Jim Blandy's avatar
Jim Blandy committed
991 992 993
	for (c = catchlist; c; c = c->next)
	  {
	    if (EQ (c->tag, tag))
994
	      unwind_to_catch (c, value);
Jim Blandy's avatar
Jim Blandy committed
995
	  }
996
      tag = Fsignal (Qno_catch, Fcons (tag, Fcons (value, Qnil)));
Jim Blandy's avatar
Jim Blandy committed
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
    }
}


DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
  "Do BODYFORM, protecting with UNWINDFORMS.\n\
Usage looks like (unwind-protect BODYFORM 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\
Usage looks like (condition-case VAR BODYFORM HANDLERS...).\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\
1036 1037 1038
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
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
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;
1052
  register Lisp_Object var, bodyform, handlers;
Jim Blandy's avatar
Jim Blandy committed
1053

1054 1055 1056 1057 1058 1059 1060 1061 1062
  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);
1063 1064
      if (! (NILP (tem)
	     || (CONSP (tem)
1065 1066
		 && (SYMBOLP (XCAR (tem))
		     || CONSP (XCAR (tem))))))
1067 1068
	error ("Invalid condition handler", tem);
    }
Jim Blandy's avatar
Jim Blandy committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

  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;
  if (_setjmp (c.jmp))
    {
Jim Blandy's avatar
Jim Blandy committed
1080
      if (!NILP (h.var))
1081 1082
        specbind (h.var, c.val);
      val = Fprogn (Fcdr (h.chosen_clause));
1083 1084 1085 1086

      /* 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
1087 1088 1089 1090 1091 1092
      unbind_to (c.pdlcount, Qnil);
      return val;
    }
  c.next = catchlist;
  catchlist = &c;
  
1093 1094
  h.var = var;
  h.handler = handlers;
Jim Blandy's avatar
Jim Blandy committed
1095 1096 1097 1098
  h.next = handlerlist;
  h.tag = &c;
  handlerlist = &h;

1099
  val = Feval (bodyform);
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102 1103 1104
  catchlist = c.next;
  handlerlist = h.next;
  return val;
}

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
/* Call the function BFUN with no arguments, catching errors within it
   according to HANDLERS.  If there is an error, call HFUN with
   one argument which is the data that describes the error:
   (SIGNALNAME . DATA)

   HANDLERS can be a list of conditions to catch.
   If HANDLERS is Qt, catch all errors.
   If HANDLERS is Qerror, catch all errors
   but allow the debugger to run if that is enabled.  */

Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
Lisp_Object
internal_condition_case (bfun, handlers, hfun)
     Lisp_Object (*bfun) ();
     Lisp_Object handlers;
     Lisp_Object (*hfun) ();
{
  Lisp_Object val;
  struct catchtag c;
  struct handler h;

1125 1126 1127 1128 1129
  /* Since Fsignal resets this to 0, it had better be 0 now
     or else we have a potential bug.  */
  if (interrupt_input_blocked != 0)
    abort ();

Jim Blandy's avatar
Jim Blandy committed
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
  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;
  if (_setjmp (c.jmp))
    {
1140
      return (*hfun) (c.val);
Jim Blandy's avatar
Jim Blandy committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
    }
  c.next = catchlist;
  catchlist = &c;
  h.handler = handlers;
  h.var = Qnil;
  h.next = handlerlist;
  h.tag = &c;
  handlerlist = &h;

  val = (*bfun) ();
  catchlist = c.next;
  handlerlist = h.next;
  return val;
}

1156 1157
/* Like internal_condition_case but call HFUN with ARG as its argument.  */

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
Lisp_Object
internal_condition_case_1 (bfun, arg, handlers, hfun)
     Lisp_Object (*bfun) ();
     Lisp_Object arg;
     Lisp_Object handlers;
     Lisp_Object (*hfun) ();
{
  Lisp_Object val;
  struct catchtag c;
  struct handler h;

  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;
  if (_setjmp (c.jmp))
    {
1179
      return (*hfun) (c.val);
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
    }
  c.next = catchlist;
  catchlist = &c;
  h.handler = handlers;
  h.var = Qnil;
  h.next = handlerlist;
  h.tag = &c;
  handlerlist = &h;

  val = (*bfun) (arg);
  catchlist = c.next;
  handlerlist = h.next;
  return val;
}

Jim Blandy's avatar
Jim Blandy committed
1195 1196 1197
static Lisp_Object find_handler_clause ();

DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1198
  "Signal an error.  Args are ERROR-SYMBOL and associated DATA.\n\
Jim Blandy's avatar
Jim Blandy committed
1199
This function does not return.\n\n\
1200
An error symbol is a symbol with an `error-conditions' property\n\
Jim Blandy's avatar
Jim Blandy committed
1201 1202 1203 1204 1205 1206 1207
that is a list of condition names.\n\
A handler for any of those names will get to handle this signal.\n\
The symbol `error' should normally be one of them.\n\
\n\
DATA should be a list.  Its elements are printed as part of the error message.\n\
If the signal is handled, DATA is made available to the handler.\n\
See also the function `condition-case'.")
1208 1209
  (error_symbol, data)
     Lisp_Object error_symbol, data;
Jim Blandy's avatar
Jim Blandy committed
1210
{
1211 1212
  /* When memory is full, ERROR-SYMBOL is nil,
     and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).  */
Jim Blandy's avatar
Jim Blandy committed
1213 1214 1215 1216 1217
  register struct handler *allhandlers = handlerlist;
  Lisp_Object conditions;
  extern int gc_in_progress;
  extern int waiting_for_input;
  Lisp_Object debugger_value;
1218
  Lisp_Object string;
1219
  Lisp_Object real_error_symbol;
1220
  extern int display_busy_cursor_p;
Jim Blandy's avatar
Jim Blandy committed
1221 1222 1223 1224 1225 1226 1227

  immediate_quit = 0;
  if (gc_in_progress || waiting_for_input)
    abort ();

  TOTALLY_UNBLOCK_INPUT;

1228 1229 1230 1231 1232
  if (NILP (error_symbol))
    real_error_symbol = Fcar (data);
  else
    real_error_symbol = error_symbol;

1233 1234 1235 1236 1237
#ifdef HAVE_X_WINDOWS
  if (display_busy_cursor_p)
    Fx_hide_busy_cursor (Qt);
#endif

1238 1239
  /* This hook is used by edebug.  */
  if (! NILP (Vsignal_hook_function))
1240
    call2 (Vsignal_hook_function, error_symbol, data);
1241

1242
  conditions = Fget (real_error_symbol, Qerror_conditions);
Jim Blandy's avatar