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