Deprecate the ((lambda ...) ...) form.
[bpt/emacs.git] / doc / lispref / eval.texi
CommitLineData
b8d4c8d0
GM
1@c -*-texinfo-*-
2@c This is part of the GNU Emacs Lisp Reference Manual.
acaf905b 3@c Copyright (C) 1990-1994, 1998, 2001-2012 Free Software Foundation, Inc.
b8d4c8d0 4@c See the file elisp.texi for copying conditions.
6336d8c3 5@setfilename ../../info/eval
b8d4c8d0
GM
6@node Evaluation, Control Structures, Symbols, Top
7@chapter Evaluation
8@cindex evaluation
9@cindex interpreter
10@cindex interpreter
11@cindex value of expression
12
13 The @dfn{evaluation} of expressions in Emacs Lisp is performed by the
14@dfn{Lisp interpreter}---a program that receives a Lisp object as input
15and computes its @dfn{value as an expression}. How it does this depends
16on the data type of the object, according to rules described in this
17chapter. The interpreter runs automatically to evaluate portions of
18your program, but can also be called explicitly via the Lisp primitive
19function @code{eval}.
20
21@ifnottex
22@menu
23* Intro Eval:: Evaluation in the scheme of things.
24* Forms:: How various sorts of objects are evaluated.
25* Quoting:: Avoiding evaluation (to put constants in the program).
03988c98 26* Backquote:: Easier construction of list structure.
b8d4c8d0
GM
27* Eval:: How to invoke the Lisp interpreter explicitly.
28@end menu
29
30@node Intro Eval
31@section Introduction to Evaluation
32
a5b99fab
CY
33 The Lisp interpreter, or evaluator, is the part of Emacs that
34computes the value of an expression that is given to it. When a
35function written in Lisp is called, the evaluator computes the value
36of the function by evaluating the expressions in the function body.
37Thus, running any Lisp program really means running the Lisp
38interpreter.
b8d4c8d0
GM
39@end ifnottex
40
a5b99fab 41@cindex form
b8d4c8d0 42@cindex expression
a037c171
CY
43@cindex S-expression
44 A Lisp object that is intended for evaluation is called a @dfn{form}
45or @dfn{expression}@footnote{It is sometimes also referred to as an
46@dfn{S-expression} or @dfn{sexp}, but we generally do not use this
47terminology in this manual.}. The fact that forms are data objects
48and not merely text is one of the fundamental differences between
49Lisp-like languages and typical programming languages. Any object can
50be evaluated, but in practice only numbers, symbols, lists and strings
51are evaluated very often.
b8d4c8d0 52
a5b99fab
CY
53 In subsequent sections, we will describe the details of what
54evaluation means for each kind of form.
55
56 It is very common to read a Lisp form and then evaluate the form,
57but reading and evaluation are separate activities, and either can be
58performed alone. Reading per se does not evaluate anything; it
59converts the printed representation of a Lisp object to the object
60itself. It is up to the caller of @code{read} to specify whether this
b8d4c8d0
GM
61object is a form to be evaluated, or serves some entirely different
62purpose. @xref{Input Functions}.
63
b8d4c8d0 64@cindex recursive evaluation
a5b99fab
CY
65 Evaluation is a recursive process, and evaluating a form often
66involves evaluating parts within that form. For instance, when you
67evaluate a @dfn{function call} form such as @code{(car x)}, Emacs
68first evaluates the argument (the subform @code{x}). After evaluating
69the argument, Emacs @dfn{executes} the function (@code{car}), and if
70the function is written in Lisp, execution works by evaluating the
31cbea1d
CY
71@dfn{body} of the function (in this example, however, @code{car} is
72not a Lisp function; it is a primitive function implemented in C).
a5b99fab
CY
73@xref{Functions}, for more information about functions and function
74calls.
b8d4c8d0
GM
75
76@cindex environment
a5b99fab
CY
77 Evaluation takes place in a context called the @dfn{environment},
78which consists of the current values and bindings of all Lisp
79variables (@pxref{Variables}).@footnote{This definition of
80``environment'' is specifically not intended to include all the data
81that can affect the result of a program.} Whenever a form refers to a
82variable without creating a new binding for it, the variable evaluates
83to the value given by the current environment. Evaluating a form may
31cbea1d
CY
84also temporarily alter the environment by binding variables
85(@pxref{Local Variables}).
b8d4c8d0
GM
86
87@cindex side effect
a5b99fab
CY
88 Evaluating a form may also make changes that persist; these changes
89are called @dfn{side effects}. An example of a form that produces a
90side effect is @code{(setq foo 1)}.
b8d4c8d0 91
a5b99fab
CY
92 Do not confuse evaluation with command key interpretation. The
93editor command loop translates keyboard input into a command (an
94interactively callable function) using the active keymaps, and then
95uses @code{call-interactively} to execute that command. Executing the
96command usually involves evaluation, if the command is written in
97Lisp; however, this step is not considered a part of command key
98interpretation. @xref{Command Loop}.
b8d4c8d0
GM
99
100@node Forms
101@section Kinds of Forms
102
a037c171
CY
103 A Lisp object that is intended to be evaluated is called a
104@dfn{form} (or an @dfn{expression}). How Emacs evaluates a form
105depends on its data type. Emacs has three different kinds of form
106that are evaluated differently: symbols, lists, and ``all other
16152b76 107types''. This section describes all three kinds, one by one, starting
a037c171 108with the ``all other types'' which are self-evaluating forms.
b8d4c8d0
GM
109
110@menu
111* Self-Evaluating Forms:: Forms that evaluate to themselves.
112* Symbol Forms:: Symbols evaluate as variables.
113* Classifying Lists:: How to distinguish various sorts of list forms.
114* Function Indirection:: When a symbol appears as the car of a list,
d24880de 115 we find the real function via the symbol.
b8d4c8d0
GM
116* Function Forms:: Forms that call functions.
117* Macro Forms:: Forms that call macros.
118* Special Forms:: "Special forms" are idiosyncratic primitives,
119 most of them extremely important.
120* Autoloading:: Functions set up to load files
121 containing their real definitions.
122@end menu
123
124@node Self-Evaluating Forms
125@subsection Self-Evaluating Forms
126@cindex vector evaluation
127@cindex literal evaluation
128@cindex self-evaluating form
129
a5b99fab
CY
130 A @dfn{self-evaluating form} is any form that is not a list or
131symbol. Self-evaluating forms evaluate to themselves: the result of
132evaluation is the same object that was evaluated. Thus, the number 25
133evaluates to 25, and the string @code{"foo"} evaluates to the string
134@code{"foo"}. Likewise, evaluating a vector does not cause evaluation
135of the elements of the vector---it returns the same vector with its
136contents unchanged.
b8d4c8d0
GM
137
138@example
139@group
140'123 ; @r{A number, shown without evaluation.}
141 @result{} 123
142@end group
143@group
144123 ; @r{Evaluated as usual---result is the same.}
145 @result{} 123
146@end group
147@group
148(eval '123) ; @r{Evaluated ``by hand''---result is the same.}
149 @result{} 123
150@end group
151@group
152(eval (eval '123)) ; @r{Evaluating twice changes nothing.}
153 @result{} 123
154@end group
155@end example
156
157 It is common to write numbers, characters, strings, and even vectors
158in Lisp code, taking advantage of the fact that they self-evaluate.
159However, it is quite unusual to do this for types that lack a read
160syntax, because there's no way to write them textually. It is possible
161to construct Lisp expressions containing these types by means of a Lisp
162program. Here is an example:
163
164@example
165@group
166;; @r{Build an expression containing a buffer object.}
167(setq print-exp (list 'print (current-buffer)))
168 @result{} (print #<buffer eval.texi>)
169@end group
170@group
171;; @r{Evaluate it.}
172(eval print-exp)
173 @print{} #<buffer eval.texi>
174 @result{} #<buffer eval.texi>
175@end group
176@end example
177
178@node Symbol Forms
179@subsection Symbol Forms
180@cindex symbol evaluation
181
182 When a symbol is evaluated, it is treated as a variable. The result
31cbea1d
CY
183is the variable's value, if it has one. If the symbol has no value as
184a variable, the Lisp interpreter signals an error. For more
185information on the use of variables, see @ref{Variables}.
b8d4c8d0
GM
186
187 In the following example, we set the value of a symbol with
188@code{setq}. Then we evaluate the symbol, and get back the value that
189@code{setq} stored.
190
191@example
192@group
193(setq a 123)
194 @result{} 123
195@end group
196@group
197(eval 'a)
198 @result{} 123
199@end group
200@group
201a
202 @result{} 123
203@end group
204@end example
205
206 The symbols @code{nil} and @code{t} are treated specially, so that the
207value of @code{nil} is always @code{nil}, and the value of @code{t} is
208always @code{t}; you cannot set or bind them to any other values. Thus,
209these two symbols act like self-evaluating forms, even though
210@code{eval} treats them like any other symbol. A symbol whose name
211starts with @samp{:} also self-evaluates in the same way; likewise,
212its value ordinarily cannot be changed. @xref{Constant Variables}.
213
214@node Classifying Lists
215@subsection Classification of List Forms
216@cindex list form evaluation
217
218 A form that is a nonempty list is either a function call, a macro
219call, or a special form, according to its first element. These three
220kinds of forms are evaluated in different ways, described below. The
221remaining list elements constitute the @dfn{arguments} for the function,
222macro, or special form.
223
224 The first step in evaluating a nonempty list is to examine its first
225element. This element alone determines what kind of form the list is
226and how the rest of the list is to be processed. The first element is
227@emph{not} evaluated, as it would be in some Lisp dialects such as
228Scheme.
229
230@node Function Indirection
231@subsection Symbol Function Indirection
232@cindex symbol function indirection
233@cindex indirection for functions
234@cindex void function
235
a5b99fab
CY
236 If the first element of the list is a symbol then evaluation
237examines the symbol's function cell, and uses its contents instead of
238the original symbol. If the contents are another symbol, this
239process, called @dfn{symbol function indirection}, is repeated until
240it obtains a non-symbol. @xref{Function Names}, for more information
241about symbol function indirection.
b8d4c8d0
GM
242
243 One possible consequence of this process is an infinite loop, in the
244event that a symbol's function cell refers to the same symbol. Or a
245symbol may have a void function cell, in which case the subroutine
246@code{symbol-function} signals a @code{void-function} error. But if
247neither of these things happens, we eventually obtain a non-symbol,
248which ought to be a function or other suitable object.
249
250@kindex invalid-function
251 More precisely, we should now have a Lisp function (a lambda
a5b99fab
CY
252expression), a byte-code function, a primitive function, a Lisp macro,
253a special form, or an autoload object. Each of these types is a case
254described in one of the following sections. If the object is not one
255of these types, Emacs signals an @code{invalid-function} error.
b8d4c8d0
GM
256
257 The following example illustrates the symbol indirection process. We
258use @code{fset} to set the function cell of a symbol and
259@code{symbol-function} to get the function cell contents
260(@pxref{Function Cells}). Specifically, we store the symbol @code{car}
261into the function cell of @code{first}, and the symbol @code{first} into
262the function cell of @code{erste}.
263
264@smallexample
265@group
266;; @r{Build this function cell linkage:}
267;; ------------- ----- ------- -------
268;; | #<subr car> | <-- | car | <-- | first | <-- | erste |
269;; ------------- ----- ------- -------
270@end group
271@end smallexample
272
273@smallexample
274@group
275(symbol-function 'car)
276 @result{} #<subr car>
277@end group
278@group
279(fset 'first 'car)
280 @result{} car
281@end group
282@group
283(fset 'erste 'first)
284 @result{} first
285@end group
286@group
287(erste '(1 2 3)) ; @r{Call the function referenced by @code{erste}.}
288 @result{} 1
289@end group
290@end smallexample
291
292 By contrast, the following example calls a function without any symbol
293function indirection, because the first element is an anonymous Lisp
294function, not a symbol.
295
296@smallexample
297@group
298((lambda (arg) (erste arg))
299 '(1 2 3))
300 @result{} 1
301@end group
302@end smallexample
303
304@noindent
305Executing the function itself evaluates its body; this does involve
306symbol function indirection when calling @code{erste}.
307
88ed9e87
SM
308 This form is rarely used and is now deprecated. Instead, you should write it
309as:
310
311@smallexample
312@group
313(funcall (lambda (arg) (erste arg))
314 '(1 2 3))
315@end group
316@end smallexample
317or just
318@smallexample
319@group
320(let ((arg '(1 2 3))) (erste arg))
321@end group
322@end smallexample
323
b8d4c8d0
GM
324 The built-in function @code{indirect-function} provides an easy way to
325perform symbol function indirection explicitly.
326
327@c Emacs 19 feature
328@defun indirect-function function &optional noerror
329@anchor{Definition of indirect-function}
330This function returns the meaning of @var{function} as a function. If
331@var{function} is a symbol, then it finds @var{function}'s function
332definition and starts over with that value. If @var{function} is not a
333symbol, then it returns @var{function} itself.
334
335This function signals a @code{void-function} error if the final symbol
336is unbound and optional argument @var{noerror} is @code{nil} or
337omitted. Otherwise, if @var{noerror} is non-@code{nil}, it returns
338@code{nil} if the final symbol is unbound.
339
340It signals a @code{cyclic-function-indirection} error if there is a
341loop in the chain of symbols.
342
343Here is how you could define @code{indirect-function} in Lisp:
344
345@smallexample
346(defun indirect-function (function)
347 (if (symbolp function)
348 (indirect-function (symbol-function function))
349 function))
350@end smallexample
351@end defun
352
353@node Function Forms
354@subsection Evaluation of Function Forms
355@cindex function form evaluation
356@cindex function call
357
358 If the first element of a list being evaluated is a Lisp function
359object, byte-code object or primitive function object, then that list is
360a @dfn{function call}. For example, here is a call to the function
361@code{+}:
362
363@example
364(+ 1 x)
365@end example
366
367 The first step in evaluating a function call is to evaluate the
368remaining elements of the list from left to right. The results are the
369actual argument values, one value for each list element. The next step
370is to call the function with this list of arguments, effectively using
371the function @code{apply} (@pxref{Calling Functions}). If the function
372is written in Lisp, the arguments are used to bind the argument
373variables of the function (@pxref{Lambda Expressions}); then the forms
374in the function body are evaluated in order, and the value of the last
375body form becomes the value of the function call.
376
377@node Macro Forms
378@subsection Lisp Macro Evaluation
379@cindex macro call evaluation
380
381 If the first element of a list being evaluated is a macro object, then
382the list is a @dfn{macro call}. When a macro call is evaluated, the
383elements of the rest of the list are @emph{not} initially evaluated.
384Instead, these elements themselves are used as the arguments of the
385macro. The macro definition computes a replacement form, called the
386@dfn{expansion} of the macro, to be evaluated in place of the original
387form. The expansion may be any sort of form: a self-evaluating
388constant, a symbol, or a list. If the expansion is itself a macro call,
389this process of expansion repeats until some other sort of form results.
390
391 Ordinary evaluation of a macro call finishes by evaluating the
392expansion. However, the macro expansion is not necessarily evaluated
393right away, or at all, because other programs also expand macro calls,
394and they may or may not evaluate the expansions.
395
396 Normally, the argument expressions are not evaluated as part of
397computing the macro expansion, but instead appear as part of the
398expansion, so they are computed when the expansion is evaluated.
399
400 For example, given a macro defined as follows:
401
402@example
403@group
404(defmacro cadr (x)
405 (list 'car (list 'cdr x)))
406@end group
407@end example
408
409@noindent
410an expression such as @code{(cadr (assq 'handler list))} is a macro
411call, and its expansion is:
412
413@example
414(car (cdr (assq 'handler list)))
415@end example
416
417@noindent
418Note that the argument @code{(assq 'handler list)} appears in the
419expansion.
420
421@xref{Macros}, for a complete description of Emacs Lisp macros.
422
423@node Special Forms
424@subsection Special Forms
45e46036
EZ
425@cindex special forms
426@cindex evaluation of special forms
b8d4c8d0
GM
427
428 A @dfn{special form} is a primitive function specially marked so that
429its arguments are not all evaluated. Most special forms define control
430structures or perform variable bindings---things which functions cannot
431do.
432
433 Each special form has its own rules for which arguments are evaluated
434and which are used without evaluation. Whether a particular argument is
435evaluated may depend on the results of evaluating other arguments.
436
437 Here is a list, in alphabetical order, of all of the special forms in
438Emacs Lisp with a reference to where each is described.
439
440@table @code
441@item and
442@pxref{Combining Conditions}
443
444@item catch
445@pxref{Catch and Throw}
446
447@item cond
448@pxref{Conditionals}
449
450@item condition-case
451@pxref{Handling Errors}
452
453@item defconst
454@pxref{Defining Variables}
455
456@item defmacro
457@pxref{Defining Macros}
458
459@item defun
460@pxref{Defining Functions}
461
462@item defvar
463@pxref{Defining Variables}
464
465@item function
466@pxref{Anonymous Functions}
467
468@item if
469@pxref{Conditionals}
470
471@item interactive
472@pxref{Interactive Call}
473
474@item let
475@itemx let*
476@pxref{Local Variables}
477
478@item or
479@pxref{Combining Conditions}
480
481@item prog1
482@itemx prog2
483@itemx progn
484@pxref{Sequencing}
485
486@item quote
487@pxref{Quoting}
488
489@item save-current-buffer
490@pxref{Current Buffer}
491
492@item save-excursion
493@pxref{Excursions}
494
495@item save-restriction
496@pxref{Narrowing}
497
498@item save-window-excursion
499@pxref{Window Configurations}
500
501@item setq
502@pxref{Setting Variables}
503
504@item setq-default
505@pxref{Creating Buffer-Local}
506
507@item track-mouse
508@pxref{Mouse Tracking}
509
510@item unwind-protect
511@pxref{Nonlocal Exits}
512
513@item while
514@pxref{Iteration}
515
516@item with-output-to-temp-buffer
517@pxref{Temporary Displays}
518@end table
519
520@cindex CL note---special forms compared
521@quotation
522@b{Common Lisp note:} Here are some comparisons of special forms in
523GNU Emacs Lisp and Common Lisp. @code{setq}, @code{if}, and
524@code{catch} are special forms in both Emacs Lisp and Common Lisp.
525@code{defun} is a special form in Emacs Lisp, but a macro in Common
526Lisp. @code{save-excursion} is a special form in Emacs Lisp, but
527doesn't exist in Common Lisp. @code{throw} is a special form in
528Common Lisp (because it must be able to throw multiple values), but it
529is a function in Emacs Lisp (which doesn't have multiple
530values).@refill
531@end quotation
532
533@node Autoloading
534@subsection Autoloading
535
536 The @dfn{autoload} feature allows you to call a function or macro
537whose function definition has not yet been loaded into Emacs. It
538specifies which file contains the definition. When an autoload object
539appears as a symbol's function definition, calling that symbol as a
310a820f
EZ
540function automatically loads the specified file; then it calls the
541real definition loaded from that file. The way to arrange for an
542autoload object to appear as a symbol's function definition is
543described in @ref{Autoload}.
b8d4c8d0
GM
544
545@node Quoting
546@section Quoting
547
548 The special form @code{quote} returns its single argument, as written,
549without evaluating it. This provides a way to include constant symbols
550and lists, which are not self-evaluating objects, in a program. (It is
551not necessary to quote self-evaluating objects such as numbers, strings,
552and vectors.)
553
554@defspec quote object
555This special form returns @var{object}, without evaluating it.
556@end defspec
557
558@cindex @samp{'} for quoting
559@cindex quoting using apostrophe
560@cindex apostrophe for quoting
561Because @code{quote} is used so often in programs, Lisp provides a
562convenient read syntax for it. An apostrophe character (@samp{'})
563followed by a Lisp object (in read syntax) expands to a list whose first
564element is @code{quote}, and whose second element is the object. Thus,
565the read syntax @code{'x} is an abbreviation for @code{(quote x)}.
566
567Here are some examples of expressions that use @code{quote}:
568
569@example
570@group
571(quote (+ 1 2))
572 @result{} (+ 1 2)
573@end group
574@group
575(quote foo)
576 @result{} foo
577@end group
578@group
579'foo
580 @result{} foo
581@end group
582@group
583''foo
584 @result{} (quote foo)
585@end group
586@group
587'(quote foo)
588 @result{} (quote foo)
589@end group
590@group
591['foo]
592 @result{} [(quote foo)]
593@end group
594@end example
595
596 Other quoting constructs include @code{function} (@pxref{Anonymous
597Functions}), which causes an anonymous lambda expression written in Lisp
598to be compiled, and @samp{`} (@pxref{Backquote}), which is used to quote
599only part of a list, while computing and substituting other parts.
600
03988c98
CY
601@node Backquote
602@section Backquote
603@cindex backquote (list substitution)
604@cindex ` (list substitution)
605@findex `
606
607 @dfn{Backquote constructs} allow you to quote a list, but
608selectively evaluate elements of that list. In the simplest case, it
609is identical to the special form @code{quote}
610@iftex
611@end iftex
612@ifnottex
613(described in the previous section; @pxref{Quoting}).
614@end ifnottex
615For example, these two forms yield identical results:
616
617@example
618@group
619`(a list of (+ 2 3) elements)
620 @result{} (a list of (+ 2 3) elements)
621@end group
622@group
623'(a list of (+ 2 3) elements)
624 @result{} (a list of (+ 2 3) elements)
625@end group
626@end example
627
628@findex , @r{(with backquote)}
629 The special marker @samp{,} inside of the argument to backquote
630indicates a value that isn't constant. The Emacs Lisp evaluator
631evaluates the argument of @samp{,}, and puts the value in the list
632structure:
633
634@example
635@group
636`(a list of ,(+ 2 3) elements)
637 @result{} (a list of 5 elements)
638@end group
639@end example
640
641@noindent
642Substitution with @samp{,} is allowed at deeper levels of the list
643structure also. For example:
644
645@example
646@group
647`(1 2 (3 ,(+ 4 5)))
648 @result{} (1 2 (3 9))
649@end group
650@end example
651
652@findex ,@@ @r{(with backquote)}
653@cindex splicing (with backquote)
654 You can also @dfn{splice} an evaluated value into the resulting list,
655using the special marker @samp{,@@}. The elements of the spliced list
656become elements at the same level as the other elements of the resulting
657list. The equivalent code without using @samp{`} is often unreadable.
658Here are some examples:
659
660@example
661@group
662(setq some-list '(2 3))
663 @result{} (2 3)
664@end group
665@group
666(cons 1 (append some-list '(4) some-list))
667 @result{} (1 2 3 4 2 3)
668@end group
669@group
670`(1 ,@@some-list 4 ,@@some-list)
671 @result{} (1 2 3 4 2 3)
672@end group
673
674@group
675(setq list '(hack foo bar))
676 @result{} (hack foo bar)
677@end group
678@group
679(cons 'use
680 (cons 'the
681 (cons 'words (append (cdr list) '(as elements)))))
682 @result{} (use the words foo bar as elements)
683@end group
684@group
685`(use the words ,@@(cdr list) as elements)
686 @result{} (use the words foo bar as elements)
687@end group
688@end example
689
690
b8d4c8d0
GM
691@node Eval
692@section Eval
693
694 Most often, forms are evaluated automatically, by virtue of their
695occurrence in a program being run. On rare occasions, you may need to
696write code that evaluates a form that is computed at run time, such as
697after reading a form from text being edited or getting one from a
698property list. On these occasions, use the @code{eval} function.
d032d5e7
SM
699Often @code{eval} is not needed and something else should be used instead.
700For example, to get the value of a variable, while @code{eval} works,
701@code{symbol-value} is preferable; or rather than store expressions
702in a property list that then need to go through @code{eval}, it is better to
703store functions instead that are then passed to @code{funcall}.
b8d4c8d0
GM
704
705 The functions and variables described in this section evaluate forms,
706specify limits to the evaluation process, or record recently returned
707values. Loading a file also does evaluation (@pxref{Loading}).
708
709 It is generally cleaner and more flexible to store a function in a
710data structure, and call it with @code{funcall} or @code{apply}, than
711to store an expression in the data structure and evaluate it. Using
712functions provides the ability to pass information to them as
713arguments.
714
d032d5e7 715@defun eval form &optional lexical
31cbea1d 716This is the basic function for evaluating an expression. It evaluates
b8d4c8d0
GM
717@var{form} in the current environment and returns the result. How the
718evaluation proceeds depends on the type of the object (@pxref{Forms}).
31cbea1d
CY
719
720The argument @var{lexical}, if non-@code{nil}, means to evaluate
721@var{form} using lexical scoping rules for variables, instead of the
722default dynamic scoping rules. @xref{Lexical Binding}.
b8d4c8d0
GM
723
724Since @code{eval} is a function, the argument expression that appears
725in a call to @code{eval} is evaluated twice: once as preparation before
726@code{eval} is called, and again by the @code{eval} function itself.
727Here is an example:
728
729@example
730@group
731(setq foo 'bar)
732 @result{} bar
733@end group
734@group
735(setq bar 'baz)
736 @result{} baz
737;; @r{Here @code{eval} receives argument @code{foo}}
738(eval 'foo)
739 @result{} bar
740;; @r{Here @code{eval} receives argument @code{bar}, which is the value of @code{foo}}
741(eval foo)
742 @result{} baz
743@end group
744@end example
745
746The number of currently active calls to @code{eval} is limited to
747@code{max-lisp-eval-depth} (see below).
748@end defun
749
750@deffn Command eval-region start end &optional stream read-function
751@anchor{Definition of eval-region}
752This function evaluates the forms in the current buffer in the region
753defined by the positions @var{start} and @var{end}. It reads forms from
754the region and calls @code{eval} on them until the end of the region is
755reached, or until an error is signaled and not handled.
756
757By default, @code{eval-region} does not produce any output. However,
758if @var{stream} is non-@code{nil}, any output produced by output
759functions (@pxref{Output Functions}), as well as the values that
760result from evaluating the expressions in the region are printed using
761@var{stream}. @xref{Output Streams}.
762
763If @var{read-function} is non-@code{nil}, it should be a function,
764which is used instead of @code{read} to read expressions one by one.
765This function is called with one argument, the stream for reading
766input. You can also use the variable @code{load-read-function}
767(@pxref{Definition of load-read-function,, How Programs Do Loading})
768to specify this function, but it is more robust to use the
769@var{read-function} argument.
770
771@code{eval-region} does not move point. It always returns @code{nil}.
772@end deffn
773
774@cindex evaluation of buffer contents
775@deffn Command eval-buffer &optional buffer-or-name stream filename unibyte print
776This is similar to @code{eval-region}, but the arguments provide
777different optional features. @code{eval-buffer} operates on the
778entire accessible portion of buffer @var{buffer-or-name}.
779@var{buffer-or-name} can be a buffer, a buffer name (a string), or
780@code{nil} (or omitted), which means to use the current buffer.
781@var{stream} is used as in @code{eval-region}, unless @var{stream} is
782@code{nil} and @var{print} non-@code{nil}. In that case, values that
783result from evaluating the expressions are still discarded, but the
784output of the output functions is printed in the echo area.
785@var{filename} is the file name to use for @code{load-history}
786(@pxref{Unloading}), and defaults to @code{buffer-file-name}
787(@pxref{Buffer File Name}). If @var{unibyte} is non-@code{nil},
788@code{read} converts strings to unibyte whenever possible.
789
790@findex eval-current-buffer
791@code{eval-current-buffer} is an alias for this command.
792@end deffn
793
01f17ae2 794@defopt max-lisp-eval-depth
b8d4c8d0
GM
795@anchor{Definition of max-lisp-eval-depth}
796This variable defines the maximum depth allowed in calls to @code{eval},
797@code{apply}, and @code{funcall} before an error is signaled (with error
798message @code{"Lisp nesting exceeds max-lisp-eval-depth"}).
799
800This limit, with the associated error when it is exceeded, is one way
801Emacs Lisp avoids infinite recursion on an ill-defined function. If
802you increase the value of @code{max-lisp-eval-depth} too much, such
803code can cause stack overflow instead.
804@cindex Lisp nesting error
805
806The depth limit counts internal uses of @code{eval}, @code{apply}, and
807@code{funcall}, such as for calling the functions mentioned in Lisp
808expressions, and recursive evaluation of function call arguments and
809function body forms, as well as explicit calls in Lisp code.
810
a5b99fab
CY
811The default value of this variable is 400. If you set it to a value
812less than 100, Lisp will reset it to 100 if the given value is
813reached. Entry to the Lisp debugger increases the value, if there is
814little room left, to make sure the debugger itself has room to
815execute.
b8d4c8d0
GM
816
817@code{max-specpdl-size} provides another limit on nesting.
818@xref{Definition of max-specpdl-size,, Local Variables}.
01f17ae2 819@end defopt
b8d4c8d0
GM
820
821@defvar values
822The value of this variable is a list of the values returned by all the
823expressions that were read, evaluated, and printed from buffers
824(including the minibuffer) by the standard Emacs commands which do
825this. (Note that this does @emph{not} include evaluation in
2bb0eca1 826@file{*ielm*} buffers, nor evaluation using @kbd{C-j} in
b8d4c8d0
GM
827@code{lisp-interaction-mode}.) The elements are ordered most recent
828first.
829
830@example
831@group
832(setq x 1)
833 @result{} 1
834@end group
835@group
836(list 'A (1+ 2) auto-save-default)
837 @result{} (A 3 t)
838@end group
839@group
840values
841 @result{} ((A 3 t) 1 @dots{})
842@end group
843@end example
844
845This variable is useful for referring back to values of forms recently
846evaluated. It is generally a bad idea to print the value of
847@code{values} itself, since this may be very long. Instead, examine
848particular elements, like this:
849
850@example
851@group
852;; @r{Refer to the most recent evaluation result.}
853(nth 0 values)
854 @result{} (A 3 t)
855@end group
856@group
857;; @r{That put a new element on,}
858;; @r{so all elements move back one.}
859(nth 1 values)
860 @result{} (A 3 t)
861@end group
862@group
863;; @r{This gets the element that was next-to-most-recent}
864;; @r{before this example.}
865(nth 3 values)
866 @result{} 1
867@end group
868@end example
869@end defvar