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

This file is part of GNU Emacs.

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

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


21
#include <config.h>
22
#include <limits.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
/* #if !BYTE_MARK_STACK */
/* static */
/* #endif */
/* struct catchtag *catchlist; */
Jim Blandy's avatar
Jim Blandy committed
39

40 41 42 43 44 45
/* 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.  */

46 47 48 49
/* #if !BYTE_MARK_STACK */
/* static */
/* #endif */
/* struct handler *handlerlist; */
50

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

56
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp;
57
Lisp_Object Qinhibit_quit;
58 59
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
60
static Lisp_Object Qinhibit_debugger;
61
static Lisp_Object Qdeclare;
62 63
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Paul Eggert's avatar
Paul Eggert committed
64
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
65

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

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

Lisp_Object Vautoload_queue;

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

81
/* ptrdiff_t specpdl_size; */
Jim Blandy's avatar
Jim Blandy committed
82 83

/* Pointer to beginning of specpdl.  */
84

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

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

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

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

93
/* static EMACS_INT lisp_eval_depth; */
Jim Blandy's avatar
Jim Blandy committed
94

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

102
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
103

104 105
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */
106
/* FIXME: We should probably get rid of this!  */
107 108
Lisp_Object Vsignaling_function;

109 110 111 112 113 114
/* If non-nil, Lisp code must not be run since some part of Emacs is
   in an inconsistent state.  Currently, x-create-frame uses this to
   avoid triggering window-configuration-change-hook while the new
   frame is half-initialized.  */
Lisp_Object inhibit_lisp_code;

115
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
116
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
117

118
/* Functions to modify slots of backtrace records.  */
119

120 121
static void
set_backtrace_args (struct specbinding *pdl, Lisp_Object *args)
122
{ eassert (pdl->kind == SPECPDL_BACKTRACE); pdl->v.bt.args = args; }
123

124 125
static void
set_backtrace_nargs (struct specbinding *pdl, ptrdiff_t n)
126 127
{ eassert (pdl->kind == SPECPDL_BACKTRACE); pdl->v.bt.nargs = n; }

128 129
static void
set_backtrace_debug_on_exit (struct specbinding *pdl, bool doe)
130 131 132 133
{ eassert (pdl->kind == SPECPDL_BACKTRACE); pdl->v.bt.debug_on_exit = doe; }

/* Helper functions to scan the backtrace.  */

134 135 136 137 138
bool backtrace_p (struct specbinding *) EXTERNALLY_VISIBLE;
struct specbinding *backtrace_top (void) EXTERNALLY_VISIBLE;
struct specbinding *backtrace_next (struct specbinding *pdl) EXTERNALLY_VISIBLE;

bool backtrace_p (struct specbinding *pdl)
139
{ return pdl >= specpdl; }
140

141 142
struct specbinding *
backtrace_top (void)
143
{
144
  struct specbinding *pdl = specpdl_ptr - 1;
145
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
146 147
    pdl--;
  return pdl;
148 149
}

150 151
struct specbinding *
backtrace_next (struct specbinding *pdl)
Tom Tromey's avatar
Tom Tromey committed
152
{
153 154 155 156
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
Tom Tromey's avatar
Tom Tromey committed
157 158
}

159

Andreas Schwab's avatar
Andreas Schwab committed
160
void
161
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
162
{
163
  enum { size = 50 };
164
  specpdl = xmalloc (size * sizeof *specpdl);
165
  specpdl_size = size;
166
  specpdl_ptr = specpdl;
167
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
168
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
169
  max_lisp_eval_depth = 600;
170 171

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
172 173
}

Andreas Schwab's avatar
Andreas Schwab committed
174
void
175
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
176 177 178 179 180 181 182
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
183
#ifdef DEBUG_GCPRO
184
  gcpro_level = 0;
185
#endif
186
  /* This is less than the initial value of num_nonmacro_input_events.  */
187
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
188 189
}

190 191 192 193 194 195 196 197 198 199 200 201 202
#if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
     || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
void
mark_catchlist (struct catchtag *catch)
{
  for (; catch; catch = catch->next)
    {
      mark_object (catch->tag);
      mark_object (catch->val);
    }
}
#endif

203
/* Unwind-protect function used by call_debugger.  */
204 205

static Lisp_Object
206
restore_stack_limits (Lisp_Object data)
207 208 209
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
210
  return Qnil;
211 212 213 214
}

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

