eval.c 116 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,
Andreas Schwab's avatar
Andreas Schwab committed
3 4
		 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
		 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>
23
#include <setjmp.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"
29
#include "frame.h"		/* For XFRAME.  */
Jim Blandy's avatar
Jim Blandy committed
30

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

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

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

struct backtrace *backtrace_list;

struct catchtag *catchlist;

55 56 57 58 59
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

60
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
61
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
62 63
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
64
Lisp_Object Qdeclare;
65
Lisp_Object Qcurry;
66 67
Lisp_Object Qinternal_interpreter_environment, Qclosure;

68
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
69

70 71 72
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
73

Jim Blandy's avatar
Jim Blandy committed
74 75 76 77 78
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:
79
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
80 81 82

Lisp_Object Vautoload_queue;

83
/* When lexical binding is being used, this is non-nil, and contains an
84
   alist of lexically-bound variable, or (t), indicating an empty
85
   environment.  The lisp name of this variable is
86 87 88 89
   `internal-interpreter-environment'.  Every element of this list
   can be either a cons (VAR . VAL) specifying a lexical binding,
   or a single symbol VAR indicating that this variable should use
   dynamic scoping.  */
90 91 92

Lisp_Object Vinternal_interpreter_environment;

Jim Blandy's avatar
Jim Blandy committed
93
/* Current number of specbindings allocated in specpdl.  */
94

95
EMACS_INT specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
96 97

/* Pointer to beginning of specpdl.  */
98

Jim Blandy's avatar
Jim Blandy committed
99 100 101
struct specbinding *specpdl;

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

103
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
104 105

/* Maximum size allowed for specpdl allocation */
106

107
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
108 109

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

111
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
112 113

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

115
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
116 117

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

Jim Blandy's avatar
Jim Blandy committed
119 120
int debug_on_next_call;

121
/* Non-zero means debugger may continue.  This is zero when the
122 123 124 125 126
   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
127
/* List of conditions (non-nil atom means all) which cause a backtrace
128
   if an error is handled by the command loop's error handler.  */
129

Roland McGrath's avatar
Roland McGrath committed
130
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
131

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

Roland McGrath's avatar
Roland McGrath committed
135
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
136

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

Karl Heuer's avatar
Karl Heuer committed
140 141
Lisp_Object Vdebug_ignored_errors;

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

144
Lisp_Object Vdebug_on_signal;
145 146

/* Hook for edebug to use.  */
147

148 149
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
153 154
int debug_on_quit;

155
/* The value of num_nonmacro_input_events as of the last time we
156
   started to enter the debugger.  If we decide to enter the debugger
157
   again when this is still equal to num_nonmacro_input_events, then we
158 159 160
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
161

162
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
163 164 165

Lisp_Object Vdebugger;

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

Lisp_Object Vsignaling_function;

171 172 173 174 175 176
/* 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;

177 178 179 180
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

181
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args,
Stefan Monnier's avatar
Stefan Monnier committed
182
				 Lisp_Object lexenv);
Stefan Monnier's avatar
Stefan Monnier committed
183 184
static Lisp_Object funcall_lambda (Lisp_Object, int, Lisp_Object *,
				   Lisp_Object);
185
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
186

Andreas Schwab's avatar
Andreas Schwab committed
187
void
188
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
189 190
{
  specpdl_size = 50;
191
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
192
  specpdl_ptr = specpdl;
193
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
194
  max_specpdl_size = 1200; /* 1000 is not enough for CEDET's c-by.el.  */
195
  max_lisp_eval_depth = 600;
196 197

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
198 199
}

Andreas Schwab's avatar
Andreas Schwab committed
200
void
201
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
202 203 204 205 206 207 208 209
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
210
#ifdef DEBUG_GCPRO
211
  gcpro_level = 0;
212
#endif
213
  /* This is less than the initial value of num_nonmacro_input_events.  */
214
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
215 216
}

217 218 219
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
220
restore_stack_limits (Lisp_Object data)
221 222 223
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
224
  return Qnil;
225 226 227 228
}

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

