eval.c 111 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

31
/* Chain of condition and catch handlers currently in effect.  */
32 33 34

struct handler *handlerlist;

35 36 37 38 39
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

40
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp;
41
Lisp_Object Qinhibit_quit;
42 43
Lisp_Object Qand_rest;
static Lisp_Object Qand_optional;
44
static Lisp_Object Qinhibit_debugger;
45
static Lisp_Object Qdeclare;
46 47
Lisp_Object Qinternal_interpreter_environment, Qclosure;

Paul Eggert's avatar
Paul Eggert committed
48
static Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
49

50 51 52
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
53

Jim Blandy's avatar
Jim Blandy committed
54 55 56 57 58
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:
59
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
60 61 62

Lisp_Object Vautoload_queue;

63 64
/* Current number of specbindings allocated in specpdl, not counting
   the dummy entry specpdl[-1].  */
65

66
ptrdiff_t specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
67

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

71
union specbinding *specpdl;
Jim Blandy's avatar
Jim Blandy committed
72 73

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

75
union specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
76 77

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

79
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
80

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

88
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
89

90 91
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */
92
/* FIXME: We should probably get rid of this!  */
93 94
Lisp_Object Vsignaling_function;

95 96
/* If non-nil, Lisp code must not be run since some part of Emacs is in
   an inconsistent state.  Currently unused.  */
97 98
Lisp_Object inhibit_lisp_code;

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

106
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
107
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, ptrdiff_t);
108

109
static Lisp_Object
110
specpdl_symbol (union specbinding *pdl)
111 112
{
  eassert (pdl->kind >= SPECPDL_LET);
113
  return pdl->let.symbol;
114 115 116
}

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

123 124 125 126 127 128 129
static void
set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
{
  eassert (pdl->kind >= SPECPDL_LET);
  pdl->let.old_value = val;
}

130
static Lisp_Object
131
specpdl_where (union specbinding *pdl)
132 133
{
  eassert (pdl->kind > SPECPDL_LET);
134
  return pdl->let.where;
135 136 137
}

static Lisp_Object
138
specpdl_arg (union specbinding *pdl)
139 140
{
  eassert (pdl->kind == SPECPDL_UNWIND);
141
  return pdl->unwind.arg;
142 143
}

144
Lisp_Object
145
backtrace_function (union specbinding *pdl)
146 147
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
148
  return pdl->bt.function;
149 150 151
}

static ptrdiff_t
152
backtrace_nargs (union specbinding *pdl)
153 154
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
155
  return pdl->bt.nargs;
156 157
}

158
Lisp_Object *
159
backtrace_args (union specbinding *pdl)
160 161
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
162
  return pdl->bt.args;
163 164 165
}

static bool
166
backtrace_debug_on_exit (union specbinding *pdl)
167 168
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
169
  return pdl->bt.debug_on_exit;
170 171
}

172
/* Functions to modify slots of backtrace records.  */
173

174
static void
175
set_backtrace_args (union specbinding *pdl, Lisp_Object *args, ptrdiff_t nargs)
176 177 178
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
179
  pdl->bt.nargs = nargs;
180
}
181

182
static void
183 184 185 186 187
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
188 189 190

/* Helper functions to scan the backtrace.  */

191 192
bool
backtrace_p (union specbinding *pdl)
193
{ return pdl >= specpdl; }
194

195
union specbinding *
196
backtrace_top (void)
197
{
198
  union specbinding *pdl = specpdl_ptr - 1;
199
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
200 201
    pdl--;
  return pdl;
202
}
203

204 205
union specbinding *
backtrace_next (union specbinding *pdl)
206
{
207 208 209 210
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
211 212
}

213

Andreas Schwab's avatar
Andreas Schwab committed
214
void
215
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
216
{
217
  enum { size = 50 };
218
  union specbinding *pdlvec = xmalloc ((size + 1) * sizeof *specpdl);
219
  specpdl_size = size;
220
  specpdl = specpdl_ptr = pdlvec + 1;
221
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
222
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
223
  max_lisp_eval_depth = 600;
224 225

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
226 227
}

