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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1993-1995, 1999-2016 Free Software Foundation,
4
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 "buffer.h"
31

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

struct handler *handlerlist;

Jim Blandy's avatar
Jim Blandy committed
36 37 38
/* 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:
39
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
40 41 42

Lisp_Object Vautoload_queue;

43 44 45 46 47
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
Lisp_Object Vrun_hooks;

48 49
/* Current number of specbindings allocated in specpdl, not counting
   the dummy entry specpdl[-1].  */
50

51
ptrdiff_t specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
52

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

56
union specbinding *specpdl;
Jim Blandy's avatar
Jim Blandy committed
57 58

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

60
union specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
61 62

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

64
static EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
65

66
/* The value of num_nonmacro_input_events as of the last time we
67
   started to enter the debugger.  If we decide to enter the debugger
68
   again when this is still equal to num_nonmacro_input_events, then we
69 70 71
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
72

73
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
74

75 76
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */
77
/* FIXME: We should probably get rid of this!  */
78 79
Lisp_Object Vsignaling_function;

80 81
/* If non-nil, Lisp code must not be run since some part of Emacs is in
   an inconsistent state.  Currently unused.  */
82 83
Lisp_Object inhibit_lisp_code;

84 85 86 87 88 89 90
/* 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;

91
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
92
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, ptrdiff_t);
Paul Pogonyshev's avatar
Paul Pogonyshev committed
93
static Lisp_Object lambda_arity (Lisp_Object);
94

95
static Lisp_Object
96
specpdl_symbol (union specbinding *pdl)
97 98
{
  eassert (pdl->kind >= SPECPDL_LET);
99
  return pdl->let.symbol;
100 101 102
}

static Lisp_Object
103
specpdl_old_value (union specbinding *pdl)
104 105
{
  eassert (pdl->kind >= SPECPDL_LET);
106
  return pdl->let.old_value;
107 108
}

109 110 111 112 113 114 115
static void
set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
{
  eassert (pdl->kind >= SPECPDL_LET);
  pdl->let.old_value = val;
}

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

static Lisp_Object
124
specpdl_arg (union specbinding *pdl)
125 126
{
  eassert (pdl->kind == SPECPDL_UNWIND);
127
  return pdl->unwind.arg;
128 129
}

130
Lisp_Object
131
backtrace_function (union specbinding *pdl)
132 133
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
134
  return pdl->bt.function;
135 136 137
}

static ptrdiff_t
138
backtrace_nargs (union specbinding *pdl)
139 140
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
141
  return pdl->bt.nargs;
142 143
}

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

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

158
/* Functions to modify slots of backtrace records.  */
159

160
static void
161
set_backtrace_args (union specbinding *pdl, Lisp_Object *args, ptrdiff_t nargs)
162 163 164
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
165
  pdl->bt.nargs = nargs;
166
}
167

168
static void
169 170 171 172 173
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
174 175 176

/* Helper functions to scan the backtrace.  */

177 178
bool
backtrace_p (union specbinding *pdl)
179
{ return pdl >= specpdl; }
180

181
union specbinding *
182
backtrace_top (void)
183
{
184
  union specbinding *pdl = specpdl_ptr - 1;
185
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
186 187
    pdl--;
  return pdl;
188
}
189

190 191
union specbinding *
backtrace_next (union specbinding *pdl)
192
{
193 194 195 196
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
197 198
}

199 200 201 202 203 204
/* Return a pointer to somewhere near the top of the C stack.  */
void *
near_C_stack_top (void)
{
  return backtrace_args (backtrace_top ());
}
205

Andreas Schwab's avatar
Andreas Schwab committed
206
void
207
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
208
{
209
  enum { size = 50 };
210
  union specbinding *pdlvec = xmalloc ((size + 1) * sizeof *specpdl);
211
  specpdl_size = size;
212
  specpdl = specpdl_ptr = pdlvec + 1;
213
  /* Don't forget to update docs (lispref node "Local Variables").  */
Stefan Monnier's avatar
Stefan Monnier committed
214
  max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el.  */
215
  max_lisp_eval_depth = 800;
216 217

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
218 219
}

220 221
static struct handler handlerlist_sentinel;

