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/>. */
25 #include "blockinput.h"
28 #include "dispextern.h"
29 #include "frame.h" /* For XFRAME. */
37 struct backtrace
*next
;
38 Lisp_Object
*function
;
39 Lisp_Object
*args
; /* Points to vector of args. */
40 ptrdiff_t nargs
; /* Length of vector. */
41 /* Nonzero means call value of debugger when done with this operation. */
42 unsigned int debug_on_exit
: 1;
45 static struct backtrace
*backtrace_list
;
50 struct catchtag
*catchlist
;
52 /* Chain of condition handlers currently in effect.
53 The elements of this chain are contained in the stack frames
54 of Fcondition_case and internal_condition_case.
55 When an error is signaled (by calling Fsignal, below),
56 this chain is searched for an element that applies. */
61 struct handler
*handlerlist
;
64 /* Count levels of GCPRO to detect failure to UNGCPRO. */
68 Lisp_Object Qautoload
, Qmacro
, Qexit
, Qinteractive
, Qcommandp
, Qdefun
;
69 Lisp_Object Qinhibit_quit
;
70 Lisp_Object Qand_rest
;
71 static Lisp_Object Qand_optional
;
72 static Lisp_Object Qdebug_on_error
;
73 static Lisp_Object Qdeclare
;
74 Lisp_Object Qinternal_interpreter_environment
, Qclosure
;
76 static Lisp_Object Qdebug
;
78 /* This holds either the symbol `run-hooks' or nil.
79 It is nil at an early stage of startup, and when Emacs
82 Lisp_Object Vrun_hooks
;
84 /* Non-nil means record all fset's and provide's, to be undone
85 if the file being autoloaded is not fully loaded.
86 They are recorded by being consed onto the front of Vautoload_queue:
87 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
89 Lisp_Object Vautoload_queue
;
91 /* Current number of specbindings allocated in specpdl. */
93 EMACS_INT specpdl_size
;
95 /* Pointer to beginning of specpdl. */
97 struct specbinding
*specpdl
;
99 /* Pointer to first unused element in specpdl. */
101 struct specbinding
*specpdl_ptr
;
103 /* Depth in Lisp evaluations and function calls. */
105 static EMACS_INT lisp_eval_depth
;
107 /* The value of num_nonmacro_input_events as of the last time we
108 started to enter the debugger. If we decide to enter the debugger
109 again when this is still equal to num_nonmacro_input_events, then we
110 know that the debugger itself has an error, and we should just
111 signal the error instead of entering an infinite loop of debugger
114 static int when_entered_debugger
;
116 /* The function from which the last `signal' was called. Set in
119 Lisp_Object Vsignaling_function
;
121 /* Set to non-zero while processing X events. Checked in Feval to
122 make sure the Lisp interpreter isn't called from a signal handler,
123 which is unsafe because the interpreter isn't reentrant. */
127 static Lisp_Object
funcall_lambda (Lisp_Object
, ptrdiff_t, Lisp_Object
*);
128 static void unwind_to_catch (struct catchtag
*, Lisp_Object
) NO_RETURN
;
129 static int interactive_p (int);
130 static Lisp_Object
apply_lambda (Lisp_Object fun
, Lisp_Object args
);
131 static Lisp_Object
Ffetch_bytecode (Lisp_Object
);
134 init_eval_once (void)
137 specpdl
= (struct specbinding
*) xmalloc (size
* sizeof (struct specbinding
));
139 specpdl_ptr
= specpdl
;
140 /* Don't forget to update docs (lispref node "Local Variables"). */
141 max_specpdl_size
= 1300; /* 1000 is not enough for CEDET's c-by.el. */
142 max_lisp_eval_depth
= 600;
150 specpdl_ptr
= specpdl
;
155 debug_on_next_call
= 0;
160 /* This is less than the initial value of num_nonmacro_input_events. */
161 when_entered_debugger
= -1;
164 /* Unwind-protect function used by call_debugger. */
167 restore_stack_limits (Lisp_Object data
)
169 max_specpdl_size
= XINT (XCAR (data
));
170 max_lisp_eval_depth
= XINT (XCDR (data
));
174 /* Call the Lisp debugger, giving it argument ARG. */
177 call_debugger (Lisp_Object arg
)
179 int debug_while_redisplaying
;
180 int count
= SPECPDL_INDEX ();
182 EMACS_INT old_max
= max_specpdl_size
;
184 /* Temporarily bump up the stack limits,
185 so the debugger won't run out of stack. */
187 max_specpdl_size
+= 1;
188 record_unwind_protect (restore_stack_limits
,
189 Fcons (make_number (old_max
),
190 make_number (max_lisp_eval_depth
)));
191 max_specpdl_size
= old_max
;
193 if (lisp_eval_depth
+ 40 > max_lisp_eval_depth
)
194 max_lisp_eval_depth
= lisp_eval_depth
+ 40;
196 if (max_specpdl_size
- 100 < SPECPDL_INDEX ())
197 max_specpdl_size
= SPECPDL_INDEX () + 100;
199 #ifdef HAVE_WINDOW_SYSTEM
200 if (display_hourglass_p
)
204 debug_on_next_call
= 0;
205 when_entered_debugger
= num_nonmacro_input_events
;
207 /* Resetting redisplaying_p to 0 makes sure that debug output is
208 displayed if the debugger is invoked during redisplay. */
209 debug_while_redisplaying
= redisplaying_p
;
211 specbind (intern ("debugger-may-continue"),
212 debug_while_redisplaying
? Qnil
: Qt
);
213 specbind (Qinhibit_redisplay
, Qnil
);
214 specbind (Qdebug_on_error
, Qnil
);
216 #if 0 /* Binding this prevents execution of Lisp code during
217 redisplay, which necessarily leads to display problems. */
218 specbind (Qinhibit_eval_during_redisplay
, Qt
);
221 val
= apply1 (Vdebugger
, arg
);
223 /* Interrupting redisplay and resuming it later is not safe under
224 all circumstances. So, when the debugger returns, abort the
225 interrupted redisplay by going back to the top-level. */
226 if (debug_while_redisplaying
)
229 return unbind_to (count
, val
);
233 do_debug_on_call (Lisp_Object code
)
235 debug_on_next_call
= 0;
236 backtrace_list
->debug_on_exit
= 1;
237 call_debugger (Fcons (code
, Qnil
));
240 /* NOTE!!! Every function that can call EVAL must protect its args
241 and temporaries from garbage collection while it needs them.
242 The definition of `For' shows what you have to do. */
244 DEFUN ("or", For
, Sor
, 0, UNEVALLED
, 0,
245 doc
: /* Eval args until one of them yields non-nil, then return that value.
246 The remaining args are not evalled at all.
247 If all args return nil, return nil.
248 usage: (or CONDITIONS...) */)
251 register Lisp_Object val
= Qnil
;
258 val
= eval_sub (XCAR (args
));
268 DEFUN ("and", Fand
, Sand
, 0, UNEVALLED
, 0,
269 doc
: /* Eval args until one of them yields nil, then return nil.
270 The remaining args are not evalled at all.
271 If no arg yields nil, return the last arg's value.
272 usage: (and CONDITIONS...) */)
275 register Lisp_Object val
= Qt
;
282 val
= eval_sub (XCAR (args
));
292 DEFUN ("if", Fif
, Sif
, 2, UNEVALLED
, 0,
293 doc
: /* If COND yields non-nil, do THEN, else do ELSE...
294 Returns the value of THEN or the value of the last of the ELSE's.
295 THEN must be one expression, but ELSE... can be zero or more expressions.
296 If COND yields nil, and there are no ELSE's, the value is nil.
297 usage: (if COND THEN ELSE...) */)
300 register Lisp_Object cond
;
304 cond
= eval_sub (Fcar (args
));
308 return eval_sub (Fcar (Fcdr (args
)));
309 return Fprogn (Fcdr (Fcdr (args
)));
312 DEFUN ("cond", Fcond
, Scond
, 0, UNEVALLED
, 0,
313 doc
: /* Try each clause until one succeeds.
314 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
315 and, if the value is non-nil, this clause succeeds:
316 then the expressions in BODY are evaluated and the last one's
317 value is the value of the cond-form.
318 If no clause succeeds, cond returns nil.
319 If a clause has one element, as in (CONDITION),
320 CONDITION's value if non-nil is returned from the cond-form.
321 usage: (cond CLAUSES...) */)
324 register Lisp_Object clause
, val
;
331 clause
= Fcar (args
);
332 val
= eval_sub (Fcar (clause
));
335 if (!EQ (XCDR (clause
), Qnil
))
336 val
= Fprogn (XCDR (clause
));
346 DEFUN ("progn", Fprogn
, Sprogn
, 0, UNEVALLED
, 0,
347 doc
: /* Eval BODY forms sequentially and return value of last one.
348 usage: (progn BODY...) */)
351 register Lisp_Object val
= Qnil
;
358 val
= eval_sub (XCAR (args
));
366 DEFUN ("prog1", Fprog1
, Sprog1
, 1, UNEVALLED
, 0,
367 doc
: /* Eval FIRST and BODY sequentially; return value from FIRST.
368 The value of FIRST is saved during the evaluation of the remaining args,
369 whose values are discarded.
370 usage: (prog1 FIRST BODY...) */)
374 register Lisp_Object args_left
;
375 struct gcpro gcpro1
, gcpro2
;
376 register int argnum
= 0;
387 Lisp_Object tem
= eval_sub (XCAR (args_left
));
390 args_left
= XCDR (args_left
);
392 while (CONSP (args_left
));
398 DEFUN ("prog2", Fprog2
, Sprog2
, 2, UNEVALLED
, 0,
399 doc
: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
400 The value of FORM2 is saved during the evaluation of the
401 remaining args, whose values are discarded.
402 usage: (prog2 FORM1 FORM2 BODY...) */)
406 register Lisp_Object args_left
;
407 struct gcpro gcpro1
, gcpro2
;
408 register int argnum
= -1;
421 Lisp_Object tem
= eval_sub (XCAR (args_left
));
424 args_left
= XCDR (args_left
);
426 while (CONSP (args_left
));
432 DEFUN ("setq", Fsetq
, Ssetq
, 0, UNEVALLED
, 0,
433 doc
: /* Set each SYM to the value of its VAL.
434 The symbols SYM are variables; they are literal (not evaluated).
435 The values VAL are expressions; they are evaluated.
436 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
437 The second VAL is not computed until after the first SYM is set, and so on;
438 each VAL can use the new value of variables set earlier in the `setq'.
439 The return value of the `setq' form is the value of the last VAL.
440 usage: (setq [SYM VAL]...) */)
443 register Lisp_Object args_left
;
444 register Lisp_Object val
, sym
, lex_binding
;
455 val
= eval_sub (Fcar (Fcdr (args_left
)));
456 sym
= Fcar (args_left
);
458 /* Like for eval_sub, we do not check declared_special here since
459 it's been done when let-binding. */
460 if (!NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
462 && !NILP (lex_binding
463 = Fassq (sym
, Vinternal_interpreter_environment
)))
464 XSETCDR (lex_binding
, val
); /* SYM is lexically bound. */
466 Fset (sym
, val
); /* SYM is dynamically bound. */
468 args_left
= Fcdr (Fcdr (args_left
));
470 while (!NILP(args_left
));
476 DEFUN ("quote", Fquote
, Squote
, 1, UNEVALLED
, 0,
477 doc
: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
478 usage: (quote ARG) */)
481 if (!NILP (Fcdr (args
)))
482 xsignal2 (Qwrong_number_of_arguments
, Qquote
, Flength (args
));
486 DEFUN ("function", Ffunction
, Sfunction
, 1, UNEVALLED
, 0,
487 doc
: /* Like `quote', but preferred for objects which are functions.
488 In byte compilation, `function' causes its argument to be compiled.
489 `quote' cannot do that.
490 usage: (function ARG) */)
493 Lisp_Object quoted
= XCAR (args
);
495 if (!NILP (Fcdr (args
)))
496 xsignal2 (Qwrong_number_of_arguments
, Qfunction
, Flength (args
));
498 if (!NILP (Vinternal_interpreter_environment
)
500 && EQ (XCAR (quoted
), Qlambda
))
501 /* This is a lambda expression within a lexical environment;
502 return an interpreted closure instead of a simple lambda. */
503 return Fcons (Qclosure
, Fcons (Vinternal_interpreter_environment
,
506 /* Simply quote the argument. */
511 DEFUN ("interactive-p", Finteractive_p
, Sinteractive_p
, 0, 0, 0,
512 doc
: /* Return t if the containing function was run directly by user input.
513 This means that the function was called with `call-interactively'
514 \(which includes being called as the binding of a key)
515 and input is currently coming from the keyboard (not a keyboard macro),
516 and Emacs is not running in batch mode (`noninteractive' is nil).
518 The only known proper use of `interactive-p' is in deciding whether to
519 display a helpful message, or how to display it. If you're thinking
520 of using it for any other purpose, it is quite likely that you're
521 making a mistake. Think: what do you want to do when the command is
522 called from a keyboard macro?
524 To test whether your function was called with `call-interactively',
525 either (i) add an extra optional argument and give it an `interactive'
526 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
527 use `called-interactively-p'. */)
530 return interactive_p (1) ? Qt
: Qnil
;
534 DEFUN ("called-interactively-p", Fcalled_interactively_p
, Scalled_interactively_p
, 0, 1, 0,
535 doc
: /* Return t if the containing function was called by `call-interactively'.
536 If KIND is `interactive', then only return t if the call was made
537 interactively by the user, i.e. not in `noninteractive' mode nor
538 when `executing-kbd-macro'.
539 If KIND is `any', on the other hand, it will return t for any kind of
540 interactive call, including being called as the binding of a key, or
541 from a keyboard macro, or in `noninteractive' mode.
543 The only known proper use of `interactive' for KIND is in deciding
544 whether to display a helpful message, or how to display it. If you're
545 thinking of using it for any other purpose, it is quite likely that
546 you're making a mistake. Think: what do you want to do when the
547 command is called from a keyboard macro?
549 This function is meant for implementing advice and other
550 function-modifying features. Instead of using this, it is sometimes
551 cleaner to give your function an extra optional argument whose
552 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
553 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
556 return ((INTERACTIVE
|| !EQ (kind
, intern ("interactive")))
557 && interactive_p (1)) ? Qt
: Qnil
;
561 /* Return 1 if function in which this appears was called using
564 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
565 called is a built-in. */
568 interactive_p (int exclude_subrs_p
)
570 struct backtrace
*btp
;
573 btp
= backtrace_list
;
575 /* If this isn't a byte-compiled function, there may be a frame at
576 the top for Finteractive_p. If so, skip it. */
577 fun
= Findirect_function (*btp
->function
, Qnil
);
578 if (SUBRP (fun
) && (XSUBR (fun
) == &Sinteractive_p
579 || XSUBR (fun
) == &Scalled_interactively_p
))
582 /* If we're running an Emacs 18-style byte-compiled function, there
583 may be a frame for Fbytecode at the top level. In any version of
584 Emacs there can be Fbytecode frames for subexpressions evaluated
585 inside catch and condition-case. Skip past them.
587 If this isn't a byte-compiled function, then we may now be
588 looking at several frames for special forms. Skip past them. */
590 && (EQ (*btp
->function
, Qbytecode
)
591 || btp
->nargs
== UNEVALLED
))
594 /* `btp' now points at the frame of the innermost function that isn't
595 a special form, ignoring frames for Finteractive_p and/or
596 Fbytecode at the top. If this frame is for a built-in function
597 (such as load or eval-region) return nil. */
598 fun
= Findirect_function (*btp
->function
, Qnil
);
599 if (exclude_subrs_p
&& SUBRP (fun
))
602 /* `btp' points to the frame of a Lisp function that called interactive-p.
603 Return t if that function was called interactively. */
604 if (btp
&& btp
->next
&& EQ (*btp
->next
->function
, Qcall_interactively
))
610 DEFUN ("defun", Fdefun
, Sdefun
, 2, UNEVALLED
, 0,
611 doc
: /* Define NAME as a function.
612 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
613 See also the function `interactive'.
614 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
617 register Lisp_Object fn_name
;
618 register Lisp_Object defn
;
620 fn_name
= Fcar (args
);
621 CHECK_SYMBOL (fn_name
);
622 defn
= Fcons (Qlambda
, Fcdr (args
));
623 if (!NILP (Vinternal_interpreter_environment
)) /* Mere optimization! */
624 defn
= Ffunction (Fcons (defn
, Qnil
));
625 if (!NILP (Vpurify_flag
))
626 defn
= Fpurecopy (defn
);
627 if (CONSP (XSYMBOL (fn_name
)->function
)
628 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
629 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
630 Ffset (fn_name
, defn
);
631 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
635 DEFUN ("defmacro", Fdefmacro
, Sdefmacro
, 2, UNEVALLED
, 0,
636 doc
: /* Define NAME as a macro.
637 The actual definition looks like
638 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
639 When the macro is called, as in (NAME ARGS...),
640 the function (lambda ARGLIST BODY...) is applied to
641 the list ARGS... as it appears in the expression,
642 and the result should be a form to be evaluated instead of the original.
644 DECL is a declaration, optional, which can specify how to indent
645 calls to this macro, how Edebug should handle it, and which argument
646 should be treated as documentation. It looks like this:
648 The elements can look like this:
650 Set NAME's `lisp-indent-function' property to INDENT.
653 Set NAME's `edebug-form-spec' property to DEBUG. (This is
654 equivalent to writing a `def-edebug-spec' for the macro.)
657 Set NAME's `doc-string-elt' property to ELT.
659 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
662 register Lisp_Object fn_name
;
663 register Lisp_Object defn
;
664 Lisp_Object lambda_list
, doc
, tail
;
666 fn_name
= Fcar (args
);
667 CHECK_SYMBOL (fn_name
);
668 lambda_list
= Fcar (Fcdr (args
));
669 tail
= Fcdr (Fcdr (args
));
672 if (STRINGP (Fcar (tail
)))
678 if (CONSP (Fcar (tail
))
679 && EQ (Fcar (Fcar (tail
)), Qdeclare
))
681 if (!NILP (Vmacro_declaration_function
))
685 call2 (Vmacro_declaration_function
, fn_name
, Fcar (tail
));
693 tail
= Fcons (lambda_list
, tail
);
695 tail
= Fcons (lambda_list
, Fcons (doc
, tail
));
697 defn
= Fcons (Qlambda
, tail
);
698 if (!NILP (Vinternal_interpreter_environment
)) /* Mere optimization! */
699 defn
= Ffunction (Fcons (defn
, Qnil
));
700 defn
= Fcons (Qmacro
, defn
);
702 if (!NILP (Vpurify_flag
))
703 defn
= Fpurecopy (defn
);
704 if (CONSP (XSYMBOL (fn_name
)->function
)
705 && EQ (XCAR (XSYMBOL (fn_name
)->function
), Qautoload
))
706 LOADHIST_ATTACH (Fcons (Qt
, fn_name
));
707 Ffset (fn_name
, defn
);
708 LOADHIST_ATTACH (Fcons (Qdefun
, fn_name
));
713 DEFUN ("defvaralias", Fdefvaralias
, Sdefvaralias
, 2, 3, 0,
714 doc
: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
715 Aliased variables always have the same value; setting one sets the other.
716 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
717 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
718 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
719 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
720 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
721 The return value is BASE-VARIABLE. */)
722 (Lisp_Object new_alias
, Lisp_Object base_variable
, Lisp_Object docstring
)
724 struct Lisp_Symbol
*sym
;
726 CHECK_SYMBOL (new_alias
);
727 CHECK_SYMBOL (base_variable
);
729 sym
= XSYMBOL (new_alias
);
732 /* Not sure why, but why not? */
733 error ("Cannot make a constant an alias");
735 switch (sym
->redirect
)
737 case SYMBOL_FORWARDED
:
738 error ("Cannot make an internal variable an alias");
739 case SYMBOL_LOCALIZED
:
740 error ("Don't know how to make a localized variable an alias");
743 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
744 If n_a is bound, but b_v is not, set the value of b_v to n_a,
745 so that old-code that affects n_a before the aliasing is setup
747 if (NILP (Fboundp (base_variable
)))
748 set_internal (base_variable
, find_symbol_value (new_alias
), Qnil
, 1);
751 struct specbinding
*p
;
753 for (p
= specpdl_ptr
- 1; p
>= specpdl
; p
--)
756 CONSP (p
->symbol
) ? XCAR (p
->symbol
) : p
->symbol
)))
757 error ("Don't know how to make a let-bound variable an alias");
760 sym
->declared_special
= 1;
761 XSYMBOL (base_variable
)->declared_special
= 1;
762 sym
->redirect
= SYMBOL_VARALIAS
;
763 SET_SYMBOL_ALIAS (sym
, XSYMBOL (base_variable
));
764 sym
->constant
= SYMBOL_CONSTANT_P (base_variable
);
765 LOADHIST_ATTACH (new_alias
);
766 /* Even if docstring is nil: remove old docstring. */
767 Fput (new_alias
, Qvariable_documentation
, docstring
);
769 return base_variable
;
773 DEFUN ("defvar", Fdefvar
, Sdefvar
, 1, UNEVALLED
, 0,
774 doc
: /* Define SYMBOL as a variable, and return SYMBOL.
775 You are not required to define a variable in order to use it,
776 but the definition can supply documentation and an initial value
777 in a way that tags can recognize.
779 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
780 If SYMBOL is buffer-local, its default value is what is set;
781 buffer-local values are not affected.
782 INITVALUE and DOCSTRING are optional.
783 If DOCSTRING starts with *, this variable is identified as a user option.
784 This means that M-x set-variable recognizes it.
785 See also `user-variable-p'.
786 If INITVALUE is missing, SYMBOL's value is not set.
788 If SYMBOL has a local binding, then this form affects the local
789 binding. This is usually not what you want. Thus, if you need to
790 load a file defining variables, with this form or with `defconst' or
791 `defcustom', you should always load that file _outside_ any bindings
792 for these variables. \(`defconst' and `defcustom' behave similarly in
794 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
797 register Lisp_Object sym
, tem
, tail
;
801 if (!NILP (Fcdr (Fcdr (tail
))))
802 error ("Too many arguments");
804 tem
= Fdefault_boundp (sym
);
807 /* Do it before evaluating the initial value, for self-references. */
808 XSYMBOL (sym
)->declared_special
= 1;
810 if (SYMBOL_CONSTANT_P (sym
))
812 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
813 Lisp_Object tem1
= Fcar (tail
);
815 && EQ (XCAR (tem1
), Qquote
)
816 && CONSP (XCDR (tem1
))
817 && EQ (XCAR (XCDR (tem1
)), sym
)))
818 error ("Constant symbol `%s' specified in defvar",
819 SDATA (SYMBOL_NAME (sym
)));
823 Fset_default (sym
, eval_sub (Fcar (tail
)));
825 { /* Check if there is really a global binding rather than just a let
826 binding that shadows the global unboundness of the var. */
827 volatile struct specbinding
*pdl
= specpdl_ptr
;
828 while (--pdl
>= specpdl
)
830 if (EQ (pdl
->symbol
, sym
) && !pdl
->func
831 && EQ (pdl
->old_value
, Qunbound
))
833 message_with_string ("Warning: defvar ignored because %s is let-bound",
834 SYMBOL_NAME (sym
), 1);
843 if (!NILP (Vpurify_flag
))
844 tem
= Fpurecopy (tem
);
845 Fput (sym
, Qvariable_documentation
, tem
);
847 LOADHIST_ATTACH (sym
);
849 else if (!NILP (Vinternal_interpreter_environment
)
850 && !XSYMBOL (sym
)->declared_special
)
851 /* A simple (defvar foo) with lexical scoping does "nothing" except
852 declare that var to be dynamically scoped *locally* (i.e. within
853 the current file or let-block). */
854 Vinternal_interpreter_environment
=
855 Fcons (sym
, Vinternal_interpreter_environment
);
858 /* Simple (defvar <var>) should not count as a definition at all.
859 It could get in the way of other definitions, and unloading this
860 package could try to make the variable unbound. */
866 DEFUN ("defconst", Fdefconst
, Sdefconst
, 2, UNEVALLED
, 0,
867 doc
: /* Define SYMBOL as a constant variable.
868 The intent is that neither programs nor users should ever change this value.
869 Always sets the value of SYMBOL to the result of evalling INITVALUE.
870 If SYMBOL is buffer-local, its default value is what is set;
871 buffer-local values are not affected.
872 DOCSTRING is optional.
874 If SYMBOL has a local binding, then this form sets the local binding's
875 value. However, you should normally not make local bindings for
876 variables defined with this form.
877 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
880 register Lisp_Object sym
, tem
;
883 if (!NILP (Fcdr (Fcdr (Fcdr (args
)))))
884 error ("Too many arguments");
886 tem
= eval_sub (Fcar (Fcdr (args
)));
887 if (!NILP (Vpurify_flag
))
888 tem
= Fpurecopy (tem
);
889 Fset_default (sym
, tem
);
890 XSYMBOL (sym
)->declared_special
= 1;
891 tem
= Fcar (Fcdr (Fcdr (args
)));
894 if (!NILP (Vpurify_flag
))
895 tem
= Fpurecopy (tem
);
896 Fput (sym
, Qvariable_documentation
, tem
);
898 Fput (sym
, Qrisky_local_variable
, Qt
);
899 LOADHIST_ATTACH (sym
);
903 /* Error handler used in Fuser_variable_p. */
905 user_variable_p_eh (Lisp_Object ignore
)
911 lisp_indirect_variable (Lisp_Object sym
)
913 struct Lisp_Symbol
*s
= indirect_variable (XSYMBOL (sym
));
918 DEFUN ("user-variable-p", Fuser_variable_p
, Suser_variable_p
, 1, 1, 0,
919 doc
: /* Return t if VARIABLE is intended to be set and modified by users.
920 \(The alternative is a variable used internally in a Lisp program.)
921 A variable is a user variable if
922 \(1) the first character of its documentation is `*', or
923 \(2) it is customizable (its property list contains a non-nil value
924 of `standard-value' or `custom-autoload'), or
925 \(3) it is an alias for another user variable.
926 Return nil if VARIABLE is an alias and there is a loop in the
927 chain of symbols. */)
928 (Lisp_Object variable
)
930 Lisp_Object documentation
;
932 if (!SYMBOLP (variable
))
935 /* If indirect and there's an alias loop, don't check anything else. */
936 if (XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
937 && NILP (internal_condition_case_1 (lisp_indirect_variable
, variable
,
938 Qt
, user_variable_p_eh
)))
943 documentation
= Fget (variable
, Qvariable_documentation
);
944 if (INTEGERP (documentation
) && XINT (documentation
) < 0)
946 if (STRINGP (documentation
)
947 && ((unsigned char) SREF (documentation
, 0) == '*'))
949 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
950 if (CONSP (documentation
)
951 && STRINGP (XCAR (documentation
))
952 && INTEGERP (XCDR (documentation
))
953 && XINT (XCDR (documentation
)) < 0)
955 /* Customizable? See `custom-variable-p'. */
956 if ((!NILP (Fget (variable
, intern ("standard-value"))))
957 || (!NILP (Fget (variable
, intern ("custom-autoload")))))
960 if (!(XSYMBOL (variable
)->redirect
== SYMBOL_VARALIAS
))
963 /* An indirect variable? Let's follow the chain. */
964 XSETSYMBOL (variable
, SYMBOL_ALIAS (XSYMBOL (variable
)));
968 DEFUN ("let*", FletX
, SletX
, 1, UNEVALLED
, 0,
969 doc
: /* Bind variables according to VARLIST then eval BODY.
970 The value of the last form in BODY is returned.
971 Each element of VARLIST is a symbol (which is bound to nil)
972 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
973 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
974 usage: (let* VARLIST BODY...) */)
977 Lisp_Object varlist
, var
, val
, elt
, lexenv
;
978 int count
= SPECPDL_INDEX ();
979 struct gcpro gcpro1
, gcpro2
, gcpro3
;
981 GCPRO3 (args
, elt
, varlist
);
983 lexenv
= Vinternal_interpreter_environment
;
985 varlist
= Fcar (args
);
986 while (CONSP (varlist
))
990 elt
= XCAR (varlist
);
996 else if (! NILP (Fcdr (Fcdr (elt
))))
997 signal_error ("`let' bindings can have only one value-form", elt
);
1001 val
= eval_sub (Fcar (Fcdr (elt
)));
1004 if (!NILP (lexenv
) && SYMBOLP (var
)
1005 && !XSYMBOL (var
)->declared_special
1006 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
1007 /* Lexically bind VAR by adding it to the interpreter's binding
1011 = Fcons (Fcons (var
, val
), Vinternal_interpreter_environment
);
1012 if (EQ (Vinternal_interpreter_environment
, lexenv
))
1013 /* Save the old lexical environment on the specpdl stack,
1014 but only for the first lexical binding, since we'll never
1015 need to revert to one of the intermediate ones. */
1016 specbind (Qinternal_interpreter_environment
, newenv
);
1018 Vinternal_interpreter_environment
= newenv
;
1021 specbind (var
, val
);
1023 varlist
= XCDR (varlist
);
1026 val
= Fprogn (Fcdr (args
));
1027 return unbind_to (count
, val
);
1030 DEFUN ("let", Flet
, Slet
, 1, UNEVALLED
, 0,
1031 doc
: /* Bind variables according to VARLIST then eval BODY.
1032 The value of the last form in BODY is returned.
1033 Each element of VARLIST is a symbol (which is bound to nil)
1034 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1035 All the VALUEFORMs are evalled before any symbols are bound.
1036 usage: (let VARLIST BODY...) */)
1039 Lisp_Object
*temps
, tem
, lexenv
;
1040 register Lisp_Object elt
, varlist
;
1041 int count
= SPECPDL_INDEX ();
1043 struct gcpro gcpro1
, gcpro2
;
1046 varlist
= Fcar (args
);
1048 /* Make space to hold the values to give the bound variables. */
1049 elt
= Flength (varlist
);
1050 SAFE_ALLOCA_LISP (temps
, XFASTINT (elt
));
1052 /* Compute the values and store them in `temps'. */
1054 GCPRO2 (args
, *temps
);
1057 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1060 elt
= XCAR (varlist
);
1062 temps
[argnum
++] = Qnil
;
1063 else if (! NILP (Fcdr (Fcdr (elt
))))
1064 signal_error ("`let' bindings can have only one value-form", elt
);
1066 temps
[argnum
++] = eval_sub (Fcar (Fcdr (elt
)));
1067 gcpro2
.nvars
= argnum
;
1071 lexenv
= Vinternal_interpreter_environment
;
1073 varlist
= Fcar (args
);
1074 for (argnum
= 0; CONSP (varlist
); varlist
= XCDR (varlist
))
1078 elt
= XCAR (varlist
);
1079 var
= SYMBOLP (elt
) ? elt
: Fcar (elt
);
1080 tem
= temps
[argnum
++];
1082 if (!NILP (lexenv
) && SYMBOLP (var
)
1083 && !XSYMBOL (var
)->declared_special
1084 && NILP (Fmemq (var
, Vinternal_interpreter_environment
)))
1085 /* Lexically bind VAR by adding it to the lexenv alist. */
1086 lexenv
= Fcons (Fcons (var
, tem
), lexenv
);
1088 /* Dynamically bind VAR. */
1089 specbind (var
, tem
);
1092 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
1093 /* Instantiate a new lexical environment. */
1094 specbind (Qinternal_interpreter_environment
, lexenv
);
1096 elt
= Fprogn (Fcdr (args
));
1098 return unbind_to (count
, elt
);
1101 DEFUN ("while", Fwhile
, Swhile
, 1, UNEVALLED
, 0,
1102 doc
: /* If TEST yields non-nil, eval BODY... and repeat.
1103 The order of execution is thus TEST, BODY, TEST, BODY and so on
1104 until TEST returns nil.
1105 usage: (while TEST BODY...) */)
1108 Lisp_Object test
, body
;
1109 struct gcpro gcpro1
, gcpro2
;
1111 GCPRO2 (test
, body
);
1115 while (!NILP (eval_sub (test
)))
1125 DEFUN ("macroexpand", Fmacroexpand
, Smacroexpand
, 1, 2, 0,
1126 doc
: /* Return result of expanding macros at top level of FORM.
1127 If FORM is not a macro call, it is returned unchanged.
1128 Otherwise, the macro is expanded and the expansion is considered
1129 in place of FORM. When a non-macro-call results, it is returned.
1131 The second optional arg ENVIRONMENT specifies an environment of macro
1132 definitions to shadow the loaded ones for use in file byte-compilation. */)
1133 (Lisp_Object form
, Lisp_Object environment
)
1135 /* With cleanups from Hallvard Furuseth. */
1136 register Lisp_Object expander
, sym
, def
, tem
;
1140 /* Come back here each time we expand a macro call,
1141 in case it expands into another macro call. */
1144 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1145 def
= sym
= XCAR (form
);
1147 /* Trace symbols aliases to other symbols
1148 until we get a symbol that is not an alias. */
1149 while (SYMBOLP (def
))
1153 tem
= Fassq (sym
, environment
);
1156 def
= XSYMBOL (sym
)->function
;
1157 if (!EQ (def
, Qunbound
))
1162 /* Right now TEM is the result from SYM in ENVIRONMENT,
1163 and if TEM is nil then DEF is SYM's function definition. */
1166 /* SYM is not mentioned in ENVIRONMENT.
1167 Look at its function definition. */
1168 if (EQ (def
, Qunbound
) || !CONSP (def
))
1169 /* Not defined or definition not suitable. */
1171 if (EQ (XCAR (def
), Qautoload
))
1173 /* Autoloading function: will it be a macro when loaded? */
1174 tem
= Fnth (make_number (4), def
);
1175 if (EQ (tem
, Qt
) || EQ (tem
, Qmacro
))
1176 /* Yes, load it and try again. */
1178 struct gcpro gcpro1
;
1180 do_autoload (def
, sym
);
1187 else if (!EQ (XCAR (def
), Qmacro
))
1189 else expander
= XCDR (def
);
1193 expander
= XCDR (tem
);
1194 if (NILP (expander
))
1197 form
= apply1 (expander
, XCDR (form
));
1202 DEFUN ("catch", Fcatch
, Scatch
, 1, UNEVALLED
, 0,
1203 doc
: /* Eval BODY allowing nonlocal exits using `throw'.
1204 TAG is evalled to get the tag to use; it must not be nil.
1206 Then the BODY is executed.
1207 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1208 If no throw happens, `catch' returns the value of the last BODY form.
1209 If a throw happens, it specifies the value to return from `catch'.
1210 usage: (catch TAG BODY...) */)
1213 register Lisp_Object tag
;
1214 struct gcpro gcpro1
;
1217 tag
= eval_sub (Fcar (args
));
1219 return internal_catch (tag
, Fprogn
, Fcdr (args
));
1222 /* Set up a catch, then call C function FUNC on argument ARG.
1223 FUNC should return a Lisp_Object.
1224 This is how catches are done from within C code. */
1227 internal_catch (Lisp_Object tag
, Lisp_Object (*func
) (Lisp_Object
), Lisp_Object arg
)
1229 /* This structure is made part of the chain `catchlist'. */
1232 /* Fill in the components of c, and put it on the list. */
1236 c
.backlist
= backtrace_list
;
1237 c
.handlerlist
= handlerlist
;
1238 c
.lisp_eval_depth
= lisp_eval_depth
;
1239 c
.pdlcount
= SPECPDL_INDEX ();
1240 c
.poll_suppress_count
= poll_suppress_count
;
1241 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1242 c
.gcpro
= gcprolist
;
1243 c
.byte_stack
= byte_stack_list
;
1247 if (! _setjmp (c
.jmp
))
1248 c
.val
= (*func
) (arg
);
1250 /* Throw works by a longjmp that comes right here. */
1255 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1256 jump to that CATCH, returning VALUE as the value of that catch.
1258 This is the guts Fthrow and Fsignal; they differ only in the way
1259 they choose the catch tag to throw to. A catch tag for a
1260 condition-case form has a TAG of Qnil.
1262 Before each catch is discarded, unbind all special bindings and
1263 execute all unwind-protect clauses made above that catch. Unwind
1264 the handler stack as we go, so that the proper handlers are in
1265 effect for each unwind-protect clause we run. At the end, restore
1266 some static info saved in CATCH, and longjmp to the location
1269 This is used for correct unwinding in Fthrow and Fsignal. */
1272 unwind_to_catch (struct catchtag
*catch, Lisp_Object value
)
1274 register int last_time
;
1276 /* Save the value in the tag. */
1279 /* Restore certain special C variables. */
1280 set_poll_suppress_count (catch->poll_suppress_count
);
1281 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked
);
1282 handling_signal
= 0;
1287 last_time
= catchlist
== catch;
1289 /* Unwind the specpdl stack, and then restore the proper set of
1291 unbind_to (catchlist
->pdlcount
, Qnil
);
1292 handlerlist
= catchlist
->handlerlist
;
1293 catchlist
= catchlist
->next
;
1295 while (! last_time
);
1298 /* If x_catch_errors was done, turn it off now.
1299 (First we give unbind_to a chance to do that.) */
1300 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1301 The catch must remain in effect during that delicate
1302 state. --lorentey */
1303 x_fully_uncatch_errors ();
1307 byte_stack_list
= catch->byte_stack
;
1308 gcprolist
= catch->gcpro
;
1310 gcpro_level
= gcprolist
? gcprolist
->level
+ 1 : 0;
1312 backtrace_list
= catch->backlist
;
1313 lisp_eval_depth
= catch->lisp_eval_depth
;
1315 _longjmp (catch->jmp
, 1);
1318 DEFUN ("throw", Fthrow
, Sthrow
, 2, 2, 0,
1319 doc
: /* Throw to the catch for TAG and return VALUE from it.
1320 Both TAG and VALUE are evalled. */)
1321 (register Lisp_Object tag
, Lisp_Object value
)
1323 register struct catchtag
*c
;
1326 for (c
= catchlist
; c
; c
= c
->next
)
1328 if (EQ (c
->tag
, tag
))
1329 unwind_to_catch (c
, value
);
1331 xsignal2 (Qno_catch
, tag
, value
);
1335 DEFUN ("unwind-protect", Funwind_protect
, Sunwind_protect
, 1, UNEVALLED
, 0,
1336 doc
: /* Do BODYFORM, protecting with UNWINDFORMS.
1337 If BODYFORM completes normally, its value is returned
1338 after executing the UNWINDFORMS.
1339 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1340 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1344 int count
= SPECPDL_INDEX ();
1346 record_unwind_protect (Fprogn
, Fcdr (args
));
1347 val
= eval_sub (Fcar (args
));
1348 return unbind_to (count
, val
);
1351 DEFUN ("condition-case", Fcondition_case
, Scondition_case
, 2, UNEVALLED
, 0,
1352 doc
: /* Regain control when an error is signaled.
1353 Executes BODYFORM and returns its value if no error happens.
1354 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1355 where the BODY is made of Lisp expressions.
1357 A handler is applicable to an error
1358 if CONDITION-NAME is one of the error's condition names.
1359 If an error happens, the first applicable handler is run.
1361 The car of a handler may be a list of condition names instead of a
1362 single condition name; then it handles all of them. If the special
1363 condition name `debug' is present in this list, it allows another
1364 condition in the list to run the debugger if `debug-on-error' and the
1365 other usual mechanisms says it should (otherwise, `condition-case'
1366 suppresses the debugger).
1368 When a handler handles an error, control returns to the `condition-case'
1369 and it executes the handler's BODY...
1370 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1371 \(If VAR is nil, the handler can't access that information.)
1372 Then the value of the last BODY form is returned from the `condition-case'
1375 See also the function `signal' for more info.
1376 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1379 register Lisp_Object bodyform
, handlers
;
1380 volatile Lisp_Object var
;
1383 bodyform
= Fcar (Fcdr (args
));
1384 handlers
= Fcdr (Fcdr (args
));
1386 return internal_lisp_condition_case (var
, bodyform
, handlers
);
1389 /* Like Fcondition_case, but the args are separate
1390 rather than passed in a list. Used by Fbyte_code. */
1393 internal_lisp_condition_case (volatile Lisp_Object var
, Lisp_Object bodyform
,
1394 Lisp_Object handlers
)
1402 for (val
= handlers
; CONSP (val
); val
= XCDR (val
))
1408 && (SYMBOLP (XCAR (tem
))
1409 || CONSP (XCAR (tem
))))))
1410 error ("Invalid condition handler: %s",
1411 SDATA (Fprin1_to_string (tem
, Qt
)));
1416 c
.backlist
= backtrace_list
;
1417 c
.handlerlist
= handlerlist
;
1418 c
.lisp_eval_depth
= lisp_eval_depth
;
1419 c
.pdlcount
= SPECPDL_INDEX ();
1420 c
.poll_suppress_count
= poll_suppress_count
;
1421 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1422 c
.gcpro
= gcprolist
;
1423 c
.byte_stack
= byte_stack_list
;
1424 if (_setjmp (c
.jmp
))
1427 specbind (h
.var
, c
.val
);
1428 val
= Fprogn (Fcdr (h
.chosen_clause
));
1430 /* Note that this just undoes the binding of h.var; whoever
1431 longjumped to us unwound the stack to c.pdlcount before
1433 unbind_to (c
.pdlcount
, Qnil
);
1440 h
.handler
= handlers
;
1441 h
.next
= handlerlist
;
1445 val
= eval_sub (bodyform
);
1447 handlerlist
= h
.next
;
1451 /* Call the function BFUN with no arguments, catching errors within it
1452 according to HANDLERS. If there is an error, call HFUN with
1453 one argument which is the data that describes the error:
1456 HANDLERS can be a list of conditions to catch.
1457 If HANDLERS is Qt, catch all errors.
1458 If HANDLERS is Qerror, catch all errors
1459 but allow the debugger to run if that is enabled. */
1462 internal_condition_case (Lisp_Object (*bfun
) (void), Lisp_Object handlers
,
1463 Lisp_Object (*hfun
) (Lisp_Object
))
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
))
1509 c
.backlist
= backtrace_list
;
1510 c
.handlerlist
= handlerlist
;
1511 c
.lisp_eval_depth
= lisp_eval_depth
;
1512 c
.pdlcount
= SPECPDL_INDEX ();
1513 c
.poll_suppress_count
= poll_suppress_count
;
1514 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1515 c
.gcpro
= gcprolist
;
1516 c
.byte_stack
= byte_stack_list
;
1517 if (_setjmp (c
.jmp
))
1519 return (*hfun
) (c
.val
);
1523 h
.handler
= handlers
;
1525 h
.next
= handlerlist
;
1529 val
= (*bfun
) (arg
);
1531 handlerlist
= h
.next
;
1535 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1539 internal_condition_case_2 (Lisp_Object (*bfun
) (Lisp_Object
, Lisp_Object
),
1542 Lisp_Object handlers
,
1543 Lisp_Object (*hfun
) (Lisp_Object
))
1551 c
.backlist
= backtrace_list
;
1552 c
.handlerlist
= handlerlist
;
1553 c
.lisp_eval_depth
= lisp_eval_depth
;
1554 c
.pdlcount
= SPECPDL_INDEX ();
1555 c
.poll_suppress_count
= poll_suppress_count
;
1556 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1557 c
.gcpro
= gcprolist
;
1558 c
.byte_stack
= byte_stack_list
;
1559 if (_setjmp (c
.jmp
))
1561 return (*hfun
) (c
.val
);
1565 h
.handler
= handlers
;
1567 h
.next
= handlerlist
;
1571 val
= (*bfun
) (arg1
, arg2
);
1573 handlerlist
= h
.next
;
1577 /* Like internal_condition_case but call BFUN with NARGS as first,
1578 and ARGS as second argument. */
1581 internal_condition_case_n (Lisp_Object (*bfun
) (ptrdiff_t, Lisp_Object
*),
1584 Lisp_Object handlers
,
1585 Lisp_Object (*hfun
) (Lisp_Object
))
1593 c
.backlist
= backtrace_list
;
1594 c
.handlerlist
= handlerlist
;
1595 c
.lisp_eval_depth
= lisp_eval_depth
;
1596 c
.pdlcount
= SPECPDL_INDEX ();
1597 c
.poll_suppress_count
= poll_suppress_count
;
1598 c
.interrupt_input_blocked
= interrupt_input_blocked
;
1599 c
.gcpro
= gcprolist
;
1600 c
.byte_stack
= byte_stack_list
;
1601 if (_setjmp (c
.jmp
))
1603 return (*hfun
) (c
.val
);
1607 h
.handler
= handlers
;
1609 h
.next
= handlerlist
;
1613 val
= (*bfun
) (nargs
, args
);
1615 handlerlist
= h
.next
;
1620 static Lisp_Object
find_handler_clause (Lisp_Object
, Lisp_Object
);
1621 static int maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
,
1624 DEFUN ("signal", Fsignal
, Ssignal
, 2, 2, 0,
1625 doc
: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1626 This function does not return.
1628 An error symbol is a symbol with an `error-conditions' property
1629 that is a list of condition names.
1630 A handler for any of those names will get to handle this signal.
1631 The symbol `error' should normally be one of them.
1633 DATA should be a list. Its elements are printed as part of the error message.
1634 See Info anchor `(elisp)Definition of signal' for some details on how this
1635 error message is constructed.
1636 If the signal is handled, DATA is made available to the handler.
1637 See also the function `condition-case'. */)
1638 (Lisp_Object error_symbol
, Lisp_Object data
)
1640 /* When memory is full, ERROR-SYMBOL is nil,
1641 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1642 That is a special case--don't do this in other situations. */
1643 Lisp_Object conditions
;
1645 Lisp_Object real_error_symbol
1646 = (NILP (error_symbol
) ? Fcar (data
) : error_symbol
);
1647 register Lisp_Object clause
= Qnil
;
1649 struct backtrace
*bp
;
1651 immediate_quit
= handling_signal
= 0;
1653 if (gc_in_progress
|| waiting_for_input
)
1656 #if 0 /* rms: I don't know why this was here,
1657 but it is surely wrong for an error that is handled. */
1658 #ifdef HAVE_WINDOW_SYSTEM
1659 if (display_hourglass_p
)
1660 cancel_hourglass ();
1664 /* This hook is used by edebug. */
1665 if (! NILP (Vsignal_hook_function
)
1666 && ! NILP (error_symbol
))
1668 /* Edebug takes care of restoring these variables when it exits. */
1669 if (lisp_eval_depth
+ 20 > max_lisp_eval_depth
)
1670 max_lisp_eval_depth
= lisp_eval_depth
+ 20;
1672 if (SPECPDL_INDEX () + 40 > max_specpdl_size
)
1673 max_specpdl_size
= SPECPDL_INDEX () + 40;
1675 call2 (Vsignal_hook_function
, error_symbol
, data
);
1678 conditions
= Fget (real_error_symbol
, Qerror_conditions
);
1680 /* Remember from where signal was called. Skip over the frame for
1681 `signal' itself. If a frame for `error' follows, skip that,
1682 too. Don't do this when ERROR_SYMBOL is nil, because that
1683 is a memory-full error. */
1684 Vsignaling_function
= Qnil
;
1685 if (backtrace_list
&& !NILP (error_symbol
))
1687 bp
= backtrace_list
->next
;
1688 if (bp
&& bp
->function
&& EQ (*bp
->function
, Qerror
))
1690 if (bp
&& bp
->function
)
1691 Vsignaling_function
= *bp
->function
;
1694 for (h
= handlerlist
; h
; h
= h
->next
)
1696 clause
= find_handler_clause (h
->handler
, conditions
);
1701 if (/* Don't run the debugger for a memory-full error.
1702 (There is no room in memory to do that!) */
1703 !NILP (error_symbol
)
1704 && (!NILP (Vdebug_on_signal
)
1705 /* If no handler is present now, try to run the debugger. */
1707 /* A `debug' symbol in the handler list disables the normal
1708 suppression of the debugger. */
1709 || (CONSP (clause
) && CONSP (XCAR (clause
))
1710 && !NILP (Fmemq (Qdebug
, XCAR (clause
))))
1711 /* Special handler that means "print a message and run debugger
1713 || EQ (h
->handler
, Qerror
)))
1716 = maybe_call_debugger (conditions
, error_symbol
, data
);
1717 /* We can't return values to code which signaled an error, but we
1718 can continue code which has signaled a quit. */
1719 if (debugger_called
&& EQ (real_error_symbol
, Qquit
))
1725 Lisp_Object unwind_data
1726 = (NILP (error_symbol
) ? data
: Fcons (error_symbol
, data
));
1728 h
->chosen_clause
= clause
;
1729 unwind_to_catch (h
->tag
, unwind_data
);
1734 Fthrow (Qtop_level
, Qt
);
1737 if (! NILP (error_symbol
))
1738 data
= Fcons (error_symbol
, data
);
1740 string
= Ferror_message_string (data
);
1741 fatal ("%s", SDATA (string
));
1744 /* Internal version of Fsignal that never returns.
1745 Used for anything but Qquit (which can return from Fsignal). */
1748 xsignal (Lisp_Object error_symbol
, Lisp_Object data
)
1750 Fsignal (error_symbol
, data
);
1754 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1757 xsignal0 (Lisp_Object error_symbol
)
1759 xsignal (error_symbol
, Qnil
);
1763 xsignal1 (Lisp_Object error_symbol
, Lisp_Object arg
)
1765 xsignal (error_symbol
, list1 (arg
));
1769 xsignal2 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
)
1771 xsignal (error_symbol
, list2 (arg1
, arg2
));
1775 xsignal3 (Lisp_Object error_symbol
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
1777 xsignal (error_symbol
, list3 (arg1
, arg2
, arg3
));
1780 /* Signal `error' with message S, and additional arg ARG.
1781 If ARG is not a genuine list, make it a one-element list. */
1784 signal_error (const char *s
, Lisp_Object arg
)
1786 Lisp_Object tortoise
, hare
;
1788 hare
= tortoise
= arg
;
1789 while (CONSP (hare
))
1796 tortoise
= XCDR (tortoise
);
1798 if (EQ (hare
, tortoise
))
1803 arg
= Fcons (arg
, Qnil
); /* Make it a list. */
1805 xsignal (Qerror
, Fcons (build_string (s
), arg
));
1809 /* Return nonzero if LIST is a non-nil atom or
1810 a list containing one of CONDITIONS. */
1813 wants_debugger (Lisp_Object list
, Lisp_Object conditions
)
1820 while (CONSP (conditions
))
1822 Lisp_Object
this, tail
;
1823 this = XCAR (conditions
);
1824 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
1825 if (EQ (XCAR (tail
), this))
1827 conditions
= XCDR (conditions
);
1832 /* Return 1 if an error with condition-symbols CONDITIONS,
1833 and described by SIGNAL-DATA, should skip the debugger
1834 according to debugger-ignored-errors. */
1837 skip_debugger (Lisp_Object conditions
, Lisp_Object data
)
1840 int first_string
= 1;
1841 Lisp_Object error_message
;
1843 error_message
= Qnil
;
1844 for (tail
= Vdebug_ignored_errors
; CONSP (tail
); tail
= XCDR (tail
))
1846 if (STRINGP (XCAR (tail
)))
1850 error_message
= Ferror_message_string (data
);
1854 if (fast_string_match (XCAR (tail
), error_message
) >= 0)
1859 Lisp_Object contail
;
1861 for (contail
= conditions
; CONSP (contail
); contail
= XCDR (contail
))
1862 if (EQ (XCAR (tail
), XCAR (contail
)))
1870 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1871 SIG and DATA describe the signal. There are two ways to pass them:
1872 = SIG is the error symbol, and DATA is the rest of the data.
1873 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1874 This is for memory-full errors only. */
1876 maybe_call_debugger (Lisp_Object conditions
, Lisp_Object sig
, Lisp_Object data
)
1878 Lisp_Object combined_data
;
1880 combined_data
= Fcons (sig
, data
);
1883 /* Don't try to run the debugger with interrupts blocked.
1884 The editing loop would return anyway. */
1886 /* Does user want to enter debugger for this kind of error? */
1889 : wants_debugger (Vdebug_on_error
, conditions
))
1890 && ! skip_debugger (conditions
, combined_data
)
1891 /* RMS: What's this for? */
1892 && when_entered_debugger
< num_nonmacro_input_events
)
1894 call_debugger (Fcons (Qerror
, Fcons (combined_data
, Qnil
)));
1902 find_handler_clause (Lisp_Object handlers
, Lisp_Object conditions
)
1904 register Lisp_Object h
;
1906 /* t is used by handlers for all conditions, set up by C code. */
1907 if (EQ (handlers
, Qt
))
1910 /* error is used similarly, but means print an error message
1911 and run the debugger if that is enabled. */
1912 if (EQ (handlers
, Qerror
))
1915 for (h
= handlers
; CONSP (h
); h
= XCDR (h
))
1917 Lisp_Object handler
= XCAR (h
);
1918 Lisp_Object condit
, tem
;
1920 if (!CONSP (handler
))
1922 condit
= XCAR (handler
);
1923 /* Handle a single condition name in handler HANDLER. */
1924 if (SYMBOLP (condit
))
1926 tem
= Fmemq (Fcar (handler
), conditions
);
1930 /* Handle a list of condition names in handler HANDLER. */
1931 else if (CONSP (condit
))
1934 for (tail
= condit
; CONSP (tail
); tail
= XCDR (tail
))
1936 tem
= Fmemq (XCAR (tail
), conditions
);
1947 /* Dump an error message; called like vprintf. */
1949 verror (const char *m
, va_list ap
)
1952 ptrdiff_t size
= sizeof buf
;
1953 ptrdiff_t size_max
= STRING_BYTES_BOUND
+ 1;
1958 used
= evxprintf (&buffer
, &size
, buf
, size_max
, m
, ap
);
1959 string
= make_string (buffer
, used
);
1963 xsignal1 (Qerror
, string
);
1967 /* Dump an error message; called like printf. */
1971 error (const char *m
, ...)
1979 DEFUN ("commandp", Fcommandp
, Scommandp
, 1, 2, 0,
1980 doc
: /* Non-nil if FUNCTION makes provisions for interactive calling.
1981 This means it contains a description for how to read arguments to give it.
1982 The value is nil for an invalid function or a symbol with no function
1985 Interactively callable functions include strings and vectors (treated
1986 as keyboard macros), lambda-expressions that contain a top-level call
1987 to `interactive', autoload definitions made by `autoload' with non-nil
1988 fourth argument, and some of the built-in functions of Lisp.
1990 Also, a symbol satisfies `commandp' if its function definition does so.
1992 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1993 then strings and vectors are not accepted. */)
1994 (Lisp_Object function
, Lisp_Object for_call_interactively
)
1996 register Lisp_Object fun
;
1997 register Lisp_Object funcar
;
1998 Lisp_Object if_prop
= Qnil
;
2002 fun
= indirect_function (fun
); /* Check cycles. */
2003 if (NILP (fun
) || EQ (fun
, Qunbound
))
2006 /* Check an `interactive-form' property if present, analogous to the
2007 function-documentation property. */
2009 while (SYMBOLP (fun
))
2011 Lisp_Object tmp
= Fget (fun
, Qinteractive_form
);
2014 fun
= Fsymbol_function (fun
);
2017 /* Emacs primitives are interactive if their DEFUN specifies an
2018 interactive spec. */
2020 return XSUBR (fun
)->intspec
? Qt
: if_prop
;
2022 /* Bytecode objects are interactive if they are long enough to
2023 have an element whose index is COMPILED_INTERACTIVE, which is
2024 where the interactive spec is stored. */
2025 else if (COMPILEDP (fun
))
2026 return ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_INTERACTIVE
2029 /* Strings and vectors are keyboard macros. */
2030 if (STRINGP (fun
) || VECTORP (fun
))
2031 return (NILP (for_call_interactively
) ? Qt
: Qnil
);
2033 /* Lists may represent commands. */
2036 funcar
= XCAR (fun
);
2037 if (EQ (funcar
, Qclosure
))
2038 return (!NILP (Fassq (Qinteractive
, Fcdr (Fcdr (XCDR (fun
)))))
2040 else if (EQ (funcar
, Qlambda
))
2041 return !NILP (Fassq (Qinteractive
, Fcdr (XCDR (fun
)))) ? Qt
: if_prop
;
2042 else if (EQ (funcar
, Qautoload
))
2043 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun
))))) ? Qt
: if_prop
;
2048 DEFUN ("autoload", Fautoload
, Sautoload
, 2, 5, 0,
2049 doc
: /* Define FUNCTION to autoload from FILE.
2050 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2051 Third arg DOCSTRING is documentation for the function.
2052 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2053 Fifth arg TYPE indicates the type of the object:
2054 nil or omitted says FUNCTION is a function,
2055 `keymap' says FUNCTION is really a keymap, and
2056 `macro' or t says FUNCTION is really a macro.
2057 Third through fifth args give info about the real definition.
2058 They default to nil.
2059 If FUNCTION is already defined other than as an autoload,
2060 this does nothing and returns nil. */)
2061 (Lisp_Object function
, Lisp_Object file
, Lisp_Object docstring
, Lisp_Object interactive
, Lisp_Object type
)
2063 CHECK_SYMBOL (function
);
2064 CHECK_STRING (file
);
2066 /* If function is defined and not as an autoload, don't override. */
2067 if (!EQ (XSYMBOL (function
)->function
, Qunbound
)
2068 && !(CONSP (XSYMBOL (function
)->function
)
2069 && EQ (XCAR (XSYMBOL (function
)->function
), Qautoload
)))
2072 if (NILP (Vpurify_flag
))
2073 /* Only add entries after dumping, because the ones before are
2074 not useful and else we get loads of them from the loaddefs.el. */
2075 LOADHIST_ATTACH (Fcons (Qautoload
, function
));
2077 /* We don't want the docstring in purespace (instead,
2078 Snarf-documentation should (hopefully) overwrite it).
2079 We used to use 0 here, but that leads to accidental sharing in
2080 purecopy's hash-consing, so we use a (hopefully) unique integer
2082 docstring
= make_number (XPNTR (function
));
2083 return Ffset (function
,
2084 Fpurecopy (list5 (Qautoload
, file
, docstring
,
2085 interactive
, type
)));
2089 un_autoload (Lisp_Object oldqueue
)
2091 register Lisp_Object queue
, first
, second
;
2093 /* Queue to unwind is current value of Vautoload_queue.
2094 oldqueue is the shadowed value to leave in Vautoload_queue. */
2095 queue
= Vautoload_queue
;
2096 Vautoload_queue
= oldqueue
;
2097 while (CONSP (queue
))
2099 first
= XCAR (queue
);
2100 second
= Fcdr (first
);
2101 first
= Fcar (first
);
2102 if (EQ (first
, make_number (0)))
2105 Ffset (first
, second
);
2106 queue
= XCDR (queue
);
2111 /* Load an autoloaded function.
2112 FUNNAME is the symbol which is the function's name.
2113 FUNDEF is the autoload definition (a list). */
2116 do_autoload (Lisp_Object fundef
, Lisp_Object funname
)
2118 int count
= SPECPDL_INDEX ();
2120 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2122 /* This is to make sure that loadup.el gives a clear picture
2123 of what files are preloaded and when. */
2124 if (! NILP (Vpurify_flag
))
2125 error ("Attempt to autoload %s while preparing to dump",
2126 SDATA (SYMBOL_NAME (funname
)));
2129 CHECK_SYMBOL (funname
);
2130 GCPRO3 (fun
, funname
, fundef
);
2132 /* Preserve the match data. */
2133 record_unwind_save_match_data ();
2135 /* If autoloading gets an error (which includes the error of failing
2136 to define the function being called), we use Vautoload_queue
2137 to undo function definitions and `provide' calls made by
2138 the function. We do this in the specific case of autoloading
2139 because autoloading is not an explicit request "load this file",
2140 but rather a request to "call this function".
2142 The value saved here is to be restored into Vautoload_queue. */
2143 record_unwind_protect (un_autoload
, Vautoload_queue
);
2144 Vautoload_queue
= Qt
;
2145 Fload (Fcar (Fcdr (fundef
)), Qnil
, Qt
, Qnil
, Qt
);
2147 /* Once loading finishes, don't undo it. */
2148 Vautoload_queue
= Qt
;
2149 unbind_to (count
, Qnil
);
2151 fun
= Findirect_function (fun
, Qnil
);
2153 if (!NILP (Fequal (fun
, fundef
)))
2154 error ("Autoloading failed to define function %s",
2155 SDATA (SYMBOL_NAME (funname
)));
2160 DEFUN ("eval", Feval
, Seval
, 1, 2, 0,
2161 doc
: /* Evaluate FORM and return its value.
2162 If LEXICAL is t, evaluate using lexical scoping. */)
2163 (Lisp_Object form
, Lisp_Object lexical
)
2165 int count
= SPECPDL_INDEX ();
2166 specbind (Qinternal_interpreter_environment
,
2167 NILP (lexical
) ? Qnil
: Fcons (Qt
, Qnil
));
2168 return unbind_to (count
, eval_sub (form
));
2171 /* Eval a sub-expression of the current expression (i.e. in the same
2174 eval_sub (Lisp_Object form
)
2176 Lisp_Object fun
, val
, original_fun
, original_args
;
2178 struct backtrace backtrace
;
2179 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2181 if (handling_signal
)
2186 /* Look up its binding in the lexical environment.
2187 We do not pay attention to the declared_special flag here, since we
2188 already did that when let-binding the variable. */
2189 Lisp_Object lex_binding
2190 = !NILP (Vinternal_interpreter_environment
) /* Mere optimization! */
2191 ? Fassq (form
, Vinternal_interpreter_environment
)
2193 if (CONSP (lex_binding
))
2194 return XCDR (lex_binding
);
2196 return Fsymbol_value (form
);
2203 if ((consing_since_gc
> gc_cons_threshold
2204 && consing_since_gc
> gc_relative_threshold
)
2206 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2209 Fgarbage_collect ();
2213 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2215 if (max_lisp_eval_depth
< 100)
2216 max_lisp_eval_depth
= 100;
2217 if (lisp_eval_depth
> max_lisp_eval_depth
)
2218 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2221 original_fun
= Fcar (form
);
2222 original_args
= Fcdr (form
);
2224 backtrace
.next
= backtrace_list
;
2225 backtrace_list
= &backtrace
;
2226 backtrace
.function
= &original_fun
; /* This also protects them from gc. */
2227 backtrace
.args
= &original_args
;
2228 backtrace
.nargs
= UNEVALLED
;
2229 backtrace
.debug_on_exit
= 0;
2231 if (debug_on_next_call
)
2232 do_debug_on_call (Qt
);
2234 /* At this point, only original_fun and original_args
2235 have values that will be used below. */
2238 /* Optimize for no indirection. */
2240 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2241 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2242 fun
= indirect_function (fun
);
2246 Lisp_Object numargs
;
2247 Lisp_Object argvals
[8];
2248 Lisp_Object args_left
;
2249 register int i
, maxargs
;
2251 args_left
= original_args
;
2252 numargs
= Flength (args_left
);
2256 if (XINT (numargs
) < XSUBR (fun
)->min_args
2257 || (XSUBR (fun
)->max_args
>= 0
2258 && XSUBR (fun
)->max_args
< XINT (numargs
)))
2259 xsignal2 (Qwrong_number_of_arguments
, original_fun
, numargs
);
2261 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2262 val
= (XSUBR (fun
)->function
.aUNEVALLED
) (args_left
);
2263 else if (XSUBR (fun
)->max_args
== MANY
)
2265 /* Pass a vector of evaluated arguments. */
2267 ptrdiff_t argnum
= 0;
2270 SAFE_ALLOCA_LISP (vals
, XINT (numargs
));
2272 GCPRO3 (args_left
, fun
, fun
);
2276 while (!NILP (args_left
))
2278 vals
[argnum
++] = eval_sub (Fcar (args_left
));
2279 args_left
= Fcdr (args_left
);
2280 gcpro3
.nvars
= argnum
;
2283 backtrace
.args
= vals
;
2284 backtrace
.nargs
= XINT (numargs
);
2286 val
= (XSUBR (fun
)->function
.aMANY
) (XINT (numargs
), vals
);
2292 GCPRO3 (args_left
, fun
, fun
);
2293 gcpro3
.var
= argvals
;
2296 maxargs
= XSUBR (fun
)->max_args
;
2297 for (i
= 0; i
< maxargs
; args_left
= Fcdr (args_left
))
2299 argvals
[i
] = eval_sub (Fcar (args_left
));
2305 backtrace
.args
= argvals
;
2306 backtrace
.nargs
= XINT (numargs
);
2311 val
= (XSUBR (fun
)->function
.a0 ());
2314 val
= (XSUBR (fun
)->function
.a1 (argvals
[0]));
2317 val
= (XSUBR (fun
)->function
.a2 (argvals
[0], argvals
[1]));
2320 val
= (XSUBR (fun
)->function
.a3
2321 (argvals
[0], argvals
[1], argvals
[2]));
2324 val
= (XSUBR (fun
)->function
.a4
2325 (argvals
[0], argvals
[1], argvals
[2], argvals
[3]));
2328 val
= (XSUBR (fun
)->function
.a5
2329 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2333 val
= (XSUBR (fun
)->function
.a6
2334 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2335 argvals
[4], argvals
[5]));
2338 val
= (XSUBR (fun
)->function
.a7
2339 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2340 argvals
[4], argvals
[5], argvals
[6]));
2344 val
= (XSUBR (fun
)->function
.a8
2345 (argvals
[0], argvals
[1], argvals
[2], argvals
[3],
2346 argvals
[4], argvals
[5], argvals
[6], argvals
[7]));
2350 /* Someone has created a subr that takes more arguments than
2351 is supported by this code. We need to either rewrite the
2352 subr to use a different argument protocol, or add more
2353 cases to this switch. */
2358 else if (COMPILEDP (fun
))
2359 val
= apply_lambda (fun
, original_args
);
2362 if (EQ (fun
, Qunbound
))
2363 xsignal1 (Qvoid_function
, original_fun
);
2365 xsignal1 (Qinvalid_function
, original_fun
);
2366 funcar
= XCAR (fun
);
2367 if (!SYMBOLP (funcar
))
2368 xsignal1 (Qinvalid_function
, original_fun
);
2369 if (EQ (funcar
, Qautoload
))
2371 do_autoload (fun
, original_fun
);
2374 if (EQ (funcar
, Qmacro
))
2375 val
= eval_sub (apply1 (Fcdr (fun
), original_args
));
2376 else if (EQ (funcar
, Qlambda
)
2377 || EQ (funcar
, Qclosure
))
2378 val
= apply_lambda (fun
, original_args
);
2380 xsignal1 (Qinvalid_function
, original_fun
);
2385 if (backtrace
.debug_on_exit
)
2386 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
2387 backtrace_list
= backtrace
.next
;
2392 DEFUN ("apply", Fapply
, Sapply
, 2, MANY
, 0,
2393 doc
: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2394 Then return the value FUNCTION returns.
2395 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2396 usage: (apply FUNCTION &rest ARGUMENTS) */)
2397 (ptrdiff_t nargs
, Lisp_Object
*args
)
2399 ptrdiff_t i
, numargs
;
2400 register Lisp_Object spread_arg
;
2401 register Lisp_Object
*funcall_args
;
2402 Lisp_Object fun
, retval
;
2403 struct gcpro gcpro1
;
2408 spread_arg
= args
[nargs
- 1];
2409 CHECK_LIST (spread_arg
);
2411 numargs
= XINT (Flength (spread_arg
));
2414 return Ffuncall (nargs
- 1, args
);
2415 else if (numargs
== 1)
2417 args
[nargs
- 1] = XCAR (spread_arg
);
2418 return Ffuncall (nargs
, args
);
2421 numargs
+= nargs
- 2;
2423 /* Optimize for no indirection. */
2424 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2425 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2426 fun
= indirect_function (fun
);
2427 if (EQ (fun
, Qunbound
))
2429 /* Let funcall get the error. */
2436 if (numargs
< XSUBR (fun
)->min_args
2437 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2438 goto funcall
; /* Let funcall get the error. */
2439 else if (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
> numargs
)
2441 /* Avoid making funcall cons up a yet another new vector of arguments
2442 by explicitly supplying nil's for optional values. */
2443 SAFE_ALLOCA_LISP (funcall_args
, 1 + XSUBR (fun
)->max_args
);
2444 for (i
= numargs
; i
< XSUBR (fun
)->max_args
;)
2445 funcall_args
[++i
] = Qnil
;
2446 GCPRO1 (*funcall_args
);
2447 gcpro1
.nvars
= 1 + XSUBR (fun
)->max_args
;
2451 /* We add 1 to numargs because funcall_args includes the
2452 function itself as well as its arguments. */
2455 SAFE_ALLOCA_LISP (funcall_args
, 1 + numargs
);
2456 GCPRO1 (*funcall_args
);
2457 gcpro1
.nvars
= 1 + numargs
;
2460 memcpy (funcall_args
, args
, nargs
* sizeof (Lisp_Object
));
2461 /* Spread the last arg we got. Its first element goes in
2462 the slot that it used to occupy, hence this value of I. */
2464 while (!NILP (spread_arg
))
2466 funcall_args
[i
++] = XCAR (spread_arg
);
2467 spread_arg
= XCDR (spread_arg
);
2470 /* By convention, the caller needs to gcpro Ffuncall's args. */
2471 retval
= Ffuncall (gcpro1
.nvars
, funcall_args
);
2478 /* Run hook variables in various ways. */
2481 funcall_nil (ptrdiff_t nargs
, Lisp_Object
*args
)
2483 Ffuncall (nargs
, args
);
2487 DEFUN ("run-hooks", Frun_hooks
, Srun_hooks
, 0, MANY
, 0,
2488 doc
: /* Run each hook in HOOKS.
2489 Each argument should be a symbol, a hook variable.
2490 These symbols are processed in the order specified.
2491 If a hook symbol has a non-nil value, that value may be a function
2492 or a list of functions to be called to run the hook.
2493 If the value is a function, it is called with no arguments.
2494 If it is a list, the elements are called, in order, with no arguments.
2496 Major modes should not use this function directly to run their mode
2497 hook; they should use `run-mode-hooks' instead.
2499 Do not use `make-local-variable' to make a hook variable buffer-local.
2500 Instead, use `add-hook' and specify t for the LOCAL argument.
2501 usage: (run-hooks &rest HOOKS) */)
2502 (ptrdiff_t nargs
, Lisp_Object
*args
)
2504 Lisp_Object hook
[1];
2507 for (i
= 0; i
< nargs
; i
++)
2510 run_hook_with_args (1, hook
, funcall_nil
);
2516 DEFUN ("run-hook-with-args", Frun_hook_with_args
,
2517 Srun_hook_with_args
, 1, MANY
, 0,
2518 doc
: /* Run HOOK with the specified arguments ARGS.
2519 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2520 value, that value may be a function or a list of functions to be
2521 called to run the hook. If the value is a function, it is called with
2522 the given arguments and its return value is returned. If it is a list
2523 of functions, those functions are called, in order,
2524 with the given arguments ARGS.
2525 It is best not to depend on the value returned by `run-hook-with-args',
2528 Do not use `make-local-variable' to make a hook variable buffer-local.
2529 Instead, use `add-hook' and specify t for the LOCAL argument.
2530 usage: (run-hook-with-args HOOK &rest ARGS) */)
2531 (ptrdiff_t nargs
, Lisp_Object
*args
)
2533 return run_hook_with_args (nargs
, args
, funcall_nil
);
2536 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success
,
2537 Srun_hook_with_args_until_success
, 1, MANY
, 0,
2538 doc
: /* Run HOOK with the specified arguments ARGS.
2539 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2540 value, that value may be a function or a list of functions to be
2541 called to run the hook. If the value is a function, it is called with
2542 the given arguments and its return value is returned.
2543 If it is a list of functions, those functions are called, in order,
2544 with the given arguments ARGS, until one of them
2545 returns a non-nil value. Then we return that value.
2546 However, if they all return nil, we return nil.
2548 Do not use `make-local-variable' to make a hook variable buffer-local.
2549 Instead, use `add-hook' and specify t for the LOCAL argument.
2550 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2551 (ptrdiff_t nargs
, Lisp_Object
*args
)
2553 return run_hook_with_args (nargs
, args
, Ffuncall
);
2557 funcall_not (ptrdiff_t nargs
, Lisp_Object
*args
)
2559 return NILP (Ffuncall (nargs
, args
)) ? Qt
: Qnil
;
2562 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure
,
2563 Srun_hook_with_args_until_failure
, 1, MANY
, 0,
2564 doc
: /* Run HOOK with the specified arguments ARGS.
2565 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2566 value, that value may be a function or a list of functions to be
2567 called to run the hook. If the value is a function, it is called with
2568 the given arguments and its return value is returned.
2569 If it is a list of functions, those functions are called, in order,
2570 with the given arguments ARGS, until one of them returns nil.
2571 Then we return nil. However, if they all return non-nil, we return non-nil.
2573 Do not use `make-local-variable' to make a hook variable buffer-local.
2574 Instead, use `add-hook' and specify t for the LOCAL argument.
2575 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2576 (ptrdiff_t nargs
, Lisp_Object
*args
)
2578 return NILP (run_hook_with_args (nargs
, args
, funcall_not
)) ? Qt
: Qnil
;
2582 run_hook_wrapped_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
2584 Lisp_Object tmp
= args
[0], ret
;
2587 ret
= Ffuncall (nargs
, args
);
2593 DEFUN ("run-hook-wrapped", Frun_hook_wrapped
, Srun_hook_wrapped
, 2, MANY
, 0,
2594 doc
: /* Run HOOK, passing each function through WRAP-FUNCTION.
2595 I.e. instead of calling each function FUN directly with arguments ARGS,
2596 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2597 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2598 aborts and returns that value.
2599 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2600 (ptrdiff_t nargs
, Lisp_Object
*args
)
2602 return run_hook_with_args (nargs
, args
, run_hook_wrapped_funcall
);
2605 /* ARGS[0] should be a hook symbol.
2606 Call each of the functions in the hook value, passing each of them
2607 as arguments all the rest of ARGS (all NARGS - 1 elements).
2608 FUNCALL specifies how to call each function on the hook.
2609 The caller (or its caller, etc) must gcpro all of ARGS,
2610 except that it isn't necessary to gcpro ARGS[0]. */
2613 run_hook_with_args (ptrdiff_t nargs
, Lisp_Object
*args
,
2614 Lisp_Object (*funcall
) (ptrdiff_t nargs
, Lisp_Object
*args
))
2616 Lisp_Object sym
, val
, ret
= Qnil
;
2617 struct gcpro gcpro1
, gcpro2
, gcpro3
;
2619 /* If we are dying or still initializing,
2620 don't do anything--it would probably crash if we tried. */
2621 if (NILP (Vrun_hooks
))
2625 val
= find_symbol_value (sym
);
2627 if (EQ (val
, Qunbound
) || NILP (val
))
2629 else if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
2632 return funcall (nargs
, args
);
2636 Lisp_Object global_vals
= Qnil
;
2637 GCPRO3 (sym
, val
, global_vals
);
2640 CONSP (val
) && NILP (ret
);
2643 if (EQ (XCAR (val
), Qt
))
2645 /* t indicates this hook has a local binding;
2646 it means to run the global binding too. */
2647 global_vals
= Fdefault_value (sym
);
2648 if (NILP (global_vals
)) continue;
2650 if (!CONSP (global_vals
) || EQ (XCAR (global_vals
), Qlambda
))
2652 args
[0] = global_vals
;
2653 ret
= funcall (nargs
, args
);
2658 CONSP (global_vals
) && NILP (ret
);
2659 global_vals
= XCDR (global_vals
))
2661 args
[0] = XCAR (global_vals
);
2662 /* In a global value, t should not occur. If it does, we
2663 must ignore it to avoid an endless loop. */
2664 if (!EQ (args
[0], Qt
))
2665 ret
= funcall (nargs
, args
);
2671 args
[0] = XCAR (val
);
2672 ret
= funcall (nargs
, args
);
2681 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2684 run_hook_with_args_2 (Lisp_Object hook
, Lisp_Object arg1
, Lisp_Object arg2
)
2686 Lisp_Object temp
[3];
2691 Frun_hook_with_args (3, temp
);
2694 /* Apply fn to arg. */
2696 apply1 (Lisp_Object fn
, Lisp_Object arg
)
2698 struct gcpro gcpro1
;
2702 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2705 Lisp_Object args
[2];
2709 RETURN_UNGCPRO (Fapply (2, args
));
2713 /* Call function fn on no arguments. */
2715 call0 (Lisp_Object fn
)
2717 struct gcpro gcpro1
;
2720 RETURN_UNGCPRO (Ffuncall (1, &fn
));
2723 /* Call function fn with 1 argument arg1. */
2726 call1 (Lisp_Object fn
, Lisp_Object arg1
)
2728 struct gcpro gcpro1
;
2729 Lisp_Object args
[2];
2735 RETURN_UNGCPRO (Ffuncall (2, args
));
2738 /* Call function fn with 2 arguments arg1, arg2. */
2741 call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2743 struct gcpro gcpro1
;
2744 Lisp_Object args
[3];
2750 RETURN_UNGCPRO (Ffuncall (3, args
));
2753 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2756 call3 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
)
2758 struct gcpro gcpro1
;
2759 Lisp_Object args
[4];
2766 RETURN_UNGCPRO (Ffuncall (4, args
));
2769 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2772 call4 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2775 struct gcpro gcpro1
;
2776 Lisp_Object args
[5];
2784 RETURN_UNGCPRO (Ffuncall (5, args
));
2787 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2790 call5 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2791 Lisp_Object arg4
, Lisp_Object arg5
)
2793 struct gcpro gcpro1
;
2794 Lisp_Object args
[6];
2803 RETURN_UNGCPRO (Ffuncall (6, args
));
2806 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2809 call6 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2810 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
)
2812 struct gcpro gcpro1
;
2813 Lisp_Object args
[7];
2823 RETURN_UNGCPRO (Ffuncall (7, args
));
2826 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2829 call7 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
, Lisp_Object arg3
,
2830 Lisp_Object arg4
, Lisp_Object arg5
, Lisp_Object arg6
, Lisp_Object arg7
)
2832 struct gcpro gcpro1
;
2833 Lisp_Object args
[8];
2844 RETURN_UNGCPRO (Ffuncall (8, args
));
2847 /* The caller should GCPRO all the elements of ARGS. */
2849 DEFUN ("functionp", Ffunctionp
, Sfunctionp
, 1, 1, 0,
2850 doc
: /* Non-nil if OBJECT is a function. */)
2851 (Lisp_Object object
)
2853 if (SYMBOLP (object
) && !NILP (Ffboundp (object
)))
2855 object
= Findirect_function (object
, Qt
);
2857 if (CONSP (object
) && EQ (XCAR (object
), Qautoload
))
2859 /* Autoloaded symbols are functions, except if they load
2860 macros or keymaps. */
2862 for (i
= 0; i
< 4 && CONSP (object
); i
++)
2863 object
= XCDR (object
);
2865 return (CONSP (object
) && !NILP (XCAR (object
))) ? Qnil
: Qt
;
2870 return (XSUBR (object
)->max_args
!= UNEVALLED
) ? Qt
: Qnil
;
2871 else if (COMPILEDP (object
))
2873 else if (CONSP (object
))
2875 Lisp_Object car
= XCAR (object
);
2876 return (EQ (car
, Qlambda
) || EQ (car
, Qclosure
)) ? Qt
: Qnil
;
2882 DEFUN ("funcall", Ffuncall
, Sfuncall
, 1, MANY
, 0,
2883 doc
: /* Call first argument as a function, passing remaining arguments to it.
2884 Return the value that function returns.
2885 Thus, (funcall 'cons 'x 'y) returns (x . y).
2886 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2887 (ptrdiff_t nargs
, Lisp_Object
*args
)
2889 Lisp_Object fun
, original_fun
;
2891 ptrdiff_t numargs
= nargs
- 1;
2892 Lisp_Object lisp_numargs
;
2894 struct backtrace backtrace
;
2895 register Lisp_Object
*internal_args
;
2899 if ((consing_since_gc
> gc_cons_threshold
2900 && consing_since_gc
> gc_relative_threshold
)
2902 (!NILP (Vmemory_full
) && consing_since_gc
> memory_full_cons_threshold
))
2903 Fgarbage_collect ();
2905 if (++lisp_eval_depth
> max_lisp_eval_depth
)
2907 if (max_lisp_eval_depth
< 100)
2908 max_lisp_eval_depth
= 100;
2909 if (lisp_eval_depth
> max_lisp_eval_depth
)
2910 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2913 backtrace
.next
= backtrace_list
;
2914 backtrace_list
= &backtrace
;
2915 backtrace
.function
= &args
[0];
2916 backtrace
.args
= &args
[1];
2917 backtrace
.nargs
= nargs
- 1;
2918 backtrace
.debug_on_exit
= 0;
2920 if (debug_on_next_call
)
2921 do_debug_on_call (Qlambda
);
2925 original_fun
= args
[0];
2929 /* Optimize for no indirection. */
2931 if (SYMBOLP (fun
) && !EQ (fun
, Qunbound
)
2932 && (fun
= XSYMBOL (fun
)->function
, SYMBOLP (fun
)))
2933 fun
= indirect_function (fun
);
2937 if (numargs
< XSUBR (fun
)->min_args
2938 || (XSUBR (fun
)->max_args
>= 0 && XSUBR (fun
)->max_args
< numargs
))
2940 XSETFASTINT (lisp_numargs
, numargs
);
2941 xsignal2 (Qwrong_number_of_arguments
, original_fun
, lisp_numargs
);
2944 else if (XSUBR (fun
)->max_args
== UNEVALLED
)
2945 xsignal1 (Qinvalid_function
, original_fun
);
2947 else if (XSUBR (fun
)->max_args
== MANY
)
2948 val
= (XSUBR (fun
)->function
.aMANY
) (numargs
, args
+ 1);
2951 if (XSUBR (fun
)->max_args
> numargs
)
2953 internal_args
= (Lisp_Object
*) alloca (XSUBR (fun
)->max_args
* sizeof (Lisp_Object
));
2954 memcpy (internal_args
, args
+ 1, numargs
* sizeof (Lisp_Object
));
2955 for (i
= numargs
; i
< XSUBR (fun
)->max_args
; i
++)
2956 internal_args
[i
] = Qnil
;
2959 internal_args
= args
+ 1;
2960 switch (XSUBR (fun
)->max_args
)
2963 val
= (XSUBR (fun
)->function
.a0 ());
2966 val
= (XSUBR (fun
)->function
.a1 (internal_args
[0]));
2969 val
= (XSUBR (fun
)->function
.a2
2970 (internal_args
[0], internal_args
[1]));
2973 val
= (XSUBR (fun
)->function
.a3
2974 (internal_args
[0], internal_args
[1], internal_args
[2]));
2977 val
= (XSUBR (fun
)->function
.a4
2978 (internal_args
[0], internal_args
[1], internal_args
[2],
2982 val
= (XSUBR (fun
)->function
.a5
2983 (internal_args
[0], internal_args
[1], internal_args
[2],
2984 internal_args
[3], internal_args
[4]));
2987 val
= (XSUBR (fun
)->function
.a6
2988 (internal_args
[0], internal_args
[1], internal_args
[2],
2989 internal_args
[3], internal_args
[4], internal_args
[5]));
2992 val
= (XSUBR (fun
)->function
.a7
2993 (internal_args
[0], internal_args
[1], internal_args
[2],
2994 internal_args
[3], internal_args
[4], internal_args
[5],
2999 val
= (XSUBR (fun
)->function
.a8
3000 (internal_args
[0], internal_args
[1], internal_args
[2],
3001 internal_args
[3], internal_args
[4], internal_args
[5],
3002 internal_args
[6], internal_args
[7]));
3007 /* If a subr takes more than 8 arguments without using MANY
3008 or UNEVALLED, we need to extend this function to support it.
3009 Until this is done, there is no way to call the function. */
3014 else if (COMPILEDP (fun
))
3015 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3018 if (EQ (fun
, Qunbound
))
3019 xsignal1 (Qvoid_function
, original_fun
);
3021 xsignal1 (Qinvalid_function
, original_fun
);
3022 funcar
= XCAR (fun
);
3023 if (!SYMBOLP (funcar
))
3024 xsignal1 (Qinvalid_function
, original_fun
);
3025 if (EQ (funcar
, Qlambda
)
3026 || EQ (funcar
, Qclosure
))
3027 val
= funcall_lambda (fun
, numargs
, args
+ 1);
3028 else if (EQ (funcar
, Qautoload
))
3030 do_autoload (fun
, original_fun
);
3035 xsignal1 (Qinvalid_function
, original_fun
);
3039 if (backtrace
.debug_on_exit
)
3040 val
= call_debugger (Fcons (Qexit
, Fcons (val
, Qnil
)));
3041 backtrace_list
= backtrace
.next
;
3046 apply_lambda (Lisp_Object fun
, Lisp_Object args
)
3048 Lisp_Object args_left
;
3049 ptrdiff_t i
, numargs
;
3050 register Lisp_Object
*arg_vector
;
3051 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3052 register Lisp_Object tem
;
3055 numargs
= XFASTINT (Flength (args
));
3056 SAFE_ALLOCA_LISP (arg_vector
, numargs
);
3059 GCPRO3 (*arg_vector
, args_left
, fun
);
3062 for (i
= 0; i
< numargs
; )
3064 tem
= Fcar (args_left
), args_left
= Fcdr (args_left
);
3065 tem
= eval_sub (tem
);
3066 arg_vector
[i
++] = tem
;
3072 backtrace_list
->args
= arg_vector
;
3073 backtrace_list
->nargs
= i
;
3074 tem
= funcall_lambda (fun
, numargs
, arg_vector
);
3076 /* Do the debug-on-exit now, while arg_vector still exists. */
3077 if (backtrace_list
->debug_on_exit
)
3078 tem
= call_debugger (Fcons (Qexit
, Fcons (tem
, Qnil
)));
3079 /* Don't do it again when we return to eval. */
3080 backtrace_list
->debug_on_exit
= 0;
3085 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3086 and return the result of evaluation.
3087 FUN must be either a lambda-expression or a compiled-code object. */
3090 funcall_lambda (Lisp_Object fun
, ptrdiff_t nargs
,
3091 register Lisp_Object
*arg_vector
)
3093 Lisp_Object val
, syms_left
, next
, lexenv
;
3094 int count
= SPECPDL_INDEX ();
3100 if (EQ (XCAR (fun
), Qclosure
))
3102 fun
= XCDR (fun
); /* Drop `closure'. */
3103 lexenv
= XCAR (fun
);
3104 CHECK_LIST_CONS (fun
, fun
);
3108 syms_left
= XCDR (fun
);
3109 if (CONSP (syms_left
))
3110 syms_left
= XCAR (syms_left
);
3112 xsignal1 (Qinvalid_function
, fun
);
3114 else if (COMPILEDP (fun
))
3116 syms_left
= AREF (fun
, COMPILED_ARGLIST
);
3117 if (INTEGERP (syms_left
))
3118 /* A byte-code object with a non-nil `push args' slot means we
3119 shouldn't bind any arguments, instead just call the byte-code
3120 interpreter directly; it will push arguments as necessary.
3122 Byte-code objects with either a non-existent, or a nil value for
3123 the `push args' slot (the default), have dynamically-bound
3124 arguments, and use the argument-binding code below instead (as do
3125 all interpreted functions, even lexically bound ones). */
3127 /* If we have not actually read the bytecode string
3128 and constants vector yet, fetch them from the file. */
3129 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3130 Ffetch_bytecode (fun
);
3131 return exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3132 AREF (fun
, COMPILED_CONSTANTS
),
3133 AREF (fun
, COMPILED_STACK_DEPTH
),
3142 i
= optional
= rest
= 0;
3143 for (; CONSP (syms_left
); syms_left
= XCDR (syms_left
))
3147 next
= XCAR (syms_left
);
3148 if (!SYMBOLP (next
))
3149 xsignal1 (Qinvalid_function
, fun
);
3151 if (EQ (next
, Qand_rest
))
3153 else if (EQ (next
, Qand_optional
))
3160 arg
= Flist (nargs
- i
, &arg_vector
[i
]);
3164 arg
= arg_vector
[i
++];
3166 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3170 /* Bind the argument. */
3171 if (!NILP (lexenv
) && SYMBOLP (next
))
3172 /* Lexically bind NEXT by adding it to the lexenv alist. */
3173 lexenv
= Fcons (Fcons (next
, arg
), lexenv
);
3175 /* Dynamically bind NEXT. */
3176 specbind (next
, arg
);
3180 if (!NILP (syms_left
))
3181 xsignal1 (Qinvalid_function
, fun
);
3183 xsignal2 (Qwrong_number_of_arguments
, fun
, make_number (nargs
));
3185 if (!EQ (lexenv
, Vinternal_interpreter_environment
))
3186 /* Instantiate a new lexical environment. */
3187 specbind (Qinternal_interpreter_environment
, lexenv
);
3190 val
= Fprogn (XCDR (XCDR (fun
)));
3193 /* If we have not actually read the bytecode string
3194 and constants vector yet, fetch them from the file. */
3195 if (CONSP (AREF (fun
, COMPILED_BYTECODE
)))
3196 Ffetch_bytecode (fun
);
3197 val
= exec_byte_code (AREF (fun
, COMPILED_BYTECODE
),
3198 AREF (fun
, COMPILED_CONSTANTS
),
3199 AREF (fun
, COMPILED_STACK_DEPTH
),
3203 return unbind_to (count
, val
);
3206 DEFUN ("fetch-bytecode", Ffetch_bytecode
, Sfetch_bytecode
,
3208 doc
: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3209 (Lisp_Object object
)
3213 if (COMPILEDP (object
) && CONSP (AREF (object
, COMPILED_BYTECODE
)))
3215 tem
= read_doc_string (AREF (object
, COMPILED_BYTECODE
));
3218 tem
= AREF (object
, COMPILED_BYTECODE
);
3219 if (CONSP (tem
) && STRINGP (XCAR (tem
)))
3220 error ("Invalid byte code in %s", SDATA (XCAR (tem
)));
3222 error ("Invalid byte code");
3224 ASET (object
, COMPILED_BYTECODE
, XCAR (tem
));
3225 ASET (object
, COMPILED_CONSTANTS
, XCDR (tem
));
3233 register int count
= SPECPDL_INDEX ();
3235 min (max_specpdl_size
,
3236 min (max (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct specbinding
),
3239 if (max_size
<= specpdl_size
)
3241 if (max_specpdl_size
< 400)
3242 max_size
= max_specpdl_size
= 400;
3243 if (max_size
<= specpdl_size
)
3244 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil
);
3246 size
= specpdl_size
< max_size
/ 2 ? 2 * specpdl_size
: max_size
;
3247 specpdl
= xnrealloc (specpdl
, size
, sizeof *specpdl
);
3248 specpdl_size
= size
;
3249 specpdl_ptr
= specpdl
+ count
;
3252 /* `specpdl_ptr->symbol' is a field which describes which variable is
3253 let-bound, so it can be properly undone when we unbind_to.
3254 It can have the following two shapes:
3255 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3256 a symbol that is not buffer-local (at least at the time
3257 the let binding started). Note also that it should not be
3258 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3260 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3261 variable SYMBOL which can be buffer-local. WHERE tells us
3262 which buffer is affected (or nil if the let-binding affects the
3263 global value of the variable) and BUFFER tells us which buffer was
3264 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3265 BUFFER did not yet have a buffer-local value). */
3268 specbind (Lisp_Object symbol
, Lisp_Object value
)
3270 struct Lisp_Symbol
*sym
;
3272 eassert (!handling_signal
);
3274 CHECK_SYMBOL (symbol
);
3275 sym
= XSYMBOL (symbol
);
3276 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3280 switch (sym
->redirect
)
3282 case SYMBOL_VARALIAS
:
3283 sym
= indirect_variable (sym
); XSETSYMBOL (symbol
, sym
); goto start
;
3284 case SYMBOL_PLAINVAL
:
3285 /* The most common case is that of a non-constant symbol with a
3286 trivial value. Make that as fast as we can. */
3287 specpdl_ptr
->symbol
= symbol
;
3288 specpdl_ptr
->old_value
= SYMBOL_VAL (sym
);
3289 specpdl_ptr
->func
= NULL
;
3292 SET_SYMBOL_VAL (sym
, value
);
3294 set_internal (symbol
, value
, Qnil
, 1);
3296 case SYMBOL_LOCALIZED
:
3297 if (SYMBOL_BLV (sym
)->frame_local
)
3298 error ("Frame-local vars cannot be let-bound");
3299 case SYMBOL_FORWARDED
:
3301 Lisp_Object ovalue
= find_symbol_value (symbol
);
3302 specpdl_ptr
->func
= 0;
3303 specpdl_ptr
->old_value
= ovalue
;
3305 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3306 || (EQ (SYMBOL_BLV (sym
)->where
,
3307 SYMBOL_BLV (sym
)->frame_local
?
3308 Fselected_frame () : Fcurrent_buffer ())));
3310 if (sym
->redirect
== SYMBOL_LOCALIZED
3311 || BUFFER_OBJFWDP (SYMBOL_FWD (sym
)))
3313 Lisp_Object where
, cur_buf
= Fcurrent_buffer ();
3315 /* For a local variable, record both the symbol and which
3316 buffer's or frame's value we are saving. */
3317 if (!NILP (Flocal_variable_p (symbol
, Qnil
)))
3319 eassert (sym
->redirect
!= SYMBOL_LOCALIZED
3320 || (BLV_FOUND (SYMBOL_BLV (sym
))
3321 && EQ (cur_buf
, SYMBOL_BLV (sym
)->where
)));
3324 else if (sym
->redirect
== SYMBOL_LOCALIZED
3325 && BLV_FOUND (SYMBOL_BLV (sym
)))
3326 where
= SYMBOL_BLV (sym
)->where
;
3330 /* We're not using the `unused' slot in the specbinding
3331 structure because this would mean we have to do more
3332 work for simple variables. */
3333 /* FIXME: The third value `current_buffer' is only used in
3334 let_shadows_buffer_binding_p which is itself only used
3335 in set_internal for local_if_set. */
3336 eassert (NILP (where
) || EQ (where
, cur_buf
));
3337 specpdl_ptr
->symbol
= Fcons (symbol
, Fcons (where
, cur_buf
));
3339 /* If SYMBOL is a per-buffer variable which doesn't have a
3340 buffer-local value here, make the `let' change the global
3341 value by changing the value of SYMBOL in all buffers not
3342 having their own value. This is consistent with what
3343 happens with other buffer-local variables. */
3345 && sym
->redirect
== SYMBOL_FORWARDED
)
3347 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym
)));
3349 Fset_default (symbol
, value
);
3354 specpdl_ptr
->symbol
= symbol
;
3357 set_internal (symbol
, value
, Qnil
, 1);
3365 record_unwind_protect (Lisp_Object (*function
) (Lisp_Object
), Lisp_Object arg
)
3367 eassert (!handling_signal
);
3369 if (specpdl_ptr
== specpdl
+ specpdl_size
)
3371 specpdl_ptr
->func
= function
;
3372 specpdl_ptr
->symbol
= Qnil
;
3373 specpdl_ptr
->old_value
= arg
;
3378 unbind_to (int count
, Lisp_Object value
)
3380 Lisp_Object quitf
= Vquit_flag
;
3381 struct gcpro gcpro1
, gcpro2
;
3383 GCPRO2 (value
, quitf
);
3386 while (specpdl_ptr
!= specpdl
+ count
)
3388 /* Copy the binding, and decrement specpdl_ptr, before we do
3389 the work to unbind it. We decrement first
3390 so that an error in unbinding won't try to unbind
3391 the same entry again, and we copy the binding first
3392 in case more bindings are made during some of the code we run. */
3394 struct specbinding this_binding
;
3395 this_binding
= *--specpdl_ptr
;
3397 if (this_binding
.func
!= 0)
3398 (*this_binding
.func
) (this_binding
.old_value
);
3399 /* If the symbol is a list, it is really (SYMBOL WHERE
3400 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3401 frame. If WHERE is a buffer or frame, this indicates we
3402 bound a variable that had a buffer-local or frame-local
3403 binding. WHERE nil means that the variable had the default
3404 value when it was bound. CURRENT-BUFFER is the buffer that
3405 was current when the variable was bound. */
3406 else if (CONSP (this_binding
.symbol
))
3408 Lisp_Object symbol
, where
;
3410 symbol
= XCAR (this_binding
.symbol
);
3411 where
= XCAR (XCDR (this_binding
.symbol
));
3414 Fset_default (symbol
, this_binding
.old_value
);
3415 /* If `where' is non-nil, reset the value in the appropriate
3416 local binding, but only if that binding still exists. */
3417 else if (BUFFERP (where
)
3418 ? !NILP (Flocal_variable_p (symbol
, where
))
3419 : !NILP (Fassq (symbol
, XFRAME (where
)->param_alist
)))
3420 set_internal (symbol
, this_binding
.old_value
, where
, 1);
3422 /* If variable has a trivial value (no forwarding), we can
3423 just set it. No need to check for constant symbols here,
3424 since that was already done by specbind. */
3425 else if (XSYMBOL (this_binding
.symbol
)->redirect
== SYMBOL_PLAINVAL
)
3426 SET_SYMBOL_VAL (XSYMBOL (this_binding
.symbol
),
3427 this_binding
.old_value
);
3429 /* NOTE: we only ever come here if make_local_foo was used for
3430 the first time on this var within this let. */
3431 Fset_default (this_binding
.symbol
, this_binding
.old_value
);
3434 if (NILP (Vquit_flag
) && !NILP (quitf
))
3441 DEFUN ("special-variable-p", Fspecial_variable_p
, Sspecial_variable_p
, 1, 1, 0,
3442 doc
: /* Return non-nil if SYMBOL's global binding has been declared special.
3443 A special variable is one that will be bound dynamically, even in a
3444 context where binding is lexical by default. */)
3445 (Lisp_Object symbol
)
3447 CHECK_SYMBOL (symbol
);
3448 return XSYMBOL (symbol
)->declared_special
? Qt
: Qnil
;
3452 DEFUN ("backtrace-debug", Fbacktrace_debug
, Sbacktrace_debug
, 2, 2, 0,
3453 doc
: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3454 The debugger is entered when that frame exits, if the flag is non-nil. */)
3455 (Lisp_Object level
, Lisp_Object flag
)
3457 register struct backtrace
*backlist
= backtrace_list
;
3460 CHECK_NUMBER (level
);
3462 for (i
= 0; backlist
&& i
< XINT (level
); i
++)
3464 backlist
= backlist
->next
;
3468 backlist
->debug_on_exit
= !NILP (flag
);
3473 DEFUN ("backtrace", Fbacktrace
, Sbacktrace
, 0, 0, "",
3474 doc
: /* Print a trace of Lisp function calls currently active.
3475 Output stream used is value of `standard-output'. */)
3478 register struct backtrace
*backlist
= backtrace_list
;
3481 struct gcpro gcpro1
;
3482 Lisp_Object old_print_level
= Vprint_level
;
3484 if (NILP (Vprint_level
))
3485 XSETFASTINT (Vprint_level
, 8);
3492 write_string (backlist
->debug_on_exit
? "* " : " ", 2);
3493 if (backlist
->nargs
== UNEVALLED
)
3495 Fprin1 (Fcons (*backlist
->function
, *backlist
->args
), Qnil
);
3496 write_string ("\n", -1);
3500 tem
= *backlist
->function
;
3501 Fprin1 (tem
, Qnil
); /* This can QUIT. */
3502 write_string ("(", -1);
3503 if (backlist
->nargs
== MANY
)
3504 { /* FIXME: Can this happen? */
3506 for (tail
= *backlist
->args
, i
= 0;
3508 tail
= Fcdr (tail
), i
= 1)
3510 if (i
) write_string (" ", -1);
3511 Fprin1 (Fcar (tail
), Qnil
);
3517 for (i
= 0; i
< backlist
->nargs
; i
++)
3519 if (i
) write_string (" ", -1);
3520 Fprin1 (backlist
->args
[i
], Qnil
);
3523 write_string (")\n", -1);
3525 backlist
= backlist
->next
;
3528 Vprint_level
= old_print_level
;
3533 DEFUN ("backtrace-frame", Fbacktrace_frame
, Sbacktrace_frame
, 1, 1, NULL
,
3534 doc
: /* Return the function and arguments NFRAMES up from current execution point.
3535 If that frame has not evaluated the arguments yet (or is a special form),
3536 the value is (nil FUNCTION ARG-FORMS...).
3537 If that frame has evaluated its arguments and called its function already,
3538 the value is (t FUNCTION ARG-VALUES...).
3539 A &rest arg is represented as the tail of the list ARG-VALUES.
3540 FUNCTION is whatever was supplied as car of evaluated list,
3541 or a lambda expression for macro calls.
3542 If NFRAMES is more than the number of frames, the value is nil. */)
3543 (Lisp_Object nframes
)
3545 register struct backtrace
*backlist
= backtrace_list
;
3546 register EMACS_INT i
;
3549 CHECK_NATNUM (nframes
);
3551 /* Find the frame requested. */
3552 for (i
= 0; backlist
&& i
< XFASTINT (nframes
); i
++)
3553 backlist
= backlist
->next
;
3557 if (backlist
->nargs
== UNEVALLED
)
3558 return Fcons (Qnil
, Fcons (*backlist
->function
, *backlist
->args
));
3561 if (backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3562 tem
= *backlist
->args
;
3564 tem
= Flist (backlist
->nargs
, backlist
->args
);
3566 return Fcons (Qt
, Fcons (*backlist
->function
, tem
));
3573 mark_backtrace (void)
3575 register struct backtrace
*backlist
;
3578 for (backlist
= backtrace_list
; backlist
; backlist
= backlist
->next
)
3580 mark_object (*backlist
->function
);
3582 if (backlist
->nargs
== UNEVALLED
3583 || backlist
->nargs
== MANY
) /* FIXME: Can this happen? */
3586 i
= backlist
->nargs
;
3588 mark_object (backlist
->args
[i
]);
3596 DEFVAR_INT ("max-specpdl-size", max_specpdl_size
,
3597 doc
: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3598 If Lisp code tries to increase the total number past this amount,
3599 an error is signaled.
3600 You can safely use a value considerably larger than the default value,
3601 if that proves inconveniently small. However, if you increase it too far,
3602 Emacs could run out of memory trying to make the stack bigger. */);
3604 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth
,
3605 doc
: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3607 This limit serves to catch infinite recursions for you before they cause
3608 actual stack overflow in C, which would be fatal for Emacs.
3609 You can safely make it considerably larger than its default value,
3610 if that proves inconveniently small. However, if you increase it too far,
3611 Emacs could overflow the real C stack, and crash. */);
3613 DEFVAR_LISP ("quit-flag", Vquit_flag
,
3614 doc
: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3615 If the value is t, that means do an ordinary quit.
3616 If the value equals `throw-on-input', that means quit by throwing
3617 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3618 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3619 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3622 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit
,
3623 doc
: /* Non-nil inhibits C-g quitting from happening immediately.
3624 Note that `quit-flag' will still be set by typing C-g,
3625 so a quit will be signaled as soon as `inhibit-quit' is nil.
3626 To prevent this happening, set `quit-flag' to nil
3627 before making `inhibit-quit' nil. */);
3628 Vinhibit_quit
= Qnil
;
3630 DEFSYM (Qinhibit_quit
, "inhibit-quit");
3631 DEFSYM (Qautoload
, "autoload");
3632 DEFSYM (Qdebug_on_error
, "debug-on-error");
3633 DEFSYM (Qmacro
, "macro");
3634 DEFSYM (Qdeclare
, "declare");
3636 /* Note that the process handling also uses Qexit, but we don't want
3637 to staticpro it twice, so we just do it here. */
3638 DEFSYM (Qexit
, "exit");
3640 DEFSYM (Qinteractive
, "interactive");
3641 DEFSYM (Qcommandp
, "commandp");
3642 DEFSYM (Qdefun
, "defun");
3643 DEFSYM (Qand_rest
, "&rest");
3644 DEFSYM (Qand_optional
, "&optional");
3645 DEFSYM (Qclosure
, "closure");
3646 DEFSYM (Qdebug
, "debug");
3648 DEFVAR_LISP ("debug-on-error", Vdebug_on_error
,
3649 doc
: /* *Non-nil means enter debugger if an error is signaled.
3650 Does not apply to errors handled by `condition-case' or those
3651 matched by `debug-ignored-errors'.
3652 If the value is a list, an error only means to enter the debugger
3653 if one of its condition symbols appears in the list.
3654 When you evaluate an expression interactively, this variable
3655 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3656 The command `toggle-debug-on-error' toggles this.
3657 See also the variable `debug-on-quit'. */);
3658 Vdebug_on_error
= Qnil
;
3660 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors
,
3661 doc
: /* *List of errors for which the debugger should not be called.
3662 Each element may be a condition-name or a regexp that matches error messages.
3663 If any element applies to a given error, that error skips the debugger
3664 and just returns to top level.
3665 This overrides the variable `debug-on-error'.
3666 It does not apply to errors handled by `condition-case'. */);
3667 Vdebug_ignored_errors
= Qnil
;
3669 DEFVAR_BOOL ("debug-on-quit", debug_on_quit
,
3670 doc
: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3671 Does not apply if quit is handled by a `condition-case'. */);
3674 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call
,
3675 doc
: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3677 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue
,
3678 doc
: /* Non-nil means debugger may continue execution.
3679 This is nil when the debugger is called under circumstances where it
3680 might not be safe to continue. */);
3681 debugger_may_continue
= 1;
3683 DEFVAR_LISP ("debugger", Vdebugger
,
3684 doc
: /* Function to call to invoke debugger.
3685 If due to frame exit, args are `exit' and the value being returned;
3686 this function's value will be returned instead of that.
3687 If due to error, args are `error' and a list of the args to `signal'.
3688 If due to `apply' or `funcall' entry, one arg, `lambda'.
3689 If due to `eval' entry, one arg, t. */);
3692 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function
,
3693 doc
: /* If non-nil, this is a function for `signal' to call.
3694 It receives the same arguments that `signal' was given.
3695 The Edebug package uses this to regain control. */);
3696 Vsignal_hook_function
= Qnil
;
3698 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal
,
3699 doc
: /* *Non-nil means call the debugger regardless of condition handlers.
3700 Note that `debug-on-error', `debug-on-quit' and friends
3701 still determine whether to handle the particular condition. */);
3702 Vdebug_on_signal
= Qnil
;
3704 DEFVAR_LISP ("macro-declaration-function", Vmacro_declaration_function
,
3705 doc
: /* Function to process declarations in a macro definition.
3706 The function will be called with two args MACRO and DECL.
3707 MACRO is the name of the macro being defined.
3708 DECL is a list `(declare ...)' containing the declarations.
3709 The value the function returns is not used. */);
3710 Vmacro_declaration_function
= Qnil
;
3712 /* When lexical binding is being used,
3713 vinternal_interpreter_environment is non-nil, and contains an alist
3714 of lexically-bound variable, or (t), indicating an empty
3715 environment. The lisp name of this variable would be
3716 `internal-interpreter-environment' if it weren't hidden.
3717 Every element of this list can be either a cons (VAR . VAL)
3718 specifying a lexical binding, or a single symbol VAR indicating
3719 that this variable should use dynamic scoping. */
3720 DEFSYM (Qinternal_interpreter_environment
, "internal-interpreter-environment");
3721 DEFVAR_LISP ("internal-interpreter-environment",
3722 Vinternal_interpreter_environment
,
3723 doc
: /* If non-nil, the current lexical environment of the lisp interpreter.
3724 When lexical binding is not being used, this variable is nil.
3725 A value of `(t)' indicates an empty environment, otherwise it is an
3726 alist of active lexical bindings. */);
3727 Vinternal_interpreter_environment
= Qnil
;
3728 /* Don't export this variable to Elisp, so noone can mess with it
3729 (Just imagine if someone makes it buffer-local). */
3730 Funintern (Qinternal_interpreter_environment
, Qnil
);
3732 DEFSYM (Vrun_hooks
, "run-hooks");
3734 staticpro (&Vautoload_queue
);
3735 Vautoload_queue
= Qnil
;
3736 staticpro (&Vsignaling_function
);
3737 Vsignaling_function
= Qnil
;
3748 defsubr (&Sfunction
);
3750 defsubr (&Sdefmacro
);
3752 defsubr (&Sdefvaralias
);
3753 defsubr (&Sdefconst
);
3754 defsubr (&Suser_variable_p
);
3758 defsubr (&Smacroexpand
);
3761 defsubr (&Sunwind_protect
);
3762 defsubr (&Scondition_case
);
3764 defsubr (&Sinteractive_p
);
3765 defsubr (&Scalled_interactively_p
);
3766 defsubr (&Scommandp
);
3767 defsubr (&Sautoload
);
3770 defsubr (&Sfuncall
);
3771 defsubr (&Srun_hooks
);
3772 defsubr (&Srun_hook_with_args
);
3773 defsubr (&Srun_hook_with_args_until_success
);
3774 defsubr (&Srun_hook_with_args_until_failure
);
3775 defsubr (&Srun_hook_wrapped
);
3776 defsubr (&Sfetch_bytecode
);
3777 defsubr (&Sbacktrace_debug
);
3778 defsubr (&Sbacktrace
);
3779 defsubr (&Sbacktrace_frame
);
3780 defsubr (&Sspecial_variable_p
);
3781 defsubr (&Sfunctionp
);