eval.c 108 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-2012  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
ptrdiff_t 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 EMACS_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 128 129 130 131 132
/* If non-nil, Lisp code must not be run since some part of Emacs is
   in an inconsistent state.  Currently, x-create-frame uses this to
   avoid triggering window-configuration-change-hook while the new
   frame is half-initialized.  */
Lisp_Object inhibit_lisp_code;

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
151 152
}

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

170
/* Unwind-protect function used by call_debugger.  */
171 172

static Lisp_Object
173
restore_stack_limits (Lisp_Object data)
174 175 176
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
177
  return Qnil;
178 179 180 181
}

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

182
static Lisp_Object
183
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
184
{
185
  int debug_while_redisplaying;
186
  ptrdiff_t count = SPECPDL_INDEX ();
187
  Lisp_Object val;
188
  EMACS_INT old_max = max_specpdl_size;
189

190 191
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
192

193 194 195 196 197 198 199 200 201
  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;

202
  if (max_specpdl_size - 100 < SPECPDL_INDEX ())
203
    max_specpdl_size = SPECPDL_INDEX () + 100;
204

205
#ifdef HAVE_WINDOW_SYSTEM
206 207
  if (display_hourglass_p)
    cancel_hourglass ();
208 209
#endif

Jim Blandy's avatar
Jim Blandy committed
210
  debug_on_next_call = 0;
211
  when_entered_debugger = num_nonmacro_input_events;
212 213 214 215 216

  /* 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;
217 218
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
219
  specbind (Qinhibit_redisplay, Qnil);
220
  specbind (Qdebug_on_error, Qnil);
221 222 223

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

227 228 229 230
  val = apply1 (Vdebugger, arg);

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

235
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
236 237
}

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

260
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
261

262
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
263
    {
264
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
265
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
266
	break;
267
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
268 269 270 271 272 273 274
    }

  UNGCPRO;
  return val;
}

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

284
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
285

286
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
287
    {
288
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
289
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
290
	break;
291
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
292 293 294 295 296 297 298
    }

  UNGCPRO;
  return val;
}

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

  GCPRO1 (args);
310
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
311 312
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
313
  if (!NILP (cond))
314
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318
  return Fprogn (Fcdr (Fcdr (args)));
}

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

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
335
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
336 337
    {
      clause = Fcar (args);
338
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
339
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
340
	{
341 342
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
343 344
	  break;
	}
345
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351
    }
  UNGCPRO;

  return val;
}

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

360
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
361

362
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
363
    {
364
      val = eval_sub (XCAR (args));
365
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369 370 371 372
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
373
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
374 375
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
376
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
377
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382 383 384 385 386
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;

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

387 388 389
  val = eval_sub (XCAR (args_left));
  while (CONSP (args_left = XCDR (args_left)))
    eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
390 391 392 393 394 395

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
396
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
397 398 399
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
400
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
401
{
402
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
403

404 405
  GCPRO1 (args);
  eval_sub (XCAR (args));
406 407
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
408 409 410
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
411 412 413 414 415 416 417
       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
418
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
419
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
420 421
{
  register Lisp_Object args_left;
422
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
423 424
  struct gcpro gcpro1;

425
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
426 427 428 429 430 431 432
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
433
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
434
      sym = Fcar (args_left);
435

436
      /* Like for eval_sub, we do not check declared_special here since
437 438
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
439
	  && SYMBOLP (sym)
440 441
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
442 443 444 445
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
446 447
      args_left = Fcdr (Fcdr (args_left));
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
448
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
449 450 451 452

  UNGCPRO;
  return val;
}
453

Jim Blandy's avatar
Jim Blandy committed
454
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
455
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
456 457 458 459 460 461 462 463
Warning: `quote' does not construct its return value, but just returns
the value that was pre-constructed by the Lisp reader (see info node
`(elisp)Printed Representation').
This means that '(a . b) is not identical to (cons 'a 'b): the former
does not cons.  Quoting should be reserved for constants that will
never be modified by side-effects, unless you like self-modifying code.
See the common pitfall in info node `(elisp)Rearrangement' for an example
of unexpected results when a quoted object is modified.
Pavel Janík's avatar
Pavel Janík committed
464
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
465
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
466
{
467 468
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
469 470
  return Fcar (args);
}
471

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

481 482
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
483 484 485 486 487 488

  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.  */
489 490
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
491 492 493
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
494 495
}

