eval.c 102 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
                 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
24
#include "lisp.h"
25
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
26
#include "commands.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "keyboard.h"
28
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
29 30
#include <setjmp.h>

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

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

struct backtrace
39 40 41 42 43
{
  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
44 45
			   If nargs is UNEVALLED, args points to slot holding
			   list of unevalled args */
46 47 48 49
  char evalargs;
  /* Nonzero means call value of debugger when done with this operation. */
  char debug_on_exit;
};
Jim Blandy's avatar
Jim Blandy committed
50 51 52

struct backtrace *backtrace_list;

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
/* 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.  */
71

Jim Blandy's avatar
Jim Blandy committed
72
struct catchtag
73 74 75 76 77 78 79 80 81 82 83
{
  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;
84
  int interrupt_input_blocked;
85 86
  struct byte_stack *byte_stack;
};
Jim Blandy's avatar
Jim Blandy committed
87 88 89

struct catchtag *catchlist;

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

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

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

Jim Blandy's avatar
Jim Blandy committed
105 106 107 108 109
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:
110
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
111 112 113 114

Lisp_Object Vautoload_queue;

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

Jim Blandy's avatar
Jim Blandy committed
116 117 118
int specpdl_size;

/* Pointer to beginning of specpdl.  */
119

Jim Blandy's avatar
Jim Blandy committed
120 121 122
struct specbinding *specpdl;

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

124
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
125 126

/* Maximum size allowed for specpdl allocation */
127

128
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
129 130

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

Jim Blandy's avatar
Jim Blandy committed
132 133 134
int lisp_eval_depth;

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

136
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
137 138

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

Jim Blandy's avatar
Jim Blandy committed
140 141
int debug_on_next_call;

142
/* Non-zero means debugger may continue.  This is zero when the
143 144 145 146 147
   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
148
/* List of conditions (non-nil atom means all) which cause a backtrace
149
   if an error is handled by the command loop's error handler.  */
150

Roland McGrath's avatar
Roland McGrath committed
151
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
152

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

Roland McGrath's avatar
Roland McGrath committed
156
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
157

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

Karl Heuer's avatar
Karl Heuer committed
161 162
Lisp_Object Vdebug_ignored_errors;

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

165
Lisp_Object Vdebug_on_signal;
166 167

/* Hook for edebug to use.  */
168

169 170
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
174 175
int debug_on_quit;

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

183
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
184 185 186

Lisp_Object Vdebugger;

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

Lisp_Object Vsignaling_function;

192 193 194 195 196 197
/* 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;

198 199 200 201
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

202
extern Lisp_Object Qrisky_local_variable;
203

204
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
205
static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
206 207 208 209 210 211 212 213

#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
214

Andreas Schwab's avatar
Andreas Schwab committed
215
void
Jim Blandy's avatar
Jim Blandy committed
216 217 218
init_eval_once ()
{
  specpdl_size = 50;
219
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
220
  specpdl_ptr = specpdl;
221
  /* Don't forget to update docs (lispref node "Local Variables").  */
222
  max_specpdl_size = 1000;
223
  max_lisp_eval_depth = 400;
224 225

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
226 227
}

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

