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

This file is part of GNU Emacs.

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

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

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


20
#include <config.h>
21
#include <limits.h>
22
#include <setjmp.h>
23
#include <stdio.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

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

39 40
/* This definition is duplicated in alloc.c and keyboard.c.  */
/* Putting it in lisp.h makes cc bomb out!  */
Jim Blandy's avatar
Jim Blandy committed
41 42

struct backtrace
43 44 45
{
  struct backtrace *next;
  Lisp_Object *function;
46
  Lisp_Object *args;	/* Points to vector of args.  */
47 48 49 50 51 52 53 54 55
#define NARGS_BITS (BITS_PER_INT - 2)
  /* Let's not use size_t because we want to allow negative values (for
     UNEVALLED).  Also let's steal 2 bits so we save a word (or more for
     alignment).  In any case I doubt Emacs would survive a function call with
     more than 500M arguments.  */
  int nargs : NARGS_BITS; /* Length of vector.
			     If nargs is UNEVALLED, args points
			     to slot holding list of unevalled args.  */
  char evalargs : 1;
56
  /* Nonzero means call value of debugger when done with this operation.  */
57
  char debug_on_exit : 1;
58
};
Jim Blandy's avatar
Jim Blandy committed
59

60
static struct backtrace *backtrace_list;
61 62 63 64

#if !BYTE_MARK_STACK
static
#endif
Jim Blandy's avatar
Jim Blandy committed
65 66
struct catchtag *catchlist;

67 68 69 70 71 72 73 74 75 76 77
/* Chain of condition handlers currently in effect.
   The elements of this chain are contained in the stack frames
   of Fcondition_case and internal_condition_case.
   When an error is signaled (by calling Fsignal, below),
   this chain is searched for an element that applies.  */

#if !BYTE_MARK_STACK
static
#endif
struct handler *handlerlist;

78 79 80 81 82
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

83
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
84
Lisp_Object Qinhibit_quit;
85 86 87 88
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
static Lisp_Object Qdebug_on_error;
static Lisp_Object Qdeclare;
89 90
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Daniel Colascione's avatar
Daniel Colascione committed
91
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
92

93 94 95
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
96

Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101
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:
102
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
103 104 105 106

Lisp_Object Vautoload_queue;

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

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

/* Pointer to beginning of specpdl.  */
111

Jim Blandy's avatar
Jim Blandy committed
112 113 114
struct specbinding *specpdl;

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

116
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
117 118

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

120
static EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
121

122
/* The value of num_nonmacro_input_events as of the last time we
123
   started to enter the debugger.  If we decide to enter the debugger
124
   again when this is still equal to num_nonmacro_input_events, then we
125 126 127
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
128

129
static int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
130

131 132 133 134 135
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

136 137 138 139 140 141
/* Set to non-zero while processing X events.  Checked in Feval to
   make sure the Lisp interpreter isn't called from a signal handler,
   which is unsafe because the interpreter isn't reentrant.  */

int handling_signal;

Stefan Monnier's avatar
Stefan Monnier committed
142
static Lisp_Object funcall_lambda (Lisp_Object, size_t, Lisp_Object *);
143
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
Andreas Schwab's avatar
Andreas Schwab committed
144
static int interactive_p (int);
145
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
146
static Lisp_Object Ffetch_bytecode (Lisp_Object);
147

Andreas Schwab's avatar
Andreas Schwab committed
148
void
149
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
150 151
{
  specpdl_size = 50;
152
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
153
  specpdl_ptr = specpdl;
154
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
155
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
156
  max_lisp_eval_depth = 600;
157 158

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
159 160
}

Andreas Schwab's avatar
Andreas Schwab committed
161
void
162
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
171
#ifdef DEBUG_GCPRO
172
  gcpro_level = 0;
173
#endif
174
  /* This is less than the initial value of num_nonmacro_input_events.  */
175
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
176 177
}

178
/* Unwind-protect function used by call_debugger.  */
179 180

static Lisp_Object
181
restore_stack_limits (Lisp_Object data)
182 183 184
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
185
  return Qnil;
186 187 188 189
}

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

