eval.c 106 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Evaluator for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
                 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 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>
23
#include <setjmp.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"
29
#include "frame.h"		/* For XFRAME.  */
Jim Blandy's avatar
Jim Blandy committed
30

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

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

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

struct backtrace *backtrace_list;

struct catchtag *catchlist;

55 56 57 58 59
#ifdef DEBUG_GCPRO
/* Count levels of GCPRO to detect failure to UNGCPRO.  */
int gcpro_level;
#endif

60
Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
Jim Blandy's avatar
Jim Blandy committed
61
Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
Jim Blandy's avatar
Jim Blandy committed
62 63
Lisp_Object Qand_rest, Qand_optional;
Lisp_Object Qdebug_on_error;
64
Lisp_Object Qdeclare;
65
Lisp_Object Qdebug;
66
extern Lisp_Object Qinteractive_form;
Jim Blandy's avatar
Jim Blandy committed
67

68 69 70
/* This holds either the symbol `run-hooks' or nil.
   It is nil at an early stage of startup, and when Emacs
   is shutting down.  */
71

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75 76
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:
77
   (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide.  */
Jim Blandy's avatar
Jim Blandy committed
78 79 80 81

Lisp_Object Vautoload_queue;

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

Jim Blandy's avatar
Jim Blandy committed
83 84 85
int specpdl_size;

/* Pointer to beginning of specpdl.  */
86

Jim Blandy's avatar
Jim Blandy committed
87 88 89
struct specbinding *specpdl;

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

91
struct specbinding *specpdl_ptr;
Jim Blandy's avatar
Jim Blandy committed
92 93

/* Maximum size allowed for specpdl allocation */
94

95
EMACS_INT max_specpdl_size;
Jim Blandy's avatar
Jim Blandy committed
96 97

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

Jim Blandy's avatar
Jim Blandy committed
99 100 101
int lisp_eval_depth;

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

103
EMACS_INT max_lisp_eval_depth;
Jim Blandy's avatar
Jim Blandy committed
104 105

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

Jim Blandy's avatar
Jim Blandy committed
107 108
int debug_on_next_call;

109
/* Non-zero means debugger may continue.  This is zero when the
110 111 112 113 114
   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
115
/* List of conditions (non-nil atom means all) which cause a backtrace
116
   if an error is handled by the command loop's error handler.  */
117

Roland McGrath's avatar
Roland McGrath committed
118
Lisp_Object Vstack_trace_on_error;
Jim Blandy's avatar
Jim Blandy committed
119

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

Roland McGrath's avatar
Roland McGrath committed
123
Lisp_Object Vdebug_on_error;
Jim Blandy's avatar
Jim Blandy committed
124

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

Karl Heuer's avatar
Karl Heuer committed
128 129
Lisp_Object Vdebug_ignored_errors;

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

132
Lisp_Object Vdebug_on_signal;
133 134

/* Hook for edebug to use.  */
135

136 137
Lisp_Object Vsignal_hook_function;

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

Jim Blandy's avatar
Jim Blandy committed
141 142
int debug_on_quit;

143
/* The value of num_nonmacro_input_events as of the last time we
144
   started to enter the debugger.  If we decide to enter the debugger
145
   again when this is still equal to num_nonmacro_input_events, then we
146 147 148
   know that the debugger itself has an error, and we should just
   signal the error instead of entering an infinite loop of debugger
   invocations.  */
149

150
int when_entered_debugger;
Jim Blandy's avatar
Jim Blandy committed
151 152 153

Lisp_Object Vdebugger;

154 155 156 157 158
/* The function from which the last `signal' was called.  Set in
   Fsignal.  */

Lisp_Object Vsignaling_function;

159 160 161 162 163 164
/* 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;

165 166 167 168
/* Function to process declarations in defmacro forms.  */

Lisp_Object Vmacro_declaration_function;

169
extern Lisp_Object Qrisky_local_variable;
170

171 172
extern Lisp_Object Qfunction;

173 174
static Lisp_Object funcall_lambda (Lisp_Object, int, Lisp_Object*);
static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
175 176 177 178 179

#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.  */
180 181
Lisp_Object apply1 (Lisp_Object fn, Lisp_Object arg) __attribute__((noinline));
Lisp_Object call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2) __attribute__((noinline));
182
#endif
183

Andreas Schwab's avatar
Andreas Schwab committed
184
void
185
init_eval_once (void)
Jim Blandy's avatar
Jim Blandy committed
186 187
{
  specpdl_size = 50;
188
  specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
189
  specpdl_ptr = specpdl;
190
  /* Don't forget to update docs (lispref node "Local Variables").  */
191
  max_specpdl_size = 1000;
192
  max_lisp_eval_depth = 500;
193 194

  Vrun_hooks = Qnil;
Jim Blandy's avatar
Jim Blandy committed
195 196
}

