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

This file is part of GNU Emacs.

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

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

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


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

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

35 36 37 38
/* #if !BYTE_MARK_STACK */
/* static */
/* #endif */
/* struct catchtag *catchlist; */
Jim Blandy's avatar
Jim Blandy committed
39

40 41 42 43 44 45
/* Chain of condition handlers currently in effect.
   The elements of this chain are contained in the stack frames
   of Fcondition_case and internal_condition_case.
   When an error is signaled (by calling Fsignal, below),
   this chain is searched for an element that applies.  */

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74
Lisp_Object Vrun_hooks;

/* Non-nil means record all fset's and provide's, to be undone
   if the file being autoloaded is not fully loaded.
   They are recorded by being consed onto the front of Vautoload_queue:
75
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
76 77 78

Lisp_Object Vautoload_queue;

79 80
/* Current number of specbindings allocated in specpdl, not counting
   the dummy entry specpdl[-1].  */
81

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

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

Tom Tromey's avatar
Tom Tromey committed
87
/* union specbinding *specpdl; */
Jim Blandy's avatar
Jim Blandy committed
88 89

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

Tom Tromey's avatar
Tom Tromey committed
91
/* union specbinding *specpdl_ptr; */
Jim Blandy's avatar
Jim Blandy committed
92 93

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

95
/* static EMACS_INT lisp_eval_depth; */
Jim Blandy's avatar
Jim Blandy committed
96

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

104
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
105

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

111 112 113 114 115 116
/* 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;

117 118 119 120 121 122 123
/* 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;

124
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
125
static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
126

127
static Lisp_Object
128
specpdl_symbol (union specbinding *pdl)
129 130
{
  eassert (pdl->kind >= SPECPDL_LET);
131
  return pdl->let.symbol;
132 133 134
}

static Lisp_Object
135
specpdl_old_value (union specbinding *pdl)
136 137
{
  eassert (pdl->kind >= SPECPDL_LET);
138
  return pdl->let.old_value;
139 140
}

141 142 143 144 145 146 147
static void
set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
{
  eassert (pdl->kind >= SPECPDL_LET);
  pdl->let.old_value = val;
}

148
static Lisp_Object
149
specpdl_where (union specbinding *pdl)
150 151
{
  eassert (pdl->kind > SPECPDL_LET);
152
  return pdl->let.where;
153 154
}

Tom Tromey's avatar
Tom Tromey committed
155 156 157 158 159 160 161
static Lisp_Object
specpdl_saved_value (union specbinding *pdl)
{
  eassert (pdl->kind >= SPECPDL_LET);
  return pdl->let.saved_value;
}

162
static Lisp_Object
163
specpdl_arg (union specbinding *pdl)
164 165
{
  eassert (pdl->kind == SPECPDL_UNWIND);
166
  return pdl->unwind.arg;
167 168
}

169
Lisp_Object
170
backtrace_function (union specbinding *pdl)
171 172
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
173
  return pdl->bt.function;
174 175 176
}

static ptrdiff_t
177
backtrace_nargs (union specbinding *pdl)
178 179
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
180
  return pdl->bt.nargs;
181 182
}

183
Lisp_Object *
184
backtrace_args (union specbinding *pdl)
185 186
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
187
  return pdl->bt.args;
188 189 190
}

static bool
191
backtrace_debug_on_exit (union specbinding *pdl)
192 193
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
194
  return pdl->bt.debug_on_exit;
195 196
}

197
/* Functions to modify slots of backtrace records.  */
198

199
static void
200 201 202 203 204
set_backtrace_args (union specbinding *pdl, Lisp_Object *args)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
}
205

206
static void
207 208 209 210 211
set_backtrace_nargs (union specbinding *pdl, ptrdiff_t n)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.nargs = n;
}
212

213
static void
214 215 216 217 218
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
219 220 221

/* Helper functions to scan the backtrace.  */

222 223
bool
backtrace_p (union specbinding *pdl)
224
{ return pdl >= specpdl; }
225

226
union specbinding *
227
backtrace_top (void)
228
{
229
  union specbinding *pdl = specpdl_ptr - 1;
230
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
231 232
    pdl--;
  return pdl;
233 234
}

235 236
union specbinding *
backtrace_next (union specbinding *pdl)
Tom Tromey's avatar
Tom Tromey committed
237
{
238 239 240 241
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
Tom Tromey's avatar
Tom Tromey committed
242 243
}

244

