eval.c 112 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
Glenn Morris's avatar
Glenn Morris committed
2

3 4
Copyright (C) 1985-1987, 1993-1995, 1999-2014 Free Software Foundation,
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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

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


22
#include <config.h>
23
#include <limits.h>
24
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
25
#include "lisp.h"
26
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "keyboard.h"
29
#include "dispextern.h"
30
#include "frame.h"		/* For XFRAME.  */
Jim Blandy's avatar
Jim Blandy committed
31

32 33 34 35
#if HAVE_X_WINDOWS
#include "xterm.h"
#endif

36
/* Chain of condition and catch handlers currently in effect.  */
37 38 39

struct handler *handlerlist;

40 41 42 43 44
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

45
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp;
46
Lisp_Object Qinhibit_quit;
47 48
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
49
static Lisp_Object Qinhibit_debugger;
50
static Lisp_Object Qdeclare;
51 52
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Paul Eggert's avatar
Paul Eggert committed
53
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
54

55 56 57
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
58

Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63
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:
64
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
65 66 67

Lisp_Object Vautoload_queue;

68 69
/* Current number of specbindings allocated in specpdl, not counting
   the dummy entry specpdl[-1].  */
70

71
ptrdiff_t specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
72

73 74
/* Pointer to beginning of specpdl.  A dummy entry specpdl[-1] exists
   only so that its address can be taken.  */
75

76
union specbinding *specpdl;
Jim Blandy's avatar
Jim Blandy committed
77 78

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

80
union specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
81 82

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

84
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
85

86
/* The value of num_nonmacro_input_events as of the last time we
87
   started to enter the debugger.  If we decide to enter the debugger
88
   again when this is still equal to num_nonmacro_input_events, then we
89 90 91
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
92

93
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
94

95 96
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */
97
/* FIXME: We should probably get rid of this!  */
98 99
Lisp_Object Vsignaling_function;

100 101 102 103 104 105
/* 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;

106 107 108 109 110 111 112
/* These would ordinarily be static, but they need to be visible to GDB.  */
bool backtrace_p (union specbinding *) EXTERNALLY_VISIBLE;
Lisp_Object *backtrace_args (union specbinding *) EXTERNALLY_VISIBLE;
Lisp_Object backtrace_function (union specbinding *) EXTERNALLY_VISIBLE;
union specbinding *backtrace_next (union specbinding *) EXTERNALLY_VISIBLE;
union specbinding *backtrace_top (void) EXTERNALLY_VISIBLE;

113
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
114
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
115

116
static Lisp_Object
117
specpdl_symbol (union specbinding *pdl)
118 119
{
  eassert (pdl->kind >= SPECPDL_LET);
120
  return pdl->let.symbol;
121 122 123
}

static Lisp_Object
124
specpdl_old_value (union specbinding *pdl)
125 126
{
  eassert (pdl->kind >= SPECPDL_LET);
127
  return pdl->let.old_value;
128 129
}

130 131 132 133 134 135 136
static void
set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
{
  eassert (pdl->kind >= SPECPDL_LET);
  pdl->let.old_value = val;
}

137
static Lisp_Object
138
specpdl_where (union specbinding *pdl)
139 140
{
  eassert (pdl->kind > SPECPDL_LET);
141
  return pdl->let.where;
142 143 144
}

static Lisp_Object
145
specpdl_arg (union specbinding *pdl)
146 147
{
  eassert (pdl->kind == SPECPDL_UNWIND);
148
  return pdl->unwind.arg;
149 150
}

151
Lisp_Object
152
backtrace_function (union specbinding *pdl)
153 154
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
155
  return pdl->bt.function;
156 157 158
}

static ptrdiff_t
159
backtrace_nargs (union specbinding *pdl)
160 161
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
162
  return pdl->bt.nargs;
163 164
}

165
Lisp_Object *
166
backtrace_args (union specbinding *pdl)
167 168
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
169
  return pdl->bt.args;
170 171 172
}

static bool
173
backtrace_debug_on_exit (union specbinding *pdl)
174 175
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
176
  return pdl->bt.debug_on_exit;
177 178
}

179
/* Functions to modify slots of backtrace records.  */
180

181
static void
182 183 184 185 186
set_backtrace_args (union specbinding *pdl, Lisp_Object *args)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
}
187

