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