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-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);
93

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

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

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

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

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

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

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

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

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

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

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

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

/* Helper functions to scan the backtrace.  */

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

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

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

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

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

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

219 220
static struct handler handlerlist_sentinel;

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

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

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

251 252
static void grow_specpdl (void);

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

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

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

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

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

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

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

302 303 304 305 306
  /* If we are debugging an error while `inhibit-changing-match-data'
     is bound to non-nil (e.g., within a call to `string-match-p'),
     then make sure debugger code can still use match data.  */
  specbind (Qinhibit_changing_match_data, Qnil);

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

312 313 314 315
  val = apply1 (Vdebugger, arg);

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

320
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
321 322
}

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

  return val;
}

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

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

  return val;
}

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

385
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
386

Jim Blandy's avatar
Jim Blandy committed
387
  if (!NILP (cond))
388 389
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
390 391 392
}

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

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

  return val;
}

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

429
  while (CONSP (body))
Jim Blandy's avatar
Jim Blandy committed
430
    {
431 432
      val = eval_sub (XCAR (body));
      body = XCDR (body);
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437
    }

  return val;
}

Paul Eggert's avatar
Paul Eggert committed
438
/* Evaluate BODY sequentially, discarding its value.  Suitable for
439 440 441 442 443 444 445 446
   record_unwind_protect.  */

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

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

  args_left = args;
458
  val = args;
Jim Blandy's avatar
Jim Blandy committed
459

460 461 462
  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
463 464 465 466 467

  return val;
}

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

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

491 492 493 494
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
495 496 497 498
      Lisp_Object numargs = Flength (args);

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

500 501 502 503 504 505 506 507 508 509 510 511 512 513
      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
514

515 516 517
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
518 519 520 521
    }

  return val;
}
522

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

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

550
  if (CONSP (XCDR (args)))
551
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
552 553 554 555

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    { /* 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));
    }
573 574 575
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
576 577
}

578

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

592 593
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
594

595
  sym = XSYMBOL (new_alias);
596 597

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

  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");
607 608 609 610 611
    case SYMBOL_PLAINVAL:
    case SYMBOL_VARALIAS:
      break;
    default:
      emacs_abort ();
612 613
    }

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

  {
622
    union specbinding *p;
623

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

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

639
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
640 641
}

642 643 644 645 646 647 648 649 650 651 652 653 654 655
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;
656 657 658 659 660 661 662 663 664 665 666

	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 ();
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
	}
    }
  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
698

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

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
716
for these variables.  (`defconst' and `defcustom' behave similarly in
717
this respect.)
718 719 720 721 722

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

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

728 729
  sym = XCAR (args);
  tail = XCDR (args);
730

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

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
776 777 778 779
  return sym;
}

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

799 800
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
801
    error ("Too many arguments");
802

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

820 821 822 823 824 825 826 827 828 829 830
/* 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
831 832

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
833 834 835 836 837
       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.