Fix earlier half-done eieio-defmethod change.
[emacs.git] / src / eval.c
blobea090644c07cee6592600389c83f2e5a25376781
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985-1987, 1993-1995, 1999-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
21 #include <limits.h>
22 #include <setjmp.h>
23 #include <stdio.h>
24 #include "lisp.h"
25 #include "blockinput.h"
26 #include "commands.h"
27 #include "keyboard.h"
28 #include "dispextern.h"
29 #include "frame.h" /* For XFRAME. */
31 #if HAVE_X_WINDOWS
32 #include "xterm.h"
33 #endif
35 #ifndef SIZE_MAX
36 # define SIZE_MAX ((size_t) -1)
37 #endif
39 /* This definition is duplicated in alloc.c and keyboard.c. */
40 /* Putting it in lisp.h makes cc bomb out! */
42 struct backtrace
44 struct backtrace *next;
45 Lisp_Object *function;
46 Lisp_Object *args; /* Points to vector of args. */
47 #define NARGS_BITS (BITS_PER_INT - 2)
48 /* Let's not use size_t because we want to allow negative values (for
49 UNEVALLED). Also let's steal 2 bits so we save a word (or more for
50 alignment). In any case I doubt Emacs would survive a function call with
51 more than 500M arguments. */
52 int nargs : NARGS_BITS; /* Length of vector.
53 If nargs is UNEVALLED, args points
54 to slot holding list of unevalled args. */
55 char evalargs : 1;
56 /* Nonzero means call value of debugger when done with this operation. */
57 char debug_on_exit : 1;
60 static struct backtrace *backtrace_list;
62 #if !BYTE_MARK_STACK
63 static
64 #endif
65 struct catchtag *catchlist;
67 /* Chain of condition handlers currently in effect.
68 The elements of this chain are contained in the stack frames
69 of Fcondition_case and internal_condition_case.
70 When an error is signaled (by calling Fsignal, below),
71 this chain is searched for an element that applies. */
73 #if !BYTE_MARK_STACK
74 static
75 #endif
76 struct handler *handlerlist;
78 #ifdef DEBUG_GCPRO
79 /* Count levels of GCPRO to detect failure to UNGCPRO. */
80 int gcpro_level;
81 #endif
83 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
84 Lisp_Object Qinhibit_quit;
85 Lisp_Object Qand_rest;
86 static Lisp_Object Qand_optional;
87 static Lisp_Object Qdebug_on_error;
88 static Lisp_Object Qdeclare;
89 Lisp_Object Qinternal_interpreter_environment, Qclosure;
91 Lisp_Object Qdebug;
93 /* This holds either the symbol `run-hooks' or nil.
94 It is nil at an early stage of startup, and when Emacs
95 is shutting down. */
97 Lisp_Object Vrun_hooks;
99 /* Non-nil means record all fset's and provide's, to be undone
100 if the file being autoloaded is not fully loaded.
101 They are recorded by being consed onto the front of Vautoload_queue:
102 (FUN . ODEF) for a defun, (0 . OFEATURES) for a provide. */
104 Lisp_Object Vautoload_queue;
106 /* Current number of specbindings allocated in specpdl. */
108 EMACS_INT specpdl_size;
110 /* Pointer to beginning of specpdl. */
112 struct specbinding *specpdl;
114 /* Pointer to first unused element in specpdl. */
116 struct specbinding *specpdl_ptr;
118 /* Depth in Lisp evaluations and function calls. */
120 static EMACS_INT lisp_eval_depth;
122 /* The value of num_nonmacro_input_events as of the last time we
123 started to enter the debugger. If we decide to enter the debugger
124 again when this is still equal to num_nonmacro_input_events, then we
125 know that the debugger itself has an error, and we should just
126 signal the error instead of entering an infinite loop of debugger
127 invocations. */
129 static int when_entered_debugger;
131 /* The function from which the last `signal' was called. Set in
132 Fsignal. */
134 Lisp_Object Vsignaling_function;
136 /* Set to non-zero while processing X events. Checked in Feval to
137 make sure the Lisp interpreter isn't called from a signal handler,
138 which is unsafe because the interpreter isn't reentrant. */
140 int handling_signal;
142 static Lisp_Object funcall_lambda (Lisp_Object, size_t, Lisp_Object *);
143 static void unwind_to_catch (struct catchtag *, Lisp_Object) NO_RETURN;
144 static int interactive_p (int);
145 static Lisp_Object apply_lambda (Lisp_Object fun, Lisp_Object args);
146 static Lisp_Object Ffetch_bytecode (Lisp_Object);
148 void
149 init_eval_once (void)
151 specpdl_size = 50;
152 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
153 specpdl_ptr = specpdl;
154 /* Don't forget to update docs (lispref node "Local Variables"). */
155 max_specpdl_size = 1300; /* 1000 is not enough for CEDET's c-by.el. */
156 max_lisp_eval_depth = 600;
158 Vrun_hooks = Qnil;
161 void
162 init_eval (void)
164 specpdl_ptr = specpdl;
165 catchlist = 0;
166 handlerlist = 0;
167 backtrace_list = 0;
168 Vquit_flag = Qnil;
169 debug_on_next_call = 0;
170 lisp_eval_depth = 0;
171 #ifdef DEBUG_GCPRO
172 gcpro_level = 0;
173 #endif
174 /* This is less than the initial value of num_nonmacro_input_events. */
175 when_entered_debugger = -1;
178 /* Unwind-protect function used by call_debugger. */
180 static Lisp_Object
181 restore_stack_limits (Lisp_Object data)
183 max_specpdl_size = XINT (XCAR (data));
184 max_lisp_eval_depth = XINT (XCDR (data));
185 return Qnil;
188 /* Call the Lisp debugger, giving it argument ARG. */
190 static Lisp_Object
191 call_debugger (Lisp_Object arg)
193 int debug_while_redisplaying;
194 int count = SPECPDL_INDEX ();
195 Lisp_Object val;
196 EMACS_INT old_max = max_specpdl_size;
198 /* Temporarily bump up the stack limits,
199 so the debugger won't run out of stack. */
201 max_specpdl_size += 1;
202 record_unwind_protect (restore_stack_limits,
203 Fcons (make_number (old_max),
204 make_number (max_lisp_eval_depth)));
205 max_specpdl_size = old_max;
207 if (lisp_eval_depth + 40 > max_lisp_eval_depth)
208 max_lisp_eval_depth = lisp_eval_depth + 40;
210 if (SPECPDL_INDEX () + 100 > max_specpdl_size)
211 max_specpdl_size = SPECPDL_INDEX () + 100;
213 #ifdef HAVE_WINDOW_SYSTEM
214 if (display_hourglass_p)
215 cancel_hourglass ();
216 #endif
218 debug_on_next_call = 0;
219 when_entered_debugger = num_nonmacro_input_events;
221 /* Resetting redisplaying_p to 0 makes sure that debug output is
222 displayed if the debugger is invoked during redisplay. */
223 debug_while_redisplaying = redisplaying_p;
224 redisplaying_p = 0;
225 specbind (intern ("debugger-may-continue"),
226 debug_while_redisplaying ? Qnil : Qt);
227 specbind (Qinhibit_redisplay, Qnil);
228 specbind (Qdebug_on_error, Qnil);
230 #if 0 /* Binding this prevents execution of Lisp code during
231 redisplay, which necessarily leads to display problems. */
232 specbind (Qinhibit_eval_during_redisplay, Qt);
233 #endif
235 val = apply1 (Vdebugger, arg);
237 /* Interrupting redisplay and resuming it later is not safe under
238 all circumstances. So, when the debugger returns, abort the
239 interrupted redisplay by going back to the top-level. */
240 if (debug_while_redisplaying)
241 Ftop_level ();
243 return unbind_to (count, val);
246 static void
247 do_debug_on_call (Lisp_Object code)
249 debug_on_next_call = 0;
250 backtrace_list->debug_on_exit = 1;
251 call_debugger (Fcons (code, Qnil));
254 /* NOTE!!! Every function that can call EVAL must protect its args
255 and temporaries from garbage collection while it needs them.
256 The definition of `For' shows what you have to do. */
258 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
259 doc: /* Eval args until one of them yields non-nil, then return that value.
260 The remaining args are not evalled at all.
261 If all args return nil, return nil.
262 usage: (or CONDITIONS...) */)
263 (Lisp_Object args)
265 register Lisp_Object val = Qnil;
266 struct gcpro gcpro1;
268 GCPRO1 (args);
270 while (CONSP (args))
272 val = eval_sub (XCAR (args));
273 if (!NILP (val))
274 break;
275 args = XCDR (args);
278 UNGCPRO;
279 return val;
282 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
283 doc: /* Eval args until one of them yields nil, then return nil.
284 The remaining args are not evalled at all.
285 If no arg yields nil, return the last arg's value.
286 usage: (and CONDITIONS...) */)
287 (Lisp_Object args)
289 register Lisp_Object val = Qt;
290 struct gcpro gcpro1;
292 GCPRO1 (args);
294 while (CONSP (args))
296 val = eval_sub (XCAR (args));
297 if (NILP (val))
298 break;
299 args = XCDR (args);
302 UNGCPRO;
303 return val;
306 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
307 doc: /* If COND yields non-nil, do THEN, else do ELSE...
308 Returns the value of THEN or the value of the last of the ELSE's.
309 THEN must be one expression, but ELSE... can be zero or more expressions.
310 If COND yields nil, and there are no ELSE's, the value is nil.
311 usage: (if COND THEN ELSE...) */)
312 (Lisp_Object args)
314 register Lisp_Object cond;
315 struct gcpro gcpro1;
317 GCPRO1 (args);
318 cond = eval_sub (Fcar (args));
319 UNGCPRO;
321 if (!NILP (cond))
322 return eval_sub (Fcar (Fcdr (args)));
323 return Fprogn (Fcdr (Fcdr (args)));
326 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
327 doc: /* Try each clause until one succeeds.
328 Each clause looks like (CONDITION BODY...). CONDITION is evaluated
329 and, if the value is non-nil, this clause succeeds:
330 then the expressions in BODY are evaluated and the last one's
331 value is the value of the cond-form.
332 If no clause succeeds, cond returns nil.
333 If a clause has one element, as in (CONDITION),
334 CONDITION's value if non-nil is returned from the cond-form.
335 usage: (cond CLAUSES...) */)
336 (Lisp_Object args)
338 register Lisp_Object clause, val;
339 struct gcpro gcpro1;
341 val = Qnil;
342 GCPRO1 (args);
343 while (!NILP (args))
345 clause = Fcar (args);
346 val = eval_sub (Fcar (clause));
347 if (!NILP (val))
349 if (!EQ (XCDR (clause), Qnil))
350 val = Fprogn (XCDR (clause));
351 break;
353 args = XCDR (args);
355 UNGCPRO;
357 return val;
360 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
361 doc: /* Eval BODY forms sequentially and return value of last one.
362 usage: (progn BODY...) */)
363 (Lisp_Object args)
365 register Lisp_Object val = Qnil;
366 struct gcpro gcpro1;
368 GCPRO1 (args);
370 while (CONSP (args))
372 val = eval_sub (XCAR (args));
373 args = XCDR (args);
376 UNGCPRO;
377 return val;
380 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
381 doc: /* Eval FIRST and BODY sequentially; return value from FIRST.
382 The value of FIRST is saved during the evaluation of the remaining args,
383 whose values are discarded.
384 usage: (prog1 FIRST BODY...) */)
385 (Lisp_Object args)
387 Lisp_Object val;
388 register Lisp_Object args_left;
389 struct gcpro gcpro1, gcpro2;
390 register int argnum = 0;
392 if (NILP (args))
393 return Qnil;
395 args_left = args;
396 val = Qnil;
397 GCPRO2 (args, val);
401 Lisp_Object tem = eval_sub (XCAR (args_left));
402 if (!(argnum++))
403 val = tem;
404 args_left = XCDR (args_left);
406 while (CONSP (args_left));
408 UNGCPRO;
409 return val;
412 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
413 doc: /* Eval FORM1, FORM2 and BODY sequentially; return value from FORM2.
414 The value of FORM2 is saved during the evaluation of the
415 remaining args, whose values are discarded.
416 usage: (prog2 FORM1 FORM2 BODY...) */)
417 (Lisp_Object args)
419 Lisp_Object val;
420 register Lisp_Object args_left;
421 struct gcpro gcpro1, gcpro2;
422 register int argnum = -1;
424 val = Qnil;
426 if (NILP (args))
427 return Qnil;
429 args_left = args;
430 val = Qnil;
431 GCPRO2 (args, val);
435 Lisp_Object tem = eval_sub (XCAR (args_left));
436 if (!(argnum++))
437 val = tem;
438 args_left = XCDR (args_left);
440 while (CONSP (args_left));
442 UNGCPRO;
443 return val;
446 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
447 doc: /* Set each SYM to the value of its VAL.
448 The symbols SYM are variables; they are literal (not evaluated).
449 The values VAL are expressions; they are evaluated.
450 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.
451 The second VAL is not computed until after the first SYM is set, and so on;
452 each VAL can use the new value of variables set earlier in the `setq'.
453 The return value of the `setq' form is the value of the last VAL.
454 usage: (setq [SYM VAL]...) */)
455 (Lisp_Object args)
457 register Lisp_Object args_left;
458 register Lisp_Object val, sym, lex_binding;
459 struct gcpro gcpro1;
461 if (NILP (args))
462 return Qnil;
464 args_left = args;
465 GCPRO1 (args);
469 val = eval_sub (Fcar (Fcdr (args_left)));
470 sym = Fcar (args_left);
472 /* Like for eval_sub, we do not check declared_special here since
473 it's been done when let-binding. */
474 if (!NILP (Vinternal_interpreter_environment) /* Mere optimization! */
475 && SYMBOLP (sym)
476 && !NILP (lex_binding
477 = Fassq (sym, Vinternal_interpreter_environment)))
478 XSETCDR (lex_binding, val); /* SYM is lexically bound. */
479 else
480 Fset (sym, val); /* SYM is dynamically bound. */
482 args_left = Fcdr (Fcdr (args_left));
484 while (!NILP(args_left));
486 UNGCPRO;
487 return val;
490 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
491 doc: /* Return the argument, without evaluating it. `(quote x)' yields `x'.
492 usage: (quote ARG) */)
493 (Lisp_Object args)
495 if (!NILP (Fcdr (args)))
496 xsignal2 (Qwrong_number_of_arguments, Qquote, Flength (args));
497 return Fcar (args);
500 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
501 doc: /* Like `quote', but preferred for objects which are functions.
502 In byte compilation, `function' causes its argument to be compiled.
503 `quote' cannot do that.
504 usage: (function ARG) */)
505 (Lisp_Object args)
507 Lisp_Object quoted = XCAR (args);
509 if (!NILP (Fcdr (args)))
510 xsignal2 (Qwrong_number_of_arguments, Qfunction, Flength (args));
512 if (!NILP (Vinternal_interpreter_environment)
513 && CONSP (quoted)
514 && EQ (XCAR (quoted), Qlambda))
515 /* This is a lambda expression within a lexical environment;
516 return an interpreted closure instead of a simple lambda. */
517 return Fcons (Qclosure, Fcons (Vinternal_interpreter_environment,
518 XCDR (quoted)));
519 else
520 /* Simply quote the argument. */
521 return quoted;
525 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
526 doc: /* Return t if the containing function was run directly by user input.
527 This means that the function was called with `call-interactively'
528 \(which includes being called as the binding of a key)
529 and input is currently coming from the keyboard (not a keyboard macro),
530 and Emacs is not running in batch mode (`noninteractive' is nil).
532 The only known proper use of `interactive-p' is in deciding whether to
533 display a helpful message, or how to display it. If you're thinking
534 of using it for any other purpose, it is quite likely that you're
535 making a mistake. Think: what do you want to do when the command is
536 called from a keyboard macro?
538 To test whether your function was called with `call-interactively',
539 either (i) add an extra optional argument and give it an `interactive'
540 spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
541 use `called-interactively-p'. */)
542 (void)
544 return interactive_p (1) ? Qt : Qnil;
548 DEFUN ("called-interactively-p", Fcalled_interactively_p, Scalled_interactively_p, 0, 1, 0,
549 doc: /* Return t if the containing function was called by `call-interactively'.
550 If KIND is `interactive', then only return t if the call was made
551 interactively by the user, i.e. not in `noninteractive' mode nor
552 when `executing-kbd-macro'.
553 If KIND is `any', on the other hand, it will return t for any kind of
554 interactive call, including being called as the binding of a key, or
555 from a keyboard macro, or in `noninteractive' mode.
557 The only known proper use of `interactive' for KIND is in deciding
558 whether to display a helpful message, or how to display it. If you're
559 thinking of using it for any other purpose, it is quite likely that
560 you're making a mistake. Think: what do you want to do when the
561 command is called from a keyboard macro?
563 This function is meant for implementing advice and other
564 function-modifying features. Instead of using this, it is sometimes
565 cleaner to give your function an extra optional argument whose
566 `interactive' spec specifies non-nil unconditionally (\"p\" is a good
567 way to do this), or via (not (or executing-kbd-macro noninteractive)). */)
568 (Lisp_Object kind)
570 return ((INTERACTIVE || !EQ (kind, intern ("interactive")))
571 && interactive_p (1)) ? Qt : Qnil;
575 /* Return 1 if function in which this appears was called using
576 call-interactively.
578 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
579 called is a built-in. */
581 static int
582 interactive_p (int exclude_subrs_p)
584 struct backtrace *btp;
585 Lisp_Object fun;
587 btp = backtrace_list;
589 /* If this isn't a byte-compiled function, there may be a frame at
590 the top for Finteractive_p. If so, skip it. */
591 fun = Findirect_function (*btp->function, Qnil);
592 if (SUBRP (fun) && (XSUBR (fun) == &Sinteractive_p
593 || XSUBR (fun) == &Scalled_interactively_p))
594 btp = btp->next;
596 /* If we're running an Emacs 18-style byte-compiled function, there
597 may be a frame for Fbytecode at the top level. In any version of
598 Emacs there can be Fbytecode frames for subexpressions evaluated
599 inside catch and condition-case. Skip past them.
601 If this isn't a byte-compiled function, then we may now be
602 looking at several frames for special forms. Skip past them. */
603 while (btp
604 && (EQ (*btp->function, Qbytecode)
605 || btp->nargs == UNEVALLED))
606 btp = btp->next;
608 /* `btp' now points at the frame of the innermost function that isn't
609 a special form, ignoring frames for Finteractive_p and/or
610 Fbytecode at the top. If this frame is for a built-in function
611 (such as load or eval-region) return nil. */
612 fun = Findirect_function (*btp->function, Qnil);
613 if (exclude_subrs_p && SUBRP (fun))
614 return 0;
616 /* `btp' points to the frame of a Lisp function that called interactive-p.
617 Return t if that function was called interactively. */
618 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
619 return 1;
620 return 0;
624 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
625 doc: /* Define NAME as a function.
626 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
627 See also the function `interactive'.
628 usage: (defun NAME ARGLIST [DOCSTRING] BODY...) */)
629 (Lisp_Object args)
631 register Lisp_Object fn_name;
632 register Lisp_Object defn;
634 fn_name = Fcar (args);
635 CHECK_SYMBOL (fn_name);
636 defn = Fcons (Qlambda, Fcdr (args));
637 if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization! */
638 defn = Ffunction (Fcons (defn, Qnil));
639 if (!NILP (Vpurify_flag))
640 defn = Fpurecopy (defn);
641 if (CONSP (XSYMBOL (fn_name)->function)
642 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
643 LOADHIST_ATTACH (Fcons (Qt, fn_name));
644 Ffset (fn_name, defn);
645 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
646 return fn_name;
649 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
650 doc: /* Define NAME as a macro.
651 The actual definition looks like
652 (macro lambda ARGLIST [DOCSTRING] [DECL] BODY...).
653 When the macro is called, as in (NAME ARGS...),
654 the function (lambda ARGLIST BODY...) is applied to
655 the list ARGS... as it appears in the expression,
656 and the result should be a form to be evaluated instead of the original.
658 DECL is a declaration, optional, which can specify how to indent
659 calls to this macro, how Edebug should handle it, and which argument
660 should be treated as documentation. It looks like this:
661 (declare SPECS...)
662 The elements can look like this:
663 (indent INDENT)
664 Set NAME's `lisp-indent-function' property to INDENT.
666 (debug DEBUG)
667 Set NAME's `edebug-form-spec' property to DEBUG. (This is
668 equivalent to writing a `def-edebug-spec' for the macro.)
670 (doc-string ELT)
671 Set NAME's `doc-string-elt' property to ELT.
673 usage: (defmacro NAME ARGLIST [DOCSTRING] [DECL] BODY...) */)
674 (Lisp_Object args)
676 register Lisp_Object fn_name;
677 register Lisp_Object defn;
678 Lisp_Object lambda_list, doc, tail;
680 fn_name = Fcar (args);
681 CHECK_SYMBOL (fn_name);
682 lambda_list = Fcar (Fcdr (args));
683 tail = Fcdr (Fcdr (args));
685 doc = Qnil;
686 if (STRINGP (Fcar (tail)))
688 doc = XCAR (tail);
689 tail = XCDR (tail);
692 if (CONSP (Fcar (tail))
693 && EQ (Fcar (Fcar (tail)), Qdeclare))
695 if (!NILP (Vmacro_declaration_function))
697 struct gcpro gcpro1;
698 GCPRO1 (args);
699 call2 (Vmacro_declaration_function, fn_name, Fcar (tail));
700 UNGCPRO;
703 tail = Fcdr (tail);
706 if (NILP (doc))
707 tail = Fcons (lambda_list, tail);
708 else
709 tail = Fcons (lambda_list, Fcons (doc, tail));
711 defn = Fcons (Qlambda, tail);
712 if (!NILP (Vinternal_interpreter_environment)) /* Mere optimization! */
713 defn = Ffunction (Fcons (defn, Qnil));
714 defn = Fcons (Qmacro, defn);
716 if (!NILP (Vpurify_flag))
717 defn = Fpurecopy (defn);
718 if (CONSP (XSYMBOL (fn_name)->function)
719 && EQ (XCAR (XSYMBOL (fn_name)->function), Qautoload))
720 LOADHIST_ATTACH (Fcons (Qt, fn_name));
721 Ffset (fn_name, defn);
722 LOADHIST_ATTACH (Fcons (Qdefun, fn_name));
723 return fn_name;
727 DEFUN ("defvaralias", Fdefvaralias, Sdefvaralias, 2, 3, 0,
728 doc: /* Make NEW-ALIAS a variable alias for symbol BASE-VARIABLE.
729 Aliased variables always have the same value; setting one sets the other.
730 Third arg DOCSTRING, if non-nil, is documentation for NEW-ALIAS. If it is
731 omitted or nil, NEW-ALIAS gets the documentation string of BASE-VARIABLE,
732 or of the variable at the end of the chain of aliases, if BASE-VARIABLE is
733 itself an alias. If NEW-ALIAS is bound, and BASE-VARIABLE is not,
734 then the value of BASE-VARIABLE is set to that of NEW-ALIAS.
735 The return value is BASE-VARIABLE. */)
736 (Lisp_Object new_alias, Lisp_Object base_variable, Lisp_Object docstring)
738 struct Lisp_Symbol *sym;
740 CHECK_SYMBOL (new_alias);
741 CHECK_SYMBOL (base_variable);
743 sym = XSYMBOL (new_alias);
745 if (sym->constant)
746 /* Not sure why, but why not? */
747 error ("Cannot make a constant an alias");
749 switch (sym->redirect)
751 case SYMBOL_FORWARDED:
752 error ("Cannot make an internal variable an alias");
753 case SYMBOL_LOCALIZED:
754 error ("Don't know how to make a localized variable an alias");
757 /* http://lists.gnu.org/archive/html/emacs-devel/2008-04/msg00834.html
758 If n_a is bound, but b_v is not, set the value of b_v to n_a,
759 so that old-code that affects n_a before the aliasing is setup
760 still works. */
761 if (NILP (Fboundp (base_variable)))
762 set_internal (base_variable, find_symbol_value (new_alias), Qnil, 1);
765 struct specbinding *p;
767 for (p = specpdl_ptr - 1; p >= specpdl; p--)
768 if (p->func == NULL
769 && (EQ (new_alias,
770 CONSP (p->symbol) ? XCAR (p->symbol) : p->symbol)))
771 error ("Don't know how to make a let-bound variable an alias");
774 sym->declared_special = 1;
775 sym->redirect = SYMBOL_VARALIAS;
776 SET_SYMBOL_ALIAS (sym, XSYMBOL (base_variable));
777 sym->constant = SYMBOL_CONSTANT_P (base_variable);
778 LOADHIST_ATTACH (new_alias);
779 /* Even if docstring is nil: remove old docstring. */
780 Fput (new_alias, Qvariable_documentation, docstring);
782 return base_variable;
786 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
787 doc: /* Define SYMBOL as a variable, and return SYMBOL.
788 You are not required to define a variable in order to use it,
789 but the definition can supply documentation and an initial value
790 in a way that tags can recognize.
792 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
793 If SYMBOL is buffer-local, its default value is what is set;
794 buffer-local values are not affected.
795 INITVALUE and DOCSTRING are optional.
796 If DOCSTRING starts with *, this variable is identified as a user option.
797 This means that M-x set-variable recognizes it.
798 See also `user-variable-p'.
799 If INITVALUE is missing, SYMBOL's value is not set.
801 If SYMBOL has a local binding, then this form affects the local
802 binding. This is usually not what you want. Thus, if you need to
803 load a file defining variables, with this form or with `defconst' or
804 `defcustom', you should always load that file _outside_ any bindings
805 for these variables. \(`defconst' and `defcustom' behave similarly in
806 this respect.)
807 usage: (defvar SYMBOL &optional INITVALUE DOCSTRING) */)
808 (Lisp_Object args)
810 register Lisp_Object sym, tem, tail;
812 sym = Fcar (args);
813 tail = Fcdr (args);
814 if (!NILP (Fcdr (Fcdr (tail))))
815 error ("Too many arguments");
817 tem = Fdefault_boundp (sym);
818 if (!NILP (tail))
820 /* Do it before evaluating the initial value, for self-references. */
821 XSYMBOL (sym)->declared_special = 1;
823 if (SYMBOL_CONSTANT_P (sym))
825 /* For upward compatibility, allow (defvar :foo (quote :foo)). */
826 Lisp_Object tem1 = Fcar (tail);
827 if (! (CONSP (tem1)
828 && EQ (XCAR (tem1), Qquote)
829 && CONSP (XCDR (tem1))
830 && EQ (XCAR (XCDR (tem1)), sym)))
831 error ("Constant symbol `%s' specified in defvar",
832 SDATA (SYMBOL_NAME (sym)));
835 if (NILP (tem))
836 Fset_default (sym, eval_sub (Fcar (tail)));
837 else
838 { /* Check if there is really a global binding rather than just a let
839 binding that shadows the global unboundness of the var. */
840 volatile struct specbinding *pdl = specpdl_ptr;
841 while (--pdl >= specpdl)
843 if (EQ (pdl->symbol, sym) && !pdl->func
844 && EQ (pdl->old_value, Qunbound))
846 message_with_string ("Warning: defvar ignored because %s is let-bound",
847 SYMBOL_NAME (sym), 1);
848 break;
852 tail = Fcdr (tail);
853 tem = Fcar (tail);
854 if (!NILP (tem))
856 if (!NILP (Vpurify_flag))
857 tem = Fpurecopy (tem);
858 Fput (sym, Qvariable_documentation, tem);
860 LOADHIST_ATTACH (sym);
862 else if (!NILP (Vinternal_interpreter_environment)
863 && !XSYMBOL (sym)->declared_special)
864 /* A simple (defvar foo) with lexical scoping does "nothing" except
865 declare that var to be dynamically scoped *locally* (i.e. within
866 the current file or let-block). */
867 Vinternal_interpreter_environment =
868 Fcons (sym, Vinternal_interpreter_environment);
869 else
871 /* Simple (defvar <var>) should not count as a definition at all.
872 It could get in the way of other definitions, and unloading this
873 package could try to make the variable unbound. */
876 return sym;
879 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
880 doc: /* Define SYMBOL as a constant variable.
881 The intent is that neither programs nor users should ever change this value.
882 Always sets the value of SYMBOL to the result of evalling INITVALUE.
883 If SYMBOL is buffer-local, its default value is what is set;
884 buffer-local values are not affected.
885 DOCSTRING is optional.
887 If SYMBOL has a local binding, then this form sets the local binding's
888 value. However, you should normally not make local bindings for
889 variables defined with this form.
890 usage: (defconst SYMBOL INITVALUE [DOCSTRING]) */)
891 (Lisp_Object args)
893 register Lisp_Object sym, tem;
895 sym = Fcar (args);
896 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
897 error ("Too many arguments");
899 tem = eval_sub (Fcar (Fcdr (args)));
900 if (!NILP (Vpurify_flag))
901 tem = Fpurecopy (tem);
902 Fset_default (sym, tem);
903 XSYMBOL (sym)->declared_special = 1;
904 tem = Fcar (Fcdr (Fcdr (args)));
905 if (!NILP (tem))
907 if (!NILP (Vpurify_flag))
908 tem = Fpurecopy (tem);
909 Fput (sym, Qvariable_documentation, tem);
911 Fput (sym, Qrisky_local_variable, Qt);
912 LOADHIST_ATTACH (sym);
913 return sym;
916 /* Error handler used in Fuser_variable_p. */
917 static Lisp_Object
918 user_variable_p_eh (Lisp_Object ignore)
920 return Qnil;
923 static Lisp_Object
924 lisp_indirect_variable (Lisp_Object sym)
926 struct Lisp_Symbol *s = indirect_variable (XSYMBOL (sym));
927 XSETSYMBOL (sym, s);
928 return sym;
931 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
932 doc: /* Return t if VARIABLE is intended to be set and modified by users.
933 \(The alternative is a variable used internally in a Lisp program.)
934 A variable is a user variable if
935 \(1) the first character of its documentation is `*', or
936 \(2) it is customizable (its property list contains a non-nil value
937 of `standard-value' or `custom-autoload'), or
938 \(3) it is an alias for another user variable.
939 Return nil if VARIABLE is an alias and there is a loop in the
940 chain of symbols. */)
941 (Lisp_Object variable)
943 Lisp_Object documentation;
945 if (!SYMBOLP (variable))
946 return Qnil;
948 /* If indirect and there's an alias loop, don't check anything else. */
949 if (XSYMBOL (variable)->redirect == SYMBOL_VARALIAS
950 && NILP (internal_condition_case_1 (lisp_indirect_variable, variable,
951 Qt, user_variable_p_eh)))
952 return Qnil;
954 while (1)
956 documentation = Fget (variable, Qvariable_documentation);
957 if (INTEGERP (documentation) && XINT (documentation) < 0)
958 return Qt;
959 if (STRINGP (documentation)
960 && ((unsigned char) SREF (documentation, 0) == '*'))
961 return Qt;
962 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
963 if (CONSP (documentation)
964 && STRINGP (XCAR (documentation))
965 && INTEGERP (XCDR (documentation))
966 && XINT (XCDR (documentation)) < 0)
967 return Qt;
968 /* Customizable? See `custom-variable-p'. */
969 if ((!NILP (Fget (variable, intern ("standard-value"))))
970 || (!NILP (Fget (variable, intern ("custom-autoload")))))
971 return Qt;
973 if (!(XSYMBOL (variable)->redirect == SYMBOL_VARALIAS))
974 return Qnil;
976 /* An indirect variable? Let's follow the chain. */
977 XSETSYMBOL (variable, SYMBOL_ALIAS (XSYMBOL (variable)));
981 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
982 doc: /* Bind variables according to VARLIST then eval BODY.
983 The value of the last form in BODY is returned.
984 Each element of VARLIST is a symbol (which is bound to nil)
985 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
986 Each VALUEFORM can refer to the symbols already bound by this VARLIST.
987 usage: (let* VARLIST BODY...) */)
988 (Lisp_Object args)
990 Lisp_Object varlist, var, val, elt, lexenv;
991 int count = SPECPDL_INDEX ();
992 struct gcpro gcpro1, gcpro2, gcpro3;
994 GCPRO3 (args, elt, varlist);
996 lexenv = Vinternal_interpreter_environment;
998 varlist = Fcar (args);
999 while (CONSP (varlist))
1001 QUIT;
1003 elt = XCAR (varlist);
1004 if (SYMBOLP (elt))
1006 var = elt;
1007 val = Qnil;
1009 else if (! NILP (Fcdr (Fcdr (elt))))
1010 signal_error ("`let' bindings can have only one value-form", elt);
1011 else
1013 var = Fcar (elt);
1014 val = eval_sub (Fcar (Fcdr (elt)));
1017 if (!NILP (lexenv) && SYMBOLP (var)
1018 && !XSYMBOL (var)->declared_special
1019 && NILP (Fmemq (var, Vinternal_interpreter_environment)))
1020 /* Lexically bind VAR by adding it to the interpreter's binding
1021 alist. */
1023 Lisp_Object newenv
1024 = Fcons (Fcons (var, val), Vinternal_interpreter_environment);
1025 if (EQ (Vinternal_interpreter_environment, lexenv))
1026 /* Save the old lexical environment on the specpdl stack,
1027 but only for the first lexical binding, since we'll never
1028 need to revert to one of the intermediate ones. */
1029 specbind (Qinternal_interpreter_environment, newenv);
1030 else
1031 Vinternal_interpreter_environment = newenv;
1033 else
1034 specbind (var, val);
1036 varlist = XCDR (varlist);
1038 UNGCPRO;
1039 val = Fprogn (Fcdr (args));
1040 return unbind_to (count, val);
1043 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
1044 doc: /* Bind variables according to VARLIST then eval BODY.
1045 The value of the last form in BODY is returned.
1046 Each element of VARLIST is a symbol (which is bound to nil)
1047 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
1048 All the VALUEFORMs are evalled before any symbols are bound.
1049 usage: (let VARLIST BODY...) */)
1050 (Lisp_Object args)
1052 Lisp_Object *temps, tem, lexenv;
1053 register Lisp_Object elt, varlist;
1054 int count = SPECPDL_INDEX ();
1055 register size_t argnum;
1056 struct gcpro gcpro1, gcpro2;
1057 USE_SAFE_ALLOCA;
1059 varlist = Fcar (args);
1061 /* Make space to hold the values to give the bound variables. */
1062 elt = Flength (varlist);
1063 SAFE_ALLOCA_LISP (temps, XFASTINT (elt));
1065 /* Compute the values and store them in `temps'. */
1067 GCPRO2 (args, *temps);
1068 gcpro2.nvars = 0;
1070 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1072 QUIT;
1073 elt = XCAR (varlist);
1074 if (SYMBOLP (elt))
1075 temps [argnum++] = Qnil;
1076 else if (! NILP (Fcdr (Fcdr (elt))))
1077 signal_error ("`let' bindings can have only one value-form", elt);
1078 else
1079 temps [argnum++] = eval_sub (Fcar (Fcdr (elt)));
1080 gcpro2.nvars = argnum;
1082 UNGCPRO;
1084 lexenv = Vinternal_interpreter_environment;
1086 varlist = Fcar (args);
1087 for (argnum = 0; CONSP (varlist); varlist = XCDR (varlist))
1089 Lisp_Object var;
1091 elt = XCAR (varlist);
1092 var = SYMBOLP (elt) ? elt : Fcar (elt);
1093 tem = temps[argnum++];
1095 if (!NILP (lexenv) && SYMBOLP (var)
1096 && !XSYMBOL (var)->declared_special
1097 && NILP (Fmemq (var, Vinternal_interpreter_environment)))
1098 /* Lexically bind VAR by adding it to the lexenv alist. */
1099 lexenv = Fcons (Fcons (var, tem), lexenv);
1100 else
1101 /* Dynamically bind VAR. */
1102 specbind (var, tem);
1105 if (!EQ (lexenv, Vinternal_interpreter_environment))
1106 /* Instantiate a new lexical environment. */
1107 specbind (Qinternal_interpreter_environment, lexenv);
1109 elt = Fprogn (Fcdr (args));
1110 SAFE_FREE ();
1111 return unbind_to (count, elt);
1114 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
1115 doc: /* If TEST yields non-nil, eval BODY... and repeat.
1116 The order of execution is thus TEST, BODY, TEST, BODY and so on
1117 until TEST returns nil.
1118 usage: (while TEST BODY...) */)
1119 (Lisp_Object args)
1121 Lisp_Object test, body;
1122 struct gcpro gcpro1, gcpro2;
1124 GCPRO2 (test, body);
1126 test = Fcar (args);
1127 body = Fcdr (args);
1128 while (!NILP (eval_sub (test)))
1130 QUIT;
1131 Fprogn (body);
1134 UNGCPRO;
1135 return Qnil;
1138 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
1139 doc: /* Return result of expanding macros at top level of FORM.
1140 If FORM is not a macro call, it is returned unchanged.
1141 Otherwise, the macro is expanded and the expansion is considered
1142 in place of FORM. When a non-macro-call results, it is returned.
1144 The second optional arg ENVIRONMENT specifies an environment of macro
1145 definitions to shadow the loaded ones for use in file byte-compilation. */)
1146 (Lisp_Object form, Lisp_Object environment)
1148 /* With cleanups from Hallvard Furuseth. */
1149 register Lisp_Object expander, sym, def, tem;
1151 while (1)
1153 /* Come back here each time we expand a macro call,
1154 in case it expands into another macro call. */
1155 if (!CONSP (form))
1156 break;
1157 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
1158 def = sym = XCAR (form);
1159 tem = Qnil;
1160 /* Trace symbols aliases to other symbols
1161 until we get a symbol that is not an alias. */
1162 while (SYMBOLP (def))
1164 QUIT;
1165 sym = def;
1166 tem = Fassq (sym, environment);
1167 if (NILP (tem))
1169 def = XSYMBOL (sym)->function;
1170 if (!EQ (def, Qunbound))
1171 continue;
1173 break;
1175 /* Right now TEM is the result from SYM in ENVIRONMENT,
1176 and if TEM is nil then DEF is SYM's function definition. */
1177 if (NILP (tem))
1179 /* SYM is not mentioned in ENVIRONMENT.
1180 Look at its function definition. */
1181 if (EQ (def, Qunbound) || !CONSP (def))
1182 /* Not defined or definition not suitable. */
1183 break;
1184 if (EQ (XCAR (def), Qautoload))
1186 /* Autoloading function: will it be a macro when loaded? */
1187 tem = Fnth (make_number (4), def);
1188 if (EQ (tem, Qt) || EQ (tem, Qmacro))
1189 /* Yes, load it and try again. */
1191 struct gcpro gcpro1;
1192 GCPRO1 (form);
1193 do_autoload (def, sym);
1194 UNGCPRO;
1195 continue;
1197 else
1198 break;
1200 else if (!EQ (XCAR (def), Qmacro))
1201 break;
1202 else expander = XCDR (def);
1204 else
1206 expander = XCDR (tem);
1207 if (NILP (expander))
1208 break;
1210 form = apply1 (expander, XCDR (form));
1212 return form;
1215 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
1216 doc: /* Eval BODY allowing nonlocal exits using `throw'.
1217 TAG is evalled to get the tag to use; it must not be nil.
1219 Then the BODY is executed.
1220 Within BODY, a call to `throw' with the same TAG exits BODY and this `catch'.
1221 If no throw happens, `catch' returns the value of the last BODY form.
1222 If a throw happens, it specifies the value to return from `catch'.
1223 usage: (catch TAG BODY...) */)
1224 (Lisp_Object args)
1226 register Lisp_Object tag;
1227 struct gcpro gcpro1;
1229 GCPRO1 (args);
1230 tag = eval_sub (Fcar (args));
1231 UNGCPRO;
1232 return internal_catch (tag, Fprogn, Fcdr (args));
1235 /* Set up a catch, then call C function FUNC on argument ARG.
1236 FUNC should return a Lisp_Object.
1237 This is how catches are done from within C code. */
1239 Lisp_Object
1240 internal_catch (Lisp_Object tag, Lisp_Object (*func) (Lisp_Object), Lisp_Object arg)
1242 /* This structure is made part of the chain `catchlist'. */
1243 struct catchtag c;
1245 /* Fill in the components of c, and put it on the list. */
1246 c.next = catchlist;
1247 c.tag = tag;
1248 c.val = Qnil;
1249 c.backlist = backtrace_list;
1250 c.handlerlist = handlerlist;
1251 c.lisp_eval_depth = lisp_eval_depth;
1252 c.pdlcount = SPECPDL_INDEX ();
1253 c.poll_suppress_count = poll_suppress_count;
1254 c.interrupt_input_blocked = interrupt_input_blocked;
1255 c.gcpro = gcprolist;
1256 c.byte_stack = byte_stack_list;
1257 catchlist = &c;
1259 /* Call FUNC. */
1260 if (! _setjmp (c.jmp))
1261 c.val = (*func) (arg);
1263 /* Throw works by a longjmp that comes right here. */
1264 catchlist = c.next;
1265 return c.val;
1268 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1269 jump to that CATCH, returning VALUE as the value of that catch.
1271 This is the guts Fthrow and Fsignal; they differ only in the way
1272 they choose the catch tag to throw to. A catch tag for a
1273 condition-case form has a TAG of Qnil.
1275 Before each catch is discarded, unbind all special bindings and
1276 execute all unwind-protect clauses made above that catch. Unwind
1277 the handler stack as we go, so that the proper handlers are in
1278 effect for each unwind-protect clause we run. At the end, restore
1279 some static info saved in CATCH, and longjmp to the location
1280 specified in the
1282 This is used for correct unwinding in Fthrow and Fsignal. */
1284 static void
1285 unwind_to_catch (struct catchtag *catch, Lisp_Object value)
1287 register int last_time;
1289 /* Save the value in the tag. */
1290 catch->val = value;
1292 /* Restore certain special C variables. */
1293 set_poll_suppress_count (catch->poll_suppress_count);
1294 UNBLOCK_INPUT_TO (catch->interrupt_input_blocked);
1295 handling_signal = 0;
1296 immediate_quit = 0;
1300 last_time = catchlist == catch;
1302 /* Unwind the specpdl stack, and then restore the proper set of
1303 handlers. */
1304 unbind_to (catchlist->pdlcount, Qnil);
1305 handlerlist = catchlist->handlerlist;
1306 catchlist = catchlist->next;
1308 while (! last_time);
1310 #if HAVE_X_WINDOWS
1311 /* If x_catch_errors was done, turn it off now.
1312 (First we give unbind_to a chance to do that.) */
1313 #if 0 /* This would disable x_catch_errors after x_connection_closed.
1314 The catch must remain in effect during that delicate
1315 state. --lorentey */
1316 x_fully_uncatch_errors ();
1317 #endif
1318 #endif
1320 byte_stack_list = catch->byte_stack;
1321 gcprolist = catch->gcpro;
1322 #ifdef DEBUG_GCPRO
1323 gcpro_level = gcprolist ? gcprolist->level + 1 : 0;
1324 #endif
1325 backtrace_list = catch->backlist;
1326 lisp_eval_depth = catch->lisp_eval_depth;
1328 _longjmp (catch->jmp, 1);
1331 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1332 doc: /* Throw to the catch for TAG and return VALUE from it.
1333 Both TAG and VALUE are evalled. */)
1334 (register Lisp_Object tag, Lisp_Object value)
1336 register struct catchtag *c;
1338 if (!NILP (tag))
1339 for (c = catchlist; c; c = c->next)
1341 if (EQ (c->tag, tag))
1342 unwind_to_catch (c, value);
1344 xsignal2 (Qno_catch, tag, value);
1348 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1349 doc: /* Do BODYFORM, protecting with UNWINDFORMS.
1350 If BODYFORM completes normally, its value is returned
1351 after executing the UNWINDFORMS.
1352 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
1353 usage: (unwind-protect BODYFORM UNWINDFORMS...) */)
1354 (Lisp_Object args)
1356 Lisp_Object val;
1357 int count = SPECPDL_INDEX ();
1359 record_unwind_protect (Fprogn, Fcdr (args));
1360 val = eval_sub (Fcar (args));
1361 return unbind_to (count, val);
1364 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1365 doc: /* Regain control when an error is signaled.
1366 Executes BODYFORM and returns its value if no error happens.
1367 Each element of HANDLERS looks like (CONDITION-NAME BODY...)
1368 where the BODY is made of Lisp expressions.
1370 A handler is applicable to an error
1371 if CONDITION-NAME is one of the error's condition names.
1372 If an error happens, the first applicable handler is run.
1374 The car of a handler may be a list of condition names
1375 instead of a single condition name. Then it handles all of them.
1377 When a handler handles an error, control returns to the `condition-case'
1378 and it executes the handler's BODY...
1379 with VAR bound to (ERROR-SYMBOL . SIGNAL-DATA) from the error.
1380 \(If VAR is nil, the handler can't access that information.)
1381 Then the value of the last BODY form is returned from the `condition-case'
1382 expression.
1384 See also the function `signal' for more info.
1385 usage: (condition-case VAR BODYFORM &rest HANDLERS) */)
1386 (Lisp_Object args)
1388 register Lisp_Object bodyform, handlers;
1389 volatile Lisp_Object var;
1391 var = Fcar (args);
1392 bodyform = Fcar (Fcdr (args));
1393 handlers = Fcdr (Fcdr (args));
1395 return internal_lisp_condition_case (var, bodyform, handlers);
1398 /* Like Fcondition_case, but the args are separate
1399 rather than passed in a list. Used by Fbyte_code. */
1401 Lisp_Object
1402 internal_lisp_condition_case (volatile Lisp_Object var, Lisp_Object bodyform,
1403 Lisp_Object handlers)
1405 Lisp_Object val;
1406 struct catchtag c;
1407 struct handler h;
1409 CHECK_SYMBOL (var);
1411 for (val = handlers; CONSP (val); val = XCDR (val))
1413 Lisp_Object tem;
1414 tem = XCAR (val);
1415 if (! (NILP (tem)
1416 || (CONSP (tem)
1417 && (SYMBOLP (XCAR (tem))
1418 || CONSP (XCAR (tem))))))
1419 error ("Invalid condition handler: %s",
1420 SDATA (Fprin1_to_string (tem, Qt)));
1423 c.tag = Qnil;
1424 c.val = Qnil;
1425 c.backlist = backtrace_list;
1426 c.handlerlist = handlerlist;
1427 c.lisp_eval_depth = lisp_eval_depth;
1428 c.pdlcount = SPECPDL_INDEX ();
1429 c.poll_suppress_count = poll_suppress_count;
1430 c.interrupt_input_blocked = interrupt_input_blocked;
1431 c.gcpro = gcprolist;
1432 c.byte_stack = byte_stack_list;
1433 if (_setjmp (c.jmp))
1435 if (!NILP (h.var))
1436 specbind (h.var, c.val);
1437 val = Fprogn (Fcdr (h.chosen_clause));
1439 /* Note that this just undoes the binding of h.var; whoever
1440 longjumped to us unwound the stack to c.pdlcount before
1441 throwing. */
1442 unbind_to (c.pdlcount, Qnil);
1443 return val;
1445 c.next = catchlist;
1446 catchlist = &c;
1448 h.var = var;
1449 h.handler = handlers;
1450 h.next = handlerlist;
1451 h.tag = &c;
1452 handlerlist = &h;
1454 val = eval_sub (bodyform);
1455 catchlist = c.next;
1456 handlerlist = h.next;
1457 return val;
1460 /* Call the function BFUN with no arguments, catching errors within it
1461 according to HANDLERS. If there is an error, call HFUN with
1462 one argument which is the data that describes the error:
1463 (SIGNALNAME . DATA)
1465 HANDLERS can be a list of conditions to catch.
1466 If HANDLERS is Qt, catch all errors.
1467 If HANDLERS is Qerror, catch all errors
1468 but allow the debugger to run if that is enabled. */
1470 Lisp_Object
1471 internal_condition_case (Lisp_Object (*bfun) (void), Lisp_Object handlers,
1472 Lisp_Object (*hfun) (Lisp_Object))
1474 Lisp_Object val;
1475 struct catchtag c;
1476 struct handler h;
1478 /* Since Fsignal will close off all calls to x_catch_errors,
1479 we will get the wrong results if some are not closed now. */
1480 #if HAVE_X_WINDOWS
1481 if (x_catching_errors ())
1482 abort ();
1483 #endif
1485 c.tag = Qnil;
1486 c.val = Qnil;
1487 c.backlist = backtrace_list;
1488 c.handlerlist = handlerlist;
1489 c.lisp_eval_depth = lisp_eval_depth;
1490 c.pdlcount = SPECPDL_INDEX ();
1491 c.poll_suppress_count = poll_suppress_count;
1492 c.interrupt_input_blocked = interrupt_input_blocked;
1493 c.gcpro = gcprolist;
1494 c.byte_stack = byte_stack_list;
1495 if (_setjmp (c.jmp))
1497 return (*hfun) (c.val);
1499 c.next = catchlist;
1500 catchlist = &c;
1501 h.handler = handlers;
1502 h.var = Qnil;
1503 h.next = handlerlist;
1504 h.tag = &c;
1505 handlerlist = &h;
1507 val = (*bfun) ();
1508 catchlist = c.next;
1509 handlerlist = h.next;
1510 return val;
1513 /* Like internal_condition_case but call BFUN with ARG as its argument. */
1515 Lisp_Object
1516 internal_condition_case_1 (Lisp_Object (*bfun) (Lisp_Object), Lisp_Object arg,
1517 Lisp_Object handlers, Lisp_Object (*hfun) (Lisp_Object))
1519 Lisp_Object val;
1520 struct catchtag c;
1521 struct handler h;
1523 /* Since Fsignal will close off all calls to x_catch_errors,
1524 we will get the wrong results if some are not closed now. */
1525 #if HAVE_X_WINDOWS
1526 if (x_catching_errors ())
1527 abort ();
1528 #endif
1530 c.tag = Qnil;
1531 c.val = Qnil;
1532 c.backlist = backtrace_list;
1533 c.handlerlist = handlerlist;
1534 c.lisp_eval_depth = lisp_eval_depth;
1535 c.pdlcount = SPECPDL_INDEX ();
1536 c.poll_suppress_count = poll_suppress_count;
1537 c.interrupt_input_blocked = interrupt_input_blocked;
1538 c.gcpro = gcprolist;
1539 c.byte_stack = byte_stack_list;
1540 if (_setjmp (c.jmp))
1542 return (*hfun) (c.val);
1544 c.next = catchlist;
1545 catchlist = &c;
1546 h.handler = handlers;
1547 h.var = Qnil;
1548 h.next = handlerlist;
1549 h.tag = &c;
1550 handlerlist = &h;
1552 val = (*bfun) (arg);
1553 catchlist = c.next;
1554 handlerlist = h.next;
1555 return val;
1558 /* Like internal_condition_case_1 but call BFUN with ARG1 and ARG2 as
1559 its arguments. */
1561 Lisp_Object
1562 internal_condition_case_2 (Lisp_Object (*bfun) (Lisp_Object, Lisp_Object),
1563 Lisp_Object arg1,
1564 Lisp_Object arg2,
1565 Lisp_Object handlers,
1566 Lisp_Object (*hfun) (Lisp_Object))
1568 Lisp_Object val;
1569 struct catchtag c;
1570 struct handler h;
1572 /* Since Fsignal will close off all calls to x_catch_errors,
1573 we will get the wrong results if some are not closed now. */
1574 #if HAVE_X_WINDOWS
1575 if (x_catching_errors ())
1576 abort ();
1577 #endif
1579 c.tag = Qnil;
1580 c.val = Qnil;
1581 c.backlist = backtrace_list;
1582 c.handlerlist = handlerlist;
1583 c.lisp_eval_depth = lisp_eval_depth;
1584 c.pdlcount = SPECPDL_INDEX ();
1585 c.poll_suppress_count = poll_suppress_count;
1586 c.interrupt_input_blocked = interrupt_input_blocked;
1587 c.gcpro = gcprolist;
1588 c.byte_stack = byte_stack_list;
1589 if (_setjmp (c.jmp))
1591 return (*hfun) (c.val);
1593 c.next = catchlist;
1594 catchlist = &c;
1595 h.handler = handlers;
1596 h.var = Qnil;
1597 h.next = handlerlist;
1598 h.tag = &c;
1599 handlerlist = &h;
1601 val = (*bfun) (arg1, arg2);
1602 catchlist = c.next;
1603 handlerlist = h.next;
1604 return val;
1607 /* Like internal_condition_case but call BFUN with NARGS as first,
1608 and ARGS as second argument. */
1610 Lisp_Object
1611 internal_condition_case_n (Lisp_Object (*bfun) (size_t, Lisp_Object *),
1612 size_t nargs,
1613 Lisp_Object *args,
1614 Lisp_Object handlers,
1615 Lisp_Object (*hfun) (Lisp_Object))
1617 Lisp_Object val;
1618 struct catchtag c;
1619 struct handler h;
1621 /* Since Fsignal will close off all calls to x_catch_errors,
1622 we will get the wrong results if some are not closed now. */
1623 #if HAVE_X_WINDOWS
1624 if (x_catching_errors ())
1625 abort ();
1626 #endif
1628 c.tag = Qnil;
1629 c.val = Qnil;
1630 c.backlist = backtrace_list;
1631 c.handlerlist = handlerlist;
1632 c.lisp_eval_depth = lisp_eval_depth;
1633 c.pdlcount = SPECPDL_INDEX ();
1634 c.poll_suppress_count = poll_suppress_count;
1635 c.interrupt_input_blocked = interrupt_input_blocked;
1636 c.gcpro = gcprolist;
1637 c.byte_stack = byte_stack_list;
1638 if (_setjmp (c.jmp))
1640 return (*hfun) (c.val);
1642 c.next = catchlist;
1643 catchlist = &c;
1644 h.handler = handlers;
1645 h.var = Qnil;
1646 h.next = handlerlist;
1647 h.tag = &c;
1648 handlerlist = &h;
1650 val = (*bfun) (nargs, args);
1651 catchlist = c.next;
1652 handlerlist = h.next;
1653 return val;
1657 static Lisp_Object find_handler_clause (Lisp_Object, Lisp_Object,
1658 Lisp_Object, Lisp_Object);
1659 static int maybe_call_debugger (Lisp_Object conditions, Lisp_Object sig,
1660 Lisp_Object data);
1662 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1663 doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
1664 This function does not return.
1666 An error symbol is a symbol with an `error-conditions' property
1667 that is a list of condition names.
1668 A handler for any of those names will get to handle this signal.
1669 The symbol `error' should normally be one of them.
1671 DATA should be a list. Its elements are printed as part of the error message.
1672 See Info anchor `(elisp)Definition of signal' for some details on how this
1673 error message is constructed.
1674 If the signal is handled, DATA is made available to the handler.
1675 See also the function `condition-case'. */)
1676 (Lisp_Object error_symbol, Lisp_Object data)
1678 /* When memory is full, ERROR-SYMBOL is nil,
1679 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA).
1680 That is a special case--don't do this in other situations. */
1681 Lisp_Object conditions;
1682 Lisp_Object string;
1683 Lisp_Object real_error_symbol
1684 = (NILP (error_symbol) ? Fcar (data) : error_symbol);
1685 register Lisp_Object clause = Qnil;
1686 struct handler *h;
1687 struct backtrace *bp;
1689 immediate_quit = handling_signal = 0;
1690 abort_on_gc = 0;
1691 if (gc_in_progress || waiting_for_input)
1692 abort ();
1694 #if 0 /* rms: I don't know why this was here,
1695 but it is surely wrong for an error that is handled. */
1696 #ifdef HAVE_WINDOW_SYSTEM
1697 if (display_hourglass_p)
1698 cancel_hourglass ();
1699 #endif
1700 #endif
1702 /* This hook is used by edebug. */
1703 if (! NILP (Vsignal_hook_function)
1704 && ! NILP (error_symbol))
1706 /* Edebug takes care of restoring these variables when it exits. */
1707 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1708 max_lisp_eval_depth = lisp_eval_depth + 20;
1710 if (SPECPDL_INDEX () + 40 > max_specpdl_size)
1711 max_specpdl_size = SPECPDL_INDEX () + 40;
1713 call2 (Vsignal_hook_function, error_symbol, data);
1716 conditions = Fget (real_error_symbol, Qerror_conditions);
1718 /* Remember from where signal was called. Skip over the frame for
1719 `signal' itself. If a frame for `error' follows, skip that,
1720 too. Don't do this when ERROR_SYMBOL is nil, because that
1721 is a memory-full error. */
1722 Vsignaling_function = Qnil;
1723 if (backtrace_list && !NILP (error_symbol))
1725 bp = backtrace_list->next;
1726 if (bp && bp->function && EQ (*bp->function, Qerror))
1727 bp = bp->next;
1728 if (bp && bp->function)
1729 Vsignaling_function = *bp->function;
1732 for (h = handlerlist; h; h = h->next)
1734 clause = find_handler_clause (h->handler, conditions,
1735 error_symbol, data);
1736 if (!NILP (clause))
1737 break;
1740 if (/* Don't run the debugger for a memory-full error.
1741 (There is no room in memory to do that!) */
1742 !NILP (error_symbol)
1743 && (!NILP (Vdebug_on_signal)
1744 /* If no handler is present now, try to run the debugger. */
1745 || NILP (clause)
1746 /* Special handler that means "print a message and run debugger
1747 if requested". */
1748 || EQ (h->handler, Qerror)))
1750 int debugger_called
1751 = maybe_call_debugger (conditions, error_symbol, data);
1752 /* We can't return values to code which signaled an error, but we
1753 can continue code which has signaled a quit. */
1754 if (debugger_called && EQ (real_error_symbol, Qquit))
1755 return Qnil;
1758 if (!NILP (clause))
1760 Lisp_Object unwind_data
1761 = (NILP (error_symbol) ? data : Fcons (error_symbol, data));
1763 h->chosen_clause = clause;
1764 unwind_to_catch (h->tag, unwind_data);
1766 else
1768 if (catchlist != 0)
1769 Fthrow (Qtop_level, Qt);
1772 if (! NILP (error_symbol))
1773 data = Fcons (error_symbol, data);
1775 string = Ferror_message_string (data);
1776 fatal ("%s", SDATA (string));
1779 /* Internal version of Fsignal that never returns.
1780 Used for anything but Qquit (which can return from Fsignal). */
1782 void
1783 xsignal (Lisp_Object error_symbol, Lisp_Object data)
1785 Fsignal (error_symbol, data);
1786 abort ();
1789 /* Like xsignal, but takes 0, 1, 2, or 3 args instead of a list. */
1791 void
1792 xsignal0 (Lisp_Object error_symbol)
1794 xsignal (error_symbol, Qnil);
1797 void
1798 xsignal1 (Lisp_Object error_symbol, Lisp_Object arg)
1800 xsignal (error_symbol, list1 (arg));
1803 void
1804 xsignal2 (Lisp_Object error_symbol, Lisp_Object arg1, Lisp_Object arg2)
1806 xsignal (error_symbol, list2 (arg1, arg2));
1809 void
1810 xsignal3 (Lisp_Object error_symbol, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
1812 xsignal (error_symbol, list3 (arg1, arg2, arg3));
1815 /* Signal `error' with message S, and additional arg ARG.
1816 If ARG is not a genuine list, make it a one-element list. */
1818 void
1819 signal_error (const char *s, Lisp_Object arg)
1821 Lisp_Object tortoise, hare;
1823 hare = tortoise = arg;
1824 while (CONSP (hare))
1826 hare = XCDR (hare);
1827 if (!CONSP (hare))
1828 break;
1830 hare = XCDR (hare);
1831 tortoise = XCDR (tortoise);
1833 if (EQ (hare, tortoise))
1834 break;
1837 if (!NILP (hare))
1838 arg = Fcons (arg, Qnil); /* Make it a list. */
1840 xsignal (Qerror, Fcons (build_string (s), arg));
1844 /* Return nonzero if LIST is a non-nil atom or
1845 a list containing one of CONDITIONS. */
1847 static int
1848 wants_debugger (Lisp_Object list, Lisp_Object conditions)
1850 if (NILP (list))
1851 return 0;
1852 if (! CONSP (list))
1853 return 1;
1855 while (CONSP (conditions))
1857 Lisp_Object this, tail;
1858 this = XCAR (conditions);
1859 for (tail = list; CONSP (tail); tail = XCDR (tail))
1860 if (EQ (XCAR (tail), this))
1861 return 1;
1862 conditions = XCDR (conditions);
1864 return 0;
1867 /* Return 1 if an error with condition-symbols CONDITIONS,
1868 and described by SIGNAL-DATA, should skip the debugger
1869 according to debugger-ignored-errors. */
1871 static int
1872 skip_debugger (Lisp_Object conditions, Lisp_Object data)
1874 Lisp_Object tail;
1875 int first_string = 1;
1876 Lisp_Object error_message;
1878 error_message = Qnil;
1879 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1881 if (STRINGP (XCAR (tail)))
1883 if (first_string)
1885 error_message = Ferror_message_string (data);
1886 first_string = 0;
1889 if (fast_string_match (XCAR (tail), error_message) >= 0)
1890 return 1;
1892 else
1894 Lisp_Object contail;
1896 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1897 if (EQ (XCAR (tail), XCAR (contail)))
1898 return 1;
1902 return 0;
1905 /* Call the debugger if calling it is currently enabled for CONDITIONS.
1906 SIG and DATA describe the signal, as in find_handler_clause. */
1908 static int
1909 maybe_call_debugger (Lisp_Object conditions, Lisp_Object sig, Lisp_Object data)
1911 Lisp_Object combined_data;
1913 combined_data = Fcons (sig, data);
1915 if (
1916 /* Don't try to run the debugger with interrupts blocked.
1917 The editing loop would return anyway. */
1918 ! INPUT_BLOCKED_P
1919 /* Does user want to enter debugger for this kind of error? */
1920 && (EQ (sig, Qquit)
1921 ? debug_on_quit
1922 : wants_debugger (Vdebug_on_error, conditions))
1923 && ! skip_debugger (conditions, combined_data)
1924 /* RMS: What's this for? */
1925 && when_entered_debugger < num_nonmacro_input_events)
1927 call_debugger (Fcons (Qerror, Fcons (combined_data, Qnil)));
1928 return 1;
1931 return 0;
1934 /* Value of Qlambda means we have called debugger and user has continued.
1935 There are two ways to pass SIG and DATA:
1936 = SIG is the error symbol, and DATA is the rest of the data.
1937 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1938 This is for memory-full errors only.
1940 We need to increase max_specpdl_size temporarily around
1941 anything we do that can push on the specpdl, so as not to get
1942 a second error here in case we're handling specpdl overflow. */
1944 static Lisp_Object
1945 find_handler_clause (Lisp_Object handlers, Lisp_Object conditions,
1946 Lisp_Object sig, Lisp_Object data)
1948 register Lisp_Object h;
1950 /* t is used by handlers for all conditions, set up by C code. */
1951 if (EQ (handlers, Qt))
1952 return Qt;
1954 /* error is used similarly, but means print an error message
1955 and run the debugger if that is enabled. */
1956 if (EQ (handlers, Qerror))
1957 return Qt;
1959 for (h = handlers; CONSP (h); h = XCDR (h))
1961 Lisp_Object handler = XCAR (h);
1962 Lisp_Object condit, tem;
1964 if (!CONSP (handler))
1965 continue;
1966 condit = XCAR (handler);
1967 /* Handle a single condition name in handler HANDLER. */
1968 if (SYMBOLP (condit))
1970 tem = Fmemq (Fcar (handler), conditions);
1971 if (!NILP (tem))
1972 return handler;
1974 /* Handle a list of condition names in handler HANDLER. */
1975 else if (CONSP (condit))
1977 Lisp_Object tail;
1978 for (tail = condit; CONSP (tail); tail = XCDR (tail))
1980 tem = Fmemq (XCAR (tail), conditions);
1981 if (!NILP (tem))
1982 return handler;
1987 return Qnil;
1991 /* Dump an error message; called like vprintf. */
1992 void
1993 verror (const char *m, va_list ap)
1995 char buf[4000];
1996 size_t size = sizeof buf;
1997 size_t size_max = min (MOST_POSITIVE_FIXNUM, SIZE_MAX);
1998 size_t mlen = strlen (m);
1999 char *buffer = buf;
2000 size_t used;
2001 Lisp_Object string;
2003 while (1)
2005 used = doprnt (buffer, size, m, m + mlen, ap);
2007 /* Note: the -1 below is because `doprnt' returns the number of bytes
2008 excluding the terminating null byte, and it always terminates with a
2009 null byte, even when producing a truncated message. */
2010 if (used < size - 1)
2011 break;
2012 if (size <= size_max / 2)
2013 size *= 2;
2014 else if (size < size_max)
2015 size = size_max;
2016 else
2017 break; /* and leave the message truncated */
2019 if (buffer != buf)
2020 xfree (buffer);
2021 buffer = (char *) xmalloc (size);
2024 string = make_string (buffer, used);
2025 if (buffer != buf)
2026 xfree (buffer);
2028 xsignal1 (Qerror, string);
2032 /* Dump an error message; called like printf. */
2034 /* VARARGS 1 */
2035 void
2036 error (const char *m, ...)
2038 va_list ap;
2039 va_start (ap, m);
2040 verror (m, ap);
2041 va_end (ap);
2044 DEFUN ("commandp", Fcommandp, Scommandp, 1, 2, 0,
2045 doc: /* Non-nil if FUNCTION makes provisions for interactive calling.
2046 This means it contains a description for how to read arguments to give it.
2047 The value is nil for an invalid function or a symbol with no function
2048 definition.
2050 Interactively callable functions include strings and vectors (treated
2051 as keyboard macros), lambda-expressions that contain a top-level call
2052 to `interactive', autoload definitions made by `autoload' with non-nil
2053 fourth argument, and some of the built-in functions of Lisp.
2055 Also, a symbol satisfies `commandp' if its function definition does so.
2057 If the optional argument FOR-CALL-INTERACTIVELY is non-nil,
2058 then strings and vectors are not accepted. */)
2059 (Lisp_Object function, Lisp_Object for_call_interactively)
2061 register Lisp_Object fun;
2062 register Lisp_Object funcar;
2063 Lisp_Object if_prop = Qnil;
2065 fun = function;
2067 fun = indirect_function (fun); /* Check cycles. */
2068 if (NILP (fun) || EQ (fun, Qunbound))
2069 return Qnil;
2071 /* Check an `interactive-form' property if present, analogous to the
2072 function-documentation property. */
2073 fun = function;
2074 while (SYMBOLP (fun))
2076 Lisp_Object tmp = Fget (fun, Qinteractive_form);
2077 if (!NILP (tmp))
2078 if_prop = Qt;
2079 fun = Fsymbol_function (fun);
2082 /* Emacs primitives are interactive if their DEFUN specifies an
2083 interactive spec. */
2084 if (SUBRP (fun))
2085 return XSUBR (fun)->intspec ? Qt : if_prop;
2087 /* Bytecode objects are interactive if they are long enough to
2088 have an element whose index is COMPILED_INTERACTIVE, which is
2089 where the interactive spec is stored. */
2090 else if (COMPILEDP (fun))
2091 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
2092 ? Qt : if_prop);
2094 /* Strings and vectors are keyboard macros. */
2095 if (STRINGP (fun) || VECTORP (fun))
2096 return (NILP (for_call_interactively) ? Qt : Qnil);
2098 /* Lists may represent commands. */
2099 if (!CONSP (fun))
2100 return Qnil;
2101 funcar = XCAR (fun);
2102 if (EQ (funcar, Qclosure))
2103 return (!NILP (Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun)))))
2104 ? Qt : if_prop);
2105 else if (EQ (funcar, Qlambda))
2106 return !NILP (Fassq (Qinteractive, Fcdr (XCDR (fun)))) ? Qt : if_prop;
2107 else if (EQ (funcar, Qautoload))
2108 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun))))) ? Qt : if_prop;
2109 else
2110 return Qnil;
2113 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
2114 doc: /* Define FUNCTION to autoload from FILE.
2115 FUNCTION is a symbol; FILE is a file name string to pass to `load'.
2116 Third arg DOCSTRING is documentation for the function.
2117 Fourth arg INTERACTIVE if non-nil says function can be called interactively.
2118 Fifth arg TYPE indicates the type of the object:
2119 nil or omitted says FUNCTION is a function,
2120 `keymap' says FUNCTION is really a keymap, and
2121 `macro' or t says FUNCTION is really a macro.
2122 Third through fifth args give info about the real definition.
2123 They default to nil.
2124 If FUNCTION is already defined other than as an autoload,
2125 this does nothing and returns nil. */)
2126 (Lisp_Object function, Lisp_Object file, Lisp_Object docstring, Lisp_Object interactive, Lisp_Object type)
2128 CHECK_SYMBOL (function);
2129 CHECK_STRING (file);
2131 /* If function is defined and not as an autoload, don't override. */
2132 if (!EQ (XSYMBOL (function)->function, Qunbound)
2133 && !(CONSP (XSYMBOL (function)->function)
2134 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
2135 return Qnil;
2137 if (NILP (Vpurify_flag))
2138 /* Only add entries after dumping, because the ones before are
2139 not useful and else we get loads of them from the loaddefs.el. */
2140 LOADHIST_ATTACH (Fcons (Qautoload, function));
2141 else
2142 /* We don't want the docstring in purespace (instead,
2143 Snarf-documentation should (hopefully) overwrite it).
2144 We used to use 0 here, but that leads to accidental sharing in
2145 purecopy's hash-consing, so we use a (hopefully) unique integer
2146 instead. */
2147 docstring = make_number (XHASH (function));
2148 return Ffset (function,
2149 Fpurecopy (list5 (Qautoload, file, docstring,
2150 interactive, type)));
2153 Lisp_Object
2154 un_autoload (Lisp_Object oldqueue)
2156 register Lisp_Object queue, first, second;
2158 /* Queue to unwind is current value of Vautoload_queue.
2159 oldqueue is the shadowed value to leave in Vautoload_queue. */
2160 queue = Vautoload_queue;
2161 Vautoload_queue = oldqueue;
2162 while (CONSP (queue))
2164 first = XCAR (queue);
2165 second = Fcdr (first);
2166 first = Fcar (first);
2167 if (EQ (first, make_number (0)))
2168 Vfeatures = second;
2169 else
2170 Ffset (first, second);
2171 queue = XCDR (queue);
2173 return Qnil;
2176 /* Load an autoloaded function.
2177 FUNNAME is the symbol which is the function's name.
2178 FUNDEF is the autoload definition (a list). */
2180 void
2181 do_autoload (Lisp_Object fundef, Lisp_Object funname)
2183 int count = SPECPDL_INDEX ();
2184 Lisp_Object fun;
2185 struct gcpro gcpro1, gcpro2, gcpro3;
2187 /* This is to make sure that loadup.el gives a clear picture
2188 of what files are preloaded and when. */
2189 if (! NILP (Vpurify_flag))
2190 error ("Attempt to autoload %s while preparing to dump",
2191 SDATA (SYMBOL_NAME (funname)));
2193 fun = funname;
2194 CHECK_SYMBOL (funname);
2195 GCPRO3 (fun, funname, fundef);
2197 /* Preserve the match data. */
2198 record_unwind_save_match_data ();
2200 /* If autoloading gets an error (which includes the error of failing
2201 to define the function being called), we use Vautoload_queue
2202 to undo function definitions and `provide' calls made by
2203 the function. We do this in the specific case of autoloading
2204 because autoloading is not an explicit request "load this file",
2205 but rather a request to "call this function".
2207 The value saved here is to be restored into Vautoload_queue. */
2208 record_unwind_protect (un_autoload, Vautoload_queue);
2209 Vautoload_queue = Qt;
2210 Fload (Fcar (Fcdr (fundef)), Qnil, Qt, Qnil, Qt);
2212 /* Once loading finishes, don't undo it. */
2213 Vautoload_queue = Qt;
2214 unbind_to (count, Qnil);
2216 fun = Findirect_function (fun, Qnil);
2218 if (!NILP (Fequal (fun, fundef)))
2219 error ("Autoloading failed to define function %s",
2220 SDATA (SYMBOL_NAME (funname)));
2221 UNGCPRO;
2225 DEFUN ("eval", Feval, Seval, 1, 2, 0,
2226 doc: /* Evaluate FORM and return its value.
2227 If LEXICAL is t, evaluate using lexical scoping. */)
2228 (Lisp_Object form, Lisp_Object lexical)
2230 int count = SPECPDL_INDEX ();
2231 specbind (Qinternal_interpreter_environment,
2232 NILP (lexical) ? Qnil : Fcons (Qt, Qnil));
2233 return unbind_to (count, eval_sub (form));
2236 /* Eval a sub-expression of the current expression (i.e. in the same
2237 lexical scope). */
2238 Lisp_Object
2239 eval_sub (Lisp_Object form)
2241 Lisp_Object fun, val, original_fun, original_args;
2242 Lisp_Object funcar;
2243 struct backtrace backtrace;
2244 struct gcpro gcpro1, gcpro2, gcpro3;
2246 if (handling_signal)
2247 abort ();
2249 if (SYMBOLP (form))
2251 /* Look up its binding in the lexical environment.
2252 We do not pay attention to the declared_special flag here, since we
2253 already did that when let-binding the variable. */
2254 Lisp_Object lex_binding
2255 = !NILP (Vinternal_interpreter_environment) /* Mere optimization! */
2256 ? Fassq (form, Vinternal_interpreter_environment)
2257 : Qnil;
2258 if (CONSP (lex_binding))
2259 return XCDR (lex_binding);
2260 else
2261 return Fsymbol_value (form);
2264 if (!CONSP (form))
2265 return form;
2267 QUIT;
2268 if ((consing_since_gc > gc_cons_threshold
2269 && consing_since_gc > gc_relative_threshold)
2271 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2273 GCPRO1 (form);
2274 Fgarbage_collect ();
2275 UNGCPRO;
2278 if (++lisp_eval_depth > max_lisp_eval_depth)
2280 if (max_lisp_eval_depth < 100)
2281 max_lisp_eval_depth = 100;
2282 if (lisp_eval_depth > max_lisp_eval_depth)
2283 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2286 original_fun = Fcar (form);
2287 original_args = Fcdr (form);
2289 backtrace.next = backtrace_list;
2290 backtrace_list = &backtrace;
2291 backtrace.function = &original_fun; /* This also protects them from gc. */
2292 backtrace.args = &original_args;
2293 backtrace.nargs = UNEVALLED;
2294 backtrace.evalargs = 1;
2295 backtrace.debug_on_exit = 0;
2297 if (debug_on_next_call)
2298 do_debug_on_call (Qt);
2300 /* At this point, only original_fun and original_args
2301 have values that will be used below. */
2302 retry:
2304 /* Optimize for no indirection. */
2305 fun = original_fun;
2306 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2307 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2308 fun = indirect_function (fun);
2310 if (SUBRP (fun))
2312 Lisp_Object numargs;
2313 Lisp_Object argvals[8];
2314 Lisp_Object args_left;
2315 register int i, maxargs;
2317 args_left = original_args;
2318 numargs = Flength (args_left);
2320 CHECK_CONS_LIST ();
2322 if (XINT (numargs) < XSUBR (fun)->min_args
2323 || (XSUBR (fun)->max_args >= 0
2324 && XSUBR (fun)->max_args < XINT (numargs)))
2325 xsignal2 (Qwrong_number_of_arguments, original_fun, numargs);
2327 else if (XSUBR (fun)->max_args == UNEVALLED)
2329 backtrace.evalargs = 0;
2330 val = (XSUBR (fun)->function.aUNEVALLED) (args_left);
2332 else if (XSUBR (fun)->max_args == MANY)
2334 /* Pass a vector of evaluated arguments. */
2335 Lisp_Object *vals;
2336 register size_t argnum = 0;
2337 USE_SAFE_ALLOCA;
2339 SAFE_ALLOCA_LISP (vals, XINT (numargs));
2341 GCPRO3 (args_left, fun, fun);
2342 gcpro3.var = vals;
2343 gcpro3.nvars = 0;
2345 while (!NILP (args_left))
2347 vals[argnum++] = eval_sub (Fcar (args_left));
2348 args_left = Fcdr (args_left);
2349 gcpro3.nvars = argnum;
2352 backtrace.args = vals;
2353 backtrace.nargs = XINT (numargs);
2355 val = (XSUBR (fun)->function.aMANY) (XINT (numargs), vals);
2356 UNGCPRO;
2357 SAFE_FREE ();
2359 else
2361 GCPRO3 (args_left, fun, fun);
2362 gcpro3.var = argvals;
2363 gcpro3.nvars = 0;
2365 maxargs = XSUBR (fun)->max_args;
2366 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2368 argvals[i] = eval_sub (Fcar (args_left));
2369 gcpro3.nvars = ++i;
2372 UNGCPRO;
2374 backtrace.args = argvals;
2375 backtrace.nargs = XINT (numargs);
2377 switch (i)
2379 case 0:
2380 val = (XSUBR (fun)->function.a0 ());
2381 break;
2382 case 1:
2383 val = (XSUBR (fun)->function.a1 (argvals[0]));
2384 break;
2385 case 2:
2386 val = (XSUBR (fun)->function.a2 (argvals[0], argvals[1]));
2387 break;
2388 case 3:
2389 val = (XSUBR (fun)->function.a3
2390 (argvals[0], argvals[1], argvals[2]));
2391 break;
2392 case 4:
2393 val = (XSUBR (fun)->function.a4
2394 (argvals[0], argvals[1], argvals[2], argvals[3]));
2395 break;
2396 case 5:
2397 val = (XSUBR (fun)->function.a5
2398 (argvals[0], argvals[1], argvals[2], argvals[3],
2399 argvals[4]));
2400 break;
2401 case 6:
2402 val = (XSUBR (fun)->function.a6
2403 (argvals[0], argvals[1], argvals[2], argvals[3],
2404 argvals[4], argvals[5]));
2405 break;
2406 case 7:
2407 val = (XSUBR (fun)->function.a7
2408 (argvals[0], argvals[1], argvals[2], argvals[3],
2409 argvals[4], argvals[5], argvals[6]));
2410 break;
2412 case 8:
2413 val = (XSUBR (fun)->function.a8
2414 (argvals[0], argvals[1], argvals[2], argvals[3],
2415 argvals[4], argvals[5], argvals[6], argvals[7]));
2416 break;
2418 default:
2419 /* Someone has created a subr that takes more arguments than
2420 is supported by this code. We need to either rewrite the
2421 subr to use a different argument protocol, or add more
2422 cases to this switch. */
2423 abort ();
2427 else if (COMPILEDP (fun))
2428 val = apply_lambda (fun, original_args);
2429 else
2431 if (EQ (fun, Qunbound))
2432 xsignal1 (Qvoid_function, original_fun);
2433 if (!CONSP (fun))
2434 xsignal1 (Qinvalid_function, original_fun);
2435 funcar = XCAR (fun);
2436 if (!SYMBOLP (funcar))
2437 xsignal1 (Qinvalid_function, original_fun);
2438 if (EQ (funcar, Qautoload))
2440 do_autoload (fun, original_fun);
2441 goto retry;
2443 if (EQ (funcar, Qmacro))
2444 val = eval_sub (apply1 (Fcdr (fun), original_args));
2445 else if (EQ (funcar, Qlambda)
2446 || EQ (funcar, Qclosure))
2447 val = apply_lambda (fun, original_args);
2448 else
2449 xsignal1 (Qinvalid_function, original_fun);
2451 CHECK_CONS_LIST ();
2453 lisp_eval_depth--;
2454 if (backtrace.debug_on_exit)
2455 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2456 backtrace_list = backtrace.next;
2458 return val;
2461 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2462 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2463 Then return the value FUNCTION returns.
2464 Thus, (apply '+ 1 2 '(3 4)) returns 10.
2465 usage: (apply FUNCTION &rest ARGUMENTS) */)
2466 (size_t nargs, Lisp_Object *args)
2468 register size_t i, numargs;
2469 register Lisp_Object spread_arg;
2470 register Lisp_Object *funcall_args;
2471 Lisp_Object fun, retval;
2472 struct gcpro gcpro1;
2473 USE_SAFE_ALLOCA;
2475 fun = args [0];
2476 funcall_args = 0;
2477 spread_arg = args [nargs - 1];
2478 CHECK_LIST (spread_arg);
2480 numargs = XINT (Flength (spread_arg));
2482 if (numargs == 0)
2483 return Ffuncall (nargs - 1, args);
2484 else if (numargs == 1)
2486 args [nargs - 1] = XCAR (spread_arg);
2487 return Ffuncall (nargs, args);
2490 numargs += nargs - 2;
2492 /* Optimize for no indirection. */
2493 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
2494 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
2495 fun = indirect_function (fun);
2496 if (EQ (fun, Qunbound))
2498 /* Let funcall get the error. */
2499 fun = args[0];
2500 goto funcall;
2503 if (SUBRP (fun))
2505 if (numargs < XSUBR (fun)->min_args
2506 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2507 goto funcall; /* Let funcall get the error. */
2508 else if (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args > numargs)
2510 /* Avoid making funcall cons up a yet another new vector of arguments
2511 by explicitly supplying nil's for optional values. */
2512 SAFE_ALLOCA_LISP (funcall_args, 1 + XSUBR (fun)->max_args);
2513 for (i = numargs; i < XSUBR (fun)->max_args;)
2514 funcall_args[++i] = Qnil;
2515 GCPRO1 (*funcall_args);
2516 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2519 funcall:
2520 /* We add 1 to numargs because funcall_args includes the
2521 function itself as well as its arguments. */
2522 if (!funcall_args)
2524 SAFE_ALLOCA_LISP (funcall_args, 1 + numargs);
2525 GCPRO1 (*funcall_args);
2526 gcpro1.nvars = 1 + numargs;
2529 memcpy (funcall_args, args, nargs * sizeof (Lisp_Object));
2530 /* Spread the last arg we got. Its first element goes in
2531 the slot that it used to occupy, hence this value of I. */
2532 i = nargs - 1;
2533 while (!NILP (spread_arg))
2535 funcall_args [i++] = XCAR (spread_arg);
2536 spread_arg = XCDR (spread_arg);
2539 /* By convention, the caller needs to gcpro Ffuncall's args. */
2540 retval = Ffuncall (gcpro1.nvars, funcall_args);
2541 UNGCPRO;
2542 SAFE_FREE ();
2544 return retval;
2547 /* Run hook variables in various ways. */
2549 static Lisp_Object
2550 funcall_nil (size_t nargs, Lisp_Object *args)
2552 Ffuncall (nargs, args);
2553 return Qnil;
2556 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2557 doc: /* Run each hook in HOOKS.
2558 Each argument should be a symbol, a hook variable.
2559 These symbols are processed in the order specified.
2560 If a hook symbol has a non-nil value, that value may be a function
2561 or a list of functions to be called to run the hook.
2562 If the value is a function, it is called with no arguments.
2563 If it is a list, the elements are called, in order, with no arguments.
2565 Major modes should not use this function directly to run their mode
2566 hook; they should use `run-mode-hooks' instead.
2568 Do not use `make-local-variable' to make a hook variable buffer-local.
2569 Instead, use `add-hook' and specify t for the LOCAL argument.
2570 usage: (run-hooks &rest HOOKS) */)
2571 (size_t nargs, Lisp_Object *args)
2573 Lisp_Object hook[1];
2574 register size_t i;
2576 for (i = 0; i < nargs; i++)
2578 hook[0] = args[i];
2579 run_hook_with_args (1, hook, funcall_nil);
2582 return Qnil;
2585 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2586 Srun_hook_with_args, 1, MANY, 0,
2587 doc: /* Run HOOK with the specified arguments ARGS.
2588 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2589 value, that value may be a function or a list of functions to be
2590 called to run the hook. If the value is a function, it is called with
2591 the given arguments and its return value is returned. If it is a list
2592 of functions, those functions are called, in order,
2593 with the given arguments ARGS.
2594 It is best not to depend on the value returned by `run-hook-with-args',
2595 as that may change.
2597 Do not use `make-local-variable' to make a hook variable buffer-local.
2598 Instead, use `add-hook' and specify t for the LOCAL argument.
2599 usage: (run-hook-with-args HOOK &rest ARGS) */)
2600 (size_t nargs, Lisp_Object *args)
2602 return run_hook_with_args (nargs, args, funcall_nil);
2605 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2606 Srun_hook_with_args_until_success, 1, MANY, 0,
2607 doc: /* Run HOOK with the specified arguments ARGS.
2608 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2609 value, that value may be a function or a list of functions to be
2610 called to run the hook. If the value is a function, it is called with
2611 the given arguments and its return value is returned.
2612 If it is a list of functions, those functions are called, in order,
2613 with the given arguments ARGS, until one of them
2614 returns a non-nil value. Then we return that value.
2615 However, if they all return nil, we return nil.
2617 Do not use `make-local-variable' to make a hook variable buffer-local.
2618 Instead, use `add-hook' and specify t for the LOCAL argument.
2619 usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2620 (size_t nargs, Lisp_Object *args)
2622 return run_hook_with_args (nargs, args, Ffuncall);
2625 static Lisp_Object
2626 funcall_not (size_t nargs, Lisp_Object *args)
2628 return NILP (Ffuncall (nargs, args)) ? Qt : Qnil;
2631 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2632 Srun_hook_with_args_until_failure, 1, MANY, 0,
2633 doc: /* Run HOOK with the specified arguments ARGS.
2634 HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2635 value, that value may be a function or a list of functions to be
2636 called to run the hook. If the value is a function, it is called with
2637 the given arguments and its return value is returned.
2638 If it is a list of functions, those functions are called, in order,
2639 with the given arguments ARGS, until one of them returns nil.
2640 Then we return nil. However, if they all return non-nil, we return non-nil.
2642 Do not use `make-local-variable' to make a hook variable buffer-local.
2643 Instead, use `add-hook' and specify t for the LOCAL argument.
2644 usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
2645 (size_t nargs, Lisp_Object *args)
2647 return NILP (run_hook_with_args (nargs, args, funcall_not)) ? Qt : Qnil;
2650 static Lisp_Object
2651 run_hook_wrapped_funcall (size_t nargs, Lisp_Object *args)
2653 Lisp_Object tmp = args[0], ret;
2654 args[0] = args[1];
2655 args[1] = tmp;
2656 ret = Ffuncall (nargs, args);
2657 args[1] = args[0];
2658 args[0] = tmp;
2659 return ret;
2662 DEFUN ("run-hook-wrapped", Frun_hook_wrapped, Srun_hook_wrapped, 2, MANY, 0,
2663 doc: /* Run HOOK, passing each function through WRAP-FUNCTION.
2664 I.e. instead of calling each function FUN directly with arguments ARGS,
2665 it calls WRAP-FUNCTION with arguments FUN and ARGS.
2666 As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2667 aborts and returns that value.
2668 usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
2669 (size_t nargs, Lisp_Object *args)
2671 return run_hook_with_args (nargs, args, run_hook_wrapped_funcall);
2674 /* ARGS[0] should be a hook symbol.
2675 Call each of the functions in the hook value, passing each of them
2676 as arguments all the rest of ARGS (all NARGS - 1 elements).
2677 FUNCALL specifies how to call each function on the hook.
2678 The caller (or its caller, etc) must gcpro all of ARGS,
2679 except that it isn't necessary to gcpro ARGS[0]. */
2681 Lisp_Object
2682 run_hook_with_args (size_t nargs, Lisp_Object *args,
2683 Lisp_Object (*funcall) (size_t nargs, Lisp_Object *args))
2685 Lisp_Object sym, val, ret = Qnil;
2686 struct gcpro gcpro1, gcpro2, gcpro3;
2688 /* If we are dying or still initializing,
2689 don't do anything--it would probably crash if we tried. */
2690 if (NILP (Vrun_hooks))
2691 return Qnil;
2693 sym = args[0];
2694 val = find_symbol_value (sym);
2696 if (EQ (val, Qunbound) || NILP (val))
2697 return ret;
2698 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2700 args[0] = val;
2701 return funcall (nargs, args);
2703 else
2705 Lisp_Object global_vals = Qnil;
2706 GCPRO3 (sym, val, global_vals);
2708 for (;
2709 CONSP (val) && NILP (ret);
2710 val = XCDR (val))
2712 if (EQ (XCAR (val), Qt))
2714 /* t indicates this hook has a local binding;
2715 it means to run the global binding too. */
2716 global_vals = Fdefault_value (sym);
2717 if (NILP (global_vals)) continue;
2719 if (!CONSP (global_vals) || EQ (XCAR (global_vals), Qlambda))
2721 args[0] = global_vals;
2722 ret = funcall (nargs, args);
2724 else
2726 for (;
2727 CONSP (global_vals) && NILP (ret);
2728 global_vals = XCDR (global_vals))
2730 args[0] = XCAR (global_vals);
2731 /* In a global value, t should not occur. If it does, we
2732 must ignore it to avoid an endless loop. */
2733 if (!EQ (args[0], Qt))
2734 ret = funcall (nargs, args);
2738 else
2740 args[0] = XCAR (val);
2741 ret = funcall (nargs, args);
2745 UNGCPRO;
2746 return ret;
2750 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2752 void
2753 run_hook_with_args_2 (Lisp_Object hook, Lisp_Object arg1, Lisp_Object arg2)
2755 Lisp_Object temp[3];
2756 temp[0] = hook;
2757 temp[1] = arg1;
2758 temp[2] = arg2;
2760 Frun_hook_with_args (3, temp);
2763 /* Apply fn to arg. */
2764 Lisp_Object
2765 apply1 (Lisp_Object fn, Lisp_Object arg)
2767 struct gcpro gcpro1;
2769 GCPRO1 (fn);
2770 if (NILP (arg))
2771 RETURN_UNGCPRO (Ffuncall (1, &fn));
2772 gcpro1.nvars = 2;
2774 Lisp_Object args[2];
2775 args[0] = fn;
2776 args[1] = arg;
2777 gcpro1.var = args;
2778 RETURN_UNGCPRO (Fapply (2, args));
2782 /* Call function fn on no arguments. */
2783 Lisp_Object
2784 call0 (Lisp_Object fn)
2786 struct gcpro gcpro1;
2788 GCPRO1 (fn);
2789 RETURN_UNGCPRO (Ffuncall (1, &fn));
2792 /* Call function fn with 1 argument arg1. */
2793 /* ARGSUSED */
2794 Lisp_Object
2795 call1 (Lisp_Object fn, Lisp_Object arg1)
2797 struct gcpro gcpro1;
2798 Lisp_Object args[2];
2800 args[0] = fn;
2801 args[1] = arg1;
2802 GCPRO1 (args[0]);
2803 gcpro1.nvars = 2;
2804 RETURN_UNGCPRO (Ffuncall (2, args));
2807 /* Call function fn with 2 arguments arg1, arg2. */
2808 /* ARGSUSED */
2809 Lisp_Object
2810 call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2812 struct gcpro gcpro1;
2813 Lisp_Object args[3];
2814 args[0] = fn;
2815 args[1] = arg1;
2816 args[2] = arg2;
2817 GCPRO1 (args[0]);
2818 gcpro1.nvars = 3;
2819 RETURN_UNGCPRO (Ffuncall (3, args));
2822 /* Call function fn with 3 arguments arg1, arg2, arg3. */
2823 /* ARGSUSED */
2824 Lisp_Object
2825 call3 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
2827 struct gcpro gcpro1;
2828 Lisp_Object args[4];
2829 args[0] = fn;
2830 args[1] = arg1;
2831 args[2] = arg2;
2832 args[3] = arg3;
2833 GCPRO1 (args[0]);
2834 gcpro1.nvars = 4;
2835 RETURN_UNGCPRO (Ffuncall (4, args));
2838 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
2839 /* ARGSUSED */
2840 Lisp_Object
2841 call4 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2842 Lisp_Object arg4)
2844 struct gcpro gcpro1;
2845 Lisp_Object args[5];
2846 args[0] = fn;
2847 args[1] = arg1;
2848 args[2] = arg2;
2849 args[3] = arg3;
2850 args[4] = arg4;
2851 GCPRO1 (args[0]);
2852 gcpro1.nvars = 5;
2853 RETURN_UNGCPRO (Ffuncall (5, args));
2856 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
2857 /* ARGSUSED */
2858 Lisp_Object
2859 call5 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2860 Lisp_Object arg4, Lisp_Object arg5)
2862 struct gcpro gcpro1;
2863 Lisp_Object args[6];
2864 args[0] = fn;
2865 args[1] = arg1;
2866 args[2] = arg2;
2867 args[3] = arg3;
2868 args[4] = arg4;
2869 args[5] = arg5;
2870 GCPRO1 (args[0]);
2871 gcpro1.nvars = 6;
2872 RETURN_UNGCPRO (Ffuncall (6, args));
2875 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
2876 /* ARGSUSED */
2877 Lisp_Object
2878 call6 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2879 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6)
2881 struct gcpro gcpro1;
2882 Lisp_Object args[7];
2883 args[0] = fn;
2884 args[1] = arg1;
2885 args[2] = arg2;
2886 args[3] = arg3;
2887 args[4] = arg4;
2888 args[5] = arg5;
2889 args[6] = arg6;
2890 GCPRO1 (args[0]);
2891 gcpro1.nvars = 7;
2892 RETURN_UNGCPRO (Ffuncall (7, args));
2895 /* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
2896 /* ARGSUSED */
2897 Lisp_Object
2898 call7 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2899 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6, Lisp_Object arg7)
2901 struct gcpro gcpro1;
2902 Lisp_Object args[8];
2903 args[0] = fn;
2904 args[1] = arg1;
2905 args[2] = arg2;
2906 args[3] = arg3;
2907 args[4] = arg4;
2908 args[5] = arg5;
2909 args[6] = arg6;
2910 args[7] = arg7;
2911 GCPRO1 (args[0]);
2912 gcpro1.nvars = 8;
2913 RETURN_UNGCPRO (Ffuncall (8, args));
2916 /* The caller should GCPRO all the elements of ARGS. */
2918 DEFUN ("functionp", Ffunctionp, Sfunctionp, 1, 1, 0,
2919 doc: /* Non-nil if OBJECT is a function. */)
2920 (Lisp_Object object)
2922 if (SYMBOLP (object) && !NILP (Ffboundp (object)))
2924 object = Findirect_function (object, Qt);
2926 if (CONSP (object) && EQ (XCAR (object), Qautoload))
2928 /* Autoloaded symbols are functions, except if they load
2929 macros or keymaps. */
2930 int i;
2931 for (i = 0; i < 4 && CONSP (object); i++)
2932 object = XCDR (object);
2934 return (CONSP (object) && !NILP (XCAR (object))) ? Qnil : Qt;
2938 if (SUBRP (object))
2939 return (XSUBR (object)->max_args != UNEVALLED) ? Qt : Qnil;
2940 else if (COMPILEDP (object))
2941 return Qt;
2942 else if (CONSP (object))
2944 Lisp_Object car = XCAR (object);
2945 return (EQ (car, Qlambda) || EQ (car, Qclosure)) ? Qt : Qnil;
2947 else
2948 return Qnil;
2951 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2952 doc: /* Call first argument as a function, passing remaining arguments to it.
2953 Return the value that function returns.
2954 Thus, (funcall 'cons 'x 'y) returns (x . y).
2955 usage: (funcall FUNCTION &rest ARGUMENTS) */)
2956 (size_t nargs, Lisp_Object *args)
2958 Lisp_Object fun, original_fun;
2959 Lisp_Object funcar;
2960 size_t numargs = nargs - 1;
2961 Lisp_Object lisp_numargs;
2962 Lisp_Object val;
2963 struct backtrace backtrace;
2964 register Lisp_Object *internal_args;
2965 register size_t i;
2967 QUIT;
2968 if ((consing_since_gc > gc_cons_threshold
2969 && consing_since_gc > gc_relative_threshold)
2971 (!NILP (Vmemory_full) && consing_since_gc > memory_full_cons_threshold))
2972 Fgarbage_collect ();
2974 if (++lisp_eval_depth > max_lisp_eval_depth)
2976 if (max_lisp_eval_depth < 100)
2977 max_lisp_eval_depth = 100;
2978 if (lisp_eval_depth > max_lisp_eval_depth)
2979 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
2982 backtrace.next = backtrace_list;
2983 backtrace_list = &backtrace;
2984 backtrace.function = &args[0];
2985 backtrace.args = &args[1];
2986 backtrace.nargs = nargs - 1;
2987 backtrace.evalargs = 0;
2988 backtrace.debug_on_exit = 0;
2990 if (debug_on_next_call)
2991 do_debug_on_call (Qlambda);
2993 CHECK_CONS_LIST ();
2995 original_fun = args[0];
2997 retry:
2999 /* Optimize for no indirection. */
3000 fun = original_fun;
3001 if (SYMBOLP (fun) && !EQ (fun, Qunbound)
3002 && (fun = XSYMBOL (fun)->function, SYMBOLP (fun)))
3003 fun = indirect_function (fun);
3005 if (SUBRP (fun))
3007 if (numargs < XSUBR (fun)->min_args
3008 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
3010 XSETFASTINT (lisp_numargs, numargs);
3011 xsignal2 (Qwrong_number_of_arguments, original_fun, lisp_numargs);
3014 else if (XSUBR (fun)->max_args == UNEVALLED)
3015 xsignal1 (Qinvalid_function, original_fun);
3017 else if (XSUBR (fun)->max_args == MANY)
3018 val = (XSUBR (fun)->function.aMANY) (numargs, args + 1);
3019 else
3021 if (XSUBR (fun)->max_args > numargs)
3023 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
3024 memcpy (internal_args, args + 1, numargs * sizeof (Lisp_Object));
3025 for (i = numargs; i < XSUBR (fun)->max_args; i++)
3026 internal_args[i] = Qnil;
3028 else
3029 internal_args = args + 1;
3030 switch (XSUBR (fun)->max_args)
3032 case 0:
3033 val = (XSUBR (fun)->function.a0 ());
3034 break;
3035 case 1:
3036 val = (XSUBR (fun)->function.a1 (internal_args[0]));
3037 break;
3038 case 2:
3039 val = (XSUBR (fun)->function.a2
3040 (internal_args[0], internal_args[1]));
3041 break;
3042 case 3:
3043 val = (XSUBR (fun)->function.a3
3044 (internal_args[0], internal_args[1], internal_args[2]));
3045 break;
3046 case 4:
3047 val = (XSUBR (fun)->function.a4
3048 (internal_args[0], internal_args[1], internal_args[2],
3049 internal_args[3]));
3050 break;
3051 case 5:
3052 val = (XSUBR (fun)->function.a5
3053 (internal_args[0], internal_args[1], internal_args[2],
3054 internal_args[3], internal_args[4]));
3055 break;
3056 case 6:
3057 val = (XSUBR (fun)->function.a6
3058 (internal_args[0], internal_args[1], internal_args[2],
3059 internal_args[3], internal_args[4], internal_args[5]));
3060 break;
3061 case 7:
3062 val = (XSUBR (fun)->function.a7
3063 (internal_args[0], internal_args[1], internal_args[2],
3064 internal_args[3], internal_args[4], internal_args[5],
3065 internal_args[6]));
3066 break;
3068 case 8:
3069 val = (XSUBR (fun)->function.a8
3070 (internal_args[0], internal_args[1], internal_args[2],
3071 internal_args[3], internal_args[4], internal_args[5],
3072 internal_args[6], internal_args[7]));
3073 break;
3075 default:
3077 /* If a subr takes more than 8 arguments without using MANY
3078 or UNEVALLED, we need to extend this function to support it.
3079 Until this is done, there is no way to call the function. */
3080 abort ();
3084 else if (COMPILEDP (fun))
3085 val = funcall_lambda (fun, numargs, args + 1);
3086 else
3088 if (EQ (fun, Qunbound))
3089 xsignal1 (Qvoid_function, original_fun);
3090 if (!CONSP (fun))
3091 xsignal1 (Qinvalid_function, original_fun);
3092 funcar = XCAR (fun);
3093 if (!SYMBOLP (funcar))
3094 xsignal1 (Qinvalid_function, original_fun);
3095 if (EQ (funcar, Qlambda)
3096 || EQ (funcar, Qclosure))
3097 val = funcall_lambda (fun, numargs, args + 1);
3098 else if (EQ (funcar, Qautoload))
3100 do_autoload (fun, original_fun);
3101 CHECK_CONS_LIST ();
3102 goto retry;
3104 else
3105 xsignal1 (Qinvalid_function, original_fun);
3107 CHECK_CONS_LIST ();
3108 lisp_eval_depth--;
3109 if (backtrace.debug_on_exit)
3110 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
3111 backtrace_list = backtrace.next;
3112 return val;
3115 static Lisp_Object
3116 apply_lambda (Lisp_Object fun, Lisp_Object args)
3118 Lisp_Object args_left;
3119 size_t numargs;
3120 register Lisp_Object *arg_vector;
3121 struct gcpro gcpro1, gcpro2, gcpro3;
3122 register size_t i;
3123 register Lisp_Object tem;
3124 USE_SAFE_ALLOCA;
3126 numargs = XINT (Flength (args));
3127 SAFE_ALLOCA_LISP (arg_vector, numargs);
3128 args_left = args;
3130 GCPRO3 (*arg_vector, args_left, fun);
3131 gcpro1.nvars = 0;
3133 for (i = 0; i < numargs; )
3135 tem = Fcar (args_left), args_left = Fcdr (args_left);
3136 tem = eval_sub (tem);
3137 arg_vector[i++] = tem;
3138 gcpro1.nvars = i;
3141 UNGCPRO;
3143 backtrace_list->args = arg_vector;
3144 backtrace_list->nargs = i;
3145 backtrace_list->evalargs = 0;
3146 tem = funcall_lambda (fun, numargs, arg_vector);
3148 /* Do the debug-on-exit now, while arg_vector still exists. */
3149 if (backtrace_list->debug_on_exit)
3150 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
3151 /* Don't do it again when we return to eval. */
3152 backtrace_list->debug_on_exit = 0;
3153 SAFE_FREE ();
3154 return tem;
3157 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3158 and return the result of evaluation.
3159 FUN must be either a lambda-expression or a compiled-code object. */
3161 static Lisp_Object
3162 funcall_lambda (Lisp_Object fun, size_t nargs,
3163 register Lisp_Object *arg_vector)
3165 Lisp_Object val, syms_left, next, lexenv;
3166 int count = SPECPDL_INDEX ();
3167 size_t i;
3168 int optional, rest;
3170 if (CONSP (fun))
3172 if (EQ (XCAR (fun), Qclosure))
3174 fun = XCDR (fun); /* Drop `closure'. */
3175 lexenv = XCAR (fun);
3176 CHECK_LIST_CONS (fun, fun);
3178 else
3179 lexenv = Qnil;
3180 syms_left = XCDR (fun);
3181 if (CONSP (syms_left))
3182 syms_left = XCAR (syms_left);
3183 else
3184 xsignal1 (Qinvalid_function, fun);
3186 else if (COMPILEDP (fun))
3188 syms_left = AREF (fun, COMPILED_ARGLIST);
3189 if (INTEGERP (syms_left))
3190 /* A byte-code object with a non-nil `push args' slot means we
3191 shouldn't bind any arguments, instead just call the byte-code
3192 interpreter directly; it will push arguments as necessary.
3194 Byte-code objects with either a non-existant, or a nil value for
3195 the `push args' slot (the default), have dynamically-bound
3196 arguments, and use the argument-binding code below instead (as do
3197 all interpreted functions, even lexically bound ones). */
3199 /* If we have not actually read the bytecode string
3200 and constants vector yet, fetch them from the file. */
3201 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3202 Ffetch_bytecode (fun);
3203 return exec_byte_code (AREF (fun, COMPILED_BYTECODE),
3204 AREF (fun, COMPILED_CONSTANTS),
3205 AREF (fun, COMPILED_STACK_DEPTH),
3206 syms_left,
3207 nargs, arg_vector);
3209 lexenv = Qnil;
3211 else
3212 abort ();
3214 i = optional = rest = 0;
3215 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
3217 QUIT;
3219 next = XCAR (syms_left);
3220 if (!SYMBOLP (next))
3221 xsignal1 (Qinvalid_function, fun);
3223 if (EQ (next, Qand_rest))
3224 rest = 1;
3225 else if (EQ (next, Qand_optional))
3226 optional = 1;
3227 else
3229 Lisp_Object arg;
3230 if (rest)
3232 arg = Flist (nargs - i, &arg_vector[i]);
3233 i = nargs;
3235 else if (i < nargs)
3236 arg = arg_vector[i++];
3237 else if (!optional)
3238 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3239 else
3240 arg = Qnil;
3242 /* Bind the argument. */
3243 if (!NILP (lexenv) && SYMBOLP (next))
3244 /* Lexically bind NEXT by adding it to the lexenv alist. */
3245 lexenv = Fcons (Fcons (next, arg), lexenv);
3246 else
3247 /* Dynamically bind NEXT. */
3248 specbind (next, arg);
3252 if (!NILP (syms_left))
3253 xsignal1 (Qinvalid_function, fun);
3254 else if (i < nargs)
3255 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3257 if (!EQ (lexenv, Vinternal_interpreter_environment))
3258 /* Instantiate a new lexical environment. */
3259 specbind (Qinternal_interpreter_environment, lexenv);
3261 if (CONSP (fun))
3262 val = Fprogn (XCDR (XCDR (fun)));
3263 else
3265 /* If we have not actually read the bytecode string
3266 and constants vector yet, fetch them from the file. */
3267 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3268 Ffetch_bytecode (fun);
3269 val = exec_byte_code (AREF (fun, COMPILED_BYTECODE),
3270 AREF (fun, COMPILED_CONSTANTS),
3271 AREF (fun, COMPILED_STACK_DEPTH),
3272 Qnil, 0, 0);
3275 return unbind_to (count, val);
3278 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
3279 1, 1, 0,
3280 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
3281 (Lisp_Object object)
3283 Lisp_Object tem;
3285 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
3287 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
3288 if (!CONSP (tem))
3290 tem = AREF (object, COMPILED_BYTECODE);
3291 if (CONSP (tem) && STRINGP (XCAR (tem)))
3292 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
3293 else
3294 error ("Invalid byte code");
3296 ASET (object, COMPILED_BYTECODE, XCAR (tem));
3297 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
3299 return object;
3302 static void
3303 grow_specpdl (void)
3305 register int count = SPECPDL_INDEX ();
3306 if (specpdl_size >= max_specpdl_size)
3308 if (max_specpdl_size < 400)
3309 max_specpdl_size = 400;
3310 if (specpdl_size >= max_specpdl_size)
3311 signal_error ("Variable binding depth exceeds max-specpdl-size", Qnil);
3313 specpdl_size *= 2;
3314 if (specpdl_size > max_specpdl_size)
3315 specpdl_size = max_specpdl_size;
3316 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
3317 specpdl_ptr = specpdl + count;
3320 /* `specpdl_ptr->symbol' is a field which describes which variable is
3321 let-bound, so it can be properly undone when we unbind_to.
3322 It can have the following two shapes:
3323 - SYMBOL : if it's a plain symbol, it means that we have let-bound
3324 a symbol that is not buffer-local (at least at the time
3325 the let binding started). Note also that it should not be
3326 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3327 to record V2 here).
3328 - (SYMBOL WHERE . BUFFER) : this means that it is a let-binding for
3329 variable SYMBOL which can be buffer-local. WHERE tells us
3330 which buffer is affected (or nil if the let-binding affects the
3331 global value of the variable) and BUFFER tells us which buffer was
3332 current (i.e. if WHERE is non-nil, then BUFFER==WHERE, otherwise
3333 BUFFER did not yet have a buffer-local value). */
3335 void
3336 specbind (Lisp_Object symbol, Lisp_Object value)
3338 struct Lisp_Symbol *sym;
3340 eassert (!handling_signal);
3342 CHECK_SYMBOL (symbol);
3343 sym = XSYMBOL (symbol);
3344 if (specpdl_ptr == specpdl + specpdl_size)
3345 grow_specpdl ();
3347 start:
3348 switch (sym->redirect)
3350 case SYMBOL_VARALIAS:
3351 sym = indirect_variable (sym); XSETSYMBOL (symbol, sym); goto start;
3352 case SYMBOL_PLAINVAL:
3353 /* The most common case is that of a non-constant symbol with a
3354 trivial value. Make that as fast as we can. */
3355 specpdl_ptr->symbol = symbol;
3356 specpdl_ptr->old_value = SYMBOL_VAL (sym);
3357 specpdl_ptr->func = NULL;
3358 ++specpdl_ptr;
3359 if (!sym->constant)
3360 SET_SYMBOL_VAL (sym, value);
3361 else
3362 set_internal (symbol, value, Qnil, 1);
3363 break;
3364 case SYMBOL_LOCALIZED:
3365 if (SYMBOL_BLV (sym)->frame_local)
3366 error ("Frame-local vars cannot be let-bound");
3367 case SYMBOL_FORWARDED:
3369 Lisp_Object ovalue = find_symbol_value (symbol);
3370 specpdl_ptr->func = 0;
3371 specpdl_ptr->old_value = ovalue;
3373 eassert (sym->redirect != SYMBOL_LOCALIZED
3374 || (EQ (SYMBOL_BLV (sym)->where,
3375 SYMBOL_BLV (sym)->frame_local ?
3376 Fselected_frame () : Fcurrent_buffer ())));
3378 if (sym->redirect == SYMBOL_LOCALIZED
3379 || BUFFER_OBJFWDP (SYMBOL_FWD (sym)))
3381 Lisp_Object where, cur_buf = Fcurrent_buffer ();
3383 /* For a local variable, record both the symbol and which
3384 buffer's or frame's value we are saving. */
3385 if (!NILP (Flocal_variable_p (symbol, Qnil)))
3387 eassert (sym->redirect != SYMBOL_LOCALIZED
3388 || (BLV_FOUND (SYMBOL_BLV (sym))
3389 && EQ (cur_buf, SYMBOL_BLV (sym)->where)));
3390 where = cur_buf;
3392 else if (sym->redirect == SYMBOL_LOCALIZED
3393 && BLV_FOUND (SYMBOL_BLV (sym)))
3394 where = SYMBOL_BLV (sym)->where;
3395 else
3396 where = Qnil;
3398 /* We're not using the `unused' slot in the specbinding
3399 structure because this would mean we have to do more
3400 work for simple variables. */
3401 /* FIXME: The third value `current_buffer' is only used in
3402 let_shadows_buffer_binding_p which is itself only used
3403 in set_internal for local_if_set. */
3404 eassert (NILP (where) || EQ (where, cur_buf));
3405 specpdl_ptr->symbol = Fcons (symbol, Fcons (where, cur_buf));
3407 /* If SYMBOL is a per-buffer variable which doesn't have a
3408 buffer-local value here, make the `let' change the global
3409 value by changing the value of SYMBOL in all buffers not
3410 having their own value. This is consistent with what
3411 happens with other buffer-local variables. */
3412 if (NILP (where)
3413 && sym->redirect == SYMBOL_FORWARDED)
3415 eassert (BUFFER_OBJFWDP (SYMBOL_FWD (sym)));
3416 ++specpdl_ptr;
3417 Fset_default (symbol, value);
3418 return;
3421 else
3422 specpdl_ptr->symbol = symbol;
3424 specpdl_ptr++;
3425 set_internal (symbol, value, Qnil, 1);
3426 break;
3428 default: abort ();
3432 void
3433 record_unwind_protect (Lisp_Object (*function) (Lisp_Object), Lisp_Object arg)
3435 eassert (!handling_signal);
3437 if (specpdl_ptr == specpdl + specpdl_size)
3438 grow_specpdl ();
3439 specpdl_ptr->func = function;
3440 specpdl_ptr->symbol = Qnil;
3441 specpdl_ptr->old_value = arg;
3442 specpdl_ptr++;
3445 Lisp_Object
3446 unbind_to (int count, Lisp_Object value)
3448 Lisp_Object quitf = Vquit_flag;
3449 struct gcpro gcpro1, gcpro2;
3451 GCPRO2 (value, quitf);
3452 Vquit_flag = Qnil;
3454 while (specpdl_ptr != specpdl + count)
3456 /* Copy the binding, and decrement specpdl_ptr, before we do
3457 the work to unbind it. We decrement first
3458 so that an error in unbinding won't try to unbind
3459 the same entry again, and we copy the binding first
3460 in case more bindings are made during some of the code we run. */
3462 struct specbinding this_binding;
3463 this_binding = *--specpdl_ptr;
3465 if (this_binding.func != 0)
3466 (*this_binding.func) (this_binding.old_value);
3467 /* If the symbol is a list, it is really (SYMBOL WHERE
3468 . CURRENT-BUFFER) where WHERE is either nil, a buffer, or a
3469 frame. If WHERE is a buffer or frame, this indicates we
3470 bound a variable that had a buffer-local or frame-local
3471 binding. WHERE nil means that the variable had the default
3472 value when it was bound. CURRENT-BUFFER is the buffer that
3473 was current when the variable was bound. */
3474 else if (CONSP (this_binding.symbol))
3476 Lisp_Object symbol, where;
3478 symbol = XCAR (this_binding.symbol);
3479 where = XCAR (XCDR (this_binding.symbol));
3481 if (NILP (where))
3482 Fset_default (symbol, this_binding.old_value);
3483 /* If `where' is non-nil, reset the value in the appropriate
3484 local binding, but only if that binding still exists. */
3485 else if (BUFFERP (where)
3486 ? !NILP (Flocal_variable_p (symbol, where))
3487 : !NILP (Fassq (symbol, XFRAME (where)->param_alist)))
3488 set_internal (symbol, this_binding.old_value, where, 1);
3490 /* If variable has a trivial value (no forwarding), we can
3491 just set it. No need to check for constant symbols here,
3492 since that was already done by specbind. */
3493 else if (XSYMBOL (this_binding.symbol)->redirect == SYMBOL_PLAINVAL)
3494 SET_SYMBOL_VAL (XSYMBOL (this_binding.symbol),
3495 this_binding.old_value);
3496 else
3497 /* NOTE: we only ever come here if make_local_foo was used for
3498 the first time on this var within this let. */
3499 Fset_default (this_binding.symbol, this_binding.old_value);
3502 if (NILP (Vquit_flag) && !NILP (quitf))
3503 Vquit_flag = quitf;
3505 UNGCPRO;
3506 return value;
3509 DEFUN ("special-variable-p", Fspecial_variable_p, Sspecial_variable_p, 1, 1, 0,
3510 doc: /* Return non-nil if SYMBOL's global binding has been declared special.
3511 A special variable is one that will be bound dynamically, even in a
3512 context where binding is lexical by default. */)
3513 (Lisp_Object symbol)
3515 CHECK_SYMBOL (symbol);
3516 return XSYMBOL (symbol)->declared_special ? Qt : Qnil;
3520 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3521 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3522 The debugger is entered when that frame exits, if the flag is non-nil. */)
3523 (Lisp_Object level, Lisp_Object flag)
3525 register struct backtrace *backlist = backtrace_list;
3526 register int i;
3528 CHECK_NUMBER (level);
3530 for (i = 0; backlist && i < XINT (level); i++)
3532 backlist = backlist->next;
3535 if (backlist)
3536 backlist->debug_on_exit = !NILP (flag);
3538 return flag;
3541 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3542 doc: /* Print a trace of Lisp function calls currently active.
3543 Output stream used is value of `standard-output'. */)
3544 (void)
3546 register struct backtrace *backlist = backtrace_list;
3547 Lisp_Object tail;
3548 Lisp_Object tem;
3549 struct gcpro gcpro1;
3550 Lisp_Object old_print_level = Vprint_level;
3552 if (NILP (Vprint_level))
3553 XSETFASTINT (Vprint_level, 8);
3555 tail = Qnil;
3556 GCPRO1 (tail);
3558 while (backlist)
3560 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3561 if (backlist->nargs == UNEVALLED)
3563 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3564 write_string ("\n", -1);
3566 else
3568 tem = *backlist->function;
3569 Fprin1 (tem, Qnil); /* This can QUIT. */
3570 write_string ("(", -1);
3571 if (backlist->nargs == MANY)
3572 { /* FIXME: Can this happen? */
3573 int i;
3574 for (tail = *backlist->args, i = 0;
3575 !NILP (tail);
3576 tail = Fcdr (tail), i = 1)
3578 if (i) write_string (" ", -1);
3579 Fprin1 (Fcar (tail), Qnil);
3582 else
3584 size_t i;
3585 for (i = 0; i < backlist->nargs; i++)
3587 if (i) write_string (" ", -1);
3588 Fprin1 (backlist->args[i], Qnil);
3591 write_string (")\n", -1);
3593 backlist = backlist->next;
3596 Vprint_level = old_print_level;
3597 UNGCPRO;
3598 return Qnil;
3601 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3602 doc: /* Return the function and arguments NFRAMES up from current execution point.
3603 If that frame has not evaluated the arguments yet (or is a special form),
3604 the value is (nil FUNCTION ARG-FORMS...).
3605 If that frame has evaluated its arguments and called its function already,
3606 the value is (t FUNCTION ARG-VALUES...).
3607 A &rest arg is represented as the tail of the list ARG-VALUES.
3608 FUNCTION is whatever was supplied as car of evaluated list,
3609 or a lambda expression for macro calls.
3610 If NFRAMES is more than the number of frames, the value is nil. */)
3611 (Lisp_Object nframes)
3613 register struct backtrace *backlist = backtrace_list;
3614 register EMACS_INT i;
3615 Lisp_Object tem;
3617 CHECK_NATNUM (nframes);
3619 /* Find the frame requested. */
3620 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3621 backlist = backlist->next;
3623 if (!backlist)
3624 return Qnil;
3625 if (backlist->nargs == UNEVALLED)
3626 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3627 else
3629 if (backlist->nargs == MANY) /* FIXME: Can this happen? */
3630 tem = *backlist->args;
3631 else
3632 tem = Flist (backlist->nargs, backlist->args);
3634 return Fcons (Qt, Fcons (*backlist->function, tem));
3639 #if BYTE_MARK_STACK
3640 void
3641 mark_backtrace (void)
3643 register struct backtrace *backlist;
3644 register size_t i;
3646 for (backlist = backtrace_list; backlist; backlist = backlist->next)
3648 mark_object (*backlist->function);
3650 if (backlist->nargs == UNEVALLED
3651 || backlist->nargs == MANY) /* FIXME: Can this happen? */
3652 i = 1;
3653 else
3654 i = backlist->nargs;
3655 while (i--)
3656 mark_object (backlist->args[i]);
3659 #endif
3661 void
3662 syms_of_eval (void)
3664 DEFVAR_INT ("max-specpdl-size", max_specpdl_size,
3665 doc: /* *Limit on number of Lisp variable bindings and `unwind-protect's.
3666 If Lisp code tries to increase the total number past this amount,
3667 an error is signaled.
3668 You can safely use a value considerably larger than the default value,
3669 if that proves inconveniently small. However, if you increase it too far,
3670 Emacs could run out of memory trying to make the stack bigger. */);
3672 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth,
3673 doc: /* *Limit on depth in `eval', `apply' and `funcall' before error.
3675 This limit serves to catch infinite recursions for you before they cause
3676 actual stack overflow in C, which would be fatal for Emacs.
3677 You can safely make it considerably larger than its default value,
3678 if that proves inconveniently small. However, if you increase it too far,
3679 Emacs could overflow the real C stack, and crash. */);
3681 DEFVAR_LISP ("quit-flag", Vquit_flag,
3682 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
3683 If the value is t, that means do an ordinary quit.
3684 If the value equals `throw-on-input', that means quit by throwing
3685 to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3686 Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3687 but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
3688 Vquit_flag = Qnil;
3690 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit,
3691 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3692 Note that `quit-flag' will still be set by typing C-g,
3693 so a quit will be signaled as soon as `inhibit-quit' is nil.
3694 To prevent this happening, set `quit-flag' to nil
3695 before making `inhibit-quit' nil. */);
3696 Vinhibit_quit = Qnil;
3698 Qinhibit_quit = intern_c_string ("inhibit-quit");
3699 staticpro (&Qinhibit_quit);
3701 Qautoload = intern_c_string ("autoload");
3702 staticpro (&Qautoload);
3704 Qdebug_on_error = intern_c_string ("debug-on-error");
3705 staticpro (&Qdebug_on_error);
3707 Qmacro = intern_c_string ("macro");
3708 staticpro (&Qmacro);
3710 Qdeclare = intern_c_string ("declare");
3711 staticpro (&Qdeclare);
3713 /* Note that the process handling also uses Qexit, but we don't want
3714 to staticpro it twice, so we just do it here. */
3715 Qexit = intern_c_string ("exit");
3716 staticpro (&Qexit);
3718 Qinteractive = intern_c_string ("interactive");
3719 staticpro (&Qinteractive);
3721 Qcommandp = intern_c_string ("commandp");
3722 staticpro (&Qcommandp);
3724 Qdefun = intern_c_string ("defun");
3725 staticpro (&Qdefun);
3727 Qand_rest = intern_c_string ("&rest");
3728 staticpro (&Qand_rest);
3730 Qand_optional = intern_c_string ("&optional");
3731 staticpro (&Qand_optional);
3733 Qclosure = intern_c_string ("closure");
3734 staticpro (&Qclosure);
3736 Qdebug = intern_c_string ("debug");
3737 staticpro (&Qdebug);
3739 DEFVAR_LISP ("debug-on-error", Vdebug_on_error,
3740 doc: /* *Non-nil means enter debugger if an error is signaled.
3741 Does not apply to errors handled by `condition-case' or those
3742 matched by `debug-ignored-errors'.
3743 If the value is a list, an error only means to enter the debugger
3744 if one of its condition symbols appears in the list.
3745 When you evaluate an expression interactively, this variable
3746 is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
3747 The command `toggle-debug-on-error' toggles this.
3748 See also the variable `debug-on-quit'. */);
3749 Vdebug_on_error = Qnil;
3751 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors,
3752 doc: /* *List of errors for which the debugger should not be called.
3753 Each element may be a condition-name or a regexp that matches error messages.
3754 If any element applies to a given error, that error skips the debugger
3755 and just returns to top level.
3756 This overrides the variable `debug-on-error'.
3757 It does not apply to errors handled by `condition-case'. */);
3758 Vdebug_ignored_errors = Qnil;
3760 DEFVAR_BOOL ("debug-on-quit", debug_on_quit,
3761 doc: /* *Non-nil means enter debugger if quit is signaled (C-g, for example).
3762 Does not apply if quit is handled by a `condition-case'. */);
3763 debug_on_quit = 0;
3765 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call,
3766 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
3768 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue,
3769 doc: /* Non-nil means debugger may continue execution.
3770 This is nil when the debugger is called under circumstances where it
3771 might not be safe to continue. */);
3772 debugger_may_continue = 1;
3774 DEFVAR_LISP ("debugger", Vdebugger,
3775 doc: /* Function to call to invoke debugger.
3776 If due to frame exit, args are `exit' and the value being returned;
3777 this function's value will be returned instead of that.
3778 If due to error, args are `error' and a list of the args to `signal'.
3779 If due to `apply' or `funcall' entry, one arg, `lambda'.
3780 If due to `eval' entry, one arg, t. */);
3781 Vdebugger = Qnil;
3783 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function,
3784 doc: /* If non-nil, this is a function for `signal' to call.
3785 It receives the same arguments that `signal' was given.
3786 The Edebug package uses this to regain control. */);
3787 Vsignal_hook_function = Qnil;
3789 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal,
3790 doc: /* *Non-nil means call the debugger regardless of condition handlers.
3791 Note that `debug-on-error', `debug-on-quit' and friends
3792 still determine whether to handle the particular condition. */);
3793 Vdebug_on_signal = Qnil;
3795 DEFVAR_LISP ("macro-declaration-function", Vmacro_declaration_function,
3796 doc: /* Function to process declarations in a macro definition.
3797 The function will be called with two args MACRO and DECL.
3798 MACRO is the name of the macro being defined.
3799 DECL is a list `(declare ...)' containing the declarations.
3800 The value the function returns is not used. */);
3801 Vmacro_declaration_function = Qnil;
3803 /* When lexical binding is being used,
3804 vinternal_interpreter_environment is non-nil, and contains an alist
3805 of lexically-bound variable, or (t), indicating an empty
3806 environment. The lisp name of this variable would be
3807 `internal-interpreter-environment' if it weren't hidden.
3808 Every element of this list can be either a cons (VAR . VAL)
3809 specifying a lexical binding, or a single symbol VAR indicating
3810 that this variable should use dynamic scoping. */
3811 Qinternal_interpreter_environment
3812 = intern_c_string ("internal-interpreter-environment");
3813 staticpro (&Qinternal_interpreter_environment);
3814 DEFVAR_LISP ("internal-interpreter-environment",
3815 Vinternal_interpreter_environment,
3816 doc: /* If non-nil, the current lexical environment of the lisp interpreter.
3817 When lexical binding is not being used, this variable is nil.
3818 A value of `(t)' indicates an empty environment, otherwise it is an
3819 alist of active lexical bindings. */);
3820 Vinternal_interpreter_environment = Qnil;
3821 /* Don't export this variable to Elisp, so noone can mess with it
3822 (Just imagine if someone makes it buffer-local). */
3823 Funintern (Qinternal_interpreter_environment, Qnil);
3825 Vrun_hooks = intern_c_string ("run-hooks");
3826 staticpro (&Vrun_hooks);
3828 staticpro (&Vautoload_queue);
3829 Vautoload_queue = Qnil;
3830 staticpro (&Vsignaling_function);
3831 Vsignaling_function = Qnil;
3833 defsubr (&Sor);
3834 defsubr (&Sand);
3835 defsubr (&Sif);
3836 defsubr (&Scond);
3837 defsubr (&Sprogn);
3838 defsubr (&Sprog1);
3839 defsubr (&Sprog2);
3840 defsubr (&Ssetq);
3841 defsubr (&Squote);
3842 defsubr (&Sfunction);
3843 defsubr (&Sdefun);
3844 defsubr (&Sdefmacro);
3845 defsubr (&Sdefvar);
3846 defsubr (&Sdefvaralias);
3847 defsubr (&Sdefconst);
3848 defsubr (&Suser_variable_p);
3849 defsubr (&Slet);
3850 defsubr (&SletX);
3851 defsubr (&Swhile);
3852 defsubr (&Smacroexpand);
3853 defsubr (&Scatch);
3854 defsubr (&Sthrow);
3855 defsubr (&Sunwind_protect);
3856 defsubr (&Scondition_case);
3857 defsubr (&Ssignal);
3858 defsubr (&Sinteractive_p);
3859 defsubr (&Scalled_interactively_p);
3860 defsubr (&Scommandp);
3861 defsubr (&Sautoload);
3862 defsubr (&Seval);
3863 defsubr (&Sapply);
3864 defsubr (&Sfuncall);
3865 defsubr (&Srun_hooks);
3866 defsubr (&Srun_hook_with_args);
3867 defsubr (&Srun_hook_with_args_until_success);
3868 defsubr (&Srun_hook_with_args_until_failure);
3869 defsubr (&Srun_hook_wrapped);
3870 defsubr (&Sfetch_bytecode);
3871 defsubr (&Sbacktrace_debug);
3872 defsubr (&Sbacktrace);
3873 defsubr (&Sbacktrace_frame);
3874 defsubr (&Sspecial_variable_p);
3875 defsubr (&Sfunctionp);