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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18 19


20
#include <config.h>
21
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
22
#include "lisp.h"
23
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
24
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
25
#include "keyboard.h"
26
#include "dispextern.h"
27
#include "frame.h"		/* For XFRAME.  */
Jim Blandy's avatar
Jim Blandy committed
28

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

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

struct backtrace
37 38 39 40 41
{
  struct backtrace *next;
  Lisp_Object *function;
  Lisp_Object *args;	/* Points to vector of args. */
  int nargs;		/* Length of vector.
Jim Blandy's avatar
Jim Blandy committed
42 43
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
44 45 46 47
  char evalargs;
  /* Nonzero means call value of debugger when done with this operation. */
  char debug_on_exit;
};
Jim Blandy's avatar
Jim Blandy committed
48 49 50 51 52

struct backtrace *backtrace_list;

struct catchtag *catchlist;

53 54 55 56 57
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

58
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
59
Lisp_Object Qinhibit_quit;
Jim Blandy's avatar
Jim Blandy committed
60 61
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
62
Lisp_Object Qdeclare;
63 64
Lisp_Object Qinternal_interpreter_environment, Qclosure;

65
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
66

67 68 69
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
70

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

Lisp_Object Vautoload_queue;

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

82
EMACS_INT specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
83 84

/* Pointer to beginning of specpdl.  */
85

Jim Blandy's avatar
Jim Blandy committed
86 87 88
struct specbinding *specpdl;

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

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

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

94
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
95

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

103
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
104

105 106 107 108 109
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

110 111 112 113 114 115
/* 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;

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
132 133
}

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

151 152 153
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
154
restore_stack_limits (Lisp_Object data)
155 156 157
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
158
  return Qnil;
159 160 161 162
}

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

Jim Blandy's avatar
Jim Blandy committed
163
Lisp_Object
164
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
165
{
166
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
167
  int count = SPECPDL_INDEX ();
168
  Lisp_Object val;
169
  EMACS_INT old_max = max_specpdl_size;
170

171 172
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
173

174 175 176 177 178 179 180 181 182 183 184
  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;
185

186
#ifdef HAVE_WINDOW_SYSTEM
187 188
  if (display_hourglass_p)
    cancel_hourglass ();
189 190
#endif

Jim Blandy's avatar
Jim Blandy committed
191
  debug_on_next_call = 0;
192
  when_entered_debugger = num_nonmacro_input_events;
193 194 195 196 197

  /* 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;
198 199
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
200
  specbind (Qinhibit_redisplay, Qnil);
201
  specbind (Qdebug_on_error, Qnil);
202 203 204

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

208 209 210 211
  val = apply1 (Vdebugger, arg);

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

216
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
217 218
}

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

241
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
242

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

  UNGCPRO;
  return val;
}

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

265
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
266

267
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
268
    {
269
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
270
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
271
	break;
272
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277 278 279
    }

  UNGCPRO;
  return val;
}

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

  GCPRO1 (args);
291
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
292 293
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
294
  if (!NILP (cond))
295
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299
  return Fprogn (Fcdr (Fcdr (args)));
}

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

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

  return val;
}

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

341
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
342

343
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
344
    {
345
      val = eval_sub (XCAR (args));
346
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352 353
    }

  UNGCPRO;
  return val;
}

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

365
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369 370 371 372 373
    return Qnil;

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

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

  UNGCPRO;
  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

434
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
435 436 437 438 439 440 441
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
442
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
443
      sym = Fcar (args_left);
444

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

Jim Blandy's avatar
Jim Blandy committed
455 456
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
457
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461

  UNGCPRO;
  return val;
}
462

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

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

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

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

496

Jim Blandy's avatar
Jim Blandy 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 577
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
578 579
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
580 581 582 583
  /* btp now points at the frame of the innermost function that isn't
     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

Jim Blandy's avatar
Jim Blandy committed
588 589 590
  /* btp points to the frame of a Lisp function that called interactive-p.
     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 739 740 741 742 743 744 745

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

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

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


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

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.)
779
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
780
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
781
{
782
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
783 784

  sym = Fcar (args);
785 786
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
787
    error ("Too many arguments");
788

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

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

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

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
851 852 853 854 855 856
       doc: /* Define SYMBOL as a constant variable.
The intent is that neither programs nor users should ever change this value.
Always sets the value of SYMBOL to the result of evalling INITVALUE.
If SYMBOL is buffer-local, its default value is what is set;
 buffer-local values are not affected.
DOCSTRING is optional.
857 858 859 860

If SYMBOL has a local binding, then this form sets the local binding's
value.  However, you should normally not make local bindings for
variables defined with this form.
861
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
862
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
863 864 865 866
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
867
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
868
    error ("Too many arguments");
869

870
  tem = eval_sub (Fcar (Fcdr (args)));
871 872 873
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
874
  XSYMBOL (sym)->declared_special = 1;
Jim Blandy's avatar
Jim Blandy committed
875
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
876
  if (!NILP (tem))