eval.c 90.4 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000, 2001
3
     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
#include <setjmp.h>

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

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

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

Jim Blandy's avatar
Jim Blandy committed
68
struct catchtag
69 70 71 72 73 74 75 76 77 78 79 80 81
{
  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 byte_stack *byte_stack;
};
Jim Blandy's avatar
Jim Blandy committed
82 83 84

struct catchtag *catchlist;

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

Jim Blandy's avatar
Jim Blandy committed
90
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
91
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
92 93 94
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.  */
98

Jim Blandy's avatar
Jim Blandy committed
99 100 101 102 103 104 105 106 107 108
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.  */
109

Jim Blandy's avatar
Jim Blandy committed
110 111 112
int specpdl_size;

/* Pointer to beginning of specpdl.  */
113

Jim Blandy's avatar
Jim Blandy committed
114 115 116
struct specbinding *specpdl;

/* Pointer to first unused element in specpdl.  */
117

Jim Blandy's avatar
Jim Blandy committed
118 119 120
struct specbinding *specpdl_ptr;

/* Maximum size allowed for specpdl allocation */
121

122
int max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
123 124

/* Depth in Lisp evaluations and function calls.  */
125

Jim Blandy's avatar
Jim Blandy committed
126 127 128
int lisp_eval_depth;

/* Maximum allowed depth in Lisp evaluations and function calls.  */
129

130
int max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
131 132

/* Nonzero means enter debugger before next function call */
133

Jim Blandy's avatar
Jim Blandy committed
134 135
int debug_on_next_call;

136
/* Non-zero means debugger may continue.  This is zero when the
137 138 139 140 141
   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
142
/* List of conditions (non-nil atom means all) which cause a backtrace
143
   if an error is handled by the command loop's error handler.  */
144

Roland McGrath's avatar
Roland McGrath committed
145
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
146

Roland McGrath's avatar
Roland McGrath committed
147
/* List of conditions (non-nil atom means all) which enter the debugger
148
   if an error is handled by the command loop's error handler.  */
149

Roland McGrath's avatar
Roland McGrath committed
150
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
151

Karl Heuer's avatar
Karl Heuer committed
152
/* List of conditions and regexps specifying error messages which
153
   do not enter the debugger even if Vdebug_on_error says they should.  */
154

Karl Heuer's avatar
Karl Heuer committed
155 156
Lisp_Object Vdebug_ignored_errors;

157
/* Non-nil means call the debugger even if the error will be handled.  */
158

159
Lisp_Object Vdebug_on_signal;
160 161

/* Hook for edebug to use.  */
162

163 164
Lisp_Object Vsignal_hook_function;

Jim Blandy's avatar
Jim Blandy committed
165
/* Nonzero means enter debugger if a quit signal
Roland McGrath's avatar
Roland McGrath committed
166
   is handled by the command loop's error handler. */
167

Jim Blandy's avatar
Jim Blandy committed
168 169
int debug_on_quit;

170
/* The value of num_nonmacro_input_events as of the last time we
171
   started to enter the debugger.  If we decide to enter the debugger
172
   again when this is still equal to num_nonmacro_input_events, then we
173 174 175
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
176

177
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
178 179 180

Lisp_Object Vdebugger;

181 182 183 184 185
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

186 187 188 189 190 191
/* Set to non-zero while processing X events.  Checked in Feval to
   make sure the Lisp interpreter isn't called from a signal handler,
   which is unsafe because the interpreter isn't reentrant.  */

int handling_signal;

192
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
Jim Blandy's avatar
Jim Blandy committed
193

Andreas Schwab's avatar
Andreas Schwab committed
194
void
Jim Blandy's avatar
Jim Blandy committed
195 196 197
init_eval_once ()
{
  specpdl_size = 50;
198
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
199
  specpdl_ptr = specpdl;
Jim Blandy's avatar
Jim Blandy committed
200
  max_specpdl_size = 600;
201
  max_lisp_eval_depth = 300;
202 203

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
204 205
}