245 246 247 248 249 250 251 252
/* 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));
253
  return Qnil;
254 255 256 257
}

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

Jim Blandy's avatar
Jim Blandy committed
258 259 260 261
Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
262
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
263
  int count = SPECPDL_INDEX ();
264
  Lisp_Object val;
265
  int old_max = max_specpdl_size;
266

267 268
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
269

270 271 272 273 274 275 276 277 278 279 280
  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;
281

282
#ifdef HAVE_X_WINDOWS
283 284
  if (display_hourglass_p)
    cancel_hourglass ();
285 286
#endif

Jim Blandy's avatar
Jim Blandy committed
287
  debug_on_next_call = 0;
288
  when_entered_debugger = num_nonmacro_input_events;
289 290 291 292 293

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

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

304 305 306 307
  val = apply1 (Vdebugger, arg);

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

312
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
313 314
}

Andreas Schwab's avatar
Andreas Schwab committed
315
void
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321 322 323 324 325 326 327 328
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
329 330 331
       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.
332
usage: (or CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
333
     (args)
Jim Blandy's avatar
Jim Blandy committed
334 335
     Lisp_Object args;
{
336
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
337 338
  struct gcpro gcpro1;

339
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
340

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
354
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
355 356
The remaining args are not evalled at all.
If no arg yields nil, return the last arg's value.
357
usage: (and CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
358
     (args)
Jim Blandy's avatar
Jim Blandy committed
359 360
     Lisp_Object args;
{
361
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
362 363
  struct gcpro gcpro1;

364
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
365

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

  UNGCPRO;
  return val;
}

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

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

Jim Blandy's avatar
Jim Blandy committed
394
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399
    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
400 401 402 403 404 405 406 407
       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.
408
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
409
     (args)
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414 415 416
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

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

  return val;
}

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.
436
usage: (progn BODY ...)  */)
Pavel Janík's avatar
Pavel Janík committed
437
     (args)
