eval.c 109 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985-1987, 1993-1995, 1999-2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18 19


20
#include <config.h>
21
#include <limits.h>
22
#include <setjmp.h>
23
#include <stdio.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
struct backtrace
36 37 38
{
  struct backtrace *next;
  Lisp_Object *function;
39
  Lisp_Object *args;	/* Points to vector of args.  */
40
  ptrdiff_t nargs;	/* Length of vector.  */
41
  /* Nonzero means call value of debugger when done with this operation.  */
42
  unsigned int debug_on_exit : 1;
43
};
Jim Blandy's avatar
Jim Blandy committed
44

45
static struct backtrace *backtrace_list;
46 47 48 49

#if !BYTE_MARK_STACK
static
#endif
Jim Blandy's avatar
Jim Blandy committed
50 51
struct catchtag *catchlist;

52 53 54 55 56 57 58 59 60 61 62
/* Chain of condition handlers currently in effect.
   The elements of this chain are contained in the stack frames
   of Fcondition_case and internal_condition_case.
   When an error is signaled (by calling Fsignal, below),
   this chain is searched for an element that applies.  */

#if !BYTE_MARK_STACK
static
#endif
struct handler *handlerlist;

63 64 65 66 67
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

68
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
69
Lisp_Object Qinhibit_quit;
70 71 72 73
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
static Lisp_Object Qdebug_on_error;
static Lisp_Object Qdeclare;
74 75
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Paul Eggert's avatar
Paul Eggert committed
76
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
77

78 79 80
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
81

Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86
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:
87
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
88 89 90 91

Lisp_Object Vautoload_queue;

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

93
EMACS_INT specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
94 95

/* Pointer to beginning of specpdl.  */
96

Jim Blandy's avatar
Jim Blandy committed
97 98 99
struct specbinding *specpdl;

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

101
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
102 103

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

105
static EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
106

107
/* The value of num_nonmacro_input_events as of the last time we
108
   started to enter the debugger.  If we decide to enter the debugger
109
   again when this is still equal to num_nonmacro_input_events, then we
110 111 112
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
113

114
static int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
115

116 117 118 119 120
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

121 122 123 124 125 126
/* 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;

127
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
128
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
Andreas Schwab's avatar
Andreas Schwab committed
129
static int interactive_p (int);
130
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
131
static Lisp_Object Ffetch_bytecode (Lisp_Object);
132

Andreas Schwab's avatar
Andreas Schwab committed
133
void
134
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
135
{
136 137 138
  enum { size = 50 };
  specpdl = (struct specbinding *) xmalloc (size * sizeof (struct specbinding));
  specpdl_size = size;
139
  specpdl_ptr = specpdl;
140
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
141
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
142
  max_lisp_eval_depth = 600;
143 144

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
145 146
}

Andreas Schwab's avatar
Andreas Schwab committed
147
void
148
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
149 150 151 152 153 154 155 156
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
157
#ifdef DEBUG_GCPRO
158
  gcpro_level = 0;
159
#endif
160
  /* This is less than the initial value of num_nonmacro_input_events.  */
161
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
162 163
}

164
/* Unwind-protect function used by call_debugger.  */
165 166

static Lisp_Object
167
restore_stack_limits (Lisp_Object data)
168 169 170
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
171
  return Qnil;
172 173 174 175
}

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