215
Lisp_Object
216
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
217
{
218
  bool debug_while_redisplaying;
219
  ptrdiff_t count = SPECPDL_INDEX ();
220
  Lisp_Object val;
221
  EMACS_INT old_max = max_specpdl_size;
222

223 224
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
225

226 227 228 229 230 231 232 233 234
  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;

235
  if (max_specpdl_size - 100 < SPECPDL_INDEX ())
236
    max_specpdl_size = SPECPDL_INDEX () + 100;
237

238
#ifdef HAVE_WINDOW_SYSTEM
239 240
  if (display_hourglass_p)
    cancel_hourglass ();
241 242
#endif

Jim Blandy's avatar
Jim Blandy committed
243
  debug_on_next_call = 0;
244
  when_entered_debugger = num_nonmacro_input_events;
245 246 247 248 249

  /* 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;
250 251
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
252
  specbind (Qinhibit_redisplay, Qnil);
253
  specbind (Qinhibit_debugger, Qt);
254 255 256

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

260 261 262 263
  val = apply1 (Vdebugger, arg);

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

268
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
269 270
}

271
static void
272
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
273 274
{
  debug_on_next_call = 0;
275
  set_backtrace_debug_on_exit (specpdl_ptr - 1, true);
Jim Blandy's avatar
Jim Blandy committed
276 277 278 279 280 281 282 283
  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
284 285 286
       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
287
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
288
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
289
{
290
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
291 292
  struct gcpro gcpro1;

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

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
308
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
309 310
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
311
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
312
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
313
{
314
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
315 316
  struct gcpro gcpro1;

317
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
318

319
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
320
    {
321
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
322
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
323
	break;
324
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
332
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
333 334 335
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.
336
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
337
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
338 339 340 341 342
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

  GCPRO1 (args);
343
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
344 345
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
346
  if (!NILP (cond))
347
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
352 353 354 355 356 357 358 359
       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.
360
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
361
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
362 363 364 365 366 367
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
368
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
369 370
    {
      clause = Fcar (args);
371
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
372
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
373
	{
374 375
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
376 377
	  break;
	}
378
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383 384
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
385
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
386
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
387
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
388
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
389
{
390
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
391 392
  struct gcpro gcpro1;

393
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
394

395
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
396
    {
397
      val = eval_sub (XCAR (args));
398
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403 404 405
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
406
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
407 408
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
409
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
410
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
411 412 413 414 415 416 417 418 419
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;

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

420 421 422
  val = eval_sub (XCAR (args_left));
  while (CONSP (args_left = XCDR (args_left)))
    eval_sub (XCAR (args_left));
Jim Blandy's avatar
Jim Blandy committed
423 424 425 426 427 428

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
429
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
430 431 432
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
433
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
434
{
435
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
436

437 438
  GCPRO1 (args);
  eval_sub (XCAR (args));
439 440
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
441 442 443
}

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

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

  args_left = args;
  GCPRO1 (args);

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

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

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

  UNGCPRO;
  return val;
}
486

Jim Blandy's avatar
Jim Blandy committed
487
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
488
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
489 490 491 492 493 494 495 496
Warning: `quote' does not construct its return value, but just returns
the value that was pre-constructed by the Lisp reader (see info node
`(elisp)Printed Representation').
This means that '(a . b) is not identical to (cons 'a 'b): the former
does not cons.  Quoting should be reserved for constants that will
never be modified by side-effects, unless you like self-modifying code.
See the common pitfall in info node `(elisp)Rearrangement' for an example
of unexpected results when a quoted object is modified.
Pavel Janík's avatar
Pavel Janík committed
497
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
498
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
499
{
500 501
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
502 503
  return Fcar (args);
}
504

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

514 515
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
516 517 518 519 520 521

  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.  */
522 523
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
524 525 526
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
527 528
}

529

530
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
531
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
532
Aliased variables always have the same value; setting one sets the other.
533
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
534 535 536 537
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.
538
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
539
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
540 541
{
  struct Lisp_Symbol *sym;
542

543 544
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
545

546
  sym = XSYMBOL (new_alias);
547 548

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
549 550
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
551 552 553 554 555 556 557 558 559

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

560
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
561 562 563 564
     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)))
565
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
566 567 568 569

  {
    struct specbinding *p;

Paul Eggert's avatar
Paul Eggert committed
570
    for (p = specpdl_ptr; p > specpdl; )
571 572
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
573 574 575
	error ("Don't know how to make a let-bound variable an alias");
  }