Andreas Schwab's avatar
Andreas Schwab committed
222
void
223
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
224
{
225
  byte_stack_list = 0;
Jim Blandy's avatar
Jim Blandy committed
226
  specpdl_ptr = specpdl;
227 228 229 230
  { /* 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.   */
    handlerlist = handlerlist_sentinel.nextfree = &handlerlist_sentinel;
231
    struct handler *c = push_handler (Qunbound, CATCHER);
232 233 234 235
    eassert (c == &handlerlist_sentinel);
    handlerlist_sentinel.nextfree = NULL;
    handlerlist_sentinel.next = NULL;
  }
Jim Blandy's avatar
Jim Blandy committed
236 237 238
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
239
  /* This is less than the initial value of num_nonmacro_input_events.  */
240
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
241 242
}

243
/* Unwind-protect function used by call_debugger.  */
244

245
static void
246
restore_stack_limits (Lisp_Object data)
247 248 249 250 251
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
}

252 253
static void grow_specpdl (void);

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

256
Lisp_Object
257
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
258
{
259
  bool debug_while_redisplaying;
260
  ptrdiff_t count = SPECPDL_INDEX ();
261
  Lisp_Object val;
262 263 264
  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);
265 266 267 268

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

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
  /* 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)));
285

286
#ifdef HAVE_WINDOW_SYSTEM
287 288
  if (display_hourglass_p)
    cancel_hourglass ();
289 290
#endif

Jim Blandy's avatar
Jim Blandy committed
291
  debug_on_next_call = 0;
292
  when_entered_debugger = num_nonmacro_input_events;
293 294 295 296 297

  /* 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;
298 299
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
300
  specbind (Qinhibit_redisplay, Qnil);
301
  specbind (Qinhibit_debugger, Qt);
302 303 304

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

308 309 310 311
  val = apply1 (Vdebugger, arg);

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

316
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
317 318
}

319
static void
320
do_debug_on_call (Lisp_Object code, ptrdiff_t count)
Jim Blandy's avatar
Jim Blandy committed
321 322
{
  debug_on_next_call = 0;
323
  set_backtrace_debug_on_exit (specpdl + count, true);
324
  call_debugger (list1 (code));
Jim Blandy's avatar
Jim Blandy committed
325 326 327 328 329 330 331
}

/* 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
332 333 334
       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
335
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
336
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
337
{
338
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
339

340
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
341
    {
342
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
343
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
344
	break;
345
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351
    }

  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
352
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
353 354
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
355
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
356
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
357
{
358
  Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
359

360
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
361
    {
362
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
363
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
364
	break;
365
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369 370 371
    }

  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
372
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
373 374 375
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.
376
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
377
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
378
{
379
  Lisp_Object cond;
Jim Blandy's avatar
Jim Blandy committed
380

381
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
382

Jim Blandy's avatar
Jim Blandy committed
383
  if (!NILP (cond))
384 385
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
386 387 388
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
389 390 391 392 393
       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
394 395
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
396
If no clause succeeds, cond returns nil.
397
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
398
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
399
{
400
  Lisp_Object val = args;
Jim Blandy's avatar
Jim Blandy committed
401

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

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
418
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
419
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
420
usage: (progn BODY...)  */)
421
  (Lisp_Object body)
Jim Blandy's avatar
Jim Blandy committed
422
{
423
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
424

425
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
426
    {
427 428
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433
    }

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
434
/* Evaluate BODY sequentially, discarding its value.  Suitable for
435 436 437 438 439 440 441 442
   record_unwind_protect.  */

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

Jim Blandy's avatar
Jim Blandy committed
443
DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
444
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
445 446
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
447
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
448
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
449 450
{
  Lisp_Object val;
451
  Lisp_Object args_left;
Jim Blandy's avatar
Jim Blandy committed
452 453

  args_left = args;
454
  val = args;
Jim Blandy's avatar
Jim Blandy committed
455

456 457 458
  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
459 460 461 462 463

  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
464
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
465 466 467
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
468
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
469
{
470
  eval_sub (XCAR (args));
471
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
472 473 474
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
475 476 477 478 479 480 481
       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
482
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
483
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
484
{
485
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
486

487 488 489 490
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
491 492 493 494
      Lisp_Object numargs = Flength (args);

      if (XINT (numargs) & 1)
        xsignal2 (Qwrong_number_of_arguments, Qsetq, numargs);
Jim Blandy's avatar
Jim Blandy committed
495

496 497 498 499 500 501 502 503 504 505 506 507 508 509
      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
510

511 512 513
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
514 515 516 517
    }

  return val;
}
518

Jim Blandy's avatar
Jim Blandy committed
519
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
520
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
521 522 523
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').
524
This means that \\='(a . b) is not identical to (cons \\='a \\='b): the former
525 526 527 528
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
529
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
530
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
531
{
532
  if (CONSP (XCDR (args)))
533
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
534
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
535
}
536

Jim Blandy's avatar
Jim Blandy committed
537
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
538 539 540 541
       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
542
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
543
{
544 545
  Lisp_Object quoted = XCAR (args);

546
  if (CONSP (XCDR (args)))
547
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
548 549 550 551

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
    { /* This is a lambda expression within a lexical environment;
	 return an interpreted closure instead of a simple lambda.  */
      Lisp_Object cdr = XCDR (quoted);
      Lisp_Object tmp = cdr;
      if (CONSP (tmp)
	  && (tmp = XCDR (tmp), CONSP (tmp))
	  && (tmp = XCAR (tmp), CONSP (tmp))
	  && (EQ (QCdocumentation, XCAR (tmp))))
	{ /* Handle the special (:documentation <form>) to build the docstring
	     dynamically.  */
	  Lisp_Object docstring = eval_sub (Fcar (XCDR (tmp)));
	  CHECK_STRING (docstring);
	  cdr = Fcons (XCAR (cdr), Fcons (docstring, XCDR (XCDR (cdr))));
	}
      return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
				     cdr));
    }
569 570 571
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
572 573
}

574

575
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
576
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
577
Aliased variables always have the same value; setting one sets the other.
578
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
579 580 581 582
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.
583
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
584
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
585 586
{
  struct Lisp_Symbol *sym;
587

588 589
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
590

591
  sym = XSYMBOL (new_alias);
592 593

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
594 595
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
596 597 598 599 600 601 602

  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");
603 604 605 606 607
    case SYMBOL_PLAINVAL:
    case SYMBOL_VARALIAS:
      break;
    default:
      emacs_abort ();
608 609
    }

610
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
611 612 613 614
     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)))
615
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
616 617

  {
618
    union specbinding *p;
619

Paul Eggert's avatar
Paul Eggert committed
620
    for (p = specpdl_ptr; p > specpdl; )
621 622
      if ((--p)->kind >= SPECPDL_LET
	  && (EQ (new_alias, specpdl_symbol (p))))
623 624 625
	error ("Don't know how to make a let-bound variable an alias");
  }

626
  sym->declared_special = 1;
627
  XSYMBOL (base_variable)->declared_special = 1;
628 629
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
630 631
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
632 633
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
634

635
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
636 637
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651
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;
652 653 654 655 656 657 658 659 660 661 662

	case SPECPDL_UNWIND:
	case SPECPDL_UNWIND_PTR:
	case SPECPDL_UNWIND_INT:
	case SPECPDL_UNWIND_VOID:
	case SPECPDL_BACKTRACE:
	case SPECPDL_LET_LOCAL:
	  break;

	default:
	  emacs_abort ();
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
	}
    }
  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
694

Jim Blandy's avatar
Jim Blandy committed
695
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
696
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
697 698 699 700 701 702 703 704 705
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
706
If INITVALUE is missing, SYMBOL's value is not set.
707 708 709 710 711

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
712
for these variables.  (`defconst' and `defcustom' behave similarly in
713
this respect.)
714 715 716 717 718

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

To define a user option, use `defcustom' instead of `defvar'.
719
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
720
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
721
{
722
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
723

724 725
  sym = XCAR (args);
  tail = XCDR (args);
726

727
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
728
    {
729 730 731 732 733
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
772 773 774 775
  return sym;
}

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

795 796
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
797
    error ("Too many arguments");
798

799
  tem = eval_sub (Fcar (XCDR (args)));
800 801 802
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
803
  XSYMBOL (sym)->declared_special = 1;
804
  tem = Fcar (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
805
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
806
    {
Jim Blandy's avatar
Jim Blandy committed
807
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
808 809 810
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
811
  Fput (sym, Qrisky_local_variable, Qt);
812
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
813 814 815
  return sym;
}

816 817 818 819 820 821 822 823 824 825 826
/* Make SYMBOL lexically scoped.  */
DEFUN ("internal-make-var-non-special", Fmake_var_non_special,
       Smake_var_non_special, 1, 1, 0,
       doc: /* Internal function.  */)
     (Lisp_Object symbol)
{
  CHECK_SYMBOL (symbol);
  XSYMBOL (symbol)->declared_special = 0;
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
827 828

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
829 830 831 832 833
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
Each VALUEFORM can refer to the symbols already bound by this VARLIST.
834
usage: (let* VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
835
  (Lisp_Object args)