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

This file is part of GNU Emacs.

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

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

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


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

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

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

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

struct backtrace *backtrace_list;

struct catchtag *catchlist;

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

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

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
182 183
}

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

201 202 203
/* unwind-protect function used by call_debugger.  */

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

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

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

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

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

236
#ifdef HAVE_WINDOW_SYSTEM
237 238
  if (display_hourglass_p)
    cancel_hourglass ();
239 240
#endif

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

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

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

258 259 260 261
  val = apply1 (Vdebugger, arg);

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

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

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

291
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
292

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

  UNGCPRO;
  return val;
}

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

315
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
316

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

  UNGCPRO;
  return val;
}

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

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

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

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

  return val;
}

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

391
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
392

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

  UNGCPRO;
  return val;
}

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

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

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

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

  UNGCPRO;
  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

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

  UNGCPRO;
  return val;
}
504

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

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

527

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

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


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

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


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

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

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

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
591 592

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

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

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

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

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

626

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

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

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

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

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

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

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

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

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
689 690
      doc = XCAR (tail);
      tail = XCDR (tail);
691 692 693 694 695 696 697 698 699 700 701 702
    }

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
723

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

737 738
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
739

740
  sym = XSYMBOL (new_alias);
741 742

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

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

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

  {
    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));
773 774
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
775 776
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
777

778
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
779 780 781
}


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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
  return sym;
}

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

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

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

884 885 886 887
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
888
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
889
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
890
    {
Jim Blandy's avatar
Jim Blandy committed
891
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
892 893 894
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
895
  Fput (sym, Qrisky_local_variable, Qt);
896
  LOADHIST_ATTACH (sym);