Andreas Schwab's avatar
Andreas Schwab committed
206
void
Jim Blandy's avatar
Jim Blandy committed
207 208 209 210 211 212 213 214 215
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
216
#ifdef DEBUG_GCPRO
217
  gcpro_level = 0;
218
#endif
219
  /* This is less than the initial value of num_nonmacro_input_events.  */
220
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
221 222 223 224 225 226
}

Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
227
  int debug_while_redisplaying;
228
  int count = specpdl_ptr - specpdl;
229 230
  Lisp_Object val;
  
Jim Blandy's avatar
Jim Blandy committed
231 232
  if (lisp_eval_depth + 20 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 20;
233
  
Jim Blandy's avatar
Jim Blandy committed
234 235
  if (specpdl_size + 40 > max_specpdl_size)
    max_specpdl_size = specpdl_size + 40;
236
  
237
#ifdef HAVE_X_WINDOWS
238 239
  if (display_hourglass_p)
    cancel_hourglass ();
240 241
#endif

Jim Blandy's avatar
Jim Blandy committed
242
  debug_on_next_call = 0;
243
  when_entered_debugger = num_nonmacro_input_events;
244 245 246 247 248

  /* 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;
249 250
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
251
  specbind (Qinhibit_redisplay, Qnil);
252 253 254

#if 0 /* Binding this prevents execution of Lisp code during
	 redisplay, which necessarily leads to display problems.  */
255
  specbind (Qinhibit_eval_during_redisplay, Qt);
256
#endif
257 258 259 260 261
  
  val = apply1 (Vdebugger, arg);

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

266
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
267 268
}

Andreas Schwab's avatar
Andreas Schwab committed
269
void
Jim Blandy's avatar
Jim Blandy committed
270 271 272 273 274 275 276 277 278 279 280 281 282
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,
Pavel Janík's avatar
Pavel Janík committed
283 284 285
       doc: /* Eval args until one of them yields non-nil, then return that value.
The remaining args are not evalled at all.
If all args return nil, return nil.
286
usage: (or CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
287
     (args)
Jim Blandy's avatar
Jim Blandy committed
288 289 290 291 292 293
     Lisp_Object args;
{
  register Lisp_Object val;
  Lisp_Object args_left;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
294
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302
    return Qnil;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
303
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
304 305 306
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
307
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312 313

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
314
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
315 316
The remaining args are not evalled at all.
If no arg yields nil, return the last arg's value.
317
usage: (and CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
318
     (args)
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322 323 324
     Lisp_Object args;
{
  register Lisp_Object val;
  Lisp_Object args_left;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
325
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329 330 331 332 333
    return Qt;

  args_left = args;
  GCPRO1 (args_left);

  do
    {
      val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
334
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
335 336 337
	break;
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
338
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
345
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
346 347 348
Returns the value of THEN or the value of the last of the ELSE's.
THEN must be one expression, but ELSE... can be zero or more expressions.
If COND yields nil, and there are no ELSE's, the value is nil.
349
usage: (if COND THEN ELSE...)  */)
Pavel Janík's avatar
Pavel Janík committed
350
     (args)
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356 357 358 359
     Lisp_Object args;
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

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

Jim Blandy's avatar
Jim Blandy committed
360
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365
    return Feval (Fcar (Fcdr (args)));
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
366 367 368 369 370 371 372 373
       doc: /* Try each clause until one succeeds.
Each clause looks like (CONDITION BODY...).  CONDITION is evaluated
and, if the value is non-nil, this clause succeeds:
then the expressions in BODY are evaluated and the last one's
value is the value of the cond-form.
If no clause succeeds, cond returns nil.
If a clause has one element, as in (CONDITION),
CONDITION's value if non-nil is returned from the cond-form.
374
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
375
     (args)
Jim Blandy's avatar
Jim Blandy committed
376 377 378 379 380 381 382
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
383
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
384 385 386
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
387
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
388
	{
389 390
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
391 392
	  break;
	}
393
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
394 395 396 397 398 399 400
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
401
       doc: /* Eval BODY forms sequentially and return value of last one.
402
usage: (progn BODY ...)  */)
Pavel Janík's avatar
Pavel Janík committed
403
     (args)
