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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

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

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

struct backtrace *backtrace_list;

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

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

struct catchtag *catchlist;

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

94
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
95
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
96 97
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
98
Lisp_Object Qdeclare;
99
Lisp_Object Qdebug;
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 205
extern Lisp_Object Qfunction;

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

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

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
228 229
}

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

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

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

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

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

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

284
#ifdef HAVE_WINDOW_SYSTEM
285 286
  if (display_hourglass_p)
    cancel_hourglass ();
287 288
#endif

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

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

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

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

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

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

Andreas Schwab's avatar
Andreas Schwab committed
317
void
Jim Blandy's avatar
Jim Blandy committed
318 319 320 321 322 323 324 325 326 327 328 329 330
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
331 332 333
       doc: /* Eval args until one of them yields non-nil, then return that value.
The remaining args are not evalled at all.
If all args return nil, return nil.
Juanma Barranquero's avatar
Juanma Barranquero committed
334
usage: (or CONDITIONS...)  */)
Pavel Janík's avatar
Pavel Janík committed
335
     (args)
Jim Blandy's avatar
Jim Blandy committed
336 337
     Lisp_Object args;
{
338
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
339 340
  struct gcpro gcpro1;

341
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
342

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

  UNGCPRO;
  return val;
}

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

366
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
367

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

  UNGCPRO;
  return val;
}

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

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

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

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

  return val;
}

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

445
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
446

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

  UNGCPRO;
  return val;
}

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

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

  UNGCPRO;
  return val;
}

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

  UNGCPRO;
  return val;
}

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

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

  UNGCPRO;
  return val;
}
561

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

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

586

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


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

The cleanest way to test whether your function was called with
616 617 618
`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.)  */)
619 620
     ()
{
621
  return interactive_p (1) ? Qt : Qnil;
622 623 624 625 626
}


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

    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
637 638

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
639 640

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

  /* If we're running an Emacs 18-style byte-compiled function, there
648 649 650
     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
651

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

Jim Blandy's avatar
Jim Blandy committed
659 660 661 662
  /* 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.  */
663
  fun = Findirect_function (*btp->function, Qnil);
664 665
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
666

Jim Blandy's avatar
Jim Blandy committed
667 668 669
  /* 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))
670 671
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
672 673
}

674

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

  fn_name = Fcar (args);
687
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
688
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
689
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
690
    defn = Fpurecopy (defn);
691 692 693
  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
694
  Ffset (fn_name, defn);
695
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
696 697 698 699
  return fn_name;
}

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

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
709 710
calls to this macro, how Edebug should handle it, and which argument
should be treated as documentation.  It looks like this:
Richard M. Stallman's avatar
Richard M. Stallman committed
711 712 713 714 715
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

716
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
717
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
718
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
719 720 721 722

  (doc-string ELT)
	Set NAME's `doc-string-elt' property to ELT.

Richard M. Stallman's avatar
Richard M. Stallman committed
723
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Pavel Janík's avatar
Pavel Janík committed
724
     (args)
Jim Blandy's avatar
Jim Blandy committed
725 726 727 728
     Lisp_Object args;
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
729
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
730 731

  fn_name = Fcar (args);
732
  CHECK_SYMBOL (fn_name);
733 734 735 736 737 738
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

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

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

754 755 756 757 758 759 760 761
      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));
762

Jim Blandy's avatar
Jim Blandy committed
763
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
764
    defn = Fpurecopy (defn);
765 766 767
  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
768
  Ffset (fn_name, defn);
769
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
770 771 772
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
773

774
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
775
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
776
Aliased variables always have the same value; setting one sets the other.
777
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
778 779 780 781
omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
itself an alias.  If NEW-ALIAS is bound, and BASE-VARIABLE is not,
then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
782 783 784
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
785 786
{
  struct Lisp_Symbol *sym;
787

788 789
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
790

791
  if (SYMBOL_CONSTANT_P (new_alias))
Gerd Moellmann's avatar
Gerd Moellmann committed
792 793
    error ("Cannot make a constant an alias");

794
  sym = XSYMBOL (new_alias);
795 796 797 798 799 800
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
     If n_a is bound, but b_v is not, set the value of b_v to n_a.
     This is for the sake of define-obsolete-variable-alias and user
     customizations.  */
  if (NILP (Fboundp (base_variable)) && !NILP (Fboundp (new_alias)))
    XSYMBOL(base_variable)->value = sym->value;
Gerd Moellmann's avatar
Gerd Moellmann committed
801
  sym->indirect_variable = 1;
802 803 804
  sym->value = base_variable;
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
805
  if (!NILP (docstring))
806
    Fput (new_alias, Qvariable_documentation, docstring);
807
  else
808
    Fput (new_alias, Qvariable_documentation, Qnil);
809

810
  return base_variable;
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812 813
}


Jim Blandy's avatar
Jim Blandy committed
814
DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
Juanma Barranquero's avatar
Juanma Barranquero committed
815
       doc: /* Define SYMBOL as a variable, and return SYMBOL.
Pavel Janík's avatar
Pavel Janík committed
816 817 818 819 820 821 822 823 824 825 826 827
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.
828 829 830 831 832 833 834

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

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

846
  tem = Fdefault_boundp (sym);
847
  if (!NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
848
    {
849 850 851 852 853 854 855 856 857 858 859 860
      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
861
      if (NILP (tem))
862
	Fset_default (sym, Feval (Fcar (tail)));
863 864 865
      else
	{ /* Check if there is really a global binding rather than just a let
	     binding that shadows the global unboundness of the var.  */
866
	  volatile struct specbinding *pdl = specpdl_ptr;
867 868 869 870 871 872 873 874 875 876 877
	  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;
		}
	    }
	}
878
      tail = Fcdr (tail);
879 880
      tem = Fcar (tail);
      if (!NILP (tem))
881 882 883 884 885
	{
	  if (!NILP (Vpurify_flag))
	    tem = Fpurecopy (tem);
	  Fput (sym, Qvariable_documentation, tem);
	}
886
      LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
887
    }
888
  else
889 890 891
    /* 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
892 893
    ;

Jim Blandy's avatar
Jim Blandy committed
894 895 896 897
  return sym;
}

DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
898 899 900 901 902 903
       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.
904 905 906 907

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.
908
usage: (defconst SYMBOL INITVALUE [DOCSTRING])  */)
Pavel Janík's avatar
Pavel Janík committed
909
     (args)
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914
     Lisp_Object args;
{
  register Lisp_Object sym, tem;

  sym = Fcar (args);
915
  if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
916
    error ("Too many arguments");
917

918 919 920 921
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
922
  tem = Fcar (Fcdr (Fcdr (args)));
Jim Blandy's avatar
Jim Blandy committed
923
  if (!NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
924
    {
Jim Blandy's avatar
Jim Blandy committed
925
      if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
926 927 928
	tem = Fpurecopy (tem);
      Fput (sym, Qvariable_documentation, tem);
    }
929
  Fput (sym, Qrisky_local_variable, Qt);
930
  LOADHIST_ATTACH (sym);
Jim Blandy's avatar
Jim Blandy committed
931 932 933
  return sym;
}

934 935 936 937 938 939 940