eval.c 104 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
                 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
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"
Jim Blandy's avatar
Jim Blandy committed
29

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

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

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

struct backtrace *backtrace_list;

struct catchtag *catchlist;

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

59
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
60
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
61 62
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
63
Lisp_Object Qdeclare;
64
Lisp_Object Qdebug;
65
extern Lisp_Object Qinteractive_form;
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

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

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

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

/* 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
extern Lisp_Object Qrisky_local_variable;
169

170 171
extern Lisp_Object Qfunction;

172
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
173
static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
174 175 176 177 178 179 180 181

#if __GNUC__
/* "gcc -O3" enables automatic function inlining, which optimizes out
   the arguments for the invocations of these functions, whereas they
   expect these values on the stack.  */
Lisp_Object apply1 () __attribute__((noinline));
Lisp_Object call2 () __attribute__((noinline));
#endif
182

Andreas Schwab's avatar
Andreas Schwab committed
183
void
Jim Blandy's avatar
Jim Blandy committed
184 185 186
init_eval_once ()
{
  specpdl_size = 50;
187
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
188
  specpdl_ptr = specpdl;
189
  /* Don't forget to update docs (lispref node "Local Variables").  */
190
  max_specpdl_size = 1000;
191
  max_lisp_eval_depth = 500;
192 193

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
194 195
}

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

213 214 215 216 217 218 219 220
/* unwind-protect function used by call_debugger.  */

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

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

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

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

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

250
#ifdef HAVE_WINDOW_SYSTEM
251 252
  if (display_hourglass_p)
    cancel_hourglass ();
253 254
#endif

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

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

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

272 273 274 275
  val = apply1 (Vdebugger, arg);

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

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

Andreas Schwab's avatar
Andreas Schwab committed
283
void
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287 288 289 290 291 292 293 294 295 296
do_debug_on_call (code)
     Lisp_Object code;
{
  debug_on_next_call = 0;
  backtrace_list->debug_on_exit = 1;
  call_debugger (Fcons (code, Qnil));
}

/* NOTE!!! Every function that can call EVAL must protect its args
   and temporaries from garbage collection while it needs them.
   The definition of `For' shows what you have to do.  */

DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
297 298 299
       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
300
usage: (or CONDITIONS...)  */)
Pavel Janík's avatar
Pavel Janík committed
301
     (args)
Jim Blandy's avatar
Jim Blandy committed
302 303
     Lisp_Object args;
{
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...)  */)
Pavel Janík's avatar
Pavel Janík committed
326
     (args)
Jim Blandy's avatar
Jim Blandy committed
327 328
     Lisp_Object args;
{
329
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
330 331
  struct gcpro gcpro1;

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

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

  UNGCPRO;
  return val;
}

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

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

Jim Blandy's avatar
Jim Blandy committed
362
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
363 364 365 366 367
    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
368 369 370 371 372 373 374 375
       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.
376
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
377
     (args)
Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382 383 384
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

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

  return val;
}

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

411
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
412

413
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
414
    {
415 416
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
417 418 419 420 421 422 423
    }

  UNGCPRO;
  return val;
}

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

436
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442 443 444 445 446 447 448 449 450
    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
451
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
452 453 454 455 456 457

  UNGCPRO;
  return val;
}

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

  val = Qnil;

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

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
494 495 496 497 498 499 500
       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
501
usage: (setq [SYM VAL]...)  */)
Pavel Janík's avatar
Pavel Janík committed
502
     (args)
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506 507 508
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

509
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514 515 516 517 518 519 520 521
    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
522
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
523 524 525 526

  UNGCPRO;
  return val;
}
527

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

Jim Blandy's avatar
Jim Blandy committed
539
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
540 541 542 543 544
       doc: /* Like `quote', but preferred for objects which are functions.
In byte compilation, `function' causes its argument to be compiled.
`quote' cannot do that.
usage: (function ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
545 546
     Lisp_Object args;
{
547 548
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
549 550 551
  return Fcar (args);
}

552

Jim Blandy's avatar
Jim Blandy committed
553
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
554
       doc: /* Return t if the containing function was run directly by user input.
555 556
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
557
and input is currently coming from the keyboard (not a keyboard macro),
558 559 560 561 562 563 564 565
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?

566 567 568 569
To test whether your function was called with `call-interactively',
either (i) add an extra optional argument and give it an `interactive'
spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
use `called-interactively-p'.  */)
Pavel Janík's avatar
Pavel Janík committed
570
     ()
Jim Blandy's avatar
Jim Blandy committed
571
{
572
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
573 574 575
}


