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 4
		 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
		 2011  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 Qdebug;
Jim Blandy's avatar
Jim Blandy committed
66

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

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

Lisp_Object Vautoload_queue;

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

82
EMACS_INT specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
83 84

/* Pointer to beginning of specpdl.  */
85

Jim Blandy's avatar
Jim Blandy committed
86 87 88
struct specbinding *specpdl;

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

90
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
91 92

/* Maximum size allowed for specpdl allocation */
93

94
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
95 96

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

98
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
99 100

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

102
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
103 104

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

Jim Blandy's avatar
Jim Blandy committed
106 107
int debug_on_next_call;

108
/* Non-zero means debugger may continue.  This is zero when the
109 110 111 112 113
   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
114
/* List of conditions (non-nil atom means all) which cause a backtrace
115
   if an error is handled by the command loop's error handler.  */
116

Roland McGrath's avatar
Roland McGrath committed
117
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
118

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

Roland McGrath's avatar
Roland McGrath committed
122
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
123

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

Karl Heuer's avatar
Karl Heuer committed
127 128
Lisp_Object Vdebug_ignored_errors;

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

131
Lisp_Object Vdebug_on_signal;
132 133

/* Hook for edebug to use.  */
134

135 136
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
140 141
int debug_on_quit;

142
/* The value of num_nonmacro_input_events as of the last time we
143
   started to enter the debugger.  If we decide to enter the debugger
144
   again when this is still equal to num_nonmacro_input_events, then we
145 146 147
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
148

149
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
150 151 152

Lisp_Object Vdebugger;

153 154 155 156 157
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

158 159 160 161 162 163
/* 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;

164 165 166 167
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

168 169
static Lisp_Object funcall_lambda (Lisp_Object, int, Lisp_Object*);
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
Andreas Schwab's avatar
Andreas Schwab committed
170 171
static int interactive_p (int);
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, int);
172

Andreas Schwab's avatar
Andreas Schwab committed
173
void
174
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
175 176
{
  specpdl_size = 50;
177
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
178
  specpdl_ptr = specpdl;
179
  /* Don't forget to update docs (lispref node "Local Variables").  */
180
  max_specpdl_size = 1000;
181
  max_lisp_eval_depth = 600;
182 183

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
184 185
}

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

203 204 205
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
206
restore_stack_limits (Lisp_Object data)
207 208 209
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
210
  return Qnil;
211 212 213 214
}

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

