eval.c 119 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>
Paul Eggert's avatar
Paul Eggert committed
25
#include <stdlib.h>
Jim Blandy's avatar
Jim Blandy committed
26
#include "lisp.h"
27
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
29
#include "keyboard.h"
30
#include "dispextern.h"
31
#include "buffer.h"
32

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

35
/* struct handler *handlerlist; */
36

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

Lisp_Object Vautoload_queue;

44 45 46 47 48
/* 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;

Eli Zaretskii's avatar
Eli Zaretskii committed
49 50
/* The commented-out variables below are macros defined in thread.h.  */

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

54
/* ptrdiff_t specpdl_size; */
Jim Blandy's avatar
Jim Blandy committed
55

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

Tom Tromey's avatar
Tom Tromey committed
59
/* union specbinding *specpdl; */
Jim Blandy's avatar
Jim Blandy committed
60 61

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

Tom Tromey's avatar
Tom Tromey committed
63
/* union specbinding *specpdl_ptr; */
Jim Blandy's avatar
Jim Blandy committed
64 65

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

Eli Zaretskii's avatar
Eli Zaretskii committed
67
/* static EMACS_INT lisp_eval_depth; */
Jim Blandy's avatar
Jim Blandy committed
68

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

76
static EMACS_INT when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
77

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

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

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

94
static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
95
static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, ptrdiff_t);
Paul Pogonyshev's avatar
Paul Pogonyshev committed
96
static Lisp_Object lambda_arity (Lisp_Object);
97

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

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

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

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

Tom Tromey's avatar
Tom Tromey committed
126 127 128 129 130 131 132
static Lisp_Object
specpdl_saved_value (union specbinding *pdl)
{
  eassert (pdl->kind >= SPECPDL_LET);
  return pdl->let.saved_value;
}

133
static Lisp_Object
134
specpdl_arg (union specbinding *pdl)
135 136
{
  eassert (pdl->kind == SPECPDL_UNWIND);
137
  return pdl->unwind.arg;
138 139
}

140
Lisp_Object
141
backtrace_function (union specbinding *pdl)
142 143
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
144
  return pdl->bt.function;
145 146 147
}

static ptrdiff_t
148
backtrace_nargs (union specbinding *pdl)
149 150
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
151
  return pdl->bt.nargs;
152 153
}

154
Lisp_Object *
155
backtrace_args (union specbinding *pdl)
156 157
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
158
  return pdl->bt.args;
159 160 161
}

static bool
162
backtrace_debug_on_exit (union specbinding *pdl)
163 164
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
165
  return pdl->bt.debug_on_exit;
166 167
}

168
/* Functions to modify slots of backtrace records.  */
169

170
static void
171
set_backtrace_args (union specbinding *pdl, Lisp_Object *args, ptrdiff_t nargs)
172 173 174
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.args = args;
175
  pdl->bt.nargs = nargs;
176
}
177

178
static void
179 180 181 182 183
set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
{
  eassert (pdl->kind == SPECPDL_BACKTRACE);
  pdl->bt.debug_on_exit = doe;
}
184 185 186

/* Helper functions to scan the backtrace.  */

187 188
bool
backtrace_p (union specbinding *pdl)
189
{ return pdl >= specpdl; }
190

191
union specbinding *
192
backtrace_top (void)
193
{
194
  union specbinding *pdl = specpdl_ptr - 1;
195
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
196 197
    pdl--;
  return pdl;
198
}
199

200 201
union specbinding *
backtrace_next (union specbinding *pdl)
202
{
203 204 205 206
  pdl--;
  while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
    pdl--;
  return pdl;
207 208
}

209 210 211 212 213 214
/* Return a pointer to somewhere near the top of the C stack.  */
void *
near_C_stack_top (void)
{
  return backtrace_args (backtrace_top ());
}
215

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
228 229
}

Ken Raeburn's avatar
Ken Raeburn committed
230
/* static struct handler handlerlist_sentinel; */
231

Andreas Schwab's avatar
Andreas Schwab committed
232
void
233
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
234
{
235
  byte_stack_list = 0;
Jim Blandy's avatar
Jim Blandy committed
236
  specpdl_ptr = specpdl;
237 238 239
  { /* 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.   */
Ken Raeburn's avatar
Ken Raeburn committed
240 241
    handlerlist_sentinel = xzalloc (sizeof (struct handler));
    handlerlist = handlerlist_sentinel->nextfree = handlerlist_sentinel;
242
    struct handler *c = push_handler (Qunbound, CATCHER);
Ken Raeburn's avatar
Ken Raeburn committed
243 244 245
    eassert (c == handlerlist_sentinel);
    handlerlist_sentinel->nextfree = NULL;
    handlerlist_sentinel->next = NULL;
246
  }
Jim Blandy's avatar
Jim Blandy committed
247 248 249
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
250
  /* This is less than the initial value of num_nonmacro_input_events.  */
251
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
252 253
}

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

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

263 264
static void grow_specpdl (void);

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

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

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

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
  /* While debugging Bug#16603, previous value of 100 was found
     too small to avoid specpdl overflow in the debugger itself.  */
  if (max_specpdl_size - 200 < count)
    max_specpdl_size = count + 200;

  if (old_max == count)
    {
      /* We can enter the debugger due to specpdl overflow (Bug#16603).  */
      specpdl_ptr--;
      grow_specpdl ();
    }

  /* Restore limits after leaving the debugger.  */
  record_unwind_protect (restore_stack_limits,
			 Fcons (make_number (old_max),
				make_number (old_depth)));
