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