eval.c 103 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3 4
                 2002, 2003, 2004, 2005, 2006, 2007, 2008
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
any later version.

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


24
#include <config.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"
Jim Blandy's avatar
Jim Blandy committed
30 31
#include <setjmp.h>

32 33 34 35
#if HAVE_X_WINDOWS
#include "xterm.h"
#endif

Jim Blandy's avatar
Jim Blandy committed
36 37 38 39
/* This definition is duplicated in alloc.c and keyboard.c */
/* Putting it in lisp.h makes cc bomb out! */

struct backtrace
40 41 42 43 44
{
  struct backtrace *next;
  Lisp_Object *function;
  Lisp_Object *args;	/* Points to vector of args. */
  int nargs;		/* Length of vector.
Jim Blandy's avatar
Jim Blandy committed
45 46
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
47 48 49 50
  char evalargs;
  /* Nonzero means call value of debugger when done with this operation. */
  char debug_on_exit;
};
Jim Blandy's avatar
Jim Blandy committed
51 52 53

struct backtrace *backtrace_list;

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/* This structure helps implement the `catch' and `throw' control
   structure.  A struct catchtag contains all the information needed
   to restore the state of the interpreter after a non-local jump.

   Handlers for error conditions (represented by `struct handler'
   structures) just point to a catch tag to do the cleanup required
   for their jumps.

   catchtag structures are chained together in the C calling stack;
   the `next' member points to the next outer catchtag.

   A call like (throw TAG VAL) searches for a catchtag whose `tag'
   member is TAG, and then unbinds to it.  The `val' member is used to
   hold VAL while the stack is unwound; `val' is returned as the value
   of the catch form.

   All the other members are concerned with restoring the interpreter
   state.  */
72

Jim Blandy's avatar
Jim Blandy committed
73
struct catchtag
74 75 76 77 78 79 80 81 82 83 84
{
  Lisp_Object tag;
  Lisp_Object val;
  struct catchtag *next;
  struct gcpro *gcpro;
  jmp_buf jmp;
  struct backtrace *backlist;
  struct handler *handlerlist;
  int lisp_eval_depth;
  int pdlcount;
  int poll_suppress_count;
85
  int interrupt_input_blocked;
86 87
  struct byte_stack *byte_stack;
};
Jim Blandy's avatar
Jim Blandy committed
88 89 90

struct catchtag *catchlist;

91 92 93 94 95
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

96
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
97
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
98 99
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
100
Lisp_Object Qdeclare;
101
Lisp_Object Qdebug;
Jim Blandy's avatar
Jim Blandy committed
102

103 104 105
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
106

Jim Blandy's avatar
Jim Blandy committed
107 108 109 110 111
Lisp_Object Vrun_hooks;

/* 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:
112
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
113 114 115 116

Lisp_Object Vautoload_queue;

/* Current number of specbindings allocated in specpdl.  */
117

Jim Blandy's avatar
Jim Blandy committed
118 119 120
int specpdl_size;

/* Pointer to beginning of specpdl.  */
121

Jim Blandy's avatar
Jim Blandy committed
122 123 124
struct specbinding *specpdl;

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

126
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
127 128

/* Maximum size allowed for specpdl allocation */
129

130
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
131 132

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

Jim Blandy's avatar
Jim Blandy committed
134 135 136
int lisp_eval_depth;

/* Maximum allowed depth in Lisp evaluations and function calls.  */
137

138
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
139 140

/* Nonzero means enter debugger before next function call */
141

Jim Blandy's avatar
Jim Blandy committed
142 143
int debug_on_next_call;

144
/* Non-zero means debugger may continue.  This is zero when the
145 146 147 148 149
   debugger is called during redisplay, where it might not be safe to
   continue the interrupted redisplay. */

int debugger_may_continue;

Roland McGrath's avatar
Roland McGrath committed
150
/* List of conditions (non-nil atom means all) which cause a backtrace
151
   if an error is handled by the command loop's error handler.  */
152

Roland McGrath's avatar
Roland McGrath committed
153
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
154

Roland McGrath's avatar
Roland McGrath committed
155
/* List of conditions (non-nil atom means all) which enter the debugger
156
   if an error is handled by the command loop's error handler.  */
157

Roland McGrath's avatar
Roland McGrath committed
158
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
159

Karl Heuer's avatar
Karl Heuer committed
160
/* List of conditions and regexps specifying error messages which
161
   do not enter the debugger even if Vdebug_on_error says they should.  */
162

Karl Heuer's avatar
Karl Heuer committed
163 164
Lisp_Object Vdebug_ignored_errors;