Jim Blandy's avatar
Jim Blandy committed
438 439
     Lisp_Object args;
{
440
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
441 442
  struct gcpro gcpro1;

443
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
444

445
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
446
    {
447 448
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
449 450 451 452 453 454 455
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
456 457 458
       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.
459
usage: (prog1 FIRST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
460
     (args)
Jim Blandy's avatar
Jim Blandy committed
461 462 463 464 465 466 467
     Lisp_Object args;
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

Jim Blandy's avatar
Jim Blandy committed
468
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482
    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
483
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
484 485 486 487 488 489

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
490 491 492 493
       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
494
     (args)
Jim Blandy's avatar
Jim Blandy committed
495 496 497 498 499 500 501 502 503
     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
504
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518
    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
519
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
520 521 522 523 524 525

  UNGCPRO;
  return val;
}

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

Jim Blandy's avatar
Jim Blandy committed
541
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547 548 549 550 551 552 553
    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
554
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558

  UNGCPRO;
  return val;
}
559

Jim Blandy's avatar
Jim Blandy committed
560
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
561 562 563
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567
     Lisp_Object args;
{
  return Fcar (args);
}
568

Jim Blandy's avatar
Jim Blandy committed
569
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
570 571 572 573 574
       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
575 576 577 578 579
     Lisp_Object args;
{
  return Fcar (args);
}

580

Jim Blandy's avatar
Jim Blandy committed
581
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
582
       doc: /* Return t if the function was run directly by user input.
583 584
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
585 586 587 588 589 590 591 592 593 594 595 596 597
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
598
     ()
Jim Blandy's avatar
Jim Blandy committed
599
{
600
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
601 602 603
}


604
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 0, 0,
605
       doc: /* Return t if the function using this was called with `call-interactively'.
606 607 608 609
This is used for implementing advice and other function-modifying
features of Emacs.

The cleanest way to test whether your function was called with
610 611 612
`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.)  */)
613 614
     ()
{
615
  return interactive_p (1) ? Qt : Qnil;
616 617 618 619 620
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
621 622 623 624 625 626 627 628 629 630

    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
631 632

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
633 634

  /* If this isn't a byte-compiled function, there may be a frame at
635
     the top for Finteractive_p.  If so, skip it.  */
636
  fun = Findirect_function (*btp->function, Qnil);
637 638
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
639
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
640 641

  /* If we're running an Emacs 18-style byte-compiled function, there
642 643 644
     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
645

646
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
647
     looking at several frames for special forms.  Skip past them.  */
648 649 650
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
651 652
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
653 654 655 656
  /* 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.  */
657
  fun = Findirect_function (*btp->function, Qnil);
658 659
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
660

Jim Blandy's avatar
Jim Blandy committed
661 662 663
  /* 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))
664 665
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
666 667
}

668

Jim Blandy's avatar
Jim Blandy committed
669
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
670 671 672
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
673
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
674
     (args)
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
681
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
682
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
683
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
684
    defn = Fpurecopy (defn);
685 686 687
  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
688
  Ffset (fn_name, defn);
689
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
690 691 692 693
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
694
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
695 696
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
697 698 699 700
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
701 702 703 704 705 706 707 708

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.

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

  fn_name = Fcar (args);
721
  CHECK_SYMBOL (fn_name);
722 723 724 725 726 727
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
728 729
      doc = XCAR (tail);
      tail = XCDR (tail);
730 731 732 733 734 735 736 737 738 739 740 741
    }

  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;
	}
742

743 744 745 746 747 748 749 750
      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));
751

Jim Blandy's avatar
Jim Blandy committed
752
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
753
    defn = Fpurecopy (defn);
754 755 756
  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
757
  Ffset (fn_name, defn);
758
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
759 760 761
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
762

763
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
764
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
765
Aliased variables always have the same value; setting one sets the other.
766 767 768 769 770 771 772
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
773 774
{
  struct Lisp_Symbol *sym;
775

776 777
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
778

779
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
780 781
    error ("Cannot make a constant an alias");

782
  sym = XSYMBOL (new_alias);
Gerd Moellmann's avatar
Gerd Moellmann committed
783
  sym->indirect_variable = 1;
784 785 786
  sym->value = base_variable;
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
787
  if (!NILP (docstring))
788
    Fput (new_alias, Qvariable_documentation, docstring);
789
  else
790
    Fput (new_alias, Qvariable_documentation, Qnil);
791

792
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
793 794 795
}


Jim Blandy's avatar
Jim Blandy committed
796
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
797
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
798 799 800 801 802 803 804 805 806 807 808 809
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.
810 811 812 813 814 815 816

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.)
817
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
818
     (args)
Jim Blandy's avatar
Jim Blandy committed
819 820
     Lisp_Object args;
{
821
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
822 823

  sym = Fcar (args);
824 825
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
826
    error ("Too many arguments");
827

828
  tem = Fdefault_boundp (sym);
829
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
830
    {
831 832 833 834 835 836 837 838 839 840 841 842
      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
843
      if (NILP (tem))
844
	Fset_default (sym, Feval (Fcar (tail)));
845 846 847
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
848
	  volatile struct specbinding *pdl = specpdl_ptr;
849 850 851 852 853 854 855 856 857 858 859
	  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;
		}
	    }
	}
860
      tail = Fcdr (tail);
861 862
      tem = Fcar (tail);
      if (!NILP (tem))
863 864 865 866 867
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
868
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
869
    }
870
  else
871 872 873
    /* 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
874 875
    ;

Jim Blandy's avatar
Jim Blandy committed
876 877 878 879
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
880 881 882 883 884 885
       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.
886 887 888 889

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.
890
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
891
     (args)
Jim Blandy's avatar
Jim Blandy committed
892 893 894 895 896
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
897
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
898
    error ("Too many arguments");
899

900 901 902 903
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
904
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
905
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
906
    {
Jim Blandy's avatar
Jim Blandy committed
907
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
908 909 910
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
911
  Fput (sym, Qrisky_local_variable, Qt);
912
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
913 914 915
  return sym;
}

916 917 918 919 920 921 922 923
/* 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
924
DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
925
       doc: /* Return t if VARIABLE is intended to be set and modified by users.
Pavel Janík's avatar
Pavel Janík committed
926
\(The alternative is a variable used internally in a Lisp program.)
927 928 929 930 931 932 933
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
934
     (variable)
Jim Blandy's avatar
Jim Blandy committed
935 936 937
     Lisp_Object variable;
{
  Lisp_Object documentation;
938

939 940 941
  if (!SYMBOLP (variable))
      return Qnil;

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
  /* If indirect and there's an alias loop, don't check anything else.  */
  if (XSYMBOL (variable)->indirect_variable
      && NILP (internal_condition_case_1 (indirect_variable, variable,