228 229
static struct handler handlerlist_sentinel;

Andreas Schwab's avatar
Andreas Schwab committed
230
void
231
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
232 233
{
  specpdl_ptr = specpdl;
234 235 236 237 238 239 240 241 242 243
  { /* 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
244 245 246
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
247
#ifdef DEBUG_GCPRO
248
  gcpro_level = 0;
249
#endif
250
  /* This is less than the initial value of num_nonmacro_input_events.  */
251
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
252 253
}

254
/* Unwind-protect function used by call_debugger.  */
255

256
static void
257
restore_stack_limits (Lisp_Object data)
258 259 260 261 262
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
}

263 264
static void grow_specpdl (void);

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

267
Lisp_Object
268
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
269
{
270
  bool debug_while_redisplaying;
271
  ptrdiff_t count = SPECPDL_INDEX ();
272
  Lisp_Object val;
273 274 275
  EMACS_INT old_depth = max_lisp_eval_depth;
  /* Do not allow max_specpdl_size less than actual depth (Bug#16603).  */
  EMACS_INT old_max = max (max_specpdl_size, count);
276 277 278 279

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

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
  /* 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)));
296

297
#ifdef HAVE_WINDOW_SYSTEM
298 299
  if (display_hourglass_p)
    cancel_hourglass ();
300 301
#endif

Jim Blandy's avatar
Jim Blandy committed
302
  debug_on_next_call = 0;
303
  when_entered_debugger = num_nonmacro_input_events;
304 305 306 307 308

  /* 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;
309 310
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
311
  specbind (Qinhibit_redisplay, Qnil);
312
  specbind (Qinhibit_debugger, Qt);
313 314 315

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

319 320 321 322
  val = apply1 (Vdebugger, arg);

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

327
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
328 329
}

330
static void
331
do_debug_on_call (Lisp_Object code, ptrdiff_t count)
Jim Blandy's avatar
Jim Blandy committed
332 333
{
  debug_on_next_call = 0;
334
  set_backtrace_debug_on_exit (specpdl + count, true);
335
  call_debugger (list1 (code));
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342
}

/* 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
343 344 345
       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
346
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
347
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
348
{
349
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
350 351
  struct gcpro gcpro1;

352
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
353

354
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
355
    {
356
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
357
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
358
	break;
359
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364 365 366
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
367
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
368 369
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
370
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
371
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
372
{
373
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
374 375
  struct gcpro gcpro1;

376
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
377

378
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
379
    {
380
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
381
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
382
	break;
383
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388 389 390
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
391
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
392 393 394
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.
395
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
397
{
398
  Lisp_Object cond;
Jim Blandy's avatar
Jim Blandy committed
399 400 401
  struct gcpro gcpro1;

  GCPRO1 (args);
402
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
403 404
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
405
  if (!NILP (cond))
406 407
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
408 409 410
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
411 412 413 414 415
       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
416 417
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
418
If no clause succeeds, cond returns nil.
419
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
420
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
421
{
422
  Lisp_Object val = args;
Jim Blandy's avatar
Jim Blandy committed
423 424 425
  struct gcpro gcpro1;

  GCPRO1 (args);
426
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
427
    {
428
      Lisp_Object clause = XCAR (args);
429
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
430
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
431
	{
432
	  if (!NILP (XCDR (clause)))
433
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
434 435
	  break;
	}
436
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440 441 442
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
443
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
444
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
445
usage: (progn BODY...)  */)
446
  (Lisp_Object body)
