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