Jim Blandy's avatar
Jim Blandy committed
229
Lisp_Object
230
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
231
{
232
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
233
  int count = SPECPDL_INDEX ();
234
  Lisp_Object val;
235
  EMACS_INT old_max = max_specpdl_size;
236

237 238
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
239

240 241 242 243 244 245 246 247 248 249 250
  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;
251

252
#ifdef HAVE_WINDOW_SYSTEM
253 254
  if (display_hourglass_p)
    cancel_hourglass ();
255 256
#endif

Jim Blandy's avatar
Jim Blandy committed
257
  debug_on_next_call = 0;
258
  when_entered_debugger = num_nonmacro_input_events;
259 260 261 262 263

  /* 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;
264 265
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
266
  specbind (Qinhibit_redisplay, Qnil);
267
  specbind (Qdebug_on_error, Qnil);
268 269 270

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

274 275 276 277
  val = apply1 (Vdebugger, arg);

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

282
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
283 284
}

Andreas Schwab's avatar
Andreas Schwab committed
285
void
286
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
287 288 289 290 291 292 293 294 295 296 297
{
  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
298 299 300
       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
301
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
303
{
304
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
305 306
  struct gcpro gcpro1;

307
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
308

309
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
310
    {
311
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
312
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
313
	break;
314
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
322
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
323 324
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
325
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
326
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
327
{
328
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
329 330
  struct gcpro gcpro1;

331
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
332

333
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
334
    {
335
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
336
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
337
	break;
338
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
346
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
347 348 349
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.
350
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
351
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355 356 357 358 359
{
  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...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
375
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
376 377 378 379 380 381
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

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

  return val;
}

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

407
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
408

409
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
410
    {
411 412
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417 418 419
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
420
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
421 422
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
423
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
424
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
425 426 427 428 429 430
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

431
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435 436 437 438 439 440
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
441
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
446
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
453
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
454 455 456
The value of FORM2 is saved during the evaluation of the
remaining args, whose values are discarded.
usage: (prog2 FORM1 FORM2 BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
457
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464 465
{
  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
466
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
467 468 469 470 471 472 473 474 475
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
476
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
481
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485 486 487

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
488 489 490 491 492 493 494
       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
495
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
496
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
497 498
{
  register Lisp_Object args_left;
499
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
500 501
  struct gcpro gcpro1;

502
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506 507 508 509 510 511
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
      val = Feval (Fcar (Fcdr (args_left)));
      sym = Fcar (args_left);
512

513 514 515
      /* Like for Feval, we do not check declared_special here since
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
516
	  && SYMBOLP (sym)
517 518
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
519 520 521 522
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
523 524
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
525
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529

  UNGCPRO;
  return val;
}
530

Jim Blandy's avatar
Jim Blandy committed
531
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
532 533
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
534
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
535
{
536 537
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
538 539
  return Fcar (args);
}
540

Jim Blandy's avatar
Jim Blandy committed
541
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
542 543 544 545
       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)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
546
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
547
{
548 549
  Lisp_Object quoted = XCAR (args);

550 551
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
552 553 554 555 556 557 558 559 560 561

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
    /* This is a lambda expression within a lexical environment;
       return an interpreted closure instead of a simple lambda.  */
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment, quoted));
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
562 563
}

564

Jim Blandy's avatar
Jim Blandy committed
565
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
566
       doc: /* Return t if the containing function was run directly by user input.
567 568
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
569
and input is currently coming from the keyboard (not a keyboard macro),
570 571 572 573 574 575 576 577
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?

578 579 580 581
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'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
582
  (void)
Jim Blandy's avatar
Jim Blandy committed
583
{
584
  return interactive_p (1) ? Qt : Qnil;
585 586 587
}


588
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
589
       doc: /* Return t if the containing function was called by `call-interactively'.
590 591 592 593 594 595 596 597 598 599 600 601
If KIND is `interactive', then only return t if the call was made
interactively by the user, i.e. not in `noninteractive' mode nor
when `executing-kbd-macro'.
If KIND is `any', on the other hand, it will return t for any kind of
interactive call, including being called as the binding of a key, or
from a keyboard macro, or in `noninteractive' mode.

The only known proper use of `interactive' for KIND 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?
602 603 604 605 606

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
607
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
608
  (Lisp_Object kind)
609
{
610 611
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
612 613 614 615 616
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
617 618 619 620 621

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

int
622
interactive_p (int exclude_subrs_p)
623 624 625
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
626 627

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
628 629

  /* If this isn't a byte-compiled function, there may be a frame at
630
     the top for Finteractive_p.  If so, skip it.  */
631
  fun = Findirect_function (*btp->function, Qnil);
632 633
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
634
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
635 636

  /* If we're running an Emacs 18-style byte-compiled function, there
637 638 639
     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
640

641
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
642
     looking at several frames for special forms.  Skip past them.  */
643 644 645
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
646 647
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
648 649 650 651
  /* 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.  */
652
  fun = Findirect_function (*btp->function, Qnil);
653 654
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
655