Andreas Schwab's avatar
Andreas Schwab committed
197
void
198
init_eval (void)
Jim Blandy's avatar
Jim Blandy committed
199 200 201 202 203 204 205 206
{
  specpdl_ptr = specpdl;
  catchlist = 0;
  handlerlist = 0;
  backtrace_list = 0;
  Vquit_flag = Qnil;
  debug_on_next_call = 0;
  lisp_eval_depth = 0;
207
#ifdef DEBUG_GCPRO
208
  gcpro_level = 0;
209
#endif
210
  /* This is less than the initial value of num_nonmacro_input_events.  */
211
  when_entered_debugger = -1;
Jim Blandy's avatar
Jim Blandy committed
212 213
}

214 215 216
/* unwind-protect function used by call_debugger.  */

static Lisp_Object
217
restore_stack_limits (Lisp_Object data)
218 219 220
{
  max_specpdl_size = XINT (XCAR (data));
  max_lisp_eval_depth = XINT (XCDR (data));
221
  return Qnil;
222 223 224 225
}

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

Jim Blandy's avatar
Jim Blandy committed
226
Lisp_Object
227
call_debugger (Lisp_Object arg)
Jim Blandy's avatar
Jim Blandy committed
228
{
229
  int debug_while_redisplaying;
Juanma Barranquero's avatar
Juanma Barranquero committed
230
  int count = SPECPDL_INDEX ();
231
  Lisp_Object val;
232
  int old_max = max_specpdl_size;
233

234 235
  /* Temporarily bump up the stack limits,
     so the debugger won't run out of stack.  */
236

237 238 239 240 241 242 243 244 245 246 247
  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;
248

249
#ifdef HAVE_WINDOW_SYSTEM
250 251
  if (display_hourglass_p)
    cancel_hourglass ();
252 253
#endif

Jim Blandy's avatar
Jim Blandy committed
254
  debug_on_next_call = 0;
255
  when_entered_debugger = num_nonmacro_input_events;
256 257 258 259 260

  /* 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;
261 262
  specbind (intern ("debugger-may-continue"),
	    debug_while_redisplaying ? Qnil : Qt);
263
  specbind (Qinhibit_redisplay, Qnil);
264
  specbind (Qdebug_on_error, Qnil);
265 266 267

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

271 272 273 274
  val = apply1 (Vdebugger, arg);

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

279
  return unbind_to (count, val);
Jim Blandy's avatar
Jim Blandy committed
280 281
}

Andreas Schwab's avatar
Andreas Schwab committed
282
void
283
do_debug_on_call (Lisp_Object code)
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287 288 289 290 291 292 293 294
{
  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
295 296 297
       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
298
usage: (or CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
299
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
300
{
301
  register Lisp_Object val = Qnil;
Jim Blandy's avatar
Jim Blandy committed
302 303
  struct gcpro gcpro1;

304
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
305

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

  UNGCPRO;
  return val;
}

DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
319
       doc: /* Eval args until one of them yields nil, then return nil.
Pavel Janík's avatar
Pavel Janík committed
320 321
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
322
usage: (and CONDITIONS...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
323
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
324
{
325
  register Lisp_Object val = Qt;
Jim Blandy's avatar
Jim Blandy committed
326 327
  struct gcpro gcpro1;

328
  GCPRO1 (args);
Jim Blandy's avatar
Jim Blandy committed
329

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

  UNGCPRO;
  return val;
}

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

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

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

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

  return val;
}

DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
397
       doc: /* Eval BODY forms sequentially and return value of last one.
Juanma Barranquero's avatar
Juanma Barranquero committed
398
usage: (progn BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
399
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
400
{
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,
417
       doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
Pavel Janík's avatar
Pavel Janík committed
418 419
The value of FIRST is saved during the evaluation of the remaining args,
whose values are discarded.
420
usage: (prog1 FIRST BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
421
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427
{
  Lisp_Object val;
  register Lisp_Object args_left;
  struct gcpro gcpro1, gcpro2;
  register int argnum = 0;

428
  if (NILP (args))
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442
    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
443
  while (!NILP(args_left));
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449

  UNGCPRO;
  return val;
}

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

  UNGCPRO;
  return val;
}

DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
485 486 487 488 489 490 491
       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
492
usage: (setq [SYM VAL]...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
493
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
494 495 496 497 498
{
  register Lisp_Object args_left;
  register Lisp_Object val, sym;
  struct gcpro gcpro1;

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

  UNGCPRO;
  return val;
}
517

Jim Blandy's avatar
Jim Blandy committed
518
DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
519 520
       doc: /* Return the argument, without evaluating it.  `(quote x)' yields `x'.
usage: (quote ARG)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
521
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
522
{
523 524
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
525 526
  return Fcar (args);
}
527

Jim Blandy's avatar
Jim Blandy committed
528
DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
529 530 531 532
       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)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
533
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
534
{
535 536
  if (!NILP (Fcdr (args)))
    xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
Jim Blandy's avatar
Jim Blandy committed
537 538 539
  return Fcar (args);
}

540

Jim Blandy's avatar
Jim Blandy committed
541
DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
542
       doc: /* Return t if the containing function was run directly by user input.
543 544
This means that the function was called with `call-interactively'
\(which includes being called as the binding of a key)
545
and input is currently coming from the keyboard (not a keyboard macro),
546 547 548 549 550 551 552 553
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?

554 555 556 557
To test whether your function was called with `call-interactively',
either (i) add an extra optional argument and give it an `interactive'
spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
use `called-interactively-p'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
558
  (void)
Jim Blandy's avatar
Jim Blandy committed
559
{
560
  return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
561 562 563
}


564
DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
565
       doc: /* Return t if the containing function was called by `call-interactively'.
566 567 568 569 570 571 572 573 574 575 576 577
If KIND is `interactive', then only return t if the call was made
interactively by the user, i.e. not in `noninteractive' mode nor
when `executing-kbd-macro'.
If KIND is `any', on the other hand, it will return t for any kind of
interactive call, including being called as the binding of a key, or
from a keyboard macro, or in `noninteractive' mode.

The only known proper use of `interactive' for KIND 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?
578 579 580 581 582

This function is meant for implementing advice and other
function-modifying features.  Instead of using this, it is sometimes
cleaner to give your function an extra optional argument whose
`interactive' spec specifies non-nil unconditionally (\"p\" is a good
583
way to do this), or via (not (or executing-kbd-macro noninteractive)).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
584
  (Lisp_Object kind)
585
{
586 587
  return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
	  && interactive_p (1)) ? Qt : Qnil;
588 589 590 591 592
}


/*  Return 1 if function in which this appears was called using
    call-interactively.
593 594 595 596 597

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

int
598
interactive_p (int exclude_subrs_p)
599 600 601
{
  struct backtrace *btp;
  Lisp_Object fun;
Jim Blandy's avatar
Jim Blandy committed
602 603

  btp = backtrace_list;
Jim Blandy's avatar
Jim Blandy committed
604 605

  /* If this isn't a byte-compiled function, there may be a frame at
606
     the top for Finteractive_p.  If so, skip it.  */
607
  fun = Findirect_function (*btp->function, Qnil);
608 609
  if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
		      || XSUBR (fun) == &Scalled_interactively_p))
