eval.c 104 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, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
                 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23
#include "lisp.h"
24
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "keyboard.h"
27
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
28 29
#include <setjmp.h>

30 31 32 33
#if HAVE_X_WINDOWS
#include "xterm.h"
#endif

Jim Blandy's avatar
Jim Blandy committed
34 35 36 37
/* This definition is duplicated in alloc.c and keyboard.c */
/* Putting it in lisp.h makes cc bomb out! */

struct backtrace
38 39 40 41 42
{
  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
43 44
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
45 46 47 48
  char evalargs;
  /* Nonzero means call value of debugger when done with this operation. */
  char debug_on_exit;
};
Jim Blandy's avatar
Jim Blandy committed
49 50 51

struct backtrace *backtrace_list;

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/* 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.  */
70

Jim Blandy's avatar
Jim Blandy committed
71
struct catchtag
72 73 74 75 76 77 78 79 80 81 82
{
  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;
83
  int interrupt_input_blocked;
84 85
  struct byte_stack *byte_stack;
};
Jim Blandy's avatar
Jim Blandy committed
86 87 88

struct catchtag *catchlist;

89 90 91 92 93
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

94
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
95
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
96 97
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
98
Lisp_Object Qdeclare;
99
Lisp_Object Qdebug;
100
extern Lisp_Object Qinteractive_form;
Jim Blandy's avatar
Jim Blandy committed
101

102 103 104
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
105

Jim Blandy's avatar
Jim Blandy committed
106 107 108 109 110
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:
111
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
112 113 114 115

Lisp_Object Vautoload_queue;

/* Current number of specbindings allocated in specpdl.  */
116

Jim Blandy's avatar
Jim Blandy committed
117 118 119
int specpdl_size;

/* Pointer to beginning of specpdl.  */
120

Jim Blandy's avatar
Jim Blandy committed
121 122 123
struct specbinding *specpdl;

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

125
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
126 127

/* Maximum size allowed for specpdl allocation */
128

129
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
130 131

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

Jim Blandy's avatar
Jim Blandy committed
133 134 135
int lisp_eval_depth;

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

137
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
138 139

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

Jim Blandy's avatar
Jim Blandy committed
141 142
int debug_on_next_call;

143
/* Non-zero means debugger may continue.  This is zero when the
144 145 146 147 148
   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
149
/* List of conditions (non-nil atom means all) which cause a backtrace
150
   if an error is handled by the command loop's error handler.  */
151

Roland McGrath's avatar
Roland McGrath committed
152
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
153

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

Roland McGrath's avatar
Roland McGrath committed
157
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
158

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

Karl Heuer's avatar
Karl Heuer committed
162 163
Lisp_Object Vdebug_ignored_errors;

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

166
Lisp_Object Vdebug_on_signal;
167 168

/* Hook for edebug to use.  */
169

170 171
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
175 176
int debug_on_quit;

177
/* The value of num_nonmacro_input_events as of the last time we
178
   started to enter the debugger.  If we decide to enter the debugger
179
   again when this is still equal to num_nonmacro_input_events, then we
180 181 182
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
183

184
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
185 186 187

Lisp_Object Vdebugger;

188 189 190 191 192
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

193 194 195 196 197 198
/* 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;

199 200 201 202
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

203
extern Lisp_Object Qrisky_local_variable;
204

205 206
extern Lisp_Object Qfunction;

207
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
208
static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
209 210 211 212 213 214 215 216

#if __GNUC__
/* "gcc -O3" enables automatic function inlining, which optimizes out
   the arguments for the invocations of these functions, whereas they
   expect these values on the stack.  */
Lisp_Object apply1 () __attribute__((noinline));
Lisp_Object call2 () __attribute__((noinline));
#endif
217

Andreas Schwab's avatar
Andreas Schwab committed
218
void
Jim Blandy's avatar
Jim Blandy committed
219 220 221
init_eval_once ()
{
  specpdl_size = 50;
222
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
223
  specpdl_ptr = specpdl;
224
  /* Don't forget to update docs (lispref node "Local Variables").  */
225
  max_specpdl_size = 1000;
226
  max_lisp_eval_depth = 400;
227 228

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
229 230
}

Andreas Schwab's avatar
Andreas Schwab committed
231
void
Jim Blandy's avatar
Jim Blandy committed
232 233 234 235 236 237 238 239 240
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
241
#ifdef DEBUG_GCPRO
242
  gcpro_level = 0;
