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