1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #include "blockinput.h"
28 #include "dispextern.h"
29 #include "frame.h" /* For XFRAME. */
37 struct backtrace
*next
;
38 Lisp_Object
*function
;
39 Lisp_Object
*args
; /* Points to vector of args. */
40 ptrdiff_t nargs
; /* Length of vector. */
41 /* Nonzero means call value of debugger when done with this operation. */
42 unsigned int debug_on_exit
: 1;
45 static struct backtrace
*backtrace_list
;
50 struct catchtag
*catchlist
;
52 /* Chain of condition handlers currently in effect.
53 The elements of this chain are contained in the stack frames
54 of Fcondition_case and internal_condition_case.
55 When an error is signaled (by calling Fsignal, below),
56 this chain is searched for an element that applies. */
61 struct handler
*handlerlist
;
64 /* Count levels of GCPRO to detect failure to UNGCPRO. */
68 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
;
69 Lisp_Object Qinhibit_quit
;
70 Lisp_Object Qand_rest
;
71 static Lisp_Object Qand_optional
;
72 static Lisp_Object Qdebug_on_error
;
73 static Lisp_Object Qdeclare
;
74 Lisp_Object Qinternal_interpreter_environment
, Qclosure
;
76 static Lisp_Object Qdebug
;
78 /* This holds either the symbol `run-hooks' or nil.
79 It is nil at an early stage of startup, and when Emacs
82 Lisp_Object Vrun_hooks
;
84 /* Non-nil means record all fset's and provide's, to be undone
85 if the file being autoloaded is not fully loaded.
86 They are recorded by being consed onto the front of Vautoload_queue:
87 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
89 Lisp_Object Vautoload_queue
;
91 /* Current number of specbindings allocated in specpdl. */
93 ptrdiff_t specpdl_size
;
95 /* Pointer to beginning of specpdl. */
97 struct specbinding
*specpdl
;
99 /* Pointer to first unused element in specpdl. */
101 struct specbinding
*specpdl_ptr
;
103 /* Depth in Lisp evaluations and function calls. */
105 static EMACS_INT lisp_eval_depth
;
107 /* The value of num_nonmacro_input_events as of the last time we
108 started to enter the debugger. If we decide to enter the debugger
109 again when this is still equal to num_nonmacro_input_events, then we
110 know that the debugger itself has an error, and we should just
111 signal the error instead of entering an infinite loop of debugger
114 static EMACS_INT when_entered_debugger
;
116 /* The function from which the last `signal' was called. Set in
119 Lisp_Object Vsignaling_function
;
121 /* Set to non-zero while processing X events. Checked in Feval to
122 make sure the Lisp interpreter isn't called from a signal handler,
123 which is unsafe because the interpreter isn't reentrant. */
127 /* If non-nil, Lisp code must not be run since some part of Emacs is
128 in an inconsistent state. Currently, x-create-frame uses this to
129 avoid triggering window-configuration-change-hook while the new
130 frame is half-initialized. */
131 Lisp_Object inhibit_lisp_code
;
133 static Lisp_Object
funcall_lambda (Lisp_Object
, ptrdiff_t, Lisp_Object
*);
134 static int interactive_p (int);
135 static Lisp_Object
apply_lambda (Lisp_Object fun
, Lisp_Object args
);
138 init_eval_once (void)
141 specpdl
= xmalloc (size
* sizeof *specpdl
);
143 specpdl_ptr
= specpdl
;
144 /* Don't forget to update docs (lispref node "Local Variables"). */
145 max_specpdl_size
= 1300; /* 1000 is not enough for CEDET's c-by.el. */
146 max_lisp_eval_depth
= 600;
154 specpdl_ptr
= specpdl
;
159 debug_on_next_call
= 0;
164 /* This is less than the initial value of num_nonmacro_input_events. */
165 when_entered_debugger
= -1;
168 /* Unwind-protect function used by call_debugger. */
171 restore_stack_limits (Lisp_Object data
)
173 max_specpdl_size
= XINT (XCAR (data
));
174 max_lisp_eval_depth
= XINT (XCDR (data
));
178 /* Call the Lisp debugger, giving it argument ARG. */
181 call_debugger (Lisp_Object arg
)
183 int debug_while_redisplaying
;
184 ptrdiff_t count
= SPECPDL_INDEX ();
186 EMACS_INT old_max
= max_specpdl_size
;
188 /* Temporarily bump up the stack limits,
189 so the debugger won't run out of stack. */
191 max_specpdl_size
+= 1;
192 record_unwind_protect (restore_stack_limits
,
193 Fcons (make_number (old_max
),
194 make_number (max_lisp_eval_depth
)));
195 max_specpdl_size
= old_max
;
197 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
198 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
200 if (max_specpdl_size
- 100 < SPECPDL_INDEX ())
201 max_specpdl_size
= SPECPDL_INDEX () + 100;
203 #ifdef HAVE_WINDOW_SYSTEM
204 if (display_hourglass_p
)
208 debug_on_next_call
= 0;
209 when_entered_debugger
= num_nonmacro_input_events
;
211 /* Resetting redisplaying_p to 0 makes sure that debug output is
212 displayed if the debugger is invoked during redisplay. */
213 debug_while_redisplaying
= redisplaying_p
;
215 specbind (intern ("debugger-may-continue"),
216 debug_while_redisplaying
? Qnil
: Qt
);
217 specbind (Qinhibit_redisplay
, Qnil
);
218 specbind (Qdebug_on_error
, Qnil
);
220 #if 0 /* Binding this prevents execution of Lisp code during
221 redisplay, which necessarily leads to display problems. */
222 specbind (Qinhibit_eval_during_redisplay
, Qt
);
225 val
= apply1 (Vdebugger
, arg
);
227 /* Interrupting redisplay and resuming it later is not safe under
228 all circumstances. So, when the debugger returns, abort the
229 interrupted redisplay by going back to the top-level. */
230 if (debug_while_redisplaying
)
233 return unbind_to (count
, val
);
237 do_debug_on_call (Lisp_Object code
)
239 debug_on_next_call
= 0;
240 backtrace_list
->debug_on_exit
= 1;
241 call_debugger (Fcons (code
, Qnil
));
244 /* NOTE!!! Every function that can call EVAL must protect its args
245 and temporaries from garbage collection while it needs them.
246 The definition of `For' shows what you have to do. */
248 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
249 doc
: /* Eval args until one of them yields non-nil, then return that value.
250 The remaining args are not evalled at all.
251 If all args return nil, return nil.
252 usage: (or CONDITIONS...) */)
255 register Lisp_Object val
= Qnil
;
262 val
= eval_sub (XCAR (args
));
272 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
273 doc
: /* Eval args until one of them yields nil, then return nil.
274 The remaining args are not evalled at all.
275 If no arg yields nil, return the last arg's value.
276 usage: (and CONDITIONS...) */)
279 register Lisp_Object val
= Qt
;
286 val
= eval_sub (XCAR (args
));
296 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
297 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
298 Returns the value of THEN or the value of the last of the ELSE's.
299 THEN must be one expression, but ELSE... can be zero or more expressions.
300 If COND yields nil, and there are no ELSE's, the value is nil.
301 usage: (if COND THEN ELSE...) */)
304 register Lisp_Object cond
;
308 cond
= eval_sub (Fcar (args
));
312 return eval_sub (Fcar (Fcdr (args
)));
313 return Fprogn (Fcdr (Fcdr (args
)));
316 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
317 doc
: /* Try each clause until one succeeds.
318 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
319 and, if the value is non-nil, this clause succeeds:
320 then the expressions in BODY are evaluated and the last one's
321 value is the value of the cond-form.
322 If no clause succeeds, cond returns nil.
323 If a clause has one element, as in (CONDITION),
324 CONDITION's value if non-nil is returned from the cond-form.
325 usage: (cond CLAUSES...) */)
328 register Lisp_Object clause
, val
;
335 clause
= Fcar (args
);
336 val
= eval_sub (Fcar (clause
));
339 if (!EQ (XCDR (clause
), Qnil
))
340 val
= Fprogn (XCDR (clause
));
350 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
351 doc
: /* Eval BODY forms sequentially and return value of last one.
352 usage: (progn BODY...) */)
355 register Lisp_Object val
= Qnil
;
362 val
= eval_sub (XCAR (args
));
370 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
371 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
372 The value of FIRST is saved during the evaluation of the remaining args,
373 whose values are discarded.
374 usage: (prog1 FIRST BODY...) */)
378 register Lisp_Object args_left
;
379 struct gcpro gcpro1
, gcpro2
;
385 val
= eval_sub (XCAR (args_left
));
386 while (CONSP (args_left
= XCDR (args_left
)))
387 eval_sub (XCAR (args_left
));
393 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
394 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
395 The value of FORM2 is saved during the evaluation of the
396 remaining args, whose values are discarded.
397 usage: (prog2 FORM1 FORM2 BODY...) */)
403 eval_sub (XCAR (args
));
405 return Fprog1 (XCDR (args
));
408 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
409 doc
: /* Set each SYM to the value of its VAL.
410 The symbols SYM are variables; they are literal (not evaluated).
411 The values VAL are expressions; they are evaluated.
412 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
413 The second VAL is not computed until after the first SYM is set, and so on;
414 each VAL can use the new value of variables set earlier in the `setq'.
415 The return value of the `setq' form is the value of the last VAL.
416 usage: (setq [SYM VAL]...) */)
419 register Lisp_Object args_left
;
420 register Lisp_Object val
, sym
, lex_binding
;
431 val
= eval_sub (Fcar (Fcdr (args_left
)));
432 sym
= Fcar (args_left
);
434 /* Like for eval_sub, we do not check declared_special here since
435 it's been done when let-binding. */
436 if (!NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
438 && !NILP (lex_binding
439 = Fassq (sym
, Vinternal_interpreter_environment
)))
440 XSETCDR (lex_binding
, val
); /* SYM is lexically bound. */
442 Fset (sym
, val
); /* SYM is dynamically bound. */
444 args_left
= Fcdr (Fcdr (args_left
));
446 while (!NILP (args_left
));
452 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
453 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
454 Warning: `quote' does not construct its return value, but just returns
455 the value that was pre-constructed by the Lisp reader (see info node
456 `(elisp)Printed Representation').
457 This means that '(a . b) is not identical to (cons 'a 'b): the former
458 does not cons. Quoting should be reserved for constants that will
459 never be modified by side-effects, unless you like self-modifying code.
460 See the common pitfall in info node `(elisp)Rearrangement' for an example
461 of unexpected results when a quoted object is modified.
462 usage: (quote ARG) */)
465 if (!NILP (Fcdr (args
)))
466 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
470 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
471 doc
: /* Like `quote', but preferred for objects which are functions.
472 In byte compilation, `function' causes its argument to be compiled.
473 `quote' cannot do that.
474 usage: (function ARG) */)
477 Lisp_Object quoted
= XCAR (args
);
479 if (!NILP (Fcdr (args
)))
480 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
482 if (!NILP (Vinternal_interpreter_environment
)
484 && EQ (XCAR (quoted
), Qlambda
))
485 /* This is a lambda expression within a lexical environment;
486 return an interpreted closure instead of a simple lambda. */
487 return Fcons (Qclosure
, Fcons (Vinternal_interpreter_environment
,
490 /* Simply quote the argument. */
495 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
496 doc
: /* Return t if the containing function was run directly by user input.
497 This means that the function was called with `call-interactively'
498 \(which includes being called as the binding of a key)
499 and input is currently coming from the keyboard (not a keyboard macro),
500 and Emacs is not running in batch mode (`noninteractive' is nil).
502 The only known proper use of `interactive-p' is in deciding whether to
503 display a helpful message, or how to display it. If you're thinking
504 of using it for any other purpose, it is quite likely that you're
505 making a mistake. Think: what do you want to do when the command is
506 called from a keyboard macro?
508 To test whether your function was called with `call-interactively',
509 either (i) add an extra optional argument and give it an `interactive'
510 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
511 use `called-interactively-p'. */)
514 return interactive_p (1) ? Qt
: Qnil
;
518 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
519 doc
: /* Return t if the containing function was called by `call-interactively'.
520 If KIND is `interactive', then only return t if the call was made
521 interactively by the user, i.e. not in `noninteractive' mode nor
522 when `executing-kbd-macro'.
523 If KIND is `any', on the other hand, it will return t for any kind of
524 interactive call, including being called as the binding of a key, or
525 from a keyboard macro, or in `noninteractive' mode.
527 The only known proper use of `interactive' for KIND is in deciding
528 whether to display a helpful message, or how to display it. If you're
529 thinking of using it for any other purpose, it is quite likely that
530 you're making a mistake. Think: what do you want to do when the
531 command is called from a keyboard macro?
533 This function is meant for implementing advice and other
534 function-modifying features. Instead of using this, it is sometimes
535 cleaner to give your function an extra optional argument whose
536 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
537 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
540 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
541 && interactive_p (1)) ? Qt
: Qnil
;
545 /* Return 1 if function in which this appears was called using
548 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
549 called is a built-in. */
552 interactive_p (int exclude_subrs_p
)
554 struct backtrace
*btp
;
557 btp
= backtrace_list
;
559 /* If this isn't a byte-compiled function, there may be a frame at
560 the top for Finteractive_p. If so, skip it. */
561 fun
= Findirect_function (*btp
->function
, Qnil
);
562 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
563 || XSUBR (fun
) == &Scalled_interactively_p
))
566 /* If we're running an Emacs 18-style byte-compiled function, there
567 may be a frame for Fbytecode at the top level. In any version of
568 Emacs there can be Fbytecode frames for subexpressions evaluated
569 inside catch and condition-case. Skip past them.
571 If this isn't a byte-compiled function, then we may now be
572 looking at several frames for special forms. Skip past them. */
574 && (EQ (*btp
->function
, Qbytecode
)
575 || btp
->nargs
== UNEVALLED
))
578 /* `btp' now points at the frame of the innermost function that isn't
579 a special form, ignoring frames for Finteractive_p and/or
580 Fbytecode at the top. If this frame is for a built-in function
581 (such as load or eval-region) return nil. */
582 fun
= Findirect_function (*btp
->function
, Qnil
);
583 if (exclude_subrs_p
&& SUBRP (fun
))
586 /* `btp' points to the frame of a Lisp function that called interactive-p.
587 Return t if that function was called interactively. */
588 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
594 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
595 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
596 Aliased variables always have the same value; setting one sets the other.
597 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
598 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
599 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
600 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
601 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
602 The return value is BASE-VARIABLE. */)
603 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
605 struct Lisp_Symbol
*sym
;
607 CHECK_SYMBOL (new_alias
);
608 CHECK_SYMBOL (base_variable
);
610 sym
= XSYMBOL (new_alias
);
613 /* Not sure why, but why not? */
614 error ("Cannot make a constant an alias");
616 switch (sym
->redirect
)
618 case SYMBOL_FORWARDED
:
619 error ("Cannot make an internal variable an alias");
620 case SYMBOL_LOCALIZED
:
621 error ("Don't know how to make a localized variable an alias");
624 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
625 If n_a is bound, but b_v is not, set the value of b_v to n_a,
626 so that old-code that affects n_a before the aliasing is setup
628 if (NILP (Fboundp (base_variable
)))
629 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
632 struct specbinding
*p
;
634 for (p
= specpdl_ptr
; p
> specpdl
; )
635 if ((--p
)->func
== NULL
637 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
638 error ("Don't know how to make a let-bound variable an alias");
641 sym
->declared_special
= 1;
642 XSYMBOL (base_variable
)->declared_special
= 1;
643 sym
->redirect
= SYMBOL_VARALIAS
;
644 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
645 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
646 LOADHIST_ATTACH (new_alias
);
647 /* Even if docstring is nil: remove old docstring. */
648 Fput (new_alias
, Qvariable_documentation
, docstring
);
650 return base_variable
;
654 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
655 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
656 You are not required to define a variable in order to use it, but
657 defining it lets you supply an initial value and documentation, which
658 can be referred to by the Emacs help facilities and other programming
659 tools. The `defvar' form also declares the variable as \"special\",
660 so that it is always dynamically bound even if `lexical-binding' is t.
662 The optional argument INITVALUE is evaluated, and used to set SYMBOL,
663 only if SYMBOL's value is void. If SYMBOL is buffer-local, its
664 default value is what is set; buffer-local values are not affected.
665 If INITVALUE is missing, SYMBOL's value is not set.
667 If SYMBOL has a local binding, then this form affects the local
668 binding. This is usually not what you want. Thus, if you need to
669 load a file defining variables, with this form or with `defconst' or
670 `defcustom', you should always load that file _outside_ any bindings
671 for these variables. \(`defconst' and `defcustom' behave similarly in
674 The optional argument DOCSTRING is a documentation string for the
677 To define a user option, use `defcustom' instead of `defvar'.
678 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
681 register Lisp_Object sym
, tem
, tail
;
685 if (!NILP (Fcdr (Fcdr (tail
))))
686 error ("Too many arguments");
688 tem
= Fdefault_boundp (sym
);
691 /* Do it before evaluating the initial value, for self-references. */
692 XSYMBOL (sym
)->declared_special
= 1;
694 if (SYMBOL_CONSTANT_P (sym
))
696 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
697 Lisp_Object tem1
= Fcar (tail
);
699 && EQ (XCAR (tem1
), Qquote
)
700 && CONSP (XCDR (tem1
))
701 && EQ (XCAR (XCDR (tem1
)), sym
)))
702 error ("Constant symbol `%s' specified in defvar",
703 SDATA (SYMBOL_NAME (sym
)));
707 Fset_default (sym
, eval_sub (Fcar (tail
)));
709 { /* Check if there is really a global binding rather than just a let
710 binding that shadows the global unboundness of the var. */
711 volatile struct specbinding
*pdl
= specpdl_ptr
;
712 while (pdl
> specpdl
)
714 if (EQ ((--pdl
)->symbol
, sym
) && !pdl
->func
715 && EQ (pdl
->old_value
, Qunbound
))
717 message_with_string ("Warning: defvar ignored because %s is let-bound",
718 SYMBOL_NAME (sym
), 1);
727 if (!NILP (Vpurify_flag
))
728 tem
= Fpurecopy (tem
);
729 Fput (sym
, Qvariable_documentation
, tem
);
731 LOADHIST_ATTACH (sym
);
733 else if (!NILP (Vinternal_interpreter_environment
)
734 && !XSYMBOL (sym
)->declared_special
)
735 /* A simple (defvar foo) with lexical scoping does "nothing" except
736 declare that var to be dynamically scoped *locally* (i.e. within
737 the current file or let-block). */
738 Vinternal_interpreter_environment
=
739 Fcons (sym
, Vinternal_interpreter_environment
);
742 /* Simple (defvar <var>) should not count as a definition at all.
743 It could get in the way of other definitions, and unloading this
744 package could try to make the variable unbound. */
750 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
751 doc
: /* Define SYMBOL as a constant variable.
752 This declares that neither programs nor users should ever change the
753 value. This constancy is not actually enforced by Emacs Lisp, but
754 SYMBOL is marked as a special variable so that it is never lexically
757 The `defconst' form always sets the value of SYMBOL to the result of
758 evalling INITVALUE. If SYMBOL is buffer-local, its default value is
759 what is set; buffer-local values are not affected. If SYMBOL has a
760 local binding, then this form sets the local binding's value.
761 However, you should normally not make local bindings for variables
762 defined with this form.
764 The optional DOCSTRING specifies the variable's documentation string.
765 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
768 register Lisp_Object sym
, tem
;
771 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
772 error ("Too many arguments");
774 tem
= eval_sub (Fcar (Fcdr (args
)));
775 if (!NILP (Vpurify_flag
))
776 tem
= Fpurecopy (tem
);
777 Fset_default (sym
, tem
);
778 XSYMBOL (sym
)->declared_special
= 1;
779 tem
= Fcar (Fcdr (Fcdr (args
)));
782 if (!NILP (Vpurify_flag
))
783 tem
= Fpurecopy (tem
);
784 Fput (sym
, Qvariable_documentation
, tem
);
786 Fput (sym
, Qrisky_local_variable
, Qt
);
787 LOADHIST_ATTACH (sym
);
791 /* Make SYMBOL lexically scoped. */
792 DEFUN ("internal-make-var-non-special", Fmake_var_non_special
,
793 Smake_var_non_special
, 1, 1, 0,
794 doc
: /* Internal function. */)
797 CHECK_SYMBOL (symbol
);
798 XSYMBOL (symbol
)->declared_special
= 0;
803 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
804 doc
: /* Bind variables according to VARLIST then eval BODY.
805 The value of the last form in BODY is returned.
806 Each element of VARLIST is a symbol (which is bound to nil)
807 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
808 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
809 usage: (let* VARLIST BODY...) */)
812 Lisp_Object varlist
, var
, val
, elt
, lexenv
;
813 ptrdiff_t count
= SPECPDL_INDEX ();
814 struct gcpro gcpro1
, gcpro2
, gcpro3
;
816 GCPRO3 (args
, elt
, varlist
);
818 lexenv
= Vinternal_interpreter_environment
;
820 varlist
= Fcar (args
);
821 while (CONSP (varlist
))
825 elt
= XCAR (varlist
);
831 else if (! NILP (Fcdr (Fcdr (elt
))))
832 signal_error ("`let' bindings can have only one value-form", elt
);
836 val
= eval_sub (Fcar (Fcdr (elt
)));
839 if (!NILP (lexenv
) && SYMBOLP (var
)
840 && !XSYMBOL (var
)->declared_special
841 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
842 /* Lexically bind VAR by adding it to the interpreter's binding
846 = Fcons (Fcons (var
, val
), Vinternal_interpreter_environment
);
847 if (EQ (Vinternal_interpreter_environment
, lexenv
))
848 /* Save the old lexical environment on the specpdl stack,
849 but only for the first lexical binding, since we'll never
850 need to revert to one of the intermediate ones. */
851 specbind (Qinternal_interpreter_environment
, newenv
);
853 Vinternal_interpreter_environment
= newenv
;
858 varlist
= XCDR (varlist
);
861 val
= Fprogn (Fcdr (args
));
862 return unbind_to (count
, val
);
865 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
866 doc
: /* Bind variables according to VARLIST then eval BODY.
867 The value of the last form in BODY is returned.
868 Each element of VARLIST is a symbol (which is bound to nil)
869 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
870 All the VALUEFORMs are evalled before any symbols are bound.
871 usage: (let VARLIST BODY...) */)
874 Lisp_Object
*temps
, tem
, lexenv
;
875 register Lisp_Object elt
, varlist
;
876 ptrdiff_t count
= SPECPDL_INDEX ();
878 struct gcpro gcpro1
, gcpro2
;
881 varlist
= Fcar (args
);
883 /* Make space to hold the values to give the bound variables. */
884 elt
= Flength (varlist
);
885 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
887 /* Compute the values and store them in `temps'. */
889 GCPRO2 (args
, *temps
);
892 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
895 elt
= XCAR (varlist
);
897 temps
[argnum
++] = Qnil
;
898 else if (! NILP (Fcdr (Fcdr (elt
))))
899 signal_error ("`let' bindings can have only one value-form", elt
);
901 temps
[argnum
++] = eval_sub (Fcar (Fcdr (elt
)));
902 gcpro2
.nvars
= argnum
;
906 lexenv
= Vinternal_interpreter_environment
;
908 varlist
= Fcar (args
);
909 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
913 elt
= XCAR (varlist
);
914 var
= SYMBOLP (elt
) ? elt
: Fcar (elt
);
915 tem
= temps
[argnum
++];
917 if (!NILP (lexenv
) && SYMBOLP (var
)
918 && !XSYMBOL (var
)->declared_special
919 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
920 /* Lexically bind VAR by adding it to the lexenv alist. */
921 lexenv
= Fcons (Fcons (var
, tem
), lexenv
);
923 /* Dynamically bind VAR. */
927 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
928 /* Instantiate a new lexical environment. */
929 specbind (Qinternal_interpreter_environment
, lexenv
);
931 elt
= Fprogn (Fcdr (args
));
933 return unbind_to (count
, elt
);
936 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
937 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
938 The order of execution is thus TEST, BODY, TEST, BODY and so on
939 until TEST returns nil.
940 usage: (while TEST BODY...) */)
943 Lisp_Object test
, body
;
944 struct gcpro gcpro1
, gcpro2
;
950 while (!NILP (eval_sub (test
)))
960 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
961 doc
: /* Return result of expanding macros at top level of FORM.
962 If FORM is not a macro call, it is returned unchanged.
963 Otherwise, the macro is expanded and the expansion is considered
964 in place of FORM. When a non-macro-call results, it is returned.
966 The second optional arg ENVIRONMENT specifies an environment of macro
967 definitions to shadow the loaded ones for use in file byte-compilation. */)
968 (Lisp_Object form
, Lisp_Object environment
)
970 /* With cleanups from Hallvard Furuseth. */
971 register Lisp_Object expander
, sym
, def
, tem
;
975 /* Come back here each time we expand a macro call,
976 in case it expands into another macro call. */
979 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
980 def
= sym
= XCAR (form
);
982 /* Trace symbols aliases to other symbols
983 until we get a symbol that is not an alias. */
984 while (SYMBOLP (def
))
988 tem
= Fassq (sym
, environment
);
991 def
= XSYMBOL (sym
)->function
;
992 if (!EQ (def
, Qunbound
))
997 /* Right now TEM is the result from SYM in ENVIRONMENT,
998 and if TEM is nil then DEF is SYM's function definition. */
1001 /* SYM is not mentioned in ENVIRONMENT.
1002 Look at its function definition. */
1003 if (EQ (def
, Qunbound
) || !CONSP (def
))
1004 /* Not defined or definition not suitable. */
1006 if (EQ (XCAR (def
), Qautoload
))
1008 /* Autoloading function: will it be a macro when loaded? */
1009 tem
= Fnth (make_number (4), def
);
1010 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1011 /* Yes, load it and try again. */
1013 struct gcpro gcpro1
;
1015 do_autoload (def
, sym
);
1022 else if (!EQ (XCAR (def
), Qmacro
))
1024 else expander
= XCDR (def
);
1028 expander
= XCDR (tem
);
1029 if (NILP (expander
))
1033 Lisp_Object newform
= apply1 (expander
, XCDR (form
));
1034 if (EQ (form
, newform
))
1043 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1044 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1045 TAG is evalled to get the tag to use; it must not be nil.
1047 Then the BODY is executed.
1048 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1049 If no throw happens, `catch' returns the value of the last BODY form.
1050 If a throw happens, it specifies the value to return from `catch'.
1051 usage: (catch TAG BODY...) */)
1054 register Lisp_Object tag
;
1055 struct gcpro gcpro1
;
1058 tag
= eval_sub (Fcar (args
));
1060 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1063 /* Set up a catch, then call C function FUNC on argument ARG.
1064 FUNC should return a Lisp_Object.
1065 This is how catches are done from within C code. */
1068 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1070 /* This structure is made part of the chain `catchlist'. */
1073 /* Fill in the components of c, and put it on the list. */
1077 c
.backlist
= backtrace_list
;
1078 c
.handlerlist
= handlerlist
;
1079 c
.lisp_eval_depth
= lisp_eval_depth
;
1080 c
.pdlcount
= SPECPDL_INDEX ();
1081 c
.poll_suppress_count
= poll_suppress_count
;
1082 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1083 c
.gcpro
= gcprolist
;
1084 c
.byte_stack
= byte_stack_list
;
1088 if (! _setjmp (c
.jmp
))
1089 c
.val
= (*func
) (arg
);
1091 /* Throw works by a longjmp that comes right here. */
1096 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1097 jump to that CATCH, returning VALUE as the value of that catch.
1099 This is the guts Fthrow and Fsignal; they differ only in the way
1100 they choose the catch tag to throw to. A catch tag for a
1101 condition-case form has a TAG of Qnil.
1103 Before each catch is discarded, unbind all special bindings and
1104 execute all unwind-protect clauses made above that catch. Unwind
1105 the handler stack as we go, so that the proper handlers are in
1106 effect for each unwind-protect clause we run. At the end, restore
1107 some static info saved in CATCH, and longjmp to the location
1110 This is used for correct unwinding in Fthrow and Fsignal. */
1112 static _Noreturn
void
1113 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1117 /* Save the value in the tag. */
1120 /* Restore certain special C variables. */
1121 set_poll_suppress_count (catch->poll_suppress_count
);
1122 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1123 handling_signal
= 0;
1128 last_time
= catchlist
== catch;
1130 /* Unwind the specpdl stack, and then restore the proper set of
1132 unbind_to (catchlist
->pdlcount
, Qnil
);
1133 handlerlist
= catchlist
->handlerlist
;
1134 catchlist
= catchlist
->next
;
1136 while (! last_time
);
1139 /* If x_catch_errors was done, turn it off now.
1140 (First we give unbind_to a chance to do that.) */
1141 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1142 The catch must remain in effect during that delicate
1143 state. --lorentey */
1144 x_fully_uncatch_errors ();
1148 byte_stack_list
= catch->byte_stack
;
1149 gcprolist
= catch->gcpro
;
1151 gcpro_level
= gcprolist
? gcprolist
->level
+ 1 : 0;
1153 backtrace_list
= catch->backlist
;
1154 lisp_eval_depth
= catch->lisp_eval_depth
;
1156 _longjmp (catch->jmp
, 1);
1159 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1160 doc
: /* Throw to the catch for TAG and return VALUE from it.
1161 Both TAG and VALUE are evalled. */)
1162 (register Lisp_Object tag
, Lisp_Object value
)
1164 register struct catchtag
*c
;
1167 for (c
= catchlist
; c
; c
= c
->next
)
1169 if (EQ (c
->tag
, tag
))
1170 unwind_to_catch (c
, value
);
1172 xsignal2 (Qno_catch
, tag
, value
);
1176 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1177 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1178 If BODYFORM completes normally, its value is returned
1179 after executing the UNWINDFORMS.
1180 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1181 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1185 ptrdiff_t count
= SPECPDL_INDEX ();
1187 record_unwind_protect (Fprogn
, Fcdr (args
));
1188 val
= eval_sub (Fcar (args
));
1189 return unbind_to (count
, val
);
1192 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1193 doc
: /* Regain control when an error is signaled.
1194 Executes BODYFORM and returns its value if no error happens.
1195 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1196 where the BODY is made of Lisp expressions.
1198 A handler is applicable to an error
1199 if CONDITION-NAME is one of the error's condition names.
1200 If an error happens, the first applicable handler is run.
1202 The car of a handler may be a list of condition names instead of a
1203 single condition name; then it handles all of them. If the special
1204 condition name `debug' is present in this list, it allows another
1205 condition in the list to run the debugger if `debug-on-error' and the
1206 other usual mechanisms says it should (otherwise, `condition-case'
1207 suppresses the debugger).
1209 When a handler handles an error, control returns to the `condition-case'
1210 and it executes the handler's BODY...
1211 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1212 \(If VAR is nil, the handler can't access that information.)
1213 Then the value of the last BODY form is returned from the `condition-case'
1216 See also the function `signal' for more info.
1217 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1220 register Lisp_Object bodyform
, handlers
;
1221 volatile Lisp_Object var
;
1224 bodyform
= Fcar (Fcdr (args
));
1225 handlers
= Fcdr (Fcdr (args
));
1227 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1230 /* Like Fcondition_case, but the args are separate
1231 rather than passed in a list. Used by Fbyte_code. */
1234 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1235 Lisp_Object handlers
)
1243 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1249 && (SYMBOLP (XCAR (tem
))
1250 || CONSP (XCAR (tem
))))))
1251 error ("Invalid condition handler: %s",
1252 SDATA (Fprin1_to_string (tem
, Qt
)));
1257 c
.backlist
= backtrace_list
;
1258 c
.handlerlist
= handlerlist
;
1259 c
.lisp_eval_depth
= lisp_eval_depth
;
1260 c
.pdlcount
= SPECPDL_INDEX ();
1261 c
.poll_suppress_count
= poll_suppress_count
;
1262 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1263 c
.gcpro
= gcprolist
;
1264 c
.byte_stack
= byte_stack_list
;
1265 if (_setjmp (c
.jmp
))
1268 specbind (h
.var
, c
.val
);
1269 val
= Fprogn (Fcdr (h
.chosen_clause
));
1271 /* Note that this just undoes the binding of h.var; whoever
1272 longjumped to us unwound the stack to c.pdlcount before
1274 unbind_to (c
.pdlcount
, Qnil
);
1281 h
.handler
= handlers
;
1282 h
.next
= handlerlist
;
1286 val
= eval_sub (bodyform
);
1288 handlerlist
= h
.next
;
1292 /* Call the function BFUN with no arguments, catching errors within it
1293 according to HANDLERS. If there is an error, call HFUN with
1294 one argument which is the data that describes the error:
1297 HANDLERS can be a list of conditions to catch.
1298 If HANDLERS is Qt, catch all errors.
1299 If HANDLERS is Qerror, catch all errors
1300 but allow the debugger to run if that is enabled. */
1303 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1304 Lisp_Object (*hfun
) (Lisp_Object
))
1312 c
.backlist
= backtrace_list
;
1313 c
.handlerlist
= handlerlist
;
1314 c
.lisp_eval_depth
= lisp_eval_depth
;
1315 c
.pdlcount
= SPECPDL_INDEX ();
1316 c
.poll_suppress_count
= poll_suppress_count
;
1317 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1318 c
.gcpro
= gcprolist
;
1319 c
.byte_stack
= byte_stack_list
;
1320 if (_setjmp (c
.jmp
))
1322 return (*hfun
) (c
.val
);
1326 h
.handler
= handlers
;
1328 h
.next
= handlerlist
;
1334 handlerlist
= h
.next
;
1338 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1341 internal_condition_case_1 (Lisp_Object (*bfun
) (Lisp_Object
), Lisp_Object arg
,
1342 Lisp_Object handlers
, Lisp_Object (*hfun
) (Lisp_Object
))
1350 c
.backlist
= backtrace_list
;
1351 c
.handlerlist
= handlerlist
;
1352 c
.lisp_eval_depth
= lisp_eval_depth
;
1353 c
.pdlcount
= SPECPDL_INDEX ();
1354 c
.poll_suppress_count
= poll_suppress_count
;
1355 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1356 c
.gcpro
= gcprolist
;
1357 c
.byte_stack
= byte_stack_list
;
1358 if (_setjmp (c
.jmp
))
1360 return (*hfun
) (c
.val
);
1364 h
.handler
= handlers
;
1366 h
.next
= handlerlist
;
1370 val
= (*bfun
) (arg
);
1372 handlerlist
= h
.next
;
1376 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1380 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1383 Lisp_Object handlers
,
1384 Lisp_Object (*hfun
) (Lisp_Object
))
1392 c
.backlist
= backtrace_list
;
1393 c
.handlerlist
= handlerlist
;
1394 c
.lisp_eval_depth
= lisp_eval_depth
;
1395 c
.pdlcount
= SPECPDL_INDEX ();
1396 c
.poll_suppress_count
= poll_suppress_count
;
1397 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1398 c
.gcpro
= gcprolist
;
1399 c
.byte_stack
= byte_stack_list
;
1400 if (_setjmp (c
.jmp
))
1402 return (*hfun
) (c
.val
);
1406 h
.handler
= handlers
;
1408 h
.next
= handlerlist
;
1412 val
= (*bfun
) (arg1
, arg2
);
1414 handlerlist
= h
.next
;
1418 /* Like internal_condition_case but call BFUN with NARGS as first,
1419 and ARGS as second argument. */
1422 internal_condition_case_n (Lisp_Object (*bfun
) (ptrdiff_t, Lisp_Object
*),
1425 Lisp_Object handlers
,
1426 Lisp_Object (*hfun
) (Lisp_Object
))
1434 c
.backlist
= backtrace_list
;
1435 c
.handlerlist
= handlerlist
;
1436 c
.lisp_eval_depth
= lisp_eval_depth
;
1437 c
.pdlcount
= SPECPDL_INDEX ();
1438 c
.poll_suppress_count
= poll_suppress_count
;
1439 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1440 c
.gcpro
= gcprolist
;
1441 c
.byte_stack
= byte_stack_list
;
1442 if (_setjmp (c
.jmp
))
1444 return (*hfun
) (c
.val
);
1448 h
.handler
= handlers
;
1450 h
.next
= handlerlist
;
1454 val
= (*bfun
) (nargs
, args
);
1456 handlerlist
= h
.next
;
1461 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
);
1462 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1466 process_quit_flag (void)
1468 Lisp_Object flag
= Vquit_flag
;
1470 if (EQ (flag
, Qkill_emacs
))
1472 if (EQ (Vthrow_on_input
, flag
))
1473 Fthrow (Vthrow_on_input
, Qt
);
1474 Fsignal (Qquit
, Qnil
);
1477 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1478 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1479 This function does not return.
1481 An error symbol is a symbol with an `error-conditions' property
1482 that is a list of condition names.
1483 A handler for any of those names will get to handle this signal.
1484 The symbol `error' should normally be one of them.
1486 DATA should be a list. Its elements are printed as part of the error message.
1487 See Info anchor `(elisp)Definition of signal' for some details on how this
1488 error message is constructed.
1489 If the signal is handled, DATA is made available to the handler.
1490 See also the function `condition-case'. */)
1491 (Lisp_Object error_symbol
, Lisp_Object data
)
1493 /* When memory is full, ERROR-SYMBOL is nil,
1494 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1495 That is a special case--don't do this in other situations. */
1496 Lisp_Object conditions
;
1498 Lisp_Object real_error_symbol
1499 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1500 register Lisp_Object clause
= Qnil
;
1502 struct backtrace
*bp
;
1504 immediate_quit
= handling_signal
= 0;
1506 if (gc_in_progress
|| waiting_for_input
)
1509 #if 0 /* rms: I don't know why this was here,
1510 but it is surely wrong for an error that is handled. */
1511 #ifdef HAVE_WINDOW_SYSTEM
1512 if (display_hourglass_p
)
1513 cancel_hourglass ();
1517 /* This hook is used by edebug. */
1518 if (! NILP (Vsignal_hook_function
)
1519 && ! NILP (error_symbol
))
1521 /* Edebug takes care of restoring these variables when it exits. */
1522 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1523 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1525 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1526 max_specpdl_size
= SPECPDL_INDEX () + 40;
1528 call2 (Vsignal_hook_function
, error_symbol
, data
);
1531 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1533 /* Remember from where signal was called. Skip over the frame for
1534 `signal' itself. If a frame for `error' follows, skip that,
1535 too. Don't do this when ERROR_SYMBOL is nil, because that
1536 is a memory-full error. */
1537 Vsignaling_function
= Qnil
;
1538 if (backtrace_list
&& !NILP (error_symbol
))
1540 bp
= backtrace_list
->next
;
1541 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1543 if (bp
&& bp
->function
)
1544 Vsignaling_function
= *bp
->function
;
1547 for (h
= handlerlist
; h
; h
= h
->next
)
1549 clause
= find_handler_clause (h
->handler
, conditions
);
1554 if (/* Don't run the debugger for a memory-full error.
1555 (There is no room in memory to do that!) */
1556 !NILP (error_symbol
)
1557 && (!NILP (Vdebug_on_signal
)
1558 /* If no handler is present now, try to run the debugger. */
1560 /* A `debug' symbol in the handler list disables the normal
1561 suppression of the debugger. */
1562 || (CONSP (clause
) && CONSP (XCAR (clause
))
1563 && !NILP (Fmemq (Qdebug
, XCAR (clause
))))
1564 /* Special handler that means "print a message and run debugger
1566 || EQ (h
->handler
, Qerror
)))
1569 = maybe_call_debugger (conditions
, error_symbol
, data
);
1570 /* We can't return values to code which signaled an error, but we
1571 can continue code which has signaled a quit. */
1572 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1578 Lisp_Object unwind_data
1579 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1581 h
->chosen_clause
= clause
;
1582 unwind_to_catch (h
->tag
, unwind_data
);
1587 Fthrow (Qtop_level
, Qt
);
1590 if (! NILP (error_symbol
))
1591 data
= Fcons (error_symbol
, data
);
1593 string
= Ferror_message_string (data
);
1594 fatal ("%s", SDATA (string
));
1597 /* Internal version of Fsignal that never returns.
1598 Used for anything but Qquit (which can return from Fsignal). */
1601 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1603 Fsignal (error_symbol
, data
);
1607 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1610 xsignal0 (Lisp_Object error_symbol
)
1612 xsignal (error_symbol
, Qnil
);
1616 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1618 xsignal (error_symbol
, list1 (arg
));
1622 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1624 xsignal (error_symbol
, list2 (arg1
, arg2
));
1628 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1630 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1633 /* Signal `error' with message S, and additional arg ARG.
1634 If ARG is not a genuine list, make it a one-element list. */
1637 signal_error (const char *s
, Lisp_Object arg
)
1639 Lisp_Object tortoise
, hare
;
1641 hare
= tortoise
= arg
;
1642 while (CONSP (hare
))
1649 tortoise
= XCDR (tortoise
);
1651 if (EQ (hare
, tortoise
))
1656 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1658 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1662 /* Return nonzero if LIST is a non-nil atom or
1663 a list containing one of CONDITIONS. */
1666 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1673 while (CONSP (conditions
))
1675 Lisp_Object
this, tail
;
1676 this = XCAR (conditions
);
1677 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1678 if (EQ (XCAR (tail
), this))
1680 conditions
= XCDR (conditions
);
1685 /* Return 1 if an error with condition-symbols CONDITIONS,
1686 and described by SIGNAL-DATA, should skip the debugger
1687 according to debugger-ignored-errors. */
1690 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1693 int first_string
= 1;
1694 Lisp_Object error_message
;
1696 error_message
= Qnil
;
1697 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1699 if (STRINGP (XCAR (tail
)))
1703 error_message
= Ferror_message_string (data
);
1707 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1712 Lisp_Object contail
;
1714 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1715 if (EQ (XCAR (tail
), XCAR (contail
)))
1723 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1724 SIG and DATA describe the signal. There are two ways to pass them:
1725 = SIG is the error symbol, and DATA is the rest of the data.
1726 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1727 This is for memory-full errors only. */
1729 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1731 Lisp_Object combined_data
;
1733 combined_data
= Fcons (sig
, data
);
1736 /* Don't try to run the debugger with interrupts blocked.
1737 The editing loop would return anyway. */
1739 /* Does user want to enter debugger for this kind of error? */
1742 : wants_debugger (Vdebug_on_error
, conditions
))
1743 && ! skip_debugger (conditions
, combined_data
)
1744 /* RMS: What's this for? */
1745 && when_entered_debugger
< num_nonmacro_input_events
)
1747 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1755 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
)
1757 register Lisp_Object h
;
1759 /* t is used by handlers for all conditions, set up by C code. */
1760 if (EQ (handlers
, Qt
))
1763 /* error is used similarly, but means print an error message
1764 and run the debugger if that is enabled. */
1765 if (EQ (handlers
, Qerror
))
1768 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1770 Lisp_Object handler
= XCAR (h
);
1771 Lisp_Object condit
, tem
;
1773 if (!CONSP (handler
))
1775 condit
= XCAR (handler
);
1776 /* Handle a single condition name in handler HANDLER. */
1777 if (SYMBOLP (condit
))
1779 tem
= Fmemq (Fcar (handler
), conditions
);
1783 /* Handle a list of condition names in handler HANDLER. */
1784 else if (CONSP (condit
))
1787 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1789 tem
= Fmemq (XCAR (tail
), conditions
);
1800 /* Dump an error message; called like vprintf. */
1802 verror (const char *m
, va_list ap
)
1805 ptrdiff_t size
= sizeof buf
;
1806 ptrdiff_t size_max
= STRING_BYTES_BOUND
+ 1;
1811 used
= evxprintf (&buffer
, &size
, buf
, size_max
, m
, ap
);
1812 string
= make_string (buffer
, used
);
1816 xsignal1 (Qerror
, string
);
1820 /* Dump an error message; called like printf. */
1824 error (const char *m
, ...)
1832 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
1833 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
1834 This means it contains a description for how to read arguments to give it.
1835 The value is nil for an invalid function or a symbol with no function
1838 Interactively callable functions include strings and vectors (treated
1839 as keyboard macros), lambda-expressions that contain a top-level call
1840 to `interactive', autoload definitions made by `autoload' with non-nil
1841 fourth argument, and some of the built-in functions of Lisp.
1843 Also, a symbol satisfies `commandp' if its function definition does so.
1845 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1846 then strings and vectors are not accepted. */)
1847 (Lisp_Object function
, Lisp_Object for_call_interactively
)
1849 register Lisp_Object fun
;
1850 register Lisp_Object funcar
;
1851 Lisp_Object if_prop
= Qnil
;
1855 fun
= indirect_function (fun
); /* Check cycles. */
1856 if (NILP (fun
) || EQ (fun
, Qunbound
))
1859 /* Check an `interactive-form' property if present, analogous to the
1860 function-documentation property. */
1862 while (SYMBOLP (fun
))
1864 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
1867 fun
= Fsymbol_function (fun
);
1870 /* Emacs primitives are interactive if their DEFUN specifies an
1871 interactive spec. */
1873 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
1875 /* Bytecode objects are interactive if they are long enough to
1876 have an element whose index is COMPILED_INTERACTIVE, which is
1877 where the interactive spec is stored. */
1878 else if (COMPILEDP (fun
))
1879 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
1882 /* Strings and vectors are keyboard macros. */
1883 if (STRINGP (fun
) || VECTORP (fun
))
1884 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
1886 /* Lists may represent commands. */
1889 funcar
= XCAR (fun
);
1890 if (EQ (funcar
, Qclosure
))
1891 return (!NILP (Fassq (Qinteractive
, Fcdr (Fcdr (XCDR (fun
)))))
1893 else if (EQ (funcar
, Qlambda
))
1894 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
1895 else if (EQ (funcar
, Qautoload
))
1896 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
1901 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
1902 doc
: /* Define FUNCTION to autoload from FILE.
1903 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1904 Third arg DOCSTRING is documentation for the function.
1905 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1906 Fifth arg TYPE indicates the type of the object:
1907 nil or omitted says FUNCTION is a function,
1908 `keymap' says FUNCTION is really a keymap, and
1909 `macro' or t says FUNCTION is really a macro.
1910 Third through fifth args give info about the real definition.
1911 They default to nil.
1912 If FUNCTION is already defined other than as an autoload,
1913 this does nothing and returns nil. */)
1914 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
1916 CHECK_SYMBOL (function
);
1917 CHECK_STRING (file
);
1919 /* If function is defined and not as an autoload, don't override. */
1920 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
1921 && !(CONSP (XSYMBOL (function
)->function
)
1922 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
1925 if (NILP (Vpurify_flag
))
1926 /* Only add entries after dumping, because the ones before are
1927 not useful and else we get loads of them from the loaddefs.el. */
1928 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
1929 else if (EQ (docstring
, make_number (0)))
1930 /* `read1' in lread.c has found the docstring starting with "\
1931 and assumed the docstring will be provided by Snarf-documentation, so it
1932 passed us 0 instead. But that leads to accidental sharing in purecopy's
1933 hash-consing, so we use a (hopefully) unique integer instead. */
1934 docstring
= make_number (XUNTAG (function
, Lisp_Symbol
));
1935 return Ffset (function
,
1936 Fpurecopy (list5 (Qautoload
, file
, docstring
,
1937 interactive
, type
)));
1941 un_autoload (Lisp_Object oldqueue
)
1943 register Lisp_Object queue
, first
, second
;
1945 /* Queue to unwind is current value of Vautoload_queue.
1946 oldqueue is the shadowed value to leave in Vautoload_queue. */
1947 queue
= Vautoload_queue
;
1948 Vautoload_queue
= oldqueue
;
1949 while (CONSP (queue
))
1951 first
= XCAR (queue
);
1952 second
= Fcdr (first
);
1953 first
= Fcar (first
);
1954 if (EQ (first
, make_number (0)))
1957 Ffset (first
, second
);
1958 queue
= XCDR (queue
);
1963 /* Load an autoloaded function.
1964 FUNNAME is the symbol which is the function's name.
1965 FUNDEF is the autoload definition (a list). */
1968 do_autoload (Lisp_Object fundef
, Lisp_Object funname
)
1970 ptrdiff_t count
= SPECPDL_INDEX ();
1972 struct gcpro gcpro1
, gcpro2
, gcpro3
;
1974 /* This is to make sure that loadup.el gives a clear picture
1975 of what files are preloaded and when. */
1976 if (! NILP (Vpurify_flag
))
1977 error ("Attempt to autoload %s while preparing to dump",
1978 SDATA (SYMBOL_NAME (funname
)));
1981 CHECK_SYMBOL (funname
);
1982 GCPRO3 (fun
, funname
, fundef
);
1984 /* Preserve the match data. */
1985 record_unwind_save_match_data ();
1987 /* If autoloading gets an error (which includes the error of failing
1988 to define the function being called), we use Vautoload_queue
1989 to undo function definitions and `provide' calls made by
1990 the function. We do this in the specific case of autoloading
1991 because autoloading is not an explicit request "load this file",
1992 but rather a request to "call this function".
1994 The value saved here is to be restored into Vautoload_queue. */
1995 record_unwind_protect (un_autoload
, Vautoload_queue
);
1996 Vautoload_queue
= Qt
;
1997 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
1999 /* Once loading finishes, don't undo it. */
2000 Vautoload_queue
= Qt
;
2001 unbind_to (count
, Qnil
);
2003 fun
= Findirect_function (fun
, Qnil
);
2005 if (!NILP (Fequal (fun
, fundef
)))
2006 error ("Autoloading failed to define function %s",
2007 SDATA (SYMBOL_NAME (funname
)));
2012 DEFUN ("eval", Feval
, Seval
, 1, 2, 0,
2013 doc
: /* Evaluate FORM and return its value.
2014 If LEXICAL is t, evaluate using lexical scoping. */)
2015 (Lisp_Object form
, Lisp_Object lexical
)
2017 ptrdiff_t count
= SPECPDL_INDEX ();
2018 specbind (Qinternal_interpreter_environment
,
2019 NILP (lexical
) ? Qnil
: Fcons (Qt
, Qnil
));
2020 return unbind_to (count
, eval_sub (form
));
2023 /* Eval a sub-expression of the current expression (i.e. in the same
2026 eval_sub (Lisp_Object form
)
2028 Lisp_Object fun
, val
, original_fun
, original_args
;
2030 struct backtrace backtrace
;
2031 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2033 if (handling_signal
)
2038 /* Look up its binding in the lexical environment.
2039 We do not pay attention to the declared_special flag here, since we
2040 already did that when let-binding the variable. */
2041 Lisp_Object lex_binding
2042 = !NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
2043 ? Fassq (form
, Vinternal_interpreter_environment
)
2045 if (CONSP (lex_binding
))
2046 return XCDR (lex_binding
);
2048 return Fsymbol_value (form
);
2055 if ((consing_since_gc
> gc_cons_threshold
2056 && consing_since_gc
> gc_relative_threshold
)
2058 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2061 Fgarbage_collect ();
2065 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2067 if (max_lisp_eval_depth
< 100)
2068 max_lisp_eval_depth
= 100;
2069 if (lisp_eval_depth
> max_lisp_eval_depth
)
2070 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2073 original_fun
= Fcar (form
);
2074 original_args
= Fcdr (form
);
2076 backtrace
.next
= backtrace_list
;
2077 backtrace_list
= &backtrace
;
2078 backtrace
.function
= &original_fun
; /* This also protects them from gc. */
2079 backtrace
.args
= &original_args
;
2080 backtrace
.nargs
= UNEVALLED
;
2081 backtrace
.debug_on_exit
= 0;
2083 if (debug_on_next_call
)
2084 do_debug_on_call (Qt
);
2086 /* At this point, only original_fun and original_args
2087 have values that will be used below. */
2090 /* Optimize for no indirection. */
2092 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2093 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2094 fun
= indirect_function (fun
);
2098 Lisp_Object numargs
;
2099 Lisp_Object argvals
[8];
2100 Lisp_Object args_left
;
2101 register int i
, maxargs
;
2103 args_left
= original_args
;
2104 numargs
= Flength (args_left
);
2108 if (XINT (numargs
) < XSUBR (fun
)->min_args
2109 || (XSUBR (fun
)->max_args
>= 0
2110 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2111 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2113 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2114 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2115 else if (XSUBR (fun
)->max_args
== MANY
)
2117 /* Pass a vector of evaluated arguments. */
2119 ptrdiff_t argnum
= 0;
2122 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2124 GCPRO3 (args_left
, fun
, fun
);
2128 while (!NILP (args_left
))
2130 vals
[argnum
++] = eval_sub (Fcar (args_left
));
2131 args_left
= Fcdr (args_left
);
2132 gcpro3
.nvars
= argnum
;
2135 backtrace
.args
= vals
;
2136 backtrace
.nargs
= XINT (numargs
);
2138 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2144 GCPRO3 (args_left
, fun
, fun
);
2145 gcpro3
.var
= argvals
;
2148 maxargs
= XSUBR (fun
)->max_args
;
2149 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2151 argvals
[i
] = eval_sub (Fcar (args_left
));
2157 backtrace
.args
= argvals
;
2158 backtrace
.nargs
= XINT (numargs
);
2163 val
= (XSUBR (fun
)->function
.a0 ());
2166 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2169 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2172 val
= (XSUBR (fun
)->function
.a3
2173 (argvals
[0], argvals
[1], argvals
[2]));
2176 val
= (XSUBR (fun
)->function
.a4
2177 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2180 val
= (XSUBR (fun
)->function
.a5
2181 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2185 val
= (XSUBR (fun
)->function
.a6
2186 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2187 argvals
[4], argvals
[5]));
2190 val
= (XSUBR (fun
)->function
.a7
2191 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2192 argvals
[4], argvals
[5], argvals
[6]));
2196 val
= (XSUBR (fun
)->function
.a8
2197 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2198 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2202 /* Someone has created a subr that takes more arguments than
2203 is supported by this code. We need to either rewrite the
2204 subr to use a different argument protocol, or add more
2205 cases to this switch. */
2210 else if (COMPILEDP (fun
))
2211 val
= apply_lambda (fun
, original_args
);
2214 if (EQ (fun
, Qunbound
))
2215 xsignal1 (Qvoid_function
, original_fun
);
2217 xsignal1 (Qinvalid_function
, original_fun
);
2218 funcar
= XCAR (fun
);
2219 if (!SYMBOLP (funcar
))
2220 xsignal1 (Qinvalid_function
, original_fun
);
2221 if (EQ (funcar
, Qautoload
))
2223 do_autoload (fun
, original_fun
);
2226 if (EQ (funcar
, Qmacro
))
2227 val
= eval_sub (apply1 (Fcdr (fun
), original_args
));
2228 else if (EQ (funcar
, Qlambda
)
2229 || EQ (funcar
, Qclosure
))
2230 val
= apply_lambda (fun
, original_args
);
2232 xsignal1 (Qinvalid_function
, original_fun
);
2237 if (backtrace
.debug_on_exit
)
2238 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2239 backtrace_list
= backtrace
.next
;
2244 DEFUN ("apply", Fapply
, Sapply
, 1, MANY
, 0,
2245 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2246 Then return the value FUNCTION returns.
2247 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2248 usage: (apply FUNCTION &rest ARGUMENTS) */)
2249 (ptrdiff_t nargs
, Lisp_Object
*args
)
2253 register Lisp_Object spread_arg
;
2254 register Lisp_Object
*funcall_args
;
2255 Lisp_Object fun
, retval
;
2256 struct gcpro gcpro1
;
2261 spread_arg
= args
[nargs
- 1];
2262 CHECK_LIST (spread_arg
);
2264 numargs
= XINT (Flength (spread_arg
));
2267 return Ffuncall (nargs
- 1, args
);
2268 else if (numargs
== 1)
2270 args
[nargs
- 1] = XCAR (spread_arg
);
2271 return Ffuncall (nargs
, args
);
2274 numargs
+= nargs
- 2;
2276 /* Optimize for no indirection. */
2277 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2278 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2279 fun
= indirect_function (fun
);
2280 if (EQ (fun
, Qunbound
))
2282 /* Let funcall get the error. */
2289 if (numargs
< XSUBR (fun
)->min_args
2290 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2291 goto funcall
; /* Let funcall get the error. */
2292 else if (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
> numargs
)
2294 /* Avoid making funcall cons up a yet another new vector of arguments
2295 by explicitly supplying nil's for optional values. */
2296 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2297 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2298 funcall_args
[++i
] = Qnil
;
2299 GCPRO1 (*funcall_args
);
2300 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2304 /* We add 1 to numargs because funcall_args includes the
2305 function itself as well as its arguments. */
2308 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2309 GCPRO1 (*funcall_args
);
2310 gcpro1
.nvars
= 1 + numargs
;
2313 memcpy (funcall_args
, args
, nargs
* sizeof (Lisp_Object
));
2314 /* Spread the last arg we got. Its first element goes in
2315 the slot that it used to occupy, hence this value of I. */
2317 while (!NILP (spread_arg
))
2319 funcall_args
[i
++] = XCAR (spread_arg
);
2320 spread_arg
= XCDR (spread_arg
);
2323 /* By convention, the caller needs to gcpro Ffuncall's args. */
2324 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2331 /* Run hook variables in various ways. */
2334 funcall_nil (ptrdiff_t nargs
, Lisp_Object
*args
)
2336 Ffuncall (nargs
, args
);
2340 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2341 doc
: /* Run each hook in HOOKS.
2342 Each argument should be a symbol, a hook variable.
2343 These symbols are processed in the order specified.
2344 If a hook symbol has a non-nil value, that value may be a function
2345 or a list of functions to be called to run the hook.
2346 If the value is a function, it is called with no arguments.
2347 If it is a list, the elements are called, in order, with no arguments.
2349 Major modes should not use this function directly to run their mode
2350 hook; they should use `run-mode-hooks' instead.
2352 Do not use `make-local-variable' to make a hook variable buffer-local.
2353 Instead, use `add-hook' and specify t for the LOCAL argument.
2354 usage: (run-hooks &rest HOOKS) */)
2355 (ptrdiff_t nargs
, Lisp_Object
*args
)
2357 Lisp_Object hook
[1];
2360 for (i
= 0; i
< nargs
; i
++)
2363 run_hook_with_args (1, hook
, funcall_nil
);
2369 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2370 Srun_hook_with_args
, 1, MANY
, 0,
2371 doc
: /* Run HOOK with the specified arguments ARGS.
2372 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2373 value, that value may be a function or a list of functions to be
2374 called to run the hook. If the value is a function, it is called with
2375 the given arguments and its return value is returned. If it is a list
2376 of functions, those functions are called, in order,
2377 with the given arguments ARGS.
2378 It is best not to depend on the value returned by `run-hook-with-args',
2381 Do not use `make-local-variable' to make a hook variable buffer-local.
2382 Instead, use `add-hook' and specify t for the LOCAL argument.
2383 usage: (run-hook-with-args HOOK &rest ARGS) */)
2384 (ptrdiff_t nargs
, Lisp_Object
*args
)
2386 return run_hook_with_args (nargs
, args
, funcall_nil
);
2389 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2390 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2391 doc
: /* Run HOOK with the specified arguments ARGS.
2392 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2393 value, that value may be a function or a list of functions to be
2394 called to run the hook. If the value is a function, it is called with
2395 the given arguments and its return value is returned.
2396 If it is a list of functions, those functions are called, in order,
2397 with the given arguments ARGS, until one of them
2398 returns a non-nil value. Then we return that value.
2399 However, if they all return nil, we return nil.
2401 Do not use `make-local-variable' to make a hook variable buffer-local.
2402 Instead, use `add-hook' and specify t for the LOCAL argument.
2403 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2404 (ptrdiff_t nargs
, Lisp_Object
*args
)
2406 return run_hook_with_args (nargs
, args
, Ffuncall
);
2410 funcall_not (ptrdiff_t nargs
, Lisp_Object
*args
)
2412 return NILP (Ffuncall (nargs
, args
)) ? Qt
: Qnil
;
2415 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2416 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2417 doc
: /* Run HOOK with the specified arguments ARGS.
2418 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2419 value, that value may be a function or a list of functions to be
2420 called to run the hook. If the value is a function, it is called with
2421 the given arguments and its return value is returned.
2422 If it is a list of functions, those functions are called, in order,
2423 with the given arguments ARGS, until one of them returns nil.
2424 Then we return nil. However, if they all return non-nil, we return non-nil.
2426 Do not use `make-local-variable' to make a hook variable buffer-local.
2427 Instead, use `add-hook' and specify t for the LOCAL argument.
2428 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2429 (ptrdiff_t nargs
, Lisp_Object
*args
)
2431 return NILP (run_hook_with_args (nargs
, args
, funcall_not
)) ? Qt
: Qnil
;
2435 run_hook_wrapped_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
2437 Lisp_Object tmp
= args
[0], ret
;
2440 ret
= Ffuncall (nargs
, args
);
2446 DEFUN ("run-hook-wrapped", Frun_hook_wrapped
, Srun_hook_wrapped
, 2, MANY
, 0,
2447 doc
: /* Run HOOK, passing each function through WRAP-FUNCTION.
2448 I.e. instead of calling each function FUN directly with arguments ARGS,
2449 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2450 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2451 aborts and returns that value.
2452 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2453 (ptrdiff_t nargs
, Lisp_Object
*args
)
2455 return run_hook_with_args (nargs
, args
, run_hook_wrapped_funcall
);
2458 /* ARGS[0] should be a hook symbol.
2459 Call each of the functions in the hook value, passing each of them
2460 as arguments all the rest of ARGS (all NARGS - 1 elements).
2461 FUNCALL specifies how to call each function on the hook.
2462 The caller (or its caller, etc) must gcpro all of ARGS,
2463 except that it isn't necessary to gcpro ARGS[0]. */
2466 run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2467 Lisp_Object (*funcall
) (ptrdiff_t nargs
, Lisp_Object
*args
))
2469 Lisp_Object sym
, val
, ret
= Qnil
;
2470 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2472 /* If we are dying or still initializing,
2473 don't do anything--it would probably crash if we tried. */
2474 if (NILP (Vrun_hooks
))
2478 val
= find_symbol_value (sym
);
2480 if (EQ (val
, Qunbound
) || NILP (val
))
2482 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2485 return funcall (nargs
, args
);
2489 Lisp_Object global_vals
= Qnil
;
2490 GCPRO3 (sym
, val
, global_vals
);
2493 CONSP (val
) && NILP (ret
);
2496 if (EQ (XCAR (val
), Qt
))
2498 /* t indicates this hook has a local binding;
2499 it means to run the global binding too. */
2500 global_vals
= Fdefault_value (sym
);
2501 if (NILP (global_vals
)) continue;
2503 if (!CONSP (global_vals
) || EQ (XCAR (global_vals
), Qlambda
))
2505 args
[0] = global_vals
;
2506 ret
= funcall (nargs
, args
);
2511 CONSP (global_vals
) && NILP (ret
);
2512 global_vals
= XCDR (global_vals
))
2514 args
[0] = XCAR (global_vals
);
2515 /* In a global value, t should not occur. If it does, we
2516 must ignore it to avoid an endless loop. */
2517 if (!EQ (args
[0], Qt
))
2518 ret
= funcall (nargs
, args
);
2524 args
[0] = XCAR (val
);
2525 ret
= funcall (nargs
, args
);
2534 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2537 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2539 Lisp_Object temp
[3];
2544 Frun_hook_with_args (3, temp
);
2547 /* Apply fn to arg. */
2549 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2551 struct gcpro gcpro1
;
2555 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2558 Lisp_Object args
[2];
2562 RETURN_UNGCPRO (Fapply (2, args
));
2566 /* Call function fn on no arguments. */
2568 call0 (Lisp_Object fn
)
2570 struct gcpro gcpro1
;
2573 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2576 /* Call function fn with 1 argument arg1. */
2579 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2581 struct gcpro gcpro1
;
2582 Lisp_Object args
[2];
2588 RETURN_UNGCPRO (Ffuncall (2, args
));
2591 /* Call function fn with 2 arguments arg1, arg2. */
2594 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2596 struct gcpro gcpro1
;
2597 Lisp_Object args
[3];
2603 RETURN_UNGCPRO (Ffuncall (3, args
));
2606 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2609 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2611 struct gcpro gcpro1
;
2612 Lisp_Object args
[4];
2619 RETURN_UNGCPRO (Ffuncall (4, args
));
2622 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2625 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2628 struct gcpro gcpro1
;
2629 Lisp_Object args
[5];
2637 RETURN_UNGCPRO (Ffuncall (5, args
));
2640 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2643 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2644 Lisp_Object arg4
, Lisp_Object arg5
)
2646 struct gcpro gcpro1
;
2647 Lisp_Object args
[6];
2656 RETURN_UNGCPRO (Ffuncall (6, args
));
2659 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2662 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2663 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2665 struct gcpro gcpro1
;
2666 Lisp_Object args
[7];
2676 RETURN_UNGCPRO (Ffuncall (7, args
));
2679 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2682 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2683 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2685 struct gcpro gcpro1
;
2686 Lisp_Object args
[8];
2697 RETURN_UNGCPRO (Ffuncall (8, args
));
2700 /* The caller should GCPRO all the elements of ARGS. */
2702 DEFUN ("functionp", Ffunctionp
, Sfunctionp
, 1, 1, 0,
2703 doc
: /* Non-nil if OBJECT is a function. */)
2704 (Lisp_Object object
)
2706 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
2708 object
= Findirect_function (object
, Qt
);
2710 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
2712 /* Autoloaded symbols are functions, except if they load
2713 macros or keymaps. */
2715 for (i
= 0; i
< 4 && CONSP (object
); i
++)
2716 object
= XCDR (object
);
2718 return (CONSP (object
) && !NILP (XCAR (object
))) ? Qnil
: Qt
;
2723 return (XSUBR (object
)->max_args
!= UNEVALLED
) ? Qt
: Qnil
;
2724 else if (COMPILEDP (object
))
2726 else if (CONSP (object
))
2728 Lisp_Object car
= XCAR (object
);
2729 return (EQ (car
, Qlambda
) || EQ (car
, Qclosure
)) ? Qt
: Qnil
;
2735 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2736 doc
: /* Call first argument as a function, passing remaining arguments to it.
2737 Return the value that function returns.
2738 Thus, (funcall 'cons 'x 'y) returns (x . y).
2739 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2740 (ptrdiff_t nargs
, Lisp_Object
*args
)
2742 Lisp_Object fun
, original_fun
;
2744 ptrdiff_t numargs
= nargs
- 1;
2745 Lisp_Object lisp_numargs
;
2747 struct backtrace backtrace
;
2748 register Lisp_Object
*internal_args
;
2752 if ((consing_since_gc
> gc_cons_threshold
2753 && consing_since_gc
> gc_relative_threshold
)
2755 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2756 Fgarbage_collect ();
2758 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2760 if (max_lisp_eval_depth
< 100)
2761 max_lisp_eval_depth
= 100;
2762 if (lisp_eval_depth
> max_lisp_eval_depth
)
2763 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2766 backtrace
.next
= backtrace_list
;
2767 backtrace_list
= &backtrace
;
2768 backtrace
.function
= &args
[0];
2769 backtrace
.args
= &args
[1];
2770 backtrace
.nargs
= nargs
- 1;
2771 backtrace
.debug_on_exit
= 0;
2773 if (debug_on_next_call
)
2774 do_debug_on_call (Qlambda
);
2778 original_fun
= args
[0];
2782 /* Optimize for no indirection. */
2784 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2785 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2786 fun
= indirect_function (fun
);
2790 if (numargs
< XSUBR (fun
)->min_args
2791 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2793 XSETFASTINT (lisp_numargs
, numargs
);
2794 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2797 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2798 xsignal1 (Qinvalid_function
, original_fun
);
2800 else if (XSUBR (fun
)->max_args
== MANY
)
2801 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
2804 if (XSUBR (fun
)->max_args
> numargs
)
2806 internal_args
= alloca (XSUBR (fun
)->max_args
2807 * sizeof *internal_args
);
2808 memcpy (internal_args
, args
+ 1, numargs
* sizeof (Lisp_Object
));
2809 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2810 internal_args
[i
] = Qnil
;
2813 internal_args
= args
+ 1;
2814 switch (XSUBR (fun
)->max_args
)
2817 val
= (XSUBR (fun
)->function
.a0 ());
2820 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
2823 val
= (XSUBR (fun
)->function
.a2
2824 (internal_args
[0], internal_args
[1]));
2827 val
= (XSUBR (fun
)->function
.a3
2828 (internal_args
[0], internal_args
[1], internal_args
[2]));
2831 val
= (XSUBR (fun
)->function
.a4
2832 (internal_args
[0], internal_args
[1], internal_args
[2],
2836 val
= (XSUBR (fun
)->function
.a5
2837 (internal_args
[0], internal_args
[1], internal_args
[2],
2838 internal_args
[3], internal_args
[4]));
2841 val
= (XSUBR (fun
)->function
.a6
2842 (internal_args
[0], internal_args
[1], internal_args
[2],
2843 internal_args
[3], internal_args
[4], internal_args
[5]));
2846 val
= (XSUBR (fun
)->function
.a7
2847 (internal_args
[0], internal_args
[1], internal_args
[2],
2848 internal_args
[3], internal_args
[4], internal_args
[5],
2853 val
= (XSUBR (fun
)->function
.a8
2854 (internal_args
[0], internal_args
[1], internal_args
[2],
2855 internal_args
[3], internal_args
[4], internal_args
[5],
2856 internal_args
[6], internal_args
[7]));
2861 /* If a subr takes more than 8 arguments without using MANY
2862 or UNEVALLED, we need to extend this function to support it.
2863 Until this is done, there is no way to call the function. */
2868 else if (COMPILEDP (fun
))
2869 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2872 if (EQ (fun
, Qunbound
))
2873 xsignal1 (Qvoid_function
, original_fun
);
2875 xsignal1 (Qinvalid_function
, original_fun
);
2876 funcar
= XCAR (fun
);
2877 if (!SYMBOLP (funcar
))
2878 xsignal1 (Qinvalid_function
, original_fun
);
2879 if (EQ (funcar
, Qlambda
)
2880 || EQ (funcar
, Qclosure
))
2881 val
= funcall_lambda (fun
, numargs
, args
+ 1);
2882 else if (EQ (funcar
, Qautoload
))
2884 do_autoload (fun
, original_fun
);
2889 xsignal1 (Qinvalid_function
, original_fun
);
2893 if (backtrace
.debug_on_exit
)
2894 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2895 backtrace_list
= backtrace
.next
;
2900 apply_lambda (Lisp_Object fun
, Lisp_Object args
)
2902 Lisp_Object args_left
;
2905 register Lisp_Object
*arg_vector
;
2906 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2907 register Lisp_Object tem
;
2910 numargs
= XFASTINT (Flength (args
));
2911 SAFE_ALLOCA_LISP (arg_vector
, numargs
);
2914 GCPRO3 (*arg_vector
, args_left
, fun
);
2917 for (i
= 0; i
< numargs
; )
2919 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
2920 tem
= eval_sub (tem
);
2921 arg_vector
[i
++] = tem
;
2927 backtrace_list
->args
= arg_vector
;
2928 backtrace_list
->nargs
= i
;
2929 tem
= funcall_lambda (fun
, numargs
, arg_vector
);
2931 /* Do the debug-on-exit now, while arg_vector still exists. */
2932 if (backtrace_list
->debug_on_exit
)
2933 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
2934 /* Don't do it again when we return to eval. */
2935 backtrace_list
->debug_on_exit
= 0;
2940 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2941 and return the result of evaluation.
2942 FUN must be either a lambda-expression or a compiled-code object. */
2945 funcall_lambda (Lisp_Object fun
, ptrdiff_t nargs
,
2946 register Lisp_Object
*arg_vector
)
2948 Lisp_Object val
, syms_left
, next
, lexenv
;
2949 ptrdiff_t count
= SPECPDL_INDEX ();
2955 if (EQ (XCAR (fun
), Qclosure
))
2957 fun
= XCDR (fun
); /* Drop `closure'. */
2958 lexenv
= XCAR (fun
);
2959 CHECK_LIST_CONS (fun
, fun
);
2963 syms_left
= XCDR (fun
);
2964 if (CONSP (syms_left
))
2965 syms_left
= XCAR (syms_left
);
2967 xsignal1 (Qinvalid_function
, fun
);
2969 else if (COMPILEDP (fun
))
2971 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
2972 if (INTEGERP (syms_left
))
2973 /* A byte-code object with a non-nil `push args' slot means we
2974 shouldn't bind any arguments, instead just call the byte-code
2975 interpreter directly; it will push arguments as necessary.
2977 Byte-code objects with either a non-existent, or a nil value for
2978 the `push args' slot (the default), have dynamically-bound
2979 arguments, and use the argument-binding code below instead (as do
2980 all interpreted functions, even lexically bound ones). */
2982 /* If we have not actually read the bytecode string
2983 and constants vector yet, fetch them from the file. */
2984 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
2985 Ffetch_bytecode (fun
);
2986 return exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
2987 AREF (fun
, COMPILED_CONSTANTS
),
2988 AREF (fun
, COMPILED_STACK_DEPTH
),
2997 i
= optional
= rest
= 0;
2998 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3002 next
= XCAR (syms_left
);
3003 if (!SYMBOLP (next
))
3004 xsignal1 (Qinvalid_function
, fun
);
3006 if (EQ (next
, Qand_rest
))
3008 else if (EQ (next
, Qand_optional
))
3015 arg
= Flist (nargs
- i
, &arg_vector
[i
]);
3019 arg
= arg_vector
[i
++];
3021 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3025 /* Bind the argument. */
3026 if (!NILP (lexenv
) && SYMBOLP (next
))
3027 /* Lexically bind NEXT by adding it to the lexenv alist. */
3028 lexenv
= Fcons (Fcons (next
, arg
), lexenv
);
3030 /* Dynamically bind NEXT. */
3031 specbind (next
, arg
);
3035 if (!NILP (syms_left
))
3036 xsignal1 (Qinvalid_function
, fun
);
3038 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3040 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
3041 /* Instantiate a new lexical environment. */
3042 specbind (Qinternal_interpreter_environment
, lexenv
);
3045 val
= Fprogn (XCDR (XCDR (fun
)));
3048 /* If we have not actually read the bytecode string
3049 and constants vector yet, fetch them from the file. */
3050 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3051 Ffetch_bytecode (fun
);
3052 val
= exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3053 AREF (fun
, COMPILED_CONSTANTS
),
3054 AREF (fun
, COMPILED_STACK_DEPTH
),
3058 return unbind_to (count
, val
);
3061 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3063 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3064 (Lisp_Object object
)
3068 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3070 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3073 tem
= AREF (object
, COMPILED_BYTECODE
);
3074 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3075 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3077 error ("Invalid byte code");
3079 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3080 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3088 register ptrdiff_t count
= SPECPDL_INDEX ();
3089 ptrdiff_t max_size
= min (max_specpdl_size
, PTRDIFF_MAX
);
3090 if (max_size
<= specpdl_size
)
3092 if (max_specpdl_size
< 400)
3093 max_size
= max_specpdl_size
= 400;
3094 if (max_size
<= specpdl_size
)
3095 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3097 specpdl
= xpalloc (specpdl
, &specpdl_size
, 1, max_size
, sizeof *specpdl
);
3098 specpdl_ptr
= specpdl
+ count
;
3101 /* `specpdl_ptr->symbol' is a field which describes which variable is
3102 let-bound, so it can be properly undone when we unbind_to.
3103 It can have the following two shapes:
3104 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3105 a symbol that is not buffer-local (at least at the time
3106 the let binding started). Note also that it should not be
3107 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3109 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3110 variable SYMBOL which can be buffer-local. WHERE tells us
3111 which buffer is affected (or nil if the let-binding affects the
3112 global value of the variable) and BUFFER tells us which buffer was
3113 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3114 BUFFER did not yet have a buffer-local value). */
3117 specbind (Lisp_Object symbol
, Lisp_Object value
)
3119 struct Lisp_Symbol
*sym
;
3121 eassert (!handling_signal
);
3123 CHECK_SYMBOL (symbol
);
3124 sym
= XSYMBOL (symbol
);
3125 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3129 switch (sym
->redirect
)
3131 case SYMBOL_VARALIAS
:
3132 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3133 case SYMBOL_PLAINVAL
:
3134 /* The most common case is that of a non-constant symbol with a
3135 trivial value. Make that as fast as we can. */
3136 specpdl_ptr
->symbol
= symbol
;
3137 specpdl_ptr
->old_value
= SYMBOL_VAL (sym
);
3138 specpdl_ptr
->func
= NULL
;
3141 SET_SYMBOL_VAL (sym
, value
);
3143 set_internal (symbol
, value
, Qnil
, 1);
3145 case SYMBOL_LOCALIZED
:
3146 if (SYMBOL_BLV (sym
)->frame_local
)
3147 error ("Frame-local vars cannot be let-bound");
3148 case SYMBOL_FORWARDED
:
3150 Lisp_Object ovalue
= find_symbol_value (symbol
);
3151 specpdl_ptr
->func
= 0;
3152 specpdl_ptr
->old_value
= ovalue
;
3154 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3155 || (EQ (SYMBOL_BLV (sym
)->where
,
3156 SYMBOL_BLV (sym
)->frame_local
?
3157 Fselected_frame () : Fcurrent_buffer ())));
3159 if (sym
->redirect
== SYMBOL_LOCALIZED
3160 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3162 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3164 /* For a local variable, record both the symbol and which
3165 buffer's or frame's value we are saving. */
3166 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3168 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3169 || (BLV_FOUND (SYMBOL_BLV (sym
))
3170 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3173 else if (sym
->redirect
== SYMBOL_LOCALIZED
3174 && BLV_FOUND (SYMBOL_BLV (sym
)))
3175 where
= SYMBOL_BLV (sym
)->where
;
3179 /* We're not using the `unused' slot in the specbinding
3180 structure because this would mean we have to do more
3181 work for simple variables. */
3182 /* FIXME: The third value `current_buffer' is only used in
3183 let_shadows_buffer_binding_p which is itself only used
3184 in set_internal for local_if_set. */
3185 eassert (NILP (where
) || EQ (where
, cur_buf
));
3186 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, cur_buf
));
3188 /* If SYMBOL is a per-buffer variable which doesn't have a
3189 buffer-local value here, make the `let' change the global
3190 value by changing the value of SYMBOL in all buffers not
3191 having their own value. This is consistent with what
3192 happens with other buffer-local variables. */
3194 && sym
->redirect
== SYMBOL_FORWARDED
)
3196 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3198 Fset_default (symbol
, value
);
3203 specpdl_ptr
->symbol
= symbol
;
3206 set_internal (symbol
, value
, Qnil
, 1);
3214 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3216 eassert (!handling_signal
);
3218 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3220 specpdl_ptr
->func
= function
;
3221 specpdl_ptr
->symbol
= Qnil
;
3222 specpdl_ptr
->old_value
= arg
;
3227 unbind_to (ptrdiff_t count
, Lisp_Object value
)
3229 Lisp_Object quitf
= Vquit_flag
;
3230 struct gcpro gcpro1
, gcpro2
;
3232 GCPRO2 (value
, quitf
);
3235 while (specpdl_ptr
!= specpdl
+ count
)
3237 /* Copy the binding, and decrement specpdl_ptr, before we do
3238 the work to unbind it. We decrement first
3239 so that an error in unbinding won't try to unbind
3240 the same entry again, and we copy the binding first
3241 in case more bindings are made during some of the code we run. */
3243 struct specbinding this_binding
;
3244 this_binding
= *--specpdl_ptr
;
3246 if (this_binding
.func
!= 0)
3247 (*this_binding
.func
) (this_binding
.old_value
);
3248 /* If the symbol is a list, it is really (SYMBOL WHERE
3249 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3250 frame. If WHERE is a buffer or frame, this indicates we
3251 bound a variable that had a buffer-local or frame-local
3252 binding. WHERE nil means that the variable had the default
3253 value when it was bound. CURRENT-BUFFER is the buffer that
3254 was current when the variable was bound. */
3255 else if (CONSP (this_binding
.symbol
))
3257 Lisp_Object symbol
, where
;
3259 symbol
= XCAR (this_binding
.symbol
);
3260 where
= XCAR (XCDR (this_binding
.symbol
));
3263 Fset_default (symbol
, this_binding
.old_value
);
3264 /* If `where' is non-nil, reset the value in the appropriate
3265 local binding, but only if that binding still exists. */
3266 else if (BUFFERP (where
)
3267 ? !NILP (Flocal_variable_p (symbol
, where
))
3268 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3269 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3271 /* If variable has a trivial value (no forwarding), we can
3272 just set it. No need to check for constant symbols here,
3273 since that was already done by specbind. */
3274 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3275 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3276 this_binding
.old_value
);
3278 /* NOTE: we only ever come here if make_local_foo was used for
3279 the first time on this var within this let. */
3280 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3283 if (NILP (Vquit_flag
) && !NILP (quitf
))
3290 DEFUN ("special-variable-p", Fspecial_variable_p
, Sspecial_variable_p
, 1, 1, 0,
3291 doc
: /* Return non-nil if SYMBOL's global binding has been declared special.
3292 A special variable is one that will be bound dynamically, even in a
3293 context where binding is lexical by default. */)
3294 (Lisp_Object symbol
)
3296 CHECK_SYMBOL (symbol
);
3297 return XSYMBOL (symbol
)->declared_special
? Qt
: Qnil
;
3301 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3302 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3303 The debugger is entered when that frame exits, if the flag is non-nil. */)
3304 (Lisp_Object level
, Lisp_Object flag
)
3306 register struct backtrace
*backlist
= backtrace_list
;
3307 register EMACS_INT i
;
3309 CHECK_NUMBER (level
);
3311 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3313 backlist
= backlist
->next
;
3317 backlist
->debug_on_exit
= !NILP (flag
);
3322 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3323 doc
: /* Print a trace of Lisp function calls currently active.
3324 Output stream used is value of `standard-output'. */)
3327 register struct backtrace
*backlist
= backtrace_list
;
3330 struct gcpro gcpro1
;
3331 Lisp_Object old_print_level
= Vprint_level
;
3333 if (NILP (Vprint_level
))
3334 XSETFASTINT (Vprint_level
, 8);
3341 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3342 if (backlist
->nargs
== UNEVALLED
)
3344 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3345 write_string ("\n", -1);
3349 tem
= *backlist
->function
;
3350 Fprin1 (tem
, Qnil
); /* This can QUIT. */
3351 write_string ("(", -1);
3352 if (backlist
->nargs
== MANY
)
3353 { /* FIXME: Can this happen? */
3355 for (tail
= *backlist
->args
, i
= 0;
3357 tail
= Fcdr (tail
), i
= 1)
3359 if (i
) write_string (" ", -1);
3360 Fprin1 (Fcar (tail
), Qnil
);
3366 for (i
= 0; i
< backlist
->nargs
; i
++)
3368 if (i
) write_string (" ", -1);
3369 Fprin1 (backlist
->args
[i
], Qnil
);
3372 write_string (")\n", -1);
3374 backlist
= backlist
->next
;
3377 Vprint_level
= old_print_level
;
3382 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3383 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3384 If that frame has not evaluated the arguments yet (or is a special form),
3385 the value is (nil FUNCTION ARG-FORMS...).
3386 If that frame has evaluated its arguments and called its function already,
3387 the value is (t FUNCTION ARG-VALUES...).
3388 A &rest arg is represented as the tail of the list ARG-VALUES.
3389 FUNCTION is whatever was supplied as car of evaluated list,
3390 or a lambda expression for macro calls.
3391 If NFRAMES is more than the number of frames, the value is nil. */)
3392 (Lisp_Object nframes
)
3394 register struct backtrace
*backlist
= backtrace_list
;
3395 register EMACS_INT i
;
3398 CHECK_NATNUM (nframes
);
3400 /* Find the frame requested. */
3401 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3402 backlist
= backlist
->next
;
3406 if (backlist
->nargs
== UNEVALLED
)
3407 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3410 if (backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3411 tem
= *backlist
->args
;
3413 tem
= Flist (backlist
->nargs
, backlist
->args
);
3415 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3422 mark_backtrace (void)
3424 register struct backtrace
*backlist
;
3427 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3429 mark_object (*backlist
->function
);
3431 if (backlist
->nargs
== UNEVALLED
3432 || backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3435 i
= backlist
->nargs
;
3437 mark_object (backlist
->args
[i
]);
3445 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3446 doc
: /* Limit on number of Lisp variable bindings and `unwind-protect's.
3447 If Lisp code tries to increase the total number past this amount,
3448 an error is signaled.
3449 You can safely use a value considerably larger than the default value,
3450 if that proves inconveniently small. However, if you increase it too far,
3451 Emacs could run out of memory trying to make the stack bigger. */);
3453 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3454 doc
: /* Limit on depth in `eval', `apply' and `funcall' before error.
3456 This limit serves to catch infinite recursions for you before they cause
3457 actual stack overflow in C, which would be fatal for Emacs.
3458 You can safely make it considerably larger than its default value,
3459 if that proves inconveniently small. However, if you increase it too far,
3460 Emacs could overflow the real C stack, and crash. */);
3462 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3463 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3464 If the value is t, that means do an ordinary quit.
3465 If the value equals `throw-on-input', that means quit by throwing
3466 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3467 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3468 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3471 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3472 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3473 Note that `quit-flag' will still be set by typing C-g,
3474 so a quit will be signaled as soon as `inhibit-quit' is nil.
3475 To prevent this happening, set `quit-flag' to nil
3476 before making `inhibit-quit' nil. */);
3477 Vinhibit_quit
= Qnil
;
3479 DEFSYM (Qinhibit_quit
, "inhibit-quit");
3480 DEFSYM (Qautoload
, "autoload");
3481 DEFSYM (Qdebug_on_error
, "debug-on-error");
3482 DEFSYM (Qmacro
, "macro");
3483 DEFSYM (Qdeclare
, "declare");
3485 /* Note that the process handling also uses Qexit, but we don't want
3486 to staticpro it twice, so we just do it here. */
3487 DEFSYM (Qexit
, "exit");
3489 DEFSYM (Qinteractive
, "interactive");
3490 DEFSYM (Qcommandp
, "commandp");
3491 DEFSYM (Qand_rest
, "&rest");
3492 DEFSYM (Qand_optional
, "&optional");
3493 DEFSYM (Qclosure
, "closure");
3494 DEFSYM (Qdebug
, "debug");
3496 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3497 doc
: /* Non-nil means enter debugger if an error is signaled.
3498 Does not apply to errors handled by `condition-case' or those
3499 matched by `debug-ignored-errors'.
3500 If the value is a list, an error only means to enter the debugger
3501 if one of its condition symbols appears in the list.
3502 When you evaluate an expression interactively, this variable
3503 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3504 The command `toggle-debug-on-error' toggles this.
3505 See also the variable `debug-on-quit'. */);
3506 Vdebug_on_error
= Qnil
;
3508 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3509 doc
: /* List of errors for which the debugger should not be called.
3510 Each element may be a condition-name or a regexp that matches error messages.
3511 If any element applies to a given error, that error skips the debugger
3512 and just returns to top level.
3513 This overrides the variable `debug-on-error'.
3514 It does not apply to errors handled by `condition-case'. */);
3515 Vdebug_ignored_errors
= Qnil
;
3517 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3518 doc
: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
3519 Does not apply if quit is handled by a `condition-case'. */);
3522 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3523 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3525 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3526 doc
: /* Non-nil means debugger may continue execution.
3527 This is nil when the debugger is called under circumstances where it
3528 might not be safe to continue. */);
3529 debugger_may_continue
= 1;
3531 DEFVAR_LISP ("debugger", Vdebugger
,
3532 doc
: /* Function to call to invoke debugger.
3533 If due to frame exit, args are `exit' and the value being returned;
3534 this function's value will be returned instead of that.
3535 If due to error, args are `error' and a list of the args to `signal'.
3536 If due to `apply' or `funcall' entry, one arg, `lambda'.
3537 If due to `eval' entry, one arg, t. */);
3540 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3541 doc
: /* If non-nil, this is a function for `signal' to call.
3542 It receives the same arguments that `signal' was given.
3543 The Edebug package uses this to regain control. */);
3544 Vsignal_hook_function
= Qnil
;
3546 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3547 doc
: /* Non-nil means call the debugger regardless of condition handlers.
3548 Note that `debug-on-error', `debug-on-quit' and friends
3549 still determine whether to handle the particular condition. */);
3550 Vdebug_on_signal
= Qnil
;
3552 /* When lexical binding is being used,
3553 Vinternal_interpreter_environment is non-nil, and contains an alist
3554 of lexically-bound variable, or (t), indicating an empty
3555 environment. The lisp name of this variable would be
3556 `internal-interpreter-environment' if it weren't hidden.
3557 Every element of this list can be either a cons (VAR . VAL)
3558 specifying a lexical binding, or a single symbol VAR indicating
3559 that this variable should use dynamic scoping. */
3560 DEFSYM (Qinternal_interpreter_environment
,
3561 "internal-interpreter-environment");
3562 DEFVAR_LISP ("internal-interpreter-environment",
3563 Vinternal_interpreter_environment
,
3564 doc
: /* If non-nil, the current lexical environment of the lisp interpreter.
3565 When lexical binding is not being used, this variable is nil.
3566 A value of `(t)' indicates an empty environment, otherwise it is an
3567 alist of active lexical bindings. */);
3568 Vinternal_interpreter_environment
= Qnil
;
3569 /* Don't export this variable to Elisp, so no one can mess with it
3570 (Just imagine if someone makes it buffer-local). */
3571 Funintern (Qinternal_interpreter_environment
, Qnil
);
3573 DEFSYM (Vrun_hooks
, "run-hooks");
3575 staticpro (&Vautoload_queue
);
3576 Vautoload_queue
= Qnil
;
3577 staticpro (&Vsignaling_function
);
3578 Vsignaling_function
= Qnil
;
3580 inhibit_lisp_code
= Qnil
;
3591 defsubr (&Sfunction
);
3593 defsubr (&Sdefvaralias
);
3594 defsubr (&Sdefconst
);
3595 defsubr (&Smake_var_non_special
);
3599 defsubr (&Smacroexpand
);
3602 defsubr (&Sunwind_protect
);
3603 defsubr (&Scondition_case
);
3605 defsubr (&Sinteractive_p
);
3606 defsubr (&Scalled_interactively_p
);
3607 defsubr (&Scommandp
);
3608 defsubr (&Sautoload
);
3611 defsubr (&Sfuncall
);
3612 defsubr (&Srun_hooks
);
3613 defsubr (&Srun_hook_with_args
);
3614 defsubr (&Srun_hook_with_args_until_success
);
3615 defsubr (&Srun_hook_with_args_until_failure
);
3616 defsubr (&Srun_hook_wrapped
);
3617 defsubr (&Sfetch_bytecode
);
3618 defsubr (&Sbacktrace_debug
);
3619 defsubr (&Sbacktrace
);
3620 defsubr (&Sbacktrace_frame
);
3621 defsubr (&Sspecial_variable_p
);
3622 defsubr (&Sfunctionp
);