165
/* Non-nil means call the debugger even if the error will be handled.  */
166

167
Lisp_Object Vdebug_on_signal;
168 169

/* Hook for edebug to use.  */
170

171 172
Lisp_Object Vsignal_hook_function;

Jim Blandy's avatar
Jim Blandy committed
173
/* Nonzero means enter debugger if a quit signal
Roland McGrath's avatar
Roland McGrath committed
174
   is handled by the command loop's error handler. */
175

Jim Blandy's avatar
Jim Blandy committed
176 177
int debug_on_quit;

178
/* The value of num_nonmacro_input_events as of the last time we
179
   started to enter the debugger.  If we decide to enter the debugger
180
   again when this is still equal to num_nonmacro_input_events, then we
181 182 183
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
184

185
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
186 187 188

Lisp_Object Vdebugger;

189 190 191 192 193
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

194 195 196 197 198 199
/* Set to non-zero while processing X events.  Checked in Feval to
   make sure the Lisp interpreter isn't called from a signal handler,
   which is unsafe because the interpreter isn't reentrant.  */

int handling_signal;

200 201 202 203
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

204
extern Lisp_Object Qrisky_local_variable;
205

206 207
extern Lisp_Object Qfunction;

208
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
209
static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
210 211 212 213 214 215 216 217

#if __GNUC__
/* "gcc -O3" enables automatic function inlining, which optimizes out
   the arguments for the invocations of these functions, whereas they
   expect these values on the stack.  */
Lisp_Object apply1 () __attribute__((noinline));
Lisp_Object call2 () __attribute__((noinline));
#endif
218

Andreas Schwab's avatar
Andreas Schwab committed
219
void
Jim Blandy's avatar
Jim Blandy committed
220 221 222
init_eval_once ()
{
  specpdl_size = 50;
223
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
224
  specpdl_ptr = specpdl;
225
  /* Don't forget to update docs (lispref node "Local Variables").  */
226
  max_specpdl_size = 1000;
227
  max_lisp_eval_depth = 400;
228 229

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
230 231
}

Andreas Schwab's avatar
Andreas Schwab committed
232
void
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240 241
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
242
#ifdef DEBUG_GCPRO
243
  gcpro_level = 0;
244
#endif
245
  /* This is less than the initial value of num_nonmacro_input_events.  */
246
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
247 248
}

249 250 251 252 253 254 255 256
/* unwind-protect function used by call_debugger.  */

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

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

Jim Blandy's avatar
Jim Blandy committed
262 263 264 265
Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
266
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
267
  int count = SPECPDL_INDEX ();
268
  Lisp_Object val;
269
  int old_max = max_specpdl_size;
270

271 272
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
273

274 275 276 277 278 279 280 281 282 283 284
  max_specpdl_size += 1;
  record_unwind_protect (restore_stack_limits,
			 Fcons (make_number (old_max),
				make_number (max_lisp_eval_depth)));
  max_specpdl_size = old_max;

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

  if (SPECPDL_INDEX () + 100 > max_specpdl_size)
    max_specpdl_size = SPECPDL_INDEX () + 100;
285

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

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

  /* Resetting redisplaying_p to 0 makes sure that debug output is
     displayed if the debugger is invoked during redisplay.  */
  debug_while_redisplaying = redisplaying_p;
  redisplaying_p = 0;
298 299
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
300
  specbind (Qinhibit_redisplay, Qnil);
301
  specbind (Qdebug_on_error, Qnil);
302 303 304

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

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

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

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

Andreas Schwab's avatar
Andreas Schwab committed
319
void
Jim Blandy's avatar
Jim Blandy committed
320 321 322 323 324 325 326 327 328 329 330 331 332
do_debug_on_call (code)
     Lisp_Object code;
{
  debug_on_next_call = 0;
  backtrace_list->debug_on_exit = 1;
  call_debugger (Fcons (code, Qnil));
}

/* NOTE!!! Every function that can call EVAL must protect its args
   and temporaries from garbage collection while it needs them.
   The definition of `For' shows what you have to do.  */

DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
333 334 335
       doc: /* Eval args until one of them yields non-nil, then return that value.
The remaining args are not evalled at all.
If all args return nil, return nil.
Juanma Barranquero's avatar
Juanma Barranquero committed
336
usage: (or CONDITIONS...)  */)
Pavel Janík's avatar
Pavel Janík committed
337
     (args)
Jim Blandy's avatar
Jim Blandy committed
338 339
     Lisp_Object args;
{
340
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
341 342
  struct gcpro gcpro1;

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

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

  UNGCPRO;
  return val;
}

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