188
static void
189 190 191 192 193
set_backtrace_nargs (union specbinding *pdl, ptrdiff_t n)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.nargs = n;
}
194

195
static void
196 197 198 199 200
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
201 202 203

/* Helper functions to scan the backtrace.  */

204 205
bool
backtrace_p (union specbinding *pdl)
206
{ return pdl >= specpdl; }
207

208
union specbinding *
209
backtrace_top (void)
210
{
211
  union specbinding *pdl = specpdl_ptr - 1;
212
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
213 214
    pdl--;
  return pdl;
215
}
216

217 218
union specbinding *
backtrace_next (union specbinding *pdl)
219
{
220 221 222 223
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
224 225
}

226

Andreas Schwab's avatar
Andreas Schwab committed
227
void
228
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
229
{
230
  enum { size = 50 };
231
  union specbinding *pdlvec = xmalloc ((size + 1) * sizeof *specpdl);
232
  specpdl_size = size;
233
  specpdl = specpdl_ptr = pdlvec + 1;
234
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
235
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
236
  max_lisp_eval_depth = 600;
237 238

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
239 240
}

241 242
static struct handler handlerlist_sentinel;

Andreas Schwab's avatar
Andreas Schwab committed
243
void
244
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
245 246
{
  specpdl_ptr = specpdl;
247 248 249 250 251 252 253 254 255 256
  { /* Put a dummy catcher at top-level so that handlerlist is never NULL.
       This is important since handlerlist->nextfree holds the freelist
       which would otherwise leak every time we unwind back to top-level.   */
    struct handler *c;
    handlerlist = handlerlist_sentinel.nextfree = &handlerlist_sentinel;
    PUSH_HANDLER (c, Qunbound, CATCHER);
    eassert (c == &handlerlist_sentinel);
    handlerlist_sentinel.nextfree = NULL;
    handlerlist_sentinel.next = NULL;
  }
Jim Blandy's avatar
Jim Blandy committed
257 258 259
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
260
#ifdef DEBUG_GCPRO
261
  gcpro_level = 0;
262
#endif
263
  /* This is less than the initial value of num_nonmacro_input_events.  */
264
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
265 266
}

267
/* Unwind-protect function used by call_debugger.  */
268

269
static void
270
restore_stack_limits (Lisp_Object data)
271 272 273 274 275
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
}

276 277
static void grow_specpdl (void);

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

