eval.c 101 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
#if !BYTE_MARK_STACK
static
#endif
Jim Blandy's avatar
Jim Blandy committed
38 39
struct catchtag *catchlist;

40 41 42 43 44 45 46 47 48 49 50
/* 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;

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

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

/* 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 122 123 124 125 126 127 128 129 130
static void set_backtrace_args (struct specbinding *pdl, Lisp_Object *args)
{ eassert (pdl->kind == SPECPDL_BACKTRACE); pdl->v.bt.args = args; }

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

void set_backtrace_debug_on_exit (struct specbinding *pdl, bool doe)
{ eassert (pdl->kind == SPECPDL_BACKTRACE); pdl->v.bt.debug_on_exit = doe; }

/* Helper functions to scan the backtrace.  */

131
EXTERN_INLINE bool backtrace_p (struct specbinding *pdl)
132
{ return pdl >= specpdl; }
133 134

EXTERN_INLINE struct specbinding *backtrace_top (void)
135
{
136
  struct specbinding *pdl = specpdl_ptr - 1;
137
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
138 139
    pdl--;
  return pdl;
140
}
141 142

EXTERN_INLINE struct specbinding *backtrace_next (struct specbinding *pdl)
143
{
144 145 146 147
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
148 149
}

150

Andreas Schwab's avatar
Andreas Schwab committed
151
void
152
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
153
{
154
  enum { size = 50 };
155
  specpdl = xmalloc (size * sizeof *specpdl);
156
  specpdl_size = size;
157
  specpdl_ptr = specpdl;
158
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
159
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
160
  max_lisp_eval_depth = 600;
161 162

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
163 164
}

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

181
/* Unwind-protect function used by call_debugger.  */
182 183

static Lisp_Object
184
restore_stack_limits (Lisp_Object data)
185 186 187
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
188
  return Qnil;
189 190 191 192
}

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

193
Lisp_Object
194
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
195
{
196
  bool debug_while_redisplaying;
197
  ptrdiff_t count = SPECPDL_INDEX ();
198
  Lisp_Object val;
199
  EMACS_INT old_max = max_specpdl_size;
200

201 202
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
203

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

213
  if (max_specpdl_size - 100 < SPECPDL_INDEX ())
214
    max_specpdl_size = SPECPDL_INDEX () + 100;
215

216
#ifdef HAVE_WINDOW_SYSTEM
217 218
  if (display_hourglass_p)
    cancel_hourglass ();
219 220
#endif

Jim Blandy's avatar
Jim Blandy committed
221
  debug_on_next_call = 0;
222
  when_entered_debugger = num_nonmacro_input_events;
223 224 225 226 227

  /* 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;
228 229
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
230
  specbind (Qinhibit_redisplay, Qnil);
231
  specbind (Qinhibit_debugger, Qt);
232 233 234

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

238 239 240 241
  val = apply1 (Vdebugger, arg);

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

246
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
247 248
}

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

271
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
272

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

  UNGCPRO;
  return val;
}

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

295
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
296

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

  UNGCPRO;
  return val;
}

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

  GCPRO1 (args);
321
  cond = eval_sub (Fcar (args));
Jim Blandy's avatar
Jim Blandy committed
322 323
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
324
  if (!NILP (cond))
325
    return eval_sub (Fcar (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329
  return Fprogn (Fcdr (Fcdr (args)));
}

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

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

  return val;
}

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

371
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
372

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

  UNGCPRO;
  return val;
}

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

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

398 399 400
  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
401 402 403 404 405 406

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
407
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
408 409 410
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
411
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
412
{
413
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
414

415 416
  GCPRO1 (args);
  eval_sub (XCAR (args));
417 418
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
419 420 421
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
422 423 424 425 426 427 428
       doc: /* Set each SYM to the value of its VAL.
The symbols SYM are variables; they are literal (not evaluated).
The values VAL are expressions; they are evaluated.
Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
The second VAL is not computed until after the first SYM is set, and so on;
each VAL can use the new value of variables set earlier in the `setq'.
The return value of the `setq' form is the value of the last VAL.
Juanma Barranquero's avatar
Juanma Barranquero committed
429
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
430
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
431 432
{
  register Lisp_Object args_left;
433
  register Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
434 435
  struct gcpro gcpro1;

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

  args_left = args;
  GCPRO1 (args);

  do
    {
444
      val = eval_sub (Fcar (Fcdr (args_left)));
Jim Blandy's avatar
Jim Blandy committed
445
      sym = Fcar (args_left);
446

447
      /* Like for eval_sub, we do not check declared_special here since
448 449
	 it's been done when let-binding.  */
      if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
450
	  && SYMBOLP (sym)
451 452
	  && !NILP (lex_binding
		    = Fassq (sym, Vinternal_interpreter_environment)))
