(eshell-parse-argument-hook): Put `number' property on entire argument
[emacs.git] / src / eval.c
blobfb1ed276c421e53713974019d84c7bbd5c8edd06
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include "lisp.h"
24 #include "blockinput.h"
25 #include "commands.h"
26 #include "keyboard.h"
27 #include "dispextern.h"
28 #include <setjmp.h>
30 #if HAVE_X_WINDOWS
31 #include "xterm.h"
32 #endif
34 /* This definition is duplicated in alloc.c and keyboard.c */
35 /* Putting it in lisp.h makes cc bomb out! */
37 struct backtrace
39 struct backtrace *next;
40 Lisp_Object *function;
41 Lisp_Object *args; /* Points to vector of args. */
42 int nargs; /* Length of vector.
43 If nargs is UNEVALLED, args points to slot holding
44 list of unevalled args */
45 char evalargs;
46 /* Nonzero means call value of debugger when done with this operation. */
47 char debug_on_exit;
50 struct backtrace *backtrace_list;
52 /* This structure helps implement the `catch' and `throw' control
53 structure. A struct catchtag contains all the information needed
54 to restore the state of the interpreter after a non-local jump.
56 Handlers for error conditions (represented by `struct handler'
57 structures) just point to a catch tag to do the cleanup required
58 for their jumps.
60 catchtag structures are chained together in the C calling stack;
61 the `next' member points to the next outer catchtag.
63 A call like (throw TAG VAL) searches for a catchtag whose `tag'
64 member is TAG, and then unbinds to it. The `val' member is used to
65 hold VAL while the stack is unwound; `val' is returned as the value
66 of the catch form.
68 All the other members are concerned with restoring the interpreter
69 state. */
71 struct catchtag
73 Lisp_Object tag;
74 Lisp_Object val;
75 struct catchtag *next;
76 struct gcpro *gcpro;
77 jmp_buf jmp;
78 struct backtrace *backlist;
79 struct handler *handlerlist;
80 int lisp_eval_depth;
81 int pdlcount;
82 int poll_suppress_count;
83 int interrupt_input_blocked;
84 struct byte_stack *byte_stack;
87 struct catchtag *catchlist;
89 #ifdef DEBUG_GCPRO
90 /* Count levels of GCPRO to detect failure to UNGCPRO. */
91 int gcpro_level;
92 #endif
94 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
95 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
96 Lisp_Object Qand_rest, Qand_optional;
97 Lisp_Object Qdebug_on_error;
98 Lisp_Object Qdeclare;
99 Lisp_Object Qdebug;
100 extern Lisp_Object Qinteractive_form;
102 /* This holds either the symbol `run-hooks' or nil.
103 It is nil at an early stage of startup, and when Emacs
104 is shutting down. */
106 Lisp_Object Vrun_hooks;
108 /* Non-nil means record all fset's and provide's, to be undone
109 if the file being autoloaded is not fully loaded.
110 They are recorded by being consed onto the front of Vautoload_queue:
111 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
113 Lisp_Object Vautoload_queue;
115 /* Current number of specbindings allocated in specpdl. */
117 int specpdl_size;
119 /* Pointer to beginning of specpdl. */
121 struct specbinding *specpdl;
123 /* Pointer to first unused element in specpdl. */
125 struct specbinding *specpdl_ptr;
127 /* Maximum size allowed for specpdl allocation */
129 EMACS_INT max_specpdl_size;
131 /* Depth in Lisp evaluations and function calls. */
133 int lisp_eval_depth;
135 /* Maximum allowed depth in Lisp evaluations and function calls. */
137 EMACS_INT max_lisp_eval_depth;
139 /* Nonzero means enter debugger before next function call */
141 int debug_on_next_call;
143 /* Non-zero means debugger may continue. This is zero when the
144 debugger is called during redisplay, where it might not be safe to
145 continue the interrupted redisplay. */
147 int debugger_may_continue;
149 /* List of conditions (non-nil atom means all) which cause a backtrace
150 if an error is handled by the command loop's error handler. */
152 Lisp_Object Vstack_trace_on_error;
154 /* List of conditions (non-nil atom means all) which enter the debugger
155 if an error is handled by the command loop's error handler. */
157 Lisp_Object Vdebug_on_error;
159 /* List of conditions and regexps specifying error messages which
160 do not enter the debugger even if Vdebug_on_error says they should. */
162 Lisp_Object Vdebug_ignored_errors;
164 /* Non-nil means call the debugger even if the error will be handled. */
166 Lisp_Object Vdebug_on_signal;
168 /* Hook for edebug to use. */
170 Lisp_Object Vsignal_hook_function;
172 /* Nonzero means enter debugger if a quit signal
173 is handled by the command loop's error handler. */
175 int debug_on_quit;
177 /* The value of num_nonmacro_input_events as of the last time we
178 started to enter the debugger. If we decide to enter the debugger
179 again when this is still equal to num_nonmacro_input_events, then we
180 know that the debugger itself has an error, and we should just
181 signal the error instead of entering an infinite loop of debugger
182 invocations. */
184 int when_entered_debugger;
186 Lisp_Object Vdebugger;
188 /* The function from which the last `signal' was called. Set in
189 Fsignal. */
191 Lisp_Object Vsignaling_function;
193 /* Set to non-zero while processing X events. Checked in Feval to
194 make sure the Lisp interpreter isn't called from a signal handler,
195 which is unsafe because the interpreter isn't reentrant. */
197 int handling_signal;
199 /* Function to process declarations in defmacro forms. */
201 Lisp_Object Vmacro_declaration_function;
203 extern Lisp_Object Qrisky_local_variable;
205 extern Lisp_Object Qfunction;
207 static Lisp_Object funcall_lambda P_ ((Lisp_Object, int, Lisp_Object*));
208 static void unwind_to_catch P_ ((struct catchtag *, Lisp_Object)) NO_RETURN;
210 #if __GNUC__
211 /* "gcc -O3" enables automatic function inlining, which optimizes out
212 the arguments for the invocations of these functions, whereas they
213 expect these values on the stack. */
214 Lisp_Object apply1 () __attribute__((noinline));
215 Lisp_Object call2 () __attribute__((noinline));
216 #endif
218 void
219 init_eval_once ()
221 specpdl_size = 50;
222 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
223 specpdl_ptr = specpdl;
224 /* Don't forget to update docs (lispref node "Local Variables"). */
225 max_specpdl_size = 1000;
226 max_lisp_eval_depth = 400;
228 Vrun_hooks = Qnil;
231 void
232 init_eval ()
234 specpdl_ptr = specpdl;
235 catchlist = 0;
236 handlerlist = 0;
237 backtrace_list = 0;
238 Vquit_flag = Qnil;
239 debug_on_next_call = 0;
240 lisp_eval_depth = 0;
241 #ifdef DEBUG_GCPRO
242 gcpro_level = 0;
243 #endif
244 /* This is less than the initial value of num_nonmacro_input_events. */
245 when_entered_debugger = -1;
248 /* unwind-protect function used by call_debugger. */
250 static Lisp_Object
251 restore_stack_limits (data)
252 Lisp_Object data;
254 max_specpdl_size = XINT (XCAR (data));
255 max_lisp_eval_depth = XINT (XCDR (data));
256 return Qnil;
259 /* Call the Lisp debugger, giving it argument ARG. */
261 Lisp_Object
262 call_debugger (arg)
263 Lisp_Object arg;
265 int debug_while_redisplaying;
266 int count = SPECPDL_INDEX ();
267 Lisp_Object val;
268 int old_max = max_specpdl_size;
270 /* Temporarily bump up the stack limits,
271 so the debugger won't run out of stack. */
273 max_specpdl_size += 1;
274 record_unwind_protect (restore_stack_limits,
275 Fcons (make_number (old_max),
276 make_number (max_lisp_eval_depth)));
277 max_specpdl_size = old_max;
279 if (lisp_eval_depth + 40 > max_lisp_eval_depth)
280 max_lisp_eval_depth = lisp_eval_depth + 40;
282 if (SPECPDL_INDEX () + 100 > max_specpdl_size)
283 max_specpdl_size = SPECPDL_INDEX () + 100;
285 #ifdef HAVE_WINDOW_SYSTEM
286 if (display_hourglass_p)
287 cancel_hourglass ();
288 #endif
290 debug_on_next_call = 0;
291 when_entered_debugger = num_nonmacro_input_events;
293 /* Resetting redisplaying_p to 0 makes sure that debug output is
294 displayed if the debugger is invoked during redisplay. */
295 debug_while_redisplaying = redisplaying_p;
296 redisplaying_p = 0;
297 specbind (intern ("debugger-may-continue"),
298 debug_while_redisplaying ? Qnil : Qt);
299 specbind (Qinhibit_redisplay, Qnil);
300 specbind (Qdebug_on_error, Qnil);
302 #if 0 /* Binding this prevents execution of Lisp code during
303 redisplay, which necessarily leads to display problems. */
304 specbind (Qinhibit_eval_during_redisplay, Qt);
305 #endif
307 val = apply1 (Vdebugger, arg);
309 /* Interrupting redisplay and resuming it later is not safe under
310 all circumstances. So, when the debugger returns, abort the
311 interrupted redisplay by going back to the top-level. */
312 if (debug_while_redisplaying)
313 Ftop_level ();
315 return unbind_to (count, val);
318 void
319 do_debug_on_call (code)
320 Lisp_Object code;
322 debug_on_next_call = 0;
323 backtrace_list->debug_on_exit = 1;
324 call_debugger (Fcons (code, Qnil));
327 /* NOTE!!! Every function that can call EVAL must protect its args
328 and temporaries from garbage collection while it needs them.
329 The definition of `For' shows what you have to do. */
331 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
332 doc: /* Eval args until one of them yields non-nil, then return that value.
333 The remaining args are not evalled at all.
334 If all args return nil, return nil.
335 usage: (or CONDITIONS...) */)
336 (args)
337 Lisp_Object args;
339 register Lisp_Object val = Qnil;
340 struct gcpro gcpro1;
342 GCPRO1 (args);
344 while (CONSP (args))
346 val = Feval (XCAR (args));
347 if (!NILP (val))
348 break;
349 args = XCDR (args);
352 UNGCPRO;
353 return val;
356 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
357 doc: /* Eval args until one of them yields nil, then return nil.
358 The remaining args are not evalled at all.
359 If no arg yields nil, return the last arg's value.
360 usage: (and CONDITIONS...) */)
361 (args)
362 Lisp_Object args;
364 register Lisp_Object val = Qt;
365 struct gcpro gcpro1;
367 GCPRO1 (args);
369 while (CONSP (args))
371 val = Feval (XCAR (args));
372 if (NILP (val))
373 break;
374 args = XCDR (args);
377 UNGCPRO;
378 return val;
381 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
382 doc: /* If COND yields non-nil, do THEN, else do ELSE...
383 Returns the value of THEN or the value of the last of the ELSE's.
384 THEN must be one expression, but ELSE... can be zero or more expressions.
385 If COND yields nil, and there are no ELSE's, the value is nil.
386 usage: (if COND THEN ELSE...) */)
387 (args)
388 Lisp_Object args;
390 register Lisp_Object cond;
391 struct gcpro gcpro1;
393 GCPRO1 (args);
394 cond = Feval (Fcar (args));
395 UNGCPRO;
397 if (!NILP (cond))
398 return Feval (Fcar (Fcdr (args)));
399 return Fprogn (Fcdr (Fcdr (args)));
402 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
403 doc: /* Try each clause until one succeeds.
404 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
405 and, if the value is non-nil, this clause succeeds:
406 then the expressions in BODY are evaluated and the last one's
407 value is the value of the cond-form.
408 If no clause succeeds, cond returns nil.
409 If a clause has one element, as in (CONDITION),
410 CONDITION's value if non-nil is returned from the cond-form.
411 usage: (cond CLAUSES...) */)
412 (args)
413 Lisp_Object args;
415 register Lisp_Object clause, val;
416 struct gcpro gcpro1;
418 val = Qnil;
419 GCPRO1 (args);
420 while (!NILP (args))
422 clause = Fcar (args);
423 val = Feval (Fcar (clause));
424 if (!NILP (val))
426 if (!EQ (XCDR (clause), Qnil))
427 val = Fprogn (XCDR (clause));
428 break;
430 args = XCDR (args);
432 UNGCPRO;
434 return val;
437 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
438 doc: /* Eval BODY forms sequentially and return value of last one.
439 usage: (progn BODY...) */)
440 (args)
441 Lisp_Object args;
443 register Lisp_Object val = Qnil;
444 struct gcpro gcpro1;
446 GCPRO1 (args);
448 while (CONSP (args))
450 val = Feval (XCAR (args));
451 args = XCDR (args);
454 UNGCPRO;
455 return val;
458 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
459 doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
460 The value of FIRST is saved during the evaluation of the remaining args,
461 whose values are discarded.
462 usage: (prog1 FIRST BODY...) */)
463 (args)
464 Lisp_Object args;
466 Lisp_Object val;
467 register Lisp_Object args_left;
468 struct gcpro gcpro1, gcpro2;
469 register int argnum = 0;
471 if (NILP (args))
472 return Qnil;
474 args_left = args;
475 val = Qnil;
476 GCPRO2 (args, val);
480 if (!(argnum++))
481 val = Feval (Fcar (args_left));
482 else
483 Feval (Fcar (args_left));
484 args_left = Fcdr (args_left);
486 while (!NILP(args_left));
488 UNGCPRO;
489 return val;
492 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
493 doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
494 The value of FORM2 is saved during the evaluation of the
495 remaining args, whose values are discarded.
496 usage: (prog2 FORM1 FORM2 BODY...) */)
497 (args)
498 Lisp_Object args;
500 Lisp_Object val;
501 register Lisp_Object args_left;
502 struct gcpro gcpro1, gcpro2;
503 register int argnum = -1;
505 val = Qnil;
507 if (NILP (args))
508 return Qnil;
510 args_left = args;
511 val = Qnil;
512 GCPRO2 (args, val);
516 if (!(argnum++))
517 val = Feval (Fcar (args_left));
518 else
519 Feval (Fcar (args_left));
520 args_left = Fcdr (args_left);
522 while (!NILP (args_left));
524 UNGCPRO;
525 return val;
528 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
529 doc: /* Set each SYM to the value of its VAL.
530 The symbols SYM are variables; they are literal (not evaluated).
531 The values VAL are expressions; they are evaluated.
532 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
533 The second VAL is not computed until after the first SYM is set, and so on;
534 each VAL can use the new value of variables set earlier in the `setq'.
535 The return value of the `setq' form is the value of the last VAL.
536 usage: (setq [SYM VAL]...) */)
537 (args)
538 Lisp_Object args;
540 register Lisp_Object args_left;
541 register Lisp_Object val, sym;
542 struct gcpro gcpro1;
544 if (NILP (args))
545 return Qnil;
547 args_left = args;
548 GCPRO1 (args);
552 val = Feval (Fcar (Fcdr (args_left)));
553 sym = Fcar (args_left);
554 Fset (sym, val);
555 args_left = Fcdr (Fcdr (args_left));
557 while (!NILP(args_left));
559 UNGCPRO;
560 return val;
563 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
564 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
565 usage: (quote ARG) */)
566 (args)
567 Lisp_Object args;
569 if (!NILP (Fcdr (args)))
570 xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
571 return Fcar (args);
574 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
575 doc: /* Like `quote', but preferred for objects which are functions.
576 In byte compilation, `function' causes its argument to be compiled.
577 `quote' cannot do that.
578 usage: (function ARG) */)
579 (args)
580 Lisp_Object args;
582 if (!NILP (Fcdr (args)))
583 xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
584 return Fcar (args);
588 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
589 doc: /* Return t if the function was run directly by user input.
590 This means that the function was called with `call-interactively'
591 \(which includes being called as the binding of a key)
592 and input is currently coming from the keyboard (not in keyboard macro),
593 and Emacs is not running in batch mode (`noninteractive' is nil).
595 The only known proper use of `interactive-p' is in deciding whether to
596 display a helpful message, or how to display it. If you're thinking
597 of using it for any other purpose, it is quite likely that you're
598 making a mistake. Think: what do you want to do when the command is
599 called from a keyboard macro?
601 If you want to test whether your function was called with
602 `call-interactively', the way to do that is by adding an extra
603 optional argument, and making the `interactive' spec specify non-nil
604 unconditionally for that argument. (`p' is a good way to do this.) */)
607 return (INTERACTIVE && interactive_p (1)) ? Qt : Qnil;
611 DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 0, 0,
612 doc: /* Return t if the function using this was called with `call-interactively'.
613 This is used for implementing advice and other function-modifying
614 features of Emacs.
616 The cleanest way to test whether your function was called with
617 `call-interactively' is by adding an extra optional argument,
618 and making the `interactive' spec specify non-nil unconditionally
619 for that argument. (`p' is a good way to do this.) */)
622 return interactive_p (1) ? Qt : Qnil;
626 /* Return 1 if function in which this appears was called using
627 call-interactively.
629 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
630 called is a built-in. */
633 interactive_p (exclude_subrs_p)
634 int exclude_subrs_p;
636 struct backtrace *btp;
637 Lisp_Object fun;
639 btp = backtrace_list;
641 /* If this isn't a byte-compiled function, there may be a frame at
642 the top for Finteractive_p. If so, skip it. */
643 fun = Findirect_function (*btp->function, Qnil);
644 if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
645 || XSUBR (fun) == &Scalled_interactively_p))
646 btp = btp->next;
648 /* If we're running an Emacs 18-style byte-compiled function, there
649 may be a frame for Fbytecode at the top level. In any version of
650 Emacs there can be Fbytecode frames for subexpressions evaluated
651 inside catch and condition-case. Skip past them.
653 If this isn't a byte-compiled function, then we may now be
654 looking at several frames for special forms. Skip past them. */
655 while (btp
656 && (EQ (*btp->function, Qbytecode)
657 || btp->nargs == UNEVALLED))
658 btp = btp->next;
660 /* btp now points at the frame of the innermost function that isn't
661 a special form, ignoring frames for Finteractive_p and/or
662 Fbytecode at the top. If this frame is for a built-in function
663 (such as load or eval-region) return nil. */
664 fun = Findirect_function (*btp->function, Qnil);
665 if (exclude_subrs_p && SUBRP (fun))
666 return 0;
668 /* btp points to the frame of a Lisp function that called interactive-p.
669 Return t if that function was called interactively. */
670 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
671 return 1;
672 return 0;
676 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
677 doc: /* Define NAME as a function.
678 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
679 See also the function `interactive'.
680 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
681 (args)
682 Lisp_Object args;
684 register Lisp_Object fn_name;
685 register Lisp_Object defn;
687 fn_name = Fcar (args);
688 CHECK_SYMBOL (fn_name);
689 defn = Fcons (Qlambda, Fcdr (args));
690 if (!NILP (Vpurify_flag))
691 defn = Fpurecopy (defn);
692 if (CONSP (XSYMBOL (fn_name)->function)
693 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
694 LOADHIST_ATTACH (Fcons (Qt, fn_name));
695 Ffset (fn_name, defn);
696 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
697 return fn_name;
700 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
701 doc: /* Define NAME as a macro.
702 The actual definition looks like
703 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
704 When the macro is called, as in (NAME ARGS...),
705 the function (lambda ARGLIST BODY...) is applied to
706 the list ARGS... as it appears in the expression,
707 and the result should be a form to be evaluated instead of the original.
709 DECL is a declaration, optional, which can specify how to indent
710 calls to this macro, how Edebug should handle it, and which argument
711 should be treated as documentation. It looks like this:
712 (declare SPECS...)
713 The elements can look like this:
714 (indent INDENT)
715 Set NAME's `lisp-indent-function' property to INDENT.
717 (debug DEBUG)
718 Set NAME's `edebug-form-spec' property to DEBUG. (This is
719 equivalent to writing a `def-edebug-spec' for the macro.)
721 (doc-string ELT)
722 Set NAME's `doc-string-elt' property to ELT.
724 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
725 (args)
726 Lisp_Object args;
728 register Lisp_Object fn_name;
729 register Lisp_Object defn;
730 Lisp_Object lambda_list, doc, tail;
732 fn_name = Fcar (args);
733 CHECK_SYMBOL (fn_name);
734 lambda_list = Fcar (Fcdr (args));
735 tail = Fcdr (Fcdr (args));
737 doc = Qnil;
738 if (STRINGP (Fcar (tail)))
740 doc = XCAR (tail);
741 tail = XCDR (tail);
744 while (CONSP (Fcar (tail))
745 && EQ (Fcar (Fcar (tail)), Qdeclare))
747 if (!NILP (Vmacro_declaration_function))
749 struct gcpro gcpro1;
750 GCPRO1 (args);
751 call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
752 UNGCPRO;
755 tail = Fcdr (tail);
758 if (NILP (doc))
759 tail = Fcons (lambda_list, tail);
760 else
761 tail = Fcons (lambda_list, Fcons (doc, tail));
762 defn = Fcons (Qmacro, Fcons (Qlambda, tail));
764 if (!NILP (Vpurify_flag))
765 defn = Fpurecopy (defn);
766 if (CONSP (XSYMBOL (fn_name)->function)
767 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
768 LOADHIST_ATTACH (Fcons (Qt, fn_name));
769 Ffset (fn_name, defn);
770 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
771 return fn_name;
775 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
776 doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
777 Aliased variables always have the same value; setting one sets the other.
778 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
779 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
780 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
781 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
782 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
783 The return value is BASE-VARIABLE. */)
784 (new_alias, base_variable, docstring)
785 Lisp_Object new_alias, base_variable, docstring;
787 struct Lisp_Symbol *sym;
789 CHECK_SYMBOL (new_alias);
790 CHECK_SYMBOL (base_variable);
792 if (SYMBOL_CONSTANT_P (new_alias))
793 error ("Cannot make a constant an alias");
795 sym = XSYMBOL (new_alias);
796 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
797 If n_a is bound, but b_v is not, set the value of b_v to n_a.
798 This is for the sake of define-obsolete-variable-alias and user
799 customizations. */
800 if (NILP (Fboundp (base_variable)) && !NILP (Fboundp (new_alias)))
801 XSYMBOL(base_variable)->value = sym->value;
802 sym->indirect_variable = 1;
803 sym->value = base_variable;
804 sym->constant = SYMBOL_CONSTANT_P (base_variable);
805 LOADHIST_ATTACH (new_alias);
806 if (!NILP (docstring))
807 Fput (new_alias, Qvariable_documentation, docstring);
808 else
809 Fput (new_alias, Qvariable_documentation, Qnil);
811 return base_variable;
815 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
816 doc: /* Define SYMBOL as a variable, and return SYMBOL.
817 You are not required to define a variable in order to use it,
818 but the definition can supply documentation and an initial value
819 in a way that tags can recognize.
821 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
822 If SYMBOL is buffer-local, its default value is what is set;
823 buffer-local values are not affected.
824 INITVALUE and DOCSTRING are optional.
825 If DOCSTRING starts with *, this variable is identified as a user option.
826 This means that M-x set-variable recognizes it.
827 See also `user-variable-p'.
828 If INITVALUE is missing, SYMBOL's value is not set.
830 If SYMBOL has a local binding, then this form affects the local
831 binding. This is usually not what you want. Thus, if you need to
832 load a file defining variables, with this form or with `defconst' or
833 `defcustom', you should always load that file _outside_ any bindings
834 for these variables. \(`defconst' and `defcustom' behave similarly in
835 this respect.)
836 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
837 (args)
838 Lisp_Object args;
840 register Lisp_Object sym, tem, tail;
842 sym = Fcar (args);
843 tail = Fcdr (args);
844 if (!NILP (Fcdr (Fcdr (tail))))
845 error ("Too many arguments");
847 tem = Fdefault_boundp (sym);
848 if (!NILP (tail))
850 if (SYMBOL_CONSTANT_P (sym))
852 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
853 Lisp_Object tem = Fcar (tail);
854 if (! (CONSP (tem)
855 && EQ (XCAR (tem), Qquote)
856 && CONSP (XCDR (tem))
857 && EQ (XCAR (XCDR (tem)), sym)))
858 error ("Constant symbol `%s' specified in defvar",
859 SDATA (SYMBOL_NAME (sym)));
862 if (NILP (tem))
863 Fset_default (sym, Feval (Fcar (tail)));
864 else
865 { /* Check if there is really a global binding rather than just a let
866 binding that shadows the global unboundness of the var. */
867 volatile struct specbinding *pdl = specpdl_ptr;
868 while (--pdl >= specpdl)
870 if (EQ (pdl->symbol, sym) && !pdl->func
871 && EQ (pdl->old_value, Qunbound))
873 message_with_string ("Warning: defvar ignored because %s is let-bound",
874 SYMBOL_NAME (sym), 1);
875 break;
879 tail = Fcdr (tail);
880 tem = Fcar (tail);
881 if (!NILP (tem))
883 if (!NILP (Vpurify_flag))
884 tem = Fpurecopy (tem);
885 Fput (sym, Qvariable_documentation, tem);
887 LOADHIST_ATTACH (sym);
889 else
890 /* Simple (defvar <var>) should not count as a definition at all.
891 It could get in the way of other definitions, and unloading this
892 package could try to make the variable unbound. */
895 return sym;
898 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
899 doc: /* Define SYMBOL as a constant variable.
900 The intent is that neither programs nor users should ever change this value.
901 Always sets the value of SYMBOL to the result of evalling INITVALUE.
902 If SYMBOL is buffer-local, its default value is what is set;
903 buffer-local values are not affected.
904 DOCSTRING is optional.
906 If SYMBOL has a local binding, then this form sets the local binding's
907 value. However, you should normally not make local bindings for
908 variables defined with this form.
909 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
910 (args)
911 Lisp_Object args;
913 register Lisp_Object sym, tem;
915 sym = Fcar (args);
916 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
917 error ("Too many arguments");
919 tem = Feval (Fcar (Fcdr (args)));
920 if (!NILP (Vpurify_flag))
921 tem = Fpurecopy (tem);
922 Fset_default (sym, tem);
923 tem = Fcar (Fcdr (Fcdr (args)));
924 if (!NILP (tem))
926 if (!NILP (Vpurify_flag))
927 tem = Fpurecopy (tem);
928 Fput (sym, Qvariable_documentation, tem);
930 Fput (sym, Qrisky_local_variable, Qt);
931 LOADHIST_ATTACH (sym);
932 return sym;
935 /* Error handler used in Fuser_variable_p. */
936 static Lisp_Object
937 user_variable_p_eh (ignore)
938 Lisp_Object ignore;
940 return Qnil;
943 static Lisp_Object
944 lisp_indirect_variable (Lisp_Object sym)
946 XSETSYMBOL (sym, indirect_variable (XSYMBOL (sym)));
947 return sym;
950 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
951 doc: /* Return t if VARIABLE is intended to be set and modified by users.
952 \(The alternative is a variable used internally in a Lisp program.)
953 A variable is a user variable if
954 \(1) the first character of its documentation is `*', or
955 \(2) it is customizable (its property list contains a non-nil value
956 of `standard-value' or `custom-autoload'), or
957 \(3) it is an alias for another user variable.
958 Return nil if VARIABLE is an alias and there is a loop in the
959 chain of symbols. */)
960 (variable)
961 Lisp_Object variable;
963 Lisp_Object documentation;
965 if (!SYMBOLP (variable))
966 return Qnil;
968 /* If indirect and there's an alias loop, don't check anything else. */
969 if (XSYMBOL (variable)->indirect_variable
970 && NILP (internal_condition_case_1 (lisp_indirect_variable, variable,
971 Qt, user_variable_p_eh)))
972 return Qnil;
974 while (1)
976 documentation = Fget (variable, Qvariable_documentation);
977 if (INTEGERP (documentation) && XINT (documentation) < 0)
978 return Qt;
979 if (STRINGP (documentation)
980 && ((unsigned char) SREF (documentation, 0) == '*'))
981 return Qt;
982 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
983 if (CONSP (documentation)
984 && STRINGP (XCAR (documentation))
985 && INTEGERP (XCDR (documentation))
986 && XINT (XCDR (documentation)) < 0)
987 return Qt;
988 /* Customizable? See `custom-variable-p'. */
989 if ((!NILP (Fget (variable, intern ("standard-value"))))
990 || (!NILP (Fget (variable, intern ("custom-autoload")))))
991 return Qt;
993 if (!XSYMBOL (variable)->indirect_variable)
994 return Qnil;
996 /* An indirect variable? Let's follow the chain. */
997 variable = XSYMBOL (variable)->value;
1001 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
1002 doc: /* Bind variables according to VARLIST then eval BODY.
1003 The value of the last form in BODY is returned.
1004 Each element of VARLIST is a symbol (which is bound to nil)
1005 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1006 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
1007 usage: (let* VARLIST BODY...) */)
1008 (args)
1009 Lisp_Object args;
1011 Lisp_Object varlist, val, elt;
1012 int count = SPECPDL_INDEX ();
1013 struct gcpro gcpro1, gcpro2, gcpro3;
1015 GCPRO3 (args, elt, varlist);
1017 varlist = Fcar (args);
1018 while (!NILP (varlist))
1020 QUIT;
1021 elt = Fcar (varlist);
1022 if (SYMBOLP (elt))
1023 specbind (elt, Qnil);
1024 else if (! NILP (Fcdr (Fcdr (elt))))
1025 signal_error ("`let' bindings can have only one value-form", elt);
1026 else
1028 val = Feval (Fcar (Fcdr (elt)));
1029 specbind (Fcar (elt), val);
1031 varlist = Fcdr (varlist);
1033 UNGCPRO;
1034 val = Fprogn (Fcdr (args));
1035 return unbind_to (count, val);
1038 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
1039 doc: /* Bind variables according to VARLIST then eval BODY.
1040 The value of the last form in BODY is returned.
1041 Each element of VARLIST is a symbol (which is bound to nil)
1042 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1043 All the VALUEFORMs are evalled before any symbols are bound.
1044 usage: (let VARLIST BODY...) */)
1045 (args)
1046 Lisp_Object args;
1048 Lisp_Object *temps, tem;
1049 register Lisp_Object elt, varlist;
1050 int count = SPECPDL_INDEX ();
1051 register int argnum;
1052 struct gcpro gcpro1, gcpro2;
1054 varlist = Fcar (args);
1056 /* Make space to hold the values to give the bound variables */
1057 elt = Flength (varlist);
1058 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
1060 /* Compute the values and store them in `temps' */
1062 GCPRO2 (args, *temps);
1063 gcpro2.nvars = 0;
1065 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1067 QUIT;
1068 elt = XCAR (varlist);
1069 if (SYMBOLP (elt))
1070 temps [argnum++] = Qnil;
1071 else if (! NILP (Fcdr (Fcdr (elt))))
1072 signal_error ("`let' bindings can have only one value-form", elt);
1073 else
1074 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
1075 gcpro2.nvars = argnum;
1077 UNGCPRO;
1079 varlist = Fcar (args);
1080 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1082 elt = XCAR (varlist);
1083 tem = temps[argnum++];
1084 if (SYMBOLP (elt))
1085 specbind (elt, tem);
1086 else
1087 specbind (Fcar (elt), tem);
1090 elt = Fprogn (Fcdr (args));
1091 return unbind_to (count, elt);
1094 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
1095 doc: /* If TEST yields non-nil, eval BODY... and repeat.
1096 The order of execution is thus TEST, BODY, TEST, BODY and so on
1097 until TEST returns nil.
1098 usage: (while TEST BODY...) */)
1099 (args)
1100 Lisp_Object args;
1102 Lisp_Object test, body;
1103 struct gcpro gcpro1, gcpro2;
1105 GCPRO2 (test, body);
1107 test = Fcar (args);
1108 body = Fcdr (args);
1109 while (!NILP (Feval (test)))
1111 QUIT;
1112 Fprogn (body);
1115 UNGCPRO;
1116 return Qnil;
1119 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
1120 doc: /* Return result of expanding macros at top level of FORM.
1121 If FORM is not a macro call, it is returned unchanged.
1122 Otherwise, the macro is expanded and the expansion is considered
1123 in place of FORM. When a non-macro-call results, it is returned.
1125 The second optional arg ENVIRONMENT specifies an environment of macro
1126 definitions to shadow the loaded ones for use in file byte-compilation. */)
1127 (form, environment)
1128 Lisp_Object form;
1129 Lisp_Object environment;
1131 /* With cleanups from Hallvard Furuseth. */
1132 register Lisp_Object expander, sym, def, tem;
1134 while (1)
1136 /* Come back here each time we expand a macro call,
1137 in case it expands into another macro call. */
1138 if (!CONSP (form))
1139 break;
1140 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1141 def = sym = XCAR (form);
1142 tem = Qnil;
1143 /* Trace symbols aliases to other symbols
1144 until we get a symbol that is not an alias. */
1145 while (SYMBOLP (def))
1147 QUIT;
1148 sym = def;
1149 tem = Fassq (sym, environment);
1150 if (NILP (tem))
1152 def = XSYMBOL (sym)->function;
1153 if (!EQ (def, Qunbound))
1154 continue;
1156 break;
1158 /* Right now TEM is the result from SYM in ENVIRONMENT,
1159 and if TEM is nil then DEF is SYM's function definition. */
1160 if (NILP (tem))
1162 /* SYM is not mentioned in ENVIRONMENT.
1163 Look at its function definition. */
1164 if (EQ (def, Qunbound) || !CONSP (def))
1165 /* Not defined or definition not suitable */
1166 break;
1167 if (EQ (XCAR (def), Qautoload))
1169 /* Autoloading function: will it be a macro when loaded? */
1170 tem = Fnth (make_number (4), def);
1171 if (EQ (tem, Qt) || EQ (tem, Qmacro))
1172 /* Yes, load it and try again. */
1174 struct gcpro gcpro1;
1175 GCPRO1 (form);
1176 do_autoload (def, sym);
1177 UNGCPRO;
1178 continue;
1180 else
1181 break;
1183 else if (!EQ (XCAR (def), Qmacro))
1184 break;
1185 else expander = XCDR (def);
1187 else
1189 expander = XCDR (tem);
1190 if (NILP (expander))
1191 break;
1193 form = apply1 (expander, XCDR (form));
1195 return form;
1198 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1199 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1200 TAG is evalled to get the tag to use; it must not be nil.
1202 Then the BODY is executed.
1203 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1204 If no throw happens, `catch' returns the value of the last BODY form.
1205 If a throw happens, it specifies the value to return from `catch'.
1206 usage: (catch TAG BODY...) */)
1207 (args)
1208 Lisp_Object args;
1210 register Lisp_Object tag;
1211 struct gcpro gcpro1;
1213 GCPRO1 (args);
1214 tag = Feval (Fcar (args));
1215 UNGCPRO;
1216 return internal_catch (tag, Fprogn, Fcdr (args));
1219 /* Set up a catch, then call C function FUNC on argument ARG.
1220 FUNC should return a Lisp_Object.
1221 This is how catches are done from within C code. */
1223 Lisp_Object
1224 internal_catch (tag, func, arg)
1225 Lisp_Object tag;
1226 Lisp_Object (*func) ();
1227 Lisp_Object arg;
1229 /* This structure is made part of the chain `catchlist'. */
1230 struct catchtag c;
1232 /* Fill in the components of c, and put it on the list. */
1233 c.next = catchlist;
1234 c.tag = tag;
1235 c.val = Qnil;
1236 c.backlist = backtrace_list;
1237 c.handlerlist = handlerlist;
1238 c.lisp_eval_depth = lisp_eval_depth;
1239 c.pdlcount = SPECPDL_INDEX ();
1240 c.poll_suppress_count = poll_suppress_count;
1241 c.interrupt_input_blocked = interrupt_input_blocked;
1242 c.gcpro = gcprolist;
1243 c.byte_stack = byte_stack_list;
1244 catchlist = &c;
1246 /* Call FUNC. */
1247 if (! _setjmp (c.jmp))
1248 c.val = (*func) (arg);
1250 /* Throw works by a longjmp that comes right here. */
1251 catchlist = c.next;
1252 return c.val;
1255 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1256 jump to that CATCH, returning VALUE as the value of that catch.
1258 This is the guts Fthrow and Fsignal; they differ only in the way
1259 they choose the catch tag to throw to. A catch tag for a
1260 condition-case form has a TAG of Qnil.
1262 Before each catch is discarded, unbind all special bindings and
1263 execute all unwind-protect clauses made above that catch. Unwind
1264 the handler stack as we go, so that the proper handlers are in
1265 effect for each unwind-protect clause we run. At the end, restore
1266 some static info saved in CATCH, and longjmp to the location
1267 specified in the
1269 This is used for correct unwinding in Fthrow and Fsignal. */
1271 static void
1272 unwind_to_catch (catch, value)
1273 struct catchtag *catch;
1274 Lisp_Object value;
1276 register int last_time;
1278 /* Save the value in the tag. */
1279 catch->val = value;
1281 /* Restore certain special C variables. */
1282 set_poll_suppress_count (catch->poll_suppress_count);
1283 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked);
1284 handling_signal = 0;
1285 immediate_quit = 0;
1289 last_time = catchlist == catch;
1291 /* Unwind the specpdl stack, and then restore the proper set of
1292 handlers. */
1293 unbind_to (catchlist->pdlcount, Qnil);
1294 handlerlist = catchlist->handlerlist;
1295 catchlist = catchlist->next;
1297 while (! last_time);
1299 #if HAVE_X_WINDOWS
1300 /* If x_catch_errors was done, turn it off now.
1301 (First we give unbind_to a chance to do that.) */
1302 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1303 * The catch must remain in effect during that delicate
1304 * state. --lorentey */
1305 x_fully_uncatch_errors ();
1306 #endif
1307 #endif
1309 byte_stack_list = catch->byte_stack;
1310 gcprolist = catch->gcpro;
1311 #ifdef DEBUG_GCPRO
1312 if (gcprolist != 0)
1313 gcpro_level = gcprolist->level + 1;
1314 else
1315 gcpro_level = 0;
1316 #endif
1317 backtrace_list = catch->backlist;
1318 lisp_eval_depth = catch->lisp_eval_depth;
1320 _longjmp (catch->jmp, 1);
1323 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1324 doc: /* Throw to the catch for TAG and return VALUE from it.
1325 Both TAG and VALUE are evalled. */)
1326 (tag, value)
1327 register Lisp_Object tag, value;
1329 register struct catchtag *c;
1331 if (!NILP (tag))
1332 for (c = catchlist; c; c = c->next)
1334 if (EQ (c->tag, tag))
1335 unwind_to_catch (c, value);
1337 xsignal2 (Qno_catch, tag, value);
1341 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1342 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1343 If BODYFORM completes normally, its value is returned
1344 after executing the UNWINDFORMS.
1345 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1346 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1347 (args)
1348 Lisp_Object args;
1350 Lisp_Object val;
1351 int count = SPECPDL_INDEX ();
1353 record_unwind_protect (Fprogn, Fcdr (args));
1354 val = Feval (Fcar (args));
1355 return unbind_to (count, val);
1358 /* Chain of condition handlers currently in effect.
1359 The elements of this chain are contained in the stack frames
1360 of Fcondition_case and internal_condition_case.
1361 When an error is signaled (by calling Fsignal, below),
1362 this chain is searched for an element that applies. */
1364 struct handler *handlerlist;
1366 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1367 doc: /* Regain control when an error is signaled.
1368 Executes BODYFORM and returns its value if no error happens.
1369 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1370 where the BODY is made of Lisp expressions.
1372 A handler is applicable to an error
1373 if CONDITION-NAME is one of the error's condition names.
1374 If an error happens, the first applicable handler is run.
1376 The car of a handler may be a list of condition names
1377 instead of a single condition name. Then it handles all of them.
1379 When a handler handles an error, control returns to the `condition-case'
1380 and it executes the handler's BODY...
1381 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1382 (If VAR is nil, the handler can't access that information.)
1383 Then the value of the last BODY form is returned from the `condition-case'
1384 expression.
1386 See also the function `signal' for more info.
1387 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1388 (args)
1389 Lisp_Object args;
1391 register Lisp_Object bodyform, handlers;
1392 volatile Lisp_Object var;
1394 var = Fcar (args);
1395 bodyform = Fcar (Fcdr (args));
1396 handlers = Fcdr (Fcdr (args));
1398 return internal_lisp_condition_case (var, bodyform, handlers);
1401 /* Like Fcondition_case, but the args are separate
1402 rather than passed in a list. Used by Fbyte_code. */
1404 Lisp_Object
1405 internal_lisp_condition_case (var, bodyform, handlers)
1406 volatile Lisp_Object var;
1407 Lisp_Object bodyform, handlers;
1409 Lisp_Object val;
1410 struct catchtag c;
1411 struct handler h;
1413 CHECK_SYMBOL (var);
1415 for (val = handlers; CONSP (val); val = XCDR (val))
1417 Lisp_Object tem;
1418 tem = XCAR (val);
1419 if (! (NILP (tem)
1420 || (CONSP (tem)
1421 && (SYMBOLP (XCAR (tem))
1422 || CONSP (XCAR (tem))))))
1423 error ("Invalid condition handler", tem);
1426 c.tag = Qnil;
1427 c.val = Qnil;
1428 c.backlist = backtrace_list;
1429 c.handlerlist = handlerlist;
1430 c.lisp_eval_depth = lisp_eval_depth;
1431 c.pdlcount = SPECPDL_INDEX ();
1432 c.poll_suppress_count = poll_suppress_count;
1433 c.interrupt_input_blocked = interrupt_input_blocked;
1434 c.gcpro = gcprolist;
1435 c.byte_stack = byte_stack_list;
1436 if (_setjmp (c.jmp))
1438 if (!NILP (h.var))
1439 specbind (h.var, c.val);
1440 val = Fprogn (Fcdr (h.chosen_clause));
1442 /* Note that this just undoes the binding of h.var; whoever
1443 longjumped to us unwound the stack to c.pdlcount before
1444 throwing. */
1445 unbind_to (c.pdlcount, Qnil);
1446 return val;
1448 c.next = catchlist;
1449 catchlist = &c;
1451 h.var = var;
1452 h.handler = handlers;
1453 h.next = handlerlist;
1454 h.tag = &c;
1455 handlerlist = &h;
1457 val = Feval (bodyform);
1458 catchlist = c.next;
1459 handlerlist = h.next;
1460 return val;
1463 /* Call the function BFUN with no arguments, catching errors within it
1464 according to HANDLERS. If there is an error, call HFUN with
1465 one argument which is the data that describes the error:
1466 (SIGNALNAME . DATA)
1468 HANDLERS can be a list of conditions to catch.
1469 If HANDLERS is Qt, catch all errors.
1470 If HANDLERS is Qerror, catch all errors
1471 but allow the debugger to run if that is enabled. */
1473 Lisp_Object
1474 internal_condition_case (bfun, handlers, hfun)
1475 Lisp_Object (*bfun) ();
1476 Lisp_Object handlers;
1477 Lisp_Object (*hfun) ();
1479 Lisp_Object val;
1480 struct catchtag c;
1481 struct handler h;
1483 /* Since Fsignal will close off all calls to x_catch_errors,
1484 we will get the wrong results if some are not closed now. */
1485 #if HAVE_X_WINDOWS
1486 if (x_catching_errors ())
1487 abort ();
1488 #endif
1490 c.tag = Qnil;
1491 c.val = Qnil;
1492 c.backlist = backtrace_list;
1493 c.handlerlist = handlerlist;
1494 c.lisp_eval_depth = lisp_eval_depth;
1495 c.pdlcount = SPECPDL_INDEX ();
1496 c.poll_suppress_count = poll_suppress_count;
1497 c.interrupt_input_blocked = interrupt_input_blocked;
1498 c.gcpro = gcprolist;
1499 c.byte_stack = byte_stack_list;
1500 if (_setjmp (c.jmp))
1502 return (*hfun) (c.val);
1504 c.next = catchlist;
1505 catchlist = &c;
1506 h.handler = handlers;
1507 h.var = Qnil;
1508 h.next = handlerlist;
1509 h.tag = &c;
1510 handlerlist = &h;
1512 val = (*bfun) ();
1513 catchlist = c.next;
1514 handlerlist = h.next;
1515 return val;
1518 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1520 Lisp_Object
1521 internal_condition_case_1 (bfun, arg, handlers, hfun)
1522 Lisp_Object (*bfun) ();
1523 Lisp_Object arg;
1524 Lisp_Object handlers;
1525 Lisp_Object (*hfun) ();
1527 Lisp_Object val;
1528 struct catchtag c;
1529 struct handler h;
1531 /* Since Fsignal will close off all calls to x_catch_errors,
1532 we will get the wrong results if some are not closed now. */
1533 #if HAVE_X_WINDOWS
1534 if (x_catching_errors ())
1535 abort ();
1536 #endif
1538 c.tag = Qnil;
1539 c.val = Qnil;
1540 c.backlist = backtrace_list;
1541 c.handlerlist = handlerlist;
1542 c.lisp_eval_depth = lisp_eval_depth;
1543 c.pdlcount = SPECPDL_INDEX ();
1544 c.poll_suppress_count = poll_suppress_count;
1545 c.interrupt_input_blocked = interrupt_input_blocked;
1546 c.gcpro = gcprolist;
1547 c.byte_stack = byte_stack_list;
1548 if (_setjmp (c.jmp))
1550 return (*hfun) (c.val);
1552 c.next = catchlist;
1553 catchlist = &c;
1554 h.handler = handlers;
1555 h.var = Qnil;
1556 h.next = handlerlist;
1557 h.tag = &c;
1558 handlerlist = &h;
1560 val = (*bfun) (arg);
1561 catchlist = c.next;
1562 handlerlist = h.next;
1563 return val;
1567 /* Like internal_condition_case but call BFUN with NARGS as first,
1568 and ARGS as second argument. */
1570 Lisp_Object
1571 internal_condition_case_2 (bfun, nargs, args, handlers, hfun)
1572 Lisp_Object (*bfun) ();
1573 int nargs;
1574 Lisp_Object *args;
1575 Lisp_Object handlers;
1576 Lisp_Object (*hfun) ();
1578 Lisp_Object val;
1579 struct catchtag c;
1580 struct handler h;
1582 /* Since Fsignal will close off all calls to x_catch_errors,
1583 we will get the wrong results if some are not closed now. */
1584 #if HAVE_X_WINDOWS
1585 if (x_catching_errors ())
1586 abort ();
1587 #endif
1589 c.tag = Qnil;
1590 c.val = Qnil;
1591 c.backlist = backtrace_list;
1592 c.handlerlist = handlerlist;
1593 c.lisp_eval_depth = lisp_eval_depth;
1594 c.pdlcount = SPECPDL_INDEX ();
1595 c.poll_suppress_count = poll_suppress_count;
1596 c.interrupt_input_blocked = interrupt_input_blocked;
1597 c.gcpro = gcprolist;
1598 c.byte_stack = byte_stack_list;
1599 if (_setjmp (c.jmp))
1601 return (*hfun) (c.val);
1603 c.next = catchlist;
1604 catchlist = &c;
1605 h.handler = handlers;
1606 h.var = Qnil;
1607 h.next = handlerlist;
1608 h.tag = &c;
1609 handlerlist = &h;
1611 val = (*bfun) (nargs, args);
1612 catchlist = c.next;
1613 handlerlist = h.next;
1614 return val;
1618 static Lisp_Object find_handler_clause P_ ((Lisp_Object, Lisp_Object,
1619 Lisp_Object, Lisp_Object));
1621 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1622 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1623 This function does not return.
1625 An error symbol is a symbol with an `error-conditions' property
1626 that is a list of condition names.
1627 A handler for any of those names will get to handle this signal.
1628 The symbol `error' should normally be one of them.
1630 DATA should be a list. Its elements are printed as part of the error message.
1631 See Info anchor `(elisp)Definition of signal' for some details on how this
1632 error message is constructed.
1633 If the signal is handled, DATA is made available to the handler.
1634 See also the function `condition-case'. */)
1635 (error_symbol, data)
1636 Lisp_Object error_symbol, data;
1638 /* When memory is full, ERROR-SYMBOL is nil,
1639 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1640 That is a special case--don't do this in other situations. */
1641 register struct handler *allhandlers = handlerlist;
1642 Lisp_Object conditions;
1643 extern int gc_in_progress;
1644 extern int waiting_for_input;
1645 Lisp_Object string;
1646 Lisp_Object real_error_symbol;
1647 struct backtrace *bp;
1649 immediate_quit = handling_signal = 0;
1650 abort_on_gc = 0;
1651 if (gc_in_progress || waiting_for_input)
1652 abort ();
1654 if (NILP (error_symbol))
1655 real_error_symbol = Fcar (data);
1656 else
1657 real_error_symbol = error_symbol;
1659 #if 0 /* rms: I don't know why this was here,
1660 but it is surely wrong for an error that is handled. */
1661 #ifdef HAVE_WINDOW_SYSTEM
1662 if (display_hourglass_p)
1663 cancel_hourglass ();
1664 #endif
1665 #endif
1667 /* This hook is used by edebug. */
1668 if (! NILP (Vsignal_hook_function)
1669 && ! NILP (error_symbol))
1671 /* Edebug takes care of restoring these variables when it exits. */
1672 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1673 max_lisp_eval_depth = lisp_eval_depth + 20;
1675 if (SPECPDL_INDEX () + 40 > max_specpdl_size)
1676 max_specpdl_size = SPECPDL_INDEX () + 40;
1678 call2 (Vsignal_hook_function, error_symbol, data);
1681 conditions = Fget (real_error_symbol, Qerror_conditions);
1683 /* Remember from where signal was called. Skip over the frame for
1684 `signal' itself. If a frame for `error' follows, skip that,
1685 too. Don't do this when ERROR_SYMBOL is nil, because that
1686 is a memory-full error. */
1687 Vsignaling_function = Qnil;
1688 if (backtrace_list && !NILP (error_symbol))
1690 bp = backtrace_list->next;
1691 if (bp && bp->function && EQ (*bp->function, Qerror))
1692 bp = bp->next;
1693 if (bp && bp->function)
1694 Vsignaling_function = *bp->function;
1697 for (; handlerlist; handlerlist = handlerlist->next)
1699 register Lisp_Object clause;
1701 clause = find_handler_clause (handlerlist->handler, conditions,
1702 error_symbol, data);
1704 if (EQ (clause, Qlambda))
1706 /* We can't return values to code which signaled an error, but we
1707 can continue code which has signaled a quit. */
1708 if (EQ (real_error_symbol, Qquit))
1709 return Qnil;
1710 else
1711 error ("Cannot return from the debugger in an error");
1714 if (!NILP (clause))
1716 Lisp_Object unwind_data;
1717 struct handler *h = handlerlist;
1719 handlerlist = allhandlers;
1721 if (NILP (error_symbol))
1722 unwind_data = data;
1723 else
1724 unwind_data = Fcons (error_symbol, data);
1725 h->chosen_clause = clause;
1726 unwind_to_catch (h->tag, unwind_data);
1730 handlerlist = allhandlers;
1731 /* If no handler is present now, try to run the debugger,
1732 and if that fails, throw to top level. */
1733 find_handler_clause (Qerror, conditions, error_symbol, data);
1734 if (catchlist != 0)
1735 Fthrow (Qtop_level, Qt);
1737 if (! NILP (error_symbol))
1738 data = Fcons (error_symbol, data);
1740 string = Ferror_message_string (data);
1741 fatal ("%s", SDATA (string), 0);
1744 /* Internal version of Fsignal that never returns.
1745 Used for anything but Qquit (which can return from Fsignal). */
1747 void
1748 xsignal (error_symbol, data)
1749 Lisp_Object error_symbol, data;
1751 Fsignal (error_symbol, data);
1752 abort ();
1755 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1757 void
1758 xsignal0 (error_symbol)
1759 Lisp_Object error_symbol;
1761 xsignal (error_symbol, Qnil);
1764 void
1765 xsignal1 (error_symbol, arg)
1766 Lisp_Object error_symbol, arg;
1768 xsignal (error_symbol, list1 (arg));
1771 void
1772 xsignal2 (error_symbol, arg1, arg2)
1773 Lisp_Object error_symbol, arg1, arg2;
1775 xsignal (error_symbol, list2 (arg1, arg2));
1778 void
1779 xsignal3 (error_symbol, arg1, arg2, arg3)
1780 Lisp_Object error_symbol, arg1, arg2, arg3;
1782 xsignal (error_symbol, list3 (arg1, arg2, arg3));
1785 /* Signal `error' with message S, and additional arg ARG.
1786 If ARG is not a genuine list, make it a one-element list. */
1788 void
1789 signal_error (s, arg)
1790 char *s;
1791 Lisp_Object arg;
1793 Lisp_Object tortoise, hare;
1795 hare = tortoise = arg;
1796 while (CONSP (hare))
1798 hare = XCDR (hare);
1799 if (!CONSP (hare))
1800 break;
1802 hare = XCDR (hare);
1803 tortoise = XCDR (tortoise);
1805 if (EQ (hare, tortoise))
1806 break;
1809 if (!NILP (hare))
1810 arg = Fcons (arg, Qnil); /* Make it a list. */
1812 xsignal (Qerror, Fcons (build_string (s), arg));
1816 /* Return nonzero if LIST is a non-nil atom or
1817 a list containing one of CONDITIONS. */
1819 static int
1820 wants_debugger (list, conditions)
1821 Lisp_Object list, conditions;
1823 if (NILP (list))
1824 return 0;
1825 if (! CONSP (list))
1826 return 1;
1828 while (CONSP (conditions))
1830 Lisp_Object this, tail;
1831 this = XCAR (conditions);
1832 for (tail = list; CONSP (tail); tail = XCDR (tail))
1833 if (EQ (XCAR (tail), this))
1834 return 1;
1835 conditions = XCDR (conditions);
1837 return 0;
1840 /* Return 1 if an error with condition-symbols CONDITIONS,
1841 and described by SIGNAL-DATA, should skip the debugger
1842 according to debugger-ignored-errors. */
1844 static int
1845 skip_debugger (conditions, data)
1846 Lisp_Object conditions, data;
1848 Lisp_Object tail;
1849 int first_string = 1;
1850 Lisp_Object error_message;
1852 error_message = Qnil;
1853 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1855 if (STRINGP (XCAR (tail)))
1857 if (first_string)
1859 error_message = Ferror_message_string (data);
1860 first_string = 0;
1863 if (fast_string_match (XCAR (tail), error_message) >= 0)
1864 return 1;
1866 else
1868 Lisp_Object contail;
1870 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1871 if (EQ (XCAR (tail), XCAR (contail)))
1872 return 1;
1876 return 0;
1879 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1880 SIG and DATA describe the signal, as in find_handler_clause. */
1882 static int
1883 maybe_call_debugger (conditions, sig, data)
1884 Lisp_Object conditions, sig, data;
1886 Lisp_Object combined_data;
1888 combined_data = Fcons (sig, data);
1890 if (
1891 /* Don't try to run the debugger with interrupts blocked.
1892 The editing loop would return anyway. */
1893 ! INPUT_BLOCKED_P
1894 /* Does user want to enter debugger for this kind of error? */
1895 && (EQ (sig, Qquit)
1896 ? debug_on_quit
1897 : wants_debugger (Vdebug_on_error, conditions))
1898 && ! skip_debugger (conditions, combined_data)
1899 /* rms: what's this for? */
1900 && when_entered_debugger < num_nonmacro_input_events)
1902 call_debugger (Fcons (Qerror, Fcons (combined_data, Qnil)));
1903 return 1;
1906 return 0;
1909 /* Value of Qlambda means we have called debugger and user has continued.
1910 There are two ways to pass SIG and DATA:
1911 = SIG is the error symbol, and DATA is the rest of the data.
1912 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1913 This is for memory-full errors only.
1915 We need to increase max_specpdl_size temporarily around
1916 anything we do that can push on the specpdl, so as not to get
1917 a second error here in case we're handling specpdl overflow. */
1919 static Lisp_Object
1920 find_handler_clause (handlers, conditions, sig, data)
1921 Lisp_Object handlers, conditions, sig, data;
1923 register Lisp_Object h;
1924 register Lisp_Object tem;
1925 int debugger_called = 0;
1926 int debugger_considered = 0;
1928 /* t is used by handlers for all conditions, set up by C code. */
1929 if (EQ (handlers, Qt))
1930 return Qt;
1932 /* Don't run the debugger for a memory-full error.
1933 (There is no room in memory to do that!) */
1934 if (NILP (sig))
1935 debugger_considered = 1;
1937 /* error is used similarly, but means print an error message
1938 and run the debugger if that is enabled. */
1939 if (EQ (handlers, Qerror)
1940 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1941 there is a handler. */
1943 if (!NILP (sig) && wants_debugger (Vstack_trace_on_error, conditions))
1945 max_lisp_eval_depth += 15;
1946 max_specpdl_size++;
1947 #ifdef PROTOTYPES
1948 internal_with_output_to_temp_buffer ("*Backtrace*",
1949 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1950 Qnil);
1951 #else
1952 internal_with_output_to_temp_buffer ("*Backtrace*",
1953 Fbacktrace, Qnil);
1954 #endif
1955 max_specpdl_size--;
1956 max_lisp_eval_depth -= 15;
1959 if (!debugger_considered)
1961 debugger_considered = 1;
1962 debugger_called = maybe_call_debugger (conditions, sig, data);
1965 /* If there is no handler, return saying whether we ran the debugger. */
1966 if (EQ (handlers, Qerror))
1968 if (debugger_called)
1969 return Qlambda;
1970 return Qt;
1974 for (h = handlers; CONSP (h); h = Fcdr (h))
1976 Lisp_Object handler, condit;
1978 handler = Fcar (h);
1979 if (!CONSP (handler))
1980 continue;
1981 condit = Fcar (handler);
1982 /* Handle a single condition name in handler HANDLER. */
1983 if (SYMBOLP (condit))
1985 tem = Fmemq (Fcar (handler), conditions);
1986 if (!NILP (tem))
1987 return handler;
1989 /* Handle a list of condition names in handler HANDLER. */
1990 else if (CONSP (condit))
1992 Lisp_Object tail;
1993 for (tail = condit; CONSP (tail); tail = XCDR (tail))
1995 tem = Fmemq (Fcar (tail), conditions);
1996 if (!NILP (tem))
1998 /* This handler is going to apply.
1999 Does it allow the debugger to run first? */
2000 if (! debugger_considered && !NILP (Fmemq (Qdebug, condit)))
2001 maybe_call_debugger (conditions, sig, data);
2002 return handler;
2008 return Qnil;
2011 /* dump an error message; called like printf */
2013 /* VARARGS 1 */
2014 void
2015 error (m, a1, a2, a3)
2016 char *m;
2017 char *a1, *a2, *a3;
2019 char buf[200];
2020 int size = 200;
2021 int mlen;
2022 char *buffer = buf;
2023 char *args[3];
2024 int allocated = 0;
2025 Lisp_Object string;
2027 args[0] = a1;
2028 args[1] = a2;
2029 args[2] = a3;
2031 mlen = strlen (m);
2033 while (1)
2035 int used = doprnt (buffer, size, m, m + mlen, 3, args);
2036 if (used < size)
2037 break;
2038 size *= 2;
2039 if (allocated)
2040 buffer = (char *) xrealloc (buffer, size);
2041 else
2043 buffer = (char *) xmalloc (size);
2044 allocated = 1;
2048 string = build_string (buffer);
2049 if (allocated)
2050 xfree (buffer);
2052 xsignal1 (Qerror, string);
2055 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
2056 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
2057 This means it contains a description for how to read arguments to give it.
2058 The value is nil for an invalid function or a symbol with no function
2059 definition.
2061 Interactively callable functions include strings and vectors (treated
2062 as keyboard macros), lambda-expressions that contain a top-level call
2063 to `interactive', autoload definitions made by `autoload' with non-nil
2064 fourth argument, and some of the built-in functions of Lisp.
2066 Also, a symbol satisfies `commandp' if its function definition does so.
2068 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2069 then strings and vectors are not accepted. */)
2070 (function, for_call_interactively)
2071 Lisp_Object function, for_call_interactively;
2073 register Lisp_Object fun;
2074 register Lisp_Object funcar;
2075 Lisp_Object if_prop = Qnil;
2077 fun = function;
2079 fun = indirect_function (fun); /* Check cycles. */
2080 if (NILP (fun) || EQ (fun, Qunbound))
2081 return Qnil;
2083 /* Check an `interactive-form' property if present, analogous to the
2084 function-documentation property. */
2085 fun = function;
2086 while (SYMBOLP (fun))
2088 Lisp_Object tmp = Fget (fun, Qinteractive_form);
2089 if (!NILP (tmp))
2090 if_prop = Qt;
2091 fun = Fsymbol_function (fun);
2094 /* Emacs primitives are interactive if their DEFUN specifies an
2095 interactive spec. */
2096 if (SUBRP (fun))
2097 return XSUBR (fun)->intspec ? Qt : if_prop;
2099 /* Bytecode objects are interactive if they are long enough to
2100 have an element whose index is COMPILED_INTERACTIVE, which is
2101 where the interactive spec is stored. */
2102 else if (COMPILEDP (fun))
2103 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
2104 ? Qt : if_prop);
2106 /* Strings and vectors are keyboard macros. */
2107 if (STRINGP (fun) || VECTORP (fun))
2108 return (NILP (for_call_interactively) ? Qt : Qnil);
2110 /* Lists may represent commands. */
2111 if (!CONSP (fun))
2112 return Qnil;
2113 funcar = XCAR (fun);
2114 if (EQ (funcar, Qlambda))
2115 return !NILP (Fassq (Qinteractive, Fcdr (XCDR (fun)))) ? Qt : if_prop;
2116 if (EQ (funcar, Qautoload))
2117 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun))))) ? Qt : if_prop;
2118 else
2119 return Qnil;
2122 /* ARGSUSED */
2123 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
2124 doc: /* Define FUNCTION to autoload from FILE.
2125 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2126 Third arg DOCSTRING is documentation for the function.
2127 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2128 Fifth arg TYPE indicates the type of the object:
2129 nil or omitted says FUNCTION is a function,
2130 `keymap' says FUNCTION is really a keymap, and
2131 `macro' or t says FUNCTION is really a macro.
2132 Third through fifth args give info about the real definition.
2133 They default to nil.
2134 If FUNCTION is already defined other than as an autoload,
2135 this does nothing and returns nil. */)
2136 (function, file, docstring, interactive, type)
2137 Lisp_Object function, file, docstring, interactive, type;
2139 #ifdef NO_ARG_ARRAY
2140 Lisp_Object args[4];
2141 #endif
2143 CHECK_SYMBOL (function);
2144 CHECK_STRING (file);
2146 /* If function is defined and not as an autoload, don't override */
2147 if (!EQ (XSYMBOL (function)->function, Qunbound)
2148 && !(CONSP (XSYMBOL (function)->function)
2149 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
2150 return Qnil;
2152 if (NILP (Vpurify_flag))
2153 /* Only add entries after dumping, because the ones before are
2154 not useful and else we get loads of them from the loaddefs.el. */
2155 LOADHIST_ATTACH (Fcons (Qautoload, function));
2157 #ifdef NO_ARG_ARRAY
2158 args[0] = file;
2159 args[1] = docstring;
2160 args[2] = interactive;
2161 args[3] = type;
2163 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
2164 #else /* NO_ARG_ARRAY */
2165 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
2166 #endif /* not NO_ARG_ARRAY */
2169 Lisp_Object
2170 un_autoload (oldqueue)
2171 Lisp_Object oldqueue;
2173 register Lisp_Object queue, first, second;
2175 /* Queue to unwind is current value of Vautoload_queue.
2176 oldqueue is the shadowed value to leave in Vautoload_queue. */
2177 queue = Vautoload_queue;
2178 Vautoload_queue = oldqueue;
2179 while (CONSP (queue))
2181 first = XCAR (queue);
2182 second = Fcdr (first);
2183 first = Fcar (first);
2184 if (EQ (first, make_number (0)))
2185 Vfeatures = second;
2186 else
2187 Ffset (first, second);
2188 queue = XCDR (queue);
2190 return Qnil;
2193 /* Load an autoloaded function.
2194 FUNNAME is the symbol which is the function's name.
2195 FUNDEF is the autoload definition (a list). */
2197 void
2198 do_autoload (fundef, funname)
2199 Lisp_Object fundef, funname;
2201 int count = SPECPDL_INDEX ();
2202 Lisp_Object fun;
2203 struct gcpro gcpro1, gcpro2, gcpro3;
2205 /* This is to make sure that loadup.el gives a clear picture
2206 of what files are preloaded and when. */
2207 if (! NILP (Vpurify_flag))
2208 error ("Attempt to autoload %s while preparing to dump",
2209 SDATA (SYMBOL_NAME (funname)));
2211 fun = funname;
2212 CHECK_SYMBOL (funname);
2213 GCPRO3 (fun, funname, fundef);
2215 /* Preserve the match data. */
2216 record_unwind_save_match_data ();
2218 /* If autoloading gets an error (which includes the error of failing
2219 to define the function being called), we use Vautoload_queue
2220 to undo function definitions and `provide' calls made by
2221 the function. We do this in the specific case of autoloading
2222 because autoloading is not an explicit request "load this file",
2223 but rather a request to "call this function".
2225 The value saved here is to be restored into Vautoload_queue. */
2226 record_unwind_protect (un_autoload, Vautoload_queue);
2227 Vautoload_queue = Qt;
2228 Fload (Fcar (Fcdr (fundef)), Qnil, Qt, Qnil, Qt);
2230 /* Once loading finishes, don't undo it. */
2231 Vautoload_queue = Qt;
2232 unbind_to (count, Qnil);
2234 fun = Findirect_function (fun, Qnil);
2236 if (!NILP (Fequal (fun, fundef)))
2237 error ("Autoloading failed to define function %s",
2238 SDATA (SYMBOL_NAME (funname)));
2239 UNGCPRO;
2243 DEFUN ("eval", Feval, Seval, 1, 1, 0,
2244 doc: /* Evaluate FORM and return its value. */)
2245 (form)
2246 Lisp_Object form;
2248 Lisp_Object fun, val, original_fun, original_args;
2249 Lisp_Object funcar;
2250 struct backtrace backtrace;
2251 struct gcpro gcpro1, gcpro2, gcpro3;
2253 if (handling_signal)
2254 abort ();
2256 if (SYMBOLP (form))
2257 return Fsymbol_value (form);
2258 if (!CONSP (form))
2259 return form;
2261 QUIT;
2262 if ((consing_since_gc > gc_cons_threshold
2263 && consing_since_gc > gc_relative_threshold)
2265 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2267 GCPRO1 (form);
2268 Fgarbage_collect ();
2269 UNGCPRO;
2272 if (++lisp_eval_depth > max_lisp_eval_depth)
2274 if (max_lisp_eval_depth < 100)
2275 max_lisp_eval_depth = 100;
2276 if (lisp_eval_depth > max_lisp_eval_depth)
2277 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2280 original_fun = Fcar (form);
2281 original_args = Fcdr (form);
2283 backtrace.next = backtrace_list;
2284 backtrace_list = &backtrace;
2285 backtrace.function = &original_fun; /* This also protects them from gc */
2286 backtrace.args = &original_args;
2287 backtrace.nargs = UNEVALLED;
2288 backtrace.evalargs = 1;
2289 backtrace.debug_on_exit = 0;
2291 if (debug_on_next_call)
2292 do_debug_on_call (Qt);
2294 /* At this point, only original_fun and original_args
2295 have values that will be used below */
2296 retry:
2298 /* Optimize for no indirection. */
2299 fun = original_fun;
2300 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2301 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2302 fun = indirect_function (fun);
2304 if (SUBRP (fun))
2306 Lisp_Object numargs;
2307 Lisp_Object argvals[8];
2308 Lisp_Object args_left;
2309 register int i, maxargs;
2311 args_left = original_args;
2312 numargs = Flength (args_left);
2314 CHECK_CONS_LIST ();
2316 if (XINT (numargs) < XSUBR (fun)->min_args ||
2317 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
2318 xsignal2 (Qwrong_number_of_arguments, original_fun, numargs);
2320 if (XSUBR (fun)->max_args == UNEVALLED)
2322 backtrace.evalargs = 0;
2323 val = (*XSUBR (fun)->function) (args_left);
2324 goto done;
2327 if (XSUBR (fun)->max_args == MANY)
2329 /* Pass a vector of evaluated arguments */
2330 Lisp_Object *vals;
2331 register int argnum = 0;
2333 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2335 GCPRO3 (args_left, fun, fun);
2336 gcpro3.var = vals;
2337 gcpro3.nvars = 0;
2339 while (!NILP (args_left))
2341 vals[argnum++] = Feval (Fcar (args_left));
2342 args_left = Fcdr (args_left);
2343 gcpro3.nvars = argnum;
2346 backtrace.args = vals;
2347 backtrace.nargs = XINT (numargs);
2349 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
2350 UNGCPRO;
2351 goto done;
2354 GCPRO3 (args_left, fun, fun);
2355 gcpro3.var = argvals;
2356 gcpro3.nvars = 0;
2358 maxargs = XSUBR (fun)->max_args;
2359 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2361 argvals[i] = Feval (Fcar (args_left));
2362 gcpro3.nvars = ++i;
2365 UNGCPRO;
2367 backtrace.args = argvals;
2368 backtrace.nargs = XINT (numargs);
2370 switch (i)
2372 case 0:
2373 val = (*XSUBR (fun)->function) ();
2374 goto done;
2375 case 1:
2376 val = (*XSUBR (fun)->function) (argvals[0]);
2377 goto done;
2378 case 2:
2379 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
2380 goto done;
2381 case 3:
2382 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2383 argvals[2]);
2384 goto done;
2385 case 4:
2386 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2387 argvals[2], argvals[3]);
2388 goto done;
2389 case 5:
2390 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2391 argvals[3], argvals[4]);
2392 goto done;
2393 case 6:
2394 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2395 argvals[3], argvals[4], argvals[5]);
2396 goto done;
2397 case 7:
2398 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2399 argvals[3], argvals[4], argvals[5],
2400 argvals[6]);
2401 goto done;
2403 case 8:
2404 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2405 argvals[3], argvals[4], argvals[5],
2406 argvals[6], argvals[7]);
2407 goto done;
2409 default:
2410 /* Someone has created a subr that takes more arguments than
2411 is supported by this code. We need to either rewrite the
2412 subr to use a different argument protocol, or add more
2413 cases to this switch. */
2414 abort ();
2417 if (COMPILEDP (fun))
2418 val = apply_lambda (fun, original_args, 1);
2419 else
2421 if (EQ (fun, Qunbound))
2422 xsignal1 (Qvoid_function, original_fun);
2423 if (!CONSP (fun))
2424 xsignal1 (Qinvalid_function, original_fun);
2425 funcar = XCAR (fun);
2426 if (!SYMBOLP (funcar))
2427 xsignal1 (Qinvalid_function, original_fun);
2428 if (EQ (funcar, Qautoload))
2430 do_autoload (fun, original_fun);
2431 goto retry;
2433 if (EQ (funcar, Qmacro))
2434 val = Feval (apply1 (Fcdr (fun), original_args));
2435 else if (EQ (funcar, Qlambda))
2436 val = apply_lambda (fun, original_args, 1);
2437 else
2438 xsignal1 (Qinvalid_function, original_fun);
2440 done:
2441 CHECK_CONS_LIST ();
2443 lisp_eval_depth--;
2444 if (backtrace.debug_on_exit)
2445 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2446 backtrace_list = backtrace.next;
2448 return val;
2451 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2452 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2453 Then return the value FUNCTION returns.
2454 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2455 usage: (apply FUNCTION &rest ARGUMENTS) */)
2456 (nargs, args)
2457 int nargs;
2458 Lisp_Object *args;
2460 register int i, numargs;
2461 register Lisp_Object spread_arg;
2462 register Lisp_Object *funcall_args;
2463 Lisp_Object fun;
2464 struct gcpro gcpro1;
2466 fun = args [0];
2467 funcall_args = 0;
2468 spread_arg = args [nargs - 1];
2469 CHECK_LIST (spread_arg);
2471 numargs = XINT (Flength (spread_arg));
2473 if (numargs == 0)
2474 return Ffuncall (nargs - 1, args);
2475 else if (numargs == 1)
2477 args [nargs - 1] = XCAR (spread_arg);
2478 return Ffuncall (nargs, args);
2481 numargs += nargs - 2;
2483 /* Optimize for no indirection. */
2484 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2485 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2486 fun = indirect_function (fun);
2487 if (EQ (fun, Qunbound))
2489 /* Let funcall get the error */
2490 fun = args[0];
2491 goto funcall;
2494 if (SUBRP (fun))
2496 if (numargs < XSUBR (fun)->min_args
2497 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2498 goto funcall; /* Let funcall get the error */
2499 else if (XSUBR (fun)->max_args > numargs)
2501 /* Avoid making funcall cons up a yet another new vector of arguments
2502 by explicitly supplying nil's for optional values */
2503 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2504 * sizeof (Lisp_Object));
2505 for (i = numargs; i < XSUBR (fun)->max_args;)
2506 funcall_args[++i] = Qnil;
2507 GCPRO1 (*funcall_args);
2508 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2511 funcall:
2512 /* We add 1 to numargs because funcall_args includes the
2513 function itself as well as its arguments. */
2514 if (!funcall_args)
2516 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
2517 * sizeof (Lisp_Object));
2518 GCPRO1 (*funcall_args);
2519 gcpro1.nvars = 1 + numargs;
2522 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2523 /* Spread the last arg we got. Its first element goes in
2524 the slot that it used to occupy, hence this value of I. */
2525 i = nargs - 1;
2526 while (!NILP (spread_arg))
2528 funcall_args [i++] = XCAR (spread_arg);
2529 spread_arg = XCDR (spread_arg);
2532 /* By convention, the caller needs to gcpro Ffuncall's args. */
2533 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
2536 /* Run hook variables in various ways. */
2538 enum run_hooks_condition {to_completion, until_success, until_failure};
2539 static Lisp_Object run_hook_with_args P_ ((int, Lisp_Object *,
2540 enum run_hooks_condition));
2542 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2543 doc: /* Run each hook in HOOKS.
2544 Each argument should be a symbol, a hook variable.
2545 These symbols are processed in the order specified.
2546 If a hook symbol has a non-nil value, that value may be a function
2547 or a list of functions to be called to run the hook.
2548 If the value is a function, it is called with no arguments.
2549 If it is a list, the elements are called, in order, with no arguments.
2551 Major modes should not use this function directly to run their mode
2552 hook; they should use `run-mode-hooks' instead.
2554 Do not use `make-local-variable' to make a hook variable buffer-local.
2555 Instead, use `add-hook' and specify t for the LOCAL argument.
2556 usage: (run-hooks &rest HOOKS) */)
2557 (nargs, args)
2558 int nargs;
2559 Lisp_Object *args;
2561 Lisp_Object hook[1];
2562 register int i;
2564 for (i = 0; i < nargs; i++)
2566 hook[0] = args[i];
2567 run_hook_with_args (1, hook, to_completion);
2570 return Qnil;
2573 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2574 Srun_hook_with_args, 1, MANY, 0,
2575 doc: /* Run HOOK with the specified arguments ARGS.
2576 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2577 value, that value may be a function or a list of functions to be
2578 called to run the hook. If the value is a function, it is called with
2579 the given arguments and its return value is returned. If it is a list
2580 of functions, those functions are called, in order,
2581 with the given arguments ARGS.
2582 It is best not to depend on the value returned by `run-hook-with-args',
2583 as that may change.
2585 Do not use `make-local-variable' to make a hook variable buffer-local.
2586 Instead, use `add-hook' and specify t for the LOCAL argument.
2587 usage: (run-hook-with-args HOOK &rest ARGS) */)
2588 (nargs, args)
2589 int nargs;
2590 Lisp_Object *args;
2592 return run_hook_with_args (nargs, args, to_completion);
2595 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2596 Srun_hook_with_args_until_success, 1, MANY, 0,
2597 doc: /* Run HOOK with the specified arguments ARGS.
2598 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2599 value, that value may be a function or a list of functions to be
2600 called to run the hook. If the value is a function, it is called with
2601 the given arguments and its return value is returned.
2602 If it is a list of functions, those functions are called, in order,
2603 with the given arguments ARGS, until one of them
2604 returns a non-nil value. Then we return that value.
2605 However, if they all return nil, we return nil.
2607 Do not use `make-local-variable' to make a hook variable buffer-local.
2608 Instead, use `add-hook' and specify t for the LOCAL argument.
2609 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2610 (nargs, args)
2611 int nargs;
2612 Lisp_Object *args;
2614 return run_hook_with_args (nargs, args, until_success);
2617 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2618 Srun_hook_with_args_until_failure, 1, MANY, 0,
2619 doc: /* Run HOOK with the specified arguments ARGS.
2620 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2621 value, that value may be a function or a list of functions to be
2622 called to run the hook. If the value is a function, it is called with
2623 the given arguments and its return value is returned.
2624 If it is a list of functions, those functions are called, in order,
2625 with the given arguments ARGS, until one of them returns nil.
2626 Then we return nil. However, if they all return non-nil, we return non-nil.
2628 Do not use `make-local-variable' to make a hook variable buffer-local.
2629 Instead, use `add-hook' and specify t for the LOCAL argument.
2630 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2631 (nargs, args)
2632 int nargs;
2633 Lisp_Object *args;
2635 return run_hook_with_args (nargs, args, until_failure);
2638 /* ARGS[0] should be a hook symbol.
2639 Call each of the functions in the hook value, passing each of them
2640 as arguments all the rest of ARGS (all NARGS - 1 elements).
2641 COND specifies a condition to test after each call
2642 to decide whether to stop.
2643 The caller (or its caller, etc) must gcpro all of ARGS,
2644 except that it isn't necessary to gcpro ARGS[0]. */
2646 static Lisp_Object
2647 run_hook_with_args (nargs, args, cond)
2648 int nargs;
2649 Lisp_Object *args;
2650 enum run_hooks_condition cond;
2652 Lisp_Object sym, val, ret;
2653 Lisp_Object globals;
2654 struct gcpro gcpro1, gcpro2, gcpro3;
2656 /* If we are dying or still initializing,
2657 don't do anything--it would probably crash if we tried. */
2658 if (NILP (Vrun_hooks))
2659 return Qnil;
2661 sym = args[0];
2662 val = find_symbol_value (sym);
2663 ret = (cond == until_failure ? Qt : Qnil);
2665 if (EQ (val, Qunbound) || NILP (val))
2666 return ret;
2667 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2669 args[0] = val;
2670 return Ffuncall (nargs, args);
2672 else
2674 globals = Qnil;
2675 GCPRO3 (sym, val, globals);
2677 for (;
2678 CONSP (val) && ((cond == to_completion)
2679 || (cond == until_success ? NILP (ret)
2680 : !NILP (ret)));
2681 val = XCDR (val))
2683 if (EQ (XCAR (val), Qt))
2685 /* t indicates this hook has a local binding;
2686 it means to run the global binding too. */
2688 for (globals = Fdefault_value (sym);
2689 CONSP (globals) && ((cond == to_completion)
2690 || (cond == until_success ? NILP (ret)
2691 : !NILP (ret)));
2692 globals = XCDR (globals))
2694 args[0] = XCAR (globals);
2695 /* In a global value, t should not occur. If it does, we
2696 must ignore it to avoid an endless loop. */
2697 if (!EQ (args[0], Qt))
2698 ret = Ffuncall (nargs, args);
2701 else
2703 args[0] = XCAR (val);
2704 ret = Ffuncall (nargs, args);
2708 UNGCPRO;
2709 return ret;
2713 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2714 present value of that symbol.
2715 Call each element of FUNLIST,
2716 passing each of them the rest of ARGS.
2717 The caller (or its caller, etc) must gcpro all of ARGS,
2718 except that it isn't necessary to gcpro ARGS[0]. */
2720 Lisp_Object
2721 run_hook_list_with_args (funlist, nargs, args)
2722 Lisp_Object funlist;
2723 int nargs;
2724 Lisp_Object *args;
2726 Lisp_Object sym;
2727 Lisp_Object val;
2728 Lisp_Object globals;
2729 struct gcpro gcpro1, gcpro2, gcpro3;
2731 sym = args[0];
2732 globals = Qnil;
2733 GCPRO3 (sym, val, globals);
2735 for (val = funlist; CONSP (val); val = XCDR (val))
2737 if (EQ (XCAR (val), Qt))
2739 /* t indicates this hook has a local binding;
2740 it means to run the global binding too. */
2742 for (globals = Fdefault_value (sym);
2743 CONSP (globals);
2744 globals = XCDR (globals))
2746 args[0] = XCAR (globals);
2747 /* In a global value, t should not occur. If it does, we
2748 must ignore it to avoid an endless loop. */
2749 if (!EQ (args[0], Qt))
2750 Ffuncall (nargs, args);
2753 else
2755 args[0] = XCAR (val);
2756 Ffuncall (nargs, args);
2759 UNGCPRO;
2760 return Qnil;
2763 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2765 void
2766 run_hook_with_args_2 (hook, arg1, arg2)
2767 Lisp_Object hook, arg1, arg2;
2769 Lisp_Object temp[3];
2770 temp[0] = hook;
2771 temp[1] = arg1;
2772 temp[2] = arg2;
2774 Frun_hook_with_args (3, temp);
2777 /* Apply fn to arg */
2778 Lisp_Object
2779 apply1 (fn, arg)
2780 Lisp_Object fn, arg;
2782 struct gcpro gcpro1;
2784 GCPRO1 (fn);
2785 if (NILP (arg))
2786 RETURN_UNGCPRO (Ffuncall (1, &fn));
2787 gcpro1.nvars = 2;
2788 #ifdef NO_ARG_ARRAY
2790 Lisp_Object args[2];
2791 args[0] = fn;
2792 args[1] = arg;
2793 gcpro1.var = args;
2794 RETURN_UNGCPRO (Fapply (2, args));
2796 #else /* not NO_ARG_ARRAY */
2797 RETURN_UNGCPRO (Fapply (2, &fn));
2798 #endif /* not NO_ARG_ARRAY */
2801 /* Call function fn on no arguments */
2802 Lisp_Object
2803 call0 (fn)
2804 Lisp_Object fn;
2806 struct gcpro gcpro1;
2808 GCPRO1 (fn);
2809 RETURN_UNGCPRO (Ffuncall (1, &fn));
2812 /* Call function fn with 1 argument arg1 */
2813 /* ARGSUSED */
2814 Lisp_Object
2815 call1 (fn, arg1)
2816 Lisp_Object fn, arg1;
2818 struct gcpro gcpro1;
2819 #ifdef NO_ARG_ARRAY
2820 Lisp_Object args[2];
2822 args[0] = fn;
2823 args[1] = arg1;
2824 GCPRO1 (args[0]);
2825 gcpro1.nvars = 2;
2826 RETURN_UNGCPRO (Ffuncall (2, args));
2827 #else /* not NO_ARG_ARRAY */
2828 GCPRO1 (fn);
2829 gcpro1.nvars = 2;
2830 RETURN_UNGCPRO (Ffuncall (2, &fn));
2831 #endif /* not NO_ARG_ARRAY */
2834 /* Call function fn with 2 arguments arg1, arg2 */
2835 /* ARGSUSED */
2836 Lisp_Object
2837 call2 (fn, arg1, arg2)
2838 Lisp_Object fn, arg1, arg2;
2840 struct gcpro gcpro1;
2841 #ifdef NO_ARG_ARRAY
2842 Lisp_Object args[3];
2843 args[0] = fn;
2844 args[1] = arg1;
2845 args[2] = arg2;
2846 GCPRO1 (args[0]);
2847 gcpro1.nvars = 3;
2848 RETURN_UNGCPRO (Ffuncall (3, args));
2849 #else /* not NO_ARG_ARRAY */
2850 GCPRO1 (fn);
2851 gcpro1.nvars = 3;
2852 RETURN_UNGCPRO (Ffuncall (3, &fn));
2853 #endif /* not NO_ARG_ARRAY */
2856 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2857 /* ARGSUSED */
2858 Lisp_Object
2859 call3 (fn, arg1, arg2, arg3)
2860 Lisp_Object fn, arg1, arg2, arg3;
2862 struct gcpro gcpro1;
2863 #ifdef NO_ARG_ARRAY
2864 Lisp_Object args[4];
2865 args[0] = fn;
2866 args[1] = arg1;
2867 args[2] = arg2;
2868 args[3] = arg3;
2869 GCPRO1 (args[0]);
2870 gcpro1.nvars = 4;
2871 RETURN_UNGCPRO (Ffuncall (4, args));
2872 #else /* not NO_ARG_ARRAY */
2873 GCPRO1 (fn);
2874 gcpro1.nvars = 4;
2875 RETURN_UNGCPRO (Ffuncall (4, &fn));
2876 #endif /* not NO_ARG_ARRAY */
2879 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2880 /* ARGSUSED */
2881 Lisp_Object
2882 call4 (fn, arg1, arg2, arg3, arg4)
2883 Lisp_Object fn, arg1, arg2, arg3, arg4;
2885 struct gcpro gcpro1;
2886 #ifdef NO_ARG_ARRAY
2887 Lisp_Object args[5];
2888 args[0] = fn;
2889 args[1] = arg1;
2890 args[2] = arg2;
2891 args[3] = arg3;
2892 args[4] = arg4;
2893 GCPRO1 (args[0]);
2894 gcpro1.nvars = 5;
2895 RETURN_UNGCPRO (Ffuncall (5, args));
2896 #else /* not NO_ARG_ARRAY */
2897 GCPRO1 (fn);
2898 gcpro1.nvars = 5;
2899 RETURN_UNGCPRO (Ffuncall (5, &fn));
2900 #endif /* not NO_ARG_ARRAY */
2903 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2904 /* ARGSUSED */
2905 Lisp_Object
2906 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2907 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2909 struct gcpro gcpro1;
2910 #ifdef NO_ARG_ARRAY
2911 Lisp_Object args[6];
2912 args[0] = fn;
2913 args[1] = arg1;
2914 args[2] = arg2;
2915 args[3] = arg3;
2916 args[4] = arg4;
2917 args[5] = arg5;
2918 GCPRO1 (args[0]);
2919 gcpro1.nvars = 6;
2920 RETURN_UNGCPRO (Ffuncall (6, args));
2921 #else /* not NO_ARG_ARRAY */
2922 GCPRO1 (fn);
2923 gcpro1.nvars = 6;
2924 RETURN_UNGCPRO (Ffuncall (6, &fn));
2925 #endif /* not NO_ARG_ARRAY */
2928 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2929 /* ARGSUSED */
2930 Lisp_Object
2931 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2932 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2934 struct gcpro gcpro1;
2935 #ifdef NO_ARG_ARRAY
2936 Lisp_Object args[7];
2937 args[0] = fn;
2938 args[1] = arg1;
2939 args[2] = arg2;
2940 args[3] = arg3;
2941 args[4] = arg4;
2942 args[5] = arg5;
2943 args[6] = arg6;
2944 GCPRO1 (args[0]);
2945 gcpro1.nvars = 7;
2946 RETURN_UNGCPRO (Ffuncall (7, args));
2947 #else /* not NO_ARG_ARRAY */
2948 GCPRO1 (fn);
2949 gcpro1.nvars = 7;
2950 RETURN_UNGCPRO (Ffuncall (7, &fn));
2951 #endif /* not NO_ARG_ARRAY */
2954 /* The caller should GCPRO all the elements of ARGS. */
2956 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2957 doc: /* Call first argument as a function, passing remaining arguments to it.
2958 Return the value that function returns.
2959 Thus, (funcall 'cons 'x 'y) returns (x . y).
2960 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2961 (nargs, args)
2962 int nargs;
2963 Lisp_Object *args;
2965 Lisp_Object fun, original_fun;
2966 Lisp_Object funcar;
2967 int numargs = nargs - 1;
2968 Lisp_Object lisp_numargs;
2969 Lisp_Object val;
2970 struct backtrace backtrace;
2971 register Lisp_Object *internal_args;
2972 register int i;
2974 QUIT;
2975 if ((consing_since_gc > gc_cons_threshold
2976 && consing_since_gc > gc_relative_threshold)
2978 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2979 Fgarbage_collect ();
2981 if (++lisp_eval_depth > max_lisp_eval_depth)
2983 if (max_lisp_eval_depth < 100)
2984 max_lisp_eval_depth = 100;
2985 if (lisp_eval_depth > max_lisp_eval_depth)
2986 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2989 backtrace.next = backtrace_list;
2990 backtrace_list = &backtrace;
2991 backtrace.function = &args[0];
2992 backtrace.args = &args[1];
2993 backtrace.nargs = nargs - 1;
2994 backtrace.evalargs = 0;
2995 backtrace.debug_on_exit = 0;
2997 if (debug_on_next_call)
2998 do_debug_on_call (Qlambda);
3000 CHECK_CONS_LIST ();
3002 original_fun = args[0];
3004 retry:
3006 /* Optimize for no indirection. */
3007 fun = original_fun;
3008 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
3009 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
3010 fun = indirect_function (fun);
3012 if (SUBRP (fun))
3014 if (numargs < XSUBR (fun)->min_args
3015 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
3017 XSETFASTINT (lisp_numargs, numargs);
3018 xsignal2 (Qwrong_number_of_arguments, original_fun, lisp_numargs);
3021 if (XSUBR (fun)->max_args == UNEVALLED)
3022 xsignal1 (Qinvalid_function, original_fun);
3024 if (XSUBR (fun)->max_args == MANY)
3026 val = (*XSUBR (fun)->function) (numargs, args + 1);
3027 goto done;
3030 if (XSUBR (fun)->max_args > numargs)
3032 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
3033 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
3034 for (i = numargs; i < XSUBR (fun)->max_args; i++)
3035 internal_args[i] = Qnil;
3037 else
3038 internal_args = args + 1;
3039 switch (XSUBR (fun)->max_args)
3041 case 0:
3042 val = (*XSUBR (fun)->function) ();
3043 goto done;
3044 case 1:
3045 val = (*XSUBR (fun)->function) (internal_args[0]);
3046 goto done;
3047 case 2:
3048 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1]);
3049 goto done;
3050 case 3:
3051 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3052 internal_args[2]);
3053 goto done;
3054 case 4:
3055 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3056 internal_args[2], internal_args[3]);
3057 goto done;
3058 case 5:
3059 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3060 internal_args[2], internal_args[3],
3061 internal_args[4]);
3062 goto done;
3063 case 6:
3064 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3065 internal_args[2], internal_args[3],
3066 internal_args[4], internal_args[5]);
3067 goto done;
3068 case 7:
3069 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3070 internal_args[2], internal_args[3],
3071 internal_args[4], internal_args[5],
3072 internal_args[6]);
3073 goto done;
3075 case 8:
3076 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
3077 internal_args[2], internal_args[3],
3078 internal_args[4], internal_args[5],
3079 internal_args[6], internal_args[7]);
3080 goto done;
3082 default:
3084 /* If a subr takes more than 8 arguments without using MANY
3085 or UNEVALLED, we need to extend this function to support it.
3086 Until this is done, there is no way to call the function. */
3087 abort ();
3090 if (COMPILEDP (fun))
3091 val = funcall_lambda (fun, numargs, args + 1);
3092 else
3094 if (EQ (fun, Qunbound))
3095 xsignal1 (Qvoid_function, original_fun);
3096 if (!CONSP (fun))
3097 xsignal1 (Qinvalid_function, original_fun);
3098 funcar = XCAR (fun);
3099 if (!SYMBOLP (funcar))
3100 xsignal1 (Qinvalid_function, original_fun);
3101 if (EQ (funcar, Qlambda))
3102 val = funcall_lambda (fun, numargs, args + 1);
3103 else if (EQ (funcar, Qautoload))
3105 do_autoload (fun, original_fun);
3106 CHECK_CONS_LIST ();
3107 goto retry;
3109 else
3110 xsignal1 (Qinvalid_function, original_fun);
3112 done:
3113 CHECK_CONS_LIST ();
3114 lisp_eval_depth--;
3115 if (backtrace.debug_on_exit)
3116 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
3117 backtrace_list = backtrace.next;
3118 return val;
3121 Lisp_Object
3122 apply_lambda (fun, args, eval_flag)
3123 Lisp_Object fun, args;
3124 int eval_flag;
3126 Lisp_Object args_left;
3127 Lisp_Object numargs;
3128 register Lisp_Object *arg_vector;
3129 struct gcpro gcpro1, gcpro2, gcpro3;
3130 register int i;
3131 register Lisp_Object tem;
3133 numargs = Flength (args);
3134 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
3135 args_left = args;
3137 GCPRO3 (*arg_vector, args_left, fun);
3138 gcpro1.nvars = 0;
3140 for (i = 0; i < XINT (numargs);)
3142 tem = Fcar (args_left), args_left = Fcdr (args_left);
3143 if (eval_flag) tem = Feval (tem);
3144 arg_vector[i++] = tem;
3145 gcpro1.nvars = i;
3148 UNGCPRO;
3150 if (eval_flag)
3152 backtrace_list->args = arg_vector;
3153 backtrace_list->nargs = i;
3155 backtrace_list->evalargs = 0;
3156 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
3158 /* Do the debug-on-exit now, while arg_vector still exists. */
3159 if (backtrace_list->debug_on_exit)
3160 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
3161 /* Don't do it again when we return to eval. */
3162 backtrace_list->debug_on_exit = 0;
3163 return tem;
3166 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3167 and return the result of evaluation.
3168 FUN must be either a lambda-expression or a compiled-code object. */
3170 static Lisp_Object
3171 funcall_lambda (fun, nargs, arg_vector)
3172 Lisp_Object fun;
3173 int nargs;
3174 register Lisp_Object *arg_vector;
3176 Lisp_Object val, syms_left, next;
3177 int count = SPECPDL_INDEX ();
3178 int i, optional, rest;
3180 if (CONSP (fun))
3182 syms_left = XCDR (fun);
3183 if (CONSP (syms_left))
3184 syms_left = XCAR (syms_left);
3185 else
3186 xsignal1 (Qinvalid_function, fun);
3188 else if (COMPILEDP (fun))
3189 syms_left = AREF (fun, COMPILED_ARGLIST);
3190 else
3191 abort ();
3193 i = optional = rest = 0;
3194 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
3196 QUIT;
3198 next = XCAR (syms_left);
3199 if (!SYMBOLP (next))
3200 xsignal1 (Qinvalid_function, fun);
3202 if (EQ (next, Qand_rest))
3203 rest = 1;
3204 else if (EQ (next, Qand_optional))
3205 optional = 1;
3206 else if (rest)
3208 specbind (next, Flist (nargs - i, &arg_vector[i]));
3209 i = nargs;
3211 else if (i < nargs)
3212 specbind (next, arg_vector[i++]);
3213 else if (!optional)
3214 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3215 else
3216 specbind (next, Qnil);
3219 if (!NILP (syms_left))
3220 xsignal1 (Qinvalid_function, fun);
3221 else if (i < nargs)
3222 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3224 if (CONSP (fun))
3225 val = Fprogn (XCDR (XCDR (fun)));
3226 else
3228 /* If we have not actually read the bytecode string
3229 and constants vector yet, fetch them from the file. */
3230 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3231 Ffetch_bytecode (fun);
3232 val = Fbyte_code (AREF (fun, COMPILED_BYTECODE),
3233 AREF (fun, COMPILED_CONSTANTS),
3234 AREF (fun, COMPILED_STACK_DEPTH));
3237 return unbind_to (count, val);
3240 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
3241 1, 1, 0,
3242 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3243 (object)
3244 Lisp_Object object;
3246 Lisp_Object tem;
3248 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
3250 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
3251 if (!CONSP (tem))
3253 tem = AREF (object, COMPILED_BYTECODE);
3254 if (CONSP (tem) && STRINGP (XCAR (tem)))
3255 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
3256 else
3257 error ("Invalid byte code");
3259 ASET (object, COMPILED_BYTECODE, XCAR (tem));
3260 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
3262 return object;
3265 void
3266 grow_specpdl ()
3268 register int count = SPECPDL_INDEX ();
3269 if (specpdl_size >= max_specpdl_size)
3271 if (max_specpdl_size < 400)
3272 max_specpdl_size = 400;
3273 if (specpdl_size >= max_specpdl_size)
3274 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil);
3276 specpdl_size *= 2;
3277 if (specpdl_size > max_specpdl_size)
3278 specpdl_size = max_specpdl_size;
3279 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
3280 specpdl_ptr = specpdl + count;
3283 void
3284 specbind (symbol, value)
3285 Lisp_Object symbol, value;
3287 Lisp_Object valcontents;
3289 CHECK_SYMBOL (symbol);
3290 if (specpdl_ptr == specpdl + specpdl_size)
3291 grow_specpdl ();
3293 /* The most common case is that of a non-constant symbol with a
3294 trivial value. Make that as fast as we can. */
3295 valcontents = SYMBOL_VALUE (symbol);
3296 if (!MISCP (valcontents) && !SYMBOL_CONSTANT_P (symbol))
3298 specpdl_ptr->symbol = symbol;
3299 specpdl_ptr->old_value = valcontents;
3300 specpdl_ptr->func = NULL;
3301 ++specpdl_ptr;
3302 SET_SYMBOL_VALUE (symbol, value);
3304 else
3306 Lisp_Object ovalue = find_symbol_value (symbol);
3307 specpdl_ptr->func = 0;
3308 specpdl_ptr->old_value = ovalue;
3310 valcontents = XSYMBOL (symbol)->value;
3312 if (BUFFER_LOCAL_VALUEP (valcontents)
3313 || BUFFER_OBJFWDP (valcontents))
3315 Lisp_Object where, current_buffer;
3317 current_buffer = Fcurrent_buffer ();
3319 /* For a local variable, record both the symbol and which
3320 buffer's or frame's value we are saving. */
3321 if (!NILP (Flocal_variable_p (symbol, Qnil)))
3322 where = current_buffer;
3323 else if (BUFFER_LOCAL_VALUEP (valcontents)
3324 && XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame)
3325 where = XBUFFER_LOCAL_VALUE (valcontents)->frame;
3326 else
3327 where = Qnil;
3329 /* We're not using the `unused' slot in the specbinding
3330 structure because this would mean we have to do more
3331 work for simple variables. */
3332 specpdl_ptr->symbol = Fcons (symbol, Fcons (where, current_buffer));
3334 /* If SYMBOL is a per-buffer variable which doesn't have a
3335 buffer-local value here, make the `let' change the global
3336 value by changing the value of SYMBOL in all buffers not
3337 having their own value. This is consistent with what
3338 happens with other buffer-local variables. */
3339 if (NILP (where)
3340 && BUFFER_OBJFWDP (valcontents))
3342 ++specpdl_ptr;
3343 Fset_default (symbol, value);
3344 return;
3347 else
3348 specpdl_ptr->symbol = symbol;
3350 specpdl_ptr++;
3351 /* We used to do
3352 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
3353 store_symval_forwarding (symbol, ovalue, value, NULL);
3354 else
3355 but ovalue comes from find_symbol_value which should never return
3356 such an internal value. */
3357 eassert (!(BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue)));
3358 set_internal (symbol, value, 0, 1);
3362 void
3363 record_unwind_protect (function, arg)
3364 Lisp_Object (*function) P_ ((Lisp_Object));
3365 Lisp_Object arg;
3367 eassert (!handling_signal);
3369 if (specpdl_ptr == specpdl + specpdl_size)
3370 grow_specpdl ();
3371 specpdl_ptr->func = function;
3372 specpdl_ptr->symbol = Qnil;
3373 specpdl_ptr->old_value = arg;
3374 specpdl_ptr++;
3377 Lisp_Object
3378 unbind_to (count, value)
3379 int count;
3380 Lisp_Object value;
3382 Lisp_Object quitf = Vquit_flag;
3383 struct gcpro gcpro1, gcpro2;
3385 GCPRO2 (value, quitf);
3386 Vquit_flag = Qnil;
3388 while (specpdl_ptr != specpdl + count)
3390 /* Copy the binding, and decrement specpdl_ptr, before we do
3391 the work to unbind it. We decrement first
3392 so that an error in unbinding won't try to unbind
3393 the same entry again, and we copy the binding first
3394 in case more bindings are made during some of the code we run. */
3396 struct specbinding this_binding;
3397 this_binding = *--specpdl_ptr;
3399 if (this_binding.func != 0)
3400 (*this_binding.func) (this_binding.old_value);
3401 /* If the symbol is a list, it is really (SYMBOL WHERE
3402 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3403 frame. If WHERE is a buffer or frame, this indicates we
3404 bound a variable that had a buffer-local or frame-local
3405 binding. WHERE nil means that the variable had the default
3406 value when it was bound. CURRENT-BUFFER is the buffer that
3407 was current when the variable was bound. */
3408 else if (CONSP (this_binding.symbol))
3410 Lisp_Object symbol, where;
3412 symbol = XCAR (this_binding.symbol);
3413 where = XCAR (XCDR (this_binding.symbol));
3415 if (NILP (where))
3416 Fset_default (symbol, this_binding.old_value);
3417 else if (BUFFERP (where))
3418 set_internal (symbol, this_binding.old_value, XBUFFER (where), 1);
3419 else
3420 set_internal (symbol, this_binding.old_value, NULL, 1);
3422 else
3424 /* If variable has a trivial value (no forwarding), we can
3425 just set it. No need to check for constant symbols here,
3426 since that was already done by specbind. */
3427 if (!MISCP (SYMBOL_VALUE (this_binding.symbol)))
3428 SET_SYMBOL_VALUE (this_binding.symbol, this_binding.old_value);
3429 else
3430 set_internal (this_binding.symbol, this_binding.old_value, 0, 1);
3434 if (NILP (Vquit_flag) && !NILP (quitf))
3435 Vquit_flag = quitf;
3437 UNGCPRO;
3438 return value;
3441 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3442 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3443 The debugger is entered when that frame exits, if the flag is non-nil. */)
3444 (level, flag)
3445 Lisp_Object level, flag;
3447 register struct backtrace *backlist = backtrace_list;
3448 register int i;
3450 CHECK_NUMBER (level);
3452 for (i = 0; backlist && i < XINT (level); i++)
3454 backlist = backlist->next;
3457 if (backlist)
3458 backlist->debug_on_exit = !NILP (flag);
3460 return flag;
3463 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3464 doc: /* Print a trace of Lisp function calls currently active.
3465 Output stream used is value of `standard-output'. */)
3468 register struct backtrace *backlist = backtrace_list;
3469 register int i;
3470 Lisp_Object tail;
3471 Lisp_Object tem;
3472 extern Lisp_Object Vprint_level;
3473 struct gcpro gcpro1;
3475 XSETFASTINT (Vprint_level, 3);
3477 tail = Qnil;
3478 GCPRO1 (tail);
3480 while (backlist)
3482 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3483 if (backlist->nargs == UNEVALLED)
3485 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3486 write_string ("\n", -1);
3488 else
3490 tem = *backlist->function;
3491 Fprin1 (tem, Qnil); /* This can QUIT */
3492 write_string ("(", -1);
3493 if (backlist->nargs == MANY)
3495 for (tail = *backlist->args, i = 0;
3496 !NILP (tail);
3497 tail = Fcdr (tail), i++)
3499 if (i) write_string (" ", -1);
3500 Fprin1 (Fcar (tail), Qnil);
3503 else
3505 for (i = 0; i < backlist->nargs; i++)
3507 if (i) write_string (" ", -1);
3508 Fprin1 (backlist->args[i], Qnil);
3511 write_string (")\n", -1);
3513 backlist = backlist->next;
3516 Vprint_level = Qnil;
3517 UNGCPRO;
3518 return Qnil;
3521 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3522 doc: /* Return the function and arguments NFRAMES up from current execution point.
3523 If that frame has not evaluated the arguments yet (or is a special form),
3524 the value is (nil FUNCTION ARG-FORMS...).
3525 If that frame has evaluated its arguments and called its function already,
3526 the value is (t FUNCTION ARG-VALUES...).
3527 A &rest arg is represented as the tail of the list ARG-VALUES.
3528 FUNCTION is whatever was supplied as car of evaluated list,
3529 or a lambda expression for macro calls.
3530 If NFRAMES is more than the number of frames, the value is nil. */)
3531 (nframes)
3532 Lisp_Object nframes;
3534 register struct backtrace *backlist = backtrace_list;
3535 register int i;
3536 Lisp_Object tem;
3538 CHECK_NATNUM (nframes);
3540 /* Find the frame requested. */
3541 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3542 backlist = backlist->next;
3544 if (!backlist)
3545 return Qnil;
3546 if (backlist->nargs == UNEVALLED)
3547 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3548 else
3550 if (backlist->nargs == MANY)
3551 tem = *backlist->args;
3552 else
3553 tem = Flist (backlist->nargs, backlist->args);
3555 return Fcons (Qt, Fcons (*backlist->function, tem));
3560 void
3561 mark_backtrace ()
3563 register struct backtrace *backlist;
3564 register int i;
3566 for (backlist = backtrace_list; backlist; backlist = backlist->next)
3568 mark_object (*backlist->function);
3570 if (backlist->nargs == UNEVALLED || backlist->nargs == MANY)
3571 i = 0;
3572 else
3573 i = backlist->nargs - 1;
3574 for (; i >= 0; i--)
3575 mark_object (backlist->args[i]);
3579 void
3580 syms_of_eval ()
3582 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3583 doc: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3584 If Lisp code tries to increase the total number past this amount,
3585 an error is signaled.
3586 You can safely use a value considerably larger than the default value,
3587 if that proves inconveniently small. However, if you increase it too far,
3588 Emacs could run out of memory trying to make the stack bigger. */);
3590 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3591 doc: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3593 This limit serves to catch infinite recursions for you before they cause
3594 actual stack overflow in C, which would be fatal for Emacs.
3595 You can safely make it considerably larger than its default value,
3596 if that proves inconveniently small. However, if you increase it too far,
3597 Emacs could overflow the real C stack, and crash. */);
3599 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3600 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3601 If the value is t, that means do an ordinary quit.
3602 If the value equals `throw-on-input', that means quit by throwing
3603 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3604 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3605 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3606 Vquit_flag = Qnil;
3608 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3609 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3610 Note that `quit-flag' will still be set by typing C-g,
3611 so a quit will be signaled as soon as `inhibit-quit' is nil.
3612 To prevent this happening, set `quit-flag' to nil
3613 before making `inhibit-quit' nil. */);
3614 Vinhibit_quit = Qnil;
3616 Qinhibit_quit = intern ("inhibit-quit");
3617 staticpro (&Qinhibit_quit);
3619 Qautoload = intern ("autoload");
3620 staticpro (&Qautoload);
3622 Qdebug_on_error = intern ("debug-on-error");
3623 staticpro (&Qdebug_on_error);
3625 Qmacro = intern ("macro");
3626 staticpro (&Qmacro);
3628 Qdeclare = intern ("declare");
3629 staticpro (&Qdeclare);
3631 /* Note that the process handling also uses Qexit, but we don't want
3632 to staticpro it twice, so we just do it here. */
3633 Qexit = intern ("exit");
3634 staticpro (&Qexit);
3636 Qinteractive = intern ("interactive");
3637 staticpro (&Qinteractive);
3639 Qcommandp = intern ("commandp");
3640 staticpro (&Qcommandp);
3642 Qdefun = intern ("defun");
3643 staticpro (&Qdefun);
3645 Qand_rest = intern ("&rest");
3646 staticpro (&Qand_rest);
3648 Qand_optional = intern ("&optional");
3649 staticpro (&Qand_optional);
3651 Qdebug = intern ("debug");
3652 staticpro (&Qdebug);
3654 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3655 doc: /* *Non-nil means errors display a backtrace buffer.
3656 More precisely, this happens for any error that is handled
3657 by the editor command loop.
3658 If the value is a list, an error only means to display a backtrace
3659 if one of its condition symbols appears in the list. */);
3660 Vstack_trace_on_error = Qnil;
3662 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3663 doc: /* *Non-nil means enter debugger if an error is signaled.
3664 Does not apply to errors handled by `condition-case' or those
3665 matched by `debug-ignored-errors'.
3666 If the value is a list, an error only means to enter the debugger
3667 if one of its condition symbols appears in the list.
3668 When you evaluate an expression interactively, this variable
3669 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3670 The command `toggle-debug-on-error' toggles this.
3671 See also the variable `debug-on-quit'. */);
3672 Vdebug_on_error = Qnil;
3674 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3675 doc: /* *List of errors for which the debugger should not be called.
3676 Each element may be a condition-name or a regexp that matches error messages.
3677 If any element applies to a given error, that error skips the debugger
3678 and just returns to top level.
3679 This overrides the variable `debug-on-error'.
3680 It does not apply to errors handled by `condition-case'. */);
3681 Vdebug_ignored_errors = Qnil;
3683 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3684 doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3685 Does not apply if quit is handled by a `condition-case'. */);
3686 debug_on_quit = 0;
3688 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3689 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3691 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3692 doc: /* Non-nil means debugger may continue execution.
3693 This is nil when the debugger is called under circumstances where it
3694 might not be safe to continue. */);
3695 debugger_may_continue = 1;
3697 DEFVAR_LISP ("debugger", &Vdebugger,
3698 doc: /* Function to call to invoke debugger.
3699 If due to frame exit, args are `exit' and the value being returned;
3700 this function's value will be returned instead of that.
3701 If due to error, args are `error' and a list of the args to `signal'.
3702 If due to `apply' or `funcall' entry, one arg, `lambda'.
3703 If due to `eval' entry, one arg, t. */);
3704 Vdebugger = Qnil;
3706 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3707 doc: /* If non-nil, this is a function for `signal' to call.
3708 It receives the same arguments that `signal' was given.
3709 The Edebug package uses this to regain control. */);
3710 Vsignal_hook_function = Qnil;
3712 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3713 doc: /* *Non-nil means call the debugger regardless of condition handlers.
3714 Note that `debug-on-error', `debug-on-quit' and friends
3715 still determine whether to handle the particular condition. */);
3716 Vdebug_on_signal = Qnil;
3718 DEFVAR_LISP ("macro-declaration-function", &Vmacro_declaration_function,
3719 doc: /* Function to process declarations in a macro definition.
3720 The function will be called with two args MACRO and DECL.
3721 MACRO is the name of the macro being defined.
3722 DECL is a list `(declare ...)' containing the declarations.
3723 The value the function returns is not used. */);
3724 Vmacro_declaration_function = Qnil;
3726 Vrun_hooks = intern ("run-hooks");
3727 staticpro (&Vrun_hooks);
3729 staticpro (&Vautoload_queue);
3730 Vautoload_queue = Qnil;
3731 staticpro (&Vsignaling_function);
3732 Vsignaling_function = Qnil;
3734 defsubr (&Sor);
3735 defsubr (&Sand);
3736 defsubr (&Sif);
3737 defsubr (&Scond);
3738 defsubr (&Sprogn);
3739 defsubr (&Sprog1);
3740 defsubr (&Sprog2);
3741 defsubr (&Ssetq);
3742 defsubr (&Squote);
3743 defsubr (&Sfunction);
3744 defsubr (&Sdefun);
3745 defsubr (&Sdefmacro);
3746 defsubr (&Sdefvar);
3747 defsubr (&Sdefvaralias);
3748 defsubr (&Sdefconst);
3749 defsubr (&Suser_variable_p);
3750 defsubr (&Slet);
3751 defsubr (&SletX);
3752 defsubr (&Swhile);
3753 defsubr (&Smacroexpand);
3754 defsubr (&Scatch);
3755 defsubr (&Sthrow);
3756 defsubr (&Sunwind_protect);
3757 defsubr (&Scondition_case);
3758 defsubr (&Ssignal);
3759 defsubr (&Sinteractive_p);
3760 defsubr (&Scalled_interactively_p);
3761 defsubr (&Scommandp);
3762 defsubr (&Sautoload);
3763 defsubr (&Seval);
3764 defsubr (&Sapply);
3765 defsubr (&Sfuncall);
3766 defsubr (&Srun_hooks);
3767 defsubr (&Srun_hook_with_args);
3768 defsubr (&Srun_hook_with_args_until_success);
3769 defsubr (&Srun_hook_with_args_until_failure);
3770 defsubr (&Sfetch_bytecode);
3771 defsubr (&Sbacktrace_debug);
3772 defsubr (&Sbacktrace);
3773 defsubr (&Sbacktrace_frame);
3776 /* arch-tag: 014a07aa-33ab-4a8f-a3d2-ee8a4a9ff7fb
3777 (do not change this comment) */