176
static Lisp_Object
177
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
178
{
179
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
180
  int count = SPECPDL_INDEX ();
181
  Lisp_Object val;
182
  EMACS_INT old_max = max_specpdl_size;
183

184 185
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
186

187 188 189 190 191 192 193 194 195
  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;

196
  if (max_specpdl_size - 100 < SPECPDL_INDEX ())
197
    max_specpdl_size = SPECPDL_INDEX () + 100;
198

199
#ifdef HAVE_WINDOW_SYSTEM
200 201
  if (display_hourglass_p)
    cancel_hourglass ();
202 203
#endif

Jim Blandy's avatar
Jim Blandy committed
204
  debug_on_next_call = 0;
205
  when_entered_debugger = num_nonmacro_input_events;
206 207 208 209 210

  /* 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;
211 212
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
213
  specbind (Qinhibit_redisplay, Qnil);
214
  specbind (Qdebug_on_error, Qnil);
215 216 217

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

221 222 223 224
  val = apply1 (Vdebugger, arg);

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

229
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
230 231
}

232
static void
233
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238 239 240 241 242 243 244
{
  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
245 246 247
       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
248
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
249
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
250
{
251
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
252 253
  struct gcpro gcpro1;

254
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
255

256
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
257
    {
258
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
259
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
260
	break;
261
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
262 263 264 265 266 267 268
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
269
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
270 271
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
272
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
273
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
274
{
275
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
276 277
  struct gcpro gcpro1;

278
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
279

280
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
281
    {
282
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
283
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
284
	break;
285
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289 290 291 292
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
293
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
294 295 296
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.
297
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
298
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302 303
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
304
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
305 306
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
307
  if (!NILP (cond))
308
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
313 314 315 316 317 318 319 320
       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.
321
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
322
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326 327 328
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
329
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
330 331
    {
      clause = Fcar (args);
332
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
333
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
334
	{
335 336
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
337 338
	  break;
	}
339
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344 345
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
346
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
347
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
348
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
349
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
350
{
351
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
352 353
  struct gcpro gcpro1;

354
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
355

356
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
357
    {
358
      val = eval_sub (XCAR (args));
359
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364 365 366
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
367
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
368 369
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
370
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
371
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

378
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383 384 385 386
    return Qnil;

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

  do
    {
387
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
388
      if (!(argnum++))
389 390
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
391
    }
392
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
399
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
400 401 402
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
403
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
404 405 406 407 408 409 410 411
{
  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
412
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417 418 419 420
    return Qnil;

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

  do
    {
421
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
422
      if (!(argnum++))
423 424
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
425
    }
426
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
433 434 435 436 437 438 439
       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
440
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
441
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
442 443
{
  register Lisp_Object args_left;
444
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
445 446
  struct gcpro gcpro1;

447
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453 454
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
455
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
456
      sym = Fcar (args_left);
457

458
      /* Like for eval_sub, we do not check declared_special here since
459 460
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
461
	  && SYMBOLP (sym)
462 463
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
464 465 466 467
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
468 469
      args_left = Fcdr (Fcdr (args_left));
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
470
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
471 472 473 474

  UNGCPRO;
  return val;
}
475

Jim Blandy's avatar
Jim Blandy committed
476
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
477 478
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
479
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
480
{
481 482
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
483 484
  return Fcar (args);
}
485

Jim Blandy's avatar
Jim Blandy committed
486
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
487 488 489 490
       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
491
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
492
{
493 494
  Lisp_Object quoted = XCAR (args);

495 496
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
497 498 499 500 501 502

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

510

Paul Eggert's avatar
Paul Eggert committed
511
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
512
       doc: /* Return t if the containing function was run directly by user input.
513 514
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
515
and input is currently coming from the keyboard (not a keyboard macro),
516 517 518 519 520 521 522 523
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?

524 525 526 527
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
528
  (void)
Jim Blandy's avatar
Jim Blandy committed
529
{
530
  return interactive_p (1) ? Qt : Qnil;
531 532 533
}


534
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
535
       doc: /* Return t if the containing function was called by `call-interactively'.
536 537 538 539 540 541 542 543 544 545 546 547
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?
548 549 550 551 552

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
553
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
554
  (Lisp_Object kind)
555
{
556 557
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
558 559 560 561 562
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
563 564 565 566

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

Andreas Schwab's avatar
Andreas Schwab committed
567
static int
568
interactive_p (int exclude_subrs_p)
569 570 571
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
572 573

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
574 575

  /* If this isn't a byte-compiled function, there may be a frame at
576
     the top for Finteractive_p.  If so, skip it.  */
577
  fun = Findirect_function (*btp->function, Qnil);
578 579
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
580
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
581 582

  /* If we're running an Emacs 18-style byte-compiled function, there
583 584 585
     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
586

587
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
588
     looking at several frames for special forms.  Skip past them.  */
589 590
  while (btp
	 && (EQ (*btp->function, Qbytecode)
591
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
592 593
    btp = btp->next;

594
  /* `btp' now points at the frame of the innermost function that isn't
Jim Blandy's avatar
Jim Blandy committed
595 596 597
     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.  */
598
  fun = Findirect_function (*btp->function, Qnil);
599 600
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
601

602
  /* `btp' points to the frame of a Lisp function that called interactive-p.
Jim Blandy's avatar
Jim Blandy committed
603 604
     Return t if that function was called interactively.  */
  if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
605 606
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
607 608
}

609

Jim Blandy's avatar
Jim Blandy committed
610
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
611 612 613
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
614
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
615
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
616 617 618 619 620
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
621
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
622
  defn = Fcons (Qlambda, Fcdr (args));
623 624
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
Jim Blandy's avatar
Jim Blandy committed
625
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
626
    defn = Fpurecopy (defn);
627 628 629
  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
630
  Ffset (fn_name, defn);
631
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
632 633 634 635
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
636
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
637 638
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
639 640 641 642
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
643 644

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
645 646
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
647 648 649 650 651
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

652
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
653
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
654
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
655 656 657 658

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

Richard M. Stallman's avatar
Richard M. Stallman committed
659
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
660
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
661 662 663
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
664
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
665 666

  fn_name = Fcar (args);
667
  CHECK_SYMBOL (fn_name);
668 669 670 671 672 673
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
674 675
      doc = XCAR (tail);
      tail = XCDR (tail);
676 677
    }

678 679
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
680 681 682 683 684 685 686 687
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
688

689 690 691 692 693 694 695
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
696

697
  defn = Fcons (Qlambda, tail);
698 699
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
700
  defn = Fcons (Qmacro, defn);
701

Jim Blandy's avatar
Jim Blandy committed
702
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
703
    defn = Fpurecopy (defn);
704 705 706
  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
707
  Ffset (fn_name, defn);
708
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
709 710 711
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
712

713
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
714
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
715
Aliased variables always have the same value; setting one sets the other.
716
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
717 718 719 720
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.
721
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
722
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
723 724
{
  struct Lisp_Symbol *sym;
725

726 727
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
728

729
  sym = XSYMBOL (new_alias);
730 731

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
732 733
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
734 735 736 737 738 739 740 741 742

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

743
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
744 745 746 747
     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)))
