eval.c 96.3 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
Stefan Monnier's avatar
Stefan Monnier committed
2
   Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000, 2001, 02, 2004
3
     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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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 106 107 108 109 110
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:
   (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide.  */

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
volatile 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 198
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;


199
static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
Jim Blandy's avatar
Jim Blandy committed
200

Andreas Schwab's avatar
Andreas Schwab committed
201
void
Jim Blandy's avatar
Jim Blandy committed
202 203 204
init_eval_once ()
{
  specpdl_size = 50;
205
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
206
  specpdl_ptr = specpdl;
207
  max_specpdl_size = 1000;
208
  max_lisp_eval_depth = 300;
209 210

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
211 212
}

Andreas Schwab's avatar
Andreas Schwab committed
213
void
Jim Blandy's avatar
Jim Blandy committed
214 215 216 217 218 219 220 221 222
init_eval ()
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
223
#ifdef DEBUG_GCPRO
224
  gcpro_level = 0;
225
#endif
226
  /* This is less than the initial value of num_nonmacro_input_events.  */
227
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
228 229 230 231 232 233
}

Lisp_Object
call_debugger (arg)
     Lisp_Object arg;
{
234
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
235
  int count = SPECPDL_INDEX ();
236
  Lisp_Object val;
237

Jim Blandy's avatar
Jim Blandy committed
238 239
  if (lisp_eval_depth + 20 > max_lisp_eval_depth)
    max_lisp_eval_depth = lisp_eval_depth + 20;
240

Jim Blandy's avatar
Jim Blandy committed
241 242
  if (specpdl_size + 40 > max_specpdl_size)
    max_specpdl_size = specpdl_size + 40;
243

244
#ifdef HAVE_X_WINDOWS
245 246
  if (display_hourglass_p)
    cancel_hourglass ();
247 248
#endif

Jim Blandy's avatar
Jim Blandy committed
249
  debug_on_next_call = 0;
250
  when_entered_debugger = num_nonmacro_input_events;
251 252 253 254 255

  /* 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;
256 257
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
258
  specbind (Qinhibit_redisplay, Qnil);
259 260 261

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

265 266 267 268
  val = apply1 (Vdebugger, arg);

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

273
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
274 275
}

Andreas Schwab's avatar
Andreas Schwab committed
276
void
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280 281 282 283 284 285 286 287 288 289
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
290 291 292
       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.
293
usage: (or CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
294
     (args)
Jim Blandy's avatar
Jim Blandy committed
295 296
     Lisp_Object args;
{
297
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
298 299
  struct gcpro gcpro1;

300
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
301

302
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
303
    {
304
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
305
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
306
	break;
307
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312 313 314
    }

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
315
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
316 317
The remaining args are not evalled at all.
If no arg yields nil, return the last arg's value.
318
usage: (and CONDITIONS ...)  */)
Pavel Janík's avatar
Pavel Janík committed
319
     (args)
Jim Blandy's avatar
Jim Blandy committed
320 321
     Lisp_Object args;
{
322
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
323 324
  struct gcpro gcpro1;

325
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
326

327
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
328
    {
329
      val = Feval (XCAR (args));
Jim Blandy's avatar
Jim Blandy committed
330
      if (NILP (val))
Jim Blandy's avatar
Jim Blandy committed
331
	break;
332
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339
    }

  UNGCPRO;
  return val;
}

DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
340
       doc: /* If COND yields non-nil, do THEN, else do ELSE...
Pavel Janík's avatar
Pavel Janík committed
341 342 343
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.
344
usage: (if COND THEN ELSE...)  */)
Pavel Janík's avatar
Pavel Janík committed
345
     (args)
Jim Blandy's avatar
Jim Blandy committed
346 347 348 349 350 351 352 353 354
     Lisp_Object args;
{
  register Lisp_Object cond;
  struct gcpro gcpro1;

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

Jim Blandy's avatar
Jim Blandy committed
355
  if (!NILP (cond))
Jim Blandy's avatar
Jim Blandy committed
356 357 358 359 360
    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
361 362 363 364 365 366 367 368
       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.
369
usage: (cond CLAUSES...)  */)
Pavel Janík's avatar
Pavel Janík committed
370
     (args)
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376 377
     Lisp_Object args;
{
  register Lisp_Object clause, val;
  struct gcpro gcpro1;

  val = Qnil;
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
378
  while (!NILP (args))
Jim Blandy's avatar
Jim Blandy committed
379 380 381
    {
      clause = Fcar (args);
      val = Feval (Fcar (clause));
Jim Blandy's avatar
Jim Blandy committed
382
      if (!NILP (val))
Jim Blandy's avatar
Jim Blandy committed
383
	{
384 385
	  if (!EQ (XCDR (clause), Qnil))
	    val = Fprogn (XCDR (clause));
Jim Blandy's avatar
Jim Blandy committed
386 387
	  break;
	}
388
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395
    }
  UNGCPRO;

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
396
       doc: /* Eval BODY forms sequentially and return value of last one.
397
usage: (progn BODY ...)  */)
Pavel Janík's avatar
Pavel Janík committed
398
     (args)
