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