280
Lisp_Object
281
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
282
{
283
  bool debug_while_redisplaying;
284
  ptrdiff_t count = SPECPDL_INDEX ();
285
  Lisp_Object val;
286
  EMACS_INT old_max = max_specpdl_size, old_depth = max_lisp_eval_depth;
287 288 289 290

  if (lisp_eval_depth + 40 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 40;

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  /* While debugging Bug#16603, previous value of 100 was found
     too small to avoid specpdl overflow in the debugger itself.  */
  if (max_specpdl_size - 200 < count)
    max_specpdl_size = count + 200;

  if (old_max == count)
    {
      /* We can enter the debugger due to specpdl overflow (Bug#16603).  */
      specpdl_ptr--;
      grow_specpdl ();
    }

  /* Restore limits after leaving the debugger.  */
  record_unwind_protect (restore_stack_limits,
			 Fcons (make_number (old_max),
				make_number (old_depth)));
307

308
#ifdef HAVE_WINDOW_SYSTEM
309 310
  if (display_hourglass_p)
    cancel_hourglass ();
311 312
#endif

Jim Blandy's avatar
Jim Blandy committed
313
  debug_on_next_call = 0;
314
  when_entered_debugger = num_nonmacro_input_events;
315 316 317 318 319

  /* 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;
320 321
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
322
  specbind (Qinhibit_redisplay, Qnil);
323
  specbind (Qinhibit_debugger, Qt);
324 325 326

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

330 331 332 333
  val = apply1 (Vdebugger, arg);

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

338
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
339 340
}

341
static void
342
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
343 344
{
  debug_on_next_call = 0;
345
  set_backtrace_debug_on_exit (specpdl_ptr - 1, true);
346
  call_debugger (list1 (code));
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350 351 352 353
}

/* 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
354 355 356
       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
357
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
358
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
359
{
360
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
361 362
  struct gcpro gcpro1;

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

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
378
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
379 380
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
381
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
382
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
383
{
384
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
385 386
  struct gcpro gcpro1;

387
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
388

389
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
390
    {
391
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
392
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
393
	break;
394
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399 400 401
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
402
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
403 404 405
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.
406
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
407
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
408
{
409
  Lisp_Object cond;
Jim Blandy's avatar
Jim Blandy committed
410 411 412
  struct gcpro gcpro1;

  GCPRO1 (args);
413
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
414 415
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
416
  if (!NILP (cond))
417 418
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
419 420 421
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
422 423 424 425 426
       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.
Glenn Morris's avatar
Glenn Morris committed
427 428
If a clause has one element, as in (CONDITION), then the cond-form
returns CONDITION's value, if that is non-nil.
Pavel Janík's avatar
Pavel Janík committed
429
If no clause succeeds, cond returns nil.
430
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
431
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
432
{
433
  Lisp_Object val = args;
Jim Blandy's avatar
Jim Blandy committed
434 435 436
  struct gcpro gcpro1;

  GCPRO1 (args);
437
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
438
    {
439
      Lisp_Object clause = XCAR (args);
440
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
441
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
442
	{
443
	  if (!NILP (XCDR (clause)))
444
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
445 446
	  break;
	}
447
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
448 449 450 451 452 453
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
454
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
455
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
456
usage: (progn BODY...)  */)
457
  (Lisp_Object body)
Jim Blandy's avatar
Jim Blandy committed
458
{
459
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
460 461
  struct gcpro gcpro1;

462
  GCPRO1 (body);
Jim Blandy's avatar
Jim Blandy committed
463

464
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
465
    {
466 467
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473
    }

  UNGCPRO;
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
474
/* Evaluate BODY sequentially, discarding its value.  Suitable for
475 476 477 478 479 480 481 482
   record_unwind_protect.  */

void
unwind_body (Lisp_Object body)
{
  Fprogn (body);
}

Jim Blandy's avatar
Jim Blandy committed
483
DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
484
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
485 486
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
487
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
488
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
489 490
{
  Lisp_Object val;
491
  Lisp_Object args_left;
Jim Blandy's avatar
Jim Blandy committed
492 493 494
  struct gcpro gcpro1, gcpro2;

  args_left = args;
495
  val = args;
Jim Blandy's avatar
Jim Blandy committed
496 497
  GCPRO2 (args, val);

498 499 500
  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
501 502 503 504 505 506

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
507
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
508 509 510
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
511
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
512
{
513
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
514

515 516
  GCPRO1 (args);
  eval_sub (XCAR (args));
517 518
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
519 520 521
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
522 523 524 525 526 527 528
       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
529
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
530
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
531
{
532
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
533

534 535 536 537 538 539
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
      struct gcpro gcpro1;
      GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554
      do
	{
	  val = eval_sub (Fcar (XCDR (args_left)));
	  sym = XCAR (args_left);

	  /* Like for eval_sub, we do not check declared_special here since
	     it's been done when let-binding.  */
	  if (!NILP (Vinternal_interpreter_environment) /* Mere optimization!  */
	      && SYMBOLP (sym)
	      && !NILP (lex_binding
			= Fassq (sym, Vinternal_interpreter_environment)))
	    XSETCDR (lex_binding, val); /* SYM is lexically bound.  */
	  else
	    Fset (sym, val);	/* SYM is dynamically bound.  */
Jim Blandy's avatar
Jim Blandy committed
555

556 557 558
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
559

560
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564
    }

  return val;
}
565

Jim Blandy's avatar
Jim Blandy committed
566
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
567
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
568 569 570 571 572 573 574 575
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
576
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
577
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
578
{
579
  if (CONSP (XCDR (args)))
580
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
581
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
582
}
583

Jim Blandy's avatar
Jim Blandy committed
584
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
585 586 587 588
       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
589
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
590
{
591 592
  Lisp_Object quoted = XCAR (args);

593
  if (CONSP (XCDR (args)))
594
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
595 596 597 598 599 600

  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.  */
601 602
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
603 604 605
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
606 607
}

608

609
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
610
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
611
Aliased variables always have the same value; setting one sets the other.
612
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
613 614 615 616
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.
617
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
618
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
619 620
{
  struct Lisp_Symbol *sym;
621

622 623
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
624

625
  sym = XSYMBOL (new_alias);
626 627

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
628 629
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
630 631 632 633 634 635 636 637 638

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

639
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
640 641 642 643
     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)))
644
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
645 646

  {
647
    union specbinding *p;
648

Paul Eggert's avatar
Paul Eggert committed
649
    for (p = specpdl_ptr; p > specpdl; )
650 651
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
652 653 654
	error ("Don't know how to make a let-bound variable an alias");
  }

655
  sym->declared_special = 1;
656
  XSYMBOL (base_variable)->declared_special = 1;
657 658
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
659 660
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
661 662
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
663

664
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
665 666
}

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
static union specbinding *
default_toplevel_binding (Lisp_Object symbol)
{
  union specbinding *binding = NULL;
  union specbinding *pdl = specpdl_ptr;
  while (pdl > specpdl)
    {
      switch ((--pdl)->kind)
	{
	case SPECPDL_LET_DEFAULT:
	case SPECPDL_LET:
	  if (EQ (specpdl_symbol (pdl), symbol))
	    binding = pdl;
	  break;
	}
    }
  return binding;
}

DEFUN ("default-toplevel-value", Fdefault_toplevel_value, Sdefault_toplevel_value, 1, 1, 0,
       doc: /* Return SYMBOL's toplevel default value.
"Toplevel" means outside of any let binding.  */)
  (Lisp_Object symbol)
{
  union specbinding *binding = default_toplevel_binding (symbol);
  Lisp_Object value
    = binding ? specpdl_old_value (binding) : Fdefault_value (symbol);
  if (!EQ (value, Qunbound))
    return value;
  xsignal1 (Qvoid_variable, symbol);
}

DEFUN ("set-default-toplevel-value", Fset_default_toplevel_value,
       Sset_default_toplevel_value, 2, 2, 0,
       doc: /* Set SYMBOL's toplevel default value to VALUE.
"Toplevel" means outside of any let binding.  */)
     (Lisp_Object symbol, Lisp_Object value)
{
  union specbinding *binding = default_toplevel_binding (symbol);
  if (binding)
    set_specpdl_old_value (binding, value);
  else
    Fset_default (symbol, value);
  return Qnil;
}
Gerd Moellmann's avatar
Gerd Moellmann committed
712

Jim Blandy's avatar
Jim Blandy committed
713
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
714
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
715 716 717 718 719 720 721 722 723
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
724
If INITVALUE is missing, SYMBOL's value is not set.
725 726 727 728 729 730 731

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.)
732 733 734 735 736

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

