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