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