Jim Blandy's avatar
Jim Blandy committed
447
{
448
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
449 450
  struct gcpro gcpro1;

451
  GCPRO1 (body);
Jim Blandy's avatar
Jim Blandy committed
452

453
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
454
    {
455 456
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462
    }

  UNGCPRO;
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
463
/* Evaluate BODY sequentially, discarding its value.  Suitable for
464 465 466 467 468 469 470 471
   record_unwind_protect.  */

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

Jim Blandy's avatar
Jim Blandy committed
472
DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
473
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
474 475
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
476
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
477
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
478 479
{
  Lisp_Object val;
480
  Lisp_Object args_left;
Jim Blandy's avatar
Jim Blandy committed
481 482 483
  struct gcpro gcpro1, gcpro2;

  args_left = args;
484
  val = args;
Jim Blandy's avatar
Jim Blandy committed
485 486
  GCPRO2 (args, val);

487 488 489
  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
490 491 492 493 494 495

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
496
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
497 498 499
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
500
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
501
{
502
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
503

504 505
  GCPRO1 (args);
  eval_sub (XCAR (args));
506 507
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
508 509 510
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
511 512 513 514 515 516 517
       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
518
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
519
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
520
{
521
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
522

523 524 525 526 527 528
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
      struct gcpro gcpro1;
      GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
529

530 531 532 533 534 535 536 537 538 539 540 541 542 543
      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
544

545 546 547
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
548

549
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
550 551 552 553
    }

  return val;
}
554

Jim Blandy's avatar
Jim Blandy committed
555
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
556
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
557 558 559 560 561 562 563 564
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
565
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
566
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
567
{
568
  if (CONSP (XCDR (args)))
569
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
570
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
571
}
572

Jim Blandy's avatar
Jim Blandy committed
573
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
574 575 576 577
       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
578
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
579
{
580 581
  Lisp_Object quoted = XCAR (args);

582
  if (CONSP (XCDR (args)))
583
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
584 585 586 587 588 589

  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.  */
590 591
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
592 593 594
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
595 596
}

597

598
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
599
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
600
Aliased variables always have the same value; setting one sets the other.
601
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
602 603 604 605
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.
606
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
607
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
608 609
{
  struct Lisp_Symbol *sym;
610

611 612
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
613

614
  sym = XSYMBOL (new_alias);
615 616

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
617 618
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
619 620 621 622 623 624 625 626 627

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

628
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
629 630 631 632
     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)))
633
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
634 635

  {
636
    union specbinding *p;
637

Paul Eggert's avatar
Paul Eggert committed
638
    for (p = specpdl_ptr; p > specpdl; )
639 640
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
641 642 643
	error ("Don't know how to make a let-bound variable an alias");
  }

644
  sym->declared_special = 1;
645
  XSYMBOL (base_variable)->declared_special = 1;
646 647
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
648 649
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
650 651
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
652

653
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
654 655
}

656 657 658 659 660 661 662 663 664 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
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
701

Jim Blandy's avatar
Jim Blandy committed
702
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
703
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
704 705 706 707 708 709 710 711 712
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
713
If INITVALUE is missing, SYMBOL's value is not set.
714 715 716 717 718 719 720

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.)
721 722 723 724 725

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

To define a user option, use `defcustom' instead of `defvar'.
726
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
727
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
728
{
729
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
730

731 732
  sym = XCAR (args);
  tail = XCDR (args);
733

734
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
735
    {
736 737 738 739 740
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
779 780 781 782
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
783
       doc: /* Define SYMBOL as a constant variable.
784 785 786 787 788 789 790 791 792 793 794 795 796
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.
797
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
798
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
799
{
800
  Lisp_Object sym, tem;
Jim Blandy's avatar
Jim Blandy committed
801

802 803
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
804
    error ("Too many arguments");
805

806
  tem = eval_sub (Fcar (XCDR (args)));
807 808 809
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
810
  XSYMBOL (sym)->declared_special = 1;
811
  tem = Fcar (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
812
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
813
    {
Jim Blandy's avatar
Jim Blandy committed
814
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
815 816 817
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
818
  Fput (sym, Qrisky_local_variable, Qt);
819
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
820 821 822
  return sym;
}

823 824 825 826 827 828 829 830 831 832 833
/* 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)