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