Jim Blandy's avatar
Jim Blandy committed
610
    btp = btp->next;
Jim Blandy's avatar
Jim Blandy committed
611 612

  /* If we're running an Emacs 18-style byte-compiled function, there
613 614 615
     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
616

617
     If this isn't a byte-compiled function, then we may now be
Jim Blandy's avatar
Jim Blandy committed
618
     looking at several frames for special forms.  Skip past them.  */
619 620 621
  while (btp
	 && (EQ (*btp->function, Qbytecode)
	     || btp->nargs == UNEVALLED))
Jim Blandy's avatar
Jim Blandy committed
622 623
    btp = btp->next;

Jim Blandy's avatar
Jim Blandy committed
624 625 626 627
  /* 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.  */
628
  fun = Findirect_function (*btp->function, Qnil);
629 630
  if (exclude_subrs_p && SUBRP (fun))
    return 0;
631

Jim Blandy's avatar
Jim Blandy committed
632 633 634
  /* 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))
635 636
    return 1;
  return 0;
Jim Blandy's avatar
Jim Blandy committed
637 638
}

639

Jim Blandy's avatar
Jim Blandy committed
640
DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
Pavel Janík's avatar
Pavel Janík committed
641 642 643
       doc: /* Define NAME as a function.
The definition is (lambda ARGLIST [DOCSTRING] BODY...).
See also the function `interactive'.
644
usage: (defun NAME ARGLIST [DOCSTRING] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
645
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;

  fn_name = Fcar (args);
651
  CHECK_SYMBOL (fn_name);
Jim Blandy's avatar
Jim Blandy committed
652
  defn = Fcons (Qlambda, Fcdr (args));
Jim Blandy's avatar
Jim Blandy committed
653
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
654
    defn = Fpurecopy (defn);
655 656 657
  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
658
  Ffset (fn_name, defn);
659
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
660 661 662 663
  return fn_name;
}

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

DECL is a declaration, optional, which can specify how to indent
John Paul Wallington's avatar
John Paul Wallington committed
673 674
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
675 676 677 678 679
  (declare SPECS...)
The elements can look like this:
  (indent INDENT)
	Set NAME's `lisp-indent-function' property to INDENT.

680
  (debug DEBUG)
Richard M. Stallman's avatar
Richard M. Stallman committed
681
	Set NAME's `edebug-form-spec' property to DEBUG.  (This is
Juanma Barranquero's avatar
Juanma Barranquero committed
682
	equivalent to writing a `def-edebug-spec' for the macro.)
John Paul Wallington's avatar
John Paul Wallington committed
683 684 685 686

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

Richard M. Stallman's avatar
Richard M. Stallman committed
687
usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
688
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
689 690 691
{
  register Lisp_Object fn_name;
  register Lisp_Object defn;
692
  Lisp_Object lambda_list, doc, tail;
Jim Blandy's avatar
Jim Blandy committed
693 694

  fn_name = Fcar (args);
695
  CHECK_SYMBOL (fn_name);
696 697 698 699 700 701
  lambda_list = Fcar (Fcdr (args));
  tail = Fcdr (Fcdr (args));

  doc = Qnil;
  if (STRINGP (Fcar (tail)))
    {
702 703
      doc = XCAR (tail);
      tail = XCDR (tail);
704 705 706 707 708 709 710 711 712 713 714 715
    }

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

717 718 719 720 721 722 723 724
      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));
725

Jim Blandy's avatar
Jim Blandy committed
726
  if (!NILP (Vpurify_flag))
Jim Blandy's avatar
Jim Blandy committed
727
    defn = Fpurecopy (defn);
728 729 730
  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
731
  Ffset (fn_name, defn);
732
  LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
Jim Blandy's avatar
Jim Blandy committed
733 734 735
  return fn_name;
}

Gerd Moellmann's avatar
Gerd Moellmann committed
736

737
DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
738
       doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
Richard M. Stallman's avatar
Richard M. Stallman committed
739
Aliased variables always have the same value; setting one sets the other.
740
Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS.  If it is
741 742 743 744
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.
745
The return value is BASE-VARIABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
746
  (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
Gerd Moellmann's avatar
Gerd Moellmann committed
747 748
{
  struct Lisp_Symbol *sym;
749

750 751
  CHECK_SYMBOL (new_alias);
  CHECK_SYMBOL (base_variable);
Gerd Moellmann's avatar
Gerd Moellmann committed
752

753
  sym = XSYMBOL (new_alias);
754 755

  if (sym->constant)
Stefan Monnier's avatar
Stefan Monnier committed
756 757
    /* Not sure why, but why not?  */
    error ("Cannot make a constant an alias");