243
#endif
244
  /* This is less than the initial value of num_nonmacro_input_events.  */
245
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
246 247
}

248 249 250 251 252 253 254 255
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
restore_stack_limits (data)
     Lisp_Object data;
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
256
  return Qnil;
257 258 259 260
}

/* Call the Lisp debugger, giving it argument ARG.  */

Jim Blandy's avatar
Jim Blandy committed
261 262 263 264
Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
265
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
266
  int count = SPECPDL_INDEX ();
267
  Lisp_Object val;
268
  int old_max = max_specpdl_size;
269

270 271
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
272

273 274 275 276 277 278 279 280 281 282 283
  max_specpdl_size += 1;
  record_unwind_protect (restore_stack_limits,
			 Fcons (make_number (old_max),
				make_number (max_lisp_eval_depth)));
  max_specpdl_size = old_max;

  if (lisp_eval_depth + 40 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 40;

  if (SPECPDL_INDEX () + 100 > max_specpdl_size)
    max_specpdl_size = SPECPDL_INDEX () + 100;
284

285
#ifdef HAVE_WINDOW_SYSTEM
286 287
  if (display_hourglass_p)
    cancel_hourglass ();
288 289
#endif

Jim Blandy's avatar
Jim Blandy committed
290
  debug_on_next_call = 0;
291
  when_entered_debugger = num_nonmacro_input_events;
292 293 294 295 296

  /* 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;
297 298
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
299
  specbind (Qinhibit_redisplay, Qnil);
300
  specbind (Qdebug_on_error, Qnil);
301 302 303

#if 0 /* Binding this prevents execution of Lisp code during
	 redisplay, which necessarily leads to display problems.  */
304
  specbind (Qinhibit_eval_during_redisplay, Qt);
305
#endif
306

307 308 309 310
  val = apply1 (Vdebugger, arg);

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

315
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
316 317
}

Andreas Schwab's avatar
Andreas Schwab committed
318
void
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322 323 324 325 326 327 328 329 330 331
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
332 333 334
       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.
Juanma Barranquero's avatar
Juanma Barranquero committed
335
usage: (or CONDITIONS...)  */)
Pavel Janík's avatar
Pavel Janík committed
336
     (args)