Jim Blandy's avatar
Jim Blandy committed
404 405
     Lisp_Object args;
{
406
  register Lisp_Object val;
Jim Blandy's avatar
Jim Blandy committed
407 408 409
  Lisp_Object args_left;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
410
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415 416 417 418 419 420
    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
421
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
428 429 430
       doc: /* Eval FIRST and BODY sequentially; value from FIRST.
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
431
usage: (prog1 FIRST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
432
     (args)
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438 439
     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
440
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454
    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
455
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
462 463 464
       doc: /* Eval X, Y and BODY sequentially; value from Y.
The value of Y is saved during the evaluation of the remaining args,
whose values are discarded.
465
usage: (prog2 X Y BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
466
     (args)
Jim Blandy's avatar
Jim Blandy committed
467 468 469 470 471 472 473 474 475
     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
476
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490
    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
491
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
492 493 494 495 496 497

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
498 499 500 501 502 503 504 505 506
       doc: /* Set each SYM to the value of its VAL.
The symbols SYM are variables; they are literal (not evaluated).
The values VAL are expressions; they are evaluated.
Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
The second VAL is not computed until after the first SYM is set, and so on;
each VAL can use the new value of variables set earlier in the `setq'.
The return value of the `setq' form is the value of the last VAL.
usage: (setq SYM VAL SYM VAL ...)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
507 508 509 510 511 512
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
513
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517 518 519 520 521 522 523 524 525
    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
526
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
527 528 529 530 531 532

  UNGCPRO;
  return val;
}
     
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
533 534 535
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541
     Lisp_Object args;
{
  return Fcar (args);
}
     
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
542 543 544 545 546
       doc: /* Like `quote', but preferred for objects which are functions.
In byte compilation, `function' causes its argument to be compiled.
`quote' cannot do that.
usage: (function ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
547 548 549 550 551
     Lisp_Object args;
{
  return Fcar (args);
}

552

Jim Blandy's avatar
Jim Blandy committed
553
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
554 555 556 557 558
       doc: /* Return t if function in which this appears was called interactively.
This means that the function was called with call-interactively (which
includes being called as the binding of a key)
and input is currently coming from the keyboard (not in keyboard macro).  */)
     ()
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 577 578
  return interactive_p (1) ? Qt : Qnil;
}


/*  Return 1 if function in which this appears was called
    interactively.  This means that the function was called with
    call-interactively (which includes being called as the binding of
    a key) and input is currently coming from the keyboard (not in
    keyboard macro).

    EXCLUDE_SUBRS_P non-zero means always return 0 if the function
    called is a built-in.  */

int
interactive_p (exclude_subrs_p)
     int exclude_subrs_p;
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
579 580

  if (!INTERACTIVE)
581
    return 0;
Jim Blandy's avatar
Jim Blandy committed
582 583

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
584 585

  /* If this isn't a byte-compiled function, there may be a frame at
586
     the top for Finteractive_p.  If so, skip it.  */
Jim Blandy's avatar
Jim Blandy committed
587
  fun = Findirect_function (*btp->function);
588
  if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
