(eval_form): GCPRO argument sexpr.
[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 \f
1278 static Lisp_Object find_handler_clause ();
1279
1280 DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
1281 "Signal an error. Args are ERROR-SYMBOL and associated DATA.\n\
1282 This function does not return.\n\n\
1283 An error symbol is a symbol with an `error-conditions' property\n\
1284 that is a list of condition names.\n\
1285 A handler for any of those names will get to handle this signal.\n\
1286 The symbol `error' should normally be one of them.\n\
1287 \n\
1288 DATA should be a list. Its elements are printed as part of the error message.\n\
1289 If the signal is handled, DATA is made available to the handler.\n\
1290 See also the function `condition-case'.")
1291 (error_symbol, data)
1292 Lisp_Object error_symbol, data;
1293 {
1294 /* When memory is full, ERROR-SYMBOL is nil,
1295 and DATA is (REAL-ERROR-SYMBOL . REAL-DATA). */
1296 register struct handler *allhandlers = handlerlist;
1297 Lisp_Object conditions;
1298 extern int gc_in_progress;
1299 extern int waiting_for_input;
1300 Lisp_Object debugger_value;
1301 Lisp_Object string;
1302 Lisp_Object real_error_symbol;
1303 extern int display_busy_cursor_p;
1304 struct backtrace *bp;
1305
1306 immediate_quit = 0;
1307 if (gc_in_progress || waiting_for_input)
1308 abort ();
1309
1310 TOTALLY_UNBLOCK_INPUT;
1311
1312 if (NILP (error_symbol))
1313 real_error_symbol = Fcar (data);
1314 else
1315 real_error_symbol = error_symbol;
1316
1317 #ifdef HAVE_X_WINDOWS
1318 if (display_busy_cursor_p)
1319 cancel_busy_cursor ();
1320 #endif
1321
1322 /* This hook is used by edebug. */
1323 if (! NILP (Vsignal_hook_function))
1324 call2 (Vsignal_hook_function, error_symbol, data);
1325
1326 conditions = Fget (real_error_symbol, Qerror_conditions);
1327
1328 /* Remember from where signal was called. Skip over the frame for
1329 `signal' itself. If a frame for `error' follows, skip that,
1330 too. */
1331 Vsignaling_function = Qnil;
1332 if (backtrace_list)
1333 {
1334 bp = backtrace_list->next;
1335 if (bp && bp->function && EQ (*bp->function, Qerror))
1336 bp = bp->next;
1337 if (bp && bp->function)
1338 Vsignaling_function = *bp->function;
1339 }
1340
1341 for (; handlerlist; handlerlist = handlerlist->next)
1342 {
1343 register Lisp_Object clause;
1344
1345 if (lisp_eval_depth + 20 > max_lisp_eval_depth)
1346 max_lisp_eval_depth = lisp_eval_depth + 20;
1347
1348 if (specpdl_size + 40 > max_specpdl_size)
1349 max_specpdl_size = specpdl_size + 40;
1350
1351 clause = find_handler_clause (handlerlist->handler, conditions,
1352 error_symbol, data, &debugger_value);
1353
1354 #if 0 /* Most callers are not prepared to handle gc if this returns.
1355 So, since this feature is not very useful, take it out. */
1356 /* If have called debugger and user wants to continue,
1357 just return nil. */
1358 if (EQ (clause, Qlambda))
1359 return debugger_value;
1360 #else
1361 if (EQ (clause, Qlambda))
1362 {
1363 /* We can't return values to code which signaled an error, but we
1364 can continue code which has signaled a quit. */
1365 if (EQ (real_error_symbol, Qquit))
1366 return Qnil;
1367 else
1368 error ("Cannot return from the debugger in an error");
1369 }
1370 #endif
1371
1372 if (!NILP (clause))
1373 {
1374 Lisp_Object unwind_data;
1375 struct handler *h = handlerlist;
1376
1377 handlerlist = allhandlers;
1378
1379 if (NILP (error_symbol))
1380 unwind_data = data;
1381 else
1382 unwind_data = Fcons (error_symbol, data);
1383 h->chosen_clause = clause;
1384 unwind_to_catch (h->tag, unwind_data);
1385 }
1386 }
1387
1388 handlerlist = allhandlers;
1389 /* If no handler is present now, try to run the debugger,
1390 and if that fails, throw to top level. */
1391 find_handler_clause (Qerror, conditions, error_symbol, data, &debugger_value);
1392 if (catchlist != 0)
1393 Fthrow (Qtop_level, Qt);
1394
1395 if (! NILP (error_symbol))
1396 data = Fcons (error_symbol, data);
1397
1398 string = Ferror_message_string (data);
1399 fatal ("%s", XSTRING (string)->data, 0);
1400 }
1401
1402 /* Return nonzero iff LIST is a non-nil atom or
1403 a list containing one of CONDITIONS. */
1404
1405 static int
1406 wants_debugger (list, conditions)
1407 Lisp_Object list, conditions;
1408 {
1409 if (NILP (list))
1410 return 0;
1411 if (! CONSP (list))
1412 return 1;
1413
1414 while (CONSP (conditions))
1415 {
1416 Lisp_Object this, tail;
1417 this = XCAR (conditions);
1418 for (tail = list; CONSP (tail); tail = XCDR (tail))
1419 if (EQ (XCAR (tail), this))
1420 return 1;
1421 conditions = XCDR (conditions);
1422 }
1423 return 0;
1424 }
1425
1426 /* Return 1 if an error with condition-symbols CONDITIONS,
1427 and described by SIGNAL-DATA, should skip the debugger
1428 according to debugger-ignore-errors. */
1429
1430 static int
1431 skip_debugger (conditions, data)
1432 Lisp_Object conditions, data;
1433 {
1434 Lisp_Object tail;
1435 int first_string = 1;
1436 Lisp_Object error_message;
1437
1438 for (tail = Vdebug_ignored_errors; CONSP (tail);
1439 tail = XCDR (tail))
1440 {
1441 if (STRINGP (XCAR (tail)))
1442 {
1443 if (first_string)
1444 {
1445 error_message = Ferror_message_string (data);
1446 first_string = 0;
1447 }
1448 if (fast_string_match (XCAR (tail), error_message) >= 0)
1449 return 1;
1450 }
1451 else
1452 {
1453 Lisp_Object contail;
1454
1455 for (contail = conditions; CONSP (contail);
1456 contail = XCDR (contail))
1457 if (EQ (XCAR (tail), XCAR (contail)))
1458 return 1;
1459 }
1460 }
1461
1462 return 0;
1463 }
1464
1465 /* Value of Qlambda means we have called debugger and user has continued.
1466 There are two ways to pass SIG and DATA:
1467 = SIG is the error symbol, and DATA is the rest of the data.
1468 = SIG is nil, and DATA is (SYMBOL . REST-OF-DATA).
1469 This is for memory-full errors only.
1470
1471 Store value returned from debugger into *DEBUGGER_VALUE_PTR. */
1472
1473 static Lisp_Object
1474 find_handler_clause (handlers, conditions, sig, data, debugger_value_ptr)
1475 Lisp_Object handlers, conditions, sig, data;
1476 Lisp_Object *debugger_value_ptr;
1477 {
1478 register Lisp_Object h;
1479 register Lisp_Object tem;
1480
1481 if (EQ (handlers, Qt)) /* t is used by handlers for all conditions, set up by C code. */
1482 return Qt;
1483 /* error is used similarly, but means print an error message
1484 and run the debugger if that is enabled. */
1485 if (EQ (handlers, Qerror)
1486 || !NILP (Vdebug_on_signal)) /* This says call debugger even if
1487 there is a handler. */
1488 {
1489 int count = specpdl_ptr - specpdl;
1490 int debugger_called = 0;
1491 Lisp_Object sig_symbol, combined_data;
1492 /* This is set to 1 if we are handling a memory-full error,
1493 because these must not run the debugger.
1494 (There is no room in memory to do that!) */
1495 int no_debugger = 0;
1496
1497 if (NILP (sig))
1498 {
1499 combined_data = data;
1500 sig_symbol = Fcar (data);
1501 no_debugger = 1;
1502 }
1503 else
1504 {
1505 combined_data = Fcons (sig, data);
1506 sig_symbol = sig;
1507 }
1508
1509 if (wants_debugger (Vstack_trace_on_error, conditions))
1510 {
1511 #ifdef PROTOTYPES
1512 internal_with_output_to_temp_buffer ("*Backtrace*",
1513 (Lisp_Object (*) (Lisp_Object)) Fbacktrace,
1514 Qnil);
1515 #else
1516 internal_with_output_to_temp_buffer ("*Backtrace*",
1517 Fbacktrace, Qnil);
1518 #endif
1519 }
1520 if (! no_debugger
1521 && (EQ (sig_symbol, Qquit)
1522 ? debug_on_quit
1523 : wants_debugger (Vdebug_on_error, conditions))
1524 && ! skip_debugger (conditions, combined_data)
1525 && when_entered_debugger < num_nonmacro_input_events)
1526 {
1527 specbind (Qdebug_on_error, Qnil);
1528 *debugger_value_ptr
1529 = call_debugger (Fcons (Qerror,
1530 Fcons (combined_data, Qnil)));
1531 debugger_called = 1;
1532 }
1533 /* If there is no handler, return saying whether we ran the debugger. */
1534 if (EQ (handlers, Qerror))
1535 {
1536 if (debugger_called)
1537 return unbind_to (count, Qlambda);
1538 return Qt;
1539 }
1540 }
1541 for (h = handlers; CONSP (h); h = Fcdr (h))
1542 {
1543 Lisp_Object handler, condit;
1544
1545 handler = Fcar (h);
1546 if (!CONSP (handler))
1547 continue;
1548 condit = Fcar (handler);
1549 /* Handle a single condition name in handler HANDLER. */
1550 if (SYMBOLP (condit))
1551 {
1552 tem = Fmemq (Fcar (handler), conditions);
1553 if (!NILP (tem))
1554 return handler;
1555 }
1556 /* Handle a list of condition names in handler HANDLER. */
1557 else if (CONSP (condit))
1558 {
1559 while (CONSP (condit))
1560 {
1561 tem = Fmemq (Fcar (condit), conditions);
1562 if (!NILP (tem))
1563 return handler;
1564 condit = XCDR (condit);
1565 }
1566 }
1567 }
1568 return Qnil;
1569 }
1570
1571 /* dump an error message; called like printf */
1572
1573 /* VARARGS 1 */
1574 void
1575 error (m, a1, a2, a3)
1576 char *m;
1577 char *a1, *a2, *a3;
1578 {
1579 char buf[200];
1580 int size = 200;
1581 int mlen;
1582 char *buffer = buf;
1583 char *args[3];
1584 int allocated = 0;
1585 Lisp_Object string;
1586
1587 args[0] = a1;
1588 args[1] = a2;
1589 args[2] = a3;
1590
1591 mlen = strlen (m);
1592
1593 while (1)
1594 {
1595 int used = doprnt (buffer, size, m, m + mlen, 3, args);
1596 if (used < size)
1597 break;
1598 size *= 2;
1599 if (allocated)
1600 buffer = (char *) xrealloc (buffer, size);
1601 else
1602 {
1603 buffer = (char *) xmalloc (size);
1604 allocated = 1;
1605 }
1606 }
1607
1608 string = build_string (buffer);
1609 if (allocated)
1610 free (buffer);
1611
1612 Fsignal (Qerror, Fcons (string, Qnil));
1613 }
1614 \f
1615 DEFUN ("commandp", Fcommandp, Scommandp, 1, 1, 0,
1616 "T if FUNCTION makes provisions for interactive calling.\n\
1617 This means it contains a description for how to read arguments to give it.\n\
1618 The value is nil for an invalid function or a symbol with no function\n\
1619 definition.\n\
1620 \n\
1621 Interactively callable functions include strings and vectors (treated\n\
1622 as keyboard macros), lambda-expressions that contain a top-level call\n\
1623 to `interactive', autoload definitions made by `autoload' with non-nil\n\
1624 fourth argument, and some of the built-in functions of Lisp.\n\
1625 \n\
1626 Also, a symbol satisfies `commandp' if its function definition does so.")
1627 (function)
1628 Lisp_Object function;
1629 {
1630 register Lisp_Object fun;
1631 register Lisp_Object funcar;
1632
1633 fun = function;
1634
1635 fun = indirect_function (fun);
1636 if (EQ (fun, Qunbound))
1637 return Qnil;
1638
1639 /* Emacs primitives are interactive if their DEFUN specifies an
1640 interactive spec. */
1641 if (SUBRP (fun))
1642 {
1643 if (XSUBR (fun)->prompt)
1644 return Qt;
1645 else
1646 return Qnil;
1647 }
1648
1649 /* Bytecode objects are interactive if they are long enough to
1650 have an element whose index is COMPILED_INTERACTIVE, which is
1651 where the interactive spec is stored. */
1652 else if (COMPILEDP (fun))
1653 return ((XVECTOR (fun)->size & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
1654 ? Qt : Qnil);
1655
1656 /* Strings and vectors are keyboard macros. */
1657 if (STRINGP (fun) || VECTORP (fun))
1658 return Qt;
1659
1660 /* Lists may represent commands. */
1661 if (!CONSP (fun))
1662 return Qnil;
1663 funcar = Fcar (fun);
1664 if (!SYMBOLP (funcar))
1665 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1666 if (EQ (funcar, Qlambda))
1667 return Fassq (Qinteractive, Fcdr (Fcdr (fun)));
1668 if (EQ (funcar, Qmocklisp))
1669 return Qt; /* All mocklisp functions can be called interactively */
1670 if (EQ (funcar, Qautoload))
1671 return Fcar (Fcdr (Fcdr (Fcdr (fun))));
1672 else
1673 return Qnil;
1674 }
1675
1676 /* ARGSUSED */
1677 DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
1678 "Define FUNCTION to autoload from FILE.\n\
1679 FUNCTION is a symbol; FILE is a file name string to pass to `load'.\n\
1680 Third arg DOCSTRING is documentation for the function.\n\
1681 Fourth arg INTERACTIVE if non-nil says function can be called interactively.\n\
1682 Fifth arg TYPE indicates the type of the object:\n\
1683 nil or omitted says FUNCTION is a function,\n\
1684 `keymap' says FUNCTION is really a keymap, and\n\
1685 `macro' or t says FUNCTION is really a macro.\n\
1686 Third through fifth args give info about the real definition.\n\
1687 They default to nil.\n\
1688 If FUNCTION is already defined other than as an autoload,\n\
1689 this does nothing and returns nil.")
1690 (function, file, docstring, interactive, type)
1691 Lisp_Object function, file, docstring, interactive, type;
1692 {
1693 #ifdef NO_ARG_ARRAY
1694 Lisp_Object args[4];
1695 #endif
1696
1697 CHECK_SYMBOL (function, 0);
1698 CHECK_STRING (file, 1);
1699
1700 /* If function is defined and not as an autoload, don't override */
1701 if (!EQ (XSYMBOL (function)->function, Qunbound)
1702 && !(CONSP (XSYMBOL (function)->function)
1703 && EQ (XCAR (XSYMBOL (function)->function), Qautoload)))
1704 return Qnil;
1705
1706 if (NILP (Vpurify_flag))
1707 /* Only add entries after dumping, because the ones before are
1708 not useful and else we get loads of them from the loaddefs.el. */
1709 LOADHIST_ATTACH (Fcons (Qautoload, function));
1710
1711 #ifdef NO_ARG_ARRAY
1712 args[0] = file;
1713 args[1] = docstring;
1714 args[2] = interactive;
1715 args[3] = type;
1716
1717 return Ffset (function, Fcons (Qautoload, Flist (4, &args[0])));
1718 #else /* NO_ARG_ARRAY */
1719 return Ffset (function, Fcons (Qautoload, Flist (4, &file)));
1720 #endif /* not NO_ARG_ARRAY */
1721 }
1722
1723 Lisp_Object
1724 un_autoload (oldqueue)
1725 Lisp_Object oldqueue;
1726 {
1727 register Lisp_Object queue, first, second;
1728
1729 /* Queue to unwind is current value of Vautoload_queue.
1730 oldqueue is the shadowed value to leave in Vautoload_queue. */
1731 queue = Vautoload_queue;
1732 Vautoload_queue = oldqueue;
1733 while (CONSP (queue))
1734 {
1735 first = Fcar (queue);
1736 second = Fcdr (first);
1737 first = Fcar (first);
1738 if (EQ (second, Qnil))
1739 Vfeatures = first;
1740 else
1741 Ffset (first, second);
1742 queue = Fcdr (queue);
1743 }
1744 return Qnil;
1745 }
1746
1747 /* Load an autoloaded function.
1748 FUNNAME is the symbol which is the function's name.
1749 FUNDEF is the autoload definition (a list). */
1750
1751 void
1752 do_autoload (fundef, funname)
1753 Lisp_Object fundef, funname;
1754 {
1755 int count = specpdl_ptr - specpdl;
1756 Lisp_Object fun, queue, first, second;
1757 struct gcpro gcpro1, gcpro2, gcpro3;
1758
1759 fun = funname;
1760 CHECK_SYMBOL (funname, 0);
1761 GCPRO3 (fun, funname, fundef);
1762
1763 /* Preserve the match data. */
1764 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
1765
1766 /* Value saved here is to be restored into Vautoload_queue. */
1767 record_unwind_protect (un_autoload, Vautoload_queue);
1768 Vautoload_queue = Qt;
1769 Fload (Fcar (Fcdr (fundef)), Qnil, noninteractive ? Qt : Qnil, Qnil, Qt);
1770
1771 /* Save the old autoloads, in case we ever do an unload. */
1772 queue = Vautoload_queue;
1773 while (CONSP (queue))
1774 {
1775 first = Fcar (queue);
1776 second = Fcdr (first);
1777 first = Fcar (first);
1778
1779 /* Note: This test is subtle. The cdr of an autoload-queue entry
1780 may be an atom if the autoload entry was generated by a defalias
1781 or fset. */
1782 if (CONSP (second))
1783 Fput (first, Qautoload, (Fcdr (second)));
1784
1785 queue = Fcdr (queue);
1786 }
1787
1788 /* Once loading finishes, don't undo it. */
1789 Vautoload_queue = Qt;
1790 unbind_to (count, Qnil);
1791
1792 fun = Findirect_function (fun);
1793
1794 if (!NILP (Fequal (fun, fundef)))
1795 error ("Autoloading failed to define function %s",
1796 XSYMBOL (funname)->name->data);
1797 UNGCPRO;
1798 }
1799
1800 \f
1801 DEFUN ("eval", Feval, Seval, 1, 1, 0,
1802 "Evaluate FORM and return its value.")
1803 (form)
1804 Lisp_Object form;
1805 {
1806 Lisp_Object fun, val, original_fun, original_args;
1807 Lisp_Object funcar;
1808 struct backtrace backtrace;
1809 struct gcpro gcpro1, gcpro2, gcpro3;
1810
1811 if (handling_signal)
1812 abort ();
1813
1814 if (SYMBOLP (form))
1815 {
1816 if (EQ (Vmocklisp_arguments, Qt))
1817 return Fsymbol_value (form);
1818 val = Fsymbol_value (form);
1819 if (NILP (val))
1820 XSETFASTINT (val, 0);
1821 else if (EQ (val, Qt))
1822 XSETFASTINT (val, 1);
1823 return val;
1824 }
1825 if (!CONSP (form))
1826 return form;
1827
1828 QUIT;
1829 if (consing_since_gc > gc_cons_threshold)
1830 {
1831 GCPRO1 (form);
1832 Fgarbage_collect ();
1833 UNGCPRO;
1834 }
1835
1836 if (++lisp_eval_depth > max_lisp_eval_depth)
1837 {
1838 if (max_lisp_eval_depth < 100)
1839 max_lisp_eval_depth = 100;
1840 if (lisp_eval_depth > max_lisp_eval_depth)
1841 error ("Lisp nesting exceeds max-lisp-eval-depth");
1842 }
1843
1844 original_fun = Fcar (form);
1845 original_args = Fcdr (form);
1846
1847 backtrace.next = backtrace_list;
1848 backtrace_list = &backtrace;
1849 backtrace.function = &original_fun; /* This also protects them from gc */
1850 backtrace.args = &original_args;
1851 backtrace.nargs = UNEVALLED;
1852 backtrace.evalargs = 1;
1853 backtrace.debug_on_exit = 0;
1854
1855 if (debug_on_next_call)
1856 do_debug_on_call (Qt);
1857
1858 /* At this point, only original_fun and original_args
1859 have values that will be used below */
1860 retry:
1861 fun = Findirect_function (original_fun);
1862
1863 if (SUBRP (fun))
1864 {
1865 Lisp_Object numargs;
1866 Lisp_Object argvals[8];
1867 Lisp_Object args_left;
1868 register int i, maxargs;
1869
1870 args_left = original_args;
1871 numargs = Flength (args_left);
1872
1873 if (XINT (numargs) < XSUBR (fun)->min_args ||
1874 (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < XINT (numargs)))
1875 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (numargs, Qnil)));
1876
1877 if (XSUBR (fun)->max_args == UNEVALLED)
1878 {
1879 backtrace.evalargs = 0;
1880 val = (*XSUBR (fun)->function) (args_left);
1881 goto done;
1882 }
1883
1884 if (XSUBR (fun)->max_args == MANY)
1885 {
1886 /* Pass a vector of evaluated arguments */
1887 Lisp_Object *vals;
1888 register int argnum = 0;
1889
1890 vals = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
1891
1892 GCPRO3 (args_left, fun, fun);
1893 gcpro3.var = vals;
1894 gcpro3.nvars = 0;
1895
1896 while (!NILP (args_left))
1897 {
1898 vals[argnum++] = Feval (Fcar (args_left));
1899 args_left = Fcdr (args_left);
1900 gcpro3.nvars = argnum;
1901 }
1902
1903 backtrace.args = vals;
1904 backtrace.nargs = XINT (numargs);
1905
1906 val = (*XSUBR (fun)->function) (XINT (numargs), vals);
1907 UNGCPRO;
1908 goto done;
1909 }
1910
1911 GCPRO3 (args_left, fun, fun);
1912 gcpro3.var = argvals;
1913 gcpro3.nvars = 0;
1914
1915 maxargs = XSUBR (fun)->max_args;
1916 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
1917 {
1918 argvals[i] = Feval (Fcar (args_left));
1919 gcpro3.nvars = ++i;
1920 }
1921
1922 UNGCPRO;
1923
1924 backtrace.args = argvals;
1925 backtrace.nargs = XINT (numargs);
1926
1927 switch (i)
1928 {
1929 case 0:
1930 val = (*XSUBR (fun)->function) ();
1931 goto done;
1932 case 1:
1933 val = (*XSUBR (fun)->function) (argvals[0]);
1934 goto done;
1935 case 2:
1936 val = (*XSUBR (fun)->function) (argvals[0], argvals[1]);
1937 goto done;
1938 case 3:
1939 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1940 argvals[2]);
1941 goto done;
1942 case 4:
1943 val = (*XSUBR (fun)->function) (argvals[0], argvals[1],
1944 argvals[2], argvals[3]);
1945 goto done;
1946 case 5:
1947 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1948 argvals[3], argvals[4]);
1949 goto done;
1950 case 6:
1951 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1952 argvals[3], argvals[4], argvals[5]);
1953 goto done;
1954 case 7:
1955 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1956 argvals[3], argvals[4], argvals[5],
1957 argvals[6]);
1958 goto done;
1959
1960 case 8:
1961 val = (*XSUBR (fun)->function) (argvals[0], argvals[1], argvals[2],
1962 argvals[3], argvals[4], argvals[5],
1963 argvals[6], argvals[7]);
1964 goto done;
1965
1966 default:
1967 /* Someone has created a subr that takes more arguments than
1968 is supported by this code. We need to either rewrite the
1969 subr to use a different argument protocol, or add more
1970 cases to this switch. */
1971 abort ();
1972 }
1973 }
1974 if (COMPILEDP (fun))
1975 val = apply_lambda (fun, original_args, 1);
1976 else
1977 {
1978 if (!CONSP (fun))
1979 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1980 funcar = Fcar (fun);
1981 if (!SYMBOLP (funcar))
1982 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1983 if (EQ (funcar, Qautoload))
1984 {
1985 do_autoload (fun, original_fun);
1986 goto retry;
1987 }
1988 if (EQ (funcar, Qmacro))
1989 val = Feval (apply1 (Fcdr (fun), original_args));
1990 else if (EQ (funcar, Qlambda))
1991 val = apply_lambda (fun, original_args, 1);
1992 else if (EQ (funcar, Qmocklisp))
1993 val = ml_apply (fun, original_args);
1994 else
1995 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
1996 }
1997 done:
1998 if (!EQ (Vmocklisp_arguments, Qt))
1999 {
2000 if (NILP (val))
2001 XSETFASTINT (val, 0);
2002 else if (EQ (val, Qt))
2003 XSETFASTINT (val, 1);
2004 }
2005 lisp_eval_depth--;
2006 if (backtrace.debug_on_exit)
2007 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2008 backtrace_list = backtrace.next;
2009 return val;
2010 }
2011 \f
2012 DEFUN ("apply", Fapply, Sapply, 2, MANY, 0,
2013 "Call FUNCTION with our remaining args, using our last arg as list of args.\n\
2014 Then return the value FUNCTION returns.\n\
2015 Thus, (apply '+ 1 2 '(3 4)) returns 10.")
2016 (nargs, args)
2017 int nargs;
2018 Lisp_Object *args;
2019 {
2020 register int i, numargs;
2021 register Lisp_Object spread_arg;
2022 register Lisp_Object *funcall_args;
2023 Lisp_Object fun;
2024 struct gcpro gcpro1;
2025
2026 fun = args [0];
2027 funcall_args = 0;
2028 spread_arg = args [nargs - 1];
2029 CHECK_LIST (spread_arg, nargs);
2030
2031 numargs = XINT (Flength (spread_arg));
2032
2033 if (numargs == 0)
2034 return Ffuncall (nargs - 1, args);
2035 else if (numargs == 1)
2036 {
2037 args [nargs - 1] = XCAR (spread_arg);
2038 return Ffuncall (nargs, args);
2039 }
2040
2041 numargs += nargs - 2;
2042
2043 fun = indirect_function (fun);
2044 if (EQ (fun, Qunbound))
2045 {
2046 /* Let funcall get the error */
2047 fun = args[0];
2048 goto funcall;
2049 }
2050
2051 if (SUBRP (fun))
2052 {
2053 if (numargs < XSUBR (fun)->min_args
2054 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2055 goto funcall; /* Let funcall get the error */
2056 else if (XSUBR (fun)->max_args > numargs)
2057 {
2058 /* Avoid making funcall cons up a yet another new vector of arguments
2059 by explicitly supplying nil's for optional values */
2060 funcall_args = (Lisp_Object *) alloca ((1 + XSUBR (fun)->max_args)
2061 * sizeof (Lisp_Object));
2062 for (i = numargs; i < XSUBR (fun)->max_args;)
2063 funcall_args[++i] = Qnil;
2064 GCPRO1 (*funcall_args);
2065 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
2066 }
2067 }
2068 funcall:
2069 /* We add 1 to numargs because funcall_args includes the
2070 function itself as well as its arguments. */
2071 if (!funcall_args)
2072 {
2073 funcall_args = (Lisp_Object *) alloca ((1 + numargs)
2074 * sizeof (Lisp_Object));
2075 GCPRO1 (*funcall_args);
2076 gcpro1.nvars = 1 + numargs;
2077 }
2078
2079 bcopy (args, funcall_args, nargs * sizeof (Lisp_Object));
2080 /* Spread the last arg we got. Its first element goes in
2081 the slot that it used to occupy, hence this value of I. */
2082 i = nargs - 1;
2083 while (!NILP (spread_arg))
2084 {
2085 funcall_args [i++] = XCAR (spread_arg);
2086 spread_arg = XCDR (spread_arg);
2087 }
2088
2089 RETURN_UNGCPRO (Ffuncall (gcpro1.nvars, funcall_args));
2090 }
2091 \f
2092 /* Run hook variables in various ways. */
2093
2094 enum run_hooks_condition {to_completion, until_success, until_failure};
2095
2096 DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 1, MANY, 0,
2097 "Run each hook in HOOKS. Major mode functions use this.\n\
2098 Each argument should be a symbol, a hook variable.\n\
2099 These symbols are processed in the order specified.\n\
2100 If a hook symbol has a non-nil value, that value may be a function\n\
2101 or a list of functions to be called to run the hook.\n\
2102 If the value is a function, it is called with no arguments.\n\
2103 If it is a list, the elements are called, in order, with no arguments.\n\
2104 \n\
2105 To make a hook variable buffer-local, use `make-local-hook',\n\
2106 not `make-local-variable'.")
2107 (nargs, args)
2108 int nargs;
2109 Lisp_Object *args;
2110 {
2111 Lisp_Object hook[1];
2112 register int i;
2113
2114 for (i = 0; i < nargs; i++)
2115 {
2116 hook[0] = args[i];
2117 run_hook_with_args (1, hook, to_completion);
2118 }
2119
2120 return Qnil;
2121 }
2122
2123 DEFUN ("run-hook-with-args", Frun_hook_with_args,
2124 Srun_hook_with_args, 1, MANY, 0,
2125 "Run HOOK with the specified arguments ARGS.\n\
2126 HOOK should be a symbol, a hook variable. If HOOK has a non-nil\n\
2127 value, that value may be a function or a list of functions to be\n\
2128 called to run the hook. If the value is a function, it is called with\n\
2129 the given arguments and its return value is returned. If it is a list\n\
2130 of functions, those functions are called, in order,\n\
2131 with the given arguments ARGS.\n\
2132 It is best not to depend on the value return by `run-hook-with-args',\n\
2133 as that may change.\n\
2134 \n\
2135 To make a hook variable buffer-local, use `make-local-hook',\n\
2136 not `make-local-variable'.")
2137 (nargs, args)
2138 int nargs;
2139 Lisp_Object *args;
2140 {
2141 return run_hook_with_args (nargs, args, to_completion);
2142 }
2143
2144 DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2145 Srun_hook_with_args_until_success, 1, MANY, 0,
2146 "Run HOOK with the specified arguments ARGS.\n\
2147 HOOK should be a symbol, a hook variable. Its value should\n\
2148 be a list of functions. We call those functions, one by one,\n\
2149 passing arguments ARGS to each of them, until one of them\n\
2150 returns a non-nil value. Then we return that value.\n\
2151 If all the functions return nil, we return nil.\n\
2152 \n\
2153 To make a hook variable buffer-local, use `make-local-hook',\n\
2154 not `make-local-variable'.")
2155 (nargs, args)
2156 int nargs;
2157 Lisp_Object *args;
2158 {
2159 return run_hook_with_args (nargs, args, until_success);
2160 }
2161
2162 DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2163 Srun_hook_with_args_until_failure, 1, MANY, 0,
2164 "Run HOOK with the specified arguments ARGS.\n\
2165 HOOK should be a symbol, a hook variable. Its value should\n\
2166 be a list of functions. We call those functions, one by one,\n\
2167 passing arguments ARGS to each of them, until one of them\n\
2168 returns nil. Then we return nil.\n\
2169 If all the functions return non-nil, we return non-nil.\n\
2170 \n\
2171 To make a hook variable buffer-local, use `make-local-hook',\n\
2172 not `make-local-variable'.")
2173 (nargs, args)
2174 int nargs;
2175 Lisp_Object *args;
2176 {
2177 return run_hook_with_args (nargs, args, until_failure);
2178 }
2179
2180 /* ARGS[0] should be a hook symbol.
2181 Call each of the functions in the hook value, passing each of them
2182 as arguments all the rest of ARGS (all NARGS - 1 elements).
2183 COND specifies a condition to test after each call
2184 to decide whether to stop.
2185 The caller (or its caller, etc) must gcpro all of ARGS,
2186 except that it isn't necessary to gcpro ARGS[0]. */
2187
2188 Lisp_Object
2189 run_hook_with_args (nargs, args, cond)
2190 int nargs;
2191 Lisp_Object *args;
2192 enum run_hooks_condition cond;
2193 {
2194 Lisp_Object sym, val, ret;
2195 Lisp_Object globals;
2196 struct gcpro gcpro1, gcpro2, gcpro3;
2197
2198 /* If we are dying or still initializing,
2199 don't do anything--it would probably crash if we tried. */
2200 if (NILP (Vrun_hooks))
2201 return Qnil;
2202
2203 sym = args[0];
2204 val = find_symbol_value (sym);
2205 ret = (cond == until_failure ? Qt : Qnil);
2206
2207 if (EQ (val, Qunbound) || NILP (val))
2208 return ret;
2209 else if (!CONSP (val) || EQ (XCAR (val), Qlambda))
2210 {
2211 args[0] = val;
2212 return Ffuncall (nargs, args);
2213 }
2214 else
2215 {
2216 globals = Qnil;
2217 GCPRO3 (sym, val, globals);
2218
2219 for (;
2220 CONSP (val) && ((cond == to_completion)
2221 || (cond == until_success ? NILP (ret)
2222 : !NILP (ret)));
2223 val = XCDR (val))
2224 {
2225 if (EQ (XCAR (val), Qt))
2226 {
2227 /* t indicates this hook has a local binding;
2228 it means to run the global binding too. */
2229
2230 for (globals = Fdefault_value (sym);
2231 CONSP (globals) && ((cond == to_completion)
2232 || (cond == until_success ? NILP (ret)
2233 : !NILP (ret)));
2234 globals = XCDR (globals))
2235 {
2236 args[0] = XCAR (globals);
2237 /* In a global value, t should not occur. If it does, we
2238 must ignore it to avoid an endless loop. */
2239 if (!EQ (args[0], Qt))
2240 ret = Ffuncall (nargs, args);
2241 }
2242 }
2243 else
2244 {
2245 args[0] = XCAR (val);
2246 ret = Ffuncall (nargs, args);
2247 }
2248 }
2249
2250 UNGCPRO;
2251 return ret;
2252 }
2253 }
2254
2255 /* Run a hook symbol ARGS[0], but use FUNLIST instead of the actual
2256 present value of that symbol.
2257 Call each element of FUNLIST,
2258 passing each of them the rest of ARGS.
2259 The caller (or its caller, etc) must gcpro all of ARGS,
2260 except that it isn't necessary to gcpro ARGS[0]. */
2261
2262 Lisp_Object
2263 run_hook_list_with_args (funlist, nargs, args)
2264 Lisp_Object funlist;
2265 int nargs;
2266 Lisp_Object *args;
2267 {
2268 Lisp_Object sym;
2269 Lisp_Object val;
2270 Lisp_Object globals;
2271 struct gcpro gcpro1, gcpro2, gcpro3;
2272
2273 sym = args[0];
2274 globals = Qnil;
2275 GCPRO3 (sym, val, globals);
2276
2277 for (val = funlist; CONSP (val); val = XCDR (val))
2278 {
2279 if (EQ (XCAR (val), Qt))
2280 {
2281 /* t indicates this hook has a local binding;
2282 it means to run the global binding too. */
2283
2284 for (globals = Fdefault_value (sym);
2285 CONSP (globals);
2286 globals = XCDR (globals))
2287 {
2288 args[0] = XCAR (globals);
2289 /* In a global value, t should not occur. If it does, we
2290 must ignore it to avoid an endless loop. */
2291 if (!EQ (args[0], Qt))
2292 Ffuncall (nargs, args);
2293 }
2294 }
2295 else
2296 {
2297 args[0] = XCAR (val);
2298 Ffuncall (nargs, args);
2299 }
2300 }
2301 UNGCPRO;
2302 return Qnil;
2303 }
2304
2305 /* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2306
2307 void
2308 run_hook_with_args_2 (hook, arg1, arg2)
2309 Lisp_Object hook, arg1, arg2;
2310 {
2311 Lisp_Object temp[3];
2312 temp[0] = hook;
2313 temp[1] = arg1;
2314 temp[2] = arg2;
2315
2316 Frun_hook_with_args (3, temp);
2317 }
2318 \f
2319 /* Apply fn to arg */
2320 Lisp_Object
2321 apply1 (fn, arg)
2322 Lisp_Object fn, arg;
2323 {
2324 struct gcpro gcpro1;
2325
2326 GCPRO1 (fn);
2327 if (NILP (arg))
2328 RETURN_UNGCPRO (Ffuncall (1, &fn));
2329 gcpro1.nvars = 2;
2330 #ifdef NO_ARG_ARRAY
2331 {
2332 Lisp_Object args[2];
2333 args[0] = fn;
2334 args[1] = arg;
2335 gcpro1.var = args;
2336 RETURN_UNGCPRO (Fapply (2, args));
2337 }
2338 #else /* not NO_ARG_ARRAY */
2339 RETURN_UNGCPRO (Fapply (2, &fn));
2340 #endif /* not NO_ARG_ARRAY */
2341 }
2342
2343 /* Call function fn on no arguments */
2344 Lisp_Object
2345 call0 (fn)
2346 Lisp_Object fn;
2347 {
2348 struct gcpro gcpro1;
2349
2350 GCPRO1 (fn);
2351 RETURN_UNGCPRO (Ffuncall (1, &fn));
2352 }
2353
2354 /* Call function fn with 1 argument arg1 */
2355 /* ARGSUSED */
2356 Lisp_Object
2357 call1 (fn, arg1)
2358 Lisp_Object fn, arg1;
2359 {
2360 struct gcpro gcpro1;
2361 #ifdef NO_ARG_ARRAY
2362 Lisp_Object args[2];
2363
2364 args[0] = fn;
2365 args[1] = arg1;
2366 GCPRO1 (args[0]);
2367 gcpro1.nvars = 2;
2368 RETURN_UNGCPRO (Ffuncall (2, args));
2369 #else /* not NO_ARG_ARRAY */
2370 GCPRO1 (fn);
2371 gcpro1.nvars = 2;
2372 RETURN_UNGCPRO (Ffuncall (2, &fn));
2373 #endif /* not NO_ARG_ARRAY */
2374 }
2375
2376 /* Call function fn with 2 arguments arg1, arg2 */
2377 /* ARGSUSED */
2378 Lisp_Object
2379 call2 (fn, arg1, arg2)
2380 Lisp_Object fn, arg1, arg2;
2381 {
2382 struct gcpro gcpro1;
2383 #ifdef NO_ARG_ARRAY
2384 Lisp_Object args[3];
2385 args[0] = fn;
2386 args[1] = arg1;
2387 args[2] = arg2;
2388 GCPRO1 (args[0]);
2389 gcpro1.nvars = 3;
2390 RETURN_UNGCPRO (Ffuncall (3, args));
2391 #else /* not NO_ARG_ARRAY */
2392 GCPRO1 (fn);
2393 gcpro1.nvars = 3;
2394 RETURN_UNGCPRO (Ffuncall (3, &fn));
2395 #endif /* not NO_ARG_ARRAY */
2396 }
2397
2398 /* Call function fn with 3 arguments arg1, arg2, arg3 */
2399 /* ARGSUSED */
2400 Lisp_Object
2401 call3 (fn, arg1, arg2, arg3)
2402 Lisp_Object fn, arg1, arg2, arg3;
2403 {
2404 struct gcpro gcpro1;
2405 #ifdef NO_ARG_ARRAY
2406 Lisp_Object args[4];
2407 args[0] = fn;
2408 args[1] = arg1;
2409 args[2] = arg2;
2410 args[3] = arg3;
2411 GCPRO1 (args[0]);
2412 gcpro1.nvars = 4;
2413 RETURN_UNGCPRO (Ffuncall (4, args));
2414 #else /* not NO_ARG_ARRAY */
2415 GCPRO1 (fn);
2416 gcpro1.nvars = 4;
2417 RETURN_UNGCPRO (Ffuncall (4, &fn));
2418 #endif /* not NO_ARG_ARRAY */
2419 }
2420
2421 /* Call function fn with 4 arguments arg1, arg2, arg3, arg4 */
2422 /* ARGSUSED */
2423 Lisp_Object
2424 call4 (fn, arg1, arg2, arg3, arg4)
2425 Lisp_Object fn, arg1, arg2, arg3, arg4;
2426 {
2427 struct gcpro gcpro1;
2428 #ifdef NO_ARG_ARRAY
2429 Lisp_Object args[5];
2430 args[0] = fn;
2431 args[1] = arg1;
2432 args[2] = arg2;
2433 args[3] = arg3;
2434 args[4] = arg4;
2435 GCPRO1 (args[0]);
2436 gcpro1.nvars = 5;
2437 RETURN_UNGCPRO (Ffuncall (5, args));
2438 #else /* not NO_ARG_ARRAY */
2439 GCPRO1 (fn);
2440 gcpro1.nvars = 5;
2441 RETURN_UNGCPRO (Ffuncall (5, &fn));
2442 #endif /* not NO_ARG_ARRAY */
2443 }
2444
2445 /* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5 */
2446 /* ARGSUSED */
2447 Lisp_Object
2448 call5 (fn, arg1, arg2, arg3, arg4, arg5)
2449 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5;
2450 {
2451 struct gcpro gcpro1;
2452 #ifdef NO_ARG_ARRAY
2453 Lisp_Object args[6];
2454 args[0] = fn;
2455 args[1] = arg1;
2456 args[2] = arg2;
2457 args[3] = arg3;
2458 args[4] = arg4;
2459 args[5] = arg5;
2460 GCPRO1 (args[0]);
2461 gcpro1.nvars = 6;
2462 RETURN_UNGCPRO (Ffuncall (6, args));
2463 #else /* not NO_ARG_ARRAY */
2464 GCPRO1 (fn);
2465 gcpro1.nvars = 6;
2466 RETURN_UNGCPRO (Ffuncall (6, &fn));
2467 #endif /* not NO_ARG_ARRAY */
2468 }
2469
2470 /* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6 */
2471 /* ARGSUSED */
2472 Lisp_Object
2473 call6 (fn, arg1, arg2, arg3, arg4, arg5, arg6)
2474 Lisp_Object fn, arg1, arg2, arg3, arg4, arg5, arg6;
2475 {
2476 struct gcpro gcpro1;
2477 #ifdef NO_ARG_ARRAY
2478 Lisp_Object args[7];
2479 args[0] = fn;
2480 args[1] = arg1;
2481 args[2] = arg2;
2482 args[3] = arg3;
2483 args[4] = arg4;
2484 args[5] = arg5;
2485 args[6] = arg6;
2486 GCPRO1 (args[0]);
2487 gcpro1.nvars = 7;
2488 RETURN_UNGCPRO (Ffuncall (7, args));
2489 #else /* not NO_ARG_ARRAY */
2490 GCPRO1 (fn);
2491 gcpro1.nvars = 7;
2492 RETURN_UNGCPRO (Ffuncall (7, &fn));
2493 #endif /* not NO_ARG_ARRAY */
2494 }
2495
2496 DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0,
2497 "Call first argument as a function, passing remaining arguments to it.\n\
2498 Return the value that function returns.\n\
2499 Thus, (funcall 'cons 'x 'y) returns (x . y).")
2500 (nargs, args)
2501 int nargs;
2502 Lisp_Object *args;
2503 {
2504 Lisp_Object fun;
2505 Lisp_Object funcar;
2506 int numargs = nargs - 1;
2507 Lisp_Object lisp_numargs;
2508 Lisp_Object val;
2509 struct backtrace backtrace;
2510 register Lisp_Object *internal_args;
2511 register int i;
2512
2513 QUIT;
2514 if (consing_since_gc > gc_cons_threshold)
2515 Fgarbage_collect ();
2516
2517 if (++lisp_eval_depth > max_lisp_eval_depth)
2518 {
2519 if (max_lisp_eval_depth < 100)
2520 max_lisp_eval_depth = 100;
2521 if (lisp_eval_depth > max_lisp_eval_depth)
2522 error ("Lisp nesting exceeds max-lisp-eval-depth");
2523 }
2524
2525 backtrace.next = backtrace_list;
2526 backtrace_list = &backtrace;
2527 backtrace.function = &args[0];
2528 backtrace.args = &args[1];
2529 backtrace.nargs = nargs - 1;
2530 backtrace.evalargs = 0;
2531 backtrace.debug_on_exit = 0;
2532
2533 if (debug_on_next_call)
2534 do_debug_on_call (Qlambda);
2535
2536 retry:
2537
2538 fun = args[0];
2539
2540 fun = Findirect_function (fun);
2541
2542 if (SUBRP (fun))
2543 {
2544 if (numargs < XSUBR (fun)->min_args
2545 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2546 {
2547 XSETFASTINT (lisp_numargs, numargs);
2548 return Fsignal (Qwrong_number_of_arguments, Fcons (fun, Fcons (lisp_numargs, Qnil)));
2549 }
2550
2551 if (XSUBR (fun)->max_args == UNEVALLED)
2552 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2553
2554 if (XSUBR (fun)->max_args == MANY)
2555 {
2556 val = (*XSUBR (fun)->function) (numargs, args + 1);
2557 goto done;
2558 }
2559
2560 if (XSUBR (fun)->max_args > numargs)
2561 {
2562 internal_args = (Lisp_Object *) alloca (XSUBR (fun)->max_args * sizeof (Lisp_Object));
2563 bcopy (args + 1, internal_args, numargs * sizeof (Lisp_Object));
2564 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2565 internal_args[i] = Qnil;
2566 }
2567 else
2568 internal_args = args + 1;
2569 switch (XSUBR (fun)->max_args)
2570 {
2571 case 0:
2572 val = (*XSUBR (fun)->function) ();
2573 goto done;
2574 case 1:
2575 val = (*XSUBR (fun)->function) (internal_args[0]);
2576 goto done;
2577 case 2:
2578 val = (*XSUBR (fun)->function) (internal_args[0],
2579 internal_args[1]);
2580 goto done;
2581 case 3:
2582 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2583 internal_args[2]);
2584 goto done;
2585 case 4:
2586 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2587 internal_args[2],
2588 internal_args[3]);
2589 goto done;
2590 case 5:
2591 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2592 internal_args[2], internal_args[3],
2593 internal_args[4]);
2594 goto done;
2595 case 6:
2596 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2597 internal_args[2], internal_args[3],
2598 internal_args[4], internal_args[5]);
2599 goto done;
2600 case 7:
2601 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2602 internal_args[2], internal_args[3],
2603 internal_args[4], internal_args[5],
2604 internal_args[6]);
2605 goto done;
2606
2607 case 8:
2608 val = (*XSUBR (fun)->function) (internal_args[0], internal_args[1],
2609 internal_args[2], internal_args[3],
2610 internal_args[4], internal_args[5],
2611 internal_args[6], internal_args[7]);
2612 goto done;
2613
2614 default:
2615
2616 /* If a subr takes more than 8 arguments without using MANY
2617 or UNEVALLED, we need to extend this function to support it.
2618 Until this is done, there is no way to call the function. */
2619 abort ();
2620 }
2621 }
2622 if (COMPILEDP (fun))
2623 val = funcall_lambda (fun, numargs, args + 1);
2624 else
2625 {
2626 if (!CONSP (fun))
2627 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2628 funcar = Fcar (fun);
2629 if (!SYMBOLP (funcar))
2630 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2631 if (EQ (funcar, Qlambda))
2632 val = funcall_lambda (fun, numargs, args + 1);
2633 else if (EQ (funcar, Qmocklisp))
2634 val = ml_apply (fun, Flist (numargs, args + 1));
2635 else if (EQ (funcar, Qautoload))
2636 {
2637 do_autoload (fun, args[0]);
2638 goto retry;
2639 }
2640 else
2641 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2642 }
2643 done:
2644 lisp_eval_depth--;
2645 if (backtrace.debug_on_exit)
2646 val = call_debugger (Fcons (Qexit, Fcons (val, Qnil)));
2647 backtrace_list = backtrace.next;
2648 return val;
2649 }
2650 \f
2651 Lisp_Object
2652 apply_lambda (fun, args, eval_flag)
2653 Lisp_Object fun, args;
2654 int eval_flag;
2655 {
2656 Lisp_Object args_left;
2657 Lisp_Object numargs;
2658 register Lisp_Object *arg_vector;
2659 struct gcpro gcpro1, gcpro2, gcpro3;
2660 register int i;
2661 register Lisp_Object tem;
2662
2663 numargs = Flength (args);
2664 arg_vector = (Lisp_Object *) alloca (XINT (numargs) * sizeof (Lisp_Object));
2665 args_left = args;
2666
2667 GCPRO3 (*arg_vector, args_left, fun);
2668 gcpro1.nvars = 0;
2669
2670 for (i = 0; i < XINT (numargs);)
2671 {
2672 tem = Fcar (args_left), args_left = Fcdr (args_left);
2673 if (eval_flag) tem = Feval (tem);
2674 arg_vector[i++] = tem;
2675 gcpro1.nvars = i;
2676 }
2677
2678 UNGCPRO;
2679
2680 if (eval_flag)
2681 {
2682 backtrace_list->args = arg_vector;
2683 backtrace_list->nargs = i;
2684 }
2685 backtrace_list->evalargs = 0;
2686 tem = funcall_lambda (fun, XINT (numargs), arg_vector);
2687
2688 /* Do the debug-on-exit now, while arg_vector still exists. */
2689 if (backtrace_list->debug_on_exit)
2690 tem = call_debugger (Fcons (Qexit, Fcons (tem, Qnil)));
2691 /* Don't do it again when we return to eval. */
2692 backtrace_list->debug_on_exit = 0;
2693 return tem;
2694 }
2695
2696 /* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2697 and return the result of evaluation.
2698 FUN must be either a lambda-expression or a compiled-code object. */
2699
2700 Lisp_Object
2701 funcall_lambda (fun, nargs, arg_vector)
2702 Lisp_Object fun;
2703 int nargs;
2704 register Lisp_Object *arg_vector;
2705 {
2706 Lisp_Object val, syms_left, next;
2707 int count = specpdl_ptr - specpdl;
2708 int i, optional, rest;
2709
2710 if (NILP (Vmocklisp_arguments))
2711 specbind (Qmocklisp_arguments, Qt); /* t means NOT mocklisp! */
2712
2713 if (CONSP (fun))
2714 {
2715 syms_left = XCDR (fun);
2716 if (CONSP (syms_left))
2717 syms_left = XCAR (syms_left);
2718 else
2719 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2720 }
2721 else if (COMPILEDP (fun))
2722 syms_left = XVECTOR (fun)->contents[COMPILED_ARGLIST];
2723 else
2724 abort ();
2725
2726 i = optional = rest = 0;
2727 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
2728 {
2729 QUIT;
2730
2731 next = XCAR (syms_left);
2732 while (!SYMBOLP (next))
2733 next = Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2734
2735 if (EQ (next, Qand_rest))
2736 rest = 1;
2737 else if (EQ (next, Qand_optional))
2738 optional = 1;
2739 else if (rest)
2740 {
2741 specbind (next, Flist (nargs - i, &arg_vector[i]));
2742 i = nargs;
2743 }
2744 else if (i < nargs)
2745 specbind (next, arg_vector[i++]);
2746 else if (!optional)
2747 return Fsignal (Qwrong_number_of_arguments,
2748 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2749 else
2750 specbind (next, Qnil);
2751 }
2752
2753 if (!NILP (syms_left))
2754 return Fsignal (Qinvalid_function, Fcons (fun, Qnil));
2755 else if (i < nargs)
2756 return Fsignal (Qwrong_number_of_arguments,
2757 Fcons (fun, Fcons (make_number (nargs), Qnil)));
2758
2759 if (CONSP (fun))
2760 val = Fprogn (XCDR (XCDR (fun)));
2761 else
2762 {
2763 /* If we have not actually read the bytecode string
2764 and constants vector yet, fetch them from the file. */
2765 if (CONSP (XVECTOR (fun)->contents[COMPILED_BYTECODE]))
2766 Ffetch_bytecode (fun);
2767 val = Fbyte_code (XVECTOR (fun)->contents[COMPILED_BYTECODE],
2768 XVECTOR (fun)->contents[COMPILED_CONSTANTS],
2769 XVECTOR (fun)->contents[COMPILED_STACK_DEPTH]);
2770 }
2771
2772 return unbind_to (count, val);
2773 }
2774
2775 DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
2776 1, 1, 0,
2777 "If byte-compiled OBJECT is lazy-loaded, fetch it now.")
2778 (object)
2779 Lisp_Object object;
2780 {
2781 Lisp_Object tem;
2782
2783 if (COMPILEDP (object)
2784 && CONSP (XVECTOR (object)->contents[COMPILED_BYTECODE]))
2785 {
2786 tem = read_doc_string (XVECTOR (object)->contents[COMPILED_BYTECODE]);
2787 if (!CONSP (tem))
2788 error ("invalid byte code");
2789 XVECTOR (object)->contents[COMPILED_BYTECODE] = XCAR (tem);
2790 XVECTOR (object)->contents[COMPILED_CONSTANTS] = XCDR (tem);
2791 }
2792 return object;
2793 }
2794 \f
2795 void
2796 grow_specpdl ()
2797 {
2798 register int count = specpdl_ptr - specpdl;
2799 if (specpdl_size >= max_specpdl_size)
2800 {
2801 if (max_specpdl_size < 400)
2802 max_specpdl_size = 400;
2803 if (specpdl_size >= max_specpdl_size)
2804 {
2805 if (!NILP (Vdebug_on_error))
2806 /* Leave room for some specpdl in the debugger. */
2807 max_specpdl_size = specpdl_size + 100;
2808 Fsignal (Qerror,
2809 Fcons (build_string ("Variable binding depth exceeds max-specpdl-size"), Qnil));
2810 }
2811 }
2812 specpdl_size *= 2;
2813 if (specpdl_size > max_specpdl_size)
2814 specpdl_size = max_specpdl_size;
2815 specpdl = (struct specbinding *) xrealloc (specpdl, specpdl_size * sizeof (struct specbinding));
2816 specpdl_ptr = specpdl + count;
2817 }
2818
2819 void
2820 specbind (symbol, value)
2821 Lisp_Object symbol, value;
2822 {
2823 Lisp_Object ovalue;
2824
2825 CHECK_SYMBOL (symbol, 0);
2826 if (specpdl_ptr == specpdl + specpdl_size)
2827 grow_specpdl ();
2828
2829 /* The most common case is that a non-constant symbol with a trivial
2830 value. Make that as fast as we can. */
2831 if (!MISCP (XSYMBOL (symbol)->value)
2832 && !EQ (symbol, Qnil)
2833 && !EQ (symbol, Qt)
2834 && !(XSYMBOL (symbol)->name->data[0] == ':'
2835 && EQ (XSYMBOL (symbol)->obarray, initial_obarray)
2836 && !EQ (value, symbol)))
2837 {
2838 specpdl_ptr->symbol = symbol;
2839 specpdl_ptr->old_value = XSYMBOL (symbol)->value;
2840 specpdl_ptr->func = NULL;
2841 ++specpdl_ptr;
2842 XSYMBOL (symbol)->value = value;
2843 }
2844 else
2845 {
2846 ovalue = find_symbol_value (symbol);
2847 specpdl_ptr->func = 0;
2848 specpdl_ptr->old_value = ovalue;
2849
2850 if (BUFFER_LOCAL_VALUEP (XSYMBOL (symbol)->value)
2851 || SOME_BUFFER_LOCAL_VALUEP (XSYMBOL (symbol)->value)
2852 || BUFFER_OBJFWDP (XSYMBOL (symbol)->value))
2853 {
2854 Lisp_Object current_buffer, binding_buffer;
2855 /* For a local variable, record both the symbol and which
2856 buffer's value we are saving. */
2857 current_buffer = Fcurrent_buffer ();
2858 binding_buffer = current_buffer;
2859 /* If the variable is not local in this buffer,
2860 we are saving the global value, so restore that. */
2861 if (NILP (Flocal_variable_p (symbol, binding_buffer)))
2862 binding_buffer = Qnil;
2863 specpdl_ptr->symbol
2864 = Fcons (symbol, Fcons (binding_buffer, current_buffer));
2865 }
2866 else
2867 specpdl_ptr->symbol = symbol;
2868
2869 specpdl_ptr++;
2870 if (BUFFER_OBJFWDP (ovalue) || KBOARD_OBJFWDP (ovalue))
2871 store_symval_forwarding (symbol, ovalue, value);
2872 else
2873 set_internal (symbol, value, 0, 1);
2874 }
2875 }
2876
2877 void
2878 record_unwind_protect (function, arg)
2879 Lisp_Object (*function) P_ ((Lisp_Object));
2880 Lisp_Object arg;
2881 {
2882 if (specpdl_ptr == specpdl + specpdl_size)
2883 grow_specpdl ();
2884 specpdl_ptr->func = function;
2885 specpdl_ptr->symbol = Qnil;
2886 specpdl_ptr->old_value = arg;
2887 specpdl_ptr++;
2888 }
2889
2890 Lisp_Object
2891 unbind_to (count, value)
2892 int count;
2893 Lisp_Object value;
2894 {
2895 int quitf = !NILP (Vquit_flag);
2896 struct gcpro gcpro1;
2897
2898 GCPRO1 (value);
2899 Vquit_flag = Qnil;
2900
2901 while (specpdl_ptr != specpdl + count)
2902 {
2903 --specpdl_ptr;
2904
2905 if (specpdl_ptr->func != 0)
2906 (*specpdl_ptr->func) (specpdl_ptr->old_value);
2907 /* Note that a "binding" of nil is really an unwind protect,
2908 so in that case the "old value" is a list of forms to evaluate. */
2909 else if (NILP (specpdl_ptr->symbol))
2910 Fprogn (specpdl_ptr->old_value);
2911 /* If the symbol is a list, it is really
2912 (SYMBOL BINDING_BUFFER . CURRENT_BUFFER)
2913 and it indicates we bound a variable that has
2914 buffer-local bindings. */
2915 else if (CONSP (specpdl_ptr->symbol))
2916 {
2917 Lisp_Object symbol, buffer;
2918
2919 symbol = XCAR (specpdl_ptr->symbol);
2920 buffer = XCAR (XCDR (specpdl_ptr->symbol));
2921
2922 /* Handle restoring a default value. */
2923 if (NILP (buffer))
2924 Fset_default (symbol, specpdl_ptr->old_value);
2925 /* Handle restoring a value saved from a live buffer. */
2926 else
2927 set_internal (symbol, specpdl_ptr->old_value, XBUFFER (buffer), 1);
2928 }
2929 else
2930 {
2931 /* If variable has a trivial value (no forwarding), we can
2932 just set it. No need to check for constant symbols here,
2933 since that was already done by specbind. */
2934 if (!MISCP (XSYMBOL (specpdl_ptr->symbol)->value))
2935 XSYMBOL (specpdl_ptr->symbol)->value = specpdl_ptr->old_value;
2936 else
2937 set_internal (specpdl_ptr->symbol, specpdl_ptr->old_value, 0, 1);
2938 }
2939 }
2940
2941 if (NILP (Vquit_flag) && quitf)
2942 Vquit_flag = Qt;
2943
2944 UNGCPRO;
2945 return value;
2946 }
2947 \f
2948 #if 0
2949
2950 /* Get the value of symbol's global binding, even if that binding
2951 is not now dynamically visible. */
2952
2953 Lisp_Object
2954 top_level_value (symbol)
2955 Lisp_Object symbol;
2956 {
2957 register struct specbinding *ptr = specpdl;
2958
2959 CHECK_SYMBOL (symbol, 0);
2960 for (; ptr != specpdl_ptr; ptr++)
2961 {
2962 if (EQ (ptr->symbol, symbol))
2963 return ptr->old_value;
2964 }
2965 return Fsymbol_value (symbol);
2966 }
2967
2968 Lisp_Object
2969 top_level_set (symbol, newval)
2970 Lisp_Object symbol, newval;
2971 {
2972 register struct specbinding *ptr = specpdl;
2973
2974 CHECK_SYMBOL (symbol, 0);
2975 for (; ptr != specpdl_ptr; ptr++)
2976 {
2977 if (EQ (ptr->symbol, symbol))
2978 {
2979 ptr->old_value = newval;
2980 return newval;
2981 }
2982 }
2983 return Fset (symbol, newval);
2984 }
2985
2986 #endif /* 0 */
2987 \f
2988 DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
2989 "Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.\n\
2990 The debugger is entered when that frame exits, if the flag is non-nil.")
2991 (level, flag)
2992 Lisp_Object level, flag;
2993 {
2994 register struct backtrace *backlist = backtrace_list;
2995 register int i;
2996
2997 CHECK_NUMBER (level, 0);
2998
2999 for (i = 0; backlist && i < XINT (level); i++)
3000 {
3001 backlist = backlist->next;
3002 }
3003
3004 if (backlist)
3005 backlist->debug_on_exit = !NILP (flag);
3006
3007 return flag;
3008 }
3009
3010 DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
3011 "Print a trace of Lisp function calls currently active.\n\
3012 Output stream used is value of `standard-output'.")
3013 ()
3014 {
3015 register struct backtrace *backlist = backtrace_list;
3016 register int i;
3017 Lisp_Object tail;
3018 Lisp_Object tem;
3019 extern Lisp_Object Vprint_level;
3020 struct gcpro gcpro1;
3021
3022 XSETFASTINT (Vprint_level, 3);
3023
3024 tail = Qnil;
3025 GCPRO1 (tail);
3026
3027 while (backlist)
3028 {
3029 write_string (backlist->debug_on_exit ? "* " : " ", 2);
3030 if (backlist->nargs == UNEVALLED)
3031 {
3032 Fprin1 (Fcons (*backlist->function, *backlist->args), Qnil);
3033 write_string ("\n", -1);
3034 }
3035 else
3036 {
3037 tem = *backlist->function;
3038 Fprin1 (tem, Qnil); /* This can QUIT */
3039 write_string ("(", -1);
3040 if (backlist->nargs == MANY)
3041 {
3042 for (tail = *backlist->args, i = 0;
3043 !NILP (tail);
3044 tail = Fcdr (tail), i++)
3045 {
3046 if (i) write_string (" ", -1);
3047 Fprin1 (Fcar (tail), Qnil);
3048 }
3049 }
3050 else
3051 {
3052 for (i = 0; i < backlist->nargs; i++)
3053 {
3054 if (i) write_string (" ", -1);
3055 Fprin1 (backlist->args[i], Qnil);
3056 }
3057 }
3058 write_string (")\n", -1);
3059 }
3060 backlist = backlist->next;
3061 }
3062
3063 Vprint_level = Qnil;
3064 UNGCPRO;
3065 return Qnil;
3066 }
3067
3068 DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 1, "",
3069 "Return the function and arguments NFRAMES up from current execution point.\n\
3070 If that frame has not evaluated the arguments yet (or is a special form),\n\
3071 the value is (nil FUNCTION ARG-FORMS...).\n\
3072 If that frame has evaluated its arguments and called its function already,\n\
3073 the value is (t FUNCTION ARG-VALUES...).\n\
3074 A &rest arg is represented as the tail of the list ARG-VALUES.\n\
3075 FUNCTION is whatever was supplied as car of evaluated list,\n\
3076 or a lambda expression for macro calls.\n\
3077 If NFRAMES is more than the number of frames, the value is nil.")
3078 (nframes)
3079 Lisp_Object nframes;
3080 {
3081 register struct backtrace *backlist = backtrace_list;
3082 register int i;
3083 Lisp_Object tem;
3084
3085 CHECK_NATNUM (nframes, 0);
3086
3087 /* Find the frame requested. */
3088 for (i = 0; backlist && i < XFASTINT (nframes); i++)
3089 backlist = backlist->next;
3090
3091 if (!backlist)
3092 return Qnil;
3093 if (backlist->nargs == UNEVALLED)
3094 return Fcons (Qnil, Fcons (*backlist->function, *backlist->args));
3095 else
3096 {
3097 if (backlist->nargs == MANY)
3098 tem = *backlist->args;
3099 else
3100 tem = Flist (backlist->nargs, backlist->args);
3101
3102 return Fcons (Qt, Fcons (*backlist->function, tem));
3103 }
3104 }
3105
3106 \f
3107 void
3108 syms_of_eval ()
3109 {
3110 DEFVAR_INT ("max-specpdl-size", &max_specpdl_size,
3111 "*Limit on number of Lisp variable bindings & unwind-protects.\n\
3112 If Lisp code tries to make more than this many at once,\n\
3113 an error is signaled.");
3114
3115 DEFVAR_INT ("max-lisp-eval-depth", &max_lisp_eval_depth,
3116 "*Limit on depth in `eval', `apply' and `funcall' before error.\n\
3117 This limit is to catch infinite recursions for you before they cause\n\
3118 actual stack overflow in C, which would be fatal for Emacs.\n\
3119 You can safely make it considerably larger than its default value,\n\
3120 if that proves inconveniently small.");
3121
3122 DEFVAR_LISP ("quit-flag", &Vquit_flag,
3123 "Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.\n\
3124 Typing C-g sets `quit-flag' non-nil, regardless of `inhibit-quit'.");
3125 Vquit_flag = Qnil;
3126
3127 DEFVAR_LISP ("inhibit-quit", &Vinhibit_quit,
3128 "Non-nil inhibits C-g quitting from happening immediately.\n\
3129 Note that `quit-flag' will still be set by typing C-g,\n\
3130 so a quit will be signaled as soon as `inhibit-quit' is nil.\n\
3131 To prevent this happening, set `quit-flag' to nil\n\
3132 before making `inhibit-quit' nil.");
3133 Vinhibit_quit = Qnil;
3134
3135 Qinhibit_quit = intern ("inhibit-quit");
3136 staticpro (&Qinhibit_quit);
3137
3138 Qautoload = intern ("autoload");
3139 staticpro (&Qautoload);
3140
3141 Qdebug_on_error = intern ("debug-on-error");
3142 staticpro (&Qdebug_on_error);
3143
3144 Qmacro = intern ("macro");
3145 staticpro (&Qmacro);
3146
3147 /* Note that the process handling also uses Qexit, but we don't want
3148 to staticpro it twice, so we just do it here. */
3149 Qexit = intern ("exit");
3150 staticpro (&Qexit);
3151
3152 Qinteractive = intern ("interactive");
3153 staticpro (&Qinteractive);
3154
3155 Qcommandp = intern ("commandp");
3156 staticpro (&Qcommandp);
3157
3158 Qdefun = intern ("defun");
3159 staticpro (&Qdefun);
3160
3161 Qand_rest = intern ("&rest");
3162 staticpro (&Qand_rest);
3163
3164 Qand_optional = intern ("&optional");
3165 staticpro (&Qand_optional);
3166
3167 DEFVAR_LISP ("stack-trace-on-error", &Vstack_trace_on_error,
3168 "*Non-nil means automatically display a backtrace buffer\n\
3169 after any error that is handled by the editor command loop.\n\
3170 If the value is a list, an error only means to display a backtrace\n\
3171 if one of its condition symbols appears in the list.");
3172 Vstack_trace_on_error = Qnil;
3173
3174 DEFVAR_LISP ("debug-on-error", &Vdebug_on_error,
3175 "*Non-nil means enter debugger if an error is signaled.\n\
3176 Does not apply to errors handled by `condition-case'.\n\
3177 If the value is a list, an error only means to enter the debugger\n\
3178 if one of its condition symbols appears in the list.\n\
3179 See also variable `debug-on-quit'.");
3180 Vdebug_on_error = Qnil;
3181
3182 DEFVAR_LISP ("debug-ignored-errors", &Vdebug_ignored_errors,
3183 "*List of errors for which the debugger should not be called.\n\
3184 Each element may be a condition-name or a regexp that matches error messages.\n\
3185 If any element applies to a given error, that error skips the debugger\n\
3186 and just returns to top level.\n\
3187 This overrides the variable `debug-on-error'.\n\
3188 It does not apply to errors handled by `condition-case'.");
3189 Vdebug_ignored_errors = Qnil;
3190
3191 DEFVAR_BOOL ("debug-on-quit", &debug_on_quit,
3192 "*Non-nil means enter debugger if quit is signaled (C-g, for example).\n\
3193 Does not apply if quit is handled by a `condition-case'.");
3194 debug_on_quit = 0;
3195
3196 DEFVAR_BOOL ("debug-on-next-call", &debug_on_next_call,
3197 "Non-nil means enter debugger before next `eval', `apply' or `funcall'.");
3198
3199 DEFVAR_BOOL ("debugger-may-continue", &debugger_may_continue,
3200 "Non-nil means debugger may continue execution.\n\
3201 This is nil when the debugger is called under circumstances where it\n\
3202 might not be safe to continue.");
3203 debugger_may_continue = 1;
3204
3205 DEFVAR_LISP ("debugger", &Vdebugger,
3206 "Function to call to invoke debugger.\n\
3207 If due to frame exit, args are `exit' and the value being returned;\n\
3208 this function's value will be returned instead of that.\n\
3209 If due to error, args are `error' and a list of the args to `signal'.\n\
3210 If due to `apply' or `funcall' entry, one arg, `lambda'.\n\
3211 If due to `eval' entry, one arg, t.");
3212 Vdebugger = Qnil;
3213
3214 DEFVAR_LISP ("signal-hook-function", &Vsignal_hook_function,
3215 "If non-nil, this is a function for `signal' to call.\n\
3216 It receives the same arguments that `signal' was given.\n\
3217 The Edebug package uses this to regain control.");
3218 Vsignal_hook_function = Qnil;
3219
3220 Qmocklisp_arguments = intern ("mocklisp-arguments");
3221 staticpro (&Qmocklisp_arguments);
3222 DEFVAR_LISP ("mocklisp-arguments", &Vmocklisp_arguments,
3223 "While in a mocklisp function, the list of its unevaluated args.");
3224 Vmocklisp_arguments = Qt;
3225
3226 DEFVAR_LISP ("debug-on-signal", &Vdebug_on_signal,
3227 "*Non-nil means call the debugger regardless of condition handlers.\n\
3228 Note that `debug-on-error', `debug-on-quit' and friends\n\
3229 still determine whether to handle the particular condition.");
3230 Vdebug_on_signal = Qnil;
3231
3232 Vrun_hooks = intern ("run-hooks");
3233 staticpro (&Vrun_hooks);
3234
3235 staticpro (&Vautoload_queue);
3236 Vautoload_queue = Qnil;
3237 staticpro (&Vsignaling_function);
3238 Vsignaling_function = Qnil;
3239
3240 defsubr (&Sor);
3241 defsubr (&Sand);
3242 defsubr (&Sif);
3243 defsubr (&Scond);
3244 defsubr (&Sprogn);
3245 defsubr (&Sprog1);
3246 defsubr (&Sprog2);
3247 defsubr (&Ssetq);
3248 defsubr (&Squote);
3249 defsubr (&Sfunction);
3250 defsubr (&Sdefun);
3251 defsubr (&Sdefmacro);
3252 defsubr (&Sdefvar);
3253 defsubr (&Sdefconst);
3254 defsubr (&Suser_variable_p);
3255 defsubr (&Slet);
3256 defsubr (&SletX);
3257 defsubr (&Swhile);
3258 defsubr (&Smacroexpand);
3259 defsubr (&Scatch);
3260 defsubr (&Sthrow);
3261 defsubr (&Sunwind_protect);
3262 defsubr (&Scondition_case);
3263 defsubr (&Ssignal);
3264 defsubr (&Sinteractive_p);
3265 defsubr (&Scommandp);
3266 defsubr (&Sautoload);
3267 defsubr (&Seval);
3268 defsubr (&Sapply);
3269 defsubr (&Sfuncall);
3270 defsubr (&Srun_hooks);
3271 defsubr (&Srun_hook_with_args);
3272 defsubr (&Srun_hook_with_args_until_success);
3273 defsubr (&Srun_hook_with_args_until_failure);
3274 defsubr (&Sfetch_bytecode);
3275 defsubr (&Sbacktrace_debug);
3276 defsubr (&Sbacktrace);
3277 defsubr (&Sbacktrace_frame);
3278 }