Jim Blandy's avatar
Jim Blandy committed
399 400
     Lisp_Object args;
{
401
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
402 403
  struct gcpro gcpro1;

404
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
405

406
  while (CONSP (args))
Jim Blandy's avatar
Jim Blandy committed
407
    {
408 409
      val = Feval (XCAR (args));
      args = XCDR (args);
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414 415 416
    }

  UNGCPRO;
  return val;
}

DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
417 418 419
       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.
420
usage: (prog1 FIRST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
421
     (args)
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427 428
     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
429
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443
    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
444
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
445 446 447 448 449 450

  UNGCPRO;
  return val;
}

DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
451 452 453
       doc: /* Eval X, Y and BODY sequentially; value from Y.
The value of Y is saved during the evaluation of the remaining args,
whose values are discarded.
454
usage: (prog2 X Y BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
455
     (args)
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459 460 461 462 463 464
     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
465
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479
    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
480
  while (!NILP (args_left));
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484 485 486

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
487 488 489 490 491 492 493 494 495
       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
496 497 498 499 500 501
     Lisp_Object args;
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

Jim Blandy's avatar
Jim Blandy committed
502
  if (NILP(args))
Jim Blandy's avatar
Jim Blandy committed
503 504 505 506 507 508 509 510 511 512 513 514
    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
515
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
516 517 518 519

  UNGCPRO;
  return val;
}
520

Jim Blandy's avatar
Jim Blandy committed
521
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
522 523 524
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
     (args)
Jim Blandy's avatar
Jim Blandy committed
525 526 527 528
     Lisp_Object args;
{
  return Fcar (args);
}
529

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

541

Jim Blandy's avatar
Jim Blandy committed
542
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
543
       doc: /* Return t if the function was run directly by user input.
Pavel Janík's avatar
Pavel Janík committed
544 545
This means that the function was called with call-interactively (which
includes being called as the binding of a key)
546 547 548 549 550 551 552 553 554 555 556 557 558
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
559
     ()
Jim Blandy's avatar
Jim Blandy committed
560
{
561
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
562 563 564
}


565
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 0, 0,
566 567 568 569 570 571 572 573 574 575
       doc: /* Return t if the function using this was called with call-interactively.
This is used for implementing advice and other function-modifying
features of Emacs.

The cleanest way 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.)  */)
     ()
{
576
  return interactive_p (1) ? Qt : Qnil;
577 578 579 580 581
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
582 583 584 585 586 587 588 589 590 591

    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
592 593

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
594 595

  /* If this isn't a byte-compiled function, there may be a frame at
596
     the top for Finteractive_p.  If so, skip it.  */
Jim Blandy's avatar
Jim Blandy committed
597
  fun = Findirect_function (*btp->function);
598 599
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
600
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
601 602

  /* If we're running an Emacs 18-style byte-compiled function, there
603 604 605
     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
606

607
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
608
     looking at several frames for special forms.  Skip past them.  */
609 610 611
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
612 613
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
614 615 616 617
  /* 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.  */
Jim Blandy's avatar
Jim Blandy committed
618
  fun = Findirect_function (*btp->function);
619 620
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
621

Jim Blandy's avatar
Jim Blandy committed
622 623 624
  /* 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))
625 626
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
627 628
}

629

Jim Blandy's avatar
Jim Blandy committed
630
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
631 632 633
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
634
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
635
     (args)
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
642
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
643
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
644
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
645
    defn = Fpurecopy (defn);
646 647 648
  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
649
  Ffset (fn_name, defn);
650
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
651 652 653 654
  return fn_name;
}

DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
655
       doc: /* Define NAME as a macro.
Richard M. Stallman's avatar
Richard M. Stallman committed
656 657
The actual definition looks like
 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
Pavel Janík's avatar
Pavel Janík committed
658 659 660 661
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
662 663 664 665 666 667 668 669

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.

670
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
671
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
672
	equivalent to writing a `def-edebug-spec' for the macro.)
Richard M. Stallman's avatar
Richard M. Stallman committed
673
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
674
     (args)
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
679
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
680 681

  fn_name = Fcar (args);
682
  CHECK_SYMBOL (fn_name);
683 684 685 686 687 688
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
689 690
      doc = XCAR (tail);
      tail = XCDR (tail);
691 692 693 694 695 696 697 698 699 700 701 702
    }

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

704 705 706 707 708 709 710 711
      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));
712

Jim Blandy's avatar
Jim Blandy committed
713
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
714
    defn = Fpurecopy (defn);
715 716 717
  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
718
  Ffset (fn_name, defn);
719
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
720 721 722
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
723

724
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
Pavel Janík's avatar
Pavel Janík committed
725 726 727
       doc: /* Make SYMBOL a variable alias for symbol ALIASED.
Setting the value of SYMBOL will subsequently set the value of ALIASED,
and getting the value of SYMBOL will return the value ALIASED has.
Luc Teirlinck's avatar
Luc Teirlinck committed
728 729
Third arg DOCSTRING, if non-nil, is documentation for SYMBOL.
The return value is ALIASED.  */)
730 731
     (symbol, aliased, docstring)
     Lisp_Object symbol, aliased, docstring;
