* cus-start.el (all): Add native condition for font-use-system-font.
[emacs.git] / src / eval.c
blob1c975003318f01671ffabbb7717dcff1a1a745b8
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 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/>. */
22 #include <config.h>
23 #include <setjmp.h>
24 #include "lisp.h"
25 #include "blockinput.h"
26 #include "commands.h"
27 #include "keyboard.h"
28 #include "dispextern.h"
30 #if HAVE_X_WINDOWS
31 #include "xterm.h"
32 #endif
34 /* This definition is duplicated in alloc.c and keyboard.c */
35 /* Putting it in lisp.h makes cc bomb out! */
37 struct backtrace
39 struct backtrace *next;
40 Lisp_Object *function;
41 Lisp_Object *args; /* Points to vector of args. */
42 int nargs; /* Length of vector.
43 If nargs is UNEVALLED, args points to slot holding
44 list of unevalled args */
45 char evalargs;
46 /* Nonzero means call value of debugger when done with this operation. */
47 char debug_on_exit;
50 struct backtrace *backtrace_list;
52 struct catchtag *catchlist;
54 #ifdef DEBUG_GCPRO
55 /* Count levels of GCPRO to detect failure to UNGCPRO. */
56 int gcpro_level;
57 #endif
59 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
60 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
61 Lisp_Object Qand_rest, Qand_optional;
62 Lisp_Object Qdebug_on_error;
63 Lisp_Object Qdeclare;
64 Lisp_Object Qdebug;
65 extern Lisp_Object Qinteractive_form;
67 /* This holds either the symbol `run-hooks' or nil.
68 It is nil at an early stage of startup, and when Emacs
69 is shutting down. */
71 Lisp_Object Vrun_hooks;
73 /* Non-nil means record all fset's and provide's, to be undone
74 if the file being autoloaded is not fully loaded.
75 They are recorded by being consed onto the front of Vautoload_queue:
76 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
78 Lisp_Object Vautoload_queue;
80 /* Current number of specbindings allocated in specpdl. */
82 int specpdl_size;
84 /* Pointer to beginning of specpdl. */
86 struct specbinding *specpdl;
88 /* Pointer to first unused element in specpdl. */
90 struct specbinding *specpdl_ptr;
92 /* Maximum size allowed for specpdl allocation */
94 EMACS_INT max_specpdl_size;
96 /* Depth in Lisp evaluations and function calls. */
98 int lisp_eval_depth;
100 /* Maximum allowed depth in Lisp evaluations and function calls. */
102 EMACS_INT max_lisp_eval_depth;
104 /* Nonzero means enter debugger before next function call */
106 int debug_on_next_call;
108 /* Non-zero means debugger may continue. This is zero when the
109 debugger is called during redisplay, where it might not be safe to
110 continue the interrupted redisplay. */
112 int debugger_may_continue;
114 /* List of conditions (non-nil atom means all) which cause a backtrace
115 if an error is handled by the command loop's error handler. */
117 Lisp_Object Vstack_trace_on_error;
119 /* List of conditions (non-nil atom means all) which enter the debugger
120 if an error is handled by the command loop's error handler. */
122 Lisp_Object Vdebug_on_error;
124 /* List of conditions and regexps specifying error messages which
125 do not enter the debugger even if Vdebug_on_error says they should. */
127 Lisp_Object Vdebug_ignored_errors;
129 /* Non-nil means call the debugger even if the error will be handled. */
131 Lisp_Object Vdebug_on_signal;
133 /* Hook for edebug to use. */
135 Lisp_Object Vsignal_hook_function;
137 /* Nonzero means enter debugger if a quit signal
138 is handled by the command loop's error handler. */
140 int debug_on_quit;
142 /* The value of num_nonmacro_input_events as of the last time we
143 started to enter the debugger. If we decide to enter the debugger
144 again when this is still equal to num_nonmacro_input_events, then we
145 know that the debugger itself has an error, and we should just
146 signal the error instead of entering an infinite loop of debugger
147 invocations. */
149 int when_entered_debugger;
151 Lisp_Object Vdebugger;
153 /* The function from which the last `signal' was called. Set in
154 Fsignal. */
156 Lisp_Object Vsignaling_function;
158 /* Set to non-zero while processing X events. Checked in Feval to
159 make sure the Lisp interpreter isn't called from a signal handler,
160 which is unsafe because the interpreter isn't reentrant. */
162 int handling_signal;
164 /* Function to process declarations in defmacro forms. */
166 Lisp_Object Vmacro_declaration_function;
168 extern Lisp_Object Qrisky_local_variable;
170 extern Lisp_Object Qfunction;
172 static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
173 static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
175 #if __GNUC__
176 /* "gcc -O3" enables automatic function inlining, which optimizes out
177 the arguments for the invocations of these functions, whereas they
178 expect these values on the stack. */
179 Lisp_Object apply1 () __attribute__((noinline));
180 Lisp_Object call2 () __attribute__((noinline));
181 #endif
183 void
184 init_eval_once ()
186 specpdl_size = 50;
187 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
188 specpdl_ptr = specpdl;
189 /* Don't forget to update docs (lispref node "Local Variables"). */
190 max_specpdl_size = 1000;
191 max_lisp_eval_depth = 500;
193 Vrun_hooks = Qnil;
196 void
197 init_eval ()
199 specpdl_ptr = specpdl;
200 catchlist = 0;
201 handlerlist = 0;
202 backtrace_list = 0;
203 Vquit_flag = Qnil;
204 debug_on_next_call = 0;
205 lisp_eval_depth = 0;
206 #ifdef DEBUG_GCPRO
207 gcpro_level = 0;
208 #endif
209 /* This is less than the initial value of num_nonmacro_input_events. */
210 when_entered_debugger = -1;
213 /* unwind-protect function used by call_debugger. */
215 static Lisp_Object
216 restore_stack_limits (data)
217 Lisp_Object data;
219 max_specpdl_size = XINT (XCAR (data));
220 max_lisp_eval_depth = XINT (XCDR (data));
221 return Qnil;
224 /* Call the Lisp debugger, giving it argument ARG. */
226 Lisp_Object
227 call_debugger (arg)
228 Lisp_Object arg;
230 int debug_while_redisplaying;
231 int count = SPECPDL_INDEX ();
232 Lisp_Object val;
233 int old_max = max_specpdl_size;
235 /* Temporarily bump up the stack limits,
236 so the debugger won't run out of stack. */
238 max_specpdl_size += 1;
239 record_unwind_protect (restore_stack_limits,
240 Fcons (make_number (old_max),
241 make_number (max_lisp_eval_depth)));
242 max_specpdl_size = old_max;
244 if (lisp_eval_depth + 40 > max_lisp_eval_depth)
245 max_lisp_eval_depth = lisp_eval_depth + 40;
247 if (SPECPDL_INDEX () + 100 > max_specpdl_size)
248 max_specpdl_size = SPECPDL_INDEX () + 100;
250 #ifdef HAVE_WINDOW_SYSTEM
251 if (display_hourglass_p)
252 cancel_hourglass ();
253 #endif
255 debug_on_next_call = 0;
256 when_entered_debugger = num_nonmacro_input_events;
258 /* Resetting redisplaying_p to 0 makes sure that debug output is
259 displayed if the debugger is invoked during redisplay. */
260 debug_while_redisplaying = redisplaying_p;
261 redisplaying_p = 0;
262 specbind (intern ("debugger-may-continue"),
263 debug_while_redisplaying ? Qnil : Qt);
264 specbind (Qinhibit_redisplay, Qnil);
265 specbind (Qdebug_on_error, Qnil);
267 #if 0 /* Binding this prevents execution of Lisp code during
268 redisplay, which necessarily leads to display problems. */
269 specbind (Qinhibit_eval_during_redisplay, Qt);
270 #endif
272 val = apply1 (Vdebugger, arg);
274 /* Interrupting redisplay and resuming it later is not safe under
275 all circumstances. So, when the debugger returns, abort the
276 interrupted redisplay by going back to the top-level. */
277 if (debug_while_redisplaying)
278 Ftop_level ();
280 return unbind_to (count, val);
283 void
284 do_debug_on_call (code)
285 Lisp_Object code;
287 debug_on_next_call = 0;
288 backtrace_list->debug_on_exit = 1;
289 call_debugger (Fcons (code, Qnil));
292 /* NOTE!!! Every function that can call EVAL must protect its args
293 and temporaries from garbage collection while it needs them.
294 The definition of `For' shows what you have to do. */
296 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
297 doc: /* Eval args until one of them yields non-nil, then return that value.
298 The remaining args are not evalled at all.
299 If all args return nil, return nil.
300 usage: (or CONDITIONS...) */)
301 (args)
302 Lisp_Object args;
304 register Lisp_Object val = Qnil;
305 struct gcpro gcpro1;
307 GCPRO1 (args);
309 while (CONSP (args))
311 val = Feval (XCAR (args));
312 if (!NILP (val))
313 break;
314 args = XCDR (args);
317 UNGCPRO;
318 return val;
321 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
322 doc: /* Eval args until one of them yields nil, then return nil.
323 The remaining args are not evalled at all.
324 If no arg yields nil, return the last arg's value.
325 usage: (and CONDITIONS...) */)
326 (args)
327 Lisp_Object args;
329 register Lisp_Object val = Qt;
330 struct gcpro gcpro1;
332 GCPRO1 (args);
334 while (CONSP (args))
336 val = Feval (XCAR (args));
337 if (NILP (val))
338 break;
339 args = XCDR (args);
342 UNGCPRO;
343 return val;
346 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
347 doc: /* If COND yields non-nil, do THEN, else do ELSE...
348 Returns the value of THEN or the value of the last of the ELSE's.
349 THEN must be one expression, but ELSE... can be zero or more expressions.
350 If COND yields nil, and there are no ELSE's, the value is nil.
351 usage: (if COND THEN ELSE...) */)
352 (args)
353 Lisp_Object args;
355 register Lisp_Object cond;
356 struct gcpro gcpro1;
358 GCPRO1 (args);
359 cond = Feval (Fcar (args));
360 UNGCPRO;
362 if (!NILP (cond))
363 return Feval (Fcar (Fcdr (args)));
364 return Fprogn (Fcdr (Fcdr (args)));
367 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
368 doc: /* Try each clause until one succeeds.
369 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
370 and, if the value is non-nil, this clause succeeds:
371 then the expressions in BODY are evaluated and the last one's
372 value is the value of the cond-form.
373 If no clause succeeds, cond returns nil.
374 If a clause has one element, as in (CONDITION),
375 CONDITION's value if non-nil is returned from the cond-form.
376 usage: (cond CLAUSES...) */)
377 (args)
378 Lisp_Object args;
380 register Lisp_Object clause, val;
381 struct gcpro gcpro1;
383 val = Qnil;
384 GCPRO1 (args);
385 while (!NILP (args))
387 clause = Fcar (args);
388 val = Feval (Fcar (clause));
389 if (!NILP (val))
391 if (!EQ (XCDR (clause), Qnil))
392 val = Fprogn (XCDR (clause));
393 break;
395 args = XCDR (args);
397 UNGCPRO;
399 return val;
402 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
403 doc: /* Eval BODY forms sequentially and return value of last one.
404 usage: (progn BODY...) */)
405 (args)
406 Lisp_Object args;
408 register Lisp_Object val = Qnil;
409 struct gcpro gcpro1;
411 GCPRO1 (args);
413 while (CONSP (args))
415 val = Feval (XCAR (args));
416 args = XCDR (args);
419 UNGCPRO;
420 return val;
423 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
424 doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
425 The value of FIRST is saved during the evaluation of the remaining args,
426 whose values are discarded.
427 usage: (prog1 FIRST BODY...) */)
428 (args)
429 Lisp_Object args;
431 Lisp_Object val;
432 register Lisp_Object args_left;
433 struct gcpro gcpro1, gcpro2;
434 register int argnum = 0;
436 if (NILP (args))
437 return Qnil;
439 args_left = args;
440 val = Qnil;
441 GCPRO2 (args, val);
445 if (!(argnum++))
446 val = Feval (Fcar (args_left));
447 else
448 Feval (Fcar (args_left));
449 args_left = Fcdr (args_left);
451 while (!NILP(args_left));
453 UNGCPRO;
454 return val;
457 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
458 doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
459 The value of FORM2 is saved during the evaluation of the
460 remaining args, whose values are discarded.
461 usage: (prog2 FORM1 FORM2 BODY...) */)
462 (args)
463 Lisp_Object args;
465 Lisp_Object val;
466 register Lisp_Object args_left;
467 struct gcpro gcpro1, gcpro2;
468 register int argnum = -1;
470 val = Qnil;
472 if (NILP (args))
473 return Qnil;
475 args_left = args;
476 val = Qnil;
477 GCPRO2 (args, val);
481 if (!(argnum++))
482 val = Feval (Fcar (args_left));
483 else
484 Feval (Fcar (args_left));
485 args_left = Fcdr (args_left);
487 while (!NILP (args_left));
489 UNGCPRO;
490 return val;
493 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
494 doc: /* Set each SYM to the value of its VAL.
495 The symbols SYM are variables; they are literal (not evaluated).
496 The values VAL are expressions; they are evaluated.
497 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
498 The second VAL is not computed until after the first SYM is set, and so on;
499 each VAL can use the new value of variables set earlier in the `setq'.
500 The return value of the `setq' form is the value of the last VAL.
501 usage: (setq [SYM VAL]...) */)
502 (args)
503 Lisp_Object args;
505 register Lisp_Object args_left;
506 register Lisp_Object val, sym;
507 struct gcpro gcpro1;
509 if (NILP (args))
510 return Qnil;
512 args_left = args;
513 GCPRO1 (args);
517 val = Feval (Fcar (Fcdr (args_left)));
518 sym = Fcar (args_left);
519 Fset (sym, val);
520 args_left = Fcdr (Fcdr (args_left));
522 while (!NILP(args_left));
524 UNGCPRO;
525 return val;
528 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
529 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
530 usage: (quote ARG) */)
531 (args)
532 Lisp_Object args;
534 if (!NILP (Fcdr (args)))
535 xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
536 return Fcar (args);
539 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
540 doc: /* Like `quote', but preferred for objects which are functions.
541 In byte compilation, `function' causes its argument to be compiled.
542 `quote' cannot do that.
543 usage: (function ARG) */)
544 (args)
545 Lisp_Object args;
547 if (!NILP (Fcdr (args)))
548 xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
549 return Fcar (args);
553 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
554 doc: /* Return t if the containing function was run directly by user input.
555 This means that the function was called with `call-interactively'
556 \(which includes being called as the binding of a key)
557 and input is currently coming from the keyboard (not a keyboard macro),
558 and Emacs is not running in batch mode (`noninteractive' is nil).
560 The only known proper use of `interactive-p' is in deciding whether to
561 display a helpful message, or how to display it. If you're thinking
562 of using it for any other purpose, it is quite likely that you're
563 making a mistake. Think: what do you want to do when the command is
564 called from a keyboard macro?
566 To test whether your function was called with `call-interactively',
567 either (i) add an extra optional argument and give it an `interactive'
568 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
569 use `called-interactively-p'. */)
572 return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
576 DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
577 doc: /* Return t if the containing function was called by `call-interactively'.
578 If KIND is `interactive', then only return t if the call was made
579 interactively by the user, i.e. not in `noninteractive' mode nor
580 when `executing-kbd-macro'.
581 If KIND is `any', on the other hand, it will return t for any kind of
582 interactive call, including being called as the binding of a key, or
583 from a keyboard macro, or in `noninteractive' mode.
585 The only known proper use of `interactive' for KIND is in deciding
586 whether to display a helpful message, or how to display it. If you're
587 thinking of using it for any other purpose, it is quite likely that
588 you're making a mistake. Think: what do you want to do when the
589 command is called from a keyboard macro?
591 This function is meant for implementing advice and other
592 function-modifying features. Instead of using this, it is sometimes
593 cleaner to give your function an extra optional argument whose
594 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
595 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
596 (kind)
597 Lisp_Object kind;
599 return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
600 && interactive_p (1)) ? Qt : Qnil;
604 /* Return 1 if function in which this appears was called using
605 call-interactively.
607 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
608 called is a built-in. */
611 interactive_p (exclude_subrs_p)
612 int exclude_subrs_p;
614 struct backtrace *btp;
615 Lisp_Object fun;
617 btp = backtrace_list;
619 /* If this isn't a byte-compiled function, there may be a frame at
620 the top for Finteractive_p. If so, skip it. */
621 fun = Findirect_function (*btp->function, Qnil);
622 if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
623 || XSUBR (fun) == &Scalled_interactively_p))
624 btp = btp->next;
626 /* If we're running an Emacs 18-style byte-compiled function, there
627 may be a frame for Fbytecode at the top level. In any version of
628 Emacs there can be Fbytecode frames for subexpressions evaluated
629 inside catch and condition-case. Skip past them.
631 If this isn't a byte-compiled function, then we may now be
632 looking at several frames for special forms. Skip past them. */
633 while (btp
634 && (EQ (*btp->function, Qbytecode)
635 || btp->nargs == UNEVALLED))
636 btp = btp->next;
638 /* btp now points at the frame of the innermost function that isn't
639 a special form, ignoring frames for Finteractive_p and/or
640 Fbytecode at the top. If this frame is for a built-in function
641 (such as load or eval-region) return nil. */
642 fun = Findirect_function (*btp->function, Qnil);
643 if (exclude_subrs_p && SUBRP (fun))
644 return 0;
646 /* btp points to the frame of a Lisp function that called interactive-p.
647 Return t if that function was called interactively. */
648 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
649 return 1;
650 return 0;
654 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
655 doc: /* Define NAME as a function.
656 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
657 See also the function `interactive'.
658 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
659 (args)
660 Lisp_Object args;
662 register Lisp_Object fn_name;
663 register Lisp_Object defn;
665 fn_name = Fcar (args);
666 CHECK_SYMBOL (fn_name);
667 defn = Fcons (Qlambda, Fcdr (args));
668 if (!NILP (Vpurify_flag))
669 defn = Fpurecopy (defn);
670 if (CONSP (XSYMBOL (fn_name)->function)
671 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
672 LOADHIST_ATTACH (Fcons (Qt, fn_name));
673 Ffset (fn_name, defn);
674 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
675 return fn_name;
678 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
679 doc: /* Define NAME as a macro.
680 The actual definition looks like
681 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
682 When the macro is called, as in (NAME ARGS...),
683 the function (lambda ARGLIST BODY...) is applied to
684 the list ARGS... as it appears in the expression,
685 and the result should be a form to be evaluated instead of the original.
687 DECL is a declaration, optional, which can specify how to indent
688 calls to this macro, how Edebug should handle it, and which argument
689 should be treated as documentation. It looks like this:
690 (declare SPECS...)
691 The elements can look like this:
692 (indent INDENT)
693 Set NAME's `lisp-indent-function' property to INDENT.
695 (debug DEBUG)
696 Set NAME's `edebug-form-spec' property to DEBUG. (This is
697 equivalent to writing a `def-edebug-spec' for the macro.)
699 (doc-string ELT)
700 Set NAME's `doc-string-elt' property to ELT.
702 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
703 (args)
704 Lisp_Object args;
706 register Lisp_Object fn_name;
707 register Lisp_Object defn;
708 Lisp_Object lambda_list, doc, tail;
710 fn_name = Fcar (args);
711 CHECK_SYMBOL (fn_name);
712 lambda_list = Fcar (Fcdr (args));
713 tail = Fcdr (Fcdr (args));
715 doc = Qnil;
716 if (STRINGP (Fcar (tail)))
718 doc = XCAR (tail);
719 tail = XCDR (tail);
722 while (CONSP (Fcar (tail))
723 && EQ (Fcar (Fcar (tail)), Qdeclare))
725 if (!NILP (Vmacro_declaration_function))
727 struct gcpro gcpro1;
728 GCPRO1 (args);
729 call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
730 UNGCPRO;
733 tail = Fcdr (tail);
736 if (NILP (doc))
737 tail = Fcons (lambda_list, tail);
738 else
739 tail = Fcons (lambda_list, Fcons (doc, tail));
740 defn = Fcons (Qmacro, Fcons (Qlambda, tail));
742 if (!NILP (Vpurify_flag))
743 defn = Fpurecopy (defn);
744 if (CONSP (XSYMBOL (fn_name)->function)
745 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
746 LOADHIST_ATTACH (Fcons (Qt, fn_name));
747 Ffset (fn_name, defn);
748 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
749 return fn_name;
753 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
754 doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
755 Aliased variables always have the same value; setting one sets the other.
756 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
757 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
758 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
759 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
760 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
761 The return value is BASE-VARIABLE. */)
762 (new_alias, base_variable, docstring)
763 Lisp_Object new_alias, base_variable, docstring;
765 struct Lisp_Symbol *sym;
767 CHECK_SYMBOL (new_alias);
768 CHECK_SYMBOL (base_variable);
770 if (SYMBOL_CONSTANT_P (new_alias))
771 error ("Cannot make a constant an alias");
773 sym = XSYMBOL (new_alias);
774 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
775 If n_a is bound, but b_v is not, set the value of b_v to n_a.
776 This is for the sake of define-obsolete-variable-alias and user
777 customizations. */
778 if (NILP (Fboundp (base_variable)) && !NILP (Fboundp (new_alias)))
779 XSYMBOL(base_variable)->value = sym->value;
780 sym->indirect_variable = 1;
781 sym->value = base_variable;
782 sym->constant = SYMBOL_CONSTANT_P (base_variable);
783 LOADHIST_ATTACH (new_alias);
784 if (!NILP (docstring))
785 Fput (new_alias, Qvariable_documentation, docstring);
786 else
787 Fput (new_alias, Qvariable_documentation, Qnil);
789 return base_variable;
793 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
794 doc: /* Define SYMBOL as a variable, and return SYMBOL.
795 You are not required to define a variable in order to use it,
796 but the definition can supply documentation and an initial value
797 in a way that tags can recognize.
799 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
800 If SYMBOL is buffer-local, its default value is what is set;
801 buffer-local values are not affected.
802 INITVALUE and DOCSTRING are optional.
803 If DOCSTRING starts with *, this variable is identified as a user option.
804 This means that M-x set-variable recognizes it.
805 See also `user-variable-p'.
806 If INITVALUE is missing, SYMBOL's value is not set.
808 If SYMBOL has a local binding, then this form affects the local
809 binding. This is usually not what you want. Thus, if you need to
810 load a file defining variables, with this form or with `defconst' or
811 `defcustom', you should always load that file _outside_ any bindings
812 for these variables. \(`defconst' and `defcustom' behave similarly in
813 this respect.)
814 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
815 (args)
816 Lisp_Object args;
818 register Lisp_Object sym, tem, tail;
820 sym = Fcar (args);
821 tail = Fcdr (args);
822 if (!NILP (Fcdr (Fcdr (tail))))
823 error ("Too many arguments");
825 tem = Fdefault_boundp (sym);
826 if (!NILP (tail))
828 if (SYMBOL_CONSTANT_P (sym))
830 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
831 Lisp_Object tem = Fcar (tail);
832 if (! (CONSP (tem)
833 && EQ (XCAR (tem), Qquote)
834 && CONSP (XCDR (tem))
835 && EQ (XCAR (XCDR (tem)), sym)))
836 error ("Constant symbol `%s' specified in defvar",
837 SDATA (SYMBOL_NAME (sym)));
840 if (NILP (tem))
841 Fset_default (sym, Feval (Fcar (tail)));
842 else
843 { /* Check if there is really a global binding rather than just a let
844 binding that shadows the global unboundness of the var. */
845 volatile struct specbinding *pdl = specpdl_ptr;
846 while (--pdl >= specpdl)
848 if (EQ (pdl->symbol, sym) && !pdl->func
849 && EQ (pdl->old_value, Qunbound))
851 message_with_string ("Warning: defvar ignored because %s is let-bound",
852 SYMBOL_NAME (sym), 1);
853 break;
857 tail = Fcdr (tail);
858 tem = Fcar (tail);
859 if (!NILP (tem))
861 if (!NILP (Vpurify_flag))
862 tem = Fpurecopy (tem);
863 Fput (sym, Qvariable_documentation, tem);
865 LOADHIST_ATTACH (sym);
867 else
868 /* Simple (defvar <var>) should not count as a definition at all.
869 It could get in the way of other definitions, and unloading this
870 package could try to make the variable unbound. */
873 return sym;
876 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
877 doc: /* Define SYMBOL as a constant variable.
878 The intent is that neither programs nor users should ever change this value.
879 Always sets the value of SYMBOL to the result of evalling INITVALUE.
880 If SYMBOL is buffer-local, its default value is what is set;
881 buffer-local values are not affected.
882 DOCSTRING is optional.
884 If SYMBOL has a local binding, then this form sets the local binding's
885 value. However, you should normally not make local bindings for
886 variables defined with this form.
887 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
888 (args)
889 Lisp_Object args;
891 register Lisp_Object sym, tem;
893 sym = Fcar (args);
894 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
895 error ("Too many arguments");
897 tem = Feval (Fcar (Fcdr (args)));
898 if (!NILP (Vpurify_flag))
899 tem = Fpurecopy (tem);
900 Fset_default (sym, tem);
901 tem = Fcar (Fcdr (Fcdr (args)));
902 if (!NILP (tem))
904 if (!NILP (Vpurify_flag))
905 tem = Fpurecopy (tem);
906 Fput (sym, Qvariable_documentation, tem);
908 Fput (sym, Qrisky_local_variable, Qt);
909 LOADHIST_ATTACH (sym);
910 return sym;
913 /* Error handler used in Fuser_variable_p. */
914 static Lisp_Object
915 user_variable_p_eh (ignore)
916 Lisp_Object ignore;
918 return Qnil;
921 static Lisp_Object
922 lisp_indirect_variable (Lisp_Object sym)
924 XSETSYMBOL (sym, indirect_variable (XSYMBOL (sym)));
925 return sym;
928 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
929 doc: /* Return t if VARIABLE is intended to be set and modified by users.
930 \(The alternative is a variable used internally in a Lisp program.)
931 A variable is a user variable if
932 \(1) the first character of its documentation is `*', or
933 \(2) it is customizable (its property list contains a non-nil value
934 of `standard-value' or `custom-autoload'), or
935 \(3) it is an alias for another user variable.
936 Return nil if VARIABLE is an alias and there is a loop in the
937 chain of symbols. */)
938 (variable)
939 Lisp_Object variable;
941 Lisp_Object documentation;
943 if (!SYMBOLP (variable))
944 return Qnil;
946 /* If indirect and there's an alias loop, don't check anything else. */
947 if (XSYMBOL (variable)->indirect_variable
948 && NILP (internal_condition_case_1 (lisp_indirect_variable, variable,
949 Qt, user_variable_p_eh)))
950 return Qnil;
952 while (1)
954 documentation = Fget (variable, Qvariable_documentation);
955 if (INTEGERP (documentation) && XINT (documentation) < 0)
956 return Qt;
957 if (STRINGP (documentation)
958 && ((unsigned char) SREF (documentation, 0) == '*'))
959 return Qt;
960 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
961 if (CONSP (documentation)
962 && STRINGP (XCAR (documentation))
963 && INTEGERP (XCDR (documentation))
964 && XINT (XCDR (documentation)) < 0)
965 return Qt;
966 /* Customizable? See `custom-variable-p'. */
967 if ((!NILP (Fget (variable, intern ("standard-value"))))
968 || (!NILP (Fget (variable, intern ("custom-autoload")))))
969 return Qt;
971 if (!XSYMBOL (variable)->indirect_variable)
972 return Qnil;
974 /* An indirect variable? Let's follow the chain. */
975 variable = XSYMBOL (variable)->value;
979 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
980 doc: /* Bind variables according to VARLIST then eval BODY.
981 The value of the last form in BODY is returned.
982 Each element of VARLIST is a symbol (which is bound to nil)
983 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
984 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
985 usage: (let* VARLIST BODY...) */)
986 (args)
987 Lisp_Object args;
989 Lisp_Object varlist, val, elt;
990 int count = SPECPDL_INDEX ();
991 struct gcpro gcpro1, gcpro2, gcpro3;
993 GCPRO3 (args, elt, varlist);
995 varlist = Fcar (args);
996 while (!NILP (varlist))
998 QUIT;
999 elt = Fcar (varlist);
1000 if (SYMBOLP (elt))
1001 specbind (elt, Qnil);
1002 else if (! NILP (Fcdr (Fcdr (elt))))
1003 signal_error ("`let' bindings can have only one value-form", elt);
1004 else
1006 val = Feval (Fcar (Fcdr (elt)));
1007 specbind (Fcar (elt), val);
1009 varlist = Fcdr (varlist);
1011 UNGCPRO;
1012 val = Fprogn (Fcdr (args));
1013 return unbind_to (count, val);
1016 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
1017 doc: /* Bind variables according to VARLIST then eval BODY.
1018 The value of the last form in BODY is returned.
1019 Each element of VARLIST is a symbol (which is bound to nil)
1020 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1021 All the VALUEFORMs are evalled before any symbols are bound.
1022 usage: (let VARLIST BODY...) */)
1023 (args)
1024 Lisp_Object args;
1026 Lisp_Object *temps, tem;
1027 register Lisp_Object elt, varlist;
1028 int count = SPECPDL_INDEX ();
1029 register int argnum;
1030 struct gcpro gcpro1, gcpro2;
1032 varlist = Fcar (args);
1034 /* Make space to hold the values to give the bound variables */
1035 elt = Flength (varlist);
1036 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
1038 /* Compute the values and store them in `temps' */
1040 GCPRO2 (args, *temps);
1041 gcpro2.nvars = 0;
1043 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1045 QUIT;
1046 elt = XCAR (varlist);
1047 if (SYMBOLP (elt))
1048 temps [argnum++] = Qnil;
1049 else if (! NILP (Fcdr (Fcdr (elt))))
1050 signal_error ("`let' bindings can have only one value-form", elt);
1051 else
1052 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
1053 gcpro2.nvars = argnum;
1055 UNGCPRO;
1057 varlist = Fcar (args);
1058 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1060 elt = XCAR (varlist);
1061 tem = temps[argnum++];
1062 if (SYMBOLP (elt))
1063 specbind (elt, tem);
1064 else
1065 specbind (Fcar (elt), tem);
1068 elt = Fprogn (Fcdr (args));
1069 return unbind_to (count, elt);
1072 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
1073 doc: /* If TEST yields non-nil, eval BODY... and repeat.
1074 The order of execution is thus TEST, BODY, TEST, BODY and so on
1075 until TEST returns nil.
1076 usage: (while TEST BODY...) */)
1077 (args)
1078 Lisp_Object args;
1080 Lisp_Object test, body;
1081 struct gcpro gcpro1, gcpro2;
1083 GCPRO2 (test, body);
1085 test = Fcar (args);
1086 body = Fcdr (args);
1087 while (!NILP (Feval (test)))
1089 QUIT;
1090 Fprogn (body);
1093 UNGCPRO;
1094 return Qnil;
1097 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
1098 doc: /* Return result of expanding macros at top level of FORM.
1099 If FORM is not a macro call, it is returned unchanged.
1100 Otherwise, the macro is expanded and the expansion is considered
1101 in place of FORM. When a non-macro-call results, it is returned.
1103 The second optional arg ENVIRONMENT specifies an environment of macro
1104 definitions to shadow the loaded ones for use in file byte-compilation. */)
1105 (form, environment)
1106 Lisp_Object form;
1107 Lisp_Object environment;
1109 /* With cleanups from Hallvard Furuseth. */
1110 register Lisp_Object expander, sym, def, tem;
1112 while (1)
1114 /* Come back here each time we expand a macro call,
1115 in case it expands into another macro call. */
1116 if (!CONSP (form))
1117 break;
1118 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1119 def = sym = XCAR (form);
1120 tem = Qnil;
1121 /* Trace symbols aliases to other symbols
1122 until we get a symbol that is not an alias. */
1123 while (SYMBOLP (def))
1125 QUIT;
1126 sym = def;
1127 tem = Fassq (sym, environment);
1128 if (NILP (tem))
1130 def = XSYMBOL (sym)->function;
1131 if (!EQ (def, Qunbound))
1132 continue;
1134 break;
1136 /* Right now TEM is the result from SYM in ENVIRONMENT,
1137 and if TEM is nil then DEF is SYM's function definition. */
1138 if (NILP (tem))
1140 /* SYM is not mentioned in ENVIRONMENT.
1141 Look at its function definition. */
1142 if (EQ (def, Qunbound) || !CONSP (def))
1143 /* Not defined or definition not suitable */
1144 break;
1145 if (EQ (XCAR (def), Qautoload))
1147 /* Autoloading function: will it be a macro when loaded? */
1148 tem = Fnth (make_number (4), def);
1149 if (EQ (tem, Qt) || EQ (tem, Qmacro))
1150 /* Yes, load it and try again. */
1152 struct gcpro gcpro1;
1153 GCPRO1 (form);
1154 do_autoload (def, sym);
1155 UNGCPRO;
1156 continue;
1158 else
1159 break;
1161 else if (!EQ (XCAR (def), Qmacro))
1162 break;
1163 else expander = XCDR (def);
1165 else
1167 expander = XCDR (tem);
1168 if (NILP (expander))
1169 break;
1171 form = apply1 (expander, XCDR (form));
1173 return form;
1176 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1177 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1178 TAG is evalled to get the tag to use; it must not be nil.
1180 Then the BODY is executed.
1181 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1182 If no throw happens, `catch' returns the value of the last BODY form.
1183 If a throw happens, it specifies the value to return from `catch'.
1184 usage: (catch TAG BODY...) */)
1185 (args)
1186 Lisp_Object args;
1188 register Lisp_Object tag;
1189 struct gcpro gcpro1;
1191 GCPRO1 (args);
1192 tag = Feval (Fcar (args));
1193 UNGCPRO;
1194 return internal_catch (tag, Fprogn, Fcdr (args));
1197 /* Set up a catch, then call C function FUNC on argument ARG.
1198 FUNC should return a Lisp_Object.
1199 This is how catches are done from within C code. */
1201 Lisp_Object
1202 internal_catch (tag, func, arg)
1203 Lisp_Object tag;
1204 Lisp_Object (*func) ();
1205 Lisp_Object arg;
1207 /* This structure is made part of the chain `catchlist'. */
1208 struct catchtag c;
1210 /* Fill in the components of c, and put it on the list. */
1211 c.next = catchlist;
1212 c.tag = tag;
1213 c.val = Qnil;
1214 c.backlist = backtrace_list;
1215 c.handlerlist = handlerlist;
1216 c.lisp_eval_depth = lisp_eval_depth;
1217 c.pdlcount = SPECPDL_INDEX ();
1218 c.poll_suppress_count = poll_suppress_count;
1219 c.interrupt_input_blocked = interrupt_input_blocked;
1220 c.gcpro = gcprolist;
1221 c.byte_stack = byte_stack_list;
1222 catchlist = &c;
1224 /* Call FUNC. */
1225 if (! _setjmp (c.jmp))
1226 c.val = (*func) (arg);
1228 /* Throw works by a longjmp that comes right here. */
1229 catchlist = c.next;
1230 return c.val;
1233 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1234 jump to that CATCH, returning VALUE as the value of that catch.
1236 This is the guts Fthrow and Fsignal; they differ only in the way
1237 they choose the catch tag to throw to. A catch tag for a
1238 condition-case form has a TAG of Qnil.
1240 Before each catch is discarded, unbind all special bindings and
1241 execute all unwind-protect clauses made above that catch. Unwind
1242 the handler stack as we go, so that the proper handlers are in
1243 effect for each unwind-protect clause we run. At the end, restore
1244 some static info saved in CATCH, and longjmp to the location
1245 specified in the
1247 This is used for correct unwinding in Fthrow and Fsignal. */
1249 static void
1250 unwind_to_catch (catch, value)
1251 struct catchtag *catch;
1252 Lisp_Object value;
1254 register int last_time;
1256 /* Save the value in the tag. */
1257 catch->val = value;
1259 /* Restore certain special C variables. */
1260 set_poll_suppress_count (catch->poll_suppress_count);
1261 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked);
1262 handling_signal = 0;
1263 immediate_quit = 0;
1267 last_time = catchlist == catch;
1269 /* Unwind the specpdl stack, and then restore the proper set of
1270 handlers. */
1271 unbind_to (catchlist->pdlcount, Qnil);
1272 handlerlist = catchlist->handlerlist;
1273 catchlist = catchlist->next;
1275 while (! last_time);
1277 #if HAVE_X_WINDOWS
1278 /* If x_catch_errors was done, turn it off now.
1279 (First we give unbind_to a chance to do that.) */
1280 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1281 * The catch must remain in effect during that delicate
1282 * state. --lorentey */
1283 x_fully_uncatch_errors ();
1284 #endif
1285 #endif
1287 byte_stack_list = catch->byte_stack;
1288 gcprolist = catch->gcpro;
1289 #ifdef DEBUG_GCPRO
1290 if (gcprolist != 0)
1291 gcpro_level = gcprolist->level + 1;
1292 else
1293 gcpro_level = 0;
1294 #endif
1295 backtrace_list = catch->backlist;
1296 lisp_eval_depth = catch->lisp_eval_depth;
1298 _longjmp (catch->jmp, 1);
1301 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1302 doc: /* Throw to the catch for TAG and return VALUE from it.
1303 Both TAG and VALUE are evalled. */)
1304 (tag, value)
1305 register Lisp_Object tag, value;
1307 register struct catchtag *c;
1309 if (!NILP (tag))
1310 for (c = catchlist; c; c = c->next)
1312 if (EQ (c->tag, tag))
1313 unwind_to_catch (c, value);
1315 xsignal2 (Qno_catch, tag, value);
1319 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1320 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1321 If BODYFORM completes normally, its value is returned
1322 after executing the UNWINDFORMS.
1323 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1324 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1325 (args)
1326 Lisp_Object args;
1328 Lisp_Object val;
1329 int count = SPECPDL_INDEX ();
1331 record_unwind_protect (Fprogn, Fcdr (args));
1332 val = Feval (Fcar (args));
1333 return unbind_to (count, val);
1336 /* Chain of condition handlers currently in effect.
1337 The elements of this chain are contained in the stack frames
1338 of Fcondition_case and internal_condition_case.
1339 When an error is signaled (by calling Fsignal, below),
1340 this chain is searched for an element that applies. */
1342 struct handler *handlerlist;
1344 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1345 doc: /* Regain control when an error is signaled.
1346 Executes BODYFORM and returns its value if no error happens.
1347 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1348 where the BODY is made of Lisp expressions.
1350 A handler is applicable to an error
1351 if CONDITION-NAME is one of the error's condition names.
1352 If an error happens, the first applicable handler is run.
1354 The car of a handler may be a list of condition names
1355 instead of a single condition name. Then it handles all of them.
1357 When a handler handles an error, control returns to the `condition-case'
1358 and it executes the handler's BODY...
1359 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1360 (If VAR is nil, the handler can't access that information.)
1361 Then the value of the last BODY form is returned from the `condition-case'
1362 expression.
1364 See also the function `signal' for more info.
1365 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1366 (args)
1367 Lisp_Object args;
1369 register Lisp_Object bodyform, handlers;
1370 volatile Lisp_Object var;
1372 var = Fcar (args);
1373 bodyform = Fcar (Fcdr (args));
1374 handlers = Fcdr (Fcdr (args));
1376 return internal_lisp_condition_case (var, bodyform, handlers);
1379 /* Like Fcondition_case, but the args are separate
1380 rather than passed in a list. Used by Fbyte_code. */
1382 Lisp_Object
1383 internal_lisp_condition_case (var, bodyform, handlers)
1384 volatile Lisp_Object var;
1385 Lisp_Object bodyform, handlers;
1387 Lisp_Object val;
1388 struct catchtag c;
1389 struct handler h;
1391 CHECK_SYMBOL (var);
1393 for (val = handlers; CONSP (val); val = XCDR (val))
1395 Lisp_Object tem;
1396 tem = XCAR (val);
1397 if (! (NILP (tem)
1398 || (CONSP (tem)
1399 && (SYMBOLP (XCAR (tem))
1400 || CONSP (XCAR (tem))))))
1401 error ("Invalid condition handler", tem);
1404 c.tag = Qnil;
1405 c.val = Qnil;
1406 c.backlist = backtrace_list;
1407 c.handlerlist = handlerlist;
1408 c.lisp_eval_depth = lisp_eval_depth;
1409 c.pdlcount = SPECPDL_INDEX ();
1410 c.poll_suppress_count = poll_suppress_count;
1411 c.interrupt_input_blocked = interrupt_input_blocked;
1412 c.gcpro = gcprolist;
1413 c.byte_stack = byte_stack_list;
1414 if (_setjmp (c.jmp))
1416 if (!NILP (h.var))
1417 specbind (h.var, c.val);
1418 val = Fprogn (Fcdr (h.chosen_clause));
1420 /* Note that this just undoes the binding of h.var; whoever
1421 longjumped to us unwound the stack to c.pdlcount before
1422 throwing. */
1423 unbind_to (c.pdlcount, Qnil);
1424 return val;
1426 c.next = catchlist;
1427 catchlist = &c;
1429 h.var = var;
1430 h.handler = handlers;
1431 h.next = handlerlist;
1432 h.tag = &c;
1433 handlerlist = &h;
1435 val = Feval (bodyform);
1436 catchlist = c.next;
1437 handlerlist = h.next;
1438 return val;
1441 /* Call the function BFUN with no arguments, catching errors within it
1442 according to HANDLERS. If there is an error, call HFUN with
1443 one argument which is the data that describes the error:
1444 (SIGNALNAME . DATA)
1446 HANDLERS can be a list of conditions to catch.
1447 If HANDLERS is Qt, catch all errors.
1448 If HANDLERS is Qerror, catch all errors
1449 but allow the debugger to run if that is enabled. */
1451 Lisp_Object
1452 internal_condition_case (bfun, handlers, hfun)
1453 Lisp_Object (*bfun) ();
1454 Lisp_Object handlers;
1455 Lisp_Object (*hfun) ();
1457 Lisp_Object val;
1458 struct catchtag c;
1459 struct handler h;
1461 /* Since Fsignal will close off all calls to x_catch_errors,
1462 we will get the wrong results if some are not closed now. */
1463 #if HAVE_X_WINDOWS
1464 if (x_catching_errors ())
1465 abort ();
1466 #endif
1468 c.tag = Qnil;
1469 c.val = Qnil;
1470 c.backlist = backtrace_list;
1471 c.handlerlist = handlerlist;
1472 c.lisp_eval_depth = lisp_eval_depth;
1473 c.pdlcount = SPECPDL_INDEX ();
1474 c.poll_suppress_count = poll_suppress_count;
1475 c.interrupt_input_blocked = interrupt_input_blocked;
1476 c.gcpro = gcprolist;
1477 c.byte_stack = byte_stack_list;
1478 if (_setjmp (c.jmp))
1480 return (*hfun) (c.val);
1482 c.next = catchlist;
1483 catchlist = &c;
1484 h.handler = handlers;
1485 h.var = Qnil;
1486 h.next = handlerlist;
1487 h.tag = &c;
1488 handlerlist = &h;
1490 val = (*bfun) ();
1491 catchlist = c.next;
1492 handlerlist = h.next;
1493 return val;
1496 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1498 Lisp_Object
1499 internal_condition_case_1 (bfun, arg, handlers, hfun)
1500 Lisp_Object (*bfun) ();
1501 Lisp_Object arg;
1502 Lisp_Object handlers;
1503 Lisp_Object (*hfun) ();
1505 Lisp_Object val;
1506 struct catchtag c;
1507 struct handler h;
1509 /* Since Fsignal will close off all calls to x_catch_errors,
1510 we will get the wrong results if some are not closed now. */
1511 #if HAVE_X_WINDOWS
1512 if (x_catching_errors ())
1513 abort ();
1514 #endif
1516 c.tag = Qnil;
1517 c.val = Qnil;
1518 c.backlist = backtrace_list;
1519 c.handlerlist = handlerlist;
1520 c.lisp_eval_depth = lisp_eval_depth;
1521 c.pdlcount = SPECPDL_INDEX ();
1522 c.poll_suppress_count = poll_suppress_count;
1523 c.interrupt_input_blocked = interrupt_input_blocked;
1524 c.gcpro = gcprolist;
1525 c.byte_stack = byte_stack_list;
1526 if (_setjmp (c.jmp))
1528 return (*hfun) (c.val);
1530 c.next = catchlist;
1531 catchlist = &c;
1532 h.handler = handlers;
1533 h.var = Qnil;
1534 h.next = handlerlist;
1535 h.tag = &c;
1536 handlerlist = &h;
1538 val = (*bfun) (arg);
1539 catchlist = c.next;
1540 handlerlist = h.next;
1541 return val;
1545 /* Like internal_condition_case but call BFUN with NARGS as first,
1546 and ARGS as second argument. */
1548 Lisp_Object
1549 internal_condition_case_2 (bfun, nargs, args, handlers, hfun)
1550 Lisp_Object (*bfun) ();
1551 int nargs;
1552 Lisp_Object *args;
1553 Lisp_Object handlers;
1554 Lisp_Object (*hfun) ();
1556 Lisp_Object val;
1557 struct catchtag c;
1558 struct handler h;
1560 /* Since Fsignal will close off all calls to x_catch_errors,
1561 we will get the wrong results if some are not closed now. */
1562 #if HAVE_X_WINDOWS
1563 if (x_catching_errors ())
1564 abort ();
1565 #endif
1567 c.tag = Qnil;
1568 c.val = Qnil;
1569 c.backlist = backtrace_list;
1570 c.handlerlist = handlerlist;
1571 c.lisp_eval_depth = lisp_eval_depth;
1572 c.pdlcount = SPECPDL_INDEX ();
1573 c.poll_suppress_count = poll_suppress_count;
1574 c.interrupt_input_blocked = interrupt_input_blocked;
1575 c.gcpro = gcprolist;
1576 c.byte_stack = byte_stack_list;
1577 if (_setjmp (c.jmp))
1579 return (*hfun) (c.val);
1581 c.next = catchlist;
1582 catchlist = &c;
1583 h.handler = handlers;
1584 h.var = Qnil;
1585 h.next = handlerlist;
1586 h.tag = &c;
1587 handlerlist = &h;
1589 val = (*bfun) (nargs, args);
1590 catchlist = c.next;
1591 handlerlist = h.next;
1592 return val;
1596 static Lisp_Object find_handler_clause P_ ((Lisp_Object, Lisp_Object,
1597 Lisp_Object, Lisp_Object));
1599 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1600 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1601 This function does not return.
1603 An error symbol is a symbol with an `error-conditions' property
1604 that is a list of condition names.
1605 A handler for any of those names will get to handle this signal.
1606 The symbol `error' should normally be one of them.
1608 DATA should be a list. Its elements are printed as part of the error message.
1609 See Info anchor `(elisp)Definition of signal' for some details on how this
1610 error message is constructed.
1611 If the signal is handled, DATA is made available to the handler.
1612 See also the function `condition-case'. */)
1613 (error_symbol, data)
1614 Lisp_Object error_symbol, data;
1616 /* When memory is full, ERROR-SYMBOL is nil,
1617 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1618 That is a special case--don't do this in other situations. */
1619 register struct handler *allhandlers = handlerlist;
1620 Lisp_Object conditions;
1621 extern int gc_in_progress;
1622 extern int waiting_for_input;
1623 Lisp_Object string;
1624 Lisp_Object real_error_symbol;
1625 struct backtrace *bp;
1627 immediate_quit = handling_signal = 0;
1628 abort_on_gc = 0;
1629 if (gc_in_progress || waiting_for_input)
1630 abort ();
1632 if (NILP (error_symbol))
1633 real_error_symbol = Fcar (data);
1634 else
1635 real_error_symbol = error_symbol;
1637 #if 0 /* rms: I don't know why this was here,
1638 but it is surely wrong for an error that is handled. */
1639 #ifdef HAVE_WINDOW_SYSTEM
1640 if (display_hourglass_p)
1641 cancel_hourglass ();
1642 #endif
1643 #endif
1645 /* This hook is used by edebug. */
1646 if (! NILP (Vsignal_hook_function)
1647 && ! NILP (error_symbol))
1649 /* Edebug takes care of restoring these variables when it exits. */
1650 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1651 max_lisp_eval_depth = lisp_eval_depth + 20;
1653 if (SPECPDL_INDEX () + 40 > max_specpdl_size)
1654 max_specpdl_size = SPECPDL_INDEX () + 40;
1656 call2 (Vsignal_hook_function, error_symbol, data);
1659 conditions = Fget (real_error_symbol, Qerror_conditions);
1661 /* Remember from where signal was called. Skip over the frame for
1662 `signal' itself. If a frame for `error' follows, skip that,
1663 too. Don't do this when ERROR_SYMBOL is nil, because that
1664 is a memory-full error. */
1665 Vsignaling_function = Qnil;
1666 if (backtrace_list && !NILP (error_symbol))
1668 bp = backtrace_list->next;
1669 if (bp && bp->function && EQ (*bp->function, Qerror))
1670 bp = bp->next;
1671 if (bp && bp->function)
1672 Vsignaling_function = *bp->function;
1675 for (; handlerlist; handlerlist = handlerlist->next)
1677 register Lisp_Object clause;
1679 clause = find_handler_clause (handlerlist->handler, conditions,
1680 error_symbol, data);
1682 if (EQ (clause, Qlambda))
1684 /* We can't return values to code which signaled an error, but we
1685 can continue code which has signaled a quit. */
1686 if (EQ (real_error_symbol, Qquit))
1687 return Qnil;
1688 else
1689 error ("Cannot return from the debugger in an error");
1692 if (!NILP (clause))
1694 Lisp_Object unwind_data;
1695 struct handler *h = handlerlist;
1697 handlerlist = allhandlers;
1699 if (NILP (error_symbol))
1700 unwind_data = data;
1701 else
1702 unwind_data = Fcons (error_symbol, data);
1703 h->chosen_clause = clause;
1704 unwind_to_catch (h->tag, unwind_data);
1708 handlerlist = allhandlers;
1709 /* If no handler is present now, try to run the debugger,
1710 and if that fails, throw to top level. */
1711 find_handler_clause (Qerror, conditions, error_symbol, data);
1712 if (catchlist != 0)
1713 Fthrow (Qtop_level, Qt);
1715 if (! NILP (error_symbol))
1716 data = Fcons (error_symbol, data);
1718 string = Ferror_message_string (data);
1719 fatal ("%s", SDATA (string), 0);
1722 /* Internal version of Fsignal that never returns.
1723 Used for anything but Qquit (which can return from Fsignal). */
1725 void
1726 xsignal (error_symbol, data)
1727 Lisp_Object error_symbol, data;
1729 Fsignal (error_symbol, data);
1730 abort ();
1733 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1735 void
1736 xsignal0 (error_symbol)
1737 Lisp_Object error_symbol;
1739 xsignal (error_symbol, Qnil);
1742 void
1743 xsignal1 (error_symbol, arg)
1744 Lisp_Object error_symbol, arg;
1746 xsignal (error_symbol, list1 (arg));
1749 void
1750 xsignal2 (error_symbol, arg1, arg2)
1751 Lisp_Object error_symbol, arg1, arg2;
1753 xsignal (error_symbol, list2 (arg1, arg2));
1756 void
1757 xsignal3 (error_symbol, arg1, arg2, arg3)
1758 Lisp_Object error_symbol, arg1, arg2, arg3;
1760 xsignal (error_symbol, list3 (arg1, arg2, arg3));
1763 /* Signal `error' with message S, and additional arg ARG.
1764 If ARG is not a genuine list, make it a one-element list. */
1766 void
1767 signal_error (s, arg)
1768 char *s;
1769 Lisp_Object arg;
1771 Lisp_Object tortoise, hare;
1773 hare = tortoise = arg;
1774 while (CONSP (hare))
1776 hare = XCDR (hare);
1777 if (!CONSP (hare))
1778 break;
1780 hare = XCDR (hare);
1781 tortoise = XCDR (tortoise);
1783 if (EQ (hare, tortoise))
1784 break;
1787 if (!NILP (hare))
1788 arg = Fcons (arg, Qnil); /* Make it a list. */
1790 xsignal (Qerror, Fcons (build_string (s), arg));
1794 /* Return nonzero if LIST is a non-nil atom or
1795 a list containing one of CONDITIONS. */
1797 static int
1798 wants_debugger (list, conditions)
1799 Lisp_Object list, conditions;
1801 if (NILP (list))
1802 return 0;
1803 if (! CONSP (list))
1804 return 1;
1806 while (CONSP (conditions))
1808 Lisp_Object this, tail;
1809 this = XCAR (conditions);
1810 for (tail = list; CONSP (tail); tail = XCDR (tail))
1811 if (EQ (XCAR (tail), this))
1812 return 1;
1813 conditions = XCDR (conditions);
1815 return 0;
1818 /* Return 1 if an error with condition-symbols CONDITIONS,
1819 and described by SIGNAL-DATA, should skip the debugger
1820 according to debugger-ignored-errors. */
1822 static int
1823 skip_debugger (conditions, data)
1824 Lisp_Object conditions, data;
1826 Lisp_Object tail;
1827 int first_string = 1;
1828 Lisp_Object error_message;
1830 error_message = Qnil;
1831 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1833 if (STRINGP (XCAR (tail)))
1835 if (first_string)
1837 error_message = Ferror_message_string (data);
1838 first_string = 0;
1841 if (fast_string_match (XCAR (tail), error_message) >= 0)
1842 return 1;
1844 else
1846 Lisp_Object contail;
1848 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1849 if (EQ (XCAR (tail), XCAR (contail)))
1850 return 1;
1854 return 0;
1857 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1858 SIG and DATA describe the signal, as in find_handler_clause. */
1860 static int
1861 maybe_call_debugger (conditions, sig, data)
1862 Lisp_Object conditions, sig, data;
1864 Lisp_Object combined_data;
1866 combined_data = Fcons (sig, data);
1868 if (
1869 /* Don't try to run the debugger with interrupts blocked.
1870 The editing loop would return anyway. */
1871 ! INPUT_BLOCKED_P
1872 /* Does user want to enter debugger for this kind of error? */
1873 && (EQ (sig, Qquit)
1874 ? debug_on_quit
1875 : wants_debugger (Vdebug_on_error, conditions))
1876 && ! skip_debugger (conditions, combined_data)
1877 /* rms: what's this for? */
1878 && when_entered_debugger < num_nonmacro_input_events)
1880 call_debugger (Fcons (Qerror, Fcons (combined_data, Qnil)));
1881 return 1;
1884 return 0;
1887 /* Value of Qlambda means we have called debugger and user has continued.
1888 There are two ways to pass SIG and DATA:
1889 = SIG is the error symbol, and DATA is the rest of the data.
1890 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1891 This is for memory-full errors only.
1893 We need to increase max_specpdl_size temporarily around
1894 anything we do that can push on the specpdl, so as not to get
1895 a second error here in case we're handling specpdl overflow. */
1897 static Lisp_Object
1898 find_handler_clause (handlers, conditions, sig, data)
1899 Lisp_Object handlers, conditions, sig, data;
1901 register Lisp_Object h;
1902 register Lisp_Object tem;
1903 int debugger_called = 0;
1904 int debugger_considered = 0;
1906 /* t is used by handlers for all conditions, set up by C code. */
1907 if (EQ (handlers, Qt))
1908 return Qt;
1910 /* Don't run the debugger for a memory-full error.
1911 (There is no room in memory to do that!) */
1912 if (NILP (sig))
1913 debugger_considered = 1;
1915 /* error is used similarly, but means print an error message
1916 and run the debugger if that is enabled. */
1917 if (EQ (handlers, Qerror)
1918 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1919 there is a handler. */
1921 if (!NILP (sig) && wants_debugger (Vstack_trace_on_error, conditions))
1923 max_lisp_eval_depth += 15;
1924 max_specpdl_size++;
1925 if (noninteractive)
1926 Fbacktrace ();
1927 else
1928 internal_with_output_to_temp_buffer
1929 ("*Backtrace*",
1930 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1931 Qnil);
1932 max_specpdl_size--;
1933 max_lisp_eval_depth -= 15;
1936 if (!debugger_considered)
1938 debugger_considered = 1;
1939 debugger_called = maybe_call_debugger (conditions, sig, data);
1942 /* If there is no handler, return saying whether we ran the debugger. */
1943 if (EQ (handlers, Qerror))
1945 if (debugger_called)
1946 return Qlambda;
1947 return Qt;
1951 for (h = handlers; CONSP (h); h = Fcdr (h))
1953 Lisp_Object handler, condit;
1955 handler = Fcar (h);
1956 if (!CONSP (handler))
1957 continue;
1958 condit = Fcar (handler);
1959 /* Handle a single condition name in handler HANDLER. */
1960 if (SYMBOLP (condit))
1962 tem = Fmemq (Fcar (handler), conditions);
1963 if (!NILP (tem))
1964 return handler;
1966 /* Handle a list of condition names in handler HANDLER. */
1967 else if (CONSP (condit))
1969 Lisp_Object tail;
1970 for (tail = condit; CONSP (tail); tail = XCDR (tail))
1972 tem = Fmemq (Fcar (tail), conditions);
1973 if (!NILP (tem))
1975 /* This handler is going to apply.
1976 Does it allow the debugger to run first? */
1977 if (! debugger_considered && !NILP (Fmemq (Qdebug, condit)))
1978 maybe_call_debugger (conditions, sig, data);
1979 return handler;
1985 return Qnil;
1988 /* dump an error message; called like printf */
1990 /* VARARGS 1 */
1991 void
1992 error (m, a1, a2, a3)
1993 char *m;
1994 char *a1, *a2, *a3;
1996 char buf[200];
1997 int size = 200;
1998 int mlen;
1999 char *buffer = buf;
2000 char *args[3];
2001 int allocated = 0;
2002 Lisp_Object string;
2004 args[0] = a1;
2005 args[1] = a2;
2006 args[2] = a3;
2008 mlen = strlen (m);
2010 while (1)
2012 int used = doprnt (buffer, size, m, m + mlen, 3, args);
2013 if (used < size)
2014 break;
2015 size *= 2;
2016 if (allocated)
2017 buffer = (char *) xrealloc (buffer, size);
2018 else
2020 buffer = (char *) xmalloc (size);
2021 allocated = 1;
2025 string = build_string (buffer);
2026 if (allocated)
2027 xfree (buffer);
2029 xsignal1 (Qerror, string);
2032 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
2033 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
2034 This means it contains a description for how to read arguments to give it.
2035 The value is nil for an invalid function or a symbol with no function
2036 definition.
2038 Interactively callable functions include strings and vectors (treated
2039 as keyboard macros), lambda-expressions that contain a top-level call
2040 to `interactive', autoload definitions made by `autoload' with non-nil
2041 fourth argument, and some of the built-in functions of Lisp.
2043 Also, a symbol satisfies `commandp' if its function definition does so.
2045 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2046 then strings and vectors are not accepted. */)
2047 (function, for_call_interactively)
2048 Lisp_Object function, for_call_interactively;
2050 register Lisp_Object fun;
2051 register Lisp_Object funcar;
2052 Lisp_Object if_prop = Qnil;
2054 fun = function;
2056 fun = indirect_function (fun); /* Check cycles. */
2057 if (NILP (fun) || EQ (fun, Qunbound))
2058 return Qnil;
2060 /* Check an `interactive-form' property if present, analogous to the
2061 function-documentation property. */
2062 fun = function;
2063 while (SYMBOLP (fun))
2065 Lisp_Object tmp = Fget (fun, Qinteractive_form);
2066 if (!NILP (tmp))
2067 if_prop = Qt;
2068 fun = Fsymbol_function (fun);
2071 /* Emacs primitives are interactive if their DEFUN specifies an
2072 interactive spec. */
2073 if (SUBRP (fun))
2074 return XSUBR (fun)->intspec ? Qt : if_prop;
2076 /* Bytecode objects are interactive if they are long enough to
2077 have an element whose index is COMPILED_INTERACTIVE, which is
2078 where the interactive spec is stored. */
2079 else if (COMPILEDP (fun))
2080 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
2081 ? Qt : if_prop);
2083 /* Strings and vectors are keyboard macros. */
2084 if (STRINGP (fun) || VECTORP (fun))
2085 return (NILP (for_call_interactively) ? Qt : Qnil);
2087 /* Lists may represent commands. */
2088 if (!CONSP (fun))
2089 return Qnil;
2090 funcar = XCAR (fun);
2091 if (EQ (funcar, Qlambda))
2092 return !NILP (Fassq (Qinteractive, Fcdr (XCDR (fun)))) ? Qt : if_prop;
2093 if (EQ (funcar, Qautoload))
2094 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun))))) ? Qt : if_prop;
2095 else
2096 return Qnil;
2099 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
2100 doc: /* Define FUNCTION to autoload from FILE.
2101 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2102 Third arg DOCSTRING is documentation for the function.
2103 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2104 Fifth arg TYPE indicates the type of the object:
2105 nil or omitted says FUNCTION is a function,
2106 `keymap' says FUNCTION is really a keymap, and
2107 `macro' or t says FUNCTION is really a macro.
2108 Third through fifth args give info about the real definition.
2109 They default to nil.
2110 If FUNCTION is already defined other than as an autoload,
2111 this does nothing and returns nil. */)
2112 (function, file, docstring, interactive, type)
2113 Lisp_Object function, file, docstring, interactive, type;
2115 Lisp_Object args[4];
2117 CHECK_SYMBOL (function);
2118 CHECK_STRING (file);
2120 /* If function is defined and not as an autoload, don't override */
2121 if (!EQ (XSYMBOL (function)->function, Qunbound)
2122 && !(CONSP (XSYMBOL (function)->function)
2123 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
2124 return Qnil;
2126 if (NILP (Vpurify_flag))
2127 /* Only add entries after dumping, because the ones before are
2128 not useful and else we get loads of them from the loaddefs.el. */
2129 LOADHIST_ATTACH (Fcons (Qautoload, function));
2130 else
2131 /* We don't want the docstring in purespace (instead,
2132 Snarf-documentation should (hopefully) overwrite it). */
2133 docstring = make_number (0);
2134 return Ffset (function,
2135 Fpurecopy (list5 (Qautoload, file, docstring,
2136 interactive, type)));
2139 Lisp_Object
2140 un_autoload (oldqueue)
2141 Lisp_Object oldqueue;
2143 register Lisp_Object queue, first, second;
2145 /* Queue to unwind is current value of Vautoload_queue.
2146 oldqueue is the shadowed value to leave in Vautoload_queue. */
2147 queue = Vautoload_queue;
2148 Vautoload_queue = oldqueue;
2149 while (CONSP (queue))
2151 first = XCAR (queue);
2152 second = Fcdr (first);
2153 first = Fcar (first);
2154 if (EQ (first, make_number (0)))
2155 Vfeatures = second;
2156 else
2157 Ffset (first, second);
2158 queue = XCDR (queue);
2160 return Qnil;
2163 /* Load an autoloaded function.
2164 FUNNAME is the symbol which is the function's name.
2165 FUNDEF is the autoload definition (a list). */
2167 void
2168 do_autoload (fundef, funname)
2169 Lisp_Object fundef, funname;
2171 int count = SPECPDL_INDEX ();
2172 Lisp_Object fun;
2173 struct gcpro gcpro1, gcpro2, gcpro3;
2175 /* This is to make sure that loadup.el gives a clear picture
2176 of what files are preloaded and when. */
2177 if (! NILP (Vpurify_flag))
2178 error ("Attempt to autoload %s while preparing to dump",
2179 SDATA (SYMBOL_NAME (funname)));
2181 fun = funname;
2182 CHECK_SYMBOL (funname);
2183 GCPRO3 (fun, funname, fundef);
2185 /* Preserve the match data. */
2186 record_unwind_save_match_data ();
2188 /* If autoloading gets an error (which includes the error of failing
2189 to define the function being called), we use Vautoload_queue
2190 to undo function definitions and `provide' calls made by
2191 the function. We do this in the specific case of autoloading
2192 because autoloading is not an explicit request "load this file",
2193 but rather a request to "call this function".
2195 The value saved here is to be restored into Vautoload_queue. */
2196 record_unwind_protect (un_autoload, Vautoload_queue);
2197 Vautoload_queue = Qt;
2198 Fload (Fcar (Fcdr (fundef)), Qnil, Qt, Qnil, Qt);
2200 /* Once loading finishes, don't undo it. */
2201 Vautoload_queue = Qt;
2202 unbind_to (count, Qnil);
2204 fun = Findirect_function (fun, Qnil);
2206 if (!NILP (Fequal (fun, fundef)))
2207 error ("Autoloading failed to define function %s",
2208 SDATA (SYMBOL_NAME (funname)));
2209 UNGCPRO;
2213 DEFUN ("eval", Feval, Seval, 1, 1, 0,
2214 doc: /* Evaluate FORM and return its value. */)
2215 (form)
2216 Lisp_Object form;
2218 Lisp_Object fun, val, original_fun, original_args;
2219 Lisp_Object funcar;
2220 struct backtrace backtrace;
2221 struct gcpro gcpro1, gcpro2, gcpro3;
2223 if (handling_signal)
2224 abort ();
2226 if (SYMBOLP (form))
2227 return Fsymbol_value (form);
2228 if (!CONSP (form))
2229 return form;
2231 QUIT;
2232 if ((consing_since_gc > gc_cons_threshold
2233 && consing_since_gc > gc_relative_threshold)
2235 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2237 GCPRO1 (form);
2238 Fgarbage_collect ();
2239 UNGCPRO;
2242 if (++lisp_eval_depth > max_lisp_eval_depth)
2244 if (max_lisp_eval_depth < 100)
2245 max_lisp_eval_depth = 100;
2246 if (lisp_eval_depth > max_lisp_eval_depth)
2247 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2250 original_fun = Fcar (form);
2251 original_args = Fcdr (form);
2253 backtrace.next = backtrace_list;
2254 backtrace_list = &backtrace;
2255 backtrace.function = &original_fun; /* This also protects them from gc */
2256 backtrace.args = &original_args;
2257 backtrace.nargs = UNEVALLED;
2258 backtrace.evalargs = 1;
2259 backtrace.debug_on_exit = 0;
2261 if (debug_on_next_call)
2262 do_debug_on_call (Qt);
2264 /* At this point, only original_fun and original_args
2265 have values that will be used below */
2266 retry:
2268 /* Optimize for no indirection. */
2269 fun = original_fun;
2270 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2271 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2272 fun = indirect_function (fun);
2274 if (SUBRP (fun))
2276 Lisp_Object numargs;
2277 Lisp_Object argvals[8];
2278 Lisp_Object args_left;
2279 register int i, maxargs;
2281 args_left = original_args;
2282 numargs = Flength (args_left);
2284 CHECK_CONS_LIST ();
2286 if (XINT (numargs) < XSUBR (fun)->min_args ||
2287 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
2288 xsignal2 (Qwrong_number_of_arguments, original_fun, numargs);
2290 if (XSUBR (fun)->max_args == UNEVALLED)
2292 backtrace.evalargs = 0;
2293 val = (*XSUBR (fun)->function) (args_left);
2294 goto done;
2297 if (XSUBR (fun)->max_args == MANY)
2299 /* Pass a vector of evaluated arguments */
2300 Lisp_Object *vals;
2301 register int argnum = 0;
2303 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2305 GCPRO3 (args_left, fun, fun);
2306 gcpro3.var = vals;
2307 gcpro3.nvars = 0;
2309 while (!NILP (args_left))
2311 vals[argnum++] = Feval (Fcar (args_left));
2312 args_left = Fcdr (args_left);
2313 gcpro3.nvars = argnum;
2316 backtrace.args = vals;
2317 backtrace.nargs = XINT (numargs);
2319 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
2320 UNGCPRO;
2321 goto done;
2324 GCPRO3 (args_left, fun, fun);
2325 gcpro3.var = argvals;
2326 gcpro3.nvars = 0;
2328 maxargs = XSUBR (fun)->max_args;
2329 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2331 argvals[i] = Feval (Fcar (args_left));
2332 gcpro3.nvars = ++i;
2335 UNGCPRO;
2337 backtrace.args = argvals;
2338 backtrace.nargs = XINT (numargs);
2340 switch (i)
2342 case 0:
2343 val = (*XSUBR (fun)->function) ();
2344 goto done;
2345 case 1:
2346 val = (*XSUBR (fun)->function) (argvals[0]);
2347 goto done;
2348 case 2:
2349 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
2350 goto done;
2351 case 3:
2352 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2353 argvals[2]);
2354 goto done;
2355 case 4:
2356 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2357 argvals[2], argvals[3]);
2358 goto done;
2359 case 5:
2360 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2361 argvals[3], argvals[4]);
2362 goto done;
2363 case 6:
2364 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2365 argvals[3], argvals[4], argvals[5]);
2366 goto done;
2367 case 7:
2368 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2369 argvals[3], argvals[4], argvals[5],
2370 argvals[6]);
2371 goto done;
2373 case 8:
2374 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2375 argvals[3], argvals[4], argvals[5],
2376 argvals[6], argvals[7]);
2377 goto done;
2379 default:
2380 /* Someone has created a subr that takes more arguments than
2381 is supported by this code. We need to either rewrite the
2382 subr to use a different argument protocol, or add more
2383 cases to this switch. */
2384 abort ();
2387 if (COMPILEDP (fun))
2388 val = apply_lambda (fun, original_args, 1);
2389 else
2391 if (EQ (fun, Qunbound))
2392 xsignal1 (Qvoid_function, original_fun);
2393 if (!CONSP (fun))
2394 xsignal1 (Qinvalid_function, original_fun);
2395 funcar = XCAR (fun);
2396 if (!SYMBOLP (funcar))
2397 xsignal1 (Qinvalid_function, original_fun);
2398 if (EQ (funcar, Qautoload))
2400 do_autoload (fun, original_fun);
2401 goto retry;
2403 if (EQ (funcar, Qmacro))
2404 val = Feval (apply1 (Fcdr (fun), original_args));
2405 else if (EQ (funcar, Qlambda))
2406 val = apply_lambda (fun, original_args, 1);
2407 else
2408 xsignal1 (Qinvalid_function, original_fun);
2410 done:
2411 CHECK_CONS_LIST ();
2413 lisp_eval_depth--;
2414 if (backtrace.debug_on_exit)
2415 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2416 backtrace_list = backtrace.next;
2418 return val;
2421 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2422 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2423 Then return the value FUNCTION returns.
2424 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2425 usage: (apply FUNCTION &rest ARGUMENTS) */)
2426 (nargs, args)
2427 int nargs;
2428 Lisp_Object *args;
2430 register int i, numargs;
2431 register Lisp_Object spread_arg;
2432 register Lisp_Object *funcall_args;
2433 Lisp_Object fun;
2434 struct gcpro gcpro1;
2436 fun = args [0];
2437 funcall_args = 0;
2438 spread_arg = args [nargs - 1];
2439 CHECK_LIST (spread_arg);
2441 numargs = XINT (Flength (spread_arg));
2443 if (numargs == 0)
2444 return Ffuncall (nargs - 1, args);
2445 else if (numargs == 1)
2447 args [nargs - 1] = XCAR (spread_arg);
2448 return Ffuncall (nargs, args);
2451 numargs += nargs - 2;
2453 /* Optimize for no indirection. */
2454 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2455 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2456 fun = indirect_function (fun);
2457 if (EQ (fun, Qunbound))
2459 /* Let funcall get the error */
2460 fun = args[0];
2461 goto funcall;
2464 if (SUBRP (fun))
2466 if (numargs < XSUBR (fun)->min_args
2467 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2468 goto funcall; /* Let funcall get the error */
2469 else if (XSUBR (fun)->max_args > numargs)
2471 /* Avoid making funcall cons up a yet another new vector of arguments
2472 by explicitly supplying nil's for optional values */
2473 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2474 * sizeof (Lisp_Object));
2475 for (i = numargs; i < XSUBR (fun)->max_args;)
2476 funcall_args[++i] = Qnil;
2477 GCPRO1 (*funcall_args);
2478 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2481 funcall:
2482 /* We add 1 to numargs because funcall_args includes the
2483 function itself as well as its arguments. */
2484 if (!funcall_args)
2486 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
2487 * sizeof (Lisp_Object));
2488 GCPRO1 (*funcall_args);
2489 gcpro1.nvars = 1 + numargs;
2492 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2493 /* Spread the last arg we got. Its first element goes in
2494 the slot that it used to occupy, hence this value of I. */
2495 i = nargs - 1;
2496 while (!NILP (spread_arg))
2498 funcall_args [i++] = XCAR (spread_arg);
2499 spread_arg = XCDR (spread_arg);
2502 /* By convention, the caller needs to gcpro Ffuncall's args. */
2503 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
2506 /* Run hook variables in various ways. */
2508 enum run_hooks_condition {to_completion, until_success, until_failure};
2509 static Lisp_Object run_hook_with_args P_ ((int, Lisp_Object *,
2510 enum run_hooks_condition));
2512 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2513 doc: /* Run each hook in HOOKS.
2514 Each argument should be a symbol, a hook variable.
2515 These symbols are processed in the order specified.
2516 If a hook symbol has a non-nil value, that value may be a function
2517 or a list of functions to be called to run the hook.
2518 If the value is a function, it is called with no arguments.
2519 If it is a list, the elements are called, in order, with no arguments.
2521 Major modes should not use this function directly to run their mode
2522 hook; they should use `run-mode-hooks' instead.
2524 Do not use `make-local-variable' to make a hook variable buffer-local.
2525 Instead, use `add-hook' and specify t for the LOCAL argument.
2526 usage: (run-hooks &rest HOOKS) */)
2527 (nargs, args)
2528 int nargs;
2529 Lisp_Object *args;
2531 Lisp_Object hook[1];
2532 register int i;
2534 for (i = 0; i < nargs; i++)
2536 hook[0] = args[i];
2537 run_hook_with_args (1, hook, to_completion);
2540 return Qnil;
2543 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2544 Srun_hook_with_args, 1, MANY, 0,
2545 doc: /* Run HOOK with the specified arguments ARGS.
2546 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2547 value, that value may be a function or a list of functions to be
2548 called to run the hook. If the value is a function, it is called with
2549 the given arguments and its return value is returned. If it is a list
2550 of functions, those functions are called, in order,
2551 with the given arguments ARGS.
2552 It is best not to depend on the value returned by `run-hook-with-args',
2553 as that may change.
2555 Do not use `make-local-variable' to make a hook variable buffer-local.
2556 Instead, use `add-hook' and specify t for the LOCAL argument.
2557 usage: (run-hook-with-args HOOK &rest ARGS) */)
2558 (nargs, args)
2559 int nargs;
2560 Lisp_Object *args;
2562 return run_hook_with_args (nargs, args, to_completion);
2565 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2566 Srun_hook_with_args_until_success, 1, MANY, 0,
2567 doc: /* Run HOOK with the specified arguments ARGS.
2568 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2569 value, that value may be a function or a list of functions to be
2570 called to run the hook. If the value is a function, it is called with
2571 the given arguments and its return value is returned.
2572 If it is a list of functions, those functions are called, in order,
2573 with the given arguments ARGS, until one of them
2574 returns a non-nil value. Then we return that value.
2575 However, if they all return nil, we return nil.
2577 Do not use `make-local-variable' to make a hook variable buffer-local.
2578 Instead, use `add-hook' and specify t for the LOCAL argument.
2579 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2580 (nargs, args)
2581 int nargs;
2582 Lisp_Object *args;
2584 return run_hook_with_args (nargs, args, until_success);
2587 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2588 Srun_hook_with_args_until_failure, 1, MANY, 0,
2589 doc: /* Run HOOK with the specified arguments ARGS.
2590 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2591 value, that value may be a function or a list of functions to be
2592 called to run the hook. If the value is a function, it is called with
2593 the given arguments and its return value is returned.
2594 If it is a list of functions, those functions are called, in order,
2595 with the given arguments ARGS, until one of them returns nil.
2596 Then we return nil. However, if they all return non-nil, we return non-nil.
2598 Do not use `make-local-variable' to make a hook variable buffer-local.
2599 Instead, use `add-hook' and specify t for the LOCAL argument.
2600 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2601 (nargs, args)
2602 int nargs;
2603 Lisp_Object *args;
2605 return run_hook_with_args (nargs, args, until_failure);
2608 /* ARGS[0] should be a hook symbol.
2609 Call each of the functions in the hook value, passing each of them
2610 as arguments all the rest of ARGS (all NARGS - 1 elements).
2611 COND specifies a condition to test after each call
2612 to decide whether to stop.
2613 The caller (or its caller, etc) must gcpro all of ARGS,
2614 except that it isn't necessary to gcpro ARGS[0]. */
2616 static Lisp_Object
2617 run_hook_with_args (nargs, args, cond)
2618 int nargs;
2619 Lisp_Object *args;
2620 enum run_hooks_condition cond;
2622 Lisp_Object sym, val, ret;
2623 Lisp_Object globals;
2624 struct gcpro gcpro1, gcpro2, gcpro3;
2626 /* If we are dying or still initializing,
2627 don't do anything--it would probably crash if we tried. */
2628 if (NILP (Vrun_hooks))
2629 return Qnil;
2631 sym = args[0];
2632 val = find_symbol_value (sym);
2633 ret = (cond == until_failure ? Qt : Qnil);
2635 if (EQ (val, Qunbound) || NILP (val))
2636 return ret;
2637 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2639 args[0] = val;
2640 return Ffuncall (nargs, args);
2642 else
2644 globals = Qnil;
2645 GCPRO3 (sym, val, globals);
2647 for (;
2648 CONSP (val) && ((cond == to_completion)
2649 || (cond == until_success ? NILP (ret)
2650 : !NILP (ret)));
2651 val = XCDR (val))
2653 if (EQ (XCAR (val), Qt))
2655 /* t indicates this hook has a local binding;
2656 it means to run the global binding too. */
2658 for (globals = Fdefault_value (sym);
2659 CONSP (globals) && ((cond == to_completion)
2660 || (cond == until_success ? NILP (ret)
2661 : !NILP (ret)));
2662 globals = XCDR (globals))
2664 args[0] = XCAR (globals);
2665 /* In a global value, t should not occur. If it does, we
2666 must ignore it to avoid an endless loop. */
2667 if (!EQ (args[0], Qt))
2668 ret = Ffuncall (nargs, args);
2671 else
2673 args[0] = XCAR (val);
2674 ret = Ffuncall (nargs, args);
2678 UNGCPRO;
2679 return ret;
2683 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2684 present value of that symbol.
2685 Call each element of FUNLIST,
2686 passing each of them the rest of ARGS.
2687 The caller (or its caller, etc) must gcpro all of ARGS,
2688 except that it isn't necessary to gcpro ARGS[0]. */
2690 Lisp_Object
2691 run_hook_list_with_args (funlist, nargs, args)
2692 Lisp_Object funlist;
2693 int nargs;
2694 Lisp_Object *args;
2696 Lisp_Object sym;
2697 Lisp_Object val;
2698 Lisp_Object globals;
2699 struct gcpro gcpro1, gcpro2, gcpro3;
2701 sym = args[0];
2702 globals = Qnil;
2703 GCPRO3 (sym, val, globals);
2705 for (val = funlist; CONSP (val); val = XCDR (val))
2707 if (EQ (XCAR (val), Qt))
2709 /* t indicates this hook has a local binding;
2710 it means to run the global binding too. */
2712 for (globals = Fdefault_value (sym);
2713 CONSP (globals);
2714 globals = XCDR (globals))
2716 args[0] = XCAR (globals);
2717 /* In a global value, t should not occur. If it does, we
2718 must ignore it to avoid an endless loop. */
2719 if (!EQ (args[0], Qt))
2720 Ffuncall (nargs, args);
2723 else
2725 args[0] = XCAR (val);
2726 Ffuncall (nargs, args);
2729 UNGCPRO;
2730 return Qnil;
2733 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2735 void
2736 run_hook_with_args_2 (hook, arg1, arg2)
2737 Lisp_Object hook, arg1, arg2;
2739 Lisp_Object temp[3];
2740 temp[0] = hook;
2741 temp[1] = arg1;
2742 temp[2] = arg2;
2744 Frun_hook_with_args (3, temp);
2747 /* Apply fn to arg */
2748 Lisp_Object
2749 apply1 (fn, arg)
2750 Lisp_Object fn, arg;
2752 struct gcpro gcpro1;
2754 GCPRO1 (fn);
2755 if (NILP (arg))
2756 RETURN_UNGCPRO (Ffuncall (1, &fn));
2757 gcpro1.nvars = 2;
2758 #ifdef NO_ARG_ARRAY
2760 Lisp_Object args[2];
2761 args[0] = fn;
2762 args[1] = arg;
2763 gcpro1.var = args;
2764 RETURN_UNGCPRO (Fapply (2, args));
2766 #else /* not NO_ARG_ARRAY */
2767 RETURN_UNGCPRO (Fapply (2, &fn));
2768 #endif /* not NO_ARG_ARRAY */
2771 /* Call function fn on no arguments */
2772 Lisp_Object
2773 call0 (fn)
2774 Lisp_Object fn;
2776 struct gcpro gcpro1;
2778 GCPRO1 (fn);
2779 RETURN_UNGCPRO (Ffuncall (1, &fn));
2782 /* Call function fn with 1 argument arg1 */
2783 /* ARGSUSED */
2784 Lisp_Object
2785 call1 (fn, arg1)
2786 Lisp_Object fn, arg1;
2788 struct gcpro gcpro1;
2789 #ifdef NO_ARG_ARRAY
2790 Lisp_Object args[2];
2792 args[0] = fn;
2793 args[1] = arg1;
2794 GCPRO1 (args[0]);
2795 gcpro1.nvars = 2;
2796 RETURN_UNGCPRO (Ffuncall (2, args));
2797 #else /* not NO_ARG_ARRAY */
2798 GCPRO1 (fn);
2799 gcpro1.nvars = 2;
2800 RETURN_UNGCPRO (Ffuncall (2, &fn));
2801 #endif /* not NO_ARG_ARRAY */
2804 /* Call function fn with 2 arguments arg1, arg2 */
2805 /* ARGSUSED */
2806 Lisp_Object
2807 call2 (fn, arg1, arg2)
2808 Lisp_Object fn, arg1, arg2;
2810 struct gcpro gcpro1;
2811 #ifdef NO_ARG_ARRAY
2812 Lisp_Object args[3];
2813 args[0] = fn;
2814 args[1] = arg1;
2815 args[2] = arg2;
2816 GCPRO1 (args[0]);
2817 gcpro1.nvars = 3;
2818 RETURN_UNGCPRO (Ffuncall (3, args));
2819 #else /* not NO_ARG_ARRAY */
2820 GCPRO1 (fn);
2821 gcpro1.nvars = 3;
2822 RETURN_UNGCPRO (Ffuncall (3, &fn));
2823 #endif /* not NO_ARG_ARRAY */
2826 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2827 /* ARGSUSED */
2828 Lisp_Object
2829 call3 (fn, arg1, arg2, arg3)
2830 Lisp_Object fn, arg1, arg2, arg3;
2832 struct gcpro gcpro1;
2833 #ifdef NO_ARG_ARRAY
2834 Lisp_Object args[4];
2835 args[0] = fn;
2836 args[1] = arg1;
2837 args[2] = arg2;
2838 args[3] = arg3;
2839 GCPRO1 (args[0]);
2840 gcpro1.nvars = 4;
2841 RETURN_UNGCPRO (Ffuncall (4, args));
2842 #else /* not NO_ARG_ARRAY */
2843 GCPRO1 (fn);
2844 gcpro1.nvars = 4;
2845 RETURN_UNGCPRO (Ffuncall (4, &fn));
2846 #endif /* not NO_ARG_ARRAY */
2849 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2850 /* ARGSUSED */
2851 Lisp_Object
2852 call4 (fn, arg1, arg2, arg3, arg4)
2853 Lisp_Object fn, arg1, arg2, arg3, arg4;
2855 struct gcpro gcpro1;
2856 #ifdef NO_ARG_ARRAY
2857 Lisp_Object args[5];
2858 args[0] = fn;
2859 args[1] = arg1;
2860 args[2] = arg2;
2861 args[3] = arg3;
2862 args[4] = arg4;
2863 GCPRO1 (args[0]);
2864 gcpro1.nvars = 5;
2865 RETURN_UNGCPRO (Ffuncall (5, args));
2866 #else /* not NO_ARG_ARRAY */
2867 GCPRO1 (fn);
2868 gcpro1.nvars = 5;
2869 RETURN_UNGCPRO (Ffuncall (5, &fn));
2870 #endif /* not NO_ARG_ARRAY */
2873 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2874 /* ARGSUSED */
2875 Lisp_Object
2876 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2877 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2879 struct gcpro gcpro1;
2880 #ifdef NO_ARG_ARRAY
2881 Lisp_Object args[6];
2882 args[0] = fn;
2883 args[1] = arg1;
2884 args[2] = arg2;
2885 args[3] = arg3;
2886 args[4] = arg4;
2887 args[5] = arg5;
2888 GCPRO1 (args[0]);
2889 gcpro1.nvars = 6;
2890 RETURN_UNGCPRO (Ffuncall (6, args));
2891 #else /* not NO_ARG_ARRAY */
2892 GCPRO1 (fn);
2893 gcpro1.nvars = 6;
2894 RETURN_UNGCPRO (Ffuncall (6, &fn));
2895 #endif /* not NO_ARG_ARRAY */
2898 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2899 /* ARGSUSED */
2900 Lisp_Object
2901 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2902 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2904 struct gcpro gcpro1;
2905 #ifdef NO_ARG_ARRAY
2906 Lisp_Object args[7];
2907 args[0] = fn;
2908 args[1] = arg1;
2909 args[2] = arg2;
2910 args[3] = arg3;
2911 args[4] = arg4;
2912 args[5] = arg5;
2913 args[6] = arg6;
2914 GCPRO1 (args[0]);
2915 gcpro1.nvars = 7;
2916 RETURN_UNGCPRO (Ffuncall (7, args));
2917 #else /* not NO_ARG_ARRAY */
2918 GCPRO1 (fn);
2919 gcpro1.nvars = 7;
2920 RETURN_UNGCPRO (Ffuncall (7, &fn));
2921 #endif /* not NO_ARG_ARRAY */
2924 /* The caller should GCPRO all the elements of ARGS. */
2926 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2927 doc: /* Call first argument as a function, passing remaining arguments to it.
2928 Return the value that function returns.
2929 Thus, (funcall 'cons 'x 'y) returns (x . y).
2930 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2931 (nargs, args)
2932 int nargs;
2933 Lisp_Object *args;
2935 Lisp_Object fun, original_fun;
2936 Lisp_Object funcar;
2937 int numargs = nargs - 1;
2938 Lisp_Object lisp_numargs;
2939 Lisp_Object val;
2940 struct backtrace backtrace;
2941 register Lisp_Object *internal_args;
2942 register int i;
2944 QUIT;
2945 if ((consing_since_gc > gc_cons_threshold
2946 && consing_since_gc > gc_relative_threshold)
2948 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2949 Fgarbage_collect ();
2951 if (++lisp_eval_depth > max_lisp_eval_depth)
2953 if (max_lisp_eval_depth < 100)
2954 max_lisp_eval_depth = 100;
2955 if (lisp_eval_depth > max_lisp_eval_depth)
2956 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2959 backtrace.next = backtrace_list;
2960 backtrace_list = &backtrace;
2961 backtrace.function = &args[0];
2962 backtrace.args = &args[1];
2963 backtrace.nargs = nargs - 1;
2964 backtrace.evalargs = 0;
2965 backtrace.debug_on_exit = 0;
2967 if (debug_on_next_call)
2968 do_debug_on_call (Qlambda);
2970 CHECK_CONS_LIST ();
2972 original_fun = args[0];
2974 retry:
2976 /* Optimize for no indirection. */
2977 fun = original_fun;
2978 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2979 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2980 fun = indirect_function (fun);
2982 if (SUBRP (fun))
2984 if (numargs < XSUBR (fun)->min_args
2985 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2987 XSETFASTINT (lisp_numargs, numargs);
2988 xsignal2 (Qwrong_number_of_arguments, original_fun, lisp_numargs);
2991 if (XSUBR (fun)->max_args == UNEVALLED)
2992 xsignal1 (Qinvalid_function, original_fun);
2994 if (XSUBR (fun)->max_args == MANY)
2996 val = (*XSUBR (fun)->function) (numargs, args + 1);
2997 goto done;
3000 if (XSUBR (fun)->max_args > numargs)
3002 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
3003 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
3004 for (i = numargs; i < XSUBR (fun)->max_args; i++)
3005 internal_args[i] = Qnil;
3007 else
3008 internal_args = args + 1;
3009 switch (XSUBR (fun)->max_args)
3011 case 0:
3012 val = (*XSUBR (fun)->function) ();
3013 goto done;
3014 case 1:
3015 val = (*XSUBR (fun)->function) (internal_args[0]);
3016 goto done;
3017 case 2:
3018 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1]);
3019 goto done;
3020 case 3:
3021 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3022 internal_args[2]);
3023 goto done;
3024 case 4:
3025 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3026 internal_args[2], internal_args[3]);
3027 goto done;
3028 case 5:
3029 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3030 internal_args[2], internal_args[3],
3031 internal_args[4]);
3032 goto done;
3033 case 6:
3034 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3035 internal_args[2], internal_args[3],
3036 internal_args[4], internal_args[5]);
3037 goto done;
3038 case 7:
3039 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3040 internal_args[2], internal_args[3],
3041 internal_args[4], internal_args[5],
3042 internal_args[6]);
3043 goto done;
3045 case 8:
3046 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3047 internal_args[2], internal_args[3],
3048 internal_args[4], internal_args[5],
3049 internal_args[6], internal_args[7]);
3050 goto done;
3052 default:
3054 /* If a subr takes more than 8 arguments without using MANY
3055 or UNEVALLED, we need to extend this function to support it.
3056 Until this is done, there is no way to call the function. */
3057 abort ();
3060 if (COMPILEDP (fun))
3061 val = funcall_lambda (fun, numargs, args + 1);
3062 else
3064 if (EQ (fun, Qunbound))
3065 xsignal1 (Qvoid_function, original_fun);
3066 if (!CONSP (fun))
3067 xsignal1 (Qinvalid_function, original_fun);
3068 funcar = XCAR (fun);
3069 if (!SYMBOLP (funcar))
3070 xsignal1 (Qinvalid_function, original_fun);
3071 if (EQ (funcar, Qlambda))
3072 val = funcall_lambda (fun, numargs, args + 1);
3073 else if (EQ (funcar, Qautoload))
3075 do_autoload (fun, original_fun);
3076 CHECK_CONS_LIST ();
3077 goto retry;
3079 else
3080 xsignal1 (Qinvalid_function, original_fun);
3082 done:
3083 CHECK_CONS_LIST ();
3084 lisp_eval_depth--;
3085 if (backtrace.debug_on_exit)
3086 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
3087 backtrace_list = backtrace.next;
3088 return val;
3091 Lisp_Object
3092 apply_lambda (fun, args, eval_flag)
3093 Lisp_Object fun, args;
3094 int eval_flag;
3096 Lisp_Object args_left;
3097 Lisp_Object numargs;
3098 register Lisp_Object *arg_vector;
3099 struct gcpro gcpro1, gcpro2, gcpro3;
3100 register int i;
3101 register Lisp_Object tem;
3103 numargs = Flength (args);
3104 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
3105 args_left = args;
3107 GCPRO3 (*arg_vector, args_left, fun);
3108 gcpro1.nvars = 0;
3110 for (i = 0; i < XINT (numargs);)
3112 tem = Fcar (args_left), args_left = Fcdr (args_left);
3113 if (eval_flag) tem = Feval (tem);
3114 arg_vector[i++] = tem;
3115 gcpro1.nvars = i;
3118 UNGCPRO;
3120 if (eval_flag)
3122 backtrace_list->args = arg_vector;
3123 backtrace_list->nargs = i;
3125 backtrace_list->evalargs = 0;
3126 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
3128 /* Do the debug-on-exit now, while arg_vector still exists. */
3129 if (backtrace_list->debug_on_exit)
3130 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
3131 /* Don't do it again when we return to eval. */
3132 backtrace_list->debug_on_exit = 0;
3133 return tem;
3136 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3137 and return the result of evaluation.
3138 FUN must be either a lambda-expression or a compiled-code object. */
3140 static Lisp_Object
3141 funcall_lambda (fun, nargs, arg_vector)
3142 Lisp_Object fun;
3143 int nargs;
3144 register Lisp_Object *arg_vector;
3146 Lisp_Object val, syms_left, next;
3147 int count = SPECPDL_INDEX ();
3148 int i, optional, rest;
3150 if (CONSP (fun))
3152 syms_left = XCDR (fun);
3153 if (CONSP (syms_left))
3154 syms_left = XCAR (syms_left);
3155 else
3156 xsignal1 (Qinvalid_function, fun);
3158 else if (COMPILEDP (fun))
3159 syms_left = AREF (fun, COMPILED_ARGLIST);
3160 else
3161 abort ();
3163 i = optional = rest = 0;
3164 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
3166 QUIT;
3168 next = XCAR (syms_left);
3169 if (!SYMBOLP (next))
3170 xsignal1 (Qinvalid_function, fun);
3172 if (EQ (next, Qand_rest))
3173 rest = 1;
3174 else if (EQ (next, Qand_optional))
3175 optional = 1;
3176 else if (rest)
3178 specbind (next, Flist (nargs - i, &arg_vector[i]));
3179 i = nargs;
3181 else if (i < nargs)
3182 specbind (next, arg_vector[i++]);
3183 else if (!optional)
3184 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3185 else
3186 specbind (next, Qnil);
3189 if (!NILP (syms_left))
3190 xsignal1 (Qinvalid_function, fun);
3191 else if (i < nargs)
3192 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3194 if (CONSP (fun))
3195 val = Fprogn (XCDR (XCDR (fun)));
3196 else
3198 /* If we have not actually read the bytecode string
3199 and constants vector yet, fetch them from the file. */
3200 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3201 Ffetch_bytecode (fun);
3202 val = Fbyte_code (AREF (fun, COMPILED_BYTECODE),
3203 AREF (fun, COMPILED_CONSTANTS),
3204 AREF (fun, COMPILED_STACK_DEPTH));
3207 return unbind_to (count, val);
3210 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
3211 1, 1, 0,
3212 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3213 (object)
3214 Lisp_Object object;
3216 Lisp_Object tem;
3218 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
3220 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
3221 if (!CONSP (tem))
3223 tem = AREF (object, COMPILED_BYTECODE);
3224 if (CONSP (tem) && STRINGP (XCAR (tem)))
3225 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
3226 else
3227 error ("Invalid byte code");
3229 ASET (object, COMPILED_BYTECODE, XCAR (tem));
3230 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
3232 return object;
3235 void
3236 grow_specpdl ()
3238 register int count = SPECPDL_INDEX ();
3239 if (specpdl_size >= max_specpdl_size)
3241 if (max_specpdl_size < 400)
3242 max_specpdl_size = 400;
3243 if (specpdl_size >= max_specpdl_size)
3244 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil);
3246 specpdl_size *= 2;
3247 if (specpdl_size > max_specpdl_size)
3248 specpdl_size = max_specpdl_size;
3249 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
3250 specpdl_ptr = specpdl + count;
3253 void
3254 specbind (symbol, value)
3255 Lisp_Object symbol, value;
3257 Lisp_Object valcontents;
3259 CHECK_SYMBOL (symbol);
3260 if (specpdl_ptr == specpdl + specpdl_size)
3261 grow_specpdl ();
3263 /* The most common case is that of a non-constant symbol with a
3264 trivial value. Make that as fast as we can. */
3265 valcontents = SYMBOL_VALUE (symbol);
3266 if (!MISCP (valcontents) && !SYMBOL_CONSTANT_P (symbol))
3268 specpdl_ptr->symbol = symbol;
3269 specpdl_ptr->old_value = valcontents;
3270 specpdl_ptr->func = NULL;
3271 ++specpdl_ptr;
3272 SET_SYMBOL_VALUE (symbol, value);
3274 else
3276 Lisp_Object ovalue = find_symbol_value (symbol);
3277 specpdl_ptr->func = 0;
3278 specpdl_ptr->old_value = ovalue;
3280 valcontents = XSYMBOL (symbol)->value;
3282 if (BUFFER_LOCAL_VALUEP (valcontents)
3283 || BUFFER_OBJFWDP (valcontents))
3285 Lisp_Object where, current_buffer;
3287 current_buffer = Fcurrent_buffer ();
3289 /* For a local variable, record both the symbol and which
3290 buffer's or frame's value we are saving. */
3291 if (!NILP (Flocal_variable_p (symbol, Qnil)))
3292 where = current_buffer;
3293 else if (BUFFER_LOCAL_VALUEP (valcontents)
3294 && XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame)
3295 where = XBUFFER_LOCAL_VALUE (valcontents)->frame;
3296 else
3297 where = Qnil;
3299 /* We're not using the `unused' slot in the specbinding
3300 structure because this would mean we have to do more
3301 work for simple variables. */
3302 specpdl_ptr->symbol = Fcons (symbol, Fcons (where, current_buffer));
3304 /* If SYMBOL is a per-buffer variable which doesn't have a
3305 buffer-local value here, make the `let' change the global
3306 value by changing the value of SYMBOL in all buffers not
3307 having their own value. This is consistent with what
3308 happens with other buffer-local variables. */
3309 if (NILP (where)
3310 && BUFFER_OBJFWDP (valcontents))
3312 ++specpdl_ptr;
3313 Fset_default (symbol, value);
3314 return;
3317 else
3318 specpdl_ptr->symbol = symbol;
3320 specpdl_ptr++;
3321 /* We used to do
3322 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3323 store_symval_forwarding (symbol, ovalue, value, NULL);
3324 else
3325 but ovalue comes from find_symbol_value which should never return
3326 such an internal value. */
3327 eassert (!(BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue)));
3328 set_internal (symbol, value, 0, 1);
3332 void
3333 record_unwind_protect (function, arg)
3334 Lisp_Object (*function) P_ ((Lisp_Object));
3335 Lisp_Object arg;
3337 eassert (!handling_signal);
3339 if (specpdl_ptr == specpdl + specpdl_size)
3340 grow_specpdl ();
3341 specpdl_ptr->func = function;
3342 specpdl_ptr->symbol = Qnil;
3343 specpdl_ptr->old_value = arg;
3344 specpdl_ptr++;
3347 Lisp_Object
3348 unbind_to (count, value)
3349 int count;
3350 Lisp_Object value;
3352 Lisp_Object quitf = Vquit_flag;
3353 struct gcpro gcpro1, gcpro2;
3355 GCPRO2 (value, quitf);
3356 Vquit_flag = Qnil;
3358 while (specpdl_ptr != specpdl + count)
3360 /* Copy the binding, and decrement specpdl_ptr, before we do
3361 the work to unbind it. We decrement first
3362 so that an error in unbinding won't try to unbind
3363 the same entry again, and we copy the binding first
3364 in case more bindings are made during some of the code we run. */
3366 struct specbinding this_binding;
3367 this_binding = *--specpdl_ptr;
3369 if (this_binding.func != 0)
3370 (*this_binding.func) (this_binding.old_value);
3371 /* If the symbol is a list, it is really (SYMBOL WHERE
3372 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3373 frame. If WHERE is a buffer or frame, this indicates we
3374 bound a variable that had a buffer-local or frame-local
3375 binding. WHERE nil means that the variable had the default
3376 value when it was bound. CURRENT-BUFFER is the buffer that
3377 was current when the variable was bound. */
3378 else if (CONSP (this_binding.symbol))
3380 Lisp_Object symbol, where;
3382 symbol = XCAR (this_binding.symbol);
3383 where = XCAR (XCDR (this_binding.symbol));
3385 if (NILP (where))
3386 Fset_default (symbol, this_binding.old_value);
3387 else if (BUFFERP (where))
3388 set_internal (symbol, this_binding.old_value, XBUFFER (where), 1);
3389 else
3390 set_internal (symbol, this_binding.old_value, NULL, 1);
3392 else
3394 /* If variable has a trivial value (no forwarding), we can
3395 just set it. No need to check for constant symbols here,
3396 since that was already done by specbind. */
3397 if (!MISCP (SYMBOL_VALUE (this_binding.symbol)))
3398 SET_SYMBOL_VALUE (this_binding.symbol, this_binding.old_value);
3399 else
3400 set_internal (this_binding.symbol, this_binding.old_value, 0, 1);
3404 if (NILP (Vquit_flag) && !NILP (quitf))
3405 Vquit_flag = quitf;
3407 UNGCPRO;
3408 return value;
3411 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3412 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3413 The debugger is entered when that frame exits, if the flag is non-nil. */)
3414 (level, flag)
3415 Lisp_Object level, flag;
3417 register struct backtrace *backlist = backtrace_list;
3418 register int i;
3420 CHECK_NUMBER (level);
3422 for (i = 0; backlist && i < XINT (level); i++)
3424 backlist = backlist->next;
3427 if (backlist)
3428 backlist->debug_on_exit = !NILP (flag);
3430 return flag;
3433 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3434 doc: /* Print a trace of Lisp function calls currently active.
3435 Output stream used is value of `standard-output'. */)
3438 register struct backtrace *backlist = backtrace_list;
3439 register int i;
3440 Lisp_Object tail;
3441 Lisp_Object tem;
3442 extern Lisp_Object Vprint_level;
3443 struct gcpro gcpro1;
3445 XSETFASTINT (Vprint_level, 3);
3447 tail = Qnil;
3448 GCPRO1 (tail);
3450 while (backlist)
3452 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3453 if (backlist->nargs == UNEVALLED)
3455 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3456 write_string ("\n", -1);
3458 else
3460 tem = *backlist->function;
3461 Fprin1 (tem, Qnil); /* This can QUIT */
3462 write_string ("(", -1);
3463 if (backlist->nargs == MANY)
3465 for (tail = *backlist->args, i = 0;
3466 !NILP (tail);
3467 tail = Fcdr (tail), i++)
3469 if (i) write_string (" ", -1);
3470 Fprin1 (Fcar (tail), Qnil);
3473 else
3475 for (i = 0; i < backlist->nargs; i++)
3477 if (i) write_string (" ", -1);
3478 Fprin1 (backlist->args[i], Qnil);
3481 write_string (")\n", -1);
3483 backlist = backlist->next;
3486 Vprint_level = Qnil;
3487 UNGCPRO;
3488 return Qnil;
3491 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3492 doc: /* Return the function and arguments NFRAMES up from current execution point.
3493 If that frame has not evaluated the arguments yet (or is a special form),
3494 the value is (nil FUNCTION ARG-FORMS...).
3495 If that frame has evaluated its arguments and called its function already,
3496 the value is (t FUNCTION ARG-VALUES...).
3497 A &rest arg is represented as the tail of the list ARG-VALUES.
3498 FUNCTION is whatever was supplied as car of evaluated list,
3499 or a lambda expression for macro calls.
3500 If NFRAMES is more than the number of frames, the value is nil. */)
3501 (nframes)
3502 Lisp_Object nframes;
3504 register struct backtrace *backlist = backtrace_list;
3505 register int i;
3506 Lisp_Object tem;
3508 CHECK_NATNUM (nframes);
3510 /* Find the frame requested. */
3511 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3512 backlist = backlist->next;
3514 if (!backlist)
3515 return Qnil;
3516 if (backlist->nargs == UNEVALLED)
3517 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3518 else
3520 if (backlist->nargs == MANY)
3521 tem = *backlist->args;
3522 else
3523 tem = Flist (backlist->nargs, backlist->args);
3525 return Fcons (Qt, Fcons (*backlist->function, tem));
3530 void
3531 mark_backtrace ()
3533 register struct backtrace *backlist;
3534 register int i;
3536 for (backlist = backtrace_list; backlist; backlist = backlist->next)
3538 mark_object (*backlist->function);
3540 if (backlist->nargs == UNEVALLED || backlist->nargs == MANY)
3541 i = 0;
3542 else
3543 i = backlist->nargs - 1;
3544 for (; i >= 0; i--)
3545 mark_object (backlist->args[i]);
3549 void
3550 syms_of_eval ()
3552 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3553 doc: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3554 If Lisp code tries to increase the total number past this amount,
3555 an error is signaled.
3556 You can safely use a value considerably larger than the default value,
3557 if that proves inconveniently small. However, if you increase it too far,
3558 Emacs could run out of memory trying to make the stack bigger. */);
3560 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3561 doc: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3563 This limit serves to catch infinite recursions for you before they cause
3564 actual stack overflow in C, which would be fatal for Emacs.
3565 You can safely make it considerably larger than its default value,
3566 if that proves inconveniently small. However, if you increase it too far,
3567 Emacs could overflow the real C stack, and crash. */);
3569 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3570 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3571 If the value is t, that means do an ordinary quit.
3572 If the value equals `throw-on-input', that means quit by throwing
3573 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3574 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3575 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3576 Vquit_flag = Qnil;
3578 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3579 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3580 Note that `quit-flag' will still be set by typing C-g,
3581 so a quit will be signaled as soon as `inhibit-quit' is nil.
3582 To prevent this happening, set `quit-flag' to nil
3583 before making `inhibit-quit' nil. */);
3584 Vinhibit_quit = Qnil;
3586 Qinhibit_quit = intern_c_string ("inhibit-quit");
3587 staticpro (&Qinhibit_quit);
3589 Qautoload = intern_c_string ("autoload");
3590 staticpro (&Qautoload);
3592 Qdebug_on_error = intern_c_string ("debug-on-error");
3593 staticpro (&Qdebug_on_error);
3595 Qmacro = intern_c_string ("macro");
3596 staticpro (&Qmacro);
3598 Qdeclare = intern_c_string ("declare");
3599 staticpro (&Qdeclare);
3601 /* Note that the process handling also uses Qexit, but we don't want
3602 to staticpro it twice, so we just do it here. */
3603 Qexit = intern_c_string ("exit");
3604 staticpro (&Qexit);
3606 Qinteractive = intern_c_string ("interactive");
3607 staticpro (&Qinteractive);
3609 Qcommandp = intern_c_string ("commandp");
3610 staticpro (&Qcommandp);
3612 Qdefun = intern_c_string ("defun");
3613 staticpro (&Qdefun);
3615 Qand_rest = intern_c_string ("&rest");
3616 staticpro (&Qand_rest);
3618 Qand_optional = intern_c_string ("&optional");
3619 staticpro (&Qand_optional);
3621 Qdebug = intern_c_string ("debug");
3622 staticpro (&Qdebug);
3624 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3625 doc: /* *Non-nil means errors display a backtrace buffer.
3626 More precisely, this happens for any error that is handled
3627 by the editor command loop.
3628 If the value is a list, an error only means to display a backtrace
3629 if one of its condition symbols appears in the list. */);
3630 Vstack_trace_on_error = Qnil;
3632 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3633 doc: /* *Non-nil means enter debugger if an error is signaled.
3634 Does not apply to errors handled by `condition-case' or those
3635 matched by `debug-ignored-errors'.
3636 If the value is a list, an error only means to enter the debugger
3637 if one of its condition symbols appears in the list.
3638 When you evaluate an expression interactively, this variable
3639 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3640 The command `toggle-debug-on-error' toggles this.
3641 See also the variable `debug-on-quit'. */);
3642 Vdebug_on_error = Qnil;
3644 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3645 doc: /* *List of errors for which the debugger should not be called.
3646 Each element may be a condition-name or a regexp that matches error messages.
3647 If any element applies to a given error, that error skips the debugger
3648 and just returns to top level.
3649 This overrides the variable `debug-on-error'.
3650 It does not apply to errors handled by `condition-case'. */);
3651 Vdebug_ignored_errors = Qnil;
3653 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3654 doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3655 Does not apply if quit is handled by a `condition-case'. */);
3656 debug_on_quit = 0;
3658 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3659 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3661 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3662 doc: /* Non-nil means debugger may continue execution.
3663 This is nil when the debugger is called under circumstances where it
3664 might not be safe to continue. */);
3665 debugger_may_continue = 1;
3667 DEFVAR_LISP ("debugger", &Vdebugger,
3668 doc: /* Function to call to invoke debugger.
3669 If due to frame exit, args are `exit' and the value being returned;
3670 this function's value will be returned instead of that.
3671 If due to error, args are `error' and a list of the args to `signal'.
3672 If due to `apply' or `funcall' entry, one arg, `lambda'.
3673 If due to `eval' entry, one arg, t. */);
3674 Vdebugger = Qnil;
3676 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3677 doc: /* If non-nil, this is a function for `signal' to call.
3678 It receives the same arguments that `signal' was given.
3679 The Edebug package uses this to regain control. */);
3680 Vsignal_hook_function = Qnil;
3682 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3683 doc: /* *Non-nil means call the debugger regardless of condition handlers.
3684 Note that `debug-on-error', `debug-on-quit' and friends
3685 still determine whether to handle the particular condition. */);
3686 Vdebug_on_signal = Qnil;
3688 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function,
3689 doc: /* Function to process declarations in a macro definition.
3690 The function will be called with two args MACRO and DECL.
3691 MACRO is the name of the macro being defined.
3692 DECL is a list `(declare ...)' containing the declarations.
3693 The value the function returns is not used. */);
3694 Vmacro_declaration_function = Qnil;
3696 Vrun_hooks = intern_c_string ("run-hooks");
3697 staticpro (&Vrun_hooks);
3699 staticpro (&Vautoload_queue);
3700 Vautoload_queue = Qnil;
3701 staticpro (&Vsignaling_function);
3702 Vsignaling_function = Qnil;
3704 defsubr (&Sor);
3705 defsubr (&Sand);
3706 defsubr (&Sif);
3707 defsubr (&Scond);
3708 defsubr (&Sprogn);
3709 defsubr (&Sprog1);
3710 defsubr (&Sprog2);
3711 defsubr (&Ssetq);
3712 defsubr (&Squote);
3713 defsubr (&Sfunction);
3714 defsubr (&Sdefun);
3715 defsubr (&Sdefmacro);
3716 defsubr (&Sdefvar);
3717 defsubr (&Sdefvaralias);
3718 defsubr (&Sdefconst);
3719 defsubr (&Suser_variable_p);
3720 defsubr (&Slet);
3721 defsubr (&SletX);
3722 defsubr (&Swhile);
3723 defsubr (&Smacroexpand);
3724 defsubr (&Scatch);
3725 defsubr (&Sthrow);
3726 defsubr (&Sunwind_protect);
3727 defsubr (&Scondition_case);
3728 defsubr (&Ssignal);
3729 defsubr (&Sinteractive_p);
3730 defsubr (&Scalled_interactively_p);
3731 defsubr (&Scommandp);
3732 defsubr (&Sautoload);
3733 defsubr (&Seval);
3734 defsubr (&Sapply);
3735 defsubr (&Sfuncall);
3736 defsubr (&Srun_hooks);
3737 defsubr (&Srun_hook_with_args);
3738 defsubr (&Srun_hook_with_args_until_success);
3739 defsubr (&Srun_hook_with_args_until_failure);
3740 defsubr (&Sfetch_bytecode);
3741 defsubr (&Sbacktrace_debug);
3742 defsubr (&Sbacktrace);
3743 defsubr (&Sbacktrace_frame);
3746 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3747 (do not change this comment) */