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