576
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
577
       doc: /* Return t if the containing function was called by `call-interactively'.
578 579 580 581 582 583 584 585 586 587 588 589
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?
590 591 592 593 594

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
595 596 597
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
     (kind)
     Lisp_Object kind;
598
{
599 600
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
601 602 603 604 605
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
606 607 608 609 610 611 612 613 614 615

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

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

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
618 619

  /* If this isn't a byte-compiled function, there may be a frame at
620
     the top for Finteractive_p.  If so, skip it.  */
621
  fun = Findirect_function (*btp->function, Qnil);
622 623
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
624
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
625 626

  /* If we're running an Emacs 18-style byte-compiled function, there
627 628 629
     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
630

631
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
632
     looking at several frames for special forms.  Skip past them.  */
633 634 635
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
636 637
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
  /* 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.  */
642
  fun = Findirect_function (*btp->function, Qnil);
643 644
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
645

Jim Blandy's avatar
Jim Blandy committed
646 647 648
  /* 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))
649 650
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
651 652
}

653

Jim Blandy's avatar
Jim Blandy committed
654
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
655 656 657
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
658
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
659
     (args)
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663 664 665
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
666
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
667
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
668
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
669
    defn = Fpurecopy (defn);
670 671 672
  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
673
  Ffset (fn_name, defn);
674
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
679
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
680 681
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
682 683 684 685
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
686 687

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
688 689
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
690 691 692 693 694
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

695
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
696
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
697
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
698 699 700 701

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

Richard M. Stallman's avatar
Richard M. Stallman committed
702
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
703
     (args)
Jim Blandy's avatar
Jim Blandy committed
704 705 706 707
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
708
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
709 710

  fn_name = Fcar (args);
711
  CHECK_SYMBOL (fn_name);
712 713 714 715 716 717
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
718 719
      doc = XCAR (tail);
      tail = XCDR (tail);
720 721 722 723 724 725 726 727 728 729 730 731
    }

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

733 734 735 736 737 738 739 740
      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));
741

Jim Blandy's avatar
Jim Blandy committed
742
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
743
    defn = Fpurecopy (defn);
744 745 746
  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
747
  Ffset (fn_name, defn);
748
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
749 750 751
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
752

753
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
754
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
755
Aliased variables always have the same value; setting one sets the other.
756
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
757 758 759 760
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.
761 762 763
The return value is BASE-VARIABLE.  */)
     (new_alias, base_variable, docstring)
     Lisp_Object new_alias, base_variable, docstring;
Gerd Moellmann's avatar
Gerd Moellmann committed
764 765
{
  struct Lisp_Symbol *sym;
766

767 768
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
769

770
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
771 772
    error ("Cannot make a constant an alias");

773
  sym = XSYMBOL (new_alias);
774 775 776 777 778 779
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
     If n_a is bound, but b_v is not, set the value of b_v to n_a.
     This is for the sake of define-obsolete-variable-alias and user
     customizations.  */
  if (NILP (Fboundp (base_variable)) && !NILP (Fboundp (new_alias)))
    XSYMBOL(base_variable)->value = sym->value;
Gerd Moellmann's avatar
Gerd Moellmann committed
780
  sym->indirect_variable = 1;
781 782 783
  sym->value = base_variable;
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
784
  if (!NILP (docstring))
785
    Fput (new_alias, Qvariable_documentation, docstring);
786
  else
787
    Fput (new_alias, Qvariable_documentation, Qnil);
788

789
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
790 791 792
}


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

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.)
814
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
815
     (args)
Jim Blandy's avatar
Jim Blandy committed
816 817
     Lisp_Object args;
{
818
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
819 820

  sym = Fcar (args);
821 822
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
823
    error ("Too many arguments");
824

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

Jim Blandy's avatar
Jim Blandy committed
873 874 875 876
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
877 878 879 880 881 882
       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.
883 884 885 886

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.
887
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
888
     (args)
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
894
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
895
    error ("Too many arguments");
896

897 898 899 900
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
901
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
902
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
903
    {
Jim Blandy's avatar
Jim Blandy committed
904
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
905 906 907
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
908
  Fput (sym, Qrisky_local_variable, Qt);
909
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
910 911 912
  return sym;
}

913 914 915 916 917 918 919 920
/* Error handler used in Fuser_variable_p.  */
static Lisp_Object
user_variable_p_eh (ignore)
     Lisp_Object ignore;
{
  return Qnil;
}

921 922 923 924 925 926 927
static Lisp_Object
lisp_indirect_variable (Lisp_Object sym)
{
  XSETSYMBOL (sym, indirect_variable (XSYMBOL (sym)));
  return sym;
}