Jim Blandy's avatar
Jim Blandy committed
656 657 658
  /* 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))
659 660
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
661 662
}

663

Jim Blandy's avatar
Jim Blandy committed
664
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
665 666 667
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
668
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
669
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673 674
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
675
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
676
  defn = Fcons (Qlambda, Fcdr (args));
677 678
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
Jim Blandy's avatar
Jim Blandy committed
679
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
680
    defn = Fpurecopy (defn);
681 682 683
  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
684
  Ffset (fn_name, defn);
685
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
686 687 688 689
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
690
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
691 692
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
693 694 695 696
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
697 698

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
699 700
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
701 702 703 704 705
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

706
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
707
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
708
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
709 710 711 712

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

Richard M. Stallman's avatar
Richard M. Stallman committed
713
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
714
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
715 716 717
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
718
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
719 720

  fn_name = Fcar (args);
721
  CHECK_SYMBOL (fn_name);
722 723 724 725 726 727
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
728 729
      doc = XCAR (tail);
      tail = XCDR (tail);
730 731
    }

732 733
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
734 735 736 737 738 739 740 741
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
742

743 744 745 746 747 748 749
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
750 751
  
  defn = Fcons (Qlambda, tail);
752 753
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
754
  defn = Fcons (Qmacro, defn);
755

Jim Blandy's avatar
Jim Blandy committed
756
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
757
    defn = Fpurecopy (defn);
758 759 760
  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
761
  Ffset (fn_name, defn);
762
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
763 764 765
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
766

767
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
768
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
769
Aliased variables always have the same value; setting one sets the other.
770
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
771 772 773 774
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.
775
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
776
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
777 778
{
  struct Lisp_Symbol *sym;
779

780 781
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
782

783
  sym = XSYMBOL (new_alias);
784 785

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
786 787
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
788 789 790 791 792 793 794 795 796

  switch (sym->redirect)
    {
    case SYMBOL_FORWARDED:
      error ("Cannot make an internal variable an alias");
    case SYMBOL_LOCALIZED:
      error ("Don't know how to make a localized variable an alias");
    }

797
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
798 799 800 801
     If n_a is bound, but b_v is not, set the value of b_v to n_a,
     so that old-code that affects n_a before the aliasing is setup
     still works.  */
  if (NILP (Fboundp (base_variable)))
802
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
803 804 805 806 807 808 809 810 811 812 813

  {
    struct specbinding *p;

    for (p = specpdl_ptr - 1; p >= specpdl; p--)
      if (p->func == NULL
	  && (EQ (new_alias,
		  CONSP (p->symbol) ? XCAR (p->symbol) : p->symbol)))
	error ("Don't know how to make a let-bound variable an alias");
  }

814
  sym->declared_special = 1;
815 816
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
817 818
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
819 820
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
821

822
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
823 824 825
}


Jim Blandy's avatar
Jim Blandy committed
826
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
827
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
828 829 830 831 832 833 834 835 836 837 838 839
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.
840 841 842 843 844 845 846

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.)
847
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
848
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
849
{
850
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
851 852

  sym = Fcar (args);
853 854
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
855
    error ("Too many arguments");
856

857
  tem = Fdefault_boundp (sym);
858
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
859
    {
860 861 862 863 864 865 866 867 868 869 870 871
      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
872
      if (NILP (tem))
873
	Fset_default (sym, Feval (Fcar (tail)));
874 875 876
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
877
	  volatile struct specbinding *pdl = specpdl_ptr;
878 879 880 881 882 883 884 885 886 887 888
	  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;
		}
	    }
	}
889
      tail = Fcdr (tail);
890 891
      tem = Fcar (tail);
      if (!NILP (tem))
892 893 894 895 896
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
897
      LOADHIST_ATTACH (sym);
898 899 900

      if (SYMBOLP (sym))
	XSYMBOL (sym)->declared_special = 1;
Jim Blandy's avatar
Jim Blandy committed
901
    }
902 903 904 905 906 907 908
  else if (!NILP (Vinternal_interpreter_environment)
	   && !XSYMBOL (sym)->declared_special)
    /* A simple (defvar foo) with lexical scoping does "nothing" except
       declare that var to be dynamically scoped *locally* (i.e. within
       the current file or let-block).  */
    Vinternal_interpreter_environment =
      Fcons (sym, Vinternal_interpreter_environment);
909
  else
910 911 912
    /* 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
913
    ;
914
      
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
919 920 921 922 923 924
       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.
925 926 927 928

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.
929
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
930
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
935
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
936
    error ("Too many arguments");
937

938 939 940 941
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
942
  XSYMBOL (sym)->declared_special = 1;
Jim Blandy's avatar
Jim Blandy committed
943
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
944
  if (!NILP (tem))