576
  sym->declared_special = 1;
577
  XSYMBOL (base_variable)->declared_special = 1;
578 579
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
580 581
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
582 583
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
584

585
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
586 587 588
}


Jim Blandy's avatar
Jim Blandy committed
589
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
590
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
591 592 593 594 595 596 597 598 599
You are not required to define a variable in order to use it, but
defining it lets you supply an initial value and documentation, which
can be referred to by the Emacs help facilities and other programming
tools.  The `defvar' form also declares the variable as \"special\",
so that it is always dynamically bound even if `lexical-binding' is t.

The optional argument 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.
Pavel Janík's avatar
Pavel Janík committed
600
If INITVALUE is missing, SYMBOL's value is not set.
601 602 603 604 605 606 607

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.)
608 609 610 611 612

The optional argument DOCSTRING is a documentation string for the
variable.

To define a user option, use `defcustom' instead of `defvar'.
613
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
614
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
615
{
616
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
617 618

  sym = Fcar (args);
619 620
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
621
    error ("Too many arguments");
622

623
  tem = Fdefault_boundp (sym);
624
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
625
    {
626 627
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
628

Jim Blandy's avatar
Jim Blandy committed
629
      if (NILP (tem))
630
	Fset_default (sym, eval_sub (Fcar (tail)));
631 632 633
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
634
	  struct specbinding *pdl = specpdl_ptr;
635
	  while (pdl > specpdl)
636
	    {
637 638 639
	      if ((--pdl)->kind >= SPECPDL_LET
		  && EQ (specpdl_symbol (pdl), sym)
		  && EQ (specpdl_old_value (pdl), Qunbound))
640
		{
641 642 643
		  message_with_string
		    ("Warning: defvar ignored because %s is let-bound",
		     SYMBOL_NAME (sym), 1);
644 645 646 647
		  break;
		}
	    }
	}
648
      tail = Fcdr (tail);
649 650
      tem = Fcar (tail);
      if (!NILP (tem))
651 652 653 654 655
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
656
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
657
    }
658 659 660 661 662
  else if (!NILP (Vinternal_interpreter_environment)
	   && !XSYMBOL (sym)->declared_special)
    /* A simple (defvar foo) with lexical scoping does "nothing" except
       declare that var to be dynamically scoped *locally* (i.e. within
       the current file or let-block).  */
663 664
    Vinternal_interpreter_environment
      = Fcons (sym, Vinternal_interpreter_environment);
665
  else
666 667 668 669 670
    {
      /* Simple (defvar <var>) should not count as a definition at all.
	 It could get in the way of other definitions, and unloading this
	 package could try to make the variable unbound.  */
    }
Andreas Schwab's avatar
Andreas Schwab committed
671

Jim Blandy's avatar
Jim Blandy committed
672 673 674 675
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
676
       doc: /* Define SYMBOL as a constant variable.
677 678 679 680 681 682 683 684 685 686 687 688 689
This declares that neither programs nor users should ever change the
value.  This constancy is not actually enforced by Emacs Lisp, but
SYMBOL is marked as a special variable so that it is never lexically
bound.

The `defconst' form always sets the value of SYMBOL to the result of
evalling INITVALUE.  If SYMBOL is buffer-local, its default value is
what is set; buffer-local values are not affected.  If SYMBOL has a
local binding, then this form sets the local binding's value.
However, you should normally not make local bindings for variables
defined with this form.

The optional DOCSTRING specifies the variable's documentation string.
690
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
691
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
692 693 694 695
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
696
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
697
    error ("Too many arguments");
698

699
  tem = eval_sub (Fcar (Fcdr (args)));
700 701 702
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
703
  XSYMBOL (sym)->declared_special = 1;
Jim Blandy's avatar
Jim Blandy committed
704
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
705
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
706
    {
Jim Blandy's avatar
Jim Blandy committed
707
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
708 709 710
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
711
  Fput (sym, Qrisky_local_variable, Qt);
712
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
713 714 715
  return sym;
}

716 717 718 719 720 721 722 723 724 725 726
/* Make SYMBOL lexically scoped.  */
DEFUN ("internal-make-var-non-special", Fmake_var_non_special,
       Smake_var_non_special, 1, 1, 0,
       doc: /* Internal function.  */)
     (Lisp_Object symbol)
{
  CHECK_SYMBOL (symbol);
  XSYMBOL (symbol)->declared_special = 0;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
727 728

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
729 730 731 732 733
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
Each VALUEFORM can refer to the symbols already bound by this VARLIST.
734
usage: (let* VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
735
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
736
{
737
  Lisp_Object varlist, var, val, elt, lexenv;
738
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
739 740 741 742
  struct gcpro gcpro1, gcpro2, gcpro3;

  GCPRO3 (args, elt, varlist);

743 744
  lexenv = Vinternal_interpreter_environment;

Jim Blandy's avatar
Jim Blandy committed
745
  varlist = Fcar (args);
746
  while (CONSP (varlist))
Jim Blandy's avatar
Jim Blandy committed
747 748
    {
      QUIT;
749 750

      elt = XCAR (varlist);
751
      if (SYMBOLP (elt))
752 753 754 755
	{
	  var = elt;
	  val = Qnil;
	}
Jim Blandy's avatar
Jim Blandy committed
756
      else if (! NILP (Fcdr (Fcdr (elt))))
757
	signal_error ("`let' bindings can have only one value-form", elt);
Jim Blandy's avatar
Jim Blandy committed
758 759
      else
	{
760
	  var = Fcar (elt);
761
	  val = eval_sub (Fcar (Fcdr (elt)));
Jim Blandy's avatar
Jim Blandy committed
762
	}
763

764 765 766
      if (!NILP (lexenv) && SYMBOLP (var)
	  && !XSYMBOL (var)->declared_special
	  && NILP (Fmemq (var, Vinternal_interpreter_environment)))
767 768 769
	/* Lexically bind VAR by adding it to the interpreter's binding
	   alist.  */
	{
770 771 772 773 774 775 776 777 778
	  Lisp_Object newenv
	    = Fcons (Fcons (var, val), Vinternal_interpreter_environment);
	  if (EQ (Vinternal_interpreter_environment, lexenv))
	    /* Save the old lexical environment on the specpdl stack,
	       but only for the first lexical binding, since we'll never
	       need to revert to one of the intermediate ones.  */
	    specbind (Qinternal_interpreter_environment, newenv);
	  else
	    Vinternal_interpreter_environment = newenv;
Jim Blandy's avatar
Jim Blandy committed
779
	}
780 781 782 783
      else
	specbind (var, val);

      varlist = XCDR (varlist);
Jim Blandy's avatar
Jim Blandy committed
784 785 786 787 788 789 790
    }
  UNGCPRO;
  val = Fprogn (Fcdr (args));
  return unbind_to (count, val);
}

DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
791 792 793 794 795
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
All the VALUEFORMs are evalled before any symbols are bound.
796
usage: (let VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
797
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
798
{
799
  Lisp_Object *temps, tem, lexenv;
Jim Blandy's avatar
Jim Blandy committed
800
  register Lisp_Object elt, varlist;
801
  ptrdiff_t count = SPECPDL_INDEX ();
802
  ptrdiff_t argnum;
Jim Blandy's avatar
Jim Blandy committed
803
  struct gcpro gcpro1, gcpro2;
804
  USE_SAFE_ALLOCA;
Jim Blandy's avatar
Jim Blandy committed
805 806 807

  varlist = Fcar (args);

808
  /* Make space to hold the values to give the bound variables.  */
Jim Blandy's avatar
Jim Blandy committed
809
  elt = Flength (varlist);
810
  SAFE_ALLOCA_LISP (temps, XFASTINT (elt));
Jim Blandy's avatar
Jim Blandy committed
811

812
  /* Compute the values and store them in `temps'.  */
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816

  GCPRO2 (args, *temps);
  gcpro2.nvars = 0;

817
  for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
Jim Blandy's avatar
Jim Blandy committed
818 819
    {
      QUIT;
820
      elt = XCAR (varlist);
821
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
822
	temps [argnum++] = Qnil;
Jim Blandy's avatar
Jim Blandy committed
823
      else if (! NILP (Fcdr (Fcdr (elt))))
824
	signal_error ("`let' bindings can have only one value-form", elt);
Jim Blandy's avatar
Jim Blandy committed
825
      else
826
	temps [argnum++] = eval_sub (Fcar (Fcdr (elt)));
Jim Blandy's avatar
Jim Blandy committed
827 828 829 830
      gcpro2.nvars = argnum;
    }
  UNGCPRO;

831 832
  lexenv = Vinternal_interpreter_environment;