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