748
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
749 750 751 752 753 754 755 756 757 758 759

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

760
  sym->declared_special = 1;
761
  XSYMBOL (base_variable)->declared_special = 1;
762 763
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
764 765
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
766 767
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
768

769
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
770 771 772
}


Jim Blandy's avatar
Jim Blandy committed
773
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
774
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
775 776 777 778 779 780 781 782 783 784 785 786
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.
787 788 789 790 791 792 793

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.)
794
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
795
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
796
{
797
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
798 799

  sym = Fcar (args);
800 801
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
802
    error ("Too many arguments");
803

804
  tem = Fdefault_boundp (sym);
805
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
806
    {
807 808
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
809

810 811 812
      if (SYMBOL_CONSTANT_P (sym))
	{
	  /* For upward compatibility, allow (defvar :foo (quote :foo)).  */
813 814 815 816 817
	  Lisp_Object tem1 = Fcar (tail);
	  if (! (CONSP (tem1)
		 && EQ (XCAR (tem1), Qquote)
		 && CONSP (XCDR (tem1))
		 && EQ (XCAR (XCDR (tem1)), sym)))
818 819 820 821
	    error ("Constant symbol `%s' specified in defvar",
		   SDATA (SYMBOL_NAME (sym)));
	}

Jim Blandy's avatar
Jim Blandy committed
822
      if (NILP (tem))
823
	Fset_default (sym, eval_sub (Fcar (tail)));
824 825 826
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
827
	  volatile struct specbinding *pdl = specpdl_ptr;
828 829 830 831 832 833 834 835 836 837 838
	  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;
		}
	    }
	}
839
      tail = Fcdr (tail);
840 841
      tem = Fcar (tail);
      if (!NILP (tem))
842 843 844 845 846
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
847
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
848
    }
849 850 851 852 853 854 855
  else if (!NILP (Vinternal_interpreter_environment)
	   && !XSYMBOL (sym)->declared_special)
    /* A simple (defvar foo) with lexical scoping does "nothing" except
       declare that var to be dynamically scoped *locally* (i.e. within
       the current file or let-block).  */
    Vinternal_interpreter_environment =
      Fcons (sym, Vinternal_interpreter_environment);
856
  else