296

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

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

  /* Resetting redisplaying_p to 0 makes sure that debug output is
     displayed if the debugger is invoked during redisplay.  */
  debug_while_redisplaying = redisplaying_p;
  redisplaying_p = 0;
309 310
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
311
  specbind (Qinhibit_redisplay, Qnil);
312
  specbind (Qinhibit_debugger, Qt);
313

314 315 316 317 318
  /* 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);

319 320
#if 0 /* Binding this prevents execution of Lisp code during
	 redisplay, which necessarily leads to display problems.  */
321
  specbind (Qinhibit_eval_during_redisplay, Qt);
322
#endif
323

324 325 326 327
  val = apply1 (Vdebugger, arg);

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

332
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
333 334
}

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

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

  return val;
}

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

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

  return val;
}

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

397
  cond = eval_sub (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
398

Jim Blandy's avatar
Jim Blandy committed
399
  if (!NILP (cond))
400 401
    return eval_sub (Fcar (XCDR (args)));
  return Fprogn (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
402 403 404
}

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

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

  return val;
}

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

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

  return val;
}

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

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

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

  args_left = args;
470
  val = args;
Jim Blandy's avatar
Jim Blandy committed
471

472 473 474
  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
475 476 477 478 479

  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
480
       doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
481 482 483
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
484
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
485
{
486
  eval_sub (XCAR (args));
487
  return Fprog1 (XCDR (args));
Jim Blandy's avatar
Jim Blandy committed
488 489 490
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
491 492 493 494 495 496 497
       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
498
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
499
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
500
{
501
  Lisp_Object val, sym, lex_binding;
Jim Blandy's avatar
Jim Blandy committed
502

503 504 505 506
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
507 508 509 510
      Lisp_Object numargs = Flength (args);

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

512 513 514 515 516 517 518 519 520 521 522 523 524 525
      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
526

527 528 529
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533
    }

  return val;
}
534

Jim Blandy's avatar
Jim Blandy committed
535
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
536
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
537 538 539
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').
540
This means that \\='(a . b) is not identical to (cons \\='a \\='b): the former
541 542 543 544
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
545
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
546
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
547
{
548
  if (CONSP (XCDR (args)))
549
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
550
  return XCAR (args);
Jim Blandy's avatar
Jim Blandy committed
551
}
552

Jim Blandy's avatar
Jim Blandy committed
553
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
554 555 556 557
       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
558
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
559
{
560 561
  Lisp_Object quoted = XCAR (args);

562
  if (CONSP (XCDR (args)))
563
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
564 565 566 567

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
    { /* 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));
    }
585 586 587
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
588 589
}

590

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

604 605
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
606

Noam Postavsky's avatar
Noam Postavsky committed
607 608
  if (SYMBOL_CONSTANT_P (new_alias))
    /* Making it an alias effectively changes its value.  */
Stefan Monnier's avatar
Stefan Monnier committed
609
    error ("Cannot make a constant an alias");
610

Noam Postavsky's avatar
Noam Postavsky committed
611 612
  sym = XSYMBOL (new_alias);

613 614 615 616 617 618
  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");
619 620 621 622 623
    case SYMBOL_PLAINVAL:
    case SYMBOL_VARALIAS:
      break;
    default:
      emacs_abort ();
624 625
    }

626
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
627 628 629 630
     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)))
Noam Postavsky's avatar
Noam Postavsky committed
631 632
    set_internal (base_variable, find_symbol_value (new_alias),
                  Qnil, SET_INTERNAL_BIND);
633
  {
634
    union specbinding *p;
635

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

Noam Postavsky's avatar
Noam Postavsky committed
642 643 644
  if (sym->trapped_write == SYMBOL_TRAPPED_WRITE)
    notify_variable_watchers (new_alias, base_variable, Qdefvaralias, Qnil);

645
  sym->declared_special = 1;
646
  XSYMBOL (base_variable)->declared_special = 1;
647 648
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
Noam Postavsky's avatar
Noam Postavsky committed
649
  sym->trapped_write = XSYMBOL (base_variable)->trapped_write;
650
  LOADHIST_ATTACH (new_alias);
651 652
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
653

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

657 658 659 660 661 662 663 664 665 666 667 668 669 670
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;
671 672 673 674 675 676 677 678 679 680 681

	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 ();
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
	}
    }
  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
713

Jim Blandy's avatar
Jim Blandy committed
714
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
715
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
716 717 718 719 720 721 722 723 724
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
725
If INITVALUE is missing, SYMBOL's value is not set.
726 727 728 729 730

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
731
for these variables.  (`defconst' and `defcustom' behave similarly in
732
this respect.)
733 734 735 736 737

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

To define a user option, use `defcustom' instead of `defvar'.
738
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
739
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
740
{
741
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
742

743 744
  sym = XCAR (args);
  tail = XCDR (args);
745

746
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
747
    {
748 749 750 751 752
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
791 792 793 794
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
795
       doc: /* Define SYMBOL as a constant variable.
796 797 798 799 800 801 802 803 804 805 806 807 808
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.
809
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
810
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
811
{
812
  Lisp_Object sym, tem;
Jim Blandy's avatar
Jim Blandy committed
813

814 815
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
816
    error ("Too many arguments");
817

818
  tem = eval_sub (Fcar (XCDR (args)));
819 820 821
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
822
  XSYMBOL (sym)->declared_special = 1;
823
  tem = Fcar (XCDR (XCDR (args)));
Jim Blandy's avatar
Jim Blandy committed
824
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed