Fix rendering of composed caharacters on the mode line. (Bug#19435)
[emacs.git] / src / eval.c
blobf0ad999f0f8bff295eeb6bd00cc29c16d4ae948f
1 /* Evaluator for GNU Emacs Lisp interpreter.
3 Copyright (C) 1985-1987, 1993-1995, 1999-2014 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <limits.h>
24 #include <stdio.h>
25 #include "lisp.h"
26 #include "blockinput.h"
27 #include "commands.h"
28 #include "keyboard.h"
29 #include "dispextern.h"
30 #include "frame.h" /* For XFRAME. */
32 #if HAVE_X_WINDOWS
33 #include "xterm.h"
34 #endif
36 /* Chain of condition and catch handlers currently in effect. */
38 struct handler *handlerlist;
40 #ifdef DEBUG_GCPRO
41 /* Count levels of GCPRO to detect failure to UNGCPRO. */
42 int gcpro_level;
43 #endif
45 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp;
46 Lisp_Object Qinhibit_quit;
47 Lisp_Object Qand_rest;
48 static Lisp_Object Qand_optional;
49 static Lisp_Object Qinhibit_debugger;
50 static Lisp_Object Qdeclare;
51 Lisp_Object Qinternal_interpreter_environment, Qclosure;
53 static Lisp_Object Qdebug;
55 /* This holds either the symbol `run-hooks' or nil.
56 It is nil at an early stage of startup, and when Emacs
57 is shutting down. */
59 Lisp_Object Vrun_hooks;
61 /* Non-nil means record all fset's and provide's, to be undone
62 if the file being autoloaded is not fully loaded.
63 They are recorded by being consed onto the front of Vautoload_queue:
64 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
66 Lisp_Object Vautoload_queue;
68 /* Current number of specbindings allocated in specpdl, not counting
69 the dummy entry specpdl[-1]. */
71 ptrdiff_t specpdl_size;
73 /* Pointer to beginning of specpdl. A dummy entry specpdl[-1] exists
74 only so that its address can be taken. */
76 union specbinding *specpdl;
78 /* Pointer to first unused element in specpdl. */
80 union specbinding *specpdl_ptr;
82 /* Depth in Lisp evaluations and function calls. */
84 EMACS_INT lisp_eval_depth;
86 /* The value of num_nonmacro_input_events as of the last time we
87 started to enter the debugger. If we decide to enter the debugger
88 again when this is still equal to num_nonmacro_input_events, then we
89 know that the debugger itself has an error, and we should just
90 signal the error instead of entering an infinite loop of debugger
91 invocations. */
93 static EMACS_INT when_entered_debugger;
95 /* The function from which the last `signal' was called. Set in
96 Fsignal. */
97 /* FIXME: We should probably get rid of this! */
98 Lisp_Object Vsignaling_function;
100 /* If non-nil, Lisp code must not be run since some part of Emacs is
101 in an inconsistent state. Currently, x-create-frame uses this to
102 avoid triggering window-configuration-change-hook while the new
103 frame is half-initialized. */
104 Lisp_Object inhibit_lisp_code;
106 /* These would ordinarily be static, but they need to be visible to GDB. */
107 bool backtrace_p (union specbinding *) EXTERNALLY_VISIBLE;
108 Lisp_Object *backtrace_args (union specbinding *) EXTERNALLY_VISIBLE;
109 Lisp_Object backtrace_function (union specbinding *) EXTERNALLY_VISIBLE;
110 union specbinding *backtrace_next (union specbinding *) EXTERNALLY_VISIBLE;
111 union specbinding *backtrace_top (void) EXTERNALLY_VISIBLE;
113 static Lisp_Object funcall_lambda (Lisp_Object, ptrdiff_t, Lisp_Object *);
114 static Lisp_Object apply_lambda (Lisp_Object, Lisp_Object, ptrdiff_t);
116 static Lisp_Object
117 specpdl_symbol (union specbinding *pdl)
119 eassert (pdl->kind >= SPECPDL_LET);
120 return pdl->let.symbol;
123 static Lisp_Object
124 specpdl_old_value (union specbinding *pdl)
126 eassert (pdl->kind >= SPECPDL_LET);
127 return pdl->let.old_value;
130 static void
131 set_specpdl_old_value (union specbinding *pdl, Lisp_Object val)
133 eassert (pdl->kind >= SPECPDL_LET);
134 pdl->let.old_value = val;
137 static Lisp_Object
138 specpdl_where (union specbinding *pdl)
140 eassert (pdl->kind > SPECPDL_LET);
141 return pdl->let.where;
144 static Lisp_Object
145 specpdl_arg (union specbinding *pdl)
147 eassert (pdl->kind == SPECPDL_UNWIND);
148 return pdl->unwind.arg;
151 Lisp_Object
152 backtrace_function (union specbinding *pdl)
154 eassert (pdl->kind == SPECPDL_BACKTRACE);
155 return pdl->bt.function;
158 static ptrdiff_t
159 backtrace_nargs (union specbinding *pdl)
161 eassert (pdl->kind == SPECPDL_BACKTRACE);
162 return pdl->bt.nargs;
165 Lisp_Object *
166 backtrace_args (union specbinding *pdl)
168 eassert (pdl->kind == SPECPDL_BACKTRACE);
169 return pdl->bt.args;
172 static bool
173 backtrace_debug_on_exit (union specbinding *pdl)
175 eassert (pdl->kind == SPECPDL_BACKTRACE);
176 return pdl->bt.debug_on_exit;
179 /* Functions to modify slots of backtrace records. */
181 static void
182 set_backtrace_args (union specbinding *pdl, Lisp_Object *args, ptrdiff_t nargs)
184 eassert (pdl->kind == SPECPDL_BACKTRACE);
185 pdl->bt.args = args;
186 pdl->bt.nargs = nargs;
189 static void
190 set_backtrace_debug_on_exit (union specbinding *pdl, bool doe)
192 eassert (pdl->kind == SPECPDL_BACKTRACE);
193 pdl->bt.debug_on_exit = doe;
196 /* Helper functions to scan the backtrace. */
198 bool
199 backtrace_p (union specbinding *pdl)
200 { return pdl >= specpdl; }
202 union specbinding *
203 backtrace_top (void)
205 union specbinding *pdl = specpdl_ptr - 1;
206 while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
207 pdl--;
208 return pdl;
211 union specbinding *
212 backtrace_next (union specbinding *pdl)
214 pdl--;
215 while (backtrace_p (pdl) && pdl->kind != SPECPDL_BACKTRACE)
216 pdl--;
217 return pdl;
221 void
222 init_eval_once (void)
224 enum { size = 50 };
225 union specbinding *pdlvec = xmalloc ((size + 1) * sizeof *specpdl);
226 specpdl_size = size;
227 specpdl = specpdl_ptr = pdlvec + 1;
228 /* Don't forget to update docs (lispref node "Local Variables"). */
229 max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el. */
230 max_lisp_eval_depth = 600;
232 Vrun_hooks = Qnil;
235 static struct handler handlerlist_sentinel;
237 void
238 init_eval (void)
240 specpdl_ptr = specpdl;
241 { /* Put a dummy catcher at top-level so that handlerlist is never NULL.
242 This is important since handlerlist->nextfree holds the freelist
243 which would otherwise leak every time we unwind back to top-level. */
244 struct handler *c;
245 handlerlist = handlerlist_sentinel.nextfree = &handlerlist_sentinel;
246 PUSH_HANDLER (c, Qunbound, CATCHER);
247 eassert (c == &handlerlist_sentinel);
248 handlerlist_sentinel.nextfree = NULL;
249 handlerlist_sentinel.next = NULL;
251 Vquit_flag = Qnil;
252 debug_on_next_call = 0;
253 lisp_eval_depth = 0;
254 #ifdef DEBUG_GCPRO
255 gcpro_level = 0;
256 #endif
257 /* This is less than the initial value of num_nonmacro_input_events. */
258 when_entered_debugger = -1;
261 /* Unwind-protect function used by call_debugger. */
263 static void
264 restore_stack_limits (Lisp_Object data)
266 max_specpdl_size = XINT (XCAR (data));
267 max_lisp_eval_depth = XINT (XCDR (data));
270 static void grow_specpdl (void);
272 /* Call the Lisp debugger, giving it argument ARG. */
274 Lisp_Object
275 call_debugger (Lisp_Object arg)
277 bool debug_while_redisplaying;
278 ptrdiff_t count = SPECPDL_INDEX ();
279 Lisp_Object val;
280 EMACS_INT old_depth = max_lisp_eval_depth;
281 /* Do not allow max_specpdl_size less than actual depth (Bug#16603). */
282 EMACS_INT old_max = max (max_specpdl_size, count);
284 if (lisp_eval_depth + 40 > max_lisp_eval_depth)
285 max_lisp_eval_depth = lisp_eval_depth + 40;
287 /* While debugging Bug#16603, previous value of 100 was found
288 too small to avoid specpdl overflow in the debugger itself. */
289 if (max_specpdl_size - 200 < count)
290 max_specpdl_size = count + 200;
292 if (old_max == count)
294 /* We can enter the debugger due to specpdl overflow (Bug#16603). */
295 specpdl_ptr--;
296 grow_specpdl ();
299 /* Restore limits after leaving the debugger. */
300 record_unwind_protect (restore_stack_limits,
301 Fcons (make_number (old_max),
302 make_number (old_depth)));
304 #ifdef HAVE_WINDOW_SYSTEM
305 if (display_hourglass_p)
306 cancel_hourglass ();
307 #endif
309 debug_on_next_call = 0;
310 when_entered_debugger = num_nonmacro_input_events;
312 /* Resetting redisplaying_p to 0 makes sure that debug output is
313 displayed if the debugger is invoked during redisplay. */
314 debug_while_redisplaying = redisplaying_p;
315 redisplaying_p = 0;
316 specbind (intern ("debugger-may-continue"),
317 debug_while_redisplaying ? Qnil : Qt);
318 specbind (Qinhibit_redisplay, Qnil);
319 specbind (Qinhibit_debugger, Qt);
321 #if 0 /* Binding this prevents execution of Lisp code during
322 redisplay, which necessarily leads to display problems. */
323 specbind (Qinhibit_eval_during_redisplay, Qt);
324 #endif
326 val = apply1 (Vdebugger, arg);
328 /* Interrupting redisplay and resuming it later is not safe under
329 all circumstances. So, when the debugger returns, abort the
330 interrupted redisplay by going back to the top-level. */
331 if (debug_while_redisplaying)
332 Ftop_level ();
334 return unbind_to (count, val);
337 static void
338 do_debug_on_call (Lisp_Object code, ptrdiff_t count)
340 debug_on_next_call = 0;
341 set_backtrace_debug_on_exit (specpdl + count, true);
342 call_debugger (list1 (code));
345 /* NOTE!!! Every function that can call EVAL must protect its args
346 and temporaries from garbage collection while it needs them.
347 The definition of `For' shows what you have to do. */
349 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
350 doc: /* Eval args until one of them yields non-nil, then return that value.
351 The remaining args are not evalled at all.
352 If all args return nil, return nil.
353 usage: (or CONDITIONS...) */)
354 (Lisp_Object args)
356 register Lisp_Object val = Qnil;
357 struct gcpro gcpro1;
359 GCPRO1 (args);
361 while (CONSP (args))
363 val = eval_sub (XCAR (args));
364 if (!NILP (val))
365 break;
366 args = XCDR (args);
369 UNGCPRO;
370 return val;
373 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
374 doc: /* Eval args until one of them yields nil, then return nil.
375 The remaining args are not evalled at all.
376 If no arg yields nil, return the last arg's value.
377 usage: (and CONDITIONS...) */)
378 (Lisp_Object args)
380 register Lisp_Object val = Qt;
381 struct gcpro gcpro1;
383 GCPRO1 (args);
385 while (CONSP (args))
387 val = eval_sub (XCAR (args));
388 if (NILP (val))
389 break;
390 args = XCDR (args);
393 UNGCPRO;
394 return val;
397 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
398 doc: /* If COND yields non-nil, do THEN, else do ELSE...
399 Returns the value of THEN or the value of the last of the ELSE's.
400 THEN must be one expression, but ELSE... can be zero or more expressions.
401 If COND yields nil, and there are no ELSE's, the value is nil.
402 usage: (if COND THEN ELSE...) */)
403 (Lisp_Object args)
405 Lisp_Object cond;
406 struct gcpro gcpro1;
408 GCPRO1 (args);
409 cond = eval_sub (XCAR (args));
410 UNGCPRO;
412 if (!NILP (cond))
413 return eval_sub (Fcar (XCDR (args)));
414 return Fprogn (XCDR (XCDR (args)));
417 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
418 doc: /* Try each clause until one succeeds.
419 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
420 and, if the value is non-nil, this clause succeeds:
421 then the expressions in BODY are evaluated and the last one's
422 value is the value of the cond-form.
423 If a clause has one element, as in (CONDITION), then the cond-form
424 returns CONDITION's value, if that is non-nil.
425 If no clause succeeds, cond returns nil.
426 usage: (cond CLAUSES...) */)
427 (Lisp_Object args)
429 Lisp_Object val = args;
430 struct gcpro gcpro1;
432 GCPRO1 (args);
433 while (CONSP (args))
435 Lisp_Object clause = XCAR (args);
436 val = eval_sub (Fcar (clause));
437 if (!NILP (val))
439 if (!NILP (XCDR (clause)))
440 val = Fprogn (XCDR (clause));
441 break;
443 args = XCDR (args);
445 UNGCPRO;
447 return val;
450 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
451 doc: /* Eval BODY forms sequentially and return value of last one.
452 usage: (progn BODY...) */)
453 (Lisp_Object body)
455 Lisp_Object val = Qnil;
456 struct gcpro gcpro1;
458 GCPRO1 (body);
460 while (CONSP (body))
462 val = eval_sub (XCAR (body));
463 body = XCDR (body);
466 UNGCPRO;
467 return val;
470 /* Evaluate BODY sequentially, discarding its value. Suitable for
471 record_unwind_protect. */
473 void
474 unwind_body (Lisp_Object body)
476 Fprogn (body);
479 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
480 doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
481 The value of FIRST is saved during the evaluation of the remaining args,
482 whose values are discarded.
483 usage: (prog1 FIRST BODY...) */)
484 (Lisp_Object args)
486 Lisp_Object val;
487 Lisp_Object args_left;
488 struct gcpro gcpro1, gcpro2;
490 args_left = args;
491 val = args;
492 GCPRO2 (args, val);
494 val = eval_sub (XCAR (args_left));
495 while (CONSP (args_left = XCDR (args_left)))
496 eval_sub (XCAR (args_left));
498 UNGCPRO;
499 return val;
502 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
503 doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
504 The value of FORM2 is saved during the evaluation of the
505 remaining args, whose values are discarded.
506 usage: (prog2 FORM1 FORM2 BODY...) */)
507 (Lisp_Object args)
509 struct gcpro gcpro1;
511 GCPRO1 (args);
512 eval_sub (XCAR (args));
513 UNGCPRO;
514 return Fprog1 (XCDR (args));
517 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
518 doc: /* Set each SYM to the value of its VAL.
519 The symbols SYM are variables; they are literal (not evaluated).
520 The values VAL are expressions; they are evaluated.
521 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
522 The second VAL is not computed until after the first SYM is set, and so on;
523 each VAL can use the new value of variables set earlier in the `setq'.
524 The return value of the `setq' form is the value of the last VAL.
525 usage: (setq [SYM VAL]...) */)
526 (Lisp_Object args)
528 Lisp_Object val, sym, lex_binding;
530 val = args;
531 if (CONSP (args))
533 Lisp_Object args_left = args;
534 struct gcpro gcpro1;
535 GCPRO1 (args);
539 val = eval_sub (Fcar (XCDR (args_left)));
540 sym = XCAR (args_left);
542 /* Like for eval_sub, we do not check declared_special here since
543 it's been done when let-binding. */
544 if (!NILP (Vinternal_interpreter_environment) /* Mere optimization! */
545 && SYMBOLP (sym)
546 && !NILP (lex_binding
547 = Fassq (sym, Vinternal_interpreter_environment)))
548 XSETCDR (lex_binding, val); /* SYM is lexically bound. */
549 else
550 Fset (sym, val); /* SYM is dynamically bound. */
552 args_left = Fcdr (XCDR (args_left));
554 while (CONSP (args_left));
556 UNGCPRO;
559 return val;
562 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
563 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
564 Warning: `quote' does not construct its return value, but just returns
565 the value that was pre-constructed by the Lisp reader (see info node
566 `(elisp)Printed Representation').
567 This means that '(a . b) is not identical to (cons 'a 'b): the former
568 does not cons. Quoting should be reserved for constants that will
569 never be modified by side-effects, unless you like self-modifying code.
570 See the common pitfall in info node `(elisp)Rearrangement' for an example
571 of unexpected results when a quoted object is modified.
572 usage: (quote ARG) */)
573 (Lisp_Object args)
575 if (CONSP (XCDR (args)))
576 xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
577 return XCAR (args);
580 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
581 doc: /* Like `quote', but preferred for objects which are functions.
582 In byte compilation, `function' causes its argument to be compiled.
583 `quote' cannot do that.
584 usage: (function ARG) */)
585 (Lisp_Object args)
587 Lisp_Object quoted = XCAR (args);
589 if (CONSP (XCDR (args)))
590 xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
592 if (!NILP (Vinternal_interpreter_environment)
593 && CONSP (quoted)
594 && EQ (XCAR (quoted), Qlambda))
595 /* This is a lambda expression within a lexical environment;
596 return an interpreted closure instead of a simple lambda. */
597 return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
598 XCDR (quoted)));
599 else
600 /* Simply quote the argument. */
601 return quoted;
605 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
606 doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
607 Aliased variables always have the same value; setting one sets the other.
608 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
609 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
610 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
611 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
612 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
613 The return value is BASE-VARIABLE. */)
614 (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
616 struct Lisp_Symbol *sym;
618 CHECK_SYMBOL (new_alias);
619 CHECK_SYMBOL (base_variable);
621 sym = XSYMBOL (new_alias);
623 if (sym->constant)
624 /* Not sure why, but why not? */
625 error ("Cannot make a constant an alias");
627 switch (sym->redirect)
629 case SYMBOL_FORWARDED:
630 error ("Cannot make an internal variable an alias");
631 case SYMBOL_LOCALIZED:
632 error ("Don't know how to make a localized variable an alias");
635 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
636 If n_a is bound, but b_v is not, set the value of b_v to n_a,
637 so that old-code that affects n_a before the aliasing is setup
638 still works. */
639 if (NILP (Fboundp (base_variable)))
640 set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
643 union specbinding *p;
645 for (p = specpdl_ptr; p > specpdl; )
646 if ((--p)->kind >= SPECPDL_LET
647 && (EQ (new_alias, specpdl_symbol (p))))
648 error ("Don't know how to make a let-bound variable an alias");
651 sym->declared_special = 1;
652 XSYMBOL (base_variable)->declared_special = 1;
653 sym->redirect = SYMBOL_VARALIAS;
654 SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
655 sym->constant = SYMBOL_CONSTANT_P (base_variable);
656 LOADHIST_ATTACH (new_alias);
657 /* Even if docstring is nil: remove old docstring. */
658 Fput (new_alias, Qvariable_documentation, docstring);
660 return base_variable;
663 static union specbinding *
664 default_toplevel_binding (Lisp_Object symbol)
666 union specbinding *binding = NULL;
667 union specbinding *pdl = specpdl_ptr;
668 while (pdl > specpdl)
670 switch ((--pdl)->kind)
672 case SPECPDL_LET_DEFAULT:
673 case SPECPDL_LET:
674 if (EQ (specpdl_symbol (pdl), symbol))
675 binding = pdl;
676 break;
679 return binding;
682 DEFUN ("default-toplevel-value", Fdefault_toplevel_value, Sdefault_toplevel_value, 1, 1, 0,
683 doc: /* Return SYMBOL's toplevel default value.
684 "Toplevel" means outside of any let binding. */)
685 (Lisp_Object symbol)
687 union specbinding *binding = default_toplevel_binding (symbol);
688 Lisp_Object value
689 = binding ? specpdl_old_value (binding) : Fdefault_value (symbol);
690 if (!EQ (value, Qunbound))
691 return value;
692 xsignal1 (Qvoid_variable, symbol);
695 DEFUN ("set-default-toplevel-value", Fset_default_toplevel_value,
696 Sset_default_toplevel_value, 2, 2, 0,
697 doc: /* Set SYMBOL's toplevel default value to VALUE.
698 "Toplevel" means outside of any let binding. */)
699 (Lisp_Object symbol, Lisp_Object value)
701 union specbinding *binding = default_toplevel_binding (symbol);
702 if (binding)
703 set_specpdl_old_value (binding, value);
704 else
705 Fset_default (symbol, value);
706 return Qnil;
709 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
710 doc: /* Define SYMBOL as a variable, and return SYMBOL.
711 You are not required to define a variable in order to use it, but
712 defining it lets you supply an initial value and documentation, which
713 can be referred to by the Emacs help facilities and other programming
714 tools. The `defvar' form also declares the variable as \"special\",
715 so that it is always dynamically bound even if `lexical-binding' is t.
717 The optional argument INITVALUE is evaluated, and used to set SYMBOL,
718 only if SYMBOL's value is void. If SYMBOL is buffer-local, its
719 default value is what is set; buffer-local values are not affected.
720 If INITVALUE is missing, SYMBOL's value is not set.
722 If SYMBOL has a local binding, then this form affects the local
723 binding. This is usually not what you want. Thus, if you need to
724 load a file defining variables, with this form or with `defconst' or
725 `defcustom', you should always load that file _outside_ any bindings
726 for these variables. \(`defconst' and `defcustom' behave similarly in
727 this respect.)
729 The optional argument DOCSTRING is a documentation string for the
730 variable.
732 To define a user option, use `defcustom' instead of `defvar'.
733 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
734 (Lisp_Object args)
736 Lisp_Object sym, tem, tail;
738 sym = XCAR (args);
739 tail = XCDR (args);
741 if (CONSP (tail))
743 if (CONSP (XCDR (tail)) && CONSP (XCDR (XCDR (tail))))
744 error ("Too many arguments");
746 tem = Fdefault_boundp (sym);
748 /* Do it before evaluating the initial value, for self-references. */
749 XSYMBOL (sym)->declared_special = 1;
751 if (NILP (tem))
752 Fset_default (sym, eval_sub (XCAR (tail)));
753 else
754 { /* Check if there is really a global binding rather than just a let
755 binding that shadows the global unboundness of the var. */
756 union specbinding *binding = default_toplevel_binding (sym);
757 if (binding && EQ (specpdl_old_value (binding), Qunbound))
759 set_specpdl_old_value (binding, eval_sub (XCAR (tail)));
762 tail = XCDR (tail);
763 tem = Fcar (tail);
764 if (!NILP (tem))
766 if (!NILP (Vpurify_flag))
767 tem = Fpurecopy (tem);
768 Fput (sym, Qvariable_documentation, tem);
770 LOADHIST_ATTACH (sym);
772 else if (!NILP (Vinternal_interpreter_environment)
773 && !XSYMBOL (sym)->declared_special)
774 /* A simple (defvar foo) with lexical scoping does "nothing" except
775 declare that var to be dynamically scoped *locally* (i.e. within
776 the current file or let-block). */
777 Vinternal_interpreter_environment
778 = Fcons (sym, Vinternal_interpreter_environment);
779 else
781 /* Simple (defvar <var>) should not count as a definition at all.
782 It could get in the way of other definitions, and unloading this
783 package could try to make the variable unbound. */
786 return sym;
789 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
790 doc: /* Define SYMBOL as a constant variable.
791 This declares that neither programs nor users should ever change the
792 value. This constancy is not actually enforced by Emacs Lisp, but
793 SYMBOL is marked as a special variable so that it is never lexically
794 bound.
796 The `defconst' form always sets the value of SYMBOL to the result of
797 evalling INITVALUE. If SYMBOL is buffer-local, its default value is
798 what is set; buffer-local values are not affected. If SYMBOL has a
799 local binding, then this form sets the local binding's value.
800 However, you should normally not make local bindings for variables
801 defined with this form.
803 The optional DOCSTRING specifies the variable's documentation string.
804 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
805 (Lisp_Object args)
807 Lisp_Object sym, tem;
809 sym = XCAR (args);
810 if (CONSP (Fcdr (XCDR (XCDR (args)))))
811 error ("Too many arguments");
813 tem = eval_sub (Fcar (XCDR (args)));
814 if (!NILP (Vpurify_flag))
815 tem = Fpurecopy (tem);
816 Fset_default (sym, tem);
817 XSYMBOL (sym)->declared_special = 1;
818 tem = Fcar (XCDR (XCDR (args)));
819 if (!NILP (tem))
821 if (!NILP (Vpurify_flag))
822 tem = Fpurecopy (tem);
823 Fput (sym, Qvariable_documentation, tem);
825 Fput (sym, Qrisky_local_variable, Qt);
826 LOADHIST_ATTACH (sym);
827 return sym;
830 /* Make SYMBOL lexically scoped. */
831 DEFUN ("internal-make-var-non-special", Fmake_var_non_special,
832 Smake_var_non_special, 1, 1, 0,
833 doc: /* Internal function. */)
834 (Lisp_Object symbol)
836 CHECK_SYMBOL (symbol);
837 XSYMBOL (symbol)->declared_special = 0;
838 return Qnil;
842 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
843 doc: /* Bind variables according to VARLIST then eval BODY.
844 The value of the last form in BODY is returned.
845 Each element of VARLIST is a symbol (which is bound to nil)
846 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
847 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
848 usage: (let* VARLIST BODY...) */)
849 (Lisp_Object args)
851 Lisp_Object varlist, var, val, elt, lexenv;
852 ptrdiff_t count = SPECPDL_INDEX ();
853 struct gcpro gcpro1, gcpro2, gcpro3;
855 GCPRO3 (args, elt, varlist);
857 lexenv = Vinternal_interpreter_environment;
859 varlist = XCAR (args);
860 while (CONSP (varlist))
862 QUIT;
864 elt = XCAR (varlist);
865 if (SYMBOLP (elt))
867 var = elt;
868 val = Qnil;
870 else if (! NILP (Fcdr (Fcdr (elt))))
871 signal_error ("`let' bindings can have only one value-form", elt);
872 else
874 var = Fcar (elt);
875 val = eval_sub (Fcar (Fcdr (elt)));
878 if (!NILP (lexenv) && SYMBOLP (var)
879 && !XSYMBOL (var)->declared_special
880 && NILP (Fmemq (var, Vinternal_interpreter_environment)))
881 /* Lexically bind VAR by adding it to the interpreter's binding
882 alist. */
884 Lisp_Object newenv
885 = Fcons (Fcons (var, val), Vinternal_interpreter_environment);
886 if (EQ (Vinternal_interpreter_environment, lexenv))
887 /* Save the old lexical environment on the specpdl stack,
888 but only for the first lexical binding, since we'll never
889 need to revert to one of the intermediate ones. */
890 specbind (Qinternal_interpreter_environment, newenv);
891 else
892 Vinternal_interpreter_environment = newenv;
894 else
895 specbind (var, val);
897 varlist = XCDR (varlist);
899 UNGCPRO;
900 val = Fprogn (XCDR (args));
901 return unbind_to (count, val);
904 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
905 doc: /* Bind variables according to VARLIST then eval BODY.
906 The value of the last form in BODY is returned.
907 Each element of VARLIST is a symbol (which is bound to nil)
908 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
909 All the VALUEFORMs are evalled before any symbols are bound.
910 usage: (let VARLIST BODY...) */)
911 (Lisp_Object args)
913 Lisp_Object *temps, tem, lexenv;
914 register Lisp_Object elt, varlist;
915 ptrdiff_t count = SPECPDL_INDEX ();
916 ptrdiff_t argnum;
917 struct gcpro gcpro1, gcpro2;
918 USE_SAFE_ALLOCA;
920 varlist = XCAR (args);
922 /* Make space to hold the values to give the bound variables. */
923 elt = Flength (varlist);
924 SAFE_ALLOCA_LISP (temps, XFASTINT (elt));
926 /* Compute the values and store them in `temps'. */
928 GCPRO2 (args, *temps);
929 gcpro2.nvars = 0;
931 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
933 QUIT;
934 elt = XCAR (varlist);
935 if (SYMBOLP (elt))
936 temps [argnum++] = Qnil;
937 else if (! NILP (Fcdr (Fcdr (elt))))
938 signal_error ("`let' bindings can have only one value-form", elt);
939 else
940 temps [argnum++] = eval_sub (Fcar (Fcdr (elt)));
941 gcpro2.nvars = argnum;
943 UNGCPRO;
945 lexenv = Vinternal_interpreter_environment;
947 varlist = XCAR (args);
948 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
950 Lisp_Object var;
952 elt = XCAR (varlist);
953 var = SYMBOLP (elt) ? elt : Fcar (elt);
954 tem = temps[argnum++];
956 if (!NILP (lexenv) && SYMBOLP (var)
957 && !XSYMBOL (var)->declared_special
958 && NILP (Fmemq (var, Vinternal_interpreter_environment)))
959 /* Lexically bind VAR by adding it to the lexenv alist. */
960 lexenv = Fcons (Fcons (var, tem), lexenv);
961 else
962 /* Dynamically bind VAR. */
963 specbind (var, tem);
966 if (!EQ (lexenv, Vinternal_interpreter_environment))
967 /* Instantiate a new lexical environment. */
968 specbind (Qinternal_interpreter_environment, lexenv);
970 elt = Fprogn (XCDR (args));
971 SAFE_FREE ();
972 return unbind_to (count, elt);
975 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
976 doc: /* If TEST yields non-nil, eval BODY... and repeat.
977 The order of execution is thus TEST, BODY, TEST, BODY and so on
978 until TEST returns nil.
979 usage: (while TEST BODY...) */)
980 (Lisp_Object args)
982 Lisp_Object test, body;
983 struct gcpro gcpro1, gcpro2;
985 GCPRO2 (test, body);
987 test = XCAR (args);
988 body = XCDR (args);
989 while (!NILP (eval_sub (test)))
991 QUIT;
992 Fprogn (body);
995 UNGCPRO;
996 return Qnil;
999 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
1000 doc: /* Return result of expanding macros at top level of FORM.
1001 If FORM is not a macro call, it is returned unchanged.
1002 Otherwise, the macro is expanded and the expansion is considered
1003 in place of FORM. When a non-macro-call results, it is returned.
1005 The second optional arg ENVIRONMENT specifies an environment of macro
1006 definitions to shadow the loaded ones for use in file byte-compilation. */)
1007 (Lisp_Object form, Lisp_Object environment)
1009 /* With cleanups from Hallvard Furuseth. */
1010 register Lisp_Object expander, sym, def, tem;
1012 while (1)
1014 /* Come back here each time we expand a macro call,
1015 in case it expands into another macro call. */
1016 if (!CONSP (form))
1017 break;
1018 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1019 def = sym = XCAR (form);
1020 tem = Qnil;
1021 /* Trace symbols aliases to other symbols
1022 until we get a symbol that is not an alias. */
1023 while (SYMBOLP (def))
1025 QUIT;
1026 sym = def;
1027 tem = Fassq (sym, environment);
1028 if (NILP (tem))
1030 def = XSYMBOL (sym)->function;
1031 if (!NILP (def))
1032 continue;
1034 break;
1036 /* Right now TEM is the result from SYM in ENVIRONMENT,
1037 and if TEM is nil then DEF is SYM's function definition. */
1038 if (NILP (tem))
1040 /* SYM is not mentioned in ENVIRONMENT.
1041 Look at its function definition. */
1042 struct gcpro gcpro1;
1043 GCPRO1 (form);
1044 def = Fautoload_do_load (def, sym, Qmacro);
1045 UNGCPRO;
1046 if (!CONSP (def))
1047 /* Not defined or definition not suitable. */
1048 break;
1049 if (!EQ (XCAR (def), Qmacro))
1050 break;
1051 else expander = XCDR (def);
1053 else
1055 expander = XCDR (tem);
1056 if (NILP (expander))
1057 break;
1060 Lisp_Object newform = apply1 (expander, XCDR (form));
1061 if (EQ (form, newform))
1062 break;
1063 else
1064 form = newform;
1067 return form;
1070 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1071 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1072 TAG is evalled to get the tag to use; it must not be nil.
1074 Then the BODY is executed.
1075 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1076 If no throw happens, `catch' returns the value of the last BODY form.
1077 If a throw happens, it specifies the value to return from `catch'.
1078 usage: (catch TAG BODY...) */)
1079 (Lisp_Object args)
1081 register Lisp_Object tag;
1082 struct gcpro gcpro1;
1084 GCPRO1 (args);
1085 tag = eval_sub (XCAR (args));
1086 UNGCPRO;
1087 return internal_catch (tag, Fprogn, XCDR (args));
1090 /* Assert that E is true, as a comment only. Use this instead of
1091 eassert (E) when E contains variables that might be clobbered by a
1092 longjmp. */
1094 #define clobbered_eassert(E) ((void) 0)
1096 /* Set up a catch, then call C function FUNC on argument ARG.
1097 FUNC should return a Lisp_Object.
1098 This is how catches are done from within C code. */
1100 Lisp_Object
1101 internal_catch (Lisp_Object tag, Lisp_Object (*func) (Lisp_Object), Lisp_Object arg)
1103 /* This structure is made part of the chain `catchlist'. */
1104 struct handler *c;
1106 /* Fill in the components of c, and put it on the list. */
1107 PUSH_HANDLER (c, tag, CATCHER);
1109 /* Call FUNC. */
1110 if (! sys_setjmp (c->jmp))
1112 Lisp_Object val = (*func) (arg);
1113 clobbered_eassert (handlerlist == c);
1114 handlerlist = handlerlist->next;
1115 return val;
1117 else
1118 { /* Throw works by a longjmp that comes right here. */
1119 Lisp_Object val = handlerlist->val;
1120 clobbered_eassert (handlerlist == c);
1121 handlerlist = handlerlist->next;
1122 return val;
1126 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1127 jump to that CATCH, returning VALUE as the value of that catch.
1129 This is the guts of Fthrow and Fsignal; they differ only in the way
1130 they choose the catch tag to throw to. A catch tag for a
1131 condition-case form has a TAG of Qnil.
1133 Before each catch is discarded, unbind all special bindings and
1134 execute all unwind-protect clauses made above that catch. Unwind
1135 the handler stack as we go, so that the proper handlers are in
1136 effect for each unwind-protect clause we run. At the end, restore
1137 some static info saved in CATCH, and longjmp to the location
1138 specified there.
1140 This is used for correct unwinding in Fthrow and Fsignal. */
1142 static _Noreturn void
1143 unwind_to_catch (struct handler *catch, Lisp_Object value)
1145 bool last_time;
1147 eassert (catch->next);
1149 /* Save the value in the tag. */
1150 catch->val = value;
1152 /* Restore certain special C variables. */
1153 set_poll_suppress_count (catch->poll_suppress_count);
1154 unblock_input_to (catch->interrupt_input_blocked);
1155 immediate_quit = 0;
1159 /* Unwind the specpdl stack, and then restore the proper set of
1160 handlers. */
1161 unbind_to (handlerlist->pdlcount, Qnil);
1162 last_time = handlerlist == catch;
1163 if (! last_time)
1164 handlerlist = handlerlist->next;
1166 while (! last_time);
1168 eassert (handlerlist == catch);
1170 byte_stack_list = catch->byte_stack;
1171 gcprolist = catch->gcpro;
1172 #ifdef DEBUG_GCPRO
1173 gcpro_level = gcprolist ? gcprolist->level + 1 : 0;
1174 #endif
1175 lisp_eval_depth = catch->lisp_eval_depth;
1177 sys_longjmp (catch->jmp, 1);
1180 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1181 doc: /* Throw to the catch for TAG and return VALUE from it.
1182 Both TAG and VALUE are evalled. */)
1183 (register Lisp_Object tag, Lisp_Object value)
1185 struct handler *c;
1187 if (!NILP (tag))
1188 for (c = handlerlist; c; c = c->next)
1190 if (c->type == CATCHER && EQ (c->tag_or_ch, tag))
1191 unwind_to_catch (c, value);
1193 xsignal2 (Qno_catch, tag, value);
1197 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1198 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1199 If BODYFORM completes normally, its value is returned
1200 after executing the UNWINDFORMS.
1201 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1202 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1203 (Lisp_Object args)
1205 Lisp_Object val;
1206 ptrdiff_t count = SPECPDL_INDEX ();
1208 record_unwind_protect (unwind_body, XCDR (args));
1209 val = eval_sub (XCAR (args));
1210 return unbind_to (count, val);
1213 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1214 doc: /* Regain control when an error is signaled.
1215 Executes BODYFORM and returns its value if no error happens.
1216 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1217 where the BODY is made of Lisp expressions.
1219 A handler is applicable to an error
1220 if CONDITION-NAME is one of the error's condition names.
1221 If an error happens, the first applicable handler is run.
1223 The car of a handler may be a list of condition names instead of a
1224 single condition name; then it handles all of them. If the special
1225 condition name `debug' is present in this list, it allows another
1226 condition in the list to run the debugger if `debug-on-error' and the
1227 other usual mechanisms says it should (otherwise, `condition-case'
1228 suppresses the debugger).
1230 When a handler handles an error, control returns to the `condition-case'
1231 and it executes the handler's BODY...
1232 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1233 \(If VAR is nil, the handler can't access that information.)
1234 Then the value of the last BODY form is returned from the `condition-case'
1235 expression.
1237 See also the function `signal' for more info.
1238 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1239 (Lisp_Object args)
1241 Lisp_Object var = XCAR (args);
1242 Lisp_Object bodyform = XCAR (XCDR (args));
1243 Lisp_Object handlers = XCDR (XCDR (args));
1245 return internal_lisp_condition_case (var, bodyform, handlers);
1248 /* Like Fcondition_case, but the args are separate
1249 rather than passed in a list. Used by Fbyte_code. */
1251 Lisp_Object
1252 internal_lisp_condition_case (volatile Lisp_Object var, Lisp_Object bodyform,
1253 Lisp_Object handlers)
1255 Lisp_Object val;
1256 struct handler *c;
1257 struct handler *oldhandlerlist = handlerlist;
1258 int clausenb = 0;
1260 CHECK_SYMBOL (var);
1262 for (val = handlers; CONSP (val); val = XCDR (val))
1264 Lisp_Object tem = XCAR (val);
1265 clausenb++;
1266 if (! (NILP (tem)
1267 || (CONSP (tem)
1268 && (SYMBOLP (XCAR (tem))
1269 || CONSP (XCAR (tem))))))
1270 error ("Invalid condition handler: %s",
1271 SDATA (Fprin1_to_string (tem, Qt)));
1274 { /* The first clause is the one that should be checked first, so it should
1275 be added to handlerlist last. So we build in `clauses' a table that
1276 contains `handlers' but in reverse order. */
1277 Lisp_Object *clauses = alloca (clausenb * sizeof *clauses);
1278 Lisp_Object *volatile clauses_volatile = clauses;
1279 int i = clausenb;
1280 for (val = handlers; CONSP (val); val = XCDR (val))
1281 clauses[--i] = XCAR (val);
1282 for (i = 0; i < clausenb; i++)
1284 Lisp_Object clause = clauses[i];
1285 Lisp_Object condition = XCAR (clause);
1286 if (!CONSP (condition))
1287 condition = Fcons (condition, Qnil);
1288 PUSH_HANDLER (c, condition, CONDITION_CASE);
1289 if (sys_setjmp (c->jmp))
1291 ptrdiff_t count = SPECPDL_INDEX ();
1292 Lisp_Object val = handlerlist->val;
1293 Lisp_Object *chosen_clause = clauses_volatile;
1294 for (c = handlerlist->next; c != oldhandlerlist; c = c->next)
1295 chosen_clause++;
1296 handlerlist = oldhandlerlist;
1297 if (!NILP (var))
1299 if (!NILP (Vinternal_interpreter_environment))
1300 specbind (Qinternal_interpreter_environment,
1301 Fcons (Fcons (var, val),
1302 Vinternal_interpreter_environment));
1303 else
1304 specbind (var, val);
1306 val = Fprogn (XCDR (*chosen_clause));
1307 /* Note that this just undoes the binding of var; whoever
1308 longjumped to us unwound the stack to c.pdlcount before
1309 throwing. */
1310 if (!NILP (var))
1311 unbind_to (count, Qnil);
1312 return val;
1317 val = eval_sub (bodyform);
1318 handlerlist = oldhandlerlist;
1319 return val;
1322 /* Call the function BFUN with no arguments, catching errors within it
1323 according to HANDLERS. If there is an error, call HFUN with
1324 one argument which is the data that describes the error:
1325 (SIGNALNAME . DATA)
1327 HANDLERS can be a list of conditions to catch.
1328 If HANDLERS is Qt, catch all errors.
1329 If HANDLERS is Qerror, catch all errors
1330 but allow the debugger to run if that is enabled. */
1332 Lisp_Object
1333 internal_condition_case (Lisp_Object (*bfun) (void), Lisp_Object handlers,
1334 Lisp_Object (*hfun) (Lisp_Object))
1336 Lisp_Object val;
1337 struct handler *c;
1339 PUSH_HANDLER (c, handlers, CONDITION_CASE);
1340 if (sys_setjmp (c->jmp))
1342 Lisp_Object val = handlerlist->val;
1343 clobbered_eassert (handlerlist == c);
1344 handlerlist = handlerlist->next;
1345 return (*hfun) (val);
1348 val = (*bfun) ();
1349 clobbered_eassert (handlerlist == c);
1350 handlerlist = handlerlist->next;
1351 return val;
1354 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1356 Lisp_Object
1357 internal_condition_case_1 (Lisp_Object (*bfun) (Lisp_Object), Lisp_Object arg,
1358 Lisp_Object handlers, Lisp_Object (*hfun) (Lisp_Object))
1360 Lisp_Object val;
1361 struct handler *c;
1363 PUSH_HANDLER (c, handlers, CONDITION_CASE);
1364 if (sys_setjmp (c->jmp))
1366 Lisp_Object val = handlerlist->val;
1367 clobbered_eassert (handlerlist == c);
1368 handlerlist = handlerlist->next;
1369 return (*hfun) (val);
1372 val = (*bfun) (arg);
1373 clobbered_eassert (handlerlist == c);
1374 handlerlist = handlerlist->next;
1375 return val;
1378 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1379 its arguments. */
1381 Lisp_Object
1382 internal_condition_case_2 (Lisp_Object (*bfun) (Lisp_Object, Lisp_Object),
1383 Lisp_Object arg1,
1384 Lisp_Object arg2,
1385 Lisp_Object handlers,
1386 Lisp_Object (*hfun) (Lisp_Object))
1388 Lisp_Object val;
1389 struct handler *c;
1391 PUSH_HANDLER (c, handlers, CONDITION_CASE);
1392 if (sys_setjmp (c->jmp))
1394 Lisp_Object val = handlerlist->val;
1395 clobbered_eassert (handlerlist == c);
1396 handlerlist = handlerlist->next;
1397 return (*hfun) (val);
1400 val = (*bfun) (arg1, arg2);
1401 clobbered_eassert (handlerlist == c);
1402 handlerlist = handlerlist->next;
1403 return val;
1406 /* Like internal_condition_case but call BFUN with NARGS as first,
1407 and ARGS as second argument. */
1409 Lisp_Object
1410 internal_condition_case_n (Lisp_Object (*bfun) (ptrdiff_t, Lisp_Object *),
1411 ptrdiff_t nargs,
1412 Lisp_Object *args,
1413 Lisp_Object handlers,
1414 Lisp_Object (*hfun) (Lisp_Object err,
1415 ptrdiff_t nargs,
1416 Lisp_Object *args))
1418 Lisp_Object val;
1419 struct handler *c;
1421 PUSH_HANDLER (c, handlers, CONDITION_CASE);
1422 if (sys_setjmp (c->jmp))
1424 Lisp_Object val = handlerlist->val;
1425 clobbered_eassert (handlerlist == c);
1426 handlerlist = handlerlist->next;
1427 return (*hfun) (val, nargs, args);
1430 val = (*bfun) (nargs, args);
1431 clobbered_eassert (handlerlist == c);
1432 handlerlist = handlerlist->next;
1433 return val;
1437 static Lisp_Object find_handler_clause (Lisp_Object, Lisp_Object);
1438 static bool maybe_call_debugger (Lisp_Object conditions, Lisp_Object sig,
1439 Lisp_Object data);
1441 void
1442 process_quit_flag (void)
1444 Lisp_Object flag = Vquit_flag;
1445 Vquit_flag = Qnil;
1446 if (EQ (flag, Qkill_emacs))
1447 Fkill_emacs (Qnil);
1448 if (EQ (Vthrow_on_input, flag))
1449 Fthrow (Vthrow_on_input, Qt);
1450 Fsignal (Qquit, Qnil);
1453 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1454 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1455 This function does not return.
1457 An error symbol is a symbol with an `error-conditions' property
1458 that is a list of condition names.
1459 A handler for any of those names will get to handle this signal.
1460 The symbol `error' should normally be one of them.
1462 DATA should be a list. Its elements are printed as part of the error message.
1463 See Info anchor `(elisp)Definition of signal' for some details on how this
1464 error message is constructed.
1465 If the signal is handled, DATA is made available to the handler.
1466 See also the function `condition-case'. */)
1467 (Lisp_Object error_symbol, Lisp_Object data)
1469 /* When memory is full, ERROR-SYMBOL is nil,
1470 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1471 That is a special case--don't do this in other situations. */
1472 Lisp_Object conditions;
1473 Lisp_Object string;
1474 Lisp_Object real_error_symbol
1475 = (NILP (error_symbol) ? Fcar (data) : error_symbol);
1476 register Lisp_Object clause = Qnil;
1477 struct handler *h;
1479 immediate_quit = 0;
1480 abort_on_gc = 0;
1481 if (gc_in_progress || waiting_for_input)
1482 emacs_abort ();
1484 #if 0 /* rms: I don't know why this was here,
1485 but it is surely wrong for an error that is handled. */
1486 #ifdef HAVE_WINDOW_SYSTEM
1487 if (display_hourglass_p)
1488 cancel_hourglass ();
1489 #endif
1490 #endif
1492 /* This hook is used by edebug. */
1493 if (! NILP (Vsignal_hook_function)
1494 && ! NILP (error_symbol))
1496 /* Edebug takes care of restoring these variables when it exits. */
1497 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1498 max_lisp_eval_depth = lisp_eval_depth + 20;
1500 if (SPECPDL_INDEX () + 40 > max_specpdl_size)
1501 max_specpdl_size = SPECPDL_INDEX () + 40;
1503 call2 (Vsignal_hook_function, error_symbol, data);
1506 conditions = Fget (real_error_symbol, Qerror_conditions);
1508 /* Remember from where signal was called. Skip over the frame for
1509 `signal' itself. If a frame for `error' follows, skip that,
1510 too. Don't do this when ERROR_SYMBOL is nil, because that
1511 is a memory-full error. */
1512 Vsignaling_function = Qnil;
1513 if (!NILP (error_symbol))
1515 union specbinding *pdl = backtrace_next (backtrace_top ());
1516 if (backtrace_p (pdl) && EQ (backtrace_function (pdl), Qerror))
1517 pdl = backtrace_next (pdl);
1518 if (backtrace_p (pdl))
1519 Vsignaling_function = backtrace_function (pdl);
1522 for (h = handlerlist; h; h = h->next)
1524 if (h->type != CONDITION_CASE)
1525 continue;
1526 clause = find_handler_clause (h->tag_or_ch, conditions);
1527 if (!NILP (clause))
1528 break;
1531 if (/* Don't run the debugger for a memory-full error.
1532 (There is no room in memory to do that!) */
1533 !NILP (error_symbol)
1534 && (!NILP (Vdebug_on_signal)
1535 /* If no handler is present now, try to run the debugger. */
1536 || NILP (clause)
1537 /* A `debug' symbol in the handler list disables the normal
1538 suppression of the debugger. */
1539 || (CONSP (clause) && !NILP (Fmemq (Qdebug, clause)))
1540 /* Special handler that means "print a message and run debugger
1541 if requested". */
1542 || EQ (h->tag_or_ch, Qerror)))
1544 bool debugger_called
1545 = maybe_call_debugger (conditions, error_symbol, data);
1546 /* We can't return values to code which signaled an error, but we
1547 can continue code which has signaled a quit. */
1548 if (debugger_called && EQ (real_error_symbol, Qquit))
1549 return Qnil;
1552 if (!NILP (clause))
1554 Lisp_Object unwind_data
1555 = (NILP (error_symbol) ? data : Fcons (error_symbol, data));
1557 unwind_to_catch (h, unwind_data);
1559 else
1561 if (handlerlist != &handlerlist_sentinel)
1562 /* FIXME: This will come right back here if there's no `top-level'
1563 catcher. A better solution would be to abort here, and instead
1564 add a catch-all condition handler so we never come here. */
1565 Fthrow (Qtop_level, Qt);
1568 if (! NILP (error_symbol))
1569 data = Fcons (error_symbol, data);
1571 string = Ferror_message_string (data);
1572 fatal ("%s", SDATA (string));
1575 /* Internal version of Fsignal that never returns.
1576 Used for anything but Qquit (which can return from Fsignal). */
1578 void
1579 xsignal (Lisp_Object error_symbol, Lisp_Object data)
1581 Fsignal (error_symbol, data);
1582 emacs_abort ();
1585 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1587 void
1588 xsignal0 (Lisp_Object error_symbol)
1590 xsignal (error_symbol, Qnil);
1593 void
1594 xsignal1 (Lisp_Object error_symbol, Lisp_Object arg)
1596 xsignal (error_symbol, list1 (arg));
1599 void
1600 xsignal2 (Lisp_Object error_symbol, Lisp_Object arg1, Lisp_Object arg2)
1602 xsignal (error_symbol, list2 (arg1, arg2));
1605 void
1606 xsignal3 (Lisp_Object error_symbol, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
1608 xsignal (error_symbol, list3 (arg1, arg2, arg3));
1611 /* Signal `error' with message S, and additional arg ARG.
1612 If ARG is not a genuine list, make it a one-element list. */
1614 void
1615 signal_error (const char *s, Lisp_Object arg)
1617 Lisp_Object tortoise, hare;
1619 hare = tortoise = arg;
1620 while (CONSP (hare))
1622 hare = XCDR (hare);
1623 if (!CONSP (hare))
1624 break;
1626 hare = XCDR (hare);
1627 tortoise = XCDR (tortoise);
1629 if (EQ (hare, tortoise))
1630 break;
1633 if (!NILP (hare))
1634 arg = list1 (arg);
1636 xsignal (Qerror, Fcons (build_string (s), arg));
1640 /* Return true if LIST is a non-nil atom or
1641 a list containing one of CONDITIONS. */
1643 static bool
1644 wants_debugger (Lisp_Object list, Lisp_Object conditions)
1646 if (NILP (list))
1647 return 0;
1648 if (! CONSP (list))
1649 return 1;
1651 while (CONSP (conditions))
1653 Lisp_Object this, tail;
1654 this = XCAR (conditions);
1655 for (tail = list; CONSP (tail); tail = XCDR (tail))
1656 if (EQ (XCAR (tail), this))
1657 return 1;
1658 conditions = XCDR (conditions);
1660 return 0;
1663 /* Return true if an error with condition-symbols CONDITIONS,
1664 and described by SIGNAL-DATA, should skip the debugger
1665 according to debugger-ignored-errors. */
1667 static bool
1668 skip_debugger (Lisp_Object conditions, Lisp_Object data)
1670 Lisp_Object tail;
1671 bool first_string = 1;
1672 Lisp_Object error_message;
1674 error_message = Qnil;
1675 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1677 if (STRINGP (XCAR (tail)))
1679 if (first_string)
1681 error_message = Ferror_message_string (data);
1682 first_string = 0;
1685 if (fast_string_match (XCAR (tail), error_message) >= 0)
1686 return 1;
1688 else
1690 Lisp_Object contail;
1692 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1693 if (EQ (XCAR (tail), XCAR (contail)))
1694 return 1;
1698 return 0;
1701 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1702 SIG and DATA describe the signal. There are two ways to pass them:
1703 = SIG is the error symbol, and DATA is the rest of the data.
1704 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1705 This is for memory-full errors only. */
1706 static bool
1707 maybe_call_debugger (Lisp_Object conditions, Lisp_Object sig, Lisp_Object data)
1709 Lisp_Object combined_data;
1711 combined_data = Fcons (sig, data);
1713 if (
1714 /* Don't try to run the debugger with interrupts blocked.
1715 The editing loop would return anyway. */
1716 ! input_blocked_p ()
1717 && NILP (Vinhibit_debugger)
1718 /* Does user want to enter debugger for this kind of error? */
1719 && (EQ (sig, Qquit)
1720 ? debug_on_quit
1721 : wants_debugger (Vdebug_on_error, conditions))
1722 && ! skip_debugger (conditions, combined_data)
1723 /* RMS: What's this for? */
1724 && when_entered_debugger < num_nonmacro_input_events)
1726 call_debugger (list2 (Qerror, combined_data));
1727 return 1;
1730 return 0;
1733 static Lisp_Object
1734 find_handler_clause (Lisp_Object handlers, Lisp_Object conditions)
1736 register Lisp_Object h;
1738 /* t is used by handlers for all conditions, set up by C code. */
1739 if (EQ (handlers, Qt))
1740 return Qt;
1742 /* error is used similarly, but means print an error message
1743 and run the debugger if that is enabled. */
1744 if (EQ (handlers, Qerror))
1745 return Qt;
1747 for (h = handlers; CONSP (h); h = XCDR (h))
1749 Lisp_Object handler = XCAR (h);
1750 if (!NILP (Fmemq (handler, conditions)))
1751 return handlers;
1754 return Qnil;
1758 /* Dump an error message; called like vprintf. */
1759 void
1760 verror (const char *m, va_list ap)
1762 char buf[4000];
1763 ptrdiff_t size = sizeof buf;
1764 ptrdiff_t size_max = STRING_BYTES_BOUND + 1;
1765 char *buffer = buf;
1766 ptrdiff_t used;
1767 Lisp_Object string;
1769 used = evxprintf (&buffer, &size, buf, size_max, m, ap);
1770 string = make_string (buffer, used);
1771 if (buffer != buf)
1772 xfree (buffer);
1774 xsignal1 (Qerror, string);
1778 /* Dump an error message; called like printf. */
1780 /* VARARGS 1 */
1781 void
1782 error (const char *m, ...)
1784 va_list ap;
1785 va_start (ap, m);
1786 verror (m, ap);
1789 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
1790 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
1791 This means it contains a description for how to read arguments to give it.
1792 The value is nil for an invalid function or a symbol with no function
1793 definition.
1795 Interactively callable functions include strings and vectors (treated
1796 as keyboard macros), lambda-expressions that contain a top-level call
1797 to `interactive', autoload definitions made by `autoload' with non-nil
1798 fourth argument, and some of the built-in functions of Lisp.
1800 Also, a symbol satisfies `commandp' if its function definition does so.
1802 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1803 then strings and vectors are not accepted. */)
1804 (Lisp_Object function, Lisp_Object for_call_interactively)
1806 register Lisp_Object fun;
1807 register Lisp_Object funcar;
1808 Lisp_Object if_prop = Qnil;
1810 fun = function;
1812 fun = indirect_function (fun); /* Check cycles. */
1813 if (NILP (fun))
1814 return Qnil;
1816 /* Check an `interactive-form' property if present, analogous to the
1817 function-documentation property. */
1818 fun = function;
1819 while (SYMBOLP (fun))
1821 Lisp_Object tmp = Fget (fun, Qinteractive_form);
1822 if (!NILP (tmp))
1823 if_prop = Qt;
1824 fun = Fsymbol_function (fun);
1827 /* Emacs primitives are interactive if their DEFUN specifies an
1828 interactive spec. */
1829 if (SUBRP (fun))
1830 return XSUBR (fun)->intspec ? Qt : if_prop;
1832 /* Bytecode objects are interactive if they are long enough to
1833 have an element whose index is COMPILED_INTERACTIVE, which is
1834 where the interactive spec is stored. */
1835 else if (COMPILEDP (fun))
1836 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
1837 ? Qt : if_prop);
1839 /* Strings and vectors are keyboard macros. */
1840 if (STRINGP (fun) || VECTORP (fun))
1841 return (NILP (for_call_interactively) ? Qt : Qnil);
1843 /* Lists may represent commands. */
1844 if (!CONSP (fun))
1845 return Qnil;
1846 funcar = XCAR (fun);
1847 if (EQ (funcar, Qclosure))
1848 return (!NILP (Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun)))))
1849 ? Qt : if_prop);
1850 else if (EQ (funcar, Qlambda))
1851 return !NILP (Fassq (Qinteractive, Fcdr (XCDR (fun)))) ? Qt : if_prop;
1852 else if (EQ (funcar, Qautoload))
1853 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun))))) ? Qt : if_prop;
1854 else
1855 return Qnil;
1858 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1859 doc: /* Define FUNCTION to autoload from FILE.
1860 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1861 Third arg DOCSTRING is documentation for the function.
1862 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1863 Fifth arg TYPE indicates the type of the object:
1864 nil or omitted says FUNCTION is a function,
1865 `keymap' says FUNCTION is really a keymap, and
1866 `macro' or t says FUNCTION is really a macro.
1867 Third through fifth args give info about the real definition.
1868 They default to nil.
1869 If FUNCTION is already defined other than as an autoload,
1870 this does nothing and returns nil. */)
1871 (Lisp_Object function, Lisp_Object file, Lisp_Object docstring, Lisp_Object interactive, Lisp_Object type)
1873 CHECK_SYMBOL (function);
1874 CHECK_STRING (file);
1876 /* If function is defined and not as an autoload, don't override. */
1877 if (!NILP (XSYMBOL (function)->function)
1878 && !AUTOLOADP (XSYMBOL (function)->function))
1879 return Qnil;
1881 if (!NILP (Vpurify_flag) && EQ (docstring, make_number (0)))
1882 /* `read1' in lread.c has found the docstring starting with "\
1883 and assumed the docstring will be provided by Snarf-documentation, so it
1884 passed us 0 instead. But that leads to accidental sharing in purecopy's
1885 hash-consing, so we use a (hopefully) unique integer instead. */
1886 docstring = make_number (XHASH (function));
1887 return Fdefalias (function,
1888 list5 (Qautoload, file, docstring, interactive, type),
1889 Qnil);
1892 void
1893 un_autoload (Lisp_Object oldqueue)
1895 Lisp_Object queue, first, second;
1897 /* Queue to unwind is current value of Vautoload_queue.
1898 oldqueue is the shadowed value to leave in Vautoload_queue. */
1899 queue = Vautoload_queue;
1900 Vautoload_queue = oldqueue;
1901 while (CONSP (queue))
1903 first = XCAR (queue);
1904 second = Fcdr (first);
1905 first = Fcar (first);
1906 if (EQ (first, make_number (0)))
1907 Vfeatures = second;
1908 else
1909 Ffset (first, second);
1910 queue = XCDR (queue);
1914 /* Load an autoloaded function.
1915 FUNNAME is the symbol which is the function's name.
1916 FUNDEF is the autoload definition (a list). */
1918 DEFUN ("autoload-do-load", Fautoload_do_load, Sautoload_do_load, 1, 3, 0,
1919 doc: /* Load FUNDEF which should be an autoload.
1920 If non-nil, FUNNAME should be the symbol whose function value is FUNDEF,
1921 in which case the function returns the new autoloaded function value.
1922 If equal to `macro', MACRO-ONLY specifies that FUNDEF should only be loaded if
1923 it defines a macro. */)
1924 (Lisp_Object fundef, Lisp_Object funname, Lisp_Object macro_only)
1926 ptrdiff_t count = SPECPDL_INDEX ();
1927 struct gcpro gcpro1, gcpro2, gcpro3;
1929 if (!CONSP (fundef) || !EQ (Qautoload, XCAR (fundef)))
1930 return fundef;
1932 if (EQ (macro_only, Qmacro))
1934 Lisp_Object kind = Fnth (make_number (4), fundef);
1935 if (! (EQ (kind, Qt) || EQ (kind, Qmacro)))
1936 return fundef;
1939 /* This is to make sure that loadup.el gives a clear picture
1940 of what files are preloaded and when. */
1941 if (! NILP (Vpurify_flag))
1942 error ("Attempt to autoload %s while preparing to dump",
1943 SDATA (SYMBOL_NAME (funname)));
1945 CHECK_SYMBOL (funname);
1946 GCPRO3 (funname, fundef, macro_only);
1948 /* Preserve the match data. */
1949 record_unwind_save_match_data ();
1951 /* If autoloading gets an error (which includes the error of failing
1952 to define the function being called), we use Vautoload_queue
1953 to undo function definitions and `provide' calls made by
1954 the function. We do this in the specific case of autoloading
1955 because autoloading is not an explicit request "load this file",
1956 but rather a request to "call this function".
1958 The value saved here is to be restored into Vautoload_queue. */
1959 record_unwind_protect (un_autoload, Vautoload_queue);
1960 Vautoload_queue = Qt;
1961 /* If `macro_only', assume this autoload to be a "best-effort",
1962 so don't signal an error if autoloading fails. */
1963 Fload (Fcar (Fcdr (fundef)), macro_only, Qt, Qnil, Qt);
1965 /* Once loading finishes, don't undo it. */
1966 Vautoload_queue = Qt;
1967 unbind_to (count, Qnil);
1969 UNGCPRO;
1971 if (NILP (funname))
1972 return Qnil;
1973 else
1975 Lisp_Object fun = Findirect_function (funname, Qnil);
1977 if (!NILP (Fequal (fun, fundef)))
1978 error ("Autoloading failed to define function %s",
1979 SDATA (SYMBOL_NAME (funname)));
1980 else
1981 return fun;
1986 DEFUN ("eval", Feval, Seval, 1, 2, 0,
1987 doc: /* Evaluate FORM and return its value.
1988 If LEXICAL is t, evaluate using lexical scoping.
1989 LEXICAL can also be an actual lexical environment, in the form of an
1990 alist mapping symbols to their value. */)
1991 (Lisp_Object form, Lisp_Object lexical)
1993 ptrdiff_t count = SPECPDL_INDEX ();
1994 specbind (Qinternal_interpreter_environment,
1995 CONSP (lexical) || NILP (lexical) ? lexical : list1 (Qt));
1996 return unbind_to (count, eval_sub (form));
1999 /* Grow the specpdl stack by one entry.
2000 The caller should have already initialized the entry.
2001 Signal an error on stack overflow.
2003 Make sure that there is always one unused entry past the top of the
2004 stack, so that the just-initialized entry is safely unwound if
2005 memory exhausted and an error is signaled here. Also, allocate a
2006 never-used entry just before the bottom of the stack; sometimes its
2007 address is taken. */
2009 static void
2010 grow_specpdl (void)
2012 specpdl_ptr++;
2014 if (specpdl_ptr == specpdl + specpdl_size)
2016 ptrdiff_t count = SPECPDL_INDEX ();
2017 ptrdiff_t max_size = min (max_specpdl_size, PTRDIFF_MAX - 1000);
2018 union specbinding *pdlvec = specpdl - 1;
2019 ptrdiff_t pdlvecsize = specpdl_size + 1;
2020 if (max_size <= specpdl_size)
2022 if (max_specpdl_size < 400)
2023 max_size = max_specpdl_size = 400;
2024 if (max_size <= specpdl_size)
2025 signal_error ("Variable binding depth exceeds max-specpdl-size",
2026 Qnil);
2028 pdlvec = xpalloc (pdlvec, &pdlvecsize, 1, max_size + 1, sizeof *specpdl);
2029 specpdl = pdlvec + 1;
2030 specpdl_size = pdlvecsize - 1;
2031 specpdl_ptr = specpdl + count;
2035 ptrdiff_t
2036 record_in_backtrace (Lisp_Object function, Lisp_Object *args, ptrdiff_t nargs)
2038 ptrdiff_t count = SPECPDL_INDEX ();
2040 eassert (nargs >= UNEVALLED);
2041 specpdl_ptr->bt.kind = SPECPDL_BACKTRACE;
2042 specpdl_ptr->bt.debug_on_exit = false;
2043 specpdl_ptr->bt.function = function;
2044 specpdl_ptr->bt.args = args;
2045 specpdl_ptr->bt.nargs = nargs;
2046 grow_specpdl ();
2048 return count;
2051 /* Eval a sub-expression of the current expression (i.e. in the same
2052 lexical scope). */
2053 Lisp_Object
2054 eval_sub (Lisp_Object form)
2056 Lisp_Object fun, val, original_fun, original_args;
2057 Lisp_Object funcar;
2058 struct gcpro gcpro1, gcpro2, gcpro3;
2059 ptrdiff_t count;
2061 if (SYMBOLP (form))
2063 /* Look up its binding in the lexical environment.
2064 We do not pay attention to the declared_special flag here, since we
2065 already did that when let-binding the variable. */
2066 Lisp_Object lex_binding
2067 = !NILP (Vinternal_interpreter_environment) /* Mere optimization! */
2068 ? Fassq (form, Vinternal_interpreter_environment)
2069 : Qnil;
2070 if (CONSP (lex_binding))
2071 return XCDR (lex_binding);
2072 else
2073 return Fsymbol_value (form);
2076 if (!CONSP (form))
2077 return form;
2079 QUIT;
2081 GCPRO1 (form);
2082 maybe_gc ();
2083 UNGCPRO;
2085 if (++lisp_eval_depth > max_lisp_eval_depth)
2087 if (max_lisp_eval_depth < 100)
2088 max_lisp_eval_depth = 100;
2089 if (lisp_eval_depth > max_lisp_eval_depth)
2090 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2093 original_fun = XCAR (form);
2094 original_args = XCDR (form);
2096 /* This also protects them from gc. */
2097 count = record_in_backtrace (original_fun, &original_args, UNEVALLED);
2099 if (debug_on_next_call)
2100 do_debug_on_call (Qt, count);
2102 /* At this point, only original_fun and original_args
2103 have values that will be used below. */
2104 retry:
2106 /* Optimize for no indirection. */
2107 fun = original_fun;
2108 if (!SYMBOLP (fun))
2109 fun = Ffunction (Fcons (fun, Qnil));
2110 else if (!NILP (fun) && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2111 fun = indirect_function (fun);
2113 if (SUBRP (fun))
2115 Lisp_Object numargs;
2116 Lisp_Object argvals[8];
2117 Lisp_Object args_left;
2118 register int i, maxargs;
2120 args_left = original_args;
2121 numargs = Flength (args_left);
2123 check_cons_list ();
2125 if (XINT (numargs) < XSUBR (fun)->min_args
2126 || (XSUBR (fun)->max_args >= 0
2127 && XSUBR (fun)->max_args < XINT (numargs)))
2128 xsignal2 (Qwrong_number_of_arguments, original_fun, numargs);
2130 else if (XSUBR (fun)->max_args == UNEVALLED)
2131 val = (XSUBR (fun)->function.aUNEVALLED) (args_left);
2132 else if (XSUBR (fun)->max_args == MANY)
2134 /* Pass a vector of evaluated arguments. */
2135 Lisp_Object *vals;
2136 ptrdiff_t argnum = 0;
2137 USE_SAFE_ALLOCA;
2139 SAFE_ALLOCA_LISP (vals, XINT (numargs));
2141 GCPRO3 (args_left, fun, fun);
2142 gcpro3.var = vals;
2143 gcpro3.nvars = 0;
2145 while (!NILP (args_left))
2147 vals[argnum++] = eval_sub (Fcar (args_left));
2148 args_left = Fcdr (args_left);
2149 gcpro3.nvars = argnum;
2152 set_backtrace_args (specpdl + count, vals, XINT (numargs));
2154 val = (XSUBR (fun)->function.aMANY) (XINT (numargs), vals);
2155 UNGCPRO;
2156 SAFE_FREE ();
2158 else
2160 GCPRO3 (args_left, fun, fun);
2161 gcpro3.var = argvals;
2162 gcpro3.nvars = 0;
2164 maxargs = XSUBR (fun)->max_args;
2165 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2167 argvals[i] = eval_sub (Fcar (args_left));
2168 gcpro3.nvars = ++i;
2171 UNGCPRO;
2173 set_backtrace_args (specpdl + count, argvals, XINT (numargs));
2175 switch (i)
2177 case 0:
2178 val = (XSUBR (fun)->function.a0 ());
2179 break;
2180 case 1:
2181 val = (XSUBR (fun)->function.a1 (argvals[0]));
2182 break;
2183 case 2:
2184 val = (XSUBR (fun)->function.a2 (argvals[0], argvals[1]));
2185 break;
2186 case 3:
2187 val = (XSUBR (fun)->function.a3
2188 (argvals[0], argvals[1], argvals[2]));
2189 break;
2190 case 4:
2191 val = (XSUBR (fun)->function.a4
2192 (argvals[0], argvals[1], argvals[2], argvals[3]));
2193 break;
2194 case 5:
2195 val = (XSUBR (fun)->function.a5
2196 (argvals[0], argvals[1], argvals[2], argvals[3],
2197 argvals[4]));
2198 break;
2199 case 6:
2200 val = (XSUBR (fun)->function.a6
2201 (argvals[0], argvals[1], argvals[2], argvals[3],
2202 argvals[4], argvals[5]));
2203 break;
2204 case 7:
2205 val = (XSUBR (fun)->function.a7
2206 (argvals[0], argvals[1], argvals[2], argvals[3],
2207 argvals[4], argvals[5], argvals[6]));
2208 break;
2210 case 8:
2211 val = (XSUBR (fun)->function.a8
2212 (argvals[0], argvals[1], argvals[2], argvals[3],
2213 argvals[4], argvals[5], argvals[6], argvals[7]));
2214 break;
2216 default:
2217 /* Someone has created a subr that takes more arguments than
2218 is supported by this code. We need to either rewrite the
2219 subr to use a different argument protocol, or add more
2220 cases to this switch. */
2221 emacs_abort ();
2225 else if (COMPILEDP (fun))
2226 val = apply_lambda (fun, original_args, count);
2227 else
2229 if (NILP (fun))
2230 xsignal1 (Qvoid_function, original_fun);
2231 if (!CONSP (fun))
2232 xsignal1 (Qinvalid_function, original_fun);
2233 funcar = XCAR (fun);
2234 if (!SYMBOLP (funcar))
2235 xsignal1 (Qinvalid_function, original_fun);
2236 if (EQ (funcar, Qautoload))
2238 Fautoload_do_load (fun, original_fun, Qnil);
2239 goto retry;
2241 if (EQ (funcar, Qmacro))
2243 ptrdiff_t count1 = SPECPDL_INDEX ();
2244 Lisp_Object exp;
2245 /* Bind lexical-binding during expansion of the macro, so the
2246 macro can know reliably if the code it outputs will be
2247 interpreted using lexical-binding or not. */
2248 specbind (Qlexical_binding,
2249 NILP (Vinternal_interpreter_environment) ? Qnil : Qt);
2250 exp = apply1 (Fcdr (fun), original_args);
2251 unbind_to (count1, Qnil);
2252 val = eval_sub (exp);
2254 else if (EQ (funcar, Qlambda)
2255 || EQ (funcar, Qclosure))
2256 val = apply_lambda (fun, original_args, count);
2257 else
2258 xsignal1 (Qinvalid_function, original_fun);
2260 check_cons_list ();
2262 lisp_eval_depth--;
2263 if (backtrace_debug_on_exit (specpdl + count))
2264 val = call_debugger (list2 (Qexit, val));
2265 specpdl_ptr--;
2267 return val;
2270 DEFUN ("apply", Fapply, Sapply, 1, MANY, 0,
2271 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2272 Then return the value FUNCTION returns.
2273 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2274 usage: (apply FUNCTION &rest ARGUMENTS) */)
2275 (ptrdiff_t nargs, Lisp_Object *args)
2277 ptrdiff_t i;
2278 EMACS_INT numargs;
2279 register Lisp_Object spread_arg;
2280 register Lisp_Object *funcall_args;
2281 Lisp_Object fun, retval;
2282 struct gcpro gcpro1;
2283 USE_SAFE_ALLOCA;
2285 fun = args [0];
2286 funcall_args = 0;
2287 spread_arg = args [nargs - 1];
2288 CHECK_LIST (spread_arg);
2290 numargs = XINT (Flength (spread_arg));
2292 if (numargs == 0)
2293 return Ffuncall (nargs - 1, args);
2294 else if (numargs == 1)
2296 args [nargs - 1] = XCAR (spread_arg);
2297 return Ffuncall (nargs, args);
2300 numargs += nargs - 2;
2302 /* Optimize for no indirection. */
2303 if (SYMBOLP (fun) && !NILP (fun)
2304 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2305 fun = indirect_function (fun);
2306 if (NILP (fun))
2308 /* Let funcall get the error. */
2309 fun = args[0];
2310 goto funcall;
2313 if (SUBRP (fun))
2315 if (numargs < XSUBR (fun)->min_args
2316 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2317 goto funcall; /* Let funcall get the error. */
2318 else if (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args > numargs)
2320 /* Avoid making funcall cons up a yet another new vector of arguments
2321 by explicitly supplying nil's for optional values. */
2322 SAFE_ALLOCA_LISP (funcall_args, 1 + XSUBR (fun)->max_args);
2323 for (i = numargs; i < XSUBR (fun)->max_args;)
2324 funcall_args[++i] = Qnil;
2325 GCPRO1 (*funcall_args);
2326 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2329 funcall:
2330 /* We add 1 to numargs because funcall_args includes the
2331 function itself as well as its arguments. */
2332 if (!funcall_args)
2334 SAFE_ALLOCA_LISP (funcall_args, 1 + numargs);
2335 GCPRO1 (*funcall_args);
2336 gcpro1.nvars = 1 + numargs;
2339 memcpy (funcall_args, args, nargs * word_size);
2340 /* Spread the last arg we got. Its first element goes in
2341 the slot that it used to occupy, hence this value of I. */
2342 i = nargs - 1;
2343 while (!NILP (spread_arg))
2345 funcall_args [i++] = XCAR (spread_arg);
2346 spread_arg = XCDR (spread_arg);
2349 /* By convention, the caller needs to gcpro Ffuncall's args. */
2350 retval = Ffuncall (gcpro1.nvars, funcall_args);
2351 UNGCPRO;
2352 SAFE_FREE ();
2354 return retval;
2357 /* Run hook variables in various ways. */
2359 static Lisp_Object
2360 funcall_nil (ptrdiff_t nargs, Lisp_Object *args)
2362 Ffuncall (nargs, args);
2363 return Qnil;
2366 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2367 doc: /* Run each hook in HOOKS.
2368 Each argument should be a symbol, a hook variable.
2369 These symbols are processed in the order specified.
2370 If a hook symbol has a non-nil value, that value may be a function
2371 or a list of functions to be called to run the hook.
2372 If the value is a function, it is called with no arguments.
2373 If it is a list, the elements are called, in order, with no arguments.
2375 Major modes should not use this function directly to run their mode
2376 hook; they should use `run-mode-hooks' instead.
2378 Do not use `make-local-variable' to make a hook variable buffer-local.
2379 Instead, use `add-hook' and specify t for the LOCAL argument.
2380 usage: (run-hooks &rest HOOKS) */)
2381 (ptrdiff_t nargs, Lisp_Object *args)
2383 Lisp_Object hook[1];
2384 ptrdiff_t i;
2386 for (i = 0; i < nargs; i++)
2388 hook[0] = args[i];
2389 run_hook_with_args (1, hook, funcall_nil);
2392 return Qnil;
2395 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2396 Srun_hook_with_args, 1, MANY, 0,
2397 doc: /* Run HOOK with the specified arguments ARGS.
2398 HOOK should be a symbol, a hook variable. The value of HOOK
2399 may be nil, a function, or a list of functions. Call each
2400 function in order with arguments ARGS. The final return value
2401 is unspecified.
2403 Do not use `make-local-variable' to make a hook variable buffer-local.
2404 Instead, use `add-hook' and specify t for the LOCAL argument.
2405 usage: (run-hook-with-args HOOK &rest ARGS) */)
2406 (ptrdiff_t nargs, Lisp_Object *args)
2408 return run_hook_with_args (nargs, args, funcall_nil);
2411 /* NB this one still documents a specific non-nil return value.
2412 (As did run-hook-with-args and run-hook-with-args-until-failure
2413 until they were changed in 24.1.) */
2414 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2415 Srun_hook_with_args_until_success, 1, MANY, 0,
2416 doc: /* Run HOOK with the specified arguments ARGS.
2417 HOOK should be a symbol, a hook variable. The value of HOOK
2418 may be nil, a function, or a list of functions. Call each
2419 function in order with arguments ARGS, stopping at the first
2420 one that returns non-nil, and return that value. Otherwise (if
2421 all functions return nil, or if there are no functions to call),
2422 return nil.
2424 Do not use `make-local-variable' to make a hook variable buffer-local.
2425 Instead, use `add-hook' and specify t for the LOCAL argument.
2426 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2427 (ptrdiff_t nargs, Lisp_Object *args)
2429 return run_hook_with_args (nargs, args, Ffuncall);
2432 static Lisp_Object
2433 funcall_not (ptrdiff_t nargs, Lisp_Object *args)
2435 return NILP (Ffuncall (nargs, args)) ? Qt : Qnil;
2438 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2439 Srun_hook_with_args_until_failure, 1, MANY, 0,
2440 doc: /* Run HOOK with the specified arguments ARGS.
2441 HOOK should be a symbol, a hook variable. The value of HOOK
2442 may be nil, a function, or a list of functions. Call each
2443 function in order with arguments ARGS, stopping at the first
2444 one that returns nil, and return nil. Otherwise (if all functions
2445 return non-nil, or if there are no functions to call), return non-nil
2446 \(do not rely on the precise return value in this case).
2448 Do not use `make-local-variable' to make a hook variable buffer-local.
2449 Instead, use `add-hook' and specify t for the LOCAL argument.
2450 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2451 (ptrdiff_t nargs, Lisp_Object *args)
2453 return NILP (run_hook_with_args (nargs, args, funcall_not)) ? Qt : Qnil;
2456 static Lisp_Object
2457 run_hook_wrapped_funcall (ptrdiff_t nargs, Lisp_Object *args)
2459 Lisp_Object tmp = args[0], ret;
2460 args[0] = args[1];
2461 args[1] = tmp;
2462 ret = Ffuncall (nargs, args);
2463 args[1] = args[0];
2464 args[0] = tmp;
2465 return ret;
2468 DEFUN ("run-hook-wrapped", Frun_hook_wrapped, Srun_hook_wrapped, 2, MANY, 0,
2469 doc: /* Run HOOK, passing each function through WRAP-FUNCTION.
2470 I.e. instead of calling each function FUN directly with arguments ARGS,
2471 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2472 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2473 aborts and returns that value.
2474 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2475 (ptrdiff_t nargs, Lisp_Object *args)
2477 return run_hook_with_args (nargs, args, run_hook_wrapped_funcall);
2480 /* ARGS[0] should be a hook symbol.
2481 Call each of the functions in the hook value, passing each of them
2482 as arguments all the rest of ARGS (all NARGS - 1 elements).
2483 FUNCALL specifies how to call each function on the hook.
2484 The caller (or its caller, etc) must gcpro all of ARGS,
2485 except that it isn't necessary to gcpro ARGS[0]. */
2487 Lisp_Object
2488 run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
2489 Lisp_Object (*funcall) (ptrdiff_t nargs, Lisp_Object *args))
2491 Lisp_Object sym, val, ret = Qnil;
2492 struct gcpro gcpro1, gcpro2, gcpro3;
2494 /* If we are dying or still initializing,
2495 don't do anything--it would probably crash if we tried. */
2496 if (NILP (Vrun_hooks))
2497 return Qnil;
2499 sym = args[0];
2500 val = find_symbol_value (sym);
2502 if (EQ (val, Qunbound) || NILP (val))
2503 return ret;
2504 else if (!CONSP (val) || FUNCTIONP (val))
2506 args[0] = val;
2507 return funcall (nargs, args);
2509 else
2511 Lisp_Object global_vals = Qnil;
2512 GCPRO3 (sym, val, global_vals);
2514 for (;
2515 CONSP (val) && NILP (ret);
2516 val = XCDR (val))
2518 if (EQ (XCAR (val), Qt))
2520 /* t indicates this hook has a local binding;
2521 it means to run the global binding too. */
2522 global_vals = Fdefault_value (sym);
2523 if (NILP (global_vals)) continue;
2525 if (!CONSP (global_vals) || EQ (XCAR (global_vals), Qlambda))
2527 args[0] = global_vals;
2528 ret = funcall (nargs, args);
2530 else
2532 for (;
2533 CONSP (global_vals) && NILP (ret);
2534 global_vals = XCDR (global_vals))
2536 args[0] = XCAR (global_vals);
2537 /* In a global value, t should not occur. If it does, we
2538 must ignore it to avoid an endless loop. */
2539 if (!EQ (args[0], Qt))
2540 ret = funcall (nargs, args);
2544 else
2546 args[0] = XCAR (val);
2547 ret = funcall (nargs, args);
2551 UNGCPRO;
2552 return ret;
2556 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2558 void
2559 run_hook_with_args_2 (Lisp_Object hook, Lisp_Object arg1, Lisp_Object arg2)
2561 Lisp_Object temp[3];
2562 temp[0] = hook;
2563 temp[1] = arg1;
2564 temp[2] = arg2;
2566 Frun_hook_with_args (3, temp);
2569 /* Apply fn to arg. */
2570 Lisp_Object
2571 apply1 (Lisp_Object fn, Lisp_Object arg)
2573 struct gcpro gcpro1;
2575 GCPRO1 (fn);
2576 if (NILP (arg))
2577 RETURN_UNGCPRO (Ffuncall (1, &fn));
2578 gcpro1.nvars = 2;
2580 Lisp_Object args[2];
2581 args[0] = fn;
2582 args[1] = arg;
2583 gcpro1.var = args;
2584 RETURN_UNGCPRO (Fapply (2, args));
2588 /* Call function fn on no arguments. */
2589 Lisp_Object
2590 call0 (Lisp_Object fn)
2592 struct gcpro gcpro1;
2594 GCPRO1 (fn);
2595 RETURN_UNGCPRO (Ffuncall (1, &fn));
2598 /* Call function fn with 1 argument arg1. */
2599 /* ARGSUSED */
2600 Lisp_Object
2601 call1 (Lisp_Object fn, Lisp_Object arg1)
2603 struct gcpro gcpro1;
2604 Lisp_Object args[2];
2606 args[0] = fn;
2607 args[1] = arg1;
2608 GCPRO1 (args[0]);
2609 gcpro1.nvars = 2;
2610 RETURN_UNGCPRO (Ffuncall (2, args));
2613 /* Call function fn with 2 arguments arg1, arg2. */
2614 /* ARGSUSED */
2615 Lisp_Object
2616 call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2618 struct gcpro gcpro1;
2619 Lisp_Object args[3];
2620 args[0] = fn;
2621 args[1] = arg1;
2622 args[2] = arg2;
2623 GCPRO1 (args[0]);
2624 gcpro1.nvars = 3;
2625 RETURN_UNGCPRO (Ffuncall (3, args));
2628 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2629 /* ARGSUSED */
2630 Lisp_Object
2631 call3 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
2633 struct gcpro gcpro1;
2634 Lisp_Object args[4];
2635 args[0] = fn;
2636 args[1] = arg1;
2637 args[2] = arg2;
2638 args[3] = arg3;
2639 GCPRO1 (args[0]);
2640 gcpro1.nvars = 4;
2641 RETURN_UNGCPRO (Ffuncall (4, args));
2644 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2645 /* ARGSUSED */
2646 Lisp_Object
2647 call4 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2648 Lisp_Object arg4)
2650 struct gcpro gcpro1;
2651 Lisp_Object args[5];
2652 args[0] = fn;
2653 args[1] = arg1;
2654 args[2] = arg2;
2655 args[3] = arg3;
2656 args[4] = arg4;
2657 GCPRO1 (args[0]);
2658 gcpro1.nvars = 5;
2659 RETURN_UNGCPRO (Ffuncall (5, args));
2662 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2663 /* ARGSUSED */
2664 Lisp_Object
2665 call5 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2666 Lisp_Object arg4, Lisp_Object arg5)
2668 struct gcpro gcpro1;
2669 Lisp_Object args[6];
2670 args[0] = fn;
2671 args[1] = arg1;
2672 args[2] = arg2;
2673 args[3] = arg3;
2674 args[4] = arg4;
2675 args[5] = arg5;
2676 GCPRO1 (args[0]);
2677 gcpro1.nvars = 6;
2678 RETURN_UNGCPRO (Ffuncall (6, args));
2681 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2682 /* ARGSUSED */
2683 Lisp_Object
2684 call6 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2685 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6)
2687 struct gcpro gcpro1;
2688 Lisp_Object args[7];
2689 args[0] = fn;
2690 args[1] = arg1;
2691 args[2] = arg2;
2692 args[3] = arg3;
2693 args[4] = arg4;
2694 args[5] = arg5;
2695 args[6] = arg6;
2696 GCPRO1 (args[0]);
2697 gcpro1.nvars = 7;
2698 RETURN_UNGCPRO (Ffuncall (7, args));
2701 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2702 /* ARGSUSED */
2703 Lisp_Object
2704 call7 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2705 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6, Lisp_Object arg7)
2707 struct gcpro gcpro1;
2708 Lisp_Object args[8];
2709 args[0] = fn;
2710 args[1] = arg1;
2711 args[2] = arg2;
2712 args[3] = arg3;
2713 args[4] = arg4;
2714 args[5] = arg5;
2715 args[6] = arg6;
2716 args[7] = arg7;
2717 GCPRO1 (args[0]);
2718 gcpro1.nvars = 8;
2719 RETURN_UNGCPRO (Ffuncall (8, args));
2722 /* The caller should GCPRO all the elements of ARGS. */
2724 DEFUN ("functionp", Ffunctionp, Sfunctionp, 1, 1, 0,
2725 doc: /* Non-nil if OBJECT is a function. */)
2726 (Lisp_Object object)
2728 if (FUNCTIONP (object))
2729 return Qt;
2730 return Qnil;
2733 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2734 doc: /* Call first argument as a function, passing remaining arguments to it.
2735 Return the value that function returns.
2736 Thus, (funcall 'cons 'x 'y) returns (x . y).
2737 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2738 (ptrdiff_t nargs, Lisp_Object *args)
2740 Lisp_Object fun, original_fun;
2741 Lisp_Object funcar;
2742 ptrdiff_t numargs = nargs - 1;
2743 Lisp_Object lisp_numargs;
2744 Lisp_Object val;
2745 register Lisp_Object *internal_args;
2746 ptrdiff_t i, count;
2748 QUIT;
2750 if (++lisp_eval_depth > max_lisp_eval_depth)
2752 if (max_lisp_eval_depth < 100)
2753 max_lisp_eval_depth = 100;
2754 if (lisp_eval_depth > max_lisp_eval_depth)
2755 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2758 /* This also GCPROs them. */
2759 count = record_in_backtrace (args[0], &args[1], nargs - 1);
2761 /* Call GC after setting up the backtrace, so the latter GCPROs the args. */
2762 maybe_gc ();
2764 if (debug_on_next_call)
2765 do_debug_on_call (Qlambda, count);
2767 check_cons_list ();
2769 original_fun = args[0];
2771 retry:
2773 /* Optimize for no indirection. */
2774 fun = original_fun;
2775 if (SYMBOLP (fun) && !NILP (fun)
2776 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2777 fun = indirect_function (fun);
2779 if (SUBRP (fun))
2781 if (numargs < XSUBR (fun)->min_args
2782 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2784 XSETFASTINT (lisp_numargs, numargs);
2785 xsignal2 (Qwrong_number_of_arguments, original_fun, lisp_numargs);
2788 else if (XSUBR (fun)->max_args == UNEVALLED)
2789 xsignal1 (Qinvalid_function, original_fun);
2791 else if (XSUBR (fun)->max_args == MANY)
2792 val = (XSUBR (fun)->function.aMANY) (numargs, args + 1);
2793 else
2795 if (XSUBR (fun)->max_args > numargs)
2797 internal_args = alloca (XSUBR (fun)->max_args
2798 * sizeof *internal_args);
2799 memcpy (internal_args, args + 1, numargs * word_size);
2800 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2801 internal_args[i] = Qnil;
2803 else
2804 internal_args = args + 1;
2805 switch (XSUBR (fun)->max_args)
2807 case 0:
2808 val = (XSUBR (fun)->function.a0 ());
2809 break;
2810 case 1:
2811 val = (XSUBR (fun)->function.a1 (internal_args[0]));
2812 break;
2813 case 2:
2814 val = (XSUBR (fun)->function.a2
2815 (internal_args[0], internal_args[1]));
2816 break;
2817 case 3:
2818 val = (XSUBR (fun)->function.a3
2819 (internal_args[0], internal_args[1], internal_args[2]));
2820 break;
2821 case 4:
2822 val = (XSUBR (fun)->function.a4
2823 (internal_args[0], internal_args[1], internal_args[2],
2824 internal_args[3]));
2825 break;
2826 case 5:
2827 val = (XSUBR (fun)->function.a5
2828 (internal_args[0], internal_args[1], internal_args[2],
2829 internal_args[3], internal_args[4]));
2830 break;
2831 case 6:
2832 val = (XSUBR (fun)->function.a6
2833 (internal_args[0], internal_args[1], internal_args[2],
2834 internal_args[3], internal_args[4], internal_args[5]));
2835 break;
2836 case 7:
2837 val = (XSUBR (fun)->function.a7
2838 (internal_args[0], internal_args[1], internal_args[2],
2839 internal_args[3], internal_args[4], internal_args[5],
2840 internal_args[6]));
2841 break;
2843 case 8:
2844 val = (XSUBR (fun)->function.a8
2845 (internal_args[0], internal_args[1], internal_args[2],
2846 internal_args[3], internal_args[4], internal_args[5],
2847 internal_args[6], internal_args[7]));
2848 break;
2850 default:
2852 /* If a subr takes more than 8 arguments without using MANY
2853 or UNEVALLED, we need to extend this function to support it.
2854 Until this is done, there is no way to call the function. */
2855 emacs_abort ();
2859 else if (COMPILEDP (fun))
2860 val = funcall_lambda (fun, numargs, args + 1);
2861 else
2863 if (NILP (fun))
2864 xsignal1 (Qvoid_function, original_fun);
2865 if (!CONSP (fun))
2866 xsignal1 (Qinvalid_function, original_fun);
2867 funcar = XCAR (fun);
2868 if (!SYMBOLP (funcar))
2869 xsignal1 (Qinvalid_function, original_fun);
2870 if (EQ (funcar, Qlambda)
2871 || EQ (funcar, Qclosure))
2872 val = funcall_lambda (fun, numargs, args + 1);
2873 else if (EQ (funcar, Qautoload))
2875 Fautoload_do_load (fun, original_fun, Qnil);
2876 check_cons_list ();
2877 goto retry;
2879 else
2880 xsignal1 (Qinvalid_function, original_fun);
2882 check_cons_list ();
2883 lisp_eval_depth--;
2884 if (backtrace_debug_on_exit (specpdl + count))
2885 val = call_debugger (list2 (Qexit, val));
2886 specpdl_ptr--;
2887 return val;
2890 static Lisp_Object
2891 apply_lambda (Lisp_Object fun, Lisp_Object args, ptrdiff_t count)
2893 Lisp_Object args_left;
2894 ptrdiff_t i;
2895 EMACS_INT numargs;
2896 register Lisp_Object *arg_vector;
2897 struct gcpro gcpro1, gcpro2, gcpro3;
2898 register Lisp_Object tem;
2899 USE_SAFE_ALLOCA;
2901 numargs = XFASTINT (Flength (args));
2902 SAFE_ALLOCA_LISP (arg_vector, numargs);
2903 args_left = args;
2905 GCPRO3 (*arg_vector, args_left, fun);
2906 gcpro1.nvars = 0;
2908 for (i = 0; i < numargs; )
2910 tem = Fcar (args_left), args_left = Fcdr (args_left);
2911 tem = eval_sub (tem);
2912 arg_vector[i++] = tem;
2913 gcpro1.nvars = i;
2916 UNGCPRO;
2918 set_backtrace_args (specpdl + count, arg_vector, i);
2919 tem = funcall_lambda (fun, numargs, arg_vector);
2921 /* Do the debug-on-exit now, while arg_vector still exists. */
2922 if (backtrace_debug_on_exit (specpdl + count))
2924 /* Don't do it again when we return to eval. */
2925 set_backtrace_debug_on_exit (specpdl + count, false);
2926 tem = call_debugger (list2 (Qexit, tem));
2928 SAFE_FREE ();
2929 return tem;
2932 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2933 and return the result of evaluation.
2934 FUN must be either a lambda-expression or a compiled-code object. */
2936 static Lisp_Object
2937 funcall_lambda (Lisp_Object fun, ptrdiff_t nargs,
2938 register Lisp_Object *arg_vector)
2940 Lisp_Object val, syms_left, next, lexenv;
2941 ptrdiff_t count = SPECPDL_INDEX ();
2942 ptrdiff_t i;
2943 bool optional, rest;
2945 if (CONSP (fun))
2947 if (EQ (XCAR (fun), Qclosure))
2949 fun = XCDR (fun); /* Drop `closure'. */
2950 lexenv = XCAR (fun);
2951 CHECK_LIST_CONS (fun, fun);
2953 else
2954 lexenv = Qnil;
2955 syms_left = XCDR (fun);
2956 if (CONSP (syms_left))
2957 syms_left = XCAR (syms_left);
2958 else
2959 xsignal1 (Qinvalid_function, fun);
2961 else if (COMPILEDP (fun))
2963 syms_left = AREF (fun, COMPILED_ARGLIST);
2964 if (INTEGERP (syms_left))
2965 /* A byte-code object with a non-nil `push args' slot means we
2966 shouldn't bind any arguments, instead just call the byte-code
2967 interpreter directly; it will push arguments as necessary.
2969 Byte-code objects with either a non-existent, or a nil value for
2970 the `push args' slot (the default), have dynamically-bound
2971 arguments, and use the argument-binding code below instead (as do
2972 all interpreted functions, even lexically bound ones). */
2974 /* If we have not actually read the bytecode string
2975 and constants vector yet, fetch them from the file. */
2976 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
2977 Ffetch_bytecode (fun);
2978 return exec_byte_code (AREF (fun, COMPILED_BYTECODE),
2979 AREF (fun, COMPILED_CONSTANTS),
2980 AREF (fun, COMPILED_STACK_DEPTH),
2981 syms_left,
2982 nargs, arg_vector);
2984 lexenv = Qnil;
2986 else
2987 emacs_abort ();
2989 i = optional = rest = 0;
2990 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
2992 QUIT;
2994 next = XCAR (syms_left);
2995 if (!SYMBOLP (next))
2996 xsignal1 (Qinvalid_function, fun);
2998 if (EQ (next, Qand_rest))
2999 rest = 1;
3000 else if (EQ (next, Qand_optional))
3001 optional = 1;
3002 else
3004 Lisp_Object arg;
3005 if (rest)
3007 arg = Flist (nargs - i, &arg_vector[i]);
3008 i = nargs;
3010 else if (i < nargs)
3011 arg = arg_vector[i++];
3012 else if (!optional)
3013 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3014 else
3015 arg = Qnil;
3017 /* Bind the argument. */
3018 if (!NILP (lexenv) && SYMBOLP (next))
3019 /* Lexically bind NEXT by adding it to the lexenv alist. */
3020 lexenv = Fcons (Fcons (next, arg), lexenv);
3021 else
3022 /* Dynamically bind NEXT. */
3023 specbind (next, arg);
3027 if (!NILP (syms_left))
3028 xsignal1 (Qinvalid_function, fun);
3029 else if (i < nargs)
3030 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3032 if (!EQ (lexenv, Vinternal_interpreter_environment))
3033 /* Instantiate a new lexical environment. */
3034 specbind (Qinternal_interpreter_environment, lexenv);
3036 if (CONSP (fun))
3037 val = Fprogn (XCDR (XCDR (fun)));
3038 else
3040 /* If we have not actually read the bytecode string
3041 and constants vector yet, fetch them from the file. */
3042 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3043 Ffetch_bytecode (fun);
3044 val = exec_byte_code (AREF (fun, COMPILED_BYTECODE),
3045 AREF (fun, COMPILED_CONSTANTS),
3046 AREF (fun, COMPILED_STACK_DEPTH),
3047 Qnil, 0, 0);
3050 return unbind_to (count, val);
3053 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
3054 1, 1, 0,
3055 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3056 (Lisp_Object object)
3058 Lisp_Object tem;
3060 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
3062 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
3063 if (!CONSP (tem))
3065 tem = AREF (object, COMPILED_BYTECODE);
3066 if (CONSP (tem) && STRINGP (XCAR (tem)))
3067 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
3068 else
3069 error ("Invalid byte code");
3071 ASET (object, COMPILED_BYTECODE, XCAR (tem));
3072 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
3074 return object;
3077 /* Return true if SYMBOL currently has a let-binding
3078 which was made in the buffer that is now current. */
3080 bool
3081 let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
3083 union specbinding *p;
3084 Lisp_Object buf = Fcurrent_buffer ();
3086 for (p = specpdl_ptr; p > specpdl; )
3087 if ((--p)->kind > SPECPDL_LET)
3089 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (specpdl_symbol (p));
3090 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
3091 if (symbol == let_bound_symbol
3092 && EQ (specpdl_where (p), buf))
3093 return 1;
3096 return 0;
3099 bool
3100 let_shadows_global_binding_p (Lisp_Object symbol)
3102 union specbinding *p;
3104 for (p = specpdl_ptr; p > specpdl; )
3105 if ((--p)->kind >= SPECPDL_LET && EQ (specpdl_symbol (p), symbol))
3106 return 1;
3108 return 0;
3111 /* `specpdl_ptr' describes which variable is
3112 let-bound, so it can be properly undone when we unbind_to.
3113 It can be either a plain SPECPDL_LET or a SPECPDL_LET_LOCAL/DEFAULT.
3114 - SYMBOL is the variable being bound. Note that it should not be
3115 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3116 to record V2 here).
3117 - WHERE tells us in which buffer the binding took place.
3118 This is used for SPECPDL_LET_LOCAL bindings (i.e. bindings to a
3119 buffer-local variable) as well as for SPECPDL_LET_DEFAULT bindings,
3120 i.e. bindings to the default value of a variable which can be
3121 buffer-local. */
3123 void
3124 specbind (Lisp_Object symbol, Lisp_Object value)
3126 struct Lisp_Symbol *sym;
3128 CHECK_SYMBOL (symbol);
3129 sym = XSYMBOL (symbol);
3131 start:
3132 switch (sym->redirect)
3134 case SYMBOL_VARALIAS:
3135 sym = indirect_variable (sym); XSETSYMBOL (symbol, sym); goto start;
3136 case SYMBOL_PLAINVAL:
3137 /* The most common case is that of a non-constant symbol with a
3138 trivial value. Make that as fast as we can. */
3139 specpdl_ptr->let.kind = SPECPDL_LET;
3140 specpdl_ptr->let.symbol = symbol;
3141 specpdl_ptr->let.old_value = SYMBOL_VAL (sym);
3142 grow_specpdl ();
3143 if (!sym->constant)
3144 SET_SYMBOL_VAL (sym, value);
3145 else
3146 set_internal (symbol, value, Qnil, 1);
3147 break;
3148 case SYMBOL_LOCALIZED:
3149 if (SYMBOL_BLV (sym)->frame_local)
3150 error ("Frame-local vars cannot be let-bound");
3151 case SYMBOL_FORWARDED:
3153 Lisp_Object ovalue = find_symbol_value (symbol);
3154 specpdl_ptr->let.kind = SPECPDL_LET_LOCAL;
3155 specpdl_ptr->let.symbol = symbol;
3156 specpdl_ptr->let.old_value = ovalue;
3157 specpdl_ptr->let.where = Fcurrent_buffer ();
3159 eassert (sym->redirect != SYMBOL_LOCALIZED
3160 || (EQ (SYMBOL_BLV (sym)->where, Fcurrent_buffer ())));
3162 if (sym->redirect == SYMBOL_LOCALIZED)
3164 if (!blv_found (SYMBOL_BLV (sym)))
3165 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
3167 else if (BUFFER_OBJFWDP (SYMBOL_FWD (sym)))
3169 /* If SYMBOL is a per-buffer variable which doesn't have a
3170 buffer-local value here, make the `let' change the global
3171 value by changing the value of SYMBOL in all buffers not
3172 having their own value. This is consistent with what
3173 happens with other buffer-local variables. */
3174 if (NILP (Flocal_variable_p (symbol, Qnil)))
3176 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
3177 grow_specpdl ();
3178 Fset_default (symbol, value);
3179 return;
3182 else
3183 specpdl_ptr->let.kind = SPECPDL_LET;
3185 grow_specpdl ();
3186 set_internal (symbol, value, Qnil, 1);
3187 break;
3189 default: emacs_abort ();
3193 /* Push unwind-protect entries of various types. */
3195 void
3196 record_unwind_protect (void (*function) (Lisp_Object), Lisp_Object arg)
3198 specpdl_ptr->unwind.kind = SPECPDL_UNWIND;
3199 specpdl_ptr->unwind.func = function;
3200 specpdl_ptr->unwind.arg = arg;
3201 grow_specpdl ();
3204 void
3205 record_unwind_protect_ptr (void (*function) (void *), void *arg)
3207 specpdl_ptr->unwind_ptr.kind = SPECPDL_UNWIND_PTR;
3208 specpdl_ptr->unwind_ptr.func = function;
3209 specpdl_ptr->unwind_ptr.arg = arg;
3210 grow_specpdl ();
3213 void
3214 record_unwind_protect_int (void (*function) (int), int arg)
3216 specpdl_ptr->unwind_int.kind = SPECPDL_UNWIND_INT;
3217 specpdl_ptr->unwind_int.func = function;
3218 specpdl_ptr->unwind_int.arg = arg;
3219 grow_specpdl ();
3222 void
3223 record_unwind_protect_void (void (*function) (void))
3225 specpdl_ptr->unwind_void.kind = SPECPDL_UNWIND_VOID;
3226 specpdl_ptr->unwind_void.func = function;
3227 grow_specpdl ();
3230 static void
3231 do_nothing (void)
3234 /* Push an unwind-protect entry that does nothing, so that
3235 set_unwind_protect_ptr can overwrite it later. */
3237 void
3238 record_unwind_protect_nothing (void)
3240 record_unwind_protect_void (do_nothing);
3243 /* Clear the unwind-protect entry COUNT, so that it does nothing.
3244 It need not be at the top of the stack. */
3246 void
3247 clear_unwind_protect (ptrdiff_t count)
3249 union specbinding *p = specpdl + count;
3250 p->unwind_void.kind = SPECPDL_UNWIND_VOID;
3251 p->unwind_void.func = do_nothing;
3254 /* Set the unwind-protect entry COUNT so that it invokes FUNC (ARG).
3255 It need not be at the top of the stack. Discard the entry's
3256 previous value without invoking it. */
3258 void
3259 set_unwind_protect (ptrdiff_t count, void (*func) (Lisp_Object),
3260 Lisp_Object arg)
3262 union specbinding *p = specpdl + count;
3263 p->unwind.kind = SPECPDL_UNWIND;
3264 p->unwind.func = func;
3265 p->unwind.arg = arg;
3268 void
3269 set_unwind_protect_ptr (ptrdiff_t count, void (*func) (void *), void *arg)
3271 union specbinding *p = specpdl + count;
3272 p->unwind_ptr.kind = SPECPDL_UNWIND_PTR;
3273 p->unwind_ptr.func = func;
3274 p->unwind_ptr.arg = arg;
3277 /* Pop and execute entries from the unwind-protect stack until the
3278 depth COUNT is reached. Return VALUE. */
3280 Lisp_Object
3281 unbind_to (ptrdiff_t count, Lisp_Object value)
3283 Lisp_Object quitf = Vquit_flag;
3284 struct gcpro gcpro1, gcpro2;
3286 GCPRO2 (value, quitf);
3287 Vquit_flag = Qnil;
3289 while (specpdl_ptr != specpdl + count)
3291 /* Decrement specpdl_ptr before we do the work to unbind it, so
3292 that an error in unbinding won't try to unbind the same entry
3293 again. Take care to copy any parts of the binding needed
3294 before invoking any code that can make more bindings. */
3296 specpdl_ptr--;
3298 switch (specpdl_ptr->kind)
3300 case SPECPDL_UNWIND:
3301 specpdl_ptr->unwind.func (specpdl_ptr->unwind.arg);
3302 break;
3303 case SPECPDL_UNWIND_PTR:
3304 specpdl_ptr->unwind_ptr.func (specpdl_ptr->unwind_ptr.arg);
3305 break;
3306 case SPECPDL_UNWIND_INT:
3307 specpdl_ptr->unwind_int.func (specpdl_ptr->unwind_int.arg);
3308 break;
3309 case SPECPDL_UNWIND_VOID:
3310 specpdl_ptr->unwind_void.func ();
3311 break;
3312 case SPECPDL_BACKTRACE:
3313 break;
3314 case SPECPDL_LET:
3315 { /* If variable has a trivial value (no forwarding), we can
3316 just set it. No need to check for constant symbols here,
3317 since that was already done by specbind. */
3318 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (specpdl_ptr));
3319 if (sym->redirect == SYMBOL_PLAINVAL)
3321 SET_SYMBOL_VAL (sym, specpdl_old_value (specpdl_ptr));
3322 break;
3324 else
3325 { /* FALLTHROUGH!!
3326 NOTE: we only ever come here if make_local_foo was used for
3327 the first time on this var within this let. */
3330 case SPECPDL_LET_DEFAULT:
3331 Fset_default (specpdl_symbol (specpdl_ptr),
3332 specpdl_old_value (specpdl_ptr));
3333 break;
3334 case SPECPDL_LET_LOCAL:
3336 Lisp_Object symbol = specpdl_symbol (specpdl_ptr);
3337 Lisp_Object where = specpdl_where (specpdl_ptr);
3338 Lisp_Object old_value = specpdl_old_value (specpdl_ptr);
3339 eassert (BUFFERP (where));
3341 /* If this was a local binding, reset the value in the appropriate
3342 buffer, but only if that buffer's binding still exists. */
3343 if (!NILP (Flocal_variable_p (symbol, where)))
3344 set_internal (symbol, old_value, where, 1);
3346 break;
3350 if (NILP (Vquit_flag) && !NILP (quitf))
3351 Vquit_flag = quitf;
3353 UNGCPRO;
3354 return value;
3357 DEFUN ("special-variable-p", Fspecial_variable_p, Sspecial_variable_p, 1, 1, 0,
3358 doc: /* Return non-nil if SYMBOL's global binding has been declared special.
3359 A special variable is one that will be bound dynamically, even in a
3360 context where binding is lexical by default. */)
3361 (Lisp_Object symbol)
3363 CHECK_SYMBOL (symbol);
3364 return XSYMBOL (symbol)->declared_special ? Qt : Qnil;
3368 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3369 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3370 The debugger is entered when that frame exits, if the flag is non-nil. */)
3371 (Lisp_Object level, Lisp_Object flag)
3373 union specbinding *pdl = backtrace_top ();
3374 register EMACS_INT i;
3376 CHECK_NUMBER (level);
3378 for (i = 0; backtrace_p (pdl) && i < XINT (level); i++)
3379 pdl = backtrace_next (pdl);
3381 if (backtrace_p (pdl))
3382 set_backtrace_debug_on_exit (pdl, !NILP (flag));
3384 return flag;
3387 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3388 doc: /* Print a trace of Lisp function calls currently active.
3389 Output stream used is value of `standard-output'. */)
3390 (void)
3392 union specbinding *pdl = backtrace_top ();
3393 Lisp_Object tem;
3394 Lisp_Object old_print_level = Vprint_level;
3396 if (NILP (Vprint_level))
3397 XSETFASTINT (Vprint_level, 8);
3399 while (backtrace_p (pdl))
3401 write_string (backtrace_debug_on_exit (pdl) ? "* " : " ", 2);
3402 if (backtrace_nargs (pdl) == UNEVALLED)
3404 Fprin1 (Fcons (backtrace_function (pdl), *backtrace_args (pdl)),
3405 Qnil);
3406 write_string ("\n", -1);
3408 else
3410 tem = backtrace_function (pdl);
3411 Fprin1 (tem, Qnil); /* This can QUIT. */
3412 write_string ("(", -1);
3414 ptrdiff_t i;
3415 for (i = 0; i < backtrace_nargs (pdl); i++)
3417 if (i) write_string (" ", -1);
3418 Fprin1 (backtrace_args (pdl)[i], Qnil);
3421 write_string (")\n", -1);
3423 pdl = backtrace_next (pdl);
3426 Vprint_level = old_print_level;
3427 return Qnil;
3430 static union specbinding *
3431 get_backtrace_frame (Lisp_Object nframes, Lisp_Object base)
3433 union specbinding *pdl = backtrace_top ();
3434 register EMACS_INT i;
3436 CHECK_NATNUM (nframes);
3438 if (!NILP (base))
3439 { /* Skip up to `base'. */
3440 base = Findirect_function (base, Qt);
3441 while (backtrace_p (pdl)
3442 && !EQ (base, Findirect_function (backtrace_function (pdl), Qt)))
3443 pdl = backtrace_next (pdl);
3446 /* Find the frame requested. */
3447 for (i = XFASTINT (nframes); i > 0 && backtrace_p (pdl); i--)
3448 pdl = backtrace_next (pdl);
3450 return pdl;
3453 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 2, NULL,
3454 doc: /* Return the function and arguments NFRAMES up from current execution point.
3455 If that frame has not evaluated the arguments yet (or is a special form),
3456 the value is (nil FUNCTION ARG-FORMS...).
3457 If that frame has evaluated its arguments and called its function already,
3458 the value is (t FUNCTION ARG-VALUES...).
3459 A &rest arg is represented as the tail of the list ARG-VALUES.
3460 FUNCTION is whatever was supplied as car of evaluated list,
3461 or a lambda expression for macro calls.
3462 If NFRAMES is more than the number of frames, the value is nil.
3463 If BASE is non-nil, it should be a function and NFRAMES counts from its
3464 nearest activation frame. */)
3465 (Lisp_Object nframes, Lisp_Object base)
3467 union specbinding *pdl = get_backtrace_frame (nframes, base);
3469 if (!backtrace_p (pdl))
3470 return Qnil;
3471 if (backtrace_nargs (pdl) == UNEVALLED)
3472 return Fcons (Qnil,
3473 Fcons (backtrace_function (pdl), *backtrace_args (pdl)));
3474 else
3476 Lisp_Object tem = Flist (backtrace_nargs (pdl), backtrace_args (pdl));
3478 return Fcons (Qt, Fcons (backtrace_function (pdl), tem));
3482 /* For backtrace-eval, we want to temporarily unwind the last few elements of
3483 the specpdl stack, and then rewind them. We store the pre-unwind values
3484 directly in the pre-existing specpdl elements (i.e. we swap the current
3485 value and the old value stored in the specpdl), kind of like the inplace
3486 pointer-reversal trick. As it turns out, the rewind does the same as the
3487 unwind, except it starts from the other end of the specpdl stack, so we use
3488 the same function for both unwind and rewind. */
3489 static void
3490 backtrace_eval_unrewind (int distance)
3492 union specbinding *tmp = specpdl_ptr;
3493 int step = -1;
3494 if (distance < 0)
3495 { /* It's a rewind rather than unwind. */
3496 tmp += distance - 1;
3497 step = 1;
3498 distance = -distance;
3501 for (; distance > 0; distance--)
3503 tmp += step;
3504 switch (tmp->kind)
3506 /* FIXME: Ideally we'd like to "temporarily unwind" (some of) those
3507 unwind_protect, but the problem is that we don't know how to
3508 rewind them afterwards. */
3509 case SPECPDL_UNWIND:
3510 case SPECPDL_UNWIND_PTR:
3511 case SPECPDL_UNWIND_INT:
3512 case SPECPDL_UNWIND_VOID:
3513 case SPECPDL_BACKTRACE:
3514 break;
3515 case SPECPDL_LET:
3516 { /* If variable has a trivial value (no forwarding), we can
3517 just set it. No need to check for constant symbols here,
3518 since that was already done by specbind. */
3519 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (tmp));
3520 if (sym->redirect == SYMBOL_PLAINVAL)
3522 Lisp_Object old_value = specpdl_old_value (tmp);
3523 set_specpdl_old_value (tmp, SYMBOL_VAL (sym));
3524 SET_SYMBOL_VAL (sym, old_value);
3525 break;
3527 else
3528 { /* FALLTHROUGH!!
3529 NOTE: we only ever come here if make_local_foo was used for
3530 the first time on this var within this let. */
3533 case SPECPDL_LET_DEFAULT:
3535 Lisp_Object sym = specpdl_symbol (tmp);
3536 Lisp_Object old_value = specpdl_old_value (tmp);
3537 set_specpdl_old_value (tmp, Fdefault_value (sym));
3538 Fset_default (sym, old_value);
3540 break;
3541 case SPECPDL_LET_LOCAL:
3543 Lisp_Object symbol = specpdl_symbol (tmp);
3544 Lisp_Object where = specpdl_where (tmp);
3545 Lisp_Object old_value = specpdl_old_value (tmp);
3546 eassert (BUFFERP (where));
3548 /* If this was a local binding, reset the value in the appropriate
3549 buffer, but only if that buffer's binding still exists. */
3550 if (!NILP (Flocal_variable_p (symbol, where)))
3552 set_specpdl_old_value
3553 (tmp, Fbuffer_local_value (symbol, where));
3554 set_internal (symbol, old_value, where, 1);
3557 break;
3562 DEFUN ("backtrace-eval", Fbacktrace_eval, Sbacktrace_eval, 2, 3, NULL,
3563 doc: /* Evaluate EXP in the context of some activation frame.
3564 NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3565 (Lisp_Object exp, Lisp_Object nframes, Lisp_Object base)
3567 union specbinding *pdl = get_backtrace_frame (nframes, base);
3568 ptrdiff_t count = SPECPDL_INDEX ();
3569 ptrdiff_t distance = specpdl_ptr - pdl;
3570 eassert (distance >= 0);
3572 if (!backtrace_p (pdl))
3573 error ("Activation frame not found!");
3575 backtrace_eval_unrewind (distance);
3576 record_unwind_protect_int (backtrace_eval_unrewind, -distance);
3578 /* Use eval_sub rather than Feval since the main motivation behind
3579 backtrace-eval is to be able to get/set the value of lexical variables
3580 from the debugger. */
3581 return unbind_to (count, eval_sub (exp));
3584 DEFUN ("backtrace--locals", Fbacktrace__locals, Sbacktrace__locals, 1, 2, NULL,
3585 doc: /* Return names and values of local variables of a stack frame.
3586 NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3587 (Lisp_Object nframes, Lisp_Object base)
3589 union specbinding *frame = get_backtrace_frame (nframes, base);
3590 union specbinding *prevframe
3591 = get_backtrace_frame (make_number (XFASTINT (nframes) - 1), base);
3592 ptrdiff_t distance = specpdl_ptr - frame;
3593 Lisp_Object result = Qnil;
3594 eassert (distance >= 0);
3596 if (!backtrace_p (prevframe))
3597 error ("Activation frame not found!");
3598 if (!backtrace_p (frame))
3599 error ("Activation frame not found!");
3601 /* The specpdl entries normally contain the symbol being bound along with its
3602 `old_value', so it can be restored. The new value to which it is bound is
3603 available in one of two places: either in the current value of the
3604 variable (if it hasn't been rebound yet) or in the `old_value' slot of the
3605 next specpdl entry for it.
3606 `backtrace_eval_unrewind' happens to swap the role of `old_value'
3607 and "new value", so we abuse it here, to fetch the new value.
3608 It's ugly (we'd rather not modify global data) and a bit inefficient,
3609 but it does the job for now. */
3610 backtrace_eval_unrewind (distance);
3612 /* Grab values. */
3614 union specbinding *tmp = prevframe;
3615 for (; tmp > frame; tmp--)
3617 switch (tmp->kind)
3619 case SPECPDL_LET:
3620 case SPECPDL_LET_DEFAULT:
3621 case SPECPDL_LET_LOCAL:
3623 Lisp_Object sym = specpdl_symbol (tmp);
3624 Lisp_Object val = specpdl_old_value (tmp);
3625 if (EQ (sym, Qinternal_interpreter_environment))
3627 Lisp_Object env = val;
3628 for (; CONSP (env); env = XCDR (env))
3630 Lisp_Object binding = XCAR (env);
3631 if (CONSP (binding))
3632 result = Fcons (Fcons (XCAR (binding),
3633 XCDR (binding)),
3634 result);
3637 else
3638 result = Fcons (Fcons (sym, val), result);
3644 /* Restore values from specpdl to original place. */
3645 backtrace_eval_unrewind (-distance);
3647 return result;
3651 void
3652 mark_specpdl (void)
3654 union specbinding *pdl;
3655 for (pdl = specpdl; pdl != specpdl_ptr; pdl++)
3657 switch (pdl->kind)
3659 case SPECPDL_UNWIND:
3660 mark_object (specpdl_arg (pdl));
3661 break;
3663 case SPECPDL_BACKTRACE:
3665 ptrdiff_t nargs = backtrace_nargs (pdl);
3666 mark_object (backtrace_function (pdl));
3667 if (nargs == UNEVALLED)
3668 nargs = 1;
3669 while (nargs--)
3670 mark_object (backtrace_args (pdl)[nargs]);
3672 break;
3674 case SPECPDL_LET_DEFAULT:
3675 case SPECPDL_LET_LOCAL:
3676 mark_object (specpdl_where (pdl));
3677 /* Fall through. */
3678 case SPECPDL_LET:
3679 mark_object (specpdl_symbol (pdl));
3680 mark_object (specpdl_old_value (pdl));
3681 break;
3686 void
3687 get_backtrace (Lisp_Object array)
3689 union specbinding *pdl = backtrace_next (backtrace_top ());
3690 ptrdiff_t i = 0, asize = ASIZE (array);
3692 /* Copy the backtrace contents into working memory. */
3693 for (; i < asize; i++)
3695 if (backtrace_p (pdl))
3697 ASET (array, i, backtrace_function (pdl));
3698 pdl = backtrace_next (pdl);
3700 else
3701 ASET (array, i, Qnil);
3705 Lisp_Object backtrace_top_function (void)
3707 union specbinding *pdl = backtrace_top ();
3708 return (backtrace_p (pdl) ? backtrace_function (pdl) : Qnil);
3711 void
3712 syms_of_eval (void)
3714 DEFVAR_INT ("max-specpdl-size", max_specpdl_size,
3715 doc: /* Limit on number of Lisp variable bindings and `unwind-protect's.
3716 If Lisp code tries to increase the total number past this amount,
3717 an error is signaled.
3718 You can safely use a value considerably larger than the default value,
3719 if that proves inconveniently small. However, if you increase it too far,
3720 Emacs could run out of memory trying to make the stack bigger.
3721 Note that this limit may be silently increased by the debugger
3722 if `debug-on-error' or `debug-on-quit' is set. */);
3724 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth,
3725 doc: /* Limit on depth in `eval', `apply' and `funcall' before error.
3727 This limit serves to catch infinite recursions for you before they cause
3728 actual stack overflow in C, which would be fatal for Emacs.
3729 You can safely make it considerably larger than its default value,
3730 if that proves inconveniently small. However, if you increase it too far,
3731 Emacs could overflow the real C stack, and crash. */);
3733 DEFVAR_LISP ("quit-flag", Vquit_flag,
3734 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3735 If the value is t, that means do an ordinary quit.
3736 If the value equals `throw-on-input', that means quit by throwing
3737 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3738 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3739 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3740 Vquit_flag = Qnil;
3742 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit,
3743 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3744 Note that `quit-flag' will still be set by typing C-g,
3745 so a quit will be signaled as soon as `inhibit-quit' is nil.
3746 To prevent this happening, set `quit-flag' to nil
3747 before making `inhibit-quit' nil. */);
3748 Vinhibit_quit = Qnil;
3750 DEFSYM (Qinhibit_quit, "inhibit-quit");
3751 DEFSYM (Qautoload, "autoload");
3752 DEFSYM (Qinhibit_debugger, "inhibit-debugger");
3753 DEFSYM (Qmacro, "macro");
3754 DEFSYM (Qdeclare, "declare");
3756 /* Note that the process handling also uses Qexit, but we don't want
3757 to staticpro it twice, so we just do it here. */
3758 DEFSYM (Qexit, "exit");
3760 DEFSYM (Qinteractive, "interactive");
3761 DEFSYM (Qcommandp, "commandp");
3762 DEFSYM (Qand_rest, "&rest");
3763 DEFSYM (Qand_optional, "&optional");
3764 DEFSYM (Qclosure, "closure");
3765 DEFSYM (Qdebug, "debug");
3767 DEFVAR_LISP ("inhibit-debugger", Vinhibit_debugger,
3768 doc: /* Non-nil means never enter the debugger.
3769 Normally set while the debugger is already active, to avoid recursive
3770 invocations. */);
3771 Vinhibit_debugger = Qnil;
3773 DEFVAR_LISP ("debug-on-error", Vdebug_on_error,
3774 doc: /* Non-nil means enter debugger if an error is signaled.
3775 Does not apply to errors handled by `condition-case' or those
3776 matched by `debug-ignored-errors'.
3777 If the value is a list, an error only means to enter the debugger
3778 if one of its condition symbols appears in the list.
3779 When you evaluate an expression interactively, this variable
3780 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3781 The command `toggle-debug-on-error' toggles this.
3782 See also the variable `debug-on-quit' and `inhibit-debugger'. */);
3783 Vdebug_on_error = Qnil;
3785 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors,
3786 doc: /* List of errors for which the debugger should not be called.
3787 Each element may be a condition-name or a regexp that matches error messages.
3788 If any element applies to a given error, that error skips the debugger
3789 and just returns to top level.
3790 This overrides the variable `debug-on-error'.
3791 It does not apply to errors handled by `condition-case'. */);
3792 Vdebug_ignored_errors = Qnil;
3794 DEFVAR_BOOL ("debug-on-quit", debug_on_quit,
3795 doc: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
3796 Does not apply if quit is handled by a `condition-case'. */);
3797 debug_on_quit = 0;
3799 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call,
3800 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3802 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue,
3803 doc: /* Non-nil means debugger may continue execution.
3804 This is nil when the debugger is called under circumstances where it
3805 might not be safe to continue. */);
3806 debugger_may_continue = 1;
3808 DEFVAR_LISP ("debugger", Vdebugger,
3809 doc: /* Function to call to invoke debugger.
3810 If due to frame exit, args are `exit' and the value being returned;
3811 this function's value will be returned instead of that.
3812 If due to error, args are `error' and a list of the args to `signal'.
3813 If due to `apply' or `funcall' entry, one arg, `lambda'.
3814 If due to `eval' entry, one arg, t. */);
3815 Vdebugger = Qnil;
3817 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function,
3818 doc: /* If non-nil, this is a function for `signal' to call.
3819 It receives the same arguments that `signal' was given.
3820 The Edebug package uses this to regain control. */);
3821 Vsignal_hook_function = Qnil;
3823 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal,
3824 doc: /* Non-nil means call the debugger regardless of condition handlers.
3825 Note that `debug-on-error', `debug-on-quit' and friends
3826 still determine whether to handle the particular condition. */);
3827 Vdebug_on_signal = Qnil;
3829 /* When lexical binding is being used,
3830 Vinternal_interpreter_environment is non-nil, and contains an alist
3831 of lexically-bound variable, or (t), indicating an empty
3832 environment. The lisp name of this variable would be
3833 `internal-interpreter-environment' if it weren't hidden.
3834 Every element of this list can be either a cons (VAR . VAL)
3835 specifying a lexical binding, or a single symbol VAR indicating
3836 that this variable should use dynamic scoping. */
3837 DEFSYM (Qinternal_interpreter_environment,
3838 "internal-interpreter-environment");
3839 DEFVAR_LISP ("internal-interpreter-environment",
3840 Vinternal_interpreter_environment,
3841 doc: /* If non-nil, the current lexical environment of the lisp interpreter.
3842 When lexical binding is not being used, this variable is nil.
3843 A value of `(t)' indicates an empty environment, otherwise it is an
3844 alist of active lexical bindings. */);
3845 Vinternal_interpreter_environment = Qnil;
3846 /* Don't export this variable to Elisp, so no one can mess with it
3847 (Just imagine if someone makes it buffer-local). */
3848 Funintern (Qinternal_interpreter_environment, Qnil);
3850 DEFSYM (Vrun_hooks, "run-hooks");
3852 staticpro (&Vautoload_queue);
3853 Vautoload_queue = Qnil;
3854 staticpro (&Vsignaling_function);
3855 Vsignaling_function = Qnil;
3857 inhibit_lisp_code = Qnil;
3859 defsubr (&Sor);
3860 defsubr (&Sand);
3861 defsubr (&Sif);
3862 defsubr (&Scond);
3863 defsubr (&Sprogn);
3864 defsubr (&Sprog1);
3865 defsubr (&Sprog2);
3866 defsubr (&Ssetq);
3867 defsubr (&Squote);
3868 defsubr (&Sfunction);
3869 defsubr (&Sdefault_toplevel_value);
3870 defsubr (&Sset_default_toplevel_value);
3871 defsubr (&Sdefvar);
3872 defsubr (&Sdefvaralias);
3873 defsubr (&Sdefconst);
3874 defsubr (&Smake_var_non_special);
3875 defsubr (&Slet);
3876 defsubr (&SletX);
3877 defsubr (&Swhile);
3878 defsubr (&Smacroexpand);
3879 defsubr (&Scatch);
3880 defsubr (&Sthrow);
3881 defsubr (&Sunwind_protect);
3882 defsubr (&Scondition_case);
3883 defsubr (&Ssignal);
3884 defsubr (&Scommandp);
3885 defsubr (&Sautoload);
3886 defsubr (&Sautoload_do_load);
3887 defsubr (&Seval);
3888 defsubr (&Sapply);
3889 defsubr (&Sfuncall);
3890 defsubr (&Srun_hooks);
3891 defsubr (&Srun_hook_with_args);
3892 defsubr (&Srun_hook_with_args_until_success);
3893 defsubr (&Srun_hook_with_args_until_failure);
3894 defsubr (&Srun_hook_wrapped);
3895 defsubr (&Sfetch_bytecode);
3896 defsubr (&Sbacktrace_debug);
3897 defsubr (&Sbacktrace);
3898 defsubr (&Sbacktrace_frame);
3899 defsubr (&Sbacktrace_eval);
3900 defsubr (&Sbacktrace__locals);
3901 defsubr (&Sspecial_variable_p);
3902 defsubr (&Sfunctionp);