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
/* 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
37 38

struct backtrace
39 40 41
{
  struct backtrace *next;
  Lisp_Object *function;
42
  Lisp_Object *args;	/* Points to vector of args.  */
43 44 45 46 47 48 49 50 51
#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;
52
  /* Nonzero means call value of debugger when done with this operation.  */
53
  char debug_on_exit : 1;
54
};
Jim Blandy's avatar
Jim Blandy committed
55

56
static struct backtrace *backtrace_list;
57 58 59 60

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

63 64 65 66 67 68 69 70 71 72 73
/* 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;

74 75 76 77 78
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

79
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
80
Lisp_Object Qinhibit_quit;
81 82 83 84
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
static Lisp_Object Qdebug_on_error;
static Lisp_Object Qdeclare;
85 86
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Paul Eggert's avatar
Paul Eggert committed
87
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
88

89 90 91
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
92

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

Lisp_Object Vautoload_queue;

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

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

/* Pointer to beginning of specpdl.  */
107

Jim Blandy's avatar
Jim Blandy committed
108 109 110
struct specbinding *specpdl;

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

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

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

116
static EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
117

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

125
static int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
126

127 128 129 130 131
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

132 133 134 135 136 137
/* 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;

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
155 156
}

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

174
/* Unwind-protect function used by call_debugger.  */
175 176

static Lisp_Object
177
restore_stack_limits (Lisp_Object data)
178 179 180
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
181
  return Qnil;
182 183 184 185
}

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

186
static Lisp_Object
187
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
188
{
189
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
190
  int count = SPECPDL_INDEX ();
191
  Lisp_Object val;
192
  EMACS_INT old_max = max_specpdl_size;
193

194 195
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
196

197 198 199 200 201 202 203 204 205 206 207
  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;
208

209
#ifdef HAVE_WINDOW_SYSTEM
210 211
  if (display_hourglass_p)
    cancel_hourglass ();
212 213
#endif

Jim Blandy's avatar
Jim Blandy committed
214
  debug_on_next_call = 0;
215
  when_entered_debugger = num_nonmacro_input_events;
216 217 218 219 220

  /* 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;
221 222
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
223
  specbind (Qinhibit_redisplay, Qnil);
224
  specbind (Qdebug_on_error, Qnil);
225 226 227

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

231 232 233 234
  val = apply1 (Vdebugger, arg);

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

239
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
240 241
}

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

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

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

  UNGCPRO;
  return val;
}

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

288
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
289

290
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
291
    {
292
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
293
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
294
	break;
295
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
296 297 298 299 300 301 302
    }

  UNGCPRO;
  return val;
}

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

  GCPRO1 (args);
314
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
315 316
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
317
  if (!NILP (cond))
318
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
319 320 321 322
  return Fprogn (Fcdr (Fcdr (args)));
}

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

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

  return val;
}

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

364
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
365

366
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
367
    {
368
      val = eval_sub (XCAR (args));
369
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
370 371 372 373 374 375 376
    }

  UNGCPRO;
  return val;
}

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

388
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395 396
    return Qnil;

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

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

  UNGCPRO;
  return val;
}

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

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

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

  UNGCPRO;
  return val;
}

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

457
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
458 459 460 461 462 463 464
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
465
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
466
      sym = Fcar (args_left);
467

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

Jim Blandy's avatar
Jim Blandy committed
478 479
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
480
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484

  UNGCPRO;
  return val;
}
485

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

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

505 506
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
507 508 509 510 511 512

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

520

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

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


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

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


/*  Return 1 if function in which this appears was called using
    call-interactively.
573 574 575 576

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

Andreas Schwab's avatar
Andreas Schwab committed
577
static int
578
interactive_p (int exclude_subrs_p)
579 580 581
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
582 583

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
584 585

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

  /* If we're running an Emacs 18-style byte-compiled function, there
593 594 595
     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
596

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

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

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

619

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

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

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

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

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

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

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

  fn_name = Fcar (args);
677
  CHECK_SYMBOL (fn_name);
678 679 680 681 682 683
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
684 685
      doc = XCAR (tail);
      tail = XCDR (tail);
686 687
    }

688 689
  if (CONSP (Fcar (tail))
      && EQ (Fcar (Fcar (tail)), Qdeclare))
690 691 692 693 694 695 696 697
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
698

699 700 701 702 703 704 705
      tail = Fcdr (tail);
    }

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

707
  defn = Fcons (Qlambda, tail);
708 709
  if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization!  */
    defn = Ffunction (Fcons (defn, Qnil));
710
  defn = Fcons (Qmacro, defn);
711

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

Gerd Moellmann's avatar
Gerd Moellmann committed
722

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

736 737
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
738

739
  sym = XSYMBOL (new_alias);
740 741

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

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

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

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

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

779
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
780 781 782
}


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

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

  sym = Fcar (args);
810 811
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
812
    error ("Too many arguments");
813

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

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

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