eval.c 111 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 <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
22
#include "lisp.h"
23
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
24
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "keyboard.h"
26
#include "dispextern.h"
27
#include "frame.h"		/* For XFRAME.  */
Jim Blandy's avatar
Jim Blandy committed
28

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

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

struct backtrace
37 38 39
{
  struct backtrace *next;
  Lisp_Object *function;
40
  Lisp_Object *args;	/* Points to vector of args.  */
41 42 43 44 45 46 47 48 49
#define NARGS_BITS (BITS_PER_INT - 2)
  /* Let's not use size_t because we want to allow negative values (for
     UNEVALLED).  Also let's steal 2 bits so we save a word (or more for
     alignment).  In any case I doubt Emacs would survive a function call with
     more than 500M arguments.  */
  int nargs : NARGS_BITS; /* Length of vector.
			     If nargs is UNEVALLED, args points
			     to slot holding list of unevalled args.  */
  char evalargs : 1;
50
  /* Nonzero means call value of debugger when done with this operation.  */
51
  char debug_on_exit : 1;
52
};
Jim Blandy's avatar
Jim Blandy committed
53 54 55 56

struct backtrace *backtrace_list;
struct catchtag *catchlist;

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

62
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
63
Lisp_Object Qinhibit_quit;
Jim Blandy's avatar
Jim Blandy committed
64 65
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
66
Lisp_Object Qdeclare;
67 68
Lisp_Object Qinternal_interpreter_environment, Qclosure;

69
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
70

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

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

Lisp_Object Vautoload_queue;

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

86
EMACS_INT specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
87 88

/* Pointer to beginning of specpdl.  */
89

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

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

94
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
95 96

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

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

100
/* The value of num_nonmacro_input_events as of the last time we
101
   started to enter the debugger.  If we decide to enter the debugger
102
   again when this is still equal to num_nonmacro_input_events, then we
103 104 105
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
106

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

109 110 111 112 113
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

114 115 116 117 118 119
/* 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;

120
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
Stefan Monnier's avatar
Stefan Monnier committed
121
static Lisp_Object funcall_lambda (Lisp_Object, size_t, Lisp_Object *);
122
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
Andreas Schwab's avatar
Andreas Schwab committed
123
static int interactive_p (int);
124

Andreas Schwab's avatar
Andreas Schwab committed
125
void
126
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
127 128
{
  specpdl_size = 50;
129
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
130
  specpdl_ptr = specpdl;
131
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
132
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
133
  max_lisp_eval_depth = 600;
134 135

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
136 137
}

Andreas Schwab's avatar
Andreas Schwab committed
138
void
139
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143 144 145 146 147
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
148
#ifdef DEBUG_GCPRO
149
  gcpro_level = 0;
150
#endif
151
  /* This is less than the initial value of num_nonmacro_input_events.  */
152
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
153 154
}

155
/* Unwind-protect function used by call_debugger.  */
156 157

static Lisp_Object
158
restore_stack_limits (Lisp_Object data)
159 160 161
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
162
  return Qnil;
163 164 165 166
}

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

167
static Lisp_Object
168
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
169
{
170
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
171
  int count = SPECPDL_INDEX ();
172
  Lisp_Object val;
173
  EMACS_INT old_max = max_specpdl_size;
174

175 176
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
177

178 179 180 181 182 183 184 185 186 187 188
  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;
189

190
#ifdef HAVE_WINDOW_SYSTEM
191 192
  if (display_hourglass_p)
    cancel_hourglass ();
193 194
#endif

Jim Blandy's avatar
Jim Blandy committed
195
  debug_on_next_call = 0;
196
  when_entered_debugger = num_nonmacro_input_events;
197 198 199 200 201

  /* 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;
202 203
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
204
  specbind (Qinhibit_redisplay, Qnil);
205
  specbind (Qdebug_on_error, Qnil);
206 207 208

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

212 213 214 215
  val = apply1 (Vdebugger, arg);

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

220
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
221 222
}

223
static void
224
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
225 226 227 228 229 230 231 232 233 234 235
{
  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
236 237 238
       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
239
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
240
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
241
{
242
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
243 244
  struct gcpro gcpro1;

245
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
246

247
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
248
    {
249
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
250
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
251
	break;
252
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258 259
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
260
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
261 262
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
263
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
264
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
265
{
266
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
267 268
  struct gcpro gcpro1;

269
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
270

271
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
272
    {
273
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
274
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
275
	break;
276
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280 281 282 283
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
284
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
285 286 287
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.
288
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
289
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
290 291 292 293 294
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
295
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
296 297
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
298
  if (!NILP (cond))
299
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
304 305 306 307 308 309 310 311
       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.
312
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
313
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
314 315 316 317 318 319
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
320
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
321 322
    {
      clause = Fcar (args);
323
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
324
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
325
	{
326 327
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
328 329
	  break;
	}
330
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
338
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
339
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
340
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
341
{
342
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
343 344
  struct gcpro gcpro1;

345
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
346

347
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
348
    {
349
      val = eval_sub (XCAR (args));
350
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
351 352 353 354 355 356 357
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
358
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
359 360
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
361
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
362
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
363 364 365 366 367 368
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

369
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
370 371 372 373 374 375 376 377
    return Qnil;

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

  do
    {
378
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
379
      if (!(argnum++))
380 381
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
382
    }
383
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388 389

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
390
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
391 392 393
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
394
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399 400 401 402
{
  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
403
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
404 405 406 407 408 409 410 411
    return Qnil;

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

  do
    {
412
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
413
      if (!(argnum++))
414 415
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
416
    }
417
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
424 425 426 427 428 429 430
       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
431
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
432
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
433 434
{
  register Lisp_Object args_left;
435
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
436 437
  struct gcpro gcpro1;

438
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442 443 444 445
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
446
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
447
      sym = Fcar (args_left);
448

449
      /* Like for eval_sub, we do not check declared_special here since
450 451
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
452
	  && SYMBOLP (sym)
453 454
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
455 456 457 458
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
459 460
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
461
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
462 463 464 465

  UNGCPRO;
  return val;
}
466

Jim Blandy's avatar
Jim Blandy committed
467
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
468 469
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
470
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
471
{
472 473
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
474 475
  return Fcar (args);
}
476

Jim Blandy's avatar
Jim Blandy committed
477
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
478 479 480 481
       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
482
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
483
{
484 485
  Lisp_Object quoted = XCAR (args);

486 487
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
488 489 490 491 492 493

  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.  */
494 495
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
496 497 498
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
499 500
}

