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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1993-1995, 1999-2015 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;

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

Jim Blandy's avatar
Jim Blandy committed
41 42 43
/* 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:
44
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
45 46 47

Lisp_Object Vautoload_queue;

48 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.  */
Lisp_Object Vrun_hooks;

53 54
/* Current number of specbindings allocated in specpdl, not counting
   the dummy entry specpdl[-1].  */
55

56
ptrdiff_t specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
57

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

61
union specbinding *specpdl;
Jim Blandy's avatar
Jim Blandy committed
62 63

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

65
union specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
66 67

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

69
EMACS_INT lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
70

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

78
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
79

80 81
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */
82
/* FIXME: We should probably get rid of this!  */
83 84
Lisp_Object Vsignaling_function;

85 86
/* If non-nil, Lisp code must not be run since some part of Emacs is in
   an inconsistent state.  Currently unused.  */
87 88
Lisp_Object inhibit_lisp_code;

89 90 91 92 93 94 95
/* 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;

96
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
97
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, ptrdiff_t);
98

99
static Lisp_Object
100
specpdl_symbol (union specbinding *pdl)
101 102
{
  eassert (pdl->kind >= SPECPDL_LET);
103
  return pdl->let.symbol;
104 105 106
}

static Lisp_Object
107
specpdl_old_value (union specbinding *pdl)
108 109
{
  eassert (pdl->kind >= SPECPDL_LET);
110
  return pdl->let.old_value;
111 112
}

113 114 115 116 117 118 119
static void
set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
{
  eassert (pdl->kind >= SPECPDL_LET);
  pdl->let.old_value = val;
}

120
static Lisp_Object
121
specpdl_where (union specbinding *pdl)
122 123
{
  eassert (pdl->kind > SPECPDL_LET);
124
  return pdl->let.where;
125 126 127
}

static Lisp_Object
128
specpdl_arg (union specbinding *pdl)
129 130
{
  eassert (pdl->kind == SPECPDL_UNWIND);
131
  return pdl->unwind.arg;
132 133
}

134
Lisp_Object
135
backtrace_function (union specbinding *pdl)
136 137
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
138
  return pdl->bt.function;
139 140 141
}

static ptrdiff_t
142
backtrace_nargs (union specbinding *pdl)
143 144
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
145
  return pdl->bt.nargs;
146 147
}

148
Lisp_Object *
149
backtrace_args (union specbinding *pdl)
150 151
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
152
  return pdl->bt.args;
153 154 155
}

static bool
156
backtrace_debug_on_exit (union specbinding *pdl)
157 158
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
159
  return pdl->bt.debug_on_exit;
160 161
}

162
/* Functions to modify slots of backtrace records.  */
163

164
static void
165
set_backtrace_args (union specbinding *pdl, Lisp_Object *args, ptrdiff_t nargs)
166 167 168
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
169
  pdl->bt.nargs = nargs;
170
}
171

172
static void
173 174 175 176 177
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
178 179 180

/* Helper functions to scan the backtrace.  */

181 182
bool
backtrace_p (union specbinding *pdl)
183
{ return pdl >= specpdl; }
184

185
union specbinding *
186
backtrace_top (void)
187
{
188
  union specbinding *pdl = specpdl_ptr - 1;
189
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
190 191
    pdl--;
  return pdl;
192
}
193

194 195
union specbinding *
backtrace_next (union specbinding *pdl)
196
{
197 198 199 200
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
201 202
}

203

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
216 217
}

218 219
static struct handler handlerlist_sentinel;

