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;
Jim Blandy's avatar
Jim Blandy committed
69 70
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
71
Lisp_Object Qdeclare;
72 73
Lisp_Object Qinternal_interpreter_environment, Qclosure;

74
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
75

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

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

Lisp_Object Vautoload_queue;

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

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

/* Pointer to beginning of specpdl.  */
94

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

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

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

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

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

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

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

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

Lisp_Object Vsignaling_function;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  UNGCPRO;
  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

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

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

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

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

  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

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

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

  do
    {
384
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
385
      if (!(argnum++))
386 387
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
388
    }
389
  while (CONSP (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 403 404 405 406 407 408
{
  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
409
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414 415 416 417
    return Qnil;

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

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

  UNGCPRO;
  return val;
}

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

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

  args_left = args;
  GCPRO1 (args);

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

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

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

  UNGCPRO;
  return val;
}
472

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

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

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

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

507

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

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


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

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


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

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

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

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

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

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

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

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

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

606

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
709

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

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

726
  sym = XSYMBOL (new_alias);
727 728

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

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

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

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

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

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


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

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

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

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

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

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

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

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,