* src/eval.c (Fbind_symbol): New function.
[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
19411656
BT
2268DEFUN ("bind-symbol", Fbind_symbol, Sbind_symbol, 3, 3, 0,
2269 doc: /* Bind symbol. */)
2270 (Lisp_Object symbol, Lisp_Object value, Lisp_Object thunk)
2271{
2272 Lisp_Object val;
2273 dynwind_begin ();
2274 specbind (symbol, value);
2275 val = call0 (thunk);
2276 dynwind_end ();
2277 return val;
2278}
2279\f
8edd4a2b 2280DEFUN ("apply", Fapply, Sapply, 1, MANY, 0,
9dbc9081
PJ
2281 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2282Then return the value FUNCTION returns.
2283Thus, (apply '+ 1 2 '(3 4)) returns 10.
2284usage: (apply FUNCTION &rest ARGUMENTS) */)
f66c7cf8 2285 (ptrdiff_t nargs, Lisp_Object *args)
db9f0278 2286{
d311d28c
PE
2287 ptrdiff_t i;
2288 EMACS_INT numargs;
db9f0278
JB
2289 register Lisp_Object spread_arg;
2290 register Lisp_Object *funcall_args;
3a7a9129 2291 Lisp_Object fun, retval;
96d44c64 2292 struct gcpro gcpro1;
3a7a9129 2293 USE_SAFE_ALLOCA;
db9f0278
JB
2294
2295 fun = args [0];
2296 funcall_args = 0;
2297 spread_arg = args [nargs - 1];
b7826503 2298 CHECK_LIST (spread_arg);
177c0ea7 2299
db9f0278
JB
2300 numargs = XINT (Flength (spread_arg));
2301
2302 if (numargs == 0)
2303 return Ffuncall (nargs - 1, args);
2304 else if (numargs == 1)
2305 {
03699b14 2306 args [nargs - 1] = XCAR (spread_arg);
db9f0278
JB
2307 return Ffuncall (nargs, args);
2308 }
2309
a6e3fa71 2310 numargs += nargs - 2;
db9f0278 2311
8788120f 2312 /* Optimize for no indirection. */
eadf1faa 2313 if (SYMBOLP (fun) && !NILP (fun)
1d59fbe3 2314 && (fun = SYMBOL_FUNCTION (fun), SYMBOLP (fun)))
8788120f 2315 fun = indirect_function (fun);
eadf1faa 2316 if (NILP (fun))
db9f0278 2317 {
f6d62986 2318 /* Let funcall get the error. */
ffd56f97 2319 fun = args[0];
db9f0278
JB
2320 }
2321
db9f0278
JB
2322 /* We add 1 to numargs because funcall_args includes the
2323 function itself as well as its arguments. */
2324 if (!funcall_args)
a6e3fa71 2325 {
b72e0717 2326 SAFE_ALLOCA_LISP (funcall_args, 1 + numargs);
96d44c64
SM
2327 GCPRO1 (*funcall_args);
2328 gcpro1.nvars = 1 + numargs;
a6e3fa71
JB
2329 }
2330
663e2b3f 2331 memcpy (funcall_args, args, nargs * word_size);
db9f0278
JB
2332 /* Spread the last arg we got. Its first element goes in
2333 the slot that it used to occupy, hence this value of I. */
2334 i = nargs - 1;
265a9e55 2335 while (!NILP (spread_arg))
db9f0278 2336 {
03699b14
KR
2337 funcall_args [i++] = XCAR (spread_arg);
2338 spread_arg = XCDR (spread_arg);
db9f0278 2339 }
a6e3fa71 2340
96d44c64 2341 /* By convention, the caller needs to gcpro Ffuncall's args. */
3a7a9129
CY
2342 retval = Ffuncall (gcpro1.nvars, funcall_args);
2343 UNGCPRO;
2344 SAFE_FREE ();
2345
2346 return retval;
db9f0278
JB
2347}
2348\f
ff936e53
SM
2349/* Run hook variables in various ways. */
2350
f6d62986 2351static Lisp_Object
f66c7cf8 2352funcall_nil (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2353{
2354 Ffuncall (nargs, args);
2355 return Qnil;
2356}
ff936e53 2357
a7ca3326 2358DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
9f685258 2359 doc: /* Run each hook in HOOKS.
9dbc9081
PJ
2360Each argument should be a symbol, a hook variable.
2361These symbols are processed in the order specified.
2362If a hook symbol has a non-nil value, that value may be a function
2363or a list of functions to be called to run the hook.
2364If the value is a function, it is called with no arguments.
2365If it is a list, the elements are called, in order, with no arguments.
2366
9f685258
LK
2367Major modes should not use this function directly to run their mode
2368hook; they should use `run-mode-hooks' instead.
2369
72e85d5d
RS
2370Do not use `make-local-variable' to make a hook variable buffer-local.
2371Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2372usage: (run-hooks &rest HOOKS) */)
f66c7cf8 2373 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53
SM
2374{
2375 Lisp_Object hook[1];
f66c7cf8 2376 ptrdiff_t i;
ff936e53
SM
2377
2378 for (i = 0; i < nargs; i++)
2379 {
2380 hook[0] = args[i];
f6d62986 2381 run_hook_with_args (1, hook, funcall_nil);
ff936e53
SM
2382 }
2383
2384 return Qnil;
2385}
177c0ea7 2386
a7ca3326 2387DEFUN ("run-hook-with-args", Frun_hook_with_args,
9dbc9081
PJ
2388 Srun_hook_with_args, 1, MANY, 0,
2389 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2390HOOK should be a symbol, a hook variable. The value of HOOK
2391may be nil, a function, or a list of functions. Call each
2392function in order with arguments ARGS. The final return value
2393is unspecified.
9dbc9081 2394
72e85d5d
RS
2395Do not use `make-local-variable' to make a hook variable buffer-local.
2396Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2397usage: (run-hook-with-args HOOK &rest ARGS) */)
f66c7cf8 2398 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53 2399{
f6d62986 2400 return run_hook_with_args (nargs, args, funcall_nil);
ff936e53
SM
2401}
2402
d393cefb
GM
2403/* NB this one still documents a specific non-nil return value.
2404 (As did run-hook-with-args and run-hook-with-args-until-failure
2405 until they were changed in 24.1.) */
a0d76c27 2406DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
9dbc9081
PJ
2407 Srun_hook_with_args_until_success, 1, MANY, 0,
2408 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2409HOOK should be a symbol, a hook variable. The value of HOOK
2410may be nil, a function, or a list of functions. Call each
2411function in order with arguments ARGS, stopping at the first
2412one that returns non-nil, and return that value. Otherwise (if
2413all functions return nil, or if there are no functions to call),
2414return nil.
9dbc9081 2415
72e85d5d
RS
2416Do not use `make-local-variable' to make a hook variable buffer-local.
2417Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2418usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
f66c7cf8 2419 (ptrdiff_t nargs, Lisp_Object *args)
b0b667cb 2420{
f6d62986
SM
2421 return run_hook_with_args (nargs, args, Ffuncall);
2422}
2423
2424static Lisp_Object
f66c7cf8 2425funcall_not (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2426{
2427 return NILP (Ffuncall (nargs, args)) ? Qt : Qnil;
ff936e53
SM
2428}
2429
a7ca3326 2430DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
9dbc9081
PJ
2431 Srun_hook_with_args_until_failure, 1, MANY, 0,
2432 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2433HOOK should be a symbol, a hook variable. The value of HOOK
2434may be nil, a function, or a list of functions. Call each
2435function in order with arguments ARGS, stopping at the first
2436one that returns nil, and return nil. Otherwise (if all functions
2437return non-nil, or if there are no functions to call), return non-nil
2438\(do not rely on the precise return value in this case).
9dbc9081 2439
72e85d5d
RS
2440Do not use `make-local-variable' to make a hook variable buffer-local.
2441Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2442usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
f66c7cf8 2443 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53 2444{
f6d62986 2445 return NILP (run_hook_with_args (nargs, args, funcall_not)) ? Qt : Qnil;
ff936e53
SM
2446}
2447
f6d62986 2448static Lisp_Object
f66c7cf8 2449run_hook_wrapped_funcall (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2450{
2451 Lisp_Object tmp = args[0], ret;
2452 args[0] = args[1];
2453 args[1] = tmp;
2454 ret = Ffuncall (nargs, args);
2455 args[1] = args[0];
2456 args[0] = tmp;
2457 return ret;
2458}
2459
2460DEFUN ("run-hook-wrapped", Frun_hook_wrapped, Srun_hook_wrapped, 2, MANY, 0,
2461 doc: /* Run HOOK, passing each function through WRAP-FUNCTION.
2462I.e. instead of calling each function FUN directly with arguments ARGS,
2463it calls WRAP-FUNCTION with arguments FUN and ARGS.
2464As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2465aborts and returns that value.
2466usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
f66c7cf8 2467 (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2468{
2469 return run_hook_with_args (nargs, args, run_hook_wrapped_funcall);
2470}
ff936e53 2471
c933ea05
RS
2472/* ARGS[0] should be a hook symbol.
2473 Call each of the functions in the hook value, passing each of them
2474 as arguments all the rest of ARGS (all NARGS - 1 elements).
f6d62986 2475 FUNCALL specifies how to call each function on the hook.
c933ea05
RS
2476 The caller (or its caller, etc) must gcpro all of ARGS,
2477 except that it isn't necessary to gcpro ARGS[0]. */
2478
f6d62986 2479Lisp_Object
f66c7cf8
PE
2480run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
2481 Lisp_Object (*funcall) (ptrdiff_t nargs, Lisp_Object *args))
ff936e53 2482{
f6d62986 2483 Lisp_Object sym, val, ret = Qnil;
fada05d6 2484 struct gcpro gcpro1, gcpro2, gcpro3;
b0b667cb 2485
f029ca5f
RS
2486 /* If we are dying or still initializing,
2487 don't do anything--it would probably crash if we tried. */
2488 if (NILP (Vrun_hooks))
caff32a7 2489 return Qnil;
f029ca5f 2490
b0b667cb 2491 sym = args[0];
aa681b51 2492 val = find_symbol_value (sym);
ff936e53 2493
b0b667cb 2494 if (EQ (val, Qunbound) || NILP (val))
ff936e53 2495 return ret;
dee4ba59 2496 else if (!CONSP (val) || FUNCTIONP (val))
b0b667cb
KH
2497 {
2498 args[0] = val;
f6d62986 2499 return funcall (nargs, args);
b0b667cb
KH
2500 }
2501 else
2502 {
1faed8ae
PE
2503 Lisp_Object global_vals = Qnil;
2504 GCPRO3 (sym, val, global_vals);
cb9d21f8 2505
ff936e53 2506 for (;
f6d62986 2507 CONSP (val) && NILP (ret);
03699b14 2508 val = XCDR (val))
b0b667cb 2509 {
03699b14 2510 if (EQ (XCAR (val), Qt))
b0b667cb
KH
2511 {
2512 /* t indicates this hook has a local binding;
2513 it means to run the global binding too. */
1faed8ae
PE
2514 global_vals = Fdefault_value (sym);
2515 if (NILP (global_vals)) continue;
b0b667cb 2516
1faed8ae 2517 if (!CONSP (global_vals) || EQ (XCAR (global_vals), Qlambda))
b0b667cb 2518 {
1faed8ae 2519 args[0] = global_vals;
f6d62986 2520 ret = funcall (nargs, args);
8932b1c2
CY
2521 }
2522 else
2523 {
2524 for (;
f6d62986 2525 CONSP (global_vals) && NILP (ret);
1faed8ae 2526 global_vals = XCDR (global_vals))
8932b1c2 2527 {
1faed8ae 2528 args[0] = XCAR (global_vals);
8932b1c2
CY
2529 /* In a global value, t should not occur. If it does, we
2530 must ignore it to avoid an endless loop. */
2531 if (!EQ (args[0], Qt))
f6d62986 2532 ret = funcall (nargs, args);
8932b1c2 2533 }
b0b667cb
KH
2534 }
2535 }
2536 else
2537 {
03699b14 2538 args[0] = XCAR (val);
f6d62986 2539 ret = funcall (nargs, args);
b0b667cb
KH
2540 }
2541 }
cb9d21f8
RS
2542
2543 UNGCPRO;
ff936e53 2544 return ret;
b0b667cb
KH
2545 }
2546}
c933ea05 2547
7d48558f
RS
2548/* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2549
2550void
d3da34e0 2551run_hook_with_args_2 (Lisp_Object hook, Lisp_Object arg1, Lisp_Object arg2)
7d48558f
RS
2552{
2553 Lisp_Object temp[3];
2554 temp[0] = hook;
2555 temp[1] = arg1;
2556 temp[2] = arg2;
2557
2558 Frun_hook_with_args (3, temp);
2559}
ff936e53 2560\f
f6d62986 2561/* Apply fn to arg. */
db9f0278 2562Lisp_Object
d3da34e0 2563apply1 (Lisp_Object fn, Lisp_Object arg)
db9f0278 2564{
a6e3fa71
JB
2565 struct gcpro gcpro1;
2566
2567 GCPRO1 (fn);
265a9e55 2568 if (NILP (arg))
2bfa3d3e 2569 return Ffuncall (1, &fn);
a6e3fa71 2570 gcpro1.nvars = 2;
db9f0278
JB
2571 {
2572 Lisp_Object args[2];
2573 args[0] = fn;
2574 args[1] = arg;
a6e3fa71 2575 gcpro1.var = args;
2bfa3d3e 2576 return Fapply (2, args);
db9f0278 2577 }
db9f0278
JB
2578}
2579
f6d62986 2580/* Call function fn on no arguments. */
db9f0278 2581Lisp_Object
d3da34e0 2582call0 (Lisp_Object fn)
db9f0278 2583{
a6e3fa71
JB
2584 struct gcpro gcpro1;
2585
2586 GCPRO1 (fn);
2bfa3d3e 2587 return Ffuncall (1, &fn);
db9f0278
JB
2588}
2589
f6d62986 2590/* Call function fn with 1 argument arg1. */
db9f0278
JB
2591/* ARGSUSED */
2592Lisp_Object
d3da34e0 2593call1 (Lisp_Object fn, Lisp_Object arg1)
db9f0278 2594{
a6e3fa71 2595 struct gcpro gcpro1;
177c0ea7 2596 Lisp_Object args[2];
a6e3fa71 2597
db9f0278 2598 args[0] = fn;
15285f9f 2599 args[1] = arg1;
a6e3fa71
JB
2600 GCPRO1 (args[0]);
2601 gcpro1.nvars = 2;
2bfa3d3e 2602 return Ffuncall (2, args);
db9f0278
JB
2603}
2604
f6d62986 2605/* Call function fn with 2 arguments arg1, arg2. */
db9f0278
JB
2606/* ARGSUSED */
2607Lisp_Object
d3da34e0 2608call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
db9f0278 2609{
a6e3fa71 2610 struct gcpro gcpro1;
db9f0278
JB
2611 Lisp_Object args[3];
2612 args[0] = fn;
15285f9f
RS
2613 args[1] = arg1;
2614 args[2] = arg2;
a6e3fa71
JB
2615 GCPRO1 (args[0]);
2616 gcpro1.nvars = 3;
2bfa3d3e 2617 return Ffuncall (3, args);
db9f0278
JB
2618}
2619
f6d62986 2620/* Call function fn with 3 arguments arg1, arg2, arg3. */
db9f0278
JB
2621/* ARGSUSED */
2622Lisp_Object
d3da34e0 2623call3 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
db9f0278 2624{
a6e3fa71 2625 struct gcpro gcpro1;
db9f0278
JB
2626 Lisp_Object args[4];
2627 args[0] = fn;
15285f9f
RS
2628 args[1] = arg1;
2629 args[2] = arg2;
2630 args[3] = arg3;
a6e3fa71
JB
2631 GCPRO1 (args[0]);
2632 gcpro1.nvars = 4;
2bfa3d3e 2633 return Ffuncall (4, args);
db9f0278
JB
2634}
2635
f6d62986 2636/* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
a5a44b91
JB
2637/* ARGSUSED */
2638Lisp_Object
d3da34e0
JB
2639call4 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2640 Lisp_Object arg4)
a5a44b91
JB
2641{
2642 struct gcpro gcpro1;
a5a44b91
JB
2643 Lisp_Object args[5];
2644 args[0] = fn;
15285f9f
RS
2645 args[1] = arg1;
2646 args[2] = arg2;
2647 args[3] = arg3;
2648 args[4] = arg4;
a5a44b91
JB
2649 GCPRO1 (args[0]);
2650 gcpro1.nvars = 5;
2bfa3d3e 2651 return Ffuncall (5, args);
a5a44b91
JB
2652}
2653
f6d62986 2654/* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
15285f9f
RS
2655/* ARGSUSED */
2656Lisp_Object
d3da34e0
JB
2657call5 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2658 Lisp_Object arg4, Lisp_Object arg5)
15285f9f
RS
2659{
2660 struct gcpro gcpro1;
15285f9f
RS
2661 Lisp_Object args[6];
2662 args[0] = fn;
2663 args[1] = arg1;
2664 args[2] = arg2;
2665 args[3] = arg3;
2666 args[4] = arg4;
2667 args[5] = arg5;
2668 GCPRO1 (args[0]);
2669 gcpro1.nvars = 6;
2bfa3d3e 2670 return Ffuncall (6, args);
15285f9f
RS
2671}
2672
f6d62986 2673/* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
15285f9f
RS
2674/* ARGSUSED */
2675Lisp_Object
d3da34e0
JB
2676call6 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2677 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6)
15285f9f
RS
2678{
2679 struct gcpro gcpro1;
15285f9f
RS
2680 Lisp_Object args[7];
2681 args[0] = fn;
2682 args[1] = arg1;
2683 args[2] = arg2;
2684 args[3] = arg3;
2685 args[4] = arg4;
2686 args[5] = arg5;
2687 args[6] = arg6;
2688 GCPRO1 (args[0]);
2689 gcpro1.nvars = 7;
2bfa3d3e 2690 return Ffuncall (7, args);
15285f9f
RS
2691}
2692
f6d62986 2693/* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
574c05e2
KK
2694/* ARGSUSED */
2695Lisp_Object
d3da34e0
JB
2696call7 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2697 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6, Lisp_Object arg7)
574c05e2
KK
2698{
2699 struct gcpro gcpro1;
574c05e2
KK
2700 Lisp_Object args[8];
2701 args[0] = fn;
2702 args[1] = arg1;
2703 args[2] = arg2;
2704 args[3] = arg3;
2705 args[4] = arg4;
2706 args[5] = arg5;
2707 args[6] = arg6;
2708 args[7] = arg7;
2709 GCPRO1 (args[0]);
2710 gcpro1.nvars = 8;
2bfa3d3e 2711 return Ffuncall (8, args);
574c05e2
KK
2712}
2713
6c2ef893
RS
2714/* The caller should GCPRO all the elements of ARGS. */
2715
a7ca3326 2716DEFUN ("functionp", Ffunctionp, Sfunctionp, 1, 1, 0,
7200d79c 2717 doc: /* Non-nil if OBJECT is a function. */)
c566235d 2718 (Lisp_Object object)
b9598260 2719{
e1f29348 2720 if (FUNCTIONP (object))
b9598260 2721 return Qt;
e1f29348 2722 return Qnil;
b9598260
SM
2723}
2724
c0ff0ac2 2725DEFUN ("funcall", Ffuncall1, Sfuncall, 1, MANY, 0,
9dbc9081
PJ
2726 doc: /* Call first argument as a function, passing remaining arguments to it.
2727Return the value that function returns.
2728Thus, (funcall 'cons 'x 'y) returns (x . y).
2729usage: (funcall FUNCTION &rest ARGUMENTS) */)
f66c7cf8 2730 (ptrdiff_t nargs, Lisp_Object *args)
db9f0278 2731{
8788120f 2732 Lisp_Object fun, original_fun;
db9f0278 2733 Lisp_Object funcar;
f66c7cf8 2734 ptrdiff_t numargs = nargs - 1;
db9f0278
JB
2735 Lisp_Object lisp_numargs;
2736 Lisp_Object val;
db9f0278 2737 register Lisp_Object *internal_args;
f66c7cf8 2738 ptrdiff_t i;
db9f0278
JB
2739
2740 QUIT;
db9f0278 2741
6376ba30
BT
2742 scm_dynwind_begin (0);
2743 scm_dynwind_unwind_handler (set_lisp_eval_depth,
2744 (void *) lisp_eval_depth,
2745 SCM_F_WIND_EXPLICITLY);
2746
db9f0278
JB
2747 if (++lisp_eval_depth > max_lisp_eval_depth)
2748 {
2749 if (max_lisp_eval_depth < 100)
2750 max_lisp_eval_depth = 100;
2751 if (lisp_eval_depth > max_lisp_eval_depth)
921baa95 2752 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
db9f0278
JB
2753 }
2754
2f592f95
SM
2755 /* This also GCPROs them. */
2756 record_in_backtrace (args[0], &args[1], nargs - 1);
db9f0278 2757
7abaf5cc
SM
2758 /* Call GC after setting up the backtrace, so the latter GCPROs the args. */
2759 maybe_gc ();
2760
db9f0278
JB
2761 if (debug_on_next_call)
2762 do_debug_on_call (Qlambda);
2763
8788120f
KS
2764 original_fun = args[0];
2765
db9f0278
JB
2766 retry:
2767
8788120f
KS
2768 /* Optimize for no indirection. */
2769 fun = original_fun;
eadf1faa 2770 if (SYMBOLP (fun) && !NILP (fun)
1d59fbe3 2771 && (fun = SYMBOL_FUNCTION (fun), SYMBOLP (fun)))
8788120f 2772 fun = indirect_function (fun);
db9f0278 2773
0a436d7d
BT
2774 if (scm_is_true (scm_procedure_p (fun)))
2775 {
2776 val = scm_call_n (fun, args + 1, numargs);
2777 }
ef1b0ba7 2778 else if (COMPILEDP (fun))
db9f0278
JB
2779 val = funcall_lambda (fun, numargs, args + 1);
2780 else
2781 {
eadf1faa 2782 if (NILP (fun))
734d55a2 2783 xsignal1 (Qvoid_function, original_fun);
db9f0278 2784 if (!CONSP (fun))
734d55a2
KS
2785 xsignal1 (Qinvalid_function, original_fun);
2786 funcar = XCAR (fun);
90165123 2787 if (!SYMBOLP (funcar))
734d55a2 2788 xsignal1 (Qinvalid_function, original_fun);
defb1411
SM
2789 if (EQ (funcar, Qlambda)
2790 || EQ (funcar, Qclosure))
db9f0278 2791 val = funcall_lambda (fun, numargs, args + 1);
db9f0278
JB
2792 else if (EQ (funcar, Qautoload))
2793 {
7abaf5cc 2794 Fautoload_do_load (fun, original_fun, Qnil);
db9f0278
JB
2795 goto retry;
2796 }
2797 else
734d55a2 2798 xsignal1 (Qinvalid_function, original_fun);
db9f0278 2799 }
2f592f95 2800 if (backtrace_debug_on_exit (specpdl_ptr - 1))
6c6f1994 2801 val = call_debugger (list2 (Qexit, val));
6376ba30 2802 scm_dynwind_end ();
db9f0278
JB
2803 return val;
2804}
c0ff0ac2
BT
2805
2806Lisp_Object
2807Ffuncall (ptrdiff_t nargs, Lisp_Object *args)
2808{
2809 return scm_c_value_ref (Ffuncall1 (nargs, args), 0);
2810}
db9f0278 2811\f
2f7c71a1 2812static Lisp_Object
defb1411 2813apply_lambda (Lisp_Object fun, Lisp_Object args)
db9f0278
JB
2814{
2815 Lisp_Object args_left;
d311d28c
PE
2816 ptrdiff_t i;
2817 EMACS_INT numargs;
db9f0278
JB
2818 register Lisp_Object *arg_vector;
2819 struct gcpro gcpro1, gcpro2, gcpro3;
db9f0278 2820 register Lisp_Object tem;
3a7a9129 2821 USE_SAFE_ALLOCA;
db9f0278 2822
f66c7cf8 2823 numargs = XFASTINT (Flength (args));
c5101a77 2824 SAFE_ALLOCA_LISP (arg_vector, numargs);
db9f0278
JB
2825 args_left = args;
2826
2827 GCPRO3 (*arg_vector, args_left, fun);
2828 gcpro1.nvars = 0;
2829
c5101a77 2830 for (i = 0; i < numargs; )
db9f0278
JB
2831 {
2832 tem = Fcar (args_left), args_left = Fcdr (args_left);
defb1411 2833 tem = eval_sub (tem);
db9f0278
JB
2834 arg_vector[i++] = tem;
2835 gcpro1.nvars = i;
2836 }
2837
2838 UNGCPRO;
2839
2f592f95
SM
2840 set_backtrace_args (specpdl_ptr - 1, arg_vector);
2841 set_backtrace_nargs (specpdl_ptr - 1, i);
c5101a77 2842 tem = funcall_lambda (fun, numargs, arg_vector);
db9f0278
JB
2843
2844 /* Do the debug-on-exit now, while arg_vector still exists. */
2f592f95
SM
2845 if (backtrace_debug_on_exit (specpdl_ptr - 1))
2846 {
2847 /* Don't do it again when we return to eval. */
2848 set_backtrace_debug_on_exit (specpdl_ptr - 1, false);
6c6f1994 2849 tem = call_debugger (list2 (Qexit, tem));
2f592f95 2850 }
3a7a9129 2851 SAFE_FREE ();
db9f0278
JB
2852 return tem;
2853}
2854
2855/* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
2856 and return the result of evaluation.
2857 FUN must be either a lambda-expression or a compiled-code object. */
2858
2901f1d1 2859static Lisp_Object
f66c7cf8 2860funcall_lambda (Lisp_Object fun, ptrdiff_t nargs,
c5101a77 2861 register Lisp_Object *arg_vector)
db9f0278 2862{
defb1411 2863 Lisp_Object val, syms_left, next, lexenv;
2bfa3d3e 2864 dynwind_begin ();
f66c7cf8 2865 ptrdiff_t i;
1882aa38 2866 bool optional, rest;
db9f0278 2867
90165123 2868 if (CONSP (fun))
9ab90667 2869 {
defb1411
SM
2870 if (EQ (XCAR (fun), Qclosure))
2871 {
2872 fun = XCDR (fun); /* Drop `closure'. */
2873 lexenv = XCAR (fun);
23aba0ea 2874 CHECK_LIST_CONS (fun, fun);
defb1411
SM
2875 }
2876 else
2877 lexenv = Qnil;
9ab90667
GM
2878 syms_left = XCDR (fun);
2879 if (CONSP (syms_left))
2880 syms_left = XCAR (syms_left);
2881 else
734d55a2 2882 xsignal1 (Qinvalid_function, fun);
9ab90667 2883 }
90165123 2884 else if (COMPILEDP (fun))
defb1411 2885 {
798cb644
SM
2886 syms_left = AREF (fun, COMPILED_ARGLIST);
2887 if (INTEGERP (syms_left))
876c194c
SM
2888 /* A byte-code object with a non-nil `push args' slot means we
2889 shouldn't bind any arguments, instead just call the byte-code
2890 interpreter directly; it will push arguments as necessary.
2891
9173deec 2892 Byte-code objects with either a non-existent, or a nil value for
876c194c
SM
2893 the `push args' slot (the default), have dynamically-bound
2894 arguments, and use the argument-binding code below instead (as do
2895 all interpreted functions, even lexically bound ones). */
2896 {
2897 /* If we have not actually read the bytecode string
2898 and constants vector yet, fetch them from the file. */
2899 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
2900 Ffetch_bytecode (fun);
2bfa3d3e 2901 dynwind_end ();
876c194c
SM
2902 return exec_byte_code (AREF (fun, COMPILED_BYTECODE),
2903 AREF (fun, COMPILED_CONSTANTS),
2904 AREF (fun, COMPILED_STACK_DEPTH),
798cb644 2905 syms_left,
876c194c
SM
2906 nargs, arg_vector);
2907 }
defb1411
SM
2908 lexenv = Qnil;
2909 }
9ab90667 2910 else
1088b922 2911 emacs_abort ();
db9f0278 2912
9ab90667
GM
2913 i = optional = rest = 0;
2914 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
db9f0278
JB
2915 {
2916 QUIT;
177c0ea7 2917
9ab90667 2918 next = XCAR (syms_left);
8788120f 2919 if (!SYMBOLP (next))
734d55a2 2920 xsignal1 (Qinvalid_function, fun);
177c0ea7 2921
db9f0278
JB
2922 if (EQ (next, Qand_rest))
2923 rest = 1;
2924 else if (EQ (next, Qand_optional))
2925 optional = 1;
db9f0278 2926 else
db9f0278 2927 {
e610eaca 2928 Lisp_Object arg;
defb1411
SM
2929 if (rest)
2930 {
e610eaca 2931 arg = Flist (nargs - i, &arg_vector[i]);
defb1411
SM
2932 i = nargs;
2933 }
2934 else if (i < nargs)
e610eaca 2935 arg = arg_vector[i++];
b9598260
SM
2936 else if (!optional)
2937 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
2938 else
e610eaca 2939 arg = Qnil;
7200d79c 2940
b9598260 2941 /* Bind the argument. */
876c194c 2942 if (!NILP (lexenv) && SYMBOLP (next))
b9598260 2943 /* Lexically bind NEXT by adding it to the lexenv alist. */
e610eaca 2944 lexenv = Fcons (Fcons (next, arg), lexenv);
b9598260
SM
2945 else
2946 /* Dynamically bind NEXT. */
e610eaca 2947 specbind (next, arg);
db9f0278 2948 }
db9f0278
JB
2949 }
2950
9ab90667 2951 if (!NILP (syms_left))
734d55a2 2952 xsignal1 (Qinvalid_function, fun);
9ab90667 2953 else if (i < nargs)
734d55a2 2954 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
db9f0278 2955
b9598260
SM
2956 if (!EQ (lexenv, Vinternal_interpreter_environment))
2957 /* Instantiate a new lexical environment. */
2958 specbind (Qinternal_interpreter_environment, lexenv);
2959
90165123 2960 if (CONSP (fun))
9ab90667 2961 val = Fprogn (XCDR (XCDR (fun)));
db9f0278 2962 else
ca248607
RS
2963 {
2964 /* If we have not actually read the bytecode string
2965 and constants vector yet, fetch them from the file. */
845975f5 2966 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
661c7d6e 2967 Ffetch_bytecode (fun);
b9598260
SM
2968 val = exec_byte_code (AREF (fun, COMPILED_BYTECODE),
2969 AREF (fun, COMPILED_CONSTANTS),
2970 AREF (fun, COMPILED_STACK_DEPTH),
2971 Qnil, 0, 0);
ca248607 2972 }
177c0ea7 2973
2bfa3d3e
BT
2974 dynwind_end ();
2975 return val;
db9f0278 2976}
661c7d6e
KH
2977
2978DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
9dbc9081
PJ
2979 1, 1, 0,
2980 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
5842a27b 2981 (Lisp_Object object)
661c7d6e
KH
2982{
2983 Lisp_Object tem;
2984
845975f5 2985 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
661c7d6e 2986 {
845975f5 2987 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
5bbdb090 2988 if (!CONSP (tem))
845975f5
SM
2989 {
2990 tem = AREF (object, COMPILED_BYTECODE);
2991 if (CONSP (tem) && STRINGP (XCAR (tem)))
d5db4077 2992 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
845975f5
SM
2993 else
2994 error ("Invalid byte code");
2995 }
3ae565b3
SM
2996 ASET (object, COMPILED_BYTECODE, XCAR (tem));
2997 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
661c7d6e
KH
2998 }
2999 return object;
3000}
db9f0278 3001\f
2f592f95
SM
3002/* Return true if SYMBOL currently has a let-binding
3003 which was made in the buffer that is now current. */
3004
3005bool
3006let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
db9f0278 3007{
9349e5f7 3008 union specbinding *p;
2f592f95
SM
3009 Lisp_Object buf = Fcurrent_buffer ();
3010
3011 for (p = specpdl_ptr; p > specpdl; )
3012 if ((--p)->kind > SPECPDL_LET)
3013 {
3014 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (specpdl_symbol (p));
3015 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
3016 if (symbol == let_bound_symbol
3017 && EQ (specpdl_where (p), buf))
3018 return 1;
3019 }
3020
3021 return 0;
3022}
3023
3024bool
3025let_shadows_global_binding_p (Lisp_Object symbol)
3026{
9349e5f7 3027 union specbinding *p;
2f592f95
SM
3028
3029 for (p = specpdl_ptr; p > specpdl; )
3030 if ((--p)->kind >= SPECPDL_LET && EQ (specpdl_symbol (p), symbol))
3031 return 1;
3032
3033 return 0;
db9f0278
JB
3034}
3035
3ec7babc 3036/* `specpdl_ptr' describes which variable is
4e2db1fe 3037 let-bound, so it can be properly undone when we unbind_to.
3ec7babc
SM
3038 It can be either a plain SPECPDL_LET or a SPECPDL_LET_LOCAL/DEFAULT.
3039 - SYMBOL is the variable being bound. Note that it should not be
4e2db1fe
SM
3040 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3041 to record V2 here).
3ec7babc
SM
3042 - WHERE tells us in which buffer the binding took place.
3043 This is used for SPECPDL_LET_LOCAL bindings (i.e. bindings to a
3044 buffer-local variable) as well as for SPECPDL_LET_DEFAULT bindings,
3045 i.e. bindings to the default value of a variable which can be
3046 buffer-local. */
4e2db1fe 3047
db9f0278 3048void
d3da34e0 3049specbind (Lisp_Object symbol, Lisp_Object value)
db9f0278 3050{
ce5b453a
SM
3051 struct Lisp_Symbol *sym;
3052
b7826503 3053 CHECK_SYMBOL (symbol);
ce5b453a 3054 sym = XSYMBOL (symbol);
719177b3 3055
ce5b453a
SM
3056 start:
3057 switch (sym->redirect)
719177b3 3058 {
ce5b453a
SM
3059 case SYMBOL_VARALIAS:
3060 sym = indirect_variable (sym); XSETSYMBOL (symbol, sym); goto start;
3061 case SYMBOL_PLAINVAL:
bb8e180f
AS
3062 /* The most common case is that of a non-constant symbol with a
3063 trivial value. Make that as fast as we can. */
9349e5f7
PE
3064 specpdl_ptr->let.kind = SPECPDL_LET;
3065 specpdl_ptr->let.symbol = symbol;
3066 specpdl_ptr->let.old_value = SYMBOL_VAL (sym);
5e301d76 3067 grow_specpdl ();
bb8e180f
AS
3068 if (!sym->constant)
3069 SET_SYMBOL_VAL (sym, value);
3070 else
3071 set_internal (symbol, value, Qnil, 1);
3072 break;
4e2db1fe
SM
3073 case SYMBOL_LOCALIZED:
3074 if (SYMBOL_BLV (sym)->frame_local)
3075 error ("Frame-local vars cannot be let-bound");
3076 case SYMBOL_FORWARDED:
ce5b453a
SM
3077 {
3078 Lisp_Object ovalue = find_symbol_value (symbol);
9349e5f7
PE
3079 specpdl_ptr->let.kind = SPECPDL_LET_LOCAL;
3080 specpdl_ptr->let.symbol = symbol;
3081 specpdl_ptr->let.old_value = ovalue;
3082 specpdl_ptr->let.where = Fcurrent_buffer ();
ce5b453a
SM
3083
3084 eassert (sym->redirect != SYMBOL_LOCALIZED
2f592f95 3085 || (EQ (SYMBOL_BLV (sym)->where, Fcurrent_buffer ())));
ce5b453a 3086
2f592f95
SM
3087 if (sym->redirect == SYMBOL_LOCALIZED)
3088 {
3089 if (!blv_found (SYMBOL_BLV (sym)))
9349e5f7 3090 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
2f592f95
SM
3091 }
3092 else if (BUFFER_OBJFWDP (SYMBOL_FWD (sym)))
ce5b453a 3093 {
ce5b453a
SM
3094 /* If SYMBOL is a per-buffer variable which doesn't have a
3095 buffer-local value here, make the `let' change the global
3096 value by changing the value of SYMBOL in all buffers not
3097 having their own value. This is consistent with what
3098 happens with other buffer-local variables. */
2f592f95 3099 if (NILP (Flocal_variable_p (symbol, Qnil)))
ce5b453a 3100 {
9349e5f7 3101 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
5e301d76 3102 grow_specpdl ();
ce5b453a 3103 Fset_default (symbol, value);
6376ba30 3104 goto done;
ce5b453a
SM
3105 }
3106 }
3107 else
9349e5f7 3108 specpdl_ptr->let.kind = SPECPDL_LET;
ce5b453a 3109
5e301d76 3110 grow_specpdl ();
94b612ad 3111 set_internal (symbol, value, Qnil, 1);
ce5b453a
SM
3112 break;
3113 }
1088b922 3114 default: emacs_abort ();
9ab90667 3115 }
6376ba30
BT
3116
3117 done:
3118 scm_dynwind_unwind_handler (unbind_once, NULL, SCM_F_WIND_EXPLICITLY);
db9f0278
JB
3119}
3120
f4b1eb36
PE
3121/* Push unwind-protect entries of various types. */
3122
db9f0278 3123void
5d1922cd
BT
3124record_unwind_protect_1 (void (*function) (Lisp_Object), Lisp_Object arg,
3125 bool wind_explicitly)
db9f0278 3126{
6376ba30 3127 record_unwind_protect_ptr_1 (function, arg, wind_explicitly);
db9f0278
JB
3128}
3129
27e498e6 3130void
5d1922cd 3131record_unwind_protect (void (*function) (Lisp_Object), Lisp_Object arg)
27e498e6 3132{
5d1922cd 3133 record_unwind_protect_1 (function, arg, true);
27e498e6
PE
3134}
3135
3136void
5d1922cd
BT
3137record_unwind_protect_ptr_1 (void (*function) (void *), void *arg,
3138 bool wind_explicitly)
27e498e6 3139{
6376ba30
BT
3140 scm_dynwind_unwind_handler (function,
3141 arg,
3142 (wind_explicitly
3143 ? SCM_F_WIND_EXPLICITLY
3144 : 0));
27e498e6
PE
3145}
3146
3147void
5d1922cd 3148record_unwind_protect_ptr (void (*function) (void *), void *arg)
27e498e6 3149{
5d1922cd 3150 record_unwind_protect_ptr_1 (function, arg, true);
27e498e6
PE
3151}
3152
f4b1eb36 3153void
5d1922cd
BT
3154record_unwind_protect_int_1 (void (*function) (int), int arg,
3155 bool wind_explicitly)
f4b1eb36 3156{
6376ba30 3157 record_unwind_protect_ptr_1 (function, arg, wind_explicitly);
f4b1eb36
PE
3158}
3159
a0931322 3160void
5d1922cd 3161record_unwind_protect_int (void (*function) (int), int arg)
a0931322 3162{
5d1922cd 3163 record_unwind_protect_int_1 (function, arg, true);
a0931322
PE
3164}
3165
6376ba30
BT
3166static void
3167call_void (void *data)
3168{
3169 ((void (*) (void)) data) ();
3170}
3171
94fcd171 3172void
5d1922cd
BT
3173record_unwind_protect_void_1 (void (*function) (void),
3174 bool wind_explicitly)
94fcd171 3175{
6376ba30 3176 record_unwind_protect_ptr_1 (call_void, function, wind_explicitly);
94fcd171
PE
3177}
3178
a0931322 3179void
5d1922cd 3180record_unwind_protect_void (void (*function) (void))
a0931322 3181{
5d1922cd 3182 record_unwind_protect_void_1 (function, true);
a0931322
PE
3183}
3184
6376ba30
BT
3185static void
3186unbind_once (void *ignore)
a26b12fa
BT
3187{
3188 /* Decrement specpdl_ptr before we do the work to unbind it, so
3189 that an error in unbinding won't try to unbind the same entry
3190 again. Take care to copy any parts of the binding needed
3191 before invoking any code that can make more bindings. */
3192
3193 specpdl_ptr--;
3194
3195 switch (specpdl_ptr->kind)
3196 {
a26b12fa
BT
3197 case SPECPDL_BACKTRACE:
3198 break;
3199 case SPECPDL_LET:
3200 { /* If variable has a trivial value (no forwarding), we can
3201 just set it. No need to check for constant symbols here,
3202 since that was already done by specbind. */
3203 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (specpdl_ptr));
3204 if (sym->redirect == SYMBOL_PLAINVAL)
3205 {
3206 SET_SYMBOL_VAL (sym, specpdl_old_value (specpdl_ptr));
3207 break;
3208 }
3209 else
3210 { /* FALLTHROUGH!!
3211 NOTE: we only ever come here if make_local_foo was used for
3212 the first time on this var within this let. */
3213 }
3214 }
3215 case SPECPDL_LET_DEFAULT:
3216 Fset_default (specpdl_symbol (specpdl_ptr),
3217 specpdl_old_value (specpdl_ptr));
3218 break;
3219 case SPECPDL_LET_LOCAL:
3220 {
3221 Lisp_Object symbol = specpdl_symbol (specpdl_ptr);
3222 Lisp_Object where = specpdl_where (specpdl_ptr);
3223 Lisp_Object old_value = specpdl_old_value (specpdl_ptr);
3224 eassert (BUFFERP (where));
3225
3226 /* If this was a local binding, reset the value in the appropriate
3227 buffer, but only if that buffer's binding still exists. */
3228 if (!NILP (Flocal_variable_p (symbol, where)))
3229 set_internal (symbol, old_value, where, 1);
3230 }
3231 break;
3232 }
3233}
3234
5d1922cd
BT
3235void
3236dynwind_begin (void)
3237{
6376ba30 3238 scm_dynwind_begin (0);
5d1922cd 3239}
f4b1eb36 3240
5d1922cd
BT
3241void
3242dynwind_end (void)
3243{
6376ba30 3244 scm_dynwind_end ();
5d1922cd
BT
3245}
3246
4a330052 3247DEFUN ("special-variable-p", Fspecial_variable_p, Sspecial_variable_p, 1, 1, 0,
b9598260
SM
3248 doc: /* Return non-nil if SYMBOL's global binding has been declared special.
3249A special variable is one that will be bound dynamically, even in a
3250context where binding is lexical by default. */)
c566235d 3251 (Lisp_Object symbol)
b9598260
SM
3252{
3253 CHECK_SYMBOL (symbol);
3254 return XSYMBOL (symbol)->declared_special ? Qt : Qnil;
3255}
3256
db9f0278 3257\f
db9f0278 3258DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
9dbc9081
PJ
3259 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3260The debugger is entered when that frame exits, if the flag is non-nil. */)
5842a27b 3261 (Lisp_Object level, Lisp_Object flag)
db9f0278 3262{
9349e5f7 3263 union specbinding *pdl = backtrace_top ();
d311d28c 3264 register EMACS_INT i;
db9f0278 3265
b7826503 3266 CHECK_NUMBER (level);
db9f0278 3267
2f592f95
SM
3268 for (i = 0; backtrace_p (pdl) && i < XINT (level); i++)
3269 pdl = backtrace_next (pdl);
db9f0278 3270
2f592f95
SM
3271 if (backtrace_p (pdl))
3272 set_backtrace_debug_on_exit (pdl, !NILP (flag));
db9f0278
JB
3273
3274 return flag;
3275}
3276
3277DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
9dbc9081
PJ
3278 doc: /* Print a trace of Lisp function calls currently active.
3279Output stream used is value of `standard-output'. */)
5842a27b 3280 (void)
db9f0278 3281{
9349e5f7 3282 union specbinding *pdl = backtrace_top ();
db9f0278 3283 Lisp_Object tem;
d4b6d95d 3284 Lisp_Object old_print_level = Vprint_level;
db9f0278 3285
d4b6d95d
LMI
3286 if (NILP (Vprint_level))
3287 XSETFASTINT (Vprint_level, 8);
db9f0278 3288
2f592f95 3289 while (backtrace_p (pdl))
db9f0278 3290 {
2f592f95
SM
3291 write_string (backtrace_debug_on_exit (pdl) ? "* " : " ", 2);
3292 if (backtrace_nargs (pdl) == UNEVALLED)
db9f0278 3293 {
2f592f95
SM
3294 Fprin1 (Fcons (backtrace_function (pdl), *backtrace_args (pdl)),
3295 Qnil);
b6703b02 3296 write_string ("\n", -1);
db9f0278
JB
3297 }
3298 else
3299 {
2f592f95 3300 tem = backtrace_function (pdl);
f6d62986 3301 Fprin1 (tem, Qnil); /* This can QUIT. */
db9f0278 3302 write_string ("(", -1);
2f592f95
SM
3303 {
3304 ptrdiff_t i;
3305 for (i = 0; i < backtrace_nargs (pdl); i++)
3306 {
3307 if (i) write_string (" ", -1);
3308 Fprin1 (backtrace_args (pdl)[i], Qnil);
3309 }
3310 }
b6703b02 3311 write_string (")\n", -1);
db9f0278 3312 }
2f592f95 3313 pdl = backtrace_next (pdl);
db9f0278
JB
3314 }
3315
d4b6d95d 3316 Vprint_level = old_print_level;
db9f0278
JB
3317 return Qnil;
3318}
3319
d5a7a9d9 3320static union specbinding *
56ea7291
SM
3321get_backtrace_frame (Lisp_Object nframes, Lisp_Object base)
3322{
3323 union specbinding *pdl = backtrace_top ();
3324 register EMACS_INT i;
3325
3326 CHECK_NATNUM (nframes);
3327
3328 if (!NILP (base))
3329 { /* Skip up to `base'. */
3330 base = Findirect_function (base, Qt);
3331 while (backtrace_p (pdl)
3332 && !EQ (base, Findirect_function (backtrace_function (pdl), Qt)))
3333 pdl = backtrace_next (pdl);
3334 }
3335
3336 /* Find the frame requested. */
3337 for (i = XFASTINT (nframes); i > 0 && backtrace_p (pdl); i--)
3338 pdl = backtrace_next (pdl);
3339
3340 return pdl;
3341}
3342
3343DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 2, NULL,
9dbc9081
PJ
3344 doc: /* Return the function and arguments NFRAMES up from current execution point.
3345If that frame has not evaluated the arguments yet (or is a special form),
3346the value is (nil FUNCTION ARG-FORMS...).
3347If that frame has evaluated its arguments and called its function already,
3348the value is (t FUNCTION ARG-VALUES...).
3349A &rest arg is represented as the tail of the list ARG-VALUES.
3350FUNCTION is whatever was supplied as car of evaluated list,
3351or a lambda expression for macro calls.
56ea7291
SM
3352If NFRAMES is more than the number of frames, the value is nil.
3353If BASE is non-nil, it should be a function and NFRAMES counts from its
3354nearest activation frame. */)
3355 (Lisp_Object nframes, Lisp_Object base)
db9f0278 3356{
56ea7291 3357 union specbinding *pdl = get_backtrace_frame (nframes, base);
db9f0278 3358
2f592f95 3359 if (!backtrace_p (pdl))
db9f0278 3360 return Qnil;
2f592f95
SM
3361 if (backtrace_nargs (pdl) == UNEVALLED)
3362 return Fcons (Qnil,
3363 Fcons (backtrace_function (pdl), *backtrace_args (pdl)));
db9f0278
JB
3364 else
3365 {
2f592f95 3366 Lisp_Object tem = Flist (backtrace_nargs (pdl), backtrace_args (pdl));
db9f0278 3367
2f592f95 3368 return Fcons (Qt, Fcons (backtrace_function (pdl), tem));
db9f0278
JB
3369 }
3370}
a2ff3819 3371
56ea7291
SM
3372/* For backtrace-eval, we want to temporarily unwind the last few elements of
3373 the specpdl stack, and then rewind them. We store the pre-unwind values
3374 directly in the pre-existing specpdl elements (i.e. we swap the current
3375 value and the old value stored in the specpdl), kind of like the inplace
3376 pointer-reversal trick. As it turns out, the rewind does the same as the
94fea300 3377 unwind, except it starts from the other end of the specpdl stack, so we use
56ea7291 3378 the same function for both unwind and rewind. */
d5a7a9d9 3379static void
56ea7291
SM
3380backtrace_eval_unrewind (int distance)
3381{
3382 union specbinding *tmp = specpdl_ptr;
3383 int step = -1;
3384 if (distance < 0)
3385 { /* It's a rewind rather than unwind. */
3386 tmp += distance - 1;
3387 step = 1;
3388 distance = -distance;
3389 }
3390
3391 for (; distance > 0; distance--)
3392 {
3393 tmp += step;
3394 /* */
3395 switch (tmp->kind)
3396 {
56ea7291
SM
3397 case SPECPDL_BACKTRACE:
3398 break;
3399 case SPECPDL_LET:
a104f656
SM
3400 { /* If variable has a trivial value (no forwarding), we can
3401 just set it. No need to check for constant symbols here,
3402 since that was already done by specbind. */
3403 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (tmp));
3404 if (sym->redirect == SYMBOL_PLAINVAL)
3405 {
3406 Lisp_Object old_value = specpdl_old_value (tmp);
3407 set_specpdl_old_value (tmp, SYMBOL_VAL (sym));
3408 SET_SYMBOL_VAL (sym, old_value);
3409 break;
3410 }
3411 else
3412 { /* FALLTHROUGH!!
3413 NOTE: we only ever come here if make_local_foo was used for
3414 the first time on this var within this let. */
3415 }
3416 }
56ea7291
SM
3417 case SPECPDL_LET_DEFAULT:
3418 {
3419 Lisp_Object sym = specpdl_symbol (tmp);
3420 Lisp_Object old_value = specpdl_old_value (tmp);
3421 set_specpdl_old_value (tmp, Fdefault_value (sym));
3422 Fset_default (sym, old_value);
3423 }
3424 break;
3425 case SPECPDL_LET_LOCAL:
3426 {
3427 Lisp_Object symbol = specpdl_symbol (tmp);
3428 Lisp_Object where = specpdl_where (tmp);
3429 Lisp_Object old_value = specpdl_old_value (tmp);
3430 eassert (BUFFERP (where));
3431
3432 /* If this was a local binding, reset the value in the appropriate
3433 buffer, but only if that buffer's binding still exists. */
3434 if (!NILP (Flocal_variable_p (symbol, where)))
3435 {
3436 set_specpdl_old_value
3437 (tmp, Fbuffer_local_value (symbol, where));
3438 set_internal (symbol, old_value, where, 1);
3439 }
3440 }
3441 break;
3442 }
3443 }
3444}
3445
3446DEFUN ("backtrace-eval", Fbacktrace_eval, Sbacktrace_eval, 2, 3, NULL,
3447 doc: /* Evaluate EXP in the context of some activation frame.
3448NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3449 (Lisp_Object exp, Lisp_Object nframes, Lisp_Object base)
3450{
3451 union specbinding *pdl = get_backtrace_frame (nframes, base);
2bfa3d3e 3452 dynwind_begin ();
56ea7291
SM
3453 ptrdiff_t distance = specpdl_ptr - pdl;
3454 eassert (distance >= 0);
3455
3456 if (!backtrace_p (pdl))
3457 error ("Activation frame not found!");
3458
3459 backtrace_eval_unrewind (distance);
3460 record_unwind_protect_int (backtrace_eval_unrewind, -distance);
3461
3462 /* Use eval_sub rather than Feval since the main motivation behind
3463 backtrace-eval is to be able to get/set the value of lexical variables
3464 from the debugger. */
2bfa3d3e
BT
3465 Lisp_Object tem1 = eval_sub (exp);
3466 dynwind_end ();
3467 return tem1;
56ea7291 3468}
f345395c
HE
3469
3470DEFUN ("backtrace--locals", Fbacktrace__locals, Sbacktrace__locals, 1, 2, NULL,
3471 doc: /* Return names and values of local variables of a stack frame.
3472NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3473 (Lisp_Object nframes, Lisp_Object base)
3474{
3475 union specbinding *frame = get_backtrace_frame (nframes, base);
3476 union specbinding *prevframe
3477 = get_backtrace_frame (make_number (XFASTINT (nframes) - 1), base);
3478 ptrdiff_t distance = specpdl_ptr - frame;
3479 Lisp_Object result = Qnil;
3480 eassert (distance >= 0);
3481
3482 if (!backtrace_p (prevframe))
3483 error ("Activation frame not found!");
3484 if (!backtrace_p (frame))
3485 error ("Activation frame not found!");
3486
3487 /* The specpdl entries normally contain the symbol being bound along with its
3488 `old_value', so it can be restored. The new value to which it is bound is
3489 available in one of two places: either in the current value of the
09a7c0fe 3490 variable (if it hasn't been rebound yet) or in the `old_value' slot of the
f345395c
HE
3491 next specpdl entry for it.
3492 `backtrace_eval_unrewind' happens to swap the role of `old_value'
3493 and "new value", so we abuse it here, to fetch the new value.
3494 It's ugly (we'd rather not modify global data) and a bit inefficient,
3495 but it does the job for now. */
3496 backtrace_eval_unrewind (distance);
3497
3498 /* Grab values. */
3499 {
3500 union specbinding *tmp = prevframe;
3501 for (; tmp > frame; tmp--)
3502 {
3503 switch (tmp->kind)
3504 {
3505 case SPECPDL_LET:
3506 case SPECPDL_LET_DEFAULT:
3507 case SPECPDL_LET_LOCAL:
3508 {
3509 Lisp_Object sym = specpdl_symbol (tmp);
3510 Lisp_Object val = specpdl_old_value (tmp);
3511 if (EQ (sym, Qinternal_interpreter_environment))
3512 {
3513 Lisp_Object env = val;
3514 for (; CONSP (env); env = XCDR (env))
3515 {
3516 Lisp_Object binding = XCAR (env);
3517 if (CONSP (binding))
3518 result = Fcons (Fcons (XCAR (binding),
3519 XCDR (binding)),
3520 result);
3521 }
3522 }
3523 else
3524 result = Fcons (Fcons (sym, val), result);
3525 }
3526 }
3527 }
3528 }
3529
3530 /* Restore values from specpdl to original place. */
3531 backtrace_eval_unrewind (-distance);
3532
3533 return result;
3534}
3535
db9f0278 3536\f
2f592f95
SM
3537void
3538get_backtrace (Lisp_Object array)
3539{
9349e5f7 3540 union specbinding *pdl = backtrace_next (backtrace_top ());
2f592f95 3541 ptrdiff_t i = 0, asize = ASIZE (array);
4ce0541e 3542
2f592f95
SM
3543 /* Copy the backtrace contents into working memory. */
3544 for (; i < asize; i++)
3545 {
3546 if (backtrace_p (pdl))
3547 {
3548 ASET (array, i, backtrace_function (pdl));
3549 pdl = backtrace_next (pdl);
3550 }
4ce0541e 3551 else
2f592f95 3552 ASET (array, i, Qnil);
4ce0541e
SM
3553 }
3554}
2f592f95
SM
3555
3556Lisp_Object backtrace_top_function (void)
3557{
9349e5f7 3558 union specbinding *pdl = backtrace_top ();
2f592f95
SM
3559 return (backtrace_p (pdl) ? backtrace_function (pdl) : Qnil);
3560}
6376ba30
BT
3561\f
3562_Noreturn SCM
3563abort_to_prompt (SCM tag, SCM arglst)
3564{
3565 static SCM var = SCM_UNDEFINED;
3566 if (SCM_UNBNDP (var))
3567 var = scm_c_public_lookup ("guile", "abort-to-prompt");
4ce0541e 3568
6376ba30
BT
3569 scm_apply_1 (scm_variable_ref (var), tag, arglst);
3570 emacs_abort ();
3571}
3572
3573SCM
3574call_with_prompt (SCM tag, SCM thunk, SCM handler)
3575{
3576 static SCM var = SCM_UNDEFINED;
3577 if (SCM_UNBNDP (var))
3578 var = scm_c_public_lookup ("guile", "call-with-prompt");
3579
3580 return scm_call_3 (scm_variable_ref (var), tag, thunk, handler);
3581}
3582
3583SCM
3584make_prompt_tag (void)
3585{
3586 static SCM var = SCM_UNDEFINED;
3587 if (SCM_UNBNDP (var))
3588 var = scm_c_public_lookup ("guile", "make-prompt-tag");
3589
3590 return scm_call_0 (scm_variable_ref (var));
3591}
3592\f
dfcf069d 3593void
d3da34e0 3594syms_of_eval (void)
db9f0278 3595{
fe6aa7a1
BT
3596#include "eval.x"
3597
29208e82 3598 DEFVAR_INT ("max-specpdl-size", max_specpdl_size,
fb7ada5f 3599 doc: /* Limit on number of Lisp variable bindings and `unwind-protect's.
9f5903bb 3600If Lisp code tries to increase the total number past this amount,
2520dc0c
RS
3601an error is signaled.
3602You can safely use a value considerably larger than the default value,
3603if that proves inconveniently small. However, if you increase it too far,
575593db
DA
3604Emacs could run out of memory trying to make the stack bigger.
3605Note that this limit may be silently increased by the debugger
3606if `debug-on-error' or `debug-on-quit' is set. */);
db9f0278 3607
29208e82 3608 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth,
fb7ada5f 3609 doc: /* Limit on depth in `eval', `apply' and `funcall' before error.
2520dc0c
RS
3610
3611This limit serves to catch infinite recursions for you before they cause
9dbc9081
PJ
3612actual stack overflow in C, which would be fatal for Emacs.
3613You can safely make it considerably larger than its default value,
2520dc0c
RS
3614if that proves inconveniently small. However, if you increase it too far,
3615Emacs could overflow the real C stack, and crash. */);
db9f0278 3616
29208e82 3617 DEFVAR_LISP ("quit-flag", Vquit_flag,
9dbc9081 3618 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
42ed718e
RS
3619If the value is t, that means do an ordinary quit.
3620If the value equals `throw-on-input', that means quit by throwing
3621to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3622Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3623but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
db9f0278
JB
3624 Vquit_flag = Qnil;
3625
29208e82 3626 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit,
9dbc9081
PJ
3627 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3628Note that `quit-flag' will still be set by typing C-g,
3629so a quit will be signaled as soon as `inhibit-quit' is nil.
3630To prevent this happening, set `quit-flag' to nil
3631before making `inhibit-quit' nil. */);
db9f0278
JB
3632 Vinhibit_quit = Qnil;
3633
cd3520a4
JB
3634 DEFSYM (Qinhibit_quit, "inhibit-quit");
3635 DEFSYM (Qautoload, "autoload");
45b82ad0 3636 DEFSYM (Qinhibit_debugger, "inhibit-debugger");
cd3520a4
JB
3637 DEFSYM (Qmacro, "macro");
3638 DEFSYM (Qdeclare, "declare");
177c0ea7 3639
db9f0278
JB
3640 /* Note that the process handling also uses Qexit, but we don't want
3641 to staticpro it twice, so we just do it here. */
cd3520a4 3642 DEFSYM (Qexit, "exit");
b9598260 3643
cd3520a4
JB
3644 DEFSYM (Qinteractive, "interactive");
3645 DEFSYM (Qcommandp, "commandp");
cd3520a4
JB
3646 DEFSYM (Qand_rest, "&rest");
3647 DEFSYM (Qand_optional, "&optional");
3648 DEFSYM (Qclosure, "closure");
3649 DEFSYM (Qdebug, "debug");
f01cbfdd 3650
45b82ad0
SM
3651 DEFVAR_LISP ("inhibit-debugger", Vinhibit_debugger,
3652 doc: /* Non-nil means never enter the debugger.
3653Normally set while the debugger is already active, to avoid recursive
3654invocations. */);
3655 Vinhibit_debugger = Qnil;
3656
29208e82 3657 DEFVAR_LISP ("debug-on-error", Vdebug_on_error,
fb7ada5f 3658 doc: /* Non-nil means enter debugger if an error is signaled.
9dbc9081
PJ
3659Does not apply to errors handled by `condition-case' or those
3660matched by `debug-ignored-errors'.
3661If the value is a list, an error only means to enter the debugger
3662if one of its condition symbols appears in the list.
3663When you evaluate an expression interactively, this variable
3664is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
fbbdcf2f 3665The command `toggle-debug-on-error' toggles this.
45b82ad0 3666See also the variable `debug-on-quit' and `inhibit-debugger'. */);
128c0f66 3667 Vdebug_on_error = Qnil;
db9f0278 3668
29208e82 3669 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors,
fb7ada5f 3670 doc: /* List of errors for which the debugger should not be called.
9dbc9081
PJ
3671Each element may be a condition-name or a regexp that matches error messages.
3672If any element applies to a given error, that error skips the debugger
3673and just returns to top level.
3674This overrides the variable `debug-on-error'.
3675It does not apply to errors handled by `condition-case'. */);
fc950e09
KH
3676 Vdebug_ignored_errors = Qnil;
3677
29208e82 3678 DEFVAR_BOOL ("debug-on-quit", debug_on_quit,
fb7ada5f 3679 doc: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
82fc29a1 3680Does not apply if quit is handled by a `condition-case'. */);
db9f0278
JB
3681 debug_on_quit = 0;
3682
29208e82 3683 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call,
9dbc9081 3684 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
db9f0278 3685
29208e82 3686 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue,
9dbc9081
PJ
3687 doc: /* Non-nil means debugger may continue execution.
3688This is nil when the debugger is called under circumstances where it
3689might not be safe to continue. */);
dac204bc 3690 debugger_may_continue = 1;
556d7314 3691
29208e82 3692 DEFVAR_LISP ("debugger", Vdebugger,
9dbc9081
PJ
3693 doc: /* Function to call to invoke debugger.
3694If due to frame exit, args are `exit' and the value being returned;
3695 this function's value will be returned instead of that.
3696If due to error, args are `error' and a list of the args to `signal'.
3697If due to `apply' or `funcall' entry, one arg, `lambda'.
3698If due to `eval' entry, one arg, t. */);
db9f0278
JB
3699 Vdebugger = Qnil;
3700
29208e82 3701 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function,
9dbc9081
PJ
3702 doc: /* If non-nil, this is a function for `signal' to call.
3703It receives the same arguments that `signal' was given.
3704The Edebug package uses this to regain control. */);
61ede770
RS
3705 Vsignal_hook_function = Qnil;
3706
29208e82 3707 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal,
fb7ada5f 3708 doc: /* Non-nil means call the debugger regardless of condition handlers.
9dbc9081
PJ
3709Note that `debug-on-error', `debug-on-quit' and friends
3710still determine whether to handle the particular condition. */);
57a6e758 3711 Vdebug_on_signal = Qnil;
61ede770 3712
b38b1ec0 3713 /* When lexical binding is being used,
61b108cc 3714 Vinternal_interpreter_environment is non-nil, and contains an alist
b38b1ec0
SM
3715 of lexically-bound variable, or (t), indicating an empty
3716 environment. The lisp name of this variable would be
3717 `internal-interpreter-environment' if it weren't hidden.
3718 Every element of this list can be either a cons (VAR . VAL)
3719 specifying a lexical binding, or a single symbol VAR indicating
3720 that this variable should use dynamic scoping. */
61b108cc
SM
3721 DEFSYM (Qinternal_interpreter_environment,
3722 "internal-interpreter-environment");
b38b1ec0
SM
3723 DEFVAR_LISP ("internal-interpreter-environment",
3724 Vinternal_interpreter_environment,
b9598260
SM
3725 doc: /* If non-nil, the current lexical environment of the lisp interpreter.
3726When lexical binding is not being used, this variable is nil.
3727A value of `(t)' indicates an empty environment, otherwise it is an
3728alist of active lexical bindings. */);
3729 Vinternal_interpreter_environment = Qnil;
c80e3b4a 3730 /* Don't export this variable to Elisp, so no one can mess with it
b38b1ec0
SM
3731 (Just imagine if someone makes it buffer-local). */
3732 Funintern (Qinternal_interpreter_environment, Qnil);
b9598260 3733
cd3520a4 3734 DEFSYM (Vrun_hooks, "run-hooks");
db9f0278
JB
3735
3736 staticpro (&Vautoload_queue);
3737 Vautoload_queue = Qnil;
a2ff3819
GM
3738 staticpro (&Vsignaling_function);
3739 Vsignaling_function = Qnil;
db9f0278 3740
d1f55f16 3741 inhibit_lisp_code = Qnil;
db9f0278 3742}