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