To define a user option, use `defcustom' instead of `defvar'.
737
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
738
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
739
{
740
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
741

742 743
  sym = XCAR (args);
  tail = XCDR (args);
744

745
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
746
    {
747 748 749 750 751
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

752 753
      /* Do it before evaluating the initial value, for self-references.  */
      XSYMBOL (sym)->declared_special = 1;
754

Jim Blandy's avatar
Jim Blandy committed
755
      if (NILP (tem))
756
	Fset_default (sym, eval_sub (XCAR (tail)));
757 758 759
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
760 761
	  union specbinding *binding = default_toplevel_binding (sym);
	  if (binding && EQ (specpdl_old_value (binding), Qunbound))
762
	    {
763
	      set_specpdl_old_value (binding, eval_sub (XCAR (tail)));
764 765
	    }
	}
766
      tail = XCDR (tail);
767 768
      tem = Fcar (tail);
      if (!NILP (tem))
769 770 771 772 773
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
774
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
775
    }
776 777 778 779 780
  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).  */
781 782
    Vinternal_interpreter_environment
      = Fcons (sym, Vinternal_interpreter_environment);
783
  else
784 785 786 787 788
    {
      /* 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
789

Jim Blandy's avatar
Jim Blandy committed
790 791 792 793
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
794
       doc: /* Define SYMBOL as a constant variable.
795 796 797 798 799 800 801 802 803 804 805 806 807
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.
808
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
809
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
810
{
811
  Lisp_Object sym, tem;
Jim Blandy's avatar
Jim Blandy committed
812

813 814
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
815
    error ("Too many arguments");
816

817
  tem = eval_sub (Fcar (XCDR (args)));
818 819 820
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
821
  XSYMBOL (sym)->declared_special = 1;
822
  tem = Fcar (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
823
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
824
    {
Jim Blandy's avatar
Jim Blandy committed
825
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
826 827 828
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
829
  Fput (sym, Qrisky_local_variable, Qt);
830
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
831 832 833
  return sym;
}