(syms_of_eval) <debug-on-error>: DOc fix.
[bpt/emacs.git] / src / eval.c
1 /* Evaluator for GNU Emacs Lisp interpreter.
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 99, 2000, 2001
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22
23 #include <config.h>
24 #include "lisp.h"
25 #include "blockinput.h"
26 #include "commands.h"
27 #include "keyboard.h"
28 #include "dispextern.h"
29 #include <setjmp.h>
30
31 /* This definition is duplicated in alloc.c and keyboard.c */
32 /* Putting it in lisp.h makes cc bomb out! */
33
34 struct backtrace
35 {
36 struct backtrace *next;
37 Lisp_Object *function;
38 Lisp_Object *args; /* Points to vector of args. */
39 int nargs; /* Length of vector.
40 If nargs is UNEVALLED, args points to slot holding
41 list of unevalled args */
42 char evalargs;
43 /* Nonzero means call value of debugger when done with this operation. */
44 char debug_on_exit;
45 };
46
47 struct backtrace *backtrace_list;
48
49 /* This structure helps implement the `catch' and `throw' control
50 structure. A struct catchtag contains all the information needed
51 to restore the state of the interpreter after a non-local jump.
52
53 Handlers for error conditions (represented by `struct handler'
54 structures) just point to a catch tag to do the cleanup required
55 for their jumps.
56
57 catchtag structures are chained together in the C calling stack;
58 the `next' member points to the next outer catchtag.
59
60 A call like (throw TAG VAL) searches for a catchtag whose `tag'
61 member is TAG, and then unbinds to it. The `val' member is used to
62 hold VAL while the stack is unwound; `val' is returned as the value
63 of the catch form.
64
65 All the other members are concerned with restoring the interpreter
66 state. */
67
68 struct catchtag
69 {
70 Lisp_Object tag;
71 Lisp_Object val;
72 struct catchtag *next;
73 struct gcpro *gcpro;
74 jmp_buf jmp;
75 struct backtrace *backlist;
76 struct handler *handlerlist;
77 int lisp_eval_depth;
78 int pdlcount;
79 int poll_suppress_count;
80 struct byte_stack *byte_stack;
81 };
82
83 struct catchtag *catchlist;
84
85 #ifdef DEBUG_GCPRO
86 /* Count levels of GCPRO to detect failure to UNGCPRO. */
87 int gcpro_level;
88 #endif
89
90 Lisp_Object Qautoload, Qmacro, Qexit, Qinteractive, Qcommandp, Qdefun;
91 Lisp_Object Qinhibit_quit, Vinhibit_quit, Vquit_flag;
92 Lisp_Object Qmocklisp_arguments, Vmocklisp_arguments, Qmocklisp;
93 Lisp_Object Qand_rest, Qand_optional;
94 Lisp_Object Qdebug_on_error;
95
96 /* This holds either the symbol `run-hooks' or nil.
97 It is nil at an early stage of startup, and when Emacs
98 is shutting down. */
99
100 Lisp_Object Vrun_hooks;
101
102 /* Non-nil means record all fset's and provide's, to be undone
103 if the file being autoloaded is not fully loaded.
104 They are recorded by being consed onto the front of Vautoload_queue:
105 (FUN . ODEF) for a defun, (OFEATURES . nil) for a provide. */
106
107 Lisp_Object Vautoload_queue;
108
109 /* Current number of specbindings allocated in specpdl. */
110
111 int specpdl_size;
112
113 /* Pointer to beginning of specpdl. */
114
115 struct specbinding *specpdl;
116
117 /* Pointer to first unused element in specpdl. */
118
119 struct specbinding *specpdl_ptr;
120
121 /* Maximum size allowed for specpdl allocation */
122
123 int max_specpdl_size;
124
125 /* Depth in Lisp evaluations and function calls. */
126
127 int lisp_eval_depth;
128
129 /* Maximum allowed depth in Lisp evaluations and function calls. */
130
131 int max_lisp_eval_depth;
132
133 /* Nonzero means enter debugger before next function call */
134
135 int debug_on_next_call;
136
137 /* Non-zero means debuffer may continue. This is zero when the
138 debugger is called during redisplay, where it might not be safe to
139 continue the interrupted redisplay. */
140
141 int debugger_may_continue;
142
143 /* List of conditions (non-nil atom means all) which cause a backtrace
144 if an error is handled by the command loop's error handler. */
145
146 Lisp_Object Vstack_trace_on_error;
147
148 /* List of conditions (non-nil atom means all) which enter the debugger
149 if an error is handled by the command loop's error handler. */
150
151 Lisp_Object Vdebug_on_error;
152
153 /* List of conditions and regexps specifying error messages which
154 do not enter the debugger even if Vdebug_on_errors says they should. */
155
156 Lisp_Object Vdebug_ignored_errors;
157
158 /* Non-nil means call the debugger even if the error will be handled. */
159
160 Lisp_Object Vdebug_on_signal;
161
162 /* Hook for edebug to use. */
163
164 Lisp_Object Vsignal_hook_function;
165
166 /* Nonzero means enter debugger if a quit signal
167 is handled by the command loop's error handler. */
168
169 int debug_on_quit;
170
171 /* The value of num_nonmacro_input_events as of the last time we
172 started to enter the debugger. If we decide to enter the debugger
173 again when this is still equal to num_nonmacro_input_events, then we
174 know that the debugger itself has an error, and we should just
175 signal the error instead of entering an infinite loop of debugger
176 invocations. */
177
178 int when_entered_debugger;
179
180 Lisp_Object Vdebugger;
181
182 /* The function from which the last `signal' was called. Set in
183 Fsignal. */
184
185 Lisp_Object Vsignaling_function;
186
187 /* Set to non-zero while processing X events. Checked in Feval to
188 make sure the Lisp interpreter isn't called from a signal handler,
189 which is unsafe because the interpreter isn't reentrant. */
190
191 int handling_signal;
192
193 void specbind (), record_unwind_protect ();
194
195 Lisp_Object run_hook_with_args ();
196
197 Lisp_Object funcall_lambda ();
198 extern Lisp_Object ml_apply (); /* Apply a mocklisp function to unevaluated argument list */
199
200 void
201 init_eval_once ()
202 {
203 specpdl_size = 50;
204 specpdl = (struct specbinding *) xmalloc (specpdl_size * sizeof (struct specbinding));
205 specpdl_ptr = specpdl;
206 max_specpdl_size = 600;
207 max_lisp_eval_depth = 300;
208
209 Vrun_hooks = Qnil;
210 }
211
212 void
213 init_eval ()
214 {
215 specpdl_ptr = specpdl;
216 catchlist = 0;
217 handlerlist = 0;
218 backtrace_list = 0;
219 Vquit_flag = Qnil;
220 debug_on_next_call = 0;
221 lisp_eval_depth = 0;
222 #ifdef DEBUG_GCPRO
223 gcpro_level = 0;
224 #endif
225 /* This is less than the initial value of num_nonmacro_input_events. */
226 when_entered_debugger = -1;
227 }
228
229 Lisp_Object
230 call_debugger (arg)
231 Lisp_Object arg;
232 {
233 int debug_while_redisplaying;
234 int count = specpdl_ptr - specpdl;
235 Lisp_Object val;
236
237 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
238 max_lisp_eval_depth = lisp_eval_depth + 20;
239
240 if (specpdl_size + 40 > max_specpdl_size)
241 max_specpdl_size = specpdl_size + 40;
242
243 #ifdef HAVE_X_WINDOWS
244 if (display_hourglass_p)
245 cancel_hourglass ();
246 #endif
247
248 debug_on_next_call = 0;
249 when_entered_debugger = num_nonmacro_input_events;
250
251 /* Resetting redisplaying_p to 0 makes sure that debug output is
252 displayed if the debugger is invoked during redisplay. */
253 debug_while_redisplaying = redisplaying_p;
254 redisplaying_p = 0;
255 specbind (intern ("debugger-may-continue"),
256 debug_while_redisplaying ? Qnil : Qt);
257
258 val = apply1 (Vdebugger, arg);
259
260 /* Interrupting redisplay and resuming it later is not safe under
261 all circumstances. So, when the debugger returns, abort the
262 interupted redisplay by going back to the top-level. */
263 if (debug_while_redisplaying)
264 Ftop_level ();
265
266 return unbind_to (count, val);
267 }
268
269 void
270 do_debug_on_call (code)
271 Lisp_Object code;
272 {
273 debug_on_next_call = 0;
274 backtrace_list->debug_on_exit = 1;
275 call_debugger (Fcons (code, Qnil));
276 }
277 \f
278 /* NOTE!!! Every function that can call EVAL must protect its args
279 and temporaries from garbage collection while it needs them.
280 The definition of `For' shows what you have to do. */
281
282 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
283 "Eval args until one of them yields non-nil, then return that value.\n\
284 The remaining args are not evalled at all.\n\
285 If all args return nil, return nil.")
286 (args)
287 Lisp_Object args;
288 {
289 register Lisp_Object val;
290 Lisp_Object args_left;
291 struct gcpro gcpro1;
292
293 if (NILP(args))
294 return Qnil;
295
296 args_left = args;
297 GCPRO1 (args_left);
298
299 do
300 {
301 val = Feval (Fcar (args_left));
302 if (!NILP (val))
303 break;
304 args_left = Fcdr (args_left);
305 }
306 while (!NILP(args_left));
307
308 UNGCPRO;
309 return val;
310 }
311
312 DEFUN ("and", Fand, Sand, 0, UNEVALLED, 0,
313 "Eval args until one of them yields nil, then return nil.\n\
314 The remaining args are not evalled at all.\n\
315 If no arg yields nil, return the last arg's value.")
316 (args)
317 Lisp_Object args;
318 {
319 register Lisp_Object val;
320 Lisp_Object args_left;
321 struct gcpro gcpro1;
322
323 if (NILP(args))
324 return Qt;
325
326 args_left = args;
327 GCPRO1 (args_left);
328
329 do
330 {
331 val = Feval (Fcar (args_left));
332 if (NILP (val))
333 break;
334 args_left = Fcdr (args_left);
335 }
336 while (!NILP(args_left));
337
338 UNGCPRO;
339 return val;
340 }
341
342 DEFUN ("if", Fif, Sif, 2, UNEVALLED, 0,
343 "If COND yields non-nil, do THEN, else do ELSE...\n\
344 Returns the value of THEN or the value of the last of the ELSE's.\n\
345 THEN must be one expression, but ELSE... can be zero or more expressions.\n\
346 If COND yields nil, and there are no ELSE's, the value is nil.")
347 (args)
348 Lisp_Object args;
349 {
350 register Lisp_Object cond;
351 struct gcpro gcpro1;
352
353 GCPRO1 (args);
354 cond = Feval (Fcar (args));
355 UNGCPRO;
356
357 if (!NILP (cond))
358 return Feval (Fcar (Fcdr (args)));
359 return Fprogn (Fcdr (Fcdr (args)));
360 }
361
362 DEFUN ("cond", Fcond, Scond, 0, UNEVALLED, 0,
363 "Try each clause until one succeeds.\n\
364 Each clause looks like (CONDITION BODY...). CONDITION is evaluated\n\
365 and, if the value is non-nil, this clause succeeds:\n\
366 then the expressions in BODY are evaluated and the last one's\n\
367 value is the value of the cond-form.\n\
368 If no clause succeeds, cond returns nil.\n\
369 If a clause has one element, as in (CONDITION),\n\
370 CONDITION's value if non-nil is returned from the cond-form.")
371 (args)
372 Lisp_Object args;
373 {
374 register Lisp_Object clause, val;
375 struct gcpro gcpro1;
376
377 val = Qnil;
378 GCPRO1 (args);
379 while (!NILP (args))
380 {
381 clause = Fcar (args);
382 val = Feval (Fcar (clause));
383 if (!NILP (val))
384 {
385 if (!EQ (XCDR (clause), Qnil))
386 val = Fprogn (XCDR (clause));
387 break;
388 }
389 args = XCDR (args);
390 }
391 UNGCPRO;
392
393 return val;
394 }
395
396 DEFUN ("progn", Fprogn, Sprogn, 0, UNEVALLED, 0,
397 "Eval BODY forms sequentially and return value of last one.")
398 (args)
399 Lisp_Object args;
400 {
401 register Lisp_Object val, tem;
402 Lisp_Object args_left;
403 struct gcpro gcpro1;
404
405 /* In Mocklisp code, symbols at the front of the progn arglist
406 are to be bound to zero. */
407 if (!EQ (Vmocklisp_arguments, Qt))
408 {
409 val = make_number (0);
410 while (!NILP (args) && (tem = Fcar (args), SYMBOLP (tem)))
411 {
412 QUIT;
413 specbind (tem, val), args = Fcdr (args);
414 }
415 }
416
417 if (NILP(args))
418 return Qnil;
419
420 args_left = args;
421 GCPRO1 (args_left);
422
423 do
424 {
425 val = Feval (Fcar (args_left));
426 args_left = Fcdr (args_left);
427 }
428 while (!NILP(args_left));
429
430 UNGCPRO;
431 return val;
432 }
433
434 DEFUN ("prog1", Fprog1, Sprog1, 1, UNEVALLED, 0,
435 "Eval FIRST and BODY sequentially; value from FIRST.\n\
436 The value of FIRST is saved during the evaluation of the remaining args,\n\
437 whose values are discarded.")
438 (args)
439 Lisp_Object args;
440 {
441 Lisp_Object val;
442 register Lisp_Object args_left;
443 struct gcpro gcpro1, gcpro2;
444 register int argnum = 0;
445
446 if (NILP(args))
447 return Qnil;
448
449 args_left = args;
450 val = Qnil;
451 GCPRO2 (args, val);
452
453 do
454 {
455 if (!(argnum++))
456 val = Feval (Fcar (args_left));
457 else
458 Feval (Fcar (args_left));
459 args_left = Fcdr (args_left);
460 }
461 while (!NILP(args_left));
462
463 UNGCPRO;
464 return val;
465 }
466
467 DEFUN ("prog2", Fprog2, Sprog2, 2, UNEVALLED, 0,
468 "Eval X, Y and BODY sequentially; value from Y.\n\
469 The value of Y is saved during the evaluation of the remaining args,\n\
470 whose values are discarded.")
471 (args)
472 Lisp_Object args;
473 {
474 Lisp_Object val;
475 register Lisp_Object args_left;
476 struct gcpro gcpro1, gcpro2;
477 register int argnum = -1;
478
479 val = Qnil;
480
481 if (NILP (args))
482 return Qnil;
483
484 args_left = args;
485 val = Qnil;
486 GCPRO2 (args, val);
487
488 do
489 {
490 if (!(argnum++))
491 val = Feval (Fcar (args_left));
492 else
493 Feval (Fcar (args_left));
494 args_left = Fcdr (args_left);
495 }
496 while (!NILP (args_left));
497
498 UNGCPRO;
499 return val;
500 }
501
502 DEFUN ("setq", Fsetq, Ssetq, 0, UNEVALLED, 0,
503 "Set each SYM to the value of its VAL.\n\
504 The symbols SYM are variables; they are literal (not evaluated).\n\
505 The values VAL are expressions; they are evaluated.\n\
506 Thus, (setq x (1+ y)) sets `x' to the value of `(1+ y)'.\n\
507 The second VAL is not computed until after the first SYM is set, and so on;\n\
508 each VAL can use the new value of variables set earlier in the `setq'.\n\
509 The return value of the `setq' form is the value of the last VAL.")
510 (args)
511 Lisp_Object args;
512 {
513 register Lisp_Object args_left;
514 register Lisp_Object val, sym;
515 struct gcpro gcpro1;
516
517 if (NILP(args))
518 return Qnil;
519
520 args_left = args;
521 GCPRO1 (args);
522
523 do
524 {
525 val = Feval (Fcar (Fcdr (args_left)));
526 sym = Fcar (args_left);
527 Fset (sym, val);
528 args_left = Fcdr (Fcdr (args_left));
529 }
530 while (!NILP(args_left));
531
532 UNGCPRO;
533 return val;
534 }
535
536 DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0,
537 "Return the argument, without evaluating it. `(quote x)' yields `x'.")
538 (args)
539 Lisp_Object args;
540 {
541 return Fcar (args);
542 }
543
544 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
545 "Like `quote', but preferred for objects which are functions.\n\
546 In byte compilation, `function' causes its argument to be compiled.\n\
547 `quote' cannot do that.")
548 (args)
549 Lisp_Object args;
550 {
551 return Fcar (args);
552 }
553
554
555 DEFUN ("interactive-p", Finteractive_p, Sinteractive_p, 0, 0, 0,
556 "Return t if function in which this appears was called interactively.\n\
557 This means that the function was called with call-interactively (which\n\
558 includes being called as the binding of a key)\n\
559 and input is currently coming from the keyboard (not in keyboard macro).")
560 ()
561 {
562 return interactive_p (1) ? Qt : Qnil;
563 }
564
565
566 /* Return 1 if function in which this appears was called
567 interactively. This means that the function was called with
568 call-interactively (which includes being called as the binding of
569 a key) and input is currently coming from the keyboard (not in
570 keyboard macro).
571
572 EXCLUDE_SUBRS_P non-zero means always return 0 if the function
573 called is a built-in. */
574
575 int
576 interactive_p (exclude_subrs_p)
577 int exclude_subrs_p;
578 {
579 struct backtrace *btp;
580 Lisp_Object fun;
581
582 if (!INTERACTIVE)
583 return 0;
584
585 btp = backtrace_list;
586
587 /* If this isn't a byte-compiled function, there may be a frame at
588 the top for Finteractive_p. If so, skip it. */
589 fun = Findirect_function (*btp->function);
590 if (SUBRP (fun) && XSUBR (fun) == &Sinteractive_p)
591 btp = btp->next;
592
593 /* If we're running an Emacs 18-style byte-compiled function, there
594 may be a frame for Fbytecode. Now, given the strictest
595 definition, this function isn't really being called
596 interactively, but because that's the way Emacs 18 always builds
597 byte-compiled functions, we'll accept it for now. */
598 if (EQ (*btp->function, Qbytecode))
599 btp = btp->next;
600
601 /* If this isn't a byte-compiled function, then we may now be
602 looking at several frames for special forms. Skip past them. */
603 while (btp &&
604 btp->nargs == UNEVALLED)
605 btp = btp->next;
606
607 /* btp now points at the frame of the innermost function that isn't
608 a special form, ignoring frames for Finteractive_p and/or
609 Fbytecode at the top. If this frame is for a built-in function
610 (such as load or eval-region) return nil. */
611 fun = Findirect_function (*btp->function);
612 if (exclude_subrs_p && SUBRP (fun))
613 return 0;
614
615 /* btp points to the frame of a Lisp function that called interactive-p.
616 Return t if that function was called interactively. */
617 if (btp && btp->next && EQ (*btp->next->function, Qcall_interactively))
618 return 1;
619 return 0;
620 }
621
622
623 DEFUN ("defun", Fdefun, Sdefun, 2, UNEVALLED, 0,
624 "Define NAME as a function.\n\
625 The definition is (lambda ARGLIST [DOCSTRING] BODY...).\n\
626 See also the function `interactive'.")
627 (args)
628 Lisp_Object args;
629 {
630 register Lisp_Object fn_name;
631 register Lisp_Object defn;
632
633 fn_name = Fcar (args);
634 defn = Fcons (Qlambda, Fcdr (args));
635 if (!NILP (Vpurify_flag))
636 defn = Fpurecopy (defn);
637 Ffset (fn_name, defn);
638 LOADHIST_ATTACH (fn_name);
639 return fn_name;
640 }
641
642 DEFUN ("defmacro", Fdefmacro, Sdefmacro, 2, UNEVALLED, 0,
643 "Define NAME as a macro.\n\
644 The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).\n\
645 When the macro is called, as in (NAME ARGS...),\n\
646 the function (lambda ARGLIST BODY...) is applied to\n\
647 the list ARGS... as it appears in the expression,\n\
648 and the result should be a form to be evaluated instead of the original.")
649 (args)
650 Lisp_Object args;
651 {
652 register Lisp_Object fn_name;
653 register Lisp_Object defn;
654
655 fn_name = Fcar (args);
656 defn = Fcons (Qmacro, Fcons (Qlambda, Fcdr (args)));
657 if (!NILP (Vpurify_flag))
658 defn = Fpurecopy (defn);
659 Ffset (fn_name, defn);
660 LOADHIST_ATTACH (fn_name);
661 return fn_name;
662 }
663
664 DEFUN ("defvar", Fdefvar, Sdefvar, 1, UNEVALLED, 0,
665 "Define SYMBOL as a variable.\n\
666 You are not required to define a variable in order to use it,\n\
667 but the definition can supply documentation and an initial value\n\
668 in a way that tags can recognize.\n\n\
669 INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.\n\
670 If SYMBOL is buffer-local, its default value is what is set;\n\
671 buffer-local values are not affected.\n\
672 INITVALUE and DOCSTRING are optional.\n\
673 If DOCSTRING starts with *, this variable is identified as a user option.\n\
674 This means that M-x set-variable recognizes it.\n\
675 See also `user-variable-p'.\n\
676 If INITVALUE is missing, SYMBOL's value is not set.")
677 (args)
678 Lisp_Object args;
679 {
680 register Lisp_Object sym, tem, tail;
681
682 sym = Fcar (args);
683 tail = Fcdr (args);
684 if (!NILP (Fcdr (Fcdr (tail))))
685 error ("too many arguments");
686
687 if (!NILP (tail))
688 {
689 tem = Fdefault_boundp (sym);
690 if (NILP (tem))
691 Fset_default (sym, Feval (Fcar (Fcdr (args))));
692 }
693 tail = Fcdr (Fcdr (args));
694 if (!NILP (Fcar (tail)))
695 {
696 tem = Fcar (tail);
697 if (!NILP (Vpurify_flag))
698 tem = Fpurecopy (tem);
699 Fput (sym, Qvariable_documentation, tem);
700 }
701 LOADHIST_ATTACH (sym);
702 return sym;
703 }
704
705 DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0,
706 "Define SYMBOL as a constant variable.\n\
707 The intent is that neither programs nor users should ever change this value.\n\
708 Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\
709 If SYMBOL is buffer-local, its default value is what is set;\n\
710 buffer-local values are not affected.\n\
711 DOCSTRING is optional.")
712 (args)
713 Lisp_Object args;
714 {
715 register Lisp_Object sym, tem;
716
717 sym = Fcar (args);
718 if (!NILP (Fcdr (Fcdr (Fcdr (args)))))
719 error ("too many arguments");
720
721 tem = Feval (Fcar (Fcdr (args)));
722 if (!NILP (Vpurify_flag))
723 tem = Fpurecopy (tem);
724 Fset_default (sym, tem);
725 tem = Fcar (Fcdr (Fcdr (args)));
726 if (!NILP (tem))
727 {
728 if (!NILP (Vpurify_flag))
729 tem = Fpurecopy (tem);
730 Fput (sym, Qvariable_documentation, tem);
731 }
732 LOADHIST_ATTACH (sym);
733 return sym;
734 }
735
736 DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0,
737 "Returns t if VARIABLE is intended to be set and modified by users.\n\
738 \(The alternative is a variable used internally in a Lisp program.)\n\
739 Determined by whether the first character of the documentation\n\
740 for the variable is `*' or if the variable is customizable (has a non-nil\n\
741 value of any of `custom-type', `custom-loads' or `standard-value'\n\
742 on its property list).")
743 (variable)
744 Lisp_Object variable;
745 {
746 Lisp_Object documentation;
747
748 if (!SYMBOLP (variable))
749 return Qnil;
750
751 documentation = Fget (variable, Qvariable_documentation);
752 if (INTEGERP (documentation) && XINT (documentation) < 0)
753 return Qt;
754 if (STRINGP (documentation)
755 && ((unsigned char) XSTRING (documentation)->data[0] == '*'))
756 return Qt;
757 /* If it is (STRING . INTEGER), a negative integer means a user variable. */
758 if (CONSP (documentation)
759 && STRINGP (XCAR (documentation))
760 && INTEGERP (XCDR (documentation))
761 && XINT (XCDR (documentation)) < 0)
762 return Qt;
763 /* Customizable? */
764 if ((!NILP (Fget (variable, intern ("custom-type"))))
765 || (!NILP (Fget (variable, intern ("custom-loads"))))
766 || (!NILP (Fget (variable, intern ("standard-value")))))
767 return Qt;
768 return Qnil;
769 }
770 \f
771 DEFUN ("let*", FletX, SletX, 1, UNEVALLED, 0,
772 "Bind variables according to VARLIST then eval BODY.\n\
773 The value of the last form in BODY is returned.\n\
774 Each element of VARLIST is a symbol (which is bound to nil)\n\
775 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
776 Each VALUEFORM can refer to the symbols already bound by this VARLIST.")
777 (args)
778 Lisp_Object args;
779 {
780 Lisp_Object varlist, val, elt;
781 int count = specpdl_ptr - specpdl;
782 struct gcpro gcpro1, gcpro2, gcpro3;
783
784 GCPRO3 (args, elt, varlist);
785
786 varlist = Fcar (args);
787 while (!NILP (varlist))
788 {
789 QUIT;
790 elt = Fcar (varlist);
791 if (SYMBOLP (elt))
792 specbind (elt, Qnil);
793 else if (! NILP (Fcdr (Fcdr (elt))))
794 Fsignal (Qerror,
795 Fcons (build_string ("`let' bindings can have only one value-form"),
796 elt));
797 else
798 {
799 val = Feval (Fcar (Fcdr (elt)));
800 specbind (Fcar (elt), val);
801 }
802 varlist = Fcdr (varlist);
803 }
804 UNGCPRO;
805 val = Fprogn (Fcdr (args));
806 return unbind_to (count, val);
807 }
808
809 DEFUN ("let", Flet, Slet, 1, UNEVALLED, 0,
810 "Bind variables according to VARLIST then eval BODY.\n\
811 The value of the last form in BODY is returned.\n\
812 Each element of VARLIST is a symbol (which is bound to nil)\n\
813 or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).\n\
814 All the VALUEFORMs are evalled before any symbols are bound.")
815 (args)
816 Lisp_Object args;
817 {
818 Lisp_Object *temps, tem;
819 register Lisp_Object elt, varlist;
820 int count = specpdl_ptr - specpdl;
821 register int argnum;
822 struct gcpro gcpro1, gcpro2;
823
824 varlist = Fcar (args);
825
826 /* Make space to hold the values to give the bound variables */
827 elt = Flength (varlist);
828 temps = (Lisp_Object *) alloca (XFASTINT (elt) * sizeof (Lisp_Object));
829
830 /* Compute the values and store them in `temps' */
831
832 GCPRO2 (args, *temps);
833 gcpro2.nvars = 0;
834
835 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
836 {
837 QUIT;
838 elt = Fcar (varlist);
839 if (SYMBOLP (elt))
840 temps [argnum++] = Qnil;
841 else if (! NILP (Fcdr (Fcdr (elt))))
842 Fsignal (Qerror,
843 Fcons (build_string ("`let' bindings can have only one value-form"),
844 elt));
845 else
846 temps [argnum++] = Feval (Fcar (Fcdr (elt)));
847 gcpro2.nvars = argnum;
848 }
849 UNGCPRO;
850
851 varlist = Fcar (args);
852 for (argnum = 0; !NILP (varlist); varlist = Fcdr (varlist))
853 {
854 elt = Fcar (varlist);
855 tem = temps[argnum++];
856 if (SYMBOLP (elt))
857 specbind (elt, tem);
858 else
859 specbind (Fcar (elt), tem);
860 }
861
862 elt = Fprogn (Fcdr (args));
863 return unbind_to (count, elt);
864 }
865
866 DEFUN ("while", Fwhile, Swhile, 1, UNEVALLED, 0,
867 "If TEST yields non-nil, eval BODY... and repeat.\n\
868 The order of execution is thus TEST, BODY, TEST, BODY and so on\n\
869 until TEST returns nil.")
870 (args)
871 Lisp_Object args;
872 {
873 Lisp_Object test, body, tem;
874 struct gcpro gcpro1, gcpro2;
875
876 GCPRO2 (test, body);
877
878 test = Fcar (args);
879 body = Fcdr (args);
880 while (tem = Feval (test),
881 (!EQ (Vmocklisp_arguments, Qt) ? XINT (tem) : !NILP (tem)))
882 {
883 QUIT;
884 Fprogn (body);
885 }
886
887 UNGCPRO;
888 return Qnil;
889 }
890
891 DEFUN ("macroexpand", Fmacroexpand, Smacroexpand, 1, 2, 0,
892 "Return result of expanding macros at top level of FORM.\n\
893 If FORM is not a macro call, it is returned unchanged.\n\
894 Otherwise, the macro is expanded and the expansion is considered\n\
895 in place of FORM. When a non-macro-call results, it is returned.\n\n\
896 The second optional arg ENVIRONMENT specifies an environment of macro\n\
897 definitions to shadow the loaded ones for use in file byte-compilation.")
898 (form, environment)
899 Lisp_Object form;
900 Lisp_Object environment;
901 {
902 /* With cleanups from Hallvard Furuseth. */
903 register Lisp_Object expander, sym, def, tem;
904
905 while (1)
906 {
907 /* Come back here each time we expand a macro call,
908 in case it expands into another macro call. */
909 if (!CONSP (form))
910 break;
911 /* Set SYM, give DEF and TEM right values in case SYM is not a symbol. */
912 def = sym = XCAR (form);
913 tem = Qnil;
914 /* Trace symbols aliases to other symbols
915 until we get a symbol that is not an alias. */
916 while (SYMBOLP (def))
917 {
918 QUIT;
919 sym = def;
920 tem = Fassq (sym, environment);
921 if (NILP (tem))
922 {
923 def = XSYMBOL (sym)->function;
924 if (!EQ (def, Qunbound))
925 continue;
926 }
927 break;
928 }
929 /* Right now TEM is the result from SYM in ENVIRONMENT,
930 and if TEM is nil then DEF is SYM's function definition. */
931 if (NILP (tem))
932 {
933 /* SYM is not mentioned in ENVIRONMENT.
934 Look at its function definition. */
935 if (EQ (def, Qunbound) || !CONSP (def))
936 /* Not defined or definition not suitable */
937 break;
938 if (EQ (XCAR (def), Qautoload))
939 {
940 /* Autoloading function: will it be a macro when loaded? */
941 tem = Fnth (make_number (4), def);
942 if (EQ (tem, Qt) || EQ (tem, Qmacro))
943 /* Yes, load it and try again. */
944 {
945 struct gcpro gcpro1;
946 GCPRO1 (form);
947 do_autoload (def, sym);
948 UNGCPRO;
949 continue;
950 }
951 else
952 break;
953 }
954 else if (!EQ (XCAR (def), Qmacro))
955 break;
956 else expander = XCDR (def);
957 }
958 else
959 {
960 expander = XCDR (tem);
961 if (NILP (expander))
962 break;
963 }
964 form = apply1 (expander, XCDR (form));
965 }
966 return form;
967 }
968 \f
969 DEFUN ("catch", Fcatch, Scatch, 1, UNEVALLED, 0,
970 "Eval BODY allowing nonlocal exits using `throw'.\n\
971 TAG is evalled to get the tag to use; it must not be nil.\n\
972 \n\
973 Then the BODY is executed.\n\
974 Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.\n\
975 If no throw happens, `catch' returns the value of the last BODY form.\n\
976 If a throw happens, it specifies the value to return from `catch'.")
977 (args)
978 Lisp_Object args;
979 {
980 register Lisp_Object tag;
981 struct gcpro gcpro1;
982
983 GCPRO1 (args);
984 tag = Feval (Fcar (args));
985 UNGCPRO;
986 return internal_catch (tag, Fprogn, Fcdr (args));
987 }
988
989 /* Set up a catch, then call C function FUNC on argument ARG.
990 FUNC should return a Lisp_Object.
991 This is how catches are done from within C code. */
992
993 Lisp_Object
994 internal_catch (tag, func, arg)
995 Lisp_Object tag;
996 Lisp_Object (*func) ();
997 Lisp_Object arg;
998 {
999 /* This structure is made part of the chain `catchlist'. */
1000 struct catchtag c;
1001
1002 /* Fill in the components of c, and put it on the list. */
1003 c.next = catchlist;
1004 c.tag = tag;
1005 c.val = Qnil;
1006 c.backlist = backtrace_list;
1007 c.handlerlist = handlerlist;
1008 c.lisp_eval_depth = lisp_eval_depth;
1009 c.pdlcount = specpdl_ptr - specpdl;
1010 c.poll_suppress_count = poll_suppress_count;
1011 c.gcpro = gcprolist;
1012 c.byte_stack = byte_stack_list;
1013 catchlist = &c;
1014
1015 /* Call FUNC. */
1016 if (! _setjmp (c.jmp))
1017 c.val = (*func) (arg);
1018
1019 /* Throw works by a longjmp that comes right here. */
1020 catchlist = c.next;
1021 return c.val;
1022 }
1023
1024 /* Unwind the specbind, catch, and handler stacks back to CATCH, and
1025 jump to that CATCH, returning VALUE as the value of that catch.
1026
1027 This is the guts Fthrow and Fsignal; they differ only in the way
1028 they choose the catch tag to throw to. A catch tag for a
1029 condition-case form has a TAG of Qnil.
1030
1031 Before each catch is discarded, unbind all special bindings and
1032 execute all unwind-protect clauses made above that catch. Unwind
1033 the handler stack as we go, so that the proper handlers are in
1034 effect for each unwind-protect clause we run. At the end, restore
1035 some static info saved in CATCH, and longjmp to the location
1036 specified in the
1037
1038 This is used for correct unwinding in Fthrow and Fsignal. */
1039
1040 static void
1041 unwind_to_catch (catch, value)
1042 struct catchtag *catch;
1043 Lisp_Object value;
1044 {
1045 register int last_time;
1046
1047 /* Save the value in the tag. */
1048 catch->val = value;
1049
1050 /* Restore the polling-suppression count. */
1051 set_poll_suppress_count (catch->poll_suppress_count);
1052
1053 do
1054 {
1055 last_time = catchlist == catch;
1056
1057 /* Unwind the specpdl stack, and then restore the proper set of
1058 handlers. */
1059 unbind_to (catchlist->pdlcount, Qnil);
1060 handlerlist = catchlist->handlerlist;
1061 catchlist = catchlist->next;
1062 }
1063 while (! last_time);
1064
1065 byte_stack_list = catch->byte_stack;
1066 gcprolist = catch->gcpro;
1067 #ifdef DEBUG_GCPRO
1068 if (gcprolist != 0)
1069 gcpro_level = gcprolist->level + 1;
1070 else
1071 gcpro_level = 0;
1072 #endif
1073 backtrace_list = catch->backlist;
1074 lisp_eval_depth = catch->lisp_eval_depth;
1075
1076 _longjmp (catch->jmp, 1);
1077 }
1078
1079 DEFUN ("throw", Fthrow, Sthrow, 2, 2, 0,
1080 "Throw to the catch for TAG and return VALUE from it.\n\
1081 Both TAG and VALUE are evalled.")
1082 (tag, value)
1083 register Lisp_Object tag, value;
1084 {
1085 register struct catchtag *c;
1086
1087 while (1)
1088 {
1089 if (!NILP (tag))
1090 for (c = catchlist; c; c = c->next)
1091 {
1092 if (EQ (c->tag, tag))
1093 unwind_to_catch (c, value);
1094 }
1095 tag = Fsignal (Qno_catch, Fcons (tag, Fcons (value, Qnil)));
1096 }
1097 }
1098
1099
1100 DEFUN ("unwind-protect", Funwind_protect, Sunwind_protect, 1, UNEVALLED, 0,
1101 "Do BODYFORM, protecting with UNWINDFORMS.\n\
1102 If BODYFORM completes normally, its value is returned\n\
1103 after executing the UNWINDFORMS.\n\
1104 If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.")
1105 (args)
1106 Lisp_Object args;
1107 {
1108 Lisp_Object val;
1109 int count = specpdl_ptr - specpdl;
1110
1111 record_unwind_protect (0, Fcdr (args));
1112 val = Feval (Fcar (args));
1113 return unbind_to (count, val);
1114 }
1115 \f
1116 /* Chain of condition handlers currently in effect.
1117 The elements of this chain are contained in the stack frames
1118 of Fcondition_case and internal_condition_case.
1119 When an error is signaled (by calling Fsignal, below),
1120 this chain is searched for an element that applies. */
1121
1122 struct handler *handlerlist;
1123
1124 DEFUN ("condition-case", Fcondition_case, Scondition_case, 2, UNEVALLED, 0,
1125 "Regain control when an error is signaled.\n\
1126 executes BODYFORM and returns its value if no error happens.\n\
1127 Each element of HANDLERS looks like (CONDITION-NAME BODY...)\n\
1128 where the BODY is made of Lisp expressions.\n\n\
1129 A handler is applicable to an error\n\
1130 if CONDITION-NAME is one of the error's condition names.\n\
1131 If an error happens, the first applicable handler is run.\n\
1132 \n\
1133 The car of a handler may be a list of condition names\n\
1134 instead of a single condition name.\n\
1135 \n\
1136 When a handler handles an error,\n\
1137 control returns to the condition-case and the handler BODY... is executed\n\
1138 with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).\n\
1139 VAR may be nil; then you do not get access to the signal information.\n\
1140 \n\
1141 The value of the last BODY form is returned from the condition-case.\n\
1142 See also the function `signal' for more info.")
1143 (args)
1144 Lisp_Object args;
1145 {
1146 Lisp_Object val;
1147 struct catchtag c;
1148 struct handler h;
1149 register Lisp_Object bodyform, handlers;
1150 volatile Lisp_Object var;
1151
1152 var = Fcar (args);
1153 bodyform = Fcar (Fcdr (args));
1154 handlers = Fcdr (Fcdr (args));
1155 CHECK_SYMBOL (var, 0);
1156
1157 for (val = handlers; ! NILP (val); val = Fcdr (val))
1158 {
1159 Lisp_Object tem;
1160 tem = Fcar (val);
1161 if (! (NILP (tem)
1162 || (CONSP (tem)
1163 && (SYMBOLP (XCAR (tem))
1164 || CONSP (XCAR (tem))))))
1165 error ("Invalid condition handler", tem);
1166 }
1167
1168 c.tag = Qnil;
1169 c.val = Qnil;
1170 c.backlist = backtrace_list;
1171 c.handlerlist = handlerlist;
1172 c.lisp_eval_depth = lisp_eval_depth;
1173 c.pdlcount = specpdl_ptr - specpdl;
1174 c.poll_suppress_count = poll_suppress_count;
1175 c.gcpro = gcprolist;
1176 c.byte_stack = byte_stack_list;
1177 if (_setjmp (c.jmp))
1178 {
1179 if (!NILP (h.var))
1180 specbind (h.var, c.val);
1181 val = Fprogn (Fcdr (h.chosen_clause));
1182
1183 /* Note that this just undoes the binding of h.var; whoever
1184 longjumped to us unwound the stack to c.pdlcount before
1185 throwing. */
1186 unbind_to (c.pdlcount, Qnil);
1187 return val;
1188 }
1189 c.next = catchlist;
1190 catchlist = &c;
1191
1192 h.var = var;
1193 h.handler = handlers;
1194 h.next = handlerlist;
1195 h.tag = &c;
1196 handlerlist = &h;
1197
1198 val = Feval (bodyform);
1199 catchlist = c.next;
1200 handlerlist = h.next;
1201 return val;
1202 }
1203
1204 /* Call the function BFUN with no arguments, catching errors within it
1205 according to HANDLERS. If there is an error, call HFUN with
1206 one argument which is the data that describes the error:
1207 (SIGNALNAME . DATA)
1208
1209 HANDLERS can be a list of conditions to catch.
1210 If HANDLERS is Qt, catch all errors.
1211 If HANDLERS is Qerror, catch all errors
1212 but allow the debugger to run if that is enabled. */
1213
1214 Lisp_Object
1215 internal_condition_case (bfun, handlers, hfun)
1216 Lisp_Object (*bfun) ();
1217 Lisp_Object handlers;
1218 Lisp_Object (*hfun) ();
1219 {
1220 Lisp_Object val;
1221 struct catchtag c;
1222 struct handler h;
1223
1224 #if 0 /* Can't do this check anymore because realize_basic_faces has
1225 to BLOCK_INPUT, and can call Lisp. What's really needed is a
1226 flag indicating that we're currently handling a signal. */
1227 /* Since Fsignal resets this to 0, it had better be 0 now
1228 or else we have a potential bug. */
1229 if (interrupt_input_blocked != 0)
1230 abort ();
1231 #endif
1232
1233 c.tag = Qnil;
1234 c.val = Qnil;
1235 c.backlist = backtrace_list;
1236 c.handlerlist = handlerlist;
1237 c.lisp_eval_depth = lisp_eval_depth;
1238 c.pdlcount = specpdl_ptr - specpdl;
1239 c.poll_suppress_count = poll_suppress_count;
1240 c.gcpro = gcprolist;
1241 c.byte_stack = byte_stack_list;
1242 if (_setjmp (c.jmp))
1243 {
1244 return (*hfun) (c.val);
1245 }
1246 c.next = catchlist;
1247 catchlist = &c;
1248 h.handler = handlers;
1249 h.var = Qnil;
1250 h.next = handlerlist;
1251 h.tag = &c;
1252 handlerlist = &h;
1253
1254 val = (*bfun) ();
1255 catchlist = c.next;
1256 handlerlist = h.next;
1257 return val;
1258 }
1259
1260 /* Like internal_condition_case but call HFUN with ARG as its argument. */
1261
1262 Lisp_Object
1263 internal_condition_case_1 (bfun, arg, handlers, hfun)
1264 Lisp_Object (*bfun) ();
1265 Lisp_Object arg;
1266 Lisp_Object handlers;
1267 Lisp_Object (*hfun) ();
1268 {
1269 Lisp_Object val;
1270 struct catchtag c;
1271 struct handler h;
1272
1273 c.tag = Qnil;
1274 c.val = Qnil;
1275 c.backlist = backtrace_list;
1276 c.handlerlist = handlerlist;
1277 c.lisp_eval_depth = lisp_eval_depth;
1278 c.pdlcount = specpdl_ptr - specpdl;
1279 c.poll_suppress_count = poll_suppress_count;
1280 c.gcpro = gcprolist;
1281 c.byte_stack = byte_stack_list;
1282 if (_setjmp (c.jmp))
1283 {
1284 return (*hfun) (c.val);
1285 }
1286 c.next = catchlist;
1287 catchlist = &c;
1288 h.handler = handlers;
1289 h.var = Qnil;
1290 h.next = handlerlist;
1291 h.tag = &c;
1292 handlerlist = &h;
1293
1294 val = (*bfun) (arg);
1295 catchlist = c.next;
1296 handlerlist = h.next;
1297 return val;
1298 }
1299
1300
1301 /* Like internal_condition_case but call HFUN with NARGS as first,
1302 and ARGS as second argument. */
1303
1304 Lisp_Object
1305 internal_condition_case_2 (bfun, nargs, args, handlers, hfun)
1306 Lisp_Object (*bfun) ();
1307 int nargs;
1308 Lisp_Object *args;
1309 Lisp_Object handlers;
1310 Lisp_Object (*hfun) ();
1311 {
1312 Lisp_Object val;
1313 struct catchtag c;
1314 struct handler h;
1315
1316 c.tag = Qnil;
1317 c.val = Qnil;
1318 c.backlist = backtrace_list;
1319 c.handlerlist = handlerlist;
1320 c.lisp_eval_depth = lisp_eval_depth;
1321 c.pdlcount = specpdl_ptr - specpdl;
1322 c.poll_suppress_count = poll_suppress_count;
1323 c.gcpro = gcprolist;
1324 c.byte_stack = byte_stack_list;
1325 if (_setjmp (c.jmp))
1326 {
1327 return (*hfun) (c.val);
1328 }
1329 c.next = catchlist;
1330 catchlist = &c;
1331 h.handler = handlers;
1332 h.var = Qnil;
1333 h.next = handlerlist;
1334 h.tag = &c;
1335 handlerlist = &h;
1336
1337 val = (*bfun) (nargs, args);
1338 catchlist = c.next;
1339 handlerlist = h.next;
1340 return val;
1341 }
1342
1343 \f
1344 static Lisp_Object find_handler_clause ();
1345
1346 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1347 "Signal an error. Args are ERROR-SYMBOL and associated DATA.\n\
1348 This function does not return.\n\n\
1349 An error symbol is a symbol with an `error-conditions' property\n\
1350 that is a list of condition names.\n\
1351 A handler for any of those names will get to handle this signal.\n\
1352 The symbol `error' should normally be one of them.\n\
1353 \n\
1354 DATA should be a list. Its elements are printed as part of the error message.\n\
1355 If the signal is handled, DATA is made available to the handler.\n\
1356 See also the function `condition-case'.")
1357 (error_symbol, data)
1358 Lisp_Object error_symbol, data;
1359 {
1360 /* When memory is full, ERROR-SYMBOL is nil,
1361 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA). */
1362 register struct handler *allhandlers = handlerlist;
1363 Lisp_Object conditions;
1364 extern int gc_in_progress;
1365 extern int waiting_for_input;
1366 Lisp_Object debugger_value;
1367 Lisp_Object string;
1368 Lisp_Object real_error_symbol;
1369 extern int display_hourglass_p;
1370 struct backtrace *bp;
1371
1372 immediate_quit = handling_signal = 0;
1373 if (gc_in_progress || waiting_for_input)
1374 abort ();
1375
1376 TOTALLY_UNBLOCK_INPUT;
1377
1378 if (NILP (error_symbol))
1379 real_error_symbol = Fcar (data);
1380 else
1381 real_error_symbol = error_symbol;
1382
1383 #ifdef HAVE_X_WINDOWS
1384 if (display_hourglass_p)
1385 cancel_hourglass ();
1386 #endif
1387
1388 /* This hook is used by edebug. */
1389 if (! NILP (Vsignal_hook_function))
1390 call2 (Vsignal_hook_function, error_symbol, data);
1391
1392 conditions = Fget (real_error_symbol, Qerror_conditions);
1393
1394 /* Remember from where signal was called. Skip over the frame for
1395 `signal' itself. If a frame for `error' follows, skip that,
1396 too. */
1397 Vsignaling_function = Qnil;
1398 if (backtrace_list)
1399 {
1400 bp = backtrace_list->next;
1401 if (bp && bp->function && EQ (*bp->function, Qerror))
1402 bp = bp->next;
1403 if (bp && bp->function)
1404 Vsignaling_function = *bp->function;
1405 }
1406
1407 for (; handlerlist; handlerlist = handlerlist->next)
1408 {
1409 register Lisp_Object clause;
1410
1411 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1412 max_lisp_eval_depth = lisp_eval_depth + 20;
1413
1414 if (specpdl_size + 40 > max_specpdl_size)
1415 max_specpdl_size = specpdl_size + 40;
1416
1417 clause = find_handler_clause (handlerlist->handler, conditions,
1418 error_symbol, data, &debugger_value);
1419
1420 #if 0 /* Most callers are not prepared to handle gc if this returns.
1421 So, since this feature is not very useful, take it out. */
1422 /* If have called debugger and user wants to continue,
1423 just return nil. */
1424 if (EQ (clause, Qlambda))
1425 return debugger_value;
1426 #else
1427 if (EQ (clause, Qlambda))
1428 {
1429 /* We can't return values to code which signaled an error, but we
1430 can continue code which has signaled a quit. */
1431 if (EQ (real_error_symbol, Qquit))
1432 return Qnil;
1433 else
1434 error ("Cannot return from the debugger in an error");
1435 }
1436 #endif
1437
1438 if (!NILP (clause))
1439 {
1440 Lisp_Object unwind_data;
1441 struct handler *h = handlerlist;
1442
1443 handlerlist = allhandlers;
1444
1445 if (NILP (error_symbol))
1446 unwind_data = data;
1447 else
1448 unwind_data = Fcons (error_symbol, data);
1449 h->chosen_clause = clause;
1450 unwind_to_catch (h->tag, unwind_data);
1451 }
1452 }
1453
1454 handlerlist = allhandlers;
1455 /* If no handler is present now, try to run the debugger,
1456 and if that fails, throw to top level. */
1457 find_handler_clause (Qerror, conditions, error_symbol, data, &debugger_value);
1458 if (catchlist != 0)
1459 Fthrow (Qtop_level, Qt);
1460
1461 if (! NILP (error_symbol))
1462 data = Fcons (error_symbol, data);
1463
1464 string = Ferror_message_string (data);
1465 fatal ("%s", XSTRING (string)->data, 0);
1466 }
1467
1468 /* Return nonzero iff LIST is a non-nil atom or
1469 a list containing one of CONDITIONS. */
1470
1471 static int
1472 wants_debugger (list, conditions)
1473 Lisp_Object list, conditions;
1474 {
1475 if (NILP (list))
1476 return 0;
1477 if (! CONSP (list))
1478 return 1;
1479
1480 while (CONSP (conditions))
1481 {
1482 Lisp_Object this, tail;
1483 this = XCAR (conditions);
1484 for (tail = list; CONSP (tail); tail = XCDR (tail))
1485 if (EQ (XCAR (tail), this))
1486 return 1;
1487 conditions = XCDR (conditions);
1488 }
1489 return 0;
1490 }
1491
1492 /* Return 1 if an error with condition-symbols CONDITIONS,
1493 and described by SIGNAL-DATA, should skip the debugger
1494 according to debugger-ignore-errors. */
1495
1496 static int
1497 skip_debugger (conditions, data)
1498 Lisp_Object conditions, data;
1499 {
1500 Lisp_Object tail;
1501 int first_string = 1;
1502 Lisp_Object error_message;
1503
1504 error_message = Qnil;
1505 for (tail = Vdebug_ignored_errors; CONSP (tail); tail = XCDR (tail))
1506 {
1507 if (STRINGP (XCAR (tail)))
1508 {
1509 if (first_string)
1510 {
1511 error_message = Ferror_message_string (data);
1512 first_string = 0;
1513 }
1514
1515 if (fast_string_match (XCAR (tail), error_message) >= 0)
1516 return 1;
1517 }
1518 else
1519 {
1520 Lisp_Object contail;
1521
1522 for (contail = conditions; CONSP (contail); contail = XCDR (contail))
1523 if (EQ (XCAR (tail), XCAR (contail)))
1524 return 1;
1525 }
1526 }
1527
1528 return 0;
1529 }
1530
1531 /* Value of Qlambda means we have called debugger and user has continued.
1532 There are two ways to pass SIG and DATA:
1533 = SIG is the error symbol, and DATA is the rest of the data.
1534 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1535 This is for memory-full errors only.
1536
1537 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1538
1539 static Lisp_Object
1540 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1541 Lisp_Object handlers, conditions, sig, data;
1542 Lisp_Object *debugger_value_ptr;
1543 {
1544 register Lisp_Object h;
1545 register Lisp_Object tem;
1546
1547 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1548 return Qt;
1549 /* error is used similarly, but means print an error message
1550 and run the debugger if that is enabled. */
1551 if (EQ (handlers, Qerror)
1552 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1553 there is a handler. */
1554 {
1555 int count = specpdl_ptr - specpdl;
1556 int debugger_called = 0;
1557 Lisp_Object sig_symbol, combined_data;
1558 /* This is set to 1 if we are handling a memory-full error,
1559 because these must not run the debugger.
1560 (There is no room in memory to do that!) */
1561 int no_debugger = 0;
1562
1563 if (NILP (sig))
1564 {
1565 combined_data = data;
1566 sig_symbol = Fcar (data);
1567 no_debugger = 1;
1568 }
1569 else
1570 {
1571 combined_data = Fcons (sig, data);
1572 sig_symbol = sig;
1573 }
1574
1575 if (wants_debugger (Vstack_trace_on_error, conditions))
1576 {
1577 #ifdef PROTOTYPES
1578 internal_with_output_to_temp_buffer ("*Backtrace*",
1579 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1580 Qnil);
1581 #else
1582 internal_with_output_to_temp_buffer ("*Backtrace*",
1583 Fbacktrace, Qnil);
1584 #endif
1585 }
1586 if (! no_debugger
1587 && (EQ (sig_symbol, Qquit)
1588 ? debug_on_quit
1589 : wants_debugger (Vdebug_on_error, conditions))
1590 && ! skip_debugger (conditions, combined_data)
1591 && when_entered_debugger < num_nonmacro_input_events)
1592 {
1593 specbind (Qdebug_on_error, Qnil);
1594 *debugger_value_ptr
1595 = call_debugger (Fcons (Qerror,
1596 Fcons (combined_data, Qnil)));
1597 debugger_called = 1;
1598 }
1599 /* If there is no handler, return saying whether we ran the debugger. */
1600 if (EQ (handlers, Qerror))
1601 {
1602 if (debugger_called)
1603 return unbind_to (count, Qlambda);
1604 return Qt;
1605 }
1606 }
1607 for (h = handlers; CONSP (h); h = Fcdr (h))
1608 {
1609 Lisp_Object handler, condit;
1610
1611 handler = Fcar (h);
1612 if (!CONSP (handler))
1613 continue;
1614 condit = Fcar (handler);
1615 /* Handle a single condition name in handler HANDLER. */
1616 if (SYMBOLP (condit))
1617 {
1618 tem = Fmemq (Fcar (handler), conditions);
1619 if (!NILP (tem))
1620 return handler;
1621 }
1622 /* Handle a list of condition names in handler HANDLER. */
1623 else if (CONSP (condit))
1624 {
1625 while (CONSP (condit))
1626 {
1627 tem = Fmemq (Fcar (condit), conditions);
1628 if (!NILP (tem))
1629 return handler;
1630 condit = XCDR (condit);
1631 }
1632 }
1633 }
1634 return Qnil;
1635 }
1636
1637 /* dump an error message; called like printf */
1638
1639 /* VARARGS 1 */
1640 void
1641 error (m, a1, a2, a3)
1642 char *m;
1643 char *a1, *a2, *a3;
1644 {
1645 char buf[200];
1646 int size = 200;
1647 int mlen;
1648 char *buffer = buf;
1649 char *args[3];
1650 int allocated = 0;
1651 Lisp_Object string;
1652
1653 args[0] = a1;
1654 args[1] = a2;
1655 args[2] = a3;
1656
1657 mlen = strlen (m);
1658
1659 while (1)
1660 {
1661 int used = doprnt (buffer, size, m, m + mlen, 3, args);
1662 if (used < size)
1663 break;
1664 size *= 2;
1665 if (allocated)
1666 buffer = (char *) xrealloc (buffer, size);
1667 else
1668 {
1669 buffer = (char *) xmalloc (size);
1670 allocated = 1;
1671 }
1672 }
1673
1674 string = build_string (buffer);
1675 if (allocated)
1676 xfree (buffer);
1677
1678 Fsignal (Qerror, Fcons (string, Qnil));
1679 abort ();
1680 }
1681 \f
1682 DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0,
1683 "T if FUNCTION makes provisions for interactive calling.\n\
1684 This means it contains a description for how to read arguments to give it.\n\
1685 The value is nil for an invalid function or a symbol with no function\n\
1686 definition.\n\
1687 \n\
1688 Interactively callable functions include strings and vectors (treated\n\
1689 as keyboard macros), lambda-expressions that contain a top-level call\n\
1690 to `interactive', autoload definitions made by `autoload' with non-nil\n\
1691 fourth argument, and some of the built-in functions of Lisp.\n\
1692 \n\
1693 Also, a symbol satisfies `commandp' if its function definition does so.")
1694 (function)
1695 Lisp_Object function;
1696 {
1697 register Lisp_Object fun;
1698 register Lisp_Object funcar;
1699
1700 fun = function;
1701
1702 fun = indirect_function (fun);
1703 if (EQ (fun, Qunbound))
1704 return Qnil;
1705
1706 /* Emacs primitives are interactive if their DEFUN specifies an
1707 interactive spec. */
1708 if (SUBRP (fun))
1709 {
1710 if (XSUBR (fun)->prompt)
1711 return Qt;
1712 else
1713 return Qnil;
1714 }
1715
1716 /* Bytecode objects are interactive if they are long enough to
1717 have an element whose index is COMPILED_INTERACTIVE, which is
1718 where the interactive spec is stored. */
1719 else if (COMPILEDP (fun))
1720 return ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
1721 ? Qt : Qnil);
1722
1723 /* Strings and vectors are keyboard macros. */
1724 if (STRINGP (fun) || VECTORP (fun))
1725 return Qt;
1726
1727 /* Lists may represent commands. */
1728 if (!CONSP (fun))
1729 return Qnil;
1730 funcar = Fcar (fun);
1731 if (!SYMBOLP (funcar))
1732 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1733 if (EQ (funcar, Qlambda))
1734 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1735 if (EQ (funcar, Qmocklisp))
1736 return Qt; /* All mocklisp functions can be called interactively */
1737 if (EQ (funcar, Qautoload))
1738 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1739 else
1740 return Qnil;
1741 }
1742
1743 /* ARGSUSED */
1744 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1745 "Define FUNCTION to autoload from FILE.\n\
1746 FUNCTION is a symbol; FILE is a file name string to pass to `load'.\n\
1747 Third arg DOCSTRING is documentation for the function.\n\
1748 Fourth arg INTERACTIVE if non-nil says function can be called interactively.\n\
1749 Fifth arg TYPE indicates the type of the object:\n\
1750 nil or omitted says FUNCTION is a function,\n\
1751 `keymap' says FUNCTION is really a keymap, and\n\
1752 `macro' or t says FUNCTION is really a macro.\n\
1753 Third through fifth args give info about the real definition.\n\
1754 They default to nil.\n\
1755 If FUNCTION is already defined other than as an autoload,\n\
1756 this does nothing and returns nil.")
1757 (function, file, docstring, interactive, type)
1758 Lisp_Object function, file, docstring, interactive, type;
1759 {
1760 #ifdef NO_ARG_ARRAY
1761 Lisp_Object args[4];
1762 #endif
1763
1764 CHECK_SYMBOL (function, 0);
1765 CHECK_STRING (file, 1);
1766
1767 /* If function is defined and not as an autoload, don't override */
1768 if (!EQ (XSYMBOL (function)->function, Qunbound)
1769 && !(CONSP (XSYMBOL (function)->function)
1770 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
1771 return Qnil;
1772
1773 if (NILP (Vpurify_flag))
1774 /* Only add entries after dumping, because the ones before are
1775 not useful and else we get loads of them from the loaddefs.el. */
1776 LOADHIST_ATTACH (Fcons (Qautoload, function));
1777
1778 #ifdef NO_ARG_ARRAY
1779 args[0] = file;
1780 args[1] = docstring;
1781 args[2] = interactive;
1782 args[3] = type;
1783
1784 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1785 #else /* NO_ARG_ARRAY */
1786 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1787 #endif /* not NO_ARG_ARRAY */
1788 }
1789
1790 Lisp_Object
1791 un_autoload (oldqueue)
1792 Lisp_Object oldqueue;
1793 {
1794 register Lisp_Object queue, first, second;
1795
1796 /* Queue to unwind is current value of Vautoload_queue.
1797 oldqueue is the shadowed value to leave in Vautoload_queue. */
1798 queue = Vautoload_queue;
1799 Vautoload_queue = oldqueue;
1800 while (CONSP (queue))
1801 {
1802 first = Fcar (queue);
1803 second = Fcdr (first);
1804 first = Fcar (first);
1805 if (EQ (second, Qnil))
1806 Vfeatures = first;
1807 else
1808 Ffset (first, second);
1809 queue = Fcdr (queue);
1810 }
1811 return Qnil;
1812 }
1813
1814 /* Load an autoloaded function.
1815 FUNNAME is the symbol which is the function's name.
1816 FUNDEF is the autoload definition (a list). */
1817
1818 void
1819 do_autoload (fundef, funname)
1820 Lisp_Object fundef, funname;
1821 {
1822 int count = specpdl_ptr - specpdl;
1823 Lisp_Object fun, queue, first, second;
1824 struct gcpro gcpro1, gcpro2, gcpro3;
1825
1826 fun = funname;
1827 CHECK_SYMBOL (funname, 0);
1828 GCPRO3 (fun, funname, fundef);
1829
1830 /* Preserve the match data. */
1831 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
1832
1833 /* Value saved here is to be restored into Vautoload_queue. */
1834 record_unwind_protect (un_autoload, Vautoload_queue);
1835 Vautoload_queue = Qt;
1836 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil, Qt);
1837
1838 /* Save the old autoloads, in case we ever do an unload. */
1839 queue = Vautoload_queue;
1840 while (CONSP (queue))
1841 {
1842 first = Fcar (queue);
1843 second = Fcdr (first);
1844 first = Fcar (first);
1845
1846 /* Note: This test is subtle. The cdr of an autoload-queue entry
1847 may be an atom if the autoload entry was generated by a defalias
1848 or fset. */
1849 if (CONSP (second))
1850 Fput (first, Qautoload, (Fcdr (second)));
1851
1852 queue = Fcdr (queue);
1853 }
1854
1855 /* Once loading finishes, don't undo it. */
1856 Vautoload_queue = Qt;
1857 unbind_to (count, Qnil);
1858
1859 fun = Findirect_function (fun);
1860
1861 if (!NILP (Fequal (fun, fundef)))
1862 error ("Autoloading failed to define function %s",
1863 XSYMBOL (funname)->name->data);
1864 UNGCPRO;
1865 }
1866
1867 \f
1868 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1869 "Evaluate FORM and return its value.")
1870 (form)
1871 Lisp_Object form;
1872 {
1873 Lisp_Object fun, val, original_fun, original_args;
1874 Lisp_Object funcar;
1875 struct backtrace backtrace;
1876 struct gcpro gcpro1, gcpro2, gcpro3;
1877
1878 if (handling_signal)
1879 abort ();
1880
1881 if (SYMBOLP (form))
1882 {
1883 if (EQ (Vmocklisp_arguments, Qt))
1884 return Fsymbol_value (form);
1885 val = Fsymbol_value (form);
1886 if (NILP (val))
1887 XSETFASTINT (val, 0);
1888 else if (EQ (val, Qt))
1889 XSETFASTINT (val, 1);
1890 return val;
1891 }
1892 if (!CONSP (form))
1893 return form;
1894
1895 QUIT;
1896 if (consing_since_gc > gc_cons_threshold)
1897 {
1898 GCPRO1 (form);
1899 Fgarbage_collect ();
1900 UNGCPRO;
1901 }
1902
1903 if (++lisp_eval_depth > max_lisp_eval_depth)
1904 {
1905 if (max_lisp_eval_depth < 100)
1906 max_lisp_eval_depth = 100;
1907 if (lisp_eval_depth > max_lisp_eval_depth)
1908 error ("Lisp nesting exceeds max-lisp-eval-depth");
1909 }
1910
1911 original_fun = Fcar (form);
1912 original_args = Fcdr (form);
1913
1914 backtrace.next = backtrace_list;
1915 backtrace_list = &backtrace;
1916 backtrace.function = &original_fun; /* This also protects them from gc */
1917 backtrace.args = &original_args;
1918 backtrace.nargs = UNEVALLED;
1919 backtrace.evalargs = 1;
1920 backtrace.debug_on_exit = 0;
1921
1922 if (debug_on_next_call)
1923 do_debug_on_call (Qt);
1924
1925 /* At this point, only original_fun and original_args
1926 have values that will be used below */
1927 retry:
1928 fun = Findirect_function (original_fun);
1929
1930 if (SUBRP (fun))
1931 {
1932 Lisp_Object numargs;
1933 Lisp_Object argvals[8];
1934 Lisp_Object args_left;
1935 register int i, maxargs;
1936
1937 args_left = original_args;
1938 numargs = Flength (args_left);
1939
1940 if (XINT (numargs) < XSUBR (fun)->min_args ||
1941 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
1942 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
1943
1944 if (XSUBR (fun)->max_args == UNEVALLED)
1945 {
1946 backtrace.evalargs = 0;
1947 val = (*XSUBR (fun)->function) (args_left);
1948 goto done;
1949 }
1950
1951 if (XSUBR (fun)->max_args == MANY)
1952 {
1953 /* Pass a vector of evaluated arguments */
1954 Lisp_Object *vals;
1955 register int argnum = 0;
1956
1957 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
1958
1959 GCPRO3 (args_left, fun, fun);
1960 gcpro3.var = vals;
1961 gcpro3.nvars = 0;
1962
1963 while (!NILP (args_left))
1964 {
1965 vals[argnum++] = Feval (Fcar (args_left));
1966 args_left = Fcdr (args_left);
1967 gcpro3.nvars = argnum;
1968 }
1969
1970 backtrace.args = vals;
1971 backtrace.nargs = XINT (numargs);
1972
1973 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
1974 UNGCPRO;
1975 goto done;
1976 }
1977
1978 GCPRO3 (args_left, fun, fun);
1979 gcpro3.var = argvals;
1980 gcpro3.nvars = 0;
1981
1982 maxargs = XSUBR (fun)->max_args;
1983 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
1984 {
1985 argvals[i] = Feval (Fcar (args_left));
1986 gcpro3.nvars = ++i;
1987 }
1988
1989 UNGCPRO;
1990
1991 backtrace.args = argvals;
1992 backtrace.nargs = XINT (numargs);
1993
1994 switch (i)
1995 {
1996 case 0:
1997 val = (*XSUBR (fun)->function) ();
1998 goto done;
1999 case 1:
2000 val = (*XSUBR (fun)->function) (argvals[0]);
2001 goto done;
2002 case 2:
2003 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
2004 goto done;
2005 case 3:
2006 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2007 argvals[2]);
2008 goto done;
2009 case 4:
2010 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
2011 argvals[2], argvals[3]);
2012 goto done;
2013 case 5:
2014 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2015 argvals[3], argvals[4]);
2016 goto done;
2017 case 6:
2018 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2019 argvals[3], argvals[4], argvals[5]);
2020 goto done;
2021 case 7:
2022 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2023 argvals[3], argvals[4], argvals[5],
2024 argvals[6]);
2025 goto done;
2026
2027 case 8:
2028 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
2029 argvals[3], argvals[4], argvals[5],
2030 argvals[6], argvals[7]);
2031 goto done;
2032
2033 default:
2034 /* Someone has created a subr that takes more arguments than
2035 is supported by this code. We need to either rewrite the
2036 subr to use a different argument protocol, or add more
2037 cases to this switch. */
2038 abort ();
2039 }
2040 }
2041 if (COMPILEDP (fun))
2042 val = apply_lambda (fun, original_args, 1);
2043 else
2044 {
2045 if (!CONSP (fun))
2046 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2047 funcar = Fcar (fun);
2048 if (!SYMBOLP (funcar))
2049 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2050 if (EQ (funcar, Qautoload))
2051 {
2052 do_autoload (fun, original_fun);
2053 goto retry;
2054 }
2055 if (EQ (funcar, Qmacro))
2056 val = Feval (apply1 (Fcdr (fun), original_args));
2057 else if (EQ (funcar, Qlambda))
2058 val = apply_lambda (fun, original_args, 1);
2059 else if (EQ (funcar, Qmocklisp))
2060 val = ml_apply (fun, original_args);
2061 else
2062 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2063 }
2064 done:
2065 if (!EQ (Vmocklisp_arguments, Qt))
2066 {
2067 if (NILP (val))
2068 XSETFASTINT (val, 0);
2069 else if (EQ (val, Qt))
2070 XSETFASTINT (val, 1);
2071 }
2072 lisp_eval_depth--;
2073 if (backtrace.debug_on_exit)
2074 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2075 backtrace_list = backtrace.next;
2076 return val;
2077 }
2078 \f
2079 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2080 "Call FUNCTION with our remaining args, using our last arg as list of args.\n\
2081 Then return the value FUNCTION returns.\n\
2082 Thus, (apply '+ 1 2 '(3 4)) returns 10.")
2083 (nargs, args)
2084 int nargs;
2085 Lisp_Object *args;
2086 {
2087 register int i, numargs;
2088 register Lisp_Object spread_arg;
2089 register Lisp_Object *funcall_args;
2090 Lisp_Object fun;
2091 struct gcpro gcpro1;
2092
2093 fun = args [0];
2094 funcall_args = 0;
2095 spread_arg = args [nargs - 1];
2096 CHECK_LIST (spread_arg, nargs);
2097
2098 numargs = XINT (Flength (spread_arg));
2099
2100 if (numargs == 0)
2101 return Ffuncall (nargs - 1, args);
2102 else if (numargs == 1)
2103 {
2104 args [nargs - 1] = XCAR (spread_arg);
2105 return Ffuncall (nargs, args);
2106 }
2107
2108 numargs += nargs - 2;
2109
2110 fun = indirect_function (fun);
2111 if (EQ (fun, Qunbound))
2112 {
2113 /* Let funcall get the error */
2114 fun = args[0];
2115 goto funcall;
2116 }
2117
2118 if (SUBRP (fun))
2119 {
2120 if (numargs < XSUBR (fun)->min_args
2121 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2122 goto funcall; /* Let funcall get the error */
2123 else if (XSUBR (fun)->max_args > numargs)
2124 {
2125 /* Avoid making funcall cons up a yet another new vector of arguments
2126 by explicitly supplying nil's for optional values */
2127 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2128 * sizeof (Lisp_Object));
2129 for (i = numargs; i < XSUBR (fun)->max_args;)
2130 funcall_args[++i] = Qnil;
2131 GCPRO1 (*funcall_args);
2132 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2133 }
2134 }
2135 funcall:
2136 /* We add 1 to numargs because funcall_args includes the
2137 function itself as well as its arguments. */
2138 if (!funcall_args)
2139 {
2140 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
2141 * sizeof (Lisp_Object));
2142 GCPRO1 (*funcall_args);
2143 gcpro1.nvars = 1 + numargs;
2144 }
2145
2146 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2147 /* Spread the last arg we got. Its first element goes in
2148 the slot that it used to occupy, hence this value of I. */
2149 i = nargs - 1;
2150 while (!NILP (spread_arg))
2151 {
2152 funcall_args [i++] = XCAR (spread_arg);
2153 spread_arg = XCDR (spread_arg);
2154 }
2155
2156 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
2157 }
2158 \f
2159 /* Run hook variables in various ways. */
2160
2161 enum run_hooks_condition {to_completion, until_success, until_failure};
2162
2163 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
2164 "Run each hook in HOOKS. Major mode functions use this.\n\
2165 Each argument should be a symbol, a hook variable.\n\
2166 These symbols are processed in the order specified.\n\
2167 If a hook symbol has a non-nil value, that value may be a function\n\
2168 or a list of functions to be called to run the hook.\n\
2169 If the value is a function, it is called with no arguments.\n\
2170 If it is a list, the elements are called, in order, with no arguments.\n\
2171 \n\
2172 To make a hook variable buffer-local, use `make-local-hook',\n\
2173 not `make-local-variable'.")
2174 (nargs, args)
2175 int nargs;
2176 Lisp_Object *args;
2177 {
2178 Lisp_Object hook[1];
2179 register int i;
2180
2181 for (i = 0; i < nargs; i++)
2182 {
2183 hook[0] = args[i];
2184 run_hook_with_args (1, hook, to_completion);
2185 }
2186
2187 return Qnil;
2188 }
2189
2190 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2191 Srun_hook_with_args, 1, MANY, 0,
2192 "Run HOOK with the specified arguments ARGS.\n\
2193 HOOK should be a symbol, a hook variable. If HOOK has a non-nil\n\
2194 value, that value may be a function or a list of functions to be\n\
2195 called to run the hook. If the value is a function, it is called with\n\
2196 the given arguments and its return value is returned. If it is a list\n\
2197 of functions, those functions are called, in order,\n\
2198 with the given arguments ARGS.\n\
2199 It is best not to depend on the value return by `run-hook-with-args',\n\
2200 as that may change.\n\
2201 \n\
2202 To make a hook variable buffer-local, use `make-local-hook',\n\
2203 not `make-local-variable'.")
2204 (nargs, args)
2205 int nargs;
2206 Lisp_Object *args;
2207 {
2208 return run_hook_with_args (nargs, args, to_completion);
2209 }
2210
2211 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2212 Srun_hook_with_args_until_success, 1, MANY, 0,
2213 "Run HOOK with the specified arguments ARGS.\n\
2214 HOOK should be a symbol, a hook variable. Its value should\n\
2215 be a list of functions. We call those functions, one by one,\n\
2216 passing arguments ARGS to each of them, until one of them\n\
2217 returns a non-nil value. Then we return that value.\n\
2218 If all the functions return nil, we return nil.\n\
2219 \n\
2220 To make a hook variable buffer-local, use `make-local-hook',\n\
2221 not `make-local-variable'.")
2222 (nargs, args)
2223 int nargs;
2224 Lisp_Object *args;
2225 {
2226 return run_hook_with_args (nargs, args, until_success);
2227 }
2228
2229 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2230 Srun_hook_with_args_until_failure, 1, MANY, 0,
2231 "Run HOOK with the specified arguments ARGS.\n\
2232 HOOK should be a symbol, a hook variable. Its value should\n\
2233 be a list of functions. We call those functions, one by one,\n\
2234 passing arguments ARGS to each of them, until one of them\n\
2235 returns nil. Then we return nil.\n\
2236 If all the functions return non-nil, we return non-nil.\n\
2237 \n\
2238 To make a hook variable buffer-local, use `make-local-hook',\n\
2239 not `make-local-variable'.")
2240 (nargs, args)
2241 int nargs;
2242 Lisp_Object *args;
2243 {
2244 return run_hook_with_args (nargs, args, until_failure);
2245 }
2246
2247 /* ARGS[0] should be a hook symbol.
2248 Call each of the functions in the hook value, passing each of them
2249 as arguments all the rest of ARGS (all NARGS - 1 elements).
2250 COND specifies a condition to test after each call
2251 to decide whether to stop.
2252 The caller (or its caller, etc) must gcpro all of ARGS,
2253 except that it isn't necessary to gcpro ARGS[0]. */
2254
2255 Lisp_Object
2256 run_hook_with_args (nargs, args, cond)
2257 int nargs;
2258 Lisp_Object *args;
2259 enum run_hooks_condition cond;
2260 {
2261 Lisp_Object sym, val, ret;
2262 Lisp_Object globals;
2263 struct gcpro gcpro1, gcpro2, gcpro3;
2264
2265 /* If we are dying or still initializing,
2266 don't do anything--it would probably crash if we tried. */
2267 if (NILP (Vrun_hooks))
2268 return Qnil;
2269
2270 sym = args[0];
2271 val = find_symbol_value (sym);
2272 ret = (cond == until_failure ? Qt : Qnil);
2273
2274 if (EQ (val, Qunbound) || NILP (val))
2275 return ret;
2276 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2277 {
2278 args[0] = val;
2279 return Ffuncall (nargs, args);
2280 }
2281 else
2282 {
2283 globals = Qnil;
2284 GCPRO3 (sym, val, globals);
2285
2286 for (;
2287 CONSP (val) && ((cond == to_completion)
2288 || (cond == until_success ? NILP (ret)
2289 : !NILP (ret)));
2290 val = XCDR (val))
2291 {
2292 if (EQ (XCAR (val), Qt))
2293 {
2294 /* t indicates this hook has a local binding;
2295 it means to run the global binding too. */
2296
2297 for (globals = Fdefault_value (sym);
2298 CONSP (globals) && ((cond == to_completion)
2299 || (cond == until_success ? NILP (ret)
2300 : !NILP (ret)));
2301 globals = XCDR (globals))
2302 {
2303 args[0] = XCAR (globals);
2304 /* In a global value, t should not occur. If it does, we
2305 must ignore it to avoid an endless loop. */
2306 if (!EQ (args[0], Qt))
2307 ret = Ffuncall (nargs, args);
2308 }
2309 }
2310 else
2311 {
2312 args[0] = XCAR (val);
2313 ret = Ffuncall (nargs, args);
2314 }
2315 }
2316
2317 UNGCPRO;
2318 return ret;
2319 }
2320 }
2321
2322 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2323 present value of that symbol.
2324 Call each element of FUNLIST,
2325 passing each of them the rest of ARGS.
2326 The caller (or its caller, etc) must gcpro all of ARGS,
2327 except that it isn't necessary to gcpro ARGS[0]. */
2328
2329 Lisp_Object
2330 run_hook_list_with_args (funlist, nargs, args)
2331 Lisp_Object funlist;
2332 int nargs;
2333 Lisp_Object *args;
2334 {
2335 Lisp_Object sym;
2336 Lisp_Object val;
2337 Lisp_Object globals;
2338 struct gcpro gcpro1, gcpro2, gcpro3;
2339
2340 sym = args[0];
2341 globals = Qnil;
2342 GCPRO3 (sym, val, globals);
2343
2344 for (val = funlist; CONSP (val); val = XCDR (val))
2345 {
2346 if (EQ (XCAR (val), Qt))
2347 {
2348 /* t indicates this hook has a local binding;
2349 it means to run the global binding too. */
2350
2351 for (globals = Fdefault_value (sym);
2352 CONSP (globals);
2353 globals = XCDR (globals))
2354 {
2355 args[0] = XCAR (globals);
2356 /* In a global value, t should not occur. If it does, we
2357 must ignore it to avoid an endless loop. */
2358 if (!EQ (args[0], Qt))
2359 Ffuncall (nargs, args);
2360 }
2361 }
2362 else
2363 {
2364 args[0] = XCAR (val);
2365 Ffuncall (nargs, args);
2366 }
2367 }
2368 UNGCPRO;
2369 return Qnil;
2370 }
2371
2372 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2373
2374 void
2375 run_hook_with_args_2 (hook, arg1, arg2)
2376 Lisp_Object hook, arg1, arg2;
2377 {
2378 Lisp_Object temp[3];
2379 temp[0] = hook;
2380 temp[1] = arg1;
2381 temp[2] = arg2;
2382
2383 Frun_hook_with_args (3, temp);
2384 }
2385 \f
2386 /* Apply fn to arg */
2387 Lisp_Object
2388 apply1 (fn, arg)
2389 Lisp_Object fn, arg;
2390 {
2391 struct gcpro gcpro1;
2392
2393 GCPRO1 (fn);
2394 if (NILP (arg))
2395 RETURN_UNGCPRO (Ffuncall (1, &fn));
2396 gcpro1.nvars = 2;
2397 #ifdef NO_ARG_ARRAY
2398 {
2399 Lisp_Object args[2];
2400 args[0] = fn;
2401 args[1] = arg;
2402 gcpro1.var = args;
2403 RETURN_UNGCPRO (Fapply (2, args));
2404 }
2405 #else /* not NO_ARG_ARRAY */
2406 RETURN_UNGCPRO (Fapply (2, &fn));
2407 #endif /* not NO_ARG_ARRAY */
2408 }
2409
2410 /* Call function fn on no arguments */
2411 Lisp_Object
2412 call0 (fn)
2413 Lisp_Object fn;
2414 {
2415 struct gcpro gcpro1;
2416
2417 GCPRO1 (fn);
2418 RETURN_UNGCPRO (Ffuncall (1, &fn));
2419 }
2420
2421 /* Call function fn with 1 argument arg1 */
2422 /* ARGSUSED */
2423 Lisp_Object
2424 call1 (fn, arg1)
2425 Lisp_Object fn, arg1;
2426 {
2427 struct gcpro gcpro1;
2428 #ifdef NO_ARG_ARRAY
2429 Lisp_Object args[2];
2430
2431 args[0] = fn;
2432 args[1] = arg1;
2433 GCPRO1 (args[0]);
2434 gcpro1.nvars = 2;
2435 RETURN_UNGCPRO (Ffuncall (2, args));
2436 #else /* not NO_ARG_ARRAY */
2437 GCPRO1 (fn);
2438 gcpro1.nvars = 2;
2439 RETURN_UNGCPRO (Ffuncall (2, &fn));
2440 #endif /* not NO_ARG_ARRAY */
2441 }
2442
2443 /* Call function fn with 2 arguments arg1, arg2 */
2444 /* ARGSUSED */
2445 Lisp_Object
2446 call2 (fn, arg1, arg2)
2447 Lisp_Object fn, arg1, arg2;
2448 {
2449 struct gcpro gcpro1;
2450 #ifdef NO_ARG_ARRAY
2451 Lisp_Object args[3];
2452 args[0] = fn;
2453 args[1] = arg1;
2454 args[2] = arg2;
2455 GCPRO1 (args[0]);
2456 gcpro1.nvars = 3;
2457 RETURN_UNGCPRO (Ffuncall (3, args));
2458 #else /* not NO_ARG_ARRAY */
2459 GCPRO1 (fn);
2460 gcpro1.nvars = 3;
2461 RETURN_UNGCPRO (Ffuncall (3, &fn));
2462 #endif /* not NO_ARG_ARRAY */
2463 }
2464
2465 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2466 /* ARGSUSED */
2467 Lisp_Object
2468 call3 (fn, arg1, arg2, arg3)
2469 Lisp_Object fn, arg1, arg2, arg3;
2470 {
2471 struct gcpro gcpro1;
2472 #ifdef NO_ARG_ARRAY
2473 Lisp_Object args[4];
2474 args[0] = fn;
2475 args[1] = arg1;
2476 args[2] = arg2;
2477 args[3] = arg3;
2478 GCPRO1 (args[0]);
2479 gcpro1.nvars = 4;
2480 RETURN_UNGCPRO (Ffuncall (4, args));
2481 #else /* not NO_ARG_ARRAY */
2482 GCPRO1 (fn);
2483 gcpro1.nvars = 4;
2484 RETURN_UNGCPRO (Ffuncall (4, &fn));
2485 #endif /* not NO_ARG_ARRAY */
2486 }
2487
2488 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2489 /* ARGSUSED */
2490 Lisp_Object
2491 call4 (fn, arg1, arg2, arg3, arg4)
2492 Lisp_Object fn, arg1, arg2, arg3, arg4;
2493 {
2494 struct gcpro gcpro1;
2495 #ifdef NO_ARG_ARRAY
2496 Lisp_Object args[5];
2497 args[0] = fn;
2498 args[1] = arg1;
2499 args[2] = arg2;
2500 args[3] = arg3;
2501 args[4] = arg4;
2502 GCPRO1 (args[0]);
2503 gcpro1.nvars = 5;
2504 RETURN_UNGCPRO (Ffuncall (5, args));
2505 #else /* not NO_ARG_ARRAY */
2506 GCPRO1 (fn);
2507 gcpro1.nvars = 5;
2508 RETURN_UNGCPRO (Ffuncall (5, &fn));
2509 #endif /* not NO_ARG_ARRAY */
2510 }
2511
2512 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2513 /* ARGSUSED */
2514 Lisp_Object
2515 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2516 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2517 {
2518 struct gcpro gcpro1;
2519 #ifdef NO_ARG_ARRAY
2520 Lisp_Object args[6];
2521 args[0] = fn;
2522 args[1] = arg1;
2523 args[2] = arg2;
2524 args[3] = arg3;
2525 args[4] = arg4;
2526 args[5] = arg5;
2527 GCPRO1 (args[0]);
2528 gcpro1.nvars = 6;
2529 RETURN_UNGCPRO (Ffuncall (6, args));
2530 #else /* not NO_ARG_ARRAY */
2531 GCPRO1 (fn);
2532 gcpro1.nvars = 6;
2533 RETURN_UNGCPRO (Ffuncall (6, &fn));
2534 #endif /* not NO_ARG_ARRAY */
2535 }
2536
2537 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2538 /* ARGSUSED */
2539 Lisp_Object
2540 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2541 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2542 {
2543 struct gcpro gcpro1;
2544 #ifdef NO_ARG_ARRAY
2545 Lisp_Object args[7];
2546 args[0] = fn;
2547 args[1] = arg1;
2548 args[2] = arg2;
2549 args[3] = arg3;
2550 args[4] = arg4;
2551 args[5] = arg5;
2552 args[6] = arg6;
2553 GCPRO1 (args[0]);
2554 gcpro1.nvars = 7;
2555 RETURN_UNGCPRO (Ffuncall (7, args));
2556 #else /* not NO_ARG_ARRAY */
2557 GCPRO1 (fn);
2558 gcpro1.nvars = 7;
2559 RETURN_UNGCPRO (Ffuncall (7, &fn));
2560 #endif /* not NO_ARG_ARRAY */
2561 }
2562
2563 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2564 "Call first argument as a function, passing remaining arguments to it.\n\
2565 Return the value that function returns.\n\
2566 Thus, (funcall 'cons 'x 'y) returns (x . y).")
2567 (nargs, args)
2568 int nargs;
2569 Lisp_Object *args;
2570 {
2571 Lisp_Object fun;
2572 Lisp_Object funcar;
2573 int numargs = nargs - 1;
2574 Lisp_Object lisp_numargs;
2575 Lisp_Object val;
2576 struct backtrace backtrace;
2577 register Lisp_Object *internal_args;
2578 register int i;
2579
2580 QUIT;
2581 if (consing_since_gc > gc_cons_threshold)
2582 Fgarbage_collect ();
2583
2584 if (++lisp_eval_depth > max_lisp_eval_depth)
2585 {
2586 if (max_lisp_eval_depth < 100)
2587 max_lisp_eval_depth = 100;
2588 if (lisp_eval_depth > max_lisp_eval_depth)
2589 error ("Lisp nesting exceeds max-lisp-eval-depth");
2590 }
2591
2592 backtrace.next = backtrace_list;
2593 backtrace_list = &backtrace;
2594 backtrace.function = &args[0];
2595 backtrace.args = &args[1];
2596 backtrace.nargs = nargs - 1;
2597 backtrace.evalargs = 0;
2598 backtrace.debug_on_exit = 0;
2599
2600 if (debug_on_next_call)
2601 do_debug_on_call (Qlambda);
2602
2603 retry:
2604
2605 fun = args[0];
2606
2607 fun = Findirect_function (fun);
2608
2609 if (SUBRP (fun))
2610 {
2611 if (numargs < XSUBR (fun)->min_args
2612 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2613 {
2614 XSETFASTINT (lisp_numargs, numargs);
2615 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
2616 }
2617
2618 if (XSUBR (fun)->max_args == UNEVALLED)
2619 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2620
2621 if (XSUBR (fun)->max_args == MANY)
2622 {
2623 val = (*XSUBR (fun)->function) (numargs, args + 1);
2624 goto done;
2625 }
2626
2627 if (XSUBR (fun)->max_args > numargs)
2628 {
2629 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
2630 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
2631 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2632 internal_args[i] = Qnil;
2633 }
2634 else
2635 internal_args = args + 1;
2636 switch (XSUBR (fun)->max_args)
2637 {
2638 case 0:
2639 val = (*XSUBR (fun)->function) ();
2640 goto done;
2641 case 1:
2642 val = (*XSUBR (fun)->function) (internal_args[0]);
2643 goto done;
2644 case 2:
2645 val = (*XSUBR (fun)->function) (internal_args[0],
2646 internal_args[1]);
2647 goto done;
2648 case 3:
2649 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2650 internal_args[2]);
2651 goto done;
2652 case 4:
2653 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2654 internal_args[2],
2655 internal_args[3]);
2656 goto done;
2657 case 5:
2658 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2659 internal_args[2], internal_args[3],
2660 internal_args[4]);
2661 goto done;
2662 case 6:
2663 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2664 internal_args[2], internal_args[3],
2665 internal_args[4], internal_args[5]);
2666 goto done;
2667 case 7:
2668 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2669 internal_args[2], internal_args[3],
2670 internal_args[4], internal_args[5],
2671 internal_args[6]);
2672 goto done;
2673
2674 case 8:
2675 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2676 internal_args[2], internal_args[3],
2677 internal_args[4], internal_args[5],
2678 internal_args[6], internal_args[7]);
2679 goto done;
2680
2681 default:
2682
2683 /* If a subr takes more than 8 arguments without using MANY
2684 or UNEVALLED, we need to extend this function to support it.
2685 Until this is done, there is no way to call the function. */
2686 abort ();
2687 }
2688 }
2689 if (COMPILEDP (fun))
2690 val = funcall_lambda (fun, numargs, args + 1);
2691 else
2692 {
2693 if (!CONSP (fun))
2694 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2695 funcar = Fcar (fun);
2696 if (!SYMBOLP (funcar))
2697 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2698 if (EQ (funcar, Qlambda))
2699 val = funcall_lambda (fun, numargs, args + 1);
2700 else if (EQ (funcar, Qmocklisp))
2701 val = ml_apply (fun, Flist (numargs, args + 1));
2702 else if (EQ (funcar, Qautoload))
2703 {
2704 do_autoload (fun, args[0]);
2705 goto retry;
2706 }
2707 else
2708 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2709 }
2710 done:
2711 lisp_eval_depth--;
2712 if (backtrace.debug_on_exit)
2713 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2714 backtrace_list = backtrace.next;
2715 return val;
2716 }
2717 \f
2718 Lisp_Object
2719 apply_lambda (fun, args, eval_flag)
2720 Lisp_Object fun, args;
2721 int eval_flag;
2722 {
2723 Lisp_Object args_left;
2724 Lisp_Object numargs;
2725 register Lisp_Object *arg_vector;
2726 struct gcpro gcpro1, gcpro2, gcpro3;
2727 register int i;
2728 register Lisp_Object tem;
2729
2730 numargs = Flength (args);
2731 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2732 args_left = args;
2733
2734 GCPRO3 (*arg_vector, args_left, fun);
2735 gcpro1.nvars = 0;
2736
2737 for (i = 0; i < XINT (numargs);)
2738 {
2739 tem = Fcar (args_left), args_left = Fcdr (args_left);
2740 if (eval_flag) tem = Feval (tem);
2741 arg_vector[i++] = tem;
2742 gcpro1.nvars = i;
2743 }
2744
2745 UNGCPRO;
2746
2747 if (eval_flag)
2748 {
2749 backtrace_list->args = arg_vector;
2750 backtrace_list->nargs = i;
2751 }
2752 backtrace_list->evalargs = 0;
2753 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2754
2755 /* Do the debug-on-exit now, while arg_vector still exists. */
2756 if (backtrace_list->debug_on_exit)
2757 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2758 /* Don't do it again when we return to eval. */
2759 backtrace_list->debug_on_exit = 0;
2760 return tem;
2761 }
2762
2763 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2764 and return the result of evaluation.
2765 FUN must be either a lambda-expression or a compiled-code object. */
2766
2767 Lisp_Object
2768 funcall_lambda (fun, nargs, arg_vector)
2769 Lisp_Object fun;
2770 int nargs;
2771 register Lisp_Object *arg_vector;
2772 {
2773 Lisp_Object val, syms_left, next;
2774 int count = specpdl_ptr - specpdl;
2775 int i, optional, rest;
2776
2777 if (NILP (Vmocklisp_arguments))
2778 specbind (Qmocklisp_arguments, Qt); /* t means NOT mocklisp! */
2779
2780 if (CONSP (fun))
2781 {
2782 syms_left = XCDR (fun);
2783 if (CONSP (syms_left))
2784 syms_left = XCAR (syms_left);
2785 else
2786 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2787 }
2788 else if (COMPILEDP (fun))
2789 syms_left = XVECTOR (fun)->contents[COMPILED_ARGLIST];
2790 else
2791 abort ();
2792
2793 i = optional = rest = 0;
2794 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
2795 {
2796 QUIT;
2797
2798 next = XCAR (syms_left);
2799 while (!SYMBOLP (next))
2800 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2801
2802 if (EQ (next, Qand_rest))
2803 rest = 1;
2804 else if (EQ (next, Qand_optional))
2805 optional = 1;
2806 else if (rest)
2807 {
2808 specbind (next, Flist (nargs - i, &arg_vector[i]));
2809 i = nargs;
2810 }
2811 else if (i < nargs)
2812 specbind (next, arg_vector[i++]);
2813 else if (!optional)
2814 return Fsignal (Qwrong_number_of_arguments,
2815 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2816 else
2817 specbind (next, Qnil);
2818 }
2819
2820 if (!NILP (syms_left))
2821 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2822 else if (i < nargs)
2823 return Fsignal (Qwrong_number_of_arguments,
2824 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2825
2826 if (CONSP (fun))
2827 val = Fprogn (XCDR (XCDR (fun)));
2828 else
2829 {
2830 /* If we have not actually read the bytecode string
2831 and constants vector yet, fetch them from the file. */
2832 if (CONSP (XVECTOR (fun)->contents[COMPILED_BYTECODE]))
2833 Ffetch_bytecode (fun);
2834 val = Fbyte_code (XVECTOR (fun)->contents[COMPILED_BYTECODE],
2835 XVECTOR (fun)->contents[COMPILED_CONSTANTS],
2836 XVECTOR (fun)->contents[COMPILED_STACK_DEPTH]);
2837 }
2838
2839 return unbind_to (count, val);
2840 }
2841
2842 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
2843 1, 1, 0,
2844 "If byte-compiled OBJECT is lazy-loaded, fetch it now.")
2845 (object)
2846 Lisp_Object object;
2847 {
2848 Lisp_Object tem;
2849
2850 if (COMPILEDP (object)
2851 && CONSP (XVECTOR (object)->contents[COMPILED_BYTECODE]))
2852 {
2853 tem = read_doc_string (XVECTOR (object)->contents[COMPILED_BYTECODE]);
2854 if (!CONSP (tem))
2855 error ("invalid byte code");
2856 XVECTOR (object)->contents[COMPILED_BYTECODE] = XCAR (tem);
2857 XVECTOR (object)->contents[COMPILED_CONSTANTS] = XCDR (tem);
2858 }
2859 return object;
2860 }
2861 \f
2862 void
2863 grow_specpdl ()
2864 {
2865 register int count = specpdl_ptr - specpdl;
2866 if (specpdl_size >= max_specpdl_size)
2867 {
2868 if (max_specpdl_size < 400)
2869 max_specpdl_size = 400;
2870 if (specpdl_size >= max_specpdl_size)
2871 {
2872 if (!NILP (Vdebug_on_error))
2873 /* Leave room for some specpdl in the debugger. */
2874 max_specpdl_size = specpdl_size + 100;
2875 Fsignal (Qerror,
2876 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2877 }
2878 }
2879 specpdl_size *= 2;
2880 if (specpdl_size > max_specpdl_size)
2881 specpdl_size = max_specpdl_size;
2882 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2883 specpdl_ptr = specpdl + count;
2884 }
2885
2886 void
2887 specbind (symbol, value)
2888 Lisp_Object symbol, value;
2889 {
2890 Lisp_Object ovalue;
2891
2892 CHECK_SYMBOL (symbol, 0);
2893 if (specpdl_ptr == specpdl + specpdl_size)
2894 grow_specpdl ();
2895
2896 /* The most common case is that a non-constant symbol with a trivial
2897 value. Make that as fast as we can. */
2898 if (!MISCP (XSYMBOL (symbol)->value)
2899 && !EQ (symbol, Qnil)
2900 && !EQ (symbol, Qt)
2901 && !(XSYMBOL (symbol)->name->data[0] == ':'
2902 && EQ (XSYMBOL (symbol)->obarray, initial_obarray)
2903 && !EQ (value, symbol)))
2904 {
2905 specpdl_ptr->symbol = symbol;
2906 specpdl_ptr->old_value = XSYMBOL (symbol)->value;
2907 specpdl_ptr->func = NULL;
2908 ++specpdl_ptr;
2909 XSYMBOL (symbol)->value = value;
2910 }
2911 else
2912 {
2913 ovalue = find_symbol_value (symbol);
2914 specpdl_ptr->func = 0;
2915 specpdl_ptr->old_value = ovalue;
2916
2917 if (BUFFER_LOCAL_VALUEP (XSYMBOL (symbol)->value)
2918 || SOME_BUFFER_LOCAL_VALUEP (XSYMBOL (symbol)->value)
2919 || BUFFER_OBJFWDP (XSYMBOL (symbol)->value))
2920 {
2921 Lisp_Object current_buffer, binding_buffer;
2922
2923 /* For a local variable, record both the symbol and which
2924 buffer's value we are saving. */
2925 current_buffer = Fcurrent_buffer ();
2926 binding_buffer = current_buffer;
2927
2928 /* If the variable is not local in this buffer,
2929 we are saving the global value, so restore that. */
2930 if (NILP (Flocal_variable_p (symbol, binding_buffer)))
2931 binding_buffer = Qnil;
2932 specpdl_ptr->symbol
2933 = Fcons (symbol, Fcons (binding_buffer, current_buffer));
2934
2935 /* If SYMBOL is a per-buffer variable which doesn't have a
2936 buffer-local value here, make the `let' change the global
2937 value by changing the value of SYMBOL in all buffers not
2938 having their own value. This is consistent with what
2939 happens with other buffer-local variables. */
2940 if (NILP (binding_buffer)
2941 && BUFFER_OBJFWDP (XSYMBOL (symbol)->value))
2942 {
2943 ++specpdl_ptr;
2944 Fset_default (symbol, value);
2945 return;
2946 }
2947 }
2948 else
2949 specpdl_ptr->symbol = symbol;
2950
2951 specpdl_ptr++;
2952 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
2953 store_symval_forwarding (symbol, ovalue, value);
2954 else
2955 set_internal (symbol, value, 0, 1);
2956 }
2957 }
2958
2959 void
2960 record_unwind_protect (function, arg)
2961 Lisp_Object (*function) P_ ((Lisp_Object));
2962 Lisp_Object arg;
2963 {
2964 if (specpdl_ptr == specpdl + specpdl_size)
2965 grow_specpdl ();
2966 specpdl_ptr->func = function;
2967 specpdl_ptr->symbol = Qnil;
2968 specpdl_ptr->old_value = arg;
2969 specpdl_ptr++;
2970 }
2971
2972 Lisp_Object
2973 unbind_to (count, value)
2974 int count;
2975 Lisp_Object value;
2976 {
2977 int quitf = !NILP (Vquit_flag);
2978 struct gcpro gcpro1;
2979
2980 GCPRO1 (value);
2981 Vquit_flag = Qnil;
2982
2983 while (specpdl_ptr != specpdl + count)
2984 {
2985 --specpdl_ptr;
2986
2987 if (specpdl_ptr->func != 0)
2988 (*specpdl_ptr->func) (specpdl_ptr->old_value);
2989 /* Note that a "binding" of nil is really an unwind protect,
2990 so in that case the "old value" is a list of forms to evaluate. */
2991 else if (NILP (specpdl_ptr->symbol))
2992 Fprogn (specpdl_ptr->old_value);
2993 /* If the symbol is a list, it is really
2994 (SYMBOL BINDING_BUFFER . CURRENT_BUFFER)
2995 and it indicates we bound a variable that has
2996 buffer-local bindings. */
2997 else if (CONSP (specpdl_ptr->symbol))
2998 {
2999 Lisp_Object symbol, buffer;
3000
3001 symbol = XCAR (specpdl_ptr->symbol);
3002 buffer = XCAR (XCDR (specpdl_ptr->symbol));
3003
3004 /* Handle restoring a default value. */
3005 if (NILP (buffer))
3006 Fset_default (symbol, specpdl_ptr->old_value);
3007 /* Handle restoring a value saved from a live buffer. */
3008 else
3009 set_internal (symbol, specpdl_ptr->old_value, XBUFFER (buffer), 1);
3010 }
3011 else
3012 {
3013 /* If variable has a trivial value (no forwarding), we can
3014 just set it. No need to check for constant symbols here,
3015 since that was already done by specbind. */
3016 if (!MISCP (XSYMBOL (specpdl_ptr->symbol)->value))
3017 XSYMBOL (specpdl_ptr->symbol)->value = specpdl_ptr->old_value;
3018 else
3019 set_internal (specpdl_ptr->symbol, specpdl_ptr->old_value, 0, 1);
3020 }
3021 }
3022
3023 if (NILP (Vquit_flag) && quitf)
3024 Vquit_flag = Qt;
3025
3026 UNGCPRO;
3027 return value;
3028 }
3029 \f
3030 #if 0
3031
3032 /* Get the value of symbol's global binding, even if that binding
3033 is not now dynamically visible. */
3034
3035 Lisp_Object
3036 top_level_value (symbol)
3037 Lisp_Object symbol;
3038 {
3039 register struct specbinding *ptr = specpdl;
3040
3041 CHECK_SYMBOL (symbol, 0);
3042 for (; ptr != specpdl_ptr; ptr++)
3043 {
3044 if (EQ (ptr->symbol, symbol))
3045 return ptr->old_value;
3046 }
3047 return Fsymbol_value (symbol);
3048 }
3049
3050 Lisp_Object
3051 top_level_set (symbol, newval)
3052 Lisp_Object symbol, newval;
3053 {
3054 register struct specbinding *ptr = specpdl;
3055
3056 CHECK_SYMBOL (symbol, 0);
3057 for (; ptr != specpdl_ptr; ptr++)
3058 {
3059 if (EQ (ptr->symbol, symbol))
3060 {
3061 ptr->old_value = newval;
3062 return newval;
3063 }
3064 }
3065 return Fset (symbol, newval);
3066 }
3067
3068 #endif /* 0 */
3069 \f
3070 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
3071 "Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.\n\
3072 The debugger is entered when that frame exits, if the flag is non-nil.")
3073 (level, flag)
3074 Lisp_Object level, flag;
3075 {
3076 register struct backtrace *backlist = backtrace_list;
3077 register int i;
3078
3079 CHECK_NUMBER (level, 0);
3080
3081 for (i = 0; backlist && i < XINT (level); i++)
3082 {
3083 backlist = backlist->next;
3084 }
3085
3086 if (backlist)
3087 backlist->debug_on_exit = !NILP (flag);
3088
3089 return flag;
3090 }
3091
3092 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3093 "Print a trace of Lisp function calls currently active.\n\
3094 Output stream used is value of `standard-output'.")
3095 ()
3096 {
3097 register struct backtrace *backlist = backtrace_list;
3098 register int i;
3099 Lisp_Object tail;
3100 Lisp_Object tem;
3101 extern Lisp_Object Vprint_level;
3102 struct gcpro gcpro1;
3103
3104 XSETFASTINT (Vprint_level, 3);
3105
3106 tail = Qnil;
3107 GCPRO1 (tail);
3108
3109 while (backlist)
3110 {
3111 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3112 if (backlist->nargs == UNEVALLED)
3113 {
3114 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3115 write_string ("\n", -1);
3116 }
3117 else
3118 {
3119 tem = *backlist->function;
3120 Fprin1 (tem, Qnil); /* This can QUIT */
3121 write_string ("(", -1);
3122 if (backlist->nargs == MANY)
3123 {
3124 for (tail = *backlist->args, i = 0;
3125 !NILP (tail);
3126 tail = Fcdr (tail), i++)
3127 {
3128 if (i) write_string (" ", -1);
3129 Fprin1 (Fcar (tail), Qnil);
3130 }
3131 }
3132 else
3133 {
3134 for (i = 0; i < backlist->nargs; i++)
3135 {
3136 if (i) write_string (" ", -1);
3137 Fprin1 (backlist->args[i], Qnil);
3138 }
3139 }
3140 write_string (")\n", -1);
3141 }
3142 backlist = backlist->next;
3143 }
3144
3145 Vprint_level = Qnil;
3146 UNGCPRO;
3147 return Qnil;
3148 }
3149
3150 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, NULL,
3151 "Return the function and arguments NFRAMES up from current execution point.\n\
3152 If that frame has not evaluated the arguments yet (or is a special form),\n\
3153 the value is (nil FUNCTION ARG-FORMS...).\n\
3154 If that frame has evaluated its arguments and called its function already,\n\
3155 the value is (t FUNCTION ARG-VALUES...).\n\
3156 A &rest arg is represented as the tail of the list ARG-VALUES.\n\
3157 FUNCTION is whatever was supplied as car of evaluated list,\n\
3158 or a lambda expression for macro calls.\n\
3159 If NFRAMES is more than the number of frames, the value is nil.")
3160 (nframes)
3161 Lisp_Object nframes;
3162 {
3163 register struct backtrace *backlist = backtrace_list;
3164 register int i;
3165 Lisp_Object tem;
3166
3167 CHECK_NATNUM (nframes, 0);
3168
3169 /* Find the frame requested. */
3170 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3171 backlist = backlist->next;
3172
3173 if (!backlist)
3174 return Qnil;
3175 if (backlist->nargs == UNEVALLED)
3176 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3177 else
3178 {
3179 if (backlist->nargs == MANY)
3180 tem = *backlist->args;
3181 else
3182 tem = Flist (backlist->nargs, backlist->args);
3183
3184 return Fcons (Qt, Fcons (*backlist->function, tem));
3185 }
3186 }
3187
3188 \f
3189 void
3190 syms_of_eval ()
3191 {
3192 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3193 "*Limit on number of Lisp variable bindings & unwind-protects.\n\
3194 If Lisp code tries to make more than this many at once,\n\
3195 an error is signaled.");
3196
3197 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3198 "*Limit on depth in `eval', `apply' and `funcall' before error.\n\
3199 This limit is to catch infinite recursions for you before they cause\n\
3200 actual stack overflow in C, which would be fatal for Emacs.\n\
3201 You can safely make it considerably larger than its default value,\n\
3202 if that proves inconveniently small.");
3203
3204 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3205 "Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.\n\
3206 Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'.");
3207 Vquit_flag = Qnil;
3208
3209 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3210 "Non-nil inhibits C-g quitting from happening immediately.\n\
3211 Note that `quit-flag' will still be set by typing C-g,\n\
3212 so a quit will be signaled as soon as `inhibit-quit' is nil.\n\
3213 To prevent this happening, set `quit-flag' to nil\n\
3214 before making `inhibit-quit' nil.");
3215 Vinhibit_quit = Qnil;
3216
3217 Qinhibit_quit = intern ("inhibit-quit");
3218 staticpro (&Qinhibit_quit);
3219
3220 Qautoload = intern ("autoload");
3221 staticpro (&Qautoload);
3222
3223 Qdebug_on_error = intern ("debug-on-error");
3224 staticpro (&Qdebug_on_error);
3225
3226 Qmacro = intern ("macro");
3227 staticpro (&Qmacro);
3228
3229 /* Note that the process handling also uses Qexit, but we don't want
3230 to staticpro it twice, so we just do it here. */
3231 Qexit = intern ("exit");
3232 staticpro (&Qexit);
3233
3234 Qinteractive = intern ("interactive");
3235 staticpro (&Qinteractive);
3236
3237 Qcommandp = intern ("commandp");
3238 staticpro (&Qcommandp);
3239
3240 Qdefun = intern ("defun");
3241 staticpro (&Qdefun);
3242
3243 Qand_rest = intern ("&rest");
3244 staticpro (&Qand_rest);
3245
3246 Qand_optional = intern ("&optional");
3247 staticpro (&Qand_optional);
3248
3249 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3250 "*Non-nil means automatically display a backtrace buffer\n\
3251 after any error that is handled by the editor command loop.\n\
3252 If the value is a list, an error only means to display a backtrace\n\
3253 if one of its condition symbols appears in the list.");
3254 Vstack_trace_on_error = Qnil;
3255
3256 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3257 "*Non-nil means enter debugger if an error is signaled.\n\
3258 Does not apply to errors handled by `condition-case' or those\n\
3259 matched by `debug-ignored-errors'.\n\
3260 If the value is a list, an error only means to enter the debugger\n\
3261 if one of its condition symbols appears in the list.\n\
3262 See also variable `debug-on-quit'.");
3263 Vdebug_on_error = Qnil;
3264
3265 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3266 "*List of errors for which the debugger should not be called.\n\
3267 Each element may be a condition-name or a regexp that matches error messages.\n\
3268 If any element applies to a given error, that error skips the debugger\n\
3269 and just returns to top level.\n\
3270 This overrides the variable `debug-on-error'.\n\
3271 It does not apply to errors handled by `condition-case'.");
3272 Vdebug_ignored_errors = Qnil;
3273
3274 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3275 "*Non-nil means enter debugger if quit is signaled (C-g, for example).\n\
3276 Does not apply if quit is handled by a `condition-case'.");
3277 debug_on_quit = 0;
3278
3279 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3280 "Non-nil means enter debugger before next `eval', `apply' or `funcall'.");
3281
3282 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3283 "Non-nil means debugger may continue execution.\n\
3284 This is nil when the debugger is called under circumstances where it\n\
3285 might not be safe to continue.");
3286 debugger_may_continue = 1;
3287
3288 DEFVAR_LISP ("debugger", &Vdebugger,
3289 "Function to call to invoke debugger.\n\
3290 If due to frame exit, args are `exit' and the value being returned;\n\
3291 this function's value will be returned instead of that.\n\
3292 If due to error, args are `error' and a list of the args to `signal'.\n\
3293 If due to `apply' or `funcall' entry, one arg, `lambda'.\n\
3294 If due to `eval' entry, one arg, t.");
3295 Vdebugger = Qnil;
3296
3297 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3298 "If non-nil, this is a function for `signal' to call.\n\
3299 It receives the same arguments that `signal' was given.\n\
3300 The Edebug package uses this to regain control.");
3301 Vsignal_hook_function = Qnil;
3302
3303 Qmocklisp_arguments = intern ("mocklisp-arguments");
3304 staticpro (&Qmocklisp_arguments);
3305 DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments,
3306 "While in a mocklisp function, the list of its unevaluated args.");
3307 Vmocklisp_arguments = Qt;
3308
3309 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3310 "*Non-nil means call the debugger regardless of condition handlers.\n\
3311 Note that `debug-on-error', `debug-on-quit' and friends\n\
3312 still determine whether to handle the particular condition.");
3313 Vdebug_on_signal = Qnil;
3314
3315 Vrun_hooks = intern ("run-hooks");
3316 staticpro (&Vrun_hooks);
3317
3318 staticpro (&Vautoload_queue);
3319 Vautoload_queue = Qnil;
3320 staticpro (&Vsignaling_function);
3321 Vsignaling_function = Qnil;
3322
3323 defsubr (&Sor);
3324 defsubr (&Sand);
3325 defsubr (&Sif);
3326 defsubr (&Scond);
3327 defsubr (&Sprogn);
3328 defsubr (&Sprog1);
3329 defsubr (&Sprog2);
3330 defsubr (&Ssetq);
3331 defsubr (&Squote);
3332 defsubr (&Sfunction);
3333 defsubr (&Sdefun);
3334 defsubr (&Sdefmacro);
3335 defsubr (&Sdefvar);
3336 defsubr (&Sdefconst);
3337 defsubr (&Suser_variable_p);
3338 defsubr (&Slet);
3339 defsubr (&SletX);
3340 defsubr (&Swhile);
3341 defsubr (&Smacroexpand);
3342 defsubr (&Scatch);
3343 defsubr (&Sthrow);
3344 defsubr (&Sunwind_protect);
3345 defsubr (&Scondition_case);
3346 defsubr (&Ssignal);
3347 defsubr (&Sinteractive_p);
3348 defsubr (&Scommandp);
3349 defsubr (&Sautoload);
3350 defsubr (&Seval);
3351 defsubr (&Sapply);
3352 defsubr (&Sfuncall);
3353 defsubr (&Srun_hooks);
3354 defsubr (&Srun_hook_with_args);
3355 defsubr (&Srun_hook_with_args_until_success);
3356 defsubr (&Srun_hook_with_args_until_failure);
3357 defsubr (&Sfetch_bytecode);
3358 defsubr (&Sbacktrace_debug);
3359 defsubr (&Sbacktrace);
3360 defsubr (&Sbacktrace_frame);
3361 }