501

Jim Blandy's avatar
Jim Blandy committed
502
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
503
       doc: /* Return t if the containing function was run directly by user input.
504 505
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
506
and input is currently coming from the keyboard (not a keyboard macro),
507 508 509 510 511 512 513 514
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?

515 516 517 518
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
519
  (void)
Jim Blandy's avatar
Jim Blandy committed
520
{
521
  return interactive_p (1) ? Qt : Qnil;
522 523 524
}


525
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
526
       doc: /* Return t if the containing function was called by `call-interactively'.
527 528 529 530 531 532 533 534 535 536 537 538
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?
539 540 541 542 543

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
544
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
545
  (Lisp_Object kind)
546
{
547 548
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
549 550 551 552 553
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
554 555 556 557

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

Andreas Schwab's avatar
Andreas Schwab committed
558
static int
559
interactive_p (int exclude_subrs_p)
560 561 562
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
563 564

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
565 566

  /* If this isn't a byte-compiled function, there may be a frame at
567
     the top for Finteractive_p.  If so, skip it.  */
568
  fun = Findirect_function (*btp->function, Qnil);
569 570
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
571
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
572 573

  /* If we're running an Emacs 18-style byte-compiled function, there
574 575 576
     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
577

578
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
579
     looking at several frames for special forms.  Skip past them.  */
580 581 582
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
583 584
    btp = btp->next;

585
  /* `btp' now points at the frame of the innermost function that isn't
Jim Blandy's avatar
Jim Blandy committed
586 587 588
     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.  */
589
  fun = Findirect_function (*btp->function, Qnil);
590 591
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
592

593
  /* `btp' points to the frame of a Lisp function that called interactive-p.
Jim Blandy's avatar
Jim Blandy committed
594 595
     Return t if that function was called interactively.  */
  if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
596 597
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
598 599
}

600

Jim Blandy's avatar
Jim Blandy committed
601
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
602 603 604
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
605
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
606
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
612
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
613
  defn = Fcons (Qlambda, Fcdr (args));
614 615
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
Jim Blandy's avatar
Jim Blandy committed
616
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
617
    defn = Fpurecopy (defn);
618 619 620
  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
621
  Ffset (fn_name, defn);
622
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
623 624 625 626
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
627
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
628 629
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
630 631 632 633
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
634 635

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
636 637
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
638 639 640 641 642
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

643
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
644
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
645
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
646 647 648 649

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

Richard M. Stallman's avatar
Richard M. Stallman committed
650
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
651
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
652 653 654
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
655
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
656 657

  fn_name = Fcar (args);
658
  CHECK_SYMBOL (fn_name);
659 660 661 662 663 664
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
665 666
      doc = XCAR (tail);
      tail = XCDR (tail);
667 668
    }

669 670
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
671 672 673 674 675 676 677 678
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
679

680 681 682 683 684 685 686
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
687 688
  
  defn = Fcons (Qlambda, tail);
689 690
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
691
  defn = Fcons (Qmacro, defn);
692

Jim Blandy's avatar
Jim Blandy committed
693
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
694
    defn = Fpurecopy (defn);
695 696 697
  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
698
  Ffset (fn_name, defn);
699
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
700 701 702
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
703

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

717 718
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
719

720
  sym = XSYMBOL (new_alias);
721 722

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
723 724
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
725 726 727 728 729 730 731 732 733

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

734
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
735 736 737 738
     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)))
739
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
740 741 742 743 744 745 746 747 748 749 750

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

751
  sym->declared_special = 1;
752 753
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
754 755
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
756 757
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
758

759
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
760 761 762
}


Jim Blandy's avatar
Jim Blandy committed
763
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
764
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
765 766 767 768 769 770 771 772 773 774 775 776
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.
777 778 779 780 781 782 783

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.)
784
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
785
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
786
{
787
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
788 789

  sym = Fcar (args);
790 791
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
792
    error ("Too many arguments");
793

794
  tem = Fdefault_boundp (sym);
795
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
796
    {
797 798
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
799

800 801 802
      if (SYMBOL_CONSTANT_P (sym))
	{
	  /* For upward compatibility, allow (defvar :foo (quote :foo)).  */
803 804 805 806 807
	  Lisp_Object tem1 = Fcar (tail);
	  if (! (CONSP (tem1)
		 && EQ (XCAR (tem1), Qquote)
		 && CONSP (XCDR (tem1))
		 && EQ (XCAR (XCDR (tem1)), sym)))
808 809 810 811
	    error ("Constant symbol `%s' specified in defvar",
		   SDATA (SYMBOL_NAME (sym)));
	}

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

Jim Blandy's avatar
Jim Blandy committed
853 854 855 856
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
857 858 859 860 861 862
       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.
863 864 865 866

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.
867
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
868
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed