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 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
25 #include "blockinput.h"
28 #include "dispextern.h"
35 /* This definition is duplicated in alloc.c and keyboard.c */
36 /* Putting it in lisp.h makes cc bomb out! */
40 struct backtrace
*next
;
41 Lisp_Object
*function
;
42 Lisp_Object
*args
; /* Points to vector of args. */
43 int nargs
; /* Length of vector.
44 If nargs is UNEVALLED, args points to slot holding
45 list of unevalled args */
47 /* Nonzero means call value of debugger when done with this operation. */
51 struct backtrace
*backtrace_list
;
53 /* This structure helps implement the `catch' and `throw' control
54 structure. A struct catchtag contains all the information needed
55 to restore the state of the interpreter after a non-local jump.
57 Handlers for error conditions (represented by `struct handler'
58 structures) just point to a catch tag to do the cleanup required
61 catchtag structures are chained together in the C calling stack;
62 the `next' member points to the next outer catchtag.
64 A call like (throw TAG VAL) searches for a catchtag whose `tag'
65 member is TAG, and then unbinds to it. The `val' member is used to
66 hold VAL while the stack is unwound; `val' is returned as the value
69 All the other members are concerned with restoring the interpreter
76 struct catchtag
*next
;
79 struct backtrace
*backlist
;
80 struct handler
*handlerlist
;
83 int poll_suppress_count
;
84 int interrupt_input_blocked
;
85 struct byte_stack
*byte_stack
;
88 struct catchtag
*catchlist
;
91 /* Count levels of GCPRO to detect failure to UNGCPRO. */
95 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
96 Lisp_Object Qinhibit_quit
, Vinhibit_quit
, Vquit_flag
;
97 Lisp_Object Qand_rest
, Qand_optional
;
98 Lisp_Object Qdebug_on_error
;
102 /* This holds either the symbol `run-hooks' or nil.
103 It is nil at an early stage of startup, and when Emacs
106 Lisp_Object Vrun_hooks
;
108 /* Non-nil means record all fset's and provide's, to be undone
109 if the file being autoloaded is not fully loaded.
110 They are recorded by being consed onto the front of Vautoload_queue:
111 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
113 Lisp_Object Vautoload_queue
;
115 /* Current number of specbindings allocated in specpdl. */
119 /* Pointer to beginning of specpdl. */
121 struct specbinding
*specpdl
;
123 /* Pointer to first unused element in specpdl. */
125 struct specbinding
*specpdl_ptr
;
127 /* Maximum size allowed for specpdl allocation */
129 EMACS_INT max_specpdl_size
;
131 /* Depth in Lisp evaluations and function calls. */
135 /* Maximum allowed depth in Lisp evaluations and function calls. */
137 EMACS_INT max_lisp_eval_depth
;
139 /* Nonzero means enter debugger before next function call */
141 int debug_on_next_call
;
143 /* Non-zero means debugger may continue. This is zero when the
144 debugger is called during redisplay, where it might not be safe to
145 continue the interrupted redisplay. */
147 int debugger_may_continue
;
149 /* List of conditions (non-nil atom means all) which cause a backtrace
150 if an error is handled by the command loop's error handler. */
152 Lisp_Object Vstack_trace_on_error
;
154 /* List of conditions (non-nil atom means all) which enter the debugger
155 if an error is handled by the command loop's error handler. */
157 Lisp_Object Vdebug_on_error
;
159 /* List of conditions and regexps specifying error messages which
160 do not enter the debugger even if Vdebug_on_error says they should. */
162 Lisp_Object Vdebug_ignored_errors
;
164 /* Non-nil means call the debugger even if the error will be handled. */
166 Lisp_Object Vdebug_on_signal
;
168 /* Hook for edebug to use. */
170 Lisp_Object Vsignal_hook_function
;
172 /* Nonzero means enter debugger if a quit signal
173 is handled by the command loop's error handler. */
177 /* The value of num_nonmacro_input_events as of the last time we
178 started to enter the debugger. If we decide to enter the debugger
179 again when this is still equal to num_nonmacro_input_events, then we
180 know that the debugger itself has an error, and we should just
181 signal the error instead of entering an infinite loop of debugger
184 int when_entered_debugger
;
186 Lisp_Object Vdebugger
;
188 /* The function from which the last `signal' was called. Set in
191 Lisp_Object Vsignaling_function
;
193 /* Set to non-zero while processing X events. Checked in Feval to
194 make sure the Lisp interpreter isn't called from a signal handler,
195 which is unsafe because the interpreter isn't reentrant. */
199 /* Function to process declarations in defmacro forms. */
201 Lisp_Object Vmacro_declaration_function
;
203 extern Lisp_Object Qrisky_local_variable
;
205 static Lisp_Object funcall_lambda
P_ ((Lisp_Object
, int, Lisp_Object
*));
206 static void unwind_to_catch
P_ ((struct catchtag
*, Lisp_Object
)) NO_RETURN
;
209 /* "gcc -O3" enables automatic function inlining, which optimizes out
210 the arguments for the invocations of these functions, whereas they
211 expect these values on the stack. */
212 Lisp_Object
apply1 () __attribute__((noinline
));
213 Lisp_Object
call2 () __attribute__((noinline
));
220 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
221 specpdl_ptr
= specpdl
;
222 /* Don't forget to update docs (lispref node "Local Variables"). */
223 max_specpdl_size
= 1000;
224 max_lisp_eval_depth
= 400;
232 specpdl_ptr
= specpdl
;
237 debug_on_next_call
= 0;
242 /* This is less than the initial value of num_nonmacro_input_events. */
243 when_entered_debugger
= -1;
246 /* unwind-protect function used by call_debugger. */
249 restore_stack_limits (data
)
252 max_specpdl_size
= XINT (XCAR (data
));
253 max_lisp_eval_depth
= XINT (XCDR (data
));
257 /* Call the Lisp debugger, giving it argument ARG. */
263 int debug_while_redisplaying
;
264 int count
= SPECPDL_INDEX ();
266 int old_max
= max_specpdl_size
;
268 /* Temporarily bump up the stack limits,
269 so the debugger won't run out of stack. */
271 max_specpdl_size
+= 1;
272 record_unwind_protect (restore_stack_limits
,
273 Fcons (make_number (old_max
),
274 make_number (max_lisp_eval_depth
)));
275 max_specpdl_size
= old_max
;
277 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
278 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
280 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
281 max_specpdl_size
= SPECPDL_INDEX () + 100;
283 #ifdef HAVE_X_WINDOWS
284 if (display_hourglass_p
)
288 debug_on_next_call
= 0;
289 when_entered_debugger
= num_nonmacro_input_events
;
291 /* Resetting redisplaying_p to 0 makes sure that debug output is
292 displayed if the debugger is invoked during redisplay. */
293 debug_while_redisplaying
= redisplaying_p
;
295 specbind (intern ("debugger-may-continue"),
296 debug_while_redisplaying
? Qnil
: Qt
);
297 specbind (Qinhibit_redisplay
, Qnil
);
298 specbind (Qdebug_on_error
, Qnil
);
300 #if 0 /* Binding this prevents execution of Lisp code during
301 redisplay, which necessarily leads to display problems. */
302 specbind (Qinhibit_eval_during_redisplay
, Qt
);
305 val
= apply1 (Vdebugger
, arg
);
307 /* Interrupting redisplay and resuming it later is not safe under
308 all circumstances. So, when the debugger returns, abort the
309 interrupted redisplay by going back to the top-level. */
310 if (debug_while_redisplaying
)
313 return unbind_to (count
, val
);
317 do_debug_on_call (code
)
320 debug_on_next_call
= 0;
321 backtrace_list
->debug_on_exit
= 1;
322 call_debugger (Fcons (code
, Qnil
));
325 /* NOTE!!! Every function that can call EVAL must protect its args
326 and temporaries from garbage collection while it needs them.
327 The definition of `For' shows what you have to do. */
329 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
330 doc
: /* Eval args until one of them yields non-nil, then return that value.
331 The remaining args are not evalled at all.
332 If all args return nil, return nil.
333 usage: (or CONDITIONS...) */)
337 register Lisp_Object val
= Qnil
;
344 val
= Feval (XCAR (args
));
354 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
355 doc
: /* Eval args until one of them yields nil, then return nil.
356 The remaining args are not evalled at all.
357 If no arg yields nil, return the last arg's value.
358 usage: (and CONDITIONS...) */)
362 register Lisp_Object val
= Qt
;
369 val
= Feval (XCAR (args
));
379 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
380 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
381 Returns the value of THEN or the value of the last of the ELSE's.
382 THEN must be one expression, but ELSE... can be zero or more expressions.
383 If COND yields nil, and there are no ELSE's, the value is nil.
384 usage: (if COND THEN ELSE...) */)
388 register Lisp_Object cond
;
392 cond
= Feval (Fcar (args
));
396 return Feval (Fcar (Fcdr (args
)));
397 return Fprogn (Fcdr (Fcdr (args
)));
400 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
401 doc
: /* Try each clause until one succeeds.
402 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
403 and, if the value is non-nil, this clause succeeds:
404 then the expressions in BODY are evaluated and the last one's
405 value is the value of the cond-form.
406 If no clause succeeds, cond returns nil.
407 If a clause has one element, as in (CONDITION),
408 CONDITION's value if non-nil is returned from the cond-form.
409 usage: (cond CLAUSES...) */)
413 register Lisp_Object clause
, val
;
420 clause
= Fcar (args
);
421 val
= Feval (Fcar (clause
));
424 if (!EQ (XCDR (clause
), Qnil
))
425 val
= Fprogn (XCDR (clause
));
435 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
436 doc
: /* Eval BODY forms sequentially and return value of last one.
437 usage: (progn BODY...) */)
441 register Lisp_Object val
= Qnil
;
448 val
= Feval (XCAR (args
));
456 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
457 doc
: /* Eval FIRST and BODY sequentially; value from FIRST.
458 The value of FIRST is saved during the evaluation of the remaining args,
459 whose values are discarded.
460 usage: (prog1 FIRST BODY...) */)
465 register Lisp_Object args_left
;
466 struct gcpro gcpro1
, gcpro2
;
467 register int argnum
= 0;
479 val
= Feval (Fcar (args_left
));
481 Feval (Fcar (args_left
));
482 args_left
= Fcdr (args_left
);
484 while (!NILP(args_left
));
490 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
491 doc
: /* Eval FORM1, FORM2 and BODY sequentially; value from FORM2.
492 The value of FORM2 is saved during the evaluation of the
493 remaining args, whose values are discarded.
494 usage: (prog2 FORM1 FORM2 BODY...) */)
499 register Lisp_Object args_left
;
500 struct gcpro gcpro1
, gcpro2
;
501 register int argnum
= -1;
515 val
= Feval (Fcar (args_left
));
517 Feval (Fcar (args_left
));
518 args_left
= Fcdr (args_left
);
520 while (!NILP (args_left
));
526 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
527 doc
: /* Set each SYM to the value of its VAL.
528 The symbols SYM are variables; they are literal (not evaluated).
529 The values VAL are expressions; they are evaluated.
530 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
531 The second VAL is not computed until after the first SYM is set, and so on;
532 each VAL can use the new value of variables set earlier in the `setq'.
533 The return value of the `setq' form is the value of the last VAL.
534 usage: (setq [SYM VAL]...) */)
538 register Lisp_Object args_left
;
539 register Lisp_Object val
, sym
;
550 val
= Feval (Fcar (Fcdr (args_left
)));
551 sym
= Fcar (args_left
);
553 args_left
= Fcdr (Fcdr (args_left
));
555 while (!NILP(args_left
));
561 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
562 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
563 usage: (quote ARG) */)
570 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
571 doc
: /* Like `quote', but preferred for objects which are functions.
572 In byte compilation, `function' causes its argument to be compiled.
573 `quote' cannot do that.
574 usage: (function ARG) */)
582 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
583 doc
: /* Return t if the function was run directly by user input.
584 This means that the function was called with `call-interactively'
585 \(which includes being called as the binding of a key)
586 and input is currently coming from the keyboard (not in keyboard macro),
587 and Emacs is not running in batch mode (`noninteractive' is nil).
589 The only known proper use of `interactive-p' is in deciding whether to
590 display a helpful message, or how to display it. If you're thinking
591 of using it for any other purpose, it is quite likely that you're
592 making a mistake. Think: what do you want to do when the command is
593 called from a keyboard macro?
595 If you want to test whether your function was called with
596 `call-interactively', the way to do that is by adding an extra
597 optional argument, and making the `interactive' spec specify non-nil
598 unconditionally for that argument. (`p' is a good way to do this.) */)
601 return (INTERACTIVE
&& interactive_p (1)) ? Qt
: Qnil
;
605 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 0, 0,
606 doc
: /* Return t if the function using this was called with `call-interactively'.
607 This is used for implementing advice and other function-modifying
610 The cleanest way to test whether your function was called with
611 `call-interactively' is by adding an extra optional argument,
612 and making the `interactive' spec specify non-nil unconditionally
613 for that argument. (`p' is a good way to do this.) */)
616 return interactive_p (1) ? Qt
: Qnil
;
620 /* Return 1 if function in which this appears was called using
623 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
624 called is a built-in. */
627 interactive_p (exclude_subrs_p
)
630 struct backtrace
*btp
;
633 btp
= backtrace_list
;
635 /* If this isn't a byte-compiled function, there may be a frame at
636 the top for Finteractive_p. If so, skip it. */
637 fun
= Findirect_function (*btp
->function
, Qnil
);
638 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
639 || XSUBR (fun
) == &Scalled_interactively_p
))
642 /* If we're running an Emacs 18-style byte-compiled function, there
643 may be a frame for Fbytecode at the top level. In any version of
644 Emacs there can be Fbytecode frames for subexpressions evaluated
645 inside catch and condition-case. Skip past them.
647 If this isn't a byte-compiled function, then we may now be
648 looking at several frames for special forms. Skip past them. */
650 && (EQ (*btp
->function
, Qbytecode
)
651 || btp
->nargs
== UNEVALLED
))
654 /* btp now points at the frame of the innermost function that isn't
655 a special form, ignoring frames for Finteractive_p and/or
656 Fbytecode at the top. If this frame is for a built-in function
657 (such as load or eval-region) return nil. */
658 fun
= Findirect_function (*btp
->function
, Qnil
);
659 if (exclude_subrs_p
&& SUBRP (fun
))
662 /* btp points to the frame of a Lisp function that called interactive-p.
663 Return t if that function was called interactively. */
664 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
670 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
671 doc
: /* Define NAME as a function.
672 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
673 See also the function `interactive'.
674 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
678 register Lisp_Object fn_name
;
679 register Lisp_Object defn
;
681 fn_name
= Fcar (args
);
682 CHECK_SYMBOL (fn_name
);
683 defn
= Fcons (Qlambda
, Fcdr (args
));
684 if (!NILP (Vpurify_flag
))
685 defn
= Fpurecopy (defn
);
686 if (CONSP (XSYMBOL (fn_name
)->function
)
687 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
688 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
689 Ffset (fn_name
, defn
);
690 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
694 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
695 doc
: /* Define NAME as a macro.
696 The actual definition looks like
697 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
698 When the macro is called, as in (NAME ARGS...),
699 the function (lambda ARGLIST BODY...) is applied to
700 the list ARGS... as it appears in the expression,
701 and the result should be a form to be evaluated instead of the original.
703 DECL is a declaration, optional, which can specify how to indent
704 calls to this macro and how Edebug should handle it. It looks like this:
706 The elements can look like this:
708 Set NAME's `lisp-indent-function' property to INDENT.
711 Set NAME's `edebug-form-spec' property to DEBUG. (This is
712 equivalent to writing a `def-edebug-spec' for the macro.)
713 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
717 register Lisp_Object fn_name
;
718 register Lisp_Object defn
;
719 Lisp_Object lambda_list
, doc
, tail
;
721 fn_name
= Fcar (args
);
722 CHECK_SYMBOL (fn_name
);
723 lambda_list
= Fcar (Fcdr (args
));
724 tail
= Fcdr (Fcdr (args
));
727 if (STRINGP (Fcar (tail
)))
733 while (CONSP (Fcar (tail
))
734 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
736 if (!NILP (Vmacro_declaration_function
))
740 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
748 tail
= Fcons (lambda_list
, tail
);
750 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
751 defn
= Fcons (Qmacro
, Fcons (Qlambda
, tail
));
753 if (!NILP (Vpurify_flag
))
754 defn
= Fpurecopy (defn
);
755 if (CONSP (XSYMBOL (fn_name
)->function
)
756 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
757 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
758 Ffset (fn_name
, defn
);
759 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
764 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
765 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
766 Aliased variables always have the same value; setting one sets the other.
767 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
768 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
769 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
771 The return value is BASE-VARIABLE. */)
772 (new_alias
, base_variable
, docstring
)
773 Lisp_Object new_alias
, base_variable
, docstring
;
775 struct Lisp_Symbol
*sym
;
777 CHECK_SYMBOL (new_alias
);
778 CHECK_SYMBOL (base_variable
);
780 if (SYMBOL_CONSTANT_P (new_alias
))
781 error ("Cannot make a constant an alias");
783 sym
= XSYMBOL (new_alias
);
784 sym
->indirect_variable
= 1;
785 sym
->value
= base_variable
;
786 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
787 LOADHIST_ATTACH (new_alias
);
788 if (!NILP (docstring
))
789 Fput (new_alias
, Qvariable_documentation
, docstring
);
791 Fput (new_alias
, Qvariable_documentation
, Qnil
);
793 return base_variable
;
797 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
798 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
799 You are not required to define a variable in order to use it,
800 but the definition can supply documentation and an initial value
801 in a way that tags can recognize.
803 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
804 If SYMBOL is buffer-local, its default value is what is set;
805 buffer-local values are not affected.
806 INITVALUE and DOCSTRING are optional.
807 If DOCSTRING starts with *, this variable is identified as a user option.
808 This means that M-x set-variable recognizes it.
809 See also `user-variable-p'.
810 If INITVALUE is missing, SYMBOL's value is not set.
812 If SYMBOL has a local binding, then this form affects the local
813 binding. This is usually not what you want. Thus, if you need to
814 load a file defining variables, with this form or with `defconst' or
815 `defcustom', you should always load that file _outside_ any bindings
816 for these variables. \(`defconst' and `defcustom' behave similarly in
818 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
822 register Lisp_Object sym
, tem
, tail
;
826 if (!NILP (Fcdr (Fcdr (tail
))))
827 error ("Too many arguments");
829 tem
= Fdefault_boundp (sym
);
832 if (SYMBOL_CONSTANT_P (sym
))
834 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
835 Lisp_Object tem
= Fcar (tail
);
837 && EQ (XCAR (tem
), Qquote
)
838 && CONSP (XCDR (tem
))
839 && EQ (XCAR (XCDR (tem
)), sym
)))
840 error ("Constant symbol `%s' specified in defvar",
841 SDATA (SYMBOL_NAME (sym
)));
845 Fset_default (sym
, Feval (Fcar (tail
)));
847 { /* Check if there is really a global binding rather than just a let
848 binding that shadows the global unboundness of the var. */
849 volatile struct specbinding
*pdl
= specpdl_ptr
;
850 while (--pdl
>= specpdl
)
852 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
853 && EQ (pdl
->old_value
, Qunbound
))
855 message_with_string ("Warning: defvar ignored because %s is let-bound",
856 SYMBOL_NAME (sym
), 1);
865 if (!NILP (Vpurify_flag
))
866 tem
= Fpurecopy (tem
);
867 Fput (sym
, Qvariable_documentation
, tem
);
869 LOADHIST_ATTACH (sym
);
872 /* Simple (defvar <var>) should not count as a definition at all.
873 It could get in the way of other definitions, and unloading this
874 package could try to make the variable unbound. */
880 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
881 doc
: /* Define SYMBOL as a constant variable.
882 The intent is that neither programs nor users should ever change this value.
883 Always sets the value of SYMBOL to the result of evalling INITVALUE.
884 If SYMBOL is buffer-local, its default value is what is set;
885 buffer-local values are not affected.
886 DOCSTRING is optional.
888 If SYMBOL has a local binding, then this form sets the local binding's
889 value. However, you should normally not make local bindings for
890 variables defined with this form.
891 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
895 register Lisp_Object sym
, tem
;
898 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
899 error ("Too many arguments");
901 tem
= Feval (Fcar (Fcdr (args
)));
902 if (!NILP (Vpurify_flag
))
903 tem
= Fpurecopy (tem
);
904 Fset_default (sym
, tem
);
905 tem
= Fcar (Fcdr (Fcdr (args
)));
908 if (!NILP (Vpurify_flag
))
909 tem
= Fpurecopy (tem
);
910 Fput (sym
, Qvariable_documentation
, tem
);
912 Fput (sym
, Qrisky_local_variable
, Qt
);
913 LOADHIST_ATTACH (sym
);
917 /* Error handler used in Fuser_variable_p. */
919 user_variable_p_eh (ignore
)
925 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
926 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
927 \(The alternative is a variable used internally in a Lisp program.)
928 A variable is a user variable if
929 \(1) the first character of its documentation is `*', or
930 \(2) it is customizable (its property list contains a non-nil value
931 of `standard-value' or `custom-autoload'), or
932 \(3) it is an alias for another user variable.
933 Return nil if VARIABLE is an alias and there is a loop in the
934 chain of symbols. */)
936 Lisp_Object variable
;
938 Lisp_Object documentation
;
940 if (!SYMBOLP (variable
))
943 /* If indirect and there's an alias loop, don't check anything else. */
944 if (XSYMBOL (variable
)->indirect_variable
945 && NILP (internal_condition_case_1 (indirect_variable
, variable
,
946 Qt
, user_variable_p_eh
)))
951 documentation
= Fget (variable
, Qvariable_documentation
);
952 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
954 if (STRINGP (documentation
)
955 && ((unsigned char) SREF (documentation
, 0) == '*'))
957 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
958 if (CONSP (documentation
)
959 && STRINGP (XCAR (documentation
))
960 && INTEGERP (XCDR (documentation
))
961 && XINT (XCDR (documentation
)) < 0)
963 /* Customizable? See `custom-variable-p'. */
964 if ((!NILP (Fget (variable
, intern ("standard-value"))))
965 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
968 if (!XSYMBOL (variable
)->indirect_variable
)
971 /* An indirect variable? Let's follow the chain. */
972 variable
= XSYMBOL (variable
)->value
;
976 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
977 doc
: /* Bind variables according to VARLIST then eval BODY.
978 The value of the last form in BODY is returned.
979 Each element of VARLIST is a symbol (which is bound to nil)
980 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
981 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
982 usage: (let* VARLIST BODY...) */)
986 Lisp_Object varlist
, val
, elt
;
987 int count
= SPECPDL_INDEX ();
988 struct gcpro gcpro1
, gcpro2
, gcpro3
;
990 GCPRO3 (args
, elt
, varlist
);
992 varlist
= Fcar (args
);
993 while (!NILP (varlist
))
996 elt
= Fcar (varlist
);
998 specbind (elt
, Qnil
);
999 else if (! NILP (Fcdr (Fcdr (elt
))))
1000 signal_error ("`let' bindings can have only one value-form", elt
);
1003 val
= Feval (Fcar (Fcdr (elt
)));
1004 specbind (Fcar (elt
), val
);
1006 varlist
= Fcdr (varlist
);
1009 val
= Fprogn (Fcdr (args
));
1010 return unbind_to (count
, val
);
1013 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1014 doc
: /* Bind variables according to VARLIST then eval BODY.
1015 The value of the last form in BODY is returned.
1016 Each element of VARLIST is a symbol (which is bound to nil)
1017 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1018 All the VALUEFORMs are evalled before any symbols are bound.
1019 usage: (let VARLIST BODY...) */)
1023 Lisp_Object
*temps
, tem
;
1024 register Lisp_Object elt
, varlist
;
1025 int count
= SPECPDL_INDEX ();
1026 register int argnum
;
1027 struct gcpro gcpro1
, gcpro2
;
1029 varlist
= Fcar (args
);
1031 /* Make space to hold the values to give the bound variables */
1032 elt
= Flength (varlist
);
1033 temps
= (Lisp_Object
*) alloca (XFASTINT (elt
) * sizeof (Lisp_Object
));
1035 /* Compute the values and store them in `temps' */
1037 GCPRO2 (args
, *temps
);
1040 for (argnum
= 0; !NILP (varlist
); varlist
= Fcdr (varlist
))
1043 elt
= Fcar (varlist
);
1045 temps
[argnum
++] = Qnil
;
1046 else if (! NILP (Fcdr (Fcdr (elt
))))
1047 signal_error ("`let' bindings can have only one value-form", elt
);
1049 temps
[argnum
++] = Feval (Fcar (Fcdr (elt
)));
1050 gcpro2
.nvars
= argnum
;
1054 varlist
= Fcar (args
);
1055 for (argnum
= 0; !NILP (varlist
); varlist
= Fcdr (varlist
))
1057 elt
= Fcar (varlist
);
1058 tem
= temps
[argnum
++];
1060 specbind (elt
, tem
);
1062 specbind (Fcar (elt
), tem
);
1065 elt
= Fprogn (Fcdr (args
));
1066 return unbind_to (count
, elt
);
1069 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1070 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1071 The order of execution is thus TEST, BODY, TEST, BODY and so on
1072 until TEST returns nil.
1073 usage: (while TEST BODY...) */)
1077 Lisp_Object test
, body
;
1078 struct gcpro gcpro1
, gcpro2
;
1080 GCPRO2 (test
, body
);
1084 while (!NILP (Feval (test
)))
1094 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1095 doc
: /* Return result of expanding macros at top level of FORM.
1096 If FORM is not a macro call, it is returned unchanged.
1097 Otherwise, the macro is expanded and the expansion is considered
1098 in place of FORM. When a non-macro-call results, it is returned.
1100 The second optional arg ENVIRONMENT specifies an environment of macro
1101 definitions to shadow the loaded ones for use in file byte-compilation. */)
1104 Lisp_Object environment
;
1106 /* With cleanups from Hallvard Furuseth. */
1107 register Lisp_Object expander
, sym
, def
, tem
;
1111 /* Come back here each time we expand a macro call,
1112 in case it expands into another macro call. */
1115 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1116 def
= sym
= XCAR (form
);
1118 /* Trace symbols aliases to other symbols
1119 until we get a symbol that is not an alias. */
1120 while (SYMBOLP (def
))
1124 tem
= Fassq (sym
, environment
);
1127 def
= XSYMBOL (sym
)->function
;
1128 if (!EQ (def
, Qunbound
))
1133 /* Right now TEM is the result from SYM in ENVIRONMENT,
1134 and if TEM is nil then DEF is SYM's function definition. */
1137 /* SYM is not mentioned in ENVIRONMENT.
1138 Look at its function definition. */
1139 if (EQ (def
, Qunbound
) || !CONSP (def
))
1140 /* Not defined or definition not suitable */
1142 if (EQ (XCAR (def
), Qautoload
))
1144 /* Autoloading function: will it be a macro when loaded? */
1145 tem
= Fnth (make_number (4), def
);
1146 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1147 /* Yes, load it and try again. */
1149 struct gcpro gcpro1
;
1151 do_autoload (def
, sym
);
1158 else if (!EQ (XCAR (def
), Qmacro
))
1160 else expander
= XCDR (def
);
1164 expander
= XCDR (tem
);
1165 if (NILP (expander
))
1168 form
= apply1 (expander
, XCDR (form
));
1173 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1174 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1175 TAG is evalled to get the tag to use; it must not be nil.
1177 Then the BODY is executed.
1178 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1179 If no throw happens, `catch' returns the value of the last BODY form.
1180 If a throw happens, it specifies the value to return from `catch'.
1181 usage: (catch TAG BODY...) */)
1185 register Lisp_Object tag
;
1186 struct gcpro gcpro1
;
1189 tag
= Feval (Fcar (args
));
1191 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1194 /* Set up a catch, then call C function FUNC on argument ARG.
1195 FUNC should return a Lisp_Object.
1196 This is how catches are done from within C code. */
1199 internal_catch (tag
, func
, arg
)
1201 Lisp_Object (*func
) ();
1204 /* This structure is made part of the chain `catchlist'. */
1207 /* Fill in the components of c, and put it on the list. */
1211 c
.backlist
= backtrace_list
;
1212 c
.handlerlist
= handlerlist
;
1213 c
.lisp_eval_depth
= lisp_eval_depth
;
1214 c
.pdlcount
= SPECPDL_INDEX ();
1215 c
.poll_suppress_count
= poll_suppress_count
;
1216 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1217 c
.gcpro
= gcprolist
;
1218 c
.byte_stack
= byte_stack_list
;
1222 if (! _setjmp (c
.jmp
))
1223 c
.val
= (*func
) (arg
);
1225 /* Throw works by a longjmp that comes right here. */
1230 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1231 jump to that CATCH, returning VALUE as the value of that catch.
1233 This is the guts Fthrow and Fsignal; they differ only in the way
1234 they choose the catch tag to throw to. A catch tag for a
1235 condition-case form has a TAG of Qnil.
1237 Before each catch is discarded, unbind all special bindings and
1238 execute all unwind-protect clauses made above that catch. Unwind
1239 the handler stack as we go, so that the proper handlers are in
1240 effect for each unwind-protect clause we run. At the end, restore
1241 some static info saved in CATCH, and longjmp to the location
1244 This is used for correct unwinding in Fthrow and Fsignal. */
1247 unwind_to_catch (catch, value
)
1248 struct catchtag
*catch;
1251 register int last_time
;
1253 /* Save the value in the tag. */
1256 /* Restore certain special C variables. */
1257 set_poll_suppress_count (catch->poll_suppress_count
);
1258 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1259 handling_signal
= 0;
1264 last_time
= catchlist
== catch;
1266 /* Unwind the specpdl stack, and then restore the proper set of
1268 unbind_to (catchlist
->pdlcount
, Qnil
);
1269 handlerlist
= catchlist
->handlerlist
;
1270 catchlist
= catchlist
->next
;
1272 while (! last_time
);
1275 /* If x_catch_errors was done, turn it off now.
1276 (First we give unbind_to a chance to do that.) */
1277 x_fully_uncatch_errors ();
1280 byte_stack_list
= catch->byte_stack
;
1281 gcprolist
= catch->gcpro
;
1284 gcpro_level
= gcprolist
->level
+ 1;
1288 backtrace_list
= catch->backlist
;
1289 lisp_eval_depth
= catch->lisp_eval_depth
;
1291 _longjmp (catch->jmp
, 1);
1294 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1295 doc
: /* Throw to the catch for TAG and return VALUE from it.
1296 Both TAG and VALUE are evalled. */)
1298 register Lisp_Object tag
, value
;
1300 register struct catchtag
*c
;
1303 for (c
= catchlist
; c
; c
= c
->next
)
1305 if (EQ (c
->tag
, tag
))
1306 unwind_to_catch (c
, value
);
1308 xsignal2 (Qno_catch
, tag
, value
);
1312 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1313 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1314 If BODYFORM completes normally, its value is returned
1315 after executing the UNWINDFORMS.
1316 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1317 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1322 int count
= SPECPDL_INDEX ();
1324 record_unwind_protect (Fprogn
, Fcdr (args
));
1325 val
= Feval (Fcar (args
));
1326 return unbind_to (count
, val
);
1329 /* Chain of condition handlers currently in effect.
1330 The elements of this chain are contained in the stack frames
1331 of Fcondition_case and internal_condition_case.
1332 When an error is signaled (by calling Fsignal, below),
1333 this chain is searched for an element that applies. */
1335 struct handler
*handlerlist
;
1337 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1338 doc
: /* Regain control when an error is signaled.
1339 Executes BODYFORM and returns its value if no error happens.
1340 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1341 where the BODY is made of Lisp expressions.
1343 A handler is applicable to an error
1344 if CONDITION-NAME is one of the error's condition names.
1345 If an error happens, the first applicable handler is run.
1347 The car of a handler may be a list of condition names
1348 instead of a single condition name. Then it handles all of them.
1350 When a handler handles an error, control returns to the `condition-case'
1351 and it executes the handler's BODY...
1352 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA) from the error.
1353 (If VAR is nil, the handler can't access that information.)
1354 Then the value of the last BODY form is returned from the `condition-case'
1357 See also the function `signal' for more info.
1358 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1362 register Lisp_Object bodyform
, handlers
;
1363 volatile Lisp_Object var
;
1366 bodyform
= Fcar (Fcdr (args
));
1367 handlers
= Fcdr (Fcdr (args
));
1369 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1372 /* Like Fcondition_case, but the args are separate
1373 rather than passed in a list. Used by Fbyte_code. */
1376 internal_lisp_condition_case (var
, bodyform
, handlers
)
1377 volatile Lisp_Object var
;
1378 Lisp_Object bodyform
, handlers
;
1386 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1392 && (SYMBOLP (XCAR (tem
))
1393 || CONSP (XCAR (tem
))))))
1394 error ("Invalid condition handler", tem
);
1399 c
.backlist
= backtrace_list
;
1400 c
.handlerlist
= handlerlist
;
1401 c
.lisp_eval_depth
= lisp_eval_depth
;
1402 c
.pdlcount
= SPECPDL_INDEX ();
1403 c
.poll_suppress_count
= poll_suppress_count
;
1404 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1405 c
.gcpro
= gcprolist
;
1406 c
.byte_stack
= byte_stack_list
;
1407 if (_setjmp (c
.jmp
))
1410 specbind (h
.var
, c
.val
);
1411 val
= Fprogn (Fcdr (h
.chosen_clause
));
1413 /* Note that this just undoes the binding of h.var; whoever
1414 longjumped to us unwound the stack to c.pdlcount before
1416 unbind_to (c
.pdlcount
, Qnil
);
1423 h
.handler
= handlers
;
1424 h
.next
= handlerlist
;
1428 val
= Feval (bodyform
);
1430 handlerlist
= h
.next
;
1434 /* Call the function BFUN with no arguments, catching errors within it
1435 according to HANDLERS. If there is an error, call HFUN with
1436 one argument which is the data that describes the error:
1439 HANDLERS can be a list of conditions to catch.
1440 If HANDLERS is Qt, catch all errors.
1441 If HANDLERS is Qerror, catch all errors
1442 but allow the debugger to run if that is enabled. */
1445 internal_condition_case (bfun
, handlers
, hfun
)
1446 Lisp_Object (*bfun
) ();
1447 Lisp_Object handlers
;
1448 Lisp_Object (*hfun
) ();
1454 /* Since Fsignal will close off all calls to x_catch_errors,
1455 we will get the wrong results if some are not closed now. */
1457 if (x_catching_errors ())
1463 c
.backlist
= backtrace_list
;
1464 c
.handlerlist
= handlerlist
;
1465 c
.lisp_eval_depth
= lisp_eval_depth
;
1466 c
.pdlcount
= SPECPDL_INDEX ();
1467 c
.poll_suppress_count
= poll_suppress_count
;
1468 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1469 c
.gcpro
= gcprolist
;
1470 c
.byte_stack
= byte_stack_list
;
1471 if (_setjmp (c
.jmp
))
1473 return (*hfun
) (c
.val
);
1477 h
.handler
= handlers
;
1479 h
.next
= handlerlist
;
1485 handlerlist
= h
.next
;
1489 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1492 internal_condition_case_1 (bfun
, arg
, handlers
, hfun
)
1493 Lisp_Object (*bfun
) ();
1495 Lisp_Object handlers
;
1496 Lisp_Object (*hfun
) ();
1502 /* Since Fsignal will close off all calls to x_catch_errors,
1503 we will get the wrong results if some are not closed now. */
1505 if (x_catching_errors ())
1511 c
.backlist
= backtrace_list
;
1512 c
.handlerlist
= handlerlist
;
1513 c
.lisp_eval_depth
= lisp_eval_depth
;
1514 c
.pdlcount
= SPECPDL_INDEX ();
1515 c
.poll_suppress_count
= poll_suppress_count
;
1516 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1517 c
.gcpro
= gcprolist
;
1518 c
.byte_stack
= byte_stack_list
;
1519 if (_setjmp (c
.jmp
))
1521 return (*hfun
) (c
.val
);
1525 h
.handler
= handlers
;
1527 h
.next
= handlerlist
;
1531 val
= (*bfun
) (arg
);
1533 handlerlist
= h
.next
;
1538 /* Like internal_condition_case but call BFUN with NARGS as first,
1539 and ARGS as second argument. */
1542 internal_condition_case_2 (bfun
, nargs
, args
, handlers
, hfun
)
1543 Lisp_Object (*bfun
) ();
1546 Lisp_Object handlers
;
1547 Lisp_Object (*hfun
) ();
1553 /* Since Fsignal will close off all calls to x_catch_errors,
1554 we will get the wrong results if some are not closed now. */
1556 if (x_catching_errors ())
1562 c
.backlist
= backtrace_list
;
1563 c
.handlerlist
= handlerlist
;
1564 c
.lisp_eval_depth
= lisp_eval_depth
;
1565 c
.pdlcount
= SPECPDL_INDEX ();
1566 c
.poll_suppress_count
= poll_suppress_count
;
1567 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1568 c
.gcpro
= gcprolist
;
1569 c
.byte_stack
= byte_stack_list
;
1570 if (_setjmp (c
.jmp
))
1572 return (*hfun
) (c
.val
);
1576 h
.handler
= handlers
;
1578 h
.next
= handlerlist
;
1582 val
= (*bfun
) (nargs
, args
);
1584 handlerlist
= h
.next
;
1589 static Lisp_Object find_handler_clause
P_ ((Lisp_Object
, Lisp_Object
,
1590 Lisp_Object
, Lisp_Object
,
1593 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1594 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1595 This function does not return.
1597 An error symbol is a symbol with an `error-conditions' property
1598 that is a list of condition names.
1599 A handler for any of those names will get to handle this signal.
1600 The symbol `error' should normally be one of them.
1602 DATA should be a list. Its elements are printed as part of the error message.
1603 See Info anchor `(elisp)Definition of signal' for some details on how this
1604 error message is constructed.
1605 If the signal is handled, DATA is made available to the handler.
1606 See also the function `condition-case'. */)
1607 (error_symbol
, data
)
1608 Lisp_Object error_symbol
, data
;
1610 /* When memory is full, ERROR-SYMBOL is nil,
1611 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1612 That is a special case--don't do this in other situations. */
1613 register struct handler
*allhandlers
= handlerlist
;
1614 Lisp_Object conditions
;
1615 extern int gc_in_progress
;
1616 extern int waiting_for_input
;
1617 Lisp_Object debugger_value
;
1619 Lisp_Object real_error_symbol
;
1620 struct backtrace
*bp
;
1622 immediate_quit
= handling_signal
= 0;
1624 if (gc_in_progress
|| waiting_for_input
)
1627 if (NILP (error_symbol
))
1628 real_error_symbol
= Fcar (data
);
1630 real_error_symbol
= error_symbol
;
1632 #if 0 /* rms: I don't know why this was here,
1633 but it is surely wrong for an error that is handled. */
1634 #ifdef HAVE_X_WINDOWS
1635 if (display_hourglass_p
)
1636 cancel_hourglass ();
1640 /* This hook is used by edebug. */
1641 if (! NILP (Vsignal_hook_function
)
1642 && ! NILP (error_symbol
))
1644 /* Edebug takes care of restoring these variables when it exits. */
1645 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1646 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1648 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1649 max_specpdl_size
= SPECPDL_INDEX () + 40;
1651 call2 (Vsignal_hook_function
, error_symbol
, data
);
1654 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1656 /* Remember from where signal was called. Skip over the frame for
1657 `signal' itself. If a frame for `error' follows, skip that,
1658 too. Don't do this when ERROR_SYMBOL is nil, because that
1659 is a memory-full error. */
1660 Vsignaling_function
= Qnil
;
1661 if (backtrace_list
&& !NILP (error_symbol
))
1663 bp
= backtrace_list
->next
;
1664 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1666 if (bp
&& bp
->function
)
1667 Vsignaling_function
= *bp
->function
;
1670 for (; handlerlist
; handlerlist
= handlerlist
->next
)
1672 register Lisp_Object clause
;
1674 clause
= find_handler_clause (handlerlist
->handler
, conditions
,
1675 error_symbol
, data
, &debugger_value
);
1677 if (EQ (clause
, Qlambda
))
1679 /* We can't return values to code which signaled an error, but we
1680 can continue code which has signaled a quit. */
1681 if (EQ (real_error_symbol
, Qquit
))
1684 error ("Cannot return from the debugger in an error");
1689 Lisp_Object unwind_data
;
1690 struct handler
*h
= handlerlist
;
1692 handlerlist
= allhandlers
;
1694 if (NILP (error_symbol
))
1697 unwind_data
= Fcons (error_symbol
, data
);
1698 h
->chosen_clause
= clause
;
1699 unwind_to_catch (h
->tag
, unwind_data
);
1703 handlerlist
= allhandlers
;
1704 /* If no handler is present now, try to run the debugger,
1705 and if that fails, throw to top level. */
1706 find_handler_clause (Qerror
, conditions
, error_symbol
, data
, &debugger_value
);
1708 Fthrow (Qtop_level
, Qt
);
1710 if (! NILP (error_symbol
))
1711 data
= Fcons (error_symbol
, data
);
1713 string
= Ferror_message_string (data
);
1714 fatal ("%s", SDATA (string
), 0);
1717 /* Internal version of Fsignal that never returns.
1718 Used for anything but Qquit (which can return from Fsignal). */
1721 xsignal (error_symbol
, data
)
1722 Lisp_Object error_symbol
, data
;
1724 Fsignal (error_symbol
, data
);
1728 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1731 xsignal0 (error_symbol
)
1732 Lisp_Object error_symbol
;
1734 xsignal (error_symbol
, Qnil
);
1738 xsignal1 (error_symbol
, arg
)
1739 Lisp_Object error_symbol
, arg
;
1741 xsignal (error_symbol
, list1 (arg
));
1745 xsignal2 (error_symbol
, arg1
, arg2
)
1746 Lisp_Object error_symbol
, arg1
, arg2
;
1748 xsignal (error_symbol
, list2 (arg1
, arg2
));
1752 xsignal3 (error_symbol
, arg1
, arg2
, arg3
)
1753 Lisp_Object error_symbol
, arg1
, arg2
, arg3
;
1755 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1758 /* Signal `error' with message S, and additional arg ARG.
1759 If ARG is not a genuine list, make it a one-element list. */
1762 signal_error (s
, arg
)
1766 Lisp_Object tortoise
, hare
;
1768 hare
= tortoise
= arg
;
1769 while (CONSP (hare
))
1776 tortoise
= XCDR (tortoise
);
1778 if (EQ (hare
, tortoise
))
1783 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1785 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1789 /* Return nonzero if LIST is a non-nil atom or
1790 a list containing one of CONDITIONS. */
1793 wants_debugger (list
, conditions
)
1794 Lisp_Object list
, conditions
;
1801 while (CONSP (conditions
))
1803 Lisp_Object
this, tail
;
1804 this = XCAR (conditions
);
1805 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1806 if (EQ (XCAR (tail
), this))
1808 conditions
= XCDR (conditions
);
1813 /* Return 1 if an error with condition-symbols CONDITIONS,
1814 and described by SIGNAL-DATA, should skip the debugger
1815 according to debugger-ignored-errors. */
1818 skip_debugger (conditions
, data
)
1819 Lisp_Object conditions
, data
;
1822 int first_string
= 1;
1823 Lisp_Object error_message
;
1825 error_message
= Qnil
;
1826 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1828 if (STRINGP (XCAR (tail
)))
1832 error_message
= Ferror_message_string (data
);
1836 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1841 Lisp_Object contail
;
1843 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1844 if (EQ (XCAR (tail
), XCAR (contail
)))
1852 /* Value of Qlambda means we have called debugger and user has continued.
1853 There are two ways to pass SIG and DATA:
1854 = SIG is the error symbol, and DATA is the rest of the data.
1855 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1856 This is for memory-full errors only.
1858 Store value returned from debugger into *DEBUGGER_VALUE_PTR.
1860 We need to increase max_specpdl_size temporarily around
1861 anything we do that can push on the specpdl, so as not to get
1862 a second error here in case we're handling specpdl overflow. */
1865 find_handler_clause (handlers
, conditions
, sig
, data
, debugger_value_ptr
)
1866 Lisp_Object handlers
, conditions
, sig
, data
;
1867 Lisp_Object
*debugger_value_ptr
;
1869 register Lisp_Object h
;
1870 register Lisp_Object tem
;
1872 if (EQ (handlers
, Qt
)) /* t is used by handlers for all conditions, set up by C code. */
1874 /* error is used similarly, but means print an error message
1875 and run the debugger if that is enabled. */
1876 if (EQ (handlers
, Qerror
)
1877 || !NILP (Vdebug_on_signal
)) /* This says call debugger even if
1878 there is a handler. */
1880 int debugger_called
= 0;
1881 Lisp_Object sig_symbol
, combined_data
;
1882 /* This is set to 1 if we are handling a memory-full error,
1883 because these must not run the debugger.
1884 (There is no room in memory to do that!) */
1885 int no_debugger
= 0;
1889 combined_data
= data
;
1890 sig_symbol
= Fcar (data
);
1895 combined_data
= Fcons (sig
, data
);
1899 if (wants_debugger (Vstack_trace_on_error
, conditions
))
1903 internal_with_output_to_temp_buffer ("*Backtrace*",
1904 (Lisp_Object (*) (Lisp_Object
)) Fbacktrace
,
1907 internal_with_output_to_temp_buffer ("*Backtrace*",
1913 /* Don't try to run the debugger with interrupts blocked.
1914 The editing loop would return anyway. */
1915 && ! INPUT_BLOCKED_P
1916 && (EQ (sig_symbol
, Qquit
)
1918 : wants_debugger (Vdebug_on_error
, conditions
))
1919 && ! skip_debugger (conditions
, combined_data
)
1920 && when_entered_debugger
< num_nonmacro_input_events
)
1923 = call_debugger (Fcons (Qerror
,
1924 Fcons (combined_data
, Qnil
)));
1925 debugger_called
= 1;
1927 /* If there is no handler, return saying whether we ran the debugger. */
1928 if (EQ (handlers
, Qerror
))
1930 if (debugger_called
)
1935 for (h
= handlers
; CONSP (h
); h
= Fcdr (h
))
1937 Lisp_Object handler
, condit
;
1940 if (!CONSP (handler
))
1942 condit
= Fcar (handler
);
1943 /* Handle a single condition name in handler HANDLER. */
1944 if (SYMBOLP (condit
))
1946 tem
= Fmemq (Fcar (handler
), conditions
);
1950 /* Handle a list of condition names in handler HANDLER. */
1951 else if (CONSP (condit
))
1953 while (CONSP (condit
))
1955 tem
= Fmemq (Fcar (condit
), conditions
);
1958 condit
= XCDR (condit
);
1965 /* dump an error message; called like printf */
1969 error (m
, a1
, a2
, a3
)
1989 int used
= doprnt (buffer
, size
, m
, m
+ mlen
, 3, args
);
1994 buffer
= (char *) xrealloc (buffer
, size
);
1997 buffer
= (char *) xmalloc (size
);
2002 string
= build_string (buffer
);
2006 xsignal1 (Qerror
, string
);
2009 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2010 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2011 This means it contains a description for how to read arguments to give it.
2012 The value is nil for an invalid function or a symbol with no function
2015 Interactively callable functions include strings and vectors (treated
2016 as keyboard macros), lambda-expressions that contain a top-level call
2017 to `interactive', autoload definitions made by `autoload' with non-nil
2018 fourth argument, and some of the built-in functions of Lisp.
2020 Also, a symbol satisfies `commandp' if its function definition does so.
2022 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2023 then strings and vectors are not accepted. */)
2024 (function
, for_call_interactively
)
2025 Lisp_Object function
, for_call_interactively
;
2027 register Lisp_Object fun
;
2028 register Lisp_Object funcar
;
2032 fun
= indirect_function (fun
);
2033 if (EQ (fun
, Qunbound
))
2036 /* Emacs primitives are interactive if their DEFUN specifies an
2037 interactive spec. */
2040 if (XSUBR (fun
)->prompt
)
2046 /* Bytecode objects are interactive if they are long enough to
2047 have an element whose index is COMPILED_INTERACTIVE, which is
2048 where the interactive spec is stored. */
2049 else if (COMPILEDP (fun
))
2050 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2053 /* Strings and vectors are keyboard macros. */
2054 if (NILP (for_call_interactively
) && (STRINGP (fun
) || VECTORP (fun
)))
2057 /* Lists may represent commands. */
2060 funcar
= XCAR (fun
);
2061 if (EQ (funcar
, Qlambda
))
2062 return Fassq (Qinteractive
, Fcdr (XCDR (fun
)));
2063 if (EQ (funcar
, Qautoload
))
2064 return Fcar (Fcdr (Fcdr (XCDR (fun
))));
2070 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2071 doc
: /* Define FUNCTION to autoload from FILE.
2072 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2073 Third arg DOCSTRING is documentation for the function.
2074 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2075 Fifth arg TYPE indicates the type of the object:
2076 nil or omitted says FUNCTION is a function,
2077 `keymap' says FUNCTION is really a keymap, and
2078 `macro' or t says FUNCTION is really a macro.
2079 Third through fifth args give info about the real definition.
2080 They default to nil.
2081 If FUNCTION is already defined other than as an autoload,
2082 this does nothing and returns nil. */)
2083 (function
, file
, docstring
, interactive
, type
)
2084 Lisp_Object function
, file
, docstring
, interactive
, type
;
2087 Lisp_Object args
[4];
2090 CHECK_SYMBOL (function
);
2091 CHECK_STRING (file
);
2093 /* If function is defined and not as an autoload, don't override */
2094 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2095 && !(CONSP (XSYMBOL (function
)->function
)
2096 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2099 if (NILP (Vpurify_flag
))
2100 /* Only add entries after dumping, because the ones before are
2101 not useful and else we get loads of them from the loaddefs.el. */
2102 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2106 args
[1] = docstring
;
2107 args
[2] = interactive
;
2110 return Ffset (function
, Fcons (Qautoload
, Flist (4, &args
[0])));
2111 #else /* NO_ARG_ARRAY */
2112 return Ffset (function
, Fcons (Qautoload
, Flist (4, &file
)));
2113 #endif /* not NO_ARG_ARRAY */
2117 un_autoload (oldqueue
)
2118 Lisp_Object oldqueue
;
2120 register Lisp_Object queue
, first
, second
;
2122 /* Queue to unwind is current value of Vautoload_queue.
2123 oldqueue is the shadowed value to leave in Vautoload_queue. */
2124 queue
= Vautoload_queue
;
2125 Vautoload_queue
= oldqueue
;
2126 while (CONSP (queue
))
2128 first
= XCAR (queue
);
2129 second
= Fcdr (first
);
2130 first
= Fcar (first
);
2131 if (EQ (first
, make_number (0)))
2134 Ffset (first
, second
);
2135 queue
= XCDR (queue
);
2140 /* Load an autoloaded function.
2141 FUNNAME is the symbol which is the function's name.
2142 FUNDEF is the autoload definition (a list). */
2145 do_autoload (fundef
, funname
)
2146 Lisp_Object fundef
, funname
;
2148 int count
= SPECPDL_INDEX ();
2150 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2152 /* This is to make sure that loadup.el gives a clear picture
2153 of what files are preloaded and when. */
2154 if (! NILP (Vpurify_flag
))
2155 error ("Attempt to autoload %s while preparing to dump",
2156 SDATA (SYMBOL_NAME (funname
)));
2159 CHECK_SYMBOL (funname
);
2160 GCPRO3 (fun
, funname
, fundef
);
2162 /* Preserve the match data. */
2163 record_unwind_save_match_data ();
2165 /* If autoloading gets an error (which includes the error of failing
2166 to define the function being called), we use Vautoload_queue
2167 to undo function definitions and `provide' calls made by
2168 the function. We do this in the specific case of autoloading
2169 because autoloading is not an explicit request "load this file",
2170 but rather a request to "call this function".
2172 The value saved here is to be restored into Vautoload_queue. */
2173 record_unwind_protect (un_autoload
, Vautoload_queue
);
2174 Vautoload_queue
= Qt
;
2175 Fload (Fcar (Fcdr (fundef
)), Qnil
, noninteractive
? Qt
: Qnil
, Qnil
, Qt
);
2177 /* Once loading finishes, don't undo it. */
2178 Vautoload_queue
= Qt
;
2179 unbind_to (count
, Qnil
);
2181 fun
= Findirect_function (fun
, Qnil
);
2183 if (!NILP (Fequal (fun
, fundef
)))
2184 error ("Autoloading failed to define function %s",
2185 SDATA (SYMBOL_NAME (funname
)));
2190 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2191 doc
: /* Evaluate FORM and return its value. */)
2195 Lisp_Object fun
, val
, original_fun
, original_args
;
2197 struct backtrace backtrace
;
2198 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2200 if (handling_signal
)
2204 return Fsymbol_value (form
);
2209 if ((consing_since_gc
> gc_cons_threshold
2210 && consing_since_gc
> gc_relative_threshold
)
2212 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2215 Fgarbage_collect ();
2219 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2221 if (max_lisp_eval_depth
< 100)
2222 max_lisp_eval_depth
= 100;
2223 if (lisp_eval_depth
> max_lisp_eval_depth
)
2224 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2227 original_fun
= Fcar (form
);
2228 original_args
= Fcdr (form
);
2230 backtrace
.next
= backtrace_list
;
2231 backtrace_list
= &backtrace
;
2232 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2233 backtrace
.args
= &original_args
;
2234 backtrace
.nargs
= UNEVALLED
;
2235 backtrace
.evalargs
= 1;
2236 backtrace
.debug_on_exit
= 0;
2238 if (debug_on_next_call
)
2239 do_debug_on_call (Qt
);
2241 /* At this point, only original_fun and original_args
2242 have values that will be used below */
2245 /* Optimize for no indirection. */
2247 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2248 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2249 fun
= indirect_function (fun
);
2253 Lisp_Object numargs
;
2254 Lisp_Object argvals
[8];
2255 Lisp_Object args_left
;
2256 register int i
, maxargs
;
2258 args_left
= original_args
;
2259 numargs
= Flength (args_left
);
2263 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2264 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2265 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2267 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2269 backtrace
.evalargs
= 0;
2270 val
= (*XSUBR (fun
)->function
) (args_left
);
2274 if (XSUBR (fun
)->max_args
== MANY
)
2276 /* Pass a vector of evaluated arguments */
2278 register int argnum
= 0;
2280 vals
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
2282 GCPRO3 (args_left
, fun
, fun
);
2286 while (!NILP (args_left
))
2288 vals
[argnum
++] = Feval (Fcar (args_left
));
2289 args_left
= Fcdr (args_left
);
2290 gcpro3
.nvars
= argnum
;
2293 backtrace
.args
= vals
;
2294 backtrace
.nargs
= XINT (numargs
);
2296 val
= (*XSUBR (fun
)->function
) (XINT (numargs
), vals
);
2301 GCPRO3 (args_left
, fun
, fun
);
2302 gcpro3
.var
= argvals
;
2305 maxargs
= XSUBR (fun
)->max_args
;
2306 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2308 argvals
[i
] = Feval (Fcar (args_left
));
2314 backtrace
.args
= argvals
;
2315 backtrace
.nargs
= XINT (numargs
);
2320 val
= (*XSUBR (fun
)->function
) ();
2323 val
= (*XSUBR (fun
)->function
) (argvals
[0]);
2326 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1]);
2329 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2333 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2334 argvals
[2], argvals
[3]);
2337 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2338 argvals
[3], argvals
[4]);
2341 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2342 argvals
[3], argvals
[4], argvals
[5]);
2345 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2346 argvals
[3], argvals
[4], argvals
[5],
2351 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2352 argvals
[3], argvals
[4], argvals
[5],
2353 argvals
[6], argvals
[7]);
2357 /* Someone has created a subr that takes more arguments than
2358 is supported by this code. We need to either rewrite the
2359 subr to use a different argument protocol, or add more
2360 cases to this switch. */
2364 if (COMPILEDP (fun
))
2365 val
= apply_lambda (fun
, original_args
, 1);
2368 if (EQ (fun
, Qunbound
))
2369 xsignal1 (Qvoid_function
, original_fun
);
2371 xsignal1 (Qinvalid_function
, original_fun
);
2372 funcar
= XCAR (fun
);
2373 if (!SYMBOLP (funcar
))
2374 xsignal1 (Qinvalid_function
, original_fun
);
2375 if (EQ (funcar
, Qautoload
))
2377 do_autoload (fun
, original_fun
);
2380 if (EQ (funcar
, Qmacro
))
2381 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2382 else if (EQ (funcar
, Qlambda
))
2383 val
= apply_lambda (fun
, original_args
, 1);
2385 xsignal1 (Qinvalid_function
, original_fun
);
2391 if (backtrace
.debug_on_exit
)
2392 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2393 backtrace_list
= backtrace
.next
;
2398 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2399 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2400 Then return the value FUNCTION returns.
2401 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2402 usage: (apply FUNCTION &rest ARGUMENTS) */)
2407 register int i
, numargs
;
2408 register Lisp_Object spread_arg
;
2409 register Lisp_Object
*funcall_args
;
2411 struct gcpro gcpro1
;
2415 spread_arg
= args
[nargs
- 1];
2416 CHECK_LIST (spread_arg
);
2418 numargs
= XINT (Flength (spread_arg
));
2421 return Ffuncall (nargs
- 1, args
);
2422 else if (numargs
== 1)
2424 args
[nargs
- 1] = XCAR (spread_arg
);
2425 return Ffuncall (nargs
, args
);
2428 numargs
+= nargs
- 2;
2430 /* Optimize for no indirection. */
2431 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2432 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2433 fun
= indirect_function (fun
);
2434 if (EQ (fun
, Qunbound
))
2436 /* Let funcall get the error */
2443 if (numargs
< XSUBR (fun
)->min_args
2444 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2445 goto funcall
; /* Let funcall get the error */
2446 else if (XSUBR (fun
)->max_args
> numargs
)
2448 /* Avoid making funcall cons up a yet another new vector of arguments
2449 by explicitly supplying nil's for optional values */
2450 funcall_args
= (Lisp_Object
*) alloca ((1 + XSUBR (fun
)->max_args
)
2451 * sizeof (Lisp_Object
));
2452 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2453 funcall_args
[++i
] = Qnil
;
2454 GCPRO1 (*funcall_args
);
2455 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2459 /* We add 1 to numargs because funcall_args includes the
2460 function itself as well as its arguments. */
2463 funcall_args
= (Lisp_Object
*) alloca ((1 + numargs
)
2464 * sizeof (Lisp_Object
));
2465 GCPRO1 (*funcall_args
);
2466 gcpro1
.nvars
= 1 + numargs
;
2469 bcopy (args
, funcall_args
, nargs
* sizeof (Lisp_Object
));
2470 /* Spread the last arg we got. Its first element goes in
2471 the slot that it used to occupy, hence this value of I. */
2473 while (!NILP (spread_arg
))
2475 funcall_args
[i
++] = XCAR (spread_arg
);
2476 spread_arg
= XCDR (spread_arg
);
2479 /* By convention, the caller needs to gcpro Ffuncall's args. */
2480 RETURN_UNGCPRO (Ffuncall (gcpro1
.nvars
, funcall_args
));
2483 /* Run hook variables in various ways. */
2485 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2486 static Lisp_Object run_hook_with_args
P_ ((int, Lisp_Object
*,
2487 enum run_hooks_condition
));
2489 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2490 doc
: /* Run each hook in HOOKS.
2491 Each argument should be a symbol, a hook variable.
2492 These symbols are processed in the order specified.
2493 If a hook symbol has a non-nil value, that value may be a function
2494 or a list of functions to be called to run the hook.
2495 If the value is a function, it is called with no arguments.
2496 If it is a list, the elements are called, in order, with no arguments.
2498 Major modes should not use this function directly to run their mode
2499 hook; they should use `run-mode-hooks' instead.
2501 Do not use `make-local-variable' to make a hook variable buffer-local.
2502 Instead, use `add-hook' and specify t for the LOCAL argument.
2503 usage: (run-hooks &rest HOOKS) */)
2508 Lisp_Object hook
[1];
2511 for (i
= 0; i
< nargs
; i
++)
2514 run_hook_with_args (1, hook
, to_completion
);
2520 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2521 Srun_hook_with_args
, 1, MANY
, 0,
2522 doc
: /* Run HOOK with the specified arguments ARGS.
2523 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2524 value, that value may be a function or a list of functions to be
2525 called to run the hook. If the value is a function, it is called with
2526 the given arguments and its return value is returned. If it is a list
2527 of functions, those functions are called, in order,
2528 with the given arguments ARGS.
2529 It is best not to depend on the value returned by `run-hook-with-args',
2532 Do not use `make-local-variable' to make a hook variable buffer-local.
2533 Instead, use `add-hook' and specify t for the LOCAL argument.
2534 usage: (run-hook-with-args HOOK &rest ARGS) */)
2539 return run_hook_with_args (nargs
, args
, to_completion
);
2542 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2543 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2544 doc
: /* Run HOOK with the specified arguments ARGS.
2545 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2546 value, that value may be a function or a list of functions to be
2547 called to run the hook. If the value is a function, it is called with
2548 the given arguments and its return value is returned.
2549 If it is a list of functions, those functions are called, in order,
2550 with the given arguments ARGS, until one of them
2551 returns a non-nil value. Then we return that value.
2552 However, if they all return nil, we return nil.
2554 Do not use `make-local-variable' to make a hook variable buffer-local.
2555 Instead, use `add-hook' and specify t for the LOCAL argument.
2556 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2561 return run_hook_with_args (nargs
, args
, until_success
);
2564 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2565 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2566 doc
: /* Run HOOK with the specified arguments ARGS.
2567 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2568 value, that value may be a function or a list of functions to be
2569 called to run the hook. If the value is a function, it is called with
2570 the given arguments and its return value is returned.
2571 If it is a list of functions, those functions are called, in order,
2572 with the given arguments ARGS, until one of them returns nil.
2573 Then we return nil. However, if they all return non-nil, we return non-nil.
2575 Do not use `make-local-variable' to make a hook variable buffer-local.
2576 Instead, use `add-hook' and specify t for the LOCAL argument.
2577 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2582 return run_hook_with_args (nargs
, args
, until_failure
);
2585 /* ARGS[0] should be a hook symbol.
2586 Call each of the functions in the hook value, passing each of them
2587 as arguments all the rest of ARGS (all NARGS - 1 elements).
2588 COND specifies a condition to test after each call
2589 to decide whether to stop.
2590 The caller (or its caller, etc) must gcpro all of ARGS,
2591 except that it isn't necessary to gcpro ARGS[0]. */
2594 run_hook_with_args (nargs
, args
, cond
)
2597 enum run_hooks_condition cond
;
2599 Lisp_Object sym
, val
, ret
;
2600 Lisp_Object globals
;
2601 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2603 /* If we are dying or still initializing,
2604 don't do anything--it would probably crash if we tried. */
2605 if (NILP (Vrun_hooks
))
2609 val
= find_symbol_value (sym
);
2610 ret
= (cond
== until_failure
? Qt
: Qnil
);
2612 if (EQ (val
, Qunbound
) || NILP (val
))
2614 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2617 return Ffuncall (nargs
, args
);
2622 GCPRO3 (sym
, val
, globals
);
2625 CONSP (val
) && ((cond
== to_completion
)
2626 || (cond
== until_success
? NILP (ret
)
2630 if (EQ (XCAR (val
), Qt
))
2632 /* t indicates this hook has a local binding;
2633 it means to run the global binding too. */
2635 for (globals
= Fdefault_value (sym
);
2636 CONSP (globals
) && ((cond
== to_completion
)
2637 || (cond
== until_success
? NILP (ret
)
2639 globals
= XCDR (globals
))
2641 args
[0] = XCAR (globals
);
2642 /* In a global value, t should not occur. If it does, we
2643 must ignore it to avoid an endless loop. */
2644 if (!EQ (args
[0], Qt
))
2645 ret
= Ffuncall (nargs
, args
);
2650 args
[0] = XCAR (val
);
2651 ret
= Ffuncall (nargs
, args
);
2660 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2661 present value of that symbol.
2662 Call each element of FUNLIST,
2663 passing each of them the rest of ARGS.
2664 The caller (or its caller, etc) must gcpro all of ARGS,
2665 except that it isn't necessary to gcpro ARGS[0]. */
2668 run_hook_list_with_args (funlist
, nargs
, args
)
2669 Lisp_Object funlist
;
2675 Lisp_Object globals
;
2676 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2680 GCPRO3 (sym
, val
, globals
);
2682 for (val
= funlist
; CONSP (val
); val
= XCDR (val
))
2684 if (EQ (XCAR (val
), Qt
))
2686 /* t indicates this hook has a local binding;
2687 it means to run the global binding too. */
2689 for (globals
= Fdefault_value (sym
);
2691 globals
= XCDR (globals
))
2693 args
[0] = XCAR (globals
);
2694 /* In a global value, t should not occur. If it does, we
2695 must ignore it to avoid an endless loop. */
2696 if (!EQ (args
[0], Qt
))
2697 Ffuncall (nargs
, args
);
2702 args
[0] = XCAR (val
);
2703 Ffuncall (nargs
, args
);
2710 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2713 run_hook_with_args_2 (hook
, arg1
, arg2
)
2714 Lisp_Object hook
, arg1
, arg2
;
2716 Lisp_Object temp
[3];
2721 Frun_hook_with_args (3, temp
);
2724 /* Apply fn to arg */
2727 Lisp_Object fn
, arg
;
2729 struct gcpro gcpro1
;
2733 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2737 Lisp_Object args
[2];
2741 RETURN_UNGCPRO (Fapply (2, args
));
2743 #else /* not NO_ARG_ARRAY */
2744 RETURN_UNGCPRO (Fapply (2, &fn
));
2745 #endif /* not NO_ARG_ARRAY */
2748 /* Call function fn on no arguments */
2753 struct gcpro gcpro1
;
2756 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2759 /* Call function fn with 1 argument arg1 */
2763 Lisp_Object fn
, arg1
;
2765 struct gcpro gcpro1
;
2767 Lisp_Object args
[2];
2773 RETURN_UNGCPRO (Ffuncall (2, args
));
2774 #else /* not NO_ARG_ARRAY */
2777 RETURN_UNGCPRO (Ffuncall (2, &fn
));
2778 #endif /* not NO_ARG_ARRAY */
2781 /* Call function fn with 2 arguments arg1, arg2 */
2784 call2 (fn
, arg1
, arg2
)
2785 Lisp_Object fn
, arg1
, arg2
;
2787 struct gcpro gcpro1
;
2789 Lisp_Object args
[3];
2795 RETURN_UNGCPRO (Ffuncall (3, args
));
2796 #else /* not NO_ARG_ARRAY */
2799 RETURN_UNGCPRO (Ffuncall (3, &fn
));
2800 #endif /* not NO_ARG_ARRAY */
2803 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2806 call3 (fn
, arg1
, arg2
, arg3
)
2807 Lisp_Object fn
, arg1
, arg2
, arg3
;
2809 struct gcpro gcpro1
;
2811 Lisp_Object args
[4];
2818 RETURN_UNGCPRO (Ffuncall (4, args
));
2819 #else /* not NO_ARG_ARRAY */
2822 RETURN_UNGCPRO (Ffuncall (4, &fn
));
2823 #endif /* not NO_ARG_ARRAY */
2826 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2829 call4 (fn
, arg1
, arg2
, arg3
, arg4
)
2830 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
;
2832 struct gcpro gcpro1
;
2834 Lisp_Object args
[5];
2842 RETURN_UNGCPRO (Ffuncall (5, args
));
2843 #else /* not NO_ARG_ARRAY */
2846 RETURN_UNGCPRO (Ffuncall (5, &fn
));
2847 #endif /* not NO_ARG_ARRAY */
2850 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2853 call5 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
)
2854 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
;
2856 struct gcpro gcpro1
;
2858 Lisp_Object args
[6];
2867 RETURN_UNGCPRO (Ffuncall (6, args
));
2868 #else /* not NO_ARG_ARRAY */
2871 RETURN_UNGCPRO (Ffuncall (6, &fn
));
2872 #endif /* not NO_ARG_ARRAY */
2875 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2878 call6 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
)
2879 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
;
2881 struct gcpro gcpro1
;
2883 Lisp_Object args
[7];
2893 RETURN_UNGCPRO (Ffuncall (7, args
));
2894 #else /* not NO_ARG_ARRAY */
2897 RETURN_UNGCPRO (Ffuncall (7, &fn
));
2898 #endif /* not NO_ARG_ARRAY */
2901 /* The caller should GCPRO all the elements of ARGS. */
2903 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2904 doc
: /* Call first argument as a function, passing remaining arguments to it.
2905 Return the value that function returns.
2906 Thus, (funcall 'cons 'x 'y) returns (x . y).
2907 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2912 Lisp_Object fun
, original_fun
;
2914 int numargs
= nargs
- 1;
2915 Lisp_Object lisp_numargs
;
2917 struct backtrace backtrace
;
2918 register Lisp_Object
*internal_args
;
2922 if ((consing_since_gc
> gc_cons_threshold
2923 && consing_since_gc
> gc_relative_threshold
)
2925 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2926 Fgarbage_collect ();
2928 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2930 if (max_lisp_eval_depth
< 100)
2931 max_lisp_eval_depth
= 100;
2932 if (lisp_eval_depth
> max_lisp_eval_depth
)
2933 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2936 backtrace
.next
= backtrace_list
;
2937 backtrace_list
= &backtrace
;
2938 backtrace
.function
= &args
[0];
2939 backtrace
.args
= &args
[1];
2940 backtrace
.nargs
= nargs
- 1;
2941 backtrace
.evalargs
= 0;
2942 backtrace
.debug_on_exit
= 0;
2944 if (debug_on_next_call
)
2945 do_debug_on_call (Qlambda
);
2949 original_fun
= args
[0];
2953 /* Optimize for no indirection. */
2955 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2956 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2957 fun
= indirect_function (fun
);
2961 if (numargs
< XSUBR (fun
)->min_args
2962 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2964 XSETFASTINT (lisp_numargs
, numargs
);
2965 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2968 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2969 xsignal1 (Qinvalid_function
, original_fun
);
2971 if (XSUBR (fun
)->max_args
== MANY
)
2973 val
= (*XSUBR (fun
)->function
) (numargs
, args
+ 1);
2977 if (XSUBR (fun
)->max_args
> numargs
)
2979 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
2980 bcopy (args
+ 1, internal_args
, numargs
* sizeof (Lisp_Object
));
2981 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2982 internal_args
[i
] = Qnil
;
2985 internal_args
= args
+ 1;
2986 switch (XSUBR (fun
)->max_args
)
2989 val
= (*XSUBR (fun
)->function
) ();
2992 val
= (*XSUBR (fun
)->function
) (internal_args
[0]);
2995 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1]);
2998 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3002 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3003 internal_args
[2], internal_args
[3]);
3006 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3007 internal_args
[2], internal_args
[3],
3011 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3012 internal_args
[2], internal_args
[3],
3013 internal_args
[4], internal_args
[5]);
3016 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3017 internal_args
[2], internal_args
[3],
3018 internal_args
[4], internal_args
[5],
3023 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3024 internal_args
[2], internal_args
[3],
3025 internal_args
[4], internal_args
[5],
3026 internal_args
[6], internal_args
[7]);
3031 /* If a subr takes more than 8 arguments without using MANY
3032 or UNEVALLED, we need to extend this function to support it.
3033 Until this is done, there is no way to call the function. */
3037 if (COMPILEDP (fun
))
3038 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3041 if (EQ (fun
, Qunbound
))
3042 xsignal1 (Qvoid_function
, original_fun
);
3044 xsignal1 (Qinvalid_function
, original_fun
);
3045 funcar
= XCAR (fun
);
3046 if (!SYMBOLP (funcar
))
3047 xsignal1 (Qinvalid_function
, original_fun
);
3048 if (EQ (funcar
, Qlambda
))
3049 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3050 else if (EQ (funcar
, Qautoload
))
3052 do_autoload (fun
, original_fun
);
3057 xsignal1 (Qinvalid_function
, original_fun
);
3062 if (backtrace
.debug_on_exit
)
3063 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3064 backtrace_list
= backtrace
.next
;
3069 apply_lambda (fun
, args
, eval_flag
)
3070 Lisp_Object fun
, args
;
3073 Lisp_Object args_left
;
3074 Lisp_Object numargs
;
3075 register Lisp_Object
*arg_vector
;
3076 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3078 register Lisp_Object tem
;
3080 numargs
= Flength (args
);
3081 arg_vector
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
3084 GCPRO3 (*arg_vector
, args_left
, fun
);
3087 for (i
= 0; i
< XINT (numargs
);)
3089 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3090 if (eval_flag
) tem
= Feval (tem
);
3091 arg_vector
[i
++] = tem
;
3099 backtrace_list
->args
= arg_vector
;
3100 backtrace_list
->nargs
= i
;
3102 backtrace_list
->evalargs
= 0;
3103 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
3105 /* Do the debug-on-exit now, while arg_vector still exists. */
3106 if (backtrace_list
->debug_on_exit
)
3107 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3108 /* Don't do it again when we return to eval. */
3109 backtrace_list
->debug_on_exit
= 0;
3113 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3114 and return the result of evaluation.
3115 FUN must be either a lambda-expression or a compiled-code object. */
3118 funcall_lambda (fun
, nargs
, arg_vector
)
3121 register Lisp_Object
*arg_vector
;
3123 Lisp_Object val
, syms_left
, next
;
3124 int count
= SPECPDL_INDEX ();
3125 int i
, optional
, rest
;
3129 syms_left
= XCDR (fun
);
3130 if (CONSP (syms_left
))
3131 syms_left
= XCAR (syms_left
);
3133 xsignal1 (Qinvalid_function
, fun
);
3135 else if (COMPILEDP (fun
))
3136 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3140 i
= optional
= rest
= 0;
3141 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3145 next
= XCAR (syms_left
);
3146 if (!SYMBOLP (next
))
3147 xsignal1 (Qinvalid_function
, fun
);
3149 if (EQ (next
, Qand_rest
))
3151 else if (EQ (next
, Qand_optional
))
3155 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3159 specbind (next
, arg_vector
[i
++]);
3161 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3163 specbind (next
, Qnil
);
3166 if (!NILP (syms_left
))
3167 xsignal1 (Qinvalid_function
, fun
);
3169 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3172 val
= Fprogn (XCDR (XCDR (fun
)));
3175 /* If we have not actually read the bytecode string
3176 and constants vector yet, fetch them from the file. */
3177 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3178 Ffetch_bytecode (fun
);
3179 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3180 AREF (fun
, COMPILED_CONSTANTS
),
3181 AREF (fun
, COMPILED_STACK_DEPTH
));
3184 return unbind_to (count
, val
);
3187 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3189 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3195 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3197 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3200 tem
= AREF (object
, COMPILED_BYTECODE
);
3201 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3202 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3204 error ("Invalid byte code");
3206 AREF (object
, COMPILED_BYTECODE
) = XCAR (tem
);
3207 AREF (object
, COMPILED_CONSTANTS
) = XCDR (tem
);
3215 register int count
= SPECPDL_INDEX ();
3216 if (specpdl_size
>= max_specpdl_size
)
3218 if (max_specpdl_size
< 400)
3219 max_specpdl_size
= 400;
3220 if (specpdl_size
>= max_specpdl_size
)
3221 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3224 if (specpdl_size
> max_specpdl_size
)
3225 specpdl_size
= max_specpdl_size
;
3226 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3227 specpdl_ptr
= specpdl
+ count
;
3231 specbind (symbol
, value
)
3232 Lisp_Object symbol
, value
;
3235 Lisp_Object valcontents
;
3237 CHECK_SYMBOL (symbol
);
3238 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3241 /* The most common case is that of a non-constant symbol with a
3242 trivial value. Make that as fast as we can. */
3243 valcontents
= SYMBOL_VALUE (symbol
);
3244 if (!MISCP (valcontents
) && !SYMBOL_CONSTANT_P (symbol
))
3246 specpdl_ptr
->symbol
= symbol
;
3247 specpdl_ptr
->old_value
= valcontents
;
3248 specpdl_ptr
->func
= NULL
;
3250 SET_SYMBOL_VALUE (symbol
, value
);
3254 Lisp_Object valcontents
;
3256 ovalue
= find_symbol_value (symbol
);
3257 specpdl_ptr
->func
= 0;
3258 specpdl_ptr
->old_value
= ovalue
;
3260 valcontents
= XSYMBOL (symbol
)->value
;
3262 if (BUFFER_LOCAL_VALUEP (valcontents
)
3263 || SOME_BUFFER_LOCAL_VALUEP (valcontents
)
3264 || BUFFER_OBJFWDP (valcontents
))
3266 Lisp_Object where
, current_buffer
;
3268 current_buffer
= Fcurrent_buffer ();
3270 /* For a local variable, record both the symbol and which
3271 buffer's or frame's value we are saving. */
3272 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3273 where
= current_buffer
;
3274 else if (!BUFFER_OBJFWDP (valcontents
)
3275 && XBUFFER_LOCAL_VALUE (valcontents
)->found_for_frame
)
3276 where
= XBUFFER_LOCAL_VALUE (valcontents
)->frame
;
3280 /* We're not using the `unused' slot in the specbinding
3281 structure because this would mean we have to do more
3282 work for simple variables. */
3283 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, current_buffer
));
3285 /* If SYMBOL is a per-buffer variable which doesn't have a
3286 buffer-local value here, make the `let' change the global
3287 value by changing the value of SYMBOL in all buffers not
3288 having their own value. This is consistent with what
3289 happens with other buffer-local variables. */
3291 && BUFFER_OBJFWDP (valcontents
))
3294 Fset_default (symbol
, value
);
3299 specpdl_ptr
->symbol
= symbol
;
3302 if (BUFFER_OBJFWDP (ovalue
) || KBOARD_OBJFWDP (ovalue
))
3303 store_symval_forwarding (symbol
, ovalue
, value
, NULL
);
3305 set_internal (symbol
, value
, 0, 1);
3310 record_unwind_protect (function
, arg
)
3311 Lisp_Object (*function
) P_ ((Lisp_Object
));
3314 eassert (!handling_signal
);
3316 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3318 specpdl_ptr
->func
= function
;
3319 specpdl_ptr
->symbol
= Qnil
;
3320 specpdl_ptr
->old_value
= arg
;
3325 unbind_to (count
, value
)
3329 Lisp_Object quitf
= Vquit_flag
;
3330 struct gcpro gcpro1
, gcpro2
;
3332 GCPRO2 (value
, quitf
);
3335 while (specpdl_ptr
!= specpdl
+ count
)
3337 /* Copy the binding, and decrement specpdl_ptr, before we do
3338 the work to unbind it. We decrement first
3339 so that an error in unbinding won't try to unbind
3340 the same entry again, and we copy the binding first
3341 in case more bindings are made during some of the code we run. */
3343 struct specbinding this_binding
;
3344 this_binding
= *--specpdl_ptr
;
3346 if (this_binding
.func
!= 0)
3347 (*this_binding
.func
) (this_binding
.old_value
);
3348 /* If the symbol is a list, it is really (SYMBOL WHERE
3349 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3350 frame. If WHERE is a buffer or frame, this indicates we
3351 bound a variable that had a buffer-local or frame-local
3352 binding. WHERE nil means that the variable had the default
3353 value when it was bound. CURRENT-BUFFER is the buffer that
3354 was current when the variable was bound. */
3355 else if (CONSP (this_binding
.symbol
))
3357 Lisp_Object symbol
, where
;
3359 symbol
= XCAR (this_binding
.symbol
);
3360 where
= XCAR (XCDR (this_binding
.symbol
));
3363 Fset_default (symbol
, this_binding
.old_value
);
3364 else if (BUFFERP (where
))
3365 set_internal (symbol
, this_binding
.old_value
, XBUFFER (where
), 1);
3367 set_internal (symbol
, this_binding
.old_value
, NULL
, 1);
3371 /* If variable has a trivial value (no forwarding), we can
3372 just set it. No need to check for constant symbols here,
3373 since that was already done by specbind. */
3374 if (!MISCP (SYMBOL_VALUE (this_binding
.symbol
)))
3375 SET_SYMBOL_VALUE (this_binding
.symbol
, this_binding
.old_value
);
3377 set_internal (this_binding
.symbol
, this_binding
.old_value
, 0, 1);
3381 if (NILP (Vquit_flag
) && !NILP (quitf
))
3388 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3389 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3390 The debugger is entered when that frame exits, if the flag is non-nil. */)
3392 Lisp_Object level
, flag
;
3394 register struct backtrace
*backlist
= backtrace_list
;
3397 CHECK_NUMBER (level
);
3399 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3401 backlist
= backlist
->next
;
3405 backlist
->debug_on_exit
= !NILP (flag
);
3410 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3411 doc
: /* Print a trace of Lisp function calls currently active.
3412 Output stream used is value of `standard-output'. */)
3415 register struct backtrace
*backlist
= backtrace_list
;
3419 extern Lisp_Object Vprint_level
;
3420 struct gcpro gcpro1
;
3422 XSETFASTINT (Vprint_level
, 3);
3429 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3430 if (backlist
->nargs
== UNEVALLED
)
3432 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3433 write_string ("\n", -1);
3437 tem
= *backlist
->function
;
3438 Fprin1 (tem
, Qnil
); /* This can QUIT */
3439 write_string ("(", -1);
3440 if (backlist
->nargs
== MANY
)
3442 for (tail
= *backlist
->args
, i
= 0;
3444 tail
= Fcdr (tail
), i
++)
3446 if (i
) write_string (" ", -1);
3447 Fprin1 (Fcar (tail
), Qnil
);
3452 for (i
= 0; i
< backlist
->nargs
; i
++)
3454 if (i
) write_string (" ", -1);
3455 Fprin1 (backlist
->args
[i
], Qnil
);
3458 write_string (")\n", -1);
3460 backlist
= backlist
->next
;
3463 Vprint_level
= Qnil
;
3468 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3469 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3470 If that frame has not evaluated the arguments yet (or is a special form),
3471 the value is (nil FUNCTION ARG-FORMS...).
3472 If that frame has evaluated its arguments and called its function already,
3473 the value is (t FUNCTION ARG-VALUES...).
3474 A &rest arg is represented as the tail of the list ARG-VALUES.
3475 FUNCTION is whatever was supplied as car of evaluated list,
3476 or a lambda expression for macro calls.
3477 If NFRAMES is more than the number of frames, the value is nil. */)
3479 Lisp_Object nframes
;
3481 register struct backtrace
*backlist
= backtrace_list
;
3485 CHECK_NATNUM (nframes
);
3487 /* Find the frame requested. */
3488 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3489 backlist
= backlist
->next
;
3493 if (backlist
->nargs
== UNEVALLED
)
3494 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3497 if (backlist
->nargs
== MANY
)
3498 tem
= *backlist
->args
;
3500 tem
= Flist (backlist
->nargs
, backlist
->args
);
3502 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3510 register struct backtrace
*backlist
;
3513 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3515 mark_object (*backlist
->function
);
3517 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3520 i
= backlist
->nargs
- 1;
3522 mark_object (backlist
->args
[i
]);
3529 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size
,
3530 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3531 If Lisp code tries to increase the total number past this amount,
3532 an error is signaled.
3533 You can safely use a value considerably larger than the default value,
3534 if that proves inconveniently small. However, if you increase it too far,
3535 Emacs could run out of memory trying to make the stack bigger. */);
3537 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth
,
3538 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3540 This limit serves to catch infinite recursions for you before they cause
3541 actual stack overflow in C, which would be fatal for Emacs.
3542 You can safely make it considerably larger than its default value,
3543 if that proves inconveniently small. However, if you increase it too far,
3544 Emacs could overflow the real C stack, and crash. */);
3546 DEFVAR_LISP ("quit-flag", &Vquit_flag
,
3547 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3548 If the value is t, that means do an ordinary quit.
3549 If the value equals `throw-on-input', that means quit by throwing
3550 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3551 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3552 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3555 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit
,
3556 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3557 Note that `quit-flag' will still be set by typing C-g,
3558 so a quit will be signaled as soon as `inhibit-quit' is nil.
3559 To prevent this happening, set `quit-flag' to nil
3560 before making `inhibit-quit' nil. */);
3561 Vinhibit_quit
= Qnil
;
3563 Qinhibit_quit
= intern ("inhibit-quit");
3564 staticpro (&Qinhibit_quit
);
3566 Qautoload
= intern ("autoload");
3567 staticpro (&Qautoload
);
3569 Qdebug_on_error
= intern ("debug-on-error");
3570 staticpro (&Qdebug_on_error
);
3572 Qmacro
= intern ("macro");
3573 staticpro (&Qmacro
);
3575 Qdeclare
= intern ("declare");
3576 staticpro (&Qdeclare
);
3578 /* Note that the process handling also uses Qexit, but we don't want
3579 to staticpro it twice, so we just do it here. */
3580 Qexit
= intern ("exit");
3583 Qinteractive
= intern ("interactive");
3584 staticpro (&Qinteractive
);
3586 Qcommandp
= intern ("commandp");
3587 staticpro (&Qcommandp
);
3589 Qdefun
= intern ("defun");
3590 staticpro (&Qdefun
);
3592 Qand_rest
= intern ("&rest");
3593 staticpro (&Qand_rest
);
3595 Qand_optional
= intern ("&optional");
3596 staticpro (&Qand_optional
);
3598 Qdebug
= intern ("debug");
3599 staticpro (&Qdebug
);
3601 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error
,
3602 doc
: /* *Non-nil means errors display a backtrace buffer.
3603 More precisely, this happens for any error that is handled
3604 by the editor command loop.
3605 If the value is a list, an error only means to display a backtrace
3606 if one of its condition symbols appears in the list. */);
3607 Vstack_trace_on_error
= Qnil
;
3609 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error
,
3610 doc
: /* *Non-nil means enter debugger if an error is signaled.
3611 Does not apply to errors handled by `condition-case' or those
3612 matched by `debug-ignored-errors'.
3613 If the value is a list, an error only means to enter the debugger
3614 if one of its condition symbols appears in the list.
3615 When you evaluate an expression interactively, this variable
3616 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3617 See also variable `debug-on-quit'. */);
3618 Vdebug_on_error
= Qnil
;
3620 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors
,
3621 doc
: /* *List of errors for which the debugger should not be called.
3622 Each element may be a condition-name or a regexp that matches error messages.
3623 If any element applies to a given error, that error skips the debugger
3624 and just returns to top level.
3625 This overrides the variable `debug-on-error'.
3626 It does not apply to errors handled by `condition-case'. */);
3627 Vdebug_ignored_errors
= Qnil
;
3629 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit
,
3630 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3631 Does not apply if quit is handled by a `condition-case'. */);
3634 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call
,
3635 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3637 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue
,
3638 doc
: /* Non-nil means debugger may continue execution.
3639 This is nil when the debugger is called under circumstances where it
3640 might not be safe to continue. */);
3641 debugger_may_continue
= 1;
3643 DEFVAR_LISP ("debugger", &Vdebugger
,
3644 doc
: /* Function to call to invoke debugger.
3645 If due to frame exit, args are `exit' and the value being returned;
3646 this function's value will be returned instead of that.
3647 If due to error, args are `error' and a list of the args to `signal'.
3648 If due to `apply' or `funcall' entry, one arg, `lambda'.
3649 If due to `eval' entry, one arg, t. */);
3652 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function
,
3653 doc
: /* If non-nil, this is a function for `signal' to call.
3654 It receives the same arguments that `signal' was given.
3655 The Edebug package uses this to regain control. */);
3656 Vsignal_hook_function
= Qnil
;
3658 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal
,
3659 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3660 Note that `debug-on-error', `debug-on-quit' and friends
3661 still determine whether to handle the particular condition. */);
3662 Vdebug_on_signal
= Qnil
;
3664 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function
,
3665 doc
: /* Function to process declarations in a macro definition.
3666 The function will be called with two args MACRO and DECL.
3667 MACRO is the name of the macro being defined.
3668 DECL is a list `(declare ...)' containing the declarations.
3669 The value the function returns is not used. */);
3670 Vmacro_declaration_function
= Qnil
;
3672 Vrun_hooks
= intern ("run-hooks");
3673 staticpro (&Vrun_hooks
);
3675 staticpro (&Vautoload_queue
);
3676 Vautoload_queue
= Qnil
;
3677 staticpro (&Vsignaling_function
);
3678 Vsignaling_function
= Qnil
;
3689 defsubr (&Sfunction
);
3691 defsubr (&Sdefmacro
);
3693 defsubr (&Sdefvaralias
);
3694 defsubr (&Sdefconst
);
3695 defsubr (&Suser_variable_p
);
3699 defsubr (&Smacroexpand
);
3702 defsubr (&Sunwind_protect
);
3703 defsubr (&Scondition_case
);
3705 defsubr (&Sinteractive_p
);
3706 defsubr (&Scalled_interactively_p
);
3707 defsubr (&Scommandp
);
3708 defsubr (&Sautoload
);
3711 defsubr (&Sfuncall
);
3712 defsubr (&Srun_hooks
);
3713 defsubr (&Srun_hook_with_args
);
3714 defsubr (&Srun_hook_with_args_until_success
);
3715 defsubr (&Srun_hook_with_args_until_failure
);
3716 defsubr (&Sfetch_bytecode
);
3717 defsubr (&Sbacktrace_debug
);
3718 defsubr (&Sbacktrace
);
3719 defsubr (&Sbacktrace_frame
);
3722 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3723 (do not change this comment) */