Andreas Schwab's avatar
Andreas Schwab committed
245
void
246
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
247
{
248
  enum { size = 50 };
249
  union specbinding *pdlvec = xmalloc ((size + 1) * sizeof *specpdl);
250
  specpdl_size = size;
251
  specpdl = specpdl_ptr = pdlvec + 1;
252
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
253
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
254
  max_lisp_eval_depth = 600;
255 256

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
257 258
}

Andreas Schwab's avatar
Andreas Schwab committed
259
void
260
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264 265 266 267
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
268
#ifdef DEBUG_GCPRO
269
  gcpro_level = 0;
270
#endif
271
  /* This is less than the initial value of num_nonmacro_input_events.  */
272
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
273 274
}

275 276 277 278 279 280 281 282 283 284 285 286 287
#if (GC_MARK_STACK == GC_MAKE_GCPROS_NOOPS \
     || GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS)
void
mark_catchlist (struct catchtag *catch)
{
  for (; catch; catch = catch->next)
    {
      mark_object (catch->tag);
      mark_object (catch->val);
    }
}
#endif

288
/* Unwind-protect function used by call_debugger.  */
289

290
static void
291
restore_stack_limits (Lisp_Object data)
292 293 294 295 296 297 298
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
}

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

299
Lisp_Object
300
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
301
{
302
  bool debug_while_redisplaying;
303
  ptrdiff_t count = SPECPDL_INDEX ();
304
  Lisp_Object val;
305
  EMACS_INT old_max = max_specpdl_size;
306

307 308
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
309

310 311 312 313 314 315 316 317 318
  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;

319
  if (max_specpdl_size - 100 < SPECPDL_INDEX ())
320
    max_specpdl_size = SPECPDL_INDEX () + 100;
321

322
#ifdef HAVE_WINDOW_SYSTEM
323 324
  if (display_hourglass_p)
    cancel_hourglass ();
325 326
#endif

Jim Blandy's avatar
Jim Blandy committed
327
  debug_on_next_call = 0;
328
  when_entered_debugger = num_nonmacro_input_events;
329 330 331 332 333

  /* 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;
334 335
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
336
  specbind (Qinhibit_redisplay, Qnil);
337
  specbind (Qinhibit_debugger, Qt);
338 339 340

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

344 345 346 347
  val = apply1 (Vdebugger, arg);

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

352
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
353 354
}

355
static void
356
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
357 358
{
  debug_on_next_call = 0;
359
  set_backtrace_debug_on_exit (specpdl_ptr - 1, true);
360
  call_debugger (list1 (code));
Jim Blandy's avatar
Jim Blandy committed
361 362 363 364 365 366 367
}

/* 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
368 369 370
       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
371
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
372
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
373
{
374
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
375 376
  struct gcpro gcpro1;

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

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
392
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
393 394
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
395
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
397
{
398
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
399 400
  struct gcpro gcpro1;

401
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
402

403
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
404
    {
405
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
406
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
407
	break;
408
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
409 410 411 412 413 414 415
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
416
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
417 418 419
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.
420
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
421
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
422
{
423
  Lisp_Object cond;
Jim Blandy's avatar
Jim Blandy committed
424 425 426
  struct gcpro gcpro1;

  GCPRO1 (args);
427
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
428 429
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
430
  if (!NILP (cond))
431 432
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
433 434 435
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
436 437 438 439 440 441 442 443
       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.
444
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
445
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
446
{
447
  Lisp_Object val = args;
Jim Blandy's avatar
Jim Blandy committed
448 449 450
  struct gcpro gcpro1;

  GCPRO1 (args);
451
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
452
    {
453
      Lisp_Object clause = XCAR (args);
454
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
455
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
456
	{
457
	  if (!NILP (XCDR (clause)))
458
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
459 460
	  break;
	}
461
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
462 463 464 465 466 467
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
468
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
469
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
470
usage: (progn BODY...)  */)
471
  (Lisp_Object body)
