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
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/>. */
24 #include "blockinput.h"
27 #include "dispextern.h"
34 /* This definition is duplicated in alloc.c and keyboard.c */
35 /* Putting it in lisp.h makes cc bomb out! */
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 */
46 /* Nonzero means call value of debugger when done with this operation. */
50 struct backtrace
*backtrace_list
;
52 /* This structure helps implement the `catch' and `throw' control
53 structure. A struct catchtag contains all the information needed
54 to restore the state of the interpreter after a non-local jump.
56 Handlers for error conditions (represented by `struct handler'
57 structures) just point to a catch tag to do the cleanup required
60 catchtag structures are chained together in the C calling stack;
61 the `next' member points to the next outer catchtag.
63 A call like (throw TAG VAL) searches for a catchtag whose `tag'
64 member is TAG, and then unbinds to it. The `val' member is used to
65 hold VAL while the stack is unwound; `val' is returned as the value
68 All the other members are concerned with restoring the interpreter
75 struct catchtag
*next
;
78 struct backtrace
*backlist
;
79 struct handler
*handlerlist
;
82 int poll_suppress_count
;
83 int interrupt_input_blocked
;
84 struct byte_stack
*byte_stack
;
87 struct catchtag
*catchlist
;
90 /* Count levels of GCPRO to detect failure to UNGCPRO. */
94 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
95 Lisp_Object Qinhibit_quit
, Vinhibit_quit
, Vquit_flag
;
96 Lisp_Object Qand_rest
, Qand_optional
;
97 Lisp_Object Qdebug_on_error
;
101 /* This holds either the symbol `run-hooks' or nil.
102 It is nil at an early stage of startup, and when Emacs
105 Lisp_Object Vrun_hooks
;
107 /* Non-nil means record all fset's and provide's, to be undone
108 if the file being autoloaded is not fully loaded.
109 They are recorded by being consed onto the front of Vautoload_queue:
110 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
112 Lisp_Object Vautoload_queue
;
114 /* Current number of specbindings allocated in specpdl. */
118 /* Pointer to beginning of specpdl. */
120 struct specbinding
*specpdl
;
122 /* Pointer to first unused element in specpdl. */
124 struct specbinding
*specpdl_ptr
;
126 /* Maximum size allowed for specpdl allocation */
128 EMACS_INT max_specpdl_size
;
130 /* Depth in Lisp evaluations and function calls. */
134 /* Maximum allowed depth in Lisp evaluations and function calls. */
136 EMACS_INT max_lisp_eval_depth
;
138 /* Nonzero means enter debugger before next function call */
140 int debug_on_next_call
;
142 /* Non-zero means debugger may continue. This is zero when the
143 debugger is called during redisplay, where it might not be safe to
144 continue the interrupted redisplay. */
146 int debugger_may_continue
;
148 /* List of conditions (non-nil atom means all) which cause a backtrace
149 if an error is handled by the command loop's error handler. */
151 Lisp_Object Vstack_trace_on_error
;
153 /* List of conditions (non-nil atom means all) which enter the debugger
154 if an error is handled by the command loop's error handler. */
156 Lisp_Object Vdebug_on_error
;
158 /* List of conditions and regexps specifying error messages which
159 do not enter the debugger even if Vdebug_on_error says they should. */
161 Lisp_Object Vdebug_ignored_errors
;
163 /* Non-nil means call the debugger even if the error will be handled. */
165 Lisp_Object Vdebug_on_signal
;
167 /* Hook for edebug to use. */
169 Lisp_Object Vsignal_hook_function
;
171 /* Nonzero means enter debugger if a quit signal
172 is handled by the command loop's error handler. */
176 /* The value of num_nonmacro_input_events as of the last time we
177 started to enter the debugger. If we decide to enter the debugger
178 again when this is still equal to num_nonmacro_input_events, then we
179 know that the debugger itself has an error, and we should just
180 signal the error instead of entering an infinite loop of debugger
183 int when_entered_debugger
;
185 Lisp_Object Vdebugger
;
187 /* The function from which the last `signal' was called. Set in
190 Lisp_Object Vsignaling_function
;
192 /* Set to non-zero while processing X events. Checked in Feval to
193 make sure the Lisp interpreter isn't called from a signal handler,
194 which is unsafe because the interpreter isn't reentrant. */
198 /* Function to process declarations in defmacro forms. */
200 Lisp_Object Vmacro_declaration_function
;
202 extern Lisp_Object Qrisky_local_variable
;
204 extern Lisp_Object Qfunction
;
206 static Lisp_Object funcall_lambda
P_ ((Lisp_Object
, int, Lisp_Object
*));
207 static void unwind_to_catch
P_ ((struct catchtag
*, Lisp_Object
)) NO_RETURN
;
210 /* "gcc -O3" enables automatic function inlining, which optimizes out
211 the arguments for the invocations of these functions, whereas they
212 expect these values on the stack. */
213 Lisp_Object
apply1 () __attribute__((noinline
));
214 Lisp_Object
call2 () __attribute__((noinline
));
221 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
222 specpdl_ptr
= specpdl
;
223 /* Don't forget to update docs (lispref node "Local Variables"). */
224 max_specpdl_size
= 1000;
225 max_lisp_eval_depth
= 400;
233 specpdl_ptr
= specpdl
;
238 debug_on_next_call
= 0;
243 /* This is less than the initial value of num_nonmacro_input_events. */
244 when_entered_debugger
= -1;
247 /* unwind-protect function used by call_debugger. */
250 restore_stack_limits (data
)
253 max_specpdl_size
= XINT (XCAR (data
));
254 max_lisp_eval_depth
= XINT (XCDR (data
));
258 /* Call the Lisp debugger, giving it argument ARG. */
264 int debug_while_redisplaying
;
265 int count
= SPECPDL_INDEX ();
267 int old_max
= max_specpdl_size
;
269 /* Temporarily bump up the stack limits,
270 so the debugger won't run out of stack. */
272 max_specpdl_size
+= 1;
273 record_unwind_protect (restore_stack_limits
,
274 Fcons (make_number (old_max
),
275 make_number (max_lisp_eval_depth
)));
276 max_specpdl_size
= old_max
;
278 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
279 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
281 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
282 max_specpdl_size
= SPECPDL_INDEX () + 100;
284 #ifdef HAVE_WINDOW_SYSTEM
285 if (display_hourglass_p
)
289 debug_on_next_call
= 0;
290 when_entered_debugger
= num_nonmacro_input_events
;
292 /* Resetting redisplaying_p to 0 makes sure that debug output is
293 displayed if the debugger is invoked during redisplay. */
294 debug_while_redisplaying
= redisplaying_p
;
296 specbind (intern ("debugger-may-continue"),
297 debug_while_redisplaying
? Qnil
: Qt
);
298 specbind (Qinhibit_redisplay
, Qnil
);
299 specbind (Qdebug_on_error
, Qnil
);
301 #if 0 /* Binding this prevents execution of Lisp code during
302 redisplay, which necessarily leads to display problems. */
303 specbind (Qinhibit_eval_during_redisplay
, Qt
);
306 val
= apply1 (Vdebugger
, arg
);
308 /* Interrupting redisplay and resuming it later is not safe under
309 all circumstances. So, when the debugger returns, abort the
310 interrupted redisplay by going back to the top-level. */
311 if (debug_while_redisplaying
)
314 return unbind_to (count
, val
);
318 do_debug_on_call (code
)
321 debug_on_next_call
= 0;
322 backtrace_list
->debug_on_exit
= 1;
323 call_debugger (Fcons (code
, Qnil
));
326 /* NOTE!!! Every function that can call EVAL must protect its args
327 and temporaries from garbage collection while it needs them.
328 The definition of `For' shows what you have to do. */
330 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
331 doc
: /* Eval args until one of them yields non-nil, then return that value.
332 The remaining args are not evalled at all.
333 If all args return nil, return nil.
334 usage: (or CONDITIONS...) */)
338 register Lisp_Object val
= Qnil
;
345 val
= Feval (XCAR (args
));
355 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
356 doc
: /* Eval args until one of them yields nil, then return nil.
357 The remaining args are not evalled at all.
358 If no arg yields nil, return the last arg's value.
359 usage: (and CONDITIONS...) */)
363 register Lisp_Object val
= Qt
;
370 val
= Feval (XCAR (args
));
380 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
381 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
382 Returns the value of THEN or the value of the last of the ELSE's.
383 THEN must be one expression, but ELSE... can be zero or more expressions.
384 If COND yields nil, and there are no ELSE's, the value is nil.
385 usage: (if COND THEN ELSE...) */)
389 register Lisp_Object cond
;
393 cond
= Feval (Fcar (args
));
397 return Feval (Fcar (Fcdr (args
)));
398 return Fprogn (Fcdr (Fcdr (args
)));
401 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
402 doc
: /* Try each clause until one succeeds.
403 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
404 and, if the value is non-nil, this clause succeeds:
405 then the expressions in BODY are evaluated and the last one's
406 value is the value of the cond-form.
407 If no clause succeeds, cond returns nil.
408 If a clause has one element, as in (CONDITION),
409 CONDITION's value if non-nil is returned from the cond-form.
410 usage: (cond CLAUSES...) */)
414 register Lisp_Object clause
, val
;
421 clause
= Fcar (args
);
422 val
= Feval (Fcar (clause
));
425 if (!EQ (XCDR (clause
), Qnil
))
426 val
= Fprogn (XCDR (clause
));
436 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
437 doc
: /* Eval BODY forms sequentially and return value of last one.
438 usage: (progn BODY...) */)
442 register Lisp_Object val
= Qnil
;
449 val
= Feval (XCAR (args
));
457 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
458 doc
: /* Eval FIRST and BODY sequentially; value from FIRST.
459 The value of FIRST is saved during the evaluation of the remaining args,
460 whose values are discarded.
461 usage: (prog1 FIRST BODY...) */)
466 register Lisp_Object args_left
;
467 struct gcpro gcpro1
, gcpro2
;
468 register int argnum
= 0;
480 val
= Feval (Fcar (args_left
));
482 Feval (Fcar (args_left
));
483 args_left
= Fcdr (args_left
);
485 while (!NILP(args_left
));
491 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
492 doc
: /* Eval FORM1, FORM2 and BODY sequentially; value from FORM2.
493 The value of FORM2 is saved during the evaluation of the
494 remaining args, whose values are discarded.
495 usage: (prog2 FORM1 FORM2 BODY...) */)
500 register Lisp_Object args_left
;
501 struct gcpro gcpro1
, gcpro2
;
502 register int argnum
= -1;
516 val
= Feval (Fcar (args_left
));
518 Feval (Fcar (args_left
));
519 args_left
= Fcdr (args_left
);
521 while (!NILP (args_left
));
527 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
528 doc
: /* Set each SYM to the value of its VAL.
529 The symbols SYM are variables; they are literal (not evaluated).
530 The values VAL are expressions; they are evaluated.
531 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
532 The second VAL is not computed until after the first SYM is set, and so on;
533 each VAL can use the new value of variables set earlier in the `setq'.
534 The return value of the `setq' form is the value of the last VAL.
535 usage: (setq [SYM VAL]...) */)
539 register Lisp_Object args_left
;
540 register Lisp_Object val
, sym
;
551 val
= Feval (Fcar (Fcdr (args_left
)));
552 sym
= Fcar (args_left
);
554 args_left
= Fcdr (Fcdr (args_left
));
556 while (!NILP(args_left
));
562 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
563 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
564 usage: (quote ARG) */)
568 if (!NILP (Fcdr (args
)))
569 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
573 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
574 doc
: /* Like `quote', but preferred for objects which are functions.
575 In byte compilation, `function' causes its argument to be compiled.
576 `quote' cannot do that.
577 usage: (function ARG) */)
581 if (!NILP (Fcdr (args
)))
582 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
587 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
588 doc
: /* Return t if the function was run directly by user input.
589 This means that the function was called with `call-interactively'
590 \(which includes being called as the binding of a key)
591 and input is currently coming from the keyboard (not in keyboard macro),
592 and Emacs is not running in batch mode (`noninteractive' is nil).
594 The only known proper use of `interactive-p' is in deciding whether to
595 display a helpful message, or how to display it. If you're thinking
596 of using it for any other purpose, it is quite likely that you're
597 making a mistake. Think: what do you want to do when the command is
598 called from a keyboard macro?
600 If you want to test whether your function was called with
601 `call-interactively', the way to do that is by adding an extra
602 optional argument, and making the `interactive' spec specify non-nil
603 unconditionally for that argument. (`p' is a good way to do this.) */)
606 return (INTERACTIVE
&& interactive_p (1)) ? Qt
: Qnil
;
610 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 0, 0,
611 doc
: /* Return t if the function using this was called with `call-interactively'.
612 This is used for implementing advice and other function-modifying
615 The cleanest way to test whether your function was called with
616 `call-interactively' is by adding an extra optional argument,
617 and making the `interactive' spec specify non-nil unconditionally
618 for that argument. (`p' is a good way to do this.) */)
621 return interactive_p (1) ? Qt
: Qnil
;
625 /* Return 1 if function in which this appears was called using
628 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
629 called is a built-in. */
632 interactive_p (exclude_subrs_p
)
635 struct backtrace
*btp
;
638 btp
= backtrace_list
;
640 /* If this isn't a byte-compiled function, there may be a frame at
641 the top for Finteractive_p. If so, skip it. */
642 fun
= Findirect_function (*btp
->function
, Qnil
);
643 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
644 || XSUBR (fun
) == &Scalled_interactively_p
))
647 /* If we're running an Emacs 18-style byte-compiled function, there
648 may be a frame for Fbytecode at the top level. In any version of
649 Emacs there can be Fbytecode frames for subexpressions evaluated
650 inside catch and condition-case. Skip past them.
652 If this isn't a byte-compiled function, then we may now be
653 looking at several frames for special forms. Skip past them. */
655 && (EQ (*btp
->function
, Qbytecode
)
656 || btp
->nargs
== UNEVALLED
))
659 /* btp now points at the frame of the innermost function that isn't
660 a special form, ignoring frames for Finteractive_p and/or
661 Fbytecode at the top. If this frame is for a built-in function
662 (such as load or eval-region) return nil. */
663 fun
= Findirect_function (*btp
->function
, Qnil
);
664 if (exclude_subrs_p
&& SUBRP (fun
))
667 /* btp points to the frame of a Lisp function that called interactive-p.
668 Return t if that function was called interactively. */
669 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
675 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
676 doc
: /* Define NAME as a function.
677 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
678 See also the function `interactive'.
679 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
683 register Lisp_Object fn_name
;
684 register Lisp_Object defn
;
686 fn_name
= Fcar (args
);
687 CHECK_SYMBOL (fn_name
);
688 defn
= Fcons (Qlambda
, Fcdr (args
));
689 if (!NILP (Vpurify_flag
))
690 defn
= Fpurecopy (defn
);
691 if (CONSP (XSYMBOL (fn_name
)->function
)
692 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
693 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
694 Ffset (fn_name
, defn
);
695 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
699 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
700 doc
: /* Define NAME as a macro.
701 The actual definition looks like
702 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
703 When the macro is called, as in (NAME ARGS...),
704 the function (lambda ARGLIST BODY...) is applied to
705 the list ARGS... as it appears in the expression,
706 and the result should be a form to be evaluated instead of the original.
708 DECL is a declaration, optional, which can specify how to indent
709 calls to this macro, how Edebug should handle it, and which argument
710 should be treated as documentation. It looks like this:
712 The elements can look like this:
714 Set NAME's `lisp-indent-function' property to INDENT.
717 Set NAME's `edebug-form-spec' property to DEBUG. (This is
718 equivalent to writing a `def-edebug-spec' for the macro.)
721 Set NAME's `doc-string-elt' property to ELT.
723 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
727 register Lisp_Object fn_name
;
728 register Lisp_Object defn
;
729 Lisp_Object lambda_list
, doc
, tail
;
731 fn_name
= Fcar (args
);
732 CHECK_SYMBOL (fn_name
);
733 lambda_list
= Fcar (Fcdr (args
));
734 tail
= Fcdr (Fcdr (args
));
737 if (STRINGP (Fcar (tail
)))
743 while (CONSP (Fcar (tail
))
744 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
746 if (!NILP (Vmacro_declaration_function
))
750 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
758 tail
= Fcons (lambda_list
, tail
);
760 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
761 defn
= Fcons (Qmacro
, Fcons (Qlambda
, tail
));
763 if (!NILP (Vpurify_flag
))
764 defn
= Fpurecopy (defn
);
765 if (CONSP (XSYMBOL (fn_name
)->function
)
766 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
767 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
768 Ffset (fn_name
, defn
);
769 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
774 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
775 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
776 Aliased variables always have the same value; setting one sets the other.
777 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
778 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
779 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
780 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
781 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
782 The return value is BASE-VARIABLE. */)
783 (new_alias
, base_variable
, docstring
)
784 Lisp_Object new_alias
, base_variable
, docstring
;
786 struct Lisp_Symbol
*sym
;
788 CHECK_SYMBOL (new_alias
);
789 CHECK_SYMBOL (base_variable
);
791 if (SYMBOL_CONSTANT_P (new_alias
))
792 error ("Cannot make a constant an alias");
794 sym
= XSYMBOL (new_alias
);
795 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
796 If n_a is bound, but b_v is not, set the value of b_v to n_a.
797 This is for the sake of define-obsolete-variable-alias and user
799 if (NILP (Fboundp (base_variable
)) && !NILP (Fboundp (new_alias
)))
800 XSYMBOL(base_variable
)->value
= sym
->value
;
801 sym
->indirect_variable
= 1;
802 sym
->value
= base_variable
;
803 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
804 LOADHIST_ATTACH (new_alias
);
805 if (!NILP (docstring
))
806 Fput (new_alias
, Qvariable_documentation
, docstring
);
808 Fput (new_alias
, Qvariable_documentation
, Qnil
);
810 return base_variable
;
814 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
815 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
816 You are not required to define a variable in order to use it,
817 but the definition can supply documentation and an initial value
818 in a way that tags can recognize.
820 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
821 If SYMBOL is buffer-local, its default value is what is set;
822 buffer-local values are not affected.
823 INITVALUE and DOCSTRING are optional.
824 If DOCSTRING starts with *, this variable is identified as a user option.
825 This means that M-x set-variable recognizes it.
826 See also `user-variable-p'.
827 If INITVALUE is missing, SYMBOL's value is not set.
829 If SYMBOL has a local binding, then this form affects the local
830 binding. This is usually not what you want. Thus, if you need to
831 load a file defining variables, with this form or with `defconst' or
832 `defcustom', you should always load that file _outside_ any bindings
833 for these variables. \(`defconst' and `defcustom' behave similarly in
835 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
839 register Lisp_Object sym
, tem
, tail
;
843 if (!NILP (Fcdr (Fcdr (tail
))))
844 error ("Too many arguments");
846 tem
= Fdefault_boundp (sym
);
849 if (SYMBOL_CONSTANT_P (sym
))
851 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
852 Lisp_Object tem
= Fcar (tail
);
854 && EQ (XCAR (tem
), Qquote
)
855 && CONSP (XCDR (tem
))
856 && EQ (XCAR (XCDR (tem
)), sym
)))
857 error ("Constant symbol `%s' specified in defvar",
858 SDATA (SYMBOL_NAME (sym
)));
862 Fset_default (sym
, Feval (Fcar (tail
)));
864 { /* Check if there is really a global binding rather than just a let
865 binding that shadows the global unboundness of the var. */
866 volatile struct specbinding
*pdl
= specpdl_ptr
;
867 while (--pdl
>= specpdl
)
869 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
870 && EQ (pdl
->old_value
, Qunbound
))
872 message_with_string ("Warning: defvar ignored because %s is let-bound",
873 SYMBOL_NAME (sym
), 1);
882 if (!NILP (Vpurify_flag
))
883 tem
= Fpurecopy (tem
);
884 Fput (sym
, Qvariable_documentation
, tem
);
886 LOADHIST_ATTACH (sym
);
889 /* Simple (defvar <var>) should not count as a definition at all.
890 It could get in the way of other definitions, and unloading this
891 package could try to make the variable unbound. */
897 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
898 doc
: /* Define SYMBOL as a constant variable.
899 The intent is that neither programs nor users should ever change this value.
900 Always sets the value of SYMBOL to the result of evalling INITVALUE.
901 If SYMBOL is buffer-local, its default value is what is set;
902 buffer-local values are not affected.
903 DOCSTRING is optional.
905 If SYMBOL has a local binding, then this form sets the local binding's
906 value. However, you should normally not make local bindings for
907 variables defined with this form.
908 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
912 register Lisp_Object sym
, tem
;
915 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
916 error ("Too many arguments");
918 tem
= Feval (Fcar (Fcdr (args
)));
919 if (!NILP (Vpurify_flag
))
920 tem
= Fpurecopy (tem
);
921 Fset_default (sym
, tem
);
922 tem
= Fcar (Fcdr (Fcdr (args
)));
925 if (!NILP (Vpurify_flag
))
926 tem
= Fpurecopy (tem
);
927 Fput (sym
, Qvariable_documentation
, tem
);
929 Fput (sym
, Qrisky_local_variable
, Qt
);
930 LOADHIST_ATTACH (sym
);
934 /* Error handler used in Fuser_variable_p. */
936 user_variable_p_eh (ignore
)
943 lisp_indirect_variable (Lisp_Object sym
)
945 XSETSYMBOL (sym
, indirect_variable (XSYMBOL (sym
)));
949 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
950 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
951 \(The alternative is a variable used internally in a Lisp program.)
952 A variable is a user variable if
953 \(1) the first character of its documentation is `*', or
954 \(2) it is customizable (its property list contains a non-nil value
955 of `standard-value' or `custom-autoload'), or
956 \(3) it is an alias for another user variable.
957 Return nil if VARIABLE is an alias and there is a loop in the
958 chain of symbols. */)
960 Lisp_Object variable
;
962 Lisp_Object documentation
;
964 if (!SYMBOLP (variable
))
967 /* If indirect and there's an alias loop, don't check anything else. */
968 if (XSYMBOL (variable
)->indirect_variable
969 && NILP (internal_condition_case_1 (lisp_indirect_variable
, variable
,
970 Qt
, user_variable_p_eh
)))
975 documentation
= Fget (variable
, Qvariable_documentation
);
976 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
978 if (STRINGP (documentation
)
979 && ((unsigned char) SREF (documentation
, 0) == '*'))
981 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
982 if (CONSP (documentation
)
983 && STRINGP (XCAR (documentation
))
984 && INTEGERP (XCDR (documentation
))
985 && XINT (XCDR (documentation
)) < 0)
987 /* Customizable? See `custom-variable-p'. */
988 if ((!NILP (Fget (variable
, intern ("standard-value"))))
989 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
992 if (!XSYMBOL (variable
)->indirect_variable
)
995 /* An indirect variable? Let's follow the chain. */
996 variable
= XSYMBOL (variable
)->value
;
1000 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
1001 doc
: /* Bind variables according to VARLIST then eval BODY.
1002 The value of the last form in BODY is returned.
1003 Each element of VARLIST is a symbol (which is bound to nil)
1004 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1005 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
1006 usage: (let* VARLIST BODY...) */)
1010 Lisp_Object varlist
, val
, elt
;
1011 int count
= SPECPDL_INDEX ();
1012 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1014 GCPRO3 (args
, elt
, varlist
);
1016 varlist
= Fcar (args
);
1017 while (!NILP (varlist
))
1020 elt
= Fcar (varlist
);
1022 specbind (elt
, Qnil
);
1023 else if (! NILP (Fcdr (Fcdr (elt
))))
1024 signal_error ("`let' bindings can have only one value-form", elt
);
1027 val
= Feval (Fcar (Fcdr (elt
)));
1028 specbind (Fcar (elt
), val
);
1030 varlist
= Fcdr (varlist
);
1033 val
= Fprogn (Fcdr (args
));
1034 return unbind_to (count
, val
);
1037 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1038 doc
: /* Bind variables according to VARLIST then eval BODY.
1039 The value of the last form in BODY is returned.
1040 Each element of VARLIST is a symbol (which is bound to nil)
1041 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1042 All the VALUEFORMs are evalled before any symbols are bound.
1043 usage: (let VARLIST BODY...) */)
1047 Lisp_Object
*temps
, tem
;
1048 register Lisp_Object elt
, varlist
;
1049 int count
= SPECPDL_INDEX ();
1050 register int argnum
;
1051 struct gcpro gcpro1
, gcpro2
;
1053 varlist
= Fcar (args
);
1055 /* Make space to hold the values to give the bound variables */
1056 elt
= Flength (varlist
);
1057 temps
= (Lisp_Object
*) alloca (XFASTINT (elt
) * sizeof (Lisp_Object
));
1059 /* Compute the values and store them in `temps' */
1061 GCPRO2 (args
, *temps
);
1064 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1067 elt
= XCAR (varlist
);
1069 temps
[argnum
++] = Qnil
;
1070 else if (! NILP (Fcdr (Fcdr (elt
))))
1071 signal_error ("`let' bindings can have only one value-form", elt
);
1073 temps
[argnum
++] = Feval (Fcar (Fcdr (elt
)));
1074 gcpro2
.nvars
= argnum
;
1078 varlist
= Fcar (args
);
1079 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1081 elt
= XCAR (varlist
);
1082 tem
= temps
[argnum
++];
1084 specbind (elt
, tem
);
1086 specbind (Fcar (elt
), tem
);
1089 elt
= Fprogn (Fcdr (args
));
1090 return unbind_to (count
, elt
);
1093 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1094 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1095 The order of execution is thus TEST, BODY, TEST, BODY and so on
1096 until TEST returns nil.
1097 usage: (while TEST BODY...) */)
1101 Lisp_Object test
, body
;
1102 struct gcpro gcpro1
, gcpro2
;
1104 GCPRO2 (test
, body
);
1108 while (!NILP (Feval (test
)))
1118 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1119 doc
: /* Return result of expanding macros at top level of FORM.
1120 If FORM is not a macro call, it is returned unchanged.
1121 Otherwise, the macro is expanded and the expansion is considered
1122 in place of FORM. When a non-macro-call results, it is returned.
1124 The second optional arg ENVIRONMENT specifies an environment of macro
1125 definitions to shadow the loaded ones for use in file byte-compilation. */)
1128 Lisp_Object environment
;
1130 /* With cleanups from Hallvard Furuseth. */
1131 register Lisp_Object expander
, sym
, def
, tem
;
1135 /* Come back here each time we expand a macro call,
1136 in case it expands into another macro call. */
1139 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1140 def
= sym
= XCAR (form
);
1142 /* Trace symbols aliases to other symbols
1143 until we get a symbol that is not an alias. */
1144 while (SYMBOLP (def
))
1148 tem
= Fassq (sym
, environment
);
1151 def
= XSYMBOL (sym
)->function
;
1152 if (!EQ (def
, Qunbound
))
1157 /* Right now TEM is the result from SYM in ENVIRONMENT,
1158 and if TEM is nil then DEF is SYM's function definition. */
1161 /* SYM is not mentioned in ENVIRONMENT.
1162 Look at its function definition. */
1163 if (EQ (def
, Qunbound
) || !CONSP (def
))
1164 /* Not defined or definition not suitable */
1166 if (EQ (XCAR (def
), Qautoload
))
1168 /* Autoloading function: will it be a macro when loaded? */
1169 tem
= Fnth (make_number (4), def
);
1170 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1171 /* Yes, load it and try again. */
1173 struct gcpro gcpro1
;
1175 do_autoload (def
, sym
);
1182 else if (!EQ (XCAR (def
), Qmacro
))
1184 else expander
= XCDR (def
);
1188 expander
= XCDR (tem
);
1189 if (NILP (expander
))
1192 form
= apply1 (expander
, XCDR (form
));
1197 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1198 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1199 TAG is evalled to get the tag to use; it must not be nil.
1201 Then the BODY is executed.
1202 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1203 If no throw happens, `catch' returns the value of the last BODY form.
1204 If a throw happens, it specifies the value to return from `catch'.
1205 usage: (catch TAG BODY...) */)
1209 register Lisp_Object tag
;
1210 struct gcpro gcpro1
;
1213 tag
= Feval (Fcar (args
));
1215 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1218 /* Set up a catch, then call C function FUNC on argument ARG.
1219 FUNC should return a Lisp_Object.
1220 This is how catches are done from within C code. */
1223 internal_catch (tag
, func
, arg
)
1225 Lisp_Object (*func
) ();
1228 /* This structure is made part of the chain `catchlist'. */
1231 /* Fill in the components of c, and put it on the list. */
1235 c
.backlist
= backtrace_list
;
1236 c
.handlerlist
= handlerlist
;
1237 c
.lisp_eval_depth
= lisp_eval_depth
;
1238 c
.pdlcount
= SPECPDL_INDEX ();
1239 c
.poll_suppress_count
= poll_suppress_count
;
1240 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1241 c
.gcpro
= gcprolist
;
1242 c
.byte_stack
= byte_stack_list
;
1246 if (! _setjmp (c
.jmp
))
1247 c
.val
= (*func
) (arg
);
1249 /* Throw works by a longjmp that comes right here. */
1254 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1255 jump to that CATCH, returning VALUE as the value of that catch.
1257 This is the guts Fthrow and Fsignal; they differ only in the way
1258 they choose the catch tag to throw to. A catch tag for a
1259 condition-case form has a TAG of Qnil.
1261 Before each catch is discarded, unbind all special bindings and
1262 execute all unwind-protect clauses made above that catch. Unwind
1263 the handler stack as we go, so that the proper handlers are in
1264 effect for each unwind-protect clause we run. At the end, restore
1265 some static info saved in CATCH, and longjmp to the location
1268 This is used for correct unwinding in Fthrow and Fsignal. */
1271 unwind_to_catch (catch, value
)
1272 struct catchtag
*catch;
1275 register int last_time
;
1277 /* Save the value in the tag. */
1280 /* Restore certain special C variables. */
1281 set_poll_suppress_count (catch->poll_suppress_count
);
1282 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1283 handling_signal
= 0;
1288 last_time
= catchlist
== catch;
1290 /* Unwind the specpdl stack, and then restore the proper set of
1292 unbind_to (catchlist
->pdlcount
, Qnil
);
1293 handlerlist
= catchlist
->handlerlist
;
1294 catchlist
= catchlist
->next
;
1296 while (! last_time
);
1299 /* If x_catch_errors was done, turn it off now.
1300 (First we give unbind_to a chance to do that.) */
1301 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1302 * The catch must remain in effect during that delicate
1303 * state. --lorentey */
1304 x_fully_uncatch_errors ();
1308 byte_stack_list
= catch->byte_stack
;
1309 gcprolist
= catch->gcpro
;
1312 gcpro_level
= gcprolist
->level
+ 1;
1316 backtrace_list
= catch->backlist
;
1317 lisp_eval_depth
= catch->lisp_eval_depth
;
1319 _longjmp (catch->jmp
, 1);
1322 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1323 doc
: /* Throw to the catch for TAG and return VALUE from it.
1324 Both TAG and VALUE are evalled. */)
1326 register Lisp_Object tag
, value
;
1328 register struct catchtag
*c
;
1331 for (c
= catchlist
; c
; c
= c
->next
)
1333 if (EQ (c
->tag
, tag
))
1334 unwind_to_catch (c
, value
);
1336 xsignal2 (Qno_catch
, tag
, value
);
1340 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1341 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1342 If BODYFORM completes normally, its value is returned
1343 after executing the UNWINDFORMS.
1344 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1345 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1350 int count
= SPECPDL_INDEX ();
1352 record_unwind_protect (Fprogn
, Fcdr (args
));
1353 val
= Feval (Fcar (args
));
1354 return unbind_to (count
, val
);
1357 /* Chain of condition handlers currently in effect.
1358 The elements of this chain are contained in the stack frames
1359 of Fcondition_case and internal_condition_case.
1360 When an error is signaled (by calling Fsignal, below),
1361 this chain is searched for an element that applies. */
1363 struct handler
*handlerlist
;
1365 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1366 doc
: /* Regain control when an error is signaled.
1367 Executes BODYFORM and returns its value if no error happens.
1368 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1369 where the BODY is made of Lisp expressions.
1371 A handler is applicable to an error
1372 if CONDITION-NAME is one of the error's condition names.
1373 If an error happens, the first applicable handler is run.
1375 The car of a handler may be a list of condition names
1376 instead of a single condition name. Then it handles all of them.
1378 When a handler handles an error, control returns to the `condition-case'
1379 and it executes the handler's BODY...
1380 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA) from the error.
1381 (If VAR is nil, the handler can't access that information.)
1382 Then the value of the last BODY form is returned from the `condition-case'
1385 See also the function `signal' for more info.
1386 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1390 register Lisp_Object bodyform
, handlers
;
1391 volatile Lisp_Object var
;
1394 bodyform
= Fcar (Fcdr (args
));
1395 handlers
= Fcdr (Fcdr (args
));
1397 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1400 /* Like Fcondition_case, but the args are separate
1401 rather than passed in a list. Used by Fbyte_code. */
1404 internal_lisp_condition_case (var
, bodyform
, handlers
)
1405 volatile Lisp_Object var
;
1406 Lisp_Object bodyform
, handlers
;
1414 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1420 && (SYMBOLP (XCAR (tem
))
1421 || CONSP (XCAR (tem
))))))
1422 error ("Invalid condition handler", tem
);
1427 c
.backlist
= backtrace_list
;
1428 c
.handlerlist
= handlerlist
;
1429 c
.lisp_eval_depth
= lisp_eval_depth
;
1430 c
.pdlcount
= SPECPDL_INDEX ();
1431 c
.poll_suppress_count
= poll_suppress_count
;
1432 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1433 c
.gcpro
= gcprolist
;
1434 c
.byte_stack
= byte_stack_list
;
1435 if (_setjmp (c
.jmp
))
1438 specbind (h
.var
, c
.val
);
1439 val
= Fprogn (Fcdr (h
.chosen_clause
));
1441 /* Note that this just undoes the binding of h.var; whoever
1442 longjumped to us unwound the stack to c.pdlcount before
1444 unbind_to (c
.pdlcount
, Qnil
);
1451 h
.handler
= handlers
;
1452 h
.next
= handlerlist
;
1456 val
= Feval (bodyform
);
1458 handlerlist
= h
.next
;
1462 /* Call the function BFUN with no arguments, catching errors within it
1463 according to HANDLERS. If there is an error, call HFUN with
1464 one argument which is the data that describes the error:
1467 HANDLERS can be a list of conditions to catch.
1468 If HANDLERS is Qt, catch all errors.
1469 If HANDLERS is Qerror, catch all errors
1470 but allow the debugger to run if that is enabled. */
1473 internal_condition_case (bfun
, handlers
, hfun
)
1474 Lisp_Object (*bfun
) ();
1475 Lisp_Object handlers
;
1476 Lisp_Object (*hfun
) ();
1482 /* Since Fsignal will close off all calls to x_catch_errors,
1483 we will get the wrong results if some are not closed now. */
1485 if (x_catching_errors ())
1491 c
.backlist
= backtrace_list
;
1492 c
.handlerlist
= handlerlist
;
1493 c
.lisp_eval_depth
= lisp_eval_depth
;
1494 c
.pdlcount
= SPECPDL_INDEX ();
1495 c
.poll_suppress_count
= poll_suppress_count
;
1496 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1497 c
.gcpro
= gcprolist
;
1498 c
.byte_stack
= byte_stack_list
;
1499 if (_setjmp (c
.jmp
))
1501 return (*hfun
) (c
.val
);
1505 h
.handler
= handlers
;
1507 h
.next
= handlerlist
;
1513 handlerlist
= h
.next
;
1517 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1520 internal_condition_case_1 (bfun
, arg
, handlers
, hfun
)
1521 Lisp_Object (*bfun
) ();
1523 Lisp_Object handlers
;
1524 Lisp_Object (*hfun
) ();
1530 /* Since Fsignal will close off all calls to x_catch_errors,
1531 we will get the wrong results if some are not closed now. */
1533 if (x_catching_errors ())
1539 c
.backlist
= backtrace_list
;
1540 c
.handlerlist
= handlerlist
;
1541 c
.lisp_eval_depth
= lisp_eval_depth
;
1542 c
.pdlcount
= SPECPDL_INDEX ();
1543 c
.poll_suppress_count
= poll_suppress_count
;
1544 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1545 c
.gcpro
= gcprolist
;
1546 c
.byte_stack
= byte_stack_list
;
1547 if (_setjmp (c
.jmp
))
1549 return (*hfun
) (c
.val
);
1553 h
.handler
= handlers
;
1555 h
.next
= handlerlist
;
1559 val
= (*bfun
) (arg
);
1561 handlerlist
= h
.next
;
1566 /* Like internal_condition_case but call BFUN with NARGS as first,
1567 and ARGS as second argument. */
1570 internal_condition_case_2 (bfun
, nargs
, args
, handlers
, hfun
)
1571 Lisp_Object (*bfun
) ();
1574 Lisp_Object handlers
;
1575 Lisp_Object (*hfun
) ();
1581 /* Since Fsignal will close off all calls to x_catch_errors,
1582 we will get the wrong results if some are not closed now. */
1584 if (x_catching_errors ())
1590 c
.backlist
= backtrace_list
;
1591 c
.handlerlist
= handlerlist
;
1592 c
.lisp_eval_depth
= lisp_eval_depth
;
1593 c
.pdlcount
= SPECPDL_INDEX ();
1594 c
.poll_suppress_count
= poll_suppress_count
;
1595 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1596 c
.gcpro
= gcprolist
;
1597 c
.byte_stack
= byte_stack_list
;
1598 if (_setjmp (c
.jmp
))
1600 return (*hfun
) (c
.val
);
1604 h
.handler
= handlers
;
1606 h
.next
= handlerlist
;
1610 val
= (*bfun
) (nargs
, args
);
1612 handlerlist
= h
.next
;
1617 static Lisp_Object find_handler_clause
P_ ((Lisp_Object
, Lisp_Object
,
1618 Lisp_Object
, Lisp_Object
));
1620 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1621 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1622 This function does not return.
1624 An error symbol is a symbol with an `error-conditions' property
1625 that is a list of condition names.
1626 A handler for any of those names will get to handle this signal.
1627 The symbol `error' should normally be one of them.
1629 DATA should be a list. Its elements are printed as part of the error message.
1630 See Info anchor `(elisp)Definition of signal' for some details on how this
1631 error message is constructed.
1632 If the signal is handled, DATA is made available to the handler.
1633 See also the function `condition-case'. */)
1634 (error_symbol
, data
)
1635 Lisp_Object error_symbol
, data
;
1637 /* When memory is full, ERROR-SYMBOL is nil,
1638 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1639 That is a special case--don't do this in other situations. */
1640 register struct handler
*allhandlers
= handlerlist
;
1641 Lisp_Object conditions
;
1642 extern int gc_in_progress
;
1643 extern int waiting_for_input
;
1645 Lisp_Object real_error_symbol
;
1646 struct backtrace
*bp
;
1648 immediate_quit
= handling_signal
= 0;
1650 if (gc_in_progress
|| waiting_for_input
)
1653 if (NILP (error_symbol
))
1654 real_error_symbol
= Fcar (data
);
1656 real_error_symbol
= error_symbol
;
1658 #if 0 /* rms: I don't know why this was here,
1659 but it is surely wrong for an error that is handled. */
1660 #ifdef HAVE_WINDOW_SYSTEM
1661 if (display_hourglass_p
)
1662 cancel_hourglass ();
1666 /* This hook is used by edebug. */
1667 if (! NILP (Vsignal_hook_function
)
1668 && ! NILP (error_symbol
))
1670 /* Edebug takes care of restoring these variables when it exits. */
1671 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1672 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1674 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1675 max_specpdl_size
= SPECPDL_INDEX () + 40;
1677 call2 (Vsignal_hook_function
, error_symbol
, data
);
1680 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1682 /* Remember from where signal was called. Skip over the frame for
1683 `signal' itself. If a frame for `error' follows, skip that,
1684 too. Don't do this when ERROR_SYMBOL is nil, because that
1685 is a memory-full error. */
1686 Vsignaling_function
= Qnil
;
1687 if (backtrace_list
&& !NILP (error_symbol
))
1689 bp
= backtrace_list
->next
;
1690 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1692 if (bp
&& bp
->function
)
1693 Vsignaling_function
= *bp
->function
;
1696 for (; handlerlist
; handlerlist
= handlerlist
->next
)
1698 register Lisp_Object clause
;
1700 clause
= find_handler_clause (handlerlist
->handler
, conditions
,
1701 error_symbol
, data
);
1703 if (EQ (clause
, Qlambda
))
1705 /* We can't return values to code which signaled an error, but we
1706 can continue code which has signaled a quit. */
1707 if (EQ (real_error_symbol
, Qquit
))
1710 error ("Cannot return from the debugger in an error");
1715 Lisp_Object unwind_data
;
1716 struct handler
*h
= handlerlist
;
1718 handlerlist
= allhandlers
;
1720 if (NILP (error_symbol
))
1723 unwind_data
= Fcons (error_symbol
, data
);
1724 h
->chosen_clause
= clause
;
1725 unwind_to_catch (h
->tag
, unwind_data
);
1729 handlerlist
= allhandlers
;
1730 /* If no handler is present now, try to run the debugger,
1731 and if that fails, throw to top level. */
1732 find_handler_clause (Qerror
, conditions
, error_symbol
, data
);
1734 Fthrow (Qtop_level
, Qt
);
1736 if (! NILP (error_symbol
))
1737 data
= Fcons (error_symbol
, data
);
1739 string
= Ferror_message_string (data
);
1740 fatal ("%s", SDATA (string
), 0);
1743 /* Internal version of Fsignal that never returns.
1744 Used for anything but Qquit (which can return from Fsignal). */
1747 xsignal (error_symbol
, data
)
1748 Lisp_Object error_symbol
, data
;
1750 Fsignal (error_symbol
, data
);
1754 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1757 xsignal0 (error_symbol
)
1758 Lisp_Object error_symbol
;
1760 xsignal (error_symbol
, Qnil
);
1764 xsignal1 (error_symbol
, arg
)
1765 Lisp_Object error_symbol
, arg
;
1767 xsignal (error_symbol
, list1 (arg
));
1771 xsignal2 (error_symbol
, arg1
, arg2
)
1772 Lisp_Object error_symbol
, arg1
, arg2
;
1774 xsignal (error_symbol
, list2 (arg1
, arg2
));
1778 xsignal3 (error_symbol
, arg1
, arg2
, arg3
)
1779 Lisp_Object error_symbol
, arg1
, arg2
, arg3
;
1781 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1784 /* Signal `error' with message S, and additional arg ARG.
1785 If ARG is not a genuine list, make it a one-element list. */
1788 signal_error (s
, arg
)
1792 Lisp_Object tortoise
, hare
;
1794 hare
= tortoise
= arg
;
1795 while (CONSP (hare
))
1802 tortoise
= XCDR (tortoise
);
1804 if (EQ (hare
, tortoise
))
1809 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1811 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1815 /* Return nonzero if LIST is a non-nil atom or
1816 a list containing one of CONDITIONS. */
1819 wants_debugger (list
, conditions
)
1820 Lisp_Object list
, conditions
;
1827 while (CONSP (conditions
))
1829 Lisp_Object
this, tail
;
1830 this = XCAR (conditions
);
1831 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1832 if (EQ (XCAR (tail
), this))
1834 conditions
= XCDR (conditions
);
1839 /* Return 1 if an error with condition-symbols CONDITIONS,
1840 and described by SIGNAL-DATA, should skip the debugger
1841 according to debugger-ignored-errors. */
1844 skip_debugger (conditions
, data
)
1845 Lisp_Object conditions
, data
;
1848 int first_string
= 1;
1849 Lisp_Object error_message
;
1851 error_message
= Qnil
;
1852 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1854 if (STRINGP (XCAR (tail
)))
1858 error_message
= Ferror_message_string (data
);
1862 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1867 Lisp_Object contail
;
1869 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1870 if (EQ (XCAR (tail
), XCAR (contail
)))
1878 /* Value of Qlambda means we have called debugger and user has continued.
1879 There are two ways to pass SIG and DATA:
1880 = SIG is the error symbol, and DATA is the rest of the data.
1881 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1882 This is for memory-full errors only.
1884 We need to increase max_specpdl_size temporarily around
1885 anything we do that can push on the specpdl, so as not to get
1886 a second error here in case we're handling specpdl overflow. */
1889 find_handler_clause (handlers
, conditions
, sig
, data
)
1890 Lisp_Object handlers
, conditions
, sig
, data
;
1892 register Lisp_Object h
;
1893 register Lisp_Object tem
;
1894 int debugger_called
= 0;
1895 int debugger_considered
= 0;
1897 /* t is used by handlers for all conditions, set up by C code. */
1898 if (EQ (handlers
, Qt
))
1901 /* Don't run the debugger for a memory-full error.
1902 (There is no room in memory to do that!) */
1904 debugger_considered
= 1;
1906 /* error is used similarly, but means print an error message
1907 and run the debugger if that is enabled. */
1908 if (EQ (handlers
, Qerror
)
1909 || !NILP (Vdebug_on_signal
)) /* This says call debugger even if
1910 there is a handler. */
1912 if (!NILP (sig
) && wants_debugger (Vstack_trace_on_error
, conditions
))
1916 internal_with_output_to_temp_buffer ("*Backtrace*",
1917 (Lisp_Object (*) (Lisp_Object
)) Fbacktrace
,
1920 internal_with_output_to_temp_buffer ("*Backtrace*",
1926 if (!debugger_considered
)
1928 debugger_considered
= 1;
1929 debugger_called
= maybe_call_debugger (conditions
, sig
, data
);
1932 /* If there is no handler, return saying whether we ran the debugger. */
1933 if (EQ (handlers
, Qerror
))
1935 if (debugger_called
)
1941 for (h
= handlers
; CONSP (h
); h
= Fcdr (h
))
1943 Lisp_Object handler
, condit
;
1946 if (!CONSP (handler
))
1948 condit
= Fcar (handler
);
1949 /* Handle a single condition name in handler HANDLER. */
1950 if (SYMBOLP (condit
))
1952 tem
= Fmemq (Fcar (handler
), conditions
);
1956 /* Handle a list of condition names in handler HANDLER. */
1957 else if (CONSP (condit
))
1960 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1962 tem
= Fmemq (Fcar (tail
), conditions
);
1965 /* This handler is going to apply.
1966 Does it allow the debugger to run first? */
1967 if (! debugger_considered
&& !NILP (Fmemq (Qdebug
, condit
)))
1968 maybe_call_debugger (conditions
, sig
, data
);
1978 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1979 SIG and DATA describe the signal, as in find_handler_clause. */
1982 maybe_call_debugger (conditions
, sig
, data
)
1983 Lisp_Object conditions
, sig
, data
;
1985 Lisp_Object combined_data
;
1987 combined_data
= Fcons (sig
, data
);
1990 /* Don't try to run the debugger with interrupts blocked.
1991 The editing loop would return anyway. */
1993 /* Does user wants to enter debugger for this kind of error? */
1996 : wants_debugger (Vdebug_on_error
, conditions
))
1997 && ! skip_debugger (conditions
, combined_data
)
1998 /* rms: what's this for? */
1999 && when_entered_debugger
< num_nonmacro_input_events
)
2001 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
2008 /* dump an error message; called like printf */
2012 error (m
, a1
, a2
, a3
)
2032 int used
= doprnt (buffer
, size
, m
, m
+ mlen
, 3, args
);
2037 buffer
= (char *) xrealloc (buffer
, size
);
2040 buffer
= (char *) xmalloc (size
);
2045 string
= build_string (buffer
);
2049 xsignal1 (Qerror
, string
);
2052 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2053 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2054 This means it contains a description for how to read arguments to give it.
2055 The value is nil for an invalid function or a symbol with no function
2058 Interactively callable functions include strings and vectors (treated
2059 as keyboard macros), lambda-expressions that contain a top-level call
2060 to `interactive', autoload definitions made by `autoload' with non-nil
2061 fourth argument, and some of the built-in functions of Lisp.
2063 Also, a symbol satisfies `commandp' if its function definition does so.
2065 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2066 then strings and vectors are not accepted. */)
2067 (function
, for_call_interactively
)
2068 Lisp_Object function
, for_call_interactively
;
2070 register Lisp_Object fun
;
2071 register Lisp_Object funcar
;
2072 Lisp_Object if_prop
= Qnil
;
2076 fun
= indirect_function (fun
); /* Check cycles. */
2077 if (NILP (fun
) || EQ (fun
, Qunbound
))
2080 /* Check an `interactive-form' property if present, analogous to the
2081 function-documentation property. */
2083 while (SYMBOLP (fun
))
2085 Lisp_Object tmp
= Fget (fun
, intern ("interactive-form"));
2088 fun
= Fsymbol_function (fun
);
2091 /* Emacs primitives are interactive if their DEFUN specifies an
2092 interactive spec. */
2094 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
2096 /* Bytecode objects are interactive if they are long enough to
2097 have an element whose index is COMPILED_INTERACTIVE, which is
2098 where the interactive spec is stored. */
2099 else if (COMPILEDP (fun
))
2100 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2103 /* Strings and vectors are keyboard macros. */
2104 if (STRINGP (fun
) || VECTORP (fun
))
2105 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
2107 /* Lists may represent commands. */
2110 funcar
= XCAR (fun
);
2111 if (EQ (funcar
, Qlambda
))
2112 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2113 if (EQ (funcar
, Qautoload
))
2114 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2120 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2121 doc
: /* Define FUNCTION to autoload from FILE.
2122 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2123 Third arg DOCSTRING is documentation for the function.
2124 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2125 Fifth arg TYPE indicates the type of the object:
2126 nil or omitted says FUNCTION is a function,
2127 `keymap' says FUNCTION is really a keymap, and
2128 `macro' or t says FUNCTION is really a macro.
2129 Third through fifth args give info about the real definition.
2130 They default to nil.
2131 If FUNCTION is already defined other than as an autoload,
2132 this does nothing and returns nil. */)
2133 (function
, file
, docstring
, interactive
, type
)
2134 Lisp_Object function
, file
, docstring
, interactive
, type
;
2137 Lisp_Object args
[4];
2140 CHECK_SYMBOL (function
);
2141 CHECK_STRING (file
);
2143 /* If function is defined and not as an autoload, don't override */
2144 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2145 && !(CONSP (XSYMBOL (function
)->function
)
2146 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2149 if (NILP (Vpurify_flag
))
2150 /* Only add entries after dumping, because the ones before are
2151 not useful and else we get loads of them from the loaddefs.el. */
2152 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2156 args
[1] = docstring
;
2157 args
[2] = interactive
;
2160 return Ffset (function
, Fcons (Qautoload
, Flist (4, &args
[0])));
2161 #else /* NO_ARG_ARRAY */
2162 return Ffset (function
, Fcons (Qautoload
, Flist (4, &file
)));
2163 #endif /* not NO_ARG_ARRAY */
2167 un_autoload (oldqueue
)
2168 Lisp_Object oldqueue
;
2170 register Lisp_Object queue
, first
, second
;
2172 /* Queue to unwind is current value of Vautoload_queue.
2173 oldqueue is the shadowed value to leave in Vautoload_queue. */
2174 queue
= Vautoload_queue
;
2175 Vautoload_queue
= oldqueue
;
2176 while (CONSP (queue
))
2178 first
= XCAR (queue
);
2179 second
= Fcdr (first
);
2180 first
= Fcar (first
);
2181 if (EQ (first
, make_number (0)))
2184 Ffset (first
, second
);
2185 queue
= XCDR (queue
);
2190 /* Load an autoloaded function.
2191 FUNNAME is the symbol which is the function's name.
2192 FUNDEF is the autoload definition (a list). */
2195 do_autoload (fundef
, funname
)
2196 Lisp_Object fundef
, funname
;
2198 int count
= SPECPDL_INDEX ();
2200 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2202 /* This is to make sure that loadup.el gives a clear picture
2203 of what files are preloaded and when. */
2204 if (! NILP (Vpurify_flag
))
2205 error ("Attempt to autoload %s while preparing to dump",
2206 SDATA (SYMBOL_NAME (funname
)));
2209 CHECK_SYMBOL (funname
);
2210 GCPRO3 (fun
, funname
, fundef
);
2212 /* Preserve the match data. */
2213 record_unwind_save_match_data ();
2215 /* If autoloading gets an error (which includes the error of failing
2216 to define the function being called), we use Vautoload_queue
2217 to undo function definitions and `provide' calls made by
2218 the function. We do this in the specific case of autoloading
2219 because autoloading is not an explicit request "load this file",
2220 but rather a request to "call this function".
2222 The value saved here is to be restored into Vautoload_queue. */
2223 record_unwind_protect (un_autoload
, Vautoload_queue
);
2224 Vautoload_queue
= Qt
;
2225 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
2227 /* Once loading finishes, don't undo it. */
2228 Vautoload_queue
= Qt
;
2229 unbind_to (count
, Qnil
);
2231 fun
= Findirect_function (fun
, Qnil
);
2233 if (!NILP (Fequal (fun
, fundef
)))
2234 error ("Autoloading failed to define function %s",
2235 SDATA (SYMBOL_NAME (funname
)));
2240 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2241 doc
: /* Evaluate FORM and return its value. */)
2245 Lisp_Object fun
, val
, original_fun
, original_args
;
2247 struct backtrace backtrace
;
2248 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2250 if (handling_signal
)
2254 return Fsymbol_value (form
);
2259 if ((consing_since_gc
> gc_cons_threshold
2260 && consing_since_gc
> gc_relative_threshold
)
2262 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2265 Fgarbage_collect ();
2269 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2271 if (max_lisp_eval_depth
< 100)
2272 max_lisp_eval_depth
= 100;
2273 if (lisp_eval_depth
> max_lisp_eval_depth
)
2274 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2277 original_fun
= Fcar (form
);
2278 original_args
= Fcdr (form
);
2280 backtrace
.next
= backtrace_list
;
2281 backtrace_list
= &backtrace
;
2282 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2283 backtrace
.args
= &original_args
;
2284 backtrace
.nargs
= UNEVALLED
;
2285 backtrace
.evalargs
= 1;
2286 backtrace
.debug_on_exit
= 0;
2288 if (debug_on_next_call
)
2289 do_debug_on_call (Qt
);
2291 /* At this point, only original_fun and original_args
2292 have values that will be used below */
2295 /* Optimize for no indirection. */
2297 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2298 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2299 fun
= indirect_function (fun
);
2303 Lisp_Object numargs
;
2304 Lisp_Object argvals
[8];
2305 Lisp_Object args_left
;
2306 register int i
, maxargs
;
2308 args_left
= original_args
;
2309 numargs
= Flength (args_left
);
2313 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2314 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2315 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2317 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2319 backtrace
.evalargs
= 0;
2320 val
= (*XSUBR (fun
)->function
) (args_left
);
2324 if (XSUBR (fun
)->max_args
== MANY
)
2326 /* Pass a vector of evaluated arguments */
2328 register int argnum
= 0;
2330 vals
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
2332 GCPRO3 (args_left
, fun
, fun
);
2336 while (!NILP (args_left
))
2338 vals
[argnum
++] = Feval (Fcar (args_left
));
2339 args_left
= Fcdr (args_left
);
2340 gcpro3
.nvars
= argnum
;
2343 backtrace
.args
= vals
;
2344 backtrace
.nargs
= XINT (numargs
);
2346 val
= (*XSUBR (fun
)->function
) (XINT (numargs
), vals
);
2351 GCPRO3 (args_left
, fun
, fun
);
2352 gcpro3
.var
= argvals
;
2355 maxargs
= XSUBR (fun
)->max_args
;
2356 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2358 argvals
[i
] = Feval (Fcar (args_left
));
2364 backtrace
.args
= argvals
;
2365 backtrace
.nargs
= XINT (numargs
);
2370 val
= (*XSUBR (fun
)->function
) ();
2373 val
= (*XSUBR (fun
)->function
) (argvals
[0]);
2376 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1]);
2379 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2383 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2384 argvals
[2], argvals
[3]);
2387 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2388 argvals
[3], argvals
[4]);
2391 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2392 argvals
[3], argvals
[4], argvals
[5]);
2395 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2396 argvals
[3], argvals
[4], argvals
[5],
2401 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2402 argvals
[3], argvals
[4], argvals
[5],
2403 argvals
[6], argvals
[7]);
2407 /* Someone has created a subr that takes more arguments than
2408 is supported by this code. We need to either rewrite the
2409 subr to use a different argument protocol, or add more
2410 cases to this switch. */
2414 if (COMPILEDP (fun
))
2415 val
= apply_lambda (fun
, original_args
, 1);
2418 if (EQ (fun
, Qunbound
))
2419 xsignal1 (Qvoid_function
, original_fun
);
2421 xsignal1 (Qinvalid_function
, original_fun
);
2422 funcar
= XCAR (fun
);
2423 if (!SYMBOLP (funcar
))
2424 xsignal1 (Qinvalid_function
, original_fun
);
2425 if (EQ (funcar
, Qautoload
))
2427 do_autoload (fun
, original_fun
);
2430 if (EQ (funcar
, Qmacro
))
2431 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2432 else if (EQ (funcar
, Qlambda
))
2433 val
= apply_lambda (fun
, original_args
, 1);
2435 xsignal1 (Qinvalid_function
, original_fun
);
2441 if (backtrace
.debug_on_exit
)
2442 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2443 backtrace_list
= backtrace
.next
;
2448 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2449 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2450 Then return the value FUNCTION returns.
2451 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2452 usage: (apply FUNCTION &rest ARGUMENTS) */)
2457 register int i
, numargs
;
2458 register Lisp_Object spread_arg
;
2459 register Lisp_Object
*funcall_args
;
2461 struct gcpro gcpro1
;
2465 spread_arg
= args
[nargs
- 1];
2466 CHECK_LIST (spread_arg
);
2468 numargs
= XINT (Flength (spread_arg
));
2471 return Ffuncall (nargs
- 1, args
);
2472 else if (numargs
== 1)
2474 args
[nargs
- 1] = XCAR (spread_arg
);
2475 return Ffuncall (nargs
, args
);
2478 numargs
+= nargs
- 2;
2480 /* Optimize for no indirection. */
2481 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2482 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2483 fun
= indirect_function (fun
);
2484 if (EQ (fun
, Qunbound
))
2486 /* Let funcall get the error */
2493 if (numargs
< XSUBR (fun
)->min_args
2494 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2495 goto funcall
; /* Let funcall get the error */
2496 else if (XSUBR (fun
)->max_args
> numargs
)
2498 /* Avoid making funcall cons up a yet another new vector of arguments
2499 by explicitly supplying nil's for optional values */
2500 funcall_args
= (Lisp_Object
*) alloca ((1 + XSUBR (fun
)->max_args
)
2501 * sizeof (Lisp_Object
));
2502 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2503 funcall_args
[++i
] = Qnil
;
2504 GCPRO1 (*funcall_args
);
2505 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2509 /* We add 1 to numargs because funcall_args includes the
2510 function itself as well as its arguments. */
2513 funcall_args
= (Lisp_Object
*) alloca ((1 + numargs
)
2514 * sizeof (Lisp_Object
));
2515 GCPRO1 (*funcall_args
);
2516 gcpro1
.nvars
= 1 + numargs
;
2519 bcopy (args
, funcall_args
, nargs
* sizeof (Lisp_Object
));
2520 /* Spread the last arg we got. Its first element goes in
2521 the slot that it used to occupy, hence this value of I. */
2523 while (!NILP (spread_arg
))
2525 funcall_args
[i
++] = XCAR (spread_arg
);
2526 spread_arg
= XCDR (spread_arg
);
2529 /* By convention, the caller needs to gcpro Ffuncall's args. */
2530 RETURN_UNGCPRO (Ffuncall (gcpro1
.nvars
, funcall_args
));
2533 /* Run hook variables in various ways. */
2535 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2536 static Lisp_Object run_hook_with_args
P_ ((int, Lisp_Object
*,
2537 enum run_hooks_condition
));
2539 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2540 doc
: /* Run each hook in HOOKS.
2541 Each argument should be a symbol, a hook variable.
2542 These symbols are processed in the order specified.
2543 If a hook symbol has a non-nil value, that value may be a function
2544 or a list of functions to be called to run the hook.
2545 If the value is a function, it is called with no arguments.
2546 If it is a list, the elements are called, in order, with no arguments.
2548 Major modes should not use this function directly to run their mode
2549 hook; they should use `run-mode-hooks' instead.
2551 Do not use `make-local-variable' to make a hook variable buffer-local.
2552 Instead, use `add-hook' and specify t for the LOCAL argument.
2553 usage: (run-hooks &rest HOOKS) */)
2558 Lisp_Object hook
[1];
2561 for (i
= 0; i
< nargs
; i
++)
2564 run_hook_with_args (1, hook
, to_completion
);
2570 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2571 Srun_hook_with_args
, 1, MANY
, 0,
2572 doc
: /* Run HOOK with the specified arguments ARGS.
2573 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2574 value, that value may be a function or a list of functions to be
2575 called to run the hook. If the value is a function, it is called with
2576 the given arguments and its return value is returned. If it is a list
2577 of functions, those functions are called, in order,
2578 with the given arguments ARGS.
2579 It is best not to depend on the value returned by `run-hook-with-args',
2582 Do not use `make-local-variable' to make a hook variable buffer-local.
2583 Instead, use `add-hook' and specify t for the LOCAL argument.
2584 usage: (run-hook-with-args HOOK &rest ARGS) */)
2589 return run_hook_with_args (nargs
, args
, to_completion
);
2592 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2593 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2594 doc
: /* Run HOOK with the specified arguments ARGS.
2595 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2596 value, that value may be a function or a list of functions to be
2597 called to run the hook. If the value is a function, it is called with
2598 the given arguments and its return value is returned.
2599 If it is a list of functions, those functions are called, in order,
2600 with the given arguments ARGS, until one of them
2601 returns a non-nil value. Then we return that value.
2602 However, if they all return nil, we return nil.
2604 Do not use `make-local-variable' to make a hook variable buffer-local.
2605 Instead, use `add-hook' and specify t for the LOCAL argument.
2606 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2611 return run_hook_with_args (nargs
, args
, until_success
);
2614 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2615 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2616 doc
: /* Run HOOK with the specified arguments ARGS.
2617 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2618 value, that value may be a function or a list of functions to be
2619 called to run the hook. If the value is a function, it is called with
2620 the given arguments and its return value is returned.
2621 If it is a list of functions, those functions are called, in order,
2622 with the given arguments ARGS, until one of them returns nil.
2623 Then we return nil. However, if they all return non-nil, we return non-nil.
2625 Do not use `make-local-variable' to make a hook variable buffer-local.
2626 Instead, use `add-hook' and specify t for the LOCAL argument.
2627 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2632 return run_hook_with_args (nargs
, args
, until_failure
);
2635 /* ARGS[0] should be a hook symbol.
2636 Call each of the functions in the hook value, passing each of them
2637 as arguments all the rest of ARGS (all NARGS - 1 elements).
2638 COND specifies a condition to test after each call
2639 to decide whether to stop.
2640 The caller (or its caller, etc) must gcpro all of ARGS,
2641 except that it isn't necessary to gcpro ARGS[0]. */
2644 run_hook_with_args (nargs
, args
, cond
)
2647 enum run_hooks_condition cond
;
2649 Lisp_Object sym
, val
, ret
;
2650 Lisp_Object globals
;
2651 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2653 /* If we are dying or still initializing,
2654 don't do anything--it would probably crash if we tried. */
2655 if (NILP (Vrun_hooks
))
2659 val
= find_symbol_value (sym
);
2660 ret
= (cond
== until_failure
? Qt
: Qnil
);
2662 if (EQ (val
, Qunbound
) || NILP (val
))
2664 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2667 return Ffuncall (nargs
, args
);
2672 GCPRO3 (sym
, val
, globals
);
2675 CONSP (val
) && ((cond
== to_completion
)
2676 || (cond
== until_success
? NILP (ret
)
2680 if (EQ (XCAR (val
), Qt
))
2682 /* t indicates this hook has a local binding;
2683 it means to run the global binding too. */
2685 for (globals
= Fdefault_value (sym
);
2686 CONSP (globals
) && ((cond
== to_completion
)
2687 || (cond
== until_success
? NILP (ret
)
2689 globals
= XCDR (globals
))
2691 args
[0] = XCAR (globals
);
2692 /* In a global value, t should not occur. If it does, we
2693 must ignore it to avoid an endless loop. */
2694 if (!EQ (args
[0], Qt
))
2695 ret
= Ffuncall (nargs
, args
);
2700 args
[0] = XCAR (val
);
2701 ret
= Ffuncall (nargs
, args
);
2710 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2711 present value of that symbol.
2712 Call each element of FUNLIST,
2713 passing each of them the rest of ARGS.
2714 The caller (or its caller, etc) must gcpro all of ARGS,
2715 except that it isn't necessary to gcpro ARGS[0]. */
2718 run_hook_list_with_args (funlist
, nargs
, args
)
2719 Lisp_Object funlist
;
2725 Lisp_Object globals
;
2726 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2730 GCPRO3 (sym
, val
, globals
);
2732 for (val
= funlist
; CONSP (val
); val
= XCDR (val
))
2734 if (EQ (XCAR (val
), Qt
))
2736 /* t indicates this hook has a local binding;
2737 it means to run the global binding too. */
2739 for (globals
= Fdefault_value (sym
);
2741 globals
= XCDR (globals
))
2743 args
[0] = XCAR (globals
);
2744 /* In a global value, t should not occur. If it does, we
2745 must ignore it to avoid an endless loop. */
2746 if (!EQ (args
[0], Qt
))
2747 Ffuncall (nargs
, args
);
2752 args
[0] = XCAR (val
);
2753 Ffuncall (nargs
, args
);
2760 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2763 run_hook_with_args_2 (hook
, arg1
, arg2
)
2764 Lisp_Object hook
, arg1
, arg2
;
2766 Lisp_Object temp
[3];
2771 Frun_hook_with_args (3, temp
);
2774 /* Apply fn to arg */
2777 Lisp_Object fn
, arg
;
2779 struct gcpro gcpro1
;
2783 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2787 Lisp_Object args
[2];
2791 RETURN_UNGCPRO (Fapply (2, args
));
2793 #else /* not NO_ARG_ARRAY */
2794 RETURN_UNGCPRO (Fapply (2, &fn
));
2795 #endif /* not NO_ARG_ARRAY */
2798 /* Call function fn on no arguments */
2803 struct gcpro gcpro1
;
2806 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2809 /* Call function fn with 1 argument arg1 */
2813 Lisp_Object fn
, arg1
;
2815 struct gcpro gcpro1
;
2817 Lisp_Object args
[2];
2823 RETURN_UNGCPRO (Ffuncall (2, args
));
2824 #else /* not NO_ARG_ARRAY */
2827 RETURN_UNGCPRO (Ffuncall (2, &fn
));
2828 #endif /* not NO_ARG_ARRAY */
2831 /* Call function fn with 2 arguments arg1, arg2 */
2834 call2 (fn
, arg1
, arg2
)
2835 Lisp_Object fn
, arg1
, arg2
;
2837 struct gcpro gcpro1
;
2839 Lisp_Object args
[3];
2845 RETURN_UNGCPRO (Ffuncall (3, args
));
2846 #else /* not NO_ARG_ARRAY */
2849 RETURN_UNGCPRO (Ffuncall (3, &fn
));
2850 #endif /* not NO_ARG_ARRAY */
2853 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2856 call3 (fn
, arg1
, arg2
, arg3
)
2857 Lisp_Object fn
, arg1
, arg2
, arg3
;
2859 struct gcpro gcpro1
;
2861 Lisp_Object args
[4];
2868 RETURN_UNGCPRO (Ffuncall (4, args
));
2869 #else /* not NO_ARG_ARRAY */
2872 RETURN_UNGCPRO (Ffuncall (4, &fn
));
2873 #endif /* not NO_ARG_ARRAY */
2876 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2879 call4 (fn
, arg1
, arg2
, arg3
, arg4
)
2880 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
;
2882 struct gcpro gcpro1
;
2884 Lisp_Object args
[5];
2892 RETURN_UNGCPRO (Ffuncall (5, args
));
2893 #else /* not NO_ARG_ARRAY */
2896 RETURN_UNGCPRO (Ffuncall (5, &fn
));
2897 #endif /* not NO_ARG_ARRAY */
2900 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2903 call5 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
)
2904 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
;
2906 struct gcpro gcpro1
;
2908 Lisp_Object args
[6];
2917 RETURN_UNGCPRO (Ffuncall (6, args
));
2918 #else /* not NO_ARG_ARRAY */
2921 RETURN_UNGCPRO (Ffuncall (6, &fn
));
2922 #endif /* not NO_ARG_ARRAY */
2925 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2928 call6 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
)
2929 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
;
2931 struct gcpro gcpro1
;
2933 Lisp_Object args
[7];
2943 RETURN_UNGCPRO (Ffuncall (7, args
));
2944 #else /* not NO_ARG_ARRAY */
2947 RETURN_UNGCPRO (Ffuncall (7, &fn
));
2948 #endif /* not NO_ARG_ARRAY */
2951 /* The caller should GCPRO all the elements of ARGS. */
2953 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2954 doc
: /* Call first argument as a function, passing remaining arguments to it.
2955 Return the value that function returns.
2956 Thus, (funcall 'cons 'x 'y) returns (x . y).
2957 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2962 Lisp_Object fun
, original_fun
;
2964 int numargs
= nargs
- 1;
2965 Lisp_Object lisp_numargs
;
2967 struct backtrace backtrace
;
2968 register Lisp_Object
*internal_args
;
2972 if ((consing_since_gc
> gc_cons_threshold
2973 && consing_since_gc
> gc_relative_threshold
)
2975 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2976 Fgarbage_collect ();
2978 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2980 if (max_lisp_eval_depth
< 100)
2981 max_lisp_eval_depth
= 100;
2982 if (lisp_eval_depth
> max_lisp_eval_depth
)
2983 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2986 backtrace
.next
= backtrace_list
;
2987 backtrace_list
= &backtrace
;
2988 backtrace
.function
= &args
[0];
2989 backtrace
.args
= &args
[1];
2990 backtrace
.nargs
= nargs
- 1;
2991 backtrace
.evalargs
= 0;
2992 backtrace
.debug_on_exit
= 0;
2994 if (debug_on_next_call
)
2995 do_debug_on_call (Qlambda
);
2999 original_fun
= args
[0];
3003 /* Optimize for no indirection. */
3005 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
3006 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
3007 fun
= indirect_function (fun
);
3011 if (numargs
< XSUBR (fun
)->min_args
3012 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
3014 XSETFASTINT (lisp_numargs
, numargs
);
3015 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
3018 if (XSUBR (fun
)->max_args
== UNEVALLED
)
3019 xsignal1 (Qinvalid_function
, original_fun
);
3021 if (XSUBR (fun
)->max_args
== MANY
)
3023 val
= (*XSUBR (fun
)->function
) (numargs
, args
+ 1);
3027 if (XSUBR (fun
)->max_args
> numargs
)
3029 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
3030 bcopy (args
+ 1, internal_args
, numargs
* sizeof (Lisp_Object
));
3031 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
3032 internal_args
[i
] = Qnil
;
3035 internal_args
= args
+ 1;
3036 switch (XSUBR (fun
)->max_args
)
3039 val
= (*XSUBR (fun
)->function
) ();
3042 val
= (*XSUBR (fun
)->function
) (internal_args
[0]);
3045 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1]);
3048 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3052 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3053 internal_args
[2], internal_args
[3]);
3056 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3057 internal_args
[2], internal_args
[3],
3061 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3062 internal_args
[2], internal_args
[3],
3063 internal_args
[4], internal_args
[5]);
3066 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3067 internal_args
[2], internal_args
[3],
3068 internal_args
[4], internal_args
[5],
3073 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3074 internal_args
[2], internal_args
[3],
3075 internal_args
[4], internal_args
[5],
3076 internal_args
[6], internal_args
[7]);
3081 /* If a subr takes more than 8 arguments without using MANY
3082 or UNEVALLED, we need to extend this function to support it.
3083 Until this is done, there is no way to call the function. */
3087 if (COMPILEDP (fun
))
3088 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3091 if (EQ (fun
, Qunbound
))
3092 xsignal1 (Qvoid_function
, original_fun
);
3094 xsignal1 (Qinvalid_function
, original_fun
);
3095 funcar
= XCAR (fun
);
3096 if (!SYMBOLP (funcar
))
3097 xsignal1 (Qinvalid_function
, original_fun
);
3098 if (EQ (funcar
, Qlambda
))
3099 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3100 else if (EQ (funcar
, Qautoload
))
3102 do_autoload (fun
, original_fun
);
3107 xsignal1 (Qinvalid_function
, original_fun
);
3112 if (backtrace
.debug_on_exit
)
3113 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3114 backtrace_list
= backtrace
.next
;
3119 apply_lambda (fun
, args
, eval_flag
)
3120 Lisp_Object fun
, args
;
3123 Lisp_Object args_left
;
3124 Lisp_Object numargs
;
3125 register Lisp_Object
*arg_vector
;
3126 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3128 register Lisp_Object tem
;
3130 numargs
= Flength (args
);
3131 arg_vector
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
3134 GCPRO3 (*arg_vector
, args_left
, fun
);
3137 for (i
= 0; i
< XINT (numargs
);)
3139 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3140 if (eval_flag
) tem
= Feval (tem
);
3141 arg_vector
[i
++] = tem
;
3149 backtrace_list
->args
= arg_vector
;
3150 backtrace_list
->nargs
= i
;
3152 backtrace_list
->evalargs
= 0;
3153 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
3155 /* Do the debug-on-exit now, while arg_vector still exists. */
3156 if (backtrace_list
->debug_on_exit
)
3157 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3158 /* Don't do it again when we return to eval. */
3159 backtrace_list
->debug_on_exit
= 0;
3163 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3164 and return the result of evaluation.
3165 FUN must be either a lambda-expression or a compiled-code object. */
3168 funcall_lambda (fun
, nargs
, arg_vector
)
3171 register Lisp_Object
*arg_vector
;
3173 Lisp_Object val
, syms_left
, next
;
3174 int count
= SPECPDL_INDEX ();
3175 int i
, optional
, rest
;
3179 syms_left
= XCDR (fun
);
3180 if (CONSP (syms_left
))
3181 syms_left
= XCAR (syms_left
);
3183 xsignal1 (Qinvalid_function
, fun
);
3185 else if (COMPILEDP (fun
))
3186 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3190 i
= optional
= rest
= 0;
3191 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3195 next
= XCAR (syms_left
);
3196 if (!SYMBOLP (next
))
3197 xsignal1 (Qinvalid_function
, fun
);
3199 if (EQ (next
, Qand_rest
))
3201 else if (EQ (next
, Qand_optional
))
3205 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3209 specbind (next
, arg_vector
[i
++]);
3211 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3213 specbind (next
, Qnil
);
3216 if (!NILP (syms_left
))
3217 xsignal1 (Qinvalid_function
, fun
);
3219 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3222 val
= Fprogn (XCDR (XCDR (fun
)));
3225 /* If we have not actually read the bytecode string
3226 and constants vector yet, fetch them from the file. */
3227 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3228 Ffetch_bytecode (fun
);
3229 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3230 AREF (fun
, COMPILED_CONSTANTS
),
3231 AREF (fun
, COMPILED_STACK_DEPTH
));
3234 return unbind_to (count
, val
);
3237 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3239 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3245 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3247 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3250 tem
= AREF (object
, COMPILED_BYTECODE
);
3251 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3252 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3254 error ("Invalid byte code");
3256 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3257 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3265 register int count
= SPECPDL_INDEX ();
3266 if (specpdl_size
>= max_specpdl_size
)
3268 if (max_specpdl_size
< 400)
3269 max_specpdl_size
= 400;
3270 if (specpdl_size
>= max_specpdl_size
)
3271 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3274 if (specpdl_size
> max_specpdl_size
)
3275 specpdl_size
= max_specpdl_size
;
3276 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3277 specpdl_ptr
= specpdl
+ count
;
3281 specbind (symbol
, value
)
3282 Lisp_Object symbol
, value
;
3284 Lisp_Object valcontents
;
3286 CHECK_SYMBOL (symbol
);
3287 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3290 /* The most common case is that of a non-constant symbol with a
3291 trivial value. Make that as fast as we can. */
3292 valcontents
= SYMBOL_VALUE (symbol
);
3293 if (!MISCP (valcontents
) && !SYMBOL_CONSTANT_P (symbol
))
3295 specpdl_ptr
->symbol
= symbol
;
3296 specpdl_ptr
->old_value
= valcontents
;
3297 specpdl_ptr
->func
= NULL
;
3299 SET_SYMBOL_VALUE (symbol
, value
);
3303 Lisp_Object ovalue
= find_symbol_value (symbol
);
3304 specpdl_ptr
->func
= 0;
3305 specpdl_ptr
->old_value
= ovalue
;
3307 valcontents
= XSYMBOL (symbol
)->value
;
3309 if (BUFFER_LOCAL_VALUEP (valcontents
)
3310 || BUFFER_OBJFWDP (valcontents
))
3312 Lisp_Object where
, current_buffer
;
3314 current_buffer
= Fcurrent_buffer ();
3316 /* For a local variable, record both the symbol and which
3317 buffer's or frame's value we are saving. */
3318 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3319 where
= current_buffer
;
3320 else if (BUFFER_LOCAL_VALUEP (valcontents
)
3321 && XBUFFER_LOCAL_VALUE (valcontents
)->found_for_frame
)
3322 where
= XBUFFER_LOCAL_VALUE (valcontents
)->frame
;
3326 /* We're not using the `unused' slot in the specbinding
3327 structure because this would mean we have to do more
3328 work for simple variables. */
3329 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, current_buffer
));
3331 /* If SYMBOL is a per-buffer variable which doesn't have a
3332 buffer-local value here, make the `let' change the global
3333 value by changing the value of SYMBOL in all buffers not
3334 having their own value. This is consistent with what
3335 happens with other buffer-local variables. */
3337 && BUFFER_OBJFWDP (valcontents
))
3340 Fset_default (symbol
, value
);
3345 specpdl_ptr
->symbol
= symbol
;
3349 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3350 store_symval_forwarding (symbol, ovalue, value, NULL);
3352 but ovalue comes from find_symbol_value which should never return
3353 such an internal value. */
3354 eassert (!(BUFFER_OBJFWDP (ovalue
) || KBOARD_OBJFWDP (ovalue
)));
3355 set_internal (symbol
, value
, 0, 1);
3360 record_unwind_protect (function
, arg
)
3361 Lisp_Object (*function
) P_ ((Lisp_Object
));
3364 eassert (!handling_signal
);
3366 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3368 specpdl_ptr
->func
= function
;
3369 specpdl_ptr
->symbol
= Qnil
;
3370 specpdl_ptr
->old_value
= arg
;
3375 unbind_to (count
, value
)
3379 Lisp_Object quitf
= Vquit_flag
;
3380 struct gcpro gcpro1
, gcpro2
;
3382 GCPRO2 (value
, quitf
);
3385 while (specpdl_ptr
!= specpdl
+ count
)
3387 /* Copy the binding, and decrement specpdl_ptr, before we do
3388 the work to unbind it. We decrement first
3389 so that an error in unbinding won't try to unbind
3390 the same entry again, and we copy the binding first
3391 in case more bindings are made during some of the code we run. */
3393 struct specbinding this_binding
;
3394 this_binding
= *--specpdl_ptr
;
3396 if (this_binding
.func
!= 0)
3397 (*this_binding
.func
) (this_binding
.old_value
);
3398 /* If the symbol is a list, it is really (SYMBOL WHERE
3399 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3400 frame. If WHERE is a buffer or frame, this indicates we
3401 bound a variable that had a buffer-local or frame-local
3402 binding. WHERE nil means that the variable had the default
3403 value when it was bound. CURRENT-BUFFER is the buffer that
3404 was current when the variable was bound. */
3405 else if (CONSP (this_binding
.symbol
))
3407 Lisp_Object symbol
, where
;
3409 symbol
= XCAR (this_binding
.symbol
);
3410 where
= XCAR (XCDR (this_binding
.symbol
));
3413 Fset_default (symbol
, this_binding
.old_value
);
3414 else if (BUFFERP (where
))
3415 set_internal (symbol
, this_binding
.old_value
, XBUFFER (where
), 1);
3417 set_internal (symbol
, this_binding
.old_value
, NULL
, 1);
3421 /* If variable has a trivial value (no forwarding), we can
3422 just set it. No need to check for constant symbols here,
3423 since that was already done by specbind. */
3424 if (!MISCP (SYMBOL_VALUE (this_binding
.symbol
)))
3425 SET_SYMBOL_VALUE (this_binding
.symbol
, this_binding
.old_value
);
3427 set_internal (this_binding
.symbol
, this_binding
.old_value
, 0, 1);
3431 if (NILP (Vquit_flag
) && !NILP (quitf
))
3438 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3439 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3440 The debugger is entered when that frame exits, if the flag is non-nil. */)
3442 Lisp_Object level
, flag
;
3444 register struct backtrace
*backlist
= backtrace_list
;
3447 CHECK_NUMBER (level
);
3449 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3451 backlist
= backlist
->next
;
3455 backlist
->debug_on_exit
= !NILP (flag
);
3460 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3461 doc
: /* Print a trace of Lisp function calls currently active.
3462 Output stream used is value of `standard-output'. */)
3465 register struct backtrace
*backlist
= backtrace_list
;
3469 extern Lisp_Object Vprint_level
;
3470 struct gcpro gcpro1
;
3472 XSETFASTINT (Vprint_level
, 3);
3479 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3480 if (backlist
->nargs
== UNEVALLED
)
3482 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3483 write_string ("\n", -1);
3487 tem
= *backlist
->function
;
3488 Fprin1 (tem
, Qnil
); /* This can QUIT */
3489 write_string ("(", -1);
3490 if (backlist
->nargs
== MANY
)
3492 for (tail
= *backlist
->args
, i
= 0;
3494 tail
= Fcdr (tail
), i
++)
3496 if (i
) write_string (" ", -1);
3497 Fprin1 (Fcar (tail
), Qnil
);
3502 for (i
= 0; i
< backlist
->nargs
; i
++)
3504 if (i
) write_string (" ", -1);
3505 Fprin1 (backlist
->args
[i
], Qnil
);
3508 write_string (")\n", -1);
3510 backlist
= backlist
->next
;
3513 Vprint_level
= Qnil
;
3518 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3519 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3520 If that frame has not evaluated the arguments yet (or is a special form),
3521 the value is (nil FUNCTION ARG-FORMS...).
3522 If that frame has evaluated its arguments and called its function already,
3523 the value is (t FUNCTION ARG-VALUES...).
3524 A &rest arg is represented as the tail of the list ARG-VALUES.
3525 FUNCTION is whatever was supplied as car of evaluated list,
3526 or a lambda expression for macro calls.
3527 If NFRAMES is more than the number of frames, the value is nil. */)
3529 Lisp_Object nframes
;
3531 register struct backtrace
*backlist
= backtrace_list
;
3535 CHECK_NATNUM (nframes
);
3537 /* Find the frame requested. */
3538 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3539 backlist
= backlist
->next
;
3543 if (backlist
->nargs
== UNEVALLED
)
3544 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3547 if (backlist
->nargs
== MANY
)
3548 tem
= *backlist
->args
;
3550 tem
= Flist (backlist
->nargs
, backlist
->args
);
3552 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3560 register struct backtrace
*backlist
;
3563 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3565 mark_object (*backlist
->function
);
3567 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3570 i
= backlist
->nargs
- 1;
3572 mark_object (backlist
->args
[i
]);
3579 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size
,
3580 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3581 If Lisp code tries to increase the total number past this amount,
3582 an error is signaled.
3583 You can safely use a value considerably larger than the default value,
3584 if that proves inconveniently small. However, if you increase it too far,
3585 Emacs could run out of memory trying to make the stack bigger. */);
3587 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth
,
3588 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3590 This limit serves to catch infinite recursions for you before they cause
3591 actual stack overflow in C, which would be fatal for Emacs.
3592 You can safely make it considerably larger than its default value,
3593 if that proves inconveniently small. However, if you increase it too far,
3594 Emacs could overflow the real C stack, and crash. */);
3596 DEFVAR_LISP ("quit-flag", &Vquit_flag
,
3597 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3598 If the value is t, that means do an ordinary quit.
3599 If the value equals `throw-on-input', that means quit by throwing
3600 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3601 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3602 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3605 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit
,
3606 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3607 Note that `quit-flag' will still be set by typing C-g,
3608 so a quit will be signaled as soon as `inhibit-quit' is nil.
3609 To prevent this happening, set `quit-flag' to nil
3610 before making `inhibit-quit' nil. */);
3611 Vinhibit_quit
= Qnil
;
3613 Qinhibit_quit
= intern ("inhibit-quit");
3614 staticpro (&Qinhibit_quit
);
3616 Qautoload
= intern ("autoload");
3617 staticpro (&Qautoload
);
3619 Qdebug_on_error
= intern ("debug-on-error");
3620 staticpro (&Qdebug_on_error
);
3622 Qmacro
= intern ("macro");
3623 staticpro (&Qmacro
);
3625 Qdeclare
= intern ("declare");
3626 staticpro (&Qdeclare
);
3628 /* Note that the process handling also uses Qexit, but we don't want
3629 to staticpro it twice, so we just do it here. */
3630 Qexit
= intern ("exit");
3633 Qinteractive
= intern ("interactive");
3634 staticpro (&Qinteractive
);
3636 Qcommandp
= intern ("commandp");
3637 staticpro (&Qcommandp
);
3639 Qdefun
= intern ("defun");
3640 staticpro (&Qdefun
);
3642 Qand_rest
= intern ("&rest");
3643 staticpro (&Qand_rest
);
3645 Qand_optional
= intern ("&optional");
3646 staticpro (&Qand_optional
);
3648 Qdebug
= intern ("debug");
3649 staticpro (&Qdebug
);
3651 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error
,
3652 doc
: /* *Non-nil means errors display a backtrace buffer.
3653 More precisely, this happens for any error that is handled
3654 by the editor command loop.
3655 If the value is a list, an error only means to display a backtrace
3656 if one of its condition symbols appears in the list. */);
3657 Vstack_trace_on_error
= Qnil
;
3659 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error
,
3660 doc
: /* *Non-nil means enter debugger if an error is signaled.
3661 Does not apply to errors handled by `condition-case' or those
3662 matched by `debug-ignored-errors'.
3663 If the value is a list, an error only means to enter the debugger
3664 if one of its condition symbols appears in the list.
3665 When you evaluate an expression interactively, this variable
3666 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3667 See also variable `debug-on-quit'. */);
3668 Vdebug_on_error
= Qnil
;
3670 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors
,
3671 doc
: /* *List of errors for which the debugger should not be called.
3672 Each element may be a condition-name or a regexp that matches error messages.
3673 If any element applies to a given error, that error skips the debugger
3674 and just returns to top level.
3675 This overrides the variable `debug-on-error'.
3676 It does not apply to errors handled by `condition-case'. */);
3677 Vdebug_ignored_errors
= Qnil
;
3679 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit
,
3680 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3681 Does not apply if quit is handled by a `condition-case'. */);
3684 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call
,
3685 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3687 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue
,
3688 doc
: /* Non-nil means debugger may continue execution.
3689 This is nil when the debugger is called under circumstances where it
3690 might not be safe to continue. */);
3691 debugger_may_continue
= 1;
3693 DEFVAR_LISP ("debugger", &Vdebugger
,
3694 doc
: /* Function to call to invoke debugger.
3695 If due to frame exit, args are `exit' and the value being returned;
3696 this function's value will be returned instead of that.
3697 If due to error, args are `error' and a list of the args to `signal'.
3698 If due to `apply' or `funcall' entry, one arg, `lambda'.
3699 If due to `eval' entry, one arg, t. */);
3702 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function
,
3703 doc
: /* If non-nil, this is a function for `signal' to call.
3704 It receives the same arguments that `signal' was given.
3705 The Edebug package uses this to regain control. */);
3706 Vsignal_hook_function
= Qnil
;
3708 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal
,
3709 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3710 Note that `debug-on-error', `debug-on-quit' and friends
3711 still determine whether to handle the particular condition. */);
3712 Vdebug_on_signal
= Qnil
;
3714 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function
,
3715 doc
: /* Function to process declarations in a macro definition.
3716 The function will be called with two args MACRO and DECL.
3717 MACRO is the name of the macro being defined.
3718 DECL is a list `(declare ...)' containing the declarations.
3719 The value the function returns is not used. */);
3720 Vmacro_declaration_function
= Qnil
;
3722 Vrun_hooks
= intern ("run-hooks");
3723 staticpro (&Vrun_hooks
);
3725 staticpro (&Vautoload_queue
);
3726 Vautoload_queue
= Qnil
;
3727 staticpro (&Vsignaling_function
);
3728 Vsignaling_function
= Qnil
;
3739 defsubr (&Sfunction
);
3741 defsubr (&Sdefmacro
);
3743 defsubr (&Sdefvaralias
);
3744 defsubr (&Sdefconst
);
3745 defsubr (&Suser_variable_p
);
3749 defsubr (&Smacroexpand
);
3752 defsubr (&Sunwind_protect
);
3753 defsubr (&Scondition_case
);
3755 defsubr (&Sinteractive_p
);
3756 defsubr (&Scalled_interactively_p
);
3757 defsubr (&Scommandp
);
3758 defsubr (&Sautoload
);
3761 defsubr (&Sfuncall
);
3762 defsubr (&Srun_hooks
);
3763 defsubr (&Srun_hook_with_args
);
3764 defsubr (&Srun_hook_with_args_until_success
);
3765 defsubr (&Srun_hook_with_args_until_failure
);
3766 defsubr (&Sfetch_bytecode
);
3767 defsubr (&Sbacktrace_debug
);
3768 defsubr (&Sbacktrace
);
3769 defsubr (&Sbacktrace_frame
);
3772 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3773 (do not change this comment) */