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
= 300;
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.
1350 When a handler handles an error,
1351 control returns to the condition-case and the handler BODY... is executed
1352 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).
1353 VAR may be nil; then you do not get access to the signal information.
1355 The value of the last BODY form is returned from the condition-case.
1356 See also the function `signal' for more info.
1357 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1361 register Lisp_Object bodyform
, handlers
;
1362 volatile Lisp_Object var
;
1365 bodyform
= Fcar (Fcdr (args
));
1366 handlers
= Fcdr (Fcdr (args
));
1368 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1371 /* Like Fcondition_case, but the args are separate
1372 rather than passed in a list. Used by Fbyte_code. */
1375 internal_lisp_condition_case (var
, bodyform
, handlers
)
1376 volatile Lisp_Object var
;
1377 Lisp_Object bodyform
, handlers
;
1385 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1391 && (SYMBOLP (XCAR (tem
))
1392 || CONSP (XCAR (tem
))))))
1393 error ("Invalid condition handler", tem
);
1398 c
.backlist
= backtrace_list
;
1399 c
.handlerlist
= handlerlist
;
1400 c
.lisp_eval_depth
= lisp_eval_depth
;
1401 c
.pdlcount
= SPECPDL_INDEX ();
1402 c
.poll_suppress_count
= poll_suppress_count
;
1403 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1404 c
.gcpro
= gcprolist
;
1405 c
.byte_stack
= byte_stack_list
;
1406 if (_setjmp (c
.jmp
))
1409 specbind (h
.var
, c
.val
);
1410 val
= Fprogn (Fcdr (h
.chosen_clause
));
1412 /* Note that this just undoes the binding of h.var; whoever
1413 longjumped to us unwound the stack to c.pdlcount before
1415 unbind_to (c
.pdlcount
, Qnil
);
1422 h
.handler
= handlers
;
1423 h
.next
= handlerlist
;
1427 val
= Feval (bodyform
);
1429 handlerlist
= h
.next
;
1433 /* Call the function BFUN with no arguments, catching errors within it
1434 according to HANDLERS. If there is an error, call HFUN with
1435 one argument which is the data that describes the error:
1438 HANDLERS can be a list of conditions to catch.
1439 If HANDLERS is Qt, catch all errors.
1440 If HANDLERS is Qerror, catch all errors
1441 but allow the debugger to run if that is enabled. */
1444 internal_condition_case (bfun
, handlers
, hfun
)
1445 Lisp_Object (*bfun
) ();
1446 Lisp_Object handlers
;
1447 Lisp_Object (*hfun
) ();
1453 /* Since Fsignal will close off all calls to x_catch_errors,
1454 we will get the wrong results if some are not closed now. */
1456 if (x_catching_errors ())
1462 c
.backlist
= backtrace_list
;
1463 c
.handlerlist
= handlerlist
;
1464 c
.lisp_eval_depth
= lisp_eval_depth
;
1465 c
.pdlcount
= SPECPDL_INDEX ();
1466 c
.poll_suppress_count
= poll_suppress_count
;
1467 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1468 c
.gcpro
= gcprolist
;
1469 c
.byte_stack
= byte_stack_list
;
1470 if (_setjmp (c
.jmp
))
1472 return (*hfun
) (c
.val
);
1476 h
.handler
= handlers
;
1478 h
.next
= handlerlist
;
1484 handlerlist
= h
.next
;
1488 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1491 internal_condition_case_1 (bfun
, arg
, handlers
, hfun
)
1492 Lisp_Object (*bfun
) ();
1494 Lisp_Object handlers
;
1495 Lisp_Object (*hfun
) ();
1501 /* Since Fsignal will close off all calls to x_catch_errors,
1502 we will get the wrong results if some are not closed now. */
1504 if (x_catching_errors ())
1510 c
.backlist
= backtrace_list
;
1511 c
.handlerlist
= handlerlist
;
1512 c
.lisp_eval_depth
= lisp_eval_depth
;
1513 c
.pdlcount
= SPECPDL_INDEX ();
1514 c
.poll_suppress_count
= poll_suppress_count
;
1515 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1516 c
.gcpro
= gcprolist
;
1517 c
.byte_stack
= byte_stack_list
;
1518 if (_setjmp (c
.jmp
))
1520 return (*hfun
) (c
.val
);
1524 h
.handler
= handlers
;
1526 h
.next
= handlerlist
;
1530 val
= (*bfun
) (arg
);
1532 handlerlist
= h
.next
;
1537 /* Like internal_condition_case but call BFUN with NARGS as first,
1538 and ARGS as second argument. */
1541 internal_condition_case_2 (bfun
, nargs
, args
, handlers
, hfun
)
1542 Lisp_Object (*bfun
) ();
1545 Lisp_Object handlers
;
1546 Lisp_Object (*hfun
) ();
1552 /* Since Fsignal will close off all calls to x_catch_errors,
1553 we will get the wrong results if some are not closed now. */
1555 if (x_catching_errors ())
1561 c
.backlist
= backtrace_list
;
1562 c
.handlerlist
= handlerlist
;
1563 c
.lisp_eval_depth
= lisp_eval_depth
;
1564 c
.pdlcount
= SPECPDL_INDEX ();
1565 c
.poll_suppress_count
= poll_suppress_count
;
1566 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1567 c
.gcpro
= gcprolist
;
1568 c
.byte_stack
= byte_stack_list
;
1569 if (_setjmp (c
.jmp
))
1571 return (*hfun
) (c
.val
);
1575 h
.handler
= handlers
;
1577 h
.next
= handlerlist
;
1581 val
= (*bfun
) (nargs
, args
);
1583 handlerlist
= h
.next
;
1588 static Lisp_Object find_handler_clause
P_ ((Lisp_Object
, Lisp_Object
,
1589 Lisp_Object
, Lisp_Object
,
1592 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1593 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1594 This function does not return.
1596 An error symbol is a symbol with an `error-conditions' property
1597 that is a list of condition names.
1598 A handler for any of those names will get to handle this signal.
1599 The symbol `error' should normally be one of them.
1601 DATA should be a list. Its elements are printed as part of the error message.
1602 See Info anchor `(elisp)Definition of signal' for some details on how this
1603 error message is constructed.
1604 If the signal is handled, DATA is made available to the handler.
1605 See also the function `condition-case'. */)
1606 (error_symbol
, data
)
1607 Lisp_Object error_symbol
, data
;
1609 /* When memory is full, ERROR-SYMBOL is nil,
1610 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1611 That is a special case--don't do this in other situations. */
1612 register struct handler
*allhandlers
= handlerlist
;
1613 Lisp_Object conditions
;
1614 extern int gc_in_progress
;
1615 extern int waiting_for_input
;
1616 Lisp_Object debugger_value
;
1618 Lisp_Object real_error_symbol
;
1619 struct backtrace
*bp
;
1621 immediate_quit
= handling_signal
= 0;
1623 if (gc_in_progress
|| waiting_for_input
)
1626 if (NILP (error_symbol
))
1627 real_error_symbol
= Fcar (data
);
1629 real_error_symbol
= error_symbol
;
1631 #if 0 /* rms: I don't know why this was here,
1632 but it is surely wrong for an error that is handled. */
1633 #ifdef HAVE_X_WINDOWS
1634 if (display_hourglass_p
)
1635 cancel_hourglass ();
1639 /* This hook is used by edebug. */
1640 if (! NILP (Vsignal_hook_function
)
1641 && ! NILP (error_symbol
))
1643 /* Edebug takes care of restoring these variables when it exits. */
1644 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1645 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1647 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1648 max_specpdl_size
= SPECPDL_INDEX () + 40;
1650 call2 (Vsignal_hook_function
, error_symbol
, data
);
1653 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1655 /* Remember from where signal was called. Skip over the frame for
1656 `signal' itself. If a frame for `error' follows, skip that,
1657 too. Don't do this when ERROR_SYMBOL is nil, because that
1658 is a memory-full error. */
1659 Vsignaling_function
= Qnil
;
1660 if (backtrace_list
&& !NILP (error_symbol
))
1662 bp
= backtrace_list
->next
;
1663 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1665 if (bp
&& bp
->function
)
1666 Vsignaling_function
= *bp
->function
;
1669 for (; handlerlist
; handlerlist
= handlerlist
->next
)
1671 register Lisp_Object clause
;
1673 clause
= find_handler_clause (handlerlist
->handler
, conditions
,
1674 error_symbol
, data
, &debugger_value
);
1676 if (EQ (clause
, Qlambda
))
1678 /* We can't return values to code which signaled an error, but we
1679 can continue code which has signaled a quit. */
1680 if (EQ (real_error_symbol
, Qquit
))
1683 error ("Cannot return from the debugger in an error");
1688 Lisp_Object unwind_data
;
1689 struct handler
*h
= handlerlist
;
1691 handlerlist
= allhandlers
;
1693 if (NILP (error_symbol
))
1696 unwind_data
= Fcons (error_symbol
, data
);
1697 h
->chosen_clause
= clause
;
1698 unwind_to_catch (h
->tag
, unwind_data
);
1702 handlerlist
= allhandlers
;
1703 /* If no handler is present now, try to run the debugger,
1704 and if that fails, throw to top level. */
1705 find_handler_clause (Qerror
, conditions
, error_symbol
, data
, &debugger_value
);
1707 Fthrow (Qtop_level
, Qt
);
1709 if (! NILP (error_symbol
))
1710 data
= Fcons (error_symbol
, data
);
1712 string
= Ferror_message_string (data
);
1713 fatal ("%s", SDATA (string
), 0);
1716 /* Internal version of Fsignal that never returns.
1717 Used for anything but Qquit (which can return from Fsignal). */
1720 xsignal (error_symbol
, data
)
1721 Lisp_Object error_symbol
, data
;
1723 Fsignal (error_symbol
, data
);
1727 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1730 xsignal0 (error_symbol
)
1731 Lisp_Object error_symbol
;
1733 xsignal (error_symbol
, Qnil
);
1737 xsignal1 (error_symbol
, arg
)
1738 Lisp_Object error_symbol
, arg
;
1740 xsignal (error_symbol
, list1 (arg
));
1744 xsignal2 (error_symbol
, arg1
, arg2
)
1745 Lisp_Object error_symbol
, arg1
, arg2
;
1747 xsignal (error_symbol
, list2 (arg1
, arg2
));
1751 xsignal3 (error_symbol
, arg1
, arg2
, arg3
)
1752 Lisp_Object error_symbol
, arg1
, arg2
, arg3
;
1754 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1757 /* Signal `error' with message S, and additional arg ARG.
1758 If ARG is not a genuine list, make it a one-element list. */
1761 signal_error (s
, arg
)
1765 Lisp_Object tortoise
, hare
;
1767 hare
= tortoise
= arg
;
1768 while (CONSP (hare
))
1775 tortoise
= XCDR (tortoise
);
1777 if (EQ (hare
, tortoise
))
1782 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1784 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1788 /* Return nonzero iff LIST is a non-nil atom or
1789 a list containing one of CONDITIONS. */
1792 wants_debugger (list
, conditions
)
1793 Lisp_Object list
, conditions
;
1800 while (CONSP (conditions
))
1802 Lisp_Object
this, tail
;
1803 this = XCAR (conditions
);
1804 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1805 if (EQ (XCAR (tail
), this))
1807 conditions
= XCDR (conditions
);
1812 /* Return 1 if an error with condition-symbols CONDITIONS,
1813 and described by SIGNAL-DATA, should skip the debugger
1814 according to debugger-ignored-errors. */
1817 skip_debugger (conditions
, data
)
1818 Lisp_Object conditions
, data
;
1821 int first_string
= 1;
1822 Lisp_Object error_message
;
1824 error_message
= Qnil
;
1825 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1827 if (STRINGP (XCAR (tail
)))
1831 error_message
= Ferror_message_string (data
);
1835 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1840 Lisp_Object contail
;
1842 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1843 if (EQ (XCAR (tail
), XCAR (contail
)))
1851 /* Value of Qlambda means we have called debugger and user has continued.
1852 There are two ways to pass SIG and DATA:
1853 = SIG is the error symbol, and DATA is the rest of the data.
1854 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1855 This is for memory-full errors only.
1857 Store value returned from debugger into *DEBUGGER_VALUE_PTR.
1859 We need to increase max_specpdl_size temporarily around
1860 anything we do that can push on the specpdl, so as not to get
1861 a second error here in case we're handling specpdl overflow. */
1864 find_handler_clause (handlers
, conditions
, sig
, data
, debugger_value_ptr
)
1865 Lisp_Object handlers
, conditions
, sig
, data
;
1866 Lisp_Object
*debugger_value_ptr
;
1868 register Lisp_Object h
;
1869 register Lisp_Object tem
;
1871 if (EQ (handlers
, Qt
)) /* t is used by handlers for all conditions, set up by C code. */
1873 /* error is used similarly, but means print an error message
1874 and run the debugger if that is enabled. */
1875 if (EQ (handlers
, Qerror
)
1876 || !NILP (Vdebug_on_signal
)) /* This says call debugger even if
1877 there is a handler. */
1879 int debugger_called
= 0;
1880 Lisp_Object sig_symbol
, combined_data
;
1881 /* This is set to 1 if we are handling a memory-full error,
1882 because these must not run the debugger.
1883 (There is no room in memory to do that!) */
1884 int no_debugger
= 0;
1888 combined_data
= data
;
1889 sig_symbol
= Fcar (data
);
1894 combined_data
= Fcons (sig
, data
);
1898 if (wants_debugger (Vstack_trace_on_error
, conditions
))
1902 internal_with_output_to_temp_buffer ("*Backtrace*",
1903 (Lisp_Object (*) (Lisp_Object
)) Fbacktrace
,
1906 internal_with_output_to_temp_buffer ("*Backtrace*",
1912 /* Don't try to run the debugger with interrupts blocked.
1913 The editing loop would return anyway. */
1914 && ! INPUT_BLOCKED_P
1915 && (EQ (sig_symbol
, Qquit
)
1917 : wants_debugger (Vdebug_on_error
, conditions
))
1918 && ! skip_debugger (conditions
, combined_data
)
1919 && when_entered_debugger
< num_nonmacro_input_events
)
1922 = call_debugger (Fcons (Qerror
,
1923 Fcons (combined_data
, Qnil
)));
1924 debugger_called
= 1;
1926 /* If there is no handler, return saying whether we ran the debugger. */
1927 if (EQ (handlers
, Qerror
))
1929 if (debugger_called
)
1934 for (h
= handlers
; CONSP (h
); h
= Fcdr (h
))
1936 Lisp_Object handler
, condit
;
1939 if (!CONSP (handler
))
1941 condit
= Fcar (handler
);
1942 /* Handle a single condition name in handler HANDLER. */
1943 if (SYMBOLP (condit
))
1945 tem
= Fmemq (Fcar (handler
), conditions
);
1949 /* Handle a list of condition names in handler HANDLER. */
1950 else if (CONSP (condit
))
1952 while (CONSP (condit
))
1954 tem
= Fmemq (Fcar (condit
), conditions
);
1957 condit
= XCDR (condit
);
1964 /* dump an error message; called like printf */
1968 error (m
, a1
, a2
, a3
)
1988 int used
= doprnt (buffer
, size
, m
, m
+ mlen
, 3, args
);
1993 buffer
= (char *) xrealloc (buffer
, size
);
1996 buffer
= (char *) xmalloc (size
);
2001 string
= build_string (buffer
);
2005 xsignal1 (Qerror
, string
);
2008 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2009 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2010 This means it contains a description for how to read arguments to give it.
2011 The value is nil for an invalid function or a symbol with no function
2014 Interactively callable functions include strings and vectors (treated
2015 as keyboard macros), lambda-expressions that contain a top-level call
2016 to `interactive', autoload definitions made by `autoload' with non-nil
2017 fourth argument, and some of the built-in functions of Lisp.
2019 Also, a symbol satisfies `commandp' if its function definition does so.
2021 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2022 then strings and vectors are not accepted. */)
2023 (function
, for_call_interactively
)
2024 Lisp_Object function
, for_call_interactively
;
2026 register Lisp_Object fun
;
2027 register Lisp_Object funcar
;
2031 fun
= indirect_function (fun
);
2032 if (EQ (fun
, Qunbound
))
2035 /* Emacs primitives are interactive if their DEFUN specifies an
2036 interactive spec. */
2039 if (XSUBR (fun
)->prompt
)
2045 /* Bytecode objects are interactive if they are long enough to
2046 have an element whose index is COMPILED_INTERACTIVE, which is
2047 where the interactive spec is stored. */
2048 else if (COMPILEDP (fun
))
2049 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2052 /* Strings and vectors are keyboard macros. */
2053 if (NILP (for_call_interactively
) && (STRINGP (fun
) || VECTORP (fun
)))
2056 /* Lists may represent commands. */
2059 funcar
= XCAR (fun
);
2060 if (EQ (funcar
, Qlambda
))
2061 return Fassq (Qinteractive
, Fcdr (XCDR (fun
)));
2062 if (EQ (funcar
, Qautoload
))
2063 return Fcar (Fcdr (Fcdr (XCDR (fun
))));
2069 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2070 doc
: /* Define FUNCTION to autoload from FILE.
2071 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2072 Third arg DOCSTRING is documentation for the function.
2073 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2074 Fifth arg TYPE indicates the type of the object:
2075 nil or omitted says FUNCTION is a function,
2076 `keymap' says FUNCTION is really a keymap, and
2077 `macro' or t says FUNCTION is really a macro.
2078 Third through fifth args give info about the real definition.
2079 They default to nil.
2080 If FUNCTION is already defined other than as an autoload,
2081 this does nothing and returns nil. */)
2082 (function
, file
, docstring
, interactive
, type
)
2083 Lisp_Object function
, file
, docstring
, interactive
, type
;
2086 Lisp_Object args
[4];
2089 CHECK_SYMBOL (function
);
2090 CHECK_STRING (file
);
2092 /* If function is defined and not as an autoload, don't override */
2093 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2094 && !(CONSP (XSYMBOL (function
)->function
)
2095 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2098 if (NILP (Vpurify_flag
))
2099 /* Only add entries after dumping, because the ones before are
2100 not useful and else we get loads of them from the loaddefs.el. */
2101 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2105 args
[1] = docstring
;
2106 args
[2] = interactive
;
2109 return Ffset (function
, Fcons (Qautoload
, Flist (4, &args
[0])));
2110 #else /* NO_ARG_ARRAY */
2111 return Ffset (function
, Fcons (Qautoload
, Flist (4, &file
)));
2112 #endif /* not NO_ARG_ARRAY */
2116 un_autoload (oldqueue
)
2117 Lisp_Object oldqueue
;
2119 register Lisp_Object queue
, first
, second
;
2121 /* Queue to unwind is current value of Vautoload_queue.
2122 oldqueue is the shadowed value to leave in Vautoload_queue. */
2123 queue
= Vautoload_queue
;
2124 Vautoload_queue
= oldqueue
;
2125 while (CONSP (queue
))
2127 first
= XCAR (queue
);
2128 second
= Fcdr (first
);
2129 first
= Fcar (first
);
2130 if (EQ (first
, make_number (0)))
2133 Ffset (first
, second
);
2134 queue
= XCDR (queue
);
2139 /* Load an autoloaded function.
2140 FUNNAME is the symbol which is the function's name.
2141 FUNDEF is the autoload definition (a list). */
2144 do_autoload (fundef
, funname
)
2145 Lisp_Object fundef
, funname
;
2147 int count
= SPECPDL_INDEX ();
2148 Lisp_Object fun
, queue
, first
, second
;
2149 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2151 /* This is to make sure that loadup.el gives a clear picture
2152 of what files are preloaded and when. */
2153 if (! NILP (Vpurify_flag
))
2154 error ("Attempt to autoload %s while preparing to dump",
2155 SDATA (SYMBOL_NAME (funname
)));
2158 CHECK_SYMBOL (funname
);
2159 GCPRO3 (fun
, funname
, fundef
);
2161 /* Preserve the match data. */
2162 record_unwind_save_match_data ();
2164 /* Value saved here is to be restored into Vautoload_queue. */
2165 record_unwind_protect (un_autoload
, Vautoload_queue
);
2166 Vautoload_queue
= Qt
;
2167 Fload (Fcar (Fcdr (fundef
)), Qnil
, noninteractive
? Qt
: Qnil
, Qnil
, Qt
);
2169 /* Save the old autoloads, in case we ever do an unload. */
2170 queue
= Vautoload_queue
;
2171 while (CONSP (queue
))
2173 first
= XCAR (queue
);
2174 second
= Fcdr (first
);
2175 first
= Fcar (first
);
2177 if (SYMBOLP (first
) && CONSP (second
) && EQ (XCAR (second
), Qautoload
))
2178 Fput (first
, Qautoload
, (XCDR (second
)));
2180 queue
= XCDR (queue
);
2183 /* Once loading finishes, don't undo it. */
2184 Vautoload_queue
= Qt
;
2185 unbind_to (count
, Qnil
);
2187 fun
= Findirect_function (fun
, Qnil
);
2189 if (!NILP (Fequal (fun
, fundef
)))
2190 error ("Autoloading failed to define function %s",
2191 SDATA (SYMBOL_NAME (funname
)));
2196 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2197 doc
: /* Evaluate FORM and return its value. */)
2201 Lisp_Object fun
, val
, original_fun
, original_args
;
2203 struct backtrace backtrace
;
2204 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2206 if (handling_signal
)
2210 return Fsymbol_value (form
);
2215 if ((consing_since_gc
> gc_cons_threshold
2216 && consing_since_gc
> gc_relative_threshold
)
2218 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2221 Fgarbage_collect ();
2225 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2227 if (max_lisp_eval_depth
< 100)
2228 max_lisp_eval_depth
= 100;
2229 if (lisp_eval_depth
> max_lisp_eval_depth
)
2230 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2233 original_fun
= Fcar (form
);
2234 original_args
= Fcdr (form
);
2236 backtrace
.next
= backtrace_list
;
2237 backtrace_list
= &backtrace
;
2238 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2239 backtrace
.args
= &original_args
;
2240 backtrace
.nargs
= UNEVALLED
;
2241 backtrace
.evalargs
= 1;
2242 backtrace
.debug_on_exit
= 0;
2244 if (debug_on_next_call
)
2245 do_debug_on_call (Qt
);
2247 /* At this point, only original_fun and original_args
2248 have values that will be used below */
2251 /* Optimize for no indirection. */
2253 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2254 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2255 fun
= indirect_function (fun
);
2259 Lisp_Object numargs
;
2260 Lisp_Object argvals
[8];
2261 Lisp_Object args_left
;
2262 register int i
, maxargs
;
2264 args_left
= original_args
;
2265 numargs
= Flength (args_left
);
2269 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2270 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2271 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2273 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2275 backtrace
.evalargs
= 0;
2276 val
= (*XSUBR (fun
)->function
) (args_left
);
2280 if (XSUBR (fun
)->max_args
== MANY
)
2282 /* Pass a vector of evaluated arguments */
2284 register int argnum
= 0;
2286 vals
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
2288 GCPRO3 (args_left
, fun
, fun
);
2292 while (!NILP (args_left
))
2294 vals
[argnum
++] = Feval (Fcar (args_left
));
2295 args_left
= Fcdr (args_left
);
2296 gcpro3
.nvars
= argnum
;
2299 backtrace
.args
= vals
;
2300 backtrace
.nargs
= XINT (numargs
);
2302 val
= (*XSUBR (fun
)->function
) (XINT (numargs
), vals
);
2307 GCPRO3 (args_left
, fun
, fun
);
2308 gcpro3
.var
= argvals
;
2311 maxargs
= XSUBR (fun
)->max_args
;
2312 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2314 argvals
[i
] = Feval (Fcar (args_left
));
2320 backtrace
.args
= argvals
;
2321 backtrace
.nargs
= XINT (numargs
);
2326 val
= (*XSUBR (fun
)->function
) ();
2329 val
= (*XSUBR (fun
)->function
) (argvals
[0]);
2332 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1]);
2335 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2339 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2340 argvals
[2], argvals
[3]);
2343 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2344 argvals
[3], argvals
[4]);
2347 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2348 argvals
[3], argvals
[4], argvals
[5]);
2351 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2352 argvals
[3], argvals
[4], argvals
[5],
2357 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2358 argvals
[3], argvals
[4], argvals
[5],
2359 argvals
[6], argvals
[7]);
2363 /* Someone has created a subr that takes more arguments than
2364 is supported by this code. We need to either rewrite the
2365 subr to use a different argument protocol, or add more
2366 cases to this switch. */
2370 if (COMPILEDP (fun
))
2371 val
= apply_lambda (fun
, original_args
, 1);
2374 if (EQ (fun
, Qunbound
))
2375 xsignal1 (Qvoid_function
, original_fun
);
2377 xsignal1 (Qinvalid_function
, original_fun
);
2378 funcar
= XCAR (fun
);
2379 if (!SYMBOLP (funcar
))
2380 xsignal1 (Qinvalid_function
, original_fun
);
2381 if (EQ (funcar
, Qautoload
))
2383 do_autoload (fun
, original_fun
);
2386 if (EQ (funcar
, Qmacro
))
2387 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2388 else if (EQ (funcar
, Qlambda
))
2389 val
= apply_lambda (fun
, original_args
, 1);
2391 xsignal1 (Qinvalid_function
, original_fun
);
2397 if (backtrace
.debug_on_exit
)
2398 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2399 backtrace_list
= backtrace
.next
;
2404 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2405 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2406 Then return the value FUNCTION returns.
2407 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2408 usage: (apply FUNCTION &rest ARGUMENTS) */)
2413 register int i
, numargs
;
2414 register Lisp_Object spread_arg
;
2415 register Lisp_Object
*funcall_args
;
2417 struct gcpro gcpro1
;
2421 spread_arg
= args
[nargs
- 1];
2422 CHECK_LIST (spread_arg
);
2424 numargs
= XINT (Flength (spread_arg
));
2427 return Ffuncall (nargs
- 1, args
);
2428 else if (numargs
== 1)
2430 args
[nargs
- 1] = XCAR (spread_arg
);
2431 return Ffuncall (nargs
, args
);
2434 numargs
+= nargs
- 2;
2436 /* Optimize for no indirection. */
2437 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2438 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2439 fun
= indirect_function (fun
);
2440 if (EQ (fun
, Qunbound
))
2442 /* Let funcall get the error */
2449 if (numargs
< XSUBR (fun
)->min_args
2450 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2451 goto funcall
; /* Let funcall get the error */
2452 else if (XSUBR (fun
)->max_args
> numargs
)
2454 /* Avoid making funcall cons up a yet another new vector of arguments
2455 by explicitly supplying nil's for optional values */
2456 funcall_args
= (Lisp_Object
*) alloca ((1 + XSUBR (fun
)->max_args
)
2457 * sizeof (Lisp_Object
));
2458 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2459 funcall_args
[++i
] = Qnil
;
2460 GCPRO1 (*funcall_args
);
2461 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2465 /* We add 1 to numargs because funcall_args includes the
2466 function itself as well as its arguments. */
2469 funcall_args
= (Lisp_Object
*) alloca ((1 + numargs
)
2470 * sizeof (Lisp_Object
));
2471 GCPRO1 (*funcall_args
);
2472 gcpro1
.nvars
= 1 + numargs
;
2475 bcopy (args
, funcall_args
, nargs
* sizeof (Lisp_Object
));
2476 /* Spread the last arg we got. Its first element goes in
2477 the slot that it used to occupy, hence this value of I. */
2479 while (!NILP (spread_arg
))
2481 funcall_args
[i
++] = XCAR (spread_arg
);
2482 spread_arg
= XCDR (spread_arg
);
2485 /* By convention, the caller needs to gcpro Ffuncall's args. */
2486 RETURN_UNGCPRO (Ffuncall (gcpro1
.nvars
, funcall_args
));
2489 /* Run hook variables in various ways. */
2491 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2492 static Lisp_Object run_hook_with_args
P_ ((int, Lisp_Object
*,
2493 enum run_hooks_condition
));
2495 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2496 doc
: /* Run each hook in HOOKS.
2497 Each argument should be a symbol, a hook variable.
2498 These symbols are processed in the order specified.
2499 If a hook symbol has a non-nil value, that value may be a function
2500 or a list of functions to be called to run the hook.
2501 If the value is a function, it is called with no arguments.
2502 If it is a list, the elements are called, in order, with no arguments.
2504 Major modes should not use this function directly to run their mode
2505 hook; they should use `run-mode-hooks' instead.
2507 Do not use `make-local-variable' to make a hook variable buffer-local.
2508 Instead, use `add-hook' and specify t for the LOCAL argument.
2509 usage: (run-hooks &rest HOOKS) */)
2514 Lisp_Object hook
[1];
2517 for (i
= 0; i
< nargs
; i
++)
2520 run_hook_with_args (1, hook
, to_completion
);
2526 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2527 Srun_hook_with_args
, 1, MANY
, 0,
2528 doc
: /* Run HOOK with the specified arguments ARGS.
2529 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2530 value, that value may be a function or a list of functions to be
2531 called to run the hook. If the value is a function, it is called with
2532 the given arguments and its return value is returned. If it is a list
2533 of functions, those functions are called, in order,
2534 with the given arguments ARGS.
2535 It is best not to depend on the value returned by `run-hook-with-args',
2538 Do not use `make-local-variable' to make a hook variable buffer-local.
2539 Instead, use `add-hook' and specify t for the LOCAL argument.
2540 usage: (run-hook-with-args HOOK &rest ARGS) */)
2545 return run_hook_with_args (nargs
, args
, to_completion
);
2548 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2549 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2550 doc
: /* Run HOOK with the specified arguments ARGS.
2551 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2552 value, that value may be a function or a list of functions to be
2553 called to run the hook. If the value is a function, it is called with
2554 the given arguments and its return value is returned.
2555 If it is a list of functions, those functions are called, in order,
2556 with the given arguments ARGS, until one of them
2557 returns a non-nil value. Then we return that value.
2558 However, if they all return nil, we return nil.
2560 Do not use `make-local-variable' to make a hook variable buffer-local.
2561 Instead, use `add-hook' and specify t for the LOCAL argument.
2562 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2567 return run_hook_with_args (nargs
, args
, until_success
);
2570 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2571 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2572 doc
: /* Run HOOK with the specified arguments ARGS.
2573 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2574 value, that value may be a function or a list of functions to be
2575 called to run the hook. If the value is a function, it is called with
2576 the given arguments and its return value is returned.
2577 If it is a list of functions, those functions are called, in order,
2578 with the given arguments ARGS, until one of them returns nil.
2579 Then we return nil. However, if they all return non-nil, we return non-nil.
2581 Do not use `make-local-variable' to make a hook variable buffer-local.
2582 Instead, use `add-hook' and specify t for the LOCAL argument.
2583 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2588 return run_hook_with_args (nargs
, args
, until_failure
);
2591 /* ARGS[0] should be a hook symbol.
2592 Call each of the functions in the hook value, passing each of them
2593 as arguments all the rest of ARGS (all NARGS - 1 elements).
2594 COND specifies a condition to test after each call
2595 to decide whether to stop.
2596 The caller (or its caller, etc) must gcpro all of ARGS,
2597 except that it isn't necessary to gcpro ARGS[0]. */
2600 run_hook_with_args (nargs
, args
, cond
)
2603 enum run_hooks_condition cond
;
2605 Lisp_Object sym
, val
, ret
;
2606 Lisp_Object globals
;
2607 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2609 /* If we are dying or still initializing,
2610 don't do anything--it would probably crash if we tried. */
2611 if (NILP (Vrun_hooks
))
2615 val
= find_symbol_value (sym
);
2616 ret
= (cond
== until_failure
? Qt
: Qnil
);
2618 if (EQ (val
, Qunbound
) || NILP (val
))
2620 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2623 return Ffuncall (nargs
, args
);
2628 GCPRO3 (sym
, val
, globals
);
2631 CONSP (val
) && ((cond
== to_completion
)
2632 || (cond
== until_success
? NILP (ret
)
2636 if (EQ (XCAR (val
), Qt
))
2638 /* t indicates this hook has a local binding;
2639 it means to run the global binding too. */
2641 for (globals
= Fdefault_value (sym
);
2642 CONSP (globals
) && ((cond
== to_completion
)
2643 || (cond
== until_success
? NILP (ret
)
2645 globals
= XCDR (globals
))
2647 args
[0] = XCAR (globals
);
2648 /* In a global value, t should not occur. If it does, we
2649 must ignore it to avoid an endless loop. */
2650 if (!EQ (args
[0], Qt
))
2651 ret
= Ffuncall (nargs
, args
);
2656 args
[0] = XCAR (val
);
2657 ret
= Ffuncall (nargs
, args
);
2666 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2667 present value of that symbol.
2668 Call each element of FUNLIST,
2669 passing each of them the rest of ARGS.
2670 The caller (or its caller, etc) must gcpro all of ARGS,
2671 except that it isn't necessary to gcpro ARGS[0]. */
2674 run_hook_list_with_args (funlist
, nargs
, args
)
2675 Lisp_Object funlist
;
2681 Lisp_Object globals
;
2682 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2686 GCPRO3 (sym
, val
, globals
);
2688 for (val
= funlist
; CONSP (val
); val
= XCDR (val
))
2690 if (EQ (XCAR (val
), Qt
))
2692 /* t indicates this hook has a local binding;
2693 it means to run the global binding too. */
2695 for (globals
= Fdefault_value (sym
);
2697 globals
= XCDR (globals
))
2699 args
[0] = XCAR (globals
);
2700 /* In a global value, t should not occur. If it does, we
2701 must ignore it to avoid an endless loop. */
2702 if (!EQ (args
[0], Qt
))
2703 Ffuncall (nargs
, args
);
2708 args
[0] = XCAR (val
);
2709 Ffuncall (nargs
, args
);
2716 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2719 run_hook_with_args_2 (hook
, arg1
, arg2
)
2720 Lisp_Object hook
, arg1
, arg2
;
2722 Lisp_Object temp
[3];
2727 Frun_hook_with_args (3, temp
);
2730 /* Apply fn to arg */
2733 Lisp_Object fn
, arg
;
2735 struct gcpro gcpro1
;
2739 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2743 Lisp_Object args
[2];
2747 RETURN_UNGCPRO (Fapply (2, args
));
2749 #else /* not NO_ARG_ARRAY */
2750 RETURN_UNGCPRO (Fapply (2, &fn
));
2751 #endif /* not NO_ARG_ARRAY */
2754 /* Call function fn on no arguments */
2759 struct gcpro gcpro1
;
2762 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2765 /* Call function fn with 1 argument arg1 */
2769 Lisp_Object fn
, arg1
;
2771 struct gcpro gcpro1
;
2773 Lisp_Object args
[2];
2779 RETURN_UNGCPRO (Ffuncall (2, args
));
2780 #else /* not NO_ARG_ARRAY */
2783 RETURN_UNGCPRO (Ffuncall (2, &fn
));
2784 #endif /* not NO_ARG_ARRAY */
2787 /* Call function fn with 2 arguments arg1, arg2 */
2790 call2 (fn
, arg1
, arg2
)
2791 Lisp_Object fn
, arg1
, arg2
;
2793 struct gcpro gcpro1
;
2795 Lisp_Object args
[3];
2801 RETURN_UNGCPRO (Ffuncall (3, args
));
2802 #else /* not NO_ARG_ARRAY */
2805 RETURN_UNGCPRO (Ffuncall (3, &fn
));
2806 #endif /* not NO_ARG_ARRAY */
2809 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2812 call3 (fn
, arg1
, arg2
, arg3
)
2813 Lisp_Object fn
, arg1
, arg2
, arg3
;
2815 struct gcpro gcpro1
;
2817 Lisp_Object args
[4];
2824 RETURN_UNGCPRO (Ffuncall (4, args
));
2825 #else /* not NO_ARG_ARRAY */
2828 RETURN_UNGCPRO (Ffuncall (4, &fn
));
2829 #endif /* not NO_ARG_ARRAY */
2832 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2835 call4 (fn
, arg1
, arg2
, arg3
, arg4
)
2836 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
;
2838 struct gcpro gcpro1
;
2840 Lisp_Object args
[5];
2848 RETURN_UNGCPRO (Ffuncall (5, args
));
2849 #else /* not NO_ARG_ARRAY */
2852 RETURN_UNGCPRO (Ffuncall (5, &fn
));
2853 #endif /* not NO_ARG_ARRAY */
2856 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2859 call5 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
)
2860 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
;
2862 struct gcpro gcpro1
;
2864 Lisp_Object args
[6];
2873 RETURN_UNGCPRO (Ffuncall (6, args
));
2874 #else /* not NO_ARG_ARRAY */
2877 RETURN_UNGCPRO (Ffuncall (6, &fn
));
2878 #endif /* not NO_ARG_ARRAY */
2881 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2884 call6 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
)
2885 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
;
2887 struct gcpro gcpro1
;
2889 Lisp_Object args
[7];
2899 RETURN_UNGCPRO (Ffuncall (7, args
));
2900 #else /* not NO_ARG_ARRAY */
2903 RETURN_UNGCPRO (Ffuncall (7, &fn
));
2904 #endif /* not NO_ARG_ARRAY */
2907 /* The caller should GCPRO all the elements of ARGS. */
2909 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2910 doc
: /* Call first argument as a function, passing remaining arguments to it.
2911 Return the value that function returns.
2912 Thus, (funcall 'cons 'x 'y) returns (x . y).
2913 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2918 Lisp_Object fun
, original_fun
;
2920 int numargs
= nargs
- 1;
2921 Lisp_Object lisp_numargs
;
2923 struct backtrace backtrace
;
2924 register Lisp_Object
*internal_args
;
2928 if ((consing_since_gc
> gc_cons_threshold
2929 && consing_since_gc
> gc_relative_threshold
)
2931 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2932 Fgarbage_collect ();
2934 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2936 if (max_lisp_eval_depth
< 100)
2937 max_lisp_eval_depth
= 100;
2938 if (lisp_eval_depth
> max_lisp_eval_depth
)
2939 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2942 backtrace
.next
= backtrace_list
;
2943 backtrace_list
= &backtrace
;
2944 backtrace
.function
= &args
[0];
2945 backtrace
.args
= &args
[1];
2946 backtrace
.nargs
= nargs
- 1;
2947 backtrace
.evalargs
= 0;
2948 backtrace
.debug_on_exit
= 0;
2950 if (debug_on_next_call
)
2951 do_debug_on_call (Qlambda
);
2955 original_fun
= args
[0];
2959 /* Optimize for no indirection. */
2961 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2962 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2963 fun
= indirect_function (fun
);
2967 if (numargs
< XSUBR (fun
)->min_args
2968 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2970 XSETFASTINT (lisp_numargs
, numargs
);
2971 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2974 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2975 xsignal1 (Qinvalid_function
, original_fun
);
2977 if (XSUBR (fun
)->max_args
== MANY
)
2979 val
= (*XSUBR (fun
)->function
) (numargs
, args
+ 1);
2983 if (XSUBR (fun
)->max_args
> numargs
)
2985 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
2986 bcopy (args
+ 1, internal_args
, numargs
* sizeof (Lisp_Object
));
2987 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2988 internal_args
[i
] = Qnil
;
2991 internal_args
= args
+ 1;
2992 switch (XSUBR (fun
)->max_args
)
2995 val
= (*XSUBR (fun
)->function
) ();
2998 val
= (*XSUBR (fun
)->function
) (internal_args
[0]);
3001 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1]);
3004 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3008 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3009 internal_args
[2], internal_args
[3]);
3012 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3013 internal_args
[2], internal_args
[3],
3017 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3018 internal_args
[2], internal_args
[3],
3019 internal_args
[4], internal_args
[5]);
3022 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3023 internal_args
[2], internal_args
[3],
3024 internal_args
[4], internal_args
[5],
3029 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3030 internal_args
[2], internal_args
[3],
3031 internal_args
[4], internal_args
[5],
3032 internal_args
[6], internal_args
[7]);
3037 /* If a subr takes more than 8 arguments without using MANY
3038 or UNEVALLED, we need to extend this function to support it.
3039 Until this is done, there is no way to call the function. */
3043 if (COMPILEDP (fun
))
3044 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3047 if (EQ (fun
, Qunbound
))
3048 xsignal1 (Qvoid_function
, original_fun
);
3050 xsignal1 (Qinvalid_function
, original_fun
);
3051 funcar
= XCAR (fun
);
3052 if (!SYMBOLP (funcar
))
3053 xsignal1 (Qinvalid_function
, original_fun
);
3054 if (EQ (funcar
, Qlambda
))
3055 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3056 else if (EQ (funcar
, Qautoload
))
3058 do_autoload (fun
, original_fun
);
3063 xsignal1 (Qinvalid_function
, original_fun
);
3068 if (backtrace
.debug_on_exit
)
3069 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3070 backtrace_list
= backtrace
.next
;
3075 apply_lambda (fun
, args
, eval_flag
)
3076 Lisp_Object fun
, args
;
3079 Lisp_Object args_left
;
3080 Lisp_Object numargs
;
3081 register Lisp_Object
*arg_vector
;
3082 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3084 register Lisp_Object tem
;
3086 numargs
= Flength (args
);
3087 arg_vector
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
3090 GCPRO3 (*arg_vector
, args_left
, fun
);
3093 for (i
= 0; i
< XINT (numargs
);)
3095 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3096 if (eval_flag
) tem
= Feval (tem
);
3097 arg_vector
[i
++] = tem
;
3105 backtrace_list
->args
= arg_vector
;
3106 backtrace_list
->nargs
= i
;
3108 backtrace_list
->evalargs
= 0;
3109 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
3111 /* Do the debug-on-exit now, while arg_vector still exists. */
3112 if (backtrace_list
->debug_on_exit
)
3113 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3114 /* Don't do it again when we return to eval. */
3115 backtrace_list
->debug_on_exit
= 0;
3119 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3120 and return the result of evaluation.
3121 FUN must be either a lambda-expression or a compiled-code object. */
3124 funcall_lambda (fun
, nargs
, arg_vector
)
3127 register Lisp_Object
*arg_vector
;
3129 Lisp_Object val
, syms_left
, next
;
3130 int count
= SPECPDL_INDEX ();
3131 int i
, optional
, rest
;
3135 syms_left
= XCDR (fun
);
3136 if (CONSP (syms_left
))
3137 syms_left
= XCAR (syms_left
);
3139 xsignal1 (Qinvalid_function
, fun
);
3141 else if (COMPILEDP (fun
))
3142 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3146 i
= optional
= rest
= 0;
3147 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3151 next
= XCAR (syms_left
);
3152 if (!SYMBOLP (next
))
3153 xsignal1 (Qinvalid_function
, fun
);
3155 if (EQ (next
, Qand_rest
))
3157 else if (EQ (next
, Qand_optional
))
3161 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3165 specbind (next
, arg_vector
[i
++]);
3167 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3169 specbind (next
, Qnil
);
3172 if (!NILP (syms_left
))
3173 xsignal1 (Qinvalid_function
, fun
);
3175 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3178 val
= Fprogn (XCDR (XCDR (fun
)));
3181 /* If we have not actually read the bytecode string
3182 and constants vector yet, fetch them from the file. */
3183 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3184 Ffetch_bytecode (fun
);
3185 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3186 AREF (fun
, COMPILED_CONSTANTS
),
3187 AREF (fun
, COMPILED_STACK_DEPTH
));
3190 return unbind_to (count
, val
);
3193 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3195 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3201 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3203 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3206 tem
= AREF (object
, COMPILED_BYTECODE
);
3207 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3208 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3210 error ("Invalid byte code");
3212 AREF (object
, COMPILED_BYTECODE
) = XCAR (tem
);
3213 AREF (object
, COMPILED_CONSTANTS
) = XCDR (tem
);
3221 register int count
= SPECPDL_INDEX ();
3222 if (specpdl_size
>= max_specpdl_size
)
3224 if (max_specpdl_size
< 400)
3225 max_specpdl_size
= 400;
3226 if (specpdl_size
>= max_specpdl_size
)
3227 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3230 if (specpdl_size
> max_specpdl_size
)
3231 specpdl_size
= max_specpdl_size
;
3232 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3233 specpdl_ptr
= specpdl
+ count
;
3237 specbind (symbol
, value
)
3238 Lisp_Object symbol
, value
;
3241 Lisp_Object valcontents
;
3243 CHECK_SYMBOL (symbol
);
3244 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3247 /* The most common case is that of a non-constant symbol with a
3248 trivial value. Make that as fast as we can. */
3249 valcontents
= SYMBOL_VALUE (symbol
);
3250 if (!MISCP (valcontents
) && !SYMBOL_CONSTANT_P (symbol
))
3252 specpdl_ptr
->symbol
= symbol
;
3253 specpdl_ptr
->old_value
= valcontents
;
3254 specpdl_ptr
->func
= NULL
;
3256 SET_SYMBOL_VALUE (symbol
, value
);
3260 Lisp_Object valcontents
;
3262 ovalue
= find_symbol_value (symbol
);
3263 specpdl_ptr
->func
= 0;
3264 specpdl_ptr
->old_value
= ovalue
;
3266 valcontents
= XSYMBOL (symbol
)->value
;
3268 if (BUFFER_LOCAL_VALUEP (valcontents
)
3269 || SOME_BUFFER_LOCAL_VALUEP (valcontents
)
3270 || BUFFER_OBJFWDP (valcontents
))
3272 Lisp_Object where
, current_buffer
;
3274 current_buffer
= Fcurrent_buffer ();
3276 /* For a local variable, record both the symbol and which
3277 buffer's or frame's value we are saving. */
3278 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3279 where
= current_buffer
;
3280 else if (!BUFFER_OBJFWDP (valcontents
)
3281 && XBUFFER_LOCAL_VALUE (valcontents
)->found_for_frame
)
3282 where
= XBUFFER_LOCAL_VALUE (valcontents
)->frame
;
3286 /* We're not using the `unused' slot in the specbinding
3287 structure because this would mean we have to do more
3288 work for simple variables. */
3289 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, current_buffer
));
3291 /* If SYMBOL is a per-buffer variable which doesn't have a
3292 buffer-local value here, make the `let' change the global
3293 value by changing the value of SYMBOL in all buffers not
3294 having their own value. This is consistent with what
3295 happens with other buffer-local variables. */
3297 && BUFFER_OBJFWDP (valcontents
))
3300 Fset_default (symbol
, value
);
3305 specpdl_ptr
->symbol
= symbol
;
3308 if (BUFFER_OBJFWDP (ovalue
) || KBOARD_OBJFWDP (ovalue
))
3309 store_symval_forwarding (symbol
, ovalue
, value
, NULL
);
3311 set_internal (symbol
, value
, 0, 1);
3316 record_unwind_protect (function
, arg
)
3317 Lisp_Object (*function
) P_ ((Lisp_Object
));
3320 eassert (!handling_signal
);
3322 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3324 specpdl_ptr
->func
= function
;
3325 specpdl_ptr
->symbol
= Qnil
;
3326 specpdl_ptr
->old_value
= arg
;
3331 unbind_to (count
, value
)
3335 Lisp_Object quitf
= Vquit_flag
;
3336 struct gcpro gcpro1
, gcpro2
;
3338 GCPRO2 (value
, quitf
);
3341 while (specpdl_ptr
!= specpdl
+ count
)
3343 /* Copy the binding, and decrement specpdl_ptr, before we do
3344 the work to unbind it. We decrement first
3345 so that an error in unbinding won't try to unbind
3346 the same entry again, and we copy the binding first
3347 in case more bindings are made during some of the code we run. */
3349 struct specbinding this_binding
;
3350 this_binding
= *--specpdl_ptr
;
3352 if (this_binding
.func
!= 0)
3353 (*this_binding
.func
) (this_binding
.old_value
);
3354 /* If the symbol is a list, it is really (SYMBOL WHERE
3355 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3356 frame. If WHERE is a buffer or frame, this indicates we
3357 bound a variable that had a buffer-local or frame-local
3358 binding. WHERE nil means that the variable had the default
3359 value when it was bound. CURRENT-BUFFER is the buffer that
3360 was current when the variable was bound. */
3361 else if (CONSP (this_binding
.symbol
))
3363 Lisp_Object symbol
, where
;
3365 symbol
= XCAR (this_binding
.symbol
);
3366 where
= XCAR (XCDR (this_binding
.symbol
));
3369 Fset_default (symbol
, this_binding
.old_value
);
3370 else if (BUFFERP (where
))
3371 set_internal (symbol
, this_binding
.old_value
, XBUFFER (where
), 1);
3373 set_internal (symbol
, this_binding
.old_value
, NULL
, 1);
3377 /* If variable has a trivial value (no forwarding), we can
3378 just set it. No need to check for constant symbols here,
3379 since that was already done by specbind. */
3380 if (!MISCP (SYMBOL_VALUE (this_binding
.symbol
)))
3381 SET_SYMBOL_VALUE (this_binding
.symbol
, this_binding
.old_value
);
3383 set_internal (this_binding
.symbol
, this_binding
.old_value
, 0, 1);
3387 if (NILP (Vquit_flag
) && !NILP (quitf
))
3394 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3395 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3396 The debugger is entered when that frame exits, if the flag is non-nil. */)
3398 Lisp_Object level
, flag
;
3400 register struct backtrace
*backlist
= backtrace_list
;
3403 CHECK_NUMBER (level
);
3405 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3407 backlist
= backlist
->next
;
3411 backlist
->debug_on_exit
= !NILP (flag
);
3416 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3417 doc
: /* Print a trace of Lisp function calls currently active.
3418 Output stream used is value of `standard-output'. */)
3421 register struct backtrace
*backlist
= backtrace_list
;
3425 extern Lisp_Object Vprint_level
;
3426 struct gcpro gcpro1
;
3428 XSETFASTINT (Vprint_level
, 3);
3435 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3436 if (backlist
->nargs
== UNEVALLED
)
3438 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3439 write_string ("\n", -1);
3443 tem
= *backlist
->function
;
3444 Fprin1 (tem
, Qnil
); /* This can QUIT */
3445 write_string ("(", -1);
3446 if (backlist
->nargs
== MANY
)
3448 for (tail
= *backlist
->args
, i
= 0;
3450 tail
= Fcdr (tail
), i
++)
3452 if (i
) write_string (" ", -1);
3453 Fprin1 (Fcar (tail
), Qnil
);
3458 for (i
= 0; i
< backlist
->nargs
; i
++)
3460 if (i
) write_string (" ", -1);
3461 Fprin1 (backlist
->args
[i
], Qnil
);
3464 write_string (")\n", -1);
3466 backlist
= backlist
->next
;
3469 Vprint_level
= Qnil
;
3474 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3475 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3476 If that frame has not evaluated the arguments yet (or is a special form),
3477 the value is (nil FUNCTION ARG-FORMS...).
3478 If that frame has evaluated its arguments and called its function already,
3479 the value is (t FUNCTION ARG-VALUES...).
3480 A &rest arg is represented as the tail of the list ARG-VALUES.
3481 FUNCTION is whatever was supplied as car of evaluated list,
3482 or a lambda expression for macro calls.
3483 If NFRAMES is more than the number of frames, the value is nil. */)
3485 Lisp_Object nframes
;
3487 register struct backtrace
*backlist
= backtrace_list
;
3491 CHECK_NATNUM (nframes
);
3493 /* Find the frame requested. */
3494 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3495 backlist
= backlist
->next
;
3499 if (backlist
->nargs
== UNEVALLED
)
3500 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3503 if (backlist
->nargs
== MANY
)
3504 tem
= *backlist
->args
;
3506 tem
= Flist (backlist
->nargs
, backlist
->args
);
3508 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3516 register struct backtrace
*backlist
;
3519 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3521 mark_object (*backlist
->function
);
3523 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3526 i
= backlist
->nargs
- 1;
3528 mark_object (backlist
->args
[i
]);
3535 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size
,
3536 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3537 If Lisp code tries to increase the total number past this amount,
3538 an error is signaled.
3539 You can safely use a value considerably larger than the default value,
3540 if that proves inconveniently small. However, if you increase it too far,
3541 Emacs could run out of memory trying to make the stack bigger. */);
3543 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth
,
3544 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3546 This limit serves to catch infinite recursions for you before they cause
3547 actual stack overflow in C, which would be fatal for Emacs.
3548 You can safely make it considerably larger than its default value,
3549 if that proves inconveniently small. However, if you increase it too far,
3550 Emacs could overflow the real C stack, and crash. */);
3552 DEFVAR_LISP ("quit-flag", &Vquit_flag
,
3553 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3554 If the value is t, that means do an ordinary quit.
3555 If the value equals `throw-on-input', that means quit by throwing
3556 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3557 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3558 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3561 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit
,
3562 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3563 Note that `quit-flag' will still be set by typing C-g,
3564 so a quit will be signaled as soon as `inhibit-quit' is nil.
3565 To prevent this happening, set `quit-flag' to nil
3566 before making `inhibit-quit' nil. */);
3567 Vinhibit_quit
= Qnil
;
3569 Qinhibit_quit
= intern ("inhibit-quit");
3570 staticpro (&Qinhibit_quit
);
3572 Qautoload
= intern ("autoload");
3573 staticpro (&Qautoload
);
3575 Qdebug_on_error
= intern ("debug-on-error");
3576 staticpro (&Qdebug_on_error
);
3578 Qmacro
= intern ("macro");
3579 staticpro (&Qmacro
);
3581 Qdeclare
= intern ("declare");
3582 staticpro (&Qdeclare
);
3584 /* Note that the process handling also uses Qexit, but we don't want
3585 to staticpro it twice, so we just do it here. */
3586 Qexit
= intern ("exit");
3589 Qinteractive
= intern ("interactive");
3590 staticpro (&Qinteractive
);
3592 Qcommandp
= intern ("commandp");
3593 staticpro (&Qcommandp
);
3595 Qdefun
= intern ("defun");
3596 staticpro (&Qdefun
);
3598 Qand_rest
= intern ("&rest");
3599 staticpro (&Qand_rest
);
3601 Qand_optional
= intern ("&optional");
3602 staticpro (&Qand_optional
);
3604 Qdebug
= intern ("debug");
3605 staticpro (&Qdebug
);
3607 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error
,
3608 doc
: /* *Non-nil means errors display a backtrace buffer.
3609 More precisely, this happens for any error that is handled
3610 by the editor command loop.
3611 If the value is a list, an error only means to display a backtrace
3612 if one of its condition symbols appears in the list. */);
3613 Vstack_trace_on_error
= Qnil
;
3615 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error
,
3616 doc
: /* *Non-nil means enter debugger if an error is signaled.
3617 Does not apply to errors handled by `condition-case' or those
3618 matched by `debug-ignored-errors'.
3619 If the value is a list, an error only means to enter the debugger
3620 if one of its condition symbols appears in the list.
3621 When you evaluate an expression interactively, this variable
3622 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3623 See also variable `debug-on-quit'. */);
3624 Vdebug_on_error
= Qnil
;
3626 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors
,
3627 doc
: /* *List of errors for which the debugger should not be called.
3628 Each element may be a condition-name or a regexp that matches error messages.
3629 If any element applies to a given error, that error skips the debugger
3630 and just returns to top level.
3631 This overrides the variable `debug-on-error'.
3632 It does not apply to errors handled by `condition-case'. */);
3633 Vdebug_ignored_errors
= Qnil
;
3635 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit
,
3636 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3637 Does not apply if quit is handled by a `condition-case'. */);
3640 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call
,
3641 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3643 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue
,
3644 doc
: /* Non-nil means debugger may continue execution.
3645 This is nil when the debugger is called under circumstances where it
3646 might not be safe to continue. */);
3647 debugger_may_continue
= 1;
3649 DEFVAR_LISP ("debugger", &Vdebugger
,
3650 doc
: /* Function to call to invoke debugger.
3651 If due to frame exit, args are `exit' and the value being returned;
3652 this function's value will be returned instead of that.
3653 If due to error, args are `error' and a list of the args to `signal'.
3654 If due to `apply' or `funcall' entry, one arg, `lambda'.
3655 If due to `eval' entry, one arg, t. */);
3658 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function
,
3659 doc
: /* If non-nil, this is a function for `signal' to call.
3660 It receives the same arguments that `signal' was given.
3661 The Edebug package uses this to regain control. */);
3662 Vsignal_hook_function
= Qnil
;
3664 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal
,
3665 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3666 Note that `debug-on-error', `debug-on-quit' and friends
3667 still determine whether to handle the particular condition. */);
3668 Vdebug_on_signal
= Qnil
;
3670 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function
,
3671 doc
: /* Function to process declarations in a macro definition.
3672 The function will be called with two args MACRO and DECL.
3673 MACRO is the name of the macro being defined.
3674 DECL is a list `(declare ...)' containing the declarations.
3675 The value the function returns is not used. */);
3676 Vmacro_declaration_function
= Qnil
;
3678 Vrun_hooks
= intern ("run-hooks");
3679 staticpro (&Vrun_hooks
);
3681 staticpro (&Vautoload_queue
);
3682 Vautoload_queue
= Qnil
;
3683 staticpro (&Vsignaling_function
);
3684 Vsignaling_function
= Qnil
;
3695 defsubr (&Sfunction
);
3697 defsubr (&Sdefmacro
);
3699 defsubr (&Sdefvaralias
);
3700 defsubr (&Sdefconst
);
3701 defsubr (&Suser_variable_p
);
3705 defsubr (&Smacroexpand
);
3708 defsubr (&Sunwind_protect
);
3709 defsubr (&Scondition_case
);
3711 defsubr (&Sinteractive_p
);
3712 defsubr (&Scalled_interactively_p
);
3713 defsubr (&Scommandp
);
3714 defsubr (&Sautoload
);
3717 defsubr (&Sfuncall
);
3718 defsubr (&Srun_hooks
);
3719 defsubr (&Srun_hook_with_args
);
3720 defsubr (&Srun_hook_with_args_until_success
);
3721 defsubr (&Srun_hook_with_args_until_failure
);
3722 defsubr (&Sfetch_bytecode
);
3723 defsubr (&Sbacktrace_debug
);
3724 defsubr (&Sbacktrace
);
3725 defsubr (&Sbacktrace_frame
);
3728 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3729 (do not change this comment) */