Gerd Moellmann's avatar
Gerd Moellmann committed
732 733
{
  struct Lisp_Symbol *sym;
734

735 736
  CHECK_SYMBOL (symbol);
  CHECK_SYMBOL (aliased);
Gerd Moellmann's avatar
Gerd Moellmann committed
737 738 739 740 741 742 743 744

  if (SYMBOL_CONSTANT_P (symbol))
    error ("Cannot make a constant an alias");

  sym = XSYMBOL (symbol);
  sym->indirect_variable = 1;
  sym->value = aliased;
  sym->constant = SYMBOL_CONSTANT_P (aliased);
745
  LOADHIST_ATTACH (symbol);
746 747 748
  if (!NILP (docstring))
    Fput (symbol, Qvariable_documentation, docstring);

Gerd Moellmann's avatar
Gerd Moellmann committed
749 750 751 752
  return aliased;
}


Jim Blandy's avatar
Jim Blandy committed
753
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
754 755 756 757 758 759 760 761 762 763 764 765 766
       doc: /* Define SYMBOL as a variable.
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.
767 768 769 770 771 772 773

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.)
774
usage: (defvar SYMBOL &optional INITVALUE DOCSTRING)  */)
Pavel Janík's avatar
Pavel Janík committed
775
     (args)
Jim Blandy's avatar
Jim Blandy committed
776 777
     Lisp_Object args;
{
778
  register Lisp_Object sym, tem, tail;
Jim Blandy's avatar
Jim Blandy committed
779 780

  sym = Fcar (args);
781 782 783 784
  tail = Fcdr (args);
  if (!NILP (Fcdr (Fcdr (tail))))
    error ("too many arguments");

785
  tem = Fdefault_boundp (sym);
786
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
787
    {
Jim Blandy's avatar
Jim Blandy committed
788
      if (NILP (tem))
789
	Fset_default (sym, Feval (Fcar (tail)));
790 791 792
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
793
	  volatile struct specbinding *pdl = specpdl_ptr;
794 795 796 797 798 799 800 801 802 803 804
	  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;
		}
	    }
	}
805
      tail = Fcdr (tail);
806 807
      tem = Fcar (tail);
      if (!NILP (tem))
808 809 810 811 812
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
813
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
814
    }
815
  else
816 817 818
    /* 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
819 820
    ;

Jim Blandy's avatar
Jim Blandy committed
821 822 823 824
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
825 826 827 828 829 830
       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.
831 832 833 834

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.
835
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
836
     (args)
Jim Blandy's avatar
Jim Blandy committed
837 838 839 840 841
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
842 843 844
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
    error ("too many arguments");

845 846 847 848
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
849
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
850
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
851
    {
Jim Blandy's avatar
Jim Blandy committed
852
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
853 854 855
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
856
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
857 858 859 860
  return sym;
}

DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
Pavel Janík's avatar
Pavel Janík committed
861 862 863 864
       doc: /* Returns t if VARIABLE is intended to be set and modified by users.
\(The alternative is a variable used internally in a Lisp program.)
Determined by whether the first character of the documentation
for the variable is `*' or if the variable is customizable (has a non-nil
865
value of `standard-value' or of `custom-autoload' on its property list).  */)
Pavel Janík's avatar
Pavel Janík committed
866
     (variable)
