1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1999-2012 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/>. */
25 #include "blockinput.h"
28 #include "dispextern.h"
29 #include "frame.h" /* For XFRAME. */
37 struct backtrace
*next
;
38 Lisp_Object
*function
;
39 Lisp_Object
*args
; /* Points to vector of args. */
40 ptrdiff_t nargs
; /* Length of vector. */
41 /* Nonzero means call value of debugger when done with this operation. */
42 unsigned int debug_on_exit
: 1;
45 static struct backtrace
*backtrace_list
;
50 struct catchtag
*catchlist
;
52 /* Chain of condition handlers currently in effect.
53 The elements of this chain are contained in the stack frames
54 of Fcondition_case and internal_condition_case.
55 When an error is signaled (by calling Fsignal, below),
56 this chain is searched for an element that applies. */
61 struct handler
*handlerlist
;
64 /* Count levels of GCPRO to detect failure to UNGCPRO. */
68 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
;
69 Lisp_Object Qinhibit_quit
;
70 Lisp_Object Qand_rest
;
71 static Lisp_Object Qand_optional
;
72 static Lisp_Object Qdebug_on_error
;
73 static Lisp_Object Qdeclare
;
74 Lisp_Object Qinternal_interpreter_environment
, Qclosure
;
76 static Lisp_Object Qdebug
;
78 /* This holds either the symbol `run-hooks' or nil.
79 It is nil at an early stage of startup, and when Emacs
82 Lisp_Object Vrun_hooks
;
84 /* Non-nil means record all fset's and provide's, to be undone
85 if the file being autoloaded is not fully loaded.
86 They are recorded by being consed onto the front of Vautoload_queue:
87 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
89 Lisp_Object Vautoload_queue
;
91 /* Current number of specbindings allocated in specpdl. */
93 ptrdiff_t specpdl_size
;
95 /* Pointer to beginning of specpdl. */
97 struct specbinding
*specpdl
;
99 /* Pointer to first unused element in specpdl. */
101 struct specbinding
*specpdl_ptr
;
103 /* Depth in Lisp evaluations and function calls. */
105 static EMACS_INT lisp_eval_depth
;
107 /* The value of num_nonmacro_input_events as of the last time we
108 started to enter the debugger. If we decide to enter the debugger
109 again when this is still equal to num_nonmacro_input_events, then we
110 know that the debugger itself has an error, and we should just
111 signal the error instead of entering an infinite loop of debugger
114 static EMACS_INT when_entered_debugger
;
116 /* The function from which the last `signal' was called. Set in
119 Lisp_Object Vsignaling_function
;
121 /* Set to non-zero while processing X events. Checked in Feval to
122 make sure the Lisp interpreter isn't called from a signal handler,
123 which is unsafe because the interpreter isn't reentrant. */
127 /* If non-nil, Lisp code must not be run since some part of Emacs is
128 in an inconsistent state. Currently, x-create-frame uses this to
129 avoid triggering window-configuration-change-hook while the new
130 frame is half-initialized. */
131 Lisp_Object inhibit_lisp_code
;
133 static Lisp_Object
funcall_lambda (Lisp_Object
, ptrdiff_t, Lisp_Object
*);
134 static int interactive_p (int);
135 static Lisp_Object
apply_lambda (Lisp_Object fun
, Lisp_Object args
);
137 /* Functions to set Lisp_Object slots of struct specbinding. */
140 set_specpdl_symbol (Lisp_Object symbol
)
142 specpdl_ptr
->symbol
= symbol
;
146 set_specpdl_old_value (Lisp_Object oldval
)
148 specpdl_ptr
->old_value
= oldval
;
152 init_eval_once (void)
155 specpdl
= xmalloc (size
* sizeof *specpdl
);
157 specpdl_ptr
= specpdl
;
158 /* Don't forget to update docs (lispref node "Local Variables"). */
159 max_specpdl_size
= 1300; /* 1000 is not enough for CEDET's c-by.el. */
160 max_lisp_eval_depth
= 600;
168 specpdl_ptr
= specpdl
;
173 debug_on_next_call
= 0;
178 /* This is less than the initial value of num_nonmacro_input_events. */
179 when_entered_debugger
= -1;
182 /* Unwind-protect function used by call_debugger. */
185 restore_stack_limits (Lisp_Object data
)
187 max_specpdl_size
= XINT (XCAR (data
));
188 max_lisp_eval_depth
= XINT (XCDR (data
));
192 /* Call the Lisp debugger, giving it argument ARG. */
195 call_debugger (Lisp_Object arg
)
197 int debug_while_redisplaying
;
198 ptrdiff_t count
= SPECPDL_INDEX ();
200 EMACS_INT old_max
= max_specpdl_size
;
202 /* Temporarily bump up the stack limits,
203 so the debugger won't run out of stack. */
205 max_specpdl_size
+= 1;
206 record_unwind_protect (restore_stack_limits
,
207 Fcons (make_number (old_max
),
208 make_number (max_lisp_eval_depth
)));
209 max_specpdl_size
= old_max
;
211 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
212 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
214 if (max_specpdl_size
- 100 < SPECPDL_INDEX ())
215 max_specpdl_size
= SPECPDL_INDEX () + 100;
217 #ifdef HAVE_WINDOW_SYSTEM
218 if (display_hourglass_p
)
222 debug_on_next_call
= 0;
223 when_entered_debugger
= num_nonmacro_input_events
;
225 /* Resetting redisplaying_p to 0 makes sure that debug output is
226 displayed if the debugger is invoked during redisplay. */
227 debug_while_redisplaying
= redisplaying_p
;
229 specbind (intern ("debugger-may-continue"),
230 debug_while_redisplaying
? Qnil
: Qt
);
231 specbind (Qinhibit_redisplay
, Qnil
);
232 specbind (Qdebug_on_error
, Qnil
);
234 #if 0 /* Binding this prevents execution of Lisp code during
235 redisplay, which necessarily leads to display problems. */
236 specbind (Qinhibit_eval_during_redisplay
, Qt
);
239 val
= apply1 (Vdebugger
, arg
);
241 /* Interrupting redisplay and resuming it later is not safe under
242 all circumstances. So, when the debugger returns, abort the
243 interrupted redisplay by going back to the top-level. */
244 if (debug_while_redisplaying
)
247 return unbind_to (count
, val
);
251 do_debug_on_call (Lisp_Object code
)
253 debug_on_next_call
= 0;
254 backtrace_list
->debug_on_exit
= 1;
255 call_debugger (Fcons (code
, Qnil
));
258 /* NOTE!!! Every function that can call EVAL must protect its args
259 and temporaries from garbage collection while it needs them.
260 The definition of `For' shows what you have to do. */
262 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
263 doc
: /* Eval args until one of them yields non-nil, then return that value.
264 The remaining args are not evalled at all.
265 If all args return nil, return nil.
266 usage: (or CONDITIONS...) */)
269 register Lisp_Object val
= Qnil
;
276 val
= eval_sub (XCAR (args
));
286 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
287 doc
: /* Eval args until one of them yields nil, then return nil.
288 The remaining args are not evalled at all.
289 If no arg yields nil, return the last arg's value.
290 usage: (and CONDITIONS...) */)
293 register Lisp_Object val
= Qt
;
300 val
= eval_sub (XCAR (args
));
310 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
311 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
312 Returns the value of THEN or the value of the last of the ELSE's.
313 THEN must be one expression, but ELSE... can be zero or more expressions.
314 If COND yields nil, and there are no ELSE's, the value is nil.
315 usage: (if COND THEN ELSE...) */)
318 register Lisp_Object cond
;
322 cond
= eval_sub (Fcar (args
));
326 return eval_sub (Fcar (Fcdr (args
)));
327 return Fprogn (Fcdr (Fcdr (args
)));
330 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
331 doc
: /* Try each clause until one succeeds.
332 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
333 and, if the value is non-nil, this clause succeeds:
334 then the expressions in BODY are evaluated and the last one's
335 value is the value of the cond-form.
336 If no clause succeeds, cond returns nil.
337 If a clause has one element, as in (CONDITION),
338 CONDITION's value if non-nil is returned from the cond-form.
339 usage: (cond CLAUSES...) */)
342 register Lisp_Object clause
, val
;
349 clause
= Fcar (args
);
350 val
= eval_sub (Fcar (clause
));
353 if (!EQ (XCDR (clause
), Qnil
))
354 val
= Fprogn (XCDR (clause
));
364 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
365 doc
: /* Eval BODY forms sequentially and return value of last one.
366 usage: (progn BODY...) */)
369 register Lisp_Object val
= Qnil
;
376 val
= eval_sub (XCAR (args
));
384 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
385 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
386 The value of FIRST is saved during the evaluation of the remaining args,
387 whose values are discarded.
388 usage: (prog1 FIRST BODY...) */)
392 register Lisp_Object args_left
;
393 struct gcpro gcpro1
, gcpro2
;
399 val
= eval_sub (XCAR (args_left
));
400 while (CONSP (args_left
= XCDR (args_left
)))
401 eval_sub (XCAR (args_left
));
407 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
408 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
409 The value of FORM2 is saved during the evaluation of the
410 remaining args, whose values are discarded.
411 usage: (prog2 FORM1 FORM2 BODY...) */)
417 eval_sub (XCAR (args
));
419 return Fprog1 (XCDR (args
));
422 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
423 doc
: /* Set each SYM to the value of its VAL.
424 The symbols SYM are variables; they are literal (not evaluated).
425 The values VAL are expressions; they are evaluated.
426 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
427 The second VAL is not computed until after the first SYM is set, and so on;
428 each VAL can use the new value of variables set earlier in the `setq'.
429 The return value of the `setq' form is the value of the last VAL.
430 usage: (setq [SYM VAL]...) */)
433 register Lisp_Object args_left
;
434 register Lisp_Object val
, sym
, lex_binding
;
445 val
= eval_sub (Fcar (Fcdr (args_left
)));
446 sym
= Fcar (args_left
);
448 /* Like for eval_sub, we do not check declared_special here since
449 it's been done when let-binding. */
450 if (!NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
452 && !NILP (lex_binding
453 = Fassq (sym
, Vinternal_interpreter_environment
)))
454 XSETCDR (lex_binding
, val
); /* SYM is lexically bound. */
456 Fset (sym
, val
); /* SYM is dynamically bound. */
458 args_left
= Fcdr (Fcdr (args_left
));
460 while (!NILP (args_left
));
466 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
467 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
468 Warning: `quote' does not construct its return value, but just returns
469 the value that was pre-constructed by the Lisp reader (see info node
470 `(elisp)Printed Representation').
471 This means that '(a . b) is not identical to (cons 'a 'b): the former
472 does not cons. Quoting should be reserved for constants that will
473 never be modified by side-effects, unless you like self-modifying code.
474 See the common pitfall in info node `(elisp)Rearrangement' for an example
475 of unexpected results when a quoted object is modified.
476 usage: (quote ARG) */)
479 if (!NILP (Fcdr (args
)))
480 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
484 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
485 doc
: /* Like `quote', but preferred for objects which are functions.
486 In byte compilation, `function' causes its argument to be compiled.
487 `quote' cannot do that.
488 usage: (function ARG) */)
491 Lisp_Object quoted
= XCAR (args
);
493 if (!NILP (Fcdr (args
)))
494 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
496 if (!NILP (Vinternal_interpreter_environment
)
498 && EQ (XCAR (quoted
), Qlambda
))
499 /* This is a lambda expression within a lexical environment;
500 return an interpreted closure instead of a simple lambda. */
501 return Fcons (Qclosure
, Fcons (Vinternal_interpreter_environment
,
504 /* Simply quote the argument. */
509 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
510 doc
: /* Return t if the containing function was run directly by user input.
511 This means that the function was called with `call-interactively'
512 \(which includes being called as the binding of a key)
513 and input is currently coming from the keyboard (not a keyboard macro),
514 and Emacs is not running in batch mode (`noninteractive' is nil).
516 The only known proper use of `interactive-p' is in deciding whether to
517 display a helpful message, or how to display it. If you're thinking
518 of using it for any other purpose, it is quite likely that you're
519 making a mistake. Think: what do you want to do when the command is
520 called from a keyboard macro?
522 To test whether your function was called with `call-interactively',
523 either (i) add an extra optional argument and give it an `interactive'
524 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
525 use `called-interactively-p'. */)
528 return interactive_p (1) ? Qt
: Qnil
;
532 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
533 doc
: /* Return t if the containing function was called by `call-interactively'.
534 If KIND is `interactive', then only return t if the call was made
535 interactively by the user, i.e. not in `noninteractive' mode nor
536 when `executing-kbd-macro'.
537 If KIND is `any', on the other hand, it will return t for any kind of
538 interactive call, including being called as the binding of a key, or
539 from a keyboard macro, or in `noninteractive' mode.
541 The only known proper use of `interactive' for KIND is in deciding
542 whether to display a helpful message, or how to display it. If you're
543 thinking of using it for any other purpose, it is quite likely that
544 you're making a mistake. Think: what do you want to do when the
545 command is called from a keyboard macro?
547 This function is meant for implementing advice and other
548 function-modifying features. Instead of using this, it is sometimes
549 cleaner to give your function an extra optional argument whose
550 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
551 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
554 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
555 && interactive_p (1)) ? Qt
: Qnil
;
559 /* Return 1 if function in which this appears was called using
562 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
563 called is a built-in. */
566 interactive_p (int exclude_subrs_p
)
568 struct backtrace
*btp
;
571 btp
= backtrace_list
;
573 /* If this isn't a byte-compiled function, there may be a frame at
574 the top for Finteractive_p. If so, skip it. */
575 fun
= Findirect_function (*btp
->function
, Qnil
);
576 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
577 || XSUBR (fun
) == &Scalled_interactively_p
))
580 /* If we're running an Emacs 18-style byte-compiled function, there
581 may be a frame for Fbytecode at the top level. In any version of
582 Emacs there can be Fbytecode frames for subexpressions evaluated
583 inside catch and condition-case. Skip past them.
585 If this isn't a byte-compiled function, then we may now be
586 looking at several frames for special forms. Skip past them. */
588 && (EQ (*btp
->function
, Qbytecode
)
589 || btp
->nargs
== UNEVALLED
))
592 /* `btp' now points at the frame of the innermost function that isn't
593 a special form, ignoring frames for Finteractive_p and/or
594 Fbytecode at the top. If this frame is for a built-in function
595 (such as load or eval-region) return nil. */
596 fun
= Findirect_function (*btp
->function
, Qnil
);
597 if (exclude_subrs_p
&& SUBRP (fun
))
600 /* `btp' points to the frame of a Lisp function that called interactive-p.
601 Return t if that function was called interactively. */
602 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
608 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
609 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
610 Aliased variables always have the same value; setting one sets the other.
611 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
612 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
613 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
614 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
615 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
616 The return value is BASE-VARIABLE. */)
617 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
619 struct Lisp_Symbol
*sym
;
621 CHECK_SYMBOL (new_alias
);
622 CHECK_SYMBOL (base_variable
);
624 sym
= XSYMBOL (new_alias
);
627 /* Not sure why, but why not? */
628 error ("Cannot make a constant an alias");
630 switch (sym
->redirect
)
632 case SYMBOL_FORWARDED
:
633 error ("Cannot make an internal variable an alias");
634 case SYMBOL_LOCALIZED
:
635 error ("Don't know how to make a localized variable an alias");
638 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
639 If n_a is bound, but b_v is not, set the value of b_v to n_a,
640 so that old-code that affects n_a before the aliasing is setup
642 if (NILP (Fboundp (base_variable
)))
643 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
646 struct specbinding
*p
;
648 for (p
= specpdl_ptr
; p
> specpdl
; )
649 if ((--p
)->func
== NULL
651 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
652 error ("Don't know how to make a let-bound variable an alias");
655 sym
->declared_special
= 1;
656 XSYMBOL (base_variable
)->declared_special
= 1;
657 sym
->redirect
= SYMBOL_VARALIAS
;
658 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
659 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
660 LOADHIST_ATTACH (new_alias
);
661 /* Even if docstring is nil: remove old docstring. */
662 Fput (new_alias
, Qvariable_documentation
, docstring
);
664 return base_variable
;
668 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
669 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
670 You are not required to define a variable in order to use it, but
671 defining it lets you supply an initial value and documentation, which
672 can be referred to by the Emacs help facilities and other programming
673 tools. The `defvar' form also declares the variable as \"special\",
674 so that it is always dynamically bound even if `lexical-binding' is t.
676 The optional argument INITVALUE is evaluated, and used to set SYMBOL,
677 only if SYMBOL's value is void. If SYMBOL is buffer-local, its
678 default value is what is set; buffer-local values are not affected.
679 If INITVALUE is missing, SYMBOL's value is not set.
681 If SYMBOL has a local binding, then this form affects the local
682 binding. This is usually not what you want. Thus, if you need to
683 load a file defining variables, with this form or with `defconst' or
684 `defcustom', you should always load that file _outside_ any bindings
685 for these variables. \(`defconst' and `defcustom' behave similarly in
688 The optional argument DOCSTRING is a documentation string for the
691 To define a user option, use `defcustom' instead of `defvar'.
692 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
695 register Lisp_Object sym
, tem
, tail
;
699 if (!NILP (Fcdr (Fcdr (tail
))))
700 error ("Too many arguments");
702 tem
= Fdefault_boundp (sym
);
705 /* Do it before evaluating the initial value, for self-references. */
706 XSYMBOL (sym
)->declared_special
= 1;
709 Fset_default (sym
, eval_sub (Fcar (tail
)));
711 { /* Check if there is really a global binding rather than just a let
712 binding that shadows the global unboundness of the var. */
713 volatile struct specbinding
*pdl
= specpdl_ptr
;
714 while (pdl
> specpdl
)
716 if (EQ ((--pdl
)->symbol
, sym
) && !pdl
->func
717 && EQ (pdl
->old_value
, Qunbound
))
719 message_with_string ("Warning: defvar ignored because %s is let-bound",
720 SYMBOL_NAME (sym
), 1);
729 if (!NILP (Vpurify_flag
))
730 tem
= Fpurecopy (tem
);
731 Fput (sym
, Qvariable_documentation
, tem
);
733 LOADHIST_ATTACH (sym
);
735 else if (!NILP (Vinternal_interpreter_environment
)
736 && !XSYMBOL (sym
)->declared_special
)
737 /* A simple (defvar foo) with lexical scoping does "nothing" except
738 declare that var to be dynamically scoped *locally* (i.e. within
739 the current file or let-block). */
740 Vinternal_interpreter_environment
=
741 Fcons (sym
, Vinternal_interpreter_environment
);
744 /* Simple (defvar <var>) should not count as a definition at all.
745 It could get in the way of other definitions, and unloading this
746 package could try to make the variable unbound. */
752 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
753 doc
: /* Define SYMBOL as a constant variable.
754 This declares that neither programs nor users should ever change the
755 value. This constancy is not actually enforced by Emacs Lisp, but
756 SYMBOL is marked as a special variable so that it is never lexically
759 The `defconst' form always sets the value of SYMBOL to the result of
760 evalling INITVALUE. If SYMBOL is buffer-local, its default value is
761 what is set; buffer-local values are not affected. If SYMBOL has a
762 local binding, then this form sets the local binding's value.
763 However, you should normally not make local bindings for variables
764 defined with this form.
766 The optional DOCSTRING specifies the variable's documentation string.
767 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
770 register Lisp_Object sym
, tem
;
773 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
774 error ("Too many arguments");
776 tem
= eval_sub (Fcar (Fcdr (args
)));
777 if (!NILP (Vpurify_flag
))
778 tem
= Fpurecopy (tem
);
779 Fset_default (sym
, tem
);
780 XSYMBOL (sym
)->declared_special
= 1;
781 tem
= Fcar (Fcdr (Fcdr (args
)));
784 if (!NILP (Vpurify_flag
))
785 tem
= Fpurecopy (tem
);
786 Fput (sym
, Qvariable_documentation
, tem
);
788 Fput (sym
, Qrisky_local_variable
, Qt
);
789 LOADHIST_ATTACH (sym
);
793 /* Make SYMBOL lexically scoped. */
794 DEFUN ("internal-make-var-non-special", Fmake_var_non_special
,
795 Smake_var_non_special
, 1, 1, 0,
796 doc
: /* Internal function. */)
799 CHECK_SYMBOL (symbol
);
800 XSYMBOL (symbol
)->declared_special
= 0;
805 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
806 doc
: /* Bind variables according to VARLIST then eval BODY.
807 The value of the last form in BODY is returned.
808 Each element of VARLIST is a symbol (which is bound to nil)
809 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
810 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
811 usage: (let* VARLIST BODY...) */)
814 Lisp_Object varlist
, var
, val
, elt
, lexenv
;
815 ptrdiff_t count
= SPECPDL_INDEX ();
816 struct gcpro gcpro1
, gcpro2
, gcpro3
;
818 GCPRO3 (args
, elt
, varlist
);
820 lexenv
= Vinternal_interpreter_environment
;
822 varlist
= Fcar (args
);
823 while (CONSP (varlist
))
827 elt
= XCAR (varlist
);
833 else if (! NILP (Fcdr (Fcdr (elt
))))
834 signal_error ("`let' bindings can have only one value-form", elt
);
838 val
= eval_sub (Fcar (Fcdr (elt
)));
841 if (!NILP (lexenv
) && SYMBOLP (var
)
842 && !XSYMBOL (var
)->declared_special
843 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
844 /* Lexically bind VAR by adding it to the interpreter's binding
848 = Fcons (Fcons (var
, val
), Vinternal_interpreter_environment
);
849 if (EQ (Vinternal_interpreter_environment
, lexenv
))
850 /* Save the old lexical environment on the specpdl stack,
851 but only for the first lexical binding, since we'll never
852 need to revert to one of the intermediate ones. */
853 specbind (Qinternal_interpreter_environment
, newenv
);
855 Vinternal_interpreter_environment
= newenv
;
860 varlist
= XCDR (varlist
);
863 val
= Fprogn (Fcdr (args
));
864 return unbind_to (count
, val
);
867 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
868 doc
: /* Bind variables according to VARLIST then eval BODY.
869 The value of the last form in BODY is returned.
870 Each element of VARLIST is a symbol (which is bound to nil)
871 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
872 All the VALUEFORMs are evalled before any symbols are bound.
873 usage: (let VARLIST BODY...) */)
876 Lisp_Object
*temps
, tem
, lexenv
;
877 register Lisp_Object elt
, varlist
;
878 ptrdiff_t count
= SPECPDL_INDEX ();
880 struct gcpro gcpro1
, gcpro2
;
883 varlist
= Fcar (args
);
885 /* Make space to hold the values to give the bound variables. */
886 elt
= Flength (varlist
);
887 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
889 /* Compute the values and store them in `temps'. */
891 GCPRO2 (args
, *temps
);
894 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
897 elt
= XCAR (varlist
);
899 temps
[argnum
++] = Qnil
;
900 else if (! NILP (Fcdr (Fcdr (elt
))))
901 signal_error ("`let' bindings can have only one value-form", elt
);
903 temps
[argnum
++] = eval_sub (Fcar (Fcdr (elt
)));
904 gcpro2
.nvars
= argnum
;
908 lexenv
= Vinternal_interpreter_environment
;
910 varlist
= Fcar (args
);
911 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
915 elt
= XCAR (varlist
);
916 var
= SYMBOLP (elt
) ? elt
: Fcar (elt
);
917 tem
= temps
[argnum
++];
919 if (!NILP (lexenv
) && SYMBOLP (var
)
920 && !XSYMBOL (var
)->declared_special
921 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
922 /* Lexically bind VAR by adding it to the lexenv alist. */
923 lexenv
= Fcons (Fcons (var
, tem
), lexenv
);
925 /* Dynamically bind VAR. */
929 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
930 /* Instantiate a new lexical environment. */
931 specbind (Qinternal_interpreter_environment
, lexenv
);
933 elt
= Fprogn (Fcdr (args
));
935 return unbind_to (count
, elt
);
938 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
939 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
940 The order of execution is thus TEST, BODY, TEST, BODY and so on
941 until TEST returns nil.
942 usage: (while TEST BODY...) */)
945 Lisp_Object test
, body
;
946 struct gcpro gcpro1
, gcpro2
;
952 while (!NILP (eval_sub (test
)))
962 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
963 doc
: /* Return result of expanding macros at top level of FORM.
964 If FORM is not a macro call, it is returned unchanged.
965 Otherwise, the macro is expanded and the expansion is considered
966 in place of FORM. When a non-macro-call results, it is returned.
968 The second optional arg ENVIRONMENT specifies an environment of macro
969 definitions to shadow the loaded ones for use in file byte-compilation. */)
970 (Lisp_Object form
, Lisp_Object environment
)
972 /* With cleanups from Hallvard Furuseth. */
973 register Lisp_Object expander
, sym
, def
, tem
;
977 /* Come back here each time we expand a macro call,
978 in case it expands into another macro call. */
981 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
982 def
= sym
= XCAR (form
);
984 /* Trace symbols aliases to other symbols
985 until we get a symbol that is not an alias. */
986 while (SYMBOLP (def
))
990 tem
= Fassq (sym
, environment
);
993 def
= XSYMBOL (sym
)->function
;
994 if (!EQ (def
, Qunbound
))
999 /* Right now TEM is the result from SYM in ENVIRONMENT,
1000 and if TEM is nil then DEF is SYM's function definition. */
1003 /* SYM is not mentioned in ENVIRONMENT.
1004 Look at its function definition. */
1005 struct gcpro gcpro1
;
1007 def
= Fautoload_do_load (def
, sym
, Qmacro
);
1009 if (EQ (def
, Qunbound
) || !CONSP (def
))
1010 /* Not defined or definition not suitable. */
1012 if (!EQ (XCAR (def
), Qmacro
))
1014 else expander
= XCDR (def
);
1018 expander
= XCDR (tem
);
1019 if (NILP (expander
))
1023 Lisp_Object newform
= apply1 (expander
, XCDR (form
));
1024 if (EQ (form
, newform
))
1033 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1034 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1035 TAG is evalled to get the tag to use; it must not be nil.
1037 Then the BODY is executed.
1038 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1039 If no throw happens, `catch' returns the value of the last BODY form.
1040 If a throw happens, it specifies the value to return from `catch'.
1041 usage: (catch TAG BODY...) */)
1044 register Lisp_Object tag
;
1045 struct gcpro gcpro1
;
1048 tag
= eval_sub (Fcar (args
));
1050 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1053 /* Set up a catch, then call C function FUNC on argument ARG.
1054 FUNC should return a Lisp_Object.
1055 This is how catches are done from within C code. */
1058 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1060 /* This structure is made part of the chain `catchlist'. */
1063 /* Fill in the components of c, and put it on the list. */
1067 c
.backlist
= backtrace_list
;
1068 c
.handlerlist
= handlerlist
;
1069 c
.lisp_eval_depth
= lisp_eval_depth
;
1070 c
.pdlcount
= SPECPDL_INDEX ();
1071 c
.poll_suppress_count
= poll_suppress_count
;
1072 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1073 c
.gcpro
= gcprolist
;
1074 c
.byte_stack
= byte_stack_list
;
1078 if (! _setjmp (c
.jmp
))
1079 c
.val
= (*func
) (arg
);
1081 /* Throw works by a longjmp that comes right here. */
1086 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1087 jump to that CATCH, returning VALUE as the value of that catch.
1089 This is the guts Fthrow and Fsignal; they differ only in the way
1090 they choose the catch tag to throw to. A catch tag for a
1091 condition-case form has a TAG of Qnil.
1093 Before each catch is discarded, unbind all special bindings and
1094 execute all unwind-protect clauses made above that catch. Unwind
1095 the handler stack as we go, so that the proper handlers are in
1096 effect for each unwind-protect clause we run. At the end, restore
1097 some static info saved in CATCH, and longjmp to the location
1100 This is used for correct unwinding in Fthrow and Fsignal. */
1102 static _Noreturn
void
1103 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1107 /* Save the value in the tag. */
1110 /* Restore certain special C variables. */
1111 set_poll_suppress_count (catch->poll_suppress_count
);
1112 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1113 handling_signal
= 0;
1118 last_time
= catchlist
== catch;
1120 /* Unwind the specpdl stack, and then restore the proper set of
1122 unbind_to (catchlist
->pdlcount
, Qnil
);
1123 handlerlist
= catchlist
->handlerlist
;
1124 catchlist
= catchlist
->next
;
1126 while (! last_time
);
1129 /* If x_catch_errors was done, turn it off now.
1130 (First we give unbind_to a chance to do that.) */
1131 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1132 The catch must remain in effect during that delicate
1133 state. --lorentey */
1134 x_fully_uncatch_errors ();
1138 byte_stack_list
= catch->byte_stack
;
1139 gcprolist
= catch->gcpro
;
1141 gcpro_level
= gcprolist
? gcprolist
->level
+ 1 : 0;
1143 backtrace_list
= catch->backlist
;
1144 lisp_eval_depth
= catch->lisp_eval_depth
;
1146 _longjmp (catch->jmp
, 1);
1149 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1150 doc
: /* Throw to the catch for TAG and return VALUE from it.
1151 Both TAG and VALUE are evalled. */)
1152 (register Lisp_Object tag
, Lisp_Object value
)
1154 register struct catchtag
*c
;
1157 for (c
= catchlist
; c
; c
= c
->next
)
1159 if (EQ (c
->tag
, tag
))
1160 unwind_to_catch (c
, value
);
1162 xsignal2 (Qno_catch
, tag
, value
);
1166 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1167 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1168 If BODYFORM completes normally, its value is returned
1169 after executing the UNWINDFORMS.
1170 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1171 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1175 ptrdiff_t count
= SPECPDL_INDEX ();
1177 record_unwind_protect (Fprogn
, Fcdr (args
));
1178 val
= eval_sub (Fcar (args
));
1179 return unbind_to (count
, val
);
1182 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1183 doc
: /* Regain control when an error is signaled.
1184 Executes BODYFORM and returns its value if no error happens.
1185 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1186 where the BODY is made of Lisp expressions.
1188 A handler is applicable to an error
1189 if CONDITION-NAME is one of the error's condition names.
1190 If an error happens, the first applicable handler is run.
1192 The car of a handler may be a list of condition names instead of a
1193 single condition name; then it handles all of them. If the special
1194 condition name `debug' is present in this list, it allows another
1195 condition in the list to run the debugger if `debug-on-error' and the
1196 other usual mechanisms says it should (otherwise, `condition-case'
1197 suppresses the debugger).
1199 When a handler handles an error, control returns to the `condition-case'
1200 and it executes the handler's BODY...
1201 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1202 \(If VAR is nil, the handler can't access that information.)
1203 Then the value of the last BODY form is returned from the `condition-case'
1206 See also the function `signal' for more info.
1207 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1210 register Lisp_Object bodyform
, handlers
;
1211 volatile Lisp_Object var
;
1214 bodyform
= Fcar (Fcdr (args
));
1215 handlers
= Fcdr (Fcdr (args
));
1217 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1220 /* Like Fcondition_case, but the args are separate
1221 rather than passed in a list. Used by Fbyte_code. */
1224 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1225 Lisp_Object handlers
)
1233 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1239 && (SYMBOLP (XCAR (tem
))
1240 || CONSP (XCAR (tem
))))))
1241 error ("Invalid condition handler: %s",
1242 SDATA (Fprin1_to_string (tem
, Qt
)));
1247 c
.backlist
= backtrace_list
;
1248 c
.handlerlist
= handlerlist
;
1249 c
.lisp_eval_depth
= lisp_eval_depth
;
1250 c
.pdlcount
= SPECPDL_INDEX ();
1251 c
.poll_suppress_count
= poll_suppress_count
;
1252 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1253 c
.gcpro
= gcprolist
;
1254 c
.byte_stack
= byte_stack_list
;
1255 if (_setjmp (c
.jmp
))
1258 specbind (h
.var
, c
.val
);
1259 val
= Fprogn (Fcdr (h
.chosen_clause
));
1261 /* Note that this just undoes the binding of h.var; whoever
1262 longjumped to us unwound the stack to c.pdlcount before
1264 unbind_to (c
.pdlcount
, Qnil
);
1271 h
.handler
= handlers
;
1272 h
.next
= handlerlist
;
1276 val
= eval_sub (bodyform
);
1278 handlerlist
= h
.next
;
1282 /* Call the function BFUN with no arguments, catching errors within it
1283 according to HANDLERS. If there is an error, call HFUN with
1284 one argument which is the data that describes the error:
1287 HANDLERS can be a list of conditions to catch.
1288 If HANDLERS is Qt, catch all errors.
1289 If HANDLERS is Qerror, catch all errors
1290 but allow the debugger to run if that is enabled. */
1293 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1294 Lisp_Object (*hfun
) (Lisp_Object
))
1302 c
.backlist
= backtrace_list
;
1303 c
.handlerlist
= handlerlist
;
1304 c
.lisp_eval_depth
= lisp_eval_depth
;
1305 c
.pdlcount
= SPECPDL_INDEX ();
1306 c
.poll_suppress_count
= poll_suppress_count
;
1307 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1308 c
.gcpro
= gcprolist
;
1309 c
.byte_stack
= byte_stack_list
;
1310 if (_setjmp (c
.jmp
))
1312 return (*hfun
) (c
.val
);
1316 h
.handler
= handlers
;
1318 h
.next
= handlerlist
;
1324 handlerlist
= h
.next
;
1328 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1331 internal_condition_case_1 (Lisp_Object (*bfun
) (Lisp_Object
), Lisp_Object arg
,
1332 Lisp_Object handlers
, Lisp_Object (*hfun
) (Lisp_Object
))
1340 c
.backlist
= backtrace_list
;
1341 c
.handlerlist
= handlerlist
;
1342 c
.lisp_eval_depth
= lisp_eval_depth
;
1343 c
.pdlcount
= SPECPDL_INDEX ();
1344 c
.poll_suppress_count
= poll_suppress_count
;
1345 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1346 c
.gcpro
= gcprolist
;
1347 c
.byte_stack
= byte_stack_list
;
1348 if (_setjmp (c
.jmp
))
1350 return (*hfun
) (c
.val
);
1354 h
.handler
= handlers
;
1356 h
.next
= handlerlist
;
1360 val
= (*bfun
) (arg
);
1362 handlerlist
= h
.next
;
1366 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1370 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1373 Lisp_Object handlers
,
1374 Lisp_Object (*hfun
) (Lisp_Object
))
1382 c
.backlist
= backtrace_list
;
1383 c
.handlerlist
= handlerlist
;
1384 c
.lisp_eval_depth
= lisp_eval_depth
;
1385 c
.pdlcount
= SPECPDL_INDEX ();
1386 c
.poll_suppress_count
= poll_suppress_count
;
1387 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1388 c
.gcpro
= gcprolist
;
1389 c
.byte_stack
= byte_stack_list
;
1390 if (_setjmp (c
.jmp
))
1392 return (*hfun
) (c
.val
);
1396 h
.handler
= handlers
;
1398 h
.next
= handlerlist
;
1402 val
= (*bfun
) (arg1
, arg2
);
1404 handlerlist
= h
.next
;
1408 /* Like internal_condition_case but call BFUN with NARGS as first,
1409 and ARGS as second argument. */
1412 internal_condition_case_n (Lisp_Object (*bfun
) (ptrdiff_t, Lisp_Object
*),
1415 Lisp_Object handlers
,
1416 Lisp_Object (*hfun
) (Lisp_Object err
,
1426 c
.backlist
= backtrace_list
;
1427 c
.handlerlist
= handlerlist
;
1428 c
.lisp_eval_depth
= lisp_eval_depth
;
1429 c
.pdlcount
= SPECPDL_INDEX ();
1430 c
.poll_suppress_count
= poll_suppress_count
;
1431 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1432 c
.gcpro
= gcprolist
;
1433 c
.byte_stack
= byte_stack_list
;
1434 if (_setjmp (c
.jmp
))
1436 return (*hfun
) (c
.val
, nargs
, args
);
1440 h
.handler
= handlers
;
1442 h
.next
= handlerlist
;
1446 val
= (*bfun
) (nargs
, args
);
1448 handlerlist
= h
.next
;
1453 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
);
1454 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1458 process_quit_flag (void)
1460 Lisp_Object flag
= Vquit_flag
;
1462 if (EQ (flag
, Qkill_emacs
))
1464 if (EQ (Vthrow_on_input
, flag
))
1465 Fthrow (Vthrow_on_input
, Qt
);
1466 Fsignal (Qquit
, Qnil
);
1469 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1470 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1471 This function does not return.
1473 An error symbol is a symbol with an `error-conditions' property
1474 that is a list of condition names.
1475 A handler for any of those names will get to handle this signal.
1476 The symbol `error' should normally be one of them.
1478 DATA should be a list. Its elements are printed as part of the error message.
1479 See Info anchor `(elisp)Definition of signal' for some details on how this
1480 error message is constructed.
1481 If the signal is handled, DATA is made available to the handler.
1482 See also the function `condition-case'. */)
1483 (Lisp_Object error_symbol
, Lisp_Object data
)
1485 /* When memory is full, ERROR-SYMBOL is nil,
1486 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1487 That is a special case--don't do this in other situations. */
1488 Lisp_Object conditions
;
1490 Lisp_Object real_error_symbol
1491 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1492 register Lisp_Object clause
= Qnil
;
1494 struct backtrace
*bp
;
1496 immediate_quit
= handling_signal
= 0;
1498 if (gc_in_progress
|| waiting_for_input
)
1501 #if 0 /* rms: I don't know why this was here,
1502 but it is surely wrong for an error that is handled. */
1503 #ifdef HAVE_WINDOW_SYSTEM
1504 if (display_hourglass_p
)
1505 cancel_hourglass ();
1509 /* This hook is used by edebug. */
1510 if (! NILP (Vsignal_hook_function
)
1511 && ! NILP (error_symbol
))
1513 /* Edebug takes care of restoring these variables when it exits. */
1514 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1515 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1517 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1518 max_specpdl_size
= SPECPDL_INDEX () + 40;
1520 call2 (Vsignal_hook_function
, error_symbol
, data
);
1523 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1525 /* Remember from where signal was called. Skip over the frame for
1526 `signal' itself. If a frame for `error' follows, skip that,
1527 too. Don't do this when ERROR_SYMBOL is nil, because that
1528 is a memory-full error. */
1529 Vsignaling_function
= Qnil
;
1530 if (backtrace_list
&& !NILP (error_symbol
))
1532 bp
= backtrace_list
->next
;
1533 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1535 if (bp
&& bp
->function
)
1536 Vsignaling_function
= *bp
->function
;
1539 for (h
= handlerlist
; h
; h
= h
->next
)
1541 clause
= find_handler_clause (h
->handler
, conditions
);
1546 if (/* Don't run the debugger for a memory-full error.
1547 (There is no room in memory to do that!) */
1548 !NILP (error_symbol
)
1549 && (!NILP (Vdebug_on_signal
)
1550 /* If no handler is present now, try to run the debugger. */
1552 /* A `debug' symbol in the handler list disables the normal
1553 suppression of the debugger. */
1554 || (CONSP (clause
) && CONSP (XCAR (clause
))
1555 && !NILP (Fmemq (Qdebug
, XCAR (clause
))))
1556 /* Special handler that means "print a message and run debugger
1558 || EQ (h
->handler
, Qerror
)))
1561 = maybe_call_debugger (conditions
, error_symbol
, data
);
1562 /* We can't return values to code which signaled an error, but we
1563 can continue code which has signaled a quit. */
1564 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1570 Lisp_Object unwind_data
1571 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1573 h
->chosen_clause
= clause
;
1574 unwind_to_catch (h
->tag
, unwind_data
);
1579 Fthrow (Qtop_level
, Qt
);
1582 if (! NILP (error_symbol
))
1583 data
= Fcons (error_symbol
, data
);
1585 string
= Ferror_message_string (data
);
1586 fatal ("%s", SDATA (string
));
1589 /* Internal version of Fsignal that never returns.
1590 Used for anything but Qquit (which can return from Fsignal). */
1593 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1595 Fsignal (error_symbol
, data
);
1599 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1602 xsignal0 (Lisp_Object error_symbol
)
1604 xsignal (error_symbol
, Qnil
);
1608 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1610 xsignal (error_symbol
, list1 (arg
));
1614 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1616 xsignal (error_symbol
, list2 (arg1
, arg2
));
1620 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1622 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1625 /* Signal `error' with message S, and additional arg ARG.
1626 If ARG is not a genuine list, make it a one-element list. */
1629 signal_error (const char *s
, Lisp_Object arg
)
1631 Lisp_Object tortoise
, hare
;
1633 hare
= tortoise
= arg
;
1634 while (CONSP (hare
))
1641 tortoise
= XCDR (tortoise
);
1643 if (EQ (hare
, tortoise
))
1648 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1650 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1654 /* Return nonzero if LIST is a non-nil atom or
1655 a list containing one of CONDITIONS. */
1658 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1665 while (CONSP (conditions
))
1667 Lisp_Object
this, tail
;
1668 this = XCAR (conditions
);
1669 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1670 if (EQ (XCAR (tail
), this))
1672 conditions
= XCDR (conditions
);
1677 /* Return 1 if an error with condition-symbols CONDITIONS,
1678 and described by SIGNAL-DATA, should skip the debugger
1679 according to debugger-ignored-errors. */
1682 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1685 int first_string
= 1;
1686 Lisp_Object error_message
;
1688 error_message
= Qnil
;
1689 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1691 if (STRINGP (XCAR (tail
)))
1695 error_message
= Ferror_message_string (data
);
1699 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1704 Lisp_Object contail
;
1706 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1707 if (EQ (XCAR (tail
), XCAR (contail
)))
1715 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1716 SIG and DATA describe the signal. There are two ways to pass them:
1717 = SIG is the error symbol, and DATA is the rest of the data.
1718 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1719 This is for memory-full errors only. */
1721 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1723 Lisp_Object combined_data
;
1725 combined_data
= Fcons (sig
, data
);
1728 /* Don't try to run the debugger with interrupts blocked.
1729 The editing loop would return anyway. */
1731 /* Does user want to enter debugger for this kind of error? */
1734 : wants_debugger (Vdebug_on_error
, conditions
))
1735 && ! skip_debugger (conditions
, combined_data
)
1736 /* RMS: What's this for? */
1737 && when_entered_debugger
< num_nonmacro_input_events
)
1739 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1747 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
)
1749 register Lisp_Object h
;
1751 /* t is used by handlers for all conditions, set up by C code. */
1752 if (EQ (handlers
, Qt
))
1755 /* error is used similarly, but means print an error message
1756 and run the debugger if that is enabled. */
1757 if (EQ (handlers
, Qerror
))
1760 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1762 Lisp_Object handler
= XCAR (h
);
1763 Lisp_Object condit
, tem
;
1765 if (!CONSP (handler
))
1767 condit
= XCAR (handler
);
1768 /* Handle a single condition name in handler HANDLER. */
1769 if (SYMBOLP (condit
))
1771 tem
= Fmemq (Fcar (handler
), conditions
);
1775 /* Handle a list of condition names in handler HANDLER. */
1776 else if (CONSP (condit
))
1779 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1781 tem
= Fmemq (XCAR (tail
), conditions
);
1792 /* Dump an error message; called like vprintf. */
1794 verror (const char *m
, va_list ap
)
1797 ptrdiff_t size
= sizeof buf
;
1798 ptrdiff_t size_max
= STRING_BYTES_BOUND
+ 1;
1803 used
= evxprintf (&buffer
, &size
, buf
, size_max
, m
, ap
);
1804 string
= make_string (buffer
, used
);
1808 xsignal1 (Qerror
, string
);
1812 /* Dump an error message; called like printf. */
1816 error (const char *m
, ...)
1824 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
1825 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
1826 This means it contains a description for how to read arguments to give it.
1827 The value is nil for an invalid function or a symbol with no function
1830 Interactively callable functions include strings and vectors (treated
1831 as keyboard macros), lambda-expressions that contain a top-level call
1832 to `interactive', autoload definitions made by `autoload' with non-nil
1833 fourth argument, and some of the built-in functions of Lisp.
1835 Also, a symbol satisfies `commandp' if its function definition does so.
1837 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1838 then strings and vectors are not accepted. */)
1839 (Lisp_Object function
, Lisp_Object for_call_interactively
)
1841 register Lisp_Object fun
;
1842 register Lisp_Object funcar
;
1843 Lisp_Object if_prop
= Qnil
;
1847 fun
= indirect_function (fun
); /* Check cycles. */
1848 if (NILP (fun
) || EQ (fun
, Qunbound
))
1851 /* Check an `interactive-form' property if present, analogous to the
1852 function-documentation property. */
1854 while (SYMBOLP (fun
))
1856 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
1859 fun
= Fsymbol_function (fun
);
1862 /* Emacs primitives are interactive if their DEFUN specifies an
1863 interactive spec. */
1865 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
1867 /* Bytecode objects are interactive if they are long enough to
1868 have an element whose index is COMPILED_INTERACTIVE, which is
1869 where the interactive spec is stored. */
1870 else if (COMPILEDP (fun
))
1871 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
1874 /* Strings and vectors are keyboard macros. */
1875 if (STRINGP (fun
) || VECTORP (fun
))
1876 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
1878 /* Lists may represent commands. */
1881 funcar
= XCAR (fun
);
1882 if (EQ (funcar
, Qclosure
))
1883 return (!NILP (Fassq (Qinteractive
, Fcdr (Fcdr (XCDR (fun
)))))
1885 else if (EQ (funcar
, Qlambda
))
1886 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
1887 else if (EQ (funcar
, Qautoload
))
1888 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
1893 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
1894 doc
: /* Define FUNCTION to autoload from FILE.
1895 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1896 Third arg DOCSTRING is documentation for the function.
1897 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1898 Fifth arg TYPE indicates the type of the object:
1899 nil or omitted says FUNCTION is a function,
1900 `keymap' says FUNCTION is really a keymap, and
1901 `macro' or t says FUNCTION is really a macro.
1902 Third through fifth args give info about the real definition.
1903 They default to nil.
1904 If FUNCTION is already defined other than as an autoload,
1905 this does nothing and returns nil. */)
1906 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
1908 CHECK_SYMBOL (function
);
1909 CHECK_STRING (file
);
1911 /* If function is defined and not as an autoload, don't override. */
1912 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
1913 && !(CONSP (XSYMBOL (function
)->function
)
1914 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
1917 if (NILP (Vpurify_flag
))
1918 /* Only add entries after dumping, because the ones before are
1919 not useful and else we get loads of them from the loaddefs.el. */
1920 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
1921 else if (EQ (docstring
, make_number (0)))
1922 /* `read1' in lread.c has found the docstring starting with "\
1923 and assumed the docstring will be provided by Snarf-documentation, so it
1924 passed us 0 instead. But that leads to accidental sharing in purecopy's
1925 hash-consing, so we use a (hopefully) unique integer instead. */
1926 docstring
= make_number (XUNTAG (function
, Lisp_Symbol
));
1927 return Ffset (function
,
1928 Fpurecopy (list5 (Qautoload
, file
, docstring
,
1929 interactive
, type
)));
1933 un_autoload (Lisp_Object oldqueue
)
1935 register Lisp_Object queue
, first
, second
;
1937 /* Queue to unwind is current value of Vautoload_queue.
1938 oldqueue is the shadowed value to leave in Vautoload_queue. */
1939 queue
= Vautoload_queue
;
1940 Vautoload_queue
= oldqueue
;
1941 while (CONSP (queue
))
1943 first
= XCAR (queue
);
1944 second
= Fcdr (first
);
1945 first
= Fcar (first
);
1946 if (EQ (first
, make_number (0)))
1949 Ffset (first
, second
);
1950 queue
= XCDR (queue
);
1955 /* Load an autoloaded function.
1956 FUNNAME is the symbol which is the function's name.
1957 FUNDEF is the autoload definition (a list). */
1959 DEFUN ("autoload-do-load", Fautoload_do_load
, Sautoload_do_load
, 1, 3, 0,
1960 doc
: /* Load FUNDEF which should be an autoload.
1961 If non-nil, FUNNAME should be the symbol whose function value is FUNDEF,
1962 in which case the function returns the new autoloaded function value.
1963 If equal to `macro', MACRO-ONLY specifies that FUNDEF should only be loaded if
1964 it is defines a macro. */)
1965 (Lisp_Object fundef
, Lisp_Object funname
, Lisp_Object macro_only
)
1967 ptrdiff_t count
= SPECPDL_INDEX ();
1968 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1970 if (!CONSP (fundef
) || !EQ (Qautoload
, XCAR (fundef
)))
1973 if (EQ (macro_only
, Qmacro
))
1975 Lisp_Object kind
= Fnth (make_number (4), fundef
);
1976 if (! (EQ (kind
, Qt
) || EQ (kind
, Qmacro
)))
1980 /* This is to make sure that loadup.el gives a clear picture
1981 of what files are preloaded and when. */
1982 if (! NILP (Vpurify_flag
))
1983 error ("Attempt to autoload %s while preparing to dump",
1984 SDATA (SYMBOL_NAME (funname
)));
1986 CHECK_SYMBOL (funname
);
1987 GCPRO3 (funname
, fundef
, macro_only
);
1989 /* Preserve the match data. */
1990 record_unwind_save_match_data ();
1992 /* If autoloading gets an error (which includes the error of failing
1993 to define the function being called), we use Vautoload_queue
1994 to undo function definitions and `provide' calls made by
1995 the function. We do this in the specific case of autoloading
1996 because autoloading is not an explicit request "load this file",
1997 but rather a request to "call this function".
1999 The value saved here is to be restored into Vautoload_queue. */
2000 record_unwind_protect (un_autoload
, Vautoload_queue
);
2001 Vautoload_queue
= Qt
;
2002 /* If `macro_only', assume this autoload to be a "best-effort",
2003 so don't signal an error if autoloading fails. */
2004 Fload (Fcar (Fcdr (fundef
)), macro_only
, Qt
, Qnil
, Qt
);
2006 /* Once loading finishes, don't undo it. */
2007 Vautoload_queue
= Qt
;
2008 unbind_to (count
, Qnil
);
2016 Lisp_Object fun
= Findirect_function (funname
, Qnil
);
2018 if (!NILP (Fequal (fun
, fundef
)))
2019 error ("Autoloading failed to define function %s",
2020 SDATA (SYMBOL_NAME (funname
)));
2027 DEFUN ("eval", Feval
, Seval
, 1, 2, 0,
2028 doc
: /* Evaluate FORM and return its value.
2029 If LEXICAL is t, evaluate using lexical scoping. */)
2030 (Lisp_Object form
, Lisp_Object lexical
)
2032 ptrdiff_t count
= SPECPDL_INDEX ();
2033 specbind (Qinternal_interpreter_environment
,
2034 NILP (lexical
) ? Qnil
: Fcons (Qt
, Qnil
));
2035 return unbind_to (count
, eval_sub (form
));
2038 /* Eval a sub-expression of the current expression (i.e. in the same
2041 eval_sub (Lisp_Object form
)
2043 Lisp_Object fun
, val
, original_fun
, original_args
;
2045 struct backtrace backtrace
;
2046 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2048 if (handling_signal
)
2053 /* Look up its binding in the lexical environment.
2054 We do not pay attention to the declared_special flag here, since we
2055 already did that when let-binding the variable. */
2056 Lisp_Object lex_binding
2057 = !NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
2058 ? Fassq (form
, Vinternal_interpreter_environment
)
2060 if (CONSP (lex_binding
))
2061 return XCDR (lex_binding
);
2063 return Fsymbol_value (form
);
2072 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2074 if (max_lisp_eval_depth
< 100)
2075 max_lisp_eval_depth
= 100;
2076 if (lisp_eval_depth
> max_lisp_eval_depth
)
2077 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2080 original_fun
= XCAR (form
);
2081 original_args
= XCDR (form
);
2083 backtrace
.next
= backtrace_list
;
2084 backtrace_list
= &backtrace
;
2085 backtrace
.function
= &original_fun
; /* This also protects them from gc. */
2086 backtrace
.args
= &original_args
;
2087 backtrace
.nargs
= UNEVALLED
;
2088 backtrace
.debug_on_exit
= 0;
2090 if (debug_on_next_call
)
2091 do_debug_on_call (Qt
);
2093 /* At this point, only original_fun and original_args
2094 have values that will be used below. */
2097 /* Optimize for no indirection. */
2099 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2100 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2101 fun
= indirect_function (fun
);
2105 Lisp_Object numargs
;
2106 Lisp_Object argvals
[8];
2107 Lisp_Object args_left
;
2108 register int i
, maxargs
;
2110 args_left
= original_args
;
2111 numargs
= Flength (args_left
);
2115 if (XINT (numargs
) < XSUBR (fun
)->min_args
2116 || (XSUBR (fun
)->max_args
>= 0
2117 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2118 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2120 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2121 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2122 else if (XSUBR (fun
)->max_args
== MANY
)
2124 /* Pass a vector of evaluated arguments. */
2126 ptrdiff_t argnum
= 0;
2129 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2131 GCPRO3 (args_left
, fun
, fun
);
2135 while (!NILP (args_left
))
2137 vals
[argnum
++] = eval_sub (Fcar (args_left
));
2138 args_left
= Fcdr (args_left
);
2139 gcpro3
.nvars
= argnum
;
2142 backtrace
.args
= vals
;
2143 backtrace
.nargs
= XINT (numargs
);
2145 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2151 GCPRO3 (args_left
, fun
, fun
);
2152 gcpro3
.var
= argvals
;
2155 maxargs
= XSUBR (fun
)->max_args
;
2156 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2158 argvals
[i
] = eval_sub (Fcar (args_left
));
2164 backtrace
.args
= argvals
;
2165 backtrace
.nargs
= XINT (numargs
);
2170 val
= (XSUBR (fun
)->function
.a0 ());
2173 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2176 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2179 val
= (XSUBR (fun
)->function
.a3
2180 (argvals
[0], argvals
[1], argvals
[2]));
2183 val
= (XSUBR (fun
)->function
.a4
2184 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2187 val
= (XSUBR (fun
)->function
.a5
2188 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2192 val
= (XSUBR (fun
)->function
.a6
2193 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2194 argvals
[4], argvals
[5]));
2197 val
= (XSUBR (fun
)->function
.a7
2198 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2199 argvals
[4], argvals
[5], argvals
[6]));
2203 val
= (XSUBR (fun
)->function
.a8
2204 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2205 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2209 /* Someone has created a subr that takes more arguments than
2210 is supported by this code. We need to either rewrite the
2211 subr to use a different argument protocol, or add more
2212 cases to this switch. */
2217 else if (COMPILEDP (fun
))
2218 val
= apply_lambda (fun
, original_args
);
2221 if (EQ (fun
, Qunbound
))
2222 xsignal1 (Qvoid_function
, original_fun
);
2224 xsignal1 (Qinvalid_function
, original_fun
);
2225 funcar
= XCAR (fun
);
2226 if (!SYMBOLP (funcar
))
2227 xsignal1 (Qinvalid_function
, original_fun
);
2228 if (EQ (funcar
, Qautoload
))
2230 Fautoload_do_load (fun
, original_fun
, Qnil
);
2233 if (EQ (funcar
, Qmacro
))
2235 ptrdiff_t count
= SPECPDL_INDEX ();
2236 extern Lisp_Object Qlexical_binding
;
2238 /* Bind lexical-binding during expansion of the macro, so the
2239 macro can know reliably if the code it outputs will be
2240 interpreted using lexical-binding or not. */
2241 specbind (Qlexical_binding
,
2242 NILP (Vinternal_interpreter_environment
) ? Qnil
: Qt
);
2243 exp
= apply1 (Fcdr (fun
), original_args
);
2244 unbind_to (count
, Qnil
);
2245 val
= eval_sub (exp
);
2247 else if (EQ (funcar
, Qlambda
)
2248 || EQ (funcar
, Qclosure
))
2249 val
= apply_lambda (fun
, original_args
);
2251 xsignal1 (Qinvalid_function
, original_fun
);
2256 if (backtrace
.debug_on_exit
)
2257 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2258 backtrace_list
= backtrace
.next
;
2263 DEFUN ("apply", Fapply
, Sapply
, 1, MANY
, 0,
2264 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2265 Then return the value FUNCTION returns.
2266 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2267 usage: (apply FUNCTION &rest ARGUMENTS) */)
2268 (ptrdiff_t nargs
, Lisp_Object
*args
)
2272 register Lisp_Object spread_arg
;
2273 register Lisp_Object
*funcall_args
;
2274 Lisp_Object fun
, retval
;
2275 struct gcpro gcpro1
;
2280 spread_arg
= args
[nargs
- 1];
2281 CHECK_LIST (spread_arg
);
2283 numargs
= XINT (Flength (spread_arg
));
2286 return Ffuncall (nargs
- 1, args
);
2287 else if (numargs
== 1)
2289 args
[nargs
- 1] = XCAR (spread_arg
);
2290 return Ffuncall (nargs
, args
);
2293 numargs
+= nargs
- 2;
2295 /* Optimize for no indirection. */
2296 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2297 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2298 fun
= indirect_function (fun
);
2299 if (EQ (fun
, Qunbound
))
2301 /* Let funcall get the error. */
2308 if (numargs
< XSUBR (fun
)->min_args
2309 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2310 goto funcall
; /* Let funcall get the error. */
2311 else if (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
> numargs
)
2313 /* Avoid making funcall cons up a yet another new vector of arguments
2314 by explicitly supplying nil's for optional values. */
2315 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2316 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2317 funcall_args
[++i
] = Qnil
;
2318 GCPRO1 (*funcall_args
);
2319 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2323 /* We add 1 to numargs because funcall_args includes the
2324 function itself as well as its arguments. */
2327 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2328 GCPRO1 (*funcall_args
);
2329 gcpro1
.nvars
= 1 + numargs
;
2332 memcpy (funcall_args
, args
, nargs
* word_size
);
2333 /* Spread the last arg we got. Its first element goes in
2334 the slot that it used to occupy, hence this value of I. */
2336 while (!NILP (spread_arg
))
2338 funcall_args
[i
++] = XCAR (spread_arg
);
2339 spread_arg
= XCDR (spread_arg
);
2342 /* By convention, the caller needs to gcpro Ffuncall's args. */
2343 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2350 /* Run hook variables in various ways. */
2353 funcall_nil (ptrdiff_t nargs
, Lisp_Object
*args
)
2355 Ffuncall (nargs
, args
);
2359 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2360 doc
: /* Run each hook in HOOKS.
2361 Each argument should be a symbol, a hook variable.
2362 These symbols are processed in the order specified.
2363 If a hook symbol has a non-nil value, that value may be a function
2364 or a list of functions to be called to run the hook.
2365 If the value is a function, it is called with no arguments.
2366 If it is a list, the elements are called, in order, with no arguments.
2368 Major modes should not use this function directly to run their mode
2369 hook; they should use `run-mode-hooks' instead.
2371 Do not use `make-local-variable' to make a hook variable buffer-local.
2372 Instead, use `add-hook' and specify t for the LOCAL argument.
2373 usage: (run-hooks &rest HOOKS) */)
2374 (ptrdiff_t nargs
, Lisp_Object
*args
)
2376 Lisp_Object hook
[1];
2379 for (i
= 0; i
< nargs
; i
++)
2382 run_hook_with_args (1, hook
, funcall_nil
);
2388 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2389 Srun_hook_with_args
, 1, MANY
, 0,
2390 doc
: /* Run HOOK with the specified arguments ARGS.
2391 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2392 value, that value may be a function or a list of functions to be
2393 called to run the hook. If the value is a function, it is called with
2394 the given arguments and its return value is returned. If it is a list
2395 of functions, those functions are called, in order,
2396 with the given arguments ARGS.
2397 It is best not to depend on the value returned by `run-hook-with-args',
2400 Do not use `make-local-variable' to make a hook variable buffer-local.
2401 Instead, use `add-hook' and specify t for the LOCAL argument.
2402 usage: (run-hook-with-args HOOK &rest ARGS) */)
2403 (ptrdiff_t nargs
, Lisp_Object
*args
)
2405 return run_hook_with_args (nargs
, args
, funcall_nil
);
2408 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2409 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2410 doc
: /* Run HOOK with the specified arguments ARGS.
2411 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2412 value, that value may be a function or a list of functions to be
2413 called to run the hook. If the value is a function, it is called with
2414 the given arguments and its return value is returned.
2415 If it is a list of functions, those functions are called, in order,
2416 with the given arguments ARGS, until one of them
2417 returns a non-nil value. Then we return that value.
2418 However, if they all return nil, we return nil.
2420 Do not use `make-local-variable' to make a hook variable buffer-local.
2421 Instead, use `add-hook' and specify t for the LOCAL argument.
2422 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2423 (ptrdiff_t nargs
, Lisp_Object
*args
)
2425 return run_hook_with_args (nargs
, args
, Ffuncall
);
2429 funcall_not (ptrdiff_t nargs
, Lisp_Object
*args
)
2431 return NILP (Ffuncall (nargs
, args
)) ? Qt
: Qnil
;
2434 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2435 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2436 doc
: /* Run HOOK with the specified arguments ARGS.
2437 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2438 value, that value may be a function or a list of functions to be
2439 called to run the hook. If the value is a function, it is called with
2440 the given arguments and its return value is returned.
2441 If it is a list of functions, those functions are called, in order,
2442 with the given arguments ARGS, until one of them returns nil.
2443 Then we return nil. However, if they all return non-nil, we return non-nil.
2445 Do not use `make-local-variable' to make a hook variable buffer-local.
2446 Instead, use `add-hook' and specify t for the LOCAL argument.
2447 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2448 (ptrdiff_t nargs
, Lisp_Object
*args
)
2450 return NILP (run_hook_with_args (nargs
, args
, funcall_not
)) ? Qt
: Qnil
;
2454 run_hook_wrapped_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
2456 Lisp_Object tmp
= args
[0], ret
;
2459 ret
= Ffuncall (nargs
, args
);
2465 DEFUN ("run-hook-wrapped", Frun_hook_wrapped
, Srun_hook_wrapped
, 2, MANY
, 0,
2466 doc
: /* Run HOOK, passing each function through WRAP-FUNCTION.
2467 I.e. instead of calling each function FUN directly with arguments ARGS,
2468 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2469 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2470 aborts and returns that value.
2471 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2472 (ptrdiff_t nargs
, Lisp_Object
*args
)
2474 return run_hook_with_args (nargs
, args
, run_hook_wrapped_funcall
);
2477 /* ARGS[0] should be a hook symbol.
2478 Call each of the functions in the hook value, passing each of them
2479 as arguments all the rest of ARGS (all NARGS - 1 elements).
2480 FUNCALL specifies how to call each function on the hook.
2481 The caller (or its caller, etc) must gcpro all of ARGS,
2482 except that it isn't necessary to gcpro ARGS[0]. */
2485 run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2486 Lisp_Object (*funcall
) (ptrdiff_t nargs
, Lisp_Object
*args
))
2488 Lisp_Object sym
, val
, ret
= Qnil
;
2489 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2491 /* If we are dying or still initializing,
2492 don't do anything--it would probably crash if we tried. */
2493 if (NILP (Vrun_hooks
))
2497 val
= find_symbol_value (sym
);
2499 if (EQ (val
, Qunbound
) || NILP (val
))
2501 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2504 return funcall (nargs
, args
);
2508 Lisp_Object global_vals
= Qnil
;
2509 GCPRO3 (sym
, val
, global_vals
);
2512 CONSP (val
) && NILP (ret
);
2515 if (EQ (XCAR (val
), Qt
))
2517 /* t indicates this hook has a local binding;
2518 it means to run the global binding too. */
2519 global_vals
= Fdefault_value (sym
);
2520 if (NILP (global_vals
)) continue;
2522 if (!CONSP (global_vals
) || EQ (XCAR (global_vals
), Qlambda
))
2524 args
[0] = global_vals
;
2525 ret
= funcall (nargs
, args
);
2530 CONSP (global_vals
) && NILP (ret
);
2531 global_vals
= XCDR (global_vals
))
2533 args
[0] = XCAR (global_vals
);
2534 /* In a global value, t should not occur. If it does, we
2535 must ignore it to avoid an endless loop. */
2536 if (!EQ (args
[0], Qt
))
2537 ret
= funcall (nargs
, args
);
2543 args
[0] = XCAR (val
);
2544 ret
= funcall (nargs
, args
);
2553 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2556 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2558 Lisp_Object temp
[3];
2563 Frun_hook_with_args (3, temp
);
2566 /* Apply fn to arg. */
2568 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2570 struct gcpro gcpro1
;
2574 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2577 Lisp_Object args
[2];
2581 RETURN_UNGCPRO (Fapply (2, args
));
2585 /* Call function fn on no arguments. */
2587 call0 (Lisp_Object fn
)
2589 struct gcpro gcpro1
;
2592 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2595 /* Call function fn with 1 argument arg1. */
2598 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2600 struct gcpro gcpro1
;
2601 Lisp_Object args
[2];
2607 RETURN_UNGCPRO (Ffuncall (2, args
));
2610 /* Call function fn with 2 arguments arg1, arg2. */
2613 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2615 struct gcpro gcpro1
;
2616 Lisp_Object args
[3];
2622 RETURN_UNGCPRO (Ffuncall (3, args
));
2625 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2628 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2630 struct gcpro gcpro1
;
2631 Lisp_Object args
[4];
2638 RETURN_UNGCPRO (Ffuncall (4, args
));
2641 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2644 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2647 struct gcpro gcpro1
;
2648 Lisp_Object args
[5];
2656 RETURN_UNGCPRO (Ffuncall (5, args
));
2659 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2662 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2663 Lisp_Object arg4
, Lisp_Object arg5
)
2665 struct gcpro gcpro1
;
2666 Lisp_Object args
[6];
2675 RETURN_UNGCPRO (Ffuncall (6, args
));
2678 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2681 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2682 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2684 struct gcpro gcpro1
;
2685 Lisp_Object args
[7];
2695 RETURN_UNGCPRO (Ffuncall (7, args
));
2698 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2701 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2702 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2704 struct gcpro gcpro1
;
2705 Lisp_Object args
[8];
2716 RETURN_UNGCPRO (Ffuncall (8, args
));
2719 /* The caller should GCPRO all the elements of ARGS. */
2721 DEFUN ("functionp", Ffunctionp
, Sfunctionp
, 1, 1, 0,
2722 doc
: /* Non-nil if OBJECT is a function. */)
2723 (Lisp_Object object
)
2725 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
2727 object
= Findirect_function (object
, Qt
);
2729 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
2731 /* Autoloaded symbols are functions, except if they load
2732 macros or keymaps. */
2734 for (i
= 0; i
< 4 && CONSP (object
); i
++)
2735 object
= XCDR (object
);
2737 return (CONSP (object
) && !NILP (XCAR (object
))) ? Qnil
: Qt
;
2742 return (XSUBR (object
)->max_args
!= UNEVALLED
) ? Qt
: Qnil
;
2743 else if (COMPILEDP (object
))
2745 else if (CONSP (object
))
2747 Lisp_Object car
= XCAR (object
);
2748 return (EQ (car
, Qlambda
) || EQ (car
, Qclosure
)) ? Qt
: Qnil
;
2754 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2755 doc
: /* Call first argument as a function, passing remaining arguments to it.
2756 Return the value that function returns.
2757 Thus, (funcall 'cons 'x 'y) returns (x . y).
2758 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2759 (ptrdiff_t nargs
, Lisp_Object
*args
)
2761 Lisp_Object fun
, original_fun
;
2763 ptrdiff_t numargs
= nargs
- 1;
2764 Lisp_Object lisp_numargs
;
2766 struct backtrace backtrace
;
2767 register Lisp_Object
*internal_args
;
2772 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2774 if (max_lisp_eval_depth
< 100)
2775 max_lisp_eval_depth
= 100;
2776 if (lisp_eval_depth
> max_lisp_eval_depth
)
2777 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2780 backtrace
.next
= backtrace_list
;
2781 backtrace_list
= &backtrace
;
2782 backtrace
.function
= &args
[0];
2783 backtrace
.args
= &args
[1]; /* This also GCPROs them. */
2784 backtrace
.nargs
= nargs
- 1;
2785 backtrace
.debug_on_exit
= 0;
2787 /* Call GC after setting up the backtrace, so the latter GCPROs the args. */
2790 if (debug_on_next_call
)
2791 do_debug_on_call (Qlambda
);
2795 original_fun
= args
[0];
2799 /* Optimize for no indirection. */
2801 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2802 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2803 fun
= indirect_function (fun
);
2807 if (numargs
< XSUBR (fun
)->min_args
2808 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2810 XSETFASTINT (lisp_numargs
, numargs
);
2811 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2814 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2815 xsignal1 (Qinvalid_function
, original_fun
);
2817 else if (XSUBR (fun
)->max_args
== MANY
)
2818 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
2821 if (XSUBR (fun
)->max_args
> numargs
)
2823 internal_args
= alloca (XSUBR (fun
)->max_args
2824 * sizeof *internal_args
);
2825 memcpy (internal_args
, args
+ 1, numargs
* word_size
);
2826 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2827 internal_args
[i
] = Qnil
;
2830 internal_args
= args
+ 1;
2831 switch (XSUBR (fun
)->max_args
)
2834 val
= (XSUBR (fun
)->function
.a0 ());
2837 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
2840 val
= (XSUBR (fun
)->function
.a2
2841 (internal_args
[0], internal_args
[1]));
2844 val
= (XSUBR (fun
)->function
.a3
2845 (internal_args
[0], internal_args
[1], internal_args
[2]));
2848 val
= (XSUBR (fun
)->function
.a4
2849 (internal_args
[0], internal_args
[1], internal_args
[2],
2853 val
= (XSUBR (fun
)->function
.a5
2854 (internal_args
[0], internal_args
[1], internal_args
[2],
2855 internal_args
[3], internal_args
[4]));
2858 val
= (XSUBR (fun
)->function
.a6
2859 (internal_args
[0], internal_args
[1], internal_args
[2],
2860 internal_args
[3], internal_args
[4], internal_args
[5]));
2863 val
= (XSUBR (fun
)->function
.a7
2864 (internal_args
[0], internal_args
[1], internal_args
[2],
2865 internal_args
[3], internal_args
[4], internal_args
[5],
2870 val
= (XSUBR (fun
)->function
.a8
2871 (internal_args
[0], internal_args
[1], internal_args
[2],
2872 internal_args
[3], internal_args
[4], internal_args
[5],
2873 internal_args
[6], internal_args
[7]));
2878 /* If a subr takes more than 8 arguments without using MANY
2879 or UNEVALLED, we need to extend this function to support it.
2880 Until this is done, there is no way to call the function. */
2885 else if (COMPILEDP (fun
))
2886 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2889 if (EQ (fun
, Qunbound
))
2890 xsignal1 (Qvoid_function
, original_fun
);
2892 xsignal1 (Qinvalid_function
, original_fun
);
2893 funcar
= XCAR (fun
);
2894 if (!SYMBOLP (funcar
))
2895 xsignal1 (Qinvalid_function
, original_fun
);
2896 if (EQ (funcar
, Qlambda
)
2897 || EQ (funcar
, Qclosure
))
2898 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2899 else if (EQ (funcar
, Qautoload
))
2901 Fautoload_do_load (fun
, original_fun
, Qnil
);
2906 xsignal1 (Qinvalid_function
, original_fun
);
2910 if (backtrace
.debug_on_exit
)
2911 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2912 backtrace_list
= backtrace
.next
;
2917 apply_lambda (Lisp_Object fun
, Lisp_Object args
)
2919 Lisp_Object args_left
;
2922 register Lisp_Object
*arg_vector
;
2923 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2924 register Lisp_Object tem
;
2927 numargs
= XFASTINT (Flength (args
));
2928 SAFE_ALLOCA_LISP (arg_vector
, numargs
);
2931 GCPRO3 (*arg_vector
, args_left
, fun
);
2934 for (i
= 0; i
< numargs
; )
2936 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
2937 tem
= eval_sub (tem
);
2938 arg_vector
[i
++] = tem
;
2944 backtrace_list
->args
= arg_vector
;
2945 backtrace_list
->nargs
= i
;
2946 tem
= funcall_lambda (fun
, numargs
, arg_vector
);
2948 /* Do the debug-on-exit now, while arg_vector still exists. */
2949 if (backtrace_list
->debug_on_exit
)
2950 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
2951 /* Don't do it again when we return to eval. */
2952 backtrace_list
->debug_on_exit
= 0;
2957 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2958 and return the result of evaluation.
2959 FUN must be either a lambda-expression or a compiled-code object. */
2962 funcall_lambda (Lisp_Object fun
, ptrdiff_t nargs
,
2963 register Lisp_Object
*arg_vector
)
2965 Lisp_Object val
, syms_left
, next
, lexenv
;
2966 ptrdiff_t count
= SPECPDL_INDEX ();
2972 if (EQ (XCAR (fun
), Qclosure
))
2974 fun
= XCDR (fun
); /* Drop `closure'. */
2975 lexenv
= XCAR (fun
);
2976 CHECK_LIST_CONS (fun
, fun
);
2980 syms_left
= XCDR (fun
);
2981 if (CONSP (syms_left
))
2982 syms_left
= XCAR (syms_left
);
2984 xsignal1 (Qinvalid_function
, fun
);
2986 else if (COMPILEDP (fun
))
2988 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
2989 if (INTEGERP (syms_left
))
2990 /* A byte-code object with a non-nil `push args' slot means we
2991 shouldn't bind any arguments, instead just call the byte-code
2992 interpreter directly; it will push arguments as necessary.
2994 Byte-code objects with either a non-existent, or a nil value for
2995 the `push args' slot (the default), have dynamically-bound
2996 arguments, and use the argument-binding code below instead (as do
2997 all interpreted functions, even lexically bound ones). */
2999 /* If we have not actually read the bytecode string
3000 and constants vector yet, fetch them from the file. */
3001 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3002 Ffetch_bytecode (fun
);
3003 return exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3004 AREF (fun
, COMPILED_CONSTANTS
),
3005 AREF (fun
, COMPILED_STACK_DEPTH
),
3014 i
= optional
= rest
= 0;
3015 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3019 next
= XCAR (syms_left
);
3020 if (!SYMBOLP (next
))
3021 xsignal1 (Qinvalid_function
, fun
);
3023 if (EQ (next
, Qand_rest
))
3025 else if (EQ (next
, Qand_optional
))
3032 arg
= Flist (nargs
- i
, &arg_vector
[i
]);
3036 arg
= arg_vector
[i
++];
3038 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3042 /* Bind the argument. */
3043 if (!NILP (lexenv
) && SYMBOLP (next
))
3044 /* Lexically bind NEXT by adding it to the lexenv alist. */
3045 lexenv
= Fcons (Fcons (next
, arg
), lexenv
);
3047 /* Dynamically bind NEXT. */
3048 specbind (next
, arg
);
3052 if (!NILP (syms_left
))
3053 xsignal1 (Qinvalid_function
, fun
);
3055 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3057 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
3058 /* Instantiate a new lexical environment. */
3059 specbind (Qinternal_interpreter_environment
, lexenv
);
3062 val
= Fprogn (XCDR (XCDR (fun
)));
3065 /* If we have not actually read the bytecode string
3066 and constants vector yet, fetch them from the file. */
3067 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3068 Ffetch_bytecode (fun
);
3069 val
= exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3070 AREF (fun
, COMPILED_CONSTANTS
),
3071 AREF (fun
, COMPILED_STACK_DEPTH
),
3075 return unbind_to (count
, val
);
3078 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3080 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3081 (Lisp_Object object
)
3085 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3087 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3090 tem
= AREF (object
, COMPILED_BYTECODE
);
3091 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3092 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3094 error ("Invalid byte code");
3096 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3097 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3105 register ptrdiff_t count
= SPECPDL_INDEX ();
3106 ptrdiff_t max_size
= min (max_specpdl_size
, PTRDIFF_MAX
);
3107 if (max_size
<= specpdl_size
)
3109 if (max_specpdl_size
< 400)
3110 max_size
= max_specpdl_size
= 400;
3111 if (max_size
<= specpdl_size
)
3112 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3114 specpdl
= xpalloc (specpdl
, &specpdl_size
, 1, max_size
, sizeof *specpdl
);
3115 specpdl_ptr
= specpdl
+ count
;
3118 /* `specpdl_ptr->symbol' is a field which describes which variable is
3119 let-bound, so it can be properly undone when we unbind_to.
3120 It can have the following two shapes:
3121 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3122 a symbol that is not buffer-local (at least at the time
3123 the let binding started). Note also that it should not be
3124 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3126 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3127 variable SYMBOL which can be buffer-local. WHERE tells us
3128 which buffer is affected (or nil if the let-binding affects the
3129 global value of the variable) and BUFFER tells us which buffer was
3130 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3131 BUFFER did not yet have a buffer-local value). */
3134 specbind (Lisp_Object symbol
, Lisp_Object value
)
3136 struct Lisp_Symbol
*sym
;
3138 eassert (!handling_signal
);
3140 CHECK_SYMBOL (symbol
);
3141 sym
= XSYMBOL (symbol
);
3142 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3146 switch (sym
->redirect
)
3148 case SYMBOL_VARALIAS
:
3149 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3150 case SYMBOL_PLAINVAL
:
3151 /* The most common case is that of a non-constant symbol with a
3152 trivial value. Make that as fast as we can. */
3153 set_specpdl_symbol (symbol
);
3154 set_specpdl_old_value (SYMBOL_VAL (sym
));
3155 specpdl_ptr
->func
= NULL
;
3158 SET_SYMBOL_VAL (sym
, value
);
3160 set_internal (symbol
, value
, Qnil
, 1);
3162 case SYMBOL_LOCALIZED
:
3163 if (SYMBOL_BLV (sym
)->frame_local
)
3164 error ("Frame-local vars cannot be let-bound");
3165 case SYMBOL_FORWARDED
:
3167 Lisp_Object ovalue
= find_symbol_value (symbol
);
3168 specpdl_ptr
->func
= 0;
3169 set_specpdl_old_value (ovalue
);
3171 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3172 || (EQ (SYMBOL_BLV (sym
)->where
,
3173 SYMBOL_BLV (sym
)->frame_local
?
3174 Fselected_frame () : Fcurrent_buffer ())));
3176 if (sym
->redirect
== SYMBOL_LOCALIZED
3177 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3179 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3181 /* For a local variable, record both the symbol and which
3182 buffer's or frame's value we are saving. */
3183 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3185 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3186 || (blv_found (SYMBOL_BLV (sym
))
3187 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3190 else if (sym
->redirect
== SYMBOL_LOCALIZED
3191 && blv_found (SYMBOL_BLV (sym
)))
3192 where
= SYMBOL_BLV (sym
)->where
;
3196 /* We're not using the `unused' slot in the specbinding
3197 structure because this would mean we have to do more
3198 work for simple variables. */
3199 /* FIXME: The third value `current_buffer' is only used in
3200 let_shadows_buffer_binding_p which is itself only used
3201 in set_internal for local_if_set. */
3202 eassert (NILP (where
) || EQ (where
, cur_buf
));
3203 set_specpdl_symbol (Fcons (symbol
, Fcons (where
, cur_buf
)));
3205 /* If SYMBOL is a per-buffer variable which doesn't have a
3206 buffer-local value here, make the `let' change the global
3207 value by changing the value of SYMBOL in all buffers not
3208 having their own value. This is consistent with what
3209 happens with other buffer-local variables. */
3211 && sym
->redirect
== SYMBOL_FORWARDED
)
3213 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3215 Fset_default (symbol
, value
);
3220 set_specpdl_symbol (symbol
);
3223 set_internal (symbol
, value
, Qnil
, 1);
3231 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3233 eassert (!handling_signal
);
3235 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3237 specpdl_ptr
->func
= function
;
3238 set_specpdl_symbol (Qnil
);
3239 set_specpdl_old_value (arg
);
3244 unbind_to (ptrdiff_t count
, Lisp_Object value
)
3246 Lisp_Object quitf
= Vquit_flag
;
3247 struct gcpro gcpro1
, gcpro2
;
3249 GCPRO2 (value
, quitf
);
3252 while (specpdl_ptr
!= specpdl
+ count
)
3254 /* Copy the binding, and decrement specpdl_ptr, before we do
3255 the work to unbind it. We decrement first
3256 so that an error in unbinding won't try to unbind
3257 the same entry again, and we copy the binding first
3258 in case more bindings are made during some of the code we run. */
3260 struct specbinding this_binding
;
3261 this_binding
= *--specpdl_ptr
;
3263 if (this_binding
.func
!= 0)
3264 (*this_binding
.func
) (this_binding
.old_value
);
3265 /* If the symbol is a list, it is really (SYMBOL WHERE
3266 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3267 frame. If WHERE is a buffer or frame, this indicates we
3268 bound a variable that had a buffer-local or frame-local
3269 binding. WHERE nil means that the variable had the default
3270 value when it was bound. CURRENT-BUFFER is the buffer that
3271 was current when the variable was bound. */
3272 else if (CONSP (this_binding
.symbol
))
3274 Lisp_Object symbol
, where
;
3276 symbol
= XCAR (this_binding
.symbol
);
3277 where
= XCAR (XCDR (this_binding
.symbol
));
3280 Fset_default (symbol
, this_binding
.old_value
);
3281 /* If `where' is non-nil, reset the value in the appropriate
3282 local binding, but only if that binding still exists. */
3283 else if (BUFFERP (where
)
3284 ? !NILP (Flocal_variable_p (symbol
, where
))
3285 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3286 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3288 /* If variable has a trivial value (no forwarding), we can
3289 just set it. No need to check for constant symbols here,
3290 since that was already done by specbind. */
3291 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3292 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3293 this_binding
.old_value
);
3295 /* NOTE: we only ever come here if make_local_foo was used for
3296 the first time on this var within this let. */
3297 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3300 if (NILP (Vquit_flag
) && !NILP (quitf
))
3307 DEFUN ("special-variable-p", Fspecial_variable_p
, Sspecial_variable_p
, 1, 1, 0,
3308 doc
: /* Return non-nil if SYMBOL's global binding has been declared special.
3309 A special variable is one that will be bound dynamically, even in a
3310 context where binding is lexical by default. */)
3311 (Lisp_Object symbol
)
3313 CHECK_SYMBOL (symbol
);
3314 return XSYMBOL (symbol
)->declared_special
? Qt
: Qnil
;
3318 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3319 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3320 The debugger is entered when that frame exits, if the flag is non-nil. */)
3321 (Lisp_Object level
, Lisp_Object flag
)
3323 register struct backtrace
*backlist
= backtrace_list
;
3324 register EMACS_INT i
;
3326 CHECK_NUMBER (level
);
3328 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3330 backlist
= backlist
->next
;
3334 backlist
->debug_on_exit
= !NILP (flag
);
3339 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3340 doc
: /* Print a trace of Lisp function calls currently active.
3341 Output stream used is value of `standard-output'. */)
3344 register struct backtrace
*backlist
= backtrace_list
;
3347 struct gcpro gcpro1
;
3348 Lisp_Object old_print_level
= Vprint_level
;
3350 if (NILP (Vprint_level
))
3351 XSETFASTINT (Vprint_level
, 8);
3358 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3359 if (backlist
->nargs
== UNEVALLED
)
3361 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3362 write_string ("\n", -1);
3366 tem
= *backlist
->function
;
3367 Fprin1 (tem
, Qnil
); /* This can QUIT. */
3368 write_string ("(", -1);
3369 if (backlist
->nargs
== MANY
)
3370 { /* FIXME: Can this happen? */
3372 for (tail
= *backlist
->args
, i
= 0;
3374 tail
= Fcdr (tail
), i
= 1)
3376 if (i
) write_string (" ", -1);
3377 Fprin1 (Fcar (tail
), Qnil
);
3383 for (i
= 0; i
< backlist
->nargs
; i
++)
3385 if (i
) write_string (" ", -1);
3386 Fprin1 (backlist
->args
[i
], Qnil
);
3389 write_string (")\n", -1);
3391 backlist
= backlist
->next
;
3394 Vprint_level
= old_print_level
;
3399 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3400 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3401 If that frame has not evaluated the arguments yet (or is a special form),
3402 the value is (nil FUNCTION ARG-FORMS...).
3403 If that frame has evaluated its arguments and called its function already,
3404 the value is (t FUNCTION ARG-VALUES...).
3405 A &rest arg is represented as the tail of the list ARG-VALUES.
3406 FUNCTION is whatever was supplied as car of evaluated list,
3407 or a lambda expression for macro calls.
3408 If NFRAMES is more than the number of frames, the value is nil. */)
3409 (Lisp_Object nframes
)
3411 register struct backtrace
*backlist
= backtrace_list
;
3412 register EMACS_INT i
;
3415 CHECK_NATNUM (nframes
);
3417 /* Find the frame requested. */
3418 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3419 backlist
= backlist
->next
;
3423 if (backlist
->nargs
== UNEVALLED
)
3424 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3427 if (backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3428 tem
= *backlist
->args
;
3430 tem
= Flist (backlist
->nargs
, backlist
->args
);
3432 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3439 mark_backtrace (void)
3441 register struct backtrace
*backlist
;
3444 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3446 mark_object (*backlist
->function
);
3448 if (backlist
->nargs
== UNEVALLED
3449 || backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3452 i
= backlist
->nargs
;
3454 mark_object (backlist
->args
[i
]);
3462 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3463 doc
: /* Limit on number of Lisp variable bindings and `unwind-protect's.
3464 If Lisp code tries to increase the total number past this amount,
3465 an error is signaled.
3466 You can safely use a value considerably larger than the default value,
3467 if that proves inconveniently small. However, if you increase it too far,
3468 Emacs could run out of memory trying to make the stack bigger. */);
3470 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3471 doc
: /* Limit on depth in `eval', `apply' and `funcall' before error.
3473 This limit serves to catch infinite recursions for you before they cause
3474 actual stack overflow in C, which would be fatal for Emacs.
3475 You can safely make it considerably larger than its default value,
3476 if that proves inconveniently small. However, if you increase it too far,
3477 Emacs could overflow the real C stack, and crash. */);
3479 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3480 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3481 If the value is t, that means do an ordinary quit.
3482 If the value equals `throw-on-input', that means quit by throwing
3483 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3484 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3485 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3488 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3489 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3490 Note that `quit-flag' will still be set by typing C-g,
3491 so a quit will be signaled as soon as `inhibit-quit' is nil.
3492 To prevent this happening, set `quit-flag' to nil
3493 before making `inhibit-quit' nil. */);
3494 Vinhibit_quit
= Qnil
;
3496 DEFSYM (Qinhibit_quit
, "inhibit-quit");
3497 DEFSYM (Qautoload
, "autoload");
3498 DEFSYM (Qdebug_on_error
, "debug-on-error");
3499 DEFSYM (Qmacro
, "macro");
3500 DEFSYM (Qdeclare
, "declare");
3502 /* Note that the process handling also uses Qexit, but we don't want
3503 to staticpro it twice, so we just do it here. */
3504 DEFSYM (Qexit
, "exit");
3506 DEFSYM (Qinteractive
, "interactive");
3507 DEFSYM (Qcommandp
, "commandp");
3508 DEFSYM (Qand_rest
, "&rest");
3509 DEFSYM (Qand_optional
, "&optional");
3510 DEFSYM (Qclosure
, "closure");
3511 DEFSYM (Qdebug
, "debug");
3513 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3514 doc
: /* Non-nil means enter debugger if an error is signaled.
3515 Does not apply to errors handled by `condition-case' or those
3516 matched by `debug-ignored-errors'.
3517 If the value is a list, an error only means to enter the debugger
3518 if one of its condition symbols appears in the list.
3519 When you evaluate an expression interactively, this variable
3520 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3521 The command `toggle-debug-on-error' toggles this.
3522 See also the variable `debug-on-quit'. */);
3523 Vdebug_on_error
= Qnil
;
3525 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3526 doc
: /* List of errors for which the debugger should not be called.
3527 Each element may be a condition-name or a regexp that matches error messages.
3528 If any element applies to a given error, that error skips the debugger
3529 and just returns to top level.
3530 This overrides the variable `debug-on-error'.
3531 It does not apply to errors handled by `condition-case'. */);
3532 Vdebug_ignored_errors
= Qnil
;
3534 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3535 doc
: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
3536 Does not apply if quit is handled by a `condition-case'. */);
3539 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3540 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3542 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3543 doc
: /* Non-nil means debugger may continue execution.
3544 This is nil when the debugger is called under circumstances where it
3545 might not be safe to continue. */);
3546 debugger_may_continue
= 1;
3548 DEFVAR_LISP ("debugger", Vdebugger
,
3549 doc
: /* Function to call to invoke debugger.
3550 If due to frame exit, args are `exit' and the value being returned;
3551 this function's value will be returned instead of that.
3552 If due to error, args are `error' and a list of the args to `signal'.
3553 If due to `apply' or `funcall' entry, one arg, `lambda'.
3554 If due to `eval' entry, one arg, t. */);
3557 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3558 doc
: /* If non-nil, this is a function for `signal' to call.
3559 It receives the same arguments that `signal' was given.
3560 The Edebug package uses this to regain control. */);
3561 Vsignal_hook_function
= Qnil
;
3563 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3564 doc
: /* Non-nil means call the debugger regardless of condition handlers.
3565 Note that `debug-on-error', `debug-on-quit' and friends
3566 still determine whether to handle the particular condition. */);
3567 Vdebug_on_signal
= Qnil
;
3569 /* When lexical binding is being used,
3570 Vinternal_interpreter_environment is non-nil, and contains an alist
3571 of lexically-bound variable, or (t), indicating an empty
3572 environment. The lisp name of this variable would be
3573 `internal-interpreter-environment' if it weren't hidden.
3574 Every element of this list can be either a cons (VAR . VAL)
3575 specifying a lexical binding, or a single symbol VAR indicating
3576 that this variable should use dynamic scoping. */
3577 DEFSYM (Qinternal_interpreter_environment
,
3578 "internal-interpreter-environment");
3579 DEFVAR_LISP ("internal-interpreter-environment",
3580 Vinternal_interpreter_environment
,
3581 doc
: /* If non-nil, the current lexical environment of the lisp interpreter.
3582 When lexical binding is not being used, this variable is nil.
3583 A value of `(t)' indicates an empty environment, otherwise it is an
3584 alist of active lexical bindings. */);
3585 Vinternal_interpreter_environment
= Qnil
;
3586 /* Don't export this variable to Elisp, so no one can mess with it
3587 (Just imagine if someone makes it buffer-local). */
3588 Funintern (Qinternal_interpreter_environment
, Qnil
);
3590 DEFSYM (Vrun_hooks
, "run-hooks");
3592 staticpro (&Vautoload_queue
);
3593 Vautoload_queue
= Qnil
;
3594 staticpro (&Vsignaling_function
);
3595 Vsignaling_function
= Qnil
;
3597 inhibit_lisp_code
= Qnil
;
3608 defsubr (&Sfunction
);
3610 defsubr (&Sdefvaralias
);
3611 defsubr (&Sdefconst
);
3612 defsubr (&Smake_var_non_special
);
3616 defsubr (&Smacroexpand
);
3619 defsubr (&Sunwind_protect
);
3620 defsubr (&Scondition_case
);
3622 defsubr (&Sinteractive_p
);
3623 defsubr (&Scalled_interactively_p
);
3624 defsubr (&Scommandp
);
3625 defsubr (&Sautoload
);
3626 defsubr (&Sautoload_do_load
);
3629 defsubr (&Sfuncall
);
3630 defsubr (&Srun_hooks
);
3631 defsubr (&Srun_hook_with_args
);
3632 defsubr (&Srun_hook_with_args_until_success
);
3633 defsubr (&Srun_hook_with_args_until_failure
);
3634 defsubr (&Srun_hook_wrapped
);
3635 defsubr (&Sfetch_bytecode
);
3636 defsubr (&Sbacktrace_debug
);
3637 defsubr (&Sbacktrace
);
3638 defsubr (&Sbacktrace_frame
);
3639 defsubr (&Sspecial_variable_p
);
3640 defsubr (&Sfunctionp
);