Jim Blandy's avatar
Jim Blandy committed
215
Lisp_Object
216
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
217
{
218
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
219
  int count = SPECPDL_INDEX ();
220
  Lisp_Object val;
221
  EMACS_INT old_max = max_specpdl_size;
222

223 224
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
225

226 227 228 229 230 231 232 233 234 235 236
  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;
237

238
#ifdef HAVE_WINDOW_SYSTEM
239 240
  if (display_hourglass_p)
    cancel_hourglass ();
241 242
#endif

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

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

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

260 261 262 263
  val = apply1 (Vdebugger, arg);

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

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

Andreas Schwab's avatar
Andreas Schwab committed
271
void
272
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277 278 279 280 281 282 283
{
  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
284 285 286
       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
287
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
288
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
289
{
290
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
291 292
  struct gcpro gcpro1;

293
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
294

295
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
296
    {
297
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
298
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
299
	break;
300
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306 307
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
308
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
309 310
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
311
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
312
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
313
{
314
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
315 316
  struct gcpro gcpro1;

317
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
318

319
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
320
    {
321
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
322
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
323
	break;
324
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
332
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
333 334 335
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.
336
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
337
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341 342 343 344 345
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

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

Jim Blandy's avatar
Jim Blandy committed
346
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351
    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
352 353 354 355 356 357 358 359
       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.
360
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
361
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365 366 367
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
368
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
369 370 371
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
372
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
373
	{
374 375
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
376 377
	  break;
	}
378
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383 384 385
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
386
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
387
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
388
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
389
{
390
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
391 392
  struct gcpro gcpro1;

393
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
394

395
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
396
    {
397 398
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404 405
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
406
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
407 408
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
409
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
410
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415 416
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

417
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425 426
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
427
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
428 429 430 431
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
432
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
439
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
440 441 442
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
443
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449 450 451
{
  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
452
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457 458 459 460 461
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
462
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
463 464 465 466
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
467
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
474 475 476 477 478 479 480
       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
481
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
482
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
483 484 485 486 487
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

488
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494 495 496 497 498 499 500
    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
501
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505

  UNGCPRO;
  return val;
}
506

Jim Blandy's avatar
Jim Blandy committed
507
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
508 509
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
510
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
511
{
512 513
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
514 515
  return Fcar (args);
}
516

Jim Blandy's avatar
Jim Blandy committed
517
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
518 519 520 521
       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
522
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
523
{
524 525
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
526 527 528
  return Fcar (args);
}

529

Jim Blandy's avatar
Jim Blandy committed
530
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
531
       doc: /* Return t if the containing function was run directly by user input.
532 533
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
534
and input is currently coming from the keyboard (not a keyboard macro),
535 536 537 538 539 540 541 542
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?

543 544 545 546
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
547
  (void)
Jim Blandy's avatar
Jim Blandy committed
548
{
549
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
550 551 552
}


553
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
554
       doc: /* Return t if the containing function was called by `call-interactively'.
555 556 557 558 559 560 561 562 563 564 565 566
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?
567 568 569 570 571

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
572
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
573
  (Lisp_Object kind)
574
{
575 576
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
577 578 579 580 581
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
582 583 584 585

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

Andreas Schwab's avatar
Andreas Schwab committed
586
static int
587
interactive_p (int exclude_subrs_p)
588 589 590
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
591 592

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
593 594

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

  /* If we're running an Emacs 18-style byte-compiled function, there
602 603 604
     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
605

606
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
607
     looking at several frames for special forms.  Skip past them.  */
608 609 610
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
611 612
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
613 614 615 616
  /* 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.  */
617
  fun = Findirect_function (*btp->function, Qnil);
618 619
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
620

Jim Blandy's avatar
Jim Blandy committed
621 622 623
  /* 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))
624 625
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
626 627
}

628

Jim Blandy's avatar
Jim Blandy committed
629
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
630 631 632
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
633
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
634
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638 639
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
640
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
641
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
642
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
643
    defn = Fpurecopy (defn);
644 645 646
  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
647
  Ffset (fn_name, defn);
648
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
653
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
654 655
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
656 657 658 659
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
660 661

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
662 663
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
664 665 666 667 668
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

669
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
670
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
671
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
672 673 674 675

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

Richard M. Stallman's avatar
Richard M. Stallman committed
676
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
677
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
678 679 680
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
681
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
682 683

  fn_name = Fcar (args);
684
  CHECK_SYMBOL (fn_name);
685 686 687 688 689 690
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
691 692
      doc = XCAR (tail);
      tail = XCDR (tail);
693 694
    }

695 696
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
697 698 699 700 701 702 703 704
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
705

706 707 708 709 710 711 712 713
      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));
714

Jim Blandy's avatar
Jim Blandy committed
715
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
716
    defn = Fpurecopy (defn);
717 718 719
  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
720
  Ffset (fn_name, defn);
721
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
722 723 724
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
725

726
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
727
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
728
Aliased variables always have the same value; setting one sets the other.
729
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
730 731 732 733
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.
734
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
735
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
736 737
{
  struct Lisp_Symbol *sym;
738

739 740
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
741

742
  sym = XSYMBOL (new_alias);
743 744

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
745 746
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
747 748 749 750 751 752 753 754 755

  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");
    }

756
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
757 758 759 760
     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)))
761
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
762 763 764 765 766 767 768 769 770 771 772 773 774

  {
    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");
  }

  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
775 776
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
777 778
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
779

780
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
781 782 783
}


Jim Blandy's avatar
Jim Blandy committed
784
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
785
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
786 787 788 789 790 791 792 793 794 795 796 797
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.
798 799 800 801 802 803 804

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.)
805
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
806
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
807
{
808
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
809 810

  sym = Fcar (args);
811 812
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
813
    error ("Too many arguments");
814

815
  tem = Fdefault_boundp (sym);
816
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
817
    {
818 819 820 821 822 823 824 825 826 827 828 829
      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
830
      if (NILP (tem))
831
	Fset_default (sym, Feval (Fcar (tail)));
832 833 834
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
835
	  volatile struct specbinding *pdl = specpdl_ptr;
836 837 838 839 840 841 842 843 844 845 846
	  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;
		}
	    }
	}
847
      tail = Fcdr (tail);
848 849
      tem = Fcar (tail);
      if (!NILP (tem))
850 851 852 853 854
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
855
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
856
    }
857
  else
858 859 860
    /* 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
861 862
    ;

Jim Blandy's avatar
Jim Blandy committed
863 864 865 866
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
867 868 869 870 871 872
       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.
873 874 875 876

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.
877
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
878
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
879 880 881 882
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
883
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
884
    error ("Too many arguments");
885

886 887 888 889
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
890
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
891
  if (!NILP (tem))