368
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
369

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

  UNGCPRO;
  return val;
}

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

  GCPRO1 (args);
  cond = Feval (Fcar (args));
  UNGCPRO;

Jim Blandy's avatar
Jim Blandy committed
398
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
399 400 401 402 403
    return Feval (Fcar (Fcdr (args)));
  return Fprogn (Fcdr (Fcdr (args)));
}

DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
404 405 406 407 408 409 410 411
       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.
If no clause succeeds, cond returns nil.
If a clause has one element, as in (CONDITION),
CONDITION's value if non-nil is returned from the cond-form.
412
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
413
     (args)
Jim Blandy's avatar
Jim Blandy committed
414 415 416 417 418 419 420
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
421
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
422 423 424
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
425
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
426
	{
427 428
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
429 430
	  break;
	}
431
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
432 433 434 435 436 437 438
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
439
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
440
usage: (progn BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
441
     (args)
Jim Blandy's avatar
Jim Blandy committed
442 443
     Lisp_Object args;
{
444
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
445 446
  struct gcpro gcpro1;

447
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
448

449
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
450
    {
451 452
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
453 454 455 456 457 458 459
    }

  UNGCPRO;
  return val;
}

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

472
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486
    return Qnil;

  args_left = args;
  val = Qnil;
  GCPRO2 (args, val);

  do
    {
      if (!(argnum++))
        val = Feval (Fcar (args_left));
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Jim Blandy's avatar
Jim Blandy committed
487
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
494 495 496 497
       doc: /* Eval FORM1, FORM2 and BODY sequentially; value from FORM2.
The value of FORM2 is saved during the evaluation of the
remaining args, whose values are discarded.
usage: (prog2 FORM1 FORM2 BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
498
     (args)
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503 504 505 506 507
     Lisp_Object args;
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = -1;

  val = Qnil;

Richard M. Stallman's avatar
Richard M. Stallman committed
508
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522
    return Qnil;

  args_left = args;
  val = Qnil;
  GCPRO2 (args, val);

  do
    {
      if (!(argnum++))
        val = Feval (Fcar (args_left));
      else
	Feval (Fcar (args_left));
      args_left = Fcdr (args_left);
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
523
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
524 525 526 527 528 529

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
530 531 532 533 534 535 536
       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
537
usage: (setq [SYM VAL]...)  */)
Pavel Janík's avatar
Pavel Janík committed
538
     (args)
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542 543 544
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

545
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
546 547 548 549 550 551 552 553 554 555 556 557
    return Qnil;

  args_left = args;
  GCPRO1 (args);

  do
    {
      val = Feval (Fcar (Fcdr (args_left)));
      sym = Fcar (args_left);
      Fset (sym, val);
      args_left = Fcdr (Fcdr (args_left));
    }
Jim Blandy's avatar
Jim Blandy committed
558
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562

  UNGCPRO;
  return val;
}
563

Jim Blandy's avatar
Jim Blandy committed
564
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
565 566 567
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
568 569
     Lisp_Object args;
{
570 571
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
572 573
  return Fcar (args);
}
574

Jim Blandy's avatar
Jim Blandy committed
575
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
576 577 578 579 580
       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)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
581 582
     Lisp_Object args;
{
583 584
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
585 586 587
  return Fcar (args);
}

588

Jim Blandy's avatar
Jim Blandy committed
589
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
590
       doc: /* Return t if the function was run directly by user input.
591 592
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
593 594 595 596 597 598 599 600 601 602 603 604 605
and input is currently coming from the keyboard (not in keyboard macro),
and Emacs is not running in batch mode (`noninteractive' is nil).

The only known proper use of `interactive-p' is in deciding whether to
display a helpful message, or how to display it.  If you're thinking
of using it for any other purpose, it is quite likely that you're
making a mistake.  Think: what do you want to do when the command is
called from a keyboard macro?

If you want to test whether your function was called with
`call-interactively', the way to do that is by adding an extra
optional argument, and making the `interactive' spec specify non-nil
unconditionally for that argument.  (`p' is a good way to do this.)  */)
Pavel Janík's avatar
Pavel Janík committed
606
     ()
Jim Blandy's avatar
Jim Blandy committed
607
{
608
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
609 610 611
}


