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