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,
3
                 2002, 2003, 2004, 2005, 2006 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 31 32 33 34
#include <setjmp.h>

/* This definition is duplicated in alloc.c and keyboard.c */
/* Putting it in lisp.h makes cc bomb out! */

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

struct backtrace *backtrace_list;

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/* 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.  */
67

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

struct catchtag *catchlist;

86 87 88 89 90
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

91
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
92
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
93 94
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
95
Lisp_Object Qdeclare;
Jim Blandy's avatar
Jim Blandy committed
96

97 98 99
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
100

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

Lisp_Object Vautoload_queue;

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

Jim Blandy's avatar
Jim Blandy committed
112 113 114
int specpdl_size;

/* Pointer to beginning of specpdl.  */
115

Jim Blandy's avatar
Jim Blandy committed
116 117 118
struct specbinding *specpdl;

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

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

/* Maximum size allowed for specpdl allocation */
123

124
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
125 126

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

Jim Blandy's avatar
Jim Blandy committed
128 129 130
int lisp_eval_depth;

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

132
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
133 134

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

Jim Blandy's avatar
Jim Blandy committed
136 137
int debug_on_next_call;

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

Roland McGrath's avatar
Roland McGrath committed
147
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
148

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

Roland McGrath's avatar
Roland McGrath committed
152
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
153

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

Karl Heuer's avatar
Karl Heuer committed
157 158
Lisp_Object Vdebug_ignored_errors;

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

161
Lisp_Object Vdebug_on_signal;
162 163

/* Hook for edebug to use.  */
164

165 166
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
170 171
int debug_on_quit;

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

179
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
180 181 182

Lisp_Object Vdebugger;

183 184 185 186 187
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

188 189 190 191 192 193
/* 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;

194 195 196 197
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

198
extern Lisp_Object Qrisky_local_variable;
199

200
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
201
static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
202 203 204 205 206 207 208 209

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
222 223
}

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

241 242 243 244 245 246 247 248
/* 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));
249
  return Qnil;
250 251 252 253
}

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

Jim Blandy's avatar
Jim Blandy committed
254 255 256 257
Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
258
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
259
  int count = SPECPDL_INDEX ();
260
  Lisp_Object val;
261
  int old_max = max_specpdl_size;
262

263 264
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
265

266 267 268 269 270 271 272 273 274 275 276
  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;
277

278
#ifdef HAVE_X_WINDOWS
279 280
  if (display_hourglass_p)
    cancel_hourglass ();
281 282
#endif

Jim Blandy's avatar
Jim Blandy committed
283
  debug_on_next_call = 0;
284
  when_entered_debugger = num_nonmacro_input_events;
285 286 287 288 289

  /* 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;
290 291
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
292
  specbind (Qinhibit_redisplay, Qnil);
293
  specbind (Qdebug_on_error, Qnil);
294 295 296

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

300 301 302 303
  val = apply1 (Vdebugger, arg);

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

308
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
309 310
}

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

335
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
336

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

  UNGCPRO;
  return val;
}

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

360
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
361

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

  UNGCPRO;
  return val;
}

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

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

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

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

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
431
       doc: /* Eval BODY forms sequentially and return value of last one.
432
usage: (progn BODY ...)  */)
Pavel Janík's avatar
Pavel Janík committed
433
     (args)
Jim Blandy's avatar
Jim Blandy committed
434 435
     Lisp_Object args;
{
436
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
437 438
  struct gcpro gcpro1;

439
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
440

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

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
452 453 454
       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.
455
usage: (prog1 FIRST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
456
     (args)
Jim Blandy's avatar
Jim Blandy committed
457 458 459 460 461 462 463
     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
464
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478
    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
479
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
480 481 482 483 484 485

  UNGCPRO;
  return val;
}

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

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
522 523 524 525 526 527 528 529 530
       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
531 532 533 534 535 536
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

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

  UNGCPRO;
  return val;
}
555

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

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

576

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


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

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


/*  Return 1 if function in which this appears was called using
    call-interactively.
617 618 619 620 621 622 623 624 625 626

    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
627 628

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
629 630

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

  /* If we're running an Emacs 18-style byte-compiled function, there
638 639 640
     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
641

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

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

Jim Blandy's avatar
Jim Blandy committed
657 658 659
  /* 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))
660 661
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
662 663
}

664

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

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

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

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.

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

  fn_name = Fcar (args);
717
  CHECK_SYMBOL (fn_name);
718 719 720 721 722 723
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
724 725
      doc = XCAR (tail);
      tail = XCDR (tail);
726 727 728 729 730 731 732 733 734 735 736 737
    }

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

739 740 741 742 743 744 745 746
      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));
747

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

Gerd Moellmann's avatar
Gerd Moellmann committed
758

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

772 773
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
774

775
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
776 777
    error ("Cannot make a constant an alias");

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

788
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
789 790 791
}


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

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

  sym = Fcar (args);
820 821
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
822
    error ("Too many arguments");
823

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

Jim Blandy's avatar
Jim Blandy committed
872 873 874 875
  return sym;
}

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

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

  sym = Fcar (args);
893
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
894
    error ("Too many arguments");
895

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

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

935 936 937
  if (!SYMBOLP (variable))
      return Qnil;

938 939 940 941 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
  /* 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,
                                          Qt, user_variable_p_eh)))
    return Qnil;

  while (1)
    {
      documentation = Fget (variable, Qvariable_documentation);
      if (INTEGERP (documentation) && XINT (documentation) < 0)
        return Qt;
      if (STRINGP (documentation)
          && ((unsigned char) SREF (documentation, 0) == '*'))
        return Qt;
      /* If it is (STRING . INTEGER), a negative integer means a user variable.  */
      if (CONSP (documentation)
          && STRINGP (XCAR (documentation))
          && INTEGERP (XCDR (documentation))
          && XINT (XCDR (documentation)) < 0)
        return Qt;
      /* Customizable?  See `custom-variable-p'.  */
      if ((!NILP (Fget (variable, intern ("standard-value"))))
          || (!NILP (Fget (variable, intern ("custom-autoload")))))
        return Qt;