eval.c 115 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,
Andreas Schwab's avatar
Andreas Schwab committed
3 4
		 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
		 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;
Jim Blandy's avatar
Jim Blandy committed
61
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
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 Qcurry;
66 67
Lisp_Object Qinternal_interpreter_environment, Qclosure;

68
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
69

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

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

Lisp_Object Vautoload_queue;

83 84 85 86 87 88 89
/* When lexical binding is being used, this is non-nil, and contains an
   alist of lexically-bound variable, or t, indicating an empty
   environment.  The lisp name of this variable is
   `internal-interpreter-lexical-environment'.  */

Lisp_Object Vinternal_interpreter_environment;

Jim Blandy's avatar
Jim Blandy committed
90
/* Current number of specbindings allocated in specpdl.  */
91

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

/* Pointer to beginning of specpdl.  */
95

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

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

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

/* Maximum size allowed for specpdl allocation */
103

104
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
105 106

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

108
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
109 110

/* Maximum allowed depth in Lisp evaluations and function calls.  */
111

112
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
113 114

/* Nonzero means enter debugger before next function call */
115

Jim Blandy's avatar
Jim Blandy committed
116 117
int debug_on_next_call;

118
/* Non-zero means debugger may continue.  This is zero when the
119 120 121 122 123
   debugger is called during redisplay, where it might not be safe to
   continue the interrupted redisplay. */

int debugger_may_continue;

Roland McGrath's avatar
Roland McGrath committed
124
/* List of conditions (non-nil atom means all) which cause a backtrace
125
   if an error is handled by the command loop's error handler.  */
126

Roland McGrath's avatar
Roland McGrath committed
127
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
128

Roland McGrath's avatar
Roland McGrath committed
129
/* List of conditions (non-nil atom means all) which enter the debugger
130
   if an error is handled by the command loop's error handler.  */
131

Roland McGrath's avatar
Roland McGrath committed
132
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
133

Karl Heuer's avatar
Karl Heuer committed
134
/* List of conditions and regexps specifying error messages which
135
   do not enter the debugger even if Vdebug_on_error says they should.  */
136

Karl Heuer's avatar
Karl Heuer committed
137 138
Lisp_Object Vdebug_ignored_errors;

139
/* Non-nil means call the debugger even if the error will be handled.  */
140

141
Lisp_Object Vdebug_on_signal;
142 143

/* Hook for edebug to use.  */
144

145 146
Lisp_Object Vsignal_hook_function;

Jim Blandy's avatar
Jim Blandy committed
147
/* Nonzero means enter debugger if a quit signal
Roland McGrath's avatar
Roland McGrath committed
148
   is handled by the command loop's error handler. */
149

Jim Blandy's avatar
Jim Blandy committed
150 151
int debug_on_quit;

152
/* The value of num_nonmacro_input_events as of the last time we
153
   started to enter the debugger.  If we decide to enter the debugger
154
   again when this is still equal to num_nonmacro_input_events, then we
155 156 157
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
158

159
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
160 161 162

Lisp_Object Vdebugger;

163 164 165 166 167
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

168 169 170 171 172 173
/* 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;

174 175 176 177
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

Stefan Monnier's avatar
Stefan Monnier committed
178 179
static Lisp_Object funcall_lambda (Lisp_Object, int, Lisp_Object *,
				   Lisp_Object);
180
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
181

Andreas Schwab's avatar
Andreas Schwab committed
182
void
183
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
184 185
{
  specpdl_size = 50;
186
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
187
  specpdl_ptr = specpdl;
188
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
189
  max_specpdl_size = 1200; /* 1000 is not enough for CEDET's c-by.el.  */
190
  max_lisp_eval_depth = 600;
191 192

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
193 194
}

Andreas Schwab's avatar
Andreas Schwab committed
195
void
196
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201 202 203 204
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
205
#ifdef DEBUG_GCPRO
206
  gcpro_level = 0;
207
#endif
208
  /* This is less than the initial value of num_nonmacro_input_events.  */
209
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
210 211
}

212 213 214
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
215
restore_stack_limits (Lisp_Object data)
216 217 218
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
219
  return Qnil;
220 221 222 223
}

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

Jim Blandy's avatar
Jim Blandy committed
224
Lisp_Object
225
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
226
{
227
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
228
  int count = SPECPDL_INDEX ();
229
  Lisp_Object val;
230
  EMACS_INT old_max = max_specpdl_size;
231

232 233
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
234

235 236 237 238 239 240 241 242 243 244 245
  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;
246

247
#ifdef HAVE_WINDOW_SYSTEM
248 249
  if (display_hourglass_p)
    cancel_hourglass ();
250 251
#endif

Jim Blandy's avatar
Jim Blandy committed
252
  debug_on_next_call = 0;
253
  when_entered_debugger = num_nonmacro_input_events;
254 255 256 257 258

  /* 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;
259 260
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
261
  specbind (Qinhibit_redisplay, Qnil);
262
  specbind (Qdebug_on_error, Qnil);
263 264 265

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

269 270 271 272
  val = apply1 (Vdebugger, arg);

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

277
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
278 279
}

Andreas Schwab's avatar
Andreas Schwab committed
280
void
281
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
282 283 284 285 286 287 288 289 290 291 292
{
  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
293 294 295
       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
296
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
297
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
298
{
299
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
300 301
  struct gcpro gcpro1;

302
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
303

304
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
305
    {
306
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
307
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
308
	break;
309
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
310 311 312 313 314 315 316
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
317
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
318 319
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
320
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
321
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
322
{
323
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
324 325
  struct gcpro gcpro1;

326
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
327

328
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
329
    {
330
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
331
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
332
	break;
333
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337 338 339 340
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
341
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
342 343 344
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.
345
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
346
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352 353 354
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

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

Jim Blandy's avatar
Jim Blandy committed
355
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
356 357 358 359 360
    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
361 362 363 364 365 366 367 368
       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.
369
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
370
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
377
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
378 379 380
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
381
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
382
	{
383 384
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
385 386
	  break;
	}
387
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
388 389 390 391 392 393 394
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
395
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
396
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
398
{
399
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
400 401
  struct gcpro gcpro1;

402
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
403

404
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
405
    {
406 407
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412 413 414
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
415
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
416 417
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
418
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
419
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423 424 425
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

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

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
436
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
441
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445 446 447

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
448
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
449 450 451
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
452
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457 458 459 460
{
  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
461
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
462 463 464 465 466 467 468 469 470
    return Qnil;

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

  do
    {
      if (!(argnum++))
Andreas Schwab's avatar
Andreas Schwab committed
471
	val = Feval (Fcar (args_left));
Jim Blandy's avatar
Jim Blandy committed
472 473 474 475
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
476
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480 481 482

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
483 484 485 486 487 488 489
       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
490
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
491
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
492 493
{
  register Lisp_Object args_left;
494
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
495 496
  struct gcpro gcpro1;

497
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503 504 505 506
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
      val = Feval (Fcar (Fcdr (args_left)));
      sym = Fcar (args_left);
507 508 509 510 511 512 513 514 515

      if (!NILP (Vinternal_interpreter_environment)
	  && SYMBOLP (sym)
	  && !XSYMBOL (sym)->declared_special
	  && !NILP (lex_binding = Fassq (sym, Vinternal_interpreter_environment)))
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
516 517
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
518
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
519 520 521 522

  UNGCPRO;
  return val;
}
523

Jim Blandy's avatar
Jim Blandy committed
524
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
525 526
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
527
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
528
{
529 530
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
531 532
  return Fcar (args);
}
533

Jim Blandy's avatar
Jim Blandy committed
534
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
535 536 537 538
       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
539
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
540
{
541 542
  Lisp_Object quoted = XCAR (args);

543 544
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
545 546 547 548 549 550 551 552 553 554

  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
555 556
}

557

Jim Blandy's avatar
Jim Blandy committed
558
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
559
       doc: /* Return t if the containing function was run directly by user input.
560 561
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
562
and input is currently coming from the keyboard (not a keyboard macro),
563 564 565 566 567 568 569 570
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?

571 572 573 574
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
575
  (void)
Jim Blandy's avatar
Jim Blandy committed
576
{
577
  return interactive_p (1) ? Qt : Qnil;
578 579 580
}


581
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
582
       doc: /* Return t if the containing function was called by `call-interactively'.
583 584 585 586 587 588 589 590 591 592 593 594
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?
595 596 597 598 599

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
600
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
601
  (Lisp_Object kind)
602
{
603 604
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
605 606 607 608 609
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
610 611 612 613 614

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

int
615
interactive_p (int exclude_subrs_p)
616 617 618
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
619 620

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
621 622

  /* If this isn't a byte-compiled function, there may be a frame at
623
     the top for Finteractive_p.  If so, skip it.  */
624
  fun = Findirect_function (*btp->function, Qnil);
625 626
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
627
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
628 629

  /* If we're running an Emacs 18-style byte-compiled function, there
630 631 632
     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
633

634
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
635
     looking at several frames for special forms.  Skip past them.  */
636 637 638
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
639 640
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
641 642 643 644
  /* 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.  */
645
  fun = Findirect_function (*btp->function, Qnil);
646 647
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
648

Jim Blandy's avatar
Jim Blandy committed
649 650 651
  /* 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))
652 653
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
654 655
}

656

Jim Blandy's avatar
Jim Blandy committed
657
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
658 659 660
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
661
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
662
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
668
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
669
  defn = Fcons (Qlambda, Fcdr (args));
670 671
  if (! NILP (Vinternal_interpreter_environment))
    defn = Fcons (Qclosure, Fcons (Vinternal_interpreter_environment, defn));
Jim Blandy's avatar
Jim Blandy committed
672
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
673
    defn = Fpurecopy (defn);
674 675 676
  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
677
  Ffset (fn_name, defn);
678
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
679 680 681 682
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
683
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
684 685
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
686 687 688 689
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
690 691

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
692 693
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
694 695 696 697 698
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

699
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
700
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
701
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
702 703 704 705

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

Richard M. Stallman's avatar
Richard M. Stallman committed
706
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
707
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
708 709 710
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
711
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
712 713

  fn_name = Fcar (args);
714
  CHECK_SYMBOL (fn_name);
715 716 717 718 719 720
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
721 722
      doc = XCAR (tail);
      tail = XCDR (tail);
723 724
    }

725 726
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
727 728 729 730 731 732 733 734
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
735

736 737 738 739 740 741 742
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
743 744 745 746 747
  
  defn = Fcons (Qlambda, tail);
  if (! NILP (Vinternal_interpreter_environment))
    defn = Fcons (Qclosure, Fcons (Vinternal_interpreter_environment, defn));
  defn = Fcons (Qmacro, defn);
748

Jim Blandy's avatar
Jim Blandy committed
749
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
750
    defn = Fpurecopy (defn);
751 752 753
  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
754
  Ffset (fn_name, defn);
755
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
756 757 758
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
759

760
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
761
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
762
Aliased variables always have the same value; setting one sets the other.
763
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
764 765 766 767
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.
768
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
769
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
770 771
{
  struct Lisp_Symbol *sym;
772

773 774
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
775

776
  sym = XSYMBOL (new_alias);
777 778

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
779 780
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
781 782 783 784 785 786 787 788 789

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

790
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
791 792 793 794
     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)))
795
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
796 797 798 799 800 801 802 803 804 805 806

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

807
  sym->declared_special = 1;
808 809
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
810 811
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
812 813
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
814

815
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
816 817 818
}


Jim Blandy's avatar
Jim Blandy committed
819
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
820
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
821 822 823 824 825 826 827 828 829 830 831 832
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.
833 834 835 836 837 838 839

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.)
840
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
841
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
842
{
843
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
844 845

  sym = Fcar (args);
846 847
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
848
    error ("Too many arguments");
849

850
  tem = Fdefault_boundp (sym);
851
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
852
    {
853 854 855 856 857 858 859 860 861 862 863 864
      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
865
      if (NILP (tem))
866
	Fset_default (sym, Feval (Fcar (tail)));
867 868 869
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
870
	  volatile struct specbinding *pdl = specpdl_ptr;
871 872 873 874 875 876 877 878 879 880 881
	  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;
		}
	    }
	}
882
      tail = Fcdr (tail);
883 884
      tem = Fcar (tail);
      if (!NILP (tem))
885 886 887 888 889
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
890
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
891
    }
892
  else