Initial revision
[emacs.git] / src / eval.c
blob897e543adf40a5f3ddcdfadb716544b1dc1f95f3
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993 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 1, or (at your option)
9 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; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
21 #include "config.h"
22 #include "lisp.h"
23 #include "blockinput.h"
25 #ifndef standalone
26 #include "commands.h"
27 #include "keyboard.h"
28 #else
29 #define INTERACTIVE 1
30 #endif
32 #include <setjmp.h>
34 /* This definition is duplicated in alloc.c and keyboard.c */
35 /* Putting it in lisp.h makes cc bomb out! */
37 struct backtrace
39 struct backtrace *next;
40 Lisp_Object *function;
41 Lisp_Object *args; /* Points to vector of args. */
42 int nargs; /* Length of vector.
43 If nargs is UNEVALLED, args points to slot holding
44 list of unevalled args */
45 char evalargs;
46 /* Nonzero means call value of debugger when done with this operation. */
47 char debug_on_exit;
50 struct backtrace *backtrace_list;
52 /* This structure helps implement the `catch' and `throw' control
53 structure. A struct catchtag contains all the information needed
54 to restore the state of the interpreter after a non-local jump.
56 Handlers for error conditions (represented by `struct handler'
57 structures) just point to a catch tag to do the cleanup required
58 for their jumps.
60 catchtag structures are chained together in the C calling stack;
61 the `next' member points to the next outer catchtag.
63 A call like (throw TAG VAL) searches for a catchtag whose `tag'
64 member is TAG, and then unbinds to it. The `val' member is used to
65 hold VAL while the stack is unwound; `val' is returned as the value
66 of the catch form.
68 All the other members are concerned with restoring the interpreter
69 state. */
70 struct catchtag
72 Lisp_Object tag;
73 Lisp_Object val;
74 struct catchtag *next;
75 struct gcpro *gcpro;
76 jmp_buf jmp;
77 struct backtrace *backlist;
78 struct handler *handlerlist;
79 int lisp_eval_depth;
80 int pdlcount;
81 int poll_suppress_count;
84 struct catchtag *catchlist;
86 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
87 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
88 Lisp_Object Qmocklisp_arguments, Vmocklisp_arguments, Qmocklisp;
89 Lisp_Object Qand_rest, Qand_optional;
90 Lisp_Object Qdebug_on_error;
92 Lisp_Object Vrun_hooks;
94 /* Non-nil means record all fset's and provide's, to be undone
95 if the file being autoloaded is not fully loaded.
96 They are recorded by being consed onto the front of Vautoload_queue:
97 (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide. */
99 Lisp_Object Vautoload_queue;
101 /* Current number of specbindings allocated in specpdl. */
102 int specpdl_size;
104 /* Pointer to beginning of specpdl. */
105 struct specbinding *specpdl;
107 /* Pointer to first unused element in specpdl. */
108 struct specbinding *specpdl_ptr;
110 /* Maximum size allowed for specpdl allocation */
111 int max_specpdl_size;
113 /* Depth in Lisp evaluations and function calls. */
114 int lisp_eval_depth;
116 /* Maximum allowed depth in Lisp evaluations and function calls. */
117 int max_lisp_eval_depth;
119 /* Nonzero means enter debugger before next function call */
120 int debug_on_next_call;
122 /* List of conditions (non-nil atom means all) which cause a backtrace
123 if an error is handled by the command loop's error handler. */
124 Lisp_Object Vstack_trace_on_error;
126 /* List of conditions (non-nil atom means all) which enter the debugger
127 if an error is handled by the command loop's error handler. */
128 Lisp_Object Vdebug_on_error;
130 /* Nonzero means enter debugger if a quit signal
131 is handled by the command loop's error handler. */
132 int debug_on_quit;
134 /* The value of num_nonmacro_input_chars as of the last time we
135 started to enter the debugger. If we decide to enter the debugger
136 again when this is still equal to num_nonmacro_input_chars, then we
137 know that the debugger itself has an error, and we should just
138 signal the error instead of entering an infinite loop of debugger
139 invocations. */
140 int when_entered_debugger;
142 Lisp_Object Vdebugger;
144 void specbind (), record_unwind_protect ();
146 Lisp_Object funcall_lambda ();
147 extern Lisp_Object ml_apply (); /* Apply a mocklisp function to unevaluated argument list */
149 init_eval_once ()
151 specpdl_size = 50;
152 specpdl = (struct specbinding *) malloc (specpdl_size * sizeof (struct specbinding));
153 max_specpdl_size = 600;
154 max_lisp_eval_depth = 200;
157 init_eval ()
159 specpdl_ptr = specpdl;
160 catchlist = 0;
161 handlerlist = 0;
162 backtrace_list = 0;
163 Vquit_flag = Qnil;
164 debug_on_next_call = 0;
165 lisp_eval_depth = 0;
166 when_entered_debugger = 0;
169 Lisp_Object
170 call_debugger (arg)
171 Lisp_Object arg;
173 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
174 max_lisp_eval_depth = lisp_eval_depth + 20;
175 if (specpdl_size + 40 > max_specpdl_size)
176 max_specpdl_size = specpdl_size + 40;
177 debug_on_next_call = 0;
178 when_entered_debugger = num_nonmacro_input_chars;
179 return apply1 (Vdebugger, arg);
182 do_debug_on_call (code)
183 Lisp_Object code;
185 debug_on_next_call = 0;
186 backtrace_list->debug_on_exit = 1;
187 call_debugger (Fcons (code, Qnil));
190 /* NOTE!!! Every function that can call EVAL must protect its args
191 and temporaries from garbage collection while it needs them.
192 The definition of `For' shows what you have to do. */
194 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
195 "Eval args until one of them yields non-nil, then return that value.\n\
196 The remaining args are not evalled at all.\n\
197 If all args return nil, return nil.")
198 (args)
199 Lisp_Object args;
201 register Lisp_Object val;
202 Lisp_Object args_left;
203 struct gcpro gcpro1;
205 if (NILP(args))
206 return Qnil;
208 args_left = args;
209 GCPRO1 (args_left);
213 val = Feval (Fcar (args_left));
214 if (!NILP (val))
215 break;
216 args_left = Fcdr (args_left);
218 while (!NILP(args_left));
220 UNGCPRO;
221 return val;
224 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
225 "Eval args until one of them yields nil, then return nil.\n\
226 The remaining args are not evalled at all.\n\
227 If no arg yields nil, return the last arg's value.")
228 (args)
229 Lisp_Object args;
231 register Lisp_Object val;
232 Lisp_Object args_left;
233 struct gcpro gcpro1;
235 if (NILP(args))
236 return Qt;
238 args_left = args;
239 GCPRO1 (args_left);
243 val = Feval (Fcar (args_left));
244 if (NILP (val))
245 break;
246 args_left = Fcdr (args_left);
248 while (!NILP(args_left));
250 UNGCPRO;
251 return val;
254 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
255 "(if COND THEN ELSE...): if COND yields non-nil, do THEN, else do ELSE...\n\
256 Returns the value of THEN or the value of the last of the ELSE's.\n\
257 THEN must be one expression, but ELSE... can be zero or more expressions.\n\
258 If COND yields nil, and there are no ELSE's, the value is nil.")
259 (args)
260 Lisp_Object args;
262 register Lisp_Object cond;
263 struct gcpro gcpro1;
265 GCPRO1 (args);
266 cond = Feval (Fcar (args));
267 UNGCPRO;
269 if (!NILP (cond))
270 return Feval (Fcar (Fcdr (args)));
271 return Fprogn (Fcdr (Fcdr (args)));
274 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
275 "(cond CLAUSES...): try each clause until one succeeds.\n\
276 Each clause looks like (CONDITION BODY...). CONDITION is evaluated\n\
277 and, if the value is non-nil, this clause succeeds:\n\
278 then the expressions in BODY are evaluated and the last one's\n\
279 value is the value of the cond-form.\n\
280 If no clause succeeds, cond returns nil.\n\
281 If a clause has one element, as in (CONDITION),\n\
282 CONDITION's value if non-nil is returned from the cond-form.")
283 (args)
284 Lisp_Object args;
286 register Lisp_Object clause, val;
287 struct gcpro gcpro1;
289 val = Qnil;
290 GCPRO1 (args);
291 while (!NILP (args))
293 clause = Fcar (args);
294 val = Feval (Fcar (clause));
295 if (!NILP (val))
297 if (!EQ (XCONS (clause)->cdr, Qnil))
298 val = Fprogn (XCONS (clause)->cdr);
299 break;
301 args = XCONS (args)->cdr;
303 UNGCPRO;
305 return val;
308 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
309 "(progn BODY...): eval BODY forms sequentially and return value of last one.")
310 (args)
311 Lisp_Object args;
313 register Lisp_Object val, tem;
314 Lisp_Object args_left;
315 struct gcpro gcpro1;
317 /* In Mocklisp code, symbols at the front of the progn arglist
318 are to be bound to zero. */
319 if (!EQ (Vmocklisp_arguments, Qt))
321 val = make_number (0);
322 while (!NILP (args) && (tem = Fcar (args), XTYPE (tem) == Lisp_Symbol))
324 QUIT;
325 specbind (tem, val), args = Fcdr (args);
329 if (NILP(args))
330 return Qnil;
332 args_left = args;
333 GCPRO1 (args_left);
337 val = Feval (Fcar (args_left));
338 args_left = Fcdr (args_left);
340 while (!NILP(args_left));
342 UNGCPRO;
343 return val;
346 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
347 "(prog1 FIRST BODY...): eval FIRST and BODY sequentially; value from FIRST.\n\
348 The value of FIRST is saved during the evaluation of the remaining args,\n\
349 whose values are discarded.")
350 (args)
351 Lisp_Object args;
353 Lisp_Object val;
354 register Lisp_Object args_left;
355 struct gcpro gcpro1, gcpro2;
356 register int argnum = 0;
358 if (NILP(args))
359 return Qnil;
361 args_left = args;
362 val = Qnil;
363 GCPRO2 (args, val);
367 if (!(argnum++))
368 val = Feval (Fcar (args_left));
369 else
370 Feval (Fcar (args_left));
371 args_left = Fcdr (args_left);
373 while (!NILP(args_left));
375 UNGCPRO;
376 return val;
379 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
380 "(prog1 X Y BODY...): eval X, Y and BODY sequentially; value from Y.\n\
381 The value of Y is saved during the evaluation of the remaining args,\n\
382 whose values are discarded.")
383 (args)
384 Lisp_Object args;
386 Lisp_Object val;
387 register Lisp_Object args_left;
388 struct gcpro gcpro1, gcpro2;
389 register int argnum = -1;
391 val = Qnil;
393 if (NILP(args))
394 return Qnil;
396 args_left = args;
397 val = Qnil;
398 GCPRO2 (args, val);
402 if (!(argnum++))
403 val = Feval (Fcar (args_left));
404 else
405 Feval (Fcar (args_left));
406 args_left = Fcdr (args_left);
408 while (!NILP(args_left));
410 UNGCPRO;
411 return val;
414 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
415 "(setq SYM VAL SYM VAL ...): set each SYM to the value of its VAL.\n\
416 The SYMs are not evaluated. Thus (setq x y) sets x to the value of y.\n\
417 Each SYM is set before the next VAL is computed.")
418 (args)
419 Lisp_Object args;
421 register Lisp_Object args_left;
422 register Lisp_Object val, sym;
423 struct gcpro gcpro1;
425 if (NILP(args))
426 return Qnil;
428 args_left = args;
429 GCPRO1 (args);
433 val = Feval (Fcar (Fcdr (args_left)));
434 sym = Fcar (args_left);
435 Fset (sym, val);
436 args_left = Fcdr (Fcdr (args_left));
438 while (!NILP(args_left));
440 UNGCPRO;
441 return val;
444 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
445 "Return the argument, without evaluating it. `(quote x)' yields `x'.")
446 (args)
447 Lisp_Object args;
449 return Fcar (args);
452 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
453 "Like `quote', but preferred for objects which are functions.\n\
454 In byte compilation, `function' causes its argument to be compiled.\n\
455 `quote' cannot do that.")
456 (args)
457 Lisp_Object args;
459 return Fcar (args);
462 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
463 "Return t if function in which this appears was called interactively.\n\
464 This means that the function was called with call-interactively (which\n\
465 includes being called as the binding of a key)\n\
466 and input is currently coming from the keyboard (not in keyboard macro).")
469 register struct backtrace *btp;
470 register Lisp_Object fun;
472 if (!INTERACTIVE)
473 return Qnil;
475 btp = backtrace_list;
477 /* If this isn't a byte-compiled function, there may be a frame at
478 the top for Finteractive_p itself. If so, skip it. */
479 fun = Findirect_function (*btp->function);
480 if (XTYPE (fun) == Lisp_Subr
481 && (struct Lisp_Subr *) XPNTR (fun) == &Sinteractive_p)
482 btp = btp->next;
484 /* If we're running an Emacs 18-style byte-compiled function, there
485 may be a frame for Fbytecode. Now, given the strictest
486 definition, this function isn't really being called
487 interactively, but because that's the way Emacs 18 always builds
488 byte-compiled functions, we'll accept it for now. */
489 if (EQ (*btp->function, Qbytecode))
490 btp = btp->next;
492 /* If this isn't a byte-compiled function, then we may now be
493 looking at several frames for special forms. Skip past them. */
494 while (btp &&
495 btp->nargs == UNEVALLED)
496 btp = btp->next;
498 /* btp now points at the frame of the innermost function that isn't
499 a special form, ignoring frames for Finteractive_p and/or
500 Fbytecode at the top. If this frame is for a built-in function
501 (such as load or eval-region) return nil. */
502 fun = Findirect_function (*btp->function);
503 if (XTYPE (fun) == Lisp_Subr)
504 return Qnil;
505 /* btp points to the frame of a Lisp function that called interactive-p.
506 Return t if that function was called interactively. */
507 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
508 return Qt;
509 return Qnil;
512 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
513 "(defun NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.\n\
514 The definition is (lambda ARGLIST [DOCSTRING] BODY...).\n\
515 See also the function `interactive'.")
516 (args)
517 Lisp_Object args;
519 register Lisp_Object fn_name;
520 register Lisp_Object defn;
522 fn_name = Fcar (args);
523 defn = Fcons (Qlambda, Fcdr (args));
524 if (!NILP (Vpurify_flag))
525 defn = Fpurecopy (defn);
526 Ffset (fn_name, defn);
527 LOADHIST_ATTACH (fn_name);
528 return fn_name;
531 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
532 "(defmacro NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro.\n\
533 The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).\n\
534 When the macro is called, as in (NAME ARGS...),\n\
535 the function (lambda ARGLIST BODY...) is applied to\n\
536 the list ARGS... as it appears in the expression,\n\
537 and the result should be a form to be evaluated instead of the original.")
538 (args)
539 Lisp_Object args;
541 register Lisp_Object fn_name;
542 register Lisp_Object defn;
544 fn_name = Fcar (args);
545 defn = Fcons (Qmacro, Fcons (Qlambda, Fcdr (args)));
546 if (!NILP (Vpurify_flag))
547 defn = Fpurecopy (defn);
548 Ffset (fn_name, defn);
549 LOADHIST_ATTACH (fn_name);
550 return fn_name;
553 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
554 "(defvar SYMBOL INITVALUE DOCSTRING): define SYMBOL as a variable.\n\
555 You are not required to define a variable in order to use it,\n\
556 but the definition can supply documentation and an initial value\n\
557 in a way that tags can recognize.\n\n\
558 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.\n\
559 If SYMBOL is buffer-local, its default value is what is set;\n\
560 buffer-local values are not affected.\n\
561 INITVALUE and DOCSTRING are optional.\n\
562 If DOCSTRING starts with *, this variable is identified as a user option.\n\
563 This means that M-x set-variable and M-x edit-options recognize it.\n\
564 If INITVALUE is missing, SYMBOL's value is not set.")
565 (args)
566 Lisp_Object args;
568 register Lisp_Object sym, tem;
570 sym = Fcar (args);
571 tem = Fcdr (args);
572 if (!NILP (tem))
574 tem = Fdefault_boundp (sym);
575 if (NILP (tem))
576 Fset_default (sym, Feval (Fcar (Fcdr (args))));
578 tem = Fcar (Fcdr (Fcdr (args)));
579 if (!NILP (tem))
581 if (!NILP (Vpurify_flag))
582 tem = Fpurecopy (tem);
583 Fput (sym, Qvariable_documentation, tem);
585 LOADHIST_ATTACH (sym);
586 return sym;
589 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
590 "(defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable.\n\
591 The intent is that programs do not change this value, but users may.\n\
592 Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\
593 If SYMBOL is buffer-local, its default value is what is set;\n\
594 buffer-local values are not affected.\n\
595 DOCSTRING is optional.\n\
596 If DOCSTRING starts with *, this variable is identified as a user option.\n\
597 This means that M-x set-variable and M-x edit-options recognize it.\n\n\
598 Note: do not use `defconst' for user options in libraries that are not\n\
599 normally loaded, since it is useful for users to be able to specify\n\
600 their own values for such variables before loading the library.\n\
601 Since `defconst' unconditionally assigns the variable,\n\
602 it would override the user's choice.")
603 (args)
604 Lisp_Object args;
606 register Lisp_Object sym, tem;
608 sym = Fcar (args);
609 Fset_default (sym, Feval (Fcar (Fcdr (args))));
610 tem = Fcar (Fcdr (Fcdr (args)));
611 if (!NILP (tem))
613 if (!NILP (Vpurify_flag))
614 tem = Fpurecopy (tem);
615 Fput (sym, Qvariable_documentation, tem);
617 LOADHIST_ATTACH (sym);
618 return sym;
621 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
622 "Returns t if VARIABLE is intended to be set and modified by users.\n\
623 \(The alternative is a variable used internally in a Lisp program.)\n\
624 Determined by whether the first character of the documentation\n\
625 for the variable is \"*\"")
626 (variable)
627 Lisp_Object variable;
629 Lisp_Object documentation;
631 documentation = Fget (variable, Qvariable_documentation);
632 if (XTYPE (documentation) == Lisp_Int && XINT (documentation) < 0)
633 return Qt;
634 if ((XTYPE (documentation) == Lisp_String) &&
635 ((unsigned char) XSTRING (documentation)->data[0] == '*'))
636 return Qt;
637 return Qnil;
640 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
641 "(let* VARLIST BODY...): bind variables according to VARLIST then eval BODY.\n\
642 The value of the last form in BODY is returned.\n\
643 Each element of VARLIST is a symbol (which is bound to nil)\n\
644 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
645 Each VALUEFORM can refer to the symbols already bound by this VARLIST.")
646 (args)
647 Lisp_Object args;
649 Lisp_Object varlist, val, elt;
650 int count = specpdl_ptr - specpdl;
651 struct gcpro gcpro1, gcpro2, gcpro3;
653 GCPRO3 (args, elt, varlist);
655 varlist = Fcar (args);
656 while (!NILP (varlist))
658 QUIT;
659 elt = Fcar (varlist);
660 if (XTYPE (elt) == Lisp_Symbol)
661 specbind (elt, Qnil);
662 else if (! NILP (Fcdr (Fcdr (elt))))
663 Fsignal (Qerror,
664 Fcons (build_string ("`let' bindings can have only one value-form"),
665 elt));
666 else
668 val = Feval (Fcar (Fcdr (elt)));
669 specbind (Fcar (elt), val);
671 varlist = Fcdr (varlist);
673 UNGCPRO;
674 val = Fprogn (Fcdr (args));
675 return unbind_to (count, val);
678 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
679 "(let VARLIST BODY...): bind variables according to VARLIST then eval BODY.\n\
680 The value of the last form in BODY is returned.\n\
681 Each element of VARLIST is a symbol (which is bound to nil)\n\
682 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
683 All the VALUEFORMs are evalled before any symbols are bound.")
684 (args)
685 Lisp_Object args;
687 Lisp_Object *temps, tem;
688 register Lisp_Object elt, varlist;
689 int count = specpdl_ptr - specpdl;
690 register int argnum;
691 struct gcpro gcpro1, gcpro2;
693 varlist = Fcar (args);
695 /* Make space to hold the values to give the bound variables */
696 elt = Flength (varlist);
697 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
699 /* Compute the values and store them in `temps' */
701 GCPRO2 (args, *temps);
702 gcpro2.nvars = 0;
704 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
706 QUIT;
707 elt = Fcar (varlist);
708 if (XTYPE (elt) == Lisp_Symbol)
709 temps [argnum++] = Qnil;
710 else if (! NILP (Fcdr (Fcdr (elt))))
711 Fsignal (Qerror,
712 Fcons (build_string ("`let' bindings can have only one value-form"),
713 elt));
714 else
715 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
716 gcpro2.nvars = argnum;
718 UNGCPRO;
720 varlist = Fcar (args);
721 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
723 elt = Fcar (varlist);
724 tem = temps[argnum++];
725 if (XTYPE (elt) == Lisp_Symbol)
726 specbind (elt, tem);
727 else
728 specbind (Fcar (elt), tem);
731 elt = Fprogn (Fcdr (args));
732 return unbind_to (count, elt);
735 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
736 "(while TEST BODY...): if TEST yields non-nil, eval BODY... and repeat.\n\
737 The order of execution is thus TEST, BODY, TEST, BODY and so on\n\
738 until TEST returns nil.")
739 (args)
740 Lisp_Object args;
742 Lisp_Object test, body, tem;
743 struct gcpro gcpro1, gcpro2;
745 GCPRO2 (test, body);
747 test = Fcar (args);
748 body = Fcdr (args);
749 while (tem = Feval (test), !NILP (tem))
751 QUIT;
752 Fprogn (body);
755 UNGCPRO;
756 return Qnil;
759 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
760 "Return result of expanding macros at top level of FORM.\n\
761 If FORM is not a macro call, it is returned unchanged.\n\
762 Otherwise, the macro is expanded and the expansion is considered\n\
763 in place of FORM. When a non-macro-call results, it is returned.\n\n\
764 The second optional arg ENVIRONMENT species an environment of macro\n\
765 definitions to shadow the loaded ones for use in file byte-compilation.")
766 (form, env)
767 register Lisp_Object form;
768 Lisp_Object env;
770 /* With cleanups from Hallvard Furuseth. */
771 register Lisp_Object expander, sym, def, tem;
773 while (1)
775 /* Come back here each time we expand a macro call,
776 in case it expands into another macro call. */
777 if (XTYPE (form) != Lisp_Cons)
778 break;
779 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
780 def = sym = XCONS (form)->car;
781 tem = Qnil;
782 /* Trace symbols aliases to other symbols
783 until we get a symbol that is not an alias. */
784 while (XTYPE (def) == Lisp_Symbol)
786 QUIT;
787 sym = def;
788 tem = Fassq (sym, env);
789 if (NILP (tem))
791 def = XSYMBOL (sym)->function;
792 if (!EQ (def, Qunbound))
793 continue;
795 break;
797 /* Right now TEM is the result from SYM in ENV,
798 and if TEM is nil then DEF is SYM's function definition. */
799 if (NILP (tem))
801 /* SYM is not mentioned in ENV.
802 Look at its function definition. */
803 if (EQ (def, Qunbound)
804 || XTYPE (def) != Lisp_Cons)
805 /* Not defined or definition not suitable */
806 break;
807 if (EQ (XCONS (def)->car, Qautoload))
809 /* Autoloading function: will it be a macro when loaded? */
810 tem = Fnth (make_number (4), def);
811 if (EQ (XCONS (tem)->car, Qt)
812 || EQ (XCONS (tem)->car, Qmacro))
813 /* Yes, load it and try again. */
815 do_autoload (def, sym);
816 continue;
818 else
819 break;
821 else if (!EQ (XCONS (def)->car, Qmacro))
822 break;
823 else expander = XCONS (def)->cdr;
825 else
827 expander = XCONS (tem)->cdr;
828 if (NILP (expander))
829 break;
831 form = apply1 (expander, XCONS (form)->cdr);
833 return form;
836 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
837 "(catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'.\n\
838 TAG is evalled to get the tag to use. Then the BODY is executed.\n\
839 Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.\n\
840 If no throw happens, `catch' returns the value of the last BODY form.\n\
841 If a throw happens, it specifies the value to return from `catch'.")
842 (args)
843 Lisp_Object args;
845 register Lisp_Object tag;
846 struct gcpro gcpro1;
848 GCPRO1 (args);
849 tag = Feval (Fcar (args));
850 UNGCPRO;
851 return internal_catch (tag, Fprogn, Fcdr (args));
854 /* Set up a catch, then call C function FUNC on argument ARG.
855 FUNC should return a Lisp_Object.
856 This is how catches are done from within C code. */
858 Lisp_Object
859 internal_catch (tag, func, arg)
860 Lisp_Object tag;
861 Lisp_Object (*func) ();
862 Lisp_Object arg;
864 /* This structure is made part of the chain `catchlist'. */
865 struct catchtag c;
867 /* Fill in the components of c, and put it on the list. */
868 c.next = catchlist;
869 c.tag = tag;
870 c.val = Qnil;
871 c.backlist = backtrace_list;
872 c.handlerlist = handlerlist;
873 c.lisp_eval_depth = lisp_eval_depth;
874 c.pdlcount = specpdl_ptr - specpdl;
875 c.poll_suppress_count = poll_suppress_count;
876 c.gcpro = gcprolist;
877 catchlist = &c;
879 /* Call FUNC. */
880 if (! _setjmp (c.jmp))
881 c.val = (*func) (arg);
883 /* Throw works by a longjmp that comes right here. */
884 catchlist = c.next;
885 return c.val;
888 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
889 jump to that CATCH, returning VALUE as the value of that catch.
891 This is the guts Fthrow and Fsignal; they differ only in the way
892 they choose the catch tag to throw to. A catch tag for a
893 condition-case form has a TAG of Qnil.
895 Before each catch is discarded, unbind all special bindings and
896 execute all unwind-protect clauses made above that catch. Unwind
897 the handler stack as we go, so that the proper handlers are in
898 effect for each unwind-protect clause we run. At the end, restore
899 some static info saved in CATCH, and longjmp to the location
900 specified in the
902 This is used for correct unwinding in Fthrow and Fsignal. */
904 static void
905 unwind_to_catch (catch, value)
906 struct catchtag *catch;
907 Lisp_Object value;
909 register int last_time;
911 /* Save the value in the tag. */
912 catch->val = value;
914 /* Restore the polling-suppression count. */
915 if (catch->poll_suppress_count > poll_suppress_count)
916 abort ();
917 while (catch->poll_suppress_count < poll_suppress_count)
918 start_polling ();
922 last_time = catchlist == catch;
924 /* Unwind the specpdl stack, and then restore the proper set of
925 handlers. */
926 unbind_to (catchlist->pdlcount, Qnil);
927 handlerlist = catchlist->handlerlist;
928 catchlist = catchlist->next;
930 while (! last_time);
932 gcprolist = catch->gcpro;
933 backtrace_list = catch->backlist;
934 lisp_eval_depth = catch->lisp_eval_depth;
936 _longjmp (catch->jmp, 1);
939 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
940 "(throw TAG VALUE): throw to the catch for TAG and return VALUE from it.\n\
941 Both TAG and VALUE are evalled.")
942 (tag, val)
943 register Lisp_Object tag, val;
945 register struct catchtag *c;
947 while (1)
949 if (!NILP (tag))
950 for (c = catchlist; c; c = c->next)
952 if (EQ (c->tag, tag))
953 unwind_to_catch (c, val);
955 tag = Fsignal (Qno_catch, Fcons (tag, Fcons (val, Qnil)));
960 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
961 "Do BODYFORM, protecting with UNWINDFORMS.\n\
962 Usage looks like (unwind-protect BODYFORM UNWINDFORMS...).\n\
963 If BODYFORM completes normally, its value is returned\n\
964 after executing the UNWINDFORMS.\n\
965 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.")
966 (args)
967 Lisp_Object args;
969 Lisp_Object val;
970 int count = specpdl_ptr - specpdl;
972 record_unwind_protect (0, Fcdr (args));
973 val = Feval (Fcar (args));
974 return unbind_to (count, val);
977 /* Chain of condition handlers currently in effect.
978 The elements of this chain are contained in the stack frames
979 of Fcondition_case and internal_condition_case.
980 When an error is signaled (by calling Fsignal, below),
981 this chain is searched for an element that applies. */
983 struct handler *handlerlist;
985 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
986 "Regain control when an error is signaled.\n\
987 Usage looks like (condition-case VAR BODYFORM HANDLERS...).\n\
988 executes BODYFORM and returns its value if no error happens.\n\
989 Each element of HANDLERS looks like (CONDITION-NAME BODY...)\n\
990 where the BODY is made of Lisp expressions.\n\n\
991 A handler is applicable to an error\n\
992 if CONDITION-NAME is one of the error's condition names.\n\
993 If an error happens, the first applicable handler is run.\n\
995 When a handler handles an error,\n\
996 control returns to the condition-case and the handler BODY... is executed\n\
997 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).\n\
998 VAR may be nil; then you do not get access to the signal information.\n\
1000 The value of the last BODY form is returned from the condition-case.\n\
1001 See also the function `signal' for more info.")
1002 (args)
1003 Lisp_Object args;
1005 Lisp_Object val;
1006 struct catchtag c;
1007 struct handler h;
1008 register Lisp_Object var, bodyform, handlers;
1010 var = Fcar (args);
1011 bodyform = Fcar (Fcdr (args));
1012 handlers = Fcdr (Fcdr (args));
1013 CHECK_SYMBOL (var, 0);
1015 for (val = handlers; ! NILP (val); val = Fcdr (val))
1017 Lisp_Object tem;
1018 tem = Fcar (val);
1019 if ((!NILP (tem)) &&
1020 (!CONSP (tem) || (XTYPE (XCONS (tem)->car) != Lisp_Symbol)))
1021 error ("Invalid condition handler", tem);
1024 c.tag = Qnil;
1025 c.val = Qnil;
1026 c.backlist = backtrace_list;
1027 c.handlerlist = handlerlist;
1028 c.lisp_eval_depth = lisp_eval_depth;
1029 c.pdlcount = specpdl_ptr - specpdl;
1030 c.poll_suppress_count = poll_suppress_count;
1031 c.gcpro = gcprolist;
1032 if (_setjmp (c.jmp))
1034 if (!NILP (h.var))
1035 specbind (h.var, Fcdr (c.val));
1036 val = Fprogn (Fcdr (Fcar (c.val)));
1038 /* Note that this just undoes the binding of h.var; whoever
1039 longjumped to us unwound the stack to c.pdlcount before
1040 throwing. */
1041 unbind_to (c.pdlcount, Qnil);
1042 return val;
1044 c.next = catchlist;
1045 catchlist = &c;
1047 h.var = var;
1048 h.handler = handlers;
1049 h.next = handlerlist;
1050 h.tag = &c;
1051 handlerlist = &h;
1053 val = Feval (bodyform);
1054 catchlist = c.next;
1055 handlerlist = h.next;
1056 return val;
1059 Lisp_Object
1060 internal_condition_case (bfun, handlers, hfun)
1061 Lisp_Object (*bfun) ();
1062 Lisp_Object handlers;
1063 Lisp_Object (*hfun) ();
1065 Lisp_Object val;
1066 struct catchtag c;
1067 struct handler h;
1069 c.tag = Qnil;
1070 c.val = Qnil;
1071 c.backlist = backtrace_list;
1072 c.handlerlist = handlerlist;
1073 c.lisp_eval_depth = lisp_eval_depth;
1074 c.pdlcount = specpdl_ptr - specpdl;
1075 c.poll_suppress_count = poll_suppress_count;
1076 c.gcpro = gcprolist;
1077 if (_setjmp (c.jmp))
1079 return (*hfun) (Fcdr (c.val));
1081 c.next = catchlist;
1082 catchlist = &c;
1083 h.handler = handlers;
1084 h.var = Qnil;
1085 h.next = handlerlist;
1086 h.tag = &c;
1087 handlerlist = &h;
1089 val = (*bfun) ();
1090 catchlist = c.next;
1091 handlerlist = h.next;
1092 return val;
1095 static Lisp_Object find_handler_clause ();
1097 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1098 "Signal an error. Args are SIGNAL-NAME, and associated DATA.\n\
1099 This function does not return.\n\n\
1100 A signal name is a symbol with an `error-conditions' property\n\
1101 that is a list of condition names.\n\
1102 A handler for any of those names will get to handle this signal.\n\
1103 The symbol `error' should normally be one of them.\n\
1105 DATA should be a list. Its elements are printed as part of the error message.\n\
1106 If the signal is handled, DATA is made available to the handler.\n\
1107 See also the function `condition-case'.")
1108 (sig, data)
1109 Lisp_Object sig, data;
1111 register struct handler *allhandlers = handlerlist;
1112 Lisp_Object conditions;
1113 extern int gc_in_progress;
1114 extern int waiting_for_input;
1115 Lisp_Object debugger_value;
1117 quit_error_check ();
1118 immediate_quit = 0;
1119 if (gc_in_progress || waiting_for_input)
1120 abort ();
1122 #ifdef HAVE_X_WINDOWS
1123 TOTALLY_UNBLOCK_INPUT;
1124 #endif
1126 conditions = Fget (sig, Qerror_conditions);
1128 for (; handlerlist; handlerlist = handlerlist->next)
1130 register Lisp_Object clause;
1131 clause = find_handler_clause (handlerlist->handler, conditions,
1132 sig, data, &debugger_value);
1134 #if 0 /* Most callers are not prepared to handle gc if this returns.
1135 So, since this feature is not very useful, take it out. */
1136 /* If have called debugger and user wants to continue,
1137 just return nil. */
1138 if (EQ (clause, Qlambda))
1139 return debugger_value;
1140 #else
1141 if (EQ (clause, Qlambda))
1143 /* We can't return values to code which signalled an error, but we
1144 can continue code which has signalled a quit. */
1145 if (EQ (sig, Qquit))
1146 return Qnil;
1147 else
1148 error ("Cannot return from the debugger in an error");
1150 #endif
1152 if (!NILP (clause))
1154 struct handler *h = handlerlist;
1155 handlerlist = allhandlers;
1156 unwind_to_catch (h->tag, Fcons (clause, Fcons (sig, data)));
1160 handlerlist = allhandlers;
1161 /* If no handler is present now, try to run the debugger,
1162 and if that fails, throw to top level. */
1163 find_handler_clause (Qerror, conditions, sig, data, &debugger_value);
1164 Fthrow (Qtop_level, Qt);
1167 /* Return nonzero iff LIST is a non-nil atom or
1168 a list containing one of CONDITIONS. */
1170 static int
1171 wants_debugger (list, conditions)
1172 Lisp_Object list, conditions;
1174 if (NILP (list))
1175 return 0;
1176 if (! CONSP (list))
1177 return 1;
1179 while (CONSP (conditions))
1181 Lisp_Object this, tail;
1182 this = XCONS (conditions)->car;
1183 for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
1184 if (EQ (XCONS (tail)->car, this))
1185 return 1;
1186 conditions = XCONS (conditions)->cdr;
1188 return 0;
1191 /* Value of Qlambda means we have called debugger and user has continued.
1192 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1194 static Lisp_Object
1195 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1196 Lisp_Object handlers, conditions, sig, data;
1197 Lisp_Object *debugger_value_ptr;
1199 register Lisp_Object h;
1200 register Lisp_Object tem;
1201 register Lisp_Object tem1;
1203 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1204 return Qt;
1205 if (EQ (handlers, Qerror)) /* error is used similarly, but means display a backtrace too */
1207 if (wants_debugger (Vstack_trace_on_error, conditions))
1208 internal_with_output_to_temp_buffer ("*Backtrace*", Fbacktrace, Qnil);
1209 if ((EQ (sig, Qquit)
1210 ? debug_on_quit
1211 : wants_debugger (Vdebug_on_error, conditions))
1212 && when_entered_debugger < num_nonmacro_input_chars)
1214 int count = specpdl_ptr - specpdl;
1215 specbind (Qdebug_on_error, Qnil);
1216 *debugger_value_ptr =
1217 call_debugger (Fcons (Qerror,
1218 Fcons (Fcons (sig, data),
1219 Qnil)));
1220 return unbind_to (count, Qlambda);
1222 return Qt;
1224 for (h = handlers; CONSP (h); h = Fcdr (h))
1226 tem1 = Fcar (h);
1227 if (!CONSP (tem1))
1228 continue;
1229 tem = Fmemq (Fcar (tem1), conditions);
1230 if (!NILP (tem))
1231 return tem1;
1233 return Qnil;
1236 /* dump an error message; called like printf */
1238 /* VARARGS 1 */
1239 void
1240 error (m, a1, a2, a3)
1241 char *m;
1243 char buf[200];
1244 sprintf (buf, m, a1, a2, a3);
1246 while (1)
1247 Fsignal (Qerror, Fcons (build_string (buf), Qnil));
1250 DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0,
1251 "T if FUNCTION makes provisions for interactive calling.\n\
1252 This means it contains a description for how to read arguments to give it.\n\
1253 The value is nil for an invalid function or a symbol with no function\n\
1254 definition.\n\
1256 Interactively callable functions include strings and vectors (treated\n\
1257 as keyboard macros), lambda-expressions that contain a top-level call\n\
1258 to `interactive', autoload definitions made by `autoload' with non-nil\n\
1259 fourth argument, and some of the built-in functions of Lisp.\n\
1261 Also, a symbol satisfies `commandp' if its function definition does so.")
1262 (function)
1263 Lisp_Object function;
1265 register Lisp_Object fun;
1266 register Lisp_Object funcar;
1267 register Lisp_Object tem;
1268 register int i = 0;
1270 fun = function;
1272 fun = indirect_function (fun);
1273 if (EQ (fun, Qunbound))
1274 return Qnil;
1276 /* Emacs primitives are interactive if their DEFUN specifies an
1277 interactive spec. */
1278 if (XTYPE (fun) == Lisp_Subr)
1280 if (XSUBR (fun)->prompt)
1281 return Qt;
1282 else
1283 return Qnil;
1286 /* Bytecode objects are interactive if they are long enough to
1287 have an element whose index is COMPILED_INTERACTIVE, which is
1288 where the interactive spec is stored. */
1289 else if (XTYPE (fun) == Lisp_Compiled)
1290 return (XVECTOR (fun)->size > COMPILED_INTERACTIVE
1291 ? Qt : Qnil);
1293 /* Strings and vectors are keyboard macros. */
1294 if (XTYPE (fun) == Lisp_String
1295 || XTYPE (fun) == Lisp_Vector)
1296 return Qt;
1298 /* Lists may represent commands. */
1299 if (!CONSP (fun))
1300 return Qnil;
1301 funcar = Fcar (fun);
1302 if (XTYPE (funcar) != Lisp_Symbol)
1303 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1304 if (EQ (funcar, Qlambda))
1305 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1306 if (EQ (funcar, Qmocklisp))
1307 return Qt; /* All mocklisp functions can be called interactively */
1308 if (EQ (funcar, Qautoload))
1309 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1310 else
1311 return Qnil;
1314 /* ARGSUSED */
1315 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1316 "Define FUNCTION to autoload from FILE.\n\
1317 FUNCTION is a symbol; FILE is a file name string to pass to `load'.\n\
1318 Third arg DOCSTRING is documentation for the function.\n\
1319 Fourth arg INTERACTIVE if non-nil says function can be called interactively.\n\
1320 Fifth arg TYPE indicates the type of the object:\n\
1321 nil or omitted says FUNCTION is a function,\n\
1322 `keymap' says FUNCTION is really a keymap, and\n\
1323 `macro' or t says FUNCTION is really a macro.\n\
1324 Third through fifth args give info about the real definition.\n\
1325 They default to nil.\n\
1326 If FUNCTION is already defined other than as an autoload,\n\
1327 this does nothing and returns nil.")
1328 (function, file, docstring, interactive, type)
1329 Lisp_Object function, file, docstring, interactive, type;
1331 #ifdef NO_ARG_ARRAY
1332 Lisp_Object args[4];
1333 #endif
1335 CHECK_SYMBOL (function, 0);
1336 CHECK_STRING (file, 1);
1338 /* If function is defined and not as an autoload, don't override */
1339 if (!EQ (XSYMBOL (function)->function, Qunbound)
1340 && !(XTYPE (XSYMBOL (function)->function) == Lisp_Cons
1341 && EQ (XCONS (XSYMBOL (function)->function)->car, Qautoload)))
1342 return Qnil;
1344 #ifdef NO_ARG_ARRAY
1345 args[0] = file;
1346 args[1] = docstring;
1347 args[2] = interactive;
1348 args[3] = type;
1350 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1351 #else /* NO_ARG_ARRAY */
1352 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1353 #endif /* not NO_ARG_ARRAY */
1356 Lisp_Object
1357 un_autoload (oldqueue)
1358 Lisp_Object oldqueue;
1360 register Lisp_Object queue, first, second;
1362 /* Queue to unwind is current value of Vautoload_queue.
1363 oldqueue is the shadowed value to leave in Vautoload_queue. */
1364 queue = Vautoload_queue;
1365 Vautoload_queue = oldqueue;
1366 while (CONSP (queue))
1368 first = Fcar (queue);
1369 second = Fcdr (first);
1370 first = Fcar (first);
1371 if (EQ (second, Qnil))
1372 Vfeatures = first;
1373 else
1374 Ffset (first, second);
1375 queue = Fcdr (queue);
1377 return Qnil;
1380 do_autoload (fundef, funname)
1381 Lisp_Object fundef, funname;
1383 int count = specpdl_ptr - specpdl;
1384 Lisp_Object fun, val, queue, first, second;
1386 fun = funname;
1387 CHECK_SYMBOL (funname, 0);
1389 /* Value saved here is to be restored into Vautoload_queue */
1390 record_unwind_protect (un_autoload, Vautoload_queue);
1391 Vautoload_queue = Qt;
1392 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil);
1394 /* Save the old autoloads, in case we ever do an unload. */
1395 queue = Vautoload_queue;
1396 while (CONSP (queue))
1398 first = Fcar (queue);
1399 second = Fcdr (first);
1400 first = Fcar (first);
1402 /* Note: This test is subtle. The cdr of an autoload-queue entry
1403 may be an atom if the autoload entry was generated by a defalias
1404 or fset. */
1405 if (CONSP (second))
1406 Fput(first, Qautoload, (Fcdr (second)));
1408 queue = Fcdr (queue);
1411 /* Once loading finishes, don't undo it. */
1412 Vautoload_queue = Qt;
1413 unbind_to (count, Qnil);
1415 fun = Findirect_function (fun);
1417 if (XTYPE (fun) == Lisp_Cons
1418 && EQ (XCONS (fun)->car, Qautoload))
1419 error ("Autoloading failed to define function %s",
1420 XSYMBOL (funname)->name->data);
1423 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1424 "Evaluate FORM and return its value.")
1425 (form)
1426 Lisp_Object form;
1428 Lisp_Object fun, val, original_fun, original_args;
1429 Lisp_Object funcar;
1430 struct backtrace backtrace;
1431 struct gcpro gcpro1, gcpro2, gcpro3;
1433 if (XTYPE (form) == Lisp_Symbol)
1435 if (EQ (Vmocklisp_arguments, Qt))
1436 return Fsymbol_value (form);
1437 val = Fsymbol_value (form);
1438 if (NILP (val))
1439 XFASTINT (val) = 0;
1440 else if (EQ (val, Qt))
1441 XFASTINT (val) = 1;
1442 return val;
1444 if (!CONSP (form))
1445 return form;
1447 QUIT;
1448 if (consing_since_gc > gc_cons_threshold)
1450 GCPRO1 (form);
1451 Fgarbage_collect ();
1452 UNGCPRO;
1455 if (++lisp_eval_depth > max_lisp_eval_depth)
1457 if (max_lisp_eval_depth < 100)
1458 max_lisp_eval_depth = 100;
1459 if (lisp_eval_depth > max_lisp_eval_depth)
1460 error ("Lisp nesting exceeds max-lisp-eval-depth");
1463 original_fun = Fcar (form);
1464 original_args = Fcdr (form);
1466 backtrace.next = backtrace_list;
1467 backtrace_list = &backtrace;
1468 backtrace.function = &original_fun; /* This also protects them from gc */
1469 backtrace.args = &original_args;
1470 backtrace.nargs = UNEVALLED;
1471 backtrace.evalargs = 1;
1472 backtrace.debug_on_exit = 0;
1474 if (debug_on_next_call)
1475 do_debug_on_call (Qt);
1477 /* At this point, only original_fun and original_args
1478 have values that will be used below */
1479 retry:
1480 fun = Findirect_function (original_fun);
1482 if (XTYPE (fun) == Lisp_Subr)
1484 Lisp_Object numargs;
1485 Lisp_Object argvals[7];
1486 Lisp_Object args_left;
1487 register int i, maxargs;
1489 args_left = original_args;
1490 numargs = Flength (args_left);
1492 if (XINT (numargs) < XSUBR (fun)->min_args ||
1493 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
1494 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
1496 if (XSUBR (fun)->max_args == UNEVALLED)
1498 backtrace.evalargs = 0;
1499 val = (*XSUBR (fun)->function) (args_left);
1500 goto done;
1503 if (XSUBR (fun)->max_args == MANY)
1505 /* Pass a vector of evaluated arguments */
1506 Lisp_Object *vals;
1507 register int argnum = 0;
1509 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
1511 GCPRO3 (args_left, fun, fun);
1512 gcpro3.var = vals;
1513 gcpro3.nvars = 0;
1515 while (!NILP (args_left))
1517 vals[argnum++] = Feval (Fcar (args_left));
1518 args_left = Fcdr (args_left);
1519 gcpro3.nvars = argnum;
1522 backtrace.args = vals;
1523 backtrace.nargs = XINT (numargs);
1525 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
1526 UNGCPRO;
1527 goto done;
1530 GCPRO3 (args_left, fun, fun);
1531 gcpro3.var = argvals;
1532 gcpro3.nvars = 0;
1534 maxargs = XSUBR (fun)->max_args;
1535 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
1537 argvals[i] = Feval (Fcar (args_left));
1538 gcpro3.nvars = ++i;
1541 UNGCPRO;
1543 backtrace.args = argvals;
1544 backtrace.nargs = XINT (numargs);
1546 switch (i)
1548 case 0:
1549 val = (*XSUBR (fun)->function) ();
1550 goto done;
1551 case 1:
1552 val = (*XSUBR (fun)->function) (argvals[0]);
1553 goto done;
1554 case 2:
1555 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
1556 goto done;
1557 case 3:
1558 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1559 argvals[2]);
1560 goto done;
1561 case 4:
1562 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1563 argvals[2], argvals[3]);
1564 goto done;
1565 case 5:
1566 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1567 argvals[3], argvals[4]);
1568 goto done;
1569 case 6:
1570 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1571 argvals[3], argvals[4], argvals[5]);
1572 goto done;
1573 case 7:
1574 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1575 argvals[3], argvals[4], argvals[5],
1576 argvals[6]);
1577 goto done;
1579 default:
1580 /* Someone has created a subr that takes more arguments than
1581 is supported by this code. We need to either rewrite the
1582 subr to use a different argument protocol, or add more
1583 cases to this switch. */
1584 abort ();
1587 if (XTYPE (fun) == Lisp_Compiled)
1588 val = apply_lambda (fun, original_args, 1);
1589 else
1591 if (!CONSP (fun))
1592 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1593 funcar = Fcar (fun);
1594 if (XTYPE (funcar) != Lisp_Symbol)
1595 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1596 if (EQ (funcar, Qautoload))
1598 do_autoload (fun, original_fun);
1599 goto retry;
1601 if (EQ (funcar, Qmacro))
1602 val = Feval (apply1 (Fcdr (fun), original_args));
1603 else if (EQ (funcar, Qlambda))
1604 val = apply_lambda (fun, original_args, 1);
1605 else if (EQ (funcar, Qmocklisp))
1606 val = ml_apply (fun, original_args);
1607 else
1608 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1610 done:
1611 if (!EQ (Vmocklisp_arguments, Qt))
1613 if (NILP (val))
1614 XFASTINT (val) = 0;
1615 else if (EQ (val, Qt))
1616 XFASTINT (val) = 1;
1618 lisp_eval_depth--;
1619 if (backtrace.debug_on_exit)
1620 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
1621 backtrace_list = backtrace.next;
1622 return val;
1625 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
1626 "Call FUNCTION with our remaining args, using our last arg as list of args.\n\
1627 Thus, (apply '+ 1 2 '(3 4)) returns 10.")
1628 (nargs, args)
1629 int nargs;
1630 Lisp_Object *args;
1632 register int i, numargs;
1633 register Lisp_Object spread_arg;
1634 register Lisp_Object *funcall_args;
1635 Lisp_Object fun;
1636 struct gcpro gcpro1;
1638 fun = args [0];
1639 funcall_args = 0;
1640 spread_arg = args [nargs - 1];
1641 CHECK_LIST (spread_arg, nargs);
1643 numargs = XINT (Flength (spread_arg));
1645 if (numargs == 0)
1646 return Ffuncall (nargs - 1, args);
1647 else if (numargs == 1)
1649 args [nargs - 1] = XCONS (spread_arg)->car;
1650 return Ffuncall (nargs, args);
1653 numargs += nargs - 2;
1655 fun = indirect_function (fun);
1656 if (EQ (fun, Qunbound))
1658 /* Let funcall get the error */
1659 fun = args[0];
1660 goto funcall;
1663 if (XTYPE (fun) == Lisp_Subr)
1665 if (numargs < XSUBR (fun)->min_args
1666 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
1667 goto funcall; /* Let funcall get the error */
1668 else if (XSUBR (fun)->max_args > numargs)
1670 /* Avoid making funcall cons up a yet another new vector of arguments
1671 by explicitly supplying nil's for optional values */
1672 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
1673 * sizeof (Lisp_Object));
1674 for (i = numargs; i < XSUBR (fun)->max_args;)
1675 funcall_args[++i] = Qnil;
1676 GCPRO1 (*funcall_args);
1677 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
1680 funcall:
1681 /* We add 1 to numargs because funcall_args includes the
1682 function itself as well as its arguments. */
1683 if (!funcall_args)
1685 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
1686 * sizeof (Lisp_Object));
1687 GCPRO1 (*funcall_args);
1688 gcpro1.nvars = 1 + numargs;
1691 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
1692 /* Spread the last arg we got. Its first element goes in
1693 the slot that it used to occupy, hence this value of I. */
1694 i = nargs - 1;
1695 while (!NILP (spread_arg))
1697 funcall_args [i++] = XCONS (spread_arg)->car;
1698 spread_arg = XCONS (spread_arg)->cdr;
1701 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
1704 /* Apply fn to arg */
1705 Lisp_Object
1706 apply1 (fn, arg)
1707 Lisp_Object fn, arg;
1709 struct gcpro gcpro1;
1711 GCPRO1 (fn);
1712 if (NILP (arg))
1713 RETURN_UNGCPRO (Ffuncall (1, &fn));
1714 gcpro1.nvars = 2;
1715 #ifdef NO_ARG_ARRAY
1717 Lisp_Object args[2];
1718 args[0] = fn;
1719 args[1] = arg;
1720 gcpro1.var = args;
1721 RETURN_UNGCPRO (Fapply (2, args));
1723 #else /* not NO_ARG_ARRAY */
1724 RETURN_UNGCPRO (Fapply (2, &fn));
1725 #endif /* not NO_ARG_ARRAY */
1728 /* Call function fn on no arguments */
1729 Lisp_Object
1730 call0 (fn)
1731 Lisp_Object fn;
1733 struct gcpro gcpro1;
1735 GCPRO1 (fn);
1736 RETURN_UNGCPRO (Ffuncall (1, &fn));
1739 /* Call function fn with 1 argument arg1 */
1740 /* ARGSUSED */
1741 Lisp_Object
1742 call1 (fn, arg1)
1743 Lisp_Object fn, arg1;
1745 struct gcpro gcpro1;
1746 #ifdef NO_ARG_ARRAY
1747 Lisp_Object args[2];
1749 args[0] = fn;
1750 args[1] = arg1;
1751 GCPRO1 (args[0]);
1752 gcpro1.nvars = 2;
1753 RETURN_UNGCPRO (Ffuncall (2, args));
1754 #else /* not NO_ARG_ARRAY */
1755 GCPRO1 (fn);
1756 gcpro1.nvars = 2;
1757 RETURN_UNGCPRO (Ffuncall (2, &fn));
1758 #endif /* not NO_ARG_ARRAY */
1761 /* Call function fn with 2 arguments arg1, arg2 */
1762 /* ARGSUSED */
1763 Lisp_Object
1764 call2 (fn, arg1, arg2)
1765 Lisp_Object fn, arg1, arg2;
1767 struct gcpro gcpro1;
1768 #ifdef NO_ARG_ARRAY
1769 Lisp_Object args[3];
1770 args[0] = fn;
1771 args[1] = arg1;
1772 args[2] = arg2;
1773 GCPRO1 (args[0]);
1774 gcpro1.nvars = 3;
1775 RETURN_UNGCPRO (Ffuncall (3, args));
1776 #else /* not NO_ARG_ARRAY */
1777 GCPRO1 (fn);
1778 gcpro1.nvars = 3;
1779 RETURN_UNGCPRO (Ffuncall (3, &fn));
1780 #endif /* not NO_ARG_ARRAY */
1783 /* Call function fn with 3 arguments arg1, arg2, arg3 */
1784 /* ARGSUSED */
1785 Lisp_Object
1786 call3 (fn, arg1, arg2, arg3)
1787 Lisp_Object fn, arg1, arg2, arg3;
1789 struct gcpro gcpro1;
1790 #ifdef NO_ARG_ARRAY
1791 Lisp_Object args[4];
1792 args[0] = fn;
1793 args[1] = arg1;
1794 args[2] = arg2;
1795 args[3] = arg3;
1796 GCPRO1 (args[0]);
1797 gcpro1.nvars = 4;
1798 RETURN_UNGCPRO (Ffuncall (4, args));
1799 #else /* not NO_ARG_ARRAY */
1800 GCPRO1 (fn);
1801 gcpro1.nvars = 4;
1802 RETURN_UNGCPRO (Ffuncall (4, &fn));
1803 #endif /* not NO_ARG_ARRAY */
1806 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
1807 /* ARGSUSED */
1808 Lisp_Object
1809 call4 (fn, arg1, arg2, arg3, arg4)
1810 Lisp_Object fn, arg1, arg2, arg3, arg4;
1812 struct gcpro gcpro1;
1813 #ifdef NO_ARG_ARRAY
1814 Lisp_Object args[5];
1815 args[0] = fn;
1816 args[1] = arg1;
1817 args[2] = arg2;
1818 args[3] = arg3;
1819 args[4] = arg4;
1820 GCPRO1 (args[0]);
1821 gcpro1.nvars = 5;
1822 RETURN_UNGCPRO (Ffuncall (5, args));
1823 #else /* not NO_ARG_ARRAY */
1824 GCPRO1 (fn);
1825 gcpro1.nvars = 5;
1826 RETURN_UNGCPRO (Ffuncall (5, &fn));
1827 #endif /* not NO_ARG_ARRAY */
1830 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
1831 /* ARGSUSED */
1832 Lisp_Object
1833 call5 (fn, arg1, arg2, arg3, arg4, arg5)
1834 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
1836 struct gcpro gcpro1;
1837 #ifdef NO_ARG_ARRAY
1838 Lisp_Object args[6];
1839 args[0] = fn;
1840 args[1] = arg1;
1841 args[2] = arg2;
1842 args[3] = arg3;
1843 args[4] = arg4;
1844 args[5] = arg5;
1845 GCPRO1 (args[0]);
1846 gcpro1.nvars = 6;
1847 RETURN_UNGCPRO (Ffuncall (6, args));
1848 #else /* not NO_ARG_ARRAY */
1849 GCPRO1 (fn);
1850 gcpro1.nvars = 6;
1851 RETURN_UNGCPRO (Ffuncall (6, &fn));
1852 #endif /* not NO_ARG_ARRAY */
1855 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
1856 /* ARGSUSED */
1857 Lisp_Object
1858 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
1859 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
1861 struct gcpro gcpro1;
1862 #ifdef NO_ARG_ARRAY
1863 Lisp_Object args[7];
1864 args[0] = fn;
1865 args[1] = arg1;
1866 args[2] = arg2;
1867 args[3] = arg3;
1868 args[4] = arg4;
1869 args[5] = arg5;
1870 args[6] = arg6;
1871 GCPRO1 (args[0]);
1872 gcpro1.nvars = 7;
1873 RETURN_UNGCPRO (Ffuncall (7, args));
1874 #else /* not NO_ARG_ARRAY */
1875 GCPRO1 (fn);
1876 gcpro1.nvars = 7;
1877 RETURN_UNGCPRO (Ffuncall (7, &fn));
1878 #endif /* not NO_ARG_ARRAY */
1881 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
1882 "Call first argument as a function, passing remaining arguments to it.\n\
1883 Thus, (funcall 'cons 'x 'y) returns (x . y).")
1884 (nargs, args)
1885 int nargs;
1886 Lisp_Object *args;
1888 Lisp_Object fun;
1889 Lisp_Object funcar;
1890 int numargs = nargs - 1;
1891 Lisp_Object lisp_numargs;
1892 Lisp_Object val;
1893 struct backtrace backtrace;
1894 register Lisp_Object *internal_args;
1895 register int i;
1897 QUIT;
1898 if (consing_since_gc > gc_cons_threshold)
1899 Fgarbage_collect ();
1901 if (++lisp_eval_depth > max_lisp_eval_depth)
1903 if (max_lisp_eval_depth < 100)
1904 max_lisp_eval_depth = 100;
1905 if (lisp_eval_depth > max_lisp_eval_depth)
1906 error ("Lisp nesting exceeds max-lisp-eval-depth");
1909 backtrace.next = backtrace_list;
1910 backtrace_list = &backtrace;
1911 backtrace.function = &args[0];
1912 backtrace.args = &args[1];
1913 backtrace.nargs = nargs - 1;
1914 backtrace.evalargs = 0;
1915 backtrace.debug_on_exit = 0;
1917 if (debug_on_next_call)
1918 do_debug_on_call (Qlambda);
1920 retry:
1922 fun = args[0];
1924 fun = Findirect_function (fun);
1926 if (XTYPE (fun) == Lisp_Subr)
1928 if (numargs < XSUBR (fun)->min_args
1929 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
1931 XFASTINT (lisp_numargs) = numargs;
1932 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
1935 if (XSUBR (fun)->max_args == UNEVALLED)
1936 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1938 if (XSUBR (fun)->max_args == MANY)
1940 val = (*XSUBR (fun)->function) (numargs, args + 1);
1941 goto done;
1944 if (XSUBR (fun)->max_args > numargs)
1946 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
1947 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
1948 for (i = numargs; i < XSUBR (fun)->max_args; i++)
1949 internal_args[i] = Qnil;
1951 else
1952 internal_args = args + 1;
1953 switch (XSUBR (fun)->max_args)
1955 case 0:
1956 val = (*XSUBR (fun)->function) ();
1957 goto done;
1958 case 1:
1959 val = (*XSUBR (fun)->function) (internal_args[0]);
1960 goto done;
1961 case 2:
1962 val = (*XSUBR (fun)->function) (internal_args[0],
1963 internal_args[1]);
1964 goto done;
1965 case 3:
1966 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
1967 internal_args[2]);
1968 goto done;
1969 case 4:
1970 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
1971 internal_args[2],
1972 internal_args[3]);
1973 goto done;
1974 case 5:
1975 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
1976 internal_args[2], internal_args[3],
1977 internal_args[4]);
1978 goto done;
1979 case 6:
1980 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
1981 internal_args[2], internal_args[3],
1982 internal_args[4], internal_args[5]);
1983 goto done;
1984 case 7:
1985 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
1986 internal_args[2], internal_args[3],
1987 internal_args[4], internal_args[5],
1988 internal_args[6]);
1989 goto done;
1991 default:
1993 /* If a subr takes more than 6 arguments without using MANY
1994 or UNEVALLED, we need to extend this function to support it.
1995 Until this is done, there is no way to call the function. */
1996 abort ();
1999 if (XTYPE (fun) == Lisp_Compiled)
2000 val = funcall_lambda (fun, numargs, args + 1);
2001 else
2003 if (!CONSP (fun))
2004 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2005 funcar = Fcar (fun);
2006 if (XTYPE (funcar) != Lisp_Symbol)
2007 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2008 if (EQ (funcar, Qlambda))
2009 val = funcall_lambda (fun, numargs, args + 1);
2010 else if (EQ (funcar, Qmocklisp))
2011 val = ml_apply (fun, Flist (numargs, args + 1));
2012 else if (EQ (funcar, Qautoload))
2014 do_autoload (fun, args[0]);
2015 goto retry;
2017 else
2018 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2020 done:
2021 lisp_eval_depth--;
2022 if (backtrace.debug_on_exit)
2023 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2024 backtrace_list = backtrace.next;
2025 return val;
2028 Lisp_Object
2029 apply_lambda (fun, args, eval_flag)
2030 Lisp_Object fun, args;
2031 int eval_flag;
2033 Lisp_Object args_left;
2034 Lisp_Object numargs;
2035 register Lisp_Object *arg_vector;
2036 struct gcpro gcpro1, gcpro2, gcpro3;
2037 register int i;
2038 register Lisp_Object tem;
2040 numargs = Flength (args);
2041 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2042 args_left = args;
2044 GCPRO3 (*arg_vector, args_left, fun);
2045 gcpro1.nvars = 0;
2047 for (i = 0; i < XINT (numargs);)
2049 tem = Fcar (args_left), args_left = Fcdr (args_left);
2050 if (eval_flag) tem = Feval (tem);
2051 arg_vector[i++] = tem;
2052 gcpro1.nvars = i;
2055 UNGCPRO;
2057 if (eval_flag)
2059 backtrace_list->args = arg_vector;
2060 backtrace_list->nargs = i;
2062 backtrace_list->evalargs = 0;
2063 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2065 /* Do the debug-on-exit now, while arg_vector still exists. */
2066 if (backtrace_list->debug_on_exit)
2067 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2068 /* Don't do it again when we return to eval. */
2069 backtrace_list->debug_on_exit = 0;
2070 return tem;
2073 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2074 and return the result of evaluation.
2075 FUN must be either a lambda-expression or a compiled-code object. */
2077 Lisp_Object
2078 funcall_lambda (fun, nargs, arg_vector)
2079 Lisp_Object fun;
2080 int nargs;
2081 register Lisp_Object *arg_vector;
2083 Lisp_Object val, tem;
2084 register Lisp_Object syms_left;
2085 Lisp_Object numargs;
2086 register Lisp_Object next;
2087 int count = specpdl_ptr - specpdl;
2088 register int i;
2089 int optional = 0, rest = 0;
2091 specbind (Qmocklisp_arguments, Qt); /* t means NOT mocklisp! */
2093 XFASTINT (numargs) = nargs;
2095 if (XTYPE (fun) == Lisp_Cons)
2096 syms_left = Fcar (Fcdr (fun));
2097 else if (XTYPE (fun) == Lisp_Compiled)
2098 syms_left = XVECTOR (fun)->contents[COMPILED_ARGLIST];
2099 else abort ();
2101 i = 0;
2102 for (; !NILP (syms_left); syms_left = Fcdr (syms_left))
2104 QUIT;
2105 next = Fcar (syms_left);
2106 while (XTYPE (next) != Lisp_Symbol)
2107 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2108 if (EQ (next, Qand_rest))
2109 rest = 1;
2110 else if (EQ (next, Qand_optional))
2111 optional = 1;
2112 else if (rest)
2114 specbind (next, Flist (nargs - i, &arg_vector[i]));
2115 i = nargs;
2117 else if (i < nargs)
2119 tem = arg_vector[i++];
2120 specbind (next, tem);
2122 else if (!optional)
2123 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2124 else
2125 specbind (next, Qnil);
2128 if (i < nargs)
2129 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2131 if (XTYPE (fun) == Lisp_Cons)
2132 val = Fprogn (Fcdr (Fcdr (fun)));
2133 else
2134 val = Fbyte_code (XVECTOR (fun)->contents[COMPILED_BYTECODE],
2135 XVECTOR (fun)->contents[COMPILED_CONSTANTS],
2136 XVECTOR (fun)->contents[COMPILED_STACK_DEPTH]);
2137 return unbind_to (count, val);
2140 void
2141 grow_specpdl ()
2143 register int count = specpdl_ptr - specpdl;
2144 if (specpdl_size >= max_specpdl_size)
2146 if (max_specpdl_size < 400)
2147 max_specpdl_size = 400;
2148 if (specpdl_size >= max_specpdl_size)
2150 if (!NILP (Vdebug_on_error))
2151 /* Leave room for some specpdl in the debugger. */
2152 max_specpdl_size = specpdl_size + 100;
2153 Fsignal (Qerror,
2154 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2157 specpdl_size *= 2;
2158 if (specpdl_size > max_specpdl_size)
2159 specpdl_size = max_specpdl_size;
2160 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2161 specpdl_ptr = specpdl + count;
2164 void
2165 specbind (symbol, value)
2166 Lisp_Object symbol, value;
2168 extern void store_symval_forwarding (); /* in eval.c */
2169 Lisp_Object ovalue;
2171 CHECK_SYMBOL (symbol, 0);
2173 if (specpdl_ptr == specpdl + specpdl_size)
2174 grow_specpdl ();
2175 specpdl_ptr->symbol = symbol;
2176 specpdl_ptr->func = 0;
2177 ovalue = XSYMBOL (symbol)->value;
2178 specpdl_ptr->old_value = EQ (ovalue, Qunbound) ? Qunbound : Fsymbol_value (symbol);
2179 specpdl_ptr++;
2180 if (XTYPE (ovalue) == Lisp_Buffer_Objfwd)
2181 store_symval_forwarding (symbol, ovalue, value);
2182 else
2183 Fset (symbol, value);
2186 void
2187 record_unwind_protect (function, arg)
2188 Lisp_Object (*function)();
2189 Lisp_Object arg;
2191 if (specpdl_ptr == specpdl + specpdl_size)
2192 grow_specpdl ();
2193 specpdl_ptr->func = function;
2194 specpdl_ptr->symbol = Qnil;
2195 specpdl_ptr->old_value = arg;
2196 specpdl_ptr++;
2199 Lisp_Object
2200 unbind_to (count, value)
2201 int count;
2202 Lisp_Object value;
2204 int quitf = !NILP (Vquit_flag);
2205 struct gcpro gcpro1;
2207 GCPRO1 (value);
2209 Vquit_flag = Qnil;
2211 while (specpdl_ptr != specpdl + count)
2213 --specpdl_ptr;
2214 if (specpdl_ptr->func != 0)
2215 (*specpdl_ptr->func) (specpdl_ptr->old_value);
2216 /* Note that a "binding" of nil is really an unwind protect,
2217 so in that case the "old value" is a list of forms to evaluate. */
2218 else if (NILP (specpdl_ptr->symbol))
2219 Fprogn (specpdl_ptr->old_value);
2220 else
2221 Fset (specpdl_ptr->symbol, specpdl_ptr->old_value);
2223 if (NILP (Vquit_flag) && quitf) Vquit_flag = Qt;
2225 UNGCPRO;
2227 return value;
2230 #if 0
2232 /* Get the value of symbol's global binding, even if that binding
2233 is not now dynamically visible. */
2235 Lisp_Object
2236 top_level_value (symbol)
2237 Lisp_Object symbol;
2239 register struct specbinding *ptr = specpdl;
2241 CHECK_SYMBOL (symbol, 0);
2242 for (; ptr != specpdl_ptr; ptr++)
2244 if (EQ (ptr->symbol, symbol))
2245 return ptr->old_value;
2247 return Fsymbol_value (symbol);
2250 Lisp_Object
2251 top_level_set (symbol, newval)
2252 Lisp_Object symbol, newval;
2254 register struct specbinding *ptr = specpdl;
2256 CHECK_SYMBOL (symbol, 0);
2257 for (; ptr != specpdl_ptr; ptr++)
2259 if (EQ (ptr->symbol, symbol))
2261 ptr->old_value = newval;
2262 return newval;
2265 return Fset (symbol, newval);
2268 #endif /* 0 */
2270 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
2271 "Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.\n\
2272 The debugger is entered when that frame exits, if the flag is non-nil.")
2273 (level, flag)
2274 Lisp_Object level, flag;
2276 register struct backtrace *backlist = backtrace_list;
2277 register int i;
2279 CHECK_NUMBER (level, 0);
2281 for (i = 0; backlist && i < XINT (level); i++)
2283 backlist = backlist->next;
2286 if (backlist)
2287 backlist->debug_on_exit = !NILP (flag);
2289 return flag;
2292 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
2293 "Print a trace of Lisp function calls currently active.\n\
2294 Output stream used is value of `standard-output'.")
2297 register struct backtrace *backlist = backtrace_list;
2298 register int i;
2299 Lisp_Object tail;
2300 Lisp_Object tem;
2301 extern Lisp_Object Vprint_level;
2302 struct gcpro gcpro1;
2304 XFASTINT (Vprint_level) = 3;
2306 tail = Qnil;
2307 GCPRO1 (tail);
2309 while (backlist)
2311 write_string (backlist->debug_on_exit ? "* " : " ", 2);
2312 if (backlist->nargs == UNEVALLED)
2314 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
2316 else
2318 tem = *backlist->function;
2319 Fprin1 (tem, Qnil); /* This can QUIT */
2320 write_string ("(", -1);
2321 if (backlist->nargs == MANY)
2323 for (tail = *backlist->args, i = 0;
2324 !NILP (tail);
2325 tail = Fcdr (tail), i++)
2327 if (i) write_string (" ", -1);
2328 Fprin1 (Fcar (tail), Qnil);
2331 else
2333 for (i = 0; i < backlist->nargs; i++)
2335 if (i) write_string (" ", -1);
2336 Fprin1 (backlist->args[i], Qnil);
2340 write_string (")\n", -1);
2341 backlist = backlist->next;
2344 Vprint_level = Qnil;
2345 UNGCPRO;
2346 return Qnil;
2349 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, "",
2350 "Return the function and arguments N frames up from current execution point.\n\
2351 If that frame has not evaluated the arguments yet (or is a special form),\n\
2352 the value is (nil FUNCTION ARG-FORMS...).\n\
2353 If that frame has evaluated its arguments and called its function already,\n\
2354 the value is (t FUNCTION ARG-VALUES...).\n\
2355 A &rest arg is represented as the tail of the list ARG-VALUES.\n\
2356 FUNCTION is whatever was supplied as car of evaluated list,\n\
2357 or a lambda expression for macro calls.\n\
2358 If N is more than the number of frames, the value is nil.")
2359 (nframes)
2360 Lisp_Object nframes;
2362 register struct backtrace *backlist = backtrace_list;
2363 register int i;
2364 Lisp_Object tem;
2366 CHECK_NATNUM (nframes, 0);
2368 /* Find the frame requested. */
2369 for (i = 0; i < XFASTINT (nframes); i++)
2370 backlist = backlist->next;
2372 if (!backlist)
2373 return Qnil;
2374 if (backlist->nargs == UNEVALLED)
2375 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
2376 else
2378 if (backlist->nargs == MANY)
2379 tem = *backlist->args;
2380 else
2381 tem = Flist (backlist->nargs, backlist->args);
2383 return Fcons (Qt, Fcons (*backlist->function, tem));
2387 syms_of_eval ()
2389 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
2390 "Limit on number of Lisp variable bindings & unwind-protects before error.");
2392 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
2393 "Limit on depth in `eval', `apply' and `funcall' before error.\n\
2394 This limit is to catch infinite recursions for you before they cause\n\
2395 actual stack overflow in C, which would be fatal for Emacs.\n\
2396 You can safely make it considerably larger than its default value,\n\
2397 if that proves inconveniently small.");
2399 DEFVAR_LISP ("quit-flag", &Vquit_flag,
2400 "Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.\n\
2401 Typing C-G sets `quit-flag' non-nil, regardless of `inhibit-quit'.");
2402 Vquit_flag = Qnil;
2404 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
2405 "Non-nil inhibits C-g quitting from happening immediately.\n\
2406 Note that `quit-flag' will still be set by typing C-g,\n\
2407 so a quit will be signalled as soon as `inhibit-quit' is nil.\n\
2408 To prevent this happening, set `quit-flag' to nil\n\
2409 before making `inhibit-quit' nil.");
2410 Vinhibit_quit = Qnil;
2412 Qinhibit_quit = intern ("inhibit-quit");
2413 staticpro (&Qinhibit_quit);
2415 Qautoload = intern ("autoload");
2416 staticpro (&Qautoload);
2418 Qdebug_on_error = intern ("debug-on-error");
2419 staticpro (&Qdebug_on_error);
2421 Qmacro = intern ("macro");
2422 staticpro (&Qmacro);
2424 /* Note that the process handling also uses Qexit, but we don't want
2425 to staticpro it twice, so we just do it here. */
2426 Qexit = intern ("exit");
2427 staticpro (&Qexit);
2429 Qinteractive = intern ("interactive");
2430 staticpro (&Qinteractive);
2432 Qcommandp = intern ("commandp");
2433 staticpro (&Qcommandp);
2435 Qdefun = intern ("defun");
2436 staticpro (&Qdefun);
2438 Qand_rest = intern ("&rest");
2439 staticpro (&Qand_rest);
2441 Qand_optional = intern ("&optional");
2442 staticpro (&Qand_optional);
2444 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
2445 "*Non-nil means automatically display a backtrace buffer\n\
2446 after any error that is handled by the editor command loop.\n\
2447 If the value is a list, an error only means to display a backtrace\n\
2448 if one of its condition symbols appears in the list.");
2449 Vstack_trace_on_error = Qnil;
2451 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
2452 "*Non-nil means enter debugger if an error is signaled.\n\
2453 Does not apply to errors handled by `condition-case'.\n\
2454 If the value is a list, an error only means to enter the debugger\n\
2455 if one of its condition symbols appears in the list.\n\
2456 See also variable `debug-on-quit'.");
2457 Vdebug_on_error = Qnil;
2459 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
2460 "*Non-nil means enter debugger if quit is signaled (C-G, for example).\n\
2461 Does not apply if quit is handled by a `condition-case'.");
2462 debug_on_quit = 0;
2464 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
2465 "Non-nil means enter debugger before next `eval', `apply' or `funcall'.");
2467 DEFVAR_LISP ("debugger", &Vdebugger,
2468 "Function to call to invoke debugger.\n\
2469 If due to frame exit, args are `exit' and the value being returned;\n\
2470 this function's value will be returned instead of that.\n\
2471 If due to error, args are `error' and a list of the args to `signal'.\n\
2472 If due to `apply' or `funcall' entry, one arg, `lambda'.\n\
2473 If due to `eval' entry, one arg, t.");
2474 Vdebugger = Qnil;
2476 Qmocklisp_arguments = intern ("mocklisp-arguments");
2477 staticpro (&Qmocklisp_arguments);
2478 DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments,
2479 "While in a mocklisp function, the list of its unevaluated args.");
2480 Vmocklisp_arguments = Qt;
2482 DEFVAR_LISP ("run-hooks", &Vrun_hooks,
2483 "Set to the function `run-hooks', if that function has been defined.\n\
2484 Otherwise, nil (in a bare Emacs without preloaded Lisp code).");
2485 Vrun_hooks = Qnil;
2487 staticpro (&Vautoload_queue);
2488 Vautoload_queue = Qnil;
2490 defsubr (&Sor);
2491 defsubr (&Sand);
2492 defsubr (&Sif);
2493 defsubr (&Scond);
2494 defsubr (&Sprogn);
2495 defsubr (&Sprog1);
2496 defsubr (&Sprog2);
2497 defsubr (&Ssetq);
2498 defsubr (&Squote);
2499 defsubr (&Sfunction);
2500 defsubr (&Sdefun);
2501 defsubr (&Sdefmacro);
2502 defsubr (&Sdefvar);
2503 defsubr (&Sdefconst);
2504 defsubr (&Suser_variable_p);
2505 defsubr (&Slet);
2506 defsubr (&SletX);
2507 defsubr (&Swhile);
2508 defsubr (&Smacroexpand);
2509 defsubr (&Scatch);
2510 defsubr (&Sthrow);
2511 defsubr (&Sunwind_protect);
2512 defsubr (&Scondition_case);
2513 defsubr (&Ssignal);
2514 defsubr (&Sinteractive_p);
2515 defsubr (&Scommandp);
2516 defsubr (&Sautoload);
2517 defsubr (&Seval);
2518 defsubr (&Sapply);
2519 defsubr (&Sfuncall);
2520 defsubr (&Sbacktrace_debug);
2521 defsubr (&Sbacktrace);
2522 defsubr (&Sbacktrace_frame);