eval.c 103 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3 4
		 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
		 2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

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

struct backtrace
39 40 41 42 43
{
  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
44 45
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
46 47 48 49
  char evalargs;
  /* Nonzero means call value of debugger when done with this operation. */
  char debug_on_exit;
};
Jim Blandy's avatar
Jim Blandy committed
50 51 52 53 54

struct backtrace *backtrace_list;

struct catchtag *catchlist;

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

60
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
61
Lisp_Object Qinhibit_quit;
Jim Blandy's avatar
Jim Blandy committed
62 63
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
64
Lisp_Object Qdeclare;
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 funcall_lambda (Lisp_Object, int, Lisp_Object*);
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
Andreas Schwab's avatar
Andreas Schwab committed
118 119
static int interactive_p (int);
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, 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").  */
128
  max_specpdl_size = 1000;
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 = Feval (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 = Feval (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 291 292 293
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
  cond = Feval (Fcar (args));
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
294
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299
    return Feval (Fcar (Fcdr (args)));
  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 319
    {
      clause = Fcar (args);
      val = Feval (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 346
      val = Feval (XCAR (args));
      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 374
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
375
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
376 377 378 379
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
380
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
381 382 383 384 385 386

  UNGCPRO;
  return val;
}

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

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
410
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
415
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419 420 421

  UNGCPRO;
  return val;
}

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

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

  args_left = args;
  GCPRO1 (args);

  do
    {
      val = Feval (Fcar (Fcdr (args_left)));
      sym = Fcar (args_left);
      Fset (sym, val);
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
449
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453

  UNGCPRO;
  return val;
}
454

Jim Blandy's avatar
Jim Blandy committed
455
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
456 457
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
458
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
459
{
460 461
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
462 463
  return Fcar (args);
}
464

Jim Blandy's avatar
Jim Blandy committed
465
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
466 467 468 469
       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
470
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
471
{
472 473
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
474 475 476
  return Fcar (args);
}

477

Jim Blandy's avatar
Jim Blandy committed
478
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
479
       doc: /* Return t if the containing function was run directly by user input.
480 481
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
482
and input is currently coming from the keyboard (not a keyboard macro),
483 484 485 486 487 488 489 490
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?

491 492 493 494
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
495
  (void)
Jim Blandy's avatar
Jim Blandy committed
496
{
497
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
498 499 500
}


501
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
502
       doc: /* Return t if the containing function was called by `call-interactively'.
503 504 505 506 507 508 509 510 511 512 513 514
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?
515 516 517 518 519

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
520
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
521
  (Lisp_Object kind)
522
{
523 524
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
525 526 527 528 529
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
530 531 532 533

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

Andreas Schwab's avatar
Andreas Schwab committed
534
static int
535
interactive_p (int exclude_subrs_p)
536 537 538
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
539 540

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
541 542

  /* If this isn't a byte-compiled function, there may be a frame at
543
     the top for Finteractive_p.  If so, skip it.  */
544
  fun = Findirect_function (*btp->function, Qnil);
545 546
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
547
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
548 549

  /* If we're running an Emacs 18-style byte-compiled function, there
550 551 552
     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
553

554
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
555
     looking at several frames for special forms.  Skip past them.  */
556 557 558
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
559 560
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
561 562 563 564
  /* 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.  */
565
  fun = Findirect_function (*btp->function, Qnil);
566 567
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
568

Jim Blandy's avatar
Jim Blandy committed
569 570 571
  /* 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))
572 573
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
574 575
}

576

Jim Blandy's avatar
Jim Blandy committed
577
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
578 579 580
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
581
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
582
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
583 584 585 586 587
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
588
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
589
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
590
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
591
    defn = Fpurecopy (defn);
592 593 594
  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
595
  Ffset (fn_name, defn);
596
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
601
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
602 603
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
604 605 606 607
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
608 609

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
610 611
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
612 613 614 615 616
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

617
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
618
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
619
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
620 621 622 623

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

Richard M. Stallman's avatar
Richard M. Stallman committed
624
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
625
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
626 627 628
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
629
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
630 631

  fn_name = Fcar (args);
632
  CHECK_SYMBOL (fn_name);
633 634 635 636 637 638
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
639 640
      doc = XCAR (tail);
      tail = XCDR (tail);
641 642
    }

643 644
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
645 646 647 648 649 650 651 652
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
653

654 655 656 657 658 659 660 661
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
  defn = Fcons (Qmacro, Fcons (Qlambda, tail));
662

Jim Blandy's avatar
Jim Blandy committed
663
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
664
    defn = Fpurecopy (defn);
665 666 667
  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
668
  Ffset (fn_name, defn);
669
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
670 671 672
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
673

674
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
675
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
676
Aliased variables always have the same value; setting one sets the other.
677
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
678 679 680 681
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.
682
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
683
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
684 685
{
  struct Lisp_Symbol *sym;
686

687 688
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
689

690
  sym = XSYMBOL (new_alias);
691 692

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
693 694
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
695 696 697 698 699 700 701 702 703

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

704
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
705 706 707 708
     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)))
709
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
710 711 712 713 714 715 716 717 718 719 720 721 722

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

  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
723 724
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
725 726
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
727

728
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
729 730 731
}


Jim Blandy's avatar
Jim Blandy committed
732
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
733
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
734 735 736 737 738 739 740 741 742 743 744 745
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.
746 747 748 749 750 751 752

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.)
753
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
754
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
755
{
756
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
757 758

  sym = Fcar (args);
759 760
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
761
    error ("Too many arguments");
762

763
  tem = Fdefault_boundp (sym);
764
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
765
    {
766 767 768 769 770 771 772 773 774 775 776 777
      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
778
      if (NILP (tem))
779
	Fset_default (sym, Feval (Fcar (tail)));
780 781 782
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
783
	  volatile struct specbinding *pdl = specpdl_ptr;
784 785 786 787 788 789 790 791 792 793 794
	  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;
		}
	    }
	}
795
      tail = Fcdr (tail);
796 797
      tem = Fcar (tail);
      if (!NILP (tem))
798 799 800 801 802
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
803
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
804
    }
805
  else
806 807 808
    /* 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
809 810
    ;

Jim Blandy's avatar
Jim Blandy committed
811 812 813 814
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
815 816 817 818 819 820
       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.
821 822 823 824

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.
825
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
826
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
827 828 829 830
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
831
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
832
    error ("Too many arguments");
833

834 835 836 837
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
838
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
839
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
840
    {
Jim Blandy's avatar
Jim Blandy committed
841
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
842 843 844
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
845
  Fput (sym, Qrisky_local_variable, Qt);
846
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
847 848 849
  return sym;
}

850 851
/* Error handler used in Fuser_variable_p.  */
static Lisp_Object
852
user_variable_p_eh (Lisp_Object ignore)
853 854 855 856
{
  return Qnil;
}

857 858 859 860 861 862 863
static Lisp_Object
lisp_indirect_variable (Lisp_Object sym)
{
  XSETSYMBOL (sym, indirect_variable (XSYMBOL (sym)));
  return sym;
}

Jim Blandy's avatar
Jim Blandy committed
864
DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
865
       doc: /* Return t if VARIABLE is intended to be set and modified by users.
Pavel Janík's avatar
Pavel Janík committed
866
\(The alternative is a variable used internally in a Lisp program.)
867 868 869 870 871 872 873
A variable is a user variable if
\(1) the first character of its documentation is `*', or
\(2) it is customizable (its property list contains a non-nil value
    of `standard-value' or `custom-autoload'), or
\(3) it is an alias for another user variable.
Return nil if VARIABLE is an alias and there is a loop in the
chain of symbols.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
874
  (Lisp_Object variable)
Jim Blandy's avatar
Jim Blandy committed
875 876
{
  Lisp_Object documentation;
877

878 879 880
  if (!SYMBOLP (variable))
      return Qnil;

881
  /* If indirect and there's an alias loop, don't check anything else.  */
882
  if (XSYMBOL (variable)->redirect == SYMBOL_VARALIAS
883
      && NILP (internal_condition_case_1 (lisp_indirect_variable, variable,
Andreas Schwab's avatar
Andreas Schwab committed
884
					  Qt, user_variable_p_eh)))
885 886 887 888 889 890
    return Qnil;

  while (1)
    {
      documentation = Fget (variable, Qvariable_documentation);
      if (INTEGERP (documentation) && XINT (documentation) < 0)
Andreas Schwab's avatar
Andreas Schwab committed
891
	return Qt;
892
      if (STRINGP (documentation)
Andreas Schwab's avatar
Andreas Schwab committed
893 894
	  && ((unsigned char) SREF (documentation, 0) == '*'))
	return Qt;
895 896
      /* If it is (STRING . INTEGER), a negative integer means a user variable.  */
      if (CONSP (documentation)
Andreas Schwab's avatar
Andreas Schwab committed
897 898 899 900
	  && STRINGP (XCAR (documentation))
	  && INTEGERP (XCDR (documentation))
	  && XINT (XCDR (documentation)) < 0)
	return Qt;
901 902
      /* Customizable?  See `custom-variable-p'.  */
      if ((!NILP (Fget (variable, intern ("standard-value"))))