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 void unwind_to_catch (struct catchtag
*, Lisp_Object
) NO_RETURN
;
135 static int interactive_p (int);
136 static Lisp_Object
apply_lambda (Lisp_Object fun
, Lisp_Object args
);
137 static Lisp_Object
Ffetch_bytecode (Lisp_Object
);
140 init_eval_once (void)
143 specpdl
= (struct specbinding
*) xmalloc (size
* sizeof (struct specbinding
));
145 specpdl_ptr
= specpdl
;
146 /* Don't forget to update docs (lispref node "Local Variables"). */
147 max_specpdl_size
= 1300; /* 1000 is not enough for CEDET's c-by.el. */
148 max_lisp_eval_depth
= 600;
156 specpdl_ptr
= specpdl
;
161 debug_on_next_call
= 0;
166 /* This is less than the initial value of num_nonmacro_input_events. */
167 when_entered_debugger
= -1;
170 /* Unwind-protect function used by call_debugger. */
173 restore_stack_limits (Lisp_Object data
)
175 max_specpdl_size
= XINT (XCAR (data
));
176 max_lisp_eval_depth
= XINT (XCDR (data
));
180 /* Call the Lisp debugger, giving it argument ARG. */
183 call_debugger (Lisp_Object arg
)
185 int debug_while_redisplaying
;
186 ptrdiff_t count
= SPECPDL_INDEX ();
188 EMACS_INT old_max
= max_specpdl_size
;
190 /* Temporarily bump up the stack limits,
191 so the debugger won't run out of stack. */
193 max_specpdl_size
+= 1;
194 record_unwind_protect (restore_stack_limits
,
195 Fcons (make_number (old_max
),
196 make_number (max_lisp_eval_depth
)));
197 max_specpdl_size
= old_max
;
199 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
200 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
202 if (max_specpdl_size
- 100 < SPECPDL_INDEX ())
203 max_specpdl_size
= SPECPDL_INDEX () + 100;
205 #ifdef HAVE_WINDOW_SYSTEM
206 if (display_hourglass_p
)
210 debug_on_next_call
= 0;
211 when_entered_debugger
= num_nonmacro_input_events
;
213 /* Resetting redisplaying_p to 0 makes sure that debug output is
214 displayed if the debugger is invoked during redisplay. */
215 debug_while_redisplaying
= redisplaying_p
;
217 specbind (intern ("debugger-may-continue"),
218 debug_while_redisplaying
? Qnil
: Qt
);
219 specbind (Qinhibit_redisplay
, Qnil
);
220 specbind (Qdebug_on_error
, Qnil
);
222 #if 0 /* Binding this prevents execution of Lisp code during
223 redisplay, which necessarily leads to display problems. */
224 specbind (Qinhibit_eval_during_redisplay
, Qt
);
227 val
= apply1 (Vdebugger
, arg
);
229 /* Interrupting redisplay and resuming it later is not safe under
230 all circumstances. So, when the debugger returns, abort the
231 interrupted redisplay by going back to the top-level. */
232 if (debug_while_redisplaying
)
235 return unbind_to (count
, val
);
239 do_debug_on_call (Lisp_Object code
)
241 debug_on_next_call
= 0;
242 backtrace_list
->debug_on_exit
= 1;
243 call_debugger (Fcons (code
, Qnil
));
246 /* NOTE!!! Every function that can call EVAL must protect its args
247 and temporaries from garbage collection while it needs them.
248 The definition of `For' shows what you have to do. */
250 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
251 doc
: /* Eval args until one of them yields non-nil, then return that value.
252 The remaining args are not evalled at all.
253 If all args return nil, return nil.
254 usage: (or CONDITIONS...) */)
257 register Lisp_Object val
= Qnil
;
264 val
= eval_sub (XCAR (args
));
274 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
275 doc
: /* Eval args until one of them yields nil, then return nil.
276 The remaining args are not evalled at all.
277 If no arg yields nil, return the last arg's value.
278 usage: (and CONDITIONS...) */)
281 register Lisp_Object val
= Qt
;
288 val
= eval_sub (XCAR (args
));
298 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
299 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
300 Returns the value of THEN or the value of the last of the ELSE's.
301 THEN must be one expression, but ELSE... can be zero or more expressions.
302 If COND yields nil, and there are no ELSE's, the value is nil.
303 usage: (if COND THEN ELSE...) */)
306 register Lisp_Object cond
;
310 cond
= eval_sub (Fcar (args
));
314 return eval_sub (Fcar (Fcdr (args
)));
315 return Fprogn (Fcdr (Fcdr (args
)));
318 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
319 doc
: /* Try each clause until one succeeds.
320 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
321 and, if the value is non-nil, this clause succeeds:
322 then the expressions in BODY are evaluated and the last one's
323 value is the value of the cond-form.
324 If no clause succeeds, cond returns nil.
325 If a clause has one element, as in (CONDITION),
326 CONDITION's value if non-nil is returned from the cond-form.
327 usage: (cond CLAUSES...) */)
330 register Lisp_Object clause
, val
;
337 clause
= Fcar (args
);
338 val
= eval_sub (Fcar (clause
));
341 if (!EQ (XCDR (clause
), Qnil
))
342 val
= Fprogn (XCDR (clause
));
352 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
353 doc
: /* Eval BODY forms sequentially and return value of last one.
354 usage: (progn BODY...) */)
357 register Lisp_Object val
= Qnil
;
364 val
= eval_sub (XCAR (args
));
372 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
373 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
374 The value of FIRST is saved during the evaluation of the remaining args,
375 whose values are discarded.
376 usage: (prog1 FIRST BODY...) */)
380 register Lisp_Object args_left
;
381 struct gcpro gcpro1
, gcpro2
;
387 val
= eval_sub (XCAR (args_left
));
388 while (CONSP (args_left
= XCDR (args_left
)))
389 eval_sub (XCAR (args_left
));
395 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
396 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
397 The value of FORM2 is saved during the evaluation of the
398 remaining args, whose values are discarded.
399 usage: (prog2 FORM1 FORM2 BODY...) */)
405 eval_sub (XCAR (args
));
407 return Fprog1 (XCDR (args
));
410 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
411 doc
: /* Set each SYM to the value of its VAL.
412 The symbols SYM are variables; they are literal (not evaluated).
413 The values VAL are expressions; they are evaluated.
414 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
415 The second VAL is not computed until after the first SYM is set, and so on;
416 each VAL can use the new value of variables set earlier in the `setq'.
417 The return value of the `setq' form is the value of the last VAL.
418 usage: (setq [SYM VAL]...) */)
421 register Lisp_Object args_left
;
422 register Lisp_Object val
, sym
, lex_binding
;
433 val
= eval_sub (Fcar (Fcdr (args_left
)));
434 sym
= Fcar (args_left
);
436 /* Like for eval_sub, we do not check declared_special here since
437 it's been done when let-binding. */
438 if (!NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
440 && !NILP (lex_binding
441 = Fassq (sym
, Vinternal_interpreter_environment
)))
442 XSETCDR (lex_binding
, val
); /* SYM is lexically bound. */
444 Fset (sym
, val
); /* SYM is dynamically bound. */
446 args_left
= Fcdr (Fcdr (args_left
));
448 while (!NILP (args_left
));
454 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
455 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
456 Warning: `quote' does not construct its return value, but just returns
457 the value that was pre-constructed by the Lisp reader (see info node
458 `(elisp)Printed Representation').
459 This means that '(a . b) is not identical to (cons 'a 'b): the former
460 does not cons. Quoting should be reserved for constants that will
461 never be modified by side-effects, unless you like self-modifying code.
462 See the common pitfall in info node `(elisp)Rearrangement' for an example
463 of unexpected results when a quoted object is modified.
464 usage: (quote ARG) */)
467 if (!NILP (Fcdr (args
)))
468 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
472 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
473 doc
: /* Like `quote', but preferred for objects which are functions.
474 In byte compilation, `function' causes its argument to be compiled.
475 `quote' cannot do that.
476 usage: (function ARG) */)
479 Lisp_Object quoted
= XCAR (args
);
481 if (!NILP (Fcdr (args
)))
482 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
484 if (!NILP (Vinternal_interpreter_environment
)
486 && EQ (XCAR (quoted
), Qlambda
))
487 /* This is a lambda expression within a lexical environment;
488 return an interpreted closure instead of a simple lambda. */
489 return Fcons (Qclosure
, Fcons (Vinternal_interpreter_environment
,
492 /* Simply quote the argument. */
497 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
498 doc
: /* Return t if the containing function was run directly by user input.
499 This means that the function was called with `call-interactively'
500 \(which includes being called as the binding of a key)
501 and input is currently coming from the keyboard (not a keyboard macro),
502 and Emacs is not running in batch mode (`noninteractive' is nil).
504 The only known proper use of `interactive-p' is in deciding whether to
505 display a helpful message, or how to display it. If you're thinking
506 of using it for any other purpose, it is quite likely that you're
507 making a mistake. Think: what do you want to do when the command is
508 called from a keyboard macro?
510 To test whether your function was called with `call-interactively',
511 either (i) add an extra optional argument and give it an `interactive'
512 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
513 use `called-interactively-p'. */)
516 return interactive_p (1) ? Qt
: Qnil
;
520 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
521 doc
: /* Return t if the containing function was called by `call-interactively'.
522 If KIND is `interactive', then only return t if the call was made
523 interactively by the user, i.e. not in `noninteractive' mode nor
524 when `executing-kbd-macro'.
525 If KIND is `any', on the other hand, it will return t for any kind of
526 interactive call, including being called as the binding of a key, or
527 from a keyboard macro, or in `noninteractive' mode.
529 The only known proper use of `interactive' for KIND is in deciding
530 whether to display a helpful message, or how to display it. If you're
531 thinking of using it for any other purpose, it is quite likely that
532 you're making a mistake. Think: what do you want to do when the
533 command is called from a keyboard macro?
535 This function is meant for implementing advice and other
536 function-modifying features. Instead of using this, it is sometimes
537 cleaner to give your function an extra optional argument whose
538 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
539 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
542 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
543 && interactive_p (1)) ? Qt
: Qnil
;
547 /* Return 1 if function in which this appears was called using
550 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
551 called is a built-in. */
554 interactive_p (int exclude_subrs_p
)
556 struct backtrace
*btp
;
559 btp
= backtrace_list
;
561 /* If this isn't a byte-compiled function, there may be a frame at
562 the top for Finteractive_p. If so, skip it. */
563 fun
= Findirect_function (*btp
->function
, Qnil
);
564 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
565 || XSUBR (fun
) == &Scalled_interactively_p
))
568 /* If we're running an Emacs 18-style byte-compiled function, there
569 may be a frame for Fbytecode at the top level. In any version of
570 Emacs there can be Fbytecode frames for subexpressions evaluated
571 inside catch and condition-case. Skip past them.
573 If this isn't a byte-compiled function, then we may now be
574 looking at several frames for special forms. Skip past them. */
576 && (EQ (*btp
->function
, Qbytecode
)
577 || btp
->nargs
== UNEVALLED
))
580 /* `btp' now points at the frame of the innermost function that isn't
581 a special form, ignoring frames for Finteractive_p and/or
582 Fbytecode at the top. If this frame is for a built-in function
583 (such as load or eval-region) return nil. */
584 fun
= Findirect_function (*btp
->function
, Qnil
);
585 if (exclude_subrs_p
&& SUBRP (fun
))
588 /* `btp' points to the frame of a Lisp function that called interactive-p.
589 Return t if that function was called interactively. */
590 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
596 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
597 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
598 Aliased variables always have the same value; setting one sets the other.
599 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
600 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
601 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
602 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
603 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
604 The return value is BASE-VARIABLE. */)
605 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
607 struct Lisp_Symbol
*sym
;
609 CHECK_SYMBOL (new_alias
);
610 CHECK_SYMBOL (base_variable
);
612 sym
= XSYMBOL (new_alias
);
615 /* Not sure why, but why not? */
616 error ("Cannot make a constant an alias");
618 switch (sym
->redirect
)
620 case SYMBOL_FORWARDED
:
621 error ("Cannot make an internal variable an alias");
622 case SYMBOL_LOCALIZED
:
623 error ("Don't know how to make a localized variable an alias");
626 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
627 If n_a is bound, but b_v is not, set the value of b_v to n_a,
628 so that old-code that affects n_a before the aliasing is setup
630 if (NILP (Fboundp (base_variable
)))
631 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
634 struct specbinding
*p
;
636 for (p
= specpdl_ptr
; p
> specpdl
; )
637 if ((--p
)->func
== NULL
639 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
640 error ("Don't know how to make a let-bound variable an alias");
643 sym
->declared_special
= 1;
644 XSYMBOL (base_variable
)->declared_special
= 1;
645 sym
->redirect
= SYMBOL_VARALIAS
;
646 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
647 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
648 LOADHIST_ATTACH (new_alias
);
649 /* Even if docstring is nil: remove old docstring. */
650 Fput (new_alias
, Qvariable_documentation
, docstring
);
652 return base_variable
;
656 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
657 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
658 You are not required to define a variable in order to use it, but
659 defining it lets you supply an initial value and documentation, which
660 can be referred to by the Emacs help facilities and other programming
661 tools. The `defvar' form also declares the variable as \"special\",
662 so that it is always dynamically bound even if `lexical-binding' is t.
664 The optional argument INITVALUE is evaluated, and used to set SYMBOL,
665 only if SYMBOL's value is void. If SYMBOL is buffer-local, its
666 default value is what is set; buffer-local values are not affected.
667 If INITVALUE is missing, SYMBOL's value is not set.
669 If SYMBOL has a local binding, then this form affects the local
670 binding. This is usually not what you want. Thus, if you need to
671 load a file defining variables, with this form or with `defconst' or
672 `defcustom', you should always load that file _outside_ any bindings
673 for these variables. \(`defconst' and `defcustom' behave similarly in
676 The optional argument DOCSTRING is a documentation string for the
679 To define a user option, use `defcustom' instead of `defvar'.
680 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
683 register Lisp_Object sym
, tem
, tail
;
687 if (!NILP (Fcdr (Fcdr (tail
))))
688 error ("Too many arguments");
690 tem
= Fdefault_boundp (sym
);
693 /* Do it before evaluating the initial value, for self-references. */
694 XSYMBOL (sym
)->declared_special
= 1;
696 if (SYMBOL_CONSTANT_P (sym
))
698 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
699 Lisp_Object tem1
= Fcar (tail
);
701 && EQ (XCAR (tem1
), Qquote
)
702 && CONSP (XCDR (tem1
))
703 && EQ (XCAR (XCDR (tem1
)), sym
)))
704 error ("Constant symbol `%s' specified in defvar",
705 SDATA (SYMBOL_NAME (sym
)));
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
);
794 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
795 doc
: /* Bind variables according to VARLIST then eval BODY.
796 The value of the last form in BODY is returned.
797 Each element of VARLIST is a symbol (which is bound to nil)
798 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
799 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
800 usage: (let* VARLIST BODY...) */)
803 Lisp_Object varlist
, var
, val
, elt
, lexenv
;
804 ptrdiff_t count
= SPECPDL_INDEX ();
805 struct gcpro gcpro1
, gcpro2
, gcpro3
;
807 GCPRO3 (args
, elt
, varlist
);
809 lexenv
= Vinternal_interpreter_environment
;
811 varlist
= Fcar (args
);
812 while (CONSP (varlist
))
816 elt
= XCAR (varlist
);
822 else if (! NILP (Fcdr (Fcdr (elt
))))
823 signal_error ("`let' bindings can have only one value-form", elt
);
827 val
= eval_sub (Fcar (Fcdr (elt
)));
830 if (!NILP (lexenv
) && SYMBOLP (var
)
831 && !XSYMBOL (var
)->declared_special
832 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
833 /* Lexically bind VAR by adding it to the interpreter's binding
837 = Fcons (Fcons (var
, val
), Vinternal_interpreter_environment
);
838 if (EQ (Vinternal_interpreter_environment
, lexenv
))
839 /* Save the old lexical environment on the specpdl stack,
840 but only for the first lexical binding, since we'll never
841 need to revert to one of the intermediate ones. */
842 specbind (Qinternal_interpreter_environment
, newenv
);
844 Vinternal_interpreter_environment
= newenv
;
849 varlist
= XCDR (varlist
);
852 val
= Fprogn (Fcdr (args
));
853 return unbind_to (count
, val
);
856 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
857 doc
: /* Bind variables according to VARLIST then eval BODY.
858 The value of the last form in BODY is returned.
859 Each element of VARLIST is a symbol (which is bound to nil)
860 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
861 All the VALUEFORMs are evalled before any symbols are bound.
862 usage: (let VARLIST BODY...) */)
865 Lisp_Object
*temps
, tem
, lexenv
;
866 register Lisp_Object elt
, varlist
;
867 ptrdiff_t count
= SPECPDL_INDEX ();
869 struct gcpro gcpro1
, gcpro2
;
872 varlist
= Fcar (args
);
874 /* Make space to hold the values to give the bound variables. */
875 elt
= Flength (varlist
);
876 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
878 /* Compute the values and store them in `temps'. */
880 GCPRO2 (args
, *temps
);
883 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
886 elt
= XCAR (varlist
);
888 temps
[argnum
++] = Qnil
;
889 else if (! NILP (Fcdr (Fcdr (elt
))))
890 signal_error ("`let' bindings can have only one value-form", elt
);
892 temps
[argnum
++] = eval_sub (Fcar (Fcdr (elt
)));
893 gcpro2
.nvars
= argnum
;
897 lexenv
= Vinternal_interpreter_environment
;
899 varlist
= Fcar (args
);
900 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
904 elt
= XCAR (varlist
);
905 var
= SYMBOLP (elt
) ? elt
: Fcar (elt
);
906 tem
= temps
[argnum
++];
908 if (!NILP (lexenv
) && SYMBOLP (var
)
909 && !XSYMBOL (var
)->declared_special
910 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
911 /* Lexically bind VAR by adding it to the lexenv alist. */
912 lexenv
= Fcons (Fcons (var
, tem
), lexenv
);
914 /* Dynamically bind VAR. */
918 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
919 /* Instantiate a new lexical environment. */
920 specbind (Qinternal_interpreter_environment
, lexenv
);
922 elt
= Fprogn (Fcdr (args
));
924 return unbind_to (count
, elt
);
927 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
928 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
929 The order of execution is thus TEST, BODY, TEST, BODY and so on
930 until TEST returns nil.
931 usage: (while TEST BODY...) */)
934 Lisp_Object test
, body
;
935 struct gcpro gcpro1
, gcpro2
;
941 while (!NILP (eval_sub (test
)))
951 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
952 doc
: /* Return result of expanding macros at top level of FORM.
953 If FORM is not a macro call, it is returned unchanged.
954 Otherwise, the macro is expanded and the expansion is considered
955 in place of FORM. When a non-macro-call results, it is returned.
957 The second optional arg ENVIRONMENT specifies an environment of macro
958 definitions to shadow the loaded ones for use in file byte-compilation. */)
959 (Lisp_Object form
, Lisp_Object environment
)
961 /* With cleanups from Hallvard Furuseth. */
962 register Lisp_Object expander
, sym
, def
, tem
;
966 /* Come back here each time we expand a macro call,
967 in case it expands into another macro call. */
970 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
971 def
= sym
= XCAR (form
);
973 /* Trace symbols aliases to other symbols
974 until we get a symbol that is not an alias. */
975 while (SYMBOLP (def
))
979 tem
= Fassq (sym
, environment
);
982 def
= XSYMBOL (sym
)->function
;
983 if (!EQ (def
, Qunbound
))
988 /* Right now TEM is the result from SYM in ENVIRONMENT,
989 and if TEM is nil then DEF is SYM's function definition. */
992 /* SYM is not mentioned in ENVIRONMENT.
993 Look at its function definition. */
994 if (EQ (def
, Qunbound
) || !CONSP (def
))
995 /* Not defined or definition not suitable. */
997 if (EQ (XCAR (def
), Qautoload
))
999 /* Autoloading function: will it be a macro when loaded? */
1000 tem
= Fnth (make_number (4), def
);
1001 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1002 /* Yes, load it and try again. */
1004 struct gcpro gcpro1
;
1006 do_autoload (def
, sym
);
1013 else if (!EQ (XCAR (def
), Qmacro
))
1015 else expander
= XCDR (def
);
1019 expander
= XCDR (tem
);
1020 if (NILP (expander
))
1024 Lisp_Object newform
= apply1 (expander
, XCDR (form
));
1025 if (EQ (form
, newform
))
1034 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1035 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1036 TAG is evalled to get the tag to use; it must not be nil.
1038 Then the BODY is executed.
1039 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1040 If no throw happens, `catch' returns the value of the last BODY form.
1041 If a throw happens, it specifies the value to return from `catch'.
1042 usage: (catch TAG BODY...) */)
1045 register Lisp_Object tag
;
1046 struct gcpro gcpro1
;
1049 tag
= eval_sub (Fcar (args
));
1051 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1054 /* Set up a catch, then call C function FUNC on argument ARG.
1055 FUNC should return a Lisp_Object.
1056 This is how catches are done from within C code. */
1059 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1061 /* This structure is made part of the chain `catchlist'. */
1064 /* Fill in the components of c, and put it on the list. */
1068 c
.backlist
= backtrace_list
;
1069 c
.handlerlist
= handlerlist
;
1070 c
.lisp_eval_depth
= lisp_eval_depth
;
1071 c
.pdlcount
= SPECPDL_INDEX ();
1072 c
.poll_suppress_count
= poll_suppress_count
;
1073 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1074 c
.gcpro
= gcprolist
;
1075 c
.byte_stack
= byte_stack_list
;
1079 if (! _setjmp (c
.jmp
))
1080 c
.val
= (*func
) (arg
);
1082 /* Throw works by a longjmp that comes right here. */
1087 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1088 jump to that CATCH, returning VALUE as the value of that catch.
1090 This is the guts Fthrow and Fsignal; they differ only in the way
1091 they choose the catch tag to throw to. A catch tag for a
1092 condition-case form has a TAG of Qnil.
1094 Before each catch is discarded, unbind all special bindings and
1095 execute all unwind-protect clauses made above that catch. Unwind
1096 the handler stack as we go, so that the proper handlers are in
1097 effect for each unwind-protect clause we run. At the end, restore
1098 some static info saved in CATCH, and longjmp to the location
1101 This is used for correct unwinding in Fthrow and Fsignal. */
1104 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1106 register int last_time
;
1108 /* Save the value in the tag. */
1111 /* Restore certain special C variables. */
1112 set_poll_suppress_count (catch->poll_suppress_count
);
1113 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1114 handling_signal
= 0;
1119 last_time
= catchlist
== catch;
1121 /* Unwind the specpdl stack, and then restore the proper set of
1123 unbind_to (catchlist
->pdlcount
, Qnil
);
1124 handlerlist
= catchlist
->handlerlist
;
1125 catchlist
= catchlist
->next
;
1127 while (! last_time
);
1130 /* If x_catch_errors was done, turn it off now.
1131 (First we give unbind_to a chance to do that.) */
1132 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1133 The catch must remain in effect during that delicate
1134 state. --lorentey */
1135 x_fully_uncatch_errors ();
1139 byte_stack_list
= catch->byte_stack
;
1140 gcprolist
= catch->gcpro
;
1142 gcpro_level
= gcprolist
? gcprolist
->level
+ 1 : 0;
1144 backtrace_list
= catch->backlist
;
1145 lisp_eval_depth
= catch->lisp_eval_depth
;
1147 _longjmp (catch->jmp
, 1);
1150 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1151 doc
: /* Throw to the catch for TAG and return VALUE from it.
1152 Both TAG and VALUE are evalled. */)
1153 (register Lisp_Object tag
, Lisp_Object value
)
1155 register struct catchtag
*c
;
1158 for (c
= catchlist
; c
; c
= c
->next
)
1160 if (EQ (c
->tag
, tag
))
1161 unwind_to_catch (c
, value
);
1163 xsignal2 (Qno_catch
, tag
, value
);
1167 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1168 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1169 If BODYFORM completes normally, its value is returned
1170 after executing the UNWINDFORMS.
1171 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1172 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1176 ptrdiff_t count
= SPECPDL_INDEX ();
1178 record_unwind_protect (Fprogn
, Fcdr (args
));
1179 val
= eval_sub (Fcar (args
));
1180 return unbind_to (count
, val
);
1183 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1184 doc
: /* Regain control when an error is signaled.
1185 Executes BODYFORM and returns its value if no error happens.
1186 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1187 where the BODY is made of Lisp expressions.
1189 A handler is applicable to an error
1190 if CONDITION-NAME is one of the error's condition names.
1191 If an error happens, the first applicable handler is run.
1193 The car of a handler may be a list of condition names instead of a
1194 single condition name; then it handles all of them. If the special
1195 condition name `debug' is present in this list, it allows another
1196 condition in the list to run the debugger if `debug-on-error' and the
1197 other usual mechanisms says it should (otherwise, `condition-case'
1198 suppresses the debugger).
1200 When a handler handles an error, control returns to the `condition-case'
1201 and it executes the handler's BODY...
1202 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1203 \(If VAR is nil, the handler can't access that information.)
1204 Then the value of the last BODY form is returned from the `condition-case'
1207 See also the function `signal' for more info.
1208 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1211 register Lisp_Object bodyform
, handlers
;
1212 volatile Lisp_Object var
;
1215 bodyform
= Fcar (Fcdr (args
));
1216 handlers
= Fcdr (Fcdr (args
));
1218 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1221 /* Like Fcondition_case, but the args are separate
1222 rather than passed in a list. Used by Fbyte_code. */
1225 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1226 Lisp_Object handlers
)
1234 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1240 && (SYMBOLP (XCAR (tem
))
1241 || CONSP (XCAR (tem
))))))
1242 error ("Invalid condition handler: %s",
1243 SDATA (Fprin1_to_string (tem
, Qt
)));
1248 c
.backlist
= backtrace_list
;
1249 c
.handlerlist
= handlerlist
;
1250 c
.lisp_eval_depth
= lisp_eval_depth
;
1251 c
.pdlcount
= SPECPDL_INDEX ();
1252 c
.poll_suppress_count
= poll_suppress_count
;
1253 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1254 c
.gcpro
= gcprolist
;
1255 c
.byte_stack
= byte_stack_list
;
1256 if (_setjmp (c
.jmp
))
1259 specbind (h
.var
, c
.val
);
1260 val
= Fprogn (Fcdr (h
.chosen_clause
));
1262 /* Note that this just undoes the binding of h.var; whoever
1263 longjumped to us unwound the stack to c.pdlcount before
1265 unbind_to (c
.pdlcount
, Qnil
);
1272 h
.handler
= handlers
;
1273 h
.next
= handlerlist
;
1277 val
= eval_sub (bodyform
);
1279 handlerlist
= h
.next
;
1283 /* Call the function BFUN with no arguments, catching errors within it
1284 according to HANDLERS. If there is an error, call HFUN with
1285 one argument which is the data that describes the error:
1288 HANDLERS can be a list of conditions to catch.
1289 If HANDLERS is Qt, catch all errors.
1290 If HANDLERS is Qerror, catch all errors
1291 but allow the debugger to run if that is enabled. */
1294 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1295 Lisp_Object (*hfun
) (Lisp_Object
))
1303 c
.backlist
= backtrace_list
;
1304 c
.handlerlist
= handlerlist
;
1305 c
.lisp_eval_depth
= lisp_eval_depth
;
1306 c
.pdlcount
= SPECPDL_INDEX ();
1307 c
.poll_suppress_count
= poll_suppress_count
;
1308 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1309 c
.gcpro
= gcprolist
;
1310 c
.byte_stack
= byte_stack_list
;
1311 if (_setjmp (c
.jmp
))
1313 return (*hfun
) (c
.val
);
1317 h
.handler
= handlers
;
1319 h
.next
= handlerlist
;
1325 handlerlist
= h
.next
;
1329 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1332 internal_condition_case_1 (Lisp_Object (*bfun
) (Lisp_Object
), Lisp_Object arg
,
1333 Lisp_Object handlers
, Lisp_Object (*hfun
) (Lisp_Object
))
1341 c
.backlist
= backtrace_list
;
1342 c
.handlerlist
= handlerlist
;
1343 c
.lisp_eval_depth
= lisp_eval_depth
;
1344 c
.pdlcount
= SPECPDL_INDEX ();
1345 c
.poll_suppress_count
= poll_suppress_count
;
1346 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1347 c
.gcpro
= gcprolist
;
1348 c
.byte_stack
= byte_stack_list
;
1349 if (_setjmp (c
.jmp
))
1351 return (*hfun
) (c
.val
);
1355 h
.handler
= handlers
;
1357 h
.next
= handlerlist
;
1361 val
= (*bfun
) (arg
);
1363 handlerlist
= h
.next
;
1367 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1371 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1374 Lisp_Object handlers
,
1375 Lisp_Object (*hfun
) (Lisp_Object
))
1383 c
.backlist
= backtrace_list
;
1384 c
.handlerlist
= handlerlist
;
1385 c
.lisp_eval_depth
= lisp_eval_depth
;
1386 c
.pdlcount
= SPECPDL_INDEX ();
1387 c
.poll_suppress_count
= poll_suppress_count
;
1388 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1389 c
.gcpro
= gcprolist
;
1390 c
.byte_stack
= byte_stack_list
;
1391 if (_setjmp (c
.jmp
))
1393 return (*hfun
) (c
.val
);
1397 h
.handler
= handlers
;
1399 h
.next
= handlerlist
;
1403 val
= (*bfun
) (arg1
, arg2
);
1405 handlerlist
= h
.next
;
1409 /* Like internal_condition_case but call BFUN with NARGS as first,
1410 and ARGS as second argument. */
1413 internal_condition_case_n (Lisp_Object (*bfun
) (ptrdiff_t, Lisp_Object
*),
1416 Lisp_Object handlers
,
1417 Lisp_Object (*hfun
) (Lisp_Object
))
1425 c
.backlist
= backtrace_list
;
1426 c
.handlerlist
= handlerlist
;
1427 c
.lisp_eval_depth
= lisp_eval_depth
;
1428 c
.pdlcount
= SPECPDL_INDEX ();
1429 c
.poll_suppress_count
= poll_suppress_count
;
1430 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1431 c
.gcpro
= gcprolist
;
1432 c
.byte_stack
= byte_stack_list
;
1433 if (_setjmp (c
.jmp
))
1435 return (*hfun
) (c
.val
);
1439 h
.handler
= handlers
;
1441 h
.next
= handlerlist
;
1445 val
= (*bfun
) (nargs
, args
);
1447 handlerlist
= h
.next
;
1452 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
);
1453 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1457 process_quit_flag (void)
1459 Lisp_Object flag
= Vquit_flag
;
1461 if (EQ (flag
, Qkill_emacs
))
1463 if (EQ (Vthrow_on_input
, flag
))
1464 Fthrow (Vthrow_on_input
, Qt
);
1465 Fsignal (Qquit
, Qnil
);
1468 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1469 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1470 This function does not return.
1472 An error symbol is a symbol with an `error-conditions' property
1473 that is a list of condition names.
1474 A handler for any of those names will get to handle this signal.
1475 The symbol `error' should normally be one of them.
1477 DATA should be a list. Its elements are printed as part of the error message.
1478 See Info anchor `(elisp)Definition of signal' for some details on how this
1479 error message is constructed.
1480 If the signal is handled, DATA is made available to the handler.
1481 See also the function `condition-case'. */)
1482 (Lisp_Object error_symbol
, Lisp_Object data
)
1484 /* When memory is full, ERROR-SYMBOL is nil,
1485 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1486 That is a special case--don't do this in other situations. */
1487 Lisp_Object conditions
;
1489 Lisp_Object real_error_symbol
1490 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1491 register Lisp_Object clause
= Qnil
;
1493 struct backtrace
*bp
;
1495 immediate_quit
= handling_signal
= 0;
1497 if (gc_in_progress
|| waiting_for_input
)
1500 #if 0 /* rms: I don't know why this was here,
1501 but it is surely wrong for an error that is handled. */
1502 #ifdef HAVE_WINDOW_SYSTEM
1503 if (display_hourglass_p
)
1504 cancel_hourglass ();
1508 /* This hook is used by edebug. */
1509 if (! NILP (Vsignal_hook_function
)
1510 && ! NILP (error_symbol
))
1512 /* Edebug takes care of restoring these variables when it exits. */
1513 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1514 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1516 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1517 max_specpdl_size
= SPECPDL_INDEX () + 40;
1519 call2 (Vsignal_hook_function
, error_symbol
, data
);
1522 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1524 /* Remember from where signal was called. Skip over the frame for
1525 `signal' itself. If a frame for `error' follows, skip that,
1526 too. Don't do this when ERROR_SYMBOL is nil, because that
1527 is a memory-full error. */
1528 Vsignaling_function
= Qnil
;
1529 if (backtrace_list
&& !NILP (error_symbol
))
1531 bp
= backtrace_list
->next
;
1532 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1534 if (bp
&& bp
->function
)
1535 Vsignaling_function
= *bp
->function
;
1538 for (h
= handlerlist
; h
; h
= h
->next
)
1540 clause
= find_handler_clause (h
->handler
, conditions
);
1545 if (/* Don't run the debugger for a memory-full error.
1546 (There is no room in memory to do that!) */
1547 !NILP (error_symbol
)
1548 && (!NILP (Vdebug_on_signal
)
1549 /* If no handler is present now, try to run the debugger. */
1551 /* A `debug' symbol in the handler list disables the normal
1552 suppression of the debugger. */
1553 || (CONSP (clause
) && CONSP (XCAR (clause
))
1554 && !NILP (Fmemq (Qdebug
, XCAR (clause
))))
1555 /* Special handler that means "print a message and run debugger
1557 || EQ (h
->handler
, Qerror
)))
1560 = maybe_call_debugger (conditions
, error_symbol
, data
);
1561 /* We can't return values to code which signaled an error, but we
1562 can continue code which has signaled a quit. */
1563 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1569 Lisp_Object unwind_data
1570 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1572 h
->chosen_clause
= clause
;
1573 unwind_to_catch (h
->tag
, unwind_data
);
1578 Fthrow (Qtop_level
, Qt
);
1581 if (! NILP (error_symbol
))
1582 data
= Fcons (error_symbol
, data
);
1584 string
= Ferror_message_string (data
);
1585 fatal ("%s", SDATA (string
));
1588 /* Internal version of Fsignal that never returns.
1589 Used for anything but Qquit (which can return from Fsignal). */
1592 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1594 Fsignal (error_symbol
, data
);
1598 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1601 xsignal0 (Lisp_Object error_symbol
)
1603 xsignal (error_symbol
, Qnil
);
1607 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1609 xsignal (error_symbol
, list1 (arg
));
1613 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1615 xsignal (error_symbol
, list2 (arg1
, arg2
));
1619 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1621 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1624 /* Signal `error' with message S, and additional arg ARG.
1625 If ARG is not a genuine list, make it a one-element list. */
1628 signal_error (const char *s
, Lisp_Object arg
)
1630 Lisp_Object tortoise
, hare
;
1632 hare
= tortoise
= arg
;
1633 while (CONSP (hare
))
1640 tortoise
= XCDR (tortoise
);
1642 if (EQ (hare
, tortoise
))
1647 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1649 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1653 /* Return nonzero if LIST is a non-nil atom or
1654 a list containing one of CONDITIONS. */
1657 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1664 while (CONSP (conditions
))
1666 Lisp_Object
this, tail
;
1667 this = XCAR (conditions
);
1668 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1669 if (EQ (XCAR (tail
), this))
1671 conditions
= XCDR (conditions
);
1676 /* Return 1 if an error with condition-symbols CONDITIONS,
1677 and described by SIGNAL-DATA, should skip the debugger
1678 according to debugger-ignored-errors. */
1681 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1684 int first_string
= 1;
1685 Lisp_Object error_message
;
1687 error_message
= Qnil
;
1688 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1690 if (STRINGP (XCAR (tail
)))
1694 error_message
= Ferror_message_string (data
);
1698 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1703 Lisp_Object contail
;
1705 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1706 if (EQ (XCAR (tail
), XCAR (contail
)))
1714 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1715 SIG and DATA describe the signal. There are two ways to pass them:
1716 = SIG is the error symbol, and DATA is the rest of the data.
1717 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1718 This is for memory-full errors only. */
1720 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1722 Lisp_Object combined_data
;
1724 combined_data
= Fcons (sig
, data
);
1727 /* Don't try to run the debugger with interrupts blocked.
1728 The editing loop would return anyway. */
1730 /* Does user want to enter debugger for this kind of error? */
1733 : wants_debugger (Vdebug_on_error
, conditions
))
1734 && ! skip_debugger (conditions
, combined_data
)
1735 /* RMS: What's this for? */
1736 && when_entered_debugger
< num_nonmacro_input_events
)
1738 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1746 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
)
1748 register Lisp_Object h
;
1750 /* t is used by handlers for all conditions, set up by C code. */
1751 if (EQ (handlers
, Qt
))
1754 /* error is used similarly, but means print an error message
1755 and run the debugger if that is enabled. */
1756 if (EQ (handlers
, Qerror
))
1759 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1761 Lisp_Object handler
= XCAR (h
);
1762 Lisp_Object condit
, tem
;
1764 if (!CONSP (handler
))
1766 condit
= XCAR (handler
);
1767 /* Handle a single condition name in handler HANDLER. */
1768 if (SYMBOLP (condit
))
1770 tem
= Fmemq (Fcar (handler
), conditions
);
1774 /* Handle a list of condition names in handler HANDLER. */
1775 else if (CONSP (condit
))
1778 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1780 tem
= Fmemq (XCAR (tail
), conditions
);
1791 /* Dump an error message; called like vprintf. */
1793 verror (const char *m
, va_list ap
)
1796 ptrdiff_t size
= sizeof buf
;
1797 ptrdiff_t size_max
= STRING_BYTES_BOUND
+ 1;
1802 used
= evxprintf (&buffer
, &size
, buf
, size_max
, m
, ap
);
1803 string
= make_string (buffer
, used
);
1807 xsignal1 (Qerror
, string
);
1811 /* Dump an error message; called like printf. */
1815 error (const char *m
, ...)
1823 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
1824 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
1825 This means it contains a description for how to read arguments to give it.
1826 The value is nil for an invalid function or a symbol with no function
1829 Interactively callable functions include strings and vectors (treated
1830 as keyboard macros), lambda-expressions that contain a top-level call
1831 to `interactive', autoload definitions made by `autoload' with non-nil
1832 fourth argument, and some of the built-in functions of Lisp.
1834 Also, a symbol satisfies `commandp' if its function definition does so.
1836 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1837 then strings and vectors are not accepted. */)
1838 (Lisp_Object function
, Lisp_Object for_call_interactively
)
1840 register Lisp_Object fun
;
1841 register Lisp_Object funcar
;
1842 Lisp_Object if_prop
= Qnil
;
1846 fun
= indirect_function (fun
); /* Check cycles. */
1847 if (NILP (fun
) || EQ (fun
, Qunbound
))
1850 /* Check an `interactive-form' property if present, analogous to the
1851 function-documentation property. */
1853 while (SYMBOLP (fun
))
1855 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
1858 fun
= Fsymbol_function (fun
);
1861 /* Emacs primitives are interactive if their DEFUN specifies an
1862 interactive spec. */
1864 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
1866 /* Bytecode objects are interactive if they are long enough to
1867 have an element whose index is COMPILED_INTERACTIVE, which is
1868 where the interactive spec is stored. */
1869 else if (COMPILEDP (fun
))
1870 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
1873 /* Strings and vectors are keyboard macros. */
1874 if (STRINGP (fun
) || VECTORP (fun
))
1875 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
1877 /* Lists may represent commands. */
1880 funcar
= XCAR (fun
);
1881 if (EQ (funcar
, Qclosure
))
1882 return (!NILP (Fassq (Qinteractive
, Fcdr (Fcdr (XCDR (fun
)))))
1884 else if (EQ (funcar
, Qlambda
))
1885 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
1886 else if (EQ (funcar
, Qautoload
))
1887 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
1892 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
1893 doc
: /* Define FUNCTION to autoload from FILE.
1894 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1895 Third arg DOCSTRING is documentation for the function.
1896 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1897 Fifth arg TYPE indicates the type of the object:
1898 nil or omitted says FUNCTION is a function,
1899 `keymap' says FUNCTION is really a keymap, and
1900 `macro' or t says FUNCTION is really a macro.
1901 Third through fifth args give info about the real definition.
1902 They default to nil.
1903 If FUNCTION is already defined other than as an autoload,
1904 this does nothing and returns nil. */)
1905 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
1907 CHECK_SYMBOL (function
);
1908 CHECK_STRING (file
);
1910 /* If function is defined and not as an autoload, don't override. */
1911 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
1912 && !(CONSP (XSYMBOL (function
)->function
)
1913 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
1916 if (NILP (Vpurify_flag
))
1917 /* Only add entries after dumping, because the ones before are
1918 not useful and else we get loads of them from the loaddefs.el. */
1919 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
1920 else if (EQ (docstring
, make_number (0)))
1921 /* `read1' in lread.c has found the docstring starting with "\
1922 and assumed the docstring will be provided by Snarf-documentation, so it
1923 passed us 0 instead. But that leads to accidental sharing in purecopy's
1924 hash-consing, so we use a (hopefully) unique integer instead. */
1925 docstring
= make_number (XUNTAG (function
, Lisp_Symbol
));
1926 return Ffset (function
,
1927 Fpurecopy (list5 (Qautoload
, file
, docstring
,
1928 interactive
, type
)));
1932 un_autoload (Lisp_Object oldqueue
)
1934 register Lisp_Object queue
, first
, second
;
1936 /* Queue to unwind is current value of Vautoload_queue.
1937 oldqueue is the shadowed value to leave in Vautoload_queue. */
1938 queue
= Vautoload_queue
;
1939 Vautoload_queue
= oldqueue
;
1940 while (CONSP (queue
))
1942 first
= XCAR (queue
);
1943 second
= Fcdr (first
);
1944 first
= Fcar (first
);
1945 if (EQ (first
, make_number (0)))
1948 Ffset (first
, second
);
1949 queue
= XCDR (queue
);
1954 /* Load an autoloaded function.
1955 FUNNAME is the symbol which is the function's name.
1956 FUNDEF is the autoload definition (a list). */
1959 do_autoload (Lisp_Object fundef
, Lisp_Object funname
)
1961 ptrdiff_t count
= SPECPDL_INDEX ();
1963 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1965 /* This is to make sure that loadup.el gives a clear picture
1966 of what files are preloaded and when. */
1967 if (! NILP (Vpurify_flag
))
1968 error ("Attempt to autoload %s while preparing to dump",
1969 SDATA (SYMBOL_NAME (funname
)));
1972 CHECK_SYMBOL (funname
);
1973 GCPRO3 (fun
, funname
, fundef
);
1975 /* Preserve the match data. */
1976 record_unwind_save_match_data ();
1978 /* If autoloading gets an error (which includes the error of failing
1979 to define the function being called), we use Vautoload_queue
1980 to undo function definitions and `provide' calls made by
1981 the function. We do this in the specific case of autoloading
1982 because autoloading is not an explicit request "load this file",
1983 but rather a request to "call this function".
1985 The value saved here is to be restored into Vautoload_queue. */
1986 record_unwind_protect (un_autoload
, Vautoload_queue
);
1987 Vautoload_queue
= Qt
;
1988 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
1990 /* Once loading finishes, don't undo it. */
1991 Vautoload_queue
= Qt
;
1992 unbind_to (count
, Qnil
);
1994 fun
= Findirect_function (fun
, Qnil
);
1996 if (!NILP (Fequal (fun
, fundef
)))
1997 error ("Autoloading failed to define function %s",
1998 SDATA (SYMBOL_NAME (funname
)));
2003 DEFUN ("eval", Feval
, Seval
, 1, 2, 0,
2004 doc
: /* Evaluate FORM and return its value.
2005 If LEXICAL is t, evaluate using lexical scoping. */)
2006 (Lisp_Object form
, Lisp_Object lexical
)
2008 ptrdiff_t count
= SPECPDL_INDEX ();
2009 specbind (Qinternal_interpreter_environment
,
2010 NILP (lexical
) ? Qnil
: Fcons (Qt
, Qnil
));
2011 return unbind_to (count
, eval_sub (form
));
2014 /* Eval a sub-expression of the current expression (i.e. in the same
2017 eval_sub (Lisp_Object form
)
2019 Lisp_Object fun
, val
, original_fun
, original_args
;
2021 struct backtrace backtrace
;
2022 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2024 if (handling_signal
)
2029 /* Look up its binding in the lexical environment.
2030 We do not pay attention to the declared_special flag here, since we
2031 already did that when let-binding the variable. */
2032 Lisp_Object lex_binding
2033 = !NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
2034 ? Fassq (form
, Vinternal_interpreter_environment
)
2036 if (CONSP (lex_binding
))
2037 return XCDR (lex_binding
);
2039 return Fsymbol_value (form
);
2046 if ((consing_since_gc
> gc_cons_threshold
2047 && consing_since_gc
> gc_relative_threshold
)
2049 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2052 Fgarbage_collect ();
2056 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2058 if (max_lisp_eval_depth
< 100)
2059 max_lisp_eval_depth
= 100;
2060 if (lisp_eval_depth
> max_lisp_eval_depth
)
2061 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2064 original_fun
= Fcar (form
);
2065 original_args
= Fcdr (form
);
2067 backtrace
.next
= backtrace_list
;
2068 backtrace_list
= &backtrace
;
2069 backtrace
.function
= &original_fun
; /* This also protects them from gc. */
2070 backtrace
.args
= &original_args
;
2071 backtrace
.nargs
= UNEVALLED
;
2072 backtrace
.debug_on_exit
= 0;
2074 if (debug_on_next_call
)
2075 do_debug_on_call (Qt
);
2077 /* At this point, only original_fun and original_args
2078 have values that will be used below. */
2081 /* Optimize for no indirection. */
2083 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2084 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2085 fun
= indirect_function (fun
);
2089 Lisp_Object numargs
;
2090 Lisp_Object argvals
[8];
2091 Lisp_Object args_left
;
2092 register int i
, maxargs
;
2094 args_left
= original_args
;
2095 numargs
= Flength (args_left
);
2099 if (XINT (numargs
) < XSUBR (fun
)->min_args
2100 || (XSUBR (fun
)->max_args
>= 0
2101 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2102 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2104 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2105 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2106 else if (XSUBR (fun
)->max_args
== MANY
)
2108 /* Pass a vector of evaluated arguments. */
2110 ptrdiff_t argnum
= 0;
2113 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2115 GCPRO3 (args_left
, fun
, fun
);
2119 while (!NILP (args_left
))
2121 vals
[argnum
++] = eval_sub (Fcar (args_left
));
2122 args_left
= Fcdr (args_left
);
2123 gcpro3
.nvars
= argnum
;
2126 backtrace
.args
= vals
;
2127 backtrace
.nargs
= XINT (numargs
);
2129 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2135 GCPRO3 (args_left
, fun
, fun
);
2136 gcpro3
.var
= argvals
;
2139 maxargs
= XSUBR (fun
)->max_args
;
2140 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2142 argvals
[i
] = eval_sub (Fcar (args_left
));
2148 backtrace
.args
= argvals
;
2149 backtrace
.nargs
= XINT (numargs
);
2154 val
= (XSUBR (fun
)->function
.a0 ());
2157 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2160 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2163 val
= (XSUBR (fun
)->function
.a3
2164 (argvals
[0], argvals
[1], argvals
[2]));
2167 val
= (XSUBR (fun
)->function
.a4
2168 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2171 val
= (XSUBR (fun
)->function
.a5
2172 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2176 val
= (XSUBR (fun
)->function
.a6
2177 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2178 argvals
[4], argvals
[5]));
2181 val
= (XSUBR (fun
)->function
.a7
2182 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2183 argvals
[4], argvals
[5], argvals
[6]));
2187 val
= (XSUBR (fun
)->function
.a8
2188 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2189 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2193 /* Someone has created a subr that takes more arguments than
2194 is supported by this code. We need to either rewrite the
2195 subr to use a different argument protocol, or add more
2196 cases to this switch. */
2201 else if (COMPILEDP (fun
))
2202 val
= apply_lambda (fun
, original_args
);
2205 if (EQ (fun
, Qunbound
))
2206 xsignal1 (Qvoid_function
, original_fun
);
2208 xsignal1 (Qinvalid_function
, original_fun
);
2209 funcar
= XCAR (fun
);
2210 if (!SYMBOLP (funcar
))
2211 xsignal1 (Qinvalid_function
, original_fun
);
2212 if (EQ (funcar
, Qautoload
))
2214 do_autoload (fun
, original_fun
);
2217 if (EQ (funcar
, Qmacro
))
2218 val
= eval_sub (apply1 (Fcdr (fun
), original_args
));
2219 else if (EQ (funcar
, Qlambda
)
2220 || EQ (funcar
, Qclosure
))
2221 val
= apply_lambda (fun
, original_args
);
2223 xsignal1 (Qinvalid_function
, original_fun
);
2228 if (backtrace
.debug_on_exit
)
2229 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2230 backtrace_list
= backtrace
.next
;
2235 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2236 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2237 Then return the value FUNCTION returns.
2238 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2239 usage: (apply FUNCTION &rest ARGUMENTS) */)
2240 (ptrdiff_t nargs
, Lisp_Object
*args
)
2244 register Lisp_Object spread_arg
;
2245 register Lisp_Object
*funcall_args
;
2246 Lisp_Object fun
, retval
;
2247 struct gcpro gcpro1
;
2252 spread_arg
= args
[nargs
- 1];
2253 CHECK_LIST (spread_arg
);
2255 numargs
= XINT (Flength (spread_arg
));
2258 return Ffuncall (nargs
- 1, args
);
2259 else if (numargs
== 1)
2261 args
[nargs
- 1] = XCAR (spread_arg
);
2262 return Ffuncall (nargs
, args
);
2265 numargs
+= nargs
- 2;
2267 /* Optimize for no indirection. */
2268 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2269 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2270 fun
= indirect_function (fun
);
2271 if (EQ (fun
, Qunbound
))
2273 /* Let funcall get the error. */
2280 if (numargs
< XSUBR (fun
)->min_args
2281 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2282 goto funcall
; /* Let funcall get the error. */
2283 else if (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
> numargs
)
2285 /* Avoid making funcall cons up a yet another new vector of arguments
2286 by explicitly supplying nil's for optional values. */
2287 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2288 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2289 funcall_args
[++i
] = Qnil
;
2290 GCPRO1 (*funcall_args
);
2291 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2295 /* We add 1 to numargs because funcall_args includes the
2296 function itself as well as its arguments. */
2299 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2300 GCPRO1 (*funcall_args
);
2301 gcpro1
.nvars
= 1 + numargs
;
2304 memcpy (funcall_args
, args
, nargs
* sizeof (Lisp_Object
));
2305 /* Spread the last arg we got. Its first element goes in
2306 the slot that it used to occupy, hence this value of I. */
2308 while (!NILP (spread_arg
))
2310 funcall_args
[i
++] = XCAR (spread_arg
);
2311 spread_arg
= XCDR (spread_arg
);
2314 /* By convention, the caller needs to gcpro Ffuncall's args. */
2315 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2322 /* Run hook variables in various ways. */
2325 funcall_nil (ptrdiff_t nargs
, Lisp_Object
*args
)
2327 Ffuncall (nargs
, args
);
2331 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2332 doc
: /* Run each hook in HOOKS.
2333 Each argument should be a symbol, a hook variable.
2334 These symbols are processed in the order specified.
2335 If a hook symbol has a non-nil value, that value may be a function
2336 or a list of functions to be called to run the hook.
2337 If the value is a function, it is called with no arguments.
2338 If it is a list, the elements are called, in order, with no arguments.
2340 Major modes should not use this function directly to run their mode
2341 hook; they should use `run-mode-hooks' instead.
2343 Do not use `make-local-variable' to make a hook variable buffer-local.
2344 Instead, use `add-hook' and specify t for the LOCAL argument.
2345 usage: (run-hooks &rest HOOKS) */)
2346 (ptrdiff_t nargs
, Lisp_Object
*args
)
2348 Lisp_Object hook
[1];
2351 for (i
= 0; i
< nargs
; i
++)
2354 run_hook_with_args (1, hook
, funcall_nil
);
2360 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2361 Srun_hook_with_args
, 1, MANY
, 0,
2362 doc
: /* Run HOOK with the specified arguments ARGS.
2363 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2364 value, that value may be a function or a list of functions to be
2365 called to run the hook. If the value is a function, it is called with
2366 the given arguments and its return value is returned. If it is a list
2367 of functions, those functions are called, in order,
2368 with the given arguments ARGS.
2369 It is best not to depend on the value returned by `run-hook-with-args',
2372 Do not use `make-local-variable' to make a hook variable buffer-local.
2373 Instead, use `add-hook' and specify t for the LOCAL argument.
2374 usage: (run-hook-with-args HOOK &rest ARGS) */)
2375 (ptrdiff_t nargs
, Lisp_Object
*args
)
2377 return run_hook_with_args (nargs
, args
, funcall_nil
);
2380 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2381 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2382 doc
: /* Run HOOK with the specified arguments ARGS.
2383 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2384 value, that value may be a function or a list of functions to be
2385 called to run the hook. If the value is a function, it is called with
2386 the given arguments and its return value is returned.
2387 If it is a list of functions, those functions are called, in order,
2388 with the given arguments ARGS, until one of them
2389 returns a non-nil value. Then we return that value.
2390 However, if they all return nil, we return nil.
2392 Do not use `make-local-variable' to make a hook variable buffer-local.
2393 Instead, use `add-hook' and specify t for the LOCAL argument.
2394 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2395 (ptrdiff_t nargs
, Lisp_Object
*args
)
2397 return run_hook_with_args (nargs
, args
, Ffuncall
);
2401 funcall_not (ptrdiff_t nargs
, Lisp_Object
*args
)
2403 return NILP (Ffuncall (nargs
, args
)) ? Qt
: Qnil
;
2406 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2407 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2408 doc
: /* Run HOOK with the specified arguments ARGS.
2409 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2410 value, that value may be a function or a list of functions to be
2411 called to run the hook. If the value is a function, it is called with
2412 the given arguments and its return value is returned.
2413 If it is a list of functions, those functions are called, in order,
2414 with the given arguments ARGS, until one of them returns nil.
2415 Then we return nil. However, if they all return non-nil, we return non-nil.
2417 Do not use `make-local-variable' to make a hook variable buffer-local.
2418 Instead, use `add-hook' and specify t for the LOCAL argument.
2419 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2420 (ptrdiff_t nargs
, Lisp_Object
*args
)
2422 return NILP (run_hook_with_args (nargs
, args
, funcall_not
)) ? Qt
: Qnil
;
2426 run_hook_wrapped_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
2428 Lisp_Object tmp
= args
[0], ret
;
2431 ret
= Ffuncall (nargs
, args
);
2437 DEFUN ("run-hook-wrapped", Frun_hook_wrapped
, Srun_hook_wrapped
, 2, MANY
, 0,
2438 doc
: /* Run HOOK, passing each function through WRAP-FUNCTION.
2439 I.e. instead of calling each function FUN directly with arguments ARGS,
2440 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2441 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2442 aborts and returns that value.
2443 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2444 (ptrdiff_t nargs
, Lisp_Object
*args
)
2446 return run_hook_with_args (nargs
, args
, run_hook_wrapped_funcall
);
2449 /* ARGS[0] should be a hook symbol.
2450 Call each of the functions in the hook value, passing each of them
2451 as arguments all the rest of ARGS (all NARGS - 1 elements).
2452 FUNCALL specifies how to call each function on the hook.
2453 The caller (or its caller, etc) must gcpro all of ARGS,
2454 except that it isn't necessary to gcpro ARGS[0]. */
2457 run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2458 Lisp_Object (*funcall
) (ptrdiff_t nargs
, Lisp_Object
*args
))
2460 Lisp_Object sym
, val
, ret
= Qnil
;
2461 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2463 /* If we are dying or still initializing,
2464 don't do anything--it would probably crash if we tried. */
2465 if (NILP (Vrun_hooks
))
2469 val
= find_symbol_value (sym
);
2471 if (EQ (val
, Qunbound
) || NILP (val
))
2473 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2476 return funcall (nargs
, args
);
2480 Lisp_Object global_vals
= Qnil
;
2481 GCPRO3 (sym
, val
, global_vals
);
2484 CONSP (val
) && NILP (ret
);
2487 if (EQ (XCAR (val
), Qt
))
2489 /* t indicates this hook has a local binding;
2490 it means to run the global binding too. */
2491 global_vals
= Fdefault_value (sym
);
2492 if (NILP (global_vals
)) continue;
2494 if (!CONSP (global_vals
) || EQ (XCAR (global_vals
), Qlambda
))
2496 args
[0] = global_vals
;
2497 ret
= funcall (nargs
, args
);
2502 CONSP (global_vals
) && NILP (ret
);
2503 global_vals
= XCDR (global_vals
))
2505 args
[0] = XCAR (global_vals
);
2506 /* In a global value, t should not occur. If it does, we
2507 must ignore it to avoid an endless loop. */
2508 if (!EQ (args
[0], Qt
))
2509 ret
= funcall (nargs
, args
);
2515 args
[0] = XCAR (val
);
2516 ret
= funcall (nargs
, args
);
2525 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2528 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2530 Lisp_Object temp
[3];
2535 Frun_hook_with_args (3, temp
);
2538 /* Apply fn to arg. */
2540 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2542 struct gcpro gcpro1
;
2546 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2549 Lisp_Object args
[2];
2553 RETURN_UNGCPRO (Fapply (2, args
));
2557 /* Call function fn on no arguments. */
2559 call0 (Lisp_Object fn
)
2561 struct gcpro gcpro1
;
2564 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2567 /* Call function fn with 1 argument arg1. */
2570 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2572 struct gcpro gcpro1
;
2573 Lisp_Object args
[2];
2579 RETURN_UNGCPRO (Ffuncall (2, args
));
2582 /* Call function fn with 2 arguments arg1, arg2. */
2585 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2587 struct gcpro gcpro1
;
2588 Lisp_Object args
[3];
2594 RETURN_UNGCPRO (Ffuncall (3, args
));
2597 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2600 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2602 struct gcpro gcpro1
;
2603 Lisp_Object args
[4];
2610 RETURN_UNGCPRO (Ffuncall (4, args
));
2613 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2616 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2619 struct gcpro gcpro1
;
2620 Lisp_Object args
[5];
2628 RETURN_UNGCPRO (Ffuncall (5, args
));
2631 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2634 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2635 Lisp_Object arg4
, Lisp_Object arg5
)
2637 struct gcpro gcpro1
;
2638 Lisp_Object args
[6];
2647 RETURN_UNGCPRO (Ffuncall (6, args
));
2650 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2653 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2654 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2656 struct gcpro gcpro1
;
2657 Lisp_Object args
[7];
2667 RETURN_UNGCPRO (Ffuncall (7, args
));
2670 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2673 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2674 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2676 struct gcpro gcpro1
;
2677 Lisp_Object args
[8];
2688 RETURN_UNGCPRO (Ffuncall (8, args
));
2691 /* The caller should GCPRO all the elements of ARGS. */
2693 DEFUN ("functionp", Ffunctionp
, Sfunctionp
, 1, 1, 0,
2694 doc
: /* Non-nil if OBJECT is a function. */)
2695 (Lisp_Object object
)
2697 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
2699 object
= Findirect_function (object
, Qt
);
2701 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
2703 /* Autoloaded symbols are functions, except if they load
2704 macros or keymaps. */
2706 for (i
= 0; i
< 4 && CONSP (object
); i
++)
2707 object
= XCDR (object
);
2709 return (CONSP (object
) && !NILP (XCAR (object
))) ? Qnil
: Qt
;
2714 return (XSUBR (object
)->max_args
!= UNEVALLED
) ? Qt
: Qnil
;
2715 else if (COMPILEDP (object
))
2717 else if (CONSP (object
))
2719 Lisp_Object car
= XCAR (object
);
2720 return (EQ (car
, Qlambda
) || EQ (car
, Qclosure
)) ? Qt
: Qnil
;
2726 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2727 doc
: /* Call first argument as a function, passing remaining arguments to it.
2728 Return the value that function returns.
2729 Thus, (funcall 'cons 'x 'y) returns (x . y).
2730 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2731 (ptrdiff_t nargs
, Lisp_Object
*args
)
2733 Lisp_Object fun
, original_fun
;
2735 ptrdiff_t numargs
= nargs
- 1;
2736 Lisp_Object lisp_numargs
;
2738 struct backtrace backtrace
;
2739 register Lisp_Object
*internal_args
;
2743 if ((consing_since_gc
> gc_cons_threshold
2744 && consing_since_gc
> gc_relative_threshold
)
2746 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2747 Fgarbage_collect ();
2749 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2751 if (max_lisp_eval_depth
< 100)
2752 max_lisp_eval_depth
= 100;
2753 if (lisp_eval_depth
> max_lisp_eval_depth
)
2754 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2757 backtrace
.next
= backtrace_list
;
2758 backtrace_list
= &backtrace
;
2759 backtrace
.function
= &args
[0];
2760 backtrace
.args
= &args
[1];
2761 backtrace
.nargs
= nargs
- 1;
2762 backtrace
.debug_on_exit
= 0;
2764 if (debug_on_next_call
)
2765 do_debug_on_call (Qlambda
);
2769 original_fun
= args
[0];
2773 /* Optimize for no indirection. */
2775 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2776 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2777 fun
= indirect_function (fun
);
2781 if (numargs
< XSUBR (fun
)->min_args
2782 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2784 XSETFASTINT (lisp_numargs
, numargs
);
2785 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2788 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2789 xsignal1 (Qinvalid_function
, original_fun
);
2791 else if (XSUBR (fun
)->max_args
== MANY
)
2792 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
2795 if (XSUBR (fun
)->max_args
> numargs
)
2797 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
2798 memcpy (internal_args
, args
+ 1, numargs
* sizeof (Lisp_Object
));
2799 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2800 internal_args
[i
] = Qnil
;
2803 internal_args
= args
+ 1;
2804 switch (XSUBR (fun
)->max_args
)
2807 val
= (XSUBR (fun
)->function
.a0 ());
2810 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
2813 val
= (XSUBR (fun
)->function
.a2
2814 (internal_args
[0], internal_args
[1]));
2817 val
= (XSUBR (fun
)->function
.a3
2818 (internal_args
[0], internal_args
[1], internal_args
[2]));
2821 val
= (XSUBR (fun
)->function
.a4
2822 (internal_args
[0], internal_args
[1], internal_args
[2],
2826 val
= (XSUBR (fun
)->function
.a5
2827 (internal_args
[0], internal_args
[1], internal_args
[2],
2828 internal_args
[3], internal_args
[4]));
2831 val
= (XSUBR (fun
)->function
.a6
2832 (internal_args
[0], internal_args
[1], internal_args
[2],
2833 internal_args
[3], internal_args
[4], internal_args
[5]));
2836 val
= (XSUBR (fun
)->function
.a7
2837 (internal_args
[0], internal_args
[1], internal_args
[2],
2838 internal_args
[3], internal_args
[4], internal_args
[5],
2843 val
= (XSUBR (fun
)->function
.a8
2844 (internal_args
[0], internal_args
[1], internal_args
[2],
2845 internal_args
[3], internal_args
[4], internal_args
[5],
2846 internal_args
[6], internal_args
[7]));
2851 /* If a subr takes more than 8 arguments without using MANY
2852 or UNEVALLED, we need to extend this function to support it.
2853 Until this is done, there is no way to call the function. */
2858 else if (COMPILEDP (fun
))
2859 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2862 if (EQ (fun
, Qunbound
))
2863 xsignal1 (Qvoid_function
, original_fun
);
2865 xsignal1 (Qinvalid_function
, original_fun
);
2866 funcar
= XCAR (fun
);
2867 if (!SYMBOLP (funcar
))
2868 xsignal1 (Qinvalid_function
, original_fun
);
2869 if (EQ (funcar
, Qlambda
)
2870 || EQ (funcar
, Qclosure
))
2871 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2872 else if (EQ (funcar
, Qautoload
))
2874 do_autoload (fun
, original_fun
);
2879 xsignal1 (Qinvalid_function
, original_fun
);
2883 if (backtrace
.debug_on_exit
)
2884 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2885 backtrace_list
= backtrace
.next
;
2890 apply_lambda (Lisp_Object fun
, Lisp_Object args
)
2892 Lisp_Object args_left
;
2895 register Lisp_Object
*arg_vector
;
2896 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2897 register Lisp_Object tem
;
2900 numargs
= XFASTINT (Flength (args
));
2901 SAFE_ALLOCA_LISP (arg_vector
, numargs
);
2904 GCPRO3 (*arg_vector
, args_left
, fun
);
2907 for (i
= 0; i
< numargs
; )
2909 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
2910 tem
= eval_sub (tem
);
2911 arg_vector
[i
++] = tem
;
2917 backtrace_list
->args
= arg_vector
;
2918 backtrace_list
->nargs
= i
;
2919 tem
= funcall_lambda (fun
, numargs
, arg_vector
);
2921 /* Do the debug-on-exit now, while arg_vector still exists. */
2922 if (backtrace_list
->debug_on_exit
)
2923 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
2924 /* Don't do it again when we return to eval. */
2925 backtrace_list
->debug_on_exit
= 0;
2930 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2931 and return the result of evaluation.
2932 FUN must be either a lambda-expression or a compiled-code object. */
2935 funcall_lambda (Lisp_Object fun
, ptrdiff_t nargs
,
2936 register Lisp_Object
*arg_vector
)
2938 Lisp_Object val
, syms_left
, next
, lexenv
;
2939 ptrdiff_t count
= SPECPDL_INDEX ();
2945 if (EQ (XCAR (fun
), Qclosure
))
2947 fun
= XCDR (fun
); /* Drop `closure'. */
2948 lexenv
= XCAR (fun
);
2949 CHECK_LIST_CONS (fun
, fun
);
2953 syms_left
= XCDR (fun
);
2954 if (CONSP (syms_left
))
2955 syms_left
= XCAR (syms_left
);
2957 xsignal1 (Qinvalid_function
, fun
);
2959 else if (COMPILEDP (fun
))
2961 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
2962 if (INTEGERP (syms_left
))
2963 /* A byte-code object with a non-nil `push args' slot means we
2964 shouldn't bind any arguments, instead just call the byte-code
2965 interpreter directly; it will push arguments as necessary.
2967 Byte-code objects with either a non-existent, or a nil value for
2968 the `push args' slot (the default), have dynamically-bound
2969 arguments, and use the argument-binding code below instead (as do
2970 all interpreted functions, even lexically bound ones). */
2972 /* If we have not actually read the bytecode string
2973 and constants vector yet, fetch them from the file. */
2974 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
2975 Ffetch_bytecode (fun
);
2976 return exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
2977 AREF (fun
, COMPILED_CONSTANTS
),
2978 AREF (fun
, COMPILED_STACK_DEPTH
),
2987 i
= optional
= rest
= 0;
2988 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
2992 next
= XCAR (syms_left
);
2993 if (!SYMBOLP (next
))
2994 xsignal1 (Qinvalid_function
, fun
);
2996 if (EQ (next
, Qand_rest
))
2998 else if (EQ (next
, Qand_optional
))
3005 arg
= Flist (nargs
- i
, &arg_vector
[i
]);
3009 arg
= arg_vector
[i
++];
3011 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3015 /* Bind the argument. */
3016 if (!NILP (lexenv
) && SYMBOLP (next
))
3017 /* Lexically bind NEXT by adding it to the lexenv alist. */
3018 lexenv
= Fcons (Fcons (next
, arg
), lexenv
);
3020 /* Dynamically bind NEXT. */
3021 specbind (next
, arg
);
3025 if (!NILP (syms_left
))
3026 xsignal1 (Qinvalid_function
, fun
);
3028 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3030 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
3031 /* Instantiate a new lexical environment. */
3032 specbind (Qinternal_interpreter_environment
, lexenv
);
3035 val
= Fprogn (XCDR (XCDR (fun
)));
3038 /* If we have not actually read the bytecode string
3039 and constants vector yet, fetch them from the file. */
3040 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3041 Ffetch_bytecode (fun
);
3042 val
= exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3043 AREF (fun
, COMPILED_CONSTANTS
),
3044 AREF (fun
, COMPILED_STACK_DEPTH
),
3048 return unbind_to (count
, val
);
3051 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3053 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3054 (Lisp_Object object
)
3058 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3060 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3063 tem
= AREF (object
, COMPILED_BYTECODE
);
3064 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3065 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3067 error ("Invalid byte code");
3069 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3070 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3078 register ptrdiff_t count
= SPECPDL_INDEX ();
3079 ptrdiff_t max_size
= min (max_specpdl_size
, PTRDIFF_MAX
);
3080 if (max_size
<= specpdl_size
)
3082 if (max_specpdl_size
< 400)
3083 max_size
= max_specpdl_size
= 400;
3084 if (max_size
<= specpdl_size
)
3085 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3087 specpdl
= xpalloc (specpdl
, &specpdl_size
, 1, max_size
, sizeof *specpdl
);
3088 specpdl_ptr
= specpdl
+ count
;
3091 /* `specpdl_ptr->symbol' is a field which describes which variable is
3092 let-bound, so it can be properly undone when we unbind_to.
3093 It can have the following two shapes:
3094 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3095 a symbol that is not buffer-local (at least at the time
3096 the let binding started). Note also that it should not be
3097 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3099 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3100 variable SYMBOL which can be buffer-local. WHERE tells us
3101 which buffer is affected (or nil if the let-binding affects the
3102 global value of the variable) and BUFFER tells us which buffer was
3103 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3104 BUFFER did not yet have a buffer-local value). */
3107 specbind (Lisp_Object symbol
, Lisp_Object value
)
3109 struct Lisp_Symbol
*sym
;
3111 eassert (!handling_signal
);
3113 CHECK_SYMBOL (symbol
);
3114 sym
= XSYMBOL (symbol
);
3115 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3119 switch (sym
->redirect
)
3121 case SYMBOL_VARALIAS
:
3122 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3123 case SYMBOL_PLAINVAL
:
3124 /* The most common case is that of a non-constant symbol with a
3125 trivial value. Make that as fast as we can. */
3126 specpdl_ptr
->symbol
= symbol
;
3127 specpdl_ptr
->old_value
= SYMBOL_VAL (sym
);
3128 specpdl_ptr
->func
= NULL
;
3131 SET_SYMBOL_VAL (sym
, value
);
3133 set_internal (symbol
, value
, Qnil
, 1);
3135 case SYMBOL_LOCALIZED
:
3136 if (SYMBOL_BLV (sym
)->frame_local
)
3137 error ("Frame-local vars cannot be let-bound");
3138 case SYMBOL_FORWARDED
:
3140 Lisp_Object ovalue
= find_symbol_value (symbol
);
3141 specpdl_ptr
->func
= 0;
3142 specpdl_ptr
->old_value
= ovalue
;
3144 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3145 || (EQ (SYMBOL_BLV (sym
)->where
,
3146 SYMBOL_BLV (sym
)->frame_local
?
3147 Fselected_frame () : Fcurrent_buffer ())));
3149 if (sym
->redirect
== SYMBOL_LOCALIZED
3150 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3152 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3154 /* For a local variable, record both the symbol and which
3155 buffer's or frame's value we are saving. */
3156 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3158 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3159 || (BLV_FOUND (SYMBOL_BLV (sym
))
3160 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3163 else if (sym
->redirect
== SYMBOL_LOCALIZED
3164 && BLV_FOUND (SYMBOL_BLV (sym
)))
3165 where
= SYMBOL_BLV (sym
)->where
;
3169 /* We're not using the `unused' slot in the specbinding
3170 structure because this would mean we have to do more
3171 work for simple variables. */
3172 /* FIXME: The third value `current_buffer' is only used in
3173 let_shadows_buffer_binding_p which is itself only used
3174 in set_internal for local_if_set. */
3175 eassert (NILP (where
) || EQ (where
, cur_buf
));
3176 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, cur_buf
));
3178 /* If SYMBOL is a per-buffer variable which doesn't have a
3179 buffer-local value here, make the `let' change the global
3180 value by changing the value of SYMBOL in all buffers not
3181 having their own value. This is consistent with what
3182 happens with other buffer-local variables. */
3184 && sym
->redirect
== SYMBOL_FORWARDED
)
3186 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3188 Fset_default (symbol
, value
);
3193 specpdl_ptr
->symbol
= symbol
;
3196 set_internal (symbol
, value
, Qnil
, 1);
3204 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3206 eassert (!handling_signal
);
3208 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3210 specpdl_ptr
->func
= function
;
3211 specpdl_ptr
->symbol
= Qnil
;
3212 specpdl_ptr
->old_value
= arg
;
3217 unbind_to (ptrdiff_t count
, Lisp_Object value
)
3219 Lisp_Object quitf
= Vquit_flag
;
3220 struct gcpro gcpro1
, gcpro2
;
3222 GCPRO2 (value
, quitf
);
3225 while (specpdl_ptr
!= specpdl
+ count
)
3227 /* Copy the binding, and decrement specpdl_ptr, before we do
3228 the work to unbind it. We decrement first
3229 so that an error in unbinding won't try to unbind
3230 the same entry again, and we copy the binding first
3231 in case more bindings are made during some of the code we run. */
3233 struct specbinding this_binding
;
3234 this_binding
= *--specpdl_ptr
;
3236 if (this_binding
.func
!= 0)
3237 (*this_binding
.func
) (this_binding
.old_value
);
3238 /* If the symbol is a list, it is really (SYMBOL WHERE
3239 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3240 frame. If WHERE is a buffer or frame, this indicates we
3241 bound a variable that had a buffer-local or frame-local
3242 binding. WHERE nil means that the variable had the default
3243 value when it was bound. CURRENT-BUFFER is the buffer that
3244 was current when the variable was bound. */
3245 else if (CONSP (this_binding
.symbol
))
3247 Lisp_Object symbol
, where
;
3249 symbol
= XCAR (this_binding
.symbol
);
3250 where
= XCAR (XCDR (this_binding
.symbol
));
3253 Fset_default (symbol
, this_binding
.old_value
);
3254 /* If `where' is non-nil, reset the value in the appropriate
3255 local binding, but only if that binding still exists. */
3256 else if (BUFFERP (where
)
3257 ? !NILP (Flocal_variable_p (symbol
, where
))
3258 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3259 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3261 /* If variable has a trivial value (no forwarding), we can
3262 just set it. No need to check for constant symbols here,
3263 since that was already done by specbind. */
3264 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3265 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3266 this_binding
.old_value
);
3268 /* NOTE: we only ever come here if make_local_foo was used for
3269 the first time on this var within this let. */
3270 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3273 if (NILP (Vquit_flag
) && !NILP (quitf
))
3280 DEFUN ("special-variable-p", Fspecial_variable_p
, Sspecial_variable_p
, 1, 1, 0,
3281 doc
: /* Return non-nil if SYMBOL's global binding has been declared special.
3282 A special variable is one that will be bound dynamically, even in a
3283 context where binding is lexical by default. */)
3284 (Lisp_Object symbol
)
3286 CHECK_SYMBOL (symbol
);
3287 return XSYMBOL (symbol
)->declared_special
? Qt
: Qnil
;
3291 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3292 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3293 The debugger is entered when that frame exits, if the flag is non-nil. */)
3294 (Lisp_Object level
, Lisp_Object flag
)
3296 register struct backtrace
*backlist
= backtrace_list
;
3297 register EMACS_INT i
;
3299 CHECK_NUMBER (level
);
3301 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3303 backlist
= backlist
->next
;
3307 backlist
->debug_on_exit
= !NILP (flag
);
3312 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3313 doc
: /* Print a trace of Lisp function calls currently active.
3314 Output stream used is value of `standard-output'. */)
3317 register struct backtrace
*backlist
= backtrace_list
;
3320 struct gcpro gcpro1
;
3321 Lisp_Object old_print_level
= Vprint_level
;
3323 if (NILP (Vprint_level
))
3324 XSETFASTINT (Vprint_level
, 8);
3331 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3332 if (backlist
->nargs
== UNEVALLED
)
3334 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3335 write_string ("\n", -1);
3339 tem
= *backlist
->function
;
3340 Fprin1 (tem
, Qnil
); /* This can QUIT. */
3341 write_string ("(", -1);
3342 if (backlist
->nargs
== MANY
)
3343 { /* FIXME: Can this happen? */
3345 for (tail
= *backlist
->args
, i
= 0;
3347 tail
= Fcdr (tail
), i
= 1)
3349 if (i
) write_string (" ", -1);
3350 Fprin1 (Fcar (tail
), Qnil
);
3356 for (i
= 0; i
< backlist
->nargs
; i
++)
3358 if (i
) write_string (" ", -1);
3359 Fprin1 (backlist
->args
[i
], Qnil
);
3362 write_string (")\n", -1);
3364 backlist
= backlist
->next
;
3367 Vprint_level
= old_print_level
;
3372 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3373 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3374 If that frame has not evaluated the arguments yet (or is a special form),
3375 the value is (nil FUNCTION ARG-FORMS...).
3376 If that frame has evaluated its arguments and called its function already,
3377 the value is (t FUNCTION ARG-VALUES...).
3378 A &rest arg is represented as the tail of the list ARG-VALUES.
3379 FUNCTION is whatever was supplied as car of evaluated list,
3380 or a lambda expression for macro calls.
3381 If NFRAMES is more than the number of frames, the value is nil. */)
3382 (Lisp_Object nframes
)
3384 register struct backtrace
*backlist
= backtrace_list
;
3385 register EMACS_INT i
;
3388 CHECK_NATNUM (nframes
);
3390 /* Find the frame requested. */
3391 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3392 backlist
= backlist
->next
;
3396 if (backlist
->nargs
== UNEVALLED
)
3397 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3400 if (backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3401 tem
= *backlist
->args
;
3403 tem
= Flist (backlist
->nargs
, backlist
->args
);
3405 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3412 mark_backtrace (void)
3414 register struct backtrace
*backlist
;
3417 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3419 mark_object (*backlist
->function
);
3421 if (backlist
->nargs
== UNEVALLED
3422 || backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3425 i
= backlist
->nargs
;
3427 mark_object (backlist
->args
[i
]);
3435 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3436 doc
: /* Limit on number of Lisp variable bindings and `unwind-protect's.
3437 If Lisp code tries to increase the total number past this amount,
3438 an error is signaled.
3439 You can safely use a value considerably larger than the default value,
3440 if that proves inconveniently small. However, if you increase it too far,
3441 Emacs could run out of memory trying to make the stack bigger. */);
3443 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3444 doc
: /* Limit on depth in `eval', `apply' and `funcall' before error.
3446 This limit serves to catch infinite recursions for you before they cause
3447 actual stack overflow in C, which would be fatal for Emacs.
3448 You can safely make it considerably larger than its default value,
3449 if that proves inconveniently small. However, if you increase it too far,
3450 Emacs could overflow the real C stack, and crash. */);
3452 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3453 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3454 If the value is t, that means do an ordinary quit.
3455 If the value equals `throw-on-input', that means quit by throwing
3456 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3457 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3458 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3461 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3462 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3463 Note that `quit-flag' will still be set by typing C-g,
3464 so a quit will be signaled as soon as `inhibit-quit' is nil.
3465 To prevent this happening, set `quit-flag' to nil
3466 before making `inhibit-quit' nil. */);
3467 Vinhibit_quit
= Qnil
;
3469 DEFSYM (Qinhibit_quit
, "inhibit-quit");
3470 DEFSYM (Qautoload
, "autoload");
3471 DEFSYM (Qdebug_on_error
, "debug-on-error");
3472 DEFSYM (Qmacro
, "macro");
3473 DEFSYM (Qdeclare
, "declare");
3475 /* Note that the process handling also uses Qexit, but we don't want
3476 to staticpro it twice, so we just do it here. */
3477 DEFSYM (Qexit
, "exit");
3479 DEFSYM (Qinteractive
, "interactive");
3480 DEFSYM (Qcommandp
, "commandp");
3481 DEFSYM (Qand_rest
, "&rest");
3482 DEFSYM (Qand_optional
, "&optional");
3483 DEFSYM (Qclosure
, "closure");
3484 DEFSYM (Qdebug
, "debug");
3486 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3487 doc
: /* Non-nil means enter debugger if an error is signaled.
3488 Does not apply to errors handled by `condition-case' or those
3489 matched by `debug-ignored-errors'.
3490 If the value is a list, an error only means to enter the debugger
3491 if one of its condition symbols appears in the list.
3492 When you evaluate an expression interactively, this variable
3493 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3494 The command `toggle-debug-on-error' toggles this.
3495 See also the variable `debug-on-quit'. */);
3496 Vdebug_on_error
= Qnil
;
3498 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3499 doc
: /* List of errors for which the debugger should not be called.
3500 Each element may be a condition-name or a regexp that matches error messages.
3501 If any element applies to a given error, that error skips the debugger
3502 and just returns to top level.
3503 This overrides the variable `debug-on-error'.
3504 It does not apply to errors handled by `condition-case'. */);
3505 Vdebug_ignored_errors
= Qnil
;
3507 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3508 doc
: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
3509 Does not apply if quit is handled by a `condition-case'. */);
3512 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3513 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3515 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3516 doc
: /* Non-nil means debugger may continue execution.
3517 This is nil when the debugger is called under circumstances where it
3518 might not be safe to continue. */);
3519 debugger_may_continue
= 1;
3521 DEFVAR_LISP ("debugger", Vdebugger
,
3522 doc
: /* Function to call to invoke debugger.
3523 If due to frame exit, args are `exit' and the value being returned;
3524 this function's value will be returned instead of that.
3525 If due to error, args are `error' and a list of the args to `signal'.
3526 If due to `apply' or `funcall' entry, one arg, `lambda'.
3527 If due to `eval' entry, one arg, t. */);
3530 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3531 doc
: /* If non-nil, this is a function for `signal' to call.
3532 It receives the same arguments that `signal' was given.
3533 The Edebug package uses this to regain control. */);
3534 Vsignal_hook_function
= Qnil
;
3536 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3537 doc
: /* Non-nil means call the debugger regardless of condition handlers.
3538 Note that `debug-on-error', `debug-on-quit' and friends
3539 still determine whether to handle the particular condition. */);
3540 Vdebug_on_signal
= Qnil
;
3542 /* When lexical binding is being used,
3543 Vinternal_interpreter_environment is non-nil, and contains an alist
3544 of lexically-bound variable, or (t), indicating an empty
3545 environment. The lisp name of this variable would be
3546 `internal-interpreter-environment' if it weren't hidden.
3547 Every element of this list can be either a cons (VAR . VAL)
3548 specifying a lexical binding, or a single symbol VAR indicating
3549 that this variable should use dynamic scoping. */
3550 DEFSYM (Qinternal_interpreter_environment
,
3551 "internal-interpreter-environment");
3552 DEFVAR_LISP ("internal-interpreter-environment",
3553 Vinternal_interpreter_environment
,
3554 doc
: /* If non-nil, the current lexical environment of the lisp interpreter.
3555 When lexical binding is not being used, this variable is nil.
3556 A value of `(t)' indicates an empty environment, otherwise it is an
3557 alist of active lexical bindings. */);
3558 Vinternal_interpreter_environment
= Qnil
;
3559 /* Don't export this variable to Elisp, so no one can mess with it
3560 (Just imagine if someone makes it buffer-local). */
3561 Funintern (Qinternal_interpreter_environment
, Qnil
);
3563 DEFSYM (Vrun_hooks
, "run-hooks");
3565 staticpro (&Vautoload_queue
);
3566 Vautoload_queue
= Qnil
;
3567 staticpro (&Vsignaling_function
);
3568 Vsignaling_function
= Qnil
;
3570 inhibit_lisp_code
= Qnil
;
3581 defsubr (&Sfunction
);
3583 defsubr (&Sdefvaralias
);
3584 defsubr (&Sdefconst
);
3588 defsubr (&Smacroexpand
);
3591 defsubr (&Sunwind_protect
);
3592 defsubr (&Scondition_case
);
3594 defsubr (&Sinteractive_p
);
3595 defsubr (&Scalled_interactively_p
);
3596 defsubr (&Scommandp
);
3597 defsubr (&Sautoload
);
3600 defsubr (&Sfuncall
);
3601 defsubr (&Srun_hooks
);
3602 defsubr (&Srun_hook_with_args
);
3603 defsubr (&Srun_hook_with_args_until_success
);
3604 defsubr (&Srun_hook_with_args_until_failure
);
3605 defsubr (&Srun_hook_wrapped
);
3606 defsubr (&Sfetch_bytecode
);
3607 defsubr (&Sbacktrace_debug
);
3608 defsubr (&Sbacktrace
);
3609 defsubr (&Sbacktrace_frame
);
3610 defsubr (&Sspecial_variable_p
);
3611 defsubr (&Sfunctionp
);