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