453 454 455 456
	XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
      else
	Fset (sym, val);	/* SYM is dynamically bound.  */

Jim Blandy's avatar
Jim Blandy committed
457 458
      args_left = Fcdr (Fcdr (args_left));
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
459
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463

  UNGCPRO;
  return val;
}
464

Jim Blandy's avatar
Jim Blandy committed
465
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
466
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
467 468 469 470 471 472 473 474
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
475
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
476
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
477
{
478 479
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
480 481
  return Fcar (args);
}
482

Jim Blandy's avatar
Jim Blandy committed
483
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
484 485 486 487
       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
488
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
489
{
490 491
  Lisp_Object quoted = XCAR (args);

492 493
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
494 495 496 497 498 499

  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.  */
500 501
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
502 503 504
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
505 506
}

507

508
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
509
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
510
Aliased variables always have the same value; setting one sets the other.
511
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
512 513 514 515
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.
516
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
517
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
518 519
{
  struct Lisp_Symbol *sym;
520

521 522
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
523

524
  sym = XSYMBOL (new_alias);
525 526

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
527 528
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
529 530 531 532 533 534 535 536 537

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

538
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
539 540 541 542
     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)))
543
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
544 545 546 547

  {
    struct specbinding *p;

Paul Eggert's avatar
Paul Eggert committed
548
    for (p = specpdl_ptr; p > specpdl; )
549 550
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
551 552 553
	error ("Don't know how to make a let-bound variable an alias");
  }

554
  sym->declared_special = 1;
555
  XSYMBOL (base_variable)->declared_special = 1;
556 557
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
558 559
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
560 561
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
562

563
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
564 565 566
}


Jim Blandy's avatar
Jim Blandy committed
567
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
568
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
569 570 571 572 573 574 575 576 577
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
578
If INITVALUE is missing, SYMBOL's value is not set.
579 580 581 582 583 584 585

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.)
586 587 588 589 590

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

To define a user option, use `defcustom' instead of `defvar'.
591
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
592
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
593
{
594
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
595 596

  sym = Fcar (args);
597 598
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
599
    error ("Too many arguments");
600

601
  tem = Fdefault_boundp (sym);
602
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
603
    {
604 605
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
606

Jim Blandy's avatar
Jim Blandy committed
607
      if (NILP (tem))
608
	Fset_default (sym, eval_sub (Fcar (tail)));
609 610 611
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
612
	  struct specbinding *pdl = specpdl_ptr;
613
	  while (pdl > specpdl)
614
	    {
615 616 617
	      if ((--pdl)->kind >= SPECPDL_LET
		  && EQ (specpdl_symbol (pdl), sym)
		  && EQ (specpdl_old_value (pdl), Qunbound))
618
		{
619 620 621
		  message_with_string
		    ("Warning: defvar ignored because %s is let-bound",
		     SYMBOL_NAME (sym), 1);
622 623 624 625
		  break;
		}
	    }
	}
626
      tail = Fcdr (tail);
627 628
      tem = Fcar (tail);
      if (!NILP (tem))
629 630 631 632 633
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
634
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
635
    }
636 637 638 639 640
  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).  */
641 642
    Vinternal_interpreter_environment
      = Fcons (sym, Vinternal_interpreter_environment);
643
  else
