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