1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1999-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #include "blockinput.h"
26 #include "dispextern.h"
27 #include "frame.h" /* For XFRAME. */
33 /* This definition is duplicated in alloc.c and keyboard.c. */
34 /* Putting it in lisp.h makes cc bomb out! */
38 struct backtrace
*next
;
39 Lisp_Object
*function
;
40 Lisp_Object
*args
; /* Points to vector of args. */
41 #define NARGS_BITS (BITS_PER_INT - 2)
42 /* Let's not use size_t because we want to allow negative values (for
43 UNEVALLED). Also let's steal 2 bits so we save a word (or more for
44 alignment). In any case I doubt Emacs would survive a function call with
45 more than 500M arguments. */
46 int nargs
: NARGS_BITS
; /* Length of vector.
47 If nargs is UNEVALLED, args points
48 to slot holding list of unevalled args. */
50 /* Nonzero means call value of debugger when done with this operation. */
51 char debug_on_exit
: 1;
54 struct backtrace
*backtrace_list
;
55 struct catchtag
*catchlist
;
58 /* Count levels of GCPRO to detect failure to UNGCPRO. */
62 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
63 Lisp_Object Qinhibit_quit
;
64 Lisp_Object Qand_rest
, Qand_optional
;
65 Lisp_Object Qdebug_on_error
;
67 Lisp_Object Qinternal_interpreter_environment
, Qclosure
;
71 /* This holds either the symbol `run-hooks' or nil.
72 It is nil at an early stage of startup, and when Emacs
75 Lisp_Object Vrun_hooks
;
77 /* Non-nil means record all fset's and provide's, to be undone
78 if the file being autoloaded is not fully loaded.
79 They are recorded by being consed onto the front of Vautoload_queue:
80 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
82 Lisp_Object Vautoload_queue
;
84 /* Current number of specbindings allocated in specpdl. */
86 EMACS_INT specpdl_size
;
88 /* Pointer to beginning of specpdl. */
90 struct specbinding
*specpdl
;
92 /* Pointer to first unused element in specpdl. */
94 struct specbinding
*specpdl_ptr
;
96 /* Depth in Lisp evaluations and function calls. */
98 EMACS_INT lisp_eval_depth
;
100 /* The value of num_nonmacro_input_events as of the last time we
101 started to enter the debugger. If we decide to enter the debugger
102 again when this is still equal to num_nonmacro_input_events, then we
103 know that the debugger itself has an error, and we should just
104 signal the error instead of entering an infinite loop of debugger
107 int when_entered_debugger
;
109 /* The function from which the last `signal' was called. Set in
112 Lisp_Object Vsignaling_function
;
114 /* Set to non-zero while processing X events. Checked in Feval to
115 make sure the Lisp interpreter isn't called from a signal handler,
116 which is unsafe because the interpreter isn't reentrant. */
120 static Lisp_Object
funcall_lambda (Lisp_Object
, size_t, Lisp_Object
*);
121 static void unwind_to_catch (struct catchtag
*, Lisp_Object
) NO_RETURN
;
122 static int interactive_p (int);
123 static Lisp_Object
apply_lambda (Lisp_Object fun
, Lisp_Object args
);
126 init_eval_once (void)
129 specpdl
= (struct specbinding
*) xmalloc (specpdl_size
* sizeof (struct specbinding
));
130 specpdl_ptr
= specpdl
;
131 /* Don't forget to update docs (lispref node "Local Variables"). */
132 max_specpdl_size
= 1300; /* 1000 is not enough for CEDET's c-by.el. */
133 max_lisp_eval_depth
= 600;
141 specpdl_ptr
= specpdl
;
146 debug_on_next_call
= 0;
151 /* This is less than the initial value of num_nonmacro_input_events. */
152 when_entered_debugger
= -1;
155 /* Unwind-protect function used by call_debugger. */
158 restore_stack_limits (Lisp_Object data
)
160 max_specpdl_size
= XINT (XCAR (data
));
161 max_lisp_eval_depth
= XINT (XCDR (data
));
165 /* Call the Lisp debugger, giving it argument ARG. */
168 call_debugger (Lisp_Object arg
)
170 int debug_while_redisplaying
;
171 int count
= SPECPDL_INDEX ();
173 EMACS_INT old_max
= max_specpdl_size
;
175 /* Temporarily bump up the stack limits,
176 so the debugger won't run out of stack. */
178 max_specpdl_size
+= 1;
179 record_unwind_protect (restore_stack_limits
,
180 Fcons (make_number (old_max
),
181 make_number (max_lisp_eval_depth
)));
182 max_specpdl_size
= old_max
;
184 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
185 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
187 if (SPECPDL_INDEX () + 100 > max_specpdl_size
)
188 max_specpdl_size
= SPECPDL_INDEX () + 100;
190 #ifdef HAVE_WINDOW_SYSTEM
191 if (display_hourglass_p
)
195 debug_on_next_call
= 0;
196 when_entered_debugger
= num_nonmacro_input_events
;
198 /* Resetting redisplaying_p to 0 makes sure that debug output is
199 displayed if the debugger is invoked during redisplay. */
200 debug_while_redisplaying
= redisplaying_p
;
202 specbind (intern ("debugger-may-continue"),
203 debug_while_redisplaying
? Qnil
: Qt
);
204 specbind (Qinhibit_redisplay
, Qnil
);
205 specbind (Qdebug_on_error
, Qnil
);
207 #if 0 /* Binding this prevents execution of Lisp code during
208 redisplay, which necessarily leads to display problems. */
209 specbind (Qinhibit_eval_during_redisplay
, Qt
);
212 val
= apply1 (Vdebugger
, arg
);
214 /* Interrupting redisplay and resuming it later is not safe under
215 all circumstances. So, when the debugger returns, abort the
216 interrupted redisplay by going back to the top-level. */
217 if (debug_while_redisplaying
)
220 return unbind_to (count
, val
);
224 do_debug_on_call (Lisp_Object code
)
226 debug_on_next_call
= 0;
227 backtrace_list
->debug_on_exit
= 1;
228 call_debugger (Fcons (code
, Qnil
));
231 /* NOTE!!! Every function that can call EVAL must protect its args
232 and temporaries from garbage collection while it needs them.
233 The definition of `For' shows what you have to do. */
235 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
236 doc
: /* Eval args until one of them yields non-nil, then return that value.
237 The remaining args are not evalled at all.
238 If all args return nil, return nil.
239 usage: (or CONDITIONS...) */)
242 register Lisp_Object val
= Qnil
;
249 val
= eval_sub (XCAR (args
));
259 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
260 doc
: /* Eval args until one of them yields nil, then return nil.
261 The remaining args are not evalled at all.
262 If no arg yields nil, return the last arg's value.
263 usage: (and CONDITIONS...) */)
266 register Lisp_Object val
= Qt
;
273 val
= eval_sub (XCAR (args
));
283 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
284 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
285 Returns the value of THEN or the value of the last of the ELSE's.
286 THEN must be one expression, but ELSE... can be zero or more expressions.
287 If COND yields nil, and there are no ELSE's, the value is nil.
288 usage: (if COND THEN ELSE...) */)
291 register Lisp_Object cond
;
295 cond
= eval_sub (Fcar (args
));
299 return eval_sub (Fcar (Fcdr (args
)));
300 return Fprogn (Fcdr (Fcdr (args
)));
303 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
304 doc
: /* Try each clause until one succeeds.
305 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
306 and, if the value is non-nil, this clause succeeds:
307 then the expressions in BODY are evaluated and the last one's
308 value is the value of the cond-form.
309 If no clause succeeds, cond returns nil.
310 If a clause has one element, as in (CONDITION),
311 CONDITION's value if non-nil is returned from the cond-form.
312 usage: (cond CLAUSES...) */)
315 register Lisp_Object clause
, val
;
322 clause
= Fcar (args
);
323 val
= eval_sub (Fcar (clause
));
326 if (!EQ (XCDR (clause
), Qnil
))
327 val
= Fprogn (XCDR (clause
));
337 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
338 doc
: /* Eval BODY forms sequentially and return value of last one.
339 usage: (progn BODY...) */)
342 register Lisp_Object val
= Qnil
;
349 val
= eval_sub (XCAR (args
));
357 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
358 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
359 The value of FIRST is saved during the evaluation of the remaining args,
360 whose values are discarded.
361 usage: (prog1 FIRST BODY...) */)
365 register Lisp_Object args_left
;
366 struct gcpro gcpro1
, gcpro2
;
367 register int argnum
= 0;
378 Lisp_Object tem
= eval_sub (XCAR (args_left
));
381 args_left
= XCDR (args_left
);
383 while (CONSP (args_left
));
389 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
390 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
391 The value of FORM2 is saved during the evaluation of the
392 remaining args, whose values are discarded.
393 usage: (prog2 FORM1 FORM2 BODY...) */)
397 register Lisp_Object args_left
;
398 struct gcpro gcpro1
, gcpro2
;
399 register int argnum
= -1;
412 Lisp_Object tem
= eval_sub (XCAR (args_left
));
415 args_left
= XCDR (args_left
);
417 while (CONSP (args_left
));
423 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
424 doc
: /* Set each SYM to the value of its VAL.
425 The symbols SYM are variables; they are literal (not evaluated).
426 The values VAL are expressions; they are evaluated.
427 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
428 The second VAL is not computed until after the first SYM is set, and so on;
429 each VAL can use the new value of variables set earlier in the `setq'.
430 The return value of the `setq' form is the value of the last VAL.
431 usage: (setq [SYM VAL]...) */)
434 register Lisp_Object args_left
;
435 register Lisp_Object val
, sym
, lex_binding
;
446 val
= eval_sub (Fcar (Fcdr (args_left
)));
447 sym
= Fcar (args_left
);
449 /* Like for eval_sub, we do not check declared_special here since
450 it's been done when let-binding. */
451 if (!NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
453 && !NILP (lex_binding
454 = Fassq (sym
, Vinternal_interpreter_environment
)))
455 XSETCDR (lex_binding
, val
); /* SYM is lexically bound. */
457 Fset (sym
, val
); /* SYM is dynamically bound. */
459 args_left
= Fcdr (Fcdr (args_left
));
461 while (!NILP(args_left
));
467 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
468 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
469 usage: (quote ARG) */)
472 if (!NILP (Fcdr (args
)))
473 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
477 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
478 doc
: /* Like `quote', but preferred for objects which are functions.
479 In byte compilation, `function' causes its argument to be compiled.
480 `quote' cannot do that.
481 usage: (function ARG) */)
484 Lisp_Object quoted
= XCAR (args
);
486 if (!NILP (Fcdr (args
)))
487 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
489 if (!NILP (Vinternal_interpreter_environment
)
491 && EQ (XCAR (quoted
), Qlambda
))
492 /* This is a lambda expression within a lexical environment;
493 return an interpreted closure instead of a simple lambda. */
494 return Fcons (Qclosure
, Fcons (Vinternal_interpreter_environment
,
497 /* Simply quote the argument. */
502 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
503 doc
: /* Return t if the containing function was run directly by user input.
504 This means that the function was called with `call-interactively'
505 \(which includes being called as the binding of a key)
506 and input is currently coming from the keyboard (not a keyboard macro),
507 and Emacs is not running in batch mode (`noninteractive' is nil).
509 The only known proper use of `interactive-p' is in deciding whether to
510 display a helpful message, or how to display it. If you're thinking
511 of using it for any other purpose, it is quite likely that you're
512 making a mistake. Think: what do you want to do when the command is
513 called from a keyboard macro?
515 To test whether your function was called with `call-interactively',
516 either (i) add an extra optional argument and give it an `interactive'
517 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
518 use `called-interactively-p'. */)
521 return interactive_p (1) ? Qt
: Qnil
;
525 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
526 doc
: /* Return t if the containing function was called by `call-interactively'.
527 If KIND is `interactive', then only return t if the call was made
528 interactively by the user, i.e. not in `noninteractive' mode nor
529 when `executing-kbd-macro'.
530 If KIND is `any', on the other hand, it will return t for any kind of
531 interactive call, including being called as the binding of a key, or
532 from a keyboard macro, or in `noninteractive' mode.
534 The only known proper use of `interactive' for KIND is in deciding
535 whether to display a helpful message, or how to display it. If you're
536 thinking of using it for any other purpose, it is quite likely that
537 you're making a mistake. Think: what do you want to do when the
538 command is called from a keyboard macro?
540 This function is meant for implementing advice and other
541 function-modifying features. Instead of using this, it is sometimes
542 cleaner to give your function an extra optional argument whose
543 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
544 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
547 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
548 && interactive_p (1)) ? Qt
: Qnil
;
552 /* Return 1 if function in which this appears was called using
555 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
556 called is a built-in. */
559 interactive_p (int exclude_subrs_p
)
561 struct backtrace
*btp
;
564 btp
= backtrace_list
;
566 /* If this isn't a byte-compiled function, there may be a frame at
567 the top for Finteractive_p. If so, skip it. */
568 fun
= Findirect_function (*btp
->function
, Qnil
);
569 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
570 || XSUBR (fun
) == &Scalled_interactively_p
))
573 /* If we're running an Emacs 18-style byte-compiled function, there
574 may be a frame for Fbytecode at the top level. In any version of
575 Emacs there can be Fbytecode frames for subexpressions evaluated
576 inside catch and condition-case. Skip past them.
578 If this isn't a byte-compiled function, then we may now be
579 looking at several frames for special forms. Skip past them. */
581 && (EQ (*btp
->function
, Qbytecode
)
582 || btp
->nargs
== UNEVALLED
))
585 /* `btp' now points at the frame of the innermost function that isn't
586 a special form, ignoring frames for Finteractive_p and/or
587 Fbytecode at the top. If this frame is for a built-in function
588 (such as load or eval-region) return nil. */
589 fun
= Findirect_function (*btp
->function
, Qnil
);
590 if (exclude_subrs_p
&& SUBRP (fun
))
593 /* `btp' points to the frame of a Lisp function that called interactive-p.
594 Return t if that function was called interactively. */
595 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
601 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
602 doc
: /* Define NAME as a function.
603 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
604 See also the function `interactive'.
605 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
608 register Lisp_Object fn_name
;
609 register Lisp_Object defn
;
611 fn_name
= Fcar (args
);
612 CHECK_SYMBOL (fn_name
);
613 defn
= Fcons (Qlambda
, Fcdr (args
));
614 if (!NILP (Vinternal_interpreter_environment
)) /* Mere optimization! */
615 defn
= Ffunction (Fcons (defn
, Qnil
));
616 if (!NILP (Vpurify_flag
))
617 defn
= Fpurecopy (defn
);
618 if (CONSP (XSYMBOL (fn_name
)->function
)
619 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
620 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
621 Ffset (fn_name
, defn
);
622 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
626 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
627 doc
: /* Define NAME as a macro.
628 The actual definition looks like
629 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
630 When the macro is called, as in (NAME ARGS...),
631 the function (lambda ARGLIST BODY...) is applied to
632 the list ARGS... as it appears in the expression,
633 and the result should be a form to be evaluated instead of the original.
635 DECL is a declaration, optional, which can specify how to indent
636 calls to this macro, how Edebug should handle it, and which argument
637 should be treated as documentation. It looks like this:
639 The elements can look like this:
641 Set NAME's `lisp-indent-function' property to INDENT.
644 Set NAME's `edebug-form-spec' property to DEBUG. (This is
645 equivalent to writing a `def-edebug-spec' for the macro.)
648 Set NAME's `doc-string-elt' property to ELT.
650 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
653 register Lisp_Object fn_name
;
654 register Lisp_Object defn
;
655 Lisp_Object lambda_list
, doc
, tail
;
657 fn_name
= Fcar (args
);
658 CHECK_SYMBOL (fn_name
);
659 lambda_list
= Fcar (Fcdr (args
));
660 tail
= Fcdr (Fcdr (args
));
663 if (STRINGP (Fcar (tail
)))
669 if (CONSP (Fcar (tail
))
670 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
672 if (!NILP (Vmacro_declaration_function
))
676 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
684 tail
= Fcons (lambda_list
, tail
);
686 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
688 defn
= Fcons (Qlambda
, tail
);
689 if (!NILP (Vinternal_interpreter_environment
)) /* Mere optimization! */
690 defn
= Ffunction (Fcons (defn
, Qnil
));
691 defn
= Fcons (Qmacro
, defn
);
693 if (!NILP (Vpurify_flag
))
694 defn
= Fpurecopy (defn
);
695 if (CONSP (XSYMBOL (fn_name
)->function
)
696 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
697 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
698 Ffset (fn_name
, defn
);
699 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
704 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
705 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
706 Aliased variables always have the same value; setting one sets the other.
707 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
708 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
709 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
710 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
711 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
712 The return value is BASE-VARIABLE. */)
713 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
715 struct Lisp_Symbol
*sym
;
717 CHECK_SYMBOL (new_alias
);
718 CHECK_SYMBOL (base_variable
);
720 sym
= XSYMBOL (new_alias
);
723 /* Not sure why, but why not? */
724 error ("Cannot make a constant an alias");
726 switch (sym
->redirect
)
728 case SYMBOL_FORWARDED
:
729 error ("Cannot make an internal variable an alias");
730 case SYMBOL_LOCALIZED
:
731 error ("Don't know how to make a localized variable an alias");
734 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
735 If n_a is bound, but b_v is not, set the value of b_v to n_a,
736 so that old-code that affects n_a before the aliasing is setup
738 if (NILP (Fboundp (base_variable
)))
739 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
742 struct specbinding
*p
;
744 for (p
= specpdl_ptr
- 1; p
>= specpdl
; p
--)
747 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
748 error ("Don't know how to make a let-bound variable an alias");
751 sym
->declared_special
= 1;
752 sym
->redirect
= SYMBOL_VARALIAS
;
753 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
754 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
755 LOADHIST_ATTACH (new_alias
);
756 /* Even if docstring is nil: remove old docstring. */
757 Fput (new_alias
, Qvariable_documentation
, docstring
);
759 return base_variable
;
763 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
764 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
765 You are not required to define a variable in order to use it,
766 but the definition can supply documentation and an initial value
767 in a way that tags can recognize.
769 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
770 If SYMBOL is buffer-local, its default value is what is set;
771 buffer-local values are not affected.
772 INITVALUE and DOCSTRING are optional.
773 If DOCSTRING starts with *, this variable is identified as a user option.
774 This means that M-x set-variable recognizes it.
775 See also `user-variable-p'.
776 If INITVALUE is missing, SYMBOL's value is not set.
778 If SYMBOL has a local binding, then this form affects the local
779 binding. This is usually not what you want. Thus, if you need to
780 load a file defining variables, with this form or with `defconst' or
781 `defcustom', you should always load that file _outside_ any bindings
782 for these variables. \(`defconst' and `defcustom' behave similarly in
784 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
787 register Lisp_Object sym
, tem
, tail
;
791 if (!NILP (Fcdr (Fcdr (tail
))))
792 error ("Too many arguments");
794 tem
= Fdefault_boundp (sym
);
797 /* Do it before evaluating the initial value, for self-references. */
798 XSYMBOL (sym
)->declared_special
= 1;
800 if (SYMBOL_CONSTANT_P (sym
))
802 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
803 Lisp_Object tem1
= Fcar (tail
);
805 && EQ (XCAR (tem1
), Qquote
)
806 && CONSP (XCDR (tem1
))
807 && EQ (XCAR (XCDR (tem1
)), sym
)))
808 error ("Constant symbol `%s' specified in defvar",
809 SDATA (SYMBOL_NAME (sym
)));
813 Fset_default (sym
, eval_sub (Fcar (tail
)));
815 { /* Check if there is really a global binding rather than just a let
816 binding that shadows the global unboundness of the var. */
817 volatile struct specbinding
*pdl
= specpdl_ptr
;
818 while (--pdl
>= specpdl
)
820 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
821 && EQ (pdl
->old_value
, Qunbound
))
823 message_with_string ("Warning: defvar ignored because %s is let-bound",
824 SYMBOL_NAME (sym
), 1);
833 if (!NILP (Vpurify_flag
))
834 tem
= Fpurecopy (tem
);
835 Fput (sym
, Qvariable_documentation
, tem
);
837 LOADHIST_ATTACH (sym
);
839 else if (!NILP (Vinternal_interpreter_environment
)
840 && !XSYMBOL (sym
)->declared_special
)
841 /* A simple (defvar foo) with lexical scoping does "nothing" except
842 declare that var to be dynamically scoped *locally* (i.e. within
843 the current file or let-block). */
844 Vinternal_interpreter_environment
=
845 Fcons (sym
, Vinternal_interpreter_environment
);
848 /* Simple (defvar <var>) should not count as a definition at all.
849 It could get in the way of other definitions, and unloading this
850 package could try to make the variable unbound. */
856 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
857 doc
: /* Define SYMBOL as a constant variable.
858 The intent is that neither programs nor users should ever change this value.
859 Always sets the value of SYMBOL to the result of evalling INITVALUE.
860 If SYMBOL is buffer-local, its default value is what is set;
861 buffer-local values are not affected.
862 DOCSTRING is optional.
864 If SYMBOL has a local binding, then this form sets the local binding's
865 value. However, you should normally not make local bindings for
866 variables defined with this form.
867 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
870 register Lisp_Object sym
, tem
;
873 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
874 error ("Too many arguments");
876 tem
= eval_sub (Fcar (Fcdr (args
)));
877 if (!NILP (Vpurify_flag
))
878 tem
= Fpurecopy (tem
);
879 Fset_default (sym
, tem
);
880 XSYMBOL (sym
)->declared_special
= 1;
881 tem
= Fcar (Fcdr (Fcdr (args
)));
884 if (!NILP (Vpurify_flag
))
885 tem
= Fpurecopy (tem
);
886 Fput (sym
, Qvariable_documentation
, tem
);
888 Fput (sym
, Qrisky_local_variable
, Qt
);
889 LOADHIST_ATTACH (sym
);
893 /* Error handler used in Fuser_variable_p. */
895 user_variable_p_eh (Lisp_Object ignore
)
901 lisp_indirect_variable (Lisp_Object sym
)
903 struct Lisp_Symbol
*s
= indirect_variable (XSYMBOL (sym
));
908 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
909 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
910 \(The alternative is a variable used internally in a Lisp program.)
911 A variable is a user variable if
912 \(1) the first character of its documentation is `*', or
913 \(2) it is customizable (its property list contains a non-nil value
914 of `standard-value' or `custom-autoload'), or
915 \(3) it is an alias for another user variable.
916 Return nil if VARIABLE is an alias and there is a loop in the
917 chain of symbols. */)
918 (Lisp_Object variable
)
920 Lisp_Object documentation
;
922 if (!SYMBOLP (variable
))
925 /* If indirect and there's an alias loop, don't check anything else. */
926 if (XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
927 && NILP (internal_condition_case_1 (lisp_indirect_variable
, variable
,
928 Qt
, user_variable_p_eh
)))
933 documentation
= Fget (variable
, Qvariable_documentation
);
934 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
936 if (STRINGP (documentation
)
937 && ((unsigned char) SREF (documentation
, 0) == '*'))
939 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
940 if (CONSP (documentation
)
941 && STRINGP (XCAR (documentation
))
942 && INTEGERP (XCDR (documentation
))
943 && XINT (XCDR (documentation
)) < 0)
945 /* Customizable? See `custom-variable-p'. */
946 if ((!NILP (Fget (variable
, intern ("standard-value"))))
947 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
950 if (!(XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
))
953 /* An indirect variable? Let's follow the chain. */
954 XSETSYMBOL (variable
, SYMBOL_ALIAS (XSYMBOL (variable
)));
958 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
959 doc
: /* Bind variables according to VARLIST then eval BODY.
960 The value of the last form in BODY is returned.
961 Each element of VARLIST is a symbol (which is bound to nil)
962 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
963 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
964 usage: (let* VARLIST BODY...) */)
967 Lisp_Object varlist
, var
, val
, elt
, lexenv
;
968 int count
= SPECPDL_INDEX ();
969 struct gcpro gcpro1
, gcpro2
, gcpro3
;
971 GCPRO3 (args
, elt
, varlist
);
973 lexenv
= Vinternal_interpreter_environment
;
975 varlist
= Fcar (args
);
976 while (CONSP (varlist
))
980 elt
= XCAR (varlist
);
986 else if (! NILP (Fcdr (Fcdr (elt
))))
987 signal_error ("`let' bindings can have only one value-form", elt
);
991 val
= eval_sub (Fcar (Fcdr (elt
)));
994 if (!NILP (lexenv
) && SYMBOLP (var
)
995 && !XSYMBOL (var
)->declared_special
996 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
997 /* Lexically bind VAR by adding it to the interpreter's binding
1001 = Fcons (Fcons (var
, val
), Vinternal_interpreter_environment
);
1002 if (EQ (Vinternal_interpreter_environment
, lexenv
))
1003 /* Save the old lexical environment on the specpdl stack,
1004 but only for the first lexical binding, since we'll never
1005 need to revert to one of the intermediate ones. */
1006 specbind (Qinternal_interpreter_environment
, newenv
);
1008 Vinternal_interpreter_environment
= newenv
;
1011 specbind (var
, val
);
1013 varlist
= XCDR (varlist
);
1016 val
= Fprogn (Fcdr (args
));
1017 return unbind_to (count
, val
);
1020 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1021 doc
: /* Bind variables according to VARLIST then eval BODY.
1022 The value of the last form in BODY is returned.
1023 Each element of VARLIST is a symbol (which is bound to nil)
1024 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1025 All the VALUEFORMs are evalled before any symbols are bound.
1026 usage: (let VARLIST BODY...) */)
1029 Lisp_Object
*temps
, tem
, lexenv
;
1030 register Lisp_Object elt
, varlist
;
1031 int count
= SPECPDL_INDEX ();
1032 register size_t argnum
;
1033 struct gcpro gcpro1
, gcpro2
;
1036 varlist
= Fcar (args
);
1038 /* Make space to hold the values to give the bound variables. */
1039 elt
= Flength (varlist
);
1040 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
1042 /* Compute the values and store them in `temps'. */
1044 GCPRO2 (args
, *temps
);
1047 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1050 elt
= XCAR (varlist
);
1052 temps
[argnum
++] = Qnil
;
1053 else if (! NILP (Fcdr (Fcdr (elt
))))
1054 signal_error ("`let' bindings can have only one value-form", elt
);
1056 temps
[argnum
++] = eval_sub (Fcar (Fcdr (elt
)));
1057 gcpro2
.nvars
= argnum
;
1061 lexenv
= Vinternal_interpreter_environment
;
1063 varlist
= Fcar (args
);
1064 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1068 elt
= XCAR (varlist
);
1069 var
= SYMBOLP (elt
) ? elt
: Fcar (elt
);
1070 tem
= temps
[argnum
++];
1072 if (!NILP (lexenv
) && SYMBOLP (var
)
1073 && !XSYMBOL (var
)->declared_special
1074 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
1075 /* Lexically bind VAR by adding it to the lexenv alist. */
1076 lexenv
= Fcons (Fcons (var
, tem
), lexenv
);
1078 /* Dynamically bind VAR. */
1079 specbind (var
, tem
);
1082 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
1083 /* Instantiate a new lexical environment. */
1084 specbind (Qinternal_interpreter_environment
, lexenv
);
1086 elt
= Fprogn (Fcdr (args
));
1088 return unbind_to (count
, elt
);
1091 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1092 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1093 The order of execution is thus TEST, BODY, TEST, BODY and so on
1094 until TEST returns nil.
1095 usage: (while TEST BODY...) */)
1098 Lisp_Object test
, body
;
1099 struct gcpro gcpro1
, gcpro2
;
1101 GCPRO2 (test
, body
);
1105 while (!NILP (eval_sub (test
)))
1115 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1116 doc
: /* Return result of expanding macros at top level of FORM.
1117 If FORM is not a macro call, it is returned unchanged.
1118 Otherwise, the macro is expanded and the expansion is considered
1119 in place of FORM. When a non-macro-call results, it is returned.
1121 The second optional arg ENVIRONMENT specifies an environment of macro
1122 definitions to shadow the loaded ones for use in file byte-compilation. */)
1123 (Lisp_Object form
, Lisp_Object environment
)
1125 /* With cleanups from Hallvard Furuseth. */
1126 register Lisp_Object expander
, sym
, def
, tem
;
1130 /* Come back here each time we expand a macro call,
1131 in case it expands into another macro call. */
1134 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1135 def
= sym
= XCAR (form
);
1137 /* Trace symbols aliases to other symbols
1138 until we get a symbol that is not an alias. */
1139 while (SYMBOLP (def
))
1143 tem
= Fassq (sym
, environment
);
1146 def
= XSYMBOL (sym
)->function
;
1147 if (!EQ (def
, Qunbound
))
1152 /* Right now TEM is the result from SYM in ENVIRONMENT,
1153 and if TEM is nil then DEF is SYM's function definition. */
1156 /* SYM is not mentioned in ENVIRONMENT.
1157 Look at its function definition. */
1158 if (EQ (def
, Qunbound
) || !CONSP (def
))
1159 /* Not defined or definition not suitable. */
1161 if (EQ (XCAR (def
), Qautoload
))
1163 /* Autoloading function: will it be a macro when loaded? */
1164 tem
= Fnth (make_number (4), def
);
1165 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1166 /* Yes, load it and try again. */
1168 struct gcpro gcpro1
;
1170 do_autoload (def
, sym
);
1177 else if (!EQ (XCAR (def
), Qmacro
))
1179 else expander
= XCDR (def
);
1183 expander
= XCDR (tem
);
1184 if (NILP (expander
))
1187 form
= apply1 (expander
, XCDR (form
));
1192 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1193 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1194 TAG is evalled to get the tag to use; it must not be nil.
1196 Then the BODY is executed.
1197 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1198 If no throw happens, `catch' returns the value of the last BODY form.
1199 If a throw happens, it specifies the value to return from `catch'.
1200 usage: (catch TAG BODY...) */)
1203 register Lisp_Object tag
;
1204 struct gcpro gcpro1
;
1207 tag
= eval_sub (Fcar (args
));
1209 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1212 /* Set up a catch, then call C function FUNC on argument ARG.
1213 FUNC should return a Lisp_Object.
1214 This is how catches are done from within C code. */
1217 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1219 /* This structure is made part of the chain `catchlist'. */
1222 /* Fill in the components of c, and put it on the list. */
1226 c
.backlist
= backtrace_list
;
1227 c
.handlerlist
= handlerlist
;
1228 c
.lisp_eval_depth
= lisp_eval_depth
;
1229 c
.pdlcount
= SPECPDL_INDEX ();
1230 c
.poll_suppress_count
= poll_suppress_count
;
1231 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1232 c
.gcpro
= gcprolist
;
1233 c
.byte_stack
= byte_stack_list
;
1237 if (! _setjmp (c
.jmp
))
1238 c
.val
= (*func
) (arg
);
1240 /* Throw works by a longjmp that comes right here. */
1245 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1246 jump to that CATCH, returning VALUE as the value of that catch.
1248 This is the guts Fthrow and Fsignal; they differ only in the way
1249 they choose the catch tag to throw to. A catch tag for a
1250 condition-case form has a TAG of Qnil.
1252 Before each catch is discarded, unbind all special bindings and
1253 execute all unwind-protect clauses made above that catch. Unwind
1254 the handler stack as we go, so that the proper handlers are in
1255 effect for each unwind-protect clause we run. At the end, restore
1256 some static info saved in CATCH, and longjmp to the location
1259 This is used for correct unwinding in Fthrow and Fsignal. */
1262 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1264 register int last_time
;
1266 /* Save the value in the tag. */
1269 /* Restore certain special C variables. */
1270 set_poll_suppress_count (catch->poll_suppress_count
);
1271 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1272 handling_signal
= 0;
1277 last_time
= catchlist
== catch;
1279 /* Unwind the specpdl stack, and then restore the proper set of
1281 unbind_to (catchlist
->pdlcount
, Qnil
);
1282 handlerlist
= catchlist
->handlerlist
;
1283 catchlist
= catchlist
->next
;
1285 while (! last_time
);
1288 /* If x_catch_errors was done, turn it off now.
1289 (First we give unbind_to a chance to do that.) */
1290 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1291 The catch must remain in effect during that delicate
1292 state. --lorentey */
1293 x_fully_uncatch_errors ();
1297 byte_stack_list
= catch->byte_stack
;
1298 gcprolist
= catch->gcpro
;
1300 gcpro_level
= gcprolist
? gcprolist
->level
+ 1 : 0;
1302 backtrace_list
= catch->backlist
;
1303 lisp_eval_depth
= catch->lisp_eval_depth
;
1305 _longjmp (catch->jmp
, 1);
1308 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1309 doc
: /* Throw to the catch for TAG and return VALUE from it.
1310 Both TAG and VALUE are evalled. */)
1311 (register Lisp_Object tag
, Lisp_Object value
)
1313 register struct catchtag
*c
;
1316 for (c
= catchlist
; c
; c
= c
->next
)
1318 if (EQ (c
->tag
, tag
))
1319 unwind_to_catch (c
, value
);
1321 xsignal2 (Qno_catch
, tag
, value
);
1325 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1326 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1327 If BODYFORM completes normally, its value is returned
1328 after executing the UNWINDFORMS.
1329 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1330 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1334 int count
= SPECPDL_INDEX ();
1336 record_unwind_protect (Fprogn
, Fcdr (args
));
1337 val
= eval_sub (Fcar (args
));
1338 return unbind_to (count
, val
);
1341 /* Chain of condition handlers currently in effect.
1342 The elements of this chain are contained in the stack frames
1343 of Fcondition_case and internal_condition_case.
1344 When an error is signaled (by calling Fsignal, below),
1345 this chain is searched for an element that applies. */
1347 struct handler
*handlerlist
;
1349 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1350 doc
: /* Regain control when an error is signaled.
1351 Executes BODYFORM and returns its value if no error happens.
1352 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1353 where the BODY is made of Lisp expressions.
1355 A handler is applicable to an error
1356 if CONDITION-NAME is one of the error's condition names.
1357 If an error happens, the first applicable handler is run.
1359 The car of a handler may be a list of condition names
1360 instead of a single condition name. Then it handles all of them.
1362 When a handler handles an error, control returns to the `condition-case'
1363 and it executes the handler's BODY...
1364 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1365 \(If VAR is nil, the handler can't access that information.)
1366 Then the value of the last BODY form is returned from the `condition-case'
1369 See also the function `signal' for more info.
1370 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1373 register Lisp_Object bodyform
, handlers
;
1374 volatile Lisp_Object var
;
1377 bodyform
= Fcar (Fcdr (args
));
1378 handlers
= Fcdr (Fcdr (args
));
1380 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1383 /* Like Fcondition_case, but the args are separate
1384 rather than passed in a list. Used by Fbyte_code. */
1387 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1388 Lisp_Object handlers
)
1396 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1402 && (SYMBOLP (XCAR (tem
))
1403 || CONSP (XCAR (tem
))))))
1404 error ("Invalid condition handler");
1409 c
.backlist
= backtrace_list
;
1410 c
.handlerlist
= handlerlist
;
1411 c
.lisp_eval_depth
= lisp_eval_depth
;
1412 c
.pdlcount
= SPECPDL_INDEX ();
1413 c
.poll_suppress_count
= poll_suppress_count
;
1414 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1415 c
.gcpro
= gcprolist
;
1416 c
.byte_stack
= byte_stack_list
;
1417 if (_setjmp (c
.jmp
))
1420 specbind (h
.var
, c
.val
);
1421 val
= Fprogn (Fcdr (h
.chosen_clause
));
1423 /* Note that this just undoes the binding of h.var; whoever
1424 longjumped to us unwound the stack to c.pdlcount before
1426 unbind_to (c
.pdlcount
, Qnil
);
1433 h
.handler
= handlers
;
1434 h
.next
= handlerlist
;
1438 val
= eval_sub (bodyform
);
1440 handlerlist
= h
.next
;
1444 /* Call the function BFUN with no arguments, catching errors within it
1445 according to HANDLERS. If there is an error, call HFUN with
1446 one argument which is the data that describes the error:
1449 HANDLERS can be a list of conditions to catch.
1450 If HANDLERS is Qt, catch all errors.
1451 If HANDLERS is Qerror, catch all errors
1452 but allow the debugger to run if that is enabled. */
1455 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1456 Lisp_Object (*hfun
) (Lisp_Object
))
1462 /* Since Fsignal will close off all calls to x_catch_errors,
1463 we will get the wrong results if some are not closed now. */
1465 if (x_catching_errors ())
1471 c
.backlist
= backtrace_list
;
1472 c
.handlerlist
= handlerlist
;
1473 c
.lisp_eval_depth
= lisp_eval_depth
;
1474 c
.pdlcount
= SPECPDL_INDEX ();
1475 c
.poll_suppress_count
= poll_suppress_count
;
1476 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1477 c
.gcpro
= gcprolist
;
1478 c
.byte_stack
= byte_stack_list
;
1479 if (_setjmp (c
.jmp
))
1481 return (*hfun
) (c
.val
);
1485 h
.handler
= handlers
;
1487 h
.next
= handlerlist
;
1493 handlerlist
= h
.next
;
1497 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1500 internal_condition_case_1 (Lisp_Object (*bfun
) (Lisp_Object
), Lisp_Object arg
,
1501 Lisp_Object handlers
, Lisp_Object (*hfun
) (Lisp_Object
))
1507 /* Since Fsignal will close off all calls to x_catch_errors,
1508 we will get the wrong results if some are not closed now. */
1510 if (x_catching_errors ())
1516 c
.backlist
= backtrace_list
;
1517 c
.handlerlist
= handlerlist
;
1518 c
.lisp_eval_depth
= lisp_eval_depth
;
1519 c
.pdlcount
= SPECPDL_INDEX ();
1520 c
.poll_suppress_count
= poll_suppress_count
;
1521 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1522 c
.gcpro
= gcprolist
;
1523 c
.byte_stack
= byte_stack_list
;
1524 if (_setjmp (c
.jmp
))
1526 return (*hfun
) (c
.val
);
1530 h
.handler
= handlers
;
1532 h
.next
= handlerlist
;
1536 val
= (*bfun
) (arg
);
1538 handlerlist
= h
.next
;
1542 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1546 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1549 Lisp_Object handlers
,
1550 Lisp_Object (*hfun
) (Lisp_Object
))
1556 /* Since Fsignal will close off all calls to x_catch_errors,
1557 we will get the wrong results if some are not closed now. */
1559 if (x_catching_errors ())
1565 c
.backlist
= backtrace_list
;
1566 c
.handlerlist
= handlerlist
;
1567 c
.lisp_eval_depth
= lisp_eval_depth
;
1568 c
.pdlcount
= SPECPDL_INDEX ();
1569 c
.poll_suppress_count
= poll_suppress_count
;
1570 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1571 c
.gcpro
= gcprolist
;
1572 c
.byte_stack
= byte_stack_list
;
1573 if (_setjmp (c
.jmp
))
1575 return (*hfun
) (c
.val
);
1579 h
.handler
= handlers
;
1581 h
.next
= handlerlist
;
1585 val
= (*bfun
) (arg1
, arg2
);
1587 handlerlist
= h
.next
;
1591 /* Like internal_condition_case but call BFUN with NARGS as first,
1592 and ARGS as second argument. */
1595 internal_condition_case_n (Lisp_Object (*bfun
) (size_t, Lisp_Object
*),
1598 Lisp_Object handlers
,
1599 Lisp_Object (*hfun
) (Lisp_Object
))
1605 /* Since Fsignal will close off all calls to x_catch_errors,
1606 we will get the wrong results if some are not closed now. */
1608 if (x_catching_errors ())
1614 c
.backlist
= backtrace_list
;
1615 c
.handlerlist
= handlerlist
;
1616 c
.lisp_eval_depth
= lisp_eval_depth
;
1617 c
.pdlcount
= SPECPDL_INDEX ();
1618 c
.poll_suppress_count
= poll_suppress_count
;
1619 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1620 c
.gcpro
= gcprolist
;
1621 c
.byte_stack
= byte_stack_list
;
1622 if (_setjmp (c
.jmp
))
1624 return (*hfun
) (c
.val
);
1628 h
.handler
= handlers
;
1630 h
.next
= handlerlist
;
1634 val
= (*bfun
) (nargs
, args
);
1636 handlerlist
= h
.next
;
1641 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
,
1642 Lisp_Object
, Lisp_Object
);
1643 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1646 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1647 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1648 This function does not return.
1650 An error symbol is a symbol with an `error-conditions' property
1651 that is a list of condition names.
1652 A handler for any of those names will get to handle this signal.
1653 The symbol `error' should normally be one of them.
1655 DATA should be a list. Its elements are printed as part of the error message.
1656 See Info anchor `(elisp)Definition of signal' for some details on how this
1657 error message is constructed.
1658 If the signal is handled, DATA is made available to the handler.
1659 See also the function `condition-case'. */)
1660 (Lisp_Object error_symbol
, Lisp_Object data
)
1662 /* When memory is full, ERROR-SYMBOL is nil,
1663 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1664 That is a special case--don't do this in other situations. */
1665 Lisp_Object conditions
;
1667 Lisp_Object real_error_symbol
1668 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1669 register Lisp_Object clause
= Qnil
;
1671 struct backtrace
*bp
;
1673 immediate_quit
= handling_signal
= 0;
1675 if (gc_in_progress
|| waiting_for_input
)
1678 #if 0 /* rms: I don't know why this was here,
1679 but it is surely wrong for an error that is handled. */
1680 #ifdef HAVE_WINDOW_SYSTEM
1681 if (display_hourglass_p
)
1682 cancel_hourglass ();
1686 /* This hook is used by edebug. */
1687 if (! NILP (Vsignal_hook_function
)
1688 && ! NILP (error_symbol
))
1690 /* Edebug takes care of restoring these variables when it exits. */
1691 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1692 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1694 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1695 max_specpdl_size
= SPECPDL_INDEX () + 40;
1697 call2 (Vsignal_hook_function
, error_symbol
, data
);
1700 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1702 /* Remember from where signal was called. Skip over the frame for
1703 `signal' itself. If a frame for `error' follows, skip that,
1704 too. Don't do this when ERROR_SYMBOL is nil, because that
1705 is a memory-full error. */
1706 Vsignaling_function
= Qnil
;
1707 if (backtrace_list
&& !NILP (error_symbol
))
1709 bp
= backtrace_list
->next
;
1710 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1712 if (bp
&& bp
->function
)
1713 Vsignaling_function
= *bp
->function
;
1716 for (h
= handlerlist
; h
; h
= h
->next
)
1718 clause
= find_handler_clause (h
->handler
, conditions
,
1719 error_symbol
, data
);
1724 if (/* Don't run the debugger for a memory-full error.
1725 (There is no room in memory to do that!) */
1726 !NILP (error_symbol
)
1727 && (!NILP (Vdebug_on_signal
)
1728 /* If no handler is present now, try to run the debugger. */
1730 /* Special handler that means "print a message and run debugger
1732 || EQ (h
->handler
, Qerror
)))
1735 = maybe_call_debugger (conditions
, error_symbol
, data
);
1736 /* We can't return values to code which signaled an error, but we
1737 can continue code which has signaled a quit. */
1738 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1744 Lisp_Object unwind_data
1745 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1747 h
->chosen_clause
= clause
;
1748 unwind_to_catch (h
->tag
, unwind_data
);
1753 Fthrow (Qtop_level
, Qt
);
1756 if (! NILP (error_symbol
))
1757 data
= Fcons (error_symbol
, data
);
1759 string
= Ferror_message_string (data
);
1760 fatal ("%s", SDATA (string
));
1763 /* Internal version of Fsignal that never returns.
1764 Used for anything but Qquit (which can return from Fsignal). */
1767 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1769 Fsignal (error_symbol
, data
);
1773 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1776 xsignal0 (Lisp_Object error_symbol
)
1778 xsignal (error_symbol
, Qnil
);
1782 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1784 xsignal (error_symbol
, list1 (arg
));
1788 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1790 xsignal (error_symbol
, list2 (arg1
, arg2
));
1794 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1796 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1799 /* Signal `error' with message S, and additional arg ARG.
1800 If ARG is not a genuine list, make it a one-element list. */
1803 signal_error (const char *s
, Lisp_Object arg
)
1805 Lisp_Object tortoise
, hare
;
1807 hare
= tortoise
= arg
;
1808 while (CONSP (hare
))
1815 tortoise
= XCDR (tortoise
);
1817 if (EQ (hare
, tortoise
))
1822 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1824 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1828 /* Return nonzero if LIST is a non-nil atom or
1829 a list containing one of CONDITIONS. */
1832 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1839 while (CONSP (conditions
))
1841 Lisp_Object
this, tail
;
1842 this = XCAR (conditions
);
1843 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1844 if (EQ (XCAR (tail
), this))
1846 conditions
= XCDR (conditions
);
1851 /* Return 1 if an error with condition-symbols CONDITIONS,
1852 and described by SIGNAL-DATA, should skip the debugger
1853 according to debugger-ignored-errors. */
1856 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1859 int first_string
= 1;
1860 Lisp_Object error_message
;
1862 error_message
= Qnil
;
1863 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1865 if (STRINGP (XCAR (tail
)))
1869 error_message
= Ferror_message_string (data
);
1873 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1878 Lisp_Object contail
;
1880 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1881 if (EQ (XCAR (tail
), XCAR (contail
)))
1889 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1890 SIG and DATA describe the signal, as in find_handler_clause. */
1893 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1895 Lisp_Object combined_data
;
1897 combined_data
= Fcons (sig
, data
);
1900 /* Don't try to run the debugger with interrupts blocked.
1901 The editing loop would return anyway. */
1903 /* Does user want to enter debugger for this kind of error? */
1906 : wants_debugger (Vdebug_on_error
, conditions
))
1907 && ! skip_debugger (conditions
, combined_data
)
1908 /* RMS: What's this for? */
1909 && when_entered_debugger
< num_nonmacro_input_events
)
1911 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1918 /* Value of Qlambda means we have called debugger and user has continued.
1919 There are two ways to pass SIG and DATA:
1920 = SIG is the error symbol, and DATA is the rest of the data.
1921 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1922 This is for memory-full errors only.
1924 We need to increase max_specpdl_size temporarily around
1925 anything we do that can push on the specpdl, so as not to get
1926 a second error here in case we're handling specpdl overflow. */
1929 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
,
1930 Lisp_Object sig
, Lisp_Object data
)
1932 register Lisp_Object h
;
1934 /* t is used by handlers for all conditions, set up by C code. */
1935 if (EQ (handlers
, Qt
))
1938 /* error is used similarly, but means print an error message
1939 and run the debugger if that is enabled. */
1940 if (EQ (handlers
, Qerror
))
1943 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1945 Lisp_Object handler
= XCAR (h
);
1946 Lisp_Object condit
, tem
;
1948 if (!CONSP (handler
))
1950 condit
= XCAR (handler
);
1951 /* Handle a single condition name in handler HANDLER. */
1952 if (SYMBOLP (condit
))
1954 tem
= Fmemq (Fcar (handler
), conditions
);
1958 /* Handle a list of condition names in handler HANDLER. */
1959 else if (CONSP (condit
))
1962 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1964 tem
= Fmemq (XCAR (tail
), conditions
);
1975 /* Dump an error message; called like vprintf. */
1977 verror (const char *m
, va_list ap
)
1980 size_t size
= sizeof buf
;
1981 size_t size_max
= (size_t) -1;
1989 used
= vsnprintf (buffer
, size
, m
, ap
);
1994 if (size
<= size_max
/ 2)
1996 else if (size
< size_max
)
2001 buffer
= (char *) xrealloc (buffer
, size
);
2004 buffer
= (char *) xmalloc (size
);
2009 string
= make_string (buffer
, used
);
2013 xsignal1 (Qerror
, string
);
2017 /* Dump an error message; called like printf. */
2021 error (const char *m
, ...)
2029 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
2030 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
2031 This means it contains a description for how to read arguments to give it.
2032 The value is nil for an invalid function or a symbol with no function
2035 Interactively callable functions include strings and vectors (treated
2036 as keyboard macros), lambda-expressions that contain a top-level call
2037 to `interactive', autoload definitions made by `autoload' with non-nil
2038 fourth argument, and some of the built-in functions of Lisp.
2040 Also, a symbol satisfies `commandp' if its function definition does so.
2042 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2043 then strings and vectors are not accepted. */)
2044 (Lisp_Object function
, Lisp_Object for_call_interactively
)
2046 register Lisp_Object fun
;
2047 register Lisp_Object funcar
;
2048 Lisp_Object if_prop
= Qnil
;
2052 fun
= indirect_function (fun
); /* Check cycles. */
2053 if (NILP (fun
) || EQ (fun
, Qunbound
))
2056 /* Check an `interactive-form' property if present, analogous to the
2057 function-documentation property. */
2059 while (SYMBOLP (fun
))
2061 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
2064 fun
= Fsymbol_function (fun
);
2067 /* Emacs primitives are interactive if their DEFUN specifies an
2068 interactive spec. */
2070 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
2072 /* Bytecode objects are interactive if they are long enough to
2073 have an element whose index is COMPILED_INTERACTIVE, which is
2074 where the interactive spec is stored. */
2075 else if (COMPILEDP (fun
))
2076 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2079 /* Strings and vectors are keyboard macros. */
2080 if (STRINGP (fun
) || VECTORP (fun
))
2081 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
2083 /* Lists may represent commands. */
2086 funcar
= XCAR (fun
);
2087 if (EQ (funcar
, Qclosure
))
2088 return (!NILP (Fassq (Qinteractive
, Fcdr (Fcdr (XCDR (fun
)))))
2090 else if (EQ (funcar
, Qlambda
))
2091 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2092 else if (EQ (funcar
, Qautoload
))
2093 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2098 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2099 doc
: /* Define FUNCTION to autoload from FILE.
2100 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2101 Third arg DOCSTRING is documentation for the function.
2102 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2103 Fifth arg TYPE indicates the type of the object:
2104 nil or omitted says FUNCTION is a function,
2105 `keymap' says FUNCTION is really a keymap, and
2106 `macro' or t says FUNCTION is really a macro.
2107 Third through fifth args give info about the real definition.
2108 They default to nil.
2109 If FUNCTION is already defined other than as an autoload,
2110 this does nothing and returns nil. */)
2111 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
2113 CHECK_SYMBOL (function
);
2114 CHECK_STRING (file
);
2116 /* If function is defined and not as an autoload, don't override. */
2117 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2118 && !(CONSP (XSYMBOL (function
)->function
)
2119 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2122 if (NILP (Vpurify_flag
))
2123 /* Only add entries after dumping, because the ones before are
2124 not useful and else we get loads of them from the loaddefs.el. */
2125 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2127 /* We don't want the docstring in purespace (instead,
2128 Snarf-documentation should (hopefully) overwrite it).
2129 We used to use 0 here, but that leads to accidental sharing in
2130 purecopy's hash-consing, so we use a (hopefully) unique integer
2132 docstring
= make_number (XHASH (function
));
2133 return Ffset (function
,
2134 Fpurecopy (list5 (Qautoload
, file
, docstring
,
2135 interactive
, type
)));
2139 un_autoload (Lisp_Object oldqueue
)
2141 register Lisp_Object queue
, first
, second
;
2143 /* Queue to unwind is current value of Vautoload_queue.
2144 oldqueue is the shadowed value to leave in Vautoload_queue. */
2145 queue
= Vautoload_queue
;
2146 Vautoload_queue
= oldqueue
;
2147 while (CONSP (queue
))
2149 first
= XCAR (queue
);
2150 second
= Fcdr (first
);
2151 first
= Fcar (first
);
2152 if (EQ (first
, make_number (0)))
2155 Ffset (first
, second
);
2156 queue
= XCDR (queue
);
2161 /* Load an autoloaded function.
2162 FUNNAME is the symbol which is the function's name.
2163 FUNDEF is the autoload definition (a list). */
2166 do_autoload (Lisp_Object fundef
, Lisp_Object funname
)
2168 int count
= SPECPDL_INDEX ();
2170 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2172 /* This is to make sure that loadup.el gives a clear picture
2173 of what files are preloaded and when. */
2174 if (! NILP (Vpurify_flag
))
2175 error ("Attempt to autoload %s while preparing to dump",
2176 SDATA (SYMBOL_NAME (funname
)));
2179 CHECK_SYMBOL (funname
);
2180 GCPRO3 (fun
, funname
, fundef
);
2182 /* Preserve the match data. */
2183 record_unwind_save_match_data ();
2185 /* If autoloading gets an error (which includes the error of failing
2186 to define the function being called), we use Vautoload_queue
2187 to undo function definitions and `provide' calls made by
2188 the function. We do this in the specific case of autoloading
2189 because autoloading is not an explicit request "load this file",
2190 but rather a request to "call this function".
2192 The value saved here is to be restored into Vautoload_queue. */
2193 record_unwind_protect (un_autoload
, Vautoload_queue
);
2194 Vautoload_queue
= Qt
;
2195 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
2197 /* Once loading finishes, don't undo it. */
2198 Vautoload_queue
= Qt
;
2199 unbind_to (count
, Qnil
);
2201 fun
= Findirect_function (fun
, Qnil
);
2203 if (!NILP (Fequal (fun
, fundef
)))
2204 error ("Autoloading failed to define function %s",
2205 SDATA (SYMBOL_NAME (funname
)));
2210 DEFUN ("eval", Feval
, Seval
, 1, 2, 0,
2211 doc
: /* Evaluate FORM and return its value.
2212 If LEXICAL is t, evaluate using lexical scoping. */)
2213 (Lisp_Object form
, Lisp_Object lexical
)
2215 int count
= SPECPDL_INDEX ();
2216 specbind (Qinternal_interpreter_environment
,
2217 NILP (lexical
) ? Qnil
: Fcons (Qt
, Qnil
));
2218 return unbind_to (count
, eval_sub (form
));
2221 /* Eval a sub-expression of the current expression (i.e. in the same
2224 eval_sub (Lisp_Object form
)
2226 Lisp_Object fun
, val
, original_fun
, original_args
;
2228 struct backtrace backtrace
;
2229 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2231 if (handling_signal
)
2236 /* Look up its binding in the lexical environment.
2237 We do not pay attention to the declared_special flag here, since we
2238 already did that when let-binding the variable. */
2239 Lisp_Object lex_binding
2240 = !NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
2241 ? Fassq (form
, Vinternal_interpreter_environment
)
2243 if (CONSP (lex_binding
))
2244 return XCDR (lex_binding
);
2246 return Fsymbol_value (form
);
2253 if ((consing_since_gc
> gc_cons_threshold
2254 && consing_since_gc
> gc_relative_threshold
)
2256 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2259 Fgarbage_collect ();
2263 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2265 if (max_lisp_eval_depth
< 100)
2266 max_lisp_eval_depth
= 100;
2267 if (lisp_eval_depth
> max_lisp_eval_depth
)
2268 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2271 original_fun
= Fcar (form
);
2272 original_args
= Fcdr (form
);
2274 backtrace
.next
= backtrace_list
;
2275 backtrace_list
= &backtrace
;
2276 backtrace
.function
= &original_fun
; /* This also protects them from gc. */
2277 backtrace
.args
= &original_args
;
2278 backtrace
.nargs
= UNEVALLED
;
2279 backtrace
.evalargs
= 1;
2280 backtrace
.debug_on_exit
= 0;
2282 if (debug_on_next_call
)
2283 do_debug_on_call (Qt
);
2285 /* At this point, only original_fun and original_args
2286 have values that will be used below. */
2289 /* Optimize for no indirection. */
2291 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2292 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2293 fun
= indirect_function (fun
);
2297 Lisp_Object numargs
;
2298 Lisp_Object argvals
[8];
2299 Lisp_Object args_left
;
2300 register int i
, maxargs
;
2302 args_left
= original_args
;
2303 numargs
= Flength (args_left
);
2307 if (XINT (numargs
) < XSUBR (fun
)->min_args
2308 || (XSUBR (fun
)->max_args
>= 0
2309 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2310 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2312 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2314 backtrace
.evalargs
= 0;
2315 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2317 else if (XSUBR (fun
)->max_args
== MANY
)
2319 /* Pass a vector of evaluated arguments. */
2321 register size_t argnum
= 0;
2324 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2326 GCPRO3 (args_left
, fun
, fun
);
2330 while (!NILP (args_left
))
2332 vals
[argnum
++] = eval_sub (Fcar (args_left
));
2333 args_left
= Fcdr (args_left
);
2334 gcpro3
.nvars
= argnum
;
2337 backtrace
.args
= vals
;
2338 backtrace
.nargs
= XINT (numargs
);
2340 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2346 GCPRO3 (args_left
, fun
, fun
);
2347 gcpro3
.var
= argvals
;
2350 maxargs
= XSUBR (fun
)->max_args
;
2351 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2353 argvals
[i
] = eval_sub (Fcar (args_left
));
2359 backtrace
.args
= argvals
;
2360 backtrace
.nargs
= XINT (numargs
);
2365 val
= (XSUBR (fun
)->function
.a0 ());
2368 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2371 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2374 val
= (XSUBR (fun
)->function
.a3
2375 (argvals
[0], argvals
[1], argvals
[2]));
2378 val
= (XSUBR (fun
)->function
.a4
2379 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2382 val
= (XSUBR (fun
)->function
.a5
2383 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2387 val
= (XSUBR (fun
)->function
.a6
2388 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2389 argvals
[4], argvals
[5]));
2392 val
= (XSUBR (fun
)->function
.a7
2393 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2394 argvals
[4], argvals
[5], argvals
[6]));
2398 val
= (XSUBR (fun
)->function
.a8
2399 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2400 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2404 /* Someone has created a subr that takes more arguments than
2405 is supported by this code. We need to either rewrite the
2406 subr to use a different argument protocol, or add more
2407 cases to this switch. */
2412 else if (COMPILEDP (fun
))
2413 val
= apply_lambda (fun
, original_args
);
2416 if (EQ (fun
, Qunbound
))
2417 xsignal1 (Qvoid_function
, original_fun
);
2419 xsignal1 (Qinvalid_function
, original_fun
);
2420 funcar
= XCAR (fun
);
2421 if (!SYMBOLP (funcar
))
2422 xsignal1 (Qinvalid_function
, original_fun
);
2423 if (EQ (funcar
, Qautoload
))
2425 do_autoload (fun
, original_fun
);
2428 if (EQ (funcar
, Qmacro
))
2429 val
= eval_sub (apply1 (Fcdr (fun
), original_args
));
2430 else if (EQ (funcar
, Qlambda
)
2431 || EQ (funcar
, Qclosure
))
2432 val
= apply_lambda (fun
, original_args
);
2434 xsignal1 (Qinvalid_function
, original_fun
);
2439 if (backtrace
.debug_on_exit
)
2440 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2441 backtrace_list
= backtrace
.next
;
2446 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2447 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2448 Then return the value FUNCTION returns.
2449 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2450 usage: (apply FUNCTION &rest ARGUMENTS) */)
2451 (size_t nargs
, Lisp_Object
*args
)
2453 register size_t i
, numargs
;
2454 register Lisp_Object spread_arg
;
2455 register Lisp_Object
*funcall_args
;
2456 Lisp_Object fun
, retval
;
2457 struct gcpro gcpro1
;
2462 spread_arg
= args
[nargs
- 1];
2463 CHECK_LIST (spread_arg
);
2465 numargs
= XINT (Flength (spread_arg
));
2468 return Ffuncall (nargs
- 1, args
);
2469 else if (numargs
== 1)
2471 args
[nargs
- 1] = XCAR (spread_arg
);
2472 return Ffuncall (nargs
, args
);
2475 numargs
+= nargs
- 2;
2477 /* Optimize for no indirection. */
2478 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2479 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2480 fun
= indirect_function (fun
);
2481 if (EQ (fun
, Qunbound
))
2483 /* Let funcall get the error. */
2490 if (numargs
< XSUBR (fun
)->min_args
2491 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2492 goto funcall
; /* Let funcall get the error. */
2493 else if (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
> numargs
)
2495 /* Avoid making funcall cons up a yet another new vector of arguments
2496 by explicitly supplying nil's for optional values. */
2497 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2498 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2499 funcall_args
[++i
] = Qnil
;
2500 GCPRO1 (*funcall_args
);
2501 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2505 /* We add 1 to numargs because funcall_args includes the
2506 function itself as well as its arguments. */
2509 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2510 GCPRO1 (*funcall_args
);
2511 gcpro1
.nvars
= 1 + numargs
;
2514 memcpy (funcall_args
, args
, nargs
* sizeof (Lisp_Object
));
2515 /* Spread the last arg we got. Its first element goes in
2516 the slot that it used to occupy, hence this value of I. */
2518 while (!NILP (spread_arg
))
2520 funcall_args
[i
++] = XCAR (spread_arg
);
2521 spread_arg
= XCDR (spread_arg
);
2524 /* By convention, the caller needs to gcpro Ffuncall's args. */
2525 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2532 /* Run hook variables in various ways. */
2535 funcall_nil (size_t nargs
, Lisp_Object
*args
)
2537 Ffuncall (nargs
, args
);
2541 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2542 doc
: /* Run each hook in HOOKS.
2543 Each argument should be a symbol, a hook variable.
2544 These symbols are processed in the order specified.
2545 If a hook symbol has a non-nil value, that value may be a function
2546 or a list of functions to be called to run the hook.
2547 If the value is a function, it is called with no arguments.
2548 If it is a list, the elements are called, in order, with no arguments.
2550 Major modes should not use this function directly to run their mode
2551 hook; they should use `run-mode-hooks' instead.
2553 Do not use `make-local-variable' to make a hook variable buffer-local.
2554 Instead, use `add-hook' and specify t for the LOCAL argument.
2555 usage: (run-hooks &rest HOOKS) */)
2556 (size_t nargs
, Lisp_Object
*args
)
2558 Lisp_Object hook
[1];
2561 for (i
= 0; i
< nargs
; i
++)
2564 run_hook_with_args (1, hook
, funcall_nil
);
2570 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2571 Srun_hook_with_args
, 1, MANY
, 0,
2572 doc
: /* Run HOOK with the specified arguments ARGS.
2573 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2574 value, that value may be a function or a list of functions to be
2575 called to run the hook. If the value is a function, it is called with
2576 the given arguments and its return value is returned. If it is a list
2577 of functions, those functions are called, in order,
2578 with the given arguments ARGS.
2579 It is best not to depend on the value returned by `run-hook-with-args',
2582 Do not use `make-local-variable' to make a hook variable buffer-local.
2583 Instead, use `add-hook' and specify t for the LOCAL argument.
2584 usage: (run-hook-with-args HOOK &rest ARGS) */)
2585 (size_t nargs
, Lisp_Object
*args
)
2587 return run_hook_with_args (nargs
, args
, funcall_nil
);
2590 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2591 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2592 doc
: /* Run HOOK with the specified arguments ARGS.
2593 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2594 value, that value may be a function or a list of functions to be
2595 called to run the hook. If the value is a function, it is called with
2596 the given arguments and its return value is returned.
2597 If it is a list of functions, those functions are called, in order,
2598 with the given arguments ARGS, until one of them
2599 returns a non-nil value. Then we return that value.
2600 However, if they all return nil, we return nil.
2602 Do not use `make-local-variable' to make a hook variable buffer-local.
2603 Instead, use `add-hook' and specify t for the LOCAL argument.
2604 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2605 (size_t nargs
, Lisp_Object
*args
)
2607 return run_hook_with_args (nargs
, args
, Ffuncall
);
2611 funcall_not (size_t nargs
, Lisp_Object
*args
)
2613 return NILP (Ffuncall (nargs
, args
)) ? Qt
: Qnil
;
2616 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2617 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2618 doc
: /* Run HOOK with the specified arguments ARGS.
2619 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2620 value, that value may be a function or a list of functions to be
2621 called to run the hook. If the value is a function, it is called with
2622 the given arguments and its return value is returned.
2623 If it is a list of functions, those functions are called, in order,
2624 with the given arguments ARGS, until one of them returns nil.
2625 Then we return nil. However, if they all return non-nil, we return non-nil.
2627 Do not use `make-local-variable' to make a hook variable buffer-local.
2628 Instead, use `add-hook' and specify t for the LOCAL argument.
2629 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2630 (size_t nargs
, Lisp_Object
*args
)
2632 return NILP (run_hook_with_args (nargs
, args
, funcall_not
)) ? Qt
: Qnil
;
2636 run_hook_wrapped_funcall (size_t nargs
, Lisp_Object
*args
)
2638 Lisp_Object tmp
= args
[0], ret
;
2641 ret
= Ffuncall (nargs
, args
);
2647 DEFUN ("run-hook-wrapped", Frun_hook_wrapped
, Srun_hook_wrapped
, 2, MANY
, 0,
2648 doc
: /* Run HOOK, passing each function through WRAP-FUNCTION.
2649 I.e. instead of calling each function FUN directly with arguments ARGS,
2650 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2651 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2652 aborts and returns that value.
2653 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2654 (size_t nargs
, Lisp_Object
*args
)
2656 return run_hook_with_args (nargs
, args
, run_hook_wrapped_funcall
);
2659 /* ARGS[0] should be a hook symbol.
2660 Call each of the functions in the hook value, passing each of them
2661 as arguments all the rest of ARGS (all NARGS - 1 elements).
2662 FUNCALL specifies how to call each function on the hook.
2663 The caller (or its caller, etc) must gcpro all of ARGS,
2664 except that it isn't necessary to gcpro ARGS[0]. */
2667 run_hook_with_args (size_t nargs
, Lisp_Object
*args
,
2668 Lisp_Object (*funcall
) (size_t nargs
, Lisp_Object
*args
))
2670 Lisp_Object sym
, val
, ret
= Qnil
;
2671 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2673 /* If we are dying or still initializing,
2674 don't do anything--it would probably crash if we tried. */
2675 if (NILP (Vrun_hooks
))
2679 val
= find_symbol_value (sym
);
2681 if (EQ (val
, Qunbound
) || NILP (val
))
2683 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2686 return funcall (nargs
, args
);
2690 Lisp_Object global_vals
= Qnil
;
2691 GCPRO3 (sym
, val
, global_vals
);
2694 CONSP (val
) && NILP (ret
);
2697 if (EQ (XCAR (val
), Qt
))
2699 /* t indicates this hook has a local binding;
2700 it means to run the global binding too. */
2701 global_vals
= Fdefault_value (sym
);
2702 if (NILP (global_vals
)) continue;
2704 if (!CONSP (global_vals
) || EQ (XCAR (global_vals
), Qlambda
))
2706 args
[0] = global_vals
;
2707 ret
= funcall (nargs
, args
);
2712 CONSP (global_vals
) && NILP (ret
);
2713 global_vals
= XCDR (global_vals
))
2715 args
[0] = XCAR (global_vals
);
2716 /* In a global value, t should not occur. If it does, we
2717 must ignore it to avoid an endless loop. */
2718 if (!EQ (args
[0], Qt
))
2719 ret
= funcall (nargs
, args
);
2725 args
[0] = XCAR (val
);
2726 ret
= funcall (nargs
, args
);
2735 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2738 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2740 Lisp_Object temp
[3];
2745 Frun_hook_with_args (3, temp
);
2748 /* Apply fn to arg. */
2750 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2752 struct gcpro gcpro1
;
2756 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2759 Lisp_Object args
[2];
2763 RETURN_UNGCPRO (Fapply (2, args
));
2767 /* Call function fn on no arguments. */
2769 call0 (Lisp_Object fn
)
2771 struct gcpro gcpro1
;
2774 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2777 /* Call function fn with 1 argument arg1. */
2780 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2782 struct gcpro gcpro1
;
2783 Lisp_Object args
[2];
2789 RETURN_UNGCPRO (Ffuncall (2, args
));
2792 /* Call function fn with 2 arguments arg1, arg2. */
2795 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2797 struct gcpro gcpro1
;
2798 Lisp_Object args
[3];
2804 RETURN_UNGCPRO (Ffuncall (3, args
));
2807 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2810 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2812 struct gcpro gcpro1
;
2813 Lisp_Object args
[4];
2820 RETURN_UNGCPRO (Ffuncall (4, args
));
2823 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2826 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2829 struct gcpro gcpro1
;
2830 Lisp_Object args
[5];
2838 RETURN_UNGCPRO (Ffuncall (5, args
));
2841 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2844 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2845 Lisp_Object arg4
, Lisp_Object arg5
)
2847 struct gcpro gcpro1
;
2848 Lisp_Object args
[6];
2857 RETURN_UNGCPRO (Ffuncall (6, args
));
2860 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2863 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2864 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2866 struct gcpro gcpro1
;
2867 Lisp_Object args
[7];
2877 RETURN_UNGCPRO (Ffuncall (7, args
));
2880 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2883 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2884 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2886 struct gcpro gcpro1
;
2887 Lisp_Object args
[8];
2898 RETURN_UNGCPRO (Ffuncall (8, args
));
2901 /* The caller should GCPRO all the elements of ARGS. */
2903 DEFUN ("functionp", Ffunctionp
, Sfunctionp
, 1, 1, 0,
2904 doc
: /* Non-nil if OBJECT is a function. */)
2905 (Lisp_Object object
)
2907 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
2909 object
= Findirect_function (object
, Qt
);
2911 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
2913 /* Autoloaded symbols are functions, except if they load
2914 macros or keymaps. */
2916 for (i
= 0; i
< 4 && CONSP (object
); i
++)
2917 object
= XCDR (object
);
2919 return (CONSP (object
) && !NILP (XCAR (object
))) ? Qnil
: Qt
;
2924 return (XSUBR (object
)->max_args
!= UNEVALLED
) ? Qt
: Qnil
;
2925 else if (COMPILEDP (object
))
2927 else if (CONSP (object
))
2929 Lisp_Object car
= XCAR (object
);
2930 return (EQ (car
, Qlambda
) || EQ (car
, Qclosure
)) ? Qt
: Qnil
;
2936 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2937 doc
: /* Call first argument as a function, passing remaining arguments to it.
2938 Return the value that function returns.
2939 Thus, (funcall 'cons 'x 'y) returns (x . y).
2940 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2941 (size_t nargs
, Lisp_Object
*args
)
2943 Lisp_Object fun
, original_fun
;
2945 size_t numargs
= nargs
- 1;
2946 Lisp_Object lisp_numargs
;
2948 struct backtrace backtrace
;
2949 register Lisp_Object
*internal_args
;
2953 if ((consing_since_gc
> gc_cons_threshold
2954 && consing_since_gc
> gc_relative_threshold
)
2956 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2957 Fgarbage_collect ();
2959 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2961 if (max_lisp_eval_depth
< 100)
2962 max_lisp_eval_depth
= 100;
2963 if (lisp_eval_depth
> max_lisp_eval_depth
)
2964 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2967 backtrace
.next
= backtrace_list
;
2968 backtrace_list
= &backtrace
;
2969 backtrace
.function
= &args
[0];
2970 backtrace
.args
= &args
[1];
2971 backtrace
.nargs
= nargs
- 1;
2972 backtrace
.evalargs
= 0;
2973 backtrace
.debug_on_exit
= 0;
2975 if (debug_on_next_call
)
2976 do_debug_on_call (Qlambda
);
2980 original_fun
= args
[0];
2984 /* Optimize for no indirection. */
2986 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2987 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2988 fun
= indirect_function (fun
);
2992 if (numargs
< XSUBR (fun
)->min_args
2993 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2995 XSETFASTINT (lisp_numargs
, numargs
);
2996 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2999 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
3000 xsignal1 (Qinvalid_function
, original_fun
);
3002 else if (XSUBR (fun
)->max_args
== MANY
)
3003 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
3006 if (XSUBR (fun
)->max_args
> numargs
)
3008 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
3009 memcpy (internal_args
, args
+ 1, numargs
* sizeof (Lisp_Object
));
3010 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
3011 internal_args
[i
] = Qnil
;
3014 internal_args
= args
+ 1;
3015 switch (XSUBR (fun
)->max_args
)
3018 val
= (XSUBR (fun
)->function
.a0 ());
3021 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
3024 val
= (XSUBR (fun
)->function
.a2
3025 (internal_args
[0], internal_args
[1]));
3028 val
= (XSUBR (fun
)->function
.a3
3029 (internal_args
[0], internal_args
[1], internal_args
[2]));
3032 val
= (XSUBR (fun
)->function
.a4
3033 (internal_args
[0], internal_args
[1], internal_args
[2],
3037 val
= (XSUBR (fun
)->function
.a5
3038 (internal_args
[0], internal_args
[1], internal_args
[2],
3039 internal_args
[3], internal_args
[4]));
3042 val
= (XSUBR (fun
)->function
.a6
3043 (internal_args
[0], internal_args
[1], internal_args
[2],
3044 internal_args
[3], internal_args
[4], internal_args
[5]));
3047 val
= (XSUBR (fun
)->function
.a7
3048 (internal_args
[0], internal_args
[1], internal_args
[2],
3049 internal_args
[3], internal_args
[4], internal_args
[5],
3054 val
= (XSUBR (fun
)->function
.a8
3055 (internal_args
[0], internal_args
[1], internal_args
[2],
3056 internal_args
[3], internal_args
[4], internal_args
[5],
3057 internal_args
[6], internal_args
[7]));
3062 /* If a subr takes more than 8 arguments without using MANY
3063 or UNEVALLED, we need to extend this function to support it.
3064 Until this is done, there is no way to call the function. */
3069 else if (COMPILEDP (fun
))
3070 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3073 if (EQ (fun
, Qunbound
))
3074 xsignal1 (Qvoid_function
, original_fun
);
3076 xsignal1 (Qinvalid_function
, original_fun
);
3077 funcar
= XCAR (fun
);
3078 if (!SYMBOLP (funcar
))
3079 xsignal1 (Qinvalid_function
, original_fun
);
3080 if (EQ (funcar
, Qlambda
)
3081 || EQ (funcar
, Qclosure
))
3082 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3083 else if (EQ (funcar
, Qautoload
))
3085 do_autoload (fun
, original_fun
);
3090 xsignal1 (Qinvalid_function
, original_fun
);
3094 if (backtrace
.debug_on_exit
)
3095 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3096 backtrace_list
= backtrace
.next
;
3101 apply_lambda (Lisp_Object fun
, Lisp_Object args
)
3103 Lisp_Object args_left
;
3105 register Lisp_Object
*arg_vector
;
3106 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3108 register Lisp_Object tem
;
3111 numargs
= XINT (Flength (args
));
3112 SAFE_ALLOCA_LISP (arg_vector
, numargs
);
3115 GCPRO3 (*arg_vector
, args_left
, fun
);
3118 for (i
= 0; i
< numargs
; )
3120 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3121 tem
= eval_sub (tem
);
3122 arg_vector
[i
++] = tem
;
3128 backtrace_list
->args
= arg_vector
;
3129 backtrace_list
->nargs
= i
;
3130 backtrace_list
->evalargs
= 0;
3131 tem
= funcall_lambda (fun
, numargs
, arg_vector
);
3133 /* Do the debug-on-exit now, while arg_vector still exists. */
3134 if (backtrace_list
->debug_on_exit
)
3135 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3136 /* Don't do it again when we return to eval. */
3137 backtrace_list
->debug_on_exit
= 0;
3142 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3143 and return the result of evaluation.
3144 FUN must be either a lambda-expression or a compiled-code object. */
3147 funcall_lambda (Lisp_Object fun
, size_t nargs
,
3148 register Lisp_Object
*arg_vector
)
3150 Lisp_Object val
, syms_left
, next
, lexenv
;
3151 int count
= SPECPDL_INDEX ();
3157 if (EQ (XCAR (fun
), Qclosure
))
3159 fun
= XCDR (fun
); /* Drop `closure'. */
3160 lexenv
= XCAR (fun
);
3161 CHECK_LIST_CONS (fun
, fun
);
3165 syms_left
= XCDR (fun
);
3166 if (CONSP (syms_left
))
3167 syms_left
= XCAR (syms_left
);
3169 xsignal1 (Qinvalid_function
, fun
);
3171 else if (COMPILEDP (fun
))
3173 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3174 if (INTEGERP (syms_left
))
3175 /* A byte-code object with a non-nil `push args' slot means we
3176 shouldn't bind any arguments, instead just call the byte-code
3177 interpreter directly; it will push arguments as necessary.
3179 Byte-code objects with either a non-existant, or a nil value for
3180 the `push args' slot (the default), have dynamically-bound
3181 arguments, and use the argument-binding code below instead (as do
3182 all interpreted functions, even lexically bound ones). */
3184 /* If we have not actually read the bytecode string
3185 and constants vector yet, fetch them from the file. */
3186 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3187 Ffetch_bytecode (fun
);
3188 return exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3189 AREF (fun
, COMPILED_CONSTANTS
),
3190 AREF (fun
, COMPILED_STACK_DEPTH
),
3199 i
= optional
= rest
= 0;
3200 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3204 next
= XCAR (syms_left
);
3205 if (!SYMBOLP (next
))
3206 xsignal1 (Qinvalid_function
, fun
);
3208 if (EQ (next
, Qand_rest
))
3210 else if (EQ (next
, Qand_optional
))
3217 arg
= Flist (nargs
- i
, &arg_vector
[i
]);
3221 arg
= arg_vector
[i
++];
3223 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3227 /* Bind the argument. */
3228 if (!NILP (lexenv
) && SYMBOLP (next
))
3229 /* Lexically bind NEXT by adding it to the lexenv alist. */
3230 lexenv
= Fcons (Fcons (next
, arg
), lexenv
);
3232 /* Dynamically bind NEXT. */
3233 specbind (next
, arg
);
3237 if (!NILP (syms_left
))
3238 xsignal1 (Qinvalid_function
, fun
);
3240 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3242 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
3243 /* Instantiate a new lexical environment. */
3244 specbind (Qinternal_interpreter_environment
, lexenv
);
3247 val
= Fprogn (XCDR (XCDR (fun
)));
3250 /* If we have not actually read the bytecode string
3251 and constants vector yet, fetch them from the file. */
3252 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3253 Ffetch_bytecode (fun
);
3254 val
= exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3255 AREF (fun
, COMPILED_CONSTANTS
),
3256 AREF (fun
, COMPILED_STACK_DEPTH
),
3260 return unbind_to (count
, val
);
3263 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3265 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3266 (Lisp_Object object
)
3270 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3272 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3275 tem
= AREF (object
, COMPILED_BYTECODE
);
3276 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3277 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3279 error ("Invalid byte code");
3281 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3282 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3290 register int count
= SPECPDL_INDEX ();
3291 if (specpdl_size
>= max_specpdl_size
)
3293 if (max_specpdl_size
< 400)
3294 max_specpdl_size
= 400;
3295 if (specpdl_size
>= max_specpdl_size
)
3296 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3299 if (specpdl_size
> max_specpdl_size
)
3300 specpdl_size
= max_specpdl_size
;
3301 specpdl
= (struct specbinding
*) xrealloc (specpdl
, specpdl_size
* sizeof (struct specbinding
));
3302 specpdl_ptr
= specpdl
+ count
;
3305 /* `specpdl_ptr->symbol' is a field which describes which variable is
3306 let-bound, so it can be properly undone when we unbind_to.
3307 It can have the following two shapes:
3308 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3309 a symbol that is not buffer-local (at least at the time
3310 the let binding started). Note also that it should not be
3311 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3313 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3314 variable SYMBOL which can be buffer-local. WHERE tells us
3315 which buffer is affected (or nil if the let-binding affects the
3316 global value of the variable) and BUFFER tells us which buffer was
3317 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3318 BUFFER did not yet have a buffer-local value). */
3321 specbind (Lisp_Object symbol
, Lisp_Object value
)
3323 struct Lisp_Symbol
*sym
;
3325 eassert (!handling_signal
);
3327 CHECK_SYMBOL (symbol
);
3328 sym
= XSYMBOL (symbol
);
3329 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3333 switch (sym
->redirect
)
3335 case SYMBOL_VARALIAS
:
3336 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3337 case SYMBOL_PLAINVAL
:
3338 /* The most common case is that of a non-constant symbol with a
3339 trivial value. Make that as fast as we can. */
3340 specpdl_ptr
->symbol
= symbol
;
3341 specpdl_ptr
->old_value
= SYMBOL_VAL (sym
);
3342 specpdl_ptr
->func
= NULL
;
3345 SET_SYMBOL_VAL (sym
, value
);
3347 set_internal (symbol
, value
, Qnil
, 1);
3349 case SYMBOL_LOCALIZED
:
3350 if (SYMBOL_BLV (sym
)->frame_local
)
3351 error ("Frame-local vars cannot be let-bound");
3352 case SYMBOL_FORWARDED
:
3354 Lisp_Object ovalue
= find_symbol_value (symbol
);
3355 specpdl_ptr
->func
= 0;
3356 specpdl_ptr
->old_value
= ovalue
;
3358 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3359 || (EQ (SYMBOL_BLV (sym
)->where
,
3360 SYMBOL_BLV (sym
)->frame_local
?
3361 Fselected_frame () : Fcurrent_buffer ())));
3363 if (sym
->redirect
== SYMBOL_LOCALIZED
3364 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3366 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3368 /* For a local variable, record both the symbol and which
3369 buffer's or frame's value we are saving. */
3370 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3372 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3373 || (BLV_FOUND (SYMBOL_BLV (sym
))
3374 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3377 else if (sym
->redirect
== SYMBOL_LOCALIZED
3378 && BLV_FOUND (SYMBOL_BLV (sym
)))
3379 where
= SYMBOL_BLV (sym
)->where
;
3383 /* We're not using the `unused' slot in the specbinding
3384 structure because this would mean we have to do more
3385 work for simple variables. */
3386 /* FIXME: The third value `current_buffer' is only used in
3387 let_shadows_buffer_binding_p which is itself only used
3388 in set_internal for local_if_set. */
3389 eassert (NILP (where
) || EQ (where
, cur_buf
));
3390 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, cur_buf
));
3392 /* If SYMBOL is a per-buffer variable which doesn't have a
3393 buffer-local value here, make the `let' change the global
3394 value by changing the value of SYMBOL in all buffers not
3395 having their own value. This is consistent with what
3396 happens with other buffer-local variables. */
3398 && sym
->redirect
== SYMBOL_FORWARDED
)
3400 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3402 Fset_default (symbol
, value
);
3407 specpdl_ptr
->symbol
= symbol
;
3410 set_internal (symbol
, value
, Qnil
, 1);
3418 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3420 eassert (!handling_signal
);
3422 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3424 specpdl_ptr
->func
= function
;
3425 specpdl_ptr
->symbol
= Qnil
;
3426 specpdl_ptr
->old_value
= arg
;
3431 unbind_to (int count
, Lisp_Object value
)
3433 Lisp_Object quitf
= Vquit_flag
;
3434 struct gcpro gcpro1
, gcpro2
;
3436 GCPRO2 (value
, quitf
);
3439 while (specpdl_ptr
!= specpdl
+ count
)
3441 /* Copy the binding, and decrement specpdl_ptr, before we do
3442 the work to unbind it. We decrement first
3443 so that an error in unbinding won't try to unbind
3444 the same entry again, and we copy the binding first
3445 in case more bindings are made during some of the code we run. */
3447 struct specbinding this_binding
;
3448 this_binding
= *--specpdl_ptr
;
3450 if (this_binding
.func
!= 0)
3451 (*this_binding
.func
) (this_binding
.old_value
);
3452 /* If the symbol is a list, it is really (SYMBOL WHERE
3453 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3454 frame. If WHERE is a buffer or frame, this indicates we
3455 bound a variable that had a buffer-local or frame-local
3456 binding. WHERE nil means that the variable had the default
3457 value when it was bound. CURRENT-BUFFER is the buffer that
3458 was current when the variable was bound. */
3459 else if (CONSP (this_binding
.symbol
))
3461 Lisp_Object symbol
, where
;
3463 symbol
= XCAR (this_binding
.symbol
);
3464 where
= XCAR (XCDR (this_binding
.symbol
));
3467 Fset_default (symbol
, this_binding
.old_value
);
3468 /* If `where' is non-nil, reset the value in the appropriate
3469 local binding, but only if that binding still exists. */
3470 else if (BUFFERP (where
)
3471 ? !NILP (Flocal_variable_p (symbol
, where
))
3472 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3473 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3475 /* If variable has a trivial value (no forwarding), we can
3476 just set it. No need to check for constant symbols here,
3477 since that was already done by specbind. */
3478 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3479 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3480 this_binding
.old_value
);
3482 /* NOTE: we only ever come here if make_local_foo was used for
3483 the first time on this var within this let. */
3484 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3487 if (NILP (Vquit_flag
) && !NILP (quitf
))
3494 DEFUN ("special-variable-p", Fspecial_variable_p
, Sspecial_variable_p
, 1, 1, 0,
3495 doc
: /* Return non-nil if SYMBOL's global binding has been declared special.
3496 A special variable is one that will be bound dynamically, even in a
3497 context where binding is lexical by default. */)
3498 (Lisp_Object symbol
)
3500 CHECK_SYMBOL (symbol
);
3501 return XSYMBOL (symbol
)->declared_special
? Qt
: Qnil
;
3505 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3506 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3507 The debugger is entered when that frame exits, if the flag is non-nil. */)
3508 (Lisp_Object level
, Lisp_Object flag
)
3510 register struct backtrace
*backlist
= backtrace_list
;
3513 CHECK_NUMBER (level
);
3515 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3517 backlist
= backlist
->next
;
3521 backlist
->debug_on_exit
= !NILP (flag
);
3526 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3527 doc
: /* Print a trace of Lisp function calls currently active.
3528 Output stream used is value of `standard-output'. */)
3531 register struct backtrace
*backlist
= backtrace_list
;
3534 struct gcpro gcpro1
;
3535 Lisp_Object old_print_level
= Vprint_level
;
3537 if (NILP (Vprint_level
))
3538 XSETFASTINT (Vprint_level
, 8);
3545 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3546 if (backlist
->nargs
== UNEVALLED
)
3548 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3549 write_string ("\n", -1);
3553 tem
= *backlist
->function
;
3554 Fprin1 (tem
, Qnil
); /* This can QUIT. */
3555 write_string ("(", -1);
3556 if (backlist
->nargs
== MANY
)
3557 { /* FIXME: Can this happen? */
3559 for (tail
= *backlist
->args
, i
= 0;
3561 tail
= Fcdr (tail
), i
= 1)
3563 if (i
) write_string (" ", -1);
3564 Fprin1 (Fcar (tail
), Qnil
);
3570 for (i
= 0; i
< backlist
->nargs
; i
++)
3572 if (i
) write_string (" ", -1);
3573 Fprin1 (backlist
->args
[i
], Qnil
);
3576 write_string (")\n", -1);
3578 backlist
= backlist
->next
;
3581 Vprint_level
= old_print_level
;
3586 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3587 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3588 If that frame has not evaluated the arguments yet (or is a special form),
3589 the value is (nil FUNCTION ARG-FORMS...).
3590 If that frame has evaluated its arguments and called its function already,
3591 the value is (t FUNCTION ARG-VALUES...).
3592 A &rest arg is represented as the tail of the list ARG-VALUES.
3593 FUNCTION is whatever was supplied as car of evaluated list,
3594 or a lambda expression for macro calls.
3595 If NFRAMES is more than the number of frames, the value is nil. */)
3596 (Lisp_Object nframes
)
3598 register struct backtrace
*backlist
= backtrace_list
;
3599 register EMACS_INT i
;
3602 CHECK_NATNUM (nframes
);
3604 /* Find the frame requested. */
3605 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3606 backlist
= backlist
->next
;
3610 if (backlist
->nargs
== UNEVALLED
)
3611 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3614 if (backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3615 tem
= *backlist
->args
;
3617 tem
= Flist (backlist
->nargs
, backlist
->args
);
3619 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3625 mark_backtrace (void)
3627 register struct backtrace
*backlist
;
3630 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3632 mark_object (*backlist
->function
);
3634 if (backlist
->nargs
== UNEVALLED
3635 || backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3638 i
= backlist
->nargs
;
3640 mark_object (backlist
->args
[i
]);
3644 EXFUN (Funintern
, 2);
3649 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3650 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3651 If Lisp code tries to increase the total number past this amount,
3652 an error is signaled.
3653 You can safely use a value considerably larger than the default value,
3654 if that proves inconveniently small. However, if you increase it too far,
3655 Emacs could run out of memory trying to make the stack bigger. */);
3657 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3658 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3660 This limit serves to catch infinite recursions for you before they cause
3661 actual stack overflow in C, which would be fatal for Emacs.
3662 You can safely make it considerably larger than its default value,
3663 if that proves inconveniently small. However, if you increase it too far,
3664 Emacs could overflow the real C stack, and crash. */);
3666 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3667 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3668 If the value is t, that means do an ordinary quit.
3669 If the value equals `throw-on-input', that means quit by throwing
3670 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3671 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3672 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3675 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3676 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3677 Note that `quit-flag' will still be set by typing C-g,
3678 so a quit will be signaled as soon as `inhibit-quit' is nil.
3679 To prevent this happening, set `quit-flag' to nil
3680 before making `inhibit-quit' nil. */);
3681 Vinhibit_quit
= Qnil
;
3683 Qinhibit_quit
= intern_c_string ("inhibit-quit");
3684 staticpro (&Qinhibit_quit
);
3686 Qautoload
= intern_c_string ("autoload");
3687 staticpro (&Qautoload
);
3689 Qdebug_on_error
= intern_c_string ("debug-on-error");
3690 staticpro (&Qdebug_on_error
);
3692 Qmacro
= intern_c_string ("macro");
3693 staticpro (&Qmacro
);
3695 Qdeclare
= intern_c_string ("declare");
3696 staticpro (&Qdeclare
);
3698 /* Note that the process handling also uses Qexit, but we don't want
3699 to staticpro it twice, so we just do it here. */
3700 Qexit
= intern_c_string ("exit");
3703 Qinteractive
= intern_c_string ("interactive");
3704 staticpro (&Qinteractive
);
3706 Qcommandp
= intern_c_string ("commandp");
3707 staticpro (&Qcommandp
);
3709 Qdefun
= intern_c_string ("defun");
3710 staticpro (&Qdefun
);
3712 Qand_rest
= intern_c_string ("&rest");
3713 staticpro (&Qand_rest
);
3715 Qand_optional
= intern_c_string ("&optional");
3716 staticpro (&Qand_optional
);
3718 Qclosure
= intern_c_string ("closure");
3719 staticpro (&Qclosure
);
3721 Qdebug
= intern_c_string ("debug");
3722 staticpro (&Qdebug
);
3724 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3725 doc
: /* *Non-nil means enter debugger if an error is signaled.
3726 Does not apply to errors handled by `condition-case' or those
3727 matched by `debug-ignored-errors'.
3728 If the value is a list, an error only means to enter the debugger
3729 if one of its condition symbols appears in the list.
3730 When you evaluate an expression interactively, this variable
3731 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3732 The command `toggle-debug-on-error' toggles this.
3733 See also the variable `debug-on-quit'. */);
3734 Vdebug_on_error
= Qnil
;
3736 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3737 doc
: /* *List of errors for which the debugger should not be called.
3738 Each element may be a condition-name or a regexp that matches error messages.
3739 If any element applies to a given error, that error skips the debugger
3740 and just returns to top level.
3741 This overrides the variable `debug-on-error'.
3742 It does not apply to errors handled by `condition-case'. */);
3743 Vdebug_ignored_errors
= Qnil
;
3745 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3746 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3747 Does not apply if quit is handled by a `condition-case'. */);
3750 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3751 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3753 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3754 doc
: /* Non-nil means debugger may continue execution.
3755 This is nil when the debugger is called under circumstances where it
3756 might not be safe to continue. */);
3757 debugger_may_continue
= 1;
3759 DEFVAR_LISP ("debugger", Vdebugger
,
3760 doc
: /* Function to call to invoke debugger.
3761 If due to frame exit, args are `exit' and the value being returned;
3762 this function's value will be returned instead of that.
3763 If due to error, args are `error' and a list of the args to `signal'.
3764 If due to `apply' or `funcall' entry, one arg, `lambda'.
3765 If due to `eval' entry, one arg, t. */);
3768 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3769 doc
: /* If non-nil, this is a function for `signal' to call.
3770 It receives the same arguments that `signal' was given.
3771 The Edebug package uses this to regain control. */);
3772 Vsignal_hook_function
= Qnil
;
3774 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3775 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3776 Note that `debug-on-error', `debug-on-quit' and friends
3777 still determine whether to handle the particular condition. */);
3778 Vdebug_on_signal
= Qnil
;
3780 DEFVAR_LISP ("macro-declaration-function", Vmacro_declaration_function
,
3781 doc
: /* Function to process declarations in a macro definition.
3782 The function will be called with two args MACRO and DECL.
3783 MACRO is the name of the macro being defined.
3784 DECL is a list `(declare ...)' containing the declarations.
3785 The value the function returns is not used. */);
3786 Vmacro_declaration_function
= Qnil
;
3788 /* When lexical binding is being used,
3789 vinternal_interpreter_environment is non-nil, and contains an alist
3790 of lexically-bound variable, or (t), indicating an empty
3791 environment. The lisp name of this variable would be
3792 `internal-interpreter-environment' if it weren't hidden.
3793 Every element of this list can be either a cons (VAR . VAL)
3794 specifying a lexical binding, or a single symbol VAR indicating
3795 that this variable should use dynamic scoping. */
3796 Qinternal_interpreter_environment
3797 = intern_c_string ("internal-interpreter-environment");
3798 staticpro (&Qinternal_interpreter_environment
);
3799 DEFVAR_LISP ("internal-interpreter-environment",
3800 Vinternal_interpreter_environment
,
3801 doc
: /* If non-nil, the current lexical environment of the lisp interpreter.
3802 When lexical binding is not being used, this variable is nil.
3803 A value of `(t)' indicates an empty environment, otherwise it is an
3804 alist of active lexical bindings. */);
3805 Vinternal_interpreter_environment
= Qnil
;
3806 /* Don't export this variable to Elisp, so noone can mess with it
3807 (Just imagine if someone makes it buffer-local). */
3808 Funintern (Qinternal_interpreter_environment
, Qnil
);
3810 Vrun_hooks
= intern_c_string ("run-hooks");
3811 staticpro (&Vrun_hooks
);
3813 staticpro (&Vautoload_queue
);
3814 Vautoload_queue
= Qnil
;
3815 staticpro (&Vsignaling_function
);
3816 Vsignaling_function
= Qnil
;
3827 defsubr (&Sfunction
);
3829 defsubr (&Sdefmacro
);
3831 defsubr (&Sdefvaralias
);
3832 defsubr (&Sdefconst
);
3833 defsubr (&Suser_variable_p
);
3837 defsubr (&Smacroexpand
);
3840 defsubr (&Sunwind_protect
);
3841 defsubr (&Scondition_case
);
3843 defsubr (&Sinteractive_p
);
3844 defsubr (&Scalled_interactively_p
);
3845 defsubr (&Scommandp
);
3846 defsubr (&Sautoload
);
3849 defsubr (&Sfuncall
);
3850 defsubr (&Srun_hooks
);
3851 defsubr (&Srun_hook_with_args
);
3852 defsubr (&Srun_hook_with_args_until_success
);
3853 defsubr (&Srun_hook_with_args_until_failure
);
3854 defsubr (&Srun_hook_wrapped
);
3855 defsubr (&Sfetch_bytecode
);
3856 defsubr (&Sbacktrace_debug
);
3857 defsubr (&Sbacktrace
);
3858 defsubr (&Sbacktrace_frame
);
3859 defsubr (&Sspecial_variable_p
);
3860 defsubr (&Sfunctionp
);