(For, Fand, Fprogn, un_autoload, do_autoload): Use XCDR, XCAR, CONSP.
[emacs.git] / src / eval.c
blob53272b9bd6813f38a6c7867407415140fc0e9675
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000, 2001, 2002
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 int interrupt_input_blocked;
81 struct byte_stack *byte_stack;
84 struct catchtag *catchlist;
86 #ifdef DEBUG_GCPRO
87 /* Count levels of GCPRO to detect failure to UNGCPRO. */
88 int gcpro_level;
89 #endif
91 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun, Qdefvar;
92 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
93 Lisp_Object Qand_rest, Qand_optional;
94 Lisp_Object Qdebug_on_error;
95 Lisp_Object Qdeclare;
97 /* This holds either the symbol `run-hooks' or nil.
98 It is nil at an early stage of startup, and when Emacs
99 is shutting down. */
101 Lisp_Object Vrun_hooks;
103 /* Non-nil means record all fset's and provide's, to be undone
104 if the file being autoloaded is not fully loaded.
105 They are recorded by being consed onto the front of Vautoload_queue:
106 (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide. */
108 Lisp_Object Vautoload_queue;
110 /* Current number of specbindings allocated in specpdl. */
112 int specpdl_size;
114 /* Pointer to beginning of specpdl. */
116 struct specbinding *specpdl;
118 /* Pointer to first unused element in specpdl. */
120 struct specbinding *specpdl_ptr;
122 /* Maximum size allowed for specpdl allocation */
124 EMACS_INT max_specpdl_size;
126 /* Depth in Lisp evaluations and function calls. */
128 int lisp_eval_depth;
130 /* Maximum allowed depth in Lisp evaluations and function calls. */
132 EMACS_INT max_lisp_eval_depth;
134 /* Nonzero means enter debugger before next function call */
136 int debug_on_next_call;
138 /* Non-zero means debugger may continue. This is zero when the
139 debugger is called during redisplay, where it might not be safe to
140 continue the interrupted redisplay. */
142 int debugger_may_continue;
144 /* List of conditions (non-nil atom means all) which cause a backtrace
145 if an error is handled by the command loop's error handler. */
147 Lisp_Object Vstack_trace_on_error;
149 /* List of conditions (non-nil atom means all) which enter the debugger
150 if an error is handled by the command loop's error handler. */
152 Lisp_Object Vdebug_on_error;
154 /* List of conditions and regexps specifying error messages which
155 do not enter the debugger even if Vdebug_on_error says they should. */
157 Lisp_Object Vdebug_ignored_errors;
159 /* Non-nil means call the debugger even if the error will be handled. */
161 Lisp_Object Vdebug_on_signal;
163 /* Hook for edebug to use. */
165 Lisp_Object Vsignal_hook_function;
167 /* Nonzero means enter debugger if a quit signal
168 is handled by the command loop's error handler. */
170 int debug_on_quit;
172 /* The value of num_nonmacro_input_events as of the last time we
173 started to enter the debugger. If we decide to enter the debugger
174 again when this is still equal to num_nonmacro_input_events, then we
175 know that the debugger itself has an error, and we should just
176 signal the error instead of entering an infinite loop of debugger
177 invocations. */
179 int when_entered_debugger;
181 Lisp_Object Vdebugger;
183 /* The function from which the last `signal' was called. Set in
184 Fsignal. */
186 Lisp_Object Vsignaling_function;
188 /* Set to non-zero while processing X events. Checked in Feval to
189 make sure the Lisp interpreter isn't called from a signal handler,
190 which is unsafe because the interpreter isn't reentrant. */
192 int handling_signal;
194 /* Function to process declarations in defmacro forms. */
196 Lisp_Object Vmacro_declaration_function;
199 static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
201 void
202 init_eval_once ()
204 specpdl_size = 50;
205 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
206 specpdl_ptr = specpdl;
207 max_specpdl_size = 600;
208 max_lisp_eval_depth = 300;
210 Vrun_hooks = Qnil;
213 void
214 init_eval ()
216 specpdl_ptr = specpdl;
217 catchlist = 0;
218 handlerlist = 0;
219 backtrace_list = 0;
220 Vquit_flag = Qnil;
221 debug_on_next_call = 0;
222 lisp_eval_depth = 0;
223 #ifdef DEBUG_GCPRO
224 gcpro_level = 0;
225 #endif
226 /* This is less than the initial value of num_nonmacro_input_events. */
227 when_entered_debugger = -1;
230 Lisp_Object
231 call_debugger (arg)
232 Lisp_Object arg;
234 int debug_while_redisplaying;
235 int count = SPECPDL_INDEX ();
236 Lisp_Object val;
238 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
239 max_lisp_eval_depth = lisp_eval_depth + 20;
241 if (specpdl_size + 40 > max_specpdl_size)
242 max_specpdl_size = specpdl_size + 40;
244 #ifdef HAVE_X_WINDOWS
245 if (display_hourglass_p)
246 cancel_hourglass ();
247 #endif
249 debug_on_next_call = 0;
250 when_entered_debugger = num_nonmacro_input_events;
252 /* Resetting redisplaying_p to 0 makes sure that debug output is
253 displayed if the debugger is invoked during redisplay. */
254 debug_while_redisplaying = redisplaying_p;
255 redisplaying_p = 0;
256 specbind (intern ("debugger-may-continue"),
257 debug_while_redisplaying ? Qnil : Qt);
258 specbind (Qinhibit_redisplay, Qnil);
260 #if 0 /* Binding this prevents execution of Lisp code during
261 redisplay, which necessarily leads to display problems. */
262 specbind (Qinhibit_eval_during_redisplay, Qt);
263 #endif
265 val = apply1 (Vdebugger, arg);
267 /* Interrupting redisplay and resuming it later is not safe under
268 all circumstances. So, when the debugger returns, abort the
269 interrupted redisplay by going back to the top-level. */
270 if (debug_while_redisplaying)
271 Ftop_level ();
273 return unbind_to (count, val);
276 void
277 do_debug_on_call (code)
278 Lisp_Object code;
280 debug_on_next_call = 0;
281 backtrace_list->debug_on_exit = 1;
282 call_debugger (Fcons (code, Qnil));
285 /* NOTE!!! Every function that can call EVAL must protect its args
286 and temporaries from garbage collection while it needs them.
287 The definition of `For' shows what you have to do. */
289 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
290 doc: /* Eval args until one of them yields non-nil, then return that value.
291 The remaining args are not evalled at all.
292 If all args return nil, return nil.
293 usage: (or CONDITIONS ...) */)
294 (args)
295 Lisp_Object args;
297 register Lisp_Object val = Qnil;
298 struct gcpro gcpro1;
300 GCPRO1 (args);
302 while (CONSP (args))
304 val = Feval (XCAR (args));
305 if (!NILP (val))
306 break;
307 args = XCDR (args);
310 UNGCPRO;
311 return val;
314 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
315 doc: /* Eval args until one of them yields nil, then return nil.
316 The remaining args are not evalled at all.
317 If no arg yields nil, return the last arg's value.
318 usage: (and CONDITIONS ...) */)
319 (args)
320 Lisp_Object args;
322 register Lisp_Object val = Qt;
323 struct gcpro gcpro1;
325 GCPRO1 (args);
327 while (CONSP (args))
329 val = Feval (XCAR (args));
330 if (NILP (val))
331 break;
332 args = XCDR (args);
335 UNGCPRO;
336 return val;
339 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
340 doc: /* If COND yields non-nil, do THEN, else do ELSE...
341 Returns the value of THEN or the value of the last of the ELSE's.
342 THEN must be one expression, but ELSE... can be zero or more expressions.
343 If COND yields nil, and there are no ELSE's, the value is nil.
344 usage: (if COND THEN ELSE...) */)
345 (args)
346 Lisp_Object args;
348 register Lisp_Object cond;
349 struct gcpro gcpro1;
351 GCPRO1 (args);
352 cond = Feval (Fcar (args));
353 UNGCPRO;
355 if (!NILP (cond))
356 return Feval (Fcar (Fcdr (args)));
357 return Fprogn (Fcdr (Fcdr (args)));
360 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
361 doc: /* Try each clause until one succeeds.
362 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
363 and, if the value is non-nil, this clause succeeds:
364 then the expressions in BODY are evaluated and the last one's
365 value is the value of the cond-form.
366 If no clause succeeds, cond returns nil.
367 If a clause has one element, as in (CONDITION),
368 CONDITION's value if non-nil is returned from the cond-form.
369 usage: (cond CLAUSES...) */)
370 (args)
371 Lisp_Object args;
373 register Lisp_Object clause, val;
374 struct gcpro gcpro1;
376 val = Qnil;
377 GCPRO1 (args);
378 while (!NILP (args))
380 clause = Fcar (args);
381 val = Feval (Fcar (clause));
382 if (!NILP (val))
384 if (!EQ (XCDR (clause), Qnil))
385 val = Fprogn (XCDR (clause));
386 break;
388 args = XCDR (args);
390 UNGCPRO;
392 return val;
395 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
396 doc: /* Eval BODY forms sequentially and return value of last one.
397 usage: (progn BODY ...) */)
398 (args)
399 Lisp_Object args;
401 register Lisp_Object val = Qnil;
402 struct gcpro gcpro1;
404 GCPRO1 (args);
406 while (CONSP (args))
408 val = Feval (XCAR (args));
409 args = XCDR (args);
412 UNGCPRO;
413 return val;
416 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
417 doc: /* Eval FIRST and BODY sequentially; value from FIRST.
418 The value of FIRST is saved during the evaluation of the remaining args,
419 whose values are discarded.
420 usage: (prog1 FIRST BODY...) */)
421 (args)
422 Lisp_Object args;
424 Lisp_Object val;
425 register Lisp_Object args_left;
426 struct gcpro gcpro1, gcpro2;
427 register int argnum = 0;
429 if (NILP(args))
430 return Qnil;
432 args_left = args;
433 val = Qnil;
434 GCPRO2 (args, val);
438 if (!(argnum++))
439 val = Feval (Fcar (args_left));
440 else
441 Feval (Fcar (args_left));
442 args_left = Fcdr (args_left);
444 while (!NILP(args_left));
446 UNGCPRO;
447 return val;
450 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
451 doc: /* Eval X, Y and BODY sequentially; value from Y.
452 The value of Y is saved during the evaluation of the remaining args,
453 whose values are discarded.
454 usage: (prog2 X Y BODY...) */)
455 (args)
456 Lisp_Object args;
458 Lisp_Object val;
459 register Lisp_Object args_left;
460 struct gcpro gcpro1, gcpro2;
461 register int argnum = -1;
463 val = Qnil;
465 if (NILP (args))
466 return Qnil;
468 args_left = args;
469 val = Qnil;
470 GCPRO2 (args, val);
474 if (!(argnum++))
475 val = Feval (Fcar (args_left));
476 else
477 Feval (Fcar (args_left));
478 args_left = Fcdr (args_left);
480 while (!NILP (args_left));
482 UNGCPRO;
483 return val;
486 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
487 doc: /* Set each SYM to the value of its VAL.
488 The symbols SYM are variables; they are literal (not evaluated).
489 The values VAL are expressions; they are evaluated.
490 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
491 The second VAL is not computed until after the first SYM is set, and so on;
492 each VAL can use the new value of variables set earlier in the `setq'.
493 The return value of the `setq' form is the value of the last VAL.
494 usage: (setq SYM VAL SYM VAL ...) */)
495 (args)
496 Lisp_Object args;
498 register Lisp_Object args_left;
499 register Lisp_Object val, sym;
500 struct gcpro gcpro1;
502 if (NILP(args))
503 return Qnil;
505 args_left = args;
506 GCPRO1 (args);
510 val = Feval (Fcar (Fcdr (args_left)));
511 sym = Fcar (args_left);
512 Fset (sym, val);
513 args_left = Fcdr (Fcdr (args_left));
515 while (!NILP(args_left));
517 UNGCPRO;
518 return val;
521 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
522 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
523 usage: (quote ARG) */)
524 (args)
525 Lisp_Object args;
527 return Fcar (args);
530 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
531 doc: /* Like `quote', but preferred for objects which are functions.
532 In byte compilation, `function' causes its argument to be compiled.
533 `quote' cannot do that.
534 usage: (function ARG) */)
535 (args)
536 Lisp_Object args;
538 return Fcar (args);
542 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
543 doc: /* Return t if function in which this appears was called interactively.
544 This means that the function was called with call-interactively (which
545 includes being called as the binding of a key)
546 and input is currently coming from the keyboard (not in keyboard macro). */)
549 return interactive_p (1) ? Qt : Qnil;
553 /* Return 1 if function in which this appears was called
554 interactively. This means that the function was called with
555 call-interactively (which includes being called as the binding of
556 a key) and input is currently coming from the keyboard (not in
557 keyboard macro).
559 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
560 called is a built-in. */
563 interactive_p (exclude_subrs_p)
564 int exclude_subrs_p;
566 struct backtrace *btp;
567 Lisp_Object fun;
569 if (!INTERACTIVE)
570 return 0;
572 btp = backtrace_list;
574 /* If this isn't a byte-compiled function, there may be a frame at
575 the top for Finteractive_p. If so, skip it. */
576 fun = Findirect_function (*btp->function);
577 if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
578 btp = btp->next;
580 /* If we're running an Emacs 18-style byte-compiled function, there
581 may be a frame for Fbytecode at the top level. In any version of
582 Emacs there can be Fbytecode frames for subexpressions evaluated
583 inside catch and condition-case. Skip past them.
585 If this isn't a byte-compiled function, then we may now be
586 looking at several frames for special forms. Skip past them. */
587 while (btp
588 && (EQ (*btp->function, Qbytecode)
589 || btp->nargs == UNEVALLED))
590 btp = btp->next;
592 /* btp now points at the frame of the innermost function that isn't
593 a special form, ignoring frames for Finteractive_p and/or
594 Fbytecode at the top. If this frame is for a built-in function
595 (such as load or eval-region) return nil. */
596 fun = Findirect_function (*btp->function);
597 if (exclude_subrs_p && SUBRP (fun))
598 return 0;
600 /* btp points to the frame of a Lisp function that called interactive-p.
601 Return t if that function was called interactively. */
602 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
603 return 1;
604 return 0;
608 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
609 doc: /* Define NAME as a function.
610 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
611 See also the function `interactive'.
612 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
613 (args)
614 Lisp_Object args;
616 register Lisp_Object fn_name;
617 register Lisp_Object defn;
619 fn_name = Fcar (args);
620 defn = Fcons (Qlambda, Fcdr (args));
621 if (!NILP (Vpurify_flag))
622 defn = Fpurecopy (defn);
623 if (CONSP (XSYMBOL (fn_name)->function)
624 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
625 LOADHIST_ATTACH (Fcons (Qt, fn_name));
626 Ffset (fn_name, defn);
627 LOADHIST_ATTACH (fn_name);
628 return fn_name;
631 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
632 doc: /* Define NAME as a macro.
633 The actual definition looks like
634 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
635 When the macro is called, as in (NAME ARGS...),
636 the function (lambda ARGLIST BODY...) is applied to
637 the list ARGS... as it appears in the expression,
638 and the result should be a form to be evaluated instead of the original.
640 DECL is a declaration, optional, which can specify how to indent
641 calls to this macro and how Edebug should handle it. It looks like this:
642 (declare SPECS...)
643 The elements can look like this:
644 (indent INDENT)
645 Set NAME's `lisp-indent-function' property to INDENT.
647 (debug DEBUG)
648 Set NAME's `edebug-form-spec' property to DEBUG. (This is
649 equivalent to writing a `def-edebug-spec' for the macro.)
650 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
651 (args)
652 Lisp_Object args;
654 register Lisp_Object fn_name;
655 register Lisp_Object defn;
656 Lisp_Object lambda_list, doc, tail;
658 fn_name = Fcar (args);
659 lambda_list = Fcar (Fcdr (args));
660 tail = Fcdr (Fcdr (args));
662 doc = Qnil;
663 if (STRINGP (Fcar (tail)))
665 doc = XCAR (tail);
666 tail = XCDR (tail);
669 while (CONSP (Fcar (tail))
670 && EQ (Fcar (Fcar (tail)), Qdeclare))
672 if (!NILP (Vmacro_declaration_function))
674 struct gcpro gcpro1;
675 GCPRO1 (args);
676 call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
677 UNGCPRO;
680 tail = Fcdr (tail);
683 if (NILP (doc))
684 tail = Fcons (lambda_list, tail);
685 else
686 tail = Fcons (lambda_list, Fcons (doc, tail));
687 defn = Fcons (Qmacro, Fcons (Qlambda, tail));
689 if (!NILP (Vpurify_flag))
690 defn = Fpurecopy (defn);
691 if (CONSP (XSYMBOL (fn_name)->function)
692 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
693 LOADHIST_ATTACH (Fcons (Qt, fn_name));
694 Ffset (fn_name, defn);
695 LOADHIST_ATTACH (fn_name);
696 return fn_name;
700 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
701 doc: /* Make SYMBOL a variable alias for symbol ALIASED.
702 Setting the value of SYMBOL will subsequently set the value of ALIASED,
703 and getting the value of SYMBOL will return the value ALIASED has.
704 ALIASED nil means remove the alias; SYMBOL is unbound after that.
705 Third arg DOCSTRING, if non-nil, is documentation for SYMBOL. */)
706 (symbol, aliased, docstring)
707 Lisp_Object symbol, aliased, docstring;
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 (Fcons (Qdefvar, symbol));
722 if (!NILP (docstring))
723 Fput (symbol, Qvariable_documentation, docstring);
725 return aliased;
729 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
730 doc: /* Define SYMBOL as a variable.
731 You are not required to define a variable in order to use it,
732 but the definition can supply documentation and an initial value
733 in a way that tags can recognize.
735 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
736 If SYMBOL is buffer-local, its default value is what is set;
737 buffer-local values are not affected.
738 INITVALUE and DOCSTRING are optional.
739 If DOCSTRING starts with *, this variable is identified as a user option.
740 This means that M-x set-variable recognizes it.
741 See also `user-variable-p'.
742 If INITVALUE is missing, SYMBOL's value is not set.
743 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
744 (args)
745 Lisp_Object args;
747 register Lisp_Object sym, tem, tail;
749 sym = Fcar (args);
750 tail = Fcdr (args);
751 if (!NILP (Fcdr (Fcdr (tail))))
752 error ("too many arguments");
754 tem = Fdefault_boundp (sym);
755 if (!NILP (tail))
757 if (NILP (tem))
758 Fset_default (sym, Feval (Fcar (tail)));
759 tail = Fcdr (tail);
760 tem = Fcar (tail);
761 if (!NILP (tem))
763 if (!NILP (Vpurify_flag))
764 tem = Fpurecopy (tem);
765 Fput (sym, Qvariable_documentation, tem);
767 LOADHIST_ATTACH (Fcons (Qdefvar, sym));
769 else
770 /* Simple (defvar <var>) should not count as a definition at all.
771 It could get in the way of other definitions, and unloading this
772 package could try to make the variable unbound. */
775 return sym;
778 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
779 doc: /* Define SYMBOL as a constant variable.
780 The intent is that neither programs nor users should ever change this value.
781 Always sets the value of SYMBOL to the result of evalling INITVALUE.
782 If SYMBOL is buffer-local, its default value is what is set;
783 buffer-local values are not affected.
784 DOCSTRING is optional.
785 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
786 (args)
787 Lisp_Object args;
789 register Lisp_Object sym, tem;
791 sym = Fcar (args);
792 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
793 error ("too many arguments");
795 tem = Feval (Fcar (Fcdr (args)));
796 if (!NILP (Vpurify_flag))
797 tem = Fpurecopy (tem);
798 Fset_default (sym, tem);
799 tem = Fcar (Fcdr (Fcdr (args)));
800 if (!NILP (tem))
802 if (!NILP (Vpurify_flag))
803 tem = Fpurecopy (tem);
804 Fput (sym, Qvariable_documentation, tem);
806 LOADHIST_ATTACH (Fcons (Qdefvar, sym));
807 return sym;
810 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
811 doc: /* Returns t if VARIABLE is intended to be set and modified by users.
812 \(The alternative is a variable used internally in a Lisp program.)
813 Determined by whether the first character of the documentation
814 for the variable is `*' or if the variable is customizable (has a non-nil
815 value of `standard-value' or of `custom-autoload' 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) SREF (documentation, 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? See `custom-variable-p'. */
837 if ((!NILP (Fget (variable, intern ("standard-value"))))
838 || (!NILP (Fget (variable, intern ("custom-autoload")))))
839 return Qt;
840 return Qnil;
843 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
844 doc: /* Bind variables according to VARLIST then eval BODY.
845 The value of the last form in BODY is returned.
846 Each element of VARLIST is a symbol (which is bound to nil)
847 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
848 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
849 usage: (let* VARLIST BODY...) */)
850 (args)
851 Lisp_Object args;
853 Lisp_Object varlist, val, elt;
854 int count = SPECPDL_INDEX ();
855 struct gcpro gcpro1, gcpro2, gcpro3;
857 GCPRO3 (args, elt, varlist);
859 varlist = Fcar (args);
860 while (!NILP (varlist))
862 QUIT;
863 elt = Fcar (varlist);
864 if (SYMBOLP (elt))
865 specbind (elt, Qnil);
866 else if (! NILP (Fcdr (Fcdr (elt))))
867 Fsignal (Qerror,
868 Fcons (build_string ("`let' bindings can have only one value-form"),
869 elt));
870 else
872 val = Feval (Fcar (Fcdr (elt)));
873 specbind (Fcar (elt), val);
875 varlist = Fcdr (varlist);
877 UNGCPRO;
878 val = Fprogn (Fcdr (args));
879 return unbind_to (count, val);
882 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
883 doc: /* Bind variables according to VARLIST then eval BODY.
884 The value of the last form in BODY is returned.
885 Each element of VARLIST is a symbol (which is bound to nil)
886 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
887 All the VALUEFORMs are evalled before any symbols are bound.
888 usage: (let VARLIST BODY...) */)
889 (args)
890 Lisp_Object args;
892 Lisp_Object *temps, tem;
893 register Lisp_Object elt, varlist;
894 int count = SPECPDL_INDEX ();
895 register int argnum;
896 struct gcpro gcpro1, gcpro2;
898 varlist = Fcar (args);
900 /* Make space to hold the values to give the bound variables */
901 elt = Flength (varlist);
902 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
904 /* Compute the values and store them in `temps' */
906 GCPRO2 (args, *temps);
907 gcpro2.nvars = 0;
909 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
911 QUIT;
912 elt = Fcar (varlist);
913 if (SYMBOLP (elt))
914 temps [argnum++] = Qnil;
915 else if (! NILP (Fcdr (Fcdr (elt))))
916 Fsignal (Qerror,
917 Fcons (build_string ("`let' bindings can have only one value-form"),
918 elt));
919 else
920 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
921 gcpro2.nvars = argnum;
923 UNGCPRO;
925 varlist = Fcar (args);
926 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
928 elt = Fcar (varlist);
929 tem = temps[argnum++];
930 if (SYMBOLP (elt))
931 specbind (elt, tem);
932 else
933 specbind (Fcar (elt), tem);
936 elt = Fprogn (Fcdr (args));
937 return unbind_to (count, elt);
940 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
941 doc: /* If TEST yields non-nil, eval BODY... and repeat.
942 The order of execution is thus TEST, BODY, TEST, BODY and so on
943 until TEST returns nil.
944 usage: (while TEST BODY...) */)
945 (args)
946 Lisp_Object args;
948 Lisp_Object test, body;
949 struct gcpro gcpro1, gcpro2;
951 GCPRO2 (test, body);
953 test = Fcar (args);
954 body = Fcdr (args);
955 while (!NILP (Feval (test)))
957 QUIT;
958 Fprogn (body);
961 UNGCPRO;
962 return Qnil;
965 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
966 doc: /* Return result of expanding macros at top level of FORM.
967 If FORM is not a macro call, it is returned unchanged.
968 Otherwise, the macro is expanded and the expansion is considered
969 in place of FORM. When a non-macro-call results, it is returned.
971 The second optional arg ENVIRONMENT specifies an environment of macro
972 definitions to shadow the loaded ones for use in file byte-compilation. */)
973 (form, environment)
974 Lisp_Object form;
975 Lisp_Object environment;
977 /* With cleanups from Hallvard Furuseth. */
978 register Lisp_Object expander, sym, def, tem;
980 while (1)
982 /* Come back here each time we expand a macro call,
983 in case it expands into another macro call. */
984 if (!CONSP (form))
985 break;
986 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
987 def = sym = XCAR (form);
988 tem = Qnil;
989 /* Trace symbols aliases to other symbols
990 until we get a symbol that is not an alias. */
991 while (SYMBOLP (def))
993 QUIT;
994 sym = def;
995 tem = Fassq (sym, environment);
996 if (NILP (tem))
998 def = XSYMBOL (sym)->function;
999 if (!EQ (def, Qunbound))
1000 continue;
1002 break;
1004 /* Right now TEM is the result from SYM in ENVIRONMENT,
1005 and if TEM is nil then DEF is SYM's function definition. */
1006 if (NILP (tem))
1008 /* SYM is not mentioned in ENVIRONMENT.
1009 Look at its function definition. */
1010 if (EQ (def, Qunbound) || !CONSP (def))
1011 /* Not defined or definition not suitable */
1012 break;
1013 if (EQ (XCAR (def), Qautoload))
1015 /* Autoloading function: will it be a macro when loaded? */
1016 tem = Fnth (make_number (4), def);
1017 if (EQ (tem, Qt) || EQ (tem, Qmacro))
1018 /* Yes, load it and try again. */
1020 struct gcpro gcpro1;
1021 GCPRO1 (form);
1022 do_autoload (def, sym);
1023 UNGCPRO;
1024 continue;
1026 else
1027 break;
1029 else if (!EQ (XCAR (def), Qmacro))
1030 break;
1031 else expander = XCDR (def);
1033 else
1035 expander = XCDR (tem);
1036 if (NILP (expander))
1037 break;
1039 form = apply1 (expander, XCDR (form));
1041 return form;
1044 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1045 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1046 TAG is evalled to get the tag to use; it must not be nil.
1048 Then the BODY is executed.
1049 Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.
1050 If no throw happens, `catch' returns the value of the last BODY form.
1051 If a throw happens, it specifies the value to return from `catch'.
1052 usage: (catch TAG BODY...) */)
1053 (args)
1054 Lisp_Object args;
1056 register Lisp_Object tag;
1057 struct gcpro gcpro1;
1059 GCPRO1 (args);
1060 tag = Feval (Fcar (args));
1061 UNGCPRO;
1062 return internal_catch (tag, Fprogn, Fcdr (args));
1065 /* Set up a catch, then call C function FUNC on argument ARG.
1066 FUNC should return a Lisp_Object.
1067 This is how catches are done from within C code. */
1069 Lisp_Object
1070 internal_catch (tag, func, arg)
1071 Lisp_Object tag;
1072 Lisp_Object (*func) ();
1073 Lisp_Object arg;
1075 /* This structure is made part of the chain `catchlist'. */
1076 struct catchtag c;
1078 /* Fill in the components of c, and put it on the list. */
1079 c.next = catchlist;
1080 c.tag = tag;
1081 c.val = Qnil;
1082 c.backlist = backtrace_list;
1083 c.handlerlist = handlerlist;
1084 c.lisp_eval_depth = lisp_eval_depth;
1085 c.pdlcount = SPECPDL_INDEX ();
1086 c.poll_suppress_count = poll_suppress_count;
1087 c.interrupt_input_blocked = interrupt_input_blocked;
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);
1129 interrupt_input_blocked = catch->interrupt_input_blocked;
1133 last_time = catchlist == catch;
1135 /* Unwind the specpdl stack, and then restore the proper set of
1136 handlers. */
1137 unbind_to (catchlist->pdlcount, Qnil);
1138 handlerlist = catchlist->handlerlist;
1139 catchlist = catchlist->next;
1141 while (! last_time);
1143 byte_stack_list = catch->byte_stack;
1144 gcprolist = catch->gcpro;
1145 #ifdef DEBUG_GCPRO
1146 if (gcprolist != 0)
1147 gcpro_level = gcprolist->level + 1;
1148 else
1149 gcpro_level = 0;
1150 #endif
1151 backtrace_list = catch->backlist;
1152 lisp_eval_depth = catch->lisp_eval_depth;
1154 _longjmp (catch->jmp, 1);
1157 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1158 doc: /* Throw to the catch for TAG and return VALUE from it.
1159 Both TAG and VALUE are evalled. */)
1160 (tag, value)
1161 register Lisp_Object tag, value;
1163 register struct catchtag *c;
1165 while (1)
1167 if (!NILP (tag))
1168 for (c = catchlist; c; c = c->next)
1170 if (EQ (c->tag, tag))
1171 unwind_to_catch (c, value);
1173 tag = Fsignal (Qno_catch, Fcons (tag, Fcons (value, Qnil)));
1178 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1179 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1180 If BODYFORM completes normally, its value is returned
1181 after executing the UNWINDFORMS.
1182 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1183 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1184 (args)
1185 Lisp_Object args;
1187 Lisp_Object val;
1188 int count = SPECPDL_INDEX ();
1190 record_unwind_protect (0, Fcdr (args));
1191 val = Feval (Fcar (args));
1192 return unbind_to (count, val);
1195 /* Chain of condition handlers currently in effect.
1196 The elements of this chain are contained in the stack frames
1197 of Fcondition_case and internal_condition_case.
1198 When an error is signaled (by calling Fsignal, below),
1199 this chain is searched for an element that applies. */
1201 struct handler *handlerlist;
1203 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1204 doc: /* Regain control when an error is signaled.
1205 Executes BODYFORM and returns its value if no error happens.
1206 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1207 where the BODY is made of Lisp expressions.
1209 A handler is applicable to an error
1210 if CONDITION-NAME is one of the error's condition names.
1211 If an error happens, the first applicable handler is run.
1213 The car of a handler may be a list of condition names
1214 instead of a single condition name.
1216 When a handler handles an error,
1217 control returns to the condition-case and the handler BODY... is executed
1218 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).
1219 VAR may be nil; then you do not get access to the signal information.
1221 The value of the last BODY form is returned from the condition-case.
1222 See also the function `signal' for more info.
1223 usage: (condition-case VAR BODYFORM HANDLERS...) */)
1224 (args)
1225 Lisp_Object args;
1227 Lisp_Object val;
1228 struct catchtag c;
1229 struct handler h;
1230 register Lisp_Object bodyform, handlers;
1231 volatile Lisp_Object var;
1233 var = Fcar (args);
1234 bodyform = Fcar (Fcdr (args));
1235 handlers = Fcdr (Fcdr (args));
1236 CHECK_SYMBOL (var);
1238 for (val = handlers; ! NILP (val); val = Fcdr (val))
1240 Lisp_Object tem;
1241 tem = Fcar (val);
1242 if (! (NILP (tem)
1243 || (CONSP (tem)
1244 && (SYMBOLP (XCAR (tem))
1245 || CONSP (XCAR (tem))))))
1246 error ("Invalid condition handler", tem);
1249 c.tag = Qnil;
1250 c.val = Qnil;
1251 c.backlist = backtrace_list;
1252 c.handlerlist = handlerlist;
1253 c.lisp_eval_depth = lisp_eval_depth;
1254 c.pdlcount = SPECPDL_INDEX ();
1255 c.poll_suppress_count = poll_suppress_count;
1256 c.interrupt_input_blocked = interrupt_input_blocked;
1257 c.gcpro = gcprolist;
1258 c.byte_stack = byte_stack_list;
1259 if (_setjmp (c.jmp))
1261 if (!NILP (h.var))
1262 specbind (h.var, c.val);
1263 val = Fprogn (Fcdr (h.chosen_clause));
1265 /* Note that this just undoes the binding of h.var; whoever
1266 longjumped to us unwound the stack to c.pdlcount before
1267 throwing. */
1268 unbind_to (c.pdlcount, Qnil);
1269 return val;
1271 c.next = catchlist;
1272 catchlist = &c;
1274 h.var = var;
1275 h.handler = handlers;
1276 h.next = handlerlist;
1277 h.tag = &c;
1278 handlerlist = &h;
1280 val = Feval (bodyform);
1281 catchlist = c.next;
1282 handlerlist = h.next;
1283 return val;
1286 /* Call the function BFUN with no arguments, catching errors within it
1287 according to HANDLERS. If there is an error, call HFUN with
1288 one argument which is the data that describes the error:
1289 (SIGNALNAME . DATA)
1291 HANDLERS can be a list of conditions to catch.
1292 If HANDLERS is Qt, catch all errors.
1293 If HANDLERS is Qerror, catch all errors
1294 but allow the debugger to run if that is enabled. */
1296 Lisp_Object
1297 internal_condition_case (bfun, handlers, hfun)
1298 Lisp_Object (*bfun) ();
1299 Lisp_Object handlers;
1300 Lisp_Object (*hfun) ();
1302 Lisp_Object val;
1303 struct catchtag c;
1304 struct handler h;
1306 #if 0 /* We now handle interrupt_input_blocked properly.
1307 What we still do not handle is exiting a signal handler. */
1308 abort ();
1309 #endif
1311 c.tag = Qnil;
1312 c.val = Qnil;
1313 c.backlist = backtrace_list;
1314 c.handlerlist = handlerlist;
1315 c.lisp_eval_depth = lisp_eval_depth;
1316 c.pdlcount = SPECPDL_INDEX ();
1317 c.poll_suppress_count = poll_suppress_count;
1318 c.interrupt_input_blocked = interrupt_input_blocked;
1319 c.gcpro = gcprolist;
1320 c.byte_stack = byte_stack_list;
1321 if (_setjmp (c.jmp))
1323 return (*hfun) (c.val);
1325 c.next = catchlist;
1326 catchlist = &c;
1327 h.handler = handlers;
1328 h.var = Qnil;
1329 h.next = handlerlist;
1330 h.tag = &c;
1331 handlerlist = &h;
1333 val = (*bfun) ();
1334 catchlist = c.next;
1335 handlerlist = h.next;
1336 return val;
1339 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1341 Lisp_Object
1342 internal_condition_case_1 (bfun, arg, handlers, hfun)
1343 Lisp_Object (*bfun) ();
1344 Lisp_Object arg;
1345 Lisp_Object handlers;
1346 Lisp_Object (*hfun) ();
1348 Lisp_Object val;
1349 struct catchtag c;
1350 struct handler h;
1352 c.tag = Qnil;
1353 c.val = Qnil;
1354 c.backlist = backtrace_list;
1355 c.handlerlist = handlerlist;
1356 c.lisp_eval_depth = lisp_eval_depth;
1357 c.pdlcount = SPECPDL_INDEX ();
1358 c.poll_suppress_count = poll_suppress_count;
1359 c.interrupt_input_blocked = interrupt_input_blocked;
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 BFUN 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_INDEX ();
1402 c.poll_suppress_count = poll_suppress_count;
1403 c.interrupt_input_blocked = interrupt_input_blocked;
1404 c.gcpro = gcprolist;
1405 c.byte_stack = byte_stack_list;
1406 if (_setjmp (c.jmp))
1408 return (*hfun) (c.val);
1410 c.next = catchlist;
1411 catchlist = &c;
1412 h.handler = handlers;
1413 h.var = Qnil;
1414 h.next = handlerlist;
1415 h.tag = &c;
1416 handlerlist = &h;
1418 val = (*bfun) (nargs, args);
1419 catchlist = c.next;
1420 handlerlist = h.next;
1421 return val;
1425 static Lisp_Object find_handler_clause P_ ((Lisp_Object, Lisp_Object,
1426 Lisp_Object, Lisp_Object,
1427 Lisp_Object *));
1429 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1430 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1431 This function does not return.
1433 An error symbol is a symbol with an `error-conditions' property
1434 that is a list of condition names.
1435 A handler for any of those names will get to handle this signal.
1436 The symbol `error' should normally be one of them.
1438 DATA should be a list. Its elements are printed as part of the error message.
1439 If the signal is handled, DATA is made available to the handler.
1440 See also the function `condition-case'. */)
1441 (error_symbol, data)
1442 Lisp_Object error_symbol, data;
1444 /* When memory is full, ERROR-SYMBOL is nil,
1445 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1446 That is a special case--don't do this in other situations. */
1447 register struct handler *allhandlers = handlerlist;
1448 Lisp_Object conditions;
1449 extern int gc_in_progress;
1450 extern int waiting_for_input;
1451 Lisp_Object debugger_value;
1452 Lisp_Object string;
1453 Lisp_Object real_error_symbol;
1454 struct backtrace *bp;
1456 immediate_quit = handling_signal = 0;
1457 if (gc_in_progress || waiting_for_input)
1458 abort ();
1460 if (NILP (error_symbol))
1461 real_error_symbol = Fcar (data);
1462 else
1463 real_error_symbol = error_symbol;
1465 #if 0 /* rms: I don't know why this was here,
1466 but it is surely wrong for an error that is handled. */
1467 #ifdef HAVE_X_WINDOWS
1468 if (display_hourglass_p)
1469 cancel_hourglass ();
1470 #endif
1471 #endif
1473 /* This hook is used by edebug. */
1474 if (! NILP (Vsignal_hook_function)
1475 && ! NILP (error_symbol))
1476 call2 (Vsignal_hook_function, error_symbol, data);
1478 conditions = Fget (real_error_symbol, Qerror_conditions);
1480 /* Remember from where signal was called. Skip over the frame for
1481 `signal' itself. If a frame for `error' follows, skip that,
1482 too. Don't do this when ERROR_SYMBOL is nil, because that
1483 is a memory-full error. */
1484 Vsignaling_function = Qnil;
1485 if (backtrace_list && !NILP (error_symbol))
1487 bp = backtrace_list->next;
1488 if (bp && bp->function && EQ (*bp->function, Qerror))
1489 bp = bp->next;
1490 if (bp && bp->function)
1491 Vsignaling_function = *bp->function;
1494 for (; handlerlist; handlerlist = handlerlist->next)
1496 register Lisp_Object clause;
1498 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1499 max_lisp_eval_depth = lisp_eval_depth + 20;
1501 if (specpdl_size + 40 > max_specpdl_size)
1502 max_specpdl_size = specpdl_size + 40;
1504 clause = find_handler_clause (handlerlist->handler, conditions,
1505 error_symbol, data, &debugger_value);
1507 if (EQ (clause, Qlambda))
1509 /* We can't return values to code which signaled an error, but we
1510 can continue code which has signaled a quit. */
1511 if (EQ (real_error_symbol, Qquit))
1512 return Qnil;
1513 else
1514 error ("Cannot return from the debugger in an error");
1517 if (!NILP (clause))
1519 Lisp_Object unwind_data;
1520 struct handler *h = handlerlist;
1522 handlerlist = allhandlers;
1524 if (NILP (error_symbol))
1525 unwind_data = data;
1526 else
1527 unwind_data = Fcons (error_symbol, data);
1528 h->chosen_clause = clause;
1529 unwind_to_catch (h->tag, unwind_data);
1533 handlerlist = allhandlers;
1534 /* If no handler is present now, try to run the debugger,
1535 and if that fails, throw to top level. */
1536 find_handler_clause (Qerror, conditions, error_symbol, data, &debugger_value);
1537 if (catchlist != 0)
1538 Fthrow (Qtop_level, Qt);
1540 if (! NILP (error_symbol))
1541 data = Fcons (error_symbol, data);
1543 string = Ferror_message_string (data);
1544 fatal ("%s", SDATA (string), 0);
1547 /* Return nonzero iff LIST is a non-nil atom or
1548 a list containing one of CONDITIONS. */
1550 static int
1551 wants_debugger (list, conditions)
1552 Lisp_Object list, conditions;
1554 if (NILP (list))
1555 return 0;
1556 if (! CONSP (list))
1557 return 1;
1559 while (CONSP (conditions))
1561 Lisp_Object this, tail;
1562 this = XCAR (conditions);
1563 for (tail = list; CONSP (tail); tail = XCDR (tail))
1564 if (EQ (XCAR (tail), this))
1565 return 1;
1566 conditions = XCDR (conditions);
1568 return 0;
1571 /* Return 1 if an error with condition-symbols CONDITIONS,
1572 and described by SIGNAL-DATA, should skip the debugger
1573 according to debugger-ignored-errors. */
1575 static int
1576 skip_debugger (conditions, data)
1577 Lisp_Object conditions, data;
1579 Lisp_Object tail;
1580 int first_string = 1;
1581 Lisp_Object error_message;
1583 error_message = Qnil;
1584 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1586 if (STRINGP (XCAR (tail)))
1588 if (first_string)
1590 error_message = Ferror_message_string (data);
1591 first_string = 0;
1594 if (fast_string_match (XCAR (tail), error_message) >= 0)
1595 return 1;
1597 else
1599 Lisp_Object contail;
1601 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1602 if (EQ (XCAR (tail), XCAR (contail)))
1603 return 1;
1607 return 0;
1610 /* Value of Qlambda means we have called debugger and user has continued.
1611 There are two ways to pass SIG and DATA:
1612 = SIG is the error symbol, and DATA is the rest of the data.
1613 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1614 This is for memory-full errors only.
1616 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1618 static Lisp_Object
1619 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1620 Lisp_Object handlers, conditions, sig, data;
1621 Lisp_Object *debugger_value_ptr;
1623 register Lisp_Object h;
1624 register Lisp_Object tem;
1626 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1627 return Qt;
1628 /* error is used similarly, but means print an error message
1629 and run the debugger if that is enabled. */
1630 if (EQ (handlers, Qerror)
1631 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1632 there is a handler. */
1634 int count = SPECPDL_INDEX ();
1635 int debugger_called = 0;
1636 Lisp_Object sig_symbol, combined_data;
1637 /* This is set to 1 if we are handling a memory-full error,
1638 because these must not run the debugger.
1639 (There is no room in memory to do that!) */
1640 int no_debugger = 0;
1642 if (NILP (sig))
1644 combined_data = data;
1645 sig_symbol = Fcar (data);
1646 no_debugger = 1;
1648 else
1650 combined_data = Fcons (sig, data);
1651 sig_symbol = sig;
1654 if (wants_debugger (Vstack_trace_on_error, conditions))
1656 #ifdef PROTOTYPES
1657 internal_with_output_to_temp_buffer ("*Backtrace*",
1658 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1659 Qnil);
1660 #else
1661 internal_with_output_to_temp_buffer ("*Backtrace*",
1662 Fbacktrace, Qnil);
1663 #endif
1665 if (! no_debugger
1666 && (EQ (sig_symbol, Qquit)
1667 ? debug_on_quit
1668 : wants_debugger (Vdebug_on_error, conditions))
1669 && ! skip_debugger (conditions, combined_data)
1670 && when_entered_debugger < num_nonmacro_input_events)
1672 specbind (Qdebug_on_error, Qnil);
1673 *debugger_value_ptr
1674 = call_debugger (Fcons (Qerror,
1675 Fcons (combined_data, Qnil)));
1676 debugger_called = 1;
1678 /* If there is no handler, return saying whether we ran the debugger. */
1679 if (EQ (handlers, Qerror))
1681 if (debugger_called)
1682 return unbind_to (count, Qlambda);
1683 return Qt;
1686 for (h = handlers; CONSP (h); h = Fcdr (h))
1688 Lisp_Object handler, condit;
1690 handler = Fcar (h);
1691 if (!CONSP (handler))
1692 continue;
1693 condit = Fcar (handler);
1694 /* Handle a single condition name in handler HANDLER. */
1695 if (SYMBOLP (condit))
1697 tem = Fmemq (Fcar (handler), conditions);
1698 if (!NILP (tem))
1699 return handler;
1701 /* Handle a list of condition names in handler HANDLER. */
1702 else if (CONSP (condit))
1704 while (CONSP (condit))
1706 tem = Fmemq (Fcar (condit), conditions);
1707 if (!NILP (tem))
1708 return handler;
1709 condit = XCDR (condit);
1713 return Qnil;
1716 /* dump an error message; called like printf */
1718 /* VARARGS 1 */
1719 void
1720 error (m, a1, a2, a3)
1721 char *m;
1722 char *a1, *a2, *a3;
1724 char buf[200];
1725 int size = 200;
1726 int mlen;
1727 char *buffer = buf;
1728 char *args[3];
1729 int allocated = 0;
1730 Lisp_Object string;
1732 args[0] = a1;
1733 args[1] = a2;
1734 args[2] = a3;
1736 mlen = strlen (m);
1738 while (1)
1740 int used = doprnt (buffer, size, m, m + mlen, 3, args);
1741 if (used < size)
1742 break;
1743 size *= 2;
1744 if (allocated)
1745 buffer = (char *) xrealloc (buffer, size);
1746 else
1748 buffer = (char *) xmalloc (size);
1749 allocated = 1;
1753 string = build_string (buffer);
1754 if (allocated)
1755 xfree (buffer);
1757 Fsignal (Qerror, Fcons (string, Qnil));
1758 abort ();
1761 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
1762 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
1763 This means it contains a description for how to read arguments to give it.
1764 The value is nil for an invalid function or a symbol with no function
1765 definition.
1767 Interactively callable functions include strings and vectors (treated
1768 as keyboard macros), lambda-expressions that contain a top-level call
1769 to `interactive', autoload definitions made by `autoload' with non-nil
1770 fourth argument, and some of the built-in functions of Lisp.
1772 Also, a symbol satisfies `commandp' if its function definition does so.
1774 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
1775 then strings and vectors are not accepted. */)
1776 (function, for_call_interactively)
1777 Lisp_Object function, for_call_interactively;
1779 register Lisp_Object fun;
1780 register Lisp_Object funcar;
1782 fun = function;
1784 fun = indirect_function (fun);
1785 if (EQ (fun, Qunbound))
1786 return Qnil;
1788 /* Emacs primitives are interactive if their DEFUN specifies an
1789 interactive spec. */
1790 if (SUBRP (fun))
1792 if (XSUBR (fun)->prompt)
1793 return Qt;
1794 else
1795 return Qnil;
1798 /* Bytecode objects are interactive if they are long enough to
1799 have an element whose index is COMPILED_INTERACTIVE, which is
1800 where the interactive spec is stored. */
1801 else if (COMPILEDP (fun))
1802 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
1803 ? Qt : Qnil);
1805 /* Strings and vectors are keyboard macros. */
1806 if (NILP (for_call_interactively) && (STRINGP (fun) || VECTORP (fun)))
1807 return Qt;
1809 /* Lists may represent commands. */
1810 if (!CONSP (fun))
1811 return Qnil;
1812 funcar = Fcar (fun);
1813 if (!SYMBOLP (funcar))
1814 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1815 if (EQ (funcar, Qlambda))
1816 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1817 if (EQ (funcar, Qautoload))
1818 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1819 else
1820 return Qnil;
1823 /* ARGSUSED */
1824 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1825 doc: /* Define FUNCTION to autoload from FILE.
1826 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1827 Third arg DOCSTRING is documentation for the function.
1828 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1829 Fifth arg TYPE indicates the type of the object:
1830 nil or omitted says FUNCTION is a function,
1831 `keymap' says FUNCTION is really a keymap, and
1832 `macro' or t says FUNCTION is really a macro.
1833 Third through fifth args give info about the real definition.
1834 They default to nil.
1835 If FUNCTION is already defined other than as an autoload,
1836 this does nothing and returns nil. */)
1837 (function, file, docstring, interactive, type)
1838 Lisp_Object function, file, docstring, interactive, type;
1840 #ifdef NO_ARG_ARRAY
1841 Lisp_Object args[4];
1842 #endif
1844 CHECK_SYMBOL (function);
1845 CHECK_STRING (file);
1847 /* If function is defined and not as an autoload, don't override */
1848 if (!EQ (XSYMBOL (function)->function, Qunbound)
1849 && !(CONSP (XSYMBOL (function)->function)
1850 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
1851 return Qnil;
1853 if (NILP (Vpurify_flag))
1854 /* Only add entries after dumping, because the ones before are
1855 not useful and else we get loads of them from the loaddefs.el. */
1856 LOADHIST_ATTACH (Fcons (Qautoload, function));
1858 #ifdef NO_ARG_ARRAY
1859 args[0] = file;
1860 args[1] = docstring;
1861 args[2] = interactive;
1862 args[3] = type;
1864 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1865 #else /* NO_ARG_ARRAY */
1866 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1867 #endif /* not NO_ARG_ARRAY */
1870 Lisp_Object
1871 un_autoload (oldqueue)
1872 Lisp_Object oldqueue;
1874 register Lisp_Object queue, first, second;
1876 /* Queue to unwind is current value of Vautoload_queue.
1877 oldqueue is the shadowed value to leave in Vautoload_queue. */
1878 queue = Vautoload_queue;
1879 Vautoload_queue = oldqueue;
1880 while (CONSP (queue))
1882 first = XCAR (queue);
1883 second = Fcdr (first);
1884 first = Fcar (first);
1885 if (EQ (second, Qnil))
1886 Vfeatures = first;
1887 else
1888 Ffset (first, second);
1889 queue = XCDR (queue);
1891 return Qnil;
1894 /* Load an autoloaded function.
1895 FUNNAME is the symbol which is the function's name.
1896 FUNDEF is the autoload definition (a list). */
1898 void
1899 do_autoload (fundef, funname)
1900 Lisp_Object fundef, funname;
1902 int count = SPECPDL_INDEX ();
1903 Lisp_Object fun, queue, first, second;
1904 struct gcpro gcpro1, gcpro2, gcpro3;
1906 /* This is to make sure that loadup.el gives a clear picture
1907 of what files are preloaded and when. */
1908 if (! NILP (Vpurify_flag))
1909 error ("Attempt to autoload %s while preparing to dump",
1910 SDATA (SYMBOL_NAME (funname)));
1912 fun = funname;
1913 CHECK_SYMBOL (funname);
1914 GCPRO3 (fun, funname, fundef);
1916 /* Preserve the match data. */
1917 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
1919 /* Value saved here is to be restored into Vautoload_queue. */
1920 record_unwind_protect (un_autoload, Vautoload_queue);
1921 Vautoload_queue = Qt;
1922 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil, Qt);
1924 /* Save the old autoloads, in case we ever do an unload. */
1925 queue = Vautoload_queue;
1926 while (CONSP (queue))
1928 first = XCAR (queue);
1929 second = Fcdr (first);
1930 first = Fcar (first);
1932 /* Note: This test is subtle. The cdr of an autoload-queue entry
1933 may be an atom if the autoload entry was generated by a defalias
1934 or fset. */
1935 if (CONSP (second))
1936 Fput (first, Qautoload, (XCDR (second)));
1938 queue = XCDR (queue);
1941 /* Once loading finishes, don't undo it. */
1942 Vautoload_queue = Qt;
1943 unbind_to (count, Qnil);
1945 fun = Findirect_function (fun);
1947 if (!NILP (Fequal (fun, fundef)))
1948 error ("Autoloading failed to define function %s",
1949 SDATA (SYMBOL_NAME (funname)));
1950 UNGCPRO;
1954 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1955 doc: /* Evaluate FORM and return its value. */)
1956 (form)
1957 Lisp_Object form;
1959 Lisp_Object fun, val, original_fun, original_args;
1960 Lisp_Object funcar;
1961 struct backtrace backtrace;
1962 struct gcpro gcpro1, gcpro2, gcpro3;
1964 if (handling_signal)
1965 abort ();
1967 if (SYMBOLP (form))
1968 return Fsymbol_value (form);
1969 if (!CONSP (form))
1970 return form;
1972 QUIT;
1973 if (consing_since_gc > gc_cons_threshold)
1975 GCPRO1 (form);
1976 Fgarbage_collect ();
1977 UNGCPRO;
1980 if (++lisp_eval_depth > max_lisp_eval_depth)
1982 if (max_lisp_eval_depth < 100)
1983 max_lisp_eval_depth = 100;
1984 if (lisp_eval_depth > max_lisp_eval_depth)
1985 error ("Lisp nesting exceeds max-lisp-eval-depth");
1988 original_fun = Fcar (form);
1989 original_args = Fcdr (form);
1991 backtrace.next = backtrace_list;
1992 backtrace_list = &backtrace;
1993 backtrace.function = &original_fun; /* This also protects them from gc */
1994 backtrace.args = &original_args;
1995 backtrace.nargs = UNEVALLED;
1996 backtrace.evalargs = 1;
1997 backtrace.debug_on_exit = 0;
1999 if (debug_on_next_call)
2000 do_debug_on_call (Qt);
2002 /* At this point, only original_fun and original_args
2003 have values that will be used below */
2004 retry:
2005 fun = Findirect_function (original_fun);
2007 if (SUBRP (fun))
2009 Lisp_Object numargs;
2010 Lisp_Object argvals[8];
2011 Lisp_Object args_left;
2012 register int i, maxargs;
2014 args_left = original_args;
2015 numargs = Flength (args_left);
2017 if (XINT (numargs) < XSUBR (fun)->min_args ||
2018 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
2019 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2021 if (XSUBR (fun)->max_args == UNEVALLED)
2023 backtrace.evalargs = 0;
2024 val = (*XSUBR (fun)->function) (args_left);
2025 goto done;
2028 if (XSUBR (fun)->max_args == MANY)
2030 /* Pass a vector of evaluated arguments */
2031 Lisp_Object *vals;
2032 register int argnum = 0;
2034 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2036 GCPRO3 (args_left, fun, fun);
2037 gcpro3.var = vals;
2038 gcpro3.nvars = 0;
2040 while (!NILP (args_left))
2042 vals[argnum++] = Feval (Fcar (args_left));
2043 args_left = Fcdr (args_left);
2044 gcpro3.nvars = argnum;
2047 backtrace.args = vals;
2048 backtrace.nargs = XINT (numargs);
2050 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
2051 UNGCPRO;
2052 goto done;
2055 GCPRO3 (args_left, fun, fun);
2056 gcpro3.var = argvals;
2057 gcpro3.nvars = 0;
2059 maxargs = XSUBR (fun)->max_args;
2060 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2062 argvals[i] = Feval (Fcar (args_left));
2063 gcpro3.nvars = ++i;
2066 UNGCPRO;
2068 backtrace.args = argvals;
2069 backtrace.nargs = XINT (numargs);
2071 switch (i)
2073 case 0:
2074 val = (*XSUBR (fun)->function) ();
2075 goto done;
2076 case 1:
2077 val = (*XSUBR (fun)->function) (argvals[0]);
2078 goto done;
2079 case 2:
2080 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
2081 goto done;
2082 case 3:
2083 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2084 argvals[2]);
2085 goto done;
2086 case 4:
2087 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2088 argvals[2], argvals[3]);
2089 goto done;
2090 case 5:
2091 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2092 argvals[3], argvals[4]);
2093 goto done;
2094 case 6:
2095 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2096 argvals[3], argvals[4], argvals[5]);
2097 goto done;
2098 case 7:
2099 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2100 argvals[3], argvals[4], argvals[5],
2101 argvals[6]);
2102 goto done;
2104 case 8:
2105 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2106 argvals[3], argvals[4], argvals[5],
2107 argvals[6], argvals[7]);
2108 goto done;
2110 default:
2111 /* Someone has created a subr that takes more arguments than
2112 is supported by this code. We need to either rewrite the
2113 subr to use a different argument protocol, or add more
2114 cases to this switch. */
2115 abort ();
2118 if (COMPILEDP (fun))
2119 val = apply_lambda (fun, original_args, 1);
2120 else
2122 if (!CONSP (fun))
2123 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2124 funcar = Fcar (fun);
2125 if (!SYMBOLP (funcar))
2126 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2127 if (EQ (funcar, Qautoload))
2129 do_autoload (fun, original_fun);
2130 goto retry;
2132 if (EQ (funcar, Qmacro))
2133 val = Feval (apply1 (Fcdr (fun), original_args));
2134 else if (EQ (funcar, Qlambda))
2135 val = apply_lambda (fun, original_args, 1);
2136 else
2137 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2139 done:
2140 lisp_eval_depth--;
2141 if (backtrace.debug_on_exit)
2142 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2143 backtrace_list = backtrace.next;
2145 #ifdef HAVE_CARBON
2146 mac_check_for_quit_char();
2147 #endif
2148 return val;
2151 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2152 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2153 Then return the value FUNCTION returns.
2154 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2155 usage: (apply FUNCTION &rest ARGUMENTS) */)
2156 (nargs, args)
2157 int nargs;
2158 Lisp_Object *args;
2160 register int i, numargs;
2161 register Lisp_Object spread_arg;
2162 register Lisp_Object *funcall_args;
2163 Lisp_Object fun;
2164 int nvars;
2166 fun = args [0];
2167 funcall_args = 0;
2168 spread_arg = args [nargs - 1];
2169 CHECK_LIST (spread_arg);
2171 numargs = XINT (Flength (spread_arg));
2173 if (numargs == 0)
2174 return Ffuncall (nargs - 1, args);
2175 else if (numargs == 1)
2177 args [nargs - 1] = XCAR (spread_arg);
2178 return Ffuncall (nargs, args);
2181 numargs += nargs - 2;
2183 fun = indirect_function (fun);
2184 if (EQ (fun, Qunbound))
2186 /* Let funcall get the error */
2187 fun = args[0];
2188 goto funcall;
2191 if (SUBRP (fun))
2193 if (numargs < XSUBR (fun)->min_args
2194 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2195 goto funcall; /* Let funcall get the error */
2196 else if (XSUBR (fun)->max_args > numargs)
2198 /* Avoid making funcall cons up a yet another new vector of arguments
2199 by explicitly supplying nil's for optional values */
2200 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2201 * sizeof (Lisp_Object));
2202 for (i = numargs; i < XSUBR (fun)->max_args;)
2203 funcall_args[++i] = Qnil;
2204 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 nvars = 1 + numargs;
2217 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2218 /* Spread the last arg we got. Its first element goes in
2219 the slot that it used to occupy, hence this value of I. */
2220 i = nargs - 1;
2221 while (!NILP (spread_arg))
2223 funcall_args [i++] = XCAR (spread_arg);
2224 spread_arg = XCDR (spread_arg);
2227 return Ffuncall (nvars, funcall_args);
2230 /* Run hook variables in various ways. */
2232 enum run_hooks_condition {to_completion, until_success, until_failure};
2233 static Lisp_Object run_hook_with_args P_ ((int, Lisp_Object *,
2234 enum run_hooks_condition));
2236 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2237 doc: /* Run each hook in HOOKS. Major mode functions use this.
2238 Each argument should be a symbol, a hook variable.
2239 These symbols are processed in the order specified.
2240 If a hook symbol has a non-nil value, that value may be a function
2241 or a list of functions to be called to run the hook.
2242 If the value is a function, it is called with no arguments.
2243 If it is a list, the elements are called, in order, with no arguments.
2245 Do not use `make-local-variable' to make a hook variable buffer-local.
2246 Instead, use `add-hook' and specify t for the LOCAL argument.
2247 usage: (run-hooks &rest HOOKS) */)
2248 (nargs, args)
2249 int nargs;
2250 Lisp_Object *args;
2252 Lisp_Object hook[1];
2253 register int i;
2255 for (i = 0; i < nargs; i++)
2257 hook[0] = args[i];
2258 run_hook_with_args (1, hook, to_completion);
2261 return Qnil;
2264 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2265 Srun_hook_with_args, 1, MANY, 0,
2266 doc: /* Run HOOK with the specified arguments ARGS.
2267 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2268 value, that value may be a function or a list of functions to be
2269 called to run the hook. If the value is a function, it is called with
2270 the given arguments and its return value is returned. If it is a list
2271 of functions, those functions are called, in order,
2272 with the given arguments ARGS.
2273 It is best not to depend on the value return by `run-hook-with-args',
2274 as that may change.
2276 Do not use `make-local-variable' to make a hook variable buffer-local.
2277 Instead, use `add-hook' and specify t for the LOCAL argument.
2278 usage: (run-hook-with-args HOOK &rest ARGS) */)
2279 (nargs, args)
2280 int nargs;
2281 Lisp_Object *args;
2283 return run_hook_with_args (nargs, args, to_completion);
2286 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2287 Srun_hook_with_args_until_success, 1, MANY, 0,
2288 doc: /* Run HOOK with the specified arguments ARGS.
2289 HOOK should be a symbol, a hook variable. Its value should
2290 be a list of functions. We call those functions, one by one,
2291 passing arguments ARGS to each of them, until one of them
2292 returns a non-nil value. Then we return that value.
2293 If all the functions return nil, we return nil.
2295 Do not use `make-local-variable' to make a hook variable buffer-local.
2296 Instead, use `add-hook' and specify t for the LOCAL argument.
2297 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2298 (nargs, args)
2299 int nargs;
2300 Lisp_Object *args;
2302 return run_hook_with_args (nargs, args, until_success);
2305 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2306 Srun_hook_with_args_until_failure, 1, MANY, 0,
2307 doc: /* Run HOOK with the specified arguments ARGS.
2308 HOOK should be a symbol, a hook variable. Its value should
2309 be a list of functions. We call those functions, one by one,
2310 passing arguments ARGS to each of them, until one of them
2311 returns nil. Then we return nil.
2312 If all the functions return non-nil, we return non-nil.
2314 Do not use `make-local-variable' to make a hook variable buffer-local.
2315 Instead, use `add-hook' and specify t for the LOCAL argument.
2316 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2317 (nargs, args)
2318 int nargs;
2319 Lisp_Object *args;
2321 return run_hook_with_args (nargs, args, until_failure);
2324 /* ARGS[0] should be a hook symbol.
2325 Call each of the functions in the hook value, passing each of them
2326 as arguments all the rest of ARGS (all NARGS - 1 elements).
2327 COND specifies a condition to test after each call
2328 to decide whether to stop.
2329 The caller (or its caller, etc) must gcpro all of ARGS,
2330 except that it isn't necessary to gcpro ARGS[0]. */
2332 static Lisp_Object
2333 run_hook_with_args (nargs, args, cond)
2334 int nargs;
2335 Lisp_Object *args;
2336 enum run_hooks_condition cond;
2338 Lisp_Object sym, val, ret;
2339 Lisp_Object globals;
2340 struct gcpro gcpro1, gcpro2, gcpro3;
2342 /* If we are dying or still initializing,
2343 don't do anything--it would probably crash if we tried. */
2344 if (NILP (Vrun_hooks))
2345 return Qnil;
2347 sym = args[0];
2348 val = find_symbol_value (sym);
2349 ret = (cond == until_failure ? Qt : Qnil);
2351 if (EQ (val, Qunbound) || NILP (val))
2352 return ret;
2353 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2355 args[0] = val;
2356 return Ffuncall (nargs, args);
2358 else
2360 globals = Qnil;
2361 GCPRO3 (sym, val, globals);
2363 for (;
2364 CONSP (val) && ((cond == to_completion)
2365 || (cond == until_success ? NILP (ret)
2366 : !NILP (ret)));
2367 val = XCDR (val))
2369 if (EQ (XCAR (val), Qt))
2371 /* t indicates this hook has a local binding;
2372 it means to run the global binding too. */
2374 for (globals = Fdefault_value (sym);
2375 CONSP (globals) && ((cond == to_completion)
2376 || (cond == until_success ? NILP (ret)
2377 : !NILP (ret)));
2378 globals = XCDR (globals))
2380 args[0] = XCAR (globals);
2381 /* In a global value, t should not occur. If it does, we
2382 must ignore it to avoid an endless loop. */
2383 if (!EQ (args[0], Qt))
2384 ret = Ffuncall (nargs, args);
2387 else
2389 args[0] = XCAR (val);
2390 ret = Ffuncall (nargs, args);
2394 UNGCPRO;
2395 return ret;
2399 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2400 present value of that symbol.
2401 Call each element of FUNLIST,
2402 passing each of them the rest of ARGS.
2403 The caller (or its caller, etc) must gcpro all of ARGS,
2404 except that it isn't necessary to gcpro ARGS[0]. */
2406 Lisp_Object
2407 run_hook_list_with_args (funlist, nargs, args)
2408 Lisp_Object funlist;
2409 int nargs;
2410 Lisp_Object *args;
2412 Lisp_Object sym;
2413 Lisp_Object val;
2414 Lisp_Object globals;
2415 struct gcpro gcpro1, gcpro2, gcpro3;
2417 sym = args[0];
2418 globals = Qnil;
2419 GCPRO3 (sym, val, globals);
2421 for (val = funlist; CONSP (val); val = XCDR (val))
2423 if (EQ (XCAR (val), Qt))
2425 /* t indicates this hook has a local binding;
2426 it means to run the global binding too. */
2428 for (globals = Fdefault_value (sym);
2429 CONSP (globals);
2430 globals = XCDR (globals))
2432 args[0] = XCAR (globals);
2433 /* In a global value, t should not occur. If it does, we
2434 must ignore it to avoid an endless loop. */
2435 if (!EQ (args[0], Qt))
2436 Ffuncall (nargs, args);
2439 else
2441 args[0] = XCAR (val);
2442 Ffuncall (nargs, args);
2445 UNGCPRO;
2446 return Qnil;
2449 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2451 void
2452 run_hook_with_args_2 (hook, arg1, arg2)
2453 Lisp_Object hook, arg1, arg2;
2455 Lisp_Object temp[3];
2456 temp[0] = hook;
2457 temp[1] = arg1;
2458 temp[2] = arg2;
2460 Frun_hook_with_args (3, temp);
2463 /* Apply fn to arg */
2464 Lisp_Object
2465 apply1 (fn, arg)
2466 Lisp_Object fn, arg;
2468 struct gcpro gcpro1;
2470 GCPRO1 (fn);
2471 if (NILP (arg))
2472 RETURN_UNGCPRO (Ffuncall (1, &fn));
2473 gcpro1.nvars = 2;
2474 #ifdef NO_ARG_ARRAY
2476 Lisp_Object args[2];
2477 args[0] = fn;
2478 args[1] = arg;
2479 gcpro1.var = args;
2480 RETURN_UNGCPRO (Fapply (2, args));
2482 #else /* not NO_ARG_ARRAY */
2483 RETURN_UNGCPRO (Fapply (2, &fn));
2484 #endif /* not NO_ARG_ARRAY */
2487 /* Call function fn on no arguments */
2488 Lisp_Object
2489 call0 (fn)
2490 Lisp_Object fn;
2492 struct gcpro gcpro1;
2494 GCPRO1 (fn);
2495 RETURN_UNGCPRO (Ffuncall (1, &fn));
2498 /* Call function fn with 1 argument arg1 */
2499 /* ARGSUSED */
2500 Lisp_Object
2501 call1 (fn, arg1)
2502 Lisp_Object fn, arg1;
2504 struct gcpro gcpro1;
2505 #ifdef NO_ARG_ARRAY
2506 Lisp_Object args[2];
2508 args[0] = fn;
2509 args[1] = arg1;
2510 GCPRO1 (args[0]);
2511 gcpro1.nvars = 2;
2512 RETURN_UNGCPRO (Ffuncall (2, args));
2513 #else /* not NO_ARG_ARRAY */
2514 GCPRO1 (fn);
2515 gcpro1.nvars = 2;
2516 RETURN_UNGCPRO (Ffuncall (2, &fn));
2517 #endif /* not NO_ARG_ARRAY */
2520 /* Call function fn with 2 arguments arg1, arg2 */
2521 /* ARGSUSED */
2522 Lisp_Object
2523 call2 (fn, arg1, arg2)
2524 Lisp_Object fn, arg1, arg2;
2526 struct gcpro gcpro1;
2527 #ifdef NO_ARG_ARRAY
2528 Lisp_Object args[3];
2529 args[0] = fn;
2530 args[1] = arg1;
2531 args[2] = arg2;
2532 GCPRO1 (args[0]);
2533 gcpro1.nvars = 3;
2534 RETURN_UNGCPRO (Ffuncall (3, args));
2535 #else /* not NO_ARG_ARRAY */
2536 GCPRO1 (fn);
2537 gcpro1.nvars = 3;
2538 RETURN_UNGCPRO (Ffuncall (3, &fn));
2539 #endif /* not NO_ARG_ARRAY */
2542 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2543 /* ARGSUSED */
2544 Lisp_Object
2545 call3 (fn, arg1, arg2, arg3)
2546 Lisp_Object fn, arg1, arg2, arg3;
2548 struct gcpro gcpro1;
2549 #ifdef NO_ARG_ARRAY
2550 Lisp_Object args[4];
2551 args[0] = fn;
2552 args[1] = arg1;
2553 args[2] = arg2;
2554 args[3] = arg3;
2555 GCPRO1 (args[0]);
2556 gcpro1.nvars = 4;
2557 RETURN_UNGCPRO (Ffuncall (4, args));
2558 #else /* not NO_ARG_ARRAY */
2559 GCPRO1 (fn);
2560 gcpro1.nvars = 4;
2561 RETURN_UNGCPRO (Ffuncall (4, &fn));
2562 #endif /* not NO_ARG_ARRAY */
2565 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2566 /* ARGSUSED */
2567 Lisp_Object
2568 call4 (fn, arg1, arg2, arg3, arg4)
2569 Lisp_Object fn, arg1, arg2, arg3, arg4;
2571 struct gcpro gcpro1;
2572 #ifdef NO_ARG_ARRAY
2573 Lisp_Object args[5];
2574 args[0] = fn;
2575 args[1] = arg1;
2576 args[2] = arg2;
2577 args[3] = arg3;
2578 args[4] = arg4;
2579 GCPRO1 (args[0]);
2580 gcpro1.nvars = 5;
2581 RETURN_UNGCPRO (Ffuncall (5, args));
2582 #else /* not NO_ARG_ARRAY */
2583 GCPRO1 (fn);
2584 gcpro1.nvars = 5;
2585 RETURN_UNGCPRO (Ffuncall (5, &fn));
2586 #endif /* not NO_ARG_ARRAY */
2589 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2590 /* ARGSUSED */
2591 Lisp_Object
2592 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2593 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2595 struct gcpro gcpro1;
2596 #ifdef NO_ARG_ARRAY
2597 Lisp_Object args[6];
2598 args[0] = fn;
2599 args[1] = arg1;
2600 args[2] = arg2;
2601 args[3] = arg3;
2602 args[4] = arg4;
2603 args[5] = arg5;
2604 GCPRO1 (args[0]);
2605 gcpro1.nvars = 6;
2606 RETURN_UNGCPRO (Ffuncall (6, args));
2607 #else /* not NO_ARG_ARRAY */
2608 GCPRO1 (fn);
2609 gcpro1.nvars = 6;
2610 RETURN_UNGCPRO (Ffuncall (6, &fn));
2611 #endif /* not NO_ARG_ARRAY */
2614 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2615 /* ARGSUSED */
2616 Lisp_Object
2617 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2618 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2620 struct gcpro gcpro1;
2621 #ifdef NO_ARG_ARRAY
2622 Lisp_Object args[7];
2623 args[0] = fn;
2624 args[1] = arg1;
2625 args[2] = arg2;
2626 args[3] = arg3;
2627 args[4] = arg4;
2628 args[5] = arg5;
2629 args[6] = arg6;
2630 GCPRO1 (args[0]);
2631 gcpro1.nvars = 7;
2632 RETURN_UNGCPRO (Ffuncall (7, args));
2633 #else /* not NO_ARG_ARRAY */
2634 GCPRO1 (fn);
2635 gcpro1.nvars = 7;
2636 RETURN_UNGCPRO (Ffuncall (7, &fn));
2637 #endif /* not NO_ARG_ARRAY */
2640 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2641 doc: /* Call first argument as a function, passing remaining arguments to it.
2642 Return the value that function returns.
2643 Thus, (funcall 'cons 'x 'y) returns (x . y).
2644 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2645 (nargs, args)
2646 int nargs;
2647 Lisp_Object *args;
2649 Lisp_Object fun;
2650 Lisp_Object funcar;
2651 int numargs = nargs - 1;
2652 Lisp_Object lisp_numargs;
2653 Lisp_Object val;
2654 struct backtrace backtrace;
2655 register Lisp_Object *internal_args;
2656 register int i;
2658 QUIT;
2659 if (consing_since_gc > gc_cons_threshold)
2660 Fgarbage_collect ();
2662 if (++lisp_eval_depth > max_lisp_eval_depth)
2664 if (max_lisp_eval_depth < 100)
2665 max_lisp_eval_depth = 100;
2666 if (lisp_eval_depth > max_lisp_eval_depth)
2667 error ("Lisp nesting exceeds max-lisp-eval-depth");
2670 backtrace.next = backtrace_list;
2671 backtrace_list = &backtrace;
2672 backtrace.function = &args[0];
2673 backtrace.args = &args[1];
2674 backtrace.nargs = nargs - 1;
2675 backtrace.evalargs = 0;
2676 backtrace.debug_on_exit = 0;
2678 if (debug_on_next_call)
2679 do_debug_on_call (Qlambda);
2681 retry:
2683 fun = args[0];
2685 fun = Findirect_function (fun);
2687 if (SUBRP (fun))
2689 if (numargs < XSUBR (fun)->min_args
2690 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2692 XSETFASTINT (lisp_numargs, numargs);
2693 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
2696 if (XSUBR (fun)->max_args == UNEVALLED)
2697 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2699 if (XSUBR (fun)->max_args == MANY)
2701 val = (*XSUBR (fun)->function) (numargs, args + 1);
2702 goto done;
2705 if (XSUBR (fun)->max_args > numargs)
2707 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
2708 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
2709 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2710 internal_args[i] = Qnil;
2712 else
2713 internal_args = args + 1;
2714 switch (XSUBR (fun)->max_args)
2716 case 0:
2717 val = (*XSUBR (fun)->function) ();
2718 goto done;
2719 case 1:
2720 val = (*XSUBR (fun)->function) (internal_args[0]);
2721 goto done;
2722 case 2:
2723 val = (*XSUBR (fun)->function) (internal_args[0],
2724 internal_args[1]);
2725 goto done;
2726 case 3:
2727 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2728 internal_args[2]);
2729 goto done;
2730 case 4:
2731 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2732 internal_args[2],
2733 internal_args[3]);
2734 goto done;
2735 case 5:
2736 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2737 internal_args[2], internal_args[3],
2738 internal_args[4]);
2739 goto done;
2740 case 6:
2741 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2742 internal_args[2], internal_args[3],
2743 internal_args[4], internal_args[5]);
2744 goto done;
2745 case 7:
2746 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2747 internal_args[2], internal_args[3],
2748 internal_args[4], internal_args[5],
2749 internal_args[6]);
2750 goto done;
2752 case 8:
2753 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2754 internal_args[2], internal_args[3],
2755 internal_args[4], internal_args[5],
2756 internal_args[6], internal_args[7]);
2757 goto done;
2759 default:
2761 /* If a subr takes more than 8 arguments without using MANY
2762 or UNEVALLED, we need to extend this function to support it.
2763 Until this is done, there is no way to call the function. */
2764 abort ();
2767 if (COMPILEDP (fun))
2768 val = funcall_lambda (fun, numargs, args + 1);
2769 else
2771 if (!CONSP (fun))
2772 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2773 funcar = Fcar (fun);
2774 if (!SYMBOLP (funcar))
2775 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2776 if (EQ (funcar, Qlambda))
2777 val = funcall_lambda (fun, numargs, args + 1);
2778 else if (EQ (funcar, Qautoload))
2780 do_autoload (fun, args[0]);
2781 goto retry;
2783 else
2784 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2786 done:
2787 lisp_eval_depth--;
2788 if (backtrace.debug_on_exit)
2789 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2790 backtrace_list = backtrace.next;
2791 return val;
2794 Lisp_Object
2795 apply_lambda (fun, args, eval_flag)
2796 Lisp_Object fun, args;
2797 int eval_flag;
2799 Lisp_Object args_left;
2800 Lisp_Object numargs;
2801 register Lisp_Object *arg_vector;
2802 struct gcpro gcpro1, gcpro2, gcpro3;
2803 register int i;
2804 register Lisp_Object tem;
2806 numargs = Flength (args);
2807 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2808 args_left = args;
2810 GCPRO3 (*arg_vector, args_left, fun);
2811 gcpro1.nvars = 0;
2813 for (i = 0; i < XINT (numargs);)
2815 tem = Fcar (args_left), args_left = Fcdr (args_left);
2816 if (eval_flag) tem = Feval (tem);
2817 arg_vector[i++] = tem;
2818 gcpro1.nvars = i;
2821 UNGCPRO;
2823 if (eval_flag)
2825 backtrace_list->args = arg_vector;
2826 backtrace_list->nargs = i;
2828 backtrace_list->evalargs = 0;
2829 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2831 /* Do the debug-on-exit now, while arg_vector still exists. */
2832 if (backtrace_list->debug_on_exit)
2833 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2834 /* Don't do it again when we return to eval. */
2835 backtrace_list->debug_on_exit = 0;
2836 return tem;
2839 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2840 and return the result of evaluation.
2841 FUN must be either a lambda-expression or a compiled-code object. */
2843 static Lisp_Object
2844 funcall_lambda (fun, nargs, arg_vector)
2845 Lisp_Object fun;
2846 int nargs;
2847 register Lisp_Object *arg_vector;
2849 Lisp_Object val, syms_left, next;
2850 int count = SPECPDL_INDEX ();
2851 int i, optional, rest;
2853 if (CONSP (fun))
2855 syms_left = XCDR (fun);
2856 if (CONSP (syms_left))
2857 syms_left = XCAR (syms_left);
2858 else
2859 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2861 else if (COMPILEDP (fun))
2862 syms_left = AREF (fun, COMPILED_ARGLIST);
2863 else
2864 abort ();
2866 i = optional = rest = 0;
2867 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
2869 QUIT;
2871 next = XCAR (syms_left);
2872 while (!SYMBOLP (next))
2873 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2875 if (EQ (next, Qand_rest))
2876 rest = 1;
2877 else if (EQ (next, Qand_optional))
2878 optional = 1;
2879 else if (rest)
2881 specbind (next, Flist (nargs - i, &arg_vector[i]));
2882 i = nargs;
2884 else if (i < nargs)
2885 specbind (next, arg_vector[i++]);
2886 else if (!optional)
2887 return Fsignal (Qwrong_number_of_arguments,
2888 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2889 else
2890 specbind (next, Qnil);
2893 if (!NILP (syms_left))
2894 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2895 else if (i < nargs)
2896 return Fsignal (Qwrong_number_of_arguments,
2897 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2899 if (CONSP (fun))
2900 val = Fprogn (XCDR (XCDR (fun)));
2901 else
2903 /* If we have not actually read the bytecode string
2904 and constants vector yet, fetch them from the file. */
2905 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
2906 Ffetch_bytecode (fun);
2907 val = Fbyte_code (AREF (fun, COMPILED_BYTECODE),
2908 AREF (fun, COMPILED_CONSTANTS),
2909 AREF (fun, COMPILED_STACK_DEPTH));
2912 return unbind_to (count, val);
2915 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
2916 1, 1, 0,
2917 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
2918 (object)
2919 Lisp_Object object;
2921 Lisp_Object tem;
2923 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
2925 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
2926 if (!CONSP (tem))
2928 tem = AREF (object, COMPILED_BYTECODE);
2929 if (CONSP (tem) && STRINGP (XCAR (tem)))
2930 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
2931 else
2932 error ("Invalid byte code");
2934 AREF (object, COMPILED_BYTECODE) = XCAR (tem);
2935 AREF (object, COMPILED_CONSTANTS) = XCDR (tem);
2937 return object;
2940 void
2941 grow_specpdl ()
2943 register int count = SPECPDL_INDEX ();
2944 if (specpdl_size >= max_specpdl_size)
2946 if (max_specpdl_size < 400)
2947 max_specpdl_size = 400;
2948 if (specpdl_size >= max_specpdl_size)
2950 if (!NILP (Vdebug_on_error))
2951 /* Leave room for some specpdl in the debugger. */
2952 max_specpdl_size = specpdl_size + 100;
2953 Fsignal (Qerror,
2954 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2957 specpdl_size *= 2;
2958 if (specpdl_size > max_specpdl_size)
2959 specpdl_size = max_specpdl_size;
2960 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2961 specpdl_ptr = specpdl + count;
2964 void
2965 specbind (symbol, value)
2966 Lisp_Object symbol, value;
2968 Lisp_Object ovalue;
2969 Lisp_Object valcontents;
2971 CHECK_SYMBOL (symbol);
2972 if (specpdl_ptr == specpdl + specpdl_size)
2973 grow_specpdl ();
2975 /* The most common case is that of a non-constant symbol with a
2976 trivial value. Make that as fast as we can. */
2977 valcontents = SYMBOL_VALUE (symbol);
2978 if (!MISCP (valcontents) && !SYMBOL_CONSTANT_P (symbol))
2980 specpdl_ptr->symbol = symbol;
2981 specpdl_ptr->old_value = valcontents;
2982 specpdl_ptr->func = NULL;
2983 ++specpdl_ptr;
2984 SET_SYMBOL_VALUE (symbol, value);
2986 else
2988 Lisp_Object valcontents;
2990 ovalue = find_symbol_value (symbol);
2991 specpdl_ptr->func = 0;
2992 specpdl_ptr->old_value = ovalue;
2994 valcontents = XSYMBOL (symbol)->value;
2996 if (BUFFER_LOCAL_VALUEP (valcontents)
2997 || SOME_BUFFER_LOCAL_VALUEP (valcontents)
2998 || BUFFER_OBJFWDP (valcontents))
3000 Lisp_Object where, current_buffer;
3002 current_buffer = Fcurrent_buffer ();
3004 /* For a local variable, record both the symbol and which
3005 buffer's or frame's value we are saving. */
3006 if (!NILP (Flocal_variable_p (symbol, Qnil)))
3007 where = current_buffer;
3008 else if (!BUFFER_OBJFWDP (valcontents)
3009 && XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame)
3010 where = XBUFFER_LOCAL_VALUE (valcontents)->frame;
3011 else
3012 where = Qnil;
3014 /* We're not using the `unused' slot in the specbinding
3015 structure because this would mean we have to do more
3016 work for simple variables. */
3017 specpdl_ptr->symbol = Fcons (symbol, Fcons (where, current_buffer));
3019 /* If SYMBOL is a per-buffer variable which doesn't have a
3020 buffer-local value here, make the `let' change the global
3021 value by changing the value of SYMBOL in all buffers not
3022 having their own value. This is consistent with what
3023 happens with other buffer-local variables. */
3024 if (NILP (where)
3025 && BUFFER_OBJFWDP (valcontents))
3027 ++specpdl_ptr;
3028 Fset_default (symbol, value);
3029 return;
3032 else
3033 specpdl_ptr->symbol = symbol;
3035 specpdl_ptr++;
3036 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3037 store_symval_forwarding (symbol, ovalue, value, NULL);
3038 else
3039 set_internal (symbol, value, 0, 1);
3043 void
3044 record_unwind_protect (function, arg)
3045 Lisp_Object (*function) P_ ((Lisp_Object));
3046 Lisp_Object arg;
3048 if (specpdl_ptr == specpdl + specpdl_size)
3049 grow_specpdl ();
3050 specpdl_ptr->func = function;
3051 specpdl_ptr->symbol = Qnil;
3052 specpdl_ptr->old_value = arg;
3053 specpdl_ptr++;
3056 Lisp_Object
3057 unbind_to (count, value)
3058 int count;
3059 Lisp_Object value;
3061 int quitf = !NILP (Vquit_flag);
3062 struct gcpro gcpro1;
3064 GCPRO1 (value);
3065 Vquit_flag = Qnil;
3067 while (specpdl_ptr != specpdl + count)
3069 --specpdl_ptr;
3071 if (specpdl_ptr->func != 0)
3072 (*specpdl_ptr->func) (specpdl_ptr->old_value);
3073 /* Note that a "binding" of nil is really an unwind protect,
3074 so in that case the "old value" is a list of forms to evaluate. */
3075 else if (NILP (specpdl_ptr->symbol))
3076 Fprogn (specpdl_ptr->old_value);
3077 /* If the symbol is a list, it is really (SYMBOL WHERE
3078 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3079 frame. If WHERE is a buffer or frame, this indicates we
3080 bound a variable that had a buffer-local or frame-local
3081 binding. WHERE nil means that the variable had the default
3082 value when it was bound. CURRENT-BUFFER is the buffer that
3083 was current when the variable was bound. */
3084 else if (CONSP (specpdl_ptr->symbol))
3086 Lisp_Object symbol, where;
3088 symbol = XCAR (specpdl_ptr->symbol);
3089 where = XCAR (XCDR (specpdl_ptr->symbol));
3091 if (NILP (where))
3092 Fset_default (symbol, specpdl_ptr->old_value);
3093 else if (BUFFERP (where))
3094 set_internal (symbol, specpdl_ptr->old_value, XBUFFER (where), 1);
3095 else
3096 set_internal (symbol, specpdl_ptr->old_value, NULL, 1);
3098 else
3100 /* If variable has a trivial value (no forwarding), we can
3101 just set it. No need to check for constant symbols here,
3102 since that was already done by specbind. */
3103 if (!MISCP (SYMBOL_VALUE (specpdl_ptr->symbol)))
3104 SET_SYMBOL_VALUE (specpdl_ptr->symbol, specpdl_ptr->old_value);
3105 else
3106 set_internal (specpdl_ptr->symbol, specpdl_ptr->old_value, 0, 1);
3110 if (NILP (Vquit_flag) && quitf)
3111 Vquit_flag = Qt;
3113 UNGCPRO;
3114 return value;
3117 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3118 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3119 The debugger is entered when that frame exits, if the flag is non-nil. */)
3120 (level, flag)
3121 Lisp_Object level, flag;
3123 register struct backtrace *backlist = backtrace_list;
3124 register int i;
3126 CHECK_NUMBER (level);
3128 for (i = 0; backlist && i < XINT (level); i++)
3130 backlist = backlist->next;
3133 if (backlist)
3134 backlist->debug_on_exit = !NILP (flag);
3136 return flag;
3139 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3140 doc: /* Print a trace of Lisp function calls currently active.
3141 Output stream used is value of `standard-output'. */)
3144 register struct backtrace *backlist = backtrace_list;
3145 register int i;
3146 Lisp_Object tail;
3147 Lisp_Object tem;
3148 extern Lisp_Object Vprint_level;
3149 struct gcpro gcpro1;
3151 XSETFASTINT (Vprint_level, 3);
3153 tail = Qnil;
3154 GCPRO1 (tail);
3156 while (backlist)
3158 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3159 if (backlist->nargs == UNEVALLED)
3161 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3162 write_string ("\n", -1);
3164 else
3166 tem = *backlist->function;
3167 Fprin1 (tem, Qnil); /* This can QUIT */
3168 write_string ("(", -1);
3169 if (backlist->nargs == MANY)
3171 for (tail = *backlist->args, i = 0;
3172 !NILP (tail);
3173 tail = Fcdr (tail), i++)
3175 if (i) write_string (" ", -1);
3176 Fprin1 (Fcar (tail), Qnil);
3179 else
3181 for (i = 0; i < backlist->nargs; i++)
3183 if (i) write_string (" ", -1);
3184 Fprin1 (backlist->args[i], Qnil);
3187 write_string (")\n", -1);
3189 backlist = backlist->next;
3192 Vprint_level = Qnil;
3193 UNGCPRO;
3194 return Qnil;
3197 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3198 doc: /* Return the function and arguments NFRAMES up from current execution point.
3199 If that frame has not evaluated the arguments yet (or is a special form),
3200 the value is (nil FUNCTION ARG-FORMS...).
3201 If that frame has evaluated its arguments and called its function already,
3202 the value is (t FUNCTION ARG-VALUES...).
3203 A &rest arg is represented as the tail of the list ARG-VALUES.
3204 FUNCTION is whatever was supplied as car of evaluated list,
3205 or a lambda expression for macro calls.
3206 If NFRAMES is more than the number of frames, the value is nil. */)
3207 (nframes)
3208 Lisp_Object nframes;
3210 register struct backtrace *backlist = backtrace_list;
3211 register int i;
3212 Lisp_Object tem;
3214 CHECK_NATNUM (nframes);
3216 /* Find the frame requested. */
3217 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3218 backlist = backlist->next;
3220 if (!backlist)
3221 return Qnil;
3222 if (backlist->nargs == UNEVALLED)
3223 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3224 else
3226 if (backlist->nargs == MANY)
3227 tem = *backlist->args;
3228 else
3229 tem = Flist (backlist->nargs, backlist->args);
3231 return Fcons (Qt, Fcons (*backlist->function, tem));
3236 void
3237 syms_of_eval ()
3239 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3240 doc: /* *Limit on number of Lisp variable bindings & unwind-protects.
3241 If Lisp code tries to make more than this many at once,
3242 an error is signaled.
3243 You can safely use a value considerably larger than the default value,
3244 if that proves inconveniently small. However, if you increase it too far,
3245 Emacs could run out of memory trying to make the stack bigger. */);
3247 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3248 doc: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3250 This limit serves to catch infinite recursions for you before they cause
3251 actual stack overflow in C, which would be fatal for Emacs.
3252 You can safely make it considerably larger than its default value,
3253 if that proves inconveniently small. However, if you increase it too far,
3254 Emacs could overflow the real C stack, and crash. */);
3256 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3257 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3258 Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'. */);
3259 Vquit_flag = Qnil;
3261 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3262 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3263 Note that `quit-flag' will still be set by typing C-g,
3264 so a quit will be signaled as soon as `inhibit-quit' is nil.
3265 To prevent this happening, set `quit-flag' to nil
3266 before making `inhibit-quit' nil. */);
3267 Vinhibit_quit = Qnil;
3269 Qinhibit_quit = intern ("inhibit-quit");
3270 staticpro (&Qinhibit_quit);
3272 Qautoload = intern ("autoload");
3273 staticpro (&Qautoload);
3275 Qdebug_on_error = intern ("debug-on-error");
3276 staticpro (&Qdebug_on_error);
3278 Qmacro = intern ("macro");
3279 staticpro (&Qmacro);
3281 Qdeclare = intern ("declare");
3282 staticpro (&Qdeclare);
3284 /* Note that the process handling also uses Qexit, but we don't want
3285 to staticpro it twice, so we just do it here. */
3286 Qexit = intern ("exit");
3287 staticpro (&Qexit);
3289 Qinteractive = intern ("interactive");
3290 staticpro (&Qinteractive);
3292 Qcommandp = intern ("commandp");
3293 staticpro (&Qcommandp);
3295 Qdefun = intern ("defun");
3296 staticpro (&Qdefun);
3298 Qdefvar = intern ("defvar");
3299 staticpro (&Qdefvar);
3301 Qand_rest = intern ("&rest");
3302 staticpro (&Qand_rest);
3304 Qand_optional = intern ("&optional");
3305 staticpro (&Qand_optional);
3307 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3308 doc: /* *Non-nil means errors display a backtrace buffer.
3309 More precisely, this happens for any error that is handled
3310 by the editor command loop.
3311 If the value is a list, an error only means to display a backtrace
3312 if one of its condition symbols appears in the list. */);
3313 Vstack_trace_on_error = Qnil;
3315 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3316 doc: /* *Non-nil means enter debugger if an error is signaled.
3317 Does not apply to errors handled by `condition-case' or those
3318 matched by `debug-ignored-errors'.
3319 If the value is a list, an error only means to enter the debugger
3320 if one of its condition symbols appears in the list.
3321 When you evaluate an expression interactively, this variable
3322 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3323 See also variable `debug-on-quit'. */);
3324 Vdebug_on_error = Qnil;
3326 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3327 doc: /* *List of errors for which the debugger should not be called.
3328 Each element may be a condition-name or a regexp that matches error messages.
3329 If any element applies to a given error, that error skips the debugger
3330 and just returns to top level.
3331 This overrides the variable `debug-on-error'.
3332 It does not apply to errors handled by `condition-case'. */);
3333 Vdebug_ignored_errors = Qnil;
3335 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3336 doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3337 Does not apply if quit is handled by a `condition-case'.
3338 When you evaluate an expression interactively, this variable
3339 is temporarily non-nil if `eval-expression-debug-on-quit' is non-nil. */);
3340 debug_on_quit = 0;
3342 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3343 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3345 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3346 doc: /* Non-nil means debugger may continue execution.
3347 This is nil when the debugger is called under circumstances where it
3348 might not be safe to continue. */);
3349 debugger_may_continue = 1;
3351 DEFVAR_LISP ("debugger", &Vdebugger,
3352 doc: /* Function to call to invoke debugger.
3353 If due to frame exit, args are `exit' and the value being returned;
3354 this function's value will be returned instead of that.
3355 If due to error, args are `error' and a list of the args to `signal'.
3356 If due to `apply' or `funcall' entry, one arg, `lambda'.
3357 If due to `eval' entry, one arg, t. */);
3358 Vdebugger = Qnil;
3360 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3361 doc: /* If non-nil, this is a function for `signal' to call.
3362 It receives the same arguments that `signal' was given.
3363 The Edebug package uses this to regain control. */);
3364 Vsignal_hook_function = Qnil;
3366 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3367 doc: /* *Non-nil means call the debugger regardless of condition handlers.
3368 Note that `debug-on-error', `debug-on-quit' and friends
3369 still determine whether to handle the particular condition. */);
3370 Vdebug_on_signal = Qnil;
3372 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function,
3373 doc: /* Function to process declarations in a macro definition.
3374 The function will be called with two args MACRO and DECL.
3375 MACRO is the name of the macro being defined.
3376 DECL is a list `(declare ...)' containing the declarations.
3377 The value the function returns is not used. */);
3378 Vmacro_declaration_function = Qnil;
3380 Vrun_hooks = intern ("run-hooks");
3381 staticpro (&Vrun_hooks);
3383 staticpro (&Vautoload_queue);
3384 Vautoload_queue = Qnil;
3385 staticpro (&Vsignaling_function);
3386 Vsignaling_function = Qnil;
3388 defsubr (&Sor);
3389 defsubr (&Sand);
3390 defsubr (&Sif);
3391 defsubr (&Scond);
3392 defsubr (&Sprogn);
3393 defsubr (&Sprog1);
3394 defsubr (&Sprog2);
3395 defsubr (&Ssetq);
3396 defsubr (&Squote);
3397 defsubr (&Sfunction);
3398 defsubr (&Sdefun);
3399 defsubr (&Sdefmacro);
3400 defsubr (&Sdefvar);
3401 defsubr (&Sdefvaralias);
3402 defsubr (&Sdefconst);
3403 defsubr (&Suser_variable_p);
3404 defsubr (&Slet);
3405 defsubr (&SletX);
3406 defsubr (&Swhile);
3407 defsubr (&Smacroexpand);
3408 defsubr (&Scatch);
3409 defsubr (&Sthrow);
3410 defsubr (&Sunwind_protect);
3411 defsubr (&Scondition_case);
3412 defsubr (&Ssignal);
3413 defsubr (&Sinteractive_p);
3414 defsubr (&Scommandp);
3415 defsubr (&Sautoload);
3416 defsubr (&Seval);
3417 defsubr (&Sapply);
3418 defsubr (&Sfuncall);
3419 defsubr (&Srun_hooks);
3420 defsubr (&Srun_hook_with_args);
3421 defsubr (&Srun_hook_with_args_until_success);
3422 defsubr (&Srun_hook_with_args_until_failure);
3423 defsubr (&Sfetch_bytecode);
3424 defsubr (&Sbacktrace_debug);
3425 defsubr (&Sbacktrace);
3426 defsubr (&Sbacktrace_frame);