1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1999-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include "blockinput.h"
26 #include "dispextern.h"
27 #include "frame.h" /* For XFRAME. */
33 /* This definition is duplicated in alloc.c and keyboard.c */
34 /* Putting it in lisp.h makes cc bomb out! */
38 struct backtrace
*next
;
39 Lisp_Object
*function
;
40 Lisp_Object
*args
; /* Points to vector of args. */
41 int nargs
; /* Length of vector.
42 If nargs is UNEVALLED, args points to slot holding
43 list of unevalled args */
45 /* Nonzero means call value of debugger when done with this operation. */
49 struct backtrace
*backtrace_list
;
51 struct catchtag
*catchlist
;
54 /* Count levels of GCPRO to detect failure to UNGCPRO. */
58 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
59 Lisp_Object Qinhibit_quit
;
60 Lisp_Object Qand_rest
, Qand_optional
;
61 Lisp_Object Qdebug_on_error
;
65 /* This holds either the symbol `run-hooks' or nil.
66 It is nil at an early stage of startup, and when Emacs
69 Lisp_Object Vrun_hooks
;
71 /* Non-nil means record all fset's and provide's, to be undone
72 if the file being autoloaded is not fully loaded.
73 They are recorded by being consed onto the front of Vautoload_queue:
74 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
76 Lisp_Object Vautoload_queue
;
78 /* Current number of specbindings allocated in specpdl. */
80 EMACS_INT specpdl_size
;
82 /* Pointer to beginning of specpdl. */
84 struct specbinding
*specpdl
;
86 /* Pointer to first unused element in specpdl. */
88 struct specbinding
*specpdl_ptr
;
90 /* Depth in Lisp evaluations and function calls. */
92 EMACS_INT lisp_eval_depth
;
94 /* The value of num_nonmacro_input_events as of the last time we
95 started to enter the debugger. If we decide to enter the debugger
96 again when this is still equal to num_nonmacro_input_events, then we
97 know that the debugger itself has an error, and we should just
98 signal the error instead of entering an infinite loop of debugger
101 int when_entered_debugger
;
103 /* The function from which the last `signal' was called. Set in
106 Lisp_Object Vsignaling_function
;
108 /* Set to non-zero while processing X events. Checked in Feval to
109 make sure the Lisp interpreter isn't called from a signal handler,
110 which is unsafe because the interpreter isn't reentrant. */
114 static Lisp_Object
funcall_lambda (Lisp_Object
, int, Lisp_Object
*);
115 static void unwind_to_catch (struct catchtag
*, Lisp_Object
) NO_RETURN
;
116 static int interactive_p (int);
117 static Lisp_Object
apply_lambda (Lisp_Object
, Lisp_Object
, int);
120 init_eval_once (void)
123 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
124 specpdl_ptr
= specpdl
;
125 /* Don't forget to update docs (lispref node "Local Variables"). */
126 max_specpdl_size
= 1000;
127 max_lisp_eval_depth
= 600;
135 specpdl_ptr
= specpdl
;
140 debug_on_next_call
= 0;
145 /* This is less than the initial value of num_nonmacro_input_events. */
146 when_entered_debugger
= -1;
149 /* unwind-protect function used by call_debugger. */
152 restore_stack_limits (Lisp_Object data
)
154 max_specpdl_size
= XINT (XCAR (data
));
155 max_lisp_eval_depth
= XINT (XCDR (data
));
159 /* Call the Lisp debugger, giving it argument ARG. */
162 call_debugger (Lisp_Object arg
)
164 int debug_while_redisplaying
;
165 int count
= SPECPDL_INDEX ();
167 EMACS_INT old_max
= max_specpdl_size
;
169 /* Temporarily bump up the stack limits,
170 so the debugger won't run out of stack. */
172 max_specpdl_size
+= 1;
173 record_unwind_protect (restore_stack_limits
,
174 Fcons (make_number (old_max
),
175 make_number (max_lisp_eval_depth
)));
176 max_specpdl_size
= old_max
;
178 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
179 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
181 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
182 max_specpdl_size
= SPECPDL_INDEX () + 100;
184 #ifdef HAVE_WINDOW_SYSTEM
185 if (display_hourglass_p
)
189 debug_on_next_call
= 0;
190 when_entered_debugger
= num_nonmacro_input_events
;
192 /* Resetting redisplaying_p to 0 makes sure that debug output is
193 displayed if the debugger is invoked during redisplay. */
194 debug_while_redisplaying
= redisplaying_p
;
196 specbind (intern ("debugger-may-continue"),
197 debug_while_redisplaying
? Qnil
: Qt
);
198 specbind (Qinhibit_redisplay
, Qnil
);
199 specbind (Qdebug_on_error
, Qnil
);
201 #if 0 /* Binding this prevents execution of Lisp code during
202 redisplay, which necessarily leads to display problems. */
203 specbind (Qinhibit_eval_during_redisplay
, Qt
);
206 val
= apply1 (Vdebugger
, arg
);
208 /* Interrupting redisplay and resuming it later is not safe under
209 all circumstances. So, when the debugger returns, abort the
210 interrupted redisplay by going back to the top-level. */
211 if (debug_while_redisplaying
)
214 return unbind_to (count
, val
);
218 do_debug_on_call (Lisp_Object code
)
220 debug_on_next_call
= 0;
221 backtrace_list
->debug_on_exit
= 1;
222 call_debugger (Fcons (code
, Qnil
));
225 /* NOTE!!! Every function that can call EVAL must protect its args
226 and temporaries from garbage collection while it needs them.
227 The definition of `For' shows what you have to do. */
229 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
230 doc
: /* Eval args until one of them yields non-nil, then return that value.
231 The remaining args are not evalled at all.
232 If all args return nil, return nil.
233 usage: (or CONDITIONS...) */)
236 register Lisp_Object val
= Qnil
;
243 val
= Feval (XCAR (args
));
253 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
254 doc
: /* Eval args until one of them yields nil, then return nil.
255 The remaining args are not evalled at all.
256 If no arg yields nil, return the last arg's value.
257 usage: (and CONDITIONS...) */)
260 register Lisp_Object val
= Qt
;
267 val
= Feval (XCAR (args
));
277 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
278 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
279 Returns the value of THEN or the value of the last of the ELSE's.
280 THEN must be one expression, but ELSE... can be zero or more expressions.
281 If COND yields nil, and there are no ELSE's, the value is nil.
282 usage: (if COND THEN ELSE...) */)
285 register Lisp_Object cond
;
289 cond
= Feval (Fcar (args
));
293 return Feval (Fcar (Fcdr (args
)));
294 return Fprogn (Fcdr (Fcdr (args
)));
297 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
298 doc
: /* Try each clause until one succeeds.
299 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
300 and, if the value is non-nil, this clause succeeds:
301 then the expressions in BODY are evaluated and the last one's
302 value is the value of the cond-form.
303 If no clause succeeds, cond returns nil.
304 If a clause has one element, as in (CONDITION),
305 CONDITION's value if non-nil is returned from the cond-form.
306 usage: (cond CLAUSES...) */)
309 register Lisp_Object clause
, val
;
316 clause
= Fcar (args
);
317 val
= Feval (Fcar (clause
));
320 if (!EQ (XCDR (clause
), Qnil
))
321 val
= Fprogn (XCDR (clause
));
331 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
332 doc
: /* Eval BODY forms sequentially and return value of last one.
333 usage: (progn BODY...) */)
336 register Lisp_Object val
= Qnil
;
343 val
= Feval (XCAR (args
));
351 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
352 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
353 The value of FIRST is saved during the evaluation of the remaining args,
354 whose values are discarded.
355 usage: (prog1 FIRST BODY...) */)
359 register Lisp_Object args_left
;
360 struct gcpro gcpro1
, gcpro2
;
361 register int argnum
= 0;
373 val
= Feval (Fcar (args_left
));
375 Feval (Fcar (args_left
));
376 args_left
= Fcdr (args_left
);
378 while (!NILP(args_left
));
384 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
385 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
386 The value of FORM2 is saved during the evaluation of the
387 remaining args, whose values are discarded.
388 usage: (prog2 FORM1 FORM2 BODY...) */)
392 register Lisp_Object args_left
;
393 struct gcpro gcpro1
, gcpro2
;
394 register int argnum
= -1;
408 val
= Feval (Fcar (args_left
));
410 Feval (Fcar (args_left
));
411 args_left
= Fcdr (args_left
);
413 while (!NILP (args_left
));
419 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
420 doc
: /* Set each SYM to the value of its VAL.
421 The symbols SYM are variables; they are literal (not evaluated).
422 The values VAL are expressions; they are evaluated.
423 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
424 The second VAL is not computed until after the first SYM is set, and so on;
425 each VAL can use the new value of variables set earlier in the `setq'.
426 The return value of the `setq' form is the value of the last VAL.
427 usage: (setq [SYM VAL]...) */)
430 register Lisp_Object args_left
;
431 register Lisp_Object val
, sym
;
442 val
= Feval (Fcar (Fcdr (args_left
)));
443 sym
= Fcar (args_left
);
445 args_left
= Fcdr (Fcdr (args_left
));
447 while (!NILP(args_left
));
453 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
454 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
455 usage: (quote ARG) */)
458 if (!NILP (Fcdr (args
)))
459 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
463 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
464 doc
: /* Like `quote', but preferred for objects which are functions.
465 In byte compilation, `function' causes its argument to be compiled.
466 `quote' cannot do that.
467 usage: (function ARG) */)
470 if (!NILP (Fcdr (args
)))
471 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
476 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
477 doc
: /* Return t if the containing function was run directly by user input.
478 This means that the function was called with `call-interactively'
479 \(which includes being called as the binding of a key)
480 and input is currently coming from the keyboard (not a keyboard macro),
481 and Emacs is not running in batch mode (`noninteractive' is nil).
483 The only known proper use of `interactive-p' is in deciding whether to
484 display a helpful message, or how to display it. If you're thinking
485 of using it for any other purpose, it is quite likely that you're
486 making a mistake. Think: what do you want to do when the command is
487 called from a keyboard macro?
489 To test whether your function was called with `call-interactively',
490 either (i) add an extra optional argument and give it an `interactive'
491 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
492 use `called-interactively-p'. */)
495 return (INTERACTIVE
&& interactive_p (1)) ? Qt
: Qnil
;
499 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
500 doc
: /* Return t if the containing function was called by `call-interactively'.
501 If KIND is `interactive', then only return t if the call was made
502 interactively by the user, i.e. not in `noninteractive' mode nor
503 when `executing-kbd-macro'.
504 If KIND is `any', on the other hand, it will return t for any kind of
505 interactive call, including being called as the binding of a key, or
506 from a keyboard macro, or in `noninteractive' mode.
508 The only known proper use of `interactive' for KIND is in deciding
509 whether to display a helpful message, or how to display it. If you're
510 thinking of using it for any other purpose, it is quite likely that
511 you're making a mistake. Think: what do you want to do when the
512 command is called from a keyboard macro?
514 This function is meant for implementing advice and other
515 function-modifying features. Instead of using this, it is sometimes
516 cleaner to give your function an extra optional argument whose
517 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
518 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
521 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
522 && interactive_p (1)) ? Qt
: Qnil
;
526 /* Return 1 if function in which this appears was called using
529 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
530 called is a built-in. */
533 interactive_p (int exclude_subrs_p
)
535 struct backtrace
*btp
;
538 btp
= backtrace_list
;
540 /* If this isn't a byte-compiled function, there may be a frame at
541 the top for Finteractive_p. If so, skip it. */
542 fun
= Findirect_function (*btp
->function
, Qnil
);
543 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
544 || XSUBR (fun
) == &Scalled_interactively_p
))
547 /* If we're running an Emacs 18-style byte-compiled function, there
548 may be a frame for Fbytecode at the top level. In any version of
549 Emacs there can be Fbytecode frames for subexpressions evaluated
550 inside catch and condition-case. Skip past them.
552 If this isn't a byte-compiled function, then we may now be
553 looking at several frames for special forms. Skip past them. */
555 && (EQ (*btp
->function
, Qbytecode
)
556 || btp
->nargs
== UNEVALLED
))
559 /* btp now points at the frame of the innermost function that isn't
560 a special form, ignoring frames for Finteractive_p and/or
561 Fbytecode at the top. If this frame is for a built-in function
562 (such as load or eval-region) return nil. */
563 fun
= Findirect_function (*btp
->function
, Qnil
);
564 if (exclude_subrs_p
&& SUBRP (fun
))
567 /* btp points to the frame of a Lisp function that called interactive-p.
568 Return t if that function was called interactively. */
569 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
575 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
576 doc
: /* Define NAME as a function.
577 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
578 See also the function `interactive'.
579 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
582 register Lisp_Object fn_name
;
583 register Lisp_Object defn
;
585 fn_name
= Fcar (args
);
586 CHECK_SYMBOL (fn_name
);
587 defn
= Fcons (Qlambda
, Fcdr (args
));
588 if (!NILP (Vpurify_flag
))
589 defn
= Fpurecopy (defn
);
590 if (CONSP (XSYMBOL (fn_name
)->function
)
591 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
592 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
593 Ffset (fn_name
, defn
);
594 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
598 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
599 doc
: /* Define NAME as a macro.
600 The actual definition looks like
601 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
602 When the macro is called, as in (NAME ARGS...),
603 the function (lambda ARGLIST BODY...) is applied to
604 the list ARGS... as it appears in the expression,
605 and the result should be a form to be evaluated instead of the original.
607 DECL is a declaration, optional, which can specify how to indent
608 calls to this macro, how Edebug should handle it, and which argument
609 should be treated as documentation. It looks like this:
611 The elements can look like this:
613 Set NAME's `lisp-indent-function' property to INDENT.
616 Set NAME's `edebug-form-spec' property to DEBUG. (This is
617 equivalent to writing a `def-edebug-spec' for the macro.)
620 Set NAME's `doc-string-elt' property to ELT.
622 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
625 register Lisp_Object fn_name
;
626 register Lisp_Object defn
;
627 Lisp_Object lambda_list
, doc
, tail
;
629 fn_name
= Fcar (args
);
630 CHECK_SYMBOL (fn_name
);
631 lambda_list
= Fcar (Fcdr (args
));
632 tail
= Fcdr (Fcdr (args
));
635 if (STRINGP (Fcar (tail
)))
641 if (CONSP (Fcar (tail
))
642 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
644 if (!NILP (Vmacro_declaration_function
))
648 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
656 tail
= Fcons (lambda_list
, tail
);
658 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
659 defn
= Fcons (Qmacro
, Fcons (Qlambda
, tail
));
661 if (!NILP (Vpurify_flag
))
662 defn
= Fpurecopy (defn
);
663 if (CONSP (XSYMBOL (fn_name
)->function
)
664 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
665 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
666 Ffset (fn_name
, defn
);
667 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
672 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
673 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
674 Aliased variables always have the same value; setting one sets the other.
675 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
676 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
677 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
678 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
679 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
680 The return value is BASE-VARIABLE. */)
681 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
683 struct Lisp_Symbol
*sym
;
685 CHECK_SYMBOL (new_alias
);
686 CHECK_SYMBOL (base_variable
);
688 sym
= XSYMBOL (new_alias
);
691 /* Not sure why, but why not? */
692 error ("Cannot make a constant an alias");
694 switch (sym
->redirect
)
696 case SYMBOL_FORWARDED
:
697 error ("Cannot make an internal variable an alias");
698 case SYMBOL_LOCALIZED
:
699 error ("Don't know how to make a localized variable an alias");
702 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
703 If n_a is bound, but b_v is not, set the value of b_v to n_a,
704 so that old-code that affects n_a before the aliasing is setup
706 if (NILP (Fboundp (base_variable
)))
707 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
710 struct specbinding
*p
;
712 for (p
= specpdl_ptr
- 1; p
>= specpdl
; p
--)
715 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
716 error ("Don't know how to make a let-bound variable an alias");
719 sym
->redirect
= SYMBOL_VARALIAS
;
720 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
721 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
722 LOADHIST_ATTACH (new_alias
);
723 /* Even if docstring is nil: remove old docstring. */
724 Fput (new_alias
, Qvariable_documentation
, docstring
);
726 return base_variable
;
730 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
731 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
732 You are not required to define a variable in order to use it,
733 but the definition can supply documentation and an initial value
734 in a way that tags can recognize.
736 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
737 If SYMBOL is buffer-local, its default value is what is set;
738 buffer-local values are not affected.
739 INITVALUE and DOCSTRING are optional.
740 If DOCSTRING starts with *, this variable is identified as a user option.
741 This means that M-x set-variable recognizes it.
742 See also `user-variable-p'.
743 If INITVALUE is missing, SYMBOL's value is not set.
745 If SYMBOL has a local binding, then this form affects the local
746 binding. This is usually not what you want. Thus, if you need to
747 load a file defining variables, with this form or with `defconst' or
748 `defcustom', you should always load that file _outside_ any bindings
749 for these variables. \(`defconst' and `defcustom' behave similarly in
751 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
754 register Lisp_Object sym
, tem
, tail
;
758 if (!NILP (Fcdr (Fcdr (tail
))))
759 error ("Too many arguments");
761 tem
= Fdefault_boundp (sym
);
764 if (SYMBOL_CONSTANT_P (sym
))
766 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
767 Lisp_Object tem
= Fcar (tail
);
769 && EQ (XCAR (tem
), Qquote
)
770 && CONSP (XCDR (tem
))
771 && EQ (XCAR (XCDR (tem
)), sym
)))
772 error ("Constant symbol `%s' specified in defvar",
773 SDATA (SYMBOL_NAME (sym
)));
777 Fset_default (sym
, Feval (Fcar (tail
)));
779 { /* Check if there is really a global binding rather than just a let
780 binding that shadows the global unboundness of the var. */
781 volatile struct specbinding
*pdl
= specpdl_ptr
;
782 while (--pdl
>= specpdl
)
784 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
785 && EQ (pdl
->old_value
, Qunbound
))
787 message_with_string ("Warning: defvar ignored because %s is let-bound",
788 SYMBOL_NAME (sym
), 1);
797 if (!NILP (Vpurify_flag
))
798 tem
= Fpurecopy (tem
);
799 Fput (sym
, Qvariable_documentation
, tem
);
801 LOADHIST_ATTACH (sym
);
804 /* Simple (defvar <var>) should not count as a definition at all.
805 It could get in the way of other definitions, and unloading this
806 package could try to make the variable unbound. */
812 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
813 doc
: /* Define SYMBOL as a constant variable.
814 The intent is that neither programs nor users should ever change this value.
815 Always sets the value of SYMBOL to the result of evalling INITVALUE.
816 If SYMBOL is buffer-local, its default value is what is set;
817 buffer-local values are not affected.
818 DOCSTRING is optional.
820 If SYMBOL has a local binding, then this form sets the local binding's
821 value. However, you should normally not make local bindings for
822 variables defined with this form.
823 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
826 register Lisp_Object sym
, tem
;
829 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
830 error ("Too many arguments");
832 tem
= Feval (Fcar (Fcdr (args
)));
833 if (!NILP (Vpurify_flag
))
834 tem
= Fpurecopy (tem
);
835 Fset_default (sym
, tem
);
836 tem
= Fcar (Fcdr (Fcdr (args
)));
839 if (!NILP (Vpurify_flag
))
840 tem
= Fpurecopy (tem
);
841 Fput (sym
, Qvariable_documentation
, tem
);
843 Fput (sym
, Qrisky_local_variable
, Qt
);
844 LOADHIST_ATTACH (sym
);
848 /* Error handler used in Fuser_variable_p. */
850 user_variable_p_eh (Lisp_Object ignore
)
856 lisp_indirect_variable (Lisp_Object sym
)
858 XSETSYMBOL (sym
, indirect_variable (XSYMBOL (sym
)));
862 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
863 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
864 \(The alternative is a variable used internally in a Lisp program.)
865 A variable is a user variable if
866 \(1) the first character of its documentation is `*', or
867 \(2) it is customizable (its property list contains a non-nil value
868 of `standard-value' or `custom-autoload'), or
869 \(3) it is an alias for another user variable.
870 Return nil if VARIABLE is an alias and there is a loop in the
871 chain of symbols. */)
872 (Lisp_Object variable
)
874 Lisp_Object documentation
;
876 if (!SYMBOLP (variable
))
879 /* If indirect and there's an alias loop, don't check anything else. */
880 if (XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
881 && NILP (internal_condition_case_1 (lisp_indirect_variable
, variable
,
882 Qt
, user_variable_p_eh
)))
887 documentation
= Fget (variable
, Qvariable_documentation
);
888 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
890 if (STRINGP (documentation
)
891 && ((unsigned char) SREF (documentation
, 0) == '*'))
893 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
894 if (CONSP (documentation
)
895 && STRINGP (XCAR (documentation
))
896 && INTEGERP (XCDR (documentation
))
897 && XINT (XCDR (documentation
)) < 0)
899 /* Customizable? See `custom-variable-p'. */
900 if ((!NILP (Fget (variable
, intern ("standard-value"))))
901 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
904 if (!(XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
))
907 /* An indirect variable? Let's follow the chain. */
908 XSETSYMBOL (variable
, SYMBOL_ALIAS (XSYMBOL (variable
)));
912 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
913 doc
: /* Bind variables according to VARLIST then eval BODY.
914 The value of the last form in BODY is returned.
915 Each element of VARLIST is a symbol (which is bound to nil)
916 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
917 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
918 usage: (let* VARLIST BODY...) */)
921 Lisp_Object varlist
, val
, elt
;
922 int count
= SPECPDL_INDEX ();
923 struct gcpro gcpro1
, gcpro2
, gcpro3
;
925 GCPRO3 (args
, elt
, varlist
);
927 varlist
= Fcar (args
);
928 while (!NILP (varlist
))
931 elt
= Fcar (varlist
);
933 specbind (elt
, Qnil
);
934 else if (! NILP (Fcdr (Fcdr (elt
))))
935 signal_error ("`let' bindings can have only one value-form", elt
);
938 val
= Feval (Fcar (Fcdr (elt
)));
939 specbind (Fcar (elt
), val
);
941 varlist
= Fcdr (varlist
);
944 val
= Fprogn (Fcdr (args
));
945 return unbind_to (count
, val
);
948 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
949 doc
: /* Bind variables according to VARLIST then eval BODY.
950 The value of the last form in BODY is returned.
951 Each element of VARLIST is a symbol (which is bound to nil)
952 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
953 All the VALUEFORMs are evalled before any symbols are bound.
954 usage: (let VARLIST BODY...) */)
957 Lisp_Object
*temps
, tem
;
958 register Lisp_Object elt
, varlist
;
959 int count
= SPECPDL_INDEX ();
961 struct gcpro gcpro1
, gcpro2
;
964 varlist
= Fcar (args
);
966 /* Make space to hold the values to give the bound variables */
967 elt
= Flength (varlist
);
968 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
970 /* Compute the values and store them in `temps' */
972 GCPRO2 (args
, *temps
);
975 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
978 elt
= XCAR (varlist
);
980 temps
[argnum
++] = Qnil
;
981 else if (! NILP (Fcdr (Fcdr (elt
))))
982 signal_error ("`let' bindings can have only one value-form", elt
);
984 temps
[argnum
++] = Feval (Fcar (Fcdr (elt
)));
985 gcpro2
.nvars
= argnum
;
989 varlist
= Fcar (args
);
990 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
992 elt
= XCAR (varlist
);
993 tem
= temps
[argnum
++];
997 specbind (Fcar (elt
), tem
);
1000 elt
= Fprogn (Fcdr (args
));
1002 return unbind_to (count
, elt
);
1005 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1006 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1007 The order of execution is thus TEST, BODY, TEST, BODY and so on
1008 until TEST returns nil.
1009 usage: (while TEST BODY...) */)
1012 Lisp_Object test
, body
;
1013 struct gcpro gcpro1
, gcpro2
;
1015 GCPRO2 (test
, body
);
1019 while (!NILP (Feval (test
)))
1029 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1030 doc
: /* Return result of expanding macros at top level of FORM.
1031 If FORM is not a macro call, it is returned unchanged.
1032 Otherwise, the macro is expanded and the expansion is considered
1033 in place of FORM. When a non-macro-call results, it is returned.
1035 The second optional arg ENVIRONMENT specifies an environment of macro
1036 definitions to shadow the loaded ones for use in file byte-compilation. */)
1037 (Lisp_Object form
, Lisp_Object environment
)
1039 /* With cleanups from Hallvard Furuseth. */
1040 register Lisp_Object expander
, sym
, def
, tem
;
1044 /* Come back here each time we expand a macro call,
1045 in case it expands into another macro call. */
1048 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1049 def
= sym
= XCAR (form
);
1051 /* Trace symbols aliases to other symbols
1052 until we get a symbol that is not an alias. */
1053 while (SYMBOLP (def
))
1057 tem
= Fassq (sym
, environment
);
1060 def
= XSYMBOL (sym
)->function
;
1061 if (!EQ (def
, Qunbound
))
1066 /* Right now TEM is the result from SYM in ENVIRONMENT,
1067 and if TEM is nil then DEF is SYM's function definition. */
1070 /* SYM is not mentioned in ENVIRONMENT.
1071 Look at its function definition. */
1072 if (EQ (def
, Qunbound
) || !CONSP (def
))
1073 /* Not defined or definition not suitable */
1075 if (EQ (XCAR (def
), Qautoload
))
1077 /* Autoloading function: will it be a macro when loaded? */
1078 tem
= Fnth (make_number (4), def
);
1079 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1080 /* Yes, load it and try again. */
1082 struct gcpro gcpro1
;
1084 do_autoload (def
, sym
);
1091 else if (!EQ (XCAR (def
), Qmacro
))
1093 else expander
= XCDR (def
);
1097 expander
= XCDR (tem
);
1098 if (NILP (expander
))
1101 form
= apply1 (expander
, XCDR (form
));
1106 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1107 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1108 TAG is evalled to get the tag to use; it must not be nil.
1110 Then the BODY is executed.
1111 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1112 If no throw happens, `catch' returns the value of the last BODY form.
1113 If a throw happens, it specifies the value to return from `catch'.
1114 usage: (catch TAG BODY...) */)
1117 register Lisp_Object tag
;
1118 struct gcpro gcpro1
;
1121 tag
= Feval (Fcar (args
));
1123 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1126 /* Set up a catch, then call C function FUNC on argument ARG.
1127 FUNC should return a Lisp_Object.
1128 This is how catches are done from within C code. */
1131 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1133 /* This structure is made part of the chain `catchlist'. */
1136 /* Fill in the components of c, and put it on the list. */
1140 c
.backlist
= backtrace_list
;
1141 c
.handlerlist
= handlerlist
;
1142 c
.lisp_eval_depth
= lisp_eval_depth
;
1143 c
.pdlcount
= SPECPDL_INDEX ();
1144 c
.poll_suppress_count
= poll_suppress_count
;
1145 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1146 c
.gcpro
= gcprolist
;
1147 c
.byte_stack
= byte_stack_list
;
1151 if (! _setjmp (c
.jmp
))
1152 c
.val
= (*func
) (arg
);
1154 /* Throw works by a longjmp that comes right here. */
1159 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1160 jump to that CATCH, returning VALUE as the value of that catch.
1162 This is the guts Fthrow and Fsignal; they differ only in the way
1163 they choose the catch tag to throw to. A catch tag for a
1164 condition-case form has a TAG of Qnil.
1166 Before each catch is discarded, unbind all special bindings and
1167 execute all unwind-protect clauses made above that catch. Unwind
1168 the handler stack as we go, so that the proper handlers are in
1169 effect for each unwind-protect clause we run. At the end, restore
1170 some static info saved in CATCH, and longjmp to the location
1173 This is used for correct unwinding in Fthrow and Fsignal. */
1176 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1178 register int last_time
;
1180 /* Save the value in the tag. */
1183 /* Restore certain special C variables. */
1184 set_poll_suppress_count (catch->poll_suppress_count
);
1185 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1186 handling_signal
= 0;
1191 last_time
= catchlist
== catch;
1193 /* Unwind the specpdl stack, and then restore the proper set of
1195 unbind_to (catchlist
->pdlcount
, Qnil
);
1196 handlerlist
= catchlist
->handlerlist
;
1197 catchlist
= catchlist
->next
;
1199 while (! last_time
);
1202 /* If x_catch_errors was done, turn it off now.
1203 (First we give unbind_to a chance to do that.) */
1204 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1205 The catch must remain in effect during that delicate
1206 state. --lorentey */
1207 x_fully_uncatch_errors ();
1211 byte_stack_list
= catch->byte_stack
;
1212 gcprolist
= catch->gcpro
;
1215 gcpro_level
= gcprolist
->level
+ 1;
1219 backtrace_list
= catch->backlist
;
1220 lisp_eval_depth
= catch->lisp_eval_depth
;
1222 _longjmp (catch->jmp
, 1);
1225 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1226 doc
: /* Throw to the catch for TAG and return VALUE from it.
1227 Both TAG and VALUE are evalled. */)
1228 (register Lisp_Object tag
, Lisp_Object value
)
1230 register struct catchtag
*c
;
1233 for (c
= catchlist
; c
; c
= c
->next
)
1235 if (EQ (c
->tag
, tag
))
1236 unwind_to_catch (c
, value
);
1238 xsignal2 (Qno_catch
, tag
, value
);
1242 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1243 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1244 If BODYFORM completes normally, its value is returned
1245 after executing the UNWINDFORMS.
1246 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1247 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1251 int count
= SPECPDL_INDEX ();
1253 record_unwind_protect (Fprogn
, Fcdr (args
));
1254 val
= Feval (Fcar (args
));
1255 return unbind_to (count
, val
);
1258 /* Chain of condition handlers currently in effect.
1259 The elements of this chain are contained in the stack frames
1260 of Fcondition_case and internal_condition_case.
1261 When an error is signaled (by calling Fsignal, below),
1262 this chain is searched for an element that applies. */
1264 struct handler
*handlerlist
;
1266 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1267 doc
: /* Regain control when an error is signaled.
1268 Executes BODYFORM and returns its value if no error happens.
1269 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1270 where the BODY is made of Lisp expressions.
1272 A handler is applicable to an error
1273 if CONDITION-NAME is one of the error's condition names.
1274 If an error happens, the first applicable handler is run.
1276 The car of a handler may be a list of condition names
1277 instead of a single condition name. Then it handles all of them.
1279 When a handler handles an error, control returns to the `condition-case'
1280 and it executes the handler's BODY...
1281 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1282 \(If VAR is nil, the handler can't access that information.)
1283 Then the value of the last BODY form is returned from the `condition-case'
1286 See also the function `signal' for more info.
1287 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1290 register Lisp_Object bodyform
, handlers
;
1291 volatile Lisp_Object var
;
1294 bodyform
= Fcar (Fcdr (args
));
1295 handlers
= Fcdr (Fcdr (args
));
1297 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1300 /* Like Fcondition_case, but the args are separate
1301 rather than passed in a list. Used by Fbyte_code. */
1304 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1305 Lisp_Object handlers
)
1313 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1319 && (SYMBOLP (XCAR (tem
))
1320 || CONSP (XCAR (tem
))))))
1321 error ("Invalid condition handler", tem
);
1326 c
.backlist
= backtrace_list
;
1327 c
.handlerlist
= handlerlist
;
1328 c
.lisp_eval_depth
= lisp_eval_depth
;
1329 c
.pdlcount
= SPECPDL_INDEX ();
1330 c
.poll_suppress_count
= poll_suppress_count
;
1331 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1332 c
.gcpro
= gcprolist
;
1333 c
.byte_stack
= byte_stack_list
;
1334 if (_setjmp (c
.jmp
))
1337 specbind (h
.var
, c
.val
);
1338 val
= Fprogn (Fcdr (h
.chosen_clause
));
1340 /* Note that this just undoes the binding of h.var; whoever
1341 longjumped to us unwound the stack to c.pdlcount before
1343 unbind_to (c
.pdlcount
, Qnil
);
1350 h
.handler
= handlers
;
1351 h
.next
= handlerlist
;
1355 val
= Feval (bodyform
);
1357 handlerlist
= h
.next
;
1361 /* Call the function BFUN with no arguments, catching errors within it
1362 according to HANDLERS. If there is an error, call HFUN with
1363 one argument which is the data that describes the error:
1366 HANDLERS can be a list of conditions to catch.
1367 If HANDLERS is Qt, catch all errors.
1368 If HANDLERS is Qerror, catch all errors
1369 but allow the debugger to run if that is enabled. */
1372 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1373 Lisp_Object (*hfun
) (Lisp_Object
))
1379 /* Since Fsignal will close off all calls to x_catch_errors,
1380 we will get the wrong results if some are not closed now. */
1382 if (x_catching_errors ())
1388 c
.backlist
= backtrace_list
;
1389 c
.handlerlist
= handlerlist
;
1390 c
.lisp_eval_depth
= lisp_eval_depth
;
1391 c
.pdlcount
= SPECPDL_INDEX ();
1392 c
.poll_suppress_count
= poll_suppress_count
;
1393 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1394 c
.gcpro
= gcprolist
;
1395 c
.byte_stack
= byte_stack_list
;
1396 if (_setjmp (c
.jmp
))
1398 return (*hfun
) (c
.val
);
1402 h
.handler
= handlers
;
1404 h
.next
= handlerlist
;
1410 handlerlist
= h
.next
;
1414 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1417 internal_condition_case_1 (Lisp_Object (*bfun
) (Lisp_Object
), Lisp_Object arg
,
1418 Lisp_Object handlers
, Lisp_Object (*hfun
) (Lisp_Object
))
1424 /* Since Fsignal will close off all calls to x_catch_errors,
1425 we will get the wrong results if some are not closed now. */
1427 if (x_catching_errors ())
1433 c
.backlist
= backtrace_list
;
1434 c
.handlerlist
= handlerlist
;
1435 c
.lisp_eval_depth
= lisp_eval_depth
;
1436 c
.pdlcount
= SPECPDL_INDEX ();
1437 c
.poll_suppress_count
= poll_suppress_count
;
1438 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1439 c
.gcpro
= gcprolist
;
1440 c
.byte_stack
= byte_stack_list
;
1441 if (_setjmp (c
.jmp
))
1443 return (*hfun
) (c
.val
);
1447 h
.handler
= handlers
;
1449 h
.next
= handlerlist
;
1453 val
= (*bfun
) (arg
);
1455 handlerlist
= h
.next
;
1459 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1463 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1466 Lisp_Object handlers
,
1467 Lisp_Object (*hfun
) (Lisp_Object
))
1473 /* Since Fsignal will close off all calls to x_catch_errors,
1474 we will get the wrong results if some are not closed now. */
1476 if (x_catching_errors ())
1482 c
.backlist
= backtrace_list
;
1483 c
.handlerlist
= handlerlist
;
1484 c
.lisp_eval_depth
= lisp_eval_depth
;
1485 c
.pdlcount
= SPECPDL_INDEX ();
1486 c
.poll_suppress_count
= poll_suppress_count
;
1487 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1488 c
.gcpro
= gcprolist
;
1489 c
.byte_stack
= byte_stack_list
;
1490 if (_setjmp (c
.jmp
))
1492 return (*hfun
) (c
.val
);
1496 h
.handler
= handlers
;
1498 h
.next
= handlerlist
;
1502 val
= (*bfun
) (arg1
, arg2
);
1504 handlerlist
= h
.next
;
1508 /* Like internal_condition_case but call BFUN with NARGS as first,
1509 and ARGS as second argument. */
1512 internal_condition_case_n (Lisp_Object (*bfun
) (int, Lisp_Object
*),
1515 Lisp_Object handlers
,
1516 Lisp_Object (*hfun
) (Lisp_Object
))
1522 /* Since Fsignal will close off all calls to x_catch_errors,
1523 we will get the wrong results if some are not closed now. */
1525 if (x_catching_errors ())
1531 c
.backlist
= backtrace_list
;
1532 c
.handlerlist
= handlerlist
;
1533 c
.lisp_eval_depth
= lisp_eval_depth
;
1534 c
.pdlcount
= SPECPDL_INDEX ();
1535 c
.poll_suppress_count
= poll_suppress_count
;
1536 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1537 c
.gcpro
= gcprolist
;
1538 c
.byte_stack
= byte_stack_list
;
1539 if (_setjmp (c
.jmp
))
1541 return (*hfun
) (c
.val
);
1545 h
.handler
= handlers
;
1547 h
.next
= handlerlist
;
1551 val
= (*bfun
) (nargs
, args
);
1553 handlerlist
= h
.next
;
1558 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
,
1559 Lisp_Object
, Lisp_Object
);
1560 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1563 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1564 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1565 This function does not return.
1567 An error symbol is a symbol with an `error-conditions' property
1568 that is a list of condition names.
1569 A handler for any of those names will get to handle this signal.
1570 The symbol `error' should normally be one of them.
1572 DATA should be a list. Its elements are printed as part of the error message.
1573 See Info anchor `(elisp)Definition of signal' for some details on how this
1574 error message is constructed.
1575 If the signal is handled, DATA is made available to the handler.
1576 See also the function `condition-case'. */)
1577 (Lisp_Object error_symbol
, Lisp_Object data
)
1579 /* When memory is full, ERROR-SYMBOL is nil,
1580 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1581 That is a special case--don't do this in other situations. */
1582 Lisp_Object conditions
;
1584 Lisp_Object real_error_symbol
1585 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1586 register Lisp_Object clause
= Qnil
;
1588 struct backtrace
*bp
;
1590 immediate_quit
= handling_signal
= 0;
1592 if (gc_in_progress
|| waiting_for_input
)
1595 #if 0 /* rms: I don't know why this was here,
1596 but it is surely wrong for an error that is handled. */
1597 #ifdef HAVE_WINDOW_SYSTEM
1598 if (display_hourglass_p
)
1599 cancel_hourglass ();
1603 /* This hook is used by edebug. */
1604 if (! NILP (Vsignal_hook_function
)
1605 && ! NILP (error_symbol
))
1607 /* Edebug takes care of restoring these variables when it exits. */
1608 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1609 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1611 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1612 max_specpdl_size
= SPECPDL_INDEX () + 40;
1614 call2 (Vsignal_hook_function
, error_symbol
, data
);
1617 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1619 /* Remember from where signal was called. Skip over the frame for
1620 `signal' itself. If a frame for `error' follows, skip that,
1621 too. Don't do this when ERROR_SYMBOL is nil, because that
1622 is a memory-full error. */
1623 Vsignaling_function
= Qnil
;
1624 if (backtrace_list
&& !NILP (error_symbol
))
1626 bp
= backtrace_list
->next
;
1627 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1629 if (bp
&& bp
->function
)
1630 Vsignaling_function
= *bp
->function
;
1633 for (h
= handlerlist
; h
; h
= h
->next
)
1635 clause
= find_handler_clause (h
->handler
, conditions
,
1636 error_symbol
, data
);
1641 if (/* Don't run the debugger for a memory-full error.
1642 (There is no room in memory to do that!) */
1643 !NILP (error_symbol
)
1644 && (!NILP (Vdebug_on_signal
)
1645 /* If no handler is present now, try to run the debugger. */
1647 /* Special handler that means "print a message and run debugger
1649 || EQ (h
->handler
, Qerror
)))
1652 = maybe_call_debugger (conditions
, error_symbol
, data
);
1653 /* We can't return values to code which signaled an error, but we
1654 can continue code which has signaled a quit. */
1655 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1661 Lisp_Object unwind_data
1662 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1664 h
->chosen_clause
= clause
;
1665 unwind_to_catch (h
->tag
, unwind_data
);
1670 Fthrow (Qtop_level
, Qt
);
1673 if (! NILP (error_symbol
))
1674 data
= Fcons (error_symbol
, data
);
1676 string
= Ferror_message_string (data
);
1677 fatal ("%s", SDATA (string
), 0);
1680 /* Internal version of Fsignal that never returns.
1681 Used for anything but Qquit (which can return from Fsignal). */
1684 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1686 Fsignal (error_symbol
, data
);
1690 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1693 xsignal0 (Lisp_Object error_symbol
)
1695 xsignal (error_symbol
, Qnil
);
1699 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1701 xsignal (error_symbol
, list1 (arg
));
1705 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1707 xsignal (error_symbol
, list2 (arg1
, arg2
));
1711 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1713 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1716 /* Signal `error' with message S, and additional arg ARG.
1717 If ARG is not a genuine list, make it a one-element list. */
1720 signal_error (const char *s
, Lisp_Object arg
)
1722 Lisp_Object tortoise
, hare
;
1724 hare
= tortoise
= arg
;
1725 while (CONSP (hare
))
1732 tortoise
= XCDR (tortoise
);
1734 if (EQ (hare
, tortoise
))
1739 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1741 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1745 /* Return nonzero if LIST is a non-nil atom or
1746 a list containing one of CONDITIONS. */
1749 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1756 while (CONSP (conditions
))
1758 Lisp_Object
this, tail
;
1759 this = XCAR (conditions
);
1760 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1761 if (EQ (XCAR (tail
), this))
1763 conditions
= XCDR (conditions
);
1768 /* Return 1 if an error with condition-symbols CONDITIONS,
1769 and described by SIGNAL-DATA, should skip the debugger
1770 according to debugger-ignored-errors. */
1773 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1776 int first_string
= 1;
1777 Lisp_Object error_message
;
1779 error_message
= Qnil
;
1780 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1782 if (STRINGP (XCAR (tail
)))
1786 error_message
= Ferror_message_string (data
);
1790 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1795 Lisp_Object contail
;
1797 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1798 if (EQ (XCAR (tail
), XCAR (contail
)))
1806 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1807 SIG and DATA describe the signal, as in find_handler_clause. */
1810 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1812 Lisp_Object combined_data
;
1814 combined_data
= Fcons (sig
, data
);
1817 /* Don't try to run the debugger with interrupts blocked.
1818 The editing loop would return anyway. */
1820 /* Does user want to enter debugger for this kind of error? */
1823 : wants_debugger (Vdebug_on_error
, conditions
))
1824 && ! skip_debugger (conditions
, combined_data
)
1825 /* rms: what's this for? */
1826 && when_entered_debugger
< num_nonmacro_input_events
)
1828 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1835 /* Value of Qlambda means we have called debugger and user has continued.
1836 There are two ways to pass SIG and DATA:
1837 = SIG is the error symbol, and DATA is the rest of the data.
1838 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1839 This is for memory-full errors only.
1841 We need to increase max_specpdl_size temporarily around
1842 anything we do that can push on the specpdl, so as not to get
1843 a second error here in case we're handling specpdl overflow. */
1846 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
,
1847 Lisp_Object sig
, Lisp_Object data
)
1849 register Lisp_Object h
;
1851 /* t is used by handlers for all conditions, set up by C code. */
1852 if (EQ (handlers
, Qt
))
1855 /* error is used similarly, but means print an error message
1856 and run the debugger if that is enabled. */
1857 if (EQ (handlers
, Qerror
))
1860 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1862 Lisp_Object handler
= XCAR (h
);
1863 Lisp_Object condit
, tem
;
1865 if (!CONSP (handler
))
1867 condit
= XCAR (handler
);
1868 /* Handle a single condition name in handler HANDLER. */
1869 if (SYMBOLP (condit
))
1871 tem
= Fmemq (Fcar (handler
), conditions
);
1875 /* Handle a list of condition names in handler HANDLER. */
1876 else if (CONSP (condit
))
1879 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1881 tem
= Fmemq (XCAR (tail
), conditions
);
1892 /* dump an error message; called like vprintf */
1894 verror (const char *m
, va_list ap
)
1897 EMACS_INT size
= 200;
1908 used
= doprnt (buffer
, size
, m
, m
+ mlen
, ap
);
1913 buffer
= (char *) xrealloc (buffer
, size
);
1916 buffer
= (char *) xmalloc (size
);
1921 string
= build_string (buffer
);
1925 xsignal1 (Qerror
, string
);
1929 /* dump an error message; called like printf */
1933 error (const char *m
, ...)
1941 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
1942 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
1943 This means it contains a description for how to read arguments to give it.
1944 The value is nil for an invalid function or a symbol with no function
1947 Interactively callable functions include strings and vectors (treated
1948 as keyboard macros), lambda-expressions that contain a top-level call
1949 to `interactive', autoload definitions made by `autoload' with non-nil
1950 fourth argument, and some of the built-in functions of Lisp.
1952 Also, a symbol satisfies `commandp' if its function definition does so.
1954 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1955 then strings and vectors are not accepted. */)
1956 (Lisp_Object function
, Lisp_Object for_call_interactively
)
1958 register Lisp_Object fun
;
1959 register Lisp_Object funcar
;
1960 Lisp_Object if_prop
= Qnil
;
1964 fun
= indirect_function (fun
); /* Check cycles. */
1965 if (NILP (fun
) || EQ (fun
, Qunbound
))
1968 /* Check an `interactive-form' property if present, analogous to the
1969 function-documentation property. */
1971 while (SYMBOLP (fun
))
1973 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
1976 fun
= Fsymbol_function (fun
);
1979 /* Emacs primitives are interactive if their DEFUN specifies an
1980 interactive spec. */
1982 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
1984 /* Bytecode objects are interactive if they are long enough to
1985 have an element whose index is COMPILED_INTERACTIVE, which is
1986 where the interactive spec is stored. */
1987 else if (COMPILEDP (fun
))
1988 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
1991 /* Strings and vectors are keyboard macros. */
1992 if (STRINGP (fun
) || VECTORP (fun
))
1993 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
1995 /* Lists may represent commands. */
1998 funcar
= XCAR (fun
);
1999 if (EQ (funcar
, Qlambda
))
2000 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2001 if (EQ (funcar
, Qautoload
))
2002 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2007 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2008 doc
: /* Define FUNCTION to autoload from FILE.
2009 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2010 Third arg DOCSTRING is documentation for the function.
2011 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2012 Fifth arg TYPE indicates the type of the object:
2013 nil or omitted says FUNCTION is a function,
2014 `keymap' says FUNCTION is really a keymap, and
2015 `macro' or t says FUNCTION is really a macro.
2016 Third through fifth args give info about the real definition.
2017 They default to nil.
2018 If FUNCTION is already defined other than as an autoload,
2019 this does nothing and returns nil. */)
2020 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
2022 CHECK_SYMBOL (function
);
2023 CHECK_STRING (file
);
2025 /* If function is defined and not as an autoload, don't override */
2026 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2027 && !(CONSP (XSYMBOL (function
)->function
)
2028 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2031 if (NILP (Vpurify_flag
))
2032 /* Only add entries after dumping, because the ones before are
2033 not useful and else we get loads of them from the loaddefs.el. */
2034 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2036 /* We don't want the docstring in purespace (instead,
2037 Snarf-documentation should (hopefully) overwrite it).
2038 We used to use 0 here, but that leads to accidental sharing in
2039 purecopy's hash-consing, so we use a (hopefully) unique integer
2041 docstring
= make_number (XHASH (function
));
2042 return Ffset (function
,
2043 Fpurecopy (list5 (Qautoload
, file
, docstring
,
2044 interactive
, type
)));
2048 un_autoload (Lisp_Object oldqueue
)
2050 register Lisp_Object queue
, first
, second
;
2052 /* Queue to unwind is current value of Vautoload_queue.
2053 oldqueue is the shadowed value to leave in Vautoload_queue. */
2054 queue
= Vautoload_queue
;
2055 Vautoload_queue
= oldqueue
;
2056 while (CONSP (queue
))
2058 first
= XCAR (queue
);
2059 second
= Fcdr (first
);
2060 first
= Fcar (first
);
2061 if (EQ (first
, make_number (0)))
2064 Ffset (first
, second
);
2065 queue
= XCDR (queue
);
2070 /* Load an autoloaded function.
2071 FUNNAME is the symbol which is the function's name.
2072 FUNDEF is the autoload definition (a list). */
2075 do_autoload (Lisp_Object fundef
, Lisp_Object funname
)
2077 int count
= SPECPDL_INDEX ();
2079 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2081 /* This is to make sure that loadup.el gives a clear picture
2082 of what files are preloaded and when. */
2083 if (! NILP (Vpurify_flag
))
2084 error ("Attempt to autoload %s while preparing to dump",
2085 SDATA (SYMBOL_NAME (funname
)));
2088 CHECK_SYMBOL (funname
);
2089 GCPRO3 (fun
, funname
, fundef
);
2091 /* Preserve the match data. */
2092 record_unwind_save_match_data ();
2094 /* If autoloading gets an error (which includes the error of failing
2095 to define the function being called), we use Vautoload_queue
2096 to undo function definitions and `provide' calls made by
2097 the function. We do this in the specific case of autoloading
2098 because autoloading is not an explicit request "load this file",
2099 but rather a request to "call this function".
2101 The value saved here is to be restored into Vautoload_queue. */
2102 record_unwind_protect (un_autoload
, Vautoload_queue
);
2103 Vautoload_queue
= Qt
;
2104 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
2106 /* Once loading finishes, don't undo it. */
2107 Vautoload_queue
= Qt
;
2108 unbind_to (count
, Qnil
);
2110 fun
= Findirect_function (fun
, Qnil
);
2112 if (!NILP (Fequal (fun
, fundef
)))
2113 error ("Autoloading failed to define function %s",
2114 SDATA (SYMBOL_NAME (funname
)));
2119 DEFUN ("eval", Feval
, Seval
, 1, 1, 0,
2120 doc
: /* Evaluate FORM and return its value. */)
2123 Lisp_Object fun
, val
, original_fun
, original_args
;
2125 struct backtrace backtrace
;
2126 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2128 if (handling_signal
)
2132 return Fsymbol_value (form
);
2137 if ((consing_since_gc
> gc_cons_threshold
2138 && consing_since_gc
> gc_relative_threshold
)
2140 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2143 Fgarbage_collect ();
2147 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2149 if (max_lisp_eval_depth
< 100)
2150 max_lisp_eval_depth
= 100;
2151 if (lisp_eval_depth
> max_lisp_eval_depth
)
2152 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2155 original_fun
= Fcar (form
);
2156 original_args
= Fcdr (form
);
2158 backtrace
.next
= backtrace_list
;
2159 backtrace_list
= &backtrace
;
2160 backtrace
.function
= &original_fun
; /* This also protects them from gc */
2161 backtrace
.args
= &original_args
;
2162 backtrace
.nargs
= UNEVALLED
;
2163 backtrace
.evalargs
= 1;
2164 backtrace
.debug_on_exit
= 0;
2166 if (debug_on_next_call
)
2167 do_debug_on_call (Qt
);
2169 /* At this point, only original_fun and original_args
2170 have values that will be used below */
2173 /* Optimize for no indirection. */
2175 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2176 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2177 fun
= indirect_function (fun
);
2181 Lisp_Object numargs
;
2182 Lisp_Object argvals
[8];
2183 Lisp_Object args_left
;
2184 register int i
, maxargs
;
2186 args_left
= original_args
;
2187 numargs
= Flength (args_left
);
2191 if (XINT (numargs
) < XSUBR (fun
)->min_args
||
2192 (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2193 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2195 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2197 backtrace
.evalargs
= 0;
2198 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2200 else if (XSUBR (fun
)->max_args
== MANY
)
2202 /* Pass a vector of evaluated arguments */
2204 register int argnum
= 0;
2207 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2209 GCPRO3 (args_left
, fun
, fun
);
2213 while (!NILP (args_left
))
2215 vals
[argnum
++] = Feval (Fcar (args_left
));
2216 args_left
= Fcdr (args_left
);
2217 gcpro3
.nvars
= argnum
;
2220 backtrace
.args
= vals
;
2221 backtrace
.nargs
= XINT (numargs
);
2223 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2229 GCPRO3 (args_left
, fun
, fun
);
2230 gcpro3
.var
= argvals
;
2233 maxargs
= XSUBR (fun
)->max_args
;
2234 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2236 argvals
[i
] = Feval (Fcar (args_left
));
2242 backtrace
.args
= argvals
;
2243 backtrace
.nargs
= XINT (numargs
);
2248 val
= (XSUBR (fun
)->function
.a0 ());
2251 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2254 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2257 val
= (XSUBR (fun
)->function
.a3
2258 (argvals
[0], argvals
[1], argvals
[2]));
2261 val
= (XSUBR (fun
)->function
.a4
2262 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2265 val
= (XSUBR (fun
)->function
.a5
2266 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2270 val
= (XSUBR (fun
)->function
.a6
2271 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2272 argvals
[4], argvals
[5]));
2275 val
= (XSUBR (fun
)->function
.a7
2276 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2277 argvals
[4], argvals
[5], argvals
[6]));
2281 val
= (XSUBR (fun
)->function
.a8
2282 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2283 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2287 /* Someone has created a subr that takes more arguments than
2288 is supported by this code. We need to either rewrite the
2289 subr to use a different argument protocol, or add more
2290 cases to this switch. */
2295 else if (COMPILEDP (fun
))
2296 val
= apply_lambda (fun
, original_args
, 1);
2299 if (EQ (fun
, Qunbound
))
2300 xsignal1 (Qvoid_function
, original_fun
);
2302 xsignal1 (Qinvalid_function
, original_fun
);
2303 funcar
= XCAR (fun
);
2304 if (!SYMBOLP (funcar
))
2305 xsignal1 (Qinvalid_function
, original_fun
);
2306 if (EQ (funcar
, Qautoload
))
2308 do_autoload (fun
, original_fun
);
2311 if (EQ (funcar
, Qmacro
))
2312 val
= Feval (apply1 (Fcdr (fun
), original_args
));
2313 else if (EQ (funcar
, Qlambda
))
2314 val
= apply_lambda (fun
, original_args
, 1);
2316 xsignal1 (Qinvalid_function
, original_fun
);
2321 if (backtrace
.debug_on_exit
)
2322 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2323 backtrace_list
= backtrace
.next
;
2328 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2329 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2330 Then return the value FUNCTION returns.
2331 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2332 usage: (apply FUNCTION &rest ARGUMENTS) */)
2333 (int nargs
, Lisp_Object
*args
)
2335 register int i
, numargs
;
2336 register Lisp_Object spread_arg
;
2337 register Lisp_Object
*funcall_args
;
2338 Lisp_Object fun
, retval
;
2339 struct gcpro gcpro1
;
2344 spread_arg
= args
[nargs
- 1];
2345 CHECK_LIST (spread_arg
);
2347 numargs
= XINT (Flength (spread_arg
));
2350 return Ffuncall (nargs
- 1, args
);
2351 else if (numargs
== 1)
2353 args
[nargs
- 1] = XCAR (spread_arg
);
2354 return Ffuncall (nargs
, args
);
2357 numargs
+= nargs
- 2;
2359 /* Optimize for no indirection. */
2360 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2361 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2362 fun
= indirect_function (fun
);
2363 if (EQ (fun
, Qunbound
))
2365 /* Let funcall get the error */
2372 if (numargs
< XSUBR (fun
)->min_args
2373 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2374 goto funcall
; /* Let funcall get the error */
2375 else if (XSUBR (fun
)->max_args
> numargs
)
2377 /* Avoid making funcall cons up a yet another new vector of arguments
2378 by explicitly supplying nil's for optional values */
2379 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2380 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2381 funcall_args
[++i
] = Qnil
;
2382 GCPRO1 (*funcall_args
);
2383 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2387 /* We add 1 to numargs because funcall_args includes the
2388 function itself as well as its arguments. */
2391 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2392 GCPRO1 (*funcall_args
);
2393 gcpro1
.nvars
= 1 + numargs
;
2396 memcpy (funcall_args
, args
, nargs
* sizeof (Lisp_Object
));
2397 /* Spread the last arg we got. Its first element goes in
2398 the slot that it used to occupy, hence this value of I. */
2400 while (!NILP (spread_arg
))
2402 funcall_args
[i
++] = XCAR (spread_arg
);
2403 spread_arg
= XCDR (spread_arg
);
2406 /* By convention, the caller needs to gcpro Ffuncall's args. */
2407 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2414 /* Run hook variables in various ways. */
2416 enum run_hooks_condition
{to_completion
, until_success
, until_failure
};
2417 static Lisp_Object
run_hook_with_args (int, Lisp_Object
*,
2418 enum run_hooks_condition
);
2420 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2421 doc
: /* Run each hook in HOOKS.
2422 Each argument should be a symbol, a hook variable.
2423 These symbols are processed in the order specified.
2424 If a hook symbol has a non-nil value, that value may be a function
2425 or a list of functions to be called to run the hook.
2426 If the value is a function, it is called with no arguments.
2427 If it is a list, the elements are called, in order, with no arguments.
2429 Major modes should not use this function directly to run their mode
2430 hook; they should use `run-mode-hooks' instead.
2432 Do not use `make-local-variable' to make a hook variable buffer-local.
2433 Instead, use `add-hook' and specify t for the LOCAL argument.
2434 usage: (run-hooks &rest HOOKS) */)
2435 (int nargs
, Lisp_Object
*args
)
2437 Lisp_Object hook
[1];
2440 for (i
= 0; i
< nargs
; i
++)
2443 run_hook_with_args (1, hook
, to_completion
);
2449 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2450 Srun_hook_with_args
, 1, MANY
, 0,
2451 doc
: /* Run HOOK with the specified arguments ARGS.
2452 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2453 value, that value may be a function or a list of functions to be
2454 called to run the hook. If the value is a function, it is called with
2455 the given arguments and its return value is returned. If it is a list
2456 of functions, those functions are called, in order,
2457 with the given arguments ARGS.
2458 It is best not to depend on the value returned by `run-hook-with-args',
2461 Do not use `make-local-variable' to make a hook variable buffer-local.
2462 Instead, use `add-hook' and specify t for the LOCAL argument.
2463 usage: (run-hook-with-args HOOK &rest ARGS) */)
2464 (int nargs
, Lisp_Object
*args
)
2466 return run_hook_with_args (nargs
, args
, to_completion
);
2469 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2470 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2471 doc
: /* Run HOOK with the specified arguments ARGS.
2472 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2473 value, that value may be a function or a list of functions to be
2474 called to run the hook. If the value is a function, it is called with
2475 the given arguments and its return value is returned.
2476 If it is a list of functions, those functions are called, in order,
2477 with the given arguments ARGS, until one of them
2478 returns a non-nil value. Then we return that value.
2479 However, if they all return nil, we return nil.
2481 Do not use `make-local-variable' to make a hook variable buffer-local.
2482 Instead, use `add-hook' and specify t for the LOCAL argument.
2483 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2484 (int nargs
, Lisp_Object
*args
)
2486 return run_hook_with_args (nargs
, args
, until_success
);
2489 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2490 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2491 doc
: /* Run HOOK with the specified arguments ARGS.
2492 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2493 value, that value may be a function or a list of functions to be
2494 called to run the hook. If the value is a function, it is called with
2495 the given arguments and its return value is returned.
2496 If it is a list of functions, those functions are called, in order,
2497 with the given arguments ARGS, until one of them returns nil.
2498 Then we return nil. However, if they all return non-nil, we return non-nil.
2500 Do not use `make-local-variable' to make a hook variable buffer-local.
2501 Instead, use `add-hook' and specify t for the LOCAL argument.
2502 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2503 (int nargs
, Lisp_Object
*args
)
2505 return run_hook_with_args (nargs
, args
, until_failure
);
2508 /* ARGS[0] should be a hook symbol.
2509 Call each of the functions in the hook value, passing each of them
2510 as arguments all the rest of ARGS (all NARGS - 1 elements).
2511 COND specifies a condition to test after each call
2512 to decide whether to stop.
2513 The caller (or its caller, etc) must gcpro all of ARGS,
2514 except that it isn't necessary to gcpro ARGS[0]. */
2517 run_hook_with_args (int nargs
, Lisp_Object
*args
, enum run_hooks_condition cond
)
2519 Lisp_Object sym
, val
, ret
;
2520 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2522 /* If we are dying or still initializing,
2523 don't do anything--it would probably crash if we tried. */
2524 if (NILP (Vrun_hooks
))
2528 val
= find_symbol_value (sym
);
2529 ret
= (cond
== until_failure
? Qt
: Qnil
);
2531 if (EQ (val
, Qunbound
) || NILP (val
))
2533 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2536 return Ffuncall (nargs
, args
);
2540 Lisp_Object globals
= Qnil
;
2541 GCPRO3 (sym
, val
, globals
);
2544 CONSP (val
) && ((cond
== to_completion
)
2545 || (cond
== until_success
? NILP (ret
)
2549 if (EQ (XCAR (val
), Qt
))
2551 /* t indicates this hook has a local binding;
2552 it means to run the global binding too. */
2553 globals
= Fdefault_value (sym
);
2554 if (NILP (globals
)) continue;
2556 if (!CONSP (globals
) || EQ (XCAR (globals
), Qlambda
))
2559 ret
= Ffuncall (nargs
, args
);
2564 CONSP (globals
) && ((cond
== to_completion
)
2565 || (cond
== until_success
? NILP (ret
)
2567 globals
= XCDR (globals
))
2569 args
[0] = XCAR (globals
);
2570 /* In a global value, t should not occur. If it does, we
2571 must ignore it to avoid an endless loop. */
2572 if (!EQ (args
[0], Qt
))
2573 ret
= Ffuncall (nargs
, args
);
2579 args
[0] = XCAR (val
);
2580 ret
= Ffuncall (nargs
, args
);
2589 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2592 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2594 Lisp_Object temp
[3];
2599 Frun_hook_with_args (3, temp
);
2602 /* Apply fn to arg */
2604 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2606 struct gcpro gcpro1
;
2610 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2613 Lisp_Object args
[2];
2617 RETURN_UNGCPRO (Fapply (2, args
));
2621 /* Call function fn on no arguments */
2623 call0 (Lisp_Object fn
)
2625 struct gcpro gcpro1
;
2628 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2631 /* Call function fn with 1 argument arg1 */
2634 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2636 struct gcpro gcpro1
;
2637 Lisp_Object args
[2];
2643 RETURN_UNGCPRO (Ffuncall (2, args
));
2646 /* Call function fn with 2 arguments arg1, arg2 */
2649 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2651 struct gcpro gcpro1
;
2652 Lisp_Object args
[3];
2658 RETURN_UNGCPRO (Ffuncall (3, args
));
2661 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2664 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2666 struct gcpro gcpro1
;
2667 Lisp_Object args
[4];
2674 RETURN_UNGCPRO (Ffuncall (4, args
));
2677 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2680 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2683 struct gcpro gcpro1
;
2684 Lisp_Object args
[5];
2692 RETURN_UNGCPRO (Ffuncall (5, args
));
2695 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2698 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2699 Lisp_Object arg4
, Lisp_Object arg5
)
2701 struct gcpro gcpro1
;
2702 Lisp_Object args
[6];
2711 RETURN_UNGCPRO (Ffuncall (6, args
));
2714 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2717 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2718 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2720 struct gcpro gcpro1
;
2721 Lisp_Object args
[7];
2731 RETURN_UNGCPRO (Ffuncall (7, args
));
2734 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7 */
2737 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2738 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2740 struct gcpro gcpro1
;
2741 Lisp_Object args
[8];
2752 RETURN_UNGCPRO (Ffuncall (8, args
));
2755 /* The caller should GCPRO all the elements of ARGS. */
2757 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2758 doc
: /* Call first argument as a function, passing remaining arguments to it.
2759 Return the value that function returns.
2760 Thus, (funcall 'cons 'x 'y) returns (x . y).
2761 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2762 (int nargs
, Lisp_Object
*args
)
2764 Lisp_Object fun
, original_fun
;
2766 int numargs
= nargs
- 1;
2767 Lisp_Object lisp_numargs
;
2769 struct backtrace backtrace
;
2770 register Lisp_Object
*internal_args
;
2774 if ((consing_since_gc
> gc_cons_threshold
2775 && consing_since_gc
> gc_relative_threshold
)
2777 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2778 Fgarbage_collect ();
2780 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2782 if (max_lisp_eval_depth
< 100)
2783 max_lisp_eval_depth
= 100;
2784 if (lisp_eval_depth
> max_lisp_eval_depth
)
2785 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2788 backtrace
.next
= backtrace_list
;
2789 backtrace_list
= &backtrace
;
2790 backtrace
.function
= &args
[0];
2791 backtrace
.args
= &args
[1];
2792 backtrace
.nargs
= nargs
- 1;
2793 backtrace
.evalargs
= 0;
2794 backtrace
.debug_on_exit
= 0;
2796 if (debug_on_next_call
)
2797 do_debug_on_call (Qlambda
);
2801 original_fun
= args
[0];
2805 /* Optimize for no indirection. */
2807 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2808 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2809 fun
= indirect_function (fun
);
2813 if (numargs
< XSUBR (fun
)->min_args
2814 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2816 XSETFASTINT (lisp_numargs
, numargs
);
2817 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2820 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2821 xsignal1 (Qinvalid_function
, original_fun
);
2823 else if (XSUBR (fun
)->max_args
== MANY
)
2824 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
2827 if (XSUBR (fun
)->max_args
> numargs
)
2829 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
2830 memcpy (internal_args
, args
+ 1, numargs
* sizeof (Lisp_Object
));
2831 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2832 internal_args
[i
] = Qnil
;
2835 internal_args
= args
+ 1;
2836 switch (XSUBR (fun
)->max_args
)
2839 val
= (XSUBR (fun
)->function
.a0 ());
2842 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
2845 val
= (XSUBR (fun
)->function
.a2
2846 (internal_args
[0], internal_args
[1]));
2849 val
= (XSUBR (fun
)->function
.a3
2850 (internal_args
[0], internal_args
[1], internal_args
[2]));
2853 val
= (XSUBR (fun
)->function
.a4
2854 (internal_args
[0], internal_args
[1], internal_args
[2],
2858 val
= (XSUBR (fun
)->function
.a5
2859 (internal_args
[0], internal_args
[1], internal_args
[2],
2860 internal_args
[3], internal_args
[4]));
2863 val
= (XSUBR (fun
)->function
.a6
2864 (internal_args
[0], internal_args
[1], internal_args
[2],
2865 internal_args
[3], internal_args
[4], internal_args
[5]));
2868 val
= (XSUBR (fun
)->function
.a7
2869 (internal_args
[0], internal_args
[1], internal_args
[2],
2870 internal_args
[3], internal_args
[4], internal_args
[5],
2875 val
= (XSUBR (fun
)->function
.a8
2876 (internal_args
[0], internal_args
[1], internal_args
[2],
2877 internal_args
[3], internal_args
[4], internal_args
[5],
2878 internal_args
[6], internal_args
[7]));
2883 /* If a subr takes more than 8 arguments without using MANY
2884 or UNEVALLED, we need to extend this function to support it.
2885 Until this is done, there is no way to call the function. */
2890 else if (COMPILEDP (fun
))
2891 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2894 if (EQ (fun
, Qunbound
))
2895 xsignal1 (Qvoid_function
, original_fun
);
2897 xsignal1 (Qinvalid_function
, original_fun
);
2898 funcar
= XCAR (fun
);
2899 if (!SYMBOLP (funcar
))
2900 xsignal1 (Qinvalid_function
, original_fun
);
2901 if (EQ (funcar
, Qlambda
))
2902 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2903 else if (EQ (funcar
, Qautoload
))
2905 do_autoload (fun
, original_fun
);
2910 xsignal1 (Qinvalid_function
, original_fun
);
2914 if (backtrace
.debug_on_exit
)
2915 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2916 backtrace_list
= backtrace
.next
;
2921 apply_lambda (Lisp_Object fun
, Lisp_Object args
, int eval_flag
)
2923 Lisp_Object args_left
;
2924 Lisp_Object numargs
;
2925 register Lisp_Object
*arg_vector
;
2926 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2928 register Lisp_Object tem
;
2931 numargs
= Flength (args
);
2932 SAFE_ALLOCA_LISP (arg_vector
, XINT (numargs
));
2935 GCPRO3 (*arg_vector
, args_left
, fun
);
2938 for (i
= 0; i
< XINT (numargs
);)
2940 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
2941 if (eval_flag
) tem
= Feval (tem
);
2942 arg_vector
[i
++] = tem
;
2950 backtrace_list
->args
= arg_vector
;
2951 backtrace_list
->nargs
= i
;
2953 backtrace_list
->evalargs
= 0;
2954 tem
= funcall_lambda (fun
, XINT (numargs
), arg_vector
);
2956 /* Do the debug-on-exit now, while arg_vector still exists. */
2957 if (backtrace_list
->debug_on_exit
)
2958 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
2959 /* Don't do it again when we return to eval. */
2960 backtrace_list
->debug_on_exit
= 0;
2965 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2966 and return the result of evaluation.
2967 FUN must be either a lambda-expression or a compiled-code object. */
2970 funcall_lambda (Lisp_Object fun
, int nargs
, register Lisp_Object
*arg_vector
)
2972 Lisp_Object val
, syms_left
, next
;
2973 int count
= SPECPDL_INDEX ();
2974 int i
, optional
, rest
;
2978 syms_left
= XCDR (fun
);
2979 if (CONSP (syms_left
))
2980 syms_left
= XCAR (syms_left
);
2982 xsignal1 (Qinvalid_function
, fun
);
2984 else if (COMPILEDP (fun
))
2985 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
2989 i
= optional
= rest
= 0;
2990 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
2994 next
= XCAR (syms_left
);
2995 if (!SYMBOLP (next
))
2996 xsignal1 (Qinvalid_function
, fun
);
2998 if (EQ (next
, Qand_rest
))
3000 else if (EQ (next
, Qand_optional
))
3004 specbind (next
, Flist (nargs
- i
, &arg_vector
[i
]));
3008 specbind (next
, arg_vector
[i
++]);
3010 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3012 specbind (next
, Qnil
);
3015 if (!NILP (syms_left
))
3016 xsignal1 (Qinvalid_function
, fun
);
3018 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3021 val
= Fprogn (XCDR (XCDR (fun
)));
3024 /* If we have not actually read the bytecode string
3025 and constants vector yet, fetch them from the file. */
3026 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3027 Ffetch_bytecode (fun
);
3028 val
= Fbyte_code (AREF (fun
, COMPILED_BYTECODE
),
3029 AREF (fun
, COMPILED_CONSTANTS
),
3030 AREF (fun
, COMPILED_STACK_DEPTH
));
3033 return unbind_to (count
, val
);
3036 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3038 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3039 (Lisp_Object object
)
3043 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3045 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3048 tem
= AREF (object
, COMPILED_BYTECODE
);
3049 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3050 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3052 error ("Invalid byte code");
3054 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3055 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3063 register int count
= SPECPDL_INDEX ();
3064 if (specpdl_size
>= max_specpdl_size
)
3066 if (max_specpdl_size
< 400)
3067 max_specpdl_size
= 400;
3068 if (specpdl_size
>= max_specpdl_size
)
3069 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3072 if (specpdl_size
> max_specpdl_size
)
3073 specpdl_size
= max_specpdl_size
;
3074 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3075 specpdl_ptr
= specpdl
+ count
;
3078 /* specpdl_ptr->symbol is a field which describes which variable is
3079 let-bound, so it can be properly undone when we unbind_to.
3080 It can have the following two shapes:
3081 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3082 a symbol that is not buffer-local (at least at the time
3083 the let binding started). Note also that it should not be
3084 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3086 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3087 variable SYMBOL which can be buffer-local. WHERE tells us
3088 which buffer is affected (or nil if the let-binding affects the
3089 global value of the variable) and BUFFER tells us which buffer was
3090 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3091 BUFFER did not yet have a buffer-local value). */
3094 specbind (Lisp_Object symbol
, Lisp_Object value
)
3096 struct Lisp_Symbol
*sym
;
3098 eassert (!handling_signal
);
3100 CHECK_SYMBOL (symbol
);
3101 sym
= XSYMBOL (symbol
);
3102 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3106 switch (sym
->redirect
)
3108 case SYMBOL_VARALIAS
:
3109 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3110 case SYMBOL_PLAINVAL
:
3111 /* The most common case is that of a non-constant symbol with a
3112 trivial value. Make that as fast as we can. */
3113 specpdl_ptr
->symbol
= symbol
;
3114 specpdl_ptr
->old_value
= SYMBOL_VAL (sym
);
3115 specpdl_ptr
->func
= NULL
;
3118 SET_SYMBOL_VAL (sym
, value
);
3120 set_internal (symbol
, value
, Qnil
, 1);
3122 case SYMBOL_LOCALIZED
:
3123 if (SYMBOL_BLV (sym
)->frame_local
)
3124 error ("Frame-local vars cannot be let-bound");
3125 case SYMBOL_FORWARDED
:
3127 Lisp_Object ovalue
= find_symbol_value (symbol
);
3128 specpdl_ptr
->func
= 0;
3129 specpdl_ptr
->old_value
= ovalue
;
3131 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3132 || (EQ (SYMBOL_BLV (sym
)->where
,
3133 SYMBOL_BLV (sym
)->frame_local
?
3134 Fselected_frame () : Fcurrent_buffer ())));
3136 if (sym
->redirect
== SYMBOL_LOCALIZED
3137 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3139 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3141 /* For a local variable, record both the symbol and which
3142 buffer's or frame's value we are saving. */
3143 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3145 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3146 || (BLV_FOUND (SYMBOL_BLV (sym
))
3147 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3150 else if (sym
->redirect
== SYMBOL_LOCALIZED
3151 && BLV_FOUND (SYMBOL_BLV (sym
)))
3152 where
= SYMBOL_BLV (sym
)->where
;
3156 /* We're not using the `unused' slot in the specbinding
3157 structure because this would mean we have to do more
3158 work for simple variables. */
3159 /* FIXME: The third value `current_buffer' is only used in
3160 let_shadows_buffer_binding_p which is itself only used
3161 in set_internal for local_if_set. */
3162 eassert (NILP (where
) || EQ (where
, cur_buf
));
3163 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, cur_buf
));
3165 /* If SYMBOL is a per-buffer variable which doesn't have a
3166 buffer-local value here, make the `let' change the global
3167 value by changing the value of SYMBOL in all buffers not
3168 having their own value. This is consistent with what
3169 happens with other buffer-local variables. */
3171 && sym
->redirect
== SYMBOL_FORWARDED
)
3173 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3175 Fset_default (symbol
, value
);
3180 specpdl_ptr
->symbol
= symbol
;
3183 set_internal (symbol
, value
, Qnil
, 1);
3191 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3193 eassert (!handling_signal
);
3195 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3197 specpdl_ptr
->func
= function
;
3198 specpdl_ptr
->symbol
= Qnil
;
3199 specpdl_ptr
->old_value
= arg
;
3204 unbind_to (int count
, Lisp_Object value
)
3206 Lisp_Object quitf
= Vquit_flag
;
3207 struct gcpro gcpro1
, gcpro2
;
3209 GCPRO2 (value
, quitf
);
3212 while (specpdl_ptr
!= specpdl
+ count
)
3214 /* Copy the binding, and decrement specpdl_ptr, before we do
3215 the work to unbind it. We decrement first
3216 so that an error in unbinding won't try to unbind
3217 the same entry again, and we copy the binding first
3218 in case more bindings are made during some of the code we run. */
3220 struct specbinding this_binding
;
3221 this_binding
= *--specpdl_ptr
;
3223 if (this_binding
.func
!= 0)
3224 (*this_binding
.func
) (this_binding
.old_value
);
3225 /* If the symbol is a list, it is really (SYMBOL WHERE
3226 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3227 frame. If WHERE is a buffer or frame, this indicates we
3228 bound a variable that had a buffer-local or frame-local
3229 binding. WHERE nil means that the variable had the default
3230 value when it was bound. CURRENT-BUFFER is the buffer that
3231 was current when the variable was bound. */
3232 else if (CONSP (this_binding
.symbol
))
3234 Lisp_Object symbol
, where
;
3236 symbol
= XCAR (this_binding
.symbol
);
3237 where
= XCAR (XCDR (this_binding
.symbol
));
3240 Fset_default (symbol
, this_binding
.old_value
);
3241 /* If `where' is non-nil, reset the value in the appropriate
3242 local binding, but only if that binding still exists. */
3243 else if (BUFFERP (where
)
3244 ? !NILP (Flocal_variable_p (symbol
, where
))
3245 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3246 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3248 /* If variable has a trivial value (no forwarding), we can
3249 just set it. No need to check for constant symbols here,
3250 since that was already done by specbind. */
3251 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3252 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3253 this_binding
.old_value
);
3255 /* NOTE: we only ever come here if make_local_foo was used for
3256 the first time on this var within this let. */
3257 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3260 if (NILP (Vquit_flag
) && !NILP (quitf
))
3267 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3268 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3269 The debugger is entered when that frame exits, if the flag is non-nil. */)
3270 (Lisp_Object level
, Lisp_Object flag
)
3272 register struct backtrace
*backlist
= backtrace_list
;
3275 CHECK_NUMBER (level
);
3277 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3279 backlist
= backlist
->next
;
3283 backlist
->debug_on_exit
= !NILP (flag
);
3288 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3289 doc
: /* Print a trace of Lisp function calls currently active.
3290 Output stream used is value of `standard-output'. */)
3293 register struct backtrace
*backlist
= backtrace_list
;
3297 struct gcpro gcpro1
;
3298 Lisp_Object old_print_level
= Vprint_level
;
3300 if (NILP (Vprint_level
))
3301 XSETFASTINT (Vprint_level
, 8);
3308 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3309 if (backlist
->nargs
== UNEVALLED
)
3311 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3312 write_string ("\n", -1);
3316 tem
= *backlist
->function
;
3317 Fprin1 (tem
, Qnil
); /* This can QUIT */
3318 write_string ("(", -1);
3319 if (backlist
->nargs
== MANY
)
3321 for (tail
= *backlist
->args
, i
= 0;
3323 tail
= Fcdr (tail
), i
++)
3325 if (i
) write_string (" ", -1);
3326 Fprin1 (Fcar (tail
), Qnil
);
3331 for (i
= 0; i
< backlist
->nargs
; i
++)
3333 if (i
) write_string (" ", -1);
3334 Fprin1 (backlist
->args
[i
], Qnil
);
3337 write_string (")\n", -1);
3339 backlist
= backlist
->next
;
3342 Vprint_level
= old_print_level
;
3347 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3348 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3349 If that frame has not evaluated the arguments yet (or is a special form),
3350 the value is (nil FUNCTION ARG-FORMS...).
3351 If that frame has evaluated its arguments and called its function already,
3352 the value is (t FUNCTION ARG-VALUES...).
3353 A &rest arg is represented as the tail of the list ARG-VALUES.
3354 FUNCTION is whatever was supplied as car of evaluated list,
3355 or a lambda expression for macro calls.
3356 If NFRAMES is more than the number of frames, the value is nil. */)
3357 (Lisp_Object nframes
)
3359 register struct backtrace
*backlist
= backtrace_list
;
3363 CHECK_NATNUM (nframes
);
3365 /* Find the frame requested. */
3366 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3367 backlist
= backlist
->next
;
3371 if (backlist
->nargs
== UNEVALLED
)
3372 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3375 if (backlist
->nargs
== MANY
)
3376 tem
= *backlist
->args
;
3378 tem
= Flist (backlist
->nargs
, backlist
->args
);
3380 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3386 mark_backtrace (void)
3388 register struct backtrace
*backlist
;
3391 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3393 mark_object (*backlist
->function
);
3395 if (backlist
->nargs
== UNEVALLED
|| backlist
->nargs
== MANY
)
3398 i
= backlist
->nargs
- 1;
3400 mark_object (backlist
->args
[i
]);
3407 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3408 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3409 If Lisp code tries to increase the total number past this amount,
3410 an error is signaled.
3411 You can safely use a value considerably larger than the default value,
3412 if that proves inconveniently small. However, if you increase it too far,
3413 Emacs could run out of memory trying to make the stack bigger. */);
3415 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3416 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3418 This limit serves to catch infinite recursions for you before they cause
3419 actual stack overflow in C, which would be fatal for Emacs.
3420 You can safely make it considerably larger than its default value,
3421 if that proves inconveniently small. However, if you increase it too far,
3422 Emacs could overflow the real C stack, and crash. */);
3424 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3425 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3426 If the value is t, that means do an ordinary quit.
3427 If the value equals `throw-on-input', that means quit by throwing
3428 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3429 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3430 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3433 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3434 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3435 Note that `quit-flag' will still be set by typing C-g,
3436 so a quit will be signaled as soon as `inhibit-quit' is nil.
3437 To prevent this happening, set `quit-flag' to nil
3438 before making `inhibit-quit' nil. */);
3439 Vinhibit_quit
= Qnil
;
3441 Qinhibit_quit
= intern_c_string ("inhibit-quit");
3442 staticpro (&Qinhibit_quit
);
3444 Qautoload
= intern_c_string ("autoload");
3445 staticpro (&Qautoload
);
3447 Qdebug_on_error
= intern_c_string ("debug-on-error");
3448 staticpro (&Qdebug_on_error
);
3450 Qmacro
= intern_c_string ("macro");
3451 staticpro (&Qmacro
);
3453 Qdeclare
= intern_c_string ("declare");
3454 staticpro (&Qdeclare
);
3456 /* Note that the process handling also uses Qexit, but we don't want
3457 to staticpro it twice, so we just do it here. */
3458 Qexit
= intern_c_string ("exit");
3461 Qinteractive
= intern_c_string ("interactive");
3462 staticpro (&Qinteractive
);
3464 Qcommandp
= intern_c_string ("commandp");
3465 staticpro (&Qcommandp
);
3467 Qdefun
= intern_c_string ("defun");
3468 staticpro (&Qdefun
);
3470 Qand_rest
= intern_c_string ("&rest");
3471 staticpro (&Qand_rest
);
3473 Qand_optional
= intern_c_string ("&optional");
3474 staticpro (&Qand_optional
);
3476 Qdebug
= intern_c_string ("debug");
3477 staticpro (&Qdebug
);
3479 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3480 doc
: /* *Non-nil means enter debugger if an error is signaled.
3481 Does not apply to errors handled by `condition-case' or those
3482 matched by `debug-ignored-errors'.
3483 If the value is a list, an error only means to enter the debugger
3484 if one of its condition symbols appears in the list.
3485 When you evaluate an expression interactively, this variable
3486 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3487 The command `toggle-debug-on-error' toggles this.
3488 See also the variable `debug-on-quit'. */);
3489 Vdebug_on_error
= Qnil
;
3491 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3492 doc
: /* *List of errors for which the debugger should not be called.
3493 Each element may be a condition-name or a regexp that matches error messages.
3494 If any element applies to a given error, that error skips the debugger
3495 and just returns to top level.
3496 This overrides the variable `debug-on-error'.
3497 It does not apply to errors handled by `condition-case'. */);
3498 Vdebug_ignored_errors
= Qnil
;
3500 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3501 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3502 Does not apply if quit is handled by a `condition-case'. */);
3505 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3506 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3508 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3509 doc
: /* Non-nil means debugger may continue execution.
3510 This is nil when the debugger is called under circumstances where it
3511 might not be safe to continue. */);
3512 debugger_may_continue
= 1;
3514 DEFVAR_LISP ("debugger", Vdebugger
,
3515 doc
: /* Function to call to invoke debugger.
3516 If due to frame exit, args are `exit' and the value being returned;
3517 this function's value will be returned instead of that.
3518 If due to error, args are `error' and a list of the args to `signal'.
3519 If due to `apply' or `funcall' entry, one arg, `lambda'.
3520 If due to `eval' entry, one arg, t. */);
3523 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3524 doc
: /* If non-nil, this is a function for `signal' to call.
3525 It receives the same arguments that `signal' was given.
3526 The Edebug package uses this to regain control. */);
3527 Vsignal_hook_function
= Qnil
;
3529 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3530 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3531 Note that `debug-on-error', `debug-on-quit' and friends
3532 still determine whether to handle the particular condition. */);
3533 Vdebug_on_signal
= Qnil
;
3535 DEFVAR_LISP ("macro-declaration-function", Vmacro_declaration_function
,
3536 doc
: /* Function to process declarations in a macro definition.
3537 The function will be called with two args MACRO and DECL.
3538 MACRO is the name of the macro being defined.
3539 DECL is a list `(declare ...)' containing the declarations.
3540 The value the function returns is not used. */);
3541 Vmacro_declaration_function
= Qnil
;
3543 Vrun_hooks
= intern_c_string ("run-hooks");
3544 staticpro (&Vrun_hooks
);
3546 staticpro (&Vautoload_queue
);
3547 Vautoload_queue
= Qnil
;
3548 staticpro (&Vsignaling_function
);
3549 Vsignaling_function
= Qnil
;
3560 defsubr (&Sfunction
);
3562 defsubr (&Sdefmacro
);
3564 defsubr (&Sdefvaralias
);
3565 defsubr (&Sdefconst
);
3566 defsubr (&Suser_variable_p
);
3570 defsubr (&Smacroexpand
);
3573 defsubr (&Sunwind_protect
);
3574 defsubr (&Scondition_case
);
3576 defsubr (&Sinteractive_p
);
3577 defsubr (&Scalled_interactively_p
);
3578 defsubr (&Scommandp
);
3579 defsubr (&Sautoload
);
3582 defsubr (&Sfuncall
);
3583 defsubr (&Srun_hooks
);
3584 defsubr (&Srun_hook_with_args
);
3585 defsubr (&Srun_hook_with_args_until_success
);
3586 defsubr (&Srun_hook_with_args_until_failure
);
3587 defsubr (&Sfetch_bytecode
);
3588 defsubr (&Sbacktrace_debug
);
3589 defsubr (&Sbacktrace
);
3590 defsubr (&Sbacktrace_frame
);