1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
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/>. */
25 #include "blockinput.h"
28 #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 struct catchtag
*catchlist
;
55 /* Count levels of GCPRO to detect failure to UNGCPRO. */
59 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
60 Lisp_Object Qinhibit_quit
, Vinhibit_quit
, Vquit_flag
;
61 Lisp_Object Qand_rest
, Qand_optional
;
62 Lisp_Object Qdebug_on_error
;
65 extern Lisp_Object Qinteractive_form
;
67 /* This holds either the symbol `run-hooks' or nil.
68 It is nil at an early stage of startup, and when Emacs
71 Lisp_Object Vrun_hooks
;
73 /* Non-nil means record all fset's and provide's, to be undone
74 if the file being autoloaded is not fully loaded.
75 They are recorded by being consed onto the front of Vautoload_queue:
76 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
78 Lisp_Object Vautoload_queue
;
80 /* Current number of specbindings allocated in specpdl. */
84 /* Pointer to beginning of specpdl. */
86 struct specbinding
*specpdl
;
88 /* Pointer to first unused element in specpdl. */
90 struct specbinding
*specpdl_ptr
;
92 /* Maximum size allowed for specpdl allocation */
94 EMACS_INT max_specpdl_size
;
96 /* Depth in Lisp evaluations and function calls. */
100 /* Maximum allowed depth in Lisp evaluations and function calls. */
102 EMACS_INT max_lisp_eval_depth
;
104 /* Nonzero means enter debugger before next function call */
106 int debug_on_next_call
;
108 /* Non-zero means debugger may continue. This is zero when the
109 debugger is called during redisplay, where it might not be safe to
110 continue the interrupted redisplay. */
112 int debugger_may_continue
;
114 /* List of conditions (non-nil atom means all) which cause a backtrace
115 if an error is handled by the command loop's error handler. */
117 Lisp_Object Vstack_trace_on_error
;
119 /* List of conditions (non-nil atom means all) which enter the debugger
120 if an error is handled by the command loop's error handler. */
122 Lisp_Object Vdebug_on_error
;
124 /* List of conditions and regexps specifying error messages which
125 do not enter the debugger even if Vdebug_on_error says they should. */
127 Lisp_Object Vdebug_ignored_errors
;
129 /* Non-nil means call the debugger even if the error will be handled. */
131 Lisp_Object Vdebug_on_signal
;
133 /* Hook for edebug to use. */
135 Lisp_Object Vsignal_hook_function
;
137 /* Nonzero means enter debugger if a quit signal
138 is handled by the command loop's error handler. */
142 /* The value of num_nonmacro_input_events as of the last time we
143 started to enter the debugger. If we decide to enter the debugger
144 again when this is still equal to num_nonmacro_input_events, then we
145 know that the debugger itself has an error, and we should just
146 signal the error instead of entering an infinite loop of debugger
149 int when_entered_debugger
;
151 Lisp_Object Vdebugger
;
153 /* The function from which the last `signal' was called. Set in
156 Lisp_Object Vsignaling_function
;
158 /* Set to non-zero while processing X events. Checked in Feval to
159 make sure the Lisp interpreter isn't called from a signal handler,
160 which is unsafe because the interpreter isn't reentrant. */
164 /* Function to process declarations in defmacro forms. */
166 Lisp_Object Vmacro_declaration_function
;
168 extern Lisp_Object Qrisky_local_variable
;
170 extern Lisp_Object Qfunction
;
172 static Lisp_Object funcall_lambda
P_ ((Lisp_Object
, int, Lisp_Object
*));
173 static void unwind_to_catch
P_ ((struct catchtag
*, Lisp_Object
)) NO_RETURN
;
176 /* "gcc -O3" enables automatic function inlining, which optimizes out
177 the arguments for the invocations of these functions, whereas they
178 expect these values on the stack. */
179 Lisp_Object
apply1 () __attribute__((noinline
));
180 Lisp_Object
call2 () __attribute__((noinline
));
187 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
188 specpdl_ptr
= specpdl
;
189 /* Don't forget to update docs (lispref node "Local Variables"). */
190 max_specpdl_size
= 1000;
191 max_lisp_eval_depth
= 500;
199 specpdl_ptr
= specpdl
;
204 debug_on_next_call
= 0;
209 /* This is less than the initial value of num_nonmacro_input_events. */
210 when_entered_debugger
= -1;
213 /* unwind-protect function used by call_debugger. */
216 restore_stack_limits (data
)
219 max_specpdl_size
= XINT (XCAR (data
));
220 max_lisp_eval_depth
= XINT (XCDR (data
));
224 /* Call the Lisp debugger, giving it argument ARG. */
230 int debug_while_redisplaying
;
231 int count
= SPECPDL_INDEX ();
233 int old_max
= max_specpdl_size
;
235 /* Temporarily bump up the stack limits,
236 so the debugger won't run out of stack. */
238 max_specpdl_size
+= 1;
239 record_unwind_protect (restore_stack_limits
,
240 Fcons (make_number (old_max
),
241 make_number (max_lisp_eval_depth
)));
242 max_specpdl_size
= old_max
;
244 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
245 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
247 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
248 max_specpdl_size
= SPECPDL_INDEX () + 100;
250 #ifdef HAVE_WINDOW_SYSTEM
251 if (display_hourglass_p
)
255 debug_on_next_call
= 0;
256 when_entered_debugger
= num_nonmacro_input_events
;
258 /* Resetting redisplaying_p to 0 makes sure that debug output is
259 displayed if the debugger is invoked during redisplay. */
260 debug_while_redisplaying
= redisplaying_p
;
262 specbind (intern ("debugger-may-continue"),
263 debug_while_redisplaying
? Qnil
: Qt
);
264 specbind (Qinhibit_redisplay
, Qnil
);
265 specbind (Qdebug_on_error
, Qnil
);
267 #if 0 /* Binding this prevents execution of Lisp code during
268 redisplay, which necessarily leads to display problems. */
269 specbind (Qinhibit_eval_during_redisplay
, Qt
);
272 val
= apply1 (Vdebugger
, arg
);
274 /* Interrupting redisplay and resuming it later is not safe under
275 all circumstances. So, when the debugger returns, abort the
276 interrupted redisplay by going back to the top-level. */
277 if (debug_while_redisplaying
)
280 return unbind_to (count
, val
);
284 do_debug_on_call (code
)
287 debug_on_next_call
= 0;
288 backtrace_list
->debug_on_exit
= 1;
289 call_debugger (Fcons (code
, Qnil
));
292 /* NOTE!!! Every function that can call EVAL must protect its args
293 and temporaries from garbage collection while it needs them.
294 The definition of `For' shows what you have to do. */
296 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
297 doc
: /* Eval args until one of them yields non-nil, then return that value.
298 The remaining args are not evalled at all.
299 If all args return nil, return nil.
300 usage: (or CONDITIONS...) */)
304 register Lisp_Object val
= Qnil
;
311 val
= Feval (XCAR (args
));
321 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
322 doc
: /* Eval args until one of them yields nil, then return nil.
323 The remaining args are not evalled at all.
324 If no arg yields nil, return the last arg's value.
325 usage: (and CONDITIONS...) */)
329 register Lisp_Object val
= Qt
;
336 val
= Feval (XCAR (args
));
346 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
347 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
348 Returns the value of THEN or the value of the last of the ELSE's.
349 THEN must be one expression, but ELSE... can be zero or more expressions.
350 If COND yields nil, and there are no ELSE's, the value is nil.
351 usage: (if COND THEN ELSE...) */)
355 register Lisp_Object cond
;
359 cond
= Feval (Fcar (args
));
363 return Feval (Fcar (Fcdr (args
)));
364 return Fprogn (Fcdr (Fcdr (args
)));
367 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
368 doc
: /* Try each clause until one succeeds.
369 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
370 and, if the value is non-nil, this clause succeeds:
371 then the expressions in BODY are evaluated and the last one's
372 value is the value of the cond-form.
373 If no clause succeeds, cond returns nil.
374 If a clause has one element, as in (CONDITION),
375 CONDITION's value if non-nil is returned from the cond-form.
376 usage: (cond CLAUSES...) */)
380 register Lisp_Object clause
, val
;
387 clause
= Fcar (args
);
388 val
= Feval (Fcar (clause
));
391 if (!EQ (XCDR (clause
), Qnil
))
392 val
= Fprogn (XCDR (clause
));
402 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
403 doc
: /* Eval BODY forms sequentially and return value of last one.
404 usage: (progn BODY...) */)
408 register Lisp_Object val
= Qnil
;
415 val
= Feval (XCAR (args
));
423 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
424 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
425 The value of FIRST is saved during the evaluation of the remaining args,
426 whose values are discarded.
427 usage: (prog1 FIRST BODY...) */)
432 register Lisp_Object args_left
;
433 struct gcpro gcpro1
, gcpro2
;
434 register int argnum
= 0;
446 val
= Feval (Fcar (args_left
));
448 Feval (Fcar (args_left
));
449 args_left
= Fcdr (args_left
);
451 while (!NILP(args_left
));
457 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
458 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
459 The value of FORM2 is saved during the evaluation of the
460 remaining args, whose values are discarded.
461 usage: (prog2 FORM1 FORM2 BODY...) */)
466 register Lisp_Object args_left
;
467 struct gcpro gcpro1
, gcpro2
;
468 register int argnum
= -1;
482 val
= Feval (Fcar (args_left
));
484 Feval (Fcar (args_left
));
485 args_left
= Fcdr (args_left
);
487 while (!NILP (args_left
));
493 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
494 doc
: /* Set each SYM to the value of its VAL.
495 The symbols SYM are variables; they are literal (not evaluated).
496 The values VAL are expressions; they are evaluated.
497 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
498 The second VAL is not computed until after the first SYM is set, and so on;
499 each VAL can use the new value of variables set earlier in the `setq'.
500 The return value of the `setq' form is the value of the last VAL.
501 usage: (setq [SYM VAL]...) */)
505 register Lisp_Object args_left
;
506 register Lisp_Object val
, sym
;
517 val
= Feval (Fcar (Fcdr (args_left
)));
518 sym
= Fcar (args_left
);
520 args_left
= Fcdr (Fcdr (args_left
));
522 while (!NILP(args_left
));
528 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
529 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
530 usage: (quote ARG) */)
534 if (!NILP (Fcdr (args
)))
535 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
539 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
540 doc
: /* Like `quote', but preferred for objects which are functions.
541 In byte compilation, `function' causes its argument to be compiled.
542 `quote' cannot do that.
543 usage: (function ARG) */)
547 if (!NILP (Fcdr (args
)))
548 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
553 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
554 doc
: /* Return t if the containing function was run directly by user input.
555 This means that the function was called with `call-interactively'
556 \(which includes being called as the binding of a key)
557 and input is currently coming from the keyboard (not a keyboard macro),
558 and Emacs is not running in batch mode (`noninteractive' is nil).
560 The only known proper use of `interactive-p' is in deciding whether to
561 display a helpful message, or how to display it. If you're thinking
562 of using it for any other purpose, it is quite likely that you're
563 making a mistake. Think: what do you want to do when the command is
564 called from a keyboard macro?
566 To test whether your function was called with `call-interactively',
567 either (i) add an extra optional argument and give it an `interactive'
568 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
569 use `called-interactively-p'. */)
572 return (INTERACTIVE
&& interactive_p (1)) ? Qt
: Qnil
;
576 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
577 doc
: /* Return t if the containing function was called by `call-interactively'.
578 If KIND is `interactive', then only return t if the call was made
579 interactively by the user, i.e. not in `noninteractive' mode nor
580 when `executing-kbd-macro'.
581 If KIND is `any', on the other hand, it will return t for any kind of
582 interactive call, including being called as the binding of a key, or
583 from a keyboard macro, or in `noninteractive' mode.
585 The only known proper use of `interactive' for KIND is in deciding
586 whether to display a helpful message, or how to display it. If you're
587 thinking of using it for any other purpose, it is quite likely that
588 you're making a mistake. Think: what do you want to do when the
589 command is called from a keyboard macro?
591 This function is meant for implementing advice and other
592 function-modifying features. Instead of using this, it is sometimes
593 cleaner to give your function an extra optional argument whose
594 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
595 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
599 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
600 && interactive_p (1)) ? Qt
: Qnil
;
604 /* Return 1 if function in which this appears was called using
607 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
608 called is a built-in. */
611 interactive_p (exclude_subrs_p
)
614 struct backtrace
*btp
;
617 btp
= backtrace_list
;
619 /* If this isn't a byte-compiled function, there may be a frame at
620 the top for Finteractive_p. If so, skip it. */
621 fun
= Findirect_function (*btp
->function
, Qnil
);
622 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
623 || XSUBR (fun
) == &Scalled_interactively_p
))
626 /* If we're running an Emacs 18-style byte-compiled function, there
627 may be a frame for Fbytecode at the top level. In any version of
628 Emacs there can be Fbytecode frames for subexpressions evaluated
629 inside catch and condition-case. Skip past them.
631 If this isn't a byte-compiled function, then we may now be
632 looking at several frames for special forms. Skip past them. */
634 && (EQ (*btp
->function
, Qbytecode
)
635 || btp
->nargs
== UNEVALLED
))
638 /* btp now points at the frame of the innermost function that isn't
639 a special form, ignoring frames for Finteractive_p and/or
640 Fbytecode at the top. If this frame is for a built-in function
641 (such as load or eval-region) return nil. */
642 fun
= Findirect_function (*btp
->function
, Qnil
);
643 if (exclude_subrs_p
&& SUBRP (fun
))
646 /* btp points to the frame of a Lisp function that called interactive-p.
647 Return t if that function was called interactively. */
648 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
654 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
655 doc
: /* Define NAME as a function.
656 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
657 See also the function `interactive'.
658 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
662 register Lisp_Object fn_name
;
663 register Lisp_Object defn
;
665 fn_name
= Fcar (args
);
666 CHECK_SYMBOL (fn_name
);
667 defn
= Fcons (Qlambda
, Fcdr (args
));
668 if (!NILP (Vpurify_flag
))
669 defn
= Fpurecopy (defn
);
670 if (CONSP (XSYMBOL (fn_name
)->function
)
671 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
672 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
673 Ffset (fn_name
, defn
);
674 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
678 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
679 doc
: /* Define NAME as a macro.
680 The actual definition looks like
681 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
682 When the macro is called, as in (NAME ARGS...),
683 the function (lambda ARGLIST BODY...) is applied to
684 the list ARGS... as it appears in the expression,
685 and the result should be a form to be evaluated instead of the original.
687 DECL is a declaration, optional, which can specify how to indent
688 calls to this macro, how Edebug should handle it, and which argument
689 should be treated as documentation. It looks like this:
691 The elements can look like this:
693 Set NAME's `lisp-indent-function' property to INDENT.
696 Set NAME's `edebug-form-spec' property to DEBUG. (This is
697 equivalent to writing a `def-edebug-spec' for the macro.)
700 Set NAME's `doc-string-elt' property to ELT.
702 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
706 register Lisp_Object fn_name
;
707 register Lisp_Object defn
;
708 Lisp_Object lambda_list
, doc
, tail
;
710 fn_name
= Fcar (args
);
711 CHECK_SYMBOL (fn_name
);
712 lambda_list
= Fcar (Fcdr (args
));
713 tail
= Fcdr (Fcdr (args
));
716 if (STRINGP (Fcar (tail
)))
722 while (CONSP (Fcar (tail
))
723 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
725 if (!NILP (Vmacro_declaration_function
))
729 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
737 tail
= Fcons (lambda_list
, tail
);
739 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
740 defn
= Fcons (Qmacro
, Fcons (Qlambda
, tail
));
742 if (!NILP (Vpurify_flag
))
743 defn
= Fpurecopy (defn
);
744 if (CONSP (XSYMBOL (fn_name
)->function
)
745 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
746 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
747 Ffset (fn_name
, defn
);
748 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
753 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
754 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
755 Aliased variables always have the same value; setting one sets the other.
756 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
757 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
758 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
759 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
760 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
761 The return value is BASE-VARIABLE. */)
762 (new_alias
, base_variable
, docstring
)
763 Lisp_Object new_alias
, base_variable
, docstring
;
765 struct Lisp_Symbol
*sym
;
767 CHECK_SYMBOL (new_alias
);
768 CHECK_SYMBOL (base_variable
);
770 if (SYMBOL_CONSTANT_P (new_alias
))
771 error ("Cannot make a constant an alias");
773 sym
= XSYMBOL (new_alias
);
774 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
775 If n_a is bound, but b_v is not, set the value of b_v to n_a.
776 This is for the sake of define-obsolete-variable-alias and user
778 if (NILP (Fboundp (base_variable
)) && !NILP (Fboundp (new_alias
)))
779 XSYMBOL(base_variable
)->value
= sym
->value
;
780 sym
->indirect_variable
= 1;
781 sym
->value
= base_variable
;
782 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
783 LOADHIST_ATTACH (new_alias
);
784 if (!NILP (docstring
))
785 Fput (new_alias
, Qvariable_documentation
, docstring
);
787 Fput (new_alias
, Qvariable_documentation
, Qnil
);
789 return base_variable
;
793 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
794 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
795 You are not required to define a variable in order to use it,
796 but the definition can supply documentation and an initial value
797 in a way that tags can recognize.
799 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
800 If SYMBOL is buffer-local, its default value is what is set;
801 buffer-local values are not affected.
802 INITVALUE and DOCSTRING are optional.
803 If DOCSTRING starts with *, this variable is identified as a user option.
804 This means that M-x set-variable recognizes it.
805 See also `user-variable-p'.
806 If INITVALUE is missing, SYMBOL's value is not set.
808 If SYMBOL has a local binding, then this form affects the local
809 binding. This is usually not what you want. Thus, if you need to
810 load a file defining variables, with this form or with `defconst' or
811 `defcustom', you should always load that file _outside_ any bindings
812 for these variables. \(`defconst' and `defcustom' behave similarly in
814 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
818 register Lisp_Object sym
, tem
, tail
;
822 if (!NILP (Fcdr (Fcdr (tail
))))
823 error ("Too many arguments");
825 tem
= Fdefault_boundp (sym
);
828 if (SYMBOL_CONSTANT_P (sym
))
830 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
831 Lisp_Object tem
= Fcar (tail
);
833 && EQ (XCAR (tem
), Qquote
)
834 && CONSP (XCDR (tem
))
835 && EQ (XCAR (XCDR (tem
)), sym
)))
836 error ("Constant symbol `%s' specified in defvar",
837 SDATA (SYMBOL_NAME (sym
)));
841 Fset_default (sym
, Feval (Fcar (tail
)));
843 { /* Check if there is really a global binding rather than just a let
844 binding that shadows the global unboundness of the var. */
845 volatile struct specbinding
*pdl
= specpdl_ptr
;
846 while (--pdl
>= specpdl
)
848 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
849 && EQ (pdl
->old_value
, Qunbound
))
851 message_with_string ("Warning: defvar ignored because %s is let-bound",
852 SYMBOL_NAME (sym
), 1);
861 if (!NILP (Vpurify_flag
))
862 tem
= Fpurecopy (tem
);
863 Fput (sym
, Qvariable_documentation
, tem
);
865 LOADHIST_ATTACH (sym
);
868 /* Simple (defvar <var>) should not count as a definition at all.
869 It could get in the way of other definitions, and unloading this
870 package could try to make the variable unbound. */
876 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
877 doc
: /* Define SYMBOL as a constant variable.
878 The intent is that neither programs nor users should ever change this value.
879 Always sets the value of SYMBOL to the result of evalling INITVALUE.
880 If SYMBOL is buffer-local, its default value is what is set;
881 buffer-local values are not affected.
882 DOCSTRING is optional.
884 If SYMBOL has a local binding, then this form sets the local binding's
885 value. However, you should normally not make local bindings for
886 variables defined with this form.
887 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
891 register Lisp_Object sym
, tem
;
894 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
895 error ("Too many arguments");
897 tem
= Feval (Fcar (Fcdr (args
)));
898 if (!NILP (Vpurify_flag
))
899 tem
= Fpurecopy (tem
);
900 Fset_default (sym
, tem
);
901 tem
= Fcar (Fcdr (Fcdr (args
)));
904 if (!NILP (Vpurify_flag
))
905 tem
= Fpurecopy (tem
);
906 Fput (sym
, Qvariable_documentation
, tem
);
908 Fput (sym
, Qrisky_local_variable
, Qt
);
909 LOADHIST_ATTACH (sym
);
913 /* Error handler used in Fuser_variable_p. */
915 user_variable_p_eh (ignore
)
922 lisp_indirect_variable (Lisp_Object sym
)
924 XSETSYMBOL (sym
, indirect_variable (XSYMBOL (sym
)));
928 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
929 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
930 \(The alternative is a variable used internally in a Lisp program.)
931 A variable is a user variable if
932 \(1) the first character of its documentation is `*', or
933 \(2) it is customizable (its property list contains a non-nil value
934 of `standard-value' or `custom-autoload'), or
935 \(3) it is an alias for another user variable.
936 Return nil if VARIABLE is an alias and there is a loop in the
937 chain of symbols. */)
939 Lisp_Object variable
;
941 Lisp_Object documentation
;
943 if (!SYMBOLP (variable
))
946 /* If indirect and there's an alias loop, don't check anything else. */
947 if (XSYMBOL (variable
)->indirect_variable
948 && NILP (internal_condition_case_1 (lisp_indirect_variable
, variable
,
949 Qt
, user_variable_p_eh
)))
954 documentation
= Fget (variable
, Qvariable_documentation
);
955 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
957 if (STRINGP (documentation
)
958 && ((unsigned char) SREF (documentation
, 0) == '*'))
960 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
961 if (CONSP (documentation
)
962 && STRINGP (XCAR (documentation
))
963 && INTEGERP (XCDR (documentation
))
964 && XINT (XCDR (documentation
)) < 0)
966 /* Customizable? See `custom-variable-p'. */
967 if ((!NILP (Fget (variable
, intern ("standard-value"))))
968 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
971 if (!XSYMBOL (variable
)->indirect_variable
)
974 /* An indirect variable? Let's follow the chain. */
975 variable
= XSYMBOL (variable
)->value
;
979 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
980 doc
: /* Bind variables according to VARLIST then eval BODY.
981 The value of the last form in BODY is returned.
982 Each element of VARLIST is a symbol (which is bound to nil)
983 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
984 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
985 usage: (let* VARLIST BODY...) */)
989 Lisp_Object varlist
, val
, elt
;
990 int count
= SPECPDL_INDEX ();
991 struct gcpro gcpro1
, gcpro2
, gcpro3
;
993 GCPRO3 (args
, elt
, varlist
);
995 varlist
= Fcar (args
);
996 while (!NILP (varlist
))
999 elt
= Fcar (varlist
);
1001 specbind (elt
, Qnil
);
1002 else if (! NILP (Fcdr (Fcdr (elt
))))
1003 signal_error ("`let' bindings can have only one value-form", elt
);
1006 val
= Feval (Fcar (Fcdr (elt
)));
1007 specbind (Fcar (elt
), val
);
1009 varlist
= Fcdr (varlist
);
1012 val
= Fprogn (Fcdr (args
));
1013 return unbind_to (count
, val
);
1016 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1017 doc
: /* Bind variables according to VARLIST then eval BODY.
1018 The value of the last form in BODY is returned.
1019 Each element of VARLIST is a symbol (which is bound to nil)
1020 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1021 All the VALUEFORMs are evalled before any symbols are bound.
1022 usage: (let VARLIST BODY...) */)
1026 Lisp_Object
*temps
, tem
;
1027 register Lisp_Object elt
, varlist
;
1028 int count
= SPECPDL_INDEX ();
1029 register int argnum
;
1030 struct gcpro gcpro1
, gcpro2
;
1033 varlist
= Fcar (args
);
1035 /* Make space to hold the values to give the bound variables */
1036 elt
= Flength (varlist
);
1037 SAFE_ALLOCA (temps
, Lisp_Object
*, XFASTINT (elt
) * sizeof (Lisp_Object
));
1039 /* Compute the values and store them in `temps' */
1041 GCPRO2 (args
, *temps
);
1044 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1047 elt
= XCAR (varlist
);
1049 temps
[argnum
++] = Qnil
;
1050 else if (! NILP (Fcdr (Fcdr (elt
))))
1051 signal_error ("`let' bindings can have only one value-form", elt
);
1053 temps
[argnum
++] = Feval (Fcar (Fcdr (elt
)));
1054 gcpro2
.nvars
= argnum
;
1058 varlist
= Fcar (args
);
1059 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1061 elt
= XCAR (varlist
);
1062 tem
= temps
[argnum
++];
1064 specbind (elt
, tem
);
1066 specbind (Fcar (elt
), tem
);
1069 elt
= Fprogn (Fcdr (args
));
1071 return unbind_to (count
, elt
);
1074 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1075 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1076 The order of execution is thus TEST, BODY, TEST, BODY and so on
1077 until TEST returns nil.
1078 usage: (while TEST BODY...) */)
1082 Lisp_Object test
, body
;
1083 struct gcpro gcpro1
, gcpro2
;
1085 GCPRO2 (test
, body
);
1089 while (!NILP (Feval (test
)))
1099 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1100 doc
: /* Return result of expanding macros at top level of FORM.
1101 If FORM is not a macro call, it is returned unchanged.
1102 Otherwise, the macro is expanded and the expansion is considered
1103 in place of FORM. When a non-macro-call results, it is returned.
1105 The second optional arg ENVIRONMENT specifies an environment of macro
1106 definitions to shadow the loaded ones for use in file byte-compilation. */)
1109 Lisp_Object environment
;
1111 /* With cleanups from Hallvard Furuseth. */
1112 register Lisp_Object expander
, sym
, def
, tem
;
1116 /* Come back here each time we expand a macro call,
1117 in case it expands into another macro call. */
1120 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1121 def
= sym
= XCAR (form
);
1123 /* Trace symbols aliases to other symbols
1124 until we get a symbol that is not an alias. */
1125 while (SYMBOLP (def
))
1129 tem
= Fassq (sym
, environment
);
1132 def
= XSYMBOL (sym
)->function
;
1133 if (!EQ (def
, Qunbound
))
1138 /* Right now TEM is the result from SYM in ENVIRONMENT,
1139 and if TEM is nil then DEF is SYM's function definition. */
1142 /* SYM is not mentioned in ENVIRONMENT.
1143 Look at its function definition. */
1144 if (EQ (def
, Qunbound
) || !CONSP (def
))
1145 /* Not defined or definition not suitable */
1147 if (EQ (XCAR (def
), Qautoload
))
1149 /* Autoloading function: will it be a macro when loaded? */
1150 tem
= Fnth (make_number (4), def
);
1151 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1152 /* Yes, load it and try again. */
1154 struct gcpro gcpro1
;
1156 do_autoload (def
, sym
);
1163 else if (!EQ (XCAR (def
), Qmacro
))
1165 else expander
= XCDR (def
);
1169 expander
= XCDR (tem
);
1170 if (NILP (expander
))
1173 form
= apply1 (expander
, XCDR (form
));
1178 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1179 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1180 TAG is evalled to get the tag to use; it must not be nil.
1182 Then the BODY is executed.
1183 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1184 If no throw happens, `catch' returns the value of the last BODY form.
1185 If a throw happens, it specifies the value to return from `catch'.
1186 usage: (catch TAG BODY...) */)
1190 register Lisp_Object tag
;
1191 struct gcpro gcpro1
;
1194 tag
= Feval (Fcar (args
));
1196 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1199 /* Set up a catch, then call C function FUNC on argument ARG.
1200 FUNC should return a Lisp_Object.
1201 This is how catches are done from within C code. */
1204 internal_catch (tag
, func
, arg
)
1206 Lisp_Object (*func
) ();
1209 /* This structure is made part of the chain `catchlist'. */
1212 /* Fill in the components of c, and put it on the list. */
1216 c
.backlist
= backtrace_list
;
1217 c
.handlerlist
= handlerlist
;
1218 c
.lisp_eval_depth
= lisp_eval_depth
;
1219 c
.pdlcount
= SPECPDL_INDEX ();
1220 c
.poll_suppress_count
= poll_suppress_count
;
1221 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1222 c
.gcpro
= gcprolist
;
1223 c
.byte_stack
= byte_stack_list
;
1227 if (! _setjmp (c
.jmp
))
1228 c
.val
= (*func
) (arg
);
1230 /* Throw works by a longjmp that comes right here. */
1235 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1236 jump to that CATCH, returning VALUE as the value of that catch.
1238 This is the guts Fthrow and Fsignal; they differ only in the way
1239 they choose the catch tag to throw to. A catch tag for a
1240 condition-case form has a TAG of Qnil.
1242 Before each catch is discarded, unbind all special bindings and
1243 execute all unwind-protect clauses made above that catch. Unwind
1244 the handler stack as we go, so that the proper handlers are in
1245 effect for each unwind-protect clause we run. At the end, restore
1246 some static info saved in CATCH, and longjmp to the location
1249 This is used for correct unwinding in Fthrow and Fsignal. */
1252 unwind_to_catch (catch, value
)
1253 struct catchtag
*catch;
1256 register int last_time
;
1258 /* Save the value in the tag. */
1261 /* Restore certain special C variables. */
1262 set_poll_suppress_count (catch->poll_suppress_count
);
1263 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1264 handling_signal
= 0;
1269 last_time
= catchlist
== catch;
1271 /* Unwind the specpdl stack, and then restore the proper set of
1273 unbind_to (catchlist
->pdlcount
, Qnil
);
1274 handlerlist
= catchlist
->handlerlist
;
1275 catchlist
= catchlist
->next
;
1277 while (! last_time
);
1280 /* If x_catch_errors was done, turn it off now.
1281 (First we give unbind_to a chance to do that.) */
1282 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1283 * The catch must remain in effect during that delicate
1284 * state. --lorentey */
1285 x_fully_uncatch_errors ();
1289 byte_stack_list
= catch->byte_stack
;
1290 gcprolist
= catch->gcpro
;
1293 gcpro_level
= gcprolist
->level
+ 1;
1297 backtrace_list
= catch->backlist
;
1298 lisp_eval_depth
= catch->lisp_eval_depth
;
1300 _longjmp (catch->jmp
, 1);
1303 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1304 doc
: /* Throw to the catch for TAG and return VALUE from it.
1305 Both TAG and VALUE are evalled. */)
1307 register Lisp_Object tag
, value
;
1309 register struct catchtag
*c
;
1312 for (c
= catchlist
; c
; c
= c
->next
)
1314 if (EQ (c
->tag
, tag
))
1315 unwind_to_catch (c
, value
);
1317 xsignal2 (Qno_catch
, tag
, value
);
1321 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1322 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1323 If BODYFORM completes normally, its value is returned
1324 after executing the UNWINDFORMS.
1325 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1326 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1331 int count
= SPECPDL_INDEX ();
1333 record_unwind_protect (Fprogn
, Fcdr (args
));
1334 val
= Feval (Fcar (args
));
1335 return unbind_to (count
, val
);
1338 /* Chain of condition handlers currently in effect.
1339 The elements of this chain are contained in the stack frames
1340 of Fcondition_case and internal_condition_case.
1341 When an error is signaled (by calling Fsignal, below),
1342 this chain is searched for an element that applies. */
1344 struct handler
*handlerlist
;
1346 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1347 doc
: /* Regain control when an error is signaled.
1348 Executes BODYFORM and returns its value if no error happens.
1349 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1350 where the BODY is made of Lisp expressions.
1352 A handler is applicable to an error
1353 if CONDITION-NAME is one of the error's condition names.
1354 If an error happens, the first applicable handler is run.
1356 The car of a handler may be a list of condition names
1357 instead of a single condition name. Then it handles all of them.
1359 When a handler handles an error, control returns to the `condition-case'
1360 and it executes the handler's BODY...
1361 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1362 (If VAR is nil, the handler can't access that information.)
1363 Then the value of the last BODY form is returned from the `condition-case'
1366 See also the function `signal' for more info.
1367 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1371 register Lisp_Object bodyform
, handlers
;
1372 volatile Lisp_Object var
;
1375 bodyform
= Fcar (Fcdr (args
));
1376 handlers
= Fcdr (Fcdr (args
));
1378 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1381 /* Like Fcondition_case, but the args are separate
1382 rather than passed in a list. Used by Fbyte_code. */
1385 internal_lisp_condition_case (var
, bodyform
, handlers
)
1386 volatile Lisp_Object var
;
1387 Lisp_Object bodyform
, handlers
;
1395 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1401 && (SYMBOLP (XCAR (tem
))
1402 || CONSP (XCAR (tem
))))))
1403 error ("Invalid condition handler", tem
);
1408 c
.backlist
= backtrace_list
;
1409 c
.handlerlist
= handlerlist
;
1410 c
.lisp_eval_depth
= lisp_eval_depth
;
1411 c
.pdlcount
= SPECPDL_INDEX ();
1412 c
.poll_suppress_count
= poll_suppress_count
;
1413 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1414 c
.gcpro
= gcprolist
;
1415 c
.byte_stack
= byte_stack_list
;
1416 if (_setjmp (c
.jmp
))
1419 specbind (h
.var
, c
.val
);
1420 val
= Fprogn (Fcdr (h
.chosen_clause
));
1422 /* Note that this just undoes the binding of h.var; whoever
1423 longjumped to us unwound the stack to c.pdlcount before
1425 unbind_to (c
.pdlcount
, Qnil
);
1432 h
.handler
= handlers
;
1433 h
.next
= handlerlist
;
1437 val
= Feval (bodyform
);
1439 handlerlist
= h
.next
;
1443 /* Call the function BFUN with no arguments, catching errors within it
1444 according to HANDLERS. If there is an error, call HFUN with
1445 one argument which is the data that describes the error:
1448 HANDLERS can be a list of conditions to catch.
1449 If HANDLERS is Qt, catch all errors.
1450 If HANDLERS is Qerror, catch all errors
1451 but allow the debugger to run if that is enabled. */
1454 internal_condition_case (bfun
, handlers
, hfun
)
1455 Lisp_Object (*bfun
) ();
1456 Lisp_Object handlers
;
1457 Lisp_Object (*hfun
) ();
1463 /* Since Fsignal will close off all calls to x_catch_errors,
1464 we will get the wrong results if some are not closed now. */
1466 if (x_catching_errors ())
1472 c
.backlist
= backtrace_list
;
1473 c
.handlerlist
= handlerlist
;
1474 c
.lisp_eval_depth
= lisp_eval_depth
;
1475 c
.pdlcount
= SPECPDL_INDEX ();
1476 c
.poll_suppress_count
= poll_suppress_count
;
1477 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1478 c
.gcpro
= gcprolist
;
1479 c
.byte_stack
= byte_stack_list
;
1480 if (_setjmp (c
.jmp
))
1482 return (*hfun
) (c
.val
);
1486 h
.handler
= handlers
;
1488 h
.next
= handlerlist
;
1494 handlerlist
= h
.next
;
1498 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1501 internal_condition_case_1 (bfun
, arg
, handlers
, hfun
)
1502 Lisp_Object (*bfun
) ();
1504 Lisp_Object handlers
;
1505 Lisp_Object (*hfun
) ();
1511 /* Since Fsignal will close off all calls to x_catch_errors,
1512 we will get the wrong results if some are not closed now. */
1514 if (x_catching_errors ())
1520 c
.backlist
= backtrace_list
;
1521 c
.handlerlist
= handlerlist
;
1522 c
.lisp_eval_depth
= lisp_eval_depth
;
1523 c
.pdlcount
= SPECPDL_INDEX ();
1524 c
.poll_suppress_count
= poll_suppress_count
;
1525 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1526 c
.gcpro
= gcprolist
;
1527 c
.byte_stack
= byte_stack_list
;
1528 if (_setjmp (c
.jmp
))
1530 return (*hfun
) (c
.val
);
1534 h
.handler
= handlers
;
1536 h
.next
= handlerlist
;
1540 val
= (*bfun
) (arg
);
1542 handlerlist
= h
.next
;
1547 /* Like internal_condition_case but call BFUN with NARGS as first,
1548 and ARGS as second argument. */
1551 internal_condition_case_2 (bfun
, nargs
, args
, handlers
, hfun
)
1552 Lisp_Object (*bfun
) ();
1555 Lisp_Object handlers
;
1556 Lisp_Object (*hfun
) ();
1562 /* Since Fsignal will close off all calls to x_catch_errors,
1563 we will get the wrong results if some are not closed now. */
1565 if (x_catching_errors ())
1571 c
.backlist
= backtrace_list
;
1572 c
.handlerlist
= handlerlist
;
1573 c
.lisp_eval_depth
= lisp_eval_depth
;
1574 c
.pdlcount
= SPECPDL_INDEX ();
1575 c
.poll_suppress_count
= poll_suppress_count
;
1576 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1577 c
.gcpro
= gcprolist
;
1578 c
.byte_stack
= byte_stack_list
;
1579 if (_setjmp (c
.jmp
))
1581 return (*hfun
) (c
.val
);
1585 h
.handler
= handlers
;
1587 h
.next
= handlerlist
;
1591 val
= (*bfun
) (nargs
, args
);
1593 handlerlist
= h
.next
;
1598 static Lisp_Object find_handler_clause
P_ ((Lisp_Object
, Lisp_Object
,
1599 Lisp_Object
, Lisp_Object
));
1601 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1602 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1603 This function does not return.
1605 An error symbol is a symbol with an `error-conditions' property
1606 that is a list of condition names.
1607 A handler for any of those names will get to handle this signal.
1608 The symbol `error' should normally be one of them.
1610 DATA should be a list. Its elements are printed as part of the error message.
1611 See Info anchor `(elisp)Definition of signal' for some details on how this
1612 error message is constructed.
1613 If the signal is handled, DATA is made available to the handler.
1614 See also the function `condition-case'. */)
1615 (error_symbol
, data
)
1616 Lisp_Object error_symbol
, data
;
1618 /* When memory is full, ERROR-SYMBOL is nil,
1619 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1620 That is a special case--don't do this in other situations. */
1621 register struct handler
*allhandlers
= handlerlist
;
1622 Lisp_Object conditions
;
1623 extern int gc_in_progress
;
1624 extern int waiting_for_input
;
1626 Lisp_Object real_error_symbol
;
1627 struct backtrace
*bp
;
1629 immediate_quit
= handling_signal
= 0;
1631 if (gc_in_progress
|| waiting_for_input
)
1634 if (NILP (error_symbol
))
1635 real_error_symbol
= Fcar (data
);
1637 real_error_symbol
= error_symbol
;
1639 #if 0 /* rms: I don't know why this was here,
1640 but it is surely wrong for an error that is handled. */
1641 #ifdef HAVE_WINDOW_SYSTEM
1642 if (display_hourglass_p
)
1643 cancel_hourglass ();
1647 /* This hook is used by edebug. */
1648 if (! NILP (Vsignal_hook_function
)
1649 && ! NILP (error_symbol
))
1651 /* Edebug takes care of restoring these variables when it exits. */
1652 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1653 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1655 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1656 max_specpdl_size
= SPECPDL_INDEX () + 40;
1658 call2 (Vsignal_hook_function
, error_symbol
, data
);
1661 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1663 /* Remember from where signal was called. Skip over the frame for
1664 `signal' itself. If a frame for `error' follows, skip that,
1665 too. Don't do this when ERROR_SYMBOL is nil, because that
1666 is a memory-full error. */
1667 Vsignaling_function
= Qnil
;
1668 if (backtrace_list
&& !NILP (error_symbol
))
1670 bp
= backtrace_list
->next
;
1671 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1673 if (bp
&& bp
->function
)
1674 Vsignaling_function
= *bp
->function
;
1677 for (; handlerlist
; handlerlist
= handlerlist
->next
)
1679 register Lisp_Object clause
;
1681 clause
= find_handler_clause (handlerlist
->handler
, conditions
,
1682 error_symbol
, data
);
1684 if (EQ (clause
, Qlambda
))
1686 /* We can't return values to code which signaled an error, but we
1687 can continue code which has signaled a quit. */
1688 if (EQ (real_error_symbol
, Qquit
))
1691 error ("Cannot return from the debugger in an error");
1696 Lisp_Object unwind_data
;
1697 struct handler
*h
= handlerlist
;
1699 handlerlist
= allhandlers
;
1701 if (NILP (error_symbol
))
1704 unwind_data
= Fcons (error_symbol
, data
);
1705 h
->chosen_clause
= clause
;
1706 unwind_to_catch (h
->tag
, unwind_data
);
1710 handlerlist
= allhandlers
;
1711 /* If no handler is present now, try to run the debugger,
1712 and if that fails, throw to top level. */
1713 find_handler_clause (Qerror
, conditions
, error_symbol
, data
);
1715 Fthrow (Qtop_level
, Qt
);
1717 if (! NILP (error_symbol
))
1718 data
= Fcons (error_symbol
, data
);
1720 string
= Ferror_message_string (data
);
1721 fatal ("%s", SDATA (string
), 0);
1724 /* Internal version of Fsignal that never returns.
1725 Used for anything but Qquit (which can return from Fsignal). */
1728 xsignal (error_symbol
, data
)
1729 Lisp_Object error_symbol
, data
;
1731 Fsignal (error_symbol
, data
);
1735 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1738 xsignal0 (error_symbol
)
1739 Lisp_Object error_symbol
;
1741 xsignal (error_symbol
, Qnil
);
1745 xsignal1 (error_symbol
, arg
)
1746 Lisp_Object error_symbol
, arg
;
1748 xsignal (error_symbol
, list1 (arg
));
1752 xsignal2 (error_symbol
, arg1
, arg2
)
1753 Lisp_Object error_symbol
, arg1
, arg2
;
1755 xsignal (error_symbol
, list2 (arg1
, arg2
));
1759 xsignal3 (error_symbol
, arg1
, arg2
, arg3
)
1760 Lisp_Object error_symbol
, arg1
, arg2
, arg3
;
1762 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1765 /* Signal `error' with message S, and additional arg ARG.
1766 If ARG is not a genuine list, make it a one-element list. */
1769 signal_error (s
, arg
)
1773 Lisp_Object tortoise
, hare
;
1775 hare
= tortoise
= arg
;
1776 while (CONSP (hare
))
1783 tortoise
= XCDR (tortoise
);
1785 if (EQ (hare
, tortoise
))
1790 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1792 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1796 /* Return nonzero if LIST is a non-nil atom or
1797 a list containing one of CONDITIONS. */
1800 wants_debugger (list
, conditions
)
1801 Lisp_Object list
, conditions
;
1808 while (CONSP (conditions
))
1810 Lisp_Object
this, tail
;
1811 this = XCAR (conditions
);
1812 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1813 if (EQ (XCAR (tail
), this))
1815 conditions
= XCDR (conditions
);
1820 /* Return 1 if an error with condition-symbols CONDITIONS,
1821 and described by SIGNAL-DATA, should skip the debugger
1822 according to debugger-ignored-errors. */
1825 skip_debugger (conditions
, data
)
1826 Lisp_Object conditions
, data
;
1829 int first_string
= 1;
1830 Lisp_Object error_message
;
1832 error_message
= Qnil
;
1833 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1835 if (STRINGP (XCAR (tail
)))
1839 error_message
= Ferror_message_string (data
);
1843 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1848 Lisp_Object contail
;
1850 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1851 if (EQ (XCAR (tail
), XCAR (contail
)))
1859 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1860 SIG and DATA describe the signal, as in find_handler_clause. */
1863 maybe_call_debugger (conditions
, sig
, data
)
1864 Lisp_Object conditions
, sig
, data
;
1866 Lisp_Object combined_data
;
1868 combined_data
= Fcons (sig
, data
);
1871 /* Don't try to run the debugger with interrupts blocked.
1872 The editing loop would return anyway. */
1874 /* Does user want to enter debugger for this kind of error? */
1877 : wants_debugger (Vdebug_on_error
, conditions
))
1878 && ! skip_debugger (conditions
, combined_data
)
1879 /* rms: what's this for? */
1880 && when_entered_debugger
< num_nonmacro_input_events
)
1882 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1889 /* Value of Qlambda means we have called debugger and user has continued.
1890 There are two ways to pass SIG and DATA:
1891 = SIG is the error symbol, and DATA is the rest of the data.
1892 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1893 This is for memory-full errors only.
1895 We need to increase max_specpdl_size temporarily around
1896 anything we do that can push on the specpdl, so as not to get
1897 a second error here in case we're handling specpdl overflow. */
1900 find_handler_clause (handlers
, conditions
, sig
, data
)
1901 Lisp_Object handlers
, conditions
, sig
, data
;
1903 register Lisp_Object h
;
1904 register Lisp_Object tem
;
1905 int debugger_called
= 0;
1906 int debugger_considered
= 0;
1908 /* t is used by handlers for all conditions, set up by C code. */
1909 if (EQ (handlers
, Qt
))
1912 /* Don't run the debugger for a memory-full error.
1913 (There is no room in memory to do that!) */
1915 debugger_considered
= 1;
1917 /* error is used similarly, but means print an error message
1918 and run the debugger if that is enabled. */
1919 if (EQ (handlers
, Qerror
)
1920 || !NILP (Vdebug_on_signal
)) /* This says call debugger even if
1921 there is a handler. */
1923 if (!NILP (sig
) && wants_debugger (Vstack_trace_on_error
, conditions
))
1925 max_lisp_eval_depth
+= 15;
1930 internal_with_output_to_temp_buffer
1932 (Lisp_Object (*) (Lisp_Object
)) Fbacktrace
,
1935 max_lisp_eval_depth
-= 15;
1938 if (!debugger_considered
)
1940 debugger_considered
= 1;
1941 debugger_called
= maybe_call_debugger (conditions
, sig
, data
);
1944 /* If there is no handler, return saying whether we ran the debugger. */
1945 if (EQ (handlers
, Qerror
))
1947 if (debugger_called
)
1953 for (h
= handlers
; CONSP (h
); h
= Fcdr (h
))
1955 Lisp_Object handler
, condit
;
1958 if (!CONSP (handler
))
1960 condit
= Fcar (handler
);
1961 /* Handle a single condition name in handler HANDLER. */
1962 if (SYMBOLP (condit
))
1964 tem
= Fmemq (Fcar (handler
), conditions
);
1968 /* Handle a list of condition names in handler HANDLER. */
1969 else if (CONSP (condit
))
1972 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1974 tem
= Fmemq (Fcar (tail
), conditions
);
1977 /* This handler is going to apply.
1978 Does it allow the debugger to run first? */
1979 if (! debugger_considered
&& !NILP (Fmemq (Qdebug
, condit
)))
1980 maybe_call_debugger (conditions
, sig
, data
);
1990 /* dump an error message; called like printf */
1994 error (m
, a1
, a2
, a3
)
2014 int used
= doprnt (buffer
, size
, m
, m
+ mlen
, 3, args
);
2019 buffer
= (char *) xrealloc (buffer
, size
);
2022 buffer
= (char *) xmalloc (size
);
2027 string
= build_string (buffer
);
2031 xsignal1 (Qerror
, string
);
2034 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2035 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2036 This means it contains a description for how to read arguments to give it.
2037 The value is nil for an invalid function or a symbol with no function
2040 Interactively callable functions include strings and vectors (treated
2041 as keyboard macros), lambda-expressions that contain a top-level call
2042 to `interactive', autoload definitions made by `autoload' with non-nil
2043 fourth argument, and some of the built-in functions of Lisp.
2045 Also, a symbol satisfies `commandp' if its function definition does so.
2047 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2048 then strings and vectors are not accepted. */)
2049 (function
, for_call_interactively
)
2050 Lisp_Object function
, for_call_interactively
;
2052 register Lisp_Object fun
;
2053 register Lisp_Object funcar
;
2054 Lisp_Object if_prop
= Qnil
;
2058 fun
= indirect_function (fun
); /* Check cycles. */
2059 if (NILP (fun
) || EQ (fun
, Qunbound
))
2062 /* Check an `interactive-form' property if present, analogous to the
2063 function-documentation property. */
2065 while (SYMBOLP (fun
))
2067 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
2070 fun
= Fsymbol_function (fun
);
2073 /* Emacs primitives are interactive if their DEFUN specifies an
2074 interactive spec. */
2076 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
2078 /* Bytecode objects are interactive if they are long enough to
2079 have an element whose index is COMPILED_INTERACTIVE, which is
2080 where the interactive spec is stored. */
2081 else if (COMPILEDP (fun
))
2082 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2085 /* Strings and vectors are keyboard macros. */
2086 if (STRINGP (fun
) || VECTORP (fun
))
2087 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
2089 /* Lists may represent commands. */
2092 funcar
= XCAR (fun
);
2093 if (EQ (funcar
, Qlambda
))
2094 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2095 if (EQ (funcar
, Qautoload
))
2096 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2101 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2102 doc
: /* Define FUNCTION to autoload from FILE.
2103 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2104 Third arg DOCSTRING is documentation for the function.
2105 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2106 Fifth arg TYPE indicates the type of the object:
2107 nil or omitted says FUNCTION is a function,
2108 `keymap' says FUNCTION is really a keymap, and
2109 `macro' or t says FUNCTION is really a macro.
2110 Third through fifth args give info about the real definition.
2111 They default to nil.
2112 If FUNCTION is already defined other than as an autoload,
2113 this does nothing and returns nil. */)
2114 (function
, file
, docstring
, interactive
, type
)
2115 Lisp_Object function
, file
, docstring
, interactive
, type
;
2117 Lisp_Object args
[4];
2119 CHECK_SYMBOL (function
);
2120 CHECK_STRING (file
);
2122 /* If function is defined and not as an autoload, don't override */
2123 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2124 && !(CONSP (XSYMBOL (function
)->function
)
2125 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2128 if (NILP (Vpurify_flag
))
2129 /* Only add entries after dumping, because the ones before are
2130 not useful and else we get loads of them from the loaddefs.el. */
2131 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2133 /* We don't want the docstring in purespace (instead,
2134 Snarf-documentation should (hopefully) overwrite it). */
2135 docstring
= make_number (0);
2136 return Ffset (function
,
2137 Fpurecopy (list5 (Qautoload
, file
, docstring
,
2138 interactive
, type
)));
2142 un_autoload (oldqueue
)
2143 Lisp_Object oldqueue
;
2145 register Lisp_Object queue
, first
, second
;
2147 /* Queue to unwind is current value of Vautoload_queue.
2148 oldqueue is the shadowed value to leave in Vautoload_queue. */
2149 queue
= Vautoload_queue
;
2150 Vautoload_queue
= oldqueue
;
2151 while (CONSP (queue
))
2153 first
= XCAR (queue
);
2154 second
= Fcdr (first
);
2155 first
= Fcar (first
);
2156 if (EQ (first
, make_number (0)))
2159 Ffset (first
, second
);
2160 queue
= XCDR (queue
);
2165 /* Load an autoloaded function.
2166 FUNNAME is the symbol which is the function's name.
2167 FUNDEF is the autoload definition (a list). */
2170 do_autoload (fundef
, funname
)
2171 Lisp_Object fundef
, funname
;
2173 int count
= SPECPDL_INDEX ();
2175 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2177 /* This is to make sure that loadup.el gives a clear picture
2178 of what files are preloaded and when. */
2179 if (! NILP (Vpurify_flag
))
2180 error ("Attempt to autoload %s while preparing to dump",
2181 SDATA (SYMBOL_NAME (funname
)));
2184 CHECK_SYMBOL (funname
);
2185 GCPRO3 (fun
, funname
, fundef
);
2187 /* Preserve the match data. */
2188 record_unwind_save_match_data ();
2190 /* If autoloading gets an error (which includes the error of failing
2191 to define the function being called), we use Vautoload_queue
2192 to undo function definitions and `provide' calls made by
2193 the function. We do this in the specific case of autoloading
2194 because autoloading is not an explicit request "load this file",
2195 but rather a request to "call this function".
2197 The value saved here is to be restored into Vautoload_queue. */
2198 record_unwind_protect (un_autoload
, Vautoload_queue
);
2199 Vautoload_queue
= Qt
;
2200 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
2202 /* Once loading finishes, don't undo it. */
2203 Vautoload_queue
= Qt
;
2204 unbind_to (count
, Qnil
);
2206 fun
= Findirect_function (fun
, Qnil
);
2208 if (!NILP (Fequal (fun
, fundef
)))
2209 error ("Autoloading failed to define function %s",
2210 SDATA (SYMBOL_NAME (funname
)));
2215 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2216 doc
: /* Evaluate FORM and return its value. */)
2220 Lisp_Object fun
, val
, original_fun
, original_args
;
2222 struct backtrace backtrace
;
2223 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2225 if (handling_signal
)
2229 return Fsymbol_value (form
);
2234 if ((consing_since_gc
> gc_cons_threshold
2235 && consing_since_gc
> gc_relative_threshold
)
2237 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2240 Fgarbage_collect ();
2244 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2246 if (max_lisp_eval_depth
< 100)
2247 max_lisp_eval_depth
= 100;
2248 if (lisp_eval_depth
> max_lisp_eval_depth
)
2249 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2252 original_fun
= Fcar (form
);
2253 original_args
= Fcdr (form
);
2255 backtrace
.next
= backtrace_list
;
2256 backtrace_list
= &backtrace
;
2257 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2258 backtrace
.args
= &original_args
;
2259 backtrace
.nargs
= UNEVALLED
;
2260 backtrace
.evalargs
= 1;
2261 backtrace
.debug_on_exit
= 0;
2263 if (debug_on_next_call
)
2264 do_debug_on_call (Qt
);
2266 /* At this point, only original_fun and original_args
2267 have values that will be used below */
2270 /* Optimize for no indirection. */
2272 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2273 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2274 fun
= indirect_function (fun
);
2278 Lisp_Object numargs
;
2279 Lisp_Object argvals
[8];
2280 Lisp_Object args_left
;
2281 register int i
, maxargs
;
2283 args_left
= original_args
;
2284 numargs
= Flength (args_left
);
2288 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2289 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2290 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2292 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2294 backtrace
.evalargs
= 0;
2295 val
= (*XSUBR (fun
)->function
) (args_left
);
2299 if (XSUBR (fun
)->max_args
== MANY
)
2301 /* Pass a vector of evaluated arguments */
2303 register int argnum
= 0;
2306 SAFE_ALLOCA (vals
, Lisp_Object
*,
2307 XINT (numargs
) * sizeof (Lisp_Object
));
2309 GCPRO3 (args_left
, fun
, fun
);
2313 while (!NILP (args_left
))
2315 vals
[argnum
++] = Feval (Fcar (args_left
));
2316 args_left
= Fcdr (args_left
);
2317 gcpro3
.nvars
= argnum
;
2320 backtrace
.args
= vals
;
2321 backtrace
.nargs
= XINT (numargs
);
2323 val
= (*XSUBR (fun
)->function
) (XINT (numargs
), vals
);
2329 GCPRO3 (args_left
, fun
, fun
);
2330 gcpro3
.var
= argvals
;
2333 maxargs
= XSUBR (fun
)->max_args
;
2334 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2336 argvals
[i
] = Feval (Fcar (args_left
));
2342 backtrace
.args
= argvals
;
2343 backtrace
.nargs
= XINT (numargs
);
2348 val
= (*XSUBR (fun
)->function
) ();
2351 val
= (*XSUBR (fun
)->function
) (argvals
[0]);
2354 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1]);
2357 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2361 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2362 argvals
[2], argvals
[3]);
2365 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2366 argvals
[3], argvals
[4]);
2369 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2370 argvals
[3], argvals
[4], argvals
[5]);
2373 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2374 argvals
[3], argvals
[4], argvals
[5],
2379 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2380 argvals
[3], argvals
[4], argvals
[5],
2381 argvals
[6], argvals
[7]);
2385 /* Someone has created a subr that takes more arguments than
2386 is supported by this code. We need to either rewrite the
2387 subr to use a different argument protocol, or add more
2388 cases to this switch. */
2392 if (COMPILEDP (fun
))
2393 val
= apply_lambda (fun
, original_args
, 1);
2396 if (EQ (fun
, Qunbound
))
2397 xsignal1 (Qvoid_function
, original_fun
);
2399 xsignal1 (Qinvalid_function
, original_fun
);
2400 funcar
= XCAR (fun
);
2401 if (!SYMBOLP (funcar
))
2402 xsignal1 (Qinvalid_function
, original_fun
);
2403 if (EQ (funcar
, Qautoload
))
2405 do_autoload (fun
, original_fun
);
2408 if (EQ (funcar
, Qmacro
))
2409 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2410 else if (EQ (funcar
, Qlambda
))
2411 val
= apply_lambda (fun
, original_args
, 1);
2413 xsignal1 (Qinvalid_function
, original_fun
);
2419 if (backtrace
.debug_on_exit
)
2420 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2421 backtrace_list
= backtrace
.next
;
2426 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2427 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2428 Then return the value FUNCTION returns.
2429 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2430 usage: (apply FUNCTION &rest ARGUMENTS) */)
2435 register int i
, numargs
;
2436 register Lisp_Object spread_arg
;
2437 register Lisp_Object
*funcall_args
;
2438 Lisp_Object fun
, retval
;
2439 struct gcpro gcpro1
;
2444 spread_arg
= args
[nargs
- 1];
2445 CHECK_LIST (spread_arg
);
2447 numargs
= XINT (Flength (spread_arg
));
2450 return Ffuncall (nargs
- 1, args
);
2451 else if (numargs
== 1)
2453 args
[nargs
- 1] = XCAR (spread_arg
);
2454 return Ffuncall (nargs
, args
);
2457 numargs
+= nargs
- 2;
2459 /* Optimize for no indirection. */
2460 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2461 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2462 fun
= indirect_function (fun
);
2463 if (EQ (fun
, Qunbound
))
2465 /* Let funcall get the error */
2472 if (numargs
< XSUBR (fun
)->min_args
2473 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2474 goto funcall
; /* Let funcall get the error */
2475 else if (XSUBR (fun
)->max_args
> numargs
)
2477 /* Avoid making funcall cons up a yet another new vector of arguments
2478 by explicitly supplying nil's for optional values */
2479 SAFE_ALLOCA (funcall_args
, Lisp_Object
*,
2480 (1 + XSUBR (fun
)->max_args
) * sizeof (Lisp_Object
));
2481 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2482 funcall_args
[++i
] = Qnil
;
2483 GCPRO1 (*funcall_args
);
2484 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2488 /* We add 1 to numargs because funcall_args includes the
2489 function itself as well as its arguments. */
2492 SAFE_ALLOCA (funcall_args
, Lisp_Object
*,
2493 (1 + numargs
) * sizeof (Lisp_Object
));
2494 GCPRO1 (*funcall_args
);
2495 gcpro1
.nvars
= 1 + numargs
;
2498 bcopy (args
, funcall_args
, nargs
* sizeof (Lisp_Object
));
2499 /* Spread the last arg we got. Its first element goes in
2500 the slot that it used to occupy, hence this value of I. */
2502 while (!NILP (spread_arg
))
2504 funcall_args
[i
++] = XCAR (spread_arg
);
2505 spread_arg
= XCDR (spread_arg
);
2508 /* By convention, the caller needs to gcpro Ffuncall's args. */
2509 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2516 /* Run hook variables in various ways. */
2518 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2519 static Lisp_Object run_hook_with_args
P_ ((int, Lisp_Object
*,
2520 enum run_hooks_condition
));
2522 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2523 doc
: /* Run each hook in HOOKS.
2524 Each argument should be a symbol, a hook variable.
2525 These symbols are processed in the order specified.
2526 If a hook symbol has a non-nil value, that value may be a function
2527 or a list of functions to be called to run the hook.
2528 If the value is a function, it is called with no arguments.
2529 If it is a list, the elements are called, in order, with no arguments.
2531 Major modes should not use this function directly to run their mode
2532 hook; they should use `run-mode-hooks' instead.
2534 Do not use `make-local-variable' to make a hook variable buffer-local.
2535 Instead, use `add-hook' and specify t for the LOCAL argument.
2536 usage: (run-hooks &rest HOOKS) */)
2541 Lisp_Object hook
[1];
2544 for (i
= 0; i
< nargs
; i
++)
2547 run_hook_with_args (1, hook
, to_completion
);
2553 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2554 Srun_hook_with_args
, 1, MANY
, 0,
2555 doc
: /* Run HOOK with the specified arguments ARGS.
2556 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2557 value, that value may be a function or a list of functions to be
2558 called to run the hook. If the value is a function, it is called with
2559 the given arguments and its return value is returned. If it is a list
2560 of functions, those functions are called, in order,
2561 with the given arguments ARGS.
2562 It is best not to depend on the value returned by `run-hook-with-args',
2565 Do not use `make-local-variable' to make a hook variable buffer-local.
2566 Instead, use `add-hook' and specify t for the LOCAL argument.
2567 usage: (run-hook-with-args HOOK &rest ARGS) */)
2572 return run_hook_with_args (nargs
, args
, to_completion
);
2575 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2576 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2577 doc
: /* Run HOOK with the specified arguments ARGS.
2578 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2579 value, that value may be a function or a list of functions to be
2580 called to run the hook. If the value is a function, it is called with
2581 the given arguments and its return value is returned.
2582 If it is a list of functions, those functions are called, in order,
2583 with the given arguments ARGS, until one of them
2584 returns a non-nil value. Then we return that value.
2585 However, if they all return nil, we return nil.
2587 Do not use `make-local-variable' to make a hook variable buffer-local.
2588 Instead, use `add-hook' and specify t for the LOCAL argument.
2589 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2594 return run_hook_with_args (nargs
, args
, until_success
);
2597 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2598 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2599 doc
: /* Run HOOK with the specified arguments ARGS.
2600 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2601 value, that value may be a function or a list of functions to be
2602 called to run the hook. If the value is a function, it is called with
2603 the given arguments and its return value is returned.
2604 If it is a list of functions, those functions are called, in order,
2605 with the given arguments ARGS, until one of them returns nil.
2606 Then we return nil. However, if they all return non-nil, we return non-nil.
2608 Do not use `make-local-variable' to make a hook variable buffer-local.
2609 Instead, use `add-hook' and specify t for the LOCAL argument.
2610 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2615 return run_hook_with_args (nargs
, args
, until_failure
);
2618 /* ARGS[0] should be a hook symbol.
2619 Call each of the functions in the hook value, passing each of them
2620 as arguments all the rest of ARGS (all NARGS - 1 elements).
2621 COND specifies a condition to test after each call
2622 to decide whether to stop.
2623 The caller (or its caller, etc) must gcpro all of ARGS,
2624 except that it isn't necessary to gcpro ARGS[0]. */
2627 run_hook_with_args (nargs
, args
, cond
)
2630 enum run_hooks_condition cond
;
2632 Lisp_Object sym
, val
, ret
;
2633 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2635 /* If we are dying or still initializing,
2636 don't do anything--it would probably crash if we tried. */
2637 if (NILP (Vrun_hooks
))
2641 val
= find_symbol_value (sym
);
2642 ret
= (cond
== until_failure
? Qt
: Qnil
);
2644 if (EQ (val
, Qunbound
) || NILP (val
))
2646 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2649 return Ffuncall (nargs
, args
);
2653 Lisp_Object globals
= Qnil
;
2654 GCPRO3 (sym
, val
, globals
);
2657 CONSP (val
) && ((cond
== to_completion
)
2658 || (cond
== until_success
? NILP (ret
)
2662 if (EQ (XCAR (val
), Qt
))
2664 /* t indicates this hook has a local binding;
2665 it means to run the global binding too. */
2666 globals
= Fdefault_value (sym
);
2667 if (NILP (globals
)) continue;
2669 if (!CONSP (globals
) || EQ (XCAR (globals
), Qlambda
))
2672 ret
= Ffuncall (nargs
, args
);
2677 CONSP (globals
) && ((cond
== to_completion
)
2678 || (cond
== until_success
? NILP (ret
)
2680 globals
= XCDR (globals
))
2682 args
[0] = XCAR (globals
);
2683 /* In a global value, t should not occur. If it does, we
2684 must ignore it to avoid an endless loop. */
2685 if (!EQ (args
[0], Qt
))
2686 ret
= Ffuncall (nargs
, args
);
2692 args
[0] = XCAR (val
);
2693 ret
= Ffuncall (nargs
, args
);
2702 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2703 present value of that symbol.
2704 Call each element of FUNLIST,
2705 passing each of them the rest of ARGS.
2706 The caller (or its caller, etc) must gcpro all of ARGS,
2707 except that it isn't necessary to gcpro ARGS[0]. */
2710 run_hook_list_with_args (funlist
, nargs
, args
)
2711 Lisp_Object funlist
;
2717 Lisp_Object globals
;
2718 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2722 GCPRO3 (sym
, val
, globals
);
2724 for (val
= funlist
; CONSP (val
); val
= XCDR (val
))
2726 if (EQ (XCAR (val
), Qt
))
2728 /* t indicates this hook has a local binding;
2729 it means to run the global binding too. */
2731 for (globals
= Fdefault_value (sym
);
2733 globals
= XCDR (globals
))
2735 args
[0] = XCAR (globals
);
2736 /* In a global value, t should not occur. If it does, we
2737 must ignore it to avoid an endless loop. */
2738 if (!EQ (args
[0], Qt
))
2739 Ffuncall (nargs
, args
);
2744 args
[0] = XCAR (val
);
2745 Ffuncall (nargs
, args
);
2752 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2755 run_hook_with_args_2 (hook
, arg1
, arg2
)
2756 Lisp_Object hook
, arg1
, arg2
;
2758 Lisp_Object temp
[3];
2763 Frun_hook_with_args (3, temp
);
2766 /* Apply fn to arg */
2769 Lisp_Object fn
, arg
;
2771 struct gcpro gcpro1
;
2775 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2779 Lisp_Object args
[2];
2783 RETURN_UNGCPRO (Fapply (2, args
));
2785 #else /* not NO_ARG_ARRAY */
2786 RETURN_UNGCPRO (Fapply (2, &fn
));
2787 #endif /* not NO_ARG_ARRAY */
2790 /* Call function fn on no arguments */
2795 struct gcpro gcpro1
;
2798 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2801 /* Call function fn with 1 argument arg1 */
2805 Lisp_Object fn
, arg1
;
2807 struct gcpro gcpro1
;
2809 Lisp_Object args
[2];
2815 RETURN_UNGCPRO (Ffuncall (2, args
));
2816 #else /* not NO_ARG_ARRAY */
2819 RETURN_UNGCPRO (Ffuncall (2, &fn
));
2820 #endif /* not NO_ARG_ARRAY */
2823 /* Call function fn with 2 arguments arg1, arg2 */
2826 call2 (fn
, arg1
, arg2
)
2827 Lisp_Object fn
, arg1
, arg2
;
2829 struct gcpro gcpro1
;
2831 Lisp_Object args
[3];
2837 RETURN_UNGCPRO (Ffuncall (3, args
));
2838 #else /* not NO_ARG_ARRAY */
2841 RETURN_UNGCPRO (Ffuncall (3, &fn
));
2842 #endif /* not NO_ARG_ARRAY */
2845 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2848 call3 (fn
, arg1
, arg2
, arg3
)
2849 Lisp_Object fn
, arg1
, arg2
, arg3
;
2851 struct gcpro gcpro1
;
2853 Lisp_Object args
[4];
2860 RETURN_UNGCPRO (Ffuncall (4, args
));
2861 #else /* not NO_ARG_ARRAY */
2864 RETURN_UNGCPRO (Ffuncall (4, &fn
));
2865 #endif /* not NO_ARG_ARRAY */
2868 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2871 call4 (fn
, arg1
, arg2
, arg3
, arg4
)
2872 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
;
2874 struct gcpro gcpro1
;
2876 Lisp_Object args
[5];
2884 RETURN_UNGCPRO (Ffuncall (5, args
));
2885 #else /* not NO_ARG_ARRAY */
2888 RETURN_UNGCPRO (Ffuncall (5, &fn
));
2889 #endif /* not NO_ARG_ARRAY */
2892 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2895 call5 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
)
2896 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
;
2898 struct gcpro gcpro1
;
2900 Lisp_Object args
[6];
2909 RETURN_UNGCPRO (Ffuncall (6, args
));
2910 #else /* not NO_ARG_ARRAY */
2913 RETURN_UNGCPRO (Ffuncall (6, &fn
));
2914 #endif /* not NO_ARG_ARRAY */
2917 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2920 call6 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
)
2921 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
;
2923 struct gcpro gcpro1
;
2925 Lisp_Object args
[7];
2935 RETURN_UNGCPRO (Ffuncall (7, args
));
2936 #else /* not NO_ARG_ARRAY */
2939 RETURN_UNGCPRO (Ffuncall (7, &fn
));
2940 #endif /* not NO_ARG_ARRAY */
2943 /* The caller should GCPRO all the elements of ARGS. */
2945 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2946 doc
: /* Call first argument as a function, passing remaining arguments to it.
2947 Return the value that function returns.
2948 Thus, (funcall 'cons 'x 'y) returns (x . y).
2949 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2954 Lisp_Object fun
, original_fun
;
2956 int numargs
= nargs
- 1;
2957 Lisp_Object lisp_numargs
;
2959 struct backtrace backtrace
;
2960 register Lisp_Object
*internal_args
;
2964 if ((consing_since_gc
> gc_cons_threshold
2965 && consing_since_gc
> gc_relative_threshold
)
2967 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2968 Fgarbage_collect ();
2970 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2972 if (max_lisp_eval_depth
< 100)
2973 max_lisp_eval_depth
= 100;
2974 if (lisp_eval_depth
> max_lisp_eval_depth
)
2975 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2978 backtrace
.next
= backtrace_list
;
2979 backtrace_list
= &backtrace
;
2980 backtrace
.function
= &args
[0];
2981 backtrace
.args
= &args
[1];
2982 backtrace
.nargs
= nargs
- 1;
2983 backtrace
.evalargs
= 0;
2984 backtrace
.debug_on_exit
= 0;
2986 if (debug_on_next_call
)
2987 do_debug_on_call (Qlambda
);
2991 original_fun
= args
[0];
2995 /* Optimize for no indirection. */
2997 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2998 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2999 fun
= indirect_function (fun
);
3003 if (numargs
< XSUBR (fun
)->min_args
3004 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
3006 XSETFASTINT (lisp_numargs
, numargs
);
3007 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
3010 if (XSUBR (fun
)->max_args
== UNEVALLED
)
3011 xsignal1 (Qinvalid_function
, original_fun
);
3013 if (XSUBR (fun
)->max_args
== MANY
)
3015 val
= (*XSUBR (fun
)->function
) (numargs
, args
+ 1);
3019 if (XSUBR (fun
)->max_args
> numargs
)
3021 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
3022 bcopy (args
+ 1, internal_args
, numargs
* sizeof (Lisp_Object
));
3023 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
3024 internal_args
[i
] = Qnil
;
3027 internal_args
= args
+ 1;
3028 switch (XSUBR (fun
)->max_args
)
3031 val
= (*XSUBR (fun
)->function
) ();
3034 val
= (*XSUBR (fun
)->function
) (internal_args
[0]);
3037 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1]);
3040 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3044 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3045 internal_args
[2], internal_args
[3]);
3048 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3049 internal_args
[2], internal_args
[3],
3053 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3054 internal_args
[2], internal_args
[3],
3055 internal_args
[4], internal_args
[5]);
3058 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3059 internal_args
[2], internal_args
[3],
3060 internal_args
[4], internal_args
[5],
3065 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3066 internal_args
[2], internal_args
[3],
3067 internal_args
[4], internal_args
[5],
3068 internal_args
[6], internal_args
[7]);
3073 /* If a subr takes more than 8 arguments without using MANY
3074 or UNEVALLED, we need to extend this function to support it.
3075 Until this is done, there is no way to call the function. */
3079 if (COMPILEDP (fun
))
3080 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3083 if (EQ (fun
, Qunbound
))
3084 xsignal1 (Qvoid_function
, original_fun
);
3086 xsignal1 (Qinvalid_function
, original_fun
);
3087 funcar
= XCAR (fun
);
3088 if (!SYMBOLP (funcar
))
3089 xsignal1 (Qinvalid_function
, original_fun
);
3090 if (EQ (funcar
, Qlambda
))
3091 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3092 else if (EQ (funcar
, Qautoload
))
3094 do_autoload (fun
, original_fun
);
3099 xsignal1 (Qinvalid_function
, original_fun
);
3104 if (backtrace
.debug_on_exit
)
3105 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3106 backtrace_list
= backtrace
.next
;
3111 apply_lambda (fun
, args
, eval_flag
)
3112 Lisp_Object fun
, args
;
3115 Lisp_Object args_left
;
3116 Lisp_Object numargs
;
3117 register Lisp_Object
*arg_vector
;
3118 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3120 register Lisp_Object tem
;
3123 numargs
= Flength (args
);
3124 SAFE_ALLOCA (arg_vector
, Lisp_Object
*,
3125 XINT (numargs
) * sizeof (Lisp_Object
));
3128 GCPRO3 (*arg_vector
, args_left
, fun
);
3131 for (i
= 0; i
< XINT (numargs
);)
3133 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3134 if (eval_flag
) tem
= Feval (tem
);
3135 arg_vector
[i
++] = tem
;
3143 backtrace_list
->args
= arg_vector
;
3144 backtrace_list
->nargs
= i
;
3146 backtrace_list
->evalargs
= 0;
3147 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
3149 /* Do the debug-on-exit now, while arg_vector still exists. */
3150 if (backtrace_list
->debug_on_exit
)
3151 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3152 /* Don't do it again when we return to eval. */
3153 backtrace_list
->debug_on_exit
= 0;
3158 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3159 and return the result of evaluation.
3160 FUN must be either a lambda-expression or a compiled-code object. */
3163 funcall_lambda (fun
, nargs
, arg_vector
)
3166 register Lisp_Object
*arg_vector
;
3168 Lisp_Object val
, syms_left
, next
;
3169 int count
= SPECPDL_INDEX ();
3170 int i
, optional
, rest
;
3174 syms_left
= XCDR (fun
);
3175 if (CONSP (syms_left
))
3176 syms_left
= XCAR (syms_left
);
3178 xsignal1 (Qinvalid_function
, fun
);
3180 else if (COMPILEDP (fun
))
3181 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3185 i
= optional
= rest
= 0;
3186 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3190 next
= XCAR (syms_left
);
3191 if (!SYMBOLP (next
))
3192 xsignal1 (Qinvalid_function
, fun
);
3194 if (EQ (next
, Qand_rest
))
3196 else if (EQ (next
, Qand_optional
))
3200 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3204 specbind (next
, arg_vector
[i
++]);
3206 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3208 specbind (next
, Qnil
);
3211 if (!NILP (syms_left
))
3212 xsignal1 (Qinvalid_function
, fun
);
3214 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3217 val
= Fprogn (XCDR (XCDR (fun
)));
3220 /* If we have not actually read the bytecode string
3221 and constants vector yet, fetch them from the file. */
3222 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3223 Ffetch_bytecode (fun
);
3224 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3225 AREF (fun
, COMPILED_CONSTANTS
),
3226 AREF (fun
, COMPILED_STACK_DEPTH
));
3229 return unbind_to (count
, val
);
3232 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3234 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3240 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3242 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3245 tem
= AREF (object
, COMPILED_BYTECODE
);
3246 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3247 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3249 error ("Invalid byte code");
3251 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3252 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3260 register int count
= SPECPDL_INDEX ();
3261 if (specpdl_size
>= max_specpdl_size
)
3263 if (max_specpdl_size
< 400)
3264 max_specpdl_size
= 400;
3265 if (specpdl_size
>= max_specpdl_size
)
3266 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3269 if (specpdl_size
> max_specpdl_size
)
3270 specpdl_size
= max_specpdl_size
;
3271 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3272 specpdl_ptr
= specpdl
+ count
;
3276 specbind (symbol
, value
)
3277 Lisp_Object symbol
, value
;
3279 Lisp_Object valcontents
;
3281 CHECK_SYMBOL (symbol
);
3282 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3285 /* The most common case is that of a non-constant symbol with a
3286 trivial value. Make that as fast as we can. */
3287 valcontents
= SYMBOL_VALUE (symbol
);
3288 if (!MISCP (valcontents
) && !SYMBOL_CONSTANT_P (symbol
))
3290 specpdl_ptr
->symbol
= symbol
;
3291 specpdl_ptr
->old_value
= valcontents
;
3292 specpdl_ptr
->func
= NULL
;
3294 SET_SYMBOL_VALUE (symbol
, value
);
3298 Lisp_Object ovalue
= find_symbol_value (symbol
);
3299 specpdl_ptr
->func
= 0;
3300 specpdl_ptr
->old_value
= ovalue
;
3302 valcontents
= XSYMBOL (symbol
)->value
;
3304 if (BUFFER_LOCAL_VALUEP (valcontents
)
3305 || BUFFER_OBJFWDP (valcontents
))
3307 Lisp_Object where
, current_buffer
;
3309 current_buffer
= Fcurrent_buffer ();
3311 /* For a local variable, record both the symbol and which
3312 buffer's or frame's value we are saving. */
3313 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3314 where
= current_buffer
;
3315 else if (BUFFER_LOCAL_VALUEP (valcontents
)
3316 && XBUFFER_LOCAL_VALUE (valcontents
)->found_for_frame
)
3317 where
= XBUFFER_LOCAL_VALUE (valcontents
)->frame
;
3321 /* We're not using the `unused' slot in the specbinding
3322 structure because this would mean we have to do more
3323 work for simple variables. */
3324 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, current_buffer
));
3326 /* If SYMBOL is a per-buffer variable which doesn't have a
3327 buffer-local value here, make the `let' change the global
3328 value by changing the value of SYMBOL in all buffers not
3329 having their own value. This is consistent with what
3330 happens with other buffer-local variables. */
3332 && BUFFER_OBJFWDP (valcontents
))
3335 Fset_default (symbol
, value
);
3340 specpdl_ptr
->symbol
= symbol
;
3344 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3345 store_symval_forwarding (symbol, ovalue, value, NULL);
3347 but ovalue comes from find_symbol_value which should never return
3348 such an internal value. */
3349 eassert (!(BUFFER_OBJFWDP (ovalue
) || KBOARD_OBJFWDP (ovalue
)));
3350 set_internal (symbol
, value
, 0, 1);
3355 record_unwind_protect (function
, arg
)
3356 Lisp_Object (*function
) P_ ((Lisp_Object
));
3359 eassert (!handling_signal
);
3361 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3363 specpdl_ptr
->func
= function
;
3364 specpdl_ptr
->symbol
= Qnil
;
3365 specpdl_ptr
->old_value
= arg
;
3370 unbind_to (count
, value
)
3374 Lisp_Object quitf
= Vquit_flag
;
3375 struct gcpro gcpro1
, gcpro2
;
3377 GCPRO2 (value
, quitf
);
3380 while (specpdl_ptr
!= specpdl
+ count
)
3382 /* Copy the binding, and decrement specpdl_ptr, before we do
3383 the work to unbind it. We decrement first
3384 so that an error in unbinding won't try to unbind
3385 the same entry again, and we copy the binding first
3386 in case more bindings are made during some of the code we run. */
3388 struct specbinding this_binding
;
3389 this_binding
= *--specpdl_ptr
;
3391 if (this_binding
.func
!= 0)
3392 (*this_binding
.func
) (this_binding
.old_value
);
3393 /* If the symbol is a list, it is really (SYMBOL WHERE
3394 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3395 frame. If WHERE is a buffer or frame, this indicates we
3396 bound a variable that had a buffer-local or frame-local
3397 binding. WHERE nil means that the variable had the default
3398 value when it was bound. CURRENT-BUFFER is the buffer that
3399 was current when the variable was bound. */
3400 else if (CONSP (this_binding
.symbol
))
3402 Lisp_Object symbol
, where
;
3404 symbol
= XCAR (this_binding
.symbol
);
3405 where
= XCAR (XCDR (this_binding
.symbol
));
3408 Fset_default (symbol
, this_binding
.old_value
);
3409 else if (BUFFERP (where
))
3410 set_internal (symbol
, this_binding
.old_value
, XBUFFER (where
), 1);
3412 set_internal (symbol
, this_binding
.old_value
, NULL
, 1);
3416 /* If variable has a trivial value (no forwarding), we can
3417 just set it. No need to check for constant symbols here,
3418 since that was already done by specbind. */
3419 if (!MISCP (SYMBOL_VALUE (this_binding
.symbol
)))
3420 SET_SYMBOL_VALUE (this_binding
.symbol
, this_binding
.old_value
);
3422 set_internal (this_binding
.symbol
, this_binding
.old_value
, 0, 1);
3426 if (NILP (Vquit_flag
) && !NILP (quitf
))
3433 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3434 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3435 The debugger is entered when that frame exits, if the flag is non-nil. */)
3437 Lisp_Object level
, flag
;
3439 register struct backtrace
*backlist
= backtrace_list
;
3442 CHECK_NUMBER (level
);
3444 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3446 backlist
= backlist
->next
;
3450 backlist
->debug_on_exit
= !NILP (flag
);
3455 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3456 doc
: /* Print a trace of Lisp function calls currently active.
3457 Output stream used is value of `standard-output'. */)
3460 register struct backtrace
*backlist
= backtrace_list
;
3464 extern Lisp_Object Vprint_level
;
3465 struct gcpro gcpro1
;
3467 XSETFASTINT (Vprint_level
, 3);
3474 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3475 if (backlist
->nargs
== UNEVALLED
)
3477 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3478 write_string ("\n", -1);
3482 tem
= *backlist
->function
;
3483 Fprin1 (tem
, Qnil
); /* This can QUIT */
3484 write_string ("(", -1);
3485 if (backlist
->nargs
== MANY
)
3487 for (tail
= *backlist
->args
, i
= 0;
3489 tail
= Fcdr (tail
), i
++)
3491 if (i
) write_string (" ", -1);
3492 Fprin1 (Fcar (tail
), Qnil
);
3497 for (i
= 0; i
< backlist
->nargs
; i
++)
3499 if (i
) write_string (" ", -1);
3500 Fprin1 (backlist
->args
[i
], Qnil
);
3503 write_string (")\n", -1);
3505 backlist
= backlist
->next
;
3508 Vprint_level
= Qnil
;
3513 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3514 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3515 If that frame has not evaluated the arguments yet (or is a special form),
3516 the value is (nil FUNCTION ARG-FORMS...).
3517 If that frame has evaluated its arguments and called its function already,
3518 the value is (t FUNCTION ARG-VALUES...).
3519 A &rest arg is represented as the tail of the list ARG-VALUES.
3520 FUNCTION is whatever was supplied as car of evaluated list,
3521 or a lambda expression for macro calls.
3522 If NFRAMES is more than the number of frames, the value is nil. */)
3524 Lisp_Object nframes
;
3526 register struct backtrace
*backlist
= backtrace_list
;
3530 CHECK_NATNUM (nframes
);
3532 /* Find the frame requested. */
3533 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3534 backlist
= backlist
->next
;
3538 if (backlist
->nargs
== UNEVALLED
)
3539 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3542 if (backlist
->nargs
== MANY
)
3543 tem
= *backlist
->args
;
3545 tem
= Flist (backlist
->nargs
, backlist
->args
);
3547 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3555 register struct backtrace
*backlist
;
3558 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3560 mark_object (*backlist
->function
);
3562 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3565 i
= backlist
->nargs
- 1;
3567 mark_object (backlist
->args
[i
]);
3574 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size
,
3575 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3576 If Lisp code tries to increase the total number past this amount,
3577 an error is signaled.
3578 You can safely use a value considerably larger than the default value,
3579 if that proves inconveniently small. However, if you increase it too far,
3580 Emacs could run out of memory trying to make the stack bigger. */);
3582 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth
,
3583 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3585 This limit serves to catch infinite recursions for you before they cause
3586 actual stack overflow in C, which would be fatal for Emacs.
3587 You can safely make it considerably larger than its default value,
3588 if that proves inconveniently small. However, if you increase it too far,
3589 Emacs could overflow the real C stack, and crash. */);
3591 DEFVAR_LISP ("quit-flag", &Vquit_flag
,
3592 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3593 If the value is t, that means do an ordinary quit.
3594 If the value equals `throw-on-input', that means quit by throwing
3595 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3596 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3597 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3600 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit
,
3601 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3602 Note that `quit-flag' will still be set by typing C-g,
3603 so a quit will be signaled as soon as `inhibit-quit' is nil.
3604 To prevent this happening, set `quit-flag' to nil
3605 before making `inhibit-quit' nil. */);
3606 Vinhibit_quit
= Qnil
;
3608 Qinhibit_quit
= intern_c_string ("inhibit-quit");
3609 staticpro (&Qinhibit_quit
);
3611 Qautoload
= intern_c_string ("autoload");
3612 staticpro (&Qautoload
);
3614 Qdebug_on_error
= intern_c_string ("debug-on-error");
3615 staticpro (&Qdebug_on_error
);
3617 Qmacro
= intern_c_string ("macro");
3618 staticpro (&Qmacro
);
3620 Qdeclare
= intern_c_string ("declare");
3621 staticpro (&Qdeclare
);
3623 /* Note that the process handling also uses Qexit, but we don't want
3624 to staticpro it twice, so we just do it here. */
3625 Qexit
= intern_c_string ("exit");
3628 Qinteractive
= intern_c_string ("interactive");
3629 staticpro (&Qinteractive
);
3631 Qcommandp
= intern_c_string ("commandp");
3632 staticpro (&Qcommandp
);
3634 Qdefun
= intern_c_string ("defun");
3635 staticpro (&Qdefun
);
3637 Qand_rest
= intern_c_string ("&rest");
3638 staticpro (&Qand_rest
);
3640 Qand_optional
= intern_c_string ("&optional");
3641 staticpro (&Qand_optional
);
3643 Qdebug
= intern_c_string ("debug");
3644 staticpro (&Qdebug
);
3646 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error
,
3647 doc
: /* *Non-nil means errors display a backtrace buffer.
3648 More precisely, this happens for any error that is handled
3649 by the editor command loop.
3650 If the value is a list, an error only means to display a backtrace
3651 if one of its condition symbols appears in the list. */);
3652 Vstack_trace_on_error
= Qnil
;
3654 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error
,
3655 doc
: /* *Non-nil means enter debugger if an error is signaled.
3656 Does not apply to errors handled by `condition-case' or those
3657 matched by `debug-ignored-errors'.
3658 If the value is a list, an error only means to enter the debugger
3659 if one of its condition symbols appears in the list.
3660 When you evaluate an expression interactively, this variable
3661 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3662 The command `toggle-debug-on-error' toggles this.
3663 See also the variable `debug-on-quit'. */);
3664 Vdebug_on_error
= Qnil
;
3666 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors
,
3667 doc
: /* *List of errors for which the debugger should not be called.
3668 Each element may be a condition-name or a regexp that matches error messages.
3669 If any element applies to a given error, that error skips the debugger
3670 and just returns to top level.
3671 This overrides the variable `debug-on-error'.
3672 It does not apply to errors handled by `condition-case'. */);
3673 Vdebug_ignored_errors
= Qnil
;
3675 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit
,
3676 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3677 Does not apply if quit is handled by a `condition-case'. */);
3680 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call
,
3681 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3683 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue
,
3684 doc
: /* Non-nil means debugger may continue execution.
3685 This is nil when the debugger is called under circumstances where it
3686 might not be safe to continue. */);
3687 debugger_may_continue
= 1;
3689 DEFVAR_LISP ("debugger", &Vdebugger
,
3690 doc
: /* Function to call to invoke debugger.
3691 If due to frame exit, args are `exit' and the value being returned;
3692 this function's value will be returned instead of that.
3693 If due to error, args are `error' and a list of the args to `signal'.
3694 If due to `apply' or `funcall' entry, one arg, `lambda'.
3695 If due to `eval' entry, one arg, t. */);
3698 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function
,
3699 doc
: /* If non-nil, this is a function for `signal' to call.
3700 It receives the same arguments that `signal' was given.
3701 The Edebug package uses this to regain control. */);
3702 Vsignal_hook_function
= Qnil
;
3704 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal
,
3705 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3706 Note that `debug-on-error', `debug-on-quit' and friends
3707 still determine whether to handle the particular condition. */);
3708 Vdebug_on_signal
= Qnil
;
3710 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function
,
3711 doc
: /* Function to process declarations in a macro definition.
3712 The function will be called with two args MACRO and DECL.
3713 MACRO is the name of the macro being defined.
3714 DECL is a list `(declare ...)' containing the declarations.
3715 The value the function returns is not used. */);
3716 Vmacro_declaration_function
= Qnil
;
3718 Vrun_hooks
= intern_c_string ("run-hooks");
3719 staticpro (&Vrun_hooks
);
3721 staticpro (&Vautoload_queue
);
3722 Vautoload_queue
= Qnil
;
3723 staticpro (&Vsignaling_function
);
3724 Vsignaling_function
= Qnil
;
3735 defsubr (&Sfunction
);
3737 defsubr (&Sdefmacro
);
3739 defsubr (&Sdefvaralias
);
3740 defsubr (&Sdefconst
);
3741 defsubr (&Suser_variable_p
);
3745 defsubr (&Smacroexpand
);
3748 defsubr (&Sunwind_protect
);
3749 defsubr (&Scondition_case
);
3751 defsubr (&Sinteractive_p
);
3752 defsubr (&Scalled_interactively_p
);
3753 defsubr (&Scommandp
);
3754 defsubr (&Sautoload
);
3757 defsubr (&Sfuncall
);
3758 defsubr (&Srun_hooks
);
3759 defsubr (&Srun_hook_with_args
);
3760 defsubr (&Srun_hook_with_args_until_success
);
3761 defsubr (&Srun_hook_with_args_until_failure
);
3762 defsubr (&Sfetch_bytecode
);
3763 defsubr (&Sbacktrace_debug
);
3764 defsubr (&Sbacktrace
);
3765 defsubr (&Sbacktrace_frame
);
3768 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3769 (do not change this comment) */