758 759 760 761 762 763 764 765 766

  switch (sym->redirect)
    {
    case SYMBOL_FORWARDED:
      error ("Cannot make an internal variable an alias");
    case SYMBOL_LOCALIZED:
      error ("Don't know how to make a localized variable an alias");
    }

767
  /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
768 769 770 771
     If n_a is bound, but b_v is not, set the value of b_v to n_a,
     so that old-code that affects n_a before the aliasing is setup
     still works.  */
  if (NILP (Fboundp (base_variable)))
772
    set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
773 774 775 776 777 778 779 780 781 782 783 784 785

  {
    struct specbinding *p;

    for (p = specpdl_ptr - 1; p >= specpdl; p--)
      if (p->func == NULL
	  && (EQ (new_alias,
		  CONSP (p->symbol) ? XCAR (p->symbol) : p->symbol)))
	error ("Don't know how to make a let-bound variable an alias");
  }

  sym->redirect = SYMBOL_VARALIAS;
  SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
786 787
  sym->constant = SYMBOL_CONSTANT_P (base_variable);
  LOADHIST_ATTACH (new_alias);
788 789
  /* Even if docstring is nil: remove old docstring.  */
  Fput (new_alias, Qvariable_documentation, docstring);
790

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


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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
874 875 876 877
  return sym;
}

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

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

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

897 898 899 900
  tem = Feval (Fcar (Fcdr (args)));
  if (!NILP (Vpurify_flag))
    tem = Fpurecopy (tem);
  Fset_default (sym, tem);
Jim Blandy's avatar
Jim Blandy committed
901
  tem = Fcar (Fcdr (Fcdr (args)));