Jim Blandy's avatar
Jim Blandy committed
472
{
473
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
474 475
  struct gcpro gcpro1;

476
  GCPRO1 (body);
Jim Blandy's avatar
Jim Blandy committed
477

478
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
479
    {
480 481
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
482 483 484 485 486 487
    }

  UNGCPRO;
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
488
/* Evaluate BODY sequentially, discarding its value.  Suitable for
489 490 491 492 493 494 495 496
   record_unwind_protect.  */

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

Jim Blandy's avatar
Jim Blandy committed
497
DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
498
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
499 500
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
501
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
502
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
503 504
{
  Lisp_Object val;
505
  Lisp_Object args_left;
Jim Blandy's avatar
Jim Blandy committed
506 507 508
  struct gcpro gcpro1, gcpro2;

  args_left = args;
509
  val = args;
Jim Blandy's avatar
Jim Blandy committed
510 511
  GCPRO2 (args, val);

512 513 514
  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
515 516 517 518 519 520

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
521
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
522 523 524
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
525
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
526
{
527
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
528

529 530
  GCPRO1 (args);
  eval_sub (XCAR (args));
531 532
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
533 534 535
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
536 537 538 539 540 541 542
       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
543
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
544
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
545
{
546
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
547

548 549
  val = args;
  if (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
550
    {
551 552 553
      Lisp_Object args_left = args;
      struct gcpro gcpro1;
      GCPRO1 (args);
554

555 556 557 558 559 560 561 562 563 564 565 566 567 568
      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
569

570 571 572
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
573

574
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
575 576 577 578
    }

  return val;
}
579

Jim Blandy's avatar
Jim Blandy committed
580
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
581
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
582 583 584 585 586 587 588 589
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
590
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
591
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
592
{
593
  if (CONSP (XCDR (args)))
594
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
595
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
596
}
597

Jim Blandy's avatar
Jim Blandy committed
598
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
599 600 601 602
       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
603
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
604
{
605 606
  Lisp_Object quoted = XCAR (args);

607
  if (CONSP (XCDR (args)))
608
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
609 610 611 612 613 614

  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.  */
615 616
    return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				   XCDR (quoted)));
617 618 619
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
620 621
}

622

623
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
624
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
625
Aliased variables always have the same value; setting one sets the other.
626
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
627 628 629 630
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.
631
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
632
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
633 634
{
  struct Lisp_Symbol *sym;
635

636 637
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
638

639
  sym = XSYMBOL (new_alias);
640 641

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
642 643
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
644 645 646 647 648 649 650 651 652

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

653
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
654 655 656 657
     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)))
658
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
659 660

  {
661
    union specbinding *p;
662

Paul Eggert's avatar
Paul Eggert committed
663
    for (p = specpdl_ptr; p > specpdl; )
664 665
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
666 667 668
	error ("Don't know how to make a let-bound variable an alias");
  }

669
  sym->declared_special = 1;
670
  XSYMBOL (base_variable)->declared_special = 1;
671 672
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
673 674
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
675 676
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
677

678
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
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 712 713 714 715 716 717 718 719 720 721 722 723 724 725
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
726

Jim Blandy's avatar
Jim Blandy committed
727
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
728
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
729 730 731 732 733 734 735 736 737
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
738
If INITVALUE is missing, SYMBOL's value is not set.
739 740 741 742 743 744 745

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.)
746 747 748 749 750

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

To define a user option, use `defcustom' instead of `defvar'.
751
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
752
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
753
{
754
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
755

756 757
  sym = XCAR (args);
  tail = XCDR (args);
758

759
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
760
    {
761 762 763 764 765
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

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

Jim Blandy's avatar
Jim Blandy committed
769
      if (NILP (tem))
770
	Fset_default (sym, eval_sub (XCAR (tail)));
771 772 773
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
774 775
	  union specbinding *binding = default_toplevel_binding (sym);
	  if (binding && EQ (specpdl_old_value (binding), Qunbound))
776
	    {
777
	      set_specpdl_old_value (binding, eval_sub (XCAR (tail)));
778 779
	    }
	}
780
      tail = XCDR (tail);
781 782
      tem = Fcar (tail);
      if (!NILP (tem))
783 784 785 786 787
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
788
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
789
    }
790 791 792 793 794
  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).  */
795 796
    Vinternal_interpreter_environment
      = Fcons (sym, Vinternal_interpreter_environment);
797
  else
798 799 800 801 802
    {
      /* 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
803

Jim Blandy's avatar
Jim Blandy committed
804 805 806 807
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
808
       doc: /* Define SYMBOL as a constant variable.
809 810 811 812 813 814 815 816 817 818 819 820 821
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.
822
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
823
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
824
{
825
  Lisp_Object sym, tem;
Jim Blandy's avatar
Jim Blandy committed
826

827 828
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
829
    error ("Too many arguments");
830

831
  tem = eval_sub (Fcar (XCDR (args)));
832 833 834
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
835
  XSYMBOL (sym)->declared_special = 1;
836
  tem = Fcar (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
837
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
838
    {
Jim Blandy's avatar
Jim Blandy committed
839
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed