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

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

34 35 36 37
#ifndef SIZE_MAX
# define SIZE_MAX ((size_t) -1)
#endif

38 39
/* 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
40 41

struct backtrace
42 43 44
{
  struct backtrace *next;
  Lisp_Object *function;
45
  Lisp_Object *args;	/* Points to vector of args.  */
46 47 48 49 50 51 52 53 54
#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;
55
  /* Nonzero means call value of debugger when done with this operation.  */
56
  char debug_on_exit : 1;
57
};
Jim Blandy's avatar
Jim Blandy committed
58 59 60 61

struct backtrace *backtrace_list;
struct catchtag *catchlist;

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

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

75
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
76

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

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

Lisp_Object Vautoload_queue;

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

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

/* Pointer to beginning of specpdl.  */
95

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

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

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

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

104
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
105

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

113
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
114

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

Lisp_Object Vsignaling_function;

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

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
143 144
}

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

162
/* Unwind-protect function used by call_debugger.  */
163 164

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

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

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

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

185 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;

  if (SPECPDL_INDEX () + 100 > max_specpdl_size)
    max_specpdl_size = SPECPDL_INDEX () + 100;
196

197
#ifdef HAVE_WINDOW_SYSTEM
198 199
  if (display_hourglass_p)
    cancel_hourglass ();
200 201
#endif

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

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

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

219 220 221 222
  val = apply1 (Vdebugger, arg);

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

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

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

252
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
253

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

  UNGCPRO;
  return val;
}

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

276
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
277

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

  UNGCPRO;
  return val;
}

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

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

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

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

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

  return val;
}

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

352
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
353

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

  UNGCPRO;
  return val;
}

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

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

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

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

  UNGCPRO;
  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

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

  args_left = args;
  GCPRO1 (args);

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

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

Jim Blandy's avatar
Jim Blandy committed
466 467
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
468
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472

  UNGCPRO;
  return val;
}
473

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

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

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

  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.  */
501 502
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
503 504 505
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
506 507
}

508

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

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


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

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


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

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

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

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
572 573

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

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

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

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

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

607

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

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

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

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

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

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

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

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

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

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

687 688 689 690 691 692 693
      tail = Fcdr (tail);
    }

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
710

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

724 725
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
726

727
  sym = XSYMBOL (new_alias);
728 729

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

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

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

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

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

766
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
767 768 769
}


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

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

  sym = Fcar (args);
797 798
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
799
    error ("Too many arguments");
800

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

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

Jim Blandy's avatar
Jim Blandy committed
819
      if (NILP (tem))
820
	Fset_default (sym, eval_sub (Fcar (tail)));
821 822 823
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
824
	  volatile struct specbinding *pdl = specpdl_ptr;
825 826 827 828 829 830 831 832 833 834 835
	  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;
		}
	    }
	}
836
      tail = Fcdr (tail);
837 838
      tem = Fcar (tail);
      if (!NILP (tem))
839 840 841 842 843
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
844
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
845
    }
846 847 848 849 850 851 852
  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);
853
  else
854 855 856 857 858
    {
      /* Simple (defvar <var>) should not count as a definition at all.
	 It could get in the way of other definitions, and unloading this
	 package could try to make the variable unbound.  */
    }
Andreas Schwab's avatar
Andreas Schwab committed
859

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

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed