use #nil and #t
[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"
316bec86
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
316bec86
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
316bec86 265static struct handler *handlerlist_sentinel;
70de5e86 266
dfcf069d 267void
d3da34e0 268init_eval (void)
db9f0278
JB
269{
270 specpdl_ptr = specpdl;
316bec86
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;
3200038e 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). */
316bec86 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
3200038e
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;
3200038e 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));
3200038e
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;
3200038e 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 ();
3200038e
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 {
d8ccbf1a 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
316bec86
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{
316bec86
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
e1ad689c
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{
316bec86 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;
3200038e 1296 dynwind_begin ();
db9f0278 1297
16b0520a
PE
1298 record_unwind_protect (unwind_body, XCDR (args));
1299 val = eval_sub (XCAR (args));
3200038e
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
316bec86
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
316bec86 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;
316bec86 1410 struct handler *c = make_condition_handler (handlers);
adf2aa61 1411
316bec86
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;
316bec86 1425 struct handler *c = make_condition_handler (handlers);
adf2aa61 1426
316bec86
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;
316bec86
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;
316bec86 1471 struct handler *c = make_condition_handler (handlers);
adf2aa61 1472
316bec86
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;
d90fb7af 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 {
316bec86 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
db9f0278
JB
1875 /* Emacs primitives are interactive if their DEFUN specifies an
1876 interactive spec. */
90165123 1877 if (SUBRP (fun))
04724b69 1878 return XSUBR (fun)->intspec ? Qt : if_prop;
db9f0278
JB
1879
1880 /* Bytecode objects are interactive if they are long enough to
1881 have an element whose index is COMPILED_INTERACTIVE, which is
1882 where the interactive spec is stored. */
90165123 1883 else if (COMPILEDP (fun))
845975f5 1884 return ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_INTERACTIVE
52b71f49 1885 ? Qt : if_prop);
db9f0278
JB
1886
1887 /* Strings and vectors are keyboard macros. */
52b71f49 1888 if (STRINGP (fun) || VECTORP (fun))
6e33efc4 1889 return (NILP (for_call_interactively) ? Qt : Qnil);
db9f0278
JB
1890
1891 /* Lists may represent commands. */
1892 if (!CONSP (fun))
1893 return Qnil;
ed16fb98 1894 funcar = XCAR (fun);
b38b1ec0 1895 if (EQ (funcar, Qclosure))
7200d79c
SM
1896 return (!NILP (Fassq (Qinteractive, Fcdr (Fcdr (XCDR (fun)))))
1897 ? Qt : if_prop);
23aba0ea 1898 else if (EQ (funcar, Qlambda))
52b71f49 1899 return !NILP (Fassq (Qinteractive, Fcdr (XCDR (fun)))) ? Qt : if_prop;
b38b1ec0 1900 else if (EQ (funcar, Qautoload))
52b71f49 1901 return !NILP (Fcar (Fcdr (Fcdr (XCDR (fun))))) ? Qt : if_prop;
db9f0278
JB
1902 else
1903 return Qnil;
1904}
1905
db9f0278 1906DEFUN ("autoload", Fautoload, Sautoload, 2, 5, 0,
9dbc9081
PJ
1907 doc: /* Define FUNCTION to autoload from FILE.
1908FUNCTION is a symbol; FILE is a file name string to pass to `load'.
1909Third arg DOCSTRING is documentation for the function.
1910Fourth arg INTERACTIVE if non-nil says function can be called interactively.
1911Fifth arg TYPE indicates the type of the object:
1912 nil or omitted says FUNCTION is a function,
1913 `keymap' says FUNCTION is really a keymap, and
1914 `macro' or t says FUNCTION is really a macro.
1915Third through fifth args give info about the real definition.
1916They default to nil.
1917If FUNCTION is already defined other than as an autoload,
1918this does nothing and returns nil. */)
5842a27b 1919 (Lisp_Object function, Lisp_Object file, Lisp_Object docstring, Lisp_Object interactive, Lisp_Object type)
db9f0278 1920{
b7826503
PJ
1921 CHECK_SYMBOL (function);
1922 CHECK_STRING (file);
db9f0278 1923
f6d62986 1924 /* If function is defined and not as an autoload, don't override. */
d8ccbf1a
BT
1925 if (!NILP (SYMBOL_FUNCTION (function))
1926 && !AUTOLOADP (SYMBOL_FUNCTION (function)))
db9f0278
JB
1927 return Qnil;
1928
32e5c58c
SM
1929 return Fdefalias (function,
1930 list5 (Qautoload, file, docstring, interactive, type),
1931 Qnil);
db9f0278
JB
1932}
1933
27e498e6 1934void
d3da34e0 1935un_autoload (Lisp_Object oldqueue)
db9f0278 1936{
27e498e6 1937 Lisp_Object queue, first, second;
db9f0278
JB
1938
1939 /* Queue to unwind is current value of Vautoload_queue.
1940 oldqueue is the shadowed value to leave in Vautoload_queue. */
1941 queue = Vautoload_queue;
1942 Vautoload_queue = oldqueue;
1943 while (CONSP (queue))
1944 {
e509f168 1945 first = XCAR (queue);
db9f0278
JB
1946 second = Fcdr (first);
1947 first = Fcar (first);
47b82df9
RS
1948 if (EQ (first, make_number (0)))
1949 Vfeatures = second;
db9f0278
JB
1950 else
1951 Ffset (first, second);
e509f168 1952 queue = XCDR (queue);
db9f0278 1953 }
db9f0278
JB
1954}
1955
ca20916b
RS
1956/* Load an autoloaded function.
1957 FUNNAME is the symbol which is the function's name.
1958 FUNDEF is the autoload definition (a list). */
1959
7abaf5cc
SM
1960DEFUN ("autoload-do-load", Fautoload_do_load, Sautoload_do_load, 1, 3, 0,
1961 doc: /* Load FUNDEF which should be an autoload.
1962If non-nil, FUNNAME should be the symbol whose function value is FUNDEF,
1963in which case the function returns the new autoloaded function value.
1964If equal to `macro', MACRO-ONLY specifies that FUNDEF should only be loaded if
1965it is defines a macro. */)
1966 (Lisp_Object fundef, Lisp_Object funname, Lisp_Object macro_only)
db9f0278 1967{
3200038e 1968 dynwind_begin ();
ca20916b 1969 struct gcpro gcpro1, gcpro2, gcpro3;
db9f0278 1970
3200038e
BT
1971 if (!CONSP (fundef) || !EQ (Qautoload, XCAR (fundef))) {
1972 dynwind_end ();
7abaf5cc 1973 return fundef;
3200038e 1974 }
7abaf5cc
SM
1975
1976 if (EQ (macro_only, Qmacro))
1977 {
1978 Lisp_Object kind = Fnth (make_number (4), fundef);
3200038e
BT
1979 if (! (EQ (kind, Qt) || EQ (kind, Qmacro))) {
1980 dynwind_end ();
1981 return fundef;
1982 }
7abaf5cc
SM
1983 }
1984
aea6173f
RS
1985 /* This is to make sure that loadup.el gives a clear picture
1986 of what files are preloaded and when. */
ab4db096
RS
1987 if (! NILP (Vpurify_flag))
1988 error ("Attempt to autoload %s while preparing to dump",
d5db4077 1989 SDATA (SYMBOL_NAME (funname)));
ab4db096 1990
b7826503 1991 CHECK_SYMBOL (funname);
7abaf5cc 1992 GCPRO3 (funname, fundef, macro_only);
db9f0278 1993
f87740dc 1994 /* Preserve the match data. */
89f2614d 1995 record_unwind_save_match_data ();
177c0ea7 1996
a04ee161
RS
1997 /* If autoloading gets an error (which includes the error of failing
1998 to define the function being called), we use Vautoload_queue
1999 to undo function definitions and `provide' calls made by
2000 the function. We do this in the specific case of autoloading
2001 because autoloading is not an explicit request "load this file",
2002 but rather a request to "call this function".
d3da34e0 2003
a04ee161 2004 The value saved here is to be restored into Vautoload_queue. */
db9f0278
JB
2005 record_unwind_protect (un_autoload, Vautoload_queue);
2006 Vautoload_queue = Qt;
7abaf5cc
SM
2007 /* If `macro_only', assume this autoload to be a "best-effort",
2008 so don't signal an error if autoloading fails. */
2009 Fload (Fcar (Fcdr (fundef)), macro_only, Qt, Qnil, Qt);
2a49b6e5 2010
db9f0278
JB
2011 /* Once loading finishes, don't undo it. */
2012 Vautoload_queue = Qt;
3200038e 2013 dynwind_end ();
db9f0278 2014
ca20916b 2015 UNGCPRO;
7abaf5cc
SM
2016
2017 if (NILP (funname))
2018 return Qnil;
2019 else
2020 {
2021 Lisp_Object fun = Findirect_function (funname, Qnil);
2022
2023 if (!NILP (Fequal (fun, fundef)))
2024 error ("Autoloading failed to define function %s",
2025 SDATA (SYMBOL_NAME (funname)));
2026 else
2027 return fun;
2028 }
db9f0278 2029}
4c576a83 2030
db9f0278 2031\f
a7ca3326 2032DEFUN ("eval", Feval, Seval, 1, 2, 0,
a0ee6f27 2033 doc: /* Evaluate FORM and return its value.
8c27f5ff
SM
2034If LEXICAL is t, evaluate using lexical scoping.
2035LEXICAL can also be an actual lexical environment, in the form of an
2036alist mapping symbols to their value. */)
a0ee6f27 2037 (Lisp_Object form, Lisp_Object lexical)
defb1411 2038{
3200038e 2039 dynwind_begin ();
a0ee6f27 2040 specbind (Qinternal_interpreter_environment,
6c6f1994 2041 CONSP (lexical) || NILP (lexical) ? lexical : list1 (Qt));
3200038e
BT
2042 Lisp_Object tem0 = eval_sub (form);
2043 dynwind_end ();
2044 return tem0;
defb1411
SM
2045}
2046
5e301d76
PE
2047/* Grow the specpdl stack by one entry.
2048 The caller should have already initialized the entry.
2049 Signal an error on stack overflow.
2050
2051 Make sure that there is always one unused entry past the top of the
2052 stack, so that the just-initialized entry is safely unwound if
2053 memory exhausted and an error is signaled here. Also, allocate a
2054 never-used entry just before the bottom of the stack; sometimes its
2055 address is taken. */
2056
2f592f95
SM
2057static void
2058grow_specpdl (void)
2059{
5e301d76
PE
2060 specpdl_ptr++;
2061
2062 if (specpdl_ptr == specpdl + specpdl_size)
2f592f95 2063 {
5e301d76
PE
2064 ptrdiff_t count = SPECPDL_INDEX ();
2065 ptrdiff_t max_size = min (max_specpdl_size, PTRDIFF_MAX - 1000);
2066 union specbinding *pdlvec = specpdl - 1;
2067 ptrdiff_t pdlvecsize = specpdl_size + 1;
2f592f95 2068 if (max_size <= specpdl_size)
5e301d76
PE
2069 {
2070 if (max_specpdl_size < 400)
2071 max_size = max_specpdl_size = 400;
2072 if (max_size <= specpdl_size)
2073 signal_error ("Variable binding depth exceeds max-specpdl-size",
2074 Qnil);
2075 }
2076 pdlvec = xpalloc (pdlvec, &pdlvecsize, 1, max_size + 1, sizeof *specpdl);
2077 specpdl = pdlvec + 1;
2078 specpdl_size = pdlvecsize - 1;
2079 specpdl_ptr = specpdl + count;
2f592f95 2080 }
2f592f95
SM
2081}
2082
3d5ee10a 2083void
2f592f95
SM
2084record_in_backtrace (Lisp_Object function, Lisp_Object *args, ptrdiff_t nargs)
2085{
2086 eassert (nargs >= UNEVALLED);
9349e5f7
PE
2087 specpdl_ptr->bt.kind = SPECPDL_BACKTRACE;
2088 specpdl_ptr->bt.debug_on_exit = false;
2089 specpdl_ptr->bt.function = function;
2090 specpdl_ptr->bt.args = args;
2091 specpdl_ptr->bt.nargs = nargs;
5e301d76 2092 grow_specpdl ();
316bec86
BT
2093 scm_dynwind_unwind_handler (unbind_once, NULL, SCM_F_WIND_EXPLICITLY);
2094}
2095
2096static void
2097set_lisp_eval_depth (void *data)
2098{
2099 EMACS_INT n = (EMACS_INT) data;
2100 lisp_eval_depth = n;
2f592f95
SM
2101}
2102
defb1411
SM
2103/* Eval a sub-expression of the current expression (i.e. in the same
2104 lexical scope). */
1f183cec
BT
2105static Lisp_Object
2106eval_sub_1 (Lisp_Object form)
db9f0278
JB
2107{
2108 Lisp_Object fun, val, original_fun, original_args;
2109 Lisp_Object funcar;
db9f0278
JB
2110 struct gcpro gcpro1, gcpro2, gcpro3;
2111
90165123 2112 if (SYMBOLP (form))
b9598260 2113 {
f07a954e
SM
2114 /* Look up its binding in the lexical environment.
2115 We do not pay attention to the declared_special flag here, since we
2116 already did that when let-binding the variable. */
2117 Lisp_Object lex_binding
2118 = !NILP (Vinternal_interpreter_environment) /* Mere optimization! */
2119 ? Fassq (form, Vinternal_interpreter_environment)
2120 : Qnil;
2121 if (CONSP (lex_binding))
2122 return XCDR (lex_binding);
2123 else
2124 return Fsymbol_value (form);
b9598260
SM
2125 }
2126
db9f0278
JB
2127 if (!CONSP (form))
2128 return form;
2129
2130 QUIT;
9d5a1260
DA
2131
2132 GCPRO1 (form);
765e61e3 2133 maybe_gc ();
9d5a1260 2134 UNGCPRO;
db9f0278 2135
316bec86
BT
2136 scm_dynwind_begin (0);
2137 scm_dynwind_unwind_handler (set_lisp_eval_depth,
2138 (void *) lisp_eval_depth,
2139 SCM_F_WIND_EXPLICITLY);
2140
db9f0278
JB
2141 if (++lisp_eval_depth > max_lisp_eval_depth)
2142 {
2143 if (max_lisp_eval_depth < 100)
2144 max_lisp_eval_depth = 100;
2145 if (lisp_eval_depth > max_lisp_eval_depth)
921baa95 2146 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
db9f0278
JB
2147 }
2148
7d7bbefd
DA
2149 original_fun = XCAR (form);
2150 original_args = XCDR (form);
db9f0278 2151
2f592f95
SM
2152 /* This also protects them from gc. */
2153 record_in_backtrace (original_fun, &original_args, UNEVALLED);
db9f0278
JB
2154
2155 if (debug_on_next_call)
2156 do_debug_on_call (Qt);
2157
2158 /* At this point, only original_fun and original_args
f6d62986 2159 have values that will be used below. */
db9f0278 2160 retry:
8788120f
KS
2161
2162 /* Optimize for no indirection. */
2163 fun = original_fun;
306d67bd 2164 if (!SYMBOLP (fun))
3ec7babc 2165 fun = Ffunction (Fcons (fun, Qnil));
d8ccbf1a 2166 else if (!NILP (fun) && (fun = SYMBOL_FUNCTION (fun), SYMBOLP (fun)))
306d67bd 2167 fun = indirect_function (fun);
db9f0278 2168
8cd38719
BT
2169 if (scm_is_true (scm_procedure_p (fun)))
2170 {
2171 Lisp_Object args_left = original_args;
2172 Lisp_Object nargs = Flength (args_left);
2173 Lisp_Object *args;
2174 size_t argnum = 0;
2175
2176 SAFE_ALLOCA_LISP (args, XINT (nargs));
2177
2178 while (! NILP (args_left))
2179 {
2180 args[argnum++] = eval_sub (Fcar (args_left));
2181 args_left = Fcdr (args_left);
2182 }
2183 val = scm_call_n (fun, args, argnum);
2184 }
2185 else if (SUBRP (fun))
db9f0278
JB
2186 {
2187 Lisp_Object numargs;
166c822d 2188 Lisp_Object argvals[8];
db9f0278
JB
2189 Lisp_Object args_left;
2190 register int i, maxargs;
2191
2192 args_left = original_args;
2193 numargs = Flength (args_left);
2194
f6d62986
SM
2195 if (XINT (numargs) < XSUBR (fun)->min_args
2196 || (XSUBR (fun)->max_args >= 0
2197 && XSUBR (fun)->max_args < XINT (numargs)))
734d55a2 2198 xsignal2 (Qwrong_number_of_arguments, original_fun, numargs);
db9f0278 2199
ef1b0ba7 2200 else if (XSUBR (fun)->max_args == UNEVALLED)
bbc6b304 2201 val = (XSUBR (fun)->function.aUNEVALLED) (args_left);
ef1b0ba7 2202 else if (XSUBR (fun)->max_args == MANY)
db9f0278 2203 {
f6d62986 2204 /* Pass a vector of evaluated arguments. */
db9f0278 2205 Lisp_Object *vals;
f66c7cf8 2206 ptrdiff_t argnum = 0;
3a7a9129 2207 USE_SAFE_ALLOCA;
db9f0278 2208
b72e0717 2209 SAFE_ALLOCA_LISP (vals, XINT (numargs));
db9f0278
JB
2210
2211 GCPRO3 (args_left, fun, fun);
2212 gcpro3.var = vals;
2213 gcpro3.nvars = 0;
2214
265a9e55 2215 while (!NILP (args_left))
db9f0278 2216 {
defb1411 2217 vals[argnum++] = eval_sub (Fcar (args_left));
db9f0278
JB
2218 args_left = Fcdr (args_left);
2219 gcpro3.nvars = argnum;
2220 }
db9f0278 2221
2f592f95
SM
2222 set_backtrace_args (specpdl_ptr - 1, vals);
2223 set_backtrace_nargs (specpdl_ptr - 1, XINT (numargs));
db9f0278 2224
d5273788 2225 val = (XSUBR (fun)->function.aMANY) (XINT (numargs), vals);
a6e3fa71 2226 UNGCPRO;
3a7a9129 2227 SAFE_FREE ();
db9f0278 2228 }
ef1b0ba7 2229 else
db9f0278 2230 {
ef1b0ba7
SM
2231 GCPRO3 (args_left, fun, fun);
2232 gcpro3.var = argvals;
2233 gcpro3.nvars = 0;
db9f0278 2234
ef1b0ba7
SM
2235 maxargs = XSUBR (fun)->max_args;
2236 for (i = 0; i < maxargs; args_left = Fcdr (args_left))
2237 {
a0ee6f27 2238 argvals[i] = eval_sub (Fcar (args_left));
ef1b0ba7
SM
2239 gcpro3.nvars = ++i;
2240 }
db9f0278 2241
ef1b0ba7 2242 UNGCPRO;
db9f0278 2243
2f592f95
SM
2244 set_backtrace_args (specpdl_ptr - 1, argvals);
2245 set_backtrace_nargs (specpdl_ptr - 1, XINT (numargs));
ef1b0ba7
SM
2246
2247 switch (i)
2248 {
2249 case 0:
2250 val = (XSUBR (fun)->function.a0 ());
2251 break;
2252 case 1:
2253 val = (XSUBR (fun)->function.a1 (argvals[0]));
2254 break;
2255 case 2:
2256 val = (XSUBR (fun)->function.a2 (argvals[0], argvals[1]));
2257 break;
2258 case 3:
2259 val = (XSUBR (fun)->function.a3
2260 (argvals[0], argvals[1], argvals[2]));
2261 break;
2262 case 4:
2263 val = (XSUBR (fun)->function.a4
2264 (argvals[0], argvals[1], argvals[2], argvals[3]));
2265 break;
2266 case 5:
2267 val = (XSUBR (fun)->function.a5
2268 (argvals[0], argvals[1], argvals[2], argvals[3],
2269 argvals[4]));
2270 break;
2271 case 6:
2272 val = (XSUBR (fun)->function.a6
2273 (argvals[0], argvals[1], argvals[2], argvals[3],
2274 argvals[4], argvals[5]));
2275 break;
2276 case 7:
2277 val = (XSUBR (fun)->function.a7
2278 (argvals[0], argvals[1], argvals[2], argvals[3],
2279 argvals[4], argvals[5], argvals[6]));
2280 break;
2281
2282 case 8:
2283 val = (XSUBR (fun)->function.a8
2284 (argvals[0], argvals[1], argvals[2], argvals[3],
2285 argvals[4], argvals[5], argvals[6], argvals[7]));
2286 break;
2287
2288 default:
2289 /* Someone has created a subr that takes more arguments than
2290 is supported by this code. We need to either rewrite the
2291 subr to use a different argument protocol, or add more
2292 cases to this switch. */
1088b922 2293 emacs_abort ();
ef1b0ba7 2294 }
db9f0278
JB
2295 }
2296 }
ef1b0ba7 2297 else if (COMPILEDP (fun))
defb1411 2298 val = apply_lambda (fun, original_args);
db9f0278
JB
2299 else
2300 {
eadf1faa 2301 if (NILP (fun))
734d55a2 2302 xsignal1 (Qvoid_function, original_fun);
db9f0278 2303 if (!CONSP (fun))
734d55a2
KS
2304 xsignal1 (Qinvalid_function, original_fun);
2305 funcar = XCAR (fun);
90165123 2306 if (!SYMBOLP (funcar))
734d55a2 2307 xsignal1 (Qinvalid_function, original_fun);
db9f0278
JB
2308 if (EQ (funcar, Qautoload))
2309 {
7abaf5cc 2310 Fautoload_do_load (fun, original_fun, Qnil);
db9f0278
JB
2311 goto retry;
2312 }
2313 if (EQ (funcar, Qmacro))
8be3a09c 2314 {
3200038e 2315 dynwind_begin ();
8be3a09c
SM
2316 Lisp_Object exp;
2317 /* Bind lexical-binding during expansion of the macro, so the
2318 macro can know reliably if the code it outputs will be
2319 interpreted using lexical-binding or not. */
2320 specbind (Qlexical_binding,
2321 NILP (Vinternal_interpreter_environment) ? Qnil : Qt);
2322 exp = apply1 (Fcdr (fun), original_args);
3200038e 2323 dynwind_end ();
8be3a09c
SM
2324 val = eval_sub (exp);
2325 }
defb1411
SM
2326 else if (EQ (funcar, Qlambda)
2327 || EQ (funcar, Qclosure))
2328 val = apply_lambda (fun, original_args);
db9f0278 2329 else
734d55a2 2330 xsignal1 (Qinvalid_function, original_fun);
db9f0278 2331 }
c1788fbc 2332
2f592f95 2333 if (backtrace_debug_on_exit (specpdl_ptr - 1))
6c6f1994 2334 val = call_debugger (list2 (Qexit, val));
316bec86 2335 scm_dynwind_end ();
824eb35e 2336
db9f0278
JB
2337 return val;
2338}
1f183cec
BT
2339
2340Lisp_Object
2341eval_sub (Lisp_Object form)
2342{
2343 return scm_c_value_ref (eval_sub_1 (form), 0);
2344}
2345\f
2346static Lisp_Object
2347values_to_list (Lisp_Object values)
2348{
2349 Lisp_Object list = Qnil;
2350 for (int i = scm_c_nvalues (values) - 1; i >= 0; i--)
2351 list = Fcons (scm_c_value_ref (values, i), list);
2352 return list;
2353}
2354
2355DEFUN ("multiple-value-call", Fmultiple_value_call, Smultiple_value_call,
2356 2, UNEVALLED, 0,
2357 doc: /* Call with multiple values.
2358usage: (multiple-value-call FUNCTION-FORM FORM) */)
2359 (Lisp_Object args)
2360{
2361 Lisp_Object function_form = eval_sub (XCAR (args));
2362 Lisp_Object values = Qnil;
2363 while (CONSP (args = XCDR (args)))
2364 values = nconc2 (Fnreverse (values_to_list (eval_sub_1 (XCAR (args)))),
2365 values);
2366 return apply1 (function_form, Fnreverse (values));
2367}
2368
2369DEFUN ("values", Fvalues, Svalues, 0, MANY, 0,
2370 doc: /* Return multiple values. */)
2371 (ptrdiff_t nargs, Lisp_Object *args)
2372{
2373 return scm_c_values (args, nargs);
2374}
db9f0278 2375\f
8edd4a2b 2376DEFUN ("apply", Fapply, Sapply, 1, MANY, 0,
9dbc9081
PJ
2377 doc: /* Call FUNCTION with our remaining args, using our last arg as list of args.
2378Then return the value FUNCTION returns.
2379Thus, (apply '+ 1 2 '(3 4)) returns 10.
2380usage: (apply FUNCTION &rest ARGUMENTS) */)
f66c7cf8 2381 (ptrdiff_t nargs, Lisp_Object *args)
db9f0278 2382{
d311d28c
PE
2383 ptrdiff_t i;
2384 EMACS_INT numargs;
db9f0278
JB
2385 register Lisp_Object spread_arg;
2386 register Lisp_Object *funcall_args;
3a7a9129 2387 Lisp_Object fun, retval;
96d44c64 2388 struct gcpro gcpro1;
3a7a9129 2389 USE_SAFE_ALLOCA;
db9f0278
JB
2390
2391 fun = args [0];
2392 funcall_args = 0;
2393 spread_arg = args [nargs - 1];
b7826503 2394 CHECK_LIST (spread_arg);
177c0ea7 2395
db9f0278
JB
2396 numargs = XINT (Flength (spread_arg));
2397
2398 if (numargs == 0)
2399 return Ffuncall (nargs - 1, args);
2400 else if (numargs == 1)
2401 {
03699b14 2402 args [nargs - 1] = XCAR (spread_arg);
db9f0278
JB
2403 return Ffuncall (nargs, args);
2404 }
2405
a6e3fa71 2406 numargs += nargs - 2;
db9f0278 2407
8788120f 2408 /* Optimize for no indirection. */
eadf1faa 2409 if (SYMBOLP (fun) && !NILP (fun)
d8ccbf1a 2410 && (fun = SYMBOL_FUNCTION (fun), SYMBOLP (fun)))
8788120f 2411 fun = indirect_function (fun);
eadf1faa 2412 if (NILP (fun))
db9f0278 2413 {
f6d62986 2414 /* Let funcall get the error. */
ffd56f97
JB
2415 fun = args[0];
2416 goto funcall;
db9f0278
JB
2417 }
2418
90165123 2419 if (SUBRP (fun))
db9f0278
JB
2420 {
2421 if (numargs < XSUBR (fun)->min_args
2422 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
f6d62986 2423 goto funcall; /* Let funcall get the error. */
c5101a77 2424 else if (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args > numargs)
db9f0278
JB
2425 {
2426 /* Avoid making funcall cons up a yet another new vector of arguments
f6d62986 2427 by explicitly supplying nil's for optional values. */
b72e0717 2428 SAFE_ALLOCA_LISP (funcall_args, 1 + XSUBR (fun)->max_args);
db9f0278
JB
2429 for (i = numargs; i < XSUBR (fun)->max_args;)
2430 funcall_args[++i] = Qnil;
96d44c64
SM
2431 GCPRO1 (*funcall_args);
2432 gcpro1.nvars = 1 + XSUBR (fun)->max_args;
db9f0278
JB
2433 }
2434 }
2435 funcall:
2436 /* We add 1 to numargs because funcall_args includes the
2437 function itself as well as its arguments. */
2438 if (!funcall_args)
a6e3fa71 2439 {
b72e0717 2440 SAFE_ALLOCA_LISP (funcall_args, 1 + numargs);
96d44c64
SM
2441 GCPRO1 (*funcall_args);
2442 gcpro1.nvars = 1 + numargs;
a6e3fa71
JB
2443 }
2444
663e2b3f 2445 memcpy (funcall_args, args, nargs * word_size);
db9f0278
JB
2446 /* Spread the last arg we got. Its first element goes in
2447 the slot that it used to occupy, hence this value of I. */
2448 i = nargs - 1;
265a9e55 2449 while (!NILP (spread_arg))
db9f0278 2450 {
03699b14
KR
2451 funcall_args [i++] = XCAR (spread_arg);
2452 spread_arg = XCDR (spread_arg);
db9f0278 2453 }
a6e3fa71 2454
96d44c64 2455 /* By convention, the caller needs to gcpro Ffuncall's args. */
3a7a9129
CY
2456 retval = Ffuncall (gcpro1.nvars, funcall_args);
2457 UNGCPRO;
2458 SAFE_FREE ();
2459
2460 return retval;
db9f0278
JB
2461}
2462\f
ff936e53
SM
2463/* Run hook variables in various ways. */
2464
f6d62986 2465static Lisp_Object
f66c7cf8 2466funcall_nil (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2467{
2468 Ffuncall (nargs, args);
2469 return Qnil;
2470}
ff936e53 2471
a7ca3326 2472DEFUN ("run-hooks", Frun_hooks, Srun_hooks, 0, MANY, 0,
9f685258 2473 doc: /* Run each hook in HOOKS.
9dbc9081
PJ
2474Each argument should be a symbol, a hook variable.
2475These symbols are processed in the order specified.
2476If a hook symbol has a non-nil value, that value may be a function
2477or a list of functions to be called to run the hook.
2478If the value is a function, it is called with no arguments.
2479If it is a list, the elements are called, in order, with no arguments.
2480
9f685258
LK
2481Major modes should not use this function directly to run their mode
2482hook; they should use `run-mode-hooks' instead.
2483
72e85d5d
RS
2484Do not use `make-local-variable' to make a hook variable buffer-local.
2485Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2486usage: (run-hooks &rest HOOKS) */)
f66c7cf8 2487 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53
SM
2488{
2489 Lisp_Object hook[1];
f66c7cf8 2490 ptrdiff_t i;
ff936e53
SM
2491
2492 for (i = 0; i < nargs; i++)
2493 {
2494 hook[0] = args[i];
f6d62986 2495 run_hook_with_args (1, hook, funcall_nil);
ff936e53
SM
2496 }
2497
2498 return Qnil;
2499}
177c0ea7 2500
a7ca3326 2501DEFUN ("run-hook-with-args", Frun_hook_with_args,
9dbc9081
PJ
2502 Srun_hook_with_args, 1, MANY, 0,
2503 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2504HOOK should be a symbol, a hook variable. The value of HOOK
2505may be nil, a function, or a list of functions. Call each
2506function in order with arguments ARGS. The final return value
2507is unspecified.
9dbc9081 2508
72e85d5d
RS
2509Do not use `make-local-variable' to make a hook variable buffer-local.
2510Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2511usage: (run-hook-with-args HOOK &rest ARGS) */)
f66c7cf8 2512 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53 2513{
f6d62986 2514 return run_hook_with_args (nargs, args, funcall_nil);
ff936e53
SM
2515}
2516
d393cefb
GM
2517/* NB this one still documents a specific non-nil return value.
2518 (As did run-hook-with-args and run-hook-with-args-until-failure
2519 until they were changed in 24.1.) */
a0d76c27 2520DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
9dbc9081
PJ
2521 Srun_hook_with_args_until_success, 1, MANY, 0,
2522 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2523HOOK should be a symbol, a hook variable. The value of HOOK
2524may be nil, a function, or a list of functions. Call each
2525function in order with arguments ARGS, stopping at the first
2526one that returns non-nil, and return that value. Otherwise (if
2527all functions return nil, or if there are no functions to call),
2528return nil.
9dbc9081 2529
72e85d5d
RS
2530Do not use `make-local-variable' to make a hook variable buffer-local.
2531Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2532usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
f66c7cf8 2533 (ptrdiff_t nargs, Lisp_Object *args)
b0b667cb 2534{
f6d62986
SM
2535 return run_hook_with_args (nargs, args, Ffuncall);
2536}
2537
2538static Lisp_Object
f66c7cf8 2539funcall_not (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2540{
2541 return NILP (Ffuncall (nargs, args)) ? Qt : Qnil;
ff936e53
SM
2542}
2543
a7ca3326 2544DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
9dbc9081
PJ
2545 Srun_hook_with_args_until_failure, 1, MANY, 0,
2546 doc: /* Run HOOK with the specified arguments ARGS.
d393cefb
GM
2547HOOK should be a symbol, a hook variable. The value of HOOK
2548may be nil, a function, or a list of functions. Call each
2549function in order with arguments ARGS, stopping at the first
2550one that returns nil, and return nil. Otherwise (if all functions
2551return non-nil, or if there are no functions to call), return non-nil
2552\(do not rely on the precise return value in this case).
9dbc9081 2553
72e85d5d
RS
2554Do not use `make-local-variable' to make a hook variable buffer-local.
2555Instead, use `add-hook' and specify t for the LOCAL argument.
9dbc9081 2556usage: (run-hook-with-args-until-failure HOOK &rest ARGS) */)
f66c7cf8 2557 (ptrdiff_t nargs, Lisp_Object *args)
ff936e53 2558{
f6d62986 2559 return NILP (run_hook_with_args (nargs, args, funcall_not)) ? Qt : Qnil;
ff936e53
SM
2560}
2561
f6d62986 2562static Lisp_Object
f66c7cf8 2563run_hook_wrapped_funcall (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2564{
2565 Lisp_Object tmp = args[0], ret;
2566 args[0] = args[1];
2567 args[1] = tmp;
2568 ret = Ffuncall (nargs, args);
2569 args[1] = args[0];
2570 args[0] = tmp;
2571 return ret;
2572}
2573
2574DEFUN ("run-hook-wrapped", Frun_hook_wrapped, Srun_hook_wrapped, 2, MANY, 0,
2575 doc: /* Run HOOK, passing each function through WRAP-FUNCTION.
2576I.e. instead of calling each function FUN directly with arguments ARGS,
2577it calls WRAP-FUNCTION with arguments FUN and ARGS.
2578As soon as a call to WRAP-FUNCTION returns non-nil, `run-hook-wrapped'
2579aborts and returns that value.
2580usage: (run-hook-wrapped HOOK WRAP-FUNCTION &rest ARGS) */)
f66c7cf8 2581 (ptrdiff_t nargs, Lisp_Object *args)
f6d62986
SM
2582{
2583 return run_hook_with_args (nargs, args, run_hook_wrapped_funcall);
2584}
ff936e53 2585
c933ea05
RS
2586/* ARGS[0] should be a hook symbol.
2587 Call each of the functions in the hook value, passing each of them
2588 as arguments all the rest of ARGS (all NARGS - 1 elements).
f6d62986 2589 FUNCALL specifies how to call each function on the hook.
c933ea05
RS
2590 The caller (or its caller, etc) must gcpro all of ARGS,
2591 except that it isn't necessary to gcpro ARGS[0]. */
2592
f6d62986 2593Lisp_Object
f66c7cf8
PE
2594run_hook_with_args (ptrdiff_t nargs, Lisp_Object *args,
2595 Lisp_Object (*funcall) (ptrdiff_t nargs, Lisp_Object *args))
ff936e53 2596{
f6d62986 2597 Lisp_Object sym, val, ret = Qnil;
fada05d6 2598 struct gcpro gcpro1, gcpro2, gcpro3;
b0b667cb 2599
f029ca5f
RS
2600 /* If we are dying or still initializing,
2601 don't do anything--it would probably crash if we tried. */
2602 if (NILP (Vrun_hooks))
caff32a7 2603 return Qnil;
f029ca5f 2604
b0b667cb 2605 sym = args[0];
aa681b51 2606 val = find_symbol_value (sym);
ff936e53 2607
b0b667cb 2608 if (EQ (val, Qunbound) || NILP (val))
ff936e53 2609 return ret;
dee4ba59 2610 else if (!CONSP (val) || FUNCTIONP (val))
b0b667cb
KH
2611 {
2612 args[0] = val;
f6d62986 2613 return funcall (nargs, args);
b0b667cb
KH
2614 }
2615 else
2616 {
1faed8ae
PE
2617 Lisp_Object global_vals = Qnil;
2618 GCPRO3 (sym, val, global_vals);
cb9d21f8 2619
ff936e53 2620 for (;
f6d62986 2621 CONSP (val) && NILP (ret);
03699b14 2622 val = XCDR (val))
b0b667cb 2623 {
03699b14 2624 if (EQ (XCAR (val), Qt))
b0b667cb
KH
2625 {
2626 /* t indicates this hook has a local binding;
2627 it means to run the global binding too. */
1faed8ae
PE
2628 global_vals = Fdefault_value (sym);
2629 if (NILP (global_vals)) continue;
b0b667cb 2630
1faed8ae 2631 if (!CONSP (global_vals) || EQ (XCAR (global_vals), Qlambda))
b0b667cb 2632 {
1faed8ae 2633 args[0] = global_vals;
f6d62986 2634 ret = funcall (nargs, args);
8932b1c2
CY
2635 }
2636 else
2637 {
2638 for (;
f6d62986 2639 CONSP (global_vals) && NILP (ret);
1faed8ae 2640 global_vals = XCDR (global_vals))
8932b1c2 2641 {
1faed8ae 2642 args[0] = XCAR (global_vals);
8932b1c2
CY
2643 /* In a global value, t should not occur. If it does, we
2644 must ignore it to avoid an endless loop. */
2645 if (!EQ (args[0], Qt))
f6d62986 2646 ret = funcall (nargs, args);
8932b1c2 2647 }
b0b667cb
KH
2648 }
2649 }
2650 else
2651 {
03699b14 2652 args[0] = XCAR (val);
f6d62986 2653 ret = funcall (nargs, args);
b0b667cb
KH
2654 }
2655 }
cb9d21f8
RS
2656
2657 UNGCPRO;
ff936e53 2658 return ret;
b0b667cb
KH
2659 }
2660}
c933ea05 2661
7d48558f
RS
2662/* Run the hook HOOK, giving each function the two args ARG1 and ARG2. */
2663
2664void
d3da34e0 2665run_hook_with_args_2 (Lisp_Object hook, Lisp_Object arg1, Lisp_Object arg2)
7d48558f
RS
2666{
2667 Lisp_Object temp[3];
2668 temp[0] = hook;
2669 temp[1] = arg1;
2670 temp[2] = arg2;
2671
2672 Frun_hook_with_args (3, temp);
2673}
ff936e53 2674\f
f6d62986 2675/* Apply fn to arg. */
db9f0278 2676Lisp_Object
d3da34e0 2677apply1 (Lisp_Object fn, Lisp_Object arg)
db9f0278 2678{
a6e3fa71
JB
2679 struct gcpro gcpro1;
2680
2681 GCPRO1 (fn);
265a9e55 2682 if (NILP (arg))
3200038e 2683 return Ffuncall (1, &fn);
a6e3fa71 2684 gcpro1.nvars = 2;
db9f0278
JB
2685 {
2686 Lisp_Object args[2];
2687 args[0] = fn;
2688 args[1] = arg;
a6e3fa71 2689 gcpro1.var = args;
3200038e 2690 return Fapply (2, args);
db9f0278 2691 }
db9f0278
JB
2692}
2693
f6d62986 2694/* Call function fn on no arguments. */
db9f0278 2695Lisp_Object
d3da34e0 2696call0 (Lisp_Object fn)
db9f0278 2697{
a6e3fa71
JB
2698 struct gcpro gcpro1;
2699
2700 GCPRO1 (fn);
3200038e 2701 return Ffuncall (1, &fn);
db9f0278
JB
2702}
2703
f6d62986 2704/* Call function fn with 1 argument arg1. */
db9f0278
JB
2705/* ARGSUSED */
2706Lisp_Object
d3da34e0 2707call1 (Lisp_Object fn, Lisp_Object arg1)
db9f0278 2708{
a6e3fa71 2709 struct gcpro gcpro1;
177c0ea7 2710 Lisp_Object args[2];
a6e3fa71 2711
db9f0278 2712 args[0] = fn;
15285f9f 2713 args[1] = arg1;
a6e3fa71
JB
2714 GCPRO1 (args[0]);
2715 gcpro1.nvars = 2;
3200038e 2716 return Ffuncall (2, args);
db9f0278
JB
2717}
2718
f6d62986 2719/* Call function fn with 2 arguments arg1, arg2. */
db9f0278
JB
2720/* ARGSUSED */
2721Lisp_Object
d3da34e0 2722call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
db9f0278 2723{
a6e3fa71 2724 struct gcpro gcpro1;
db9f0278
JB
2725 Lisp_Object args[3];
2726 args[0] = fn;
15285f9f
RS
2727 args[1] = arg1;
2728 args[2] = arg2;
a6e3fa71
JB
2729 GCPRO1 (args[0]);
2730 gcpro1.nvars = 3;
3200038e 2731 return Ffuncall (3, args);
db9f0278
JB
2732}
2733
f6d62986 2734/* Call function fn with 3 arguments arg1, arg2, arg3. */
db9f0278
JB
2735/* ARGSUSED */
2736Lisp_Object
d3da34e0 2737call3 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3)
db9f0278 2738{
a6e3fa71 2739 struct gcpro gcpro1;
db9f0278
JB
2740 Lisp_Object args[4];
2741 args[0] = fn;
15285f9f
RS
2742 args[1] = arg1;
2743 args[2] = arg2;
2744 args[3] = arg3;
a6e3fa71
JB
2745 GCPRO1 (args[0]);
2746 gcpro1.nvars = 4;
3200038e 2747 return Ffuncall (4, args);
db9f0278
JB
2748}
2749
f6d62986 2750/* Call function fn with 4 arguments arg1, arg2, arg3, arg4. */
a5a44b91
JB
2751/* ARGSUSED */
2752Lisp_Object
d3da34e0
JB
2753call4 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2754 Lisp_Object arg4)
a5a44b91
JB
2755{
2756 struct gcpro gcpro1;
a5a44b91
JB
2757 Lisp_Object args[5];
2758 args[0] = fn;
15285f9f
RS
2759 args[1] = arg1;
2760 args[2] = arg2;
2761 args[3] = arg3;
2762 args[4] = arg4;
a5a44b91
JB
2763 GCPRO1 (args[0]);
2764 gcpro1.nvars = 5;
3200038e 2765 return Ffuncall (5, args);
a5a44b91
JB
2766}
2767
f6d62986 2768/* Call function fn with 5 arguments arg1, arg2, arg3, arg4, arg5. */
15285f9f
RS
2769/* ARGSUSED */
2770Lisp_Object
d3da34e0
JB
2771call5 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2772 Lisp_Object arg4, Lisp_Object arg5)
15285f9f
RS
2773{
2774 struct gcpro gcpro1;
15285f9f
RS
2775 Lisp_Object args[6];
2776 args[0] = fn;
2777 args[1] = arg1;
2778 args[2] = arg2;
2779 args[3] = arg3;
2780 args[4] = arg4;
2781 args[5] = arg5;
2782 GCPRO1 (args[0]);
2783 gcpro1.nvars = 6;
3200038e 2784 return Ffuncall (6, args);
15285f9f
RS
2785}
2786
f6d62986 2787/* Call function fn with 6 arguments arg1, arg2, arg3, arg4, arg5, arg6. */
15285f9f
RS
2788/* ARGSUSED */
2789Lisp_Object
d3da34e0
JB
2790call6 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2791 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6)
15285f9f
RS
2792{
2793 struct gcpro gcpro1;
15285f9f
RS
2794 Lisp_Object args[7];
2795 args[0] = fn;
2796 args[1] = arg1;
2797 args[2] = arg2;
2798 args[3] = arg3;
2799 args[4] = arg4;
2800 args[5] = arg5;
2801 args[6] = arg6;
2802 GCPRO1 (args[0]);
2803 gcpro1.nvars = 7;
3200038e 2804 return Ffuncall (7, args);
15285f9f
RS
2805}
2806
f6d62986 2807/* Call function fn with 7 arguments arg1, arg2, arg3, arg4, arg5, arg6, arg7. */
574c05e2
KK
2808/* ARGSUSED */
2809Lisp_Object
d3da34e0
JB
2810call7 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2, Lisp_Object arg3,
2811 Lisp_Object arg4, Lisp_Object arg5, Lisp_Object arg6, Lisp_Object arg7)
574c05e2
KK
2812{
2813 struct gcpro gcpro1;
574c05e2
KK
2814 Lisp_Object args[8];
2815 args[0] = fn;
2816 args[1] = arg1;
2817 args[2] = arg2;
2818 args[3] = arg3;
2819 args[4] = arg4;
2820 args[5] = arg5;
2821 args[6] = arg6;
2822 args[7] = arg7;
2823 GCPRO1 (args[0]);
2824 gcpro1.nvars = 8;
3200038e 2825 return Ffuncall (8, args);
574c05e2
KK
2826}
2827
6c2ef893
RS
2828/* The caller should GCPRO all the elements of ARGS. */
2829
a7ca3326 2830DEFUN ("functionp", Ffunctionp, Sfunctionp, 1, 1, 0,
7200d79c 2831 doc: /* Non-nil if OBJECT is a function. */)
c566235d 2832 (Lisp_Object object)
b9598260 2833{
e1f29348 2834 if (FUNCTIONP (object))
b9598260 2835 return Qt;
e1f29348 2836 return Qnil;
b9598260
SM
2837}
2838
1f183cec 2839DEFUN ("funcall", Ffuncall1, Sfuncall, 1, MANY, 0,
9dbc9081
PJ
2840 doc: /* Call first argument as a function, passing remaining arguments to it.
2841Return the value that function returns.
2842Thus, (funcall 'cons 'x 'y) returns (x . y).
2843usage: (funcall FUNCTION &rest ARGUMENTS) */)
f66c7cf8 2844 (ptrdiff_t nargs, Lisp_Object *args)
db9f0278 2845{
8788120f 2846 Lisp_Object fun, original_fun;
db9f0278 2847 Lisp_Object funcar;
f66c7cf8 2848 ptrdiff_t numargs = nargs - 1;
db9f0278
JB
2849 Lisp_Object lisp_numargs;
2850 Lisp_Object val;
db9f0278 2851 register Lisp_Object *internal_args;
f66c7cf8 2852 ptrdiff_t i;
db9f0278
JB
2853
2854 QUIT;
db9f0278 2855
316bec86
BT
2856 scm_dynwind_begin (0);
2857 scm_dynwind_unwind_handler (set_lisp_eval_depth,
2858 (void *) lisp_eval_depth,
2859 SCM_F_WIND_EXPLICITLY);
2860
db9f0278
JB
2861 if (++lisp_eval_depth > max_lisp_eval_depth)
2862 {
2863 if (max_lisp_eval_depth < 100)
2864 max_lisp_eval_depth = 100;
2865 if (lisp_eval_depth > max_lisp_eval_depth)
921baa95 2866 error ("Lisp nesting exceeds `max-lisp-eval-depth'");
db9f0278
JB
2867 }
2868
2f592f95
SM
2869 /* This also GCPROs them. */
2870 record_in_backtrace (args[0], &args[1], nargs - 1);
db9f0278 2871
7abaf5cc
SM
2872 /* Call GC after setting up the backtrace, so the latter GCPROs the args. */
2873 maybe_gc ();
2874
db9f0278
JB
2875 if (debug_on_next_call)
2876 do_debug_on_call (Qlambda);
2877
8788120f
KS
2878 original_fun = args[0];
2879
db9f0278
JB
2880 retry:
2881
8788120f
KS
2882 /* Optimize for no indirection. */
2883 fun = original_fun;
eadf1faa 2884 if (SYMBOLP (fun) && !NILP (fun)
d8ccbf1a 2885 && (fun = SYMBOL_FUNCTION (fun), SYMBOLP (fun)))
8788120f 2886 fun = indirect_function (fun);
db9f0278 2887
8cd38719
BT
2888 if (scm_is_true (scm_procedure_p (fun)))
2889 {
2890 val = scm_call_n (fun, args + 1, numargs);
2891 }
2892 else if (SUBRP (fun))
db9f0278 2893 {
ef1b0ba7 2894 if (numargs < XSUBR (fun)->min_args
db9f0278
JB
2895 || (XSUBR (fun)->max_args >= 0 && XSUBR (fun)->max_args < numargs))
2896 {
a631e24c 2897 XSETFASTINT (lisp_numargs, numargs);
734d55a2 2898 xsignal2 (Qwrong_number_of_arguments, original_fun, lisp_numargs);
db9f0278
JB
2899 }
2900
ef1b0ba7 2901 else if (XSUBR (fun)->max_args == UNEVALLED)
734d55a2 2902 xsignal1 (Qinvalid_function, original_fun);
db9f0278 2903
ef1b0ba7
SM
2904 else if (XSUBR (fun)->max_args == MANY)
2905 val = (XSUBR (fun)->function.aMANY) (numargs, args + 1);
db9f0278 2906 else
db9f0278 2907 {
ef1b0ba7
SM
2908 if (XSUBR (fun)->max_args > numargs)
2909 {
38182d90
PE
2910 internal_args = alloca (XSUBR (fun)->max_args
2911 * sizeof *internal_args);
663e2b3f 2912 memcpy (internal_args, args + 1, numargs * word_size);
ef1b0ba7
SM
2913 for (i = numargs; i < XSUBR (fun)->max_args; i++)
2914 internal_args[i] = Qnil;
2915 }
2916 else
2917 internal_args = args + 1;
2918 switch (XSUBR (fun)->max_args)
2919 {
2920 case 0:
2921 val = (XSUBR (fun)->function.a0 ());
2922 break;
2923 case 1:
2924 val = (XSUBR (fun)->function.a1 (internal_args[0]));
2925 break;
2926 case 2:
2927 val = (XSUBR (fun)->function.a2
2928 (internal_args[0], internal_args[1]));
2929 break;
2930 case 3:
2931 val = (XSUBR (fun)->function.a3
2932 (internal_args[0], internal_args[1], internal_args[2]));
2933 break;
2934 case 4:
2935 val = (XSUBR (fun)->function.a4
2936 (internal_args[0], internal_args[1], internal_args[2],
2937 internal_args[3]));
2938 break;
2939 case 5:
2940 val = (XSUBR (fun)->function.a5
2941 (internal_args[0], internal_args[1], internal_args[2],
2942 internal_args[3], internal_args[4]));
2943 break;
2944 case 6:
2945 val = (XSUBR (fun)->function.a6
2946 (internal_args[0], internal_args[1], internal_args[2],
2947 internal_args[3], internal_args[4], internal_args[5]));
2948 break;
2949 case 7:
2950 val = (XSUBR (fun)->function.a7
2951 (internal_args[0], internal_args[1], internal_args[2],
2952 internal_args[3], internal_args[4], internal_args[5],
2953 internal_args[6]));
2954 break;
2955
2956 case 8:
2957 val = (XSUBR (fun)->function.a8
2958 (internal_args[0], internal_args[1], internal_args[2],
2959 internal_args[3], internal_args[4], internal_args[5],
2960 internal_args[6], internal_args[7]));
2961 break;
2962
2963 default:
2964
2965 /* If a subr takes more than 8 arguments without using MANY
2966 or UNEVALLED, we need to extend this function to support it.
2967 Until this is done, there is no way to call the function. */
1088b922 2968 emacs_abort ();
ef1b0ba7 2969 }
db9f0278
JB
2970 }
2971 }
ef1b0ba7 2972 else if (COMPILEDP (fun))
db9f0278
JB
2973 val = funcall_lambda (fun, numargs, args + 1);
2974 else
2975 {
eadf1faa 2976 if (NILP (fun))
734d55a2 2977 xsignal1 (Qvoid_function, original_fun);
db9f0278 2978 if (!CONSP (fun))
734d55a2
KS
2979 xsignal1 (Qinvalid_function, original_fun);
2980 funcar = XCAR (fun);
90165123 2981 if (!SYMBOLP (funcar))
734d55a2 2982 xsignal1 (Qinvalid_function, original_fun);
defb1411
SM
2983 if (EQ (funcar, Qlambda)
2984 || EQ (funcar, Qclosure))
db9f0278 2985 val = funcall_lambda (fun, numargs, args + 1);
db9f0278
JB
2986 else if (EQ (funcar, Qautoload))
2987 {
7abaf5cc 2988 Fautoload_do_load (fun, original_fun, Qnil);
db9f0278
JB
2989 goto retry;
2990 }
2991 else
734d55a2 2992 xsignal1 (Qinvalid_function, original_fun);
db9f0278 2993 }
2f592f95 2994 if (backtrace_debug_on_exit (specpdl_ptr - 1))
6c6f1994 2995 val = call_debugger (list2 (Qexit, val));
316bec86 2996 scm_dynwind_end ();
db9f0278
JB
2997 return val;
2998}
1f183cec
BT
2999
3000Lisp_Object
3001Ffuncall (ptrdiff_t nargs, Lisp_Object *args)
3002{
3003 return scm_c_value_ref (Ffuncall1 (nargs, args), 0);
3004}
db9f0278 3005\f
2f7c71a1 3006static Lisp_Object
defb1411 3007apply_lambda (Lisp_Object fun, Lisp_Object args)
db9f0278
JB
3008{
3009 Lisp_Object args_left;
d311d28c
PE
3010 ptrdiff_t i;
3011 EMACS_INT numargs;
db9f0278
JB
3012 register Lisp_Object *arg_vector;
3013 struct gcpro gcpro1, gcpro2, gcpro3;
db9f0278 3014 register Lisp_Object tem;
3a7a9129 3015 USE_SAFE_ALLOCA;
db9f0278 3016
f66c7cf8 3017 numargs = XFASTINT (Flength (args));
c5101a77 3018 SAFE_ALLOCA_LISP (arg_vector, numargs);
db9f0278
JB
3019 args_left = args;
3020
3021 GCPRO3 (*arg_vector, args_left, fun);
3022 gcpro1.nvars = 0;
3023
c5101a77 3024 for (i = 0; i < numargs; )
db9f0278
JB
3025 {
3026 tem = Fcar (args_left), args_left = Fcdr (args_left);
defb1411 3027 tem = eval_sub (tem);
db9f0278
JB
3028 arg_vector[i++] = tem;
3029 gcpro1.nvars = i;
3030 }
3031
3032 UNGCPRO;
3033
2f592f95
SM
3034 set_backtrace_args (specpdl_ptr - 1, arg_vector);
3035 set_backtrace_nargs (specpdl_ptr - 1, i);
c5101a77 3036 tem = funcall_lambda (fun, numargs, arg_vector);
db9f0278
JB
3037
3038 /* Do the debug-on-exit now, while arg_vector still exists. */
2f592f95
SM
3039 if (backtrace_debug_on_exit (specpdl_ptr - 1))
3040 {
3041 /* Don't do it again when we return to eval. */
3042 set_backtrace_debug_on_exit (specpdl_ptr - 1, false);
6c6f1994 3043 tem = call_debugger (list2 (Qexit, tem));
2f592f95 3044 }
3a7a9129 3045 SAFE_FREE ();
db9f0278
JB
3046 return tem;
3047}
3048
3049/* Apply a Lisp function FUN to the NARGS evaluated arguments in ARG_VECTOR
3050 and return the result of evaluation.
3051 FUN must be either a lambda-expression or a compiled-code object. */
3052
2901f1d1 3053static Lisp_Object
f66c7cf8 3054funcall_lambda (Lisp_Object fun, ptrdiff_t nargs,
c5101a77 3055 register Lisp_Object *arg_vector)
db9f0278 3056{
defb1411 3057 Lisp_Object val, syms_left, next, lexenv;
3200038e 3058 dynwind_begin ();
f66c7cf8 3059 ptrdiff_t i;
1882aa38 3060 bool optional, rest;
db9f0278 3061
90165123 3062 if (CONSP (fun))
9ab90667 3063 {
defb1411
SM
3064 if (EQ (XCAR (fun), Qclosure))
3065 {
3066 fun = XCDR (fun); /* Drop `closure'. */
3067 lexenv = XCAR (fun);
23aba0ea 3068 CHECK_LIST_CONS (fun, fun);
defb1411
SM
3069 }
3070 else
3071 lexenv = Qnil;
9ab90667
GM
3072 syms_left = XCDR (fun);
3073 if (CONSP (syms_left))
3074 syms_left = XCAR (syms_left);
3075 else
734d55a2 3076 xsignal1 (Qinvalid_function, fun);
9ab90667 3077 }
90165123 3078 else if (COMPILEDP (fun))
defb1411 3079 {
798cb644
SM
3080 syms_left = AREF (fun, COMPILED_ARGLIST);
3081 if (INTEGERP (syms_left))
876c194c
SM
3082 /* A byte-code object with a non-nil `push args' slot means we
3083 shouldn't bind any arguments, instead just call the byte-code
3084 interpreter directly; it will push arguments as necessary.
3085
9173deec 3086 Byte-code objects with either a non-existent, or a nil value for
876c194c
SM
3087 the `push args' slot (the default), have dynamically-bound
3088 arguments, and use the argument-binding code below instead (as do
3089 all interpreted functions, even lexically bound ones). */
3090 {
3091 /* If we have not actually read the bytecode string
3092 and constants vector yet, fetch them from the file. */
3093 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
3094 Ffetch_bytecode (fun);
3200038e 3095 dynwind_end ();
876c194c
SM
3096 return exec_byte_code (AREF (fun, COMPILED_BYTECODE),
3097 AREF (fun, COMPILED_CONSTANTS),
3098 AREF (fun, COMPILED_STACK_DEPTH),
798cb644 3099 syms_left,
876c194c
SM
3100 nargs, arg_vector);
3101 }
defb1411
SM
3102 lexenv = Qnil;
3103 }
9ab90667 3104 else
1088b922 3105 emacs_abort ();
db9f0278 3106
9ab90667
GM
3107 i = optional = rest = 0;
3108 for (; CONSP (syms_left); syms_left = XCDR (syms_left))
db9f0278
JB
3109 {
3110 QUIT;
177c0ea7 3111
9ab90667 3112 next = XCAR (syms_left);
8788120f 3113 if (!SYMBOLP (next))
734d55a2 3114 xsignal1 (Qinvalid_function, fun);
177c0ea7 3115
db9f0278
JB
3116 if (EQ (next, Qand_rest))
3117 rest = 1;
3118 else if (EQ (next, Qand_optional))
3119 optional = 1;
db9f0278 3120 else
db9f0278 3121 {
e610eaca 3122 Lisp_Object arg;
defb1411
SM
3123 if (rest)
3124 {
e610eaca 3125 arg = Flist (nargs - i, &arg_vector[i]);
defb1411
SM
3126 i = nargs;
3127 }
3128 else if (i < nargs)
e610eaca 3129 arg = arg_vector[i++];
b9598260
SM
3130 else if (!optional)
3131 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
3132 else
e610eaca 3133 arg = Qnil;
7200d79c 3134
b9598260 3135 /* Bind the argument. */
876c194c 3136 if (!NILP (lexenv) && SYMBOLP (next))
b9598260 3137 /* Lexically bind NEXT by adding it to the lexenv alist. */
e610eaca 3138 lexenv = Fcons (Fcons (next, arg), lexenv);
b9598260
SM
3139 else
3140 /* Dynamically bind NEXT. */
e610eaca 3141 specbind (next, arg);
db9f0278 3142 }
db9f0278
JB
3143 }
3144
9ab90667 3145 if (!NILP (syms_left))
734d55a2 3146 xsignal1 (Qinvalid_function, fun);
9ab90667 3147 else if (i < nargs)
734d55a2 3148 xsignal2 (Qwrong_number_of_arguments, fun, make_number (nargs));
db9f0278 3149
b9598260
SM
3150 if (!EQ (lexenv, Vinternal_interpreter_environment))
3151 /* Instantiate a new lexical environment. */
3152 specbind (Qinternal_interpreter_environment, lexenv);
3153
90165123 3154 if (CONSP (fun))
9ab90667 3155 val = Fprogn (XCDR (XCDR (fun)));
db9f0278 3156 else
ca248607
RS
3157 {
3158 /* If we have not actually read the bytecode string
3159 and constants vector yet, fetch them from the file. */
845975f5 3160 if (CONSP (AREF (fun, COMPILED_BYTECODE)))
661c7d6e 3161 Ffetch_bytecode (fun);
b9598260
SM
3162 val = exec_byte_code (AREF (fun, COMPILED_BYTECODE),
3163 AREF (fun, COMPILED_CONSTANTS),
3164 AREF (fun, COMPILED_STACK_DEPTH),
3165 Qnil, 0, 0);
ca248607 3166 }
177c0ea7 3167
3200038e
BT
3168 dynwind_end ();
3169 return val;
db9f0278 3170}
661c7d6e
KH
3171
3172DEFUN ("fetch-bytecode", Ffetch_bytecode, Sfetch_bytecode,
9dbc9081
PJ
3173 1, 1, 0,
3174 doc: /* If byte-compiled OBJECT is lazy-loaded, fetch it now. */)
5842a27b 3175 (Lisp_Object object)
661c7d6e
KH
3176{
3177 Lisp_Object tem;
3178
845975f5 3179 if (COMPILEDP (object) && CONSP (AREF (object, COMPILED_BYTECODE)))
661c7d6e 3180 {
845975f5 3181 tem = read_doc_string (AREF (object, COMPILED_BYTECODE));
5bbdb090 3182 if (!CONSP (tem))
845975f5
SM
3183 {
3184 tem = AREF (object, COMPILED_BYTECODE);
3185 if (CONSP (tem) && STRINGP (XCAR (tem)))
d5db4077 3186 error ("Invalid byte code in %s", SDATA (XCAR (tem)));
845975f5
SM
3187 else
3188 error ("Invalid byte code");
3189 }
3ae565b3
SM
3190 ASET (object, COMPILED_BYTECODE, XCAR (tem));
3191 ASET (object, COMPILED_CONSTANTS, XCDR (tem));
661c7d6e
KH
3192 }
3193 return object;
3194}
db9f0278 3195\f
2f592f95
SM
3196/* Return true if SYMBOL currently has a let-binding
3197 which was made in the buffer that is now current. */
3198
3199bool
3200let_shadows_buffer_binding_p (struct Lisp_Symbol *symbol)
db9f0278 3201{
9349e5f7 3202 union specbinding *p;
2f592f95
SM
3203 Lisp_Object buf = Fcurrent_buffer ();
3204
3205 for (p = specpdl_ptr; p > specpdl; )
3206 if ((--p)->kind > SPECPDL_LET)
3207 {
3208 struct Lisp_Symbol *let_bound_symbol = XSYMBOL (specpdl_symbol (p));
3209 eassert (let_bound_symbol->redirect != SYMBOL_VARALIAS);
3210 if (symbol == let_bound_symbol
3211 && EQ (specpdl_where (p), buf))
3212 return 1;
3213 }
3214
3215 return 0;
3216}
3217
3218bool
3219let_shadows_global_binding_p (Lisp_Object symbol)
3220{
9349e5f7 3221 union specbinding *p;
2f592f95
SM
3222
3223 for (p = specpdl_ptr; p > specpdl; )
3224 if ((--p)->kind >= SPECPDL_LET && EQ (specpdl_symbol (p), symbol))
3225 return 1;
3226
3227 return 0;
db9f0278
JB
3228}
3229
3ec7babc 3230/* `specpdl_ptr' describes which variable is
4e2db1fe 3231 let-bound, so it can be properly undone when we unbind_to.
3ec7babc
SM
3232 It can be either a plain SPECPDL_LET or a SPECPDL_LET_LOCAL/DEFAULT.
3233 - SYMBOL is the variable being bound. Note that it should not be
4e2db1fe
SM
3234 aliased (i.e. when let-binding V1 that's aliased to V2, we want
3235 to record V2 here).
3ec7babc
SM
3236 - WHERE tells us in which buffer the binding took place.
3237 This is used for SPECPDL_LET_LOCAL bindings (i.e. bindings to a
3238 buffer-local variable) as well as for SPECPDL_LET_DEFAULT bindings,
3239 i.e. bindings to the default value of a variable which can be
3240 buffer-local. */
4e2db1fe 3241
db9f0278 3242void
d3da34e0 3243specbind (Lisp_Object symbol, Lisp_Object value)
db9f0278 3244{
ce5b453a
SM
3245 struct Lisp_Symbol *sym;
3246
b7826503 3247 CHECK_SYMBOL (symbol);
ce5b453a 3248 sym = XSYMBOL (symbol);
719177b3 3249
ce5b453a
SM
3250 start:
3251 switch (sym->redirect)
719177b3 3252 {
ce5b453a
SM
3253 case SYMBOL_VARALIAS:
3254 sym = indirect_variable (sym); XSETSYMBOL (symbol, sym); goto start;
3255 case SYMBOL_PLAINVAL:
bb8e180f
AS
3256 /* The most common case is that of a non-constant symbol with a
3257 trivial value. Make that as fast as we can. */
9349e5f7
PE
3258 specpdl_ptr->let.kind = SPECPDL_LET;
3259 specpdl_ptr->let.symbol = symbol;
3260 specpdl_ptr->let.old_value = SYMBOL_VAL (sym);
5e301d76 3261 grow_specpdl ();
bb8e180f
AS
3262 if (!sym->constant)
3263 SET_SYMBOL_VAL (sym, value);
3264 else
3265 set_internal (symbol, value, Qnil, 1);
3266 break;
4e2db1fe
SM
3267 case SYMBOL_LOCALIZED:
3268 if (SYMBOL_BLV (sym)->frame_local)
3269 error ("Frame-local vars cannot be let-bound");
3270 case SYMBOL_FORWARDED:
ce5b453a
SM
3271 {
3272 Lisp_Object ovalue = find_symbol_value (symbol);
9349e5f7
PE
3273 specpdl_ptr->let.kind = SPECPDL_LET_LOCAL;
3274 specpdl_ptr->let.symbol = symbol;
3275 specpdl_ptr->let.old_value = ovalue;
3276 specpdl_ptr->let.where = Fcurrent_buffer ();
ce5b453a
SM
3277
3278 eassert (sym->redirect != SYMBOL_LOCALIZED
2f592f95 3279 || (EQ (SYMBOL_BLV (sym)->where, Fcurrent_buffer ())));
ce5b453a 3280
2f592f95
SM
3281 if (sym->redirect == SYMBOL_LOCALIZED)
3282 {
3283 if (!blv_found (SYMBOL_BLV (sym)))
9349e5f7 3284 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
2f592f95
SM
3285 }
3286 else if (BUFFER_OBJFWDP (SYMBOL_FWD (sym)))
ce5b453a 3287 {
ce5b453a
SM
3288 /* If SYMBOL is a per-buffer variable which doesn't have a
3289 buffer-local value here, make the `let' change the global
3290 value by changing the value of SYMBOL in all buffers not
3291 having their own value. This is consistent with what
3292 happens with other buffer-local variables. */
2f592f95 3293 if (NILP (Flocal_variable_p (symbol, Qnil)))
ce5b453a 3294 {
9349e5f7 3295 specpdl_ptr->let.kind = SPECPDL_LET_DEFAULT;
5e301d76 3296 grow_specpdl ();
ce5b453a 3297 Fset_default (symbol, value);
316bec86 3298 goto done;
ce5b453a
SM
3299 }
3300 }
3301 else
9349e5f7 3302 specpdl_ptr->let.kind = SPECPDL_LET;
ce5b453a 3303
5e301d76 3304 grow_specpdl ();
94b612ad 3305 set_internal (symbol, value, Qnil, 1);
ce5b453a
SM
3306 break;
3307 }
1088b922 3308 default: emacs_abort ();
9ab90667 3309 }
316bec86
BT
3310
3311 done:
3312 scm_dynwind_unwind_handler (unbind_once, NULL, SCM_F_WIND_EXPLICITLY);
db9f0278
JB
3313}
3314
f4b1eb36
PE
3315/* Push unwind-protect entries of various types. */
3316
db9f0278 3317void
e1ad689c
BT
3318record_unwind_protect_1 (void (*function) (Lisp_Object), Lisp_Object arg,
3319 bool wind_explicitly)
db9f0278 3320{
316bec86 3321 record_unwind_protect_ptr_1 (function, arg, wind_explicitly);
db9f0278
JB
3322}
3323
27e498e6 3324void
e1ad689c 3325record_unwind_protect (void (*function) (Lisp_Object), Lisp_Object arg)
27e498e6 3326{
e1ad689c 3327 record_unwind_protect_1 (function, arg, true);
27e498e6
PE
3328}
3329
3330void
e1ad689c
BT
3331record_unwind_protect_ptr_1 (void (*function) (void *), void *arg,
3332 bool wind_explicitly)
27e498e6 3333{
316bec86
BT
3334 scm_dynwind_unwind_handler (function,
3335 arg,
3336 (wind_explicitly
3337 ? SCM_F_WIND_EXPLICITLY
3338 : 0));
27e498e6
PE
3339}
3340
3341void
e1ad689c 3342record_unwind_protect_ptr (void (*function) (void *), void *arg)
27e498e6 3343{
e1ad689c 3344 record_unwind_protect_ptr_1 (function, arg, true);
27e498e6
PE
3345}
3346
f4b1eb36 3347void
e1ad689c
BT
3348record_unwind_protect_int_1 (void (*function) (int), int arg,
3349 bool wind_explicitly)
f4b1eb36 3350{
316bec86 3351 record_unwind_protect_ptr_1 (function, arg, wind_explicitly);
f4b1eb36
PE
3352}
3353
a0931322 3354void
e1ad689c 3355record_unwind_protect_int (void (*function) (int), int arg)
a0931322 3356{
e1ad689c 3357 record_unwind_protect_int_1 (function, arg, true);
a0931322
PE
3358}
3359
316bec86
BT
3360static void
3361call_void (void *data)
3362{
3363 ((void (*) (void)) data) ();
3364}
3365
94fcd171 3366void
e1ad689c
BT
3367record_unwind_protect_void_1 (void (*function) (void),
3368 bool wind_explicitly)
94fcd171 3369{
316bec86 3370 record_unwind_protect_ptr_1 (call_void, function, wind_explicitly);
94fcd171
PE
3371}
3372
a0931322 3373void
e1ad689c 3374record_unwind_protect_void (void (*function) (void))
a0931322 3375{
e1ad689c 3376 record_unwind_protect_void_1 (function, true);
a0931322
PE
3377}
3378
316bec86
BT
3379static void
3380unbind_once (void *ignore)
c26b5ed1
BT
3381{
3382 /* Decrement specpdl_ptr before we do the work to unbind it, so
3383 that an error in unbinding won't try to unbind the same entry
3384 again. Take care to copy any parts of the binding needed
3385 before invoking any code that can make more bindings. */
3386
3387 specpdl_ptr--;
3388
3389 switch (specpdl_ptr->kind)
3390 {
c26b5ed1
BT
3391 case SPECPDL_BACKTRACE:
3392 break;
3393 case SPECPDL_LET:
3394 { /* If variable has a trivial value (no forwarding), we can
3395 just set it. No need to check for constant symbols here,
3396 since that was already done by specbind. */
3397 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (specpdl_ptr));
3398 if (sym->redirect == SYMBOL_PLAINVAL)
3399 {
3400 SET_SYMBOL_VAL (sym, specpdl_old_value (specpdl_ptr));
3401 break;
3402 }
3403 else
3404 { /* FALLTHROUGH!!
3405 NOTE: we only ever come here if make_local_foo was used for
3406 the first time on this var within this let. */
3407 }
3408 }
3409 case SPECPDL_LET_DEFAULT:
3410 Fset_default (specpdl_symbol (specpdl_ptr),
3411 specpdl_old_value (specpdl_ptr));
3412 break;
3413 case SPECPDL_LET_LOCAL:
3414 {
3415 Lisp_Object symbol = specpdl_symbol (specpdl_ptr);
3416 Lisp_Object where = specpdl_where (specpdl_ptr);
3417 Lisp_Object old_value = specpdl_old_value (specpdl_ptr);
3418 eassert (BUFFERP (where));
3419
3420 /* If this was a local binding, reset the value in the appropriate
3421 buffer, but only if that buffer's binding still exists. */
3422 if (!NILP (Flocal_variable_p (symbol, where)))
3423 set_internal (symbol, old_value, where, 1);
3424 }
3425 break;
3426 }
3427}
3428
e1ad689c
BT
3429void
3430dynwind_begin (void)
3431{
316bec86 3432 scm_dynwind_begin (0);
e1ad689c 3433}
f4b1eb36 3434
e1ad689c
BT
3435void
3436dynwind_end (void)
3437{
316bec86 3438 scm_dynwind_end ();
e1ad689c
BT
3439}
3440
4a330052 3441DEFUN ("special-variable-p", Fspecial_variable_p, Sspecial_variable_p, 1, 1, 0,
b9598260
SM
3442 doc: /* Return non-nil if SYMBOL's global binding has been declared special.
3443A special variable is one that will be bound dynamically, even in a
3444context where binding is lexical by default. */)
c566235d 3445 (Lisp_Object symbol)
b9598260
SM
3446{
3447 CHECK_SYMBOL (symbol);
3448 return XSYMBOL (symbol)->declared_special ? Qt : Qnil;
3449}
3450
db9f0278 3451\f
db9f0278 3452DEFUN ("backtrace-debug", Fbacktrace_debug, Sbacktrace_debug, 2, 2, 0,
9dbc9081
PJ
3453 doc: /* Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
3454The debugger is entered when that frame exits, if the flag is non-nil. */)
5842a27b 3455 (Lisp_Object level, Lisp_Object flag)
db9f0278 3456{
9349e5f7 3457 union specbinding *pdl = backtrace_top ();
d311d28c 3458 register EMACS_INT i;
db9f0278 3459
b7826503 3460 CHECK_NUMBER (level);
db9f0278 3461
2f592f95
SM
3462 for (i = 0; backtrace_p (pdl) && i < XINT (level); i++)
3463 pdl = backtrace_next (pdl);
db9f0278 3464
2f592f95
SM
3465 if (backtrace_p (pdl))
3466 set_backtrace_debug_on_exit (pdl, !NILP (flag));
db9f0278
JB
3467
3468 return flag;
3469}
3470
3471DEFUN ("backtrace", Fbacktrace, Sbacktrace, 0, 0, "",
9dbc9081
PJ
3472 doc: /* Print a trace of Lisp function calls currently active.
3473Output stream used is value of `standard-output'. */)
5842a27b 3474 (void)
db9f0278 3475{
9349e5f7 3476 union specbinding *pdl = backtrace_top ();
db9f0278 3477 Lisp_Object tem;
d4b6d95d 3478 Lisp_Object old_print_level = Vprint_level;
db9f0278 3479
d4b6d95d
LMI
3480 if (NILP (Vprint_level))
3481 XSETFASTINT (Vprint_level, 8);
db9f0278 3482
2f592f95 3483 while (backtrace_p (pdl))
db9f0278 3484 {
2f592f95
SM
3485 write_string (backtrace_debug_on_exit (pdl) ? "* " : " ", 2);
3486 if (backtrace_nargs (pdl) == UNEVALLED)
db9f0278 3487 {
2f592f95
SM
3488 Fprin1 (Fcons (backtrace_function (pdl), *backtrace_args (pdl)),
3489 Qnil);
b6703b02 3490 write_string ("\n", -1);
db9f0278
JB
3491 }
3492 else
3493 {
2f592f95 3494 tem = backtrace_function (pdl);
f6d62986 3495 Fprin1 (tem, Qnil); /* This can QUIT. */
db9f0278 3496 write_string ("(", -1);
2f592f95
SM
3497 {
3498 ptrdiff_t i;
3499 for (i = 0; i < backtrace_nargs (pdl); i++)
3500 {
3501 if (i) write_string (" ", -1);
3502 Fprin1 (backtrace_args (pdl)[i], Qnil);
3503 }
3504 }
b6703b02 3505 write_string (")\n", -1);
db9f0278 3506 }
2f592f95 3507 pdl = backtrace_next (pdl);
db9f0278
JB
3508 }
3509
d4b6d95d 3510 Vprint_level = old_print_level;
db9f0278
JB
3511 return Qnil;
3512}
3513
d5a7a9d9 3514static union specbinding *
56ea7291
SM
3515get_backtrace_frame (Lisp_Object nframes, Lisp_Object base)
3516{
3517 union specbinding *pdl = backtrace_top ();
3518 register EMACS_INT i;
3519
3520 CHECK_NATNUM (nframes);
3521
3522 if (!NILP (base))
3523 { /* Skip up to `base'. */
3524 base = Findirect_function (base, Qt);
3525 while (backtrace_p (pdl)
3526 && !EQ (base, Findirect_function (backtrace_function (pdl), Qt)))
3527 pdl = backtrace_next (pdl);
3528 }
3529
3530 /* Find the frame requested. */
3531 for (i = XFASTINT (nframes); i > 0 && backtrace_p (pdl); i--)
3532 pdl = backtrace_next (pdl);
3533
3534 return pdl;
3535}
3536
3537DEFUN ("backtrace-frame", Fbacktrace_frame, Sbacktrace_frame, 1, 2, NULL,
9dbc9081
PJ
3538 doc: /* Return the function and arguments NFRAMES up from current execution point.
3539If that frame has not evaluated the arguments yet (or is a special form),
3540the value is (nil FUNCTION ARG-FORMS...).
3541If that frame has evaluated its arguments and called its function already,
3542the value is (t FUNCTION ARG-VALUES...).
3543A &rest arg is represented as the tail of the list ARG-VALUES.
3544FUNCTION is whatever was supplied as car of evaluated list,
3545or a lambda expression for macro calls.
56ea7291
SM
3546If NFRAMES is more than the number of frames, the value is nil.
3547If BASE is non-nil, it should be a function and NFRAMES counts from its
3548nearest activation frame. */)
3549 (Lisp_Object nframes, Lisp_Object base)
db9f0278 3550{
56ea7291 3551 union specbinding *pdl = get_backtrace_frame (nframes, base);
db9f0278 3552
2f592f95 3553 if (!backtrace_p (pdl))
db9f0278 3554 return Qnil;
2f592f95
SM
3555 if (backtrace_nargs (pdl) == UNEVALLED)
3556 return Fcons (Qnil,
3557 Fcons (backtrace_function (pdl), *backtrace_args (pdl)));
db9f0278
JB
3558 else
3559 {
2f592f95 3560 Lisp_Object tem = Flist (backtrace_nargs (pdl), backtrace_args (pdl));
db9f0278 3561
2f592f95 3562 return Fcons (Qt, Fcons (backtrace_function (pdl), tem));
db9f0278
JB
3563 }
3564}
a2ff3819 3565
56ea7291
SM
3566/* For backtrace-eval, we want to temporarily unwind the last few elements of
3567 the specpdl stack, and then rewind them. We store the pre-unwind values
3568 directly in the pre-existing specpdl elements (i.e. we swap the current
3569 value and the old value stored in the specpdl), kind of like the inplace
3570 pointer-reversal trick. As it turns out, the rewind does the same as the
94fea300 3571 unwind, except it starts from the other end of the specpdl stack, so we use
56ea7291 3572 the same function for both unwind and rewind. */
d5a7a9d9 3573static void
56ea7291
SM
3574backtrace_eval_unrewind (int distance)
3575{
3576 union specbinding *tmp = specpdl_ptr;
3577 int step = -1;
3578 if (distance < 0)
3579 { /* It's a rewind rather than unwind. */
3580 tmp += distance - 1;
3581 step = 1;
3582 distance = -distance;
3583 }
3584
3585 for (; distance > 0; distance--)
3586 {
3587 tmp += step;
3588 /* */
3589 switch (tmp->kind)
3590 {
56ea7291
SM
3591 case SPECPDL_BACKTRACE:
3592 break;
3593 case SPECPDL_LET:
a104f656
SM
3594 { /* If variable has a trivial value (no forwarding), we can
3595 just set it. No need to check for constant symbols here,
3596 since that was already done by specbind. */
3597 struct Lisp_Symbol *sym = XSYMBOL (specpdl_symbol (tmp));
3598 if (sym->redirect == SYMBOL_PLAINVAL)
3599 {
3600 Lisp_Object old_value = specpdl_old_value (tmp);
3601 set_specpdl_old_value (tmp, SYMBOL_VAL (sym));
3602 SET_SYMBOL_VAL (sym, old_value);
3603 break;
3604 }
3605 else
3606 { /* FALLTHROUGH!!
3607 NOTE: we only ever come here if make_local_foo was used for
3608 the first time on this var within this let. */
3609 }
3610 }
56ea7291
SM
3611 case SPECPDL_LET_DEFAULT:
3612 {
3613 Lisp_Object sym = specpdl_symbol (tmp);
3614 Lisp_Object old_value = specpdl_old_value (tmp);
3615 set_specpdl_old_value (tmp, Fdefault_value (sym));
3616 Fset_default (sym, old_value);
3617 }
3618 break;
3619 case SPECPDL_LET_LOCAL:
3620 {
3621 Lisp_Object symbol = specpdl_symbol (tmp);
3622 Lisp_Object where = specpdl_where (tmp);
3623 Lisp_Object old_value = specpdl_old_value (tmp);
3624 eassert (BUFFERP (where));
3625
3626 /* If this was a local binding, reset the value in the appropriate
3627 buffer, but only if that buffer's binding still exists. */
3628 if (!NILP (Flocal_variable_p (symbol, where)))
3629 {
3630 set_specpdl_old_value
3631 (tmp, Fbuffer_local_value (symbol, where));
3632 set_internal (symbol, old_value, where, 1);
3633 }
3634 }
3635 break;
3636 }
3637 }
3638}
3639
3640DEFUN ("backtrace-eval", Fbacktrace_eval, Sbacktrace_eval, 2, 3, NULL,
3641 doc: /* Evaluate EXP in the context of some activation frame.
3642NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3643 (Lisp_Object exp, Lisp_Object nframes, Lisp_Object base)
3644{
3645 union specbinding *pdl = get_backtrace_frame (nframes, base);
3200038e 3646 dynwind_begin ();
56ea7291
SM
3647 ptrdiff_t distance = specpdl_ptr - pdl;
3648 eassert (distance >= 0);
3649
3650 if (!backtrace_p (pdl))
3651 error ("Activation frame not found!");
3652
3653 backtrace_eval_unrewind (distance);
3654 record_unwind_protect_int (backtrace_eval_unrewind, -distance);
3655
3656 /* Use eval_sub rather than Feval since the main motivation behind
3657 backtrace-eval is to be able to get/set the value of lexical variables
3658 from the debugger. */
3200038e
BT
3659 Lisp_Object tem1 = eval_sub (exp);
3660 dynwind_end ();
3661 return tem1;
56ea7291 3662}
f345395c
HE
3663
3664DEFUN ("backtrace--locals", Fbacktrace__locals, Sbacktrace__locals, 1, 2, NULL,
3665 doc: /* Return names and values of local variables of a stack frame.
3666NFRAMES and BASE specify the activation frame to use, as in `backtrace-frame'. */)
3667 (Lisp_Object nframes, Lisp_Object base)
3668{
3669 union specbinding *frame = get_backtrace_frame (nframes, base);
3670 union specbinding *prevframe
3671 = get_backtrace_frame (make_number (XFASTINT (nframes) - 1), base);
3672 ptrdiff_t distance = specpdl_ptr - frame;
3673 Lisp_Object result = Qnil;
3674 eassert (distance >= 0);
3675
3676 if (!backtrace_p (prevframe))
3677 error ("Activation frame not found!");
3678 if (!backtrace_p (frame))
3679 error ("Activation frame not found!");
3680
3681 /* The specpdl entries normally contain the symbol being bound along with its
3682 `old_value', so it can be restored. The new value to which it is bound is
3683 available in one of two places: either in the current value of the
09a7c0fe 3684 variable (if it hasn't been rebound yet) or in the `old_value' slot of the
f345395c
HE
3685 next specpdl entry for it.
3686 `backtrace_eval_unrewind' happens to swap the role of `old_value'
3687 and "new value", so we abuse it here, to fetch the new value.
3688 It's ugly (we'd rather not modify global data) and a bit inefficient,
3689 but it does the job for now. */
3690 backtrace_eval_unrewind (distance);
3691
3692 /* Grab values. */
3693 {
3694 union specbinding *tmp = prevframe;
3695 for (; tmp > frame; tmp--)
3696 {
3697 switch (tmp->kind)
3698 {
3699 case SPECPDL_LET:
3700 case SPECPDL_LET_DEFAULT:
3701 case SPECPDL_LET_LOCAL:
3702 {
3703 Lisp_Object sym = specpdl_symbol (tmp);
3704 Lisp_Object val = specpdl_old_value (tmp);
3705 if (EQ (sym, Qinternal_interpreter_environment))
3706 {
3707 Lisp_Object env = val;
3708 for (; CONSP (env); env = XCDR (env))
3709 {
3710 Lisp_Object binding = XCAR (env);
3711 if (CONSP (binding))
3712 result = Fcons (Fcons (XCAR (binding),
3713 XCDR (binding)),
3714 result);
3715 }
3716 }
3717 else
3718 result = Fcons (Fcons (sym, val), result);
3719 }
3720 }
3721 }
3722 }
3723
3724 /* Restore values from specpdl to original place. */
3725 backtrace_eval_unrewind (-distance);
3726
3727 return result;
3728}
3729
db9f0278 3730\f
2f592f95
SM
3731void
3732get_backtrace (Lisp_Object array)
3733{
9349e5f7 3734 union specbinding *pdl = backtrace_next (backtrace_top ());
2f592f95 3735 ptrdiff_t i = 0, asize = ASIZE (array);
4ce0541e 3736
2f592f95
SM
3737 /* Copy the backtrace contents into working memory. */
3738 for (; i < asize; i++)
3739 {
3740 if (backtrace_p (pdl))
3741 {
3742 ASET (array, i, backtrace_function (pdl));
3743 pdl = backtrace_next (pdl);
3744 }
4ce0541e 3745 else
2f592f95 3746 ASET (array, i, Qnil);
4ce0541e
SM
3747 }
3748}
2f592f95
SM
3749
3750Lisp_Object backtrace_top_function (void)
3751{
9349e5f7 3752 union specbinding *pdl = backtrace_top ();
2f592f95
SM
3753 return (backtrace_p (pdl) ? backtrace_function (pdl) : Qnil);
3754}
316bec86
BT
3755\f
3756_Noreturn SCM
3757abort_to_prompt (SCM tag, SCM arglst)
3758{
3759 static SCM var = SCM_UNDEFINED;
3760 if (SCM_UNBNDP (var))
3761 var = scm_c_public_lookup ("guile", "abort-to-prompt");
4ce0541e 3762
316bec86
BT
3763 scm_apply_1 (scm_variable_ref (var), tag, arglst);
3764 emacs_abort ();
3765}
3766
3767SCM
3768call_with_prompt (SCM tag, SCM thunk, SCM handler)
3769{
3770 static SCM var = SCM_UNDEFINED;
3771 if (SCM_UNBNDP (var))
3772 var = scm_c_public_lookup ("guile", "call-with-prompt");
3773
3774 return scm_call_3 (scm_variable_ref (var), tag, thunk, handler);
3775}
3776
3777SCM
3778make_prompt_tag (void)
3779{
3780 static SCM var = SCM_UNDEFINED;
3781 if (SCM_UNBNDP (var))
3782 var = scm_c_public_lookup ("guile", "make-prompt-tag");
3783
3784 return scm_call_0 (scm_variable_ref (var));
3785}
3786\f
dfcf069d 3787void
d3da34e0 3788syms_of_eval (void)
db9f0278 3789{
172a66a1
BT
3790#include "eval.x"
3791
29208e82 3792 DEFVAR_INT ("max-specpdl-size", max_specpdl_size,
fb7ada5f 3793 doc: /* Limit on number of Lisp variable bindings and `unwind-protect's.
9f5903bb 3794If Lisp code tries to increase the total number past this amount,
2520dc0c
RS
3795an error is signaled.
3796You can safely use a value considerably larger than the default value,
3797if that proves inconveniently small. However, if you increase it too far,
575593db
DA
3798Emacs could run out of memory trying to make the stack bigger.
3799Note that this limit may be silently increased by the debugger
3800if `debug-on-error' or `debug-on-quit' is set. */);
db9f0278 3801
29208e82 3802 DEFVAR_INT ("max-lisp-eval-depth", max_lisp_eval_depth,
fb7ada5f 3803 doc: /* Limit on depth in `eval', `apply' and `funcall' before error.
2520dc0c
RS
3804
3805This limit serves to catch infinite recursions for you before they cause
9dbc9081
PJ
3806actual stack overflow in C, which would be fatal for Emacs.
3807You can safely make it considerably larger than its default value,
2520dc0c
RS
3808if that proves inconveniently small. However, if you increase it too far,
3809Emacs could overflow the real C stack, and crash. */);
db9f0278 3810
29208e82 3811 DEFVAR_LISP ("quit-flag", Vquit_flag,
9dbc9081 3812 doc: /* Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
42ed718e
RS
3813If the value is t, that means do an ordinary quit.
3814If the value equals `throw-on-input', that means quit by throwing
3815to the tag specified in `throw-on-input'; it's for handling `while-no-input'.
3816Typing C-g sets `quit-flag' to t, regardless of `inhibit-quit',
3817but `inhibit-quit' non-nil prevents anything from taking notice of that. */);
db9f0278
JB
3818 Vquit_flag = Qnil;
3819
29208e82 3820 DEFVAR_LISP ("inhibit-quit", Vinhibit_quit,
9dbc9081
PJ
3821 doc: /* Non-nil inhibits C-g quitting from happening immediately.
3822Note that `quit-flag' will still be set by typing C-g,
3823so a quit will be signaled as soon as `inhibit-quit' is nil.
3824To prevent this happening, set `quit-flag' to nil
3825before making `inhibit-quit' nil. */);
db9f0278
JB
3826 Vinhibit_quit = Qnil;
3827
cd3520a4
JB
3828 DEFSYM (Qinhibit_quit, "inhibit-quit");
3829 DEFSYM (Qautoload, "autoload");
45b82ad0 3830 DEFSYM (Qinhibit_debugger, "inhibit-debugger");
cd3520a4
JB
3831 DEFSYM (Qmacro, "macro");
3832 DEFSYM (Qdeclare, "declare");
177c0ea7 3833
db9f0278
JB
3834 /* Note that the process handling also uses Qexit, but we don't want
3835 to staticpro it twice, so we just do it here. */
cd3520a4 3836 DEFSYM (Qexit, "exit");
b9598260 3837
cd3520a4
JB
3838 DEFSYM (Qinteractive, "interactive");
3839 DEFSYM (Qcommandp, "commandp");
cd3520a4
JB
3840 DEFSYM (Qand_rest, "&rest");
3841 DEFSYM (Qand_optional, "&optional");
3842 DEFSYM (Qclosure, "closure");
3843 DEFSYM (Qdebug, "debug");
f01cbfdd 3844
45b82ad0
SM
3845 DEFVAR_LISP ("inhibit-debugger", Vinhibit_debugger,
3846 doc: /* Non-nil means never enter the debugger.
3847Normally set while the debugger is already active, to avoid recursive
3848invocations. */);
3849 Vinhibit_debugger = Qnil;
3850
29208e82 3851 DEFVAR_LISP ("debug-on-error", Vdebug_on_error,
fb7ada5f 3852 doc: /* Non-nil means enter debugger if an error is signaled.
9dbc9081
PJ
3853Does not apply to errors handled by `condition-case' or those
3854matched by `debug-ignored-errors'.
3855If the value is a list, an error only means to enter the debugger
3856if one of its condition symbols appears in the list.
3857When you evaluate an expression interactively, this variable
3858is temporarily non-nil if `eval-expression-debug-on-error' is non-nil.
fbbdcf2f 3859The command `toggle-debug-on-error' toggles this.
45b82ad0 3860See also the variable `debug-on-quit' and `inhibit-debugger'. */);
128c0f66 3861 Vdebug_on_error = Qnil;
db9f0278 3862
29208e82 3863 DEFVAR_LISP ("debug-ignored-errors", Vdebug_ignored_errors,
fb7ada5f 3864 doc: /* List of errors for which the debugger should not be called.
9dbc9081
PJ
3865Each element may be a condition-name or a regexp that matches error messages.
3866If any element applies to a given error, that error skips the debugger
3867and just returns to top level.
3868This overrides the variable `debug-on-error'.
3869It does not apply to errors handled by `condition-case'. */);
fc950e09
KH
3870 Vdebug_ignored_errors = Qnil;
3871
29208e82 3872 DEFVAR_BOOL ("debug-on-quit", debug_on_quit,
fb7ada5f 3873 doc: /* Non-nil means enter debugger if quit is signaled (C-g, for example).
82fc29a1 3874Does not apply if quit is handled by a `condition-case'. */);
db9f0278
JB
3875 debug_on_quit = 0;
3876
29208e82 3877 DEFVAR_BOOL ("debug-on-next-call", debug_on_next_call,
9dbc9081 3878 doc: /* Non-nil means enter debugger before next `eval', `apply' or `funcall'. */);
db9f0278 3879
29208e82 3880 DEFVAR_BOOL ("debugger-may-continue", debugger_may_continue,
9dbc9081
PJ
3881 doc: /* Non-nil means debugger may continue execution.
3882This is nil when the debugger is called under circumstances where it
3883might not be safe to continue. */);
dac204bc 3884 debugger_may_continue = 1;
556d7314 3885
29208e82 3886 DEFVAR_LISP ("debugger", Vdebugger,
9dbc9081
PJ
3887 doc: /* Function to call to invoke debugger.
3888If due to frame exit, args are `exit' and the value being returned;
3889 this function's value will be returned instead of that.
3890If due to error, args are `error' and a list of the args to `signal'.
3891If due to `apply' or `funcall' entry, one arg, `lambda'.
3892If due to `eval' entry, one arg, t. */);
db9f0278
JB
3893 Vdebugger = Qnil;
3894
29208e82 3895 DEFVAR_LISP ("signal-hook-function", Vsignal_hook_function,
9dbc9081
PJ
3896 doc: /* If non-nil, this is a function for `signal' to call.
3897It receives the same arguments that `signal' was given.
3898The Edebug package uses this to regain control. */);
61ede770
RS
3899 Vsignal_hook_function = Qnil;
3900
29208e82 3901 DEFVAR_LISP ("debug-on-signal", Vdebug_on_signal,
fb7ada5f 3902 doc: /* Non-nil means call the debugger regardless of condition handlers.
9dbc9081
PJ
3903Note that `debug-on-error', `debug-on-quit' and friends
3904still determine whether to handle the particular condition. */);
57a6e758 3905 Vdebug_on_signal = Qnil;
61ede770 3906
b38b1ec0 3907 /* When lexical binding is being used,
61b108cc 3908 Vinternal_interpreter_environment is non-nil, and contains an alist
b38b1ec0
SM
3909 of lexically-bound variable, or (t), indicating an empty
3910 environment. The lisp name of this variable would be
3911 `internal-interpreter-environment' if it weren't hidden.
3912 Every element of this list can be either a cons (VAR . VAL)
3913 specifying a lexical binding, or a single symbol VAR indicating
3914 that this variable should use dynamic scoping. */
61b108cc
SM
3915 DEFSYM (Qinternal_interpreter_environment,
3916 "internal-interpreter-environment");
b38b1ec0
SM
3917 DEFVAR_LISP ("internal-interpreter-environment",
3918 Vinternal_interpreter_environment,
b9598260
SM
3919 doc: /* If non-nil, the current lexical environment of the lisp interpreter.
3920When lexical binding is not being used, this variable is nil.
3921A value of `(t)' indicates an empty environment, otherwise it is an
3922alist of active lexical bindings. */);
3923 Vinternal_interpreter_environment = Qnil;
c80e3b4a 3924 /* Don't export this variable to Elisp, so no one can mess with it
b38b1ec0
SM
3925 (Just imagine if someone makes it buffer-local). */
3926 Funintern (Qinternal_interpreter_environment, Qnil);
b9598260 3927
cd3520a4 3928 DEFSYM (Vrun_hooks, "run-hooks");
db9f0278
JB
3929
3930 staticpro (&Vautoload_queue);
3931 Vautoload_queue = Qnil;
a2ff3819
GM
3932 staticpro (&Vsignaling_function);
3933 Vsignaling_function = Qnil;
db9f0278 3934
d1f55f16 3935 inhibit_lisp_code = Qnil;
db9f0278 3936}