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