190
static Lisp_Object
191
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
192
{
193
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
194
  int count = SPECPDL_INDEX ();
195
  Lisp_Object val;
196
  EMACS_INT old_max = max_specpdl_size;
197

198 199
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
200

201 202 203 204 205 206 207 208 209 210 211
  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;
212

213
#ifdef HAVE_WINDOW_SYSTEM
214 215
  if (display_hourglass_p)
    cancel_hourglass ();
216 217
#endif

Jim Blandy's avatar
Jim Blandy committed
218
  debug_on_next_call = 0;
219
  when_entered_debugger = num_nonmacro_input_events;
220 221 222 223 224

  /* 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;
225 226
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
227
  specbind (Qinhibit_redisplay, Qnil);
228
  specbind (Qdebug_on_error, Qnil);
229 230 231

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

235 236 237 238
  val = apply1 (Vdebugger, arg);

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

243
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
244 245
}

246
static void
247
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251 252 253 254 255 256 257 258
{
  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
259 260 261
       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
262
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
264
{
265
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
266 267
  struct gcpro gcpro1;

268
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
269

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
283
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
284 285
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
286
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
287
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
288
{
289
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
290 291
  struct gcpro gcpro1;

292
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
293

294
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
295
    {
296
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
297
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
298
	break;
299
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
300 301 302 303 304 305 306
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
307
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
308 309 310
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.
311
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
312
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
313 314 315 316 317
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
318
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
319 320
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
321
  if (!NILP (cond))
322
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
323 324 325 326
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
327 328 329 330 331 332 333 334
       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.
335
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
336
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
337 338 339 340 341 342
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
343
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
344 345
    {
      clause = Fcar (args);
346
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
347
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
348
	{
349 350
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
351 352
	  break;
	}
353
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
354 355 356 357 358 359
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
360
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
361
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
362
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
363
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
364
{
365
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
366 367
  struct gcpro gcpro1;

368
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
369

370
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
371
    {
372
      val = eval_sub (XCAR (args));
373
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378 379 380
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
381
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
382 383
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
384
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
385
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
386 387 388 389 390 391
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

392
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
393 394 395 396 397 398 399 400
    return Qnil;

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

  do
    {
401
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
402
      if (!(argnum++))
403 404
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
405
    }
406
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
413
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
414 415 416
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
417
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425
{
  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
426
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432 433 434
    return Qnil;

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

  do
    {
435
      Lisp_Object tem = eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
436
      if (!(argnum++))
437 438
	val = tem;
      args_left = XCDR (args_left);
Jim Blandy's avatar
Jim Blandy committed
439
    }
440
  while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445 446

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
447 448 449 450 451 452 453
       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
454
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
455
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
456 457
{
  register Lisp_Object args_left;
458
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
459 460
  struct gcpro gcpro1;

461
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
462 463 464 465 466 467 468
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
469
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
470
      sym = Fcar (args_left);
471

472
      /* Like for eval_sub, we do not check declared_special here since
473 474
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
475
	  && SYMBOLP (sym)
476 477
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
478 479 480 481
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
482 483
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
484
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
485 486 487 488

  UNGCPRO;
  return val;
}
489

Jim Blandy's avatar
Jim Blandy committed
490
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
491 492
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
493
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
494
{
495 496
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
497 498
  return Fcar (args);
}
499

Jim Blandy's avatar
Jim Blandy committed
500
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
501 502 503 504
       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
505
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
506
{
507 508
  Lisp_Object quoted = XCAR (args);

509 510
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
511 512 513 514 515 516

  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.  */
517 518
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
519 520 521
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
522 523
}

524

Paul Eggert's avatar
Paul Eggert committed
525
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
526
       doc: /* Return t if the containing function was run directly by user input.
527 528
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
529
and input is currently coming from the keyboard (not a keyboard macro),
530 531 532 533 534 535 536 537
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?

538 539 540 541
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
542
  (void)
Jim Blandy's avatar
Jim Blandy committed
543
{
544
  return interactive_p (1) ? Qt : Qnil;
545 546 547
}


548
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
549
       doc: /* Return t if the containing function was called by `call-interactively'.
550 551 552 553 554 555 556 557 558 559 560 561
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?
562 563 564 565 566

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
567
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
568
  (Lisp_Object kind)
569
{
570 571
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
572 573 574 575 576
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
577 578 579 580

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

Andreas Schwab's avatar
Andreas Schwab committed
581
static int
582
interactive_p (int exclude_subrs_p)
583 584 585
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
586 587

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
588 589

  /* If this isn't a byte-compiled function, there may be a frame at
590
     the top for Finteractive_p.  If so, skip it.  */