Jim Blandy's avatar
Jim Blandy committed
337 338
     Lisp_Object args;
{
339
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
340 341
  struct gcpro gcpro1;

342
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
343

344
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
345
    {
346
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
347
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
348
	break;
349
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
350 351 352 353 354 355 356
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
357
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
358 359
The remaining args are not evalled at all.
If no arg yields nil, return the last arg's value.
Juanma Barranquero's avatar
Juanma Barranquero committed
360
usage: (and CONDITIONS...)  */)
Pavel Janík's avatar
Pavel Janík committed
361
     (args)
Jim Blandy's avatar
Jim Blandy committed
362 363
     Lisp_Object args;
{
364
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
365 366
  struct gcpro gcpro1;

367
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
368

369
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
370
    {
371
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
372
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
373
	break;
374
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
375 376 377 378 379 380 381
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
382
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
383 384 385
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.
386
usage: (if COND THEN ELSE...)  */)
Pavel Janík's avatar
Pavel Janík committed
387
     (args)
Jim Blandy's avatar
Jim Blandy committed
388 389 390 391 392 393 394 395 396
     Lisp_Object args;
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

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

Jim Blandy's avatar
Jim Blandy committed
397
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402
    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
403 404 405 406 407 408 409 410
       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.
411
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
412
     (args)
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417 418 419
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
420
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
421 422 423
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
424
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
425
	{
426 427
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
428 429
	  break;
	}
430
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
431 432 433 434 435 436 437
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
438
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
439
usage: (progn BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
440
     (args)
Jim Blandy's avatar
Jim Blandy committed
441 442
     Lisp_Object args;
{
443
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
444 445
  struct gcpro gcpro1;

446
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
447

448
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
449
    {
450 451
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456 457 458
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
459
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
460 461
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
462
usage: (prog1 FIRST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
463
     (args)
Jim Blandy's avatar
Jim Blandy committed
464 465 466 467 468 469 470
     Lisp_Object args;
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

471
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485
    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
486
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490 491 492

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
493
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
494 495 496
The value of FORM2 is saved during the evaluation of the
remaining args, whose values are discarded.
usage: (prog2 FORM1 FORM2 BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
497
     (args)
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503 504 505 506
     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
507
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521
    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
522
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526 527 528

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
529 530 531 532 533 534 535
       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.
Juanma Barranquero's avatar
Juanma Barranquero committed
536
usage: (setq [SYM VAL]...)  */)
Pavel Janík's avatar
Pavel Janík committed
537
     (args)
Jim Blandy's avatar
Jim Blandy committed
538 539 540 541 542 543
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

544
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549 550 551 552 553 554 555 556
    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
557
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
558 559 560 561

  UNGCPRO;
  return val;
}
562

Jim Blandy's avatar
Jim Blandy committed
563
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
564 565 566
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
567 568
     Lisp_Object args;
{
569 570
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
571 572
  return Fcar (args);
}
573

Jim Blandy's avatar
Jim Blandy committed
574
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
575 576 577 578 579
       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
580 581
     Lisp_Object args;
{
582 583
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
584 585 586
  return Fcar (args);
}

587

Jim Blandy's avatar
Jim Blandy committed
588
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
589
       doc: /* Return t if the containing function was run directly by user input.
590 591
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
592
and input is currently coming from the keyboard (not a keyboard macro),
593 594 595 596 597 598 599 600
and Emacs is not running in batch mode (`noninteractive' is nil).

The only known proper use of `interactive-p' is in deciding whether to
display a helpful message, or how to display it.  If you're thinking
of using it for any other purpose, it is quite likely that you're
making a mistake.  Think: what do you want to do when the command is
called from a keyboard macro?

601 602 603 604
To test whether your function was called with `call-interactively',
either (i) add an extra optional argument and give it an `interactive'
spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
use `called-interactively-p'.  */)
Pavel Janík's avatar
Pavel Janík committed
605
     ()
Jim Blandy's avatar
Jim Blandy committed
606
{
607
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
608 609 610
}


611
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 0, 0,
612 613 614 615 616 617 618 619 620
       doc: /* Return t if the containing function was called by `call-interactively'.
This includes being called as the binding of a key, or called from a
keyboard macro (unlike `interactive-p').

This function is meant for implementing advice and other
function-modifying features.  Instead of using this, it is sometimes
cleaner to give your function an extra optional argument whose
`interactive' spec specifies non-nil unconditionally (\"p\" is a good
way to do this).  */)
621 622
     ()
{
623
  return interactive_p (1) ? Qt : Qnil;
624 625 626 627 628
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
629 630 631 632 633 634 635 636 637 638

    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
639 640

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
641 642

  /* If this isn't a byte-compiled function, there may be a frame at
643
     the top for Finteractive_p.  If so, skip it.  */
644
  fun = Findirect_function (*btp->function, Qnil);
645 646
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
647
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
648 649

  /* If we're running an Emacs 18-style byte-compiled function, there
650 651 652
     may be a frame for Fbytecode at the top level.  In any version of
     Emacs there can be Fbytecode frames for subexpressions evaluated
     inside catch and condition-case.  Skip past them.
Jim Blandy's avatar
Jim Blandy committed
653

654
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
655
     looking at several frames for special forms.  Skip past them.  */
656 657 658
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
659 660
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
661 662 663 664
  /* 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.  */
665
  fun = Findirect_function (*btp->function, Qnil);
666 667
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
668

Jim Blandy's avatar
Jim Blandy committed
669 670 671
  /* 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))
672 673
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
674 675
}

676

Jim Blandy's avatar
Jim Blandy committed
677
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
678 679 680
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
681
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
682
     (args)
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
689
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
690
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
691
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
692
    defn = Fpurecopy (defn);
693 694 695
  if (CONSP (XSYMBOL (fn_name)->function)
      && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, fn_name));
Jim Blandy's avatar
Jim Blandy committed
696
  Ffset (fn_name, defn);
697
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
702
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
705 706 707 708
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.
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
711 712
calls to this macro, how Edebug should handle it, and which argument
should be treated as documentation.  It looks like this:
Richard M. Stallman's avatar
Richard M. Stallman committed
713 714 715 716 717
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

718
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
719
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
720
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
721 722 723 724

  (doc-string ELT)
	Set NAME's `doc-string-elt' property to ELT.

Richard M. Stallman's avatar
Richard M. Stallman committed
725
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
726
     (args)
Jim Blandy's avatar
Jim Blandy committed
727 728 729 730
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
731
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
732 733

  fn_name = Fcar (args);
734
  CHECK_SYMBOL (fn_name);
735 736 737 738 739 740
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
741 742
      doc = XCAR (tail);
      tail = XCDR (tail);
743 744 745 746 747 748 749 750 751 752 753 754
    }

  while (CONSP (Fcar (tail))
	 && EQ (Fcar (Fcar (tail)), Qdeclare))
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
755

756 757 758 759 760 761 762 763
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
  defn = Fcons (Qmacro, Fcons (Qlambda, tail));
764

Jim Blandy's avatar
Jim Blandy committed
765
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
766
    defn = Fpurecopy (defn);
767 768 769
  if (CONSP (XSYMBOL (fn_name)->function)
      && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, fn_name));
Jim Blandy's avatar
Jim Blandy committed
770
  Ffset (fn_name, defn);
771
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
772 773 774
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
775

776
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
777
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
778
Aliased variables always have the same value; setting one sets the other.
779
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
780 781 782 783
omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
itself an alias.  If NEW-ALIAS is bound, and BASE-VARIABLE is not,
then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
784 785 786
The return value is BASE-VARIABLE.  */)
     (new_alias, base_variable, docstring)
     Lisp_Object new_alias, base_variable, docstring;
Gerd Moellmann's avatar
Gerd Moellmann committed
787 788
{
  struct Lisp_Symbol *sym;
789

790 791
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
792

793
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
794 795
    error ("Cannot make a constant an alias");

796
  sym = XSYMBOL (new_alias);
797 798 799 800 801 802
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
     If n_a is bound, but b_v is not, set the value of b_v to n_a.
     This is for the sake of define-obsolete-variable-alias and user
     customizations.  */
  if (NILP (Fboundp (base_variable)) && !NILP (Fboundp (new_alias)))
    XSYMBOL(base_variable)->value = sym->value;
Gerd Moellmann's avatar
Gerd Moellmann committed
803
  sym->indirect_variable = 1;
804 805 806
  sym->value = base_variable;
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
807
  if (!NILP (docstring))
808
    Fput (new_alias, Qvariable_documentation, docstring);
809
  else
810
    Fput (new_alias, Qvariable_documentation, Qnil);
811

812
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
813 814 815
}


Jim Blandy's avatar
Jim Blandy committed
816
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
817
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
818 819 820 821 822 823 824 825 826 827 828 829
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.
830 831 832 833 834 835 836

If SYMBOL has a local binding, then this form affects the local
binding.  This is usually not what you want.  Thus, if you need to
load a file defining variables, with this form or with `defconst' or
`defcustom', you should always load that file _outside_ any bindings
for these variables.  \(`defconst' and `defcustom' behave similarly in
this respect.)
837
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
838
     (args)
Jim Blandy's avatar
Jim Blandy committed
839 840
     Lisp_Object args;
{
841
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
842 843

  sym = Fcar (args);
844 845
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
846
    error ("Too many arguments");
847

848
  tem = Fdefault_boundp (sym);
849
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
850
    {
851 852 853 854 855 856 857 858 859 860 861 862
      if (SYMBOL_CONSTANT_P (sym))
	{
	  /* For upward compatibility, allow (defvar :foo (quote :foo)).  */
	  Lisp_Object tem = Fcar (tail);
	  if (! (CONSP (tem)
		 && EQ (XCAR (tem), Qquote)
		 && CONSP (XCDR (tem))
		 && EQ (XCAR (XCDR (tem)), sym)))
	    error ("Constant symbol `%s' specified in defvar",
		   SDATA (SYMBOL_NAME (sym)));
	}

Jim Blandy's avatar
Jim Blandy committed
863
      if (NILP (tem))
864
	Fset_default (sym, Feval (Fcar (tail)));
865 866 867
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
868
	  volatile struct specbinding *pdl = specpdl_ptr;
869 870 871 872 873 874 875 876 877 878 879
	  while (--pdl >= specpdl)
	    {
	      if (EQ (pdl->symbol, sym) && !pdl->func
		  && EQ (pdl->old_value, Qunbound))
		{
		  message_with_string ("Warning: defvar ignored because %s is let-bound",
				       SYMBOL_NAME (sym), 1);
		  break;
		}
	    }
	}
880
      tail = Fcdr (tail);
881 882
      tem = Fcar (tail);
      if (!NILP (tem))
883 884 885 886 887
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
888
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
889
    }
890
  else
891 892 893
    /* Simple (defvar <var>) should not count as a definition at all.
       It could get in the way of other definitions, and unloading this
       package could try to make the variable unbound.  */
Andreas Schwab's avatar
Andreas Schwab committed
894 895
    ;

Jim Blandy's avatar
Jim Blandy committed
896 897 898 899
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
900 901 902 903 904 905
       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.
906 907 908 909

If SYMBOL has a local binding, then this form sets the local binding's
value.  However, you should normally not make local bindings for
variables defined with this form.
910
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
911
     (args)
Jim Blandy's avatar
Jim Blandy committed
912 913 914 915 916
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
917
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
918
    error ("Too many arguments");
919

920 921 922 923
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
924
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
925
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
926
    {
Jim Blandy's avatar
Jim Blandy committed
927
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
928 929 930
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
931
  Fput (sym, Qrisky_local_variable, Qt);
932
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
933 934 935
  return sym;
}

936 937 938 939 940 941 942 943
/* Error handler used in Fuser_variable_p.  */
static Lisp_Object
user_variable_p_eh (ignore)
     Lisp_Object ignore;
{
  return Qnil;
}

944 945 946 947 948 949 950
static Lisp_Object
lisp_indirect_variable (Lisp_Object sym)
{
  XSETSYMBOL (sym, indirect_variable (XSYMBOL (sym)));
  return sym;
}

Jim Blandy's avatar
Jim Blandy committed
951
DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
952
       doc: /* Return t if VARIABLE is intended to be set and modified by users.
Pavel Janík's avatar
Pavel Janík committed
953
\(The alternative is a variable used internally in a Lisp program.)
954 955 956 957 958 959 960
A variable is a user variable if
\(1) the first character of its documentation is `*', or
\(2) it is customizable (its property list contains a non-nil value
    of `standard-value' or `custom-autoload'), or
\(3) it is an alias for another user variable.
Return nil if VARIABLE is an alias and there is a loop in the
chain of symbols.  */)
Pavel Janík's avatar
Pavel Janík committed
961
     (variable)
Jim Blandy's avatar
Jim Blandy committed
962 963 964
     Lisp_Object variable;
{
  Lisp_Object documentation;
965

966 967 968
  if (!SYMBOLP (variable))
      return Qnil;

969 970
  /* If indirect and there's an alias loop, don't check anything else.  */
  if (XSYMBOL (variable)->indirect_variable
971
      && NILP (internal_condition_case_1 (lisp_indirect_variable, variable,
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
                                          Qt, user_variable_p_eh)))
    return Qnil;

  while (1)
    {
      documentation = Fget (variable, Qvariable_documentation);
      if (INTEGERP (documentation) && XINT (documentation) < 0)
        return Qt;
      if (STRINGP (documentation)
          && ((unsigned char) SREF (documentation, 0) == '*'))
        return Qt;
      /* If it is (STRING . INTEGER), a negative integer means a user variable.  */
      if (CONSP (documentation)
          && STRINGP (XCAR (documentation))
          && INTEGERP (XCDR (documentation))
          && XINT (XCDR (documentation)) < 0)
        return Qt;
      /* Customizable?  See `custom-variable-p'.  */
      if ((!NILP (Fget (variable, intern ("standard-value"))))
          || (!NILP (Fget (variable, intern ("custom-autoload")))))
        return Qt;

      if (!XSYMBOL (variable)->indirect_variable)
        return Qnil;

      /* An indirect variable?  Let's follow the chain.  */
      variable = XSYMBOL (variable)->value;
    }
1000
}
Jim Blandy's avatar
Jim Blandy committed
1001 1002

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
1003 1004 1005 1006 1007
       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.
1008
usage: (let* VARLIST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
1009
     (args)
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
     Lisp_Object args;
{
  Lisp_Object varlist, val, elt;
Juanma Barranquero's avatar
Juanma Barranquero committed
1013
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016 1017 1018
  struct gcpro gcpro1, gcpro2, gcpro3;

  GCPRO3 (args, elt, varlist);

  varlist = Fcar (args);