Remove unnecessary prev/next/up pointers in @node
[emacs.git] / src / eval.c
blob33bda7bfc570c5f2b9da79b68ce8fcda4d1dae31
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include "lisp.h"
25 #include "blockinput.h"
26 #include "commands.h"
27 #include "keyboard.h"
28 #include "dispextern.h"
29 #include <setjmp.h>
31 /* This definition is duplicated in alloc.c and keyboard.c */
32 /* Putting it in lisp.h makes cc bomb out! */
34 struct backtrace
36 struct backtrace *next;
37 Lisp_Object *function;
38 Lisp_Object *args; /* Points to vector of args. */
39 int nargs; /* Length of vector.
40 If nargs is UNEVALLED, args points to slot holding
41 list of unevalled args */
42 char evalargs;
43 /* Nonzero means call value of debugger when done with this operation. */
44 char debug_on_exit;
47 struct backtrace *backtrace_list;
49 /* This structure helps implement the `catch' and `throw' control
50 structure. A struct catchtag contains all the information needed
51 to restore the state of the interpreter after a non-local jump.
53 Handlers for error conditions (represented by `struct handler'
54 structures) just point to a catch tag to do the cleanup required
55 for their jumps.
57 catchtag structures are chained together in the C calling stack;
58 the `next' member points to the next outer catchtag.
60 A call like (throw TAG VAL) searches for a catchtag whose `tag'
61 member is TAG, and then unbinds to it. The `val' member is used to
62 hold VAL while the stack is unwound; `val' is returned as the value
63 of the catch form.
65 All the other members are concerned with restoring the interpreter
66 state. */
68 struct catchtag
70 Lisp_Object tag;
71 Lisp_Object val;
72 struct catchtag *next;
73 struct gcpro *gcpro;
74 jmp_buf jmp;
75 struct backtrace *backlist;
76 struct handler *handlerlist;
77 int lisp_eval_depth;
78 int pdlcount;
79 int poll_suppress_count;
80 struct byte_stack *byte_stack;
83 struct catchtag *catchlist;
85 #ifdef DEBUG_GCPRO
86 /* Count levels of GCPRO to detect failure to UNGCPRO. */
87 int gcpro_level;
88 #endif
90 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
91 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
92 Lisp_Object Qand_rest, Qand_optional;
93 Lisp_Object Qdebug_on_error;
94 Lisp_Object Qdeclare;
96 /* This holds either the symbol `run-hooks' or nil.
97 It is nil at an early stage of startup, and when Emacs
98 is shutting down. */
100 Lisp_Object Vrun_hooks;
102 /* Non-nil means record all fset's and provide's, to be undone
103 if the file being autoloaded is not fully loaded.
104 They are recorded by being consed onto the front of Vautoload_queue:
105 (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide. */
107 Lisp_Object Vautoload_queue;
109 /* Current number of specbindings allocated in specpdl. */
111 int specpdl_size;
113 /* Pointer to beginning of specpdl. */
115 struct specbinding *specpdl;
117 /* Pointer to first unused element in specpdl. */
119 struct specbinding *specpdl_ptr;
121 /* Maximum size allowed for specpdl allocation */
123 EMACS_INT max_specpdl_size;
125 /* Depth in Lisp evaluations and function calls. */
127 int lisp_eval_depth;
129 /* Maximum allowed depth in Lisp evaluations and function calls. */
131 EMACS_INT max_lisp_eval_depth;
133 /* Nonzero means enter debugger before next function call */
135 int debug_on_next_call;
137 /* Non-zero means debugger may continue. This is zero when the
138 debugger is called during redisplay, where it might not be safe to
139 continue the interrupted redisplay. */
141 int debugger_may_continue;
143 /* List of conditions (non-nil atom means all) which cause a backtrace
144 if an error is handled by the command loop's error handler. */
146 Lisp_Object Vstack_trace_on_error;
148 /* List of conditions (non-nil atom means all) which enter the debugger
149 if an error is handled by the command loop's error handler. */
151 Lisp_Object Vdebug_on_error;
153 /* List of conditions and regexps specifying error messages which
154 do not enter the debugger even if Vdebug_on_error says they should. */
156 Lisp_Object Vdebug_ignored_errors;
158 /* Non-nil means call the debugger even if the error will be handled. */
160 Lisp_Object Vdebug_on_signal;
162 /* Hook for edebug to use. */
164 Lisp_Object Vsignal_hook_function;
166 /* Nonzero means enter debugger if a quit signal
167 is handled by the command loop's error handler. */
169 int debug_on_quit;
171 /* The value of num_nonmacro_input_events as of the last time we
172 started to enter the debugger. If we decide to enter the debugger
173 again when this is still equal to num_nonmacro_input_events, then we
174 know that the debugger itself has an error, and we should just
175 signal the error instead of entering an infinite loop of debugger
176 invocations. */
178 int when_entered_debugger;
180 Lisp_Object Vdebugger;
182 /* The function from which the last `signal' was called. Set in
183 Fsignal. */
185 Lisp_Object Vsignaling_function;
187 /* Set to non-zero while processing X events. Checked in Feval to
188 make sure the Lisp interpreter isn't called from a signal handler,
189 which is unsafe because the interpreter isn't reentrant. */
191 int handling_signal;
193 /* Function to process declarations in defmacro forms. */
195 Lisp_Object Vmacro_declaration_function;
198 static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
200 void
201 init_eval_once ()
203 specpdl_size = 50;
204 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
205 specpdl_ptr = specpdl;
206 max_specpdl_size = 600;
207 max_lisp_eval_depth = 300;
209 Vrun_hooks = Qnil;
212 void
213 init_eval ()
215 specpdl_ptr = specpdl;
216 catchlist = 0;
217 handlerlist = 0;
218 backtrace_list = 0;
219 Vquit_flag = Qnil;
220 debug_on_next_call = 0;
221 lisp_eval_depth = 0;
222 #ifdef DEBUG_GCPRO
223 gcpro_level = 0;
224 #endif
225 /* This is less than the initial value of num_nonmacro_input_events. */
226 when_entered_debugger = -1;
229 Lisp_Object
230 call_debugger (arg)
231 Lisp_Object arg;
233 int debug_while_redisplaying;
234 int count = specpdl_ptr - specpdl;
235 Lisp_Object val;
237 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
238 max_lisp_eval_depth = lisp_eval_depth + 20;
240 if (specpdl_size + 40 > max_specpdl_size)
241 max_specpdl_size = specpdl_size + 40;
243 #ifdef HAVE_X_WINDOWS
244 if (display_hourglass_p)
245 cancel_hourglass ();
246 #endif
248 debug_on_next_call = 0;
249 when_entered_debugger = num_nonmacro_input_events;
251 /* Resetting redisplaying_p to 0 makes sure that debug output is
252 displayed if the debugger is invoked during redisplay. */
253 debug_while_redisplaying = redisplaying_p;
254 redisplaying_p = 0;
255 specbind (intern ("debugger-may-continue"),
256 debug_while_redisplaying ? Qnil : Qt);
257 specbind (Qinhibit_redisplay, Qnil);
259 #if 0 /* Binding this prevents execution of Lisp code during
260 redisplay, which necessarily leads to display problems. */
261 specbind (Qinhibit_eval_during_redisplay, Qt);
262 #endif
264 val = apply1 (Vdebugger, arg);
266 /* Interrupting redisplay and resuming it later is not safe under
267 all circumstances. So, when the debugger returns, abort the
268 interrupted redisplay by going back to the top-level. */
269 if (debug_while_redisplaying)
270 Ftop_level ();
272 return unbind_to (count, val);
275 void
276 do_debug_on_call (code)
277 Lisp_Object code;
279 debug_on_next_call = 0;
280 backtrace_list->debug_on_exit = 1;
281 call_debugger (Fcons (code, Qnil));
284 /* NOTE!!! Every function that can call EVAL must protect its args
285 and temporaries from garbage collection while it needs them.
286 The definition of `For' shows what you have to do. */
288 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
289 doc: /* Eval args until one of them yields non-nil, then return that value.
290 The remaining args are not evalled at all.
291 If all args return nil, return nil.
292 usage: (or CONDITIONS ...) */)
293 (args)
294 Lisp_Object args;
296 register Lisp_Object val;
297 Lisp_Object args_left;
298 struct gcpro gcpro1;
300 if (NILP(args))
301 return Qnil;
303 args_left = args;
304 GCPRO1 (args_left);
308 val = Feval (Fcar (args_left));
309 if (!NILP (val))
310 break;
311 args_left = Fcdr (args_left);
313 while (!NILP(args_left));
315 UNGCPRO;
316 return val;
319 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
320 doc: /* Eval args until one of them yields nil, then return nil.
321 The remaining args are not evalled at all.
322 If no arg yields nil, return the last arg's value.
323 usage: (and CONDITIONS ...) */)
324 (args)
325 Lisp_Object args;
327 register Lisp_Object val;
328 Lisp_Object args_left;
329 struct gcpro gcpro1;
331 if (NILP(args))
332 return Qt;
334 args_left = args;
335 GCPRO1 (args_left);
339 val = Feval (Fcar (args_left));
340 if (NILP (val))
341 break;
342 args_left = Fcdr (args_left);
344 while (!NILP(args_left));
346 UNGCPRO;
347 return val;
350 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
351 doc: /* If COND yields non-nil, do THEN, else do ELSE...
352 Returns the value of THEN or the value of the last of the ELSE's.
353 THEN must be one expression, but ELSE... can be zero or more expressions.
354 If COND yields nil, and there are no ELSE's, the value is nil.
355 usage: (if COND THEN ELSE...) */)
356 (args)
357 Lisp_Object args;
359 register Lisp_Object cond;
360 struct gcpro gcpro1;
362 GCPRO1 (args);
363 cond = Feval (Fcar (args));
364 UNGCPRO;
366 if (!NILP (cond))
367 return Feval (Fcar (Fcdr (args)));
368 return Fprogn (Fcdr (Fcdr (args)));
371 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
372 doc: /* Try each clause until one succeeds.
373 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
374 and, if the value is non-nil, this clause succeeds:
375 then the expressions in BODY are evaluated and the last one's
376 value is the value of the cond-form.
377 If no clause succeeds, cond returns nil.
378 If a clause has one element, as in (CONDITION),
379 CONDITION's value if non-nil is returned from the cond-form.
380 usage: (cond CLAUSES...) */)
381 (args)
382 Lisp_Object args;
384 register Lisp_Object clause, val;
385 struct gcpro gcpro1;
387 val = Qnil;
388 GCPRO1 (args);
389 while (!NILP (args))
391 clause = Fcar (args);
392 val = Feval (Fcar (clause));
393 if (!NILP (val))
395 if (!EQ (XCDR (clause), Qnil))
396 val = Fprogn (XCDR (clause));
397 break;
399 args = XCDR (args);
401 UNGCPRO;
403 return val;
406 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
407 doc: /* Eval BODY forms sequentially and return value of last one.
408 usage: (progn BODY ...) */)
409 (args)
410 Lisp_Object args;
412 register Lisp_Object val;
413 Lisp_Object args_left;
414 struct gcpro gcpro1;
416 if (NILP(args))
417 return Qnil;
419 args_left = args;
420 GCPRO1 (args_left);
424 val = Feval (Fcar (args_left));
425 args_left = Fcdr (args_left);
427 while (!NILP(args_left));
429 UNGCPRO;
430 return val;
433 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
434 doc: /* Eval FIRST and BODY sequentially; value from FIRST.
435 The value of FIRST is saved during the evaluation of the remaining args,
436 whose values are discarded.
437 usage: (prog1 FIRST BODY...) */)
438 (args)
439 Lisp_Object args;
441 Lisp_Object val;
442 register Lisp_Object args_left;
443 struct gcpro gcpro1, gcpro2;
444 register int argnum = 0;
446 if (NILP(args))
447 return Qnil;
449 args_left = args;
450 val = Qnil;
451 GCPRO2 (args, val);
455 if (!(argnum++))
456 val = Feval (Fcar (args_left));
457 else
458 Feval (Fcar (args_left));
459 args_left = Fcdr (args_left);
461 while (!NILP(args_left));
463 UNGCPRO;
464 return val;
467 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
468 doc: /* Eval X, Y and BODY sequentially; value from Y.
469 The value of Y is saved during the evaluation of the remaining args,
470 whose values are discarded.
471 usage: (prog2 X Y BODY...) */)
472 (args)
473 Lisp_Object args;
475 Lisp_Object val;
476 register Lisp_Object args_left;
477 struct gcpro gcpro1, gcpro2;
478 register int argnum = -1;
480 val = Qnil;
482 if (NILP (args))
483 return Qnil;
485 args_left = args;
486 val = Qnil;
487 GCPRO2 (args, val);
491 if (!(argnum++))
492 val = Feval (Fcar (args_left));
493 else
494 Feval (Fcar (args_left));
495 args_left = Fcdr (args_left);
497 while (!NILP (args_left));
499 UNGCPRO;
500 return val;
503 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
504 doc: /* Set each SYM to the value of its VAL.
505 The symbols SYM are variables; they are literal (not evaluated).
506 The values VAL are expressions; they are evaluated.
507 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
508 The second VAL is not computed until after the first SYM is set, and so on;
509 each VAL can use the new value of variables set earlier in the `setq'.
510 The return value of the `setq' form is the value of the last VAL.
511 usage: (setq SYM VAL SYM VAL ...) */)
512 (args)
513 Lisp_Object args;
515 register Lisp_Object args_left;
516 register Lisp_Object val, sym;
517 struct gcpro gcpro1;
519 if (NILP(args))
520 return Qnil;
522 args_left = args;
523 GCPRO1 (args);
527 val = Feval (Fcar (Fcdr (args_left)));
528 sym = Fcar (args_left);
529 Fset (sym, val);
530 args_left = Fcdr (Fcdr (args_left));
532 while (!NILP(args_left));
534 UNGCPRO;
535 return val;
538 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
539 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
540 usage: (quote ARG) */)
541 (args)
542 Lisp_Object args;
544 return Fcar (args);
547 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
548 doc: /* Like `quote', but preferred for objects which are functions.
549 In byte compilation, `function' causes its argument to be compiled.
550 `quote' cannot do that.
551 usage: (function ARG) */)
552 (args)
553 Lisp_Object args;
555 return Fcar (args);
559 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
560 doc: /* Return t if function in which this appears was called interactively.
561 This means that the function was called with call-interactively (which
562 includes being called as the binding of a key)
563 and input is currently coming from the keyboard (not in keyboard macro). */)
566 return interactive_p (1) ? Qt : Qnil;
570 /* Return 1 if function in which this appears was called
571 interactively. This means that the function was called with
572 call-interactively (which includes being called as the binding of
573 a key) and input is currently coming from the keyboard (not in
574 keyboard macro).
576 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
577 called is a built-in. */
580 interactive_p (exclude_subrs_p)
581 int exclude_subrs_p;
583 struct backtrace *btp;
584 Lisp_Object fun;
586 if (!INTERACTIVE)
587 return 0;
589 btp = backtrace_list;
591 /* If this isn't a byte-compiled function, there may be a frame at
592 the top for Finteractive_p. If so, skip it. */
593 fun = Findirect_function (*btp->function);
594 if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
595 btp = btp->next;
597 /* If we're running an Emacs 18-style byte-compiled function, there
598 may be a frame for Fbytecode. Now, given the strictest
599 definition, this function isn't really being called
600 interactively, but because that's the way Emacs 18 always builds
601 byte-compiled functions, we'll accept it for now. */
602 if (EQ (*btp->function, Qbytecode))
603 btp = btp->next;
605 /* If this isn't a byte-compiled function, then we may now be
606 looking at several frames for special forms. Skip past them. */
607 while (btp &&
608 btp->nargs == UNEVALLED)
609 btp = btp->next;
611 /* btp now points at the frame of the innermost function that isn't
612 a special form, ignoring frames for Finteractive_p and/or
613 Fbytecode at the top. If this frame is for a built-in function
614 (such as load or eval-region) return nil. */
615 fun = Findirect_function (*btp->function);
616 if (exclude_subrs_p && SUBRP (fun))
617 return 0;
619 /* btp points to the frame of a Lisp function that called interactive-p.
620 Return t if that function was called interactively. */
621 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
622 return 1;
623 return 0;
627 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
628 doc: /* Define NAME as a function.
629 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
630 See also the function `interactive'.
631 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
632 (args)
633 Lisp_Object args;
635 register Lisp_Object fn_name;
636 register Lisp_Object defn;
638 fn_name = Fcar (args);
639 defn = Fcons (Qlambda, Fcdr (args));
640 if (!NILP (Vpurify_flag))
641 defn = Fpurecopy (defn);
642 Ffset (fn_name, defn);
643 LOADHIST_ATTACH (fn_name);
644 return fn_name;
647 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
648 doc: /* Define NAME as a macro.
649 The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).
650 When the macro is called, as in (NAME ARGS...),
651 the function (lambda ARGLIST BODY...) is applied to
652 the list ARGS... as it appears in the expression,
653 and the result should be a form to be evaluated instead of the original.
654 usage: (defmacro NAME ARGLIST [DOCSTRING] BODY...) */)
655 (args)
656 Lisp_Object args;
658 register Lisp_Object fn_name;
659 register Lisp_Object defn;
660 Lisp_Object lambda_list, doc, tail;
662 fn_name = Fcar (args);
663 lambda_list = Fcar (Fcdr (args));
664 tail = Fcdr (Fcdr (args));
666 doc = Qnil;
667 if (STRINGP (Fcar (tail)))
669 doc = Fcar (tail);
670 tail = Fcdr (tail);
673 while (CONSP (Fcar (tail))
674 && EQ (Fcar (Fcar (tail)), Qdeclare))
676 if (!NILP (Vmacro_declaration_function))
678 struct gcpro gcpro1;
679 GCPRO1 (args);
680 call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
681 UNGCPRO;
684 tail = Fcdr (tail);
687 if (NILP (doc))
688 tail = Fcons (lambda_list, tail);
689 else
690 tail = Fcons (lambda_list, Fcons (doc, tail));
691 defn = Fcons (Qmacro, Fcons (Qlambda, tail));
693 if (!NILP (Vpurify_flag))
694 defn = Fpurecopy (defn);
695 Ffset (fn_name, defn);
696 LOADHIST_ATTACH (fn_name);
697 return fn_name;
701 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 2, 0,
702 doc: /* Make SYMBOL a variable alias for symbol ALIASED.
703 Setting the value of SYMBOL will subsequently set the value of ALIASED,
704 and getting the value of SYMBOL will return the value ALIASED has.
705 ALIASED nil means remove the alias; SYMBOL is unbound after that. */)
706 (symbol, aliased)
707 Lisp_Object symbol, aliased;
709 struct Lisp_Symbol *sym;
711 CHECK_SYMBOL (symbol);
712 CHECK_SYMBOL (aliased);
714 if (SYMBOL_CONSTANT_P (symbol))
715 error ("Cannot make a constant an alias");
717 sym = XSYMBOL (symbol);
718 sym->indirect_variable = 1;
719 sym->value = aliased;
720 sym->constant = SYMBOL_CONSTANT_P (aliased);
721 LOADHIST_ATTACH (symbol);
723 return aliased;
727 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
728 doc: /* Define SYMBOL as a variable.
729 You are not required to define a variable in order to use it,
730 but the definition can supply documentation and an initial value
731 in a way that tags can recognize.
733 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
734 If SYMBOL is buffer-local, its default value is what is set;
735 buffer-local values are not affected.
736 INITVALUE and DOCSTRING are optional.
737 If DOCSTRING starts with *, this variable is identified as a user option.
738 This means that M-x set-variable recognizes it.
739 See also `user-variable-p'.
740 If INITVALUE is missing, SYMBOL's value is not set.
741 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
742 (args)
743 Lisp_Object args;
745 register Lisp_Object sym, tem, tail;
747 sym = Fcar (args);
748 tail = Fcdr (args);
749 if (!NILP (Fcdr (Fcdr (tail))))
750 error ("too many arguments");
752 tem = Fdefault_boundp (sym);
753 if (!NILP (tail))
755 if (NILP (tem))
756 Fset_default (sym, Feval (Fcar (tail)));
757 tail = Fcdr (tail);
758 if (!NILP (Fcar (tail)))
760 tem = Fcar (tail);
761 if (!NILP (Vpurify_flag))
762 tem = Fpurecopy (tem);
763 Fput (sym, Qvariable_documentation, tem);
765 LOADHIST_ATTACH (sym);
767 else
768 /* A (defvar <var>) should not take precedence in the load-history over
769 an earlier (defvar <var> <val>), so only add to history if the default
770 value is still unbound. */
771 if (NILP (tem))
772 LOADHIST_ATTACH (sym);
774 return sym;
777 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
778 doc: /* Define SYMBOL as a constant variable.
779 The intent is that neither programs nor users should ever change this value.
780 Always sets the value of SYMBOL to the result of evalling INITVALUE.
781 If SYMBOL is buffer-local, its default value is what is set;
782 buffer-local values are not affected.
783 DOCSTRING is optional.
784 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
785 (args)
786 Lisp_Object args;
788 register Lisp_Object sym, tem;
790 sym = Fcar (args);
791 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
792 error ("too many arguments");
794 tem = Feval (Fcar (Fcdr (args)));
795 if (!NILP (Vpurify_flag))
796 tem = Fpurecopy (tem);
797 Fset_default (sym, tem);
798 tem = Fcar (Fcdr (Fcdr (args)));
799 if (!NILP (tem))
801 if (!NILP (Vpurify_flag))
802 tem = Fpurecopy (tem);
803 Fput (sym, Qvariable_documentation, tem);
805 LOADHIST_ATTACH (sym);
806 return sym;
809 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
810 doc: /* Returns t if VARIABLE is intended to be set and modified by users.
811 \(The alternative is a variable used internally in a Lisp program.)
812 Determined by whether the first character of the documentation
813 for the variable is `*' or if the variable is customizable (has a non-nil
814 value of any of `custom-type', `custom-loads' or `standard-value'
815 on its property list). */)
816 (variable)
817 Lisp_Object variable;
819 Lisp_Object documentation;
821 if (!SYMBOLP (variable))
822 return Qnil;
824 documentation = Fget (variable, Qvariable_documentation);
825 if (INTEGERP (documentation) && XINT (documentation) < 0)
826 return Qt;
827 if (STRINGP (documentation)
828 && ((unsigned char) XSTRING (documentation)->data[0] == '*'))
829 return Qt;
830 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
831 if (CONSP (documentation)
832 && STRINGP (XCAR (documentation))
833 && INTEGERP (XCDR (documentation))
834 && XINT (XCDR (documentation)) < 0)
835 return Qt;
836 /* Customizable? */
837 if ((!NILP (Fget (variable, intern ("custom-type"))))
838 || (!NILP (Fget (variable, intern ("custom-loads"))))
839 || (!NILP (Fget (variable, intern ("standard-value")))))
840 return Qt;
841 return Qnil;
844 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
845 doc: /* Bind variables according to VARLIST then eval BODY.
846 The value of the last form in BODY is returned.
847 Each element of VARLIST is a symbol (which is bound to nil)
848 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
849 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
850 usage: (let* VARLIST BODY...) */)
851 (args)
852 Lisp_Object args;
854 Lisp_Object varlist, val, elt;
855 int count = specpdl_ptr - specpdl;
856 struct gcpro gcpro1, gcpro2, gcpro3;
858 GCPRO3 (args, elt, varlist);
860 varlist = Fcar (args);
861 while (!NILP (varlist))
863 QUIT;
864 elt = Fcar (varlist);
865 if (SYMBOLP (elt))
866 specbind (elt, Qnil);
867 else if (! NILP (Fcdr (Fcdr (elt))))
868 Fsignal (Qerror,
869 Fcons (build_string ("`let' bindings can have only one value-form"),
870 elt));
871 else
873 val = Feval (Fcar (Fcdr (elt)));
874 specbind (Fcar (elt), val);
876 varlist = Fcdr (varlist);
878 UNGCPRO;
879 val = Fprogn (Fcdr (args));
880 return unbind_to (count, val);
883 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
884 doc: /* Bind variables according to VARLIST then eval BODY.
885 The value of the last form in BODY is returned.
886 Each element of VARLIST is a symbol (which is bound to nil)
887 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
888 All the VALUEFORMs are evalled before any symbols are bound.
889 usage: (let VARLIST BODY...) */)
890 (args)
891 Lisp_Object args;
893 Lisp_Object *temps, tem;
894 register Lisp_Object elt, varlist;
895 int count = specpdl_ptr - specpdl;
896 register int argnum;
897 struct gcpro gcpro1, gcpro2;
899 varlist = Fcar (args);
901 /* Make space to hold the values to give the bound variables */
902 elt = Flength (varlist);
903 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
905 /* Compute the values and store them in `temps' */
907 GCPRO2 (args, *temps);
908 gcpro2.nvars = 0;
910 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
912 QUIT;
913 elt = Fcar (varlist);
914 if (SYMBOLP (elt))
915 temps [argnum++] = Qnil;
916 else if (! NILP (Fcdr (Fcdr (elt))))
917 Fsignal (Qerror,
918 Fcons (build_string ("`let' bindings can have only one value-form"),
919 elt));
920 else
921 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
922 gcpro2.nvars = argnum;
924 UNGCPRO;
926 varlist = Fcar (args);
927 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
929 elt = Fcar (varlist);
930 tem = temps[argnum++];
931 if (SYMBOLP (elt))
932 specbind (elt, tem);
933 else
934 specbind (Fcar (elt), tem);
937 elt = Fprogn (Fcdr (args));
938 return unbind_to (count, elt);
941 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
942 doc: /* If TEST yields non-nil, eval BODY... and repeat.
943 The order of execution is thus TEST, BODY, TEST, BODY and so on
944 until TEST returns nil.
945 usage: (while TEST BODY...) */)
946 (args)
947 Lisp_Object args;
949 Lisp_Object test, body;
950 struct gcpro gcpro1, gcpro2;
952 GCPRO2 (test, body);
954 test = Fcar (args);
955 body = Fcdr (args);
956 while (!NILP (Feval (test)))
958 QUIT;
959 Fprogn (body);
962 UNGCPRO;
963 return Qnil;
966 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
967 doc: /* Return result of expanding macros at top level of FORM.
968 If FORM is not a macro call, it is returned unchanged.
969 Otherwise, the macro is expanded and the expansion is considered
970 in place of FORM. When a non-macro-call results, it is returned.
972 The second optional arg ENVIRONMENT specifies an environment of macro
973 definitions to shadow the loaded ones for use in file byte-compilation. */)
974 (form, environment)
975 Lisp_Object form;
976 Lisp_Object environment;
978 /* With cleanups from Hallvard Furuseth. */
979 register Lisp_Object expander, sym, def, tem;
981 while (1)
983 /* Come back here each time we expand a macro call,
984 in case it expands into another macro call. */
985 if (!CONSP (form))
986 break;
987 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
988 def = sym = XCAR (form);
989 tem = Qnil;
990 /* Trace symbols aliases to other symbols
991 until we get a symbol that is not an alias. */
992 while (SYMBOLP (def))
994 QUIT;
995 sym = def;
996 tem = Fassq (sym, environment);
997 if (NILP (tem))
999 def = XSYMBOL (sym)->function;
1000 if (!EQ (def, Qunbound))
1001 continue;
1003 break;
1005 /* Right now TEM is the result from SYM in ENVIRONMENT,
1006 and if TEM is nil then DEF is SYM's function definition. */
1007 if (NILP (tem))
1009 /* SYM is not mentioned in ENVIRONMENT.
1010 Look at its function definition. */
1011 if (EQ (def, Qunbound) || !CONSP (def))
1012 /* Not defined or definition not suitable */
1013 break;
1014 if (EQ (XCAR (def), Qautoload))
1016 /* Autoloading function: will it be a macro when loaded? */
1017 tem = Fnth (make_number (4), def);
1018 if (EQ (tem, Qt) || EQ (tem, Qmacro))
1019 /* Yes, load it and try again. */
1021 struct gcpro gcpro1;
1022 GCPRO1 (form);
1023 do_autoload (def, sym);
1024 UNGCPRO;
1025 continue;
1027 else
1028 break;
1030 else if (!EQ (XCAR (def), Qmacro))
1031 break;
1032 else expander = XCDR (def);
1034 else
1036 expander = XCDR (tem);
1037 if (NILP (expander))
1038 break;
1040 form = apply1 (expander, XCDR (form));
1042 return form;
1045 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1046 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1047 TAG is evalled to get the tag to use; it must not be nil.
1049 Then the BODY is executed.
1050 Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.
1051 If no throw happens, `catch' returns the value of the last BODY form.
1052 If a throw happens, it specifies the value to return from `catch'.
1053 usage: (catch TAG BODY...) */)
1054 (args)
1055 Lisp_Object args;
1057 register Lisp_Object tag;
1058 struct gcpro gcpro1;
1060 GCPRO1 (args);
1061 tag = Feval (Fcar (args));
1062 UNGCPRO;
1063 return internal_catch (tag, Fprogn, Fcdr (args));
1066 /* Set up a catch, then call C function FUNC on argument ARG.
1067 FUNC should return a Lisp_Object.
1068 This is how catches are done from within C code. */
1070 Lisp_Object
1071 internal_catch (tag, func, arg)
1072 Lisp_Object tag;
1073 Lisp_Object (*func) ();
1074 Lisp_Object arg;
1076 /* This structure is made part of the chain `catchlist'. */
1077 struct catchtag c;
1079 /* Fill in the components of c, and put it on the list. */
1080 c.next = catchlist;
1081 c.tag = tag;
1082 c.val = Qnil;
1083 c.backlist = backtrace_list;
1084 c.handlerlist = handlerlist;
1085 c.lisp_eval_depth = lisp_eval_depth;
1086 c.pdlcount = specpdl_ptr - specpdl;
1087 c.poll_suppress_count = poll_suppress_count;
1088 c.gcpro = gcprolist;
1089 c.byte_stack = byte_stack_list;
1090 catchlist = &c;
1092 /* Call FUNC. */
1093 if (! _setjmp (c.jmp))
1094 c.val = (*func) (arg);
1096 /* Throw works by a longjmp that comes right here. */
1097 catchlist = c.next;
1098 return c.val;
1101 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1102 jump to that CATCH, returning VALUE as the value of that catch.
1104 This is the guts Fthrow and Fsignal; they differ only in the way
1105 they choose the catch tag to throw to. A catch tag for a
1106 condition-case form has a TAG of Qnil.
1108 Before each catch is discarded, unbind all special bindings and
1109 execute all unwind-protect clauses made above that catch. Unwind
1110 the handler stack as we go, so that the proper handlers are in
1111 effect for each unwind-protect clause we run. At the end, restore
1112 some static info saved in CATCH, and longjmp to the location
1113 specified in the
1115 This is used for correct unwinding in Fthrow and Fsignal. */
1117 static void
1118 unwind_to_catch (catch, value)
1119 struct catchtag *catch;
1120 Lisp_Object value;
1122 register int last_time;
1124 /* Save the value in the tag. */
1125 catch->val = value;
1127 /* Restore the polling-suppression count. */
1128 set_poll_suppress_count (catch->poll_suppress_count);
1132 last_time = catchlist == catch;
1134 /* Unwind the specpdl stack, and then restore the proper set of
1135 handlers. */
1136 unbind_to (catchlist->pdlcount, Qnil);
1137 handlerlist = catchlist->handlerlist;
1138 catchlist = catchlist->next;
1140 while (! last_time);
1142 byte_stack_list = catch->byte_stack;
1143 gcprolist = catch->gcpro;
1144 #ifdef DEBUG_GCPRO
1145 if (gcprolist != 0)
1146 gcpro_level = gcprolist->level + 1;
1147 else
1148 gcpro_level = 0;
1149 #endif
1150 backtrace_list = catch->backlist;
1151 lisp_eval_depth = catch->lisp_eval_depth;
1153 _longjmp (catch->jmp, 1);
1156 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1157 doc: /* Throw to the catch for TAG and return VALUE from it.
1158 Both TAG and VALUE are evalled. */)
1159 (tag, value)
1160 register Lisp_Object tag, value;
1162 register struct catchtag *c;
1164 while (1)
1166 if (!NILP (tag))
1167 for (c = catchlist; c; c = c->next)
1169 if (EQ (c->tag, tag))
1170 unwind_to_catch (c, value);
1172 tag = Fsignal (Qno_catch, Fcons (tag, Fcons (value, Qnil)));
1177 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1178 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1179 If BODYFORM completes normally, its value is returned
1180 after executing the UNWINDFORMS.
1181 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1182 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1183 (args)
1184 Lisp_Object args;
1186 Lisp_Object val;
1187 int count = specpdl_ptr - specpdl;
1189 record_unwind_protect (0, Fcdr (args));
1190 val = Feval (Fcar (args));
1191 return unbind_to (count, val);
1194 /* Chain of condition handlers currently in effect.
1195 The elements of this chain are contained in the stack frames
1196 of Fcondition_case and internal_condition_case.
1197 When an error is signaled (by calling Fsignal, below),
1198 this chain is searched for an element that applies. */
1200 struct handler *handlerlist;
1202 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1203 doc: /* Regain control when an error is signaled.
1204 Executes BODYFORM and returns its value if no error happens.
1205 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1206 where the BODY is made of Lisp expressions.
1208 A handler is applicable to an error
1209 if CONDITION-NAME is one of the error's condition names.
1210 If an error happens, the first applicable handler is run.
1212 The car of a handler may be a list of condition names
1213 instead of a single condition name.
1215 When a handler handles an error,
1216 control returns to the condition-case and the handler BODY... is executed
1217 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).
1218 VAR may be nil; then you do not get access to the signal information.
1220 The value of the last BODY form is returned from the condition-case.
1221 See also the function `signal' for more info.
1222 usage: (condition-case VAR BODYFORM HANDLERS...) */)
1223 (args)
1224 Lisp_Object args;
1226 Lisp_Object val;
1227 struct catchtag c;
1228 struct handler h;
1229 register Lisp_Object bodyform, handlers;
1230 volatile Lisp_Object var;
1232 var = Fcar (args);
1233 bodyform = Fcar (Fcdr (args));
1234 handlers = Fcdr (Fcdr (args));
1235 CHECK_SYMBOL (var);
1237 for (val = handlers; ! NILP (val); val = Fcdr (val))
1239 Lisp_Object tem;
1240 tem = Fcar (val);
1241 if (! (NILP (tem)
1242 || (CONSP (tem)
1243 && (SYMBOLP (XCAR (tem))
1244 || CONSP (XCAR (tem))))))
1245 error ("Invalid condition handler", tem);
1248 c.tag = Qnil;
1249 c.val = Qnil;
1250 c.backlist = backtrace_list;
1251 c.handlerlist = handlerlist;
1252 c.lisp_eval_depth = lisp_eval_depth;
1253 c.pdlcount = specpdl_ptr - specpdl;
1254 c.poll_suppress_count = poll_suppress_count;
1255 c.gcpro = gcprolist;
1256 c.byte_stack = byte_stack_list;
1257 if (_setjmp (c.jmp))
1259 if (!NILP (h.var))
1260 specbind (h.var, c.val);
1261 val = Fprogn (Fcdr (h.chosen_clause));
1263 /* Note that this just undoes the binding of h.var; whoever
1264 longjumped to us unwound the stack to c.pdlcount before
1265 throwing. */
1266 unbind_to (c.pdlcount, Qnil);
1267 return val;
1269 c.next = catchlist;
1270 catchlist = &c;
1272 h.var = var;
1273 h.handler = handlers;
1274 h.next = handlerlist;
1275 h.tag = &c;
1276 handlerlist = &h;
1278 val = Feval (bodyform);
1279 catchlist = c.next;
1280 handlerlist = h.next;
1281 return val;
1284 /* Call the function BFUN with no arguments, catching errors within it
1285 according to HANDLERS. If there is an error, call HFUN with
1286 one argument which is the data that describes the error:
1287 (SIGNALNAME . DATA)
1289 HANDLERS can be a list of conditions to catch.
1290 If HANDLERS is Qt, catch all errors.
1291 If HANDLERS is Qerror, catch all errors
1292 but allow the debugger to run if that is enabled. */
1294 Lisp_Object
1295 internal_condition_case (bfun, handlers, hfun)
1296 Lisp_Object (*bfun) ();
1297 Lisp_Object handlers;
1298 Lisp_Object (*hfun) ();
1300 Lisp_Object val;
1301 struct catchtag c;
1302 struct handler h;
1304 #if 0 /* Can't do this check anymore because realize_basic_faces has
1305 to BLOCK_INPUT, and can call Lisp. What's really needed is a
1306 flag indicating that we're currently handling a signal. */
1307 /* Since Fsignal resets this to 0, it had better be 0 now
1308 or else we have a potential bug. */
1309 if (interrupt_input_blocked != 0)
1310 abort ();
1311 #endif
1313 c.tag = Qnil;
1314 c.val = Qnil;
1315 c.backlist = backtrace_list;
1316 c.handlerlist = handlerlist;
1317 c.lisp_eval_depth = lisp_eval_depth;
1318 c.pdlcount = specpdl_ptr - specpdl;
1319 c.poll_suppress_count = poll_suppress_count;
1320 c.gcpro = gcprolist;
1321 c.byte_stack = byte_stack_list;
1322 if (_setjmp (c.jmp))
1324 return (*hfun) (c.val);
1326 c.next = catchlist;
1327 catchlist = &c;
1328 h.handler = handlers;
1329 h.var = Qnil;
1330 h.next = handlerlist;
1331 h.tag = &c;
1332 handlerlist = &h;
1334 val = (*bfun) ();
1335 catchlist = c.next;
1336 handlerlist = h.next;
1337 return val;
1340 /* Like internal_condition_case but call HFUN with ARG as its argument. */
1342 Lisp_Object
1343 internal_condition_case_1 (bfun, arg, handlers, hfun)
1344 Lisp_Object (*bfun) ();
1345 Lisp_Object arg;
1346 Lisp_Object handlers;
1347 Lisp_Object (*hfun) ();
1349 Lisp_Object val;
1350 struct catchtag c;
1351 struct handler h;
1353 c.tag = Qnil;
1354 c.val = Qnil;
1355 c.backlist = backtrace_list;
1356 c.handlerlist = handlerlist;
1357 c.lisp_eval_depth = lisp_eval_depth;
1358 c.pdlcount = specpdl_ptr - specpdl;
1359 c.poll_suppress_count = poll_suppress_count;
1360 c.gcpro = gcprolist;
1361 c.byte_stack = byte_stack_list;
1362 if (_setjmp (c.jmp))
1364 return (*hfun) (c.val);
1366 c.next = catchlist;
1367 catchlist = &c;
1368 h.handler = handlers;
1369 h.var = Qnil;
1370 h.next = handlerlist;
1371 h.tag = &c;
1372 handlerlist = &h;
1374 val = (*bfun) (arg);
1375 catchlist = c.next;
1376 handlerlist = h.next;
1377 return val;
1381 /* Like internal_condition_case but call HFUN with NARGS as first,
1382 and ARGS as second argument. */
1384 Lisp_Object
1385 internal_condition_case_2 (bfun, nargs, args, handlers, hfun)
1386 Lisp_Object (*bfun) ();
1387 int nargs;
1388 Lisp_Object *args;
1389 Lisp_Object handlers;
1390 Lisp_Object (*hfun) ();
1392 Lisp_Object val;
1393 struct catchtag c;
1394 struct handler h;
1396 c.tag = Qnil;
1397 c.val = Qnil;
1398 c.backlist = backtrace_list;
1399 c.handlerlist = handlerlist;
1400 c.lisp_eval_depth = lisp_eval_depth;
1401 c.pdlcount = specpdl_ptr - specpdl;
1402 c.poll_suppress_count = poll_suppress_count;
1403 c.gcpro = gcprolist;
1404 c.byte_stack = byte_stack_list;
1405 if (_setjmp (c.jmp))
1407 return (*hfun) (c.val);
1409 c.next = catchlist;
1410 catchlist = &c;
1411 h.handler = handlers;
1412 h.var = Qnil;
1413 h.next = handlerlist;
1414 h.tag = &c;
1415 handlerlist = &h;
1417 val = (*bfun) (nargs, args);
1418 catchlist = c.next;
1419 handlerlist = h.next;
1420 return val;
1424 static Lisp_Object find_handler_clause P_ ((Lisp_Object, Lisp_Object,
1425 Lisp_Object, Lisp_Object,
1426 Lisp_Object *));
1428 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1429 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1430 This function does not return.
1432 An error symbol is a symbol with an `error-conditions' property
1433 that is a list of condition names.
1434 A handler for any of those names will get to handle this signal.
1435 The symbol `error' should normally be one of them.
1437 DATA should be a list. Its elements are printed as part of the error message.
1438 If the signal is handled, DATA is made available to the handler.
1439 See also the function `condition-case'. */)
1440 (error_symbol, data)
1441 Lisp_Object error_symbol, data;
1443 /* When memory is full, ERROR-SYMBOL is nil,
1444 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA). */
1445 register struct handler *allhandlers = handlerlist;
1446 Lisp_Object conditions;
1447 extern int gc_in_progress;
1448 extern int waiting_for_input;
1449 Lisp_Object debugger_value;
1450 Lisp_Object string;
1451 Lisp_Object real_error_symbol;
1452 struct backtrace *bp;
1454 immediate_quit = handling_signal = 0;
1455 if (gc_in_progress || waiting_for_input)
1456 abort ();
1458 TOTALLY_UNBLOCK_INPUT;
1460 if (NILP (error_symbol))
1461 real_error_symbol = Fcar (data);
1462 else
1463 real_error_symbol = error_symbol;
1465 #ifdef HAVE_X_WINDOWS
1466 if (display_hourglass_p)
1467 cancel_hourglass ();
1468 #endif
1470 /* This hook is used by edebug. */
1471 if (! NILP (Vsignal_hook_function))
1472 call2 (Vsignal_hook_function, error_symbol, data);
1474 conditions = Fget (real_error_symbol, Qerror_conditions);
1476 /* Remember from where signal was called. Skip over the frame for
1477 `signal' itself. If a frame for `error' follows, skip that,
1478 too. */
1479 Vsignaling_function = Qnil;
1480 if (backtrace_list)
1482 bp = backtrace_list->next;
1483 if (bp && bp->function && EQ (*bp->function, Qerror))
1484 bp = bp->next;
1485 if (bp && bp->function)
1486 Vsignaling_function = *bp->function;
1489 for (; handlerlist; handlerlist = handlerlist->next)
1491 register Lisp_Object clause;
1493 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1494 max_lisp_eval_depth = lisp_eval_depth + 20;
1496 if (specpdl_size + 40 > max_specpdl_size)
1497 max_specpdl_size = specpdl_size + 40;
1499 clause = find_handler_clause (handlerlist->handler, conditions,
1500 error_symbol, data, &debugger_value);
1502 #if 0 /* Most callers are not prepared to handle gc if this returns.
1503 So, since this feature is not very useful, take it out. */
1504 /* If have called debugger and user wants to continue,
1505 just return nil. */
1506 if (EQ (clause, Qlambda))
1507 return debugger_value;
1508 #else
1509 if (EQ (clause, Qlambda))
1511 /* We can't return values to code which signaled an error, but we
1512 can continue code which has signaled a quit. */
1513 if (EQ (real_error_symbol, Qquit))
1514 return Qnil;
1515 else
1516 error ("Cannot return from the debugger in an error");
1518 #endif
1520 if (!NILP (clause))
1522 Lisp_Object unwind_data;
1523 struct handler *h = handlerlist;
1525 handlerlist = allhandlers;
1527 if (NILP (error_symbol))
1528 unwind_data = data;
1529 else
1530 unwind_data = Fcons (error_symbol, data);
1531 h->chosen_clause = clause;
1532 unwind_to_catch (h->tag, unwind_data);
1536 handlerlist = allhandlers;
1537 /* If no handler is present now, try to run the debugger,
1538 and if that fails, throw to top level. */
1539 find_handler_clause (Qerror, conditions, error_symbol, data, &debugger_value);
1540 if (catchlist != 0)
1541 Fthrow (Qtop_level, Qt);
1543 if (! NILP (error_symbol))
1544 data = Fcons (error_symbol, data);
1546 string = Ferror_message_string (data);
1547 fatal ("%s", XSTRING (string)->data, 0);
1550 /* Return nonzero iff LIST is a non-nil atom or
1551 a list containing one of CONDITIONS. */
1553 static int
1554 wants_debugger (list, conditions)
1555 Lisp_Object list, conditions;
1557 if (NILP (list))
1558 return 0;
1559 if (! CONSP (list))
1560 return 1;
1562 while (CONSP (conditions))
1564 Lisp_Object this, tail;
1565 this = XCAR (conditions);
1566 for (tail = list; CONSP (tail); tail = XCDR (tail))
1567 if (EQ (XCAR (tail), this))
1568 return 1;
1569 conditions = XCDR (conditions);
1571 return 0;
1574 /* Return 1 if an error with condition-symbols CONDITIONS,
1575 and described by SIGNAL-DATA, should skip the debugger
1576 according to debugger-ignored-errors. */
1578 static int
1579 skip_debugger (conditions, data)
1580 Lisp_Object conditions, data;
1582 Lisp_Object tail;
1583 int first_string = 1;
1584 Lisp_Object error_message;
1586 error_message = Qnil;
1587 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1589 if (STRINGP (XCAR (tail)))
1591 if (first_string)
1593 error_message = Ferror_message_string (data);
1594 first_string = 0;
1597 if (fast_string_match (XCAR (tail), error_message) >= 0)
1598 return 1;
1600 else
1602 Lisp_Object contail;
1604 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1605 if (EQ (XCAR (tail), XCAR (contail)))
1606 return 1;
1610 return 0;
1613 /* Value of Qlambda means we have called debugger and user has continued.
1614 There are two ways to pass SIG and DATA:
1615 = SIG is the error symbol, and DATA is the rest of the data.
1616 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1617 This is for memory-full errors only.
1619 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1621 static Lisp_Object
1622 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1623 Lisp_Object handlers, conditions, sig, data;
1624 Lisp_Object *debugger_value_ptr;
1626 register Lisp_Object h;
1627 register Lisp_Object tem;
1629 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1630 return Qt;
1631 /* error is used similarly, but means print an error message
1632 and run the debugger if that is enabled. */
1633 if (EQ (handlers, Qerror)
1634 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1635 there is a handler. */
1637 int count = specpdl_ptr - specpdl;
1638 int debugger_called = 0;
1639 Lisp_Object sig_symbol, combined_data;
1640 /* This is set to 1 if we are handling a memory-full error,
1641 because these must not run the debugger.
1642 (There is no room in memory to do that!) */
1643 int no_debugger = 0;
1645 if (NILP (sig))
1647 combined_data = data;
1648 sig_symbol = Fcar (data);
1649 no_debugger = 1;
1651 else
1653 combined_data = Fcons (sig, data);
1654 sig_symbol = sig;
1657 if (wants_debugger (Vstack_trace_on_error, conditions))
1659 #ifdef PROTOTYPES
1660 internal_with_output_to_temp_buffer ("*Backtrace*",
1661 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1662 Qnil);
1663 #else
1664 internal_with_output_to_temp_buffer ("*Backtrace*",
1665 Fbacktrace, Qnil);
1666 #endif
1668 if (! no_debugger
1669 && (EQ (sig_symbol, Qquit)
1670 ? debug_on_quit
1671 : wants_debugger (Vdebug_on_error, conditions))
1672 && ! skip_debugger (conditions, combined_data)
1673 && when_entered_debugger < num_nonmacro_input_events)
1675 specbind (Qdebug_on_error, Qnil);
1676 *debugger_value_ptr
1677 = call_debugger (Fcons (Qerror,
1678 Fcons (combined_data, Qnil)));
1679 debugger_called = 1;
1681 /* If there is no handler, return saying whether we ran the debugger. */
1682 if (EQ (handlers, Qerror))
1684 if (debugger_called)
1685 return unbind_to (count, Qlambda);
1686 return Qt;
1689 for (h = handlers; CONSP (h); h = Fcdr (h))
1691 Lisp_Object handler, condit;
1693 handler = Fcar (h);
1694 if (!CONSP (handler))
1695 continue;
1696 condit = Fcar (handler);
1697 /* Handle a single condition name in handler HANDLER. */
1698 if (SYMBOLP (condit))
1700 tem = Fmemq (Fcar (handler), conditions);
1701 if (!NILP (tem))
1702 return handler;
1704 /* Handle a list of condition names in handler HANDLER. */
1705 else if (CONSP (condit))
1707 while (CONSP (condit))
1709 tem = Fmemq (Fcar (condit), conditions);
1710 if (!NILP (tem))
1711 return handler;
1712 condit = XCDR (condit);
1716 return Qnil;
1719 /* dump an error message; called like printf */
1721 /* VARARGS 1 */
1722 void
1723 error (m, a1, a2, a3)
1724 char *m;
1725 char *a1, *a2, *a3;
1727 char buf[200];
1728 int size = 200;
1729 int mlen;
1730 char *buffer = buf;
1731 char *args[3];
1732 int allocated = 0;
1733 Lisp_Object string;
1735 args[0] = a1;
1736 args[1] = a2;
1737 args[2] = a3;
1739 mlen = strlen (m);
1741 while (1)
1743 int used = doprnt (buffer, size, m, m + mlen, 3, args);
1744 if (used < size)
1745 break;
1746 size *= 2;
1747 if (allocated)
1748 buffer = (char *) xrealloc (buffer, size);
1749 else
1751 buffer = (char *) xmalloc (size);
1752 allocated = 1;
1756 string = build_string (buffer);
1757 if (allocated)
1758 xfree (buffer);
1760 Fsignal (Qerror, Fcons (string, Qnil));
1761 abort ();
1764 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
1765 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
1766 This means it contains a description for how to read arguments to give it.
1767 The value is nil for an invalid function or a symbol with no function
1768 definition.
1770 Interactively callable functions include strings and vectors (treated
1771 as keyboard macros), lambda-expressions that contain a top-level call
1772 to `interactive', autoload definitions made by `autoload' with non-nil
1773 fourth argument, and some of the built-in functions of Lisp.
1775 Also, a symbol satisfies `commandp' if its function definition does so.
1777 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1778 then strings and vectors are not accepted. */)
1779 (function, for_call_interactively)
1780 Lisp_Object function, for_call_interactively;
1782 register Lisp_Object fun;
1783 register Lisp_Object funcar;
1785 fun = function;
1787 fun = indirect_function (fun);
1788 if (EQ (fun, Qunbound))
1789 return Qnil;
1791 /* Emacs primitives are interactive if their DEFUN specifies an
1792 interactive spec. */
1793 if (SUBRP (fun))
1795 if (XSUBR (fun)->prompt)
1796 return Qt;
1797 else
1798 return Qnil;
1801 /* Bytecode objects are interactive if they are long enough to
1802 have an element whose index is COMPILED_INTERACTIVE, which is
1803 where the interactive spec is stored. */
1804 else if (COMPILEDP (fun))
1805 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
1806 ? Qt : Qnil);
1808 /* Strings and vectors are keyboard macros. */
1809 if (NILP (for_call_interactively) && (STRINGP (fun) || VECTORP (fun)))
1810 return Qt;
1812 /* Lists may represent commands. */
1813 if (!CONSP (fun))
1814 return Qnil;
1815 funcar = Fcar (fun);
1816 if (!SYMBOLP (funcar))
1817 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1818 if (EQ (funcar, Qlambda))
1819 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1820 if (EQ (funcar, Qautoload))
1821 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1822 else
1823 return Qnil;
1826 /* ARGSUSED */
1827 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1828 doc: /* Define FUNCTION to autoload from FILE.
1829 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1830 Third arg DOCSTRING is documentation for the function.
1831 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1832 Fifth arg TYPE indicates the type of the object:
1833 nil or omitted says FUNCTION is a function,
1834 `keymap' says FUNCTION is really a keymap, and
1835 `macro' or t says FUNCTION is really a macro.
1836 Third through fifth args give info about the real definition.
1837 They default to nil.
1838 If FUNCTION is already defined other than as an autoload,
1839 this does nothing and returns nil. */)
1840 (function, file, docstring, interactive, type)
1841 Lisp_Object function, file, docstring, interactive, type;
1843 #ifdef NO_ARG_ARRAY
1844 Lisp_Object args[4];
1845 #endif
1847 CHECK_SYMBOL (function);
1848 CHECK_STRING (file);
1850 /* If function is defined and not as an autoload, don't override */
1851 if (!EQ (XSYMBOL (function)->function, Qunbound)
1852 && !(CONSP (XSYMBOL (function)->function)
1853 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
1854 return Qnil;
1856 if (NILP (Vpurify_flag))
1857 /* Only add entries after dumping, because the ones before are
1858 not useful and else we get loads of them from the loaddefs.el. */
1859 LOADHIST_ATTACH (Fcons (Qautoload, function));
1861 #ifdef NO_ARG_ARRAY
1862 args[0] = file;
1863 args[1] = docstring;
1864 args[2] = interactive;
1865 args[3] = type;
1867 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1868 #else /* NO_ARG_ARRAY */
1869 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1870 #endif /* not NO_ARG_ARRAY */
1873 Lisp_Object
1874 un_autoload (oldqueue)
1875 Lisp_Object oldqueue;
1877 register Lisp_Object queue, first, second;
1879 /* Queue to unwind is current value of Vautoload_queue.
1880 oldqueue is the shadowed value to leave in Vautoload_queue. */
1881 queue = Vautoload_queue;
1882 Vautoload_queue = oldqueue;
1883 while (CONSP (queue))
1885 first = Fcar (queue);
1886 second = Fcdr (first);
1887 first = Fcar (first);
1888 if (EQ (second, Qnil))
1889 Vfeatures = first;
1890 else
1891 Ffset (first, second);
1892 queue = Fcdr (queue);
1894 return Qnil;
1897 /* Load an autoloaded function.
1898 FUNNAME is the symbol which is the function's name.
1899 FUNDEF is the autoload definition (a list). */
1901 void
1902 do_autoload (fundef, funname)
1903 Lisp_Object fundef, funname;
1905 int count = specpdl_ptr - specpdl;
1906 Lisp_Object fun, queue, first, second;
1907 struct gcpro gcpro1, gcpro2, gcpro3;
1909 /* This is to make sure that loadup.el gives a clear picture
1910 of what files are preloaded and when. */
1911 if (! NILP (Vpurify_flag))
1912 error ("Attempt to autoload %s while preparing to dump",
1913 XSTRING (SYMBOL_NAME (funname))->data);
1915 fun = funname;
1916 CHECK_SYMBOL (funname);
1917 GCPRO3 (fun, funname, fundef);
1919 /* Preserve the match data. */
1920 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
1922 /* Value saved here is to be restored into Vautoload_queue. */
1923 record_unwind_protect (un_autoload, Vautoload_queue);
1924 Vautoload_queue = Qt;
1925 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil, Qt);
1927 /* Save the old autoloads, in case we ever do an unload. */
1928 queue = Vautoload_queue;
1929 while (CONSP (queue))
1931 first = Fcar (queue);
1932 second = Fcdr (first);
1933 first = Fcar (first);
1935 /* Note: This test is subtle. The cdr of an autoload-queue entry
1936 may be an atom if the autoload entry was generated by a defalias
1937 or fset. */
1938 if (CONSP (second))
1939 Fput (first, Qautoload, (Fcdr (second)));
1941 queue = Fcdr (queue);
1944 /* Once loading finishes, don't undo it. */
1945 Vautoload_queue = Qt;
1946 unbind_to (count, Qnil);
1948 fun = Findirect_function (fun);
1950 if (!NILP (Fequal (fun, fundef)))
1951 error ("Autoloading failed to define function %s",
1952 XSTRING (SYMBOL_NAME (funname))->data);
1953 UNGCPRO;
1957 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1958 doc: /* Evaluate FORM and return its value. */)
1959 (form)
1960 Lisp_Object form;
1962 Lisp_Object fun, val, original_fun, original_args;
1963 Lisp_Object funcar;
1964 struct backtrace backtrace;
1965 struct gcpro gcpro1, gcpro2, gcpro3;
1967 if (handling_signal)
1968 abort ();
1970 if (SYMBOLP (form))
1971 return Fsymbol_value (form);
1972 if (!CONSP (form))
1973 return form;
1975 QUIT;
1976 if (consing_since_gc > gc_cons_threshold)
1978 GCPRO1 (form);
1979 Fgarbage_collect ();
1980 UNGCPRO;
1983 if (++lisp_eval_depth > max_lisp_eval_depth)
1985 if (max_lisp_eval_depth < 100)
1986 max_lisp_eval_depth = 100;
1987 if (lisp_eval_depth > max_lisp_eval_depth)
1988 error ("Lisp nesting exceeds max-lisp-eval-depth");
1991 original_fun = Fcar (form);
1992 original_args = Fcdr (form);
1994 backtrace.next = backtrace_list;
1995 backtrace_list = &backtrace;
1996 backtrace.function = &original_fun; /* This also protects them from gc */
1997 backtrace.args = &original_args;
1998 backtrace.nargs = UNEVALLED;
1999 backtrace.evalargs = 1;
2000 backtrace.debug_on_exit = 0;
2002 if (debug_on_next_call)
2003 do_debug_on_call (Qt);
2005 /* At this point, only original_fun and original_args
2006 have values that will be used below */
2007 retry:
2008 fun = Findirect_function (original_fun);
2010 if (SUBRP (fun))
2012 Lisp_Object numargs;
2013 Lisp_Object argvals[8];
2014 Lisp_Object args_left;
2015 register int i, maxargs;
2017 args_left = original_args;
2018 numargs = Flength (args_left);
2020 if (XINT (numargs) < XSUBR (fun)->min_args ||
2021 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
2022 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2024 if (XSUBR (fun)->max_args == UNEVALLED)
2026 backtrace.evalargs = 0;
2027 val = (*XSUBR (fun)->function) (args_left);
2028 goto done;
2031 if (XSUBR (fun)->max_args == MANY)
2033 /* Pass a vector of evaluated arguments */
2034 Lisp_Object *vals;
2035 register int argnum = 0;
2037 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2039 GCPRO3 (args_left, fun, fun);
2040 gcpro3.var = vals;
2041 gcpro3.nvars = 0;
2043 while (!NILP (args_left))
2045 vals[argnum++] = Feval (Fcar (args_left));
2046 args_left = Fcdr (args_left);
2047 gcpro3.nvars = argnum;
2050 backtrace.args = vals;
2051 backtrace.nargs = XINT (numargs);
2053 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
2054 UNGCPRO;
2055 goto done;
2058 GCPRO3 (args_left, fun, fun);
2059 gcpro3.var = argvals;
2060 gcpro3.nvars = 0;
2062 maxargs = XSUBR (fun)->max_args;
2063 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2065 argvals[i] = Feval (Fcar (args_left));
2066 gcpro3.nvars = ++i;
2069 UNGCPRO;
2071 backtrace.args = argvals;
2072 backtrace.nargs = XINT (numargs);
2074 switch (i)
2076 case 0:
2077 val = (*XSUBR (fun)->function) ();
2078 goto done;
2079 case 1:
2080 val = (*XSUBR (fun)->function) (argvals[0]);
2081 goto done;
2082 case 2:
2083 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
2084 goto done;
2085 case 3:
2086 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2087 argvals[2]);
2088 goto done;
2089 case 4:
2090 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2091 argvals[2], argvals[3]);
2092 goto done;
2093 case 5:
2094 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2095 argvals[3], argvals[4]);
2096 goto done;
2097 case 6:
2098 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2099 argvals[3], argvals[4], argvals[5]);
2100 goto done;
2101 case 7:
2102 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2103 argvals[3], argvals[4], argvals[5],
2104 argvals[6]);
2105 goto done;
2107 case 8:
2108 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2109 argvals[3], argvals[4], argvals[5],
2110 argvals[6], argvals[7]);
2111 goto done;
2113 default:
2114 /* Someone has created a subr that takes more arguments than
2115 is supported by this code. We need to either rewrite the
2116 subr to use a different argument protocol, or add more
2117 cases to this switch. */
2118 abort ();
2121 if (COMPILEDP (fun))
2122 val = apply_lambda (fun, original_args, 1);
2123 else
2125 if (!CONSP (fun))
2126 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2127 funcar = Fcar (fun);
2128 if (!SYMBOLP (funcar))
2129 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2130 if (EQ (funcar, Qautoload))
2132 do_autoload (fun, original_fun);
2133 goto retry;
2135 if (EQ (funcar, Qmacro))
2136 val = Feval (apply1 (Fcdr (fun), original_args));
2137 else if (EQ (funcar, Qlambda))
2138 val = apply_lambda (fun, original_args, 1);
2139 else
2140 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2142 done:
2143 lisp_eval_depth--;
2144 if (backtrace.debug_on_exit)
2145 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2146 backtrace_list = backtrace.next;
2147 return val;
2150 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2151 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2152 Then return the value FUNCTION returns.
2153 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2154 usage: (apply FUNCTION &rest ARGUMENTS) */)
2155 (nargs, args)
2156 int nargs;
2157 Lisp_Object *args;
2159 register int i, numargs;
2160 register Lisp_Object spread_arg;
2161 register Lisp_Object *funcall_args;
2162 Lisp_Object fun;
2163 struct gcpro gcpro1;
2165 fun = args [0];
2166 funcall_args = 0;
2167 spread_arg = args [nargs - 1];
2168 CHECK_LIST (spread_arg);
2170 numargs = XINT (Flength (spread_arg));
2172 if (numargs == 0)
2173 return Ffuncall (nargs - 1, args);
2174 else if (numargs == 1)
2176 args [nargs - 1] = XCAR (spread_arg);
2177 return Ffuncall (nargs, args);
2180 numargs += nargs - 2;
2182 fun = indirect_function (fun);
2183 if (EQ (fun, Qunbound))
2185 /* Let funcall get the error */
2186 fun = args[0];
2187 goto funcall;
2190 if (SUBRP (fun))
2192 if (numargs < XSUBR (fun)->min_args
2193 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2194 goto funcall; /* Let funcall get the error */
2195 else if (XSUBR (fun)->max_args > numargs)
2197 /* Avoid making funcall cons up a yet another new vector of arguments
2198 by explicitly supplying nil's for optional values */
2199 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2200 * sizeof (Lisp_Object));
2201 for (i = numargs; i < XSUBR (fun)->max_args;)
2202 funcall_args[++i] = Qnil;
2203 GCPRO1 (*funcall_args);
2204 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2207 funcall:
2208 /* We add 1 to numargs because funcall_args includes the
2209 function itself as well as its arguments. */
2210 if (!funcall_args)
2212 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
2213 * sizeof (Lisp_Object));
2214 GCPRO1 (*funcall_args);
2215 gcpro1.nvars = 1 + numargs;
2218 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2219 /* Spread the last arg we got. Its first element goes in
2220 the slot that it used to occupy, hence this value of I. */
2221 i = nargs - 1;
2222 while (!NILP (spread_arg))
2224 funcall_args [i++] = XCAR (spread_arg);
2225 spread_arg = XCDR (spread_arg);
2228 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
2231 /* Run hook variables in various ways. */
2233 enum run_hooks_condition {to_completion, until_success, until_failure};
2234 static Lisp_Object run_hook_with_args P_ ((int, Lisp_Object *,
2235 enum run_hooks_condition));
2237 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2238 doc: /* Run each hook in HOOKS. Major mode functions use this.
2239 Each argument should be a symbol, a hook variable.
2240 These symbols are processed in the order specified.
2241 If a hook symbol has a non-nil value, that value may be a function
2242 or a list of functions to be called to run the hook.
2243 If the value is a function, it is called with no arguments.
2244 If it is a list, the elements are called, in order, with no arguments.
2246 Do not use `make-local-variable' to make a hook variable buffer-local.
2247 Instead, use `add-hook' and specify t for the LOCAL argument.
2248 usage: (run-hooks &rest HOOKS) */)
2249 (nargs, args)
2250 int nargs;
2251 Lisp_Object *args;
2253 Lisp_Object hook[1];
2254 register int i;
2256 for (i = 0; i < nargs; i++)
2258 hook[0] = args[i];
2259 run_hook_with_args (1, hook, to_completion);
2262 return Qnil;
2265 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2266 Srun_hook_with_args, 1, MANY, 0,
2267 doc: /* Run HOOK with the specified arguments ARGS.
2268 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2269 value, that value may be a function or a list of functions to be
2270 called to run the hook. If the value is a function, it is called with
2271 the given arguments and its return value is returned. If it is a list
2272 of functions, those functions are called, in order,
2273 with the given arguments ARGS.
2274 It is best not to depend on the value return by `run-hook-with-args',
2275 as that may change.
2277 Do not use `make-local-variable' to make a hook variable buffer-local.
2278 Instead, use `add-hook' and specify t for the LOCAL argument.
2279 usage: (run-hook-with-args HOOK &rest ARGS) */)
2280 (nargs, args)
2281 int nargs;
2282 Lisp_Object *args;
2284 return run_hook_with_args (nargs, args, to_completion);
2287 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2288 Srun_hook_with_args_until_success, 1, MANY, 0,
2289 doc: /* Run HOOK with the specified arguments ARGS.
2290 HOOK should be a symbol, a hook variable. Its value should
2291 be a list of functions. We call those functions, one by one,
2292 passing arguments ARGS to each of them, until one of them
2293 returns a non-nil value. Then we return that value.
2294 If all the functions return nil, we return nil.
2296 Do not use `make-local-variable' to make a hook variable buffer-local.
2297 Instead, use `add-hook' and specify t for the LOCAL argument.
2298 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2299 (nargs, args)
2300 int nargs;
2301 Lisp_Object *args;
2303 return run_hook_with_args (nargs, args, until_success);
2306 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2307 Srun_hook_with_args_until_failure, 1, MANY, 0,
2308 doc: /* Run HOOK with the specified arguments ARGS.
2309 HOOK should be a symbol, a hook variable. Its value should
2310 be a list of functions. We call those functions, one by one,
2311 passing arguments ARGS to each of them, until one of them
2312 returns nil. Then we return nil.
2313 If all the functions return non-nil, we return non-nil.
2315 Do not use `make-local-variable' to make a hook variable buffer-local.
2316 Instead, use `add-hook' and specify t for the LOCAL argument.
2317 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2318 (nargs, args)
2319 int nargs;
2320 Lisp_Object *args;
2322 return run_hook_with_args (nargs, args, until_failure);
2325 /* ARGS[0] should be a hook symbol.
2326 Call each of the functions in the hook value, passing each of them
2327 as arguments all the rest of ARGS (all NARGS - 1 elements).
2328 COND specifies a condition to test after each call
2329 to decide whether to stop.
2330 The caller (or its caller, etc) must gcpro all of ARGS,
2331 except that it isn't necessary to gcpro ARGS[0]. */
2333 static Lisp_Object
2334 run_hook_with_args (nargs, args, cond)
2335 int nargs;
2336 Lisp_Object *args;
2337 enum run_hooks_condition cond;
2339 Lisp_Object sym, val, ret;
2340 Lisp_Object globals;
2341 struct gcpro gcpro1, gcpro2, gcpro3;
2343 /* If we are dying or still initializing,
2344 don't do anything--it would probably crash if we tried. */
2345 if (NILP (Vrun_hooks))
2346 return Qnil;
2348 sym = args[0];
2349 val = find_symbol_value (sym);
2350 ret = (cond == until_failure ? Qt : Qnil);
2352 if (EQ (val, Qunbound) || NILP (val))
2353 return ret;
2354 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2356 args[0] = val;
2357 return Ffuncall (nargs, args);
2359 else
2361 globals = Qnil;
2362 GCPRO3 (sym, val, globals);
2364 for (;
2365 CONSP (val) && ((cond == to_completion)
2366 || (cond == until_success ? NILP (ret)
2367 : !NILP (ret)));
2368 val = XCDR (val))
2370 if (EQ (XCAR (val), Qt))
2372 /* t indicates this hook has a local binding;
2373 it means to run the global binding too. */
2375 for (globals = Fdefault_value (sym);
2376 CONSP (globals) && ((cond == to_completion)
2377 || (cond == until_success ? NILP (ret)
2378 : !NILP (ret)));
2379 globals = XCDR (globals))
2381 args[0] = XCAR (globals);
2382 /* In a global value, t should not occur. If it does, we
2383 must ignore it to avoid an endless loop. */
2384 if (!EQ (args[0], Qt))
2385 ret = Ffuncall (nargs, args);
2388 else
2390 args[0] = XCAR (val);
2391 ret = Ffuncall (nargs, args);
2395 UNGCPRO;
2396 return ret;
2400 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2401 present value of that symbol.
2402 Call each element of FUNLIST,
2403 passing each of them the rest of ARGS.
2404 The caller (or its caller, etc) must gcpro all of ARGS,
2405 except that it isn't necessary to gcpro ARGS[0]. */
2407 Lisp_Object
2408 run_hook_list_with_args (funlist, nargs, args)
2409 Lisp_Object funlist;
2410 int nargs;
2411 Lisp_Object *args;
2413 Lisp_Object sym;
2414 Lisp_Object val;
2415 Lisp_Object globals;
2416 struct gcpro gcpro1, gcpro2, gcpro3;
2418 sym = args[0];
2419 globals = Qnil;
2420 GCPRO3 (sym, val, globals);
2422 for (val = funlist; CONSP (val); val = XCDR (val))
2424 if (EQ (XCAR (val), Qt))
2426 /* t indicates this hook has a local binding;
2427 it means to run the global binding too. */
2429 for (globals = Fdefault_value (sym);
2430 CONSP (globals);
2431 globals = XCDR (globals))
2433 args[0] = XCAR (globals);
2434 /* In a global value, t should not occur. If it does, we
2435 must ignore it to avoid an endless loop. */
2436 if (!EQ (args[0], Qt))
2437 Ffuncall (nargs, args);
2440 else
2442 args[0] = XCAR (val);
2443 Ffuncall (nargs, args);
2446 UNGCPRO;
2447 return Qnil;
2450 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2452 void
2453 run_hook_with_args_2 (hook, arg1, arg2)
2454 Lisp_Object hook, arg1, arg2;
2456 Lisp_Object temp[3];
2457 temp[0] = hook;
2458 temp[1] = arg1;
2459 temp[2] = arg2;
2461 Frun_hook_with_args (3, temp);
2464 /* Apply fn to arg */
2465 Lisp_Object
2466 apply1 (fn, arg)
2467 Lisp_Object fn, arg;
2469 struct gcpro gcpro1;
2471 GCPRO1 (fn);
2472 if (NILP (arg))
2473 RETURN_UNGCPRO (Ffuncall (1, &fn));
2474 gcpro1.nvars = 2;
2475 #ifdef NO_ARG_ARRAY
2477 Lisp_Object args[2];
2478 args[0] = fn;
2479 args[1] = arg;
2480 gcpro1.var = args;
2481 RETURN_UNGCPRO (Fapply (2, args));
2483 #else /* not NO_ARG_ARRAY */
2484 RETURN_UNGCPRO (Fapply (2, &fn));
2485 #endif /* not NO_ARG_ARRAY */
2488 /* Call function fn on no arguments */
2489 Lisp_Object
2490 call0 (fn)
2491 Lisp_Object fn;
2493 struct gcpro gcpro1;
2495 GCPRO1 (fn);
2496 RETURN_UNGCPRO (Ffuncall (1, &fn));
2499 /* Call function fn with 1 argument arg1 */
2500 /* ARGSUSED */
2501 Lisp_Object
2502 call1 (fn, arg1)
2503 Lisp_Object fn, arg1;
2505 struct gcpro gcpro1;
2506 #ifdef NO_ARG_ARRAY
2507 Lisp_Object args[2];
2509 args[0] = fn;
2510 args[1] = arg1;
2511 GCPRO1 (args[0]);
2512 gcpro1.nvars = 2;
2513 RETURN_UNGCPRO (Ffuncall (2, args));
2514 #else /* not NO_ARG_ARRAY */
2515 GCPRO1 (fn);
2516 gcpro1.nvars = 2;
2517 RETURN_UNGCPRO (Ffuncall (2, &fn));
2518 #endif /* not NO_ARG_ARRAY */
2521 /* Call function fn with 2 arguments arg1, arg2 */
2522 /* ARGSUSED */
2523 Lisp_Object
2524 call2 (fn, arg1, arg2)
2525 Lisp_Object fn, arg1, arg2;
2527 struct gcpro gcpro1;
2528 #ifdef NO_ARG_ARRAY
2529 Lisp_Object args[3];
2530 args[0] = fn;
2531 args[1] = arg1;
2532 args[2] = arg2;
2533 GCPRO1 (args[0]);
2534 gcpro1.nvars = 3;
2535 RETURN_UNGCPRO (Ffuncall (3, args));
2536 #else /* not NO_ARG_ARRAY */
2537 GCPRO1 (fn);
2538 gcpro1.nvars = 3;
2539 RETURN_UNGCPRO (Ffuncall (3, &fn));
2540 #endif /* not NO_ARG_ARRAY */
2543 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2544 /* ARGSUSED */
2545 Lisp_Object
2546 call3 (fn, arg1, arg2, arg3)
2547 Lisp_Object fn, arg1, arg2, arg3;
2549 struct gcpro gcpro1;
2550 #ifdef NO_ARG_ARRAY
2551 Lisp_Object args[4];
2552 args[0] = fn;
2553 args[1] = arg1;
2554 args[2] = arg2;
2555 args[3] = arg3;
2556 GCPRO1 (args[0]);
2557 gcpro1.nvars = 4;
2558 RETURN_UNGCPRO (Ffuncall (4, args));
2559 #else /* not NO_ARG_ARRAY */
2560 GCPRO1 (fn);
2561 gcpro1.nvars = 4;
2562 RETURN_UNGCPRO (Ffuncall (4, &fn));
2563 #endif /* not NO_ARG_ARRAY */
2566 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2567 /* ARGSUSED */
2568 Lisp_Object
2569 call4 (fn, arg1, arg2, arg3, arg4)
2570 Lisp_Object fn, arg1, arg2, arg3, arg4;
2572 struct gcpro gcpro1;
2573 #ifdef NO_ARG_ARRAY
2574 Lisp_Object args[5];
2575 args[0] = fn;
2576 args[1] = arg1;
2577 args[2] = arg2;
2578 args[3] = arg3;
2579 args[4] = arg4;
2580 GCPRO1 (args[0]);
2581 gcpro1.nvars = 5;
2582 RETURN_UNGCPRO (Ffuncall (5, args));
2583 #else /* not NO_ARG_ARRAY */
2584 GCPRO1 (fn);
2585 gcpro1.nvars = 5;
2586 RETURN_UNGCPRO (Ffuncall (5, &fn));
2587 #endif /* not NO_ARG_ARRAY */
2590 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2591 /* ARGSUSED */
2592 Lisp_Object
2593 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2594 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2596 struct gcpro gcpro1;
2597 #ifdef NO_ARG_ARRAY
2598 Lisp_Object args[6];
2599 args[0] = fn;
2600 args[1] = arg1;
2601 args[2] = arg2;
2602 args[3] = arg3;
2603 args[4] = arg4;
2604 args[5] = arg5;
2605 GCPRO1 (args[0]);
2606 gcpro1.nvars = 6;
2607 RETURN_UNGCPRO (Ffuncall (6, args));
2608 #else /* not NO_ARG_ARRAY */
2609 GCPRO1 (fn);
2610 gcpro1.nvars = 6;
2611 RETURN_UNGCPRO (Ffuncall (6, &fn));
2612 #endif /* not NO_ARG_ARRAY */
2615 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2616 /* ARGSUSED */
2617 Lisp_Object
2618 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2619 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2621 struct gcpro gcpro1;
2622 #ifdef NO_ARG_ARRAY
2623 Lisp_Object args[7];
2624 args[0] = fn;
2625 args[1] = arg1;
2626 args[2] = arg2;
2627 args[3] = arg3;
2628 args[4] = arg4;
2629 args[5] = arg5;
2630 args[6] = arg6;
2631 GCPRO1 (args[0]);
2632 gcpro1.nvars = 7;
2633 RETURN_UNGCPRO (Ffuncall (7, args));
2634 #else /* not NO_ARG_ARRAY */
2635 GCPRO1 (fn);
2636 gcpro1.nvars = 7;
2637 RETURN_UNGCPRO (Ffuncall (7, &fn));
2638 #endif /* not NO_ARG_ARRAY */
2641 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2642 doc: /* Call first argument as a function, passing remaining arguments to it.
2643 Return the value that function returns.
2644 Thus, (funcall 'cons 'x 'y) returns (x . y).
2645 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2646 (nargs, args)
2647 int nargs;
2648 Lisp_Object *args;
2650 Lisp_Object fun;
2651 Lisp_Object funcar;
2652 int numargs = nargs - 1;
2653 Lisp_Object lisp_numargs;
2654 Lisp_Object val;
2655 struct backtrace backtrace;
2656 register Lisp_Object *internal_args;
2657 register int i;
2659 QUIT;
2660 if (consing_since_gc > gc_cons_threshold)
2661 Fgarbage_collect ();
2663 if (++lisp_eval_depth > max_lisp_eval_depth)
2665 if (max_lisp_eval_depth < 100)
2666 max_lisp_eval_depth = 100;
2667 if (lisp_eval_depth > max_lisp_eval_depth)
2668 error ("Lisp nesting exceeds max-lisp-eval-depth");
2671 backtrace.next = backtrace_list;
2672 backtrace_list = &backtrace;
2673 backtrace.function = &args[0];
2674 backtrace.args = &args[1];
2675 backtrace.nargs = nargs - 1;
2676 backtrace.evalargs = 0;
2677 backtrace.debug_on_exit = 0;
2679 if (debug_on_next_call)
2680 do_debug_on_call (Qlambda);
2682 retry:
2684 fun = args[0];
2686 fun = Findirect_function (fun);
2688 if (SUBRP (fun))
2690 if (numargs < XSUBR (fun)->min_args
2691 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2693 XSETFASTINT (lisp_numargs, numargs);
2694 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
2697 if (XSUBR (fun)->max_args == UNEVALLED)
2698 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2700 if (XSUBR (fun)->max_args == MANY)
2702 val = (*XSUBR (fun)->function) (numargs, args + 1);
2703 goto done;
2706 if (XSUBR (fun)->max_args > numargs)
2708 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
2709 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
2710 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2711 internal_args[i] = Qnil;
2713 else
2714 internal_args = args + 1;
2715 switch (XSUBR (fun)->max_args)
2717 case 0:
2718 val = (*XSUBR (fun)->function) ();
2719 goto done;
2720 case 1:
2721 val = (*XSUBR (fun)->function) (internal_args[0]);
2722 goto done;
2723 case 2:
2724 val = (*XSUBR (fun)->function) (internal_args[0],
2725 internal_args[1]);
2726 goto done;
2727 case 3:
2728 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2729 internal_args[2]);
2730 goto done;
2731 case 4:
2732 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2733 internal_args[2],
2734 internal_args[3]);
2735 goto done;
2736 case 5:
2737 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2738 internal_args[2], internal_args[3],
2739 internal_args[4]);
2740 goto done;
2741 case 6:
2742 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2743 internal_args[2], internal_args[3],
2744 internal_args[4], internal_args[5]);
2745 goto done;
2746 case 7:
2747 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2748 internal_args[2], internal_args[3],
2749 internal_args[4], internal_args[5],
2750 internal_args[6]);
2751 goto done;
2753 case 8:
2754 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2755 internal_args[2], internal_args[3],
2756 internal_args[4], internal_args[5],
2757 internal_args[6], internal_args[7]);
2758 goto done;
2760 default:
2762 /* If a subr takes more than 8 arguments without using MANY
2763 or UNEVALLED, we need to extend this function to support it.
2764 Until this is done, there is no way to call the function. */
2765 abort ();
2768 if (COMPILEDP (fun))
2769 val = funcall_lambda (fun, numargs, args + 1);
2770 else
2772 if (!CONSP (fun))
2773 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2774 funcar = Fcar (fun);
2775 if (!SYMBOLP (funcar))
2776 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2777 if (EQ (funcar, Qlambda))
2778 val = funcall_lambda (fun, numargs, args + 1);
2779 else if (EQ (funcar, Qautoload))
2781 do_autoload (fun, args[0]);
2782 goto retry;
2784 else
2785 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2787 done:
2788 lisp_eval_depth--;
2789 if (backtrace.debug_on_exit)
2790 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2791 backtrace_list = backtrace.next;
2792 return val;
2795 Lisp_Object
2796 apply_lambda (fun, args, eval_flag)
2797 Lisp_Object fun, args;
2798 int eval_flag;
2800 Lisp_Object args_left;
2801 Lisp_Object numargs;
2802 register Lisp_Object *arg_vector;
2803 struct gcpro gcpro1, gcpro2, gcpro3;
2804 register int i;
2805 register Lisp_Object tem;
2807 numargs = Flength (args);
2808 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2809 args_left = args;
2811 GCPRO3 (*arg_vector, args_left, fun);
2812 gcpro1.nvars = 0;
2814 for (i = 0; i < XINT (numargs);)
2816 tem = Fcar (args_left), args_left = Fcdr (args_left);
2817 if (eval_flag) tem = Feval (tem);
2818 arg_vector[i++] = tem;
2819 gcpro1.nvars = i;
2822 UNGCPRO;
2824 if (eval_flag)
2826 backtrace_list->args = arg_vector;
2827 backtrace_list->nargs = i;
2829 backtrace_list->evalargs = 0;
2830 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2832 /* Do the debug-on-exit now, while arg_vector still exists. */
2833 if (backtrace_list->debug_on_exit)
2834 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2835 /* Don't do it again when we return to eval. */
2836 backtrace_list->debug_on_exit = 0;
2837 return tem;
2840 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2841 and return the result of evaluation.
2842 FUN must be either a lambda-expression or a compiled-code object. */
2844 static Lisp_Object
2845 funcall_lambda (fun, nargs, arg_vector)
2846 Lisp_Object fun;
2847 int nargs;
2848 register Lisp_Object *arg_vector;
2850 Lisp_Object val, syms_left, next;
2851 int count = specpdl_ptr - specpdl;
2852 int i, optional, rest;
2854 if (CONSP (fun))
2856 syms_left = XCDR (fun);
2857 if (CONSP (syms_left))
2858 syms_left = XCAR (syms_left);
2859 else
2860 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2862 else if (COMPILEDP (fun))
2863 syms_left = AREF (fun, COMPILED_ARGLIST);
2864 else
2865 abort ();
2867 i = optional = rest = 0;
2868 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
2870 QUIT;
2872 next = XCAR (syms_left);
2873 while (!SYMBOLP (next))
2874 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2876 if (EQ (next, Qand_rest))
2877 rest = 1;
2878 else if (EQ (next, Qand_optional))
2879 optional = 1;
2880 else if (rest)
2882 specbind (next, Flist (nargs - i, &arg_vector[i]));
2883 i = nargs;
2885 else if (i < nargs)
2886 specbind (next, arg_vector[i++]);
2887 else if (!optional)
2888 return Fsignal (Qwrong_number_of_arguments,
2889 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2890 else
2891 specbind (next, Qnil);
2894 if (!NILP (syms_left))
2895 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2896 else if (i < nargs)
2897 return Fsignal (Qwrong_number_of_arguments,
2898 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2900 if (CONSP (fun))
2901 val = Fprogn (XCDR (XCDR (fun)));
2902 else
2904 /* If we have not actually read the bytecode string
2905 and constants vector yet, fetch them from the file. */
2906 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
2907 Ffetch_bytecode (fun);
2908 val = Fbyte_code (AREF (fun, COMPILED_BYTECODE),
2909 AREF (fun, COMPILED_CONSTANTS),
2910 AREF (fun, COMPILED_STACK_DEPTH));
2913 return unbind_to (count, val);
2916 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
2917 1, 1, 0,
2918 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
2919 (object)
2920 Lisp_Object object;
2922 Lisp_Object tem;
2924 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
2926 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
2927 if (!CONSP (tem))
2929 tem = AREF (object, COMPILED_BYTECODE);
2930 if (CONSP (tem) && STRINGP (XCAR (tem)))
2931 error ("Invalid byte code in %s", XSTRING (XCAR (tem))->data);
2932 else
2933 error ("Invalid byte code");
2935 AREF (object, COMPILED_BYTECODE) = XCAR (tem);
2936 AREF (object, COMPILED_CONSTANTS) = XCDR (tem);
2938 return object;
2941 void
2942 grow_specpdl ()
2944 register int count = specpdl_ptr - specpdl;
2945 if (specpdl_size >= max_specpdl_size)
2947 if (max_specpdl_size < 400)
2948 max_specpdl_size = 400;
2949 if (specpdl_size >= max_specpdl_size)
2951 if (!NILP (Vdebug_on_error))
2952 /* Leave room for some specpdl in the debugger. */
2953 max_specpdl_size = specpdl_size + 100;
2954 Fsignal (Qerror,
2955 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2958 specpdl_size *= 2;
2959 if (specpdl_size > max_specpdl_size)
2960 specpdl_size = max_specpdl_size;
2961 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2962 specpdl_ptr = specpdl + count;
2965 void
2966 specbind (symbol, value)
2967 Lisp_Object symbol, value;
2969 Lisp_Object ovalue;
2970 Lisp_Object valcontents;
2972 CHECK_SYMBOL (symbol);
2973 if (specpdl_ptr == specpdl + specpdl_size)
2974 grow_specpdl ();
2976 /* The most common case is that of a non-constant symbol with a
2977 trivial value. Make that as fast as we can. */
2978 valcontents = SYMBOL_VALUE (symbol);
2979 if (!MISCP (valcontents) && !SYMBOL_CONSTANT_P (symbol))
2981 specpdl_ptr->symbol = symbol;
2982 specpdl_ptr->old_value = valcontents;
2983 specpdl_ptr->func = NULL;
2984 ++specpdl_ptr;
2985 SET_SYMBOL_VALUE (symbol, value);
2987 else
2989 Lisp_Object valcontents;
2991 ovalue = find_symbol_value (symbol);
2992 specpdl_ptr->func = 0;
2993 specpdl_ptr->old_value = ovalue;
2995 valcontents = XSYMBOL (symbol)->value;
2997 if (BUFFER_LOCAL_VALUEP (valcontents)
2998 || SOME_BUFFER_LOCAL_VALUEP (valcontents)
2999 || BUFFER_OBJFWDP (valcontents))
3001 Lisp_Object where, current_buffer;
3003 current_buffer = Fcurrent_buffer ();
3005 /* For a local variable, record both the symbol and which
3006 buffer's or frame's value we are saving. */
3007 if (!NILP (Flocal_variable_p (symbol, Qnil)))
3008 where = current_buffer;
3009 else if (!BUFFER_OBJFWDP (valcontents)
3010 && XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame)
3011 where = XBUFFER_LOCAL_VALUE (valcontents)->frame;
3012 else
3013 where = Qnil;
3015 /* We're not using the `unused' slot in the specbinding
3016 structure because this would mean we have to do more
3017 work for simple variables. */
3018 specpdl_ptr->symbol = Fcons (symbol, Fcons (where, current_buffer));
3020 /* If SYMBOL is a per-buffer variable which doesn't have a
3021 buffer-local value here, make the `let' change the global
3022 value by changing the value of SYMBOL in all buffers not
3023 having their own value. This is consistent with what
3024 happens with other buffer-local variables. */
3025 if (NILP (where)
3026 && BUFFER_OBJFWDP (valcontents))
3028 ++specpdl_ptr;
3029 Fset_default (symbol, value);
3030 return;
3033 else
3034 specpdl_ptr->symbol = symbol;
3036 specpdl_ptr++;
3037 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3038 store_symval_forwarding (symbol, ovalue, value, NULL);
3039 else
3040 set_internal (symbol, value, 0, 1);
3044 void
3045 record_unwind_protect (function, arg)
3046 Lisp_Object (*function) P_ ((Lisp_Object));
3047 Lisp_Object arg;
3049 if (specpdl_ptr == specpdl + specpdl_size)
3050 grow_specpdl ();
3051 specpdl_ptr->func = function;
3052 specpdl_ptr->symbol = Qnil;
3053 specpdl_ptr->old_value = arg;
3054 specpdl_ptr++;
3057 Lisp_Object
3058 unbind_to (count, value)
3059 int count;
3060 Lisp_Object value;
3062 int quitf = !NILP (Vquit_flag);
3063 struct gcpro gcpro1;
3065 GCPRO1 (value);
3066 Vquit_flag = Qnil;
3068 while (specpdl_ptr != specpdl + count)
3070 --specpdl_ptr;
3072 if (specpdl_ptr->func != 0)
3073 (*specpdl_ptr->func) (specpdl_ptr->old_value);
3074 /* Note that a "binding" of nil is really an unwind protect,
3075 so in that case the "old value" is a list of forms to evaluate. */
3076 else if (NILP (specpdl_ptr->symbol))
3077 Fprogn (specpdl_ptr->old_value);
3078 /* If the symbol is a list, it is really (SYMBOL WHERE
3079 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3080 frame. If WHERE is a buffer or frame, this indicates we
3081 bound a variable that had a buffer-local or frame-local
3082 binding. WHERE nil means that the variable had the default
3083 value when it was bound. CURRENT-BUFFER is the buffer that
3084 was current when the variable was bound. */
3085 else if (CONSP (specpdl_ptr->symbol))
3087 Lisp_Object symbol, where;
3089 symbol = XCAR (specpdl_ptr->symbol);
3090 where = XCAR (XCDR (specpdl_ptr->symbol));
3092 if (NILP (where))
3093 Fset_default (symbol, specpdl_ptr->old_value);
3094 else if (BUFFERP (where))
3095 set_internal (symbol, specpdl_ptr->old_value, XBUFFER (where), 1);
3096 else
3097 set_internal (symbol, specpdl_ptr->old_value, NULL, 1);
3099 else
3101 /* If variable has a trivial value (no forwarding), we can
3102 just set it. No need to check for constant symbols here,
3103 since that was already done by specbind. */
3104 if (!MISCP (SYMBOL_VALUE (specpdl_ptr->symbol)))
3105 SET_SYMBOL_VALUE (specpdl_ptr->symbol, specpdl_ptr->old_value);
3106 else
3107 set_internal (specpdl_ptr->symbol, specpdl_ptr->old_value, 0, 1);
3111 if (NILP (Vquit_flag) && quitf)
3112 Vquit_flag = Qt;
3114 UNGCPRO;
3115 return value;
3118 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3119 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3120 The debugger is entered when that frame exits, if the flag is non-nil. */)
3121 (level, flag)
3122 Lisp_Object level, flag;
3124 register struct backtrace *backlist = backtrace_list;
3125 register int i;
3127 CHECK_NUMBER (level);
3129 for (i = 0; backlist && i < XINT (level); i++)
3131 backlist = backlist->next;
3134 if (backlist)
3135 backlist->debug_on_exit = !NILP (flag);
3137 return flag;
3140 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3141 doc: /* Print a trace of Lisp function calls currently active.
3142 Output stream used is value of `standard-output'. */)
3145 register struct backtrace *backlist = backtrace_list;
3146 register int i;
3147 Lisp_Object tail;
3148 Lisp_Object tem;
3149 extern Lisp_Object Vprint_level;
3150 struct gcpro gcpro1;
3152 XSETFASTINT (Vprint_level, 3);
3154 tail = Qnil;
3155 GCPRO1 (tail);
3157 while (backlist)
3159 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3160 if (backlist->nargs == UNEVALLED)
3162 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3163 write_string ("\n", -1);
3165 else
3167 tem = *backlist->function;
3168 Fprin1 (tem, Qnil); /* This can QUIT */
3169 write_string ("(", -1);
3170 if (backlist->nargs == MANY)
3172 for (tail = *backlist->args, i = 0;
3173 !NILP (tail);
3174 tail = Fcdr (tail), i++)
3176 if (i) write_string (" ", -1);
3177 Fprin1 (Fcar (tail), Qnil);
3180 else
3182 for (i = 0; i < backlist->nargs; i++)
3184 if (i) write_string (" ", -1);
3185 Fprin1 (backlist->args[i], Qnil);
3188 write_string (")\n", -1);
3190 backlist = backlist->next;
3193 Vprint_level = Qnil;
3194 UNGCPRO;
3195 return Qnil;
3198 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3199 doc: /* Return the function and arguments NFRAMES up from current execution point.
3200 If that frame has not evaluated the arguments yet (or is a special form),
3201 the value is (nil FUNCTION ARG-FORMS...).
3202 If that frame has evaluated its arguments and called its function already,
3203 the value is (t FUNCTION ARG-VALUES...).
3204 A &rest arg is represented as the tail of the list ARG-VALUES.
3205 FUNCTION is whatever was supplied as car of evaluated list,
3206 or a lambda expression for macro calls.
3207 If NFRAMES is more than the number of frames, the value is nil. */)
3208 (nframes)
3209 Lisp_Object nframes;
3211 register struct backtrace *backlist = backtrace_list;
3212 register int i;
3213 Lisp_Object tem;
3215 CHECK_NATNUM (nframes);
3217 /* Find the frame requested. */
3218 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3219 backlist = backlist->next;
3221 if (!backlist)
3222 return Qnil;
3223 if (backlist->nargs == UNEVALLED)
3224 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3225 else
3227 if (backlist->nargs == MANY)
3228 tem = *backlist->args;
3229 else
3230 tem = Flist (backlist->nargs, backlist->args);
3232 return Fcons (Qt, Fcons (*backlist->function, tem));
3237 void
3238 syms_of_eval ()
3240 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3241 doc: /* *Limit on number of Lisp variable bindings & unwind-protects.
3242 If Lisp code tries to make more than this many at once,
3243 an error is signaled.
3244 You can safely use a value considerably larger than the default value,
3245 if that proves inconveniently small. However, if you increase it too far,
3246 Emacs could run out of memory trying to make the stack bigger. */);
3248 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3249 doc: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3251 This limit serves to catch infinite recursions for you before they cause
3252 actual stack overflow in C, which would be fatal for Emacs.
3253 You can safely make it considerably larger than its default value,
3254 if that proves inconveniently small. However, if you increase it too far,
3255 Emacs could overflow the real C stack, and crash. */);
3257 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3258 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3259 Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'. */);
3260 Vquit_flag = Qnil;
3262 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3263 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3264 Note that `quit-flag' will still be set by typing C-g,
3265 so a quit will be signaled as soon as `inhibit-quit' is nil.
3266 To prevent this happening, set `quit-flag' to nil
3267 before making `inhibit-quit' nil. */);
3268 Vinhibit_quit = Qnil;
3270 Qinhibit_quit = intern ("inhibit-quit");
3271 staticpro (&Qinhibit_quit);
3273 Qautoload = intern ("autoload");
3274 staticpro (&Qautoload);
3276 Qdebug_on_error = intern ("debug-on-error");
3277 staticpro (&Qdebug_on_error);
3279 Qmacro = intern ("macro");
3280 staticpro (&Qmacro);
3282 Qdeclare = intern ("declare");
3283 staticpro (&Qdeclare);
3285 /* Note that the process handling also uses Qexit, but we don't want
3286 to staticpro it twice, so we just do it here. */
3287 Qexit = intern ("exit");
3288 staticpro (&Qexit);
3290 Qinteractive = intern ("interactive");
3291 staticpro (&Qinteractive);
3293 Qcommandp = intern ("commandp");
3294 staticpro (&Qcommandp);
3296 Qdefun = intern ("defun");
3297 staticpro (&Qdefun);
3299 Qand_rest = intern ("&rest");
3300 staticpro (&Qand_rest);
3302 Qand_optional = intern ("&optional");
3303 staticpro (&Qand_optional);
3305 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3306 doc: /* *Non-nil means errors display a backtrace buffer.
3307 More precisely, this happens for any error that is handled
3308 by the editor command loop.
3309 If the value is a list, an error only means to display a backtrace
3310 if one of its condition symbols appears in the list. */);
3311 Vstack_trace_on_error = Qnil;
3313 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3314 doc: /* *Non-nil means enter debugger if an error is signaled.
3315 Does not apply to errors handled by `condition-case' or those
3316 matched by `debug-ignored-errors'.
3317 If the value is a list, an error only means to enter the debugger
3318 if one of its condition symbols appears in the list.
3319 When you evaluate an expression interactively, this variable
3320 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3321 See also variable `debug-on-quit'. */);
3322 Vdebug_on_error = Qnil;
3324 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3325 doc: /* *List of errors for which the debugger should not be called.
3326 Each element may be a condition-name or a regexp that matches error messages.
3327 If any element applies to a given error, that error skips the debugger
3328 and just returns to top level.
3329 This overrides the variable `debug-on-error'.
3330 It does not apply to errors handled by `condition-case'. */);
3331 Vdebug_ignored_errors = Qnil;
3333 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3334 doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3335 Does not apply if quit is handled by a `condition-case'.
3336 When you evaluate an expression interactively, this variable
3337 is temporarily non-nil if `eval-expression-debug-on-quit' is non-nil. */);
3338 debug_on_quit = 0;
3340 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3341 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3343 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3344 doc: /* Non-nil means debugger may continue execution.
3345 This is nil when the debugger is called under circumstances where it
3346 might not be safe to continue. */);
3347 debugger_may_continue = 1;
3349 DEFVAR_LISP ("debugger", &Vdebugger,
3350 doc: /* Function to call to invoke debugger.
3351 If due to frame exit, args are `exit' and the value being returned;
3352 this function's value will be returned instead of that.
3353 If due to error, args are `error' and a list of the args to `signal'.
3354 If due to `apply' or `funcall' entry, one arg, `lambda'.
3355 If due to `eval' entry, one arg, t. */);
3356 Vdebugger = Qnil;
3358 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3359 doc: /* If non-nil, this is a function for `signal' to call.
3360 It receives the same arguments that `signal' was given.
3361 The Edebug package uses this to regain control. */);
3362 Vsignal_hook_function = Qnil;
3364 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3365 doc: /* *Non-nil means call the debugger regardless of condition handlers.
3366 Note that `debug-on-error', `debug-on-quit' and friends
3367 still determine whether to handle the particular condition. */);
3368 Vdebug_on_signal = Qnil;
3370 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function,
3371 doc: /* Function to process declarations in a macro definition.
3372 The function will be called with two args MACRO and DECL.
3373 MACRO is the name of the macro being defined.
3374 DECL is a list `(declare ...)' containing the declarations.
3375 The value the function returns is not used. */);
3376 Vmacro_declaration_function = Qnil;
3378 Vrun_hooks = intern ("run-hooks");
3379 staticpro (&Vrun_hooks);
3381 staticpro (&Vautoload_queue);
3382 Vautoload_queue = Qnil;
3383 staticpro (&Vsignaling_function);
3384 Vsignaling_function = Qnil;
3386 defsubr (&Sor);
3387 defsubr (&Sand);
3388 defsubr (&Sif);
3389 defsubr (&Scond);
3390 defsubr (&Sprogn);
3391 defsubr (&Sprog1);
3392 defsubr (&Sprog2);
3393 defsubr (&Ssetq);
3394 defsubr (&Squote);
3395 defsubr (&Sfunction);
3396 defsubr (&Sdefun);
3397 defsubr (&Sdefmacro);
3398 defsubr (&Sdefvar);
3399 defsubr (&Sdefvaralias);
3400 defsubr (&Sdefconst);
3401 defsubr (&Suser_variable_p);
3402 defsubr (&Slet);
3403 defsubr (&SletX);
3404 defsubr (&Swhile);
3405 defsubr (&Smacroexpand);
3406 defsubr (&Scatch);
3407 defsubr (&Sthrow);
3408 defsubr (&Sunwind_protect);
3409 defsubr (&Scondition_case);
3410 defsubr (&Ssignal);
3411 defsubr (&Sinteractive_p);
3412 defsubr (&Scommandp);
3413 defsubr (&Sautoload);
3414 defsubr (&Seval);
3415 defsubr (&Sapply);
3416 defsubr (&Sfuncall);
3417 defsubr (&Srun_hooks);
3418 defsubr (&Srun_hook_with_args);
3419 defsubr (&Srun_hook_with_args_until_success);
3420 defsubr (&Srun_hook_with_args_until_failure);
3421 defsubr (&Sfetch_bytecode);
3422 defsubr (&Sbacktrace_debug);
3423 defsubr (&Sbacktrace);
3424 defsubr (&Sbacktrace_frame);