612
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 0, 0,
613
       doc: /* Return t if the function using this was called with `call-interactively'.
614 615 616 617
This is used for implementing advice and other function-modifying
features of Emacs.

The cleanest way to test whether your function was called with
618 619 620
`call-interactively' is by adding an extra optional argument,
and making the `interactive' spec specify non-nil unconditionally
for that argument.  (`p' is a good way to do this.)  */)
621 622
     ()
{
623
  return interactive_p (1) ? Qt : Qnil;
624 625 626 627 628
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
629 630 631 632 633 634 635 636 637 638

    EXCLUDE_SUBRS_P non-zero means always return 0 if the function
    called is a built-in.  */

int
interactive_p (exclude_subrs_p)
     int exclude_subrs_p;
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
639 640

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
641 642

  /* If this isn't a byte-compiled function, there may be a frame at
643
     the top for Finteractive_p.  If so, skip it.  */
644
  fun = Findirect_function (*btp->function, Qnil);
645 646
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
647
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
648 649

  /* If we're running an Emacs 18-style byte-compiled function, there
650 651 652
     may be a frame for Fbytecode at the top level.  In any version of
     Emacs there can be Fbytecode frames for subexpressions evaluated
     inside catch and condition-case.  Skip past them.
Jim Blandy's avatar
Jim Blandy committed
653

654
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
655
     looking at several frames for special forms.  Skip past them.  */
656 657 658
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
659 660
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
661 662 663 664
  /* btp now points at the frame of the innermost function that isn't
     a special form, ignoring frames for Finteractive_p and/or
     Fbytecode at the top.  If this frame is for a built-in function
     (such as load or eval-region) return nil.  */
665
  fun = Findirect_function (*btp->function, Qnil);
666 667
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
668

Jim Blandy's avatar
Jim Blandy committed
669 670 671
  /* btp points to the frame of a Lisp function that called interactive-p.
     Return t if that function was called interactively.  */
  if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
672 673
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
674 675
}

676

Jim Blandy's avatar
Jim Blandy committed
677
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
678 679 680
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
681
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
682
     (args)
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
689
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
690
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
691
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
692
    defn = Fpurecopy (defn);
693 694 695
  if (CONSP (XSYMBOL (fn_name)->function)
      && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, fn_name));
Jim Blandy's avatar
Jim Blandy committed
696
  Ffset (fn_name, defn);
697
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
698 699 700 701
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
702
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
705 706 707 708
When the macro is called, as in (NAME ARGS...),
the function (lambda ARGLIST BODY...) is applied to
the list ARGS... as it appears in the expression,
and the result should be a form to be evaluated instead of the original.
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710 711 712 713 714 715 716

DECL is a declaration, optional, which can specify how to indent
calls to this macro and how Edebug should handle it.  It looks like this:
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

717
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
718
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
719
	equivalent to writing a `def-edebug-spec' for the macro.)
Richard M. Stallman's avatar
Richard M. Stallman committed
720
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
721
     (args)
Jim Blandy's avatar
Jim Blandy committed
722 723 724 725
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
726
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
727 728

  fn_name = Fcar (args);
729
  CHECK_SYMBOL (fn_name);
730 731 732 733 734 735
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
736 737
      doc = XCAR (tail);
      tail = XCDR (tail);
738 739 740 741 742 743 744 745 746 747 748 749
    }

  while (CONSP (Fcar (tail))
	 && EQ (Fcar (Fcar (tail)), Qdeclare))
    {
      if (!NILP (Vmacro_declaration_function))
	{
	  struct gcpro gcpro1;
	  GCPRO1 (args);
	  call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
	  UNGCPRO;
	}
750

751 752 753 754 755 756 757 758
      tail = Fcdr (tail);
    }

  if (NILP (doc))
    tail = Fcons (lambda_list, tail);
  else
    tail = Fcons (lambda_list, Fcons (doc, tail));
  defn = Fcons (Qmacro, Fcons (Qlambda, tail));
759

Jim Blandy's avatar
Jim Blandy committed
760
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
761
    defn = Fpurecopy (defn);
762 763 764
  if (CONSP (XSYMBOL (fn_name)->function)
      && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
    LOADHIST_ATTACH (Fcons (Qt, fn_name));
Jim Blandy's avatar
Jim Blandy committed
765
  Ffset (fn_name, defn);
766
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
767 768 769
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
770

771
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
772
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
773
Aliased variables always have the same value; setting one sets the other.
774 775 776 777 778 779 780
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
 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.
The return value is BASE-VARIABLE.  */)
     (new_alias, base_variable, docstring)
     Lisp_Object new_alias, base_variable, docstring;
Gerd Moellmann's avatar
Gerd Moellmann committed
781 782
{
  struct Lisp_Symbol *sym;
783

784 785
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
786

787
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
788 789
    error ("Cannot make a constant an alias");

790
  sym = XSYMBOL (new_alias);
Gerd Moellmann's avatar
Gerd Moellmann committed
791
  sym->indirect_variable = 1;
792 793 794
  sym->value = base_variable;
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
795
  if (!NILP (docstring))
796
    Fput (new_alias, Qvariable_documentation, docstring);
797
  else
798
    Fput (new_alias, Qvariable_documentation, Qnil);
799

800
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
801 802 803
}


Jim Blandy's avatar
Jim Blandy committed
804
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
805
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
806 807 808 809 810 811 812 813 814 815 816 817
You are not required to define a variable in order to use it,
but the definition can supply documentation and an initial value
in a way that tags can recognize.

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.
INITVALUE and DOCSTRING are optional.
If DOCSTRING starts with *, this variable is identified as a user option.
 This means that M-x set-variable recognizes it.
 See also `user-variable-p'.