644 645 646 647 648
    {
      /* 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
649

Jim Blandy's avatar
Jim Blandy committed
650 651 652 653
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
654
       doc: /* Define SYMBOL as a constant variable.
655 656 657 658 659 660 661 662 663 664 665 666 667
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.
668
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
669
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
670 671 672 673
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
674
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
675
    error ("Too many arguments");
676

677
  tem = eval_sub (Fcar (Fcdr (args)));
678 679 680
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
681
  XSYMBOL (sym)->declared_special = 1;
Jim Blandy's avatar
Jim Blandy committed
682
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
683
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
684
    {
Jim Blandy's avatar
Jim Blandy committed
685
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
686 687 688
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
689
  Fput (sym, Qrisky_local_variable, Qt);
690
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
691 692 693
  return sym;
}

694 695 696 697 698 699 700 701 702 703 704
/* 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
705 706

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
707 708 709 710 711
       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.
712
usage: (let* VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
713
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
714
{
715
  Lisp_Object varlist, var, val, elt, lexenv;
716
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720
  struct gcpro gcpro1, gcpro2, gcpro3;

  GCPRO3 (args, elt, varlist);

721 722
  lexenv = Vinternal_interpreter_environment;

Jim Blandy's avatar
Jim Blandy committed
723
  varlist = Fcar (args);
724
  while (CONSP (varlist))
Jim Blandy's avatar
Jim Blandy committed
725 726
    {
      QUIT;
727 728

      elt = XCAR (varlist);
729
      if (SYMBOLP (elt))
730 731 732 733
	{
	  var = elt;
	  val = Qnil;
	}
Jim Blandy's avatar
Jim Blandy committed
734
      else if (! NILP (Fcdr (Fcdr (elt))))
735
	signal_error ("`let' bindings can have only one value-form", elt);
Jim Blandy's avatar
Jim Blandy committed
736 737
      else
	{
738
	  var = Fcar (elt);
739
	  val = eval_sub (Fcar (Fcdr (elt)));
Jim Blandy's avatar
Jim Blandy committed
740
	}
741

742 743 744
      if (!NILP (lexenv) && SYMBOLP (var)
	  && !XSYMBOL (var)->declared_special
	  && NILP (Fmemq (var, Vinternal_interpreter_environment)))
745 746 747
	/* Lexically bind VAR by adding it to the interpreter's binding
	   alist.  */
	{
748 749 750 751 752 753 754 755 756
	  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
757
	}
758 759 760 761
      else
	specbind (var, val);

      varlist = XCDR (varlist);
Jim Blandy's avatar
Jim Blandy committed
762 763 764 765 766 767 768
    }
  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
769 770 771 772 773
       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.
774
usage: (let VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
775
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
776
{
777
  Lisp_Object *temps, tem, lexenv;
Jim Blandy's avatar
Jim Blandy committed
778
  register Lisp_Object elt, varlist;
779
  ptrdiff_t count = SPECPDL_INDEX ();
780
  ptrdiff_t argnum;
Jim Blandy's avatar
Jim Blandy committed
781
  struct gcpro gcpro1, gcpro2;
782
  USE_SAFE_ALLOCA;
Jim Blandy's avatar
Jim Blandy committed
783 784 785

  varlist = Fcar (args);

786
  /* Make space to hold the values to give the bound variables.  */
Jim Blandy's avatar
Jim Blandy committed
787
  elt = Flength (varlist);
788
  SAFE_ALLOCA_LISP (temps, XFASTINT (elt));
Jim Blandy's avatar
Jim Blandy committed
789

790
  /* Compute the values and store them in `temps'.  */
Jim Blandy's avatar
Jim Blandy committed
791 792 793 794

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

795
  for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
Jim Blandy's avatar
Jim Blandy committed
796 797
    {
      QUIT;
798
      elt = XCAR (varlist);
799
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
800
	temps [argnum++] = Qnil;
Jim Blandy's avatar
Jim Blandy committed
801
      else if (! NILP (Fcdr (Fcdr (elt))))
802
	signal_error ("`let' bindings can have only one value-form", elt);
Jim Blandy's avatar
Jim Blandy committed
803
      else
804
	temps [argnum++] = eval_sub (Fcar (Fcdr (elt)));
Jim Blandy's avatar
Jim Blandy committed
805 806 807 808
      gcpro2.nvars = argnum;
    }
  UNGCPRO;

809 810
  lexenv = Vinternal_interpreter_environment;

Jim Blandy's avatar
Jim Blandy committed
811
  varlist = Fcar (args);
812
  for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
Jim Blandy's avatar
Jim Blandy committed
813
    {
814 815
      Lisp_Object var;

816
      elt = XCAR (varlist);
817
      var = SYMBOLP (elt) ? elt : Fcar (elt);
Jim Blandy's avatar
Jim Blandy committed
818
      tem = temps[argnum++];
819

820 821 822
      if (!NILP (lexenv) && SYMBOLP (var)
	  && !XSYMBOL (var)->declared_special
	  && NILP (Fmemq (var, Vinternal_interpreter_environment)))
823 824
	/* Lexically bind VAR by adding it to the lexenv alist.  */
	lexenv = Fcons (Fcons (var, tem), lexenv);
Jim Blandy's avatar
Jim Blandy committed
825
      else