Jim Blandy's avatar
Jim Blandy committed
589
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
590 591 592 593 594 595 596 597 598 599 600 601 602

  /* 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
603 604
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
605 606 607 608
  /* 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
609
  fun = Findirect_function (*btp->function);
610 611 612
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
  
Jim Blandy's avatar
Jim Blandy committed
613 614 615
  /* 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))
616 617
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
618 619
}

620

Jim Blandy's avatar
Jim Blandy committed
621
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
622 623 624
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
625
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
626
     (args)
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632 633
     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
634
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
635 636
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
637
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
642 643 644 645 646 647
       doc: /* Define NAME as a macro.
The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).
When the macro is called, as in (NAME ARGS...),
the function (lambda ARGLIST BODY...) is applied to
the list ARGS... as it appears in the expression,
and the result should be a form to be evaluated instead of the original.
648
usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
649
     (args)
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653 654 655 656
     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
657
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
658 659
    defn = Fpurecopy (defn);
  Ffset (fn_name, defn);
660
  LOADHIST_ATTACH (fn_name);
Jim Blandy's avatar
Jim Blandy committed
661 662 663
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
664 665

DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 2, 0,
Pavel Janík's avatar
Pavel Janík committed
666 667 668 669 670
       doc: /* Make SYMBOL a variable alias for symbol ALIASED.
Setting the value of SYMBOL will subsequently set the value of ALIASED,
and getting the value of SYMBOL will return the value ALIASED has.
ALIASED nil means remove the alias; SYMBOL is unbound after that.  */)
     (symbol, aliased)
Gerd Moellmann's avatar
Gerd Moellmann committed
671 672 673 674
     Lisp_Object symbol, aliased;
{
  struct Lisp_Symbol *sym;
  
675 676
  CHECK_SYMBOL (symbol);
  CHECK_SYMBOL (aliased);
Gerd Moellmann's avatar
Gerd Moellmann committed
677 678 679 680 681 682 683 684 685 686 687 688 689 690

  if (SYMBOL_CONSTANT_P (symbol))
    error ("Cannot make a constant an alias");

  sym = XSYMBOL (symbol);
  sym->indirect_variable = 1;
  sym->value = aliased;
  sym->constant = SYMBOL_CONSTANT_P (aliased);
  LOADHIST_ATTACH (symbol);
  
  return aliased;
}


Jim Blandy's avatar
Jim Blandy committed
691
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
692 693 694 695 696 697 698 699 700 701 702 703 704
       doc: /* Define SYMBOL as a variable.
You are not required to define a variable in order to use it,
but the definition can supply documentation and an initial value
in a way that tags can recognize.

INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
If SYMBOL is buffer-local, its default value is what is set;
 buffer-local values are not affected.
INITVALUE and DOCSTRING are optional.
If DOCSTRING starts with *, this variable is identified as a user option.
 This means that M-x set-variable recognizes it.
 See also `user-variable-p'.
If INITVALUE is missing, SYMBOL's value is not set.
705
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
706
     (args)
Jim Blandy's avatar
Jim Blandy committed
707 708
     Lisp_Object args;
{
709
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
710 711

  sym = Fcar (args);
712 713 714 715
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
    error ("too many arguments");

716
  tem = Fdefault_boundp (sym);
717
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
718
    {
Jim Blandy's avatar
Jim Blandy committed
719
      if (NILP (tem))
720 721 722 723 724 725 726 727 728 729
	Fset_default (sym, Feval (Fcar (tail)));
      tail = Fcdr (tail);
      if (!NILP (Fcar (tail)))
	{
	  tem = Fcar (tail);
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
730
    }
731 732 733 734 735 736 737
  else
    /* A (defvar <var>) should not take precedence in the load-history over
       an earlier (defvar <var> <val>), so only add to history if the default
       value is still unbound.  */
    if (NILP (tem))
      LOADHIST_ATTACH (sym);
    
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
742 743 744 745 746 747
       doc: /* Define SYMBOL as a constant variable.
The intent is that neither programs nor users should ever change this value.
Always sets the value of SYMBOL to the result of evalling INITVALUE.
If SYMBOL is buffer-local, its default value is what is set;
 buffer-local values are not affected.
DOCSTRING is optional.
748
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
749
     (args)
Jim Blandy's avatar
Jim Blandy committed
750 751 752 753 754
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
755 756 757
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
    error ("too many arguments");

758 759 760 761
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
762
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
763
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
764
    {
Jim Blandy's avatar
Jim Blandy committed
765
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
766 767 768
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
769
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
770 771 772 773
  return sym;
}

DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
Pavel Janík's avatar
Pavel Janík committed
774 775 776 777 778 779 780
       doc: /* Returns t if VARIABLE is intended to be set and modified by users.
\(The alternative is a variable used internally in a Lisp program.)
Determined by whether the first character of the documentation
for the variable is `*' or if the variable is customizable (has a non-nil
value of any of `custom-type', `custom-loads' or `standard-value'
on its property list).  */)
     (variable)
