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