Andreas Schwab's avatar
Andreas Schwab committed
220
void
221
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
222 223
{
  specpdl_ptr = specpdl;
224 225 226 227 228 229 230 231 232 233
  { /* 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
234 235 236
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
237
#ifdef DEBUG_GCPRO
238
  gcpro_level = 0;
239
#endif
240
  /* This is less than the initial value of num_nonmacro_input_events.  */
241
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
242 243
}

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

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

253 254
static void grow_specpdl (void);

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

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

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

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

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

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

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

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

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

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

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

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

342
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
343

344
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
345
    {
346
      val = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
347
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
348
	break;
349
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
350 351 352 353 354 355 356
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
357
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
358 359
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
360
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
361
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
362
{
363
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
364 365
  struct gcpro gcpro1;

366
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
367

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

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
381
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
382 383 384
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.
385
usage: (if COND THEN ELSE...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
386
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
387
{
388
  Lisp_Object cond;
Jim Blandy's avatar
Jim Blandy committed
389 390 391
  struct gcpro gcpro1;

  GCPRO1 (args);
392
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
393 394
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
395
  if (!NILP (cond))
396 397
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
398 399 400
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
401 402 403 404 405
       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
406 407
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
408
If no clause succeeds, cond returns nil.
409
usage: (cond CLAUSES...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
410
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
411
{
412
  Lisp_Object val = args;
Jim Blandy's avatar
Jim Blandy committed
413 414 415
  struct gcpro gcpro1;

  GCPRO1 (args);
416
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
417
    {
418
      Lisp_Object clause = XCAR (args);
419
      val = eval_sub (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
420
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
421
	{
422
	  if (!NILP (XCDR (clause)))
423
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
424 425
	  break;
	}
426
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
427 428 429 430 431 432
    }
  UNGCPRO;

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
433
DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
434
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
435
usage: (progn BODY...)  */)
436
  (Lisp_Object body)
Jim Blandy's avatar
Jim Blandy committed
437
{
438
  Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
439 440
  struct gcpro gcpro1;

441
  GCPRO1 (body);
Jim Blandy's avatar
Jim Blandy committed
442

443
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
444
    {
445 446
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450 451 452
    }

  UNGCPRO;
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
453
/* Evaluate BODY sequentially, discarding its value.  Suitable for
454 455 456 457 458 459 460 461
   record_unwind_protect.  */

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

Jim Blandy's avatar
Jim Blandy committed
462
DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
463
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
464 465
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
466
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
467
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
468 469
{
  Lisp_Object val;
470
  Lisp_Object args_left;
Jim Blandy's avatar
Jim Blandy committed
471 472 473
  struct gcpro gcpro1, gcpro2;

  args_left = args;
474
  val = args;
Jim Blandy's avatar
Jim Blandy committed
475 476
  GCPRO2 (args, val);

477 478 479
  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
480 481 482 483 484 485

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
486
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
487 488 489
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
490
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
491
{
492
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
493

494 495
  GCPRO1 (args);
  eval_sub (XCAR (args));
496 497
  UNGCPRO;
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
498 499 500
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
501 502 503 504 505 506 507
       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
508
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
509
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
510
{
511
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
512

513 514 515 516 517 518
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
      struct gcpro gcpro1;
      GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
519

520 521 522 523 524 525 526 527 528 529 530 531 532 533
      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
534

535 536 537
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
538

539
      UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543
    }

  return val;
}
544

Jim Blandy's avatar
Jim Blandy committed
545
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
546
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
547 548 549 550 551 552 553 554
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
555
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
556
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
557
{
558
  if (CONSP (XCDR (args)))
559
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
560
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
561
}
562

Jim Blandy's avatar
Jim Blandy committed
563
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
564 565 566 567
       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
568
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
569
{
570 571
  Lisp_Object quoted = XCAR (args);

572
  if (CONSP (XCDR (args)))
573
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
574 575 576 577

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
    { /* 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));
    }
595 596 597
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
598 599
}

600

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

614 615
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
616

617
  sym = XSYMBOL (new_alias);
618 619

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

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

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

  {
639
    union specbinding *p;
640

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

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

656
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
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 701 702 703
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
704

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

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.)
724 725 726 727 728

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

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

734 735
  sym = XCAR (args);
  tail = XCDR (args);
736

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

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
782 783 784 785
  return sym;
}

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

805 806
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
807
    error ("Too many arguments");
808

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

826 827 828 829 830 831 832 833 834 835 836
/* 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
837 838

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
839 840 841 842 843
       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.