Jim Blandy's avatar
Jim Blandy committed
781 782 783 784
     Lisp_Object variable;
{
  Lisp_Object documentation;
  
785 786 787
  if (!SYMBOLP (variable))
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
788
  documentation = Fget (variable, Qvariable_documentation);
789
  if (INTEGERP (documentation) && XINT (documentation) < 0)
Jim Blandy's avatar
Jim Blandy committed
790
    return Qt;
791 792 793 794 795
  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)
796 797 798
      && STRINGP (XCAR (documentation))
      && INTEGERP (XCDR (documentation))
      && XINT (XCDR (documentation)) < 0)
Jim Blandy's avatar
Jim Blandy committed
799
    return Qt;
800 801 802 803 804
  /* 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
805 806 807 808
  return Qnil;
}  

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
809 810 811 812 813
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
Each VALUEFORM can refer to the symbols already bound by this VARLIST.
814
usage: (let* VARLIST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
815
     (args)
Jim Blandy's avatar
Jim Blandy committed
816 817 818 819 820 821 822 823 824
     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
825
  while (!NILP (varlist))
Jim Blandy's avatar
Jim Blandy committed
826 827 828
    {
      QUIT;
      elt = Fcar (varlist);
829
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
830
	specbind (elt, Qnil);
Jim Blandy's avatar
Jim Blandy committed
831 832 833 834
      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
835 836 837 838 839 840 841 842 843 844 845 846 847
      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,
Pavel Janík's avatar
Pavel Janík committed
848 849 850 851 852
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
All the VALUEFORMs are evalled before any symbols are bound.
853
usage: (let VARLIST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
854
     (args)
Jim Blandy's avatar
Jim Blandy committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
     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
874
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
875 876 877
    {
      QUIT;
      elt = Fcar (varlist);
878
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
879
	temps [argnum++] = Qnil;
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883
      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
884 885 886 887 888 889 890
      else
	temps [argnum++] = Feval (Fcar (Fcdr (elt)));
      gcpro2.nvars = argnum;
    }
  UNGCPRO;

  varlist = Fcar (args);
Jim Blandy's avatar
Jim Blandy committed
891
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
892 893 894
    {
      elt = Fcar (varlist);
      tem = temps[argnum++];
895
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900 901 902 903 904 905
	specbind (elt, tem);
      else
	specbind (Fcar (elt), tem);
    }

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

DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
906 907 908
       doc: /* If TEST yields non-nil, eval BODY... and repeat.
The order of execution is thus TEST, BODY, TEST, BODY and so on
until TEST returns nil.
909
usage: (while TEST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
910
     (args)
Jim Blandy's avatar
Jim Blandy committed
911 912
     Lisp_Object args;
{
913
  Lisp_Object test, body;
Jim Blandy's avatar
Jim Blandy committed
914 915 916 917 918 919
  struct gcpro gcpro1, gcpro2;

  GCPRO2 (test, body);

  test = Fcar (args);
  body = Fcdr (args);
920
  while (!NILP (Feval (test)))
Jim Blandy's avatar
Jim Blandy committed
921 922 923 924 925 926 927 928 929 930
    {
      QUIT;
      Fprogn (body);
    }

  UNGCPRO;
  return Qnil;
}

DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
Pavel Janík's avatar
Pavel Janík committed
931 932 933 934 935 936 937 938
       doc: /* Return result of expanding macros at top level of FORM.
If FORM is not a macro call, it is returned unchanged.
Otherwise, the macro is expanded and the expansion is considered
in place of FORM.  When a non-macro-call results, it is returned.

The second optional arg ENVIRONMENT specifies an environment of macro
definitions to shadow the loaded ones for use in file byte-compilation.  */)
     (form, environment)
939
     Lisp_Object form;
940
     Lisp_Object environment;
Jim Blandy's avatar
Jim Blandy committed
941
{
Jim Blandy's avatar
Jim Blandy committed
942
  /* With cleanups from Hallvard Furuseth.  */
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946 947 948
  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.  */
949
      if (!CONSP (form))
Jim Blandy's avatar
Jim Blandy committed
950
	break;
Jim Blandy's avatar
Jim Blandy committed
951
      /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
952
      def = sym = XCAR (form);
Jim Blandy's avatar
Jim Blandy committed
953
      tem = Qnil;
Jim Blandy's avatar
Jim Blandy committed
954 955
      /* Trace symbols aliases to other symbols
	 until we get a symbol that is not an alias.  */
956
      while (SYMBOLP (def))
Jim Blandy's avatar
Jim Blandy committed
957 958
	{
	  QUIT;
Jim Blandy's avatar
Jim Blandy committed
959
	  sym = def;
960
	  tem = Fassq (sym, environment);
Jim Blandy's avatar
Jim Blandy committed
961
	  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
962 963
	    {
	      def = XSYMBOL (sym)->function;
Jim Blandy's avatar
Jim Blandy committed
964 965
	      if (!EQ (def, Qunbound))
		continue;
Jim Blandy's avatar
Jim Blandy committed
966
	    }
Jim Blandy's avatar
Jim Blandy committed
967
	  break;
Jim Blandy's avatar
Jim Blandy committed
968
	}
969
      /* Right now TEM is the result from SYM in ENVIRONMENT,
Jim Blandy's avatar
Jim Blandy committed
970
	 and if TEM is nil then DEF is SYM's function definition.  */
Jim Blandy's avatar
Jim Blandy committed
971
      if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
972
	{
973
	  /* SYM is not mentioned in ENVIRONMENT.
Jim Blandy's avatar
Jim Blandy committed
974
	     Look at its function definition.  */
975
	  if (EQ (def, Qunbound) || !CONSP (def))
Jim Blandy's avatar
Jim Blandy committed
976 977
	    /* Not defined or definition not suitable */
	    break;
978
	  if (EQ (XCAR (def), Qautoload))
Jim Blandy's avatar
Jim Blandy committed
979 980
	    {
	      /* Autoloading function: will it be a macro when loaded?  */
981
	      tem = Fnth (make_number (4), def);
982
	      if (EQ (tem, Qt) || EQ (tem, Qmacro))
983 984
		/* Yes, load it and try again.  */
		{
985 986
		  struct gcpro gcpro1;
		  GCPRO1 (form);
987
		  do_autoload (def, sym);
988
		  UNGCPRO;
989 990 991
		  continue;
		}
	      else
Jim Blandy's avatar
Jim Blandy committed
992 993
		break;
	    }
994
	  else if (!EQ (XCAR (def), Qmacro))
Jim Blandy's avatar
Jim Blandy committed
995
	    break;
996
	  else expander = XCDR (def);
Jim Blandy's avatar
Jim Blandy committed
997 998 999
	}
      else
	{
1000
	  expander = XCDR (tem);
Jim Blandy's avatar
Jim Blandy committed
1001
	  if (NILP (expander))
Jim Blandy's avatar
Jim Blandy committed
1002 1003
	    break;
	}
1004
      form = apply1 (expander, XCDR (form));
Jim Blandy's avatar
Jim Blandy committed
1005 1006 1007 1008 1009
    }
  return form;
}

DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
1010 1011 1012 1013 1014 1015 1016
       doc: /* Eval BODY allowing nonlocal exits using `throw'.
TAG is evalled to get the tag to use; it must not be nil.

Then the BODY is executed.
Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.
If no throw happens, `catch' returns the value of the last BODY form.
If a throw happens, it specifies the value to return from `catch'.
1017
usage: (catch TAG BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
1018
     (args)
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
     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