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;

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

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

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

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

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

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

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

  return val;
}

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

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

  return val;
}

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

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

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

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

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

  return val;
}

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

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

  return val;
}

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

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

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

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

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

  return val;
}

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

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

486 487 488 489
  val = args;
  if (CONSP (args))
    {
      Lisp_Object args_left = args;
Jim Blandy's avatar
Jim Blandy committed
490

491 492 493 494 495 496 497 498 499 500 501 502 503 504
      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
505

506 507 508
	  args_left = Fcdr (XCDR (args_left));
	}
      while (CONSP (args_left));
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512
    }

  return val;
}
513

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

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

541
  if (CONSP (XCDR (args)))
542
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
543 544 545 546

  if (!NILP (Vinternal_interpreter_environment)
      && CONSP (quoted)
      && EQ (XCAR (quoted), Qlambda))
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
    { /* 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));
    }
564 565 566
  else
    /* Simply quote the argument.  */
    return quoted;
Jim Blandy's avatar
Jim Blandy committed
567 568
}

569

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

583 584
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
585

586
  sym = XSYMBOL (new_alias);
587 588

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
589 590
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
591 592 593 594 595 596 597

  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");
598 599 600 601 602
    case SYMBOL_PLAINVAL:
    case SYMBOL_VARALIAS:
      break;
    default:
      emacs_abort ();
603 604
    }

605
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
606 607 608 609
     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)))
610
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
611 612

  {
613
    union specbinding *p;
614

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

621
  sym->declared_special = 1;
622
  XSYMBOL (base_variable)->declared_special = 1;
623 624
  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
625 626
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
627 628
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
629

630
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
631 632
}

633 634 635 636 637 638 639 640 641 642 643 644 645 646
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;
647 648 649 650 651 652 653 654 655 656 657

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

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

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
707
for these variables.  (`defconst' and `defcustom' behave similarly in
708
this respect.)
709 710 711 712 713

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

To define a user option, use `defcustom' instead of `defvar'.
714
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
715
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
716
{
717
  Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
718

719 720
  sym = XCAR (args);
  tail = XCDR (args);
721

722
  if (CONSP (tail))
Jim Blandy's avatar
Jim Blandy committed
723
    {
724 725 726 727 728
      if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
	error ("Too many arguments");

      tem = Fdefault_boundp (sym);

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

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

Jim Blandy's avatar
Jim Blandy committed
767 768 769 770
  return sym;
}

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

790 791
  sym = XCAR (args);
  if (CONSP (Fcdr (XCDR (XCDR (args)))))
792
    error ("Too many arguments");
793

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

811 812 813 814 815 816 817 818 819 820 821
/* 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
822 823

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
824 825 826 827 828
       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.
829
usage: (let* VARLIST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
830
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
831
{
832
  Lisp_Object varlist, var, val, elt, lexenv;