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