If INITVALUE is missing, SYMBOL's value is not set.
818 819 820 821 822 823 824

If SYMBOL has a local binding, then this form affects the local
binding.  This is usually not what you want.  Thus, if you need to
load a file defining variables, with this form or with `defconst' or
`defcustom', you should always load that file _outside_ any bindings
for these variables.  \(`defconst' and `defcustom' behave similarly in
this respect.)
825
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
826
     (args)
Jim Blandy's avatar
Jim Blandy committed
827 828
     Lisp_Object args;
{
829
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
830 831

  sym = Fcar (args);
832 833
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
834
    error ("Too many arguments");
835

836
  tem = Fdefault_boundp (sym);
837
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
838
    {
839 840 841 842 843 844 845 846 847 848 849 850
      if (SYMBOL_CONSTANT_P (sym))
	{
	  /* For upward compatibility, allow (defvar :foo (quote :foo)).  */
	  Lisp_Object tem = Fcar (tail);
	  if (! (CONSP (tem)
		 && EQ (XCAR (tem), Qquote)
		 && CONSP (XCDR (tem))
		 && EQ (XCAR (XCDR (tem)), sym)))
	    error ("Constant symbol `%s' specified in defvar",
		   SDATA (SYMBOL_NAME (sym)));
	}

Jim Blandy's avatar
Jim Blandy committed
851
      if (NILP (tem))
852
	Fset_default (sym, Feval (Fcar (tail)));
853 854 855
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
856
	  volatile struct specbinding *pdl = specpdl_ptr;
857 858 859 860 861 862 863 864 865 866 867
	  while (--pdl >= specpdl)
	    {
	      if (EQ (pdl->symbol, sym) && !pdl->func
		  && EQ (pdl->old_value, Qunbound))
		{
		  message_with_string ("Warning: defvar ignored because %s is let-bound",
				       SYMBOL_NAME (sym), 1);
		  break;
		}
	    }
	}
868
      tail = Fcdr (tail);
869 870
      tem = Fcar (tail);
      if (!NILP (tem))
871 872 873 874 875
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
876
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
877
    }
878
  else
879 880 881
    /* 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
882 883
    ;

Jim Blandy's avatar
Jim Blandy committed
884 885 886 887
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
888 889 890 891 892 893
       doc: /* Define SYMBOL as a constant variable.
The intent is that neither programs nor users should ever change this value.
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.
DOCSTRING is optional.
894 895 896 897

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.
898
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
899
     (args)
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903 904
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
905
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
906
    error ("Too many arguments");
907

908 909 910 911
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
912
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
913
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
914
    {
Jim Blandy's avatar
Jim Blandy committed
915
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
916 917 918
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
919
  Fput (sym, Qrisky_local_variable, Qt);
920
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
921 922 923
  return sym;
}

924 925 926 927 928 929 930 931
/* Error handler used in Fuser_variable_p.  */
static Lisp_Object
user_variable_p_eh (ignore)
     Lisp_Object ignore;
{
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
932
DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
933
       doc: /* Return t if VARIABLE is intended to be set and modified by users.
Pavel Janík's avatar
Pavel Janík committed
934
\(The alternative is a variable used internally in a Lisp program.)
935 936 937 938 939 940 941
A variable is a user variable if
\(1) the first character of its documentation is `*', or
\(2) it is customizable (its property list contains a non-nil value
    of `standard-value' or `custom-autoload'), or
\(3) it is an alias for another user variable.
Return nil if VARIABLE is an alias and there is a loop in the
chain of symbols.  */)
Pavel Janík's avatar
Pavel Janík committed
942
     (variable)
Jim Blandy's avatar
Jim Blandy committed
943 944 945
     Lisp_Object variable;
{
  Lisp_Object documentation;