(Info-fontify-node): Add mouse-face properties.
[bpt/emacs.git] / src / eval.c
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 1986, 1987, 1993 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
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.
10
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.
15
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. */
19
20
21 #include <config.h>
22 #include "lisp.h"
23 #include "blockinput.h"
24
25 #ifndef standalone
26 #include "commands.h"
27 #include "keyboard.h"
28 #else
29 #define INTERACTIVE 1
30 #endif
31
32 #include <setjmp.h>
33
34 /* This definition is duplicated in alloc.c and keyboard.c */
35 /* Putting it in lisp.h makes cc bomb out! */
36
37 struct backtrace
38 {
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;
48 };
49
50 struct backtrace *backtrace_list;
51
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.
55
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.
59
60 catchtag structures are chained together in the C calling stack;
61 the `next' member points to the next outer catchtag.
62
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.
67
68 All the other members are concerned with restoring the interpreter
69 state. */
70 struct catchtag
71 {
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;
82 };
83
84 struct catchtag *catchlist;
85
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;
91
92 Lisp_Object Vrun_hooks;
93
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. */
98
99 Lisp_Object Vautoload_queue;
100
101 /* Current number of specbindings allocated in specpdl. */
102 int specpdl_size;
103
104 /* Pointer to beginning of specpdl. */
105 struct specbinding *specpdl;
106
107 /* Pointer to first unused element in specpdl. */
108 struct specbinding *specpdl_ptr;
109
110 /* Maximum size allowed for specpdl allocation */
111 int max_specpdl_size;
112
113 /* Depth in Lisp evaluations and function calls. */
114 int lisp_eval_depth;
115
116 /* Maximum allowed depth in Lisp evaluations and function calls. */
117 int max_lisp_eval_depth;
118
119 /* Nonzero means enter debugger before next function call */
120 int debug_on_next_call;
121
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;
125
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;
129
130 /* Nonzero means enter debugger if a quit signal
131 is handled by the command loop's error handler. */
132 int debug_on_quit;
133
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;
141
142 Lisp_Object Vdebugger;
143
144 void specbind (), record_unwind_protect ();
145
146 Lisp_Object funcall_lambda ();
147 extern Lisp_Object ml_apply (); /* Apply a mocklisp function to unevaluated argument list */
148
149 init_eval_once ()
150 {
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;
155 }
156
157 init_eval ()
158 {
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;
167 }
168
169 Lisp_Object
170 call_debugger (arg)
171 Lisp_Object arg;
172 {
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);
180 }
181
182 do_debug_on_call (code)
183 Lisp_Object code;
184 {
185 debug_on_next_call = 0;
186 backtrace_list->debug_on_exit = 1;
187 call_debugger (Fcons (code, Qnil));
188 }
189 \f
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. */
193
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;
200 {
201 register Lisp_Object val;
202 Lisp_Object args_left;
203 struct gcpro gcpro1;
204
205 if (NILP(args))
206 return Qnil;
207
208 args_left = args;
209 GCPRO1 (args_left);
210
211 do
212 {
213 val = Feval (Fcar (args_left));
214 if (!NILP (val))
215 break;
216 args_left = Fcdr (args_left);
217 }
218 while (!NILP(args_left));
219
220 UNGCPRO;
221 return val;
222 }
223
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;
230 {
231 register Lisp_Object val;
232 Lisp_Object args_left;
233 struct gcpro gcpro1;
234
235 if (NILP(args))
236 return Qt;
237
238 args_left = args;
239 GCPRO1 (args_left);
240
241 do
242 {
243 val = Feval (Fcar (args_left));
244 if (NILP (val))
245 break;
246 args_left = Fcdr (args_left);
247 }
248 while (!NILP(args_left));
249
250 UNGCPRO;
251 return val;
252 }
253
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;
261 {
262 register Lisp_Object cond;
263 struct gcpro gcpro1;
264
265 GCPRO1 (args);
266 cond = Feval (Fcar (args));
267 UNGCPRO;
268
269 if (!NILP (cond))
270 return Feval (Fcar (Fcdr (args)));
271 return Fprogn (Fcdr (Fcdr (args)));
272 }
273
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;
285 {
286 register Lisp_Object clause, val;
287 struct gcpro gcpro1;
288
289 val = Qnil;
290 GCPRO1 (args);
291 while (!NILP (args))
292 {
293 clause = Fcar (args);
294 val = Feval (Fcar (clause));
295 if (!NILP (val))
296 {
297 if (!EQ (XCONS (clause)->cdr, Qnil))
298 val = Fprogn (XCONS (clause)->cdr);
299 break;
300 }
301 args = XCONS (args)->cdr;
302 }
303 UNGCPRO;
304
305 return val;
306 }
307
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;
312 {
313 register Lisp_Object val, tem;
314 Lisp_Object args_left;
315 struct gcpro gcpro1;
316
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))
320 {
321 val = make_number (0);
322 while (!NILP (args) && (tem = Fcar (args), XTYPE (tem) == Lisp_Symbol))
323 {
324 QUIT;
325 specbind (tem, val), args = Fcdr (args);
326 }
327 }
328
329 if (NILP(args))
330 return Qnil;
331
332 args_left = args;
333 GCPRO1 (args_left);
334
335 do
336 {
337 val = Feval (Fcar (args_left));
338 args_left = Fcdr (args_left);
339 }
340 while (!NILP(args_left));
341
342 UNGCPRO;
343 return val;
344 }
345
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;
352 {
353 Lisp_Object val;
354 register Lisp_Object args_left;
355 struct gcpro gcpro1, gcpro2;
356 register int argnum = 0;
357
358 if (NILP(args))
359 return Qnil;
360
361 args_left = args;
362 val = Qnil;
363 GCPRO2 (args, val);
364
365 do
366 {
367 if (!(argnum++))
368 val = Feval (Fcar (args_left));
369 else
370 Feval (Fcar (args_left));
371 args_left = Fcdr (args_left);
372 }
373 while (!NILP(args_left));
374
375 UNGCPRO;
376 return val;
377 }
378
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;
385 {
386 Lisp_Object val;
387 register Lisp_Object args_left;
388 struct gcpro gcpro1, gcpro2;
389 register int argnum = -1;
390
391 val = Qnil;
392
393 if (NILP(args))
394 return Qnil;
395
396 args_left = args;
397 val = Qnil;
398 GCPRO2 (args, val);
399
400 do
401 {
402 if (!(argnum++))
403 val = Feval (Fcar (args_left));
404 else
405 Feval (Fcar (args_left));
406 args_left = Fcdr (args_left);
407 }
408 while (!NILP(args_left));
409
410 UNGCPRO;
411 return val;
412 }
413
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;
420 {
421 register Lisp_Object args_left;
422 register Lisp_Object val, sym;
423 struct gcpro gcpro1;
424
425 if (NILP(args))
426 return Qnil;
427
428 args_left = args;
429 GCPRO1 (args);
430
431 do
432 {
433 val = Feval (Fcar (Fcdr (args_left)));
434 sym = Fcar (args_left);
435 Fset (sym, val);
436 args_left = Fcdr (Fcdr (args_left));
437 }
438 while (!NILP(args_left));
439
440 UNGCPRO;
441 return val;
442 }
443
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;
448 {
449 return Fcar (args);
450 }
451
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;
458 {
459 return Fcar (args);
460 }
461
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).")
467 ()
468 {
469 register struct backtrace *btp;
470 register Lisp_Object fun;
471
472 if (!INTERACTIVE)
473 return Qnil;
474
475 btp = backtrace_list;
476
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;
483
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;
491
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;
497
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;
510 }
511
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;
518 {
519 register Lisp_Object fn_name;
520 register Lisp_Object defn;
521
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;
529 }
530
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;
540 {
541 register Lisp_Object fn_name;
542 register Lisp_Object defn;
543
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;
551 }
552
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;
567 {
568 register Lisp_Object sym, tem;
569
570 sym = Fcar (args);
571 tem = Fcdr (args);
572 if (!NILP (tem))
573 {
574 tem = Fdefault_boundp (sym);
575 if (NILP (tem))
576 Fset_default (sym, Feval (Fcar (Fcdr (args))));
577 }
578 tem = Fcar (Fcdr (Fcdr (args)));
579 if (!NILP (tem))
580 {
581 if (!NILP (Vpurify_flag))
582 tem = Fpurecopy (tem);
583 Fput (sym, Qvariable_documentation, tem);
584 }
585 LOADHIST_ATTACH (sym);
586 return sym;
587 }
588
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;
605 {
606 register Lisp_Object sym, tem;
607
608 sym = Fcar (args);
609 Fset_default (sym, Feval (Fcar (Fcdr (args))));
610 tem = Fcar (Fcdr (Fcdr (args)));
611 if (!NILP (tem))
612 {
613 if (!NILP (Vpurify_flag))
614 tem = Fpurecopy (tem);
615 Fput (sym, Qvariable_documentation, tem);
616 }
617 LOADHIST_ATTACH (sym);
618 return sym;
619 }
620
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;
628 {
629 Lisp_Object documentation;
630
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;
638 }
639 \f
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;
648 {
649 Lisp_Object varlist, val, elt;
650 int count = specpdl_ptr - specpdl;
651 struct gcpro gcpro1, gcpro2, gcpro3;
652
653 GCPRO3 (args, elt, varlist);
654
655 varlist = Fcar (args);
656 while (!NILP (varlist))
657 {
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
667 {
668 val = Feval (Fcar (Fcdr (elt)));
669 specbind (Fcar (elt), val);
670 }
671 varlist = Fcdr (varlist);
672 }
673 UNGCPRO;
674 val = Fprogn (Fcdr (args));
675 return unbind_to (count, val);
676 }
677
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;
686 {
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;
692
693 varlist = Fcar (args);
694
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));
698
699 /* Compute the values and store them in `temps' */
700
701 GCPRO2 (args, *temps);
702 gcpro2.nvars = 0;
703
704 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
705 {
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;
717 }
718 UNGCPRO;
719
720 varlist = Fcar (args);
721 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
722 {
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);
729 }
730
731 elt = Fprogn (Fcdr (args));
732 return unbind_to (count, elt);
733 }
734
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;
741 {
742 Lisp_Object test, body, tem;
743 struct gcpro gcpro1, gcpro2;
744
745 GCPRO2 (test, body);
746
747 test = Fcar (args);
748 body = Fcdr (args);
749 while (tem = Feval (test),
750 (!EQ (Vmocklisp_arguments, Qt) ? XINT (tem) : !NILP (tem)))
751 {
752 QUIT;
753 Fprogn (body);
754 }
755
756 UNGCPRO;
757 return Qnil;
758 }
759
760 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
761 "Return result of expanding macros at top level of FORM.\n\
762 If FORM is not a macro call, it is returned unchanged.\n\
763 Otherwise, the macro is expanded and the expansion is considered\n\
764 in place of FORM. When a non-macro-call results, it is returned.\n\n\
765 The second optional arg ENVIRONMENT species an environment of macro\n\
766 definitions to shadow the loaded ones for use in file byte-compilation.")
767 (form, env)
768 register Lisp_Object form;
769 Lisp_Object env;
770 {
771 /* With cleanups from Hallvard Furuseth. */
772 register Lisp_Object expander, sym, def, tem;
773
774 while (1)
775 {
776 /* Come back here each time we expand a macro call,
777 in case it expands into another macro call. */
778 if (XTYPE (form) != Lisp_Cons)
779 break;
780 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
781 def = sym = XCONS (form)->car;
782 tem = Qnil;
783 /* Trace symbols aliases to other symbols
784 until we get a symbol that is not an alias. */
785 while (XTYPE (def) == Lisp_Symbol)
786 {
787 QUIT;
788 sym = def;
789 tem = Fassq (sym, env);
790 if (NILP (tem))
791 {
792 def = XSYMBOL (sym)->function;
793 if (!EQ (def, Qunbound))
794 continue;
795 }
796 break;
797 }
798 /* Right now TEM is the result from SYM in ENV,
799 and if TEM is nil then DEF is SYM's function definition. */
800 if (NILP (tem))
801 {
802 /* SYM is not mentioned in ENV.
803 Look at its function definition. */
804 if (EQ (def, Qunbound)
805 || XTYPE (def) != Lisp_Cons)
806 /* Not defined or definition not suitable */
807 break;
808 if (EQ (XCONS (def)->car, Qautoload))
809 {
810 /* Autoloading function: will it be a macro when loaded? */
811 tem = Fnth (make_number (4), def);
812 if (EQ (tem, Qt) || EQ (tem, Qmacro))
813 /* Yes, load it and try again. */
814 {
815 do_autoload (def, sym);
816 continue;
817 }
818 else
819 break;
820 }
821 else if (!EQ (XCONS (def)->car, Qmacro))
822 break;
823 else expander = XCONS (def)->cdr;
824 }
825 else
826 {
827 expander = XCONS (tem)->cdr;
828 if (NILP (expander))
829 break;
830 }
831 form = apply1 (expander, XCONS (form)->cdr);
832 }
833 return form;
834 }
835 \f
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;
844 {
845 register Lisp_Object tag;
846 struct gcpro gcpro1;
847
848 GCPRO1 (args);
849 tag = Feval (Fcar (args));
850 UNGCPRO;
851 return internal_catch (tag, Fprogn, Fcdr (args));
852 }
853
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. */
857
858 Lisp_Object
859 internal_catch (tag, func, arg)
860 Lisp_Object tag;
861 Lisp_Object (*func) ();
862 Lisp_Object arg;
863 {
864 /* This structure is made part of the chain `catchlist'. */
865 struct catchtag c;
866
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;
878
879 /* Call FUNC. */
880 if (! _setjmp (c.jmp))
881 c.val = (*func) (arg);
882
883 /* Throw works by a longjmp that comes right here. */
884 catchlist = c.next;
885 return c.val;
886 }
887
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.
890
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.
894
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
901
902 This is used for correct unwinding in Fthrow and Fsignal. */
903
904 static void
905 unwind_to_catch (catch, value)
906 struct catchtag *catch;
907 Lisp_Object value;
908 {
909 register int last_time;
910
911 /* Save the value in the tag. */
912 catch->val = value;
913
914 /* Restore the polling-suppression count. */
915 set_poll_suppress_count (catch->poll_suppress_count);
916
917 do
918 {
919 last_time = catchlist == catch;
920
921 /* Unwind the specpdl stack, and then restore the proper set of
922 handlers. */
923 unbind_to (catchlist->pdlcount, Qnil);
924 handlerlist = catchlist->handlerlist;
925 catchlist = catchlist->next;
926 }
927 while (! last_time);
928
929 gcprolist = catch->gcpro;
930 backtrace_list = catch->backlist;
931 lisp_eval_depth = catch->lisp_eval_depth;
932
933 _longjmp (catch->jmp, 1);
934 }
935
936 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
937 "(throw TAG VALUE): throw to the catch for TAG and return VALUE from it.\n\
938 Both TAG and VALUE are evalled.")
939 (tag, val)
940 register Lisp_Object tag, val;
941 {
942 register struct catchtag *c;
943
944 while (1)
945 {
946 if (!NILP (tag))
947 for (c = catchlist; c; c = c->next)
948 {
949 if (EQ (c->tag, tag))
950 unwind_to_catch (c, val);
951 }
952 tag = Fsignal (Qno_catch, Fcons (tag, Fcons (val, Qnil)));
953 }
954 }
955
956
957 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
958 "Do BODYFORM, protecting with UNWINDFORMS.\n\
959 Usage looks like (unwind-protect BODYFORM UNWINDFORMS...).\n\
960 If BODYFORM completes normally, its value is returned\n\
961 after executing the UNWINDFORMS.\n\
962 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.")
963 (args)
964 Lisp_Object args;
965 {
966 Lisp_Object val;
967 int count = specpdl_ptr - specpdl;
968
969 record_unwind_protect (0, Fcdr (args));
970 val = Feval (Fcar (args));
971 return unbind_to (count, val);
972 }
973 \f
974 /* Chain of condition handlers currently in effect.
975 The elements of this chain are contained in the stack frames
976 of Fcondition_case and internal_condition_case.
977 When an error is signaled (by calling Fsignal, below),
978 this chain is searched for an element that applies. */
979
980 struct handler *handlerlist;
981
982 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
983 "Regain control when an error is signaled.\n\
984 Usage looks like (condition-case VAR BODYFORM HANDLERS...).\n\
985 executes BODYFORM and returns its value if no error happens.\n\
986 Each element of HANDLERS looks like (CONDITION-NAME BODY...)\n\
987 where the BODY is made of Lisp expressions.\n\n\
988 A handler is applicable to an error\n\
989 if CONDITION-NAME is one of the error's condition names.\n\
990 If an error happens, the first applicable handler is run.\n\
991 \n\
992 The car of a handler may be a list of condition names\n\
993 instead of a single condition name.\n\
994 \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\
999 \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;
1004 {
1005 Lisp_Object val;
1006 struct catchtag c;
1007 struct handler h;
1008 register Lisp_Object var, bodyform, handlers;
1009
1010 var = Fcar (args);
1011 bodyform = Fcar (Fcdr (args));
1012 handlers = Fcdr (Fcdr (args));
1013 CHECK_SYMBOL (var, 0);
1014
1015 for (val = handlers; ! NILP (val); val = Fcdr (val))
1016 {
1017 Lisp_Object tem;
1018 tem = Fcar (val);
1019 if (! (NILP (tem)
1020 || (CONSP (tem)
1021 && (SYMBOLP (XCONS (tem)->car)
1022 || CONSP (XCONS (tem)->car)))))
1023 error ("Invalid condition handler", tem);
1024 }
1025
1026 c.tag = Qnil;
1027 c.val = Qnil;
1028 c.backlist = backtrace_list;
1029 c.handlerlist = handlerlist;
1030 c.lisp_eval_depth = lisp_eval_depth;
1031 c.pdlcount = specpdl_ptr - specpdl;
1032 c.poll_suppress_count = poll_suppress_count;
1033 c.gcpro = gcprolist;
1034 if (_setjmp (c.jmp))
1035 {
1036 if (!NILP (h.var))
1037 specbind (h.var, c.val);
1038 val = Fprogn (Fcdr (h.chosen_clause));
1039
1040 /* Note that this just undoes the binding of h.var; whoever
1041 longjumped to us unwound the stack to c.pdlcount before
1042 throwing. */
1043 unbind_to (c.pdlcount, Qnil);
1044 return val;
1045 }
1046 c.next = catchlist;
1047 catchlist = &c;
1048
1049 h.var = var;
1050 h.handler = handlers;
1051 h.next = handlerlist;
1052 h.tag = &c;
1053 handlerlist = &h;
1054
1055 val = Feval (bodyform);
1056 catchlist = c.next;
1057 handlerlist = h.next;
1058 return val;
1059 }
1060
1061 Lisp_Object
1062 internal_condition_case (bfun, handlers, hfun)
1063 Lisp_Object (*bfun) ();
1064 Lisp_Object handlers;
1065 Lisp_Object (*hfun) ();
1066 {
1067 Lisp_Object val;
1068 struct catchtag c;
1069 struct handler h;
1070
1071 c.tag = Qnil;
1072 c.val = Qnil;
1073 c.backlist = backtrace_list;
1074 c.handlerlist = handlerlist;
1075 c.lisp_eval_depth = lisp_eval_depth;
1076 c.pdlcount = specpdl_ptr - specpdl;
1077 c.poll_suppress_count = poll_suppress_count;
1078 c.gcpro = gcprolist;
1079 if (_setjmp (c.jmp))
1080 {
1081 return (*hfun) (c.val);
1082 }
1083 c.next = catchlist;
1084 catchlist = &c;
1085 h.handler = handlers;
1086 h.var = Qnil;
1087 h.next = handlerlist;
1088 h.tag = &c;
1089 handlerlist = &h;
1090
1091 val = (*bfun) ();
1092 catchlist = c.next;
1093 handlerlist = h.next;
1094 return val;
1095 }
1096
1097 Lisp_Object
1098 internal_condition_case_1 (bfun, arg, handlers, hfun)
1099 Lisp_Object (*bfun) ();
1100 Lisp_Object arg;
1101 Lisp_Object handlers;
1102 Lisp_Object (*hfun) ();
1103 {
1104 Lisp_Object val;
1105 struct catchtag c;
1106 struct handler h;
1107
1108 c.tag = Qnil;
1109 c.val = Qnil;
1110 c.backlist = backtrace_list;
1111 c.handlerlist = handlerlist;
1112 c.lisp_eval_depth = lisp_eval_depth;
1113 c.pdlcount = specpdl_ptr - specpdl;
1114 c.poll_suppress_count = poll_suppress_count;
1115 c.gcpro = gcprolist;
1116 if (_setjmp (c.jmp))
1117 {
1118 return (*hfun) (c.val);
1119 }
1120 c.next = catchlist;
1121 catchlist = &c;
1122 h.handler = handlers;
1123 h.var = Qnil;
1124 h.next = handlerlist;
1125 h.tag = &c;
1126 handlerlist = &h;
1127
1128 val = (*bfun) (arg);
1129 catchlist = c.next;
1130 handlerlist = h.next;
1131 return val;
1132 }
1133 \f
1134 static Lisp_Object find_handler_clause ();
1135
1136 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1137 "Signal an error. Args are ERROR-SYMBOL and associated DATA.\n\
1138 This function does not return.\n\n\
1139 An error symbol is a symbol with an `error-conditions' property\n\
1140 that is a list of condition names.\n\
1141 A handler for any of those names will get to handle this signal.\n\
1142 The symbol `error' should normally be one of them.\n\
1143 \n\
1144 DATA should be a list. Its elements are printed as part of the error message.\n\
1145 If the signal is handled, DATA is made available to the handler.\n\
1146 See also the function `condition-case'.")
1147 (error_symbol, data)
1148 Lisp_Object error_symbol, data;
1149 {
1150 register struct handler *allhandlers = handlerlist;
1151 Lisp_Object conditions;
1152 extern int gc_in_progress;
1153 extern int waiting_for_input;
1154 Lisp_Object debugger_value;
1155
1156 quit_error_check ();
1157 immediate_quit = 0;
1158 if (gc_in_progress || waiting_for_input)
1159 abort ();
1160
1161 #ifdef HAVE_X_WINDOWS
1162 TOTALLY_UNBLOCK_INPUT;
1163 #endif
1164
1165 conditions = Fget (error_symbol, Qerror_conditions);
1166
1167 for (; handlerlist; handlerlist = handlerlist->next)
1168 {
1169 register Lisp_Object clause;
1170 clause = find_handler_clause (handlerlist->handler, conditions,
1171 error_symbol, data, &debugger_value);
1172
1173 #if 0 /* Most callers are not prepared to handle gc if this returns.
1174 So, since this feature is not very useful, take it out. */
1175 /* If have called debugger and user wants to continue,
1176 just return nil. */
1177 if (EQ (clause, Qlambda))
1178 return debugger_value;
1179 #else
1180 if (EQ (clause, Qlambda))
1181 {
1182 /* We can't return values to code which signalled an error, but we
1183 can continue code which has signalled a quit. */
1184 if (EQ (error_symbol, Qquit))
1185 return Qnil;
1186 else
1187 error ("Cannot return from the debugger in an error");
1188 }
1189 #endif
1190
1191 if (!NILP (clause))
1192 {
1193 Lisp_Object unwind_data;
1194 struct handler *h = handlerlist;
1195
1196 handlerlist = allhandlers;
1197 if (data == memory_signal_data)
1198 unwind_data = memory_signal_data;
1199 else
1200 unwind_data = Fcons (error_symbol, data);
1201 h->chosen_clause = clause;
1202 unwind_to_catch (h->tag, unwind_data);
1203 }
1204 }
1205
1206 handlerlist = allhandlers;
1207 /* If no handler is present now, try to run the debugger,
1208 and if that fails, throw to top level. */
1209 find_handler_clause (Qerror, conditions, error_symbol, data, &debugger_value);
1210 Fthrow (Qtop_level, Qt);
1211 }
1212
1213 /* Return nonzero iff LIST is a non-nil atom or
1214 a list containing one of CONDITIONS. */
1215
1216 static int
1217 wants_debugger (list, conditions)
1218 Lisp_Object list, conditions;
1219 {
1220 if (NILP (list))
1221 return 0;
1222 if (! CONSP (list))
1223 return 1;
1224
1225 while (CONSP (conditions))
1226 {
1227 Lisp_Object this, tail;
1228 this = XCONS (conditions)->car;
1229 for (tail = list; CONSP (tail); tail = XCONS (tail)->cdr)
1230 if (EQ (XCONS (tail)->car, this))
1231 return 1;
1232 conditions = XCONS (conditions)->cdr;
1233 }
1234 return 0;
1235 }
1236
1237 /* Value of Qlambda means we have called debugger and user has continued.
1238 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1239
1240 static Lisp_Object
1241 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1242 Lisp_Object handlers, conditions, sig, data;
1243 Lisp_Object *debugger_value_ptr;
1244 {
1245 register Lisp_Object h;
1246 register Lisp_Object tem;
1247
1248 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1249 return Qt;
1250 if (EQ (handlers, Qerror)) /* error is used similarly, but means display a backtrace too */
1251 {
1252 if (wants_debugger (Vstack_trace_on_error, conditions))
1253 internal_with_output_to_temp_buffer ("*Backtrace*", Fbacktrace, Qnil);
1254 if ((EQ (sig, Qquit)
1255 ? debug_on_quit
1256 : wants_debugger (Vdebug_on_error, conditions))
1257 && when_entered_debugger < num_nonmacro_input_chars)
1258 {
1259 int count = specpdl_ptr - specpdl;
1260 specbind (Qdebug_on_error, Qnil);
1261 *debugger_value_ptr =
1262 call_debugger (Fcons (Qerror,
1263 Fcons (Fcons (sig, data),
1264 Qnil)));
1265 return unbind_to (count, Qlambda);
1266 }
1267 return Qt;
1268 }
1269 for (h = handlers; CONSP (h); h = Fcdr (h))
1270 {
1271 Lisp_Object handler, condit;
1272
1273 handler = Fcar (h);
1274 if (!CONSP (handler))
1275 continue;
1276 condit = Fcar (handler);
1277 /* Handle a single condition name in handler HANDLER. */
1278 if (SYMBOLP (condit))
1279 {
1280 tem = Fmemq (Fcar (handler), conditions);
1281 if (!NILP (tem))
1282 return handler;
1283 }
1284 /* Handle a list of condition names in handler HANDLER. */
1285 else if (CONSP (condit))
1286 {
1287 while (CONSP (condit))
1288 {
1289 tem = Fmemq (Fcar (condit), conditions);
1290 if (!NILP (tem))
1291 return handler;
1292 condit = XCONS (condit)->cdr;
1293 }
1294 }
1295 }
1296 return Qnil;
1297 }
1298
1299 /* dump an error message; called like printf */
1300
1301 /* VARARGS 1 */
1302 void
1303 error (m, a1, a2, a3)
1304 char *m;
1305 char *a1, *a2, *a3;
1306 {
1307 char buf[200];
1308 int size = 200;
1309 int mlen;
1310 char *buffer = buf;
1311 char *args[3];
1312 int allocated = 0;
1313 Lisp_Object string;
1314
1315 args[0] = a1;
1316 args[1] = a2;
1317 args[2] = a3;
1318
1319 mlen = strlen (m);
1320
1321 while (1)
1322 {
1323 int used = doprnt (buf, size, m, m + mlen, 3, args);
1324 if (used < size)
1325 break;
1326 size *= 2;
1327 if (allocated)
1328 buffer = (char *) xrealloc (buffer, size);
1329 buffer = (char *) xmalloc (size);
1330 }
1331
1332 string = build_string (buf);
1333 if (allocated)
1334 free (buffer);
1335
1336 Fsignal (Qerror, Fcons (string, Qnil));
1337 }
1338 \f
1339 DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0,
1340 "T if FUNCTION makes provisions for interactive calling.\n\
1341 This means it contains a description for how to read arguments to give it.\n\
1342 The value is nil for an invalid function or a symbol with no function\n\
1343 definition.\n\
1344 \n\
1345 Interactively callable functions include strings and vectors (treated\n\
1346 as keyboard macros), lambda-expressions that contain a top-level call\n\
1347 to `interactive', autoload definitions made by `autoload' with non-nil\n\
1348 fourth argument, and some of the built-in functions of Lisp.\n\
1349 \n\
1350 Also, a symbol satisfies `commandp' if its function definition does so.")
1351 (function)
1352 Lisp_Object function;
1353 {
1354 register Lisp_Object fun;
1355 register Lisp_Object funcar;
1356 register Lisp_Object tem;
1357 register int i = 0;
1358
1359 fun = function;
1360
1361 fun = indirect_function (fun);
1362 if (EQ (fun, Qunbound))
1363 return Qnil;
1364
1365 /* Emacs primitives are interactive if their DEFUN specifies an
1366 interactive spec. */
1367 if (XTYPE (fun) == Lisp_Subr)
1368 {
1369 if (XSUBR (fun)->prompt)
1370 return Qt;
1371 else
1372 return Qnil;
1373 }
1374
1375 /* Bytecode objects are interactive if they are long enough to
1376 have an element whose index is COMPILED_INTERACTIVE, which is
1377 where the interactive spec is stored. */
1378 else if (XTYPE (fun) == Lisp_Compiled)
1379 return (XVECTOR (fun)->size > COMPILED_INTERACTIVE
1380 ? Qt : Qnil);
1381
1382 /* Strings and vectors are keyboard macros. */
1383 if (XTYPE (fun) == Lisp_String
1384 || XTYPE (fun) == Lisp_Vector)
1385 return Qt;
1386
1387 /* Lists may represent commands. */
1388 if (!CONSP (fun))
1389 return Qnil;
1390 funcar = Fcar (fun);
1391 if (XTYPE (funcar) != Lisp_Symbol)
1392 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1393 if (EQ (funcar, Qlambda))
1394 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1395 if (EQ (funcar, Qmocklisp))
1396 return Qt; /* All mocklisp functions can be called interactively */
1397 if (EQ (funcar, Qautoload))
1398 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1399 else
1400 return Qnil;
1401 }
1402
1403 /* ARGSUSED */
1404 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1405 "Define FUNCTION to autoload from FILE.\n\
1406 FUNCTION is a symbol; FILE is a file name string to pass to `load'.\n\
1407 Third arg DOCSTRING is documentation for the function.\n\
1408 Fourth arg INTERACTIVE if non-nil says function can be called interactively.\n\
1409 Fifth arg TYPE indicates the type of the object:\n\
1410 nil or omitted says FUNCTION is a function,\n\
1411 `keymap' says FUNCTION is really a keymap, and\n\
1412 `macro' or t says FUNCTION is really a macro.\n\
1413 Third through fifth args give info about the real definition.\n\
1414 They default to nil.\n\
1415 If FUNCTION is already defined other than as an autoload,\n\
1416 this does nothing and returns nil.")
1417 (function, file, docstring, interactive, type)
1418 Lisp_Object function, file, docstring, interactive, type;
1419 {
1420 #ifdef NO_ARG_ARRAY
1421 Lisp_Object args[4];
1422 #endif
1423
1424 CHECK_SYMBOL (function, 0);
1425 CHECK_STRING (file, 1);
1426
1427 /* If function is defined and not as an autoload, don't override */
1428 if (!EQ (XSYMBOL (function)->function, Qunbound)
1429 && !(XTYPE (XSYMBOL (function)->function) == Lisp_Cons
1430 && EQ (XCONS (XSYMBOL (function)->function)->car, Qautoload)))
1431 return Qnil;
1432
1433 #ifdef NO_ARG_ARRAY
1434 args[0] = file;
1435 args[1] = docstring;
1436 args[2] = interactive;
1437 args[3] = type;
1438
1439 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1440 #else /* NO_ARG_ARRAY */
1441 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1442 #endif /* not NO_ARG_ARRAY */
1443 }
1444
1445 Lisp_Object
1446 un_autoload (oldqueue)
1447 Lisp_Object oldqueue;
1448 {
1449 register Lisp_Object queue, first, second;
1450
1451 /* Queue to unwind is current value of Vautoload_queue.
1452 oldqueue is the shadowed value to leave in Vautoload_queue. */
1453 queue = Vautoload_queue;
1454 Vautoload_queue = oldqueue;
1455 while (CONSP (queue))
1456 {
1457 first = Fcar (queue);
1458 second = Fcdr (first);
1459 first = Fcar (first);
1460 if (EQ (second, Qnil))
1461 Vfeatures = first;
1462 else
1463 Ffset (first, second);
1464 queue = Fcdr (queue);
1465 }
1466 return Qnil;
1467 }
1468
1469 do_autoload (fundef, funname)
1470 Lisp_Object fundef, funname;
1471 {
1472 int count = specpdl_ptr - specpdl;
1473 Lisp_Object fun, val, queue, first, second;
1474
1475 fun = funname;
1476 CHECK_SYMBOL (funname, 0);
1477
1478 /* Value saved here is to be restored into Vautoload_queue */
1479 record_unwind_protect (un_autoload, Vautoload_queue);
1480 Vautoload_queue = Qt;
1481 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil);
1482
1483 /* Save the old autoloads, in case we ever do an unload. */
1484 queue = Vautoload_queue;
1485 while (CONSP (queue))
1486 {
1487 first = Fcar (queue);
1488 second = Fcdr (first);
1489 first = Fcar (first);
1490
1491 /* Note: This test is subtle. The cdr of an autoload-queue entry
1492 may be an atom if the autoload entry was generated by a defalias
1493 or fset. */
1494 if (CONSP (second))
1495 Fput (first, Qautoload, (Fcdr (second)));
1496
1497 queue = Fcdr (queue);
1498 }
1499
1500 /* Once loading finishes, don't undo it. */
1501 Vautoload_queue = Qt;
1502 unbind_to (count, Qnil);
1503
1504 fun = Findirect_function (fun);
1505
1506 if (!NILP (Fequal (fun, fundef)))
1507 error ("Autoloading failed to define function %s",
1508 XSYMBOL (funname)->name->data);
1509 }
1510 \f
1511 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1512 "Evaluate FORM and return its value.")
1513 (form)
1514 Lisp_Object form;
1515 {
1516 Lisp_Object fun, val, original_fun, original_args;
1517 Lisp_Object funcar;
1518 struct backtrace backtrace;
1519 struct gcpro gcpro1, gcpro2, gcpro3;
1520
1521 if (XTYPE (form) == Lisp_Symbol)
1522 {
1523 if (EQ (Vmocklisp_arguments, Qt))
1524 return Fsymbol_value (form);
1525 val = Fsymbol_value (form);
1526 if (NILP (val))
1527 XFASTINT (val) = 0;
1528 else if (EQ (val, Qt))
1529 XFASTINT (val) = 1;
1530 return val;
1531 }
1532 if (!CONSP (form))
1533 return form;
1534
1535 QUIT;
1536 if (consing_since_gc > gc_cons_threshold)
1537 {
1538 GCPRO1 (form);
1539 Fgarbage_collect ();
1540 UNGCPRO;
1541 }
1542
1543 if (++lisp_eval_depth > max_lisp_eval_depth)
1544 {
1545 if (max_lisp_eval_depth < 100)
1546 max_lisp_eval_depth = 100;
1547 if (lisp_eval_depth > max_lisp_eval_depth)
1548 error ("Lisp nesting exceeds max-lisp-eval-depth");
1549 }
1550
1551 original_fun = Fcar (form);
1552 original_args = Fcdr (form);
1553
1554 backtrace.next = backtrace_list;
1555 backtrace_list = &backtrace;
1556 backtrace.function = &original_fun; /* This also protects them from gc */
1557 backtrace.args = &original_args;
1558 backtrace.nargs = UNEVALLED;
1559 backtrace.evalargs = 1;
1560 backtrace.debug_on_exit = 0;
1561
1562 if (debug_on_next_call)
1563 do_debug_on_call (Qt);
1564
1565 /* At this point, only original_fun and original_args
1566 have values that will be used below */
1567 retry:
1568 fun = Findirect_function (original_fun);
1569
1570 if (XTYPE (fun) == Lisp_Subr)
1571 {
1572 Lisp_Object numargs;
1573 Lisp_Object argvals[7];
1574 Lisp_Object args_left;
1575 register int i, maxargs;
1576
1577 args_left = original_args;
1578 numargs = Flength (args_left);
1579
1580 if (XINT (numargs) < XSUBR (fun)->min_args ||
1581 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
1582 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
1583
1584 if (XSUBR (fun)->max_args == UNEVALLED)
1585 {
1586 backtrace.evalargs = 0;
1587 val = (*XSUBR (fun)->function) (args_left);
1588 goto done;
1589 }
1590
1591 if (XSUBR (fun)->max_args == MANY)
1592 {
1593 /* Pass a vector of evaluated arguments */
1594 Lisp_Object *vals;
1595 register int argnum = 0;
1596
1597 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
1598
1599 GCPRO3 (args_left, fun, fun);
1600 gcpro3.var = vals;
1601 gcpro3.nvars = 0;
1602
1603 while (!NILP (args_left))
1604 {
1605 vals[argnum++] = Feval (Fcar (args_left));
1606 args_left = Fcdr (args_left);
1607 gcpro3.nvars = argnum;
1608 }
1609
1610 backtrace.args = vals;
1611 backtrace.nargs = XINT (numargs);
1612
1613 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
1614 UNGCPRO;
1615 goto done;
1616 }
1617
1618 GCPRO3 (args_left, fun, fun);
1619 gcpro3.var = argvals;
1620 gcpro3.nvars = 0;
1621
1622 maxargs = XSUBR (fun)->max_args;
1623 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
1624 {
1625 argvals[i] = Feval (Fcar (args_left));
1626 gcpro3.nvars = ++i;
1627 }
1628
1629 UNGCPRO;
1630
1631 backtrace.args = argvals;
1632 backtrace.nargs = XINT (numargs);
1633
1634 switch (i)
1635 {
1636 case 0:
1637 val = (*XSUBR (fun)->function) ();
1638 goto done;
1639 case 1:
1640 val = (*XSUBR (fun)->function) (argvals[0]);
1641 goto done;
1642 case 2:
1643 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
1644 goto done;
1645 case 3:
1646 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1647 argvals[2]);
1648 goto done;
1649 case 4:
1650 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1651 argvals[2], argvals[3]);
1652 goto done;
1653 case 5:
1654 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1655 argvals[3], argvals[4]);
1656 goto done;
1657 case 6:
1658 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1659 argvals[3], argvals[4], argvals[5]);
1660 goto done;
1661 case 7:
1662 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1663 argvals[3], argvals[4], argvals[5],
1664 argvals[6]);
1665 goto done;
1666
1667 default:
1668 /* Someone has created a subr that takes more arguments than
1669 is supported by this code. We need to either rewrite the
1670 subr to use a different argument protocol, or add more
1671 cases to this switch. */
1672 abort ();
1673 }
1674 }
1675 if (XTYPE (fun) == Lisp_Compiled)
1676 val = apply_lambda (fun, original_args, 1);
1677 else
1678 {
1679 if (!CONSP (fun))
1680 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1681 funcar = Fcar (fun);
1682 if (XTYPE (funcar) != Lisp_Symbol)
1683 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1684 if (EQ (funcar, Qautoload))
1685 {
1686 do_autoload (fun, original_fun);
1687 goto retry;
1688 }
1689 if (EQ (funcar, Qmacro))
1690 val = Feval (apply1 (Fcdr (fun), original_args));
1691 else if (EQ (funcar, Qlambda))
1692 val = apply_lambda (fun, original_args, 1);
1693 else if (EQ (funcar, Qmocklisp))
1694 val = ml_apply (fun, original_args);
1695 else
1696 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1697 }
1698 done:
1699 if (!EQ (Vmocklisp_arguments, Qt))
1700 {
1701 if (NILP (val))
1702 XFASTINT (val) = 0;
1703 else if (EQ (val, Qt))
1704 XFASTINT (val) = 1;
1705 }
1706 lisp_eval_depth--;
1707 if (backtrace.debug_on_exit)
1708 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
1709 backtrace_list = backtrace.next;
1710 return val;
1711 }
1712 \f
1713 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
1714 "Call FUNCTION with our remaining args, using our last arg as list of args.\n\
1715 Thus, (apply '+ 1 2 '(3 4)) returns 10.")
1716 (nargs, args)
1717 int nargs;
1718 Lisp_Object *args;
1719 {
1720 register int i, numargs;
1721 register Lisp_Object spread_arg;
1722 register Lisp_Object *funcall_args;
1723 Lisp_Object fun;
1724 struct gcpro gcpro1;
1725
1726 fun = args [0];
1727 funcall_args = 0;
1728 spread_arg = args [nargs - 1];
1729 CHECK_LIST (spread_arg, nargs);
1730
1731 numargs = XINT (Flength (spread_arg));
1732
1733 if (numargs == 0)
1734 return Ffuncall (nargs - 1, args);
1735 else if (numargs == 1)
1736 {
1737 args [nargs - 1] = XCONS (spread_arg)->car;
1738 return Ffuncall (nargs, args);
1739 }
1740
1741 numargs += nargs - 2;
1742
1743 fun = indirect_function (fun);
1744 if (EQ (fun, Qunbound))
1745 {
1746 /* Let funcall get the error */
1747 fun = args[0];
1748 goto funcall;
1749 }
1750
1751 if (XTYPE (fun) == Lisp_Subr)
1752 {
1753 if (numargs < XSUBR (fun)->min_args
1754 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
1755 goto funcall; /* Let funcall get the error */
1756 else if (XSUBR (fun)->max_args > numargs)
1757 {
1758 /* Avoid making funcall cons up a yet another new vector of arguments
1759 by explicitly supplying nil's for optional values */
1760 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
1761 * sizeof (Lisp_Object));
1762 for (i = numargs; i < XSUBR (fun)->max_args;)
1763 funcall_args[++i] = Qnil;
1764 GCPRO1 (*funcall_args);
1765 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
1766 }
1767 }
1768 funcall:
1769 /* We add 1 to numargs because funcall_args includes the
1770 function itself as well as its arguments. */
1771 if (!funcall_args)
1772 {
1773 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
1774 * sizeof (Lisp_Object));
1775 GCPRO1 (*funcall_args);
1776 gcpro1.nvars = 1 + numargs;
1777 }
1778
1779 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
1780 /* Spread the last arg we got. Its first element goes in
1781 the slot that it used to occupy, hence this value of I. */
1782 i = nargs - 1;
1783 while (!NILP (spread_arg))
1784 {
1785 funcall_args [i++] = XCONS (spread_arg)->car;
1786 spread_arg = XCONS (spread_arg)->cdr;
1787 }
1788
1789 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
1790 }
1791 \f
1792 /* Apply fn to arg */
1793 Lisp_Object
1794 apply1 (fn, arg)
1795 Lisp_Object fn, arg;
1796 {
1797 struct gcpro gcpro1;
1798
1799 GCPRO1 (fn);
1800 if (NILP (arg))
1801 RETURN_UNGCPRO (Ffuncall (1, &fn));
1802 gcpro1.nvars = 2;
1803 #ifdef NO_ARG_ARRAY
1804 {
1805 Lisp_Object args[2];
1806 args[0] = fn;
1807 args[1] = arg;
1808 gcpro1.var = args;
1809 RETURN_UNGCPRO (Fapply (2, args));
1810 }
1811 #else /* not NO_ARG_ARRAY */
1812 RETURN_UNGCPRO (Fapply (2, &fn));
1813 #endif /* not NO_ARG_ARRAY */
1814 }
1815
1816 /* Call function fn on no arguments */
1817 Lisp_Object
1818 call0 (fn)
1819 Lisp_Object fn;
1820 {
1821 struct gcpro gcpro1;
1822
1823 GCPRO1 (fn);
1824 RETURN_UNGCPRO (Ffuncall (1, &fn));
1825 }
1826
1827 /* Call function fn with 1 argument arg1 */
1828 /* ARGSUSED */
1829 Lisp_Object
1830 call1 (fn, arg1)
1831 Lisp_Object fn, arg1;
1832 {
1833 struct gcpro gcpro1;
1834 #ifdef NO_ARG_ARRAY
1835 Lisp_Object args[2];
1836
1837 args[0] = fn;
1838 args[1] = arg1;
1839 GCPRO1 (args[0]);
1840 gcpro1.nvars = 2;
1841 RETURN_UNGCPRO (Ffuncall (2, args));
1842 #else /* not NO_ARG_ARRAY */
1843 GCPRO1 (fn);
1844 gcpro1.nvars = 2;
1845 RETURN_UNGCPRO (Ffuncall (2, &fn));
1846 #endif /* not NO_ARG_ARRAY */
1847 }
1848
1849 /* Call function fn with 2 arguments arg1, arg2 */
1850 /* ARGSUSED */
1851 Lisp_Object
1852 call2 (fn, arg1, arg2)
1853 Lisp_Object fn, arg1, arg2;
1854 {
1855 struct gcpro gcpro1;
1856 #ifdef NO_ARG_ARRAY
1857 Lisp_Object args[3];
1858 args[0] = fn;
1859 args[1] = arg1;
1860 args[2] = arg2;
1861 GCPRO1 (args[0]);
1862 gcpro1.nvars = 3;
1863 RETURN_UNGCPRO (Ffuncall (3, args));
1864 #else /* not NO_ARG_ARRAY */
1865 GCPRO1 (fn);
1866 gcpro1.nvars = 3;
1867 RETURN_UNGCPRO (Ffuncall (3, &fn));
1868 #endif /* not NO_ARG_ARRAY */
1869 }
1870
1871 /* Call function fn with 3 arguments arg1, arg2, arg3 */
1872 /* ARGSUSED */
1873 Lisp_Object
1874 call3 (fn, arg1, arg2, arg3)
1875 Lisp_Object fn, arg1, arg2, arg3;
1876 {
1877 struct gcpro gcpro1;
1878 #ifdef NO_ARG_ARRAY
1879 Lisp_Object args[4];
1880 args[0] = fn;
1881 args[1] = arg1;
1882 args[2] = arg2;
1883 args[3] = arg3;
1884 GCPRO1 (args[0]);
1885 gcpro1.nvars = 4;
1886 RETURN_UNGCPRO (Ffuncall (4, args));
1887 #else /* not NO_ARG_ARRAY */
1888 GCPRO1 (fn);
1889 gcpro1.nvars = 4;
1890 RETURN_UNGCPRO (Ffuncall (4, &fn));
1891 #endif /* not NO_ARG_ARRAY */
1892 }
1893
1894 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
1895 /* ARGSUSED */
1896 Lisp_Object
1897 call4 (fn, arg1, arg2, arg3, arg4)
1898 Lisp_Object fn, arg1, arg2, arg3, arg4;
1899 {
1900 struct gcpro gcpro1;
1901 #ifdef NO_ARG_ARRAY
1902 Lisp_Object args[5];
1903 args[0] = fn;
1904 args[1] = arg1;
1905 args[2] = arg2;
1906 args[3] = arg3;
1907 args[4] = arg4;
1908 GCPRO1 (args[0]);
1909 gcpro1.nvars = 5;
1910 RETURN_UNGCPRO (Ffuncall (5, args));
1911 #else /* not NO_ARG_ARRAY */
1912 GCPRO1 (fn);
1913 gcpro1.nvars = 5;
1914 RETURN_UNGCPRO (Ffuncall (5, &fn));
1915 #endif /* not NO_ARG_ARRAY */
1916 }
1917
1918 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
1919 /* ARGSUSED */
1920 Lisp_Object
1921 call5 (fn, arg1, arg2, arg3, arg4, arg5)
1922 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
1923 {
1924 struct gcpro gcpro1;
1925 #ifdef NO_ARG_ARRAY
1926 Lisp_Object args[6];
1927 args[0] = fn;
1928 args[1] = arg1;
1929 args[2] = arg2;
1930 args[3] = arg3;
1931 args[4] = arg4;
1932 args[5] = arg5;
1933 GCPRO1 (args[0]);
1934 gcpro1.nvars = 6;
1935 RETURN_UNGCPRO (Ffuncall (6, args));
1936 #else /* not NO_ARG_ARRAY */
1937 GCPRO1 (fn);
1938 gcpro1.nvars = 6;
1939 RETURN_UNGCPRO (Ffuncall (6, &fn));
1940 #endif /* not NO_ARG_ARRAY */
1941 }
1942
1943 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
1944 /* ARGSUSED */
1945 Lisp_Object
1946 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
1947 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
1948 {
1949 struct gcpro gcpro1;
1950 #ifdef NO_ARG_ARRAY
1951 Lisp_Object args[7];
1952 args[0] = fn;
1953 args[1] = arg1;
1954 args[2] = arg2;
1955 args[3] = arg3;
1956 args[4] = arg4;
1957 args[5] = arg5;
1958 args[6] = arg6;
1959 GCPRO1 (args[0]);
1960 gcpro1.nvars = 7;
1961 RETURN_UNGCPRO (Ffuncall (7, args));
1962 #else /* not NO_ARG_ARRAY */
1963 GCPRO1 (fn);
1964 gcpro1.nvars = 7;
1965 RETURN_UNGCPRO (Ffuncall (7, &fn));
1966 #endif /* not NO_ARG_ARRAY */
1967 }
1968
1969 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
1970 "Call first argument as a function, passing remaining arguments to it.\n\
1971 Thus, (funcall 'cons 'x 'y) returns (x . y).")
1972 (nargs, args)
1973 int nargs;
1974 Lisp_Object *args;
1975 {
1976 Lisp_Object fun;
1977 Lisp_Object funcar;
1978 int numargs = nargs - 1;
1979 Lisp_Object lisp_numargs;
1980 Lisp_Object val;
1981 struct backtrace backtrace;
1982 register Lisp_Object *internal_args;
1983 register int i;
1984
1985 QUIT;
1986 if (consing_since_gc > gc_cons_threshold)
1987 Fgarbage_collect ();
1988
1989 if (++lisp_eval_depth > max_lisp_eval_depth)
1990 {
1991 if (max_lisp_eval_depth < 100)
1992 max_lisp_eval_depth = 100;
1993 if (lisp_eval_depth > max_lisp_eval_depth)
1994 error ("Lisp nesting exceeds max-lisp-eval-depth");
1995 }
1996
1997 backtrace.next = backtrace_list;
1998 backtrace_list = &backtrace;
1999 backtrace.function = &args[0];
2000 backtrace.args = &args[1];
2001 backtrace.nargs = nargs - 1;
2002 backtrace.evalargs = 0;
2003 backtrace.debug_on_exit = 0;
2004
2005 if (debug_on_next_call)
2006 do_debug_on_call (Qlambda);
2007
2008 retry:
2009
2010 fun = args[0];
2011
2012 fun = Findirect_function (fun);
2013
2014 if (XTYPE (fun) == Lisp_Subr)
2015 {
2016 if (numargs < XSUBR (fun)->min_args
2017 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2018 {
2019 XFASTINT (lisp_numargs) = numargs;
2020 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
2021 }
2022
2023 if (XSUBR (fun)->max_args == UNEVALLED)
2024 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2025
2026 if (XSUBR (fun)->max_args == MANY)
2027 {
2028 val = (*XSUBR (fun)->function) (numargs, args + 1);
2029 goto done;
2030 }
2031
2032 if (XSUBR (fun)->max_args > numargs)
2033 {
2034 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
2035 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
2036 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2037 internal_args[i] = Qnil;
2038 }
2039 else
2040 internal_args = args + 1;
2041 switch (XSUBR (fun)->max_args)
2042 {
2043 case 0:
2044 val = (*XSUBR (fun)->function) ();
2045 goto done;
2046 case 1:
2047 val = (*XSUBR (fun)->function) (internal_args[0]);
2048 goto done;
2049 case 2:
2050 val = (*XSUBR (fun)->function) (internal_args[0],
2051 internal_args[1]);
2052 goto done;
2053 case 3:
2054 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2055 internal_args[2]);
2056 goto done;
2057 case 4:
2058 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2059 internal_args[2],
2060 internal_args[3]);
2061 goto done;
2062 case 5:
2063 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2064 internal_args[2], internal_args[3],
2065 internal_args[4]);
2066 goto done;
2067 case 6:
2068 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2069 internal_args[2], internal_args[3],
2070 internal_args[4], internal_args[5]);
2071 goto done;
2072 case 7:
2073 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2074 internal_args[2], internal_args[3],
2075 internal_args[4], internal_args[5],
2076 internal_args[6]);
2077 goto done;
2078
2079 default:
2080
2081 /* If a subr takes more than 6 arguments without using MANY
2082 or UNEVALLED, we need to extend this function to support it.
2083 Until this is done, there is no way to call the function. */
2084 abort ();
2085 }
2086 }
2087 if (XTYPE (fun) == Lisp_Compiled)
2088 val = funcall_lambda (fun, numargs, args + 1);
2089 else
2090 {
2091 if (!CONSP (fun))
2092 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2093 funcar = Fcar (fun);
2094 if (XTYPE (funcar) != Lisp_Symbol)
2095 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2096 if (EQ (funcar, Qlambda))
2097 val = funcall_lambda (fun, numargs, args + 1);
2098 else if (EQ (funcar, Qmocklisp))
2099 val = ml_apply (fun, Flist (numargs, args + 1));
2100 else if (EQ (funcar, Qautoload))
2101 {
2102 do_autoload (fun, args[0]);
2103 goto retry;
2104 }
2105 else
2106 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2107 }
2108 done:
2109 lisp_eval_depth--;
2110 if (backtrace.debug_on_exit)
2111 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2112 backtrace_list = backtrace.next;
2113 return val;
2114 }
2115 \f
2116 Lisp_Object
2117 apply_lambda (fun, args, eval_flag)
2118 Lisp_Object fun, args;
2119 int eval_flag;
2120 {
2121 Lisp_Object args_left;
2122 Lisp_Object numargs;
2123 register Lisp_Object *arg_vector;
2124 struct gcpro gcpro1, gcpro2, gcpro3;
2125 register int i;
2126 register Lisp_Object tem;
2127
2128 numargs = Flength (args);
2129 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2130 args_left = args;
2131
2132 GCPRO3 (*arg_vector, args_left, fun);
2133 gcpro1.nvars = 0;
2134
2135 for (i = 0; i < XINT (numargs);)
2136 {
2137 tem = Fcar (args_left), args_left = Fcdr (args_left);
2138 if (eval_flag) tem = Feval (tem);
2139 arg_vector[i++] = tem;
2140 gcpro1.nvars = i;
2141 }
2142
2143 UNGCPRO;
2144
2145 if (eval_flag)
2146 {
2147 backtrace_list->args = arg_vector;
2148 backtrace_list->nargs = i;
2149 }
2150 backtrace_list->evalargs = 0;
2151 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2152
2153 /* Do the debug-on-exit now, while arg_vector still exists. */
2154 if (backtrace_list->debug_on_exit)
2155 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2156 /* Don't do it again when we return to eval. */
2157 backtrace_list->debug_on_exit = 0;
2158 return tem;
2159 }
2160
2161 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2162 and return the result of evaluation.
2163 FUN must be either a lambda-expression or a compiled-code object. */
2164
2165 Lisp_Object
2166 funcall_lambda (fun, nargs, arg_vector)
2167 Lisp_Object fun;
2168 int nargs;
2169 register Lisp_Object *arg_vector;
2170 {
2171 Lisp_Object val, tem;
2172 register Lisp_Object syms_left;
2173 Lisp_Object numargs;
2174 register Lisp_Object next;
2175 int count = specpdl_ptr - specpdl;
2176 register int i;
2177 int optional = 0, rest = 0;
2178
2179 specbind (Qmocklisp_arguments, Qt); /* t means NOT mocklisp! */
2180
2181 XFASTINT (numargs) = nargs;
2182
2183 if (XTYPE (fun) == Lisp_Cons)
2184 syms_left = Fcar (Fcdr (fun));
2185 else if (XTYPE (fun) == Lisp_Compiled)
2186 syms_left = XVECTOR (fun)->contents[COMPILED_ARGLIST];
2187 else abort ();
2188
2189 i = 0;
2190 for (; !NILP (syms_left); syms_left = Fcdr (syms_left))
2191 {
2192 QUIT;
2193 next = Fcar (syms_left);
2194 while (XTYPE (next) != Lisp_Symbol)
2195 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2196 if (EQ (next, Qand_rest))
2197 rest = 1;
2198 else if (EQ (next, Qand_optional))
2199 optional = 1;
2200 else if (rest)
2201 {
2202 specbind (next, Flist (nargs - i, &arg_vector[i]));
2203 i = nargs;
2204 }
2205 else if (i < nargs)
2206 {
2207 tem = arg_vector[i++];
2208 specbind (next, tem);
2209 }
2210 else if (!optional)
2211 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2212 else
2213 specbind (next, Qnil);
2214 }
2215
2216 if (i < nargs)
2217 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
2218
2219 if (XTYPE (fun) == Lisp_Cons)
2220 val = Fprogn (Fcdr (Fcdr (fun)));
2221 else
2222 val = Fbyte_code (XVECTOR (fun)->contents[COMPILED_BYTECODE],
2223 XVECTOR (fun)->contents[COMPILED_CONSTANTS],
2224 XVECTOR (fun)->contents[COMPILED_STACK_DEPTH]);
2225 return unbind_to (count, val);
2226 }
2227 \f
2228 void
2229 grow_specpdl ()
2230 {
2231 register int count = specpdl_ptr - specpdl;
2232 if (specpdl_size >= max_specpdl_size)
2233 {
2234 if (max_specpdl_size < 400)
2235 max_specpdl_size = 400;
2236 if (specpdl_size >= max_specpdl_size)
2237 {
2238 if (!NILP (Vdebug_on_error))
2239 /* Leave room for some specpdl in the debugger. */
2240 max_specpdl_size = specpdl_size + 100;
2241 Fsignal (Qerror,
2242 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2243 }
2244 }
2245 specpdl_size *= 2;
2246 if (specpdl_size > max_specpdl_size)
2247 specpdl_size = max_specpdl_size;
2248 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2249 specpdl_ptr = specpdl + count;
2250 }
2251
2252 void
2253 specbind (symbol, value)
2254 Lisp_Object symbol, value;
2255 {
2256 extern void store_symval_forwarding (); /* in eval.c */
2257 Lisp_Object ovalue;
2258
2259 CHECK_SYMBOL (symbol, 0);
2260
2261 if (specpdl_ptr == specpdl + specpdl_size)
2262 grow_specpdl ();
2263 specpdl_ptr->symbol = symbol;
2264 specpdl_ptr->func = 0;
2265 ovalue = XSYMBOL (symbol)->value;
2266 specpdl_ptr->old_value = EQ (ovalue, Qunbound) ? Qunbound : Fsymbol_value (symbol);
2267 specpdl_ptr++;
2268 if (XTYPE (ovalue) == Lisp_Buffer_Objfwd)
2269 store_symval_forwarding (symbol, ovalue, value);
2270 else
2271 Fset (symbol, value);
2272 }
2273
2274 void
2275 record_unwind_protect (function, arg)
2276 Lisp_Object (*function)();
2277 Lisp_Object arg;
2278 {
2279 if (specpdl_ptr == specpdl + specpdl_size)
2280 grow_specpdl ();
2281 specpdl_ptr->func = function;
2282 specpdl_ptr->symbol = Qnil;
2283 specpdl_ptr->old_value = arg;
2284 specpdl_ptr++;
2285 }
2286
2287 Lisp_Object
2288 unbind_to (count, value)
2289 int count;
2290 Lisp_Object value;
2291 {
2292 int quitf = !NILP (Vquit_flag);
2293 struct gcpro gcpro1;
2294
2295 GCPRO1 (value);
2296
2297 Vquit_flag = Qnil;
2298
2299 while (specpdl_ptr != specpdl + count)
2300 {
2301 --specpdl_ptr;
2302 if (specpdl_ptr->func != 0)
2303 (*specpdl_ptr->func) (specpdl_ptr->old_value);
2304 /* Note that a "binding" of nil is really an unwind protect,
2305 so in that case the "old value" is a list of forms to evaluate. */
2306 else if (NILP (specpdl_ptr->symbol))
2307 Fprogn (specpdl_ptr->old_value);
2308 else
2309 Fset (specpdl_ptr->symbol, specpdl_ptr->old_value);
2310 }
2311 if (NILP (Vquit_flag) && quitf) Vquit_flag = Qt;
2312
2313 UNGCPRO;
2314
2315 return value;
2316 }
2317 \f
2318 #if 0
2319
2320 /* Get the value of symbol's global binding, even if that binding
2321 is not now dynamically visible. */
2322
2323 Lisp_Object
2324 top_level_value (symbol)
2325 Lisp_Object symbol;
2326 {
2327 register struct specbinding *ptr = specpdl;
2328
2329 CHECK_SYMBOL (symbol, 0);
2330 for (; ptr != specpdl_ptr; ptr++)
2331 {
2332 if (EQ (ptr->symbol, symbol))
2333 return ptr->old_value;
2334 }
2335 return Fsymbol_value (symbol);
2336 }
2337
2338 Lisp_Object
2339 top_level_set (symbol, newval)
2340 Lisp_Object symbol, newval;
2341 {
2342 register struct specbinding *ptr = specpdl;
2343
2344 CHECK_SYMBOL (symbol, 0);
2345 for (; ptr != specpdl_ptr; ptr++)
2346 {
2347 if (EQ (ptr->symbol, symbol))
2348 {
2349 ptr->old_value = newval;
2350 return newval;
2351 }
2352 }
2353 return Fset (symbol, newval);
2354 }
2355
2356 #endif /* 0 */
2357 \f
2358 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
2359 "Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.\n\
2360 The debugger is entered when that frame exits, if the flag is non-nil.")
2361 (level, flag)
2362 Lisp_Object level, flag;
2363 {
2364 register struct backtrace *backlist = backtrace_list;
2365 register int i;
2366
2367 CHECK_NUMBER (level, 0);
2368
2369 for (i = 0; backlist && i < XINT (level); i++)
2370 {
2371 backlist = backlist->next;
2372 }
2373
2374 if (backlist)
2375 backlist->debug_on_exit = !NILP (flag);
2376
2377 return flag;
2378 }
2379
2380 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
2381 "Print a trace of Lisp function calls currently active.\n\
2382 Output stream used is value of `standard-output'.")
2383 ()
2384 {
2385 register struct backtrace *backlist = backtrace_list;
2386 register int i;
2387 Lisp_Object tail;
2388 Lisp_Object tem;
2389 extern Lisp_Object Vprint_level;
2390 struct gcpro gcpro1;
2391
2392 XFASTINT (Vprint_level) = 3;
2393
2394 tail = Qnil;
2395 GCPRO1 (tail);
2396
2397 while (backlist)
2398 {
2399 write_string (backlist->debug_on_exit ? "* " : " ", 2);
2400 if (backlist->nargs == UNEVALLED)
2401 {
2402 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
2403 }
2404 else
2405 {
2406 tem = *backlist->function;
2407 Fprin1 (tem, Qnil); /* This can QUIT */
2408 write_string ("(", -1);
2409 if (backlist->nargs == MANY)
2410 {
2411 for (tail = *backlist->args, i = 0;
2412 !NILP (tail);
2413 tail = Fcdr (tail), i++)
2414 {
2415 if (i) write_string (" ", -1);
2416 Fprin1 (Fcar (tail), Qnil);
2417 }
2418 }
2419 else
2420 {
2421 for (i = 0; i < backlist->nargs; i++)
2422 {
2423 if (i) write_string (" ", -1);
2424 Fprin1 (backlist->args[i], Qnil);
2425 }
2426 }
2427 }
2428 write_string (")\n", -1);
2429 backlist = backlist->next;
2430 }
2431
2432 Vprint_level = Qnil;
2433 UNGCPRO;
2434 return Qnil;
2435 }
2436
2437 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, "",
2438 "Return the function and arguments N frames up from current execution point.\n\
2439 If that frame has not evaluated the arguments yet (or is a special form),\n\
2440 the value is (nil FUNCTION ARG-FORMS...).\n\
2441 If that frame has evaluated its arguments and called its function already,\n\
2442 the value is (t FUNCTION ARG-VALUES...).\n\
2443 A &rest arg is represented as the tail of the list ARG-VALUES.\n\
2444 FUNCTION is whatever was supplied as car of evaluated list,\n\
2445 or a lambda expression for macro calls.\n\
2446 If N is more than the number of frames, the value is nil.")
2447 (nframes)
2448 Lisp_Object nframes;
2449 {
2450 register struct backtrace *backlist = backtrace_list;
2451 register int i;
2452 Lisp_Object tem;
2453
2454 CHECK_NATNUM (nframes, 0);
2455
2456 /* Find the frame requested. */
2457 for (i = 0; i < XFASTINT (nframes); i++)
2458 backlist = backlist->next;
2459
2460 if (!backlist)
2461 return Qnil;
2462 if (backlist->nargs == UNEVALLED)
2463 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
2464 else
2465 {
2466 if (backlist->nargs == MANY)
2467 tem = *backlist->args;
2468 else
2469 tem = Flist (backlist->nargs, backlist->args);
2470
2471 return Fcons (Qt, Fcons (*backlist->function, tem));
2472 }
2473 }
2474 \f
2475 syms_of_eval ()
2476 {
2477 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
2478 "Limit on number of Lisp variable bindings & unwind-protects before error.");
2479
2480 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
2481 "Limit on depth in `eval', `apply' and `funcall' before error.\n\
2482 This limit is to catch infinite recursions for you before they cause\n\
2483 actual stack overflow in C, which would be fatal for Emacs.\n\
2484 You can safely make it considerably larger than its default value,\n\
2485 if that proves inconveniently small.");
2486
2487 DEFVAR_LISP ("quit-flag", &Vquit_flag,
2488 "Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.\n\
2489 Typing C-G sets `quit-flag' non-nil, regardless of `inhibit-quit'.");
2490 Vquit_flag = Qnil;
2491
2492 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
2493 "Non-nil inhibits C-g quitting from happening immediately.\n\
2494 Note that `quit-flag' will still be set by typing C-g,\n\
2495 so a quit will be signalled as soon as `inhibit-quit' is nil.\n\
2496 To prevent this happening, set `quit-flag' to nil\n\
2497 before making `inhibit-quit' nil.");
2498 Vinhibit_quit = Qnil;
2499
2500 Qinhibit_quit = intern ("inhibit-quit");
2501 staticpro (&Qinhibit_quit);
2502
2503 Qautoload = intern ("autoload");
2504 staticpro (&Qautoload);
2505
2506 Qdebug_on_error = intern ("debug-on-error");
2507 staticpro (&Qdebug_on_error);
2508
2509 Qmacro = intern ("macro");
2510 staticpro (&Qmacro);
2511
2512 /* Note that the process handling also uses Qexit, but we don't want
2513 to staticpro it twice, so we just do it here. */
2514 Qexit = intern ("exit");
2515 staticpro (&Qexit);
2516
2517 Qinteractive = intern ("interactive");
2518 staticpro (&Qinteractive);
2519
2520 Qcommandp = intern ("commandp");
2521 staticpro (&Qcommandp);
2522
2523 Qdefun = intern ("defun");
2524 staticpro (&Qdefun);
2525
2526 Qand_rest = intern ("&rest");
2527 staticpro (&Qand_rest);
2528
2529 Qand_optional = intern ("&optional");
2530 staticpro (&Qand_optional);
2531
2532 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
2533 "*Non-nil means automatically display a backtrace buffer\n\
2534 after any error that is handled by the editor command loop.\n\
2535 If the value is a list, an error only means to display a backtrace\n\
2536 if one of its condition symbols appears in the list.");
2537 Vstack_trace_on_error = Qnil;
2538
2539 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
2540 "*Non-nil means enter debugger if an error is signaled.\n\
2541 Does not apply to errors handled by `condition-case'.\n\
2542 If the value is a list, an error only means to enter the debugger\n\
2543 if one of its condition symbols appears in the list.\n\
2544 See also variable `debug-on-quit'.");
2545 Vdebug_on_error = Qnil;
2546
2547 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
2548 "*Non-nil means enter debugger if quit is signaled (C-G, for example).\n\
2549 Does not apply if quit is handled by a `condition-case'.");
2550 debug_on_quit = 0;
2551
2552 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
2553 "Non-nil means enter debugger before next `eval', `apply' or `funcall'.");
2554
2555 DEFVAR_LISP ("debugger", &Vdebugger,
2556 "Function to call to invoke debugger.\n\
2557 If due to frame exit, args are `exit' and the value being returned;\n\
2558 this function's value will be returned instead of that.\n\
2559 If due to error, args are `error' and a list of the args to `signal'.\n\
2560 If due to `apply' or `funcall' entry, one arg, `lambda'.\n\
2561 If due to `eval' entry, one arg, t.");
2562 Vdebugger = Qnil;
2563
2564 Qmocklisp_arguments = intern ("mocklisp-arguments");
2565 staticpro (&Qmocklisp_arguments);
2566 DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments,
2567 "While in a mocklisp function, the list of its unevaluated args.");
2568 Vmocklisp_arguments = Qt;
2569
2570 DEFVAR_LISP ("run-hooks", &Vrun_hooks,
2571 "Set to the function `run-hooks', if that function has been defined.\n\
2572 Otherwise, nil (in a bare Emacs without preloaded Lisp code).");
2573 Vrun_hooks = Qnil;
2574
2575 staticpro (&Vautoload_queue);
2576 Vautoload_queue = Qnil;
2577
2578 defsubr (&Sor);
2579 defsubr (&Sand);
2580 defsubr (&Sif);
2581 defsubr (&Scond);
2582 defsubr (&Sprogn);
2583 defsubr (&Sprog1);
2584 defsubr (&Sprog2);
2585 defsubr (&Ssetq);
2586 defsubr (&Squote);
2587 defsubr (&Sfunction);
2588 defsubr (&Sdefun);
2589 defsubr (&Sdefmacro);
2590 defsubr (&Sdefvar);
2591 defsubr (&Sdefconst);
2592 defsubr (&Suser_variable_p);
2593 defsubr (&Slet);
2594 defsubr (&SletX);
2595 defsubr (&Swhile);
2596 defsubr (&Smacroexpand);
2597 defsubr (&Scatch);
2598 defsubr (&Sthrow);
2599 defsubr (&Sunwind_protect);
2600 defsubr (&Scondition_case);
2601 defsubr (&Ssignal);
2602 defsubr (&Sinteractive_p);
2603 defsubr (&Scommandp);
2604 defsubr (&Sautoload);
2605 defsubr (&Seval);
2606 defsubr (&Sapply);
2607 defsubr (&Sfuncall);
2608 defsubr (&Sbacktrace_debug);
2609 defsubr (&Sbacktrace);
2610 defsubr (&Sbacktrace_frame);
2611 }