496

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

510 511 512 513
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
514
  (void)
Jim Blandy's avatar
Jim Blandy committed
515
{
516
  return interactive_p (1) ? Qt : Qnil;
517 518 519
}


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

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


/*  Return 1 if function in which this appears was called using
    call-interactively.
549 550 551 552

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

Andreas Schwab's avatar
Andreas Schwab committed
553
static int
554
interactive_p (int exclude_subrs_p)
555 556 557
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
558 559

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
560 561

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

  /* If we're running an Emacs 18-style byte-compiled function, there
569 570 571
     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
572

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

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

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

595

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

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

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

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

638
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
639
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
640
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
641 642 643 644

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

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

  fn_name = Fcar (args);
653
  CHECK_SYMBOL (fn_name);
654 655 656 657 658 659
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
660 661
      doc = XCAR (tail);
      tail = XCDR (tail);
662 663
    }

664 665
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
666 667 668 669 670 671 672 673
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
674

675 676 677 678 679 680 681
      tail = Fcdr (tail);
    }

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

683
  defn = Fcons (Qlambda, tail);
684 685
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
686
  defn = Fcons (Qmacro, defn);
687

Jim Blandy's avatar
Jim Blandy committed
688
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
689
    defn = Fpurecopy (defn);
690 691 692
  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
693
  Ffset (fn_name, defn);
694
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
695 696 697
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
698

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

712 713
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
714

715
  sym = XSYMBOL (new_alias);
716 717

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
718 719
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
720 721 722 723 724 725 726 727 728

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

729
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
730 731 732 733
     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)))
734
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
735 736 737 738

  {
    struct specbinding *p;

Paul Eggert's avatar
Paul Eggert committed
739
    for (p = specpdl_ptr; p > specpdl; )
740
      if ((--p)->func == NULL
741 742 743 744 745
	  && (EQ (new_alias,
		  CONSP (p->symbol) ? XCAR (p->symbol) : p->symbol)))
	error ("Don't know how to make a let-bound variable an alias");
  }

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

755
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
756 757 758
}


Jim Blandy's avatar
Jim Blandy committed
759
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
760
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
761 762 763 764 765 766 767 768 769
You are not required to define a variable in order to use it, but
defining it lets you supply an initial value and documentation, which
can be referred to by the Emacs help facilities and other programming
tools.  The `defvar' form also declares the variable as \"special\",
so that it is always dynamically bound even if `lexical-binding' is t.

The optional argument 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.
Pavel Janík's avatar
Pavel Janík committed
770
If INITVALUE is missing, SYMBOL's value is not set.
771 772 773 774 775 776 777

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.)
778 779 780 781 782

The optional argument DOCSTRING is a documentation string for the
variable.

To define a user option, use `defcustom' instead of `defvar'.
783
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
784
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
785
{
786
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
787 788

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

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

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

Jim Blandy's avatar
Jim Blandy committed
811
      if (NILP (tem))
812
	Fset_default (sym, eval_sub (Fcar (tail)));
813 814 815
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
816
	  volatile struct specbinding *pdl = specpdl_ptr;
817
	  while (pdl > specpdl)
818
	    {
819
	      if (EQ ((--pdl)->symbol, sym) && !pdl->func
820 821 822 823 824 825 826 827
		  && EQ (pdl->old_value, Qunbound))
		{
		  message_with_string ("Warning: defvar ignored because %s is let-bound",
				       SYMBOL_NAME (sym), 1);
		  break;
		}
	    }
	}
828
      tail = Fcdr (tail);
829 830
      tem = Fcar (tail);
      if (!NILP (tem))
831 832 833 834 835
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
836
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
837
    }
838 839 840 841 842 843 844
  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);
845
  else