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