1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
25 #include "blockinput.h"
28 #include "dispextern.h"
35 /* This definition is duplicated in alloc.c and keyboard.c */
36 /* Putting it in lisp.h makes cc bomb out! */
40 struct backtrace
*next
;
41 Lisp_Object
*function
;
42 Lisp_Object
*args
; /* Points to vector of args. */
43 int nargs
; /* Length of vector.
44 If nargs is UNEVALLED, args points to slot holding
45 list of unevalled args */
47 /* Nonzero means call value of debugger when done with this operation. */
51 struct backtrace
*backtrace_list
;
53 /* This structure helps implement the `catch' and `throw' control
54 structure. A struct catchtag contains all the information needed
55 to restore the state of the interpreter after a non-local jump.
57 Handlers for error conditions (represented by `struct handler'
58 structures) just point to a catch tag to do the cleanup required
61 catchtag structures are chained together in the C calling stack;
62 the `next' member points to the next outer catchtag.
64 A call like (throw TAG VAL) searches for a catchtag whose `tag'
65 member is TAG, and then unbinds to it. The `val' member is used to
66 hold VAL while the stack is unwound; `val' is returned as the value
69 All the other members are concerned with restoring the interpreter
76 struct catchtag
*next
;
79 struct backtrace
*backlist
;
80 struct handler
*handlerlist
;
83 int poll_suppress_count
;
84 int interrupt_input_blocked
;
85 struct byte_stack
*byte_stack
;
88 struct catchtag
*catchlist
;
91 /* Count levels of GCPRO to detect failure to UNGCPRO. */
95 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
96 Lisp_Object Qinhibit_quit
, Vinhibit_quit
, Vquit_flag
;
97 Lisp_Object Qand_rest
, Qand_optional
;
98 Lisp_Object Qdebug_on_error
;
102 /* This holds either the symbol `run-hooks' or nil.
103 It is nil at an early stage of startup, and when Emacs
106 Lisp_Object Vrun_hooks
;
108 /* Non-nil means record all fset's and provide's, to be undone
109 if the file being autoloaded is not fully loaded.
110 They are recorded by being consed onto the front of Vautoload_queue:
111 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
113 Lisp_Object Vautoload_queue
;
115 /* Current number of specbindings allocated in specpdl. */
119 /* Pointer to beginning of specpdl. */
121 struct specbinding
*specpdl
;
123 /* Pointer to first unused element in specpdl. */
125 struct specbinding
*specpdl_ptr
;
127 /* Maximum size allowed for specpdl allocation */
129 EMACS_INT max_specpdl_size
;
131 /* Depth in Lisp evaluations and function calls. */
135 /* Maximum allowed depth in Lisp evaluations and function calls. */
137 EMACS_INT max_lisp_eval_depth
;
139 /* Nonzero means enter debugger before next function call */
141 int debug_on_next_call
;
143 /* Non-zero means debugger may continue. This is zero when the
144 debugger is called during redisplay, where it might not be safe to
145 continue the interrupted redisplay. */
147 int debugger_may_continue
;
149 /* List of conditions (non-nil atom means all) which cause a backtrace
150 if an error is handled by the command loop's error handler. */
152 Lisp_Object Vstack_trace_on_error
;
154 /* List of conditions (non-nil atom means all) which enter the debugger
155 if an error is handled by the command loop's error handler. */
157 Lisp_Object Vdebug_on_error
;
159 /* List of conditions and regexps specifying error messages which
160 do not enter the debugger even if Vdebug_on_error says they should. */
162 Lisp_Object Vdebug_ignored_errors
;
164 /* Non-nil means call the debugger even if the error will be handled. */
166 Lisp_Object Vdebug_on_signal
;
168 /* Hook for edebug to use. */
170 Lisp_Object Vsignal_hook_function
;
172 /* Nonzero means enter debugger if a quit signal
173 is handled by the command loop's error handler. */
177 /* The value of num_nonmacro_input_events as of the last time we
178 started to enter the debugger. If we decide to enter the debugger
179 again when this is still equal to num_nonmacro_input_events, then we
180 know that the debugger itself has an error, and we should just
181 signal the error instead of entering an infinite loop of debugger
184 int when_entered_debugger
;
186 Lisp_Object Vdebugger
;
188 /* The function from which the last `signal' was called. Set in
191 Lisp_Object Vsignaling_function
;
193 /* Set to non-zero while processing X events. Checked in Feval to
194 make sure the Lisp interpreter isn't called from a signal handler,
195 which is unsafe because the interpreter isn't reentrant. */
199 /* Function to process declarations in defmacro forms. */
201 Lisp_Object Vmacro_declaration_function
;
203 extern Lisp_Object Qrisky_local_variable
;
205 static Lisp_Object funcall_lambda
P_ ((Lisp_Object
, int, Lisp_Object
*));
206 static void unwind_to_catch
P_ ((struct catchtag
*, Lisp_Object
)) NO_RETURN
;
209 /* "gcc -O3" enables automatic function inlining, which optimizes out
210 the arguments for the invocations of these functions, whereas they
211 expect these values on the stack. */
212 Lisp_Object
apply1 () __attribute__((noinline
));
213 Lisp_Object
call2 () __attribute__((noinline
));
220 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
221 specpdl_ptr
= specpdl
;
222 /* Don't forget to update docs (lispref node "Local Variables"). */
223 max_specpdl_size
= 1000;
224 max_lisp_eval_depth
= 400;
232 specpdl_ptr
= specpdl
;
237 debug_on_next_call
= 0;
242 /* This is less than the initial value of num_nonmacro_input_events. */
243 when_entered_debugger
= -1;
246 /* unwind-protect function used by call_debugger. */
249 restore_stack_limits (data
)
252 max_specpdl_size
= XINT (XCAR (data
));
253 max_lisp_eval_depth
= XINT (XCDR (data
));
257 /* Call the Lisp debugger, giving it argument ARG. */
263 int debug_while_redisplaying
;
264 int count
= SPECPDL_INDEX ();
266 int old_max
= max_specpdl_size
;
268 /* Temporarily bump up the stack limits,
269 so the debugger won't run out of stack. */
271 max_specpdl_size
+= 1;
272 record_unwind_protect (restore_stack_limits
,
273 Fcons (make_number (old_max
),
274 make_number (max_lisp_eval_depth
)));
275 max_specpdl_size
= old_max
;
277 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
278 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
280 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
281 max_specpdl_size
= SPECPDL_INDEX () + 100;
283 #ifdef HAVE_X_WINDOWS
284 if (display_hourglass_p
)
288 debug_on_next_call
= 0;
289 when_entered_debugger
= num_nonmacro_input_events
;
291 /* Resetting redisplaying_p to 0 makes sure that debug output is
292 displayed if the debugger is invoked during redisplay. */
293 debug_while_redisplaying
= redisplaying_p
;
295 specbind (intern ("debugger-may-continue"),
296 debug_while_redisplaying
? Qnil
: Qt
);
297 specbind (Qinhibit_redisplay
, Qnil
);
298 specbind (Qdebug_on_error
, Qnil
);
300 #if 0 /* Binding this prevents execution of Lisp code during
301 redisplay, which necessarily leads to display problems. */
302 specbind (Qinhibit_eval_during_redisplay
, Qt
);
305 val
= apply1 (Vdebugger
, arg
);
307 /* Interrupting redisplay and resuming it later is not safe under
308 all circumstances. So, when the debugger returns, abort the
309 interrupted redisplay by going back to the top-level. */
310 if (debug_while_redisplaying
)
313 return unbind_to (count
, val
);
317 do_debug_on_call (code
)
320 debug_on_next_call
= 0;
321 backtrace_list
->debug_on_exit
= 1;
322 call_debugger (Fcons (code
, Qnil
));
325 /* NOTE!!! Every function that can call EVAL must protect its args
326 and temporaries from garbage collection while it needs them.
327 The definition of `For' shows what you have to do. */
329 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
330 doc
: /* Eval args until one of them yields non-nil, then return that value.
331 The remaining args are not evalled at all.
332 If all args return nil, return nil.
333 usage: (or CONDITIONS...) */)
337 register Lisp_Object val
= Qnil
;
344 val
= Feval (XCAR (args
));
354 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
355 doc
: /* Eval args until one of them yields nil, then return nil.
356 The remaining args are not evalled at all.
357 If no arg yields nil, return the last arg's value.
358 usage: (and CONDITIONS...) */)
362 register Lisp_Object val
= Qt
;
369 val
= Feval (XCAR (args
));
379 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
380 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
381 Returns the value of THEN or the value of the last of the ELSE's.
382 THEN must be one expression, but ELSE... can be zero or more expressions.
383 If COND yields nil, and there are no ELSE's, the value is nil.
384 usage: (if COND THEN ELSE...) */)
388 register Lisp_Object cond
;
392 cond
= Feval (Fcar (args
));
396 return Feval (Fcar (Fcdr (args
)));
397 return Fprogn (Fcdr (Fcdr (args
)));
400 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
401 doc
: /* Try each clause until one succeeds.
402 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
403 and, if the value is non-nil, this clause succeeds:
404 then the expressions in BODY are evaluated and the last one's
405 value is the value of the cond-form.
406 If no clause succeeds, cond returns nil.
407 If a clause has one element, as in (CONDITION),
408 CONDITION's value if non-nil is returned from the cond-form.
409 usage: (cond CLAUSES...) */)
413 register Lisp_Object clause
, val
;
420 clause
= Fcar (args
);
421 val
= Feval (Fcar (clause
));
424 if (!EQ (XCDR (clause
), Qnil
))
425 val
= Fprogn (XCDR (clause
));
435 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
436 doc
: /* Eval BODY forms sequentially and return value of last one.
437 usage: (progn BODY...) */)
441 register Lisp_Object val
= Qnil
;
448 val
= Feval (XCAR (args
));
456 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
457 doc
: /* Eval FIRST and BODY sequentially; value from FIRST.
458 The value of FIRST is saved during the evaluation of the remaining args,
459 whose values are discarded.
460 usage: (prog1 FIRST BODY...) */)
465 register Lisp_Object args_left
;
466 struct gcpro gcpro1
, gcpro2
;
467 register int argnum
= 0;
479 val
= Feval (Fcar (args_left
));
481 Feval (Fcar (args_left
));
482 args_left
= Fcdr (args_left
);
484 while (!NILP(args_left
));
490 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
491 doc
: /* Eval FORM1, FORM2 and BODY sequentially; value from FORM2.
492 The value of FORM2 is saved during the evaluation of the
493 remaining args, whose values are discarded.
494 usage: (prog2 FORM1 FORM2 BODY...) */)
499 register Lisp_Object args_left
;
500 struct gcpro gcpro1
, gcpro2
;
501 register int argnum
= -1;
515 val
= Feval (Fcar (args_left
));
517 Feval (Fcar (args_left
));
518 args_left
= Fcdr (args_left
);
520 while (!NILP (args_left
));
526 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
527 doc
: /* Set each SYM to the value of its VAL.
528 The symbols SYM are variables; they are literal (not evaluated).
529 The values VAL are expressions; they are evaluated.
530 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
531 The second VAL is not computed until after the first SYM is set, and so on;
532 each VAL can use the new value of variables set earlier in the `setq'.
533 The return value of the `setq' form is the value of the last VAL.
534 usage: (setq [SYM VAL]...) */)
538 register Lisp_Object args_left
;
539 register Lisp_Object val
, sym
;
550 val
= Feval (Fcar (Fcdr (args_left
)));
551 sym
= Fcar (args_left
);
553 args_left
= Fcdr (Fcdr (args_left
));
555 while (!NILP(args_left
));
561 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
562 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
563 usage: (quote ARG) */)
570 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
571 doc
: /* Like `quote', but preferred for objects which are functions.
572 In byte compilation, `function' causes its argument to be compiled.
573 `quote' cannot do that.
574 usage: (function ARG) */)
582 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
583 doc
: /* Return t if the function was run directly by user input.
584 This means that the function was called with `call-interactively'
585 \(which includes being called as the binding of a key)
586 and input is currently coming from the keyboard (not in keyboard macro),
587 and Emacs is not running in batch mode (`noninteractive' is nil).
589 The only known proper use of `interactive-p' is in deciding whether to
590 display a helpful message, or how to display it. If you're thinking
591 of using it for any other purpose, it is quite likely that you're
592 making a mistake. Think: what do you want to do when the command is
593 called from a keyboard macro?
595 If you want to test whether your function was called with
596 `call-interactively', the way to do that is by adding an extra
597 optional argument, and making the `interactive' spec specify non-nil
598 unconditionally for that argument. (`p' is a good way to do this.) */)
601 return (INTERACTIVE
&& interactive_p (1)) ? Qt
: Qnil
;
605 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 0, 0,
606 doc
: /* Return t if the function using this was called with `call-interactively'.
607 This is used for implementing advice and other function-modifying
610 The cleanest way to test whether your function was called with
611 `call-interactively' is by adding an extra optional argument,
612 and making the `interactive' spec specify non-nil unconditionally
613 for that argument. (`p' is a good way to do this.) */)
616 return interactive_p (1) ? Qt
: Qnil
;
620 /* Return 1 if function in which this appears was called using
623 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
624 called is a built-in. */
627 interactive_p (exclude_subrs_p
)
630 struct backtrace
*btp
;
633 btp
= backtrace_list
;
635 /* If this isn't a byte-compiled function, there may be a frame at
636 the top for Finteractive_p. If so, skip it. */
637 fun
= Findirect_function (*btp
->function
, Qnil
);
638 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
639 || XSUBR (fun
) == &Scalled_interactively_p
))
642 /* If we're running an Emacs 18-style byte-compiled function, there
643 may be a frame for Fbytecode at the top level. In any version of
644 Emacs there can be Fbytecode frames for subexpressions evaluated
645 inside catch and condition-case. Skip past them.
647 If this isn't a byte-compiled function, then we may now be
648 looking at several frames for special forms. Skip past them. */
650 && (EQ (*btp
->function
, Qbytecode
)
651 || btp
->nargs
== UNEVALLED
))
654 /* btp now points at the frame of the innermost function that isn't
655 a special form, ignoring frames for Finteractive_p and/or
656 Fbytecode at the top. If this frame is for a built-in function
657 (such as load or eval-region) return nil. */
658 fun
= Findirect_function (*btp
->function
, Qnil
);
659 if (exclude_subrs_p
&& SUBRP (fun
))
662 /* btp points to the frame of a Lisp function that called interactive-p.
663 Return t if that function was called interactively. */
664 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
670 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
671 doc
: /* Define NAME as a function.
672 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
673 See also the function `interactive'.
674 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
678 register Lisp_Object fn_name
;
679 register Lisp_Object defn
;
681 fn_name
= Fcar (args
);
682 CHECK_SYMBOL (fn_name
);
683 defn
= Fcons (Qlambda
, Fcdr (args
));
684 if (!NILP (Vpurify_flag
))
685 defn
= Fpurecopy (defn
);
686 if (CONSP (XSYMBOL (fn_name
)->function
)
687 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
688 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
689 Ffset (fn_name
, defn
);
690 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
694 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
695 doc
: /* Define NAME as a macro.
696 The actual definition looks like
697 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
698 When the macro is called, as in (NAME ARGS...),
699 the function (lambda ARGLIST BODY...) is applied to
700 the list ARGS... as it appears in the expression,
701 and the result should be a form to be evaluated instead of the original.
703 DECL is a declaration, optional, which can specify how to indent
704 calls to this macro and how Edebug should handle it. It looks like this:
706 The elements can look like this:
708 Set NAME's `lisp-indent-function' property to INDENT.
711 Set NAME's `edebug-form-spec' property to DEBUG. (This is
712 equivalent to writing a `def-edebug-spec' for the macro.)
713 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
717 register Lisp_Object fn_name
;
718 register Lisp_Object defn
;
719 Lisp_Object lambda_list
, doc
, tail
;
721 fn_name
= Fcar (args
);
722 CHECK_SYMBOL (fn_name
);
723 lambda_list
= Fcar (Fcdr (args
));
724 tail
= Fcdr (Fcdr (args
));
727 if (STRINGP (Fcar (tail
)))
733 while (CONSP (Fcar (tail
))
734 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
736 if (!NILP (Vmacro_declaration_function
))
740 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
748 tail
= Fcons (lambda_list
, tail
);
750 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
751 defn
= Fcons (Qmacro
, Fcons (Qlambda
, tail
));
753 if (!NILP (Vpurify_flag
))
754 defn
= Fpurecopy (defn
);
755 if (CONSP (XSYMBOL (fn_name
)->function
)
756 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
757 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
758 Ffset (fn_name
, defn
);
759 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
764 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
765 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
766 Aliased variables always have the same value; setting one sets the other.
767 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
768 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
769 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
771 The return value is BASE-VARIABLE. */)
772 (new_alias
, base_variable
, docstring
)
773 Lisp_Object new_alias
, base_variable
, docstring
;
775 struct Lisp_Symbol
*sym
;
777 CHECK_SYMBOL (new_alias
);
778 CHECK_SYMBOL (base_variable
);
780 if (SYMBOL_CONSTANT_P (new_alias
))
781 error ("Cannot make a constant an alias");
783 sym
= XSYMBOL (new_alias
);
784 sym
->indirect_variable
= 1;
785 sym
->value
= base_variable
;
786 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
787 LOADHIST_ATTACH (new_alias
);
788 if (!NILP (docstring
))
789 Fput (new_alias
, Qvariable_documentation
, docstring
);
791 Fput (new_alias
, Qvariable_documentation
, Qnil
);
793 return base_variable
;
797 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
798 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
799 You are not required to define a variable in order to use it,
800 but the definition can supply documentation and an initial value
801 in a way that tags can recognize.
803 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
804 If SYMBOL is buffer-local, its default value is what is set;
805 buffer-local values are not affected.
806 INITVALUE and DOCSTRING are optional.
807 If DOCSTRING starts with *, this variable is identified as a user option.
808 This means that M-x set-variable recognizes it.
809 See also `user-variable-p'.
810 If INITVALUE is missing, SYMBOL's value is not set.
812 If SYMBOL has a local binding, then this form affects the local
813 binding. This is usually not what you want. Thus, if you need to
814 load a file defining variables, with this form or with `defconst' or
815 `defcustom', you should always load that file _outside_ any bindings
816 for these variables. \(`defconst' and `defcustom' behave similarly in
818 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
822 register Lisp_Object sym
, tem
, tail
;
826 if (!NILP (Fcdr (Fcdr (tail
))))
827 error ("Too many arguments");
829 tem
= Fdefault_boundp (sym
);
832 if (SYMBOL_CONSTANT_P (sym
))
834 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
835 Lisp_Object tem
= Fcar (tail
);
837 && EQ (XCAR (tem
), Qquote
)
838 && CONSP (XCDR (tem
))
839 && EQ (XCAR (XCDR (tem
)), sym
)))
840 error ("Constant symbol `%s' specified in defvar",
841 SDATA (SYMBOL_NAME (sym
)));
845 Fset_default (sym
, Feval (Fcar (tail
)));
847 { /* Check if there is really a global binding rather than just a let
848 binding that shadows the global unboundness of the var. */
849 volatile struct specbinding
*pdl
= specpdl_ptr
;
850 while (--pdl
>= specpdl
)
852 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
853 && EQ (pdl
->old_value
, Qunbound
))
855 message_with_string ("Warning: defvar ignored because %s is let-bound",
856 SYMBOL_NAME (sym
), 1);
865 if (!NILP (Vpurify_flag
))
866 tem
= Fpurecopy (tem
);
867 Fput (sym
, Qvariable_documentation
, tem
);
869 LOADHIST_ATTACH (sym
);
872 /* Simple (defvar <var>) should not count as a definition at all.
873 It could get in the way of other definitions, and unloading this
874 package could try to make the variable unbound. */
880 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
881 doc
: /* Define SYMBOL as a constant variable.
882 The intent is that neither programs nor users should ever change this value.
883 Always sets the value of SYMBOL to the result of evalling INITVALUE.
884 If SYMBOL is buffer-local, its default value is what is set;
885 buffer-local values are not affected.
886 DOCSTRING is optional.
888 If SYMBOL has a local binding, then this form sets the local binding's
889 value. However, you should normally not make local bindings for
890 variables defined with this form.
891 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
895 register Lisp_Object sym
, tem
;
898 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
899 error ("Too many arguments");
901 tem
= Feval (Fcar (Fcdr (args
)));
902 if (!NILP (Vpurify_flag
))
903 tem
= Fpurecopy (tem
);
904 Fset_default (sym
, tem
);
905 tem
= Fcar (Fcdr (Fcdr (args
)));
908 if (!NILP (Vpurify_flag
))
909 tem
= Fpurecopy (tem
);
910 Fput (sym
, Qvariable_documentation
, tem
);
912 Fput (sym
, Qrisky_local_variable
, Qt
);
913 LOADHIST_ATTACH (sym
);
917 /* Error handler used in Fuser_variable_p. */
919 user_variable_p_eh (ignore
)
925 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
926 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
927 \(The alternative is a variable used internally in a Lisp program.)
928 A variable is a user variable if
929 \(1) the first character of its documentation is `*', or
930 \(2) it is customizable (its property list contains a non-nil value
931 of `standard-value' or `custom-autoload'), or
932 \(3) it is an alias for another user variable.
933 Return nil if VARIABLE is an alias and there is a loop in the
934 chain of symbols. */)
936 Lisp_Object variable
;
938 Lisp_Object documentation
;
940 if (!SYMBOLP (variable
))
943 /* If indirect and there's an alias loop, don't check anything else. */
944 if (XSYMBOL (variable
)->indirect_variable
945 && NILP (internal_condition_case_1 (indirect_variable
, variable
,
946 Qt
, user_variable_p_eh
)))
951 documentation
= Fget (variable
, Qvariable_documentation
);
952 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
954 if (STRINGP (documentation
)
955 && ((unsigned char) SREF (documentation
, 0) == '*'))
957 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
958 if (CONSP (documentation
)
959 && STRINGP (XCAR (documentation
))
960 && INTEGERP (XCDR (documentation
))
961 && XINT (XCDR (documentation
)) < 0)
963 /* Customizable? See `custom-variable-p'. */
964 if ((!NILP (Fget (variable
, intern ("standard-value"))))
965 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
968 if (!XSYMBOL (variable
)->indirect_variable
)
971 /* An indirect variable? Let's follow the chain. */
972 variable
= XSYMBOL (variable
)->value
;
976 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
977 doc
: /* Bind variables according to VARLIST then eval BODY.
978 The value of the last form in BODY is returned.
979 Each element of VARLIST is a symbol (which is bound to nil)
980 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
981 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
982 usage: (let* VARLIST BODY...) */)
986 Lisp_Object varlist
, val
, elt
;
987 int count
= SPECPDL_INDEX ();
988 struct gcpro gcpro1
, gcpro2
, gcpro3
;
990 GCPRO3 (args
, elt
, varlist
);
992 varlist
= Fcar (args
);
993 while (!NILP (varlist
))
996 elt
= Fcar (varlist
);
998 specbind (elt
, Qnil
);
999 else if (! NILP (Fcdr (Fcdr (elt
))))
1000 signal_error ("`let' bindings can have only one value-form", elt
);
1003 val
= Feval (Fcar (Fcdr (elt
)));
1004 specbind (Fcar (elt
), val
);
1006 varlist
= Fcdr (varlist
);
1009 val
= Fprogn (Fcdr (args
));
1010 return unbind_to (count
, val
);
1013 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1014 doc
: /* Bind variables according to VARLIST then eval BODY.
1015 The value of the last form in BODY is returned.
1016 Each element of VARLIST is a symbol (which is bound to nil)
1017 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1018 All the VALUEFORMs are evalled before any symbols are bound.
1019 usage: (let VARLIST BODY...) */)
1023 Lisp_Object
*temps
, tem
;
1024 register Lisp_Object elt
, varlist
;
1025 int count
= SPECPDL_INDEX ();
1026 register int argnum
;
1027 struct gcpro gcpro1
, gcpro2
;
1029 varlist
= Fcar (args
);
1031 /* Make space to hold the values to give the bound variables */
1032 elt
= Flength (varlist
);
1033 temps
= (Lisp_Object
*) alloca (XFASTINT (elt
) * sizeof (Lisp_Object
));
1035 /* Compute the values and store them in `temps' */
1037 GCPRO2 (args
, *temps
);
1040 for (argnum
= 0; !NILP (varlist
); varlist
= Fcdr (varlist
))
1043 elt
= Fcar (varlist
);
1045 temps
[argnum
++] = Qnil
;
1046 else if (! NILP (Fcdr (Fcdr (elt
))))
1047 signal_error ("`let' bindings can have only one value-form", elt
);
1049 temps
[argnum
++] = Feval (Fcar (Fcdr (elt
)));
1050 gcpro2
.nvars
= argnum
;
1054 varlist
= Fcar (args
);
1055 for (argnum
= 0; !NILP (varlist
); varlist
= Fcdr (varlist
))
1057 elt
= Fcar (varlist
);
1058 tem
= temps
[argnum
++];
1060 specbind (elt
, tem
);
1062 specbind (Fcar (elt
), tem
);
1065 elt
= Fprogn (Fcdr (args
));
1066 return unbind_to (count
, elt
);
1069 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1070 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1071 The order of execution is thus TEST, BODY, TEST, BODY and so on
1072 until TEST returns nil.
1073 usage: (while TEST BODY...) */)
1077 Lisp_Object test
, body
;
1078 struct gcpro gcpro1
, gcpro2
;
1080 GCPRO2 (test
, body
);
1084 while (!NILP (Feval (test
)))
1094 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1095 doc
: /* Return result of expanding macros at top level of FORM.
1096 If FORM is not a macro call, it is returned unchanged.
1097 Otherwise, the macro is expanded and the expansion is considered
1098 in place of FORM. When a non-macro-call results, it is returned.
1100 The second optional arg ENVIRONMENT specifies an environment of macro
1101 definitions to shadow the loaded ones for use in file byte-compilation. */)
1104 Lisp_Object environment
;
1106 /* With cleanups from Hallvard Furuseth. */
1107 register Lisp_Object expander
, sym
, def
, tem
;
1111 /* Come back here each time we expand a macro call,
1112 in case it expands into another macro call. */
1115 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1116 def
= sym
= XCAR (form
);
1118 /* Trace symbols aliases to other symbols
1119 until we get a symbol that is not an alias. */
1120 while (SYMBOLP (def
))
1124 tem
= Fassq (sym
, environment
);
1127 def
= XSYMBOL (sym
)->function
;
1128 if (!EQ (def
, Qunbound
))
1133 /* Right now TEM is the result from SYM in ENVIRONMENT,
1134 and if TEM is nil then DEF is SYM's function definition. */
1137 /* SYM is not mentioned in ENVIRONMENT.
1138 Look at its function definition. */
1139 if (EQ (def
, Qunbound
) || !CONSP (def
))
1140 /* Not defined or definition not suitable */
1142 if (EQ (XCAR (def
), Qautoload
))
1144 /* Autoloading function: will it be a macro when loaded? */
1145 tem
= Fnth (make_number (4), def
);
1146 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1147 /* Yes, load it and try again. */
1149 struct gcpro gcpro1
;
1151 do_autoload (def
, sym
);
1158 else if (!EQ (XCAR (def
), Qmacro
))
1160 else expander
= XCDR (def
);
1164 expander
= XCDR (tem
);
1165 if (NILP (expander
))
1168 form
= apply1 (expander
, XCDR (form
));
1173 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1174 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1175 TAG is evalled to get the tag to use; it must not be nil.
1177 Then the BODY is executed.
1178 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1179 If no throw happens, `catch' returns the value of the last BODY form.
1180 If a throw happens, it specifies the value to return from `catch'.
1181 usage: (catch TAG BODY...) */)
1185 register Lisp_Object tag
;
1186 struct gcpro gcpro1
;
1189 tag
= Feval (Fcar (args
));
1191 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1194 /* Set up a catch, then call C function FUNC on argument ARG.
1195 FUNC should return a Lisp_Object.
1196 This is how catches are done from within C code. */
1199 internal_catch (tag
, func
, arg
)
1201 Lisp_Object (*func
) ();
1204 /* This structure is made part of the chain `catchlist'. */
1207 /* Fill in the components of c, and put it on the list. */
1211 c
.backlist
= backtrace_list
;
1212 c
.handlerlist
= handlerlist
;
1213 c
.lisp_eval_depth
= lisp_eval_depth
;
1214 c
.pdlcount
= SPECPDL_INDEX ();
1215 c
.poll_suppress_count
= poll_suppress_count
;
1216 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1217 c
.gcpro
= gcprolist
;
1218 c
.byte_stack
= byte_stack_list
;
1222 if (! _setjmp (c
.jmp
))
1223 c
.val
= (*func
) (arg
);
1225 /* Throw works by a longjmp that comes right here. */
1230 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1231 jump to that CATCH, returning VALUE as the value of that catch.
1233 This is the guts Fthrow and Fsignal; they differ only in the way
1234 they choose the catch tag to throw to. A catch tag for a
1235 condition-case form has a TAG of Qnil.
1237 Before each catch is discarded, unbind all special bindings and
1238 execute all unwind-protect clauses made above that catch. Unwind
1239 the handler stack as we go, so that the proper handlers are in
1240 effect for each unwind-protect clause we run. At the end, restore
1241 some static info saved in CATCH, and longjmp to the location
1244 This is used for correct unwinding in Fthrow and Fsignal. */
1247 unwind_to_catch (catch, value
)
1248 struct catchtag
*catch;
1251 register int last_time
;
1253 /* Save the value in the tag. */
1256 /* Restore certain special C variables. */
1257 set_poll_suppress_count (catch->poll_suppress_count
);
1258 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1259 handling_signal
= 0;
1264 last_time
= catchlist
== catch;
1266 /* Unwind the specpdl stack, and then restore the proper set of
1268 unbind_to (catchlist
->pdlcount
, Qnil
);
1269 handlerlist
= catchlist
->handlerlist
;
1270 catchlist
= catchlist
->next
;
1272 while (! last_time
);
1275 /* If x_catch_errors was done, turn it off now.
1276 (First we give unbind_to a chance to do that.) */
1277 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1278 * The catch must remain in effect during that delicate
1279 * state. --lorentey */
1280 x_fully_uncatch_errors ();
1284 byte_stack_list
= catch->byte_stack
;
1285 gcprolist
= catch->gcpro
;
1288 gcpro_level
= gcprolist
->level
+ 1;
1292 backtrace_list
= catch->backlist
;
1293 lisp_eval_depth
= catch->lisp_eval_depth
;
1295 _longjmp (catch->jmp
, 1);
1298 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1299 doc
: /* Throw to the catch for TAG and return VALUE from it.
1300 Both TAG and VALUE are evalled. */)
1302 register Lisp_Object tag
, value
;
1304 register struct catchtag
*c
;
1307 for (c
= catchlist
; c
; c
= c
->next
)
1309 if (EQ (c
->tag
, tag
))
1310 unwind_to_catch (c
, value
);
1312 xsignal2 (Qno_catch
, tag
, value
);
1316 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1317 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1318 If BODYFORM completes normally, its value is returned
1319 after executing the UNWINDFORMS.
1320 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1321 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1326 int count
= SPECPDL_INDEX ();
1328 record_unwind_protect (Fprogn
, Fcdr (args
));
1329 val
= Feval (Fcar (args
));
1330 return unbind_to (count
, val
);
1333 /* Chain of condition handlers currently in effect.
1334 The elements of this chain are contained in the stack frames
1335 of Fcondition_case and internal_condition_case.
1336 When an error is signaled (by calling Fsignal, below),
1337 this chain is searched for an element that applies. */
1339 struct handler
*handlerlist
;
1341 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1342 doc
: /* Regain control when an error is signaled.
1343 Executes BODYFORM and returns its value if no error happens.
1344 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1345 where the BODY is made of Lisp expressions.
1347 A handler is applicable to an error
1348 if CONDITION-NAME is one of the error's condition names.
1349 If an error happens, the first applicable handler is run.
1351 The car of a handler may be a list of condition names
1352 instead of a single condition name.
1354 When a handler handles an error,
1355 control returns to the condition-case and the handler BODY... is executed
1356 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).
1357 VAR may be nil; then you do not get access to the signal information.
1359 The value of the last BODY form is returned from the condition-case.
1360 See also the function `signal' for more info.
1361 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1365 register Lisp_Object bodyform
, handlers
;
1366 volatile Lisp_Object var
;
1369 bodyform
= Fcar (Fcdr (args
));
1370 handlers
= Fcdr (Fcdr (args
));
1372 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1375 /* Like Fcondition_case, but the args are separate
1376 rather than passed in a list. Used by Fbyte_code. */
1379 internal_lisp_condition_case (var
, bodyform
, handlers
)
1380 volatile Lisp_Object var
;
1381 Lisp_Object bodyform
, handlers
;
1389 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1395 && (SYMBOLP (XCAR (tem
))
1396 || CONSP (XCAR (tem
))))))
1397 error ("Invalid condition handler", tem
);
1402 c
.backlist
= backtrace_list
;
1403 c
.handlerlist
= handlerlist
;
1404 c
.lisp_eval_depth
= lisp_eval_depth
;
1405 c
.pdlcount
= SPECPDL_INDEX ();
1406 c
.poll_suppress_count
= poll_suppress_count
;
1407 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1408 c
.gcpro
= gcprolist
;
1409 c
.byte_stack
= byte_stack_list
;
1410 if (_setjmp (c
.jmp
))
1413 specbind (h
.var
, c
.val
);
1414 val
= Fprogn (Fcdr (h
.chosen_clause
));
1416 /* Note that this just undoes the binding of h.var; whoever
1417 longjumped to us unwound the stack to c.pdlcount before
1419 unbind_to (c
.pdlcount
, Qnil
);
1426 h
.handler
= handlers
;
1427 h
.next
= handlerlist
;
1431 val
= Feval (bodyform
);
1433 handlerlist
= h
.next
;
1437 /* Call the function BFUN with no arguments, catching errors within it
1438 according to HANDLERS. If there is an error, call HFUN with
1439 one argument which is the data that describes the error:
1442 HANDLERS can be a list of conditions to catch.
1443 If HANDLERS is Qt, catch all errors.
1444 If HANDLERS is Qerror, catch all errors
1445 but allow the debugger to run if that is enabled. */
1448 internal_condition_case (bfun
, handlers
, hfun
)
1449 Lisp_Object (*bfun
) ();
1450 Lisp_Object handlers
;
1451 Lisp_Object (*hfun
) ();
1457 /* Since Fsignal will close off all calls to x_catch_errors,
1458 we will get the wrong results if some are not closed now. */
1459 #if 0 /* Fsignal doesn't do that anymore. --lorentey */
1461 if (x_catching_errors ())
1468 c
.backlist
= backtrace_list
;
1469 c
.handlerlist
= handlerlist
;
1470 c
.lisp_eval_depth
= lisp_eval_depth
;
1471 c
.pdlcount
= SPECPDL_INDEX ();
1472 c
.poll_suppress_count
= poll_suppress_count
;
1473 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1474 c
.gcpro
= gcprolist
;
1475 c
.byte_stack
= byte_stack_list
;
1476 if (_setjmp (c
.jmp
))
1478 return (*hfun
) (c
.val
);
1482 h
.handler
= handlers
;
1484 h
.next
= handlerlist
;
1490 handlerlist
= h
.next
;
1494 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1497 internal_condition_case_1 (bfun
, arg
, handlers
, hfun
)
1498 Lisp_Object (*bfun
) ();
1500 Lisp_Object handlers
;
1501 Lisp_Object (*hfun
) ();
1507 /* Since Fsignal will close off all calls to x_catch_errors,
1508 we will get the wrong results if some are not closed now. */
1509 #if 0 /* Fsignal doesn't do that anymore. --lorentey */
1511 if (x_catching_errors ())
1518 c
.backlist
= backtrace_list
;
1519 c
.handlerlist
= handlerlist
;
1520 c
.lisp_eval_depth
= lisp_eval_depth
;
1521 c
.pdlcount
= SPECPDL_INDEX ();
1522 c
.poll_suppress_count
= poll_suppress_count
;
1523 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1524 c
.gcpro
= gcprolist
;
1525 c
.byte_stack
= byte_stack_list
;
1526 if (_setjmp (c
.jmp
))
1528 return (*hfun
) (c
.val
);
1532 h
.handler
= handlers
;
1534 h
.next
= handlerlist
;
1538 val
= (*bfun
) (arg
);
1540 handlerlist
= h
.next
;
1545 /* Like internal_condition_case but call BFUN with NARGS as first,
1546 and ARGS as second argument. */
1549 internal_condition_case_2 (bfun
, nargs
, args
, handlers
, hfun
)
1550 Lisp_Object (*bfun
) ();
1553 Lisp_Object handlers
;
1554 Lisp_Object (*hfun
) ();
1560 /* Since Fsignal will close off all calls to x_catch_errors,
1561 we will get the wrong results if some are not closed now. */
1562 #if 0 /* Fsignal doesn't do that anymore. --lorentey */
1564 if (x_catching_errors ())
1571 c
.backlist
= backtrace_list
;
1572 c
.handlerlist
= handlerlist
;
1573 c
.lisp_eval_depth
= lisp_eval_depth
;
1574 c
.pdlcount
= SPECPDL_INDEX ();
1575 c
.poll_suppress_count
= poll_suppress_count
;
1576 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1577 c
.gcpro
= gcprolist
;
1578 c
.byte_stack
= byte_stack_list
;
1579 if (_setjmp (c
.jmp
))
1581 return (*hfun
) (c
.val
);
1585 h
.handler
= handlers
;
1587 h
.next
= handlerlist
;
1591 val
= (*bfun
) (nargs
, args
);
1593 handlerlist
= h
.next
;
1598 static Lisp_Object find_handler_clause
P_ ((Lisp_Object
, Lisp_Object
,
1599 Lisp_Object
, Lisp_Object
));
1601 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1602 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1603 This function does not return.
1605 An error symbol is a symbol with an `error-conditions' property
1606 that is a list of condition names.
1607 A handler for any of those names will get to handle this signal.
1608 The symbol `error' should normally be one of them.
1610 DATA should be a list. Its elements are printed as part of the error message.
1611 See Info anchor `(elisp)Definition of signal' for some details on how this
1612 error message is constructed.
1613 If the signal is handled, DATA is made available to the handler.
1614 See also the function `condition-case'. */)
1615 (error_symbol
, data
)
1616 Lisp_Object error_symbol
, data
;
1618 /* When memory is full, ERROR-SYMBOL is nil,
1619 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1620 That is a special case--don't do this in other situations. */
1621 register struct handler
*allhandlers
= handlerlist
;
1622 Lisp_Object conditions
;
1623 extern int gc_in_progress
;
1624 extern int waiting_for_input
;
1626 Lisp_Object real_error_symbol
;
1627 struct backtrace
*bp
;
1629 immediate_quit
= handling_signal
= 0;
1631 if (gc_in_progress
|| waiting_for_input
)
1634 if (NILP (error_symbol
))
1635 real_error_symbol
= Fcar (data
);
1637 real_error_symbol
= error_symbol
;
1639 #if 0 /* rms: I don't know why this was here,
1640 but it is surely wrong for an error that is handled. */
1641 #ifdef HAVE_X_WINDOWS
1642 if (display_hourglass_p
)
1643 cancel_hourglass ();
1647 /* This hook is used by edebug. */
1648 if (! NILP (Vsignal_hook_function
)
1649 && ! NILP (error_symbol
))
1651 /* Edebug takes care of restoring these variables when it exits. */
1652 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1653 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1655 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1656 max_specpdl_size
= SPECPDL_INDEX () + 40;
1658 call2 (Vsignal_hook_function
, error_symbol
, data
);
1661 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1663 /* Remember from where signal was called. Skip over the frame for
1664 `signal' itself. If a frame for `error' follows, skip that,
1665 too. Don't do this when ERROR_SYMBOL is nil, because that
1666 is a memory-full error. */
1667 Vsignaling_function
= Qnil
;
1668 if (backtrace_list
&& !NILP (error_symbol
))
1670 bp
= backtrace_list
->next
;
1671 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1673 if (bp
&& bp
->function
)
1674 Vsignaling_function
= *bp
->function
;
1677 for (; handlerlist
; handlerlist
= handlerlist
->next
)
1679 register Lisp_Object clause
;
1681 clause
= find_handler_clause (handlerlist
->handler
, conditions
,
1682 error_symbol
, data
);
1684 if (EQ (clause
, Qlambda
))
1686 /* We can't return values to code which signaled an error, but we
1687 can continue code which has signaled a quit. */
1688 if (EQ (real_error_symbol
, Qquit
))
1691 error ("Cannot return from the debugger in an error");
1696 Lisp_Object unwind_data
;
1697 struct handler
*h
= handlerlist
;
1699 handlerlist
= allhandlers
;
1701 if (NILP (error_symbol
))
1704 unwind_data
= Fcons (error_symbol
, data
);
1705 h
->chosen_clause
= clause
;
1706 unwind_to_catch (h
->tag
, unwind_data
);
1710 handlerlist
= allhandlers
;
1711 /* If no handler is present now, try to run the debugger,
1712 and if that fails, throw to top level. */
1713 find_handler_clause (Qerror
, conditions
, error_symbol
, data
);
1715 Fthrow (Qtop_level
, Qt
);
1717 if (! NILP (error_symbol
))
1718 data
= Fcons (error_symbol
, data
);
1720 string
= Ferror_message_string (data
);
1721 fatal ("%s", SDATA (string
), 0);
1724 /* Internal version of Fsignal that never returns.
1725 Used for anything but Qquit (which can return from Fsignal). */
1728 xsignal (error_symbol
, data
)
1729 Lisp_Object error_symbol
, data
;
1731 Fsignal (error_symbol
, data
);
1735 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1738 xsignal0 (error_symbol
)
1739 Lisp_Object error_symbol
;
1741 xsignal (error_symbol
, Qnil
);
1745 xsignal1 (error_symbol
, arg
)
1746 Lisp_Object error_symbol
, arg
;
1748 xsignal (error_symbol
, list1 (arg
));
1752 xsignal2 (error_symbol
, arg1
, arg2
)
1753 Lisp_Object error_symbol
, arg1
, arg2
;
1755 xsignal (error_symbol
, list2 (arg1
, arg2
));
1759 xsignal3 (error_symbol
, arg1
, arg2
, arg3
)
1760 Lisp_Object error_symbol
, arg1
, arg2
, arg3
;
1762 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1765 /* Signal `error' with message S, and additional arg ARG.
1766 If ARG is not a genuine list, make it a one-element list. */
1769 signal_error (s
, arg
)
1773 Lisp_Object tortoise
, hare
;
1775 hare
= tortoise
= arg
;
1776 while (CONSP (hare
))
1783 tortoise
= XCDR (tortoise
);
1785 if (EQ (hare
, tortoise
))
1790 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1792 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1796 /* Return nonzero iff LIST is a non-nil atom or
1797 a list containing one of CONDITIONS. */
1800 wants_debugger (list
, conditions
)
1801 Lisp_Object list
, conditions
;
1808 while (CONSP (conditions
))
1810 Lisp_Object
this, tail
;
1811 this = XCAR (conditions
);
1812 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1813 if (EQ (XCAR (tail
), this))
1815 conditions
= XCDR (conditions
);
1820 /* Return 1 if an error with condition-symbols CONDITIONS,
1821 and described by SIGNAL-DATA, should skip the debugger
1822 according to debugger-ignored-errors. */
1825 skip_debugger (conditions
, data
)
1826 Lisp_Object conditions
, data
;
1829 int first_string
= 1;
1830 Lisp_Object error_message
;
1832 error_message
= Qnil
;
1833 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1835 if (STRINGP (XCAR (tail
)))
1839 error_message
= Ferror_message_string (data
);
1843 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1848 Lisp_Object contail
;
1850 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1851 if (EQ (XCAR (tail
), XCAR (contail
)))
1859 /* Value of Qlambda means we have called debugger and user has continued.
1860 There are two ways to pass SIG and DATA:
1861 = SIG is the error symbol, and DATA is the rest of the data.
1862 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1863 This is for memory-full errors only.
1865 We need to increase max_specpdl_size temporarily around
1866 anything we do that can push on the specpdl, so as not to get
1867 a second error here in case we're handling specpdl overflow. */
1870 find_handler_clause (handlers
, conditions
, sig
, data
)
1871 Lisp_Object handlers
, conditions
, sig
, data
;
1873 register Lisp_Object h
;
1874 register Lisp_Object tem
;
1875 int debugger_called
= 0;
1876 int debugger_considered
= 0;
1878 /* t is used by handlers for all conditions, set up by C code. */
1879 if (EQ (handlers
, Qt
))
1882 /* Don't run the debugger for a memory-full error.
1883 (There is no room in memory to do that!) */
1885 debugger_considered
= 1;
1887 /* error is used similarly, but means print an error message
1888 and run the debugger if that is enabled. */
1889 if (EQ (handlers
, Qerror
)
1890 || !NILP (Vdebug_on_signal
)) /* This says call debugger even if
1891 there is a handler. */
1893 if (!NILP (sig
) && wants_debugger (Vstack_trace_on_error
, conditions
))
1897 internal_with_output_to_temp_buffer ("*Backtrace*",
1898 (Lisp_Object (*) (Lisp_Object
)) Fbacktrace
,
1901 internal_with_output_to_temp_buffer ("*Backtrace*",
1907 if (!debugger_considered
)
1909 debugger_considered
= 1;
1910 debugger_called
= maybe_call_debugger (conditions
, sig
, data
);
1913 /* If there is no handler, return saying whether we ran the debugger. */
1914 if (EQ (handlers
, Qerror
))
1916 if (debugger_called
)
1922 for (h
= handlers
; CONSP (h
); h
= Fcdr (h
))
1924 Lisp_Object handler
, condit
;
1927 if (!CONSP (handler
))
1929 condit
= Fcar (handler
);
1930 /* Handle a single condition name in handler HANDLER. */
1931 if (SYMBOLP (condit
))
1933 tem
= Fmemq (Fcar (handler
), conditions
);
1937 /* Handle a list of condition names in handler HANDLER. */
1938 else if (CONSP (condit
))
1941 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1943 tem
= Fmemq (Fcar (tail
), conditions
);
1946 /* This handler is going to apply.
1947 Does it allow the debugger to run first? */
1948 if (! debugger_considered
&& !NILP (Fmemq (Qdebug
, condit
)))
1949 maybe_call_debugger (conditions
, sig
, data
);
1959 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1960 SIG and DATA describe the signal, as in find_handler_clause. */
1963 maybe_call_debugger (conditions
, sig
, data
)
1964 Lisp_Object conditions
, sig
, data
;
1966 Lisp_Object combined_data
;
1968 combined_data
= Fcons (sig
, data
);
1971 /* Don't try to run the debugger with interrupts blocked.
1972 The editing loop would return anyway. */
1974 /* Does user wants to enter debugger for this kind of error? */
1977 : wants_debugger (Vdebug_on_error
, conditions
))
1978 && ! skip_debugger (conditions
, combined_data
)
1979 /* rms: what's this for? */
1980 && when_entered_debugger
< num_nonmacro_input_events
)
1982 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1989 /* dump an error message; called like printf */
1993 error (m
, a1
, a2
, a3
)
2013 int used
= doprnt (buffer
, size
, m
, m
+ mlen
, 3, args
);
2018 buffer
= (char *) xrealloc (buffer
, size
);
2021 buffer
= (char *) xmalloc (size
);
2026 string
= build_string (buffer
);
2030 xsignal1 (Qerror
, string
);
2033 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2034 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2035 This means it contains a description for how to read arguments to give it.
2036 The value is nil for an invalid function or a symbol with no function
2039 Interactively callable functions include strings and vectors (treated
2040 as keyboard macros), lambda-expressions that contain a top-level call
2041 to `interactive', autoload definitions made by `autoload' with non-nil
2042 fourth argument, and some of the built-in functions of Lisp.
2044 Also, a symbol satisfies `commandp' if its function definition does so.
2046 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2047 then strings and vectors are not accepted. */)
2048 (function
, for_call_interactively
)
2049 Lisp_Object function
, for_call_interactively
;
2051 register Lisp_Object fun
;
2052 register Lisp_Object funcar
;
2053 Lisp_Object if_prop
= Qnil
;
2057 fun
= indirect_function (fun
); /* Check cycles. */
2058 if (NILP (fun
) || EQ (fun
, Qunbound
))
2061 /* Check an `interactive-form' property if present, analogous to the
2062 function-documentation property. */
2064 while (SYMBOLP (fun
))
2066 Lisp_Object tmp
= Fget (fun
, intern ("interactive-form"));
2069 fun
= Fsymbol_function (fun
);
2072 /* Emacs primitives are interactive if their DEFUN specifies an
2073 interactive spec. */
2075 return XSUBR (fun
)->prompt
? Qt
: if_prop
;
2077 /* Bytecode objects are interactive if they are long enough to
2078 have an element whose index is COMPILED_INTERACTIVE, which is
2079 where the interactive spec is stored. */
2080 else if (COMPILEDP (fun
))
2081 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2084 /* Strings and vectors are keyboard macros. */
2085 if (STRINGP (fun
) || VECTORP (fun
))
2086 return NILP (for_call_interactively
) ? Qt
: Qnil
;
2088 /* Lists may represent commands. */
2091 funcar
= XCAR (fun
);
2092 if (EQ (funcar
, Qlambda
))
2093 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2094 if (EQ (funcar
, Qautoload
))
2095 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2101 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2102 doc
: /* Define FUNCTION to autoload from FILE.
2103 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2104 Third arg DOCSTRING is documentation for the function.
2105 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2106 Fifth arg TYPE indicates the type of the object:
2107 nil or omitted says FUNCTION is a function,
2108 `keymap' says FUNCTION is really a keymap, and
2109 `macro' or t says FUNCTION is really a macro.
2110 Third through fifth args give info about the real definition.
2111 They default to nil.
2112 If FUNCTION is already defined other than as an autoload,
2113 this does nothing and returns nil. */)
2114 (function
, file
, docstring
, interactive
, type
)
2115 Lisp_Object function
, file
, docstring
, interactive
, type
;
2118 Lisp_Object args
[4];
2121 CHECK_SYMBOL (function
);
2122 CHECK_STRING (file
);
2124 /* If function is defined and not as an autoload, don't override */
2125 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2126 && !(CONSP (XSYMBOL (function
)->function
)
2127 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2130 if (NILP (Vpurify_flag
))
2131 /* Only add entries after dumping, because the ones before are
2132 not useful and else we get loads of them from the loaddefs.el. */
2133 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2137 args
[1] = docstring
;
2138 args
[2] = interactive
;
2141 return Ffset (function
, Fcons (Qautoload
, Flist (4, &args
[0])));
2142 #else /* NO_ARG_ARRAY */
2143 return Ffset (function
, Fcons (Qautoload
, Flist (4, &file
)));
2144 #endif /* not NO_ARG_ARRAY */
2148 un_autoload (oldqueue
)
2149 Lisp_Object oldqueue
;
2151 register Lisp_Object queue
, first
, second
;
2153 /* Queue to unwind is current value of Vautoload_queue.
2154 oldqueue is the shadowed value to leave in Vautoload_queue. */
2155 queue
= Vautoload_queue
;
2156 Vautoload_queue
= oldqueue
;
2157 while (CONSP (queue
))
2159 first
= XCAR (queue
);
2160 second
= Fcdr (first
);
2161 first
= Fcar (first
);
2162 if (EQ (first
, make_number (0)))
2165 Ffset (first
, second
);
2166 queue
= XCDR (queue
);
2171 /* Load an autoloaded function.
2172 FUNNAME is the symbol which is the function's name.
2173 FUNDEF is the autoload definition (a list). */
2176 do_autoload (fundef
, funname
)
2177 Lisp_Object fundef
, funname
;
2179 int count
= SPECPDL_INDEX ();
2180 Lisp_Object fun
, queue
, first
, second
;
2181 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2183 /* This is to make sure that loadup.el gives a clear picture
2184 of what files are preloaded and when. */
2185 if (! NILP (Vpurify_flag
))
2186 error ("Attempt to autoload %s while preparing to dump",
2187 SDATA (SYMBOL_NAME (funname
)));
2190 CHECK_SYMBOL (funname
);
2191 GCPRO3 (fun
, funname
, fundef
);
2193 /* Preserve the match data. */
2194 record_unwind_save_match_data ();
2196 /* Value saved here is to be restored into Vautoload_queue. */
2197 record_unwind_protect (un_autoload
, Vautoload_queue
);
2198 Vautoload_queue
= Qt
;
2199 Fload (Fcar (Fcdr (fundef
)), Qnil
, noninteractive
? Qt
: Qnil
, Qnil
, Qt
);
2201 /* Save the old autoloads, in case we ever do an unload. */
2202 queue
= Vautoload_queue
;
2203 while (CONSP (queue
))
2205 first
= XCAR (queue
);
2206 second
= Fcdr (first
);
2207 first
= Fcar (first
);
2209 if (SYMBOLP (first
) && CONSP (second
) && EQ (XCAR (second
), Qautoload
))
2210 Fput (first
, Qautoload
, (XCDR (second
)));
2212 queue
= XCDR (queue
);
2215 /* Once loading finishes, don't undo it. */
2216 Vautoload_queue
= Qt
;
2217 unbind_to (count
, Qnil
);
2219 fun
= Findirect_function (fun
, Qnil
);
2221 if (!NILP (Fequal (fun
, fundef
)))
2222 error ("Autoloading failed to define function %s",
2223 SDATA (SYMBOL_NAME (funname
)));
2228 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2229 doc
: /* Evaluate FORM and return its value. */)
2233 Lisp_Object fun
, val
, original_fun
, original_args
;
2235 struct backtrace backtrace
;
2236 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2238 if (handling_signal
)
2242 return Fsymbol_value (form
);
2247 if ((consing_since_gc
> gc_cons_threshold
2248 && consing_since_gc
> gc_relative_threshold
)
2250 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2253 Fgarbage_collect ();
2257 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2259 if (max_lisp_eval_depth
< 100)
2260 max_lisp_eval_depth
= 100;
2261 if (lisp_eval_depth
> max_lisp_eval_depth
)
2262 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2265 original_fun
= Fcar (form
);
2266 original_args
= Fcdr (form
);
2268 backtrace
.next
= backtrace_list
;
2269 backtrace_list
= &backtrace
;
2270 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2271 backtrace
.args
= &original_args
;
2272 backtrace
.nargs
= UNEVALLED
;
2273 backtrace
.evalargs
= 1;
2274 backtrace
.debug_on_exit
= 0;
2276 if (debug_on_next_call
)
2277 do_debug_on_call (Qt
);
2279 /* At this point, only original_fun and original_args
2280 have values that will be used below */
2283 /* Optimize for no indirection. */
2285 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2286 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2287 fun
= indirect_function (fun
);
2291 Lisp_Object numargs
;
2292 Lisp_Object argvals
[8];
2293 Lisp_Object args_left
;
2294 register int i
, maxargs
;
2296 args_left
= original_args
;
2297 numargs
= Flength (args_left
);
2301 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2302 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2303 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2305 if (XSUBR (fun
)->max_args
== UNEVALLED
)
2307 backtrace
.evalargs
= 0;
2308 val
= (*XSUBR (fun
)->function
) (args_left
);
2312 if (XSUBR (fun
)->max_args
== MANY
)
2314 /* Pass a vector of evaluated arguments */
2316 register int argnum
= 0;
2318 vals
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
2320 GCPRO3 (args_left
, fun
, fun
);
2324 while (!NILP (args_left
))
2326 vals
[argnum
++] = Feval (Fcar (args_left
));
2327 args_left
= Fcdr (args_left
);
2328 gcpro3
.nvars
= argnum
;
2331 backtrace
.args
= vals
;
2332 backtrace
.nargs
= XINT (numargs
);
2334 val
= (*XSUBR (fun
)->function
) (XINT (numargs
), vals
);
2339 GCPRO3 (args_left
, fun
, fun
);
2340 gcpro3
.var
= argvals
;
2343 maxargs
= XSUBR (fun
)->max_args
;
2344 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2346 argvals
[i
] = Feval (Fcar (args_left
));
2352 backtrace
.args
= argvals
;
2353 backtrace
.nargs
= XINT (numargs
);
2358 val
= (*XSUBR (fun
)->function
) ();
2361 val
= (*XSUBR (fun
)->function
) (argvals
[0]);
2364 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1]);
2367 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2371 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1],
2372 argvals
[2], argvals
[3]);
2375 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2376 argvals
[3], argvals
[4]);
2379 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2380 argvals
[3], argvals
[4], argvals
[5]);
2383 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2384 argvals
[3], argvals
[4], argvals
[5],
2389 val
= (*XSUBR (fun
)->function
) (argvals
[0], argvals
[1], argvals
[2],
2390 argvals
[3], argvals
[4], argvals
[5],
2391 argvals
[6], argvals
[7]);
2395 /* Someone has created a subr that takes more arguments than
2396 is supported by this code. We need to either rewrite the
2397 subr to use a different argument protocol, or add more
2398 cases to this switch. */
2402 if (COMPILEDP (fun
))
2403 val
= apply_lambda (fun
, original_args
, 1);
2406 if (EQ (fun
, Qunbound
))
2407 xsignal1 (Qvoid_function
, original_fun
);
2409 xsignal1 (Qinvalid_function
, original_fun
);
2410 funcar
= XCAR (fun
);
2411 if (!SYMBOLP (funcar
))
2412 xsignal1 (Qinvalid_function
, original_fun
);
2413 if (EQ (funcar
, Qautoload
))
2415 do_autoload (fun
, original_fun
);
2418 if (EQ (funcar
, Qmacro
))
2419 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2420 else if (EQ (funcar
, Qlambda
))
2421 val
= apply_lambda (fun
, original_args
, 1);
2423 xsignal1 (Qinvalid_function
, original_fun
);
2429 if (backtrace
.debug_on_exit
)
2430 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2431 backtrace_list
= backtrace
.next
;
2436 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2437 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2438 Then return the value FUNCTION returns.
2439 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2440 usage: (apply FUNCTION &rest ARGUMENTS) */)
2445 register int i
, numargs
;
2446 register Lisp_Object spread_arg
;
2447 register Lisp_Object
*funcall_args
;
2449 struct gcpro gcpro1
;
2453 spread_arg
= args
[nargs
- 1];
2454 CHECK_LIST (spread_arg
);
2456 numargs
= XINT (Flength (spread_arg
));
2459 return Ffuncall (nargs
- 1, args
);
2460 else if (numargs
== 1)
2462 args
[nargs
- 1] = XCAR (spread_arg
);
2463 return Ffuncall (nargs
, args
);
2466 numargs
+= nargs
- 2;
2468 /* Optimize for no indirection. */
2469 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2470 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2471 fun
= indirect_function (fun
);
2472 if (EQ (fun
, Qunbound
))
2474 /* Let funcall get the error */
2481 if (numargs
< XSUBR (fun
)->min_args
2482 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2483 goto funcall
; /* Let funcall get the error */
2484 else if (XSUBR (fun
)->max_args
> numargs
)
2486 /* Avoid making funcall cons up a yet another new vector of arguments
2487 by explicitly supplying nil's for optional values */
2488 funcall_args
= (Lisp_Object
*) alloca ((1 + XSUBR (fun
)->max_args
)
2489 * sizeof (Lisp_Object
));
2490 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2491 funcall_args
[++i
] = Qnil
;
2492 GCPRO1 (*funcall_args
);
2493 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2497 /* We add 1 to numargs because funcall_args includes the
2498 function itself as well as its arguments. */
2501 funcall_args
= (Lisp_Object
*) alloca ((1 + numargs
)
2502 * sizeof (Lisp_Object
));
2503 GCPRO1 (*funcall_args
);
2504 gcpro1
.nvars
= 1 + numargs
;
2507 bcopy (args
, funcall_args
, nargs
* sizeof (Lisp_Object
));
2508 /* Spread the last arg we got. Its first element goes in
2509 the slot that it used to occupy, hence this value of I. */
2511 while (!NILP (spread_arg
))
2513 funcall_args
[i
++] = XCAR (spread_arg
);
2514 spread_arg
= XCDR (spread_arg
);
2517 /* By convention, the caller needs to gcpro Ffuncall's args. */
2518 RETURN_UNGCPRO (Ffuncall (gcpro1
.nvars
, funcall_args
));
2521 /* Run hook variables in various ways. */
2523 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2524 static Lisp_Object run_hook_with_args
P_ ((int, Lisp_Object
*,
2525 enum run_hooks_condition
));
2527 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2528 doc
: /* Run each hook in HOOKS.
2529 Each argument should be a symbol, a hook variable.
2530 These symbols are processed in the order specified.
2531 If a hook symbol has a non-nil value, that value may be a function
2532 or a list of functions to be called to run the hook.
2533 If the value is a function, it is called with no arguments.
2534 If it is a list, the elements are called, in order, with no arguments.
2536 Major modes should not use this function directly to run their mode
2537 hook; they should use `run-mode-hooks' instead.
2539 Do not use `make-local-variable' to make a hook variable buffer-local.
2540 Instead, use `add-hook' and specify t for the LOCAL argument.
2541 usage: (run-hooks &rest HOOKS) */)
2546 Lisp_Object hook
[1];
2549 for (i
= 0; i
< nargs
; i
++)
2552 run_hook_with_args (1, hook
, to_completion
);
2558 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2559 Srun_hook_with_args
, 1, MANY
, 0,
2560 doc
: /* Run HOOK with the specified arguments ARGS.
2561 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2562 value, that value may be a function or a list of functions to be
2563 called to run the hook. If the value is a function, it is called with
2564 the given arguments and its return value is returned. If it is a list
2565 of functions, those functions are called, in order,
2566 with the given arguments ARGS.
2567 It is best not to depend on the value returned by `run-hook-with-args',
2570 Do not use `make-local-variable' to make a hook variable buffer-local.
2571 Instead, use `add-hook' and specify t for the LOCAL argument.
2572 usage: (run-hook-with-args HOOK &rest ARGS) */)
2577 return run_hook_with_args (nargs
, args
, to_completion
);
2580 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2581 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2582 doc
: /* Run HOOK with the specified arguments ARGS.
2583 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2584 value, that value may be a function or a list of functions to be
2585 called to run the hook. If the value is a function, it is called with
2586 the given arguments and its return value is returned.
2587 If it is a list of functions, those functions are called, in order,
2588 with the given arguments ARGS, until one of them
2589 returns a non-nil value. Then we return that value.
2590 However, if they all return nil, we return nil.
2592 Do not use `make-local-variable' to make a hook variable buffer-local.
2593 Instead, use `add-hook' and specify t for the LOCAL argument.
2594 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2599 return run_hook_with_args (nargs
, args
, until_success
);
2602 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2603 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2604 doc
: /* Run HOOK with the specified arguments ARGS.
2605 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2606 value, that value may be a function or a list of functions to be
2607 called to run the hook. If the value is a function, it is called with
2608 the given arguments and its return value is returned.
2609 If it is a list of functions, those functions are called, in order,
2610 with the given arguments ARGS, until one of them returns nil.
2611 Then we return nil. However, if they all return non-nil, we return non-nil.
2613 Do not use `make-local-variable' to make a hook variable buffer-local.
2614 Instead, use `add-hook' and specify t for the LOCAL argument.
2615 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2620 return run_hook_with_args (nargs
, args
, until_failure
);
2623 /* ARGS[0] should be a hook symbol.
2624 Call each of the functions in the hook value, passing each of them
2625 as arguments all the rest of ARGS (all NARGS - 1 elements).
2626 COND specifies a condition to test after each call
2627 to decide whether to stop.
2628 The caller (or its caller, etc) must gcpro all of ARGS,
2629 except that it isn't necessary to gcpro ARGS[0]. */
2632 run_hook_with_args (nargs
, args
, cond
)
2635 enum run_hooks_condition cond
;
2637 Lisp_Object sym
, val
, ret
;
2638 Lisp_Object globals
;
2639 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2641 /* If we are dying or still initializing,
2642 don't do anything--it would probably crash if we tried. */
2643 if (NILP (Vrun_hooks
))
2647 val
= find_symbol_value (sym
);
2648 ret
= (cond
== until_failure
? Qt
: Qnil
);
2650 if (EQ (val
, Qunbound
) || NILP (val
))
2652 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2655 return Ffuncall (nargs
, args
);
2660 GCPRO3 (sym
, val
, globals
);
2663 CONSP (val
) && ((cond
== to_completion
)
2664 || (cond
== until_success
? NILP (ret
)
2668 if (EQ (XCAR (val
), Qt
))
2670 /* t indicates this hook has a local binding;
2671 it means to run the global binding too. */
2673 for (globals
= Fdefault_value (sym
);
2674 CONSP (globals
) && ((cond
== to_completion
)
2675 || (cond
== until_success
? NILP (ret
)
2677 globals
= XCDR (globals
))
2679 args
[0] = XCAR (globals
);
2680 /* In a global value, t should not occur. If it does, we
2681 must ignore it to avoid an endless loop. */
2682 if (!EQ (args
[0], Qt
))
2683 ret
= Ffuncall (nargs
, args
);
2688 args
[0] = XCAR (val
);
2689 ret
= Ffuncall (nargs
, args
);
2698 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2699 present value of that symbol.
2700 Call each element of FUNLIST,
2701 passing each of them the rest of ARGS.
2702 The caller (or its caller, etc) must gcpro all of ARGS,
2703 except that it isn't necessary to gcpro ARGS[0]. */
2706 run_hook_list_with_args (funlist
, nargs
, args
)
2707 Lisp_Object funlist
;
2713 Lisp_Object globals
;
2714 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2718 GCPRO3 (sym
, val
, globals
);
2720 for (val
= funlist
; CONSP (val
); val
= XCDR (val
))
2722 if (EQ (XCAR (val
), Qt
))
2724 /* t indicates this hook has a local binding;
2725 it means to run the global binding too. */
2727 for (globals
= Fdefault_value (sym
);
2729 globals
= XCDR (globals
))
2731 args
[0] = XCAR (globals
);
2732 /* In a global value, t should not occur. If it does, we
2733 must ignore it to avoid an endless loop. */
2734 if (!EQ (args
[0], Qt
))
2735 Ffuncall (nargs
, args
);
2740 args
[0] = XCAR (val
);
2741 Ffuncall (nargs
, args
);
2748 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2751 run_hook_with_args_2 (hook
, arg1
, arg2
)
2752 Lisp_Object hook
, arg1
, arg2
;
2754 Lisp_Object temp
[3];
2759 Frun_hook_with_args (3, temp
);
2762 /* Apply fn to arg */
2765 Lisp_Object fn
, arg
;
2767 struct gcpro gcpro1
;
2771 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2775 Lisp_Object args
[2];
2779 RETURN_UNGCPRO (Fapply (2, args
));
2781 #else /* not NO_ARG_ARRAY */
2782 RETURN_UNGCPRO (Fapply (2, &fn
));
2783 #endif /* not NO_ARG_ARRAY */
2786 /* Call function fn on no arguments */
2791 struct gcpro gcpro1
;
2794 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2797 /* Call function fn with 1 argument arg1 */
2801 Lisp_Object fn
, arg1
;
2803 struct gcpro gcpro1
;
2805 Lisp_Object args
[2];
2811 RETURN_UNGCPRO (Ffuncall (2, args
));
2812 #else /* not NO_ARG_ARRAY */
2815 RETURN_UNGCPRO (Ffuncall (2, &fn
));
2816 #endif /* not NO_ARG_ARRAY */
2819 /* Call function fn with 2 arguments arg1, arg2 */
2822 call2 (fn
, arg1
, arg2
)
2823 Lisp_Object fn
, arg1
, arg2
;
2825 struct gcpro gcpro1
;
2827 Lisp_Object args
[3];
2833 RETURN_UNGCPRO (Ffuncall (3, args
));
2834 #else /* not NO_ARG_ARRAY */
2837 RETURN_UNGCPRO (Ffuncall (3, &fn
));
2838 #endif /* not NO_ARG_ARRAY */
2841 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2844 call3 (fn
, arg1
, arg2
, arg3
)
2845 Lisp_Object fn
, arg1
, arg2
, arg3
;
2847 struct gcpro gcpro1
;
2849 Lisp_Object args
[4];
2856 RETURN_UNGCPRO (Ffuncall (4, args
));
2857 #else /* not NO_ARG_ARRAY */
2860 RETURN_UNGCPRO (Ffuncall (4, &fn
));
2861 #endif /* not NO_ARG_ARRAY */
2864 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2867 call4 (fn
, arg1
, arg2
, arg3
, arg4
)
2868 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
;
2870 struct gcpro gcpro1
;
2872 Lisp_Object args
[5];
2880 RETURN_UNGCPRO (Ffuncall (5, args
));
2881 #else /* not NO_ARG_ARRAY */
2884 RETURN_UNGCPRO (Ffuncall (5, &fn
));
2885 #endif /* not NO_ARG_ARRAY */
2888 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2891 call5 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
)
2892 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
;
2894 struct gcpro gcpro1
;
2896 Lisp_Object args
[6];
2905 RETURN_UNGCPRO (Ffuncall (6, args
));
2906 #else /* not NO_ARG_ARRAY */
2909 RETURN_UNGCPRO (Ffuncall (6, &fn
));
2910 #endif /* not NO_ARG_ARRAY */
2913 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2916 call6 (fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
)
2917 Lisp_Object fn
, arg1
, arg2
, arg3
, arg4
, arg5
, arg6
;
2919 struct gcpro gcpro1
;
2921 Lisp_Object args
[7];
2931 RETURN_UNGCPRO (Ffuncall (7, args
));
2932 #else /* not NO_ARG_ARRAY */
2935 RETURN_UNGCPRO (Ffuncall (7, &fn
));
2936 #endif /* not NO_ARG_ARRAY */
2939 /* The caller should GCPRO all the elements of ARGS. */
2941 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2942 doc
: /* Call first argument as a function, passing remaining arguments to it.
2943 Return the value that function returns.
2944 Thus, (funcall 'cons 'x 'y) returns (x . y).
2945 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2950 Lisp_Object fun
, original_fun
;
2952 int numargs
= nargs
- 1;
2953 Lisp_Object lisp_numargs
;
2955 struct backtrace backtrace
;
2956 register Lisp_Object
*internal_args
;
2960 if ((consing_since_gc
> gc_cons_threshold
2961 && consing_since_gc
> gc_relative_threshold
)
2963 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2964 Fgarbage_collect ();
2966 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2968 if (max_lisp_eval_depth
< 100)
2969 max_lisp_eval_depth
= 100;
2970 if (lisp_eval_depth
> max_lisp_eval_depth
)
2971 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2974 backtrace
.next
= backtrace_list
;
2975 backtrace_list
= &backtrace
;
2976 backtrace
.function
= &args
[0];
2977 backtrace
.args
= &args
[1];
2978 backtrace
.nargs
= nargs
- 1;
2979 backtrace
.evalargs
= 0;
2980 backtrace
.debug_on_exit
= 0;
2982 if (debug_on_next_call
)
2983 do_debug_on_call (Qlambda
);
2987 original_fun
= args
[0];
2991 /* Optimize for no indirection. */
2993 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2994 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2995 fun
= indirect_function (fun
);
2999 if (numargs
< XSUBR (fun
)->min_args
3000 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
3002 XSETFASTINT (lisp_numargs
, numargs
);
3003 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
3006 if (XSUBR (fun
)->max_args
== UNEVALLED
)
3007 xsignal1 (Qinvalid_function
, original_fun
);
3009 if (XSUBR (fun
)->max_args
== MANY
)
3011 val
= (*XSUBR (fun
)->function
) (numargs
, args
+ 1);
3015 if (XSUBR (fun
)->max_args
> numargs
)
3017 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
3018 bcopy (args
+ 1, internal_args
, numargs
* sizeof (Lisp_Object
));
3019 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
3020 internal_args
[i
] = Qnil
;
3023 internal_args
= args
+ 1;
3024 switch (XSUBR (fun
)->max_args
)
3027 val
= (*XSUBR (fun
)->function
) ();
3030 val
= (*XSUBR (fun
)->function
) (internal_args
[0]);
3033 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1]);
3036 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3040 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3041 internal_args
[2], internal_args
[3]);
3044 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3045 internal_args
[2], internal_args
[3],
3049 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3050 internal_args
[2], internal_args
[3],
3051 internal_args
[4], internal_args
[5]);
3054 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3055 internal_args
[2], internal_args
[3],
3056 internal_args
[4], internal_args
[5],
3061 val
= (*XSUBR (fun
)->function
) (internal_args
[0], internal_args
[1],
3062 internal_args
[2], internal_args
[3],
3063 internal_args
[4], internal_args
[5],
3064 internal_args
[6], internal_args
[7]);
3069 /* If a subr takes more than 8 arguments without using MANY
3070 or UNEVALLED, we need to extend this function to support it.
3071 Until this is done, there is no way to call the function. */
3075 if (COMPILEDP (fun
))
3076 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3079 if (EQ (fun
, Qunbound
))
3080 xsignal1 (Qvoid_function
, original_fun
);
3082 xsignal1 (Qinvalid_function
, original_fun
);
3083 funcar
= XCAR (fun
);
3084 if (!SYMBOLP (funcar
))
3085 xsignal1 (Qinvalid_function
, original_fun
);
3086 if (EQ (funcar
, Qlambda
))
3087 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3088 else if (EQ (funcar
, Qautoload
))
3090 do_autoload (fun
, original_fun
);
3095 xsignal1 (Qinvalid_function
, original_fun
);
3100 if (backtrace
.debug_on_exit
)
3101 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3102 backtrace_list
= backtrace
.next
;
3107 apply_lambda (fun
, args
, eval_flag
)
3108 Lisp_Object fun
, args
;
3111 Lisp_Object args_left
;
3112 Lisp_Object numargs
;
3113 register Lisp_Object
*arg_vector
;
3114 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3116 register Lisp_Object tem
;
3118 numargs
= Flength (args
);
3119 arg_vector
= (Lisp_Object
*) alloca (XINT (numargs
) * sizeof (Lisp_Object
));
3122 GCPRO3 (*arg_vector
, args_left
, fun
);
3125 for (i
= 0; i
< XINT (numargs
);)
3127 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3128 if (eval_flag
) tem
= Feval (tem
);
3129 arg_vector
[i
++] = tem
;
3137 backtrace_list
->args
= arg_vector
;
3138 backtrace_list
->nargs
= i
;
3140 backtrace_list
->evalargs
= 0;
3141 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
3143 /* Do the debug-on-exit now, while arg_vector still exists. */
3144 if (backtrace_list
->debug_on_exit
)
3145 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3146 /* Don't do it again when we return to eval. */
3147 backtrace_list
->debug_on_exit
= 0;
3151 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3152 and return the result of evaluation.
3153 FUN must be either a lambda-expression or a compiled-code object. */
3156 funcall_lambda (fun
, nargs
, arg_vector
)
3159 register Lisp_Object
*arg_vector
;
3161 Lisp_Object val
, syms_left
, next
;
3162 int count
= SPECPDL_INDEX ();
3163 int i
, optional
, rest
;
3167 syms_left
= XCDR (fun
);
3168 if (CONSP (syms_left
))
3169 syms_left
= XCAR (syms_left
);
3171 xsignal1 (Qinvalid_function
, fun
);
3173 else if (COMPILEDP (fun
))
3174 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3178 i
= optional
= rest
= 0;
3179 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3183 next
= XCAR (syms_left
);
3184 if (!SYMBOLP (next
))
3185 xsignal1 (Qinvalid_function
, fun
);
3187 if (EQ (next
, Qand_rest
))
3189 else if (EQ (next
, Qand_optional
))
3193 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3197 specbind (next
, arg_vector
[i
++]);
3199 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3201 specbind (next
, Qnil
);
3204 if (!NILP (syms_left
))
3205 xsignal1 (Qinvalid_function
, fun
);
3207 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3210 val
= Fprogn (XCDR (XCDR (fun
)));
3213 /* If we have not actually read the bytecode string
3214 and constants vector yet, fetch them from the file. */
3215 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3216 Ffetch_bytecode (fun
);
3217 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3218 AREF (fun
, COMPILED_CONSTANTS
),
3219 AREF (fun
, COMPILED_STACK_DEPTH
));
3222 return unbind_to (count
, val
);
3225 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3227 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3233 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3235 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3238 tem
= AREF (object
, COMPILED_BYTECODE
);
3239 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3240 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3242 error ("Invalid byte code");
3244 AREF (object
, COMPILED_BYTECODE
) = XCAR (tem
);
3245 AREF (object
, COMPILED_CONSTANTS
) = XCDR (tem
);
3253 register int count
= SPECPDL_INDEX ();
3254 if (specpdl_size
>= max_specpdl_size
)
3256 if (max_specpdl_size
< 400)
3257 max_specpdl_size
= 400;
3258 if (specpdl_size
>= max_specpdl_size
)
3259 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3262 if (specpdl_size
> max_specpdl_size
)
3263 specpdl_size
= max_specpdl_size
;
3264 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3265 specpdl_ptr
= specpdl
+ count
;
3269 specbind (symbol
, value
)
3270 Lisp_Object symbol
, value
;
3273 Lisp_Object valcontents
;
3275 CHECK_SYMBOL (symbol
);
3276 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3279 /* The most common case is that of a non-constant symbol with a
3280 trivial value. Make that as fast as we can. */
3281 valcontents
= SYMBOL_VALUE (symbol
);
3282 if (!MISCP (valcontents
) && !SYMBOL_CONSTANT_P (symbol
))
3284 specpdl_ptr
->symbol
= symbol
;
3285 specpdl_ptr
->old_value
= valcontents
;
3286 specpdl_ptr
->func
= NULL
;
3288 SET_SYMBOL_VALUE (symbol
, value
);
3292 Lisp_Object valcontents
;
3294 ovalue
= find_symbol_value (symbol
);
3295 specpdl_ptr
->func
= 0;
3296 specpdl_ptr
->old_value
= ovalue
;
3298 valcontents
= XSYMBOL (symbol
)->value
;
3300 if (BUFFER_LOCAL_VALUEP (valcontents
)
3301 || SOME_BUFFER_LOCAL_VALUEP (valcontents
)
3302 || BUFFER_OBJFWDP (valcontents
))
3304 Lisp_Object where
, current_buffer
;
3306 current_buffer
= Fcurrent_buffer ();
3308 /* For a local variable, record both the symbol and which
3309 buffer's or frame's value we are saving. */
3310 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3311 where
= current_buffer
;
3312 else if (!BUFFER_OBJFWDP (valcontents
)
3313 && XBUFFER_LOCAL_VALUE (valcontents
)->found_for_frame
)
3314 where
= XBUFFER_LOCAL_VALUE (valcontents
)->frame
;
3318 /* We're not using the `unused' slot in the specbinding
3319 structure because this would mean we have to do more
3320 work for simple variables. */
3321 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, current_buffer
));
3323 /* If SYMBOL is a per-buffer variable which doesn't have a
3324 buffer-local value here, make the `let' change the global
3325 value by changing the value of SYMBOL in all buffers not
3326 having their own value. This is consistent with what
3327 happens with other buffer-local variables. */
3329 && BUFFER_OBJFWDP (valcontents
))
3332 Fset_default (symbol
, value
);
3337 specpdl_ptr
->symbol
= symbol
;
3340 if (BUFFER_OBJFWDP (ovalue
) || KBOARD_OBJFWDP (ovalue
))
3341 store_symval_forwarding (symbol
, ovalue
, value
, NULL
);
3343 set_internal (symbol
, value
, 0, 1);
3348 record_unwind_protect (function
, arg
)
3349 Lisp_Object (*function
) P_ ((Lisp_Object
));
3352 eassert (!handling_signal
);
3354 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3356 specpdl_ptr
->func
= function
;
3357 specpdl_ptr
->symbol
= Qnil
;
3358 specpdl_ptr
->old_value
= arg
;
3363 unbind_to (count
, value
)
3367 Lisp_Object quitf
= Vquit_flag
;
3368 struct gcpro gcpro1
, gcpro2
;
3370 GCPRO2 (value
, quitf
);
3373 while (specpdl_ptr
!= specpdl
+ count
)
3375 /* Copy the binding, and decrement specpdl_ptr, before we do
3376 the work to unbind it. We decrement first
3377 so that an error in unbinding won't try to unbind
3378 the same entry again, and we copy the binding first
3379 in case more bindings are made during some of the code we run. */
3381 struct specbinding this_binding
;
3382 this_binding
= *--specpdl_ptr
;
3384 if (this_binding
.func
!= 0)
3385 (*this_binding
.func
) (this_binding
.old_value
);
3386 /* If the symbol is a list, it is really (SYMBOL WHERE
3387 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3388 frame. If WHERE is a buffer or frame, this indicates we
3389 bound a variable that had a buffer-local or frame-local
3390 binding. WHERE nil means that the variable had the default
3391 value when it was bound. CURRENT-BUFFER is the buffer that
3392 was current when the variable was bound. */
3393 else if (CONSP (this_binding
.symbol
))
3395 Lisp_Object symbol
, where
;
3397 symbol
= XCAR (this_binding
.symbol
);
3398 where
= XCAR (XCDR (this_binding
.symbol
));
3401 Fset_default (symbol
, this_binding
.old_value
);
3402 else if (BUFFERP (where
))
3403 set_internal (symbol
, this_binding
.old_value
, XBUFFER (where
), 1);
3405 set_internal (symbol
, this_binding
.old_value
, NULL
, 1);
3409 /* If variable has a trivial value (no forwarding), we can
3410 just set it. No need to check for constant symbols here,
3411 since that was already done by specbind. */
3412 if (!MISCP (SYMBOL_VALUE (this_binding
.symbol
)))
3413 SET_SYMBOL_VALUE (this_binding
.symbol
, this_binding
.old_value
);
3415 set_internal (this_binding
.symbol
, this_binding
.old_value
, 0, 1);
3419 if (NILP (Vquit_flag
) && !NILP (quitf
))
3426 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3427 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3428 The debugger is entered when that frame exits, if the flag is non-nil. */)
3430 Lisp_Object level
, flag
;
3432 register struct backtrace
*backlist
= backtrace_list
;
3435 CHECK_NUMBER (level
);
3437 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3439 backlist
= backlist
->next
;
3443 backlist
->debug_on_exit
= !NILP (flag
);
3448 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3449 doc
: /* Print a trace of Lisp function calls currently active.
3450 Output stream used is value of `standard-output'. */)
3453 register struct backtrace
*backlist
= backtrace_list
;
3457 extern Lisp_Object Vprint_level
;
3458 struct gcpro gcpro1
;
3460 XSETFASTINT (Vprint_level
, 3);
3467 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3468 if (backlist
->nargs
== UNEVALLED
)
3470 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3471 write_string ("\n", -1);
3475 tem
= *backlist
->function
;
3476 Fprin1 (tem
, Qnil
); /* This can QUIT */
3477 write_string ("(", -1);
3478 if (backlist
->nargs
== MANY
)
3480 for (tail
= *backlist
->args
, i
= 0;
3482 tail
= Fcdr (tail
), i
++)
3484 if (i
) write_string (" ", -1);
3485 Fprin1 (Fcar (tail
), Qnil
);
3490 for (i
= 0; i
< backlist
->nargs
; i
++)
3492 if (i
) write_string (" ", -1);
3493 Fprin1 (backlist
->args
[i
], Qnil
);
3496 write_string (")\n", -1);
3498 backlist
= backlist
->next
;
3501 Vprint_level
= Qnil
;
3506 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3507 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3508 If that frame has not evaluated the arguments yet (or is a special form),
3509 the value is (nil FUNCTION ARG-FORMS...).
3510 If that frame has evaluated its arguments and called its function already,
3511 the value is (t FUNCTION ARG-VALUES...).
3512 A &rest arg is represented as the tail of the list ARG-VALUES.
3513 FUNCTION is whatever was supplied as car of evaluated list,
3514 or a lambda expression for macro calls.
3515 If NFRAMES is more than the number of frames, the value is nil. */)
3517 Lisp_Object nframes
;
3519 register struct backtrace
*backlist
= backtrace_list
;
3523 CHECK_NATNUM (nframes
);
3525 /* Find the frame requested. */
3526 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3527 backlist
= backlist
->next
;
3531 if (backlist
->nargs
== UNEVALLED
)
3532 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3535 if (backlist
->nargs
== MANY
)
3536 tem
= *backlist
->args
;
3538 tem
= Flist (backlist
->nargs
, backlist
->args
);
3540 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3548 register struct backtrace
*backlist
;
3551 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3553 mark_object (*backlist
->function
);
3555 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3558 i
= backlist
->nargs
- 1;
3560 mark_object (backlist
->args
[i
]);
3567 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size
,
3568 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3569 If Lisp code tries to increase the total number past this amount,
3570 an error is signaled.
3571 You can safely use a value considerably larger than the default value,
3572 if that proves inconveniently small. However, if you increase it too far,
3573 Emacs could run out of memory trying to make the stack bigger. */);
3575 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth
,
3576 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3578 This limit serves to catch infinite recursions for you before they cause
3579 actual stack overflow in C, which would be fatal for Emacs.
3580 You can safely make it considerably larger than its default value,
3581 if that proves inconveniently small. However, if you increase it too far,
3582 Emacs could overflow the real C stack, and crash. */);
3584 DEFVAR_LISP ("quit-flag", &Vquit_flag
,
3585 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3586 If the value is t, that means do an ordinary quit.
3587 If the value equals `throw-on-input', that means quit by throwing
3588 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3589 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3590 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3593 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit
,
3594 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3595 Note that `quit-flag' will still be set by typing C-g,
3596 so a quit will be signaled as soon as `inhibit-quit' is nil.
3597 To prevent this happening, set `quit-flag' to nil
3598 before making `inhibit-quit' nil. */);
3599 Vinhibit_quit
= Qnil
;
3601 Qinhibit_quit
= intern ("inhibit-quit");
3602 staticpro (&Qinhibit_quit
);
3604 Qautoload
= intern ("autoload");
3605 staticpro (&Qautoload
);
3607 Qdebug_on_error
= intern ("debug-on-error");
3608 staticpro (&Qdebug_on_error
);
3610 Qmacro
= intern ("macro");
3611 staticpro (&Qmacro
);
3613 Qdeclare
= intern ("declare");
3614 staticpro (&Qdeclare
);
3616 /* Note that the process handling also uses Qexit, but we don't want
3617 to staticpro it twice, so we just do it here. */
3618 Qexit
= intern ("exit");
3621 Qinteractive
= intern ("interactive");
3622 staticpro (&Qinteractive
);
3624 Qcommandp
= intern ("commandp");
3625 staticpro (&Qcommandp
);
3627 Qdefun
= intern ("defun");
3628 staticpro (&Qdefun
);
3630 Qand_rest
= intern ("&rest");
3631 staticpro (&Qand_rest
);
3633 Qand_optional
= intern ("&optional");
3634 staticpro (&Qand_optional
);
3636 Qdebug
= intern ("debug");
3637 staticpro (&Qdebug
);
3639 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error
,
3640 doc
: /* *Non-nil means errors display a backtrace buffer.
3641 More precisely, this happens for any error that is handled
3642 by the editor command loop.
3643 If the value is a list, an error only means to display a backtrace
3644 if one of its condition symbols appears in the list. */);
3645 Vstack_trace_on_error
= Qnil
;
3647 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error
,
3648 doc
: /* *Non-nil means enter debugger if an error is signaled.
3649 Does not apply to errors handled by `condition-case' or those
3650 matched by `debug-ignored-errors'.
3651 If the value is a list, an error only means to enter the debugger
3652 if one of its condition symbols appears in the list.
3653 When you evaluate an expression interactively, this variable
3654 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3655 See also variable `debug-on-quit'. */);
3656 Vdebug_on_error
= Qnil
;
3658 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors
,
3659 doc
: /* *List of errors for which the debugger should not be called.
3660 Each element may be a condition-name or a regexp that matches error messages.
3661 If any element applies to a given error, that error skips the debugger
3662 and just returns to top level.
3663 This overrides the variable `debug-on-error'.
3664 It does not apply to errors handled by `condition-case'. */);
3665 Vdebug_ignored_errors
= Qnil
;
3667 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit
,
3668 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3669 Does not apply if quit is handled by a `condition-case'. */);
3672 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call
,
3673 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3675 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue
,
3676 doc
: /* Non-nil means debugger may continue execution.
3677 This is nil when the debugger is called under circumstances where it
3678 might not be safe to continue. */);
3679 debugger_may_continue
= 1;
3681 DEFVAR_LISP ("debugger", &Vdebugger
,
3682 doc
: /* Function to call to invoke debugger.
3683 If due to frame exit, args are `exit' and the value being returned;
3684 this function's value will be returned instead of that.
3685 If due to error, args are `error' and a list of the args to `signal'.
3686 If due to `apply' or `funcall' entry, one arg, `lambda'.
3687 If due to `eval' entry, one arg, t. */);
3690 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function
,
3691 doc
: /* If non-nil, this is a function for `signal' to call.
3692 It receives the same arguments that `signal' was given.
3693 The Edebug package uses this to regain control. */);
3694 Vsignal_hook_function
= Qnil
;
3696 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal
,
3697 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3698 Note that `debug-on-error', `debug-on-quit' and friends
3699 still determine whether to handle the particular condition. */);
3700 Vdebug_on_signal
= Qnil
;
3702 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function
,
3703 doc
: /* Function to process declarations in a macro definition.
3704 The function will be called with two args MACRO and DECL.
3705 MACRO is the name of the macro being defined.
3706 DECL is a list `(declare ...)' containing the declarations.
3707 The value the function returns is not used. */);
3708 Vmacro_declaration_function
= Qnil
;
3710 Vrun_hooks
= intern ("run-hooks");
3711 staticpro (&Vrun_hooks
);
3713 staticpro (&Vautoload_queue
);
3714 Vautoload_queue
= Qnil
;
3715 staticpro (&Vsignaling_function
);
3716 Vsignaling_function
= Qnil
;
3727 defsubr (&Sfunction
);
3729 defsubr (&Sdefmacro
);
3731 defsubr (&Sdefvaralias
);
3732 defsubr (&Sdefconst
);
3733 defsubr (&Suser_variable_p
);
3737 defsubr (&Smacroexpand
);
3740 defsubr (&Sunwind_protect
);
3741 defsubr (&Scondition_case
);
3743 defsubr (&Sinteractive_p
);
3744 defsubr (&Scalled_interactively_p
);
3745 defsubr (&Scommandp
);
3746 defsubr (&Sautoload
);
3749 defsubr (&Sfuncall
);
3750 defsubr (&Srun_hooks
);
3751 defsubr (&Srun_hook_with_args
);
3752 defsubr (&Srun_hook_with_args_until_success
);
3753 defsubr (&Srun_hook_with_args_until_failure
);
3754 defsubr (&Sfetch_bytecode
);
3755 defsubr (&Sbacktrace_debug
);
3756 defsubr (&Sbacktrace
);
3757 defsubr (&Sbacktrace_frame
);
3760 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3761 (do not change this comment) */