Jim Blandy's avatar
Jim Blandy committed
867 868 869
     Lisp_Object variable;
{
  Lisp_Object documentation;
870

871 872 873
  if (!SYMBOLP (variable))
      return Qnil;

Jim Blandy's avatar
Jim Blandy committed
874
  documentation = Fget (variable, Qvariable_documentation);
875
  if (INTEGERP (documentation) && XINT (documentation) < 0)
Jim Blandy's avatar
Jim Blandy committed
876
    return Qt;
877
  if (STRINGP (documentation)
878
      && ((unsigned char) SREF (documentation, 0) == '*'))
879 880 881
    return Qt;
  /* If it is (STRING . INTEGER), a negative integer means a user variable.  */
  if (CONSP (documentation)
882 883 884
      && STRINGP (XCAR (documentation))
      && INTEGERP (XCDR (documentation))
      && XINT (XCDR (documentation)) < 0)
Jim Blandy's avatar
Jim Blandy committed
885
    return Qt;
886 887 888
  /* Customizable?  See `custom-variable-p'. */
  if ((!NILP (Fget (variable, intern ("standard-value"))))
      || (!NILP (Fget (variable, intern ("custom-autoload")))))
889
    return Qt;
Jim Blandy's avatar
Jim Blandy committed
890
  return Qnil;
891
}
Jim Blandy's avatar
Jim Blandy committed
892 893

DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
894 895 896 897 898
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
Each VALUEFORM can refer to the symbols already bound by this VARLIST.
899
usage: (let* VARLIST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
900
     (args)
Jim Blandy's avatar
Jim Blandy committed
901 902 903
     Lisp_Object args;
{
  Lisp_Object varlist, val, elt;
Juanma Barranquero's avatar
Juanma Barranquero committed
904
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
905 906 907 908 909
  struct gcpro gcpro1, gcpro2, gcpro3;

  GCPRO3 (args, elt, varlist);

  varlist = Fcar (args);
Jim Blandy's avatar
Jim Blandy committed
910
  while (!NILP (varlist))
Jim Blandy's avatar
Jim Blandy committed
911 912 913
    {
      QUIT;
      elt = Fcar (varlist);
914
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
915
	specbind (elt, Qnil);
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919
      else if (! NILP (Fcdr (Fcdr (elt))))
	Fsignal (Qerror,
		 Fcons (build_string ("`let' bindings can have only one value-form"),
			elt));
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924 925 926 927 928 929 930 931 932
      else
	{
	  val = Feval (Fcar (Fcdr (elt)));
	  specbind (Fcar (elt), val);
	}
      varlist = Fcdr (varlist);
    }
  UNGCPRO;
  val = Fprogn (Fcdr (args));
  return unbind_to (count, val);
}

DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
933 934 935 936 937
       doc: /* Bind variables according to VARLIST then eval BODY.
The value of the last form in BODY is returned.
Each element of VARLIST is a symbol (which is bound to nil)
or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
All the VALUEFORMs are evalled before any symbols are bound.
938
usage: (let VARLIST BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
939
     (args)
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943
     Lisp_Object args;
{
  Lisp_Object *temps, tem;
  register Lisp_Object elt, varlist;
Juanma Barranquero's avatar
Juanma Barranquero committed
944
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958
  register int argnum;
  struct gcpro gcpro1, gcpro2;

  varlist = Fcar (args);

  /* Make space to hold the values to give the bound variables */
  elt = Flength (varlist);
  temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));

  /* Compute the values and store them in `temps' */

  GCPRO2 (args, *temps);
  gcpro2.nvars = 0;

Jim Blandy's avatar
Jim Blandy committed
959
  for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
Jim Blandy's avatar
Jim Blandy committed
960 961 962
    {
      QUIT;
      elt = Fcar (varlist);
963
      if (SYMBOLP (elt))
Jim Blandy's avatar
Jim Blandy committed
964
	temps [argnum++] = Qnil;
Jim Blandy's avatar
Jim Blandy committed
965 966 967 968