591
  fun = Findirect_function (*btp->function, Qnil);
592 593
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
594
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
595 596

  /* If we're running an Emacs 18-style byte-compiled function, there
597 598 599
     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
600

601
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
602
     looking at several frames for special forms.  Skip past them.  */
603 604
  while (btp
	 && (EQ (*btp->function, Qbytecode)
605
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
606 607
    btp = btp->next;

608
  /* `btp' now points at the frame of the innermost function that isn't
Jim Blandy's avatar
Jim Blandy committed
609 610 611
     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.  */
612
  fun = Findirect_function (*btp->function, Qnil);
613 614
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
615

616
  /* `btp' points to the frame of a Lisp function that called interactive-p.
Jim Blandy's avatar
Jim Blandy committed
617 618
     Return t if that function was called interactively.  */
  if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
619 620
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
621 622
}

623

Jim Blandy's avatar
Jim Blandy committed
624
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
625 626 627
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
628
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
629
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
630 631 632 633 634
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
635
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
636
  defn = Fcons (Qlambda, Fcdr (args));
637 638
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
Jim Blandy's avatar
Jim Blandy committed
639
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
640
    defn = Fpurecopy (defn);
641 642 643
  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
644
  Ffset (fn_name, defn);
645
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
650
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
651 652
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
653 654 655 656
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
657 658

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
659 660
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
661 662 663 664 665
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

666
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
667
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
668
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
669 670 671 672

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

Richard M. Stallman's avatar
Richard M. Stallman committed
673
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
674
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
675 676 677
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
678
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
679 680

  fn_name = Fcar (args);
681
  CHECK_SYMBOL (fn_name);
682 683 684 685 686 687
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
688 689
      doc = XCAR (tail);
      tail = XCDR (tail);
690 691
    }

692 693
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
694 695 696 697 698 699 700 701
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
702

703 704 705 706 707 708 709
      tail = Fcdr (tail);
    }

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

711
  defn = Fcons (Qlambda, tail);
712 713
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
714
  defn = Fcons (Qmacro, defn);
715

Jim Blandy's avatar
Jim Blandy committed
716
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
717
    defn = Fpurecopy (defn);
718 719 720
  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
721
  Ffset (fn_name, defn);
722
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
723 724 725
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
726

727
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
728
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
729
Aliased variables always have the same value; setting one sets the other.
730
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
731 732 733 734
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.
735
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
736
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
737 738
{
  struct Lisp_Symbol *sym;
739

740 741
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
742

743
  sym = XSYMBOL (new_alias);
744 745

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
746 747
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
748 749 750 751 752 753 754 755 756

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

757
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
758 759 760 761
     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)))
762
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
763 764 765 766 767 768 769 770 771 772 773

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

774
  sym->declared_special = 1;
775 776
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
777 778
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
779 780
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
781

782
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
783 784 785
}


Jim Blandy's avatar
Jim Blandy committed
786
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
787
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
788 789 790 791 792 793 794 795 796 797 798 799
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.
800 801 802 803 804 805 806

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.)
807
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
808
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
809
{
810
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
811 812

  sym = Fcar (args);
813 814
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
815
    error ("Too many arguments");
816

817
  tem = Fdefault_boundp (sym);
818
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
819
    {
820 821
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
822

823 824 825
      if (SYMBOL_CONSTANT_P (sym))
	{
	  /* For upward compatibility, allow (defvar :foo (quote :foo)).  */
826 827 828 829 830
	  Lisp_Object tem1 = Fcar (tail);
	  if (! (CONSP (tem1)
		 && EQ (XCAR (tem1), Qquote)
		 && CONSP (XCDR (tem1))
		 && EQ (XCAR (XCDR (tem1)), sym)))
831 832 833 834
	    error ("Constant symbol `%s' specified in defvar",
		   SDATA (SYMBOL_NAME (sym)));
	}

Jim Blandy's avatar
Jim Blandy committed
835
      if (NILP (tem))
836
	Fset_default (sym, eval_sub (Fcar (tail)));
837 838 839
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
840
	  volatile struct specbinding *pdl = specpdl_ptr;
841 842 843 844 845 846 847 848 849 850 851
	  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;
		}
	    }
	}
852
      tail = Fcdr (tail);
853 854
      tem = Fcar (tail);
      if (!NILP (tem))
855 856 857 858 859
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
860
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
861
    }
862 863 864 865 866 867