eval.c 106 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, 2010
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>
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;
66
extern Lisp_Object Qinteractive_form;
Jim Blandy's avatar
Jim Blandy committed
67

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

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

Lisp_Object Vautoload_queue;

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

Jim Blandy's avatar
Jim Blandy committed
83 84 85
int specpdl_size;

/* Pointer to beginning of specpdl.  */
86

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

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

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

/* Maximum size allowed for specpdl allocation */
94

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

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

Jim Blandy's avatar
Jim Blandy committed
99 100 101
int lisp_eval_depth;

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

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

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

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

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

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

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

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

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

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

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

132
Lisp_Object Vdebug_on_signal;
133 134

/* Hook for edebug to use.  */
135

136 137
Lisp_Object Vsignal_hook_function;

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

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

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

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

Lisp_Object Vdebugger;

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

Lisp_Object Vsignaling_function;

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

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

Lisp_Object Vmacro_declaration_function;

169
extern Lisp_Object Qrisky_local_variable;
170

171 172
extern Lisp_Object Qfunction;

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
187 188
}

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

206 207 208
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
209
restore_stack_limits (Lisp_Object data)
210 211 212
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
213
  return Qnil;
214 215 216 217
}

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

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

226 227
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
228

229 230 231 232 233 234 235 236 237 238 239
  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;
240

241
#ifdef HAVE_WINDOW_SYSTEM
242 243
  if (display_hourglass_p)
    cancel_hourglass ();
244 245
#endif

Jim Blandy's avatar
Jim Blandy committed
246
  debug_on_next_call = 0;
247
  when_entered_debugger = num_nonmacro_input_events;
248 249 250 251 252

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

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

263 264 265 266
  val = apply1 (Vdebugger, arg);

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

271
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
272 273
}

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

296
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
297

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

  UNGCPRO;
  return val;
}

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

320
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
321

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

  UNGCPRO;
  return val;
}

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

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

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

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

  return val;
}

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

396
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
397

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

  UNGCPRO;
  return val;
}

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

420
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434
    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
435
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440 441

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
442
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
443 444 445
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
446
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452 453 454
{
  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
455
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469
    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
470
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
471 472 473 474 475 476

  UNGCPRO;
  return val;
}

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

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

  UNGCPRO;
  return val;
}
509

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

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

532

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

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


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

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


/*  Return 1 if function in which this appears was called using
    call-interactively.
585 586 587 588 589

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

int
590
interactive_p (int exclude_subrs_p)
591 592 593
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
594 595

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
596 597

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

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

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

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

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

631

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

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

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

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

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

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

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

  fn_name = Fcar (args);
687
  CHECK_SYMBOL (fn_name);
688 689 690 691 692 693
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
694 695
      doc = XCAR (tail);
      tail = XCDR (tail);
696 697 698 699 700 701 702 703 704 705 706 707
    }

  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;
	}
708

709 710 711 712 713 714 715 716
      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));
717

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

Gerd Moellmann's avatar
Gerd Moellmann committed
728

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

742 743
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
744

745
  sym = XSYMBOL (new_alias);
746 747

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

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

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

  {
    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));
778 779
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
780 781
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
782

783
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786
}


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

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

  sym = Fcar (args);
814 815
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
816
    error ("Too many arguments");
817

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

Jim Blandy's avatar
Jim Blandy committed
866 867 868 869
  return sym;
}

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

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

  sym = Fcar (args);
886
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
887
    error ("Too many arguments");
888

889 890 891 892
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
893
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
894
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
895
    {
Jim Blandy's avatar
Jim Blandy committed
896
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
897 898 899
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
Richard M. Stallman's avatar