annotate doc/lispref/control.texi @ 93453:22b3710e206a

(holiday-chinese-new-year): Doc fix and comment.
author Glenn Morris <rgm@gnu.org>
date Mon, 31 Mar 2008 07:40:11 +0000
parents 107ccd98fa12
children 71fac6afda5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84057
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001, 2002,
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
4 @c 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
84057
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84057
diff changeset
6 @setfilename ../../info/control
84057
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Control Structures, Variables, Evaluation, Top
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @chapter Control Structures
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @cindex special forms for control structures
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex control structures
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 A Lisp program consists of expressions or @dfn{forms} (@pxref{Forms}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 We control the order of execution of these forms by enclosing them in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @dfn{control structures}. Control structures are special forms which
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 control when, whether, or how many times to execute the forms they
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 contain.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 The simplest order of execution is sequential execution: first form
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 @var{a}, then form @var{b}, and so on. This is what happens when you
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 write several forms in succession in the body of a function, or at top
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 level in a file of Lisp code---the forms are executed in the order
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 written. We call this @dfn{textual order}. For example, if a function
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 body consists of two forms @var{a} and @var{b}, evaluation of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 function evaluates first @var{a} and then @var{b}. The result of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 evaluating @var{b} becomes the value of the function.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 Explicit control structures make possible an order of execution other
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 than sequential.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 Emacs Lisp provides several kinds of control structure, including
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 other varieties of sequencing, conditionals, iteration, and (controlled)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 jumps---all discussed below. The built-in control structures are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 special forms since their subforms are not necessarily evaluated or not
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 evaluated sequentially. You can use macros to define your own control
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 structure constructs (@pxref{Macros}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 @menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 * Sequencing:: Evaluation in textual order.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 * Conditionals:: @code{if}, @code{cond}, @code{when}, @code{unless}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 * Combining Conditions:: @code{and}, @code{or}, @code{not}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 * Iteration:: @code{while} loops.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 * Nonlocal Exits:: Jumping out of a sequence.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 @end menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 @node Sequencing
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 @section Sequencing
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 Evaluating forms in the order they appear is the most common way
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 control passes from one form to another. In some contexts, such as in a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 function body, this happens automatically. Elsewhere you must use a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 control structure construct to do this: @code{progn}, the simplest
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 control construct of Lisp.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 A @code{progn} special form looks like this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 (progn @var{a} @var{b} @var{c} @dots{})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 and it says to execute the forms @var{a}, @var{b}, @var{c}, and so on, in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 that order. These forms are called the @dfn{body} of the @code{progn} form.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 The value of the last form in the body becomes the value of the entire
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 @code{progn}. @code{(progn)} returns @code{nil}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 @cindex implicit @code{progn}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 In the early days of Lisp, @code{progn} was the only way to execute
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 two or more forms in succession and use the value of the last of them.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 But programmers found they often needed to use a @code{progn} in the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 body of a function, where (at that time) only one form was allowed. So
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 the body of a function was made into an ``implicit @code{progn}'':
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 several forms are allowed just as in the body of an actual @code{progn}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 Many other control structures likewise contain an implicit @code{progn}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 As a result, @code{progn} is not used as much as it was many years ago.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 It is needed now most often inside an @code{unwind-protect}, @code{and},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @code{or}, or in the @var{then}-part of an @code{if}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @defspec progn forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 This special form evaluates all of the @var{forms}, in textual
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 order, returning the result of the final form.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 (progn (print "The first form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 (print "The second form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 (print "The third form"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 @print{} "The first form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @print{} "The second form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @print{} "The third form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @result{} "The third form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 Two other control constructs likewise evaluate a series of forms but return
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 a different value:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 @defspec prog1 form1 forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 This special form evaluates @var{form1} and all of the @var{forms}, in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 textual order, returning the result of @var{form1}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 (prog1 (print "The first form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 (print "The second form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 (print "The third form"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @print{} "The first form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 @print{} "The second form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 @print{} "The third form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 @result{} "The first form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 Here is a way to remove the first element from a list in the variable
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 @code{x}, then return the value of that former element:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 (prog1 (car x) (setq x (cdr x)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @defspec prog2 form1 form2 forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 This special form evaluates @var{form1}, @var{form2}, and all of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 following @var{forms}, in textual order, returning the result of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 @var{form2}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 (prog2 (print "The first form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 (print "The second form")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 (print "The third form"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @print{} "The first form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @print{} "The second form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @print{} "The third form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 @result{} "The second form"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @node Conditionals
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @section Conditionals
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @cindex conditional evaluation
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 Conditional control structures choose among alternatives. Emacs Lisp
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 has four conditional forms: @code{if}, which is much the same as in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 other languages; @code{when} and @code{unless}, which are variants of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @code{if}; and @code{cond}, which is a generalized case statement.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @defspec if condition then-form else-forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 @code{if} chooses between the @var{then-form} and the @var{else-forms}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 based on the value of @var{condition}. If the evaluated @var{condition} is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 non-@code{nil}, @var{then-form} is evaluated and the result returned.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 Otherwise, the @var{else-forms} are evaluated in textual order, and the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 value of the last one is returned. (The @var{else} part of @code{if} is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 an example of an implicit @code{progn}. @xref{Sequencing}.)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 If @var{condition} has the value @code{nil}, and no @var{else-forms} are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 given, @code{if} returns @code{nil}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @code{if} is a special form because the branch that is not selected is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 never evaluated---it is ignored. Thus, in the example below,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 @code{true} is not printed because @code{print} is never called.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 (if nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 (print 'true)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 'very-false)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 @result{} very-false
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @defmac when condition then-forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 This is a variant of @code{if} where there are no @var{else-forms},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 and possibly several @var{then-forms}. In particular,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 (when @var{condition} @var{a} @var{b} @var{c})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 is entirely equivalent to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 (if @var{condition} (progn @var{a} @var{b} @var{c}) nil)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @end defmac
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @defmac unless condition forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 This is a variant of @code{if} where there is no @var{then-form}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 (unless @var{condition} @var{a} @var{b} @var{c})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 is entirely equivalent to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 (if @var{condition} nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 @var{a} @var{b} @var{c})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 @end defmac
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 @defspec cond clause@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 @code{cond} chooses among an arbitrary number of alternatives. Each
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 @var{clause} in the @code{cond} must be a list. The @sc{car} of this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 list is the @var{condition}; the remaining elements, if any, the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @var{body-forms}. Thus, a clause looks like this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 (@var{condition} @var{body-forms}@dots{})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @code{cond} tries the clauses in textual order, by evaluating the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @var{condition} of each clause. If the value of @var{condition} is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 non-@code{nil}, the clause ``succeeds''; then @code{cond} evaluates its
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 @var{body-forms}, and the value of the last of @var{body-forms} becomes
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 the value of the @code{cond}. The remaining clauses are ignored.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 If the value of @var{condition} is @code{nil}, the clause ``fails,'' so
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 the @code{cond} moves on to the following clause, trying its
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @var{condition}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 If every @var{condition} evaluates to @code{nil}, so that every clause
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 fails, @code{cond} returns @code{nil}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 A clause may also look like this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 (@var{condition})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 Then, if @var{condition} is non-@code{nil} when tested, the value of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 @var{condition} becomes the value of the @code{cond} form.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 The following example has four clauses, which test for the cases where
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 the value of @code{x} is a number, string, buffer and symbol,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 respectively:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 (cond ((numberp x) x)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 ((stringp x) x)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 ((bufferp x)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 (setq temporary-hack x) ; @r{multiple body-forms}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 (buffer-name x)) ; @r{in one clause}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 ((symbolp x) (symbol-value x)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 Often we want to execute the last clause whenever none of the previous
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 clauses was successful. To do this, we use @code{t} as the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 @var{condition} of the last clause, like this: @code{(t
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 @var{body-forms})}. The form @code{t} evaluates to @code{t}, which is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 never @code{nil}, so this clause never fails, provided the @code{cond}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 gets to it at all.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 For example,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 (setq a 5)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 (cond ((eq a 'hack) 'foo)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 (t "default"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 @result{} "default"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 This @code{cond} expression returns @code{foo} if the value of @code{a}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 is @code{hack}, and returns the string @code{"default"} otherwise.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 Any conditional construct can be expressed with @code{cond} or with
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 @code{if}. Therefore, the choice between them is a matter of style.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 For example:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 (if @var{a} @var{b} @var{c})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 @equiv{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 (cond (@var{a} @var{b}) (t @var{c}))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @node Combining Conditions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @section Constructs for Combining Conditions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 This section describes three constructs that are often used together
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 with @code{if} and @code{cond} to express complicated conditions. The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 constructs @code{and} and @code{or} can also be used individually as
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 kinds of multiple conditional constructs.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 @defun not condition
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 This function tests for the falsehood of @var{condition}. It returns
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 @code{t} if @var{condition} is @code{nil}, and @code{nil} otherwise.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 The function @code{not} is identical to @code{null}, and we recommend
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 using the name @code{null} if you are testing for an empty list.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 @end defun
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @defspec and conditions@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 The @code{and} special form tests whether all the @var{conditions} are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 true. It works by evaluating the @var{conditions} one by one in the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 order written.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 If any of the @var{conditions} evaluates to @code{nil}, then the result
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 of the @code{and} must be @code{nil} regardless of the remaining
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @var{conditions}; so @code{and} returns @code{nil} right away, ignoring
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 the remaining @var{conditions}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 If all the @var{conditions} turn out non-@code{nil}, then the value of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 the last of them becomes the value of the @code{and} form. Just
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 @code{(and)}, with no @var{conditions}, returns @code{t}, appropriate
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 because all the @var{conditions} turned out non-@code{nil}. (Think
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 about it; which one did not?)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 Here is an example. The first condition returns the integer 1, which is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 not @code{nil}. Similarly, the second condition returns the integer 2,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 which is not @code{nil}. The third condition is @code{nil}, so the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 remaining condition is never evaluated.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 (and (print 1) (print 2) nil (print 3))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @print{} 1
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @print{} 2
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 @result{} nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 Here is a more realistic example of using @code{and}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 (if (and (consp foo) (eq (car foo) 'x))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 (message "foo is a list starting with x"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 Note that @code{(car foo)} is not executed if @code{(consp foo)} returns
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 @code{nil}, thus avoiding an error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 @code{and} expressions can also be written using either @code{if} or
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @code{cond}. Here's how:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 (and @var{arg1} @var{arg2} @var{arg3})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 @equiv{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 (if @var{arg1} (if @var{arg2} @var{arg3}))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @equiv{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 (cond (@var{arg1} (cond (@var{arg2} @var{arg3}))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @defspec or conditions@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 The @code{or} special form tests whether at least one of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @var{conditions} is true. It works by evaluating all the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 @var{conditions} one by one in the order written.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 If any of the @var{conditions} evaluates to a non-@code{nil} value, then
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 the result of the @code{or} must be non-@code{nil}; so @code{or} returns
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 right away, ignoring the remaining @var{conditions}. The value it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 returns is the non-@code{nil} value of the condition just evaluated.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 If all the @var{conditions} turn out @code{nil}, then the @code{or}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 expression returns @code{nil}. Just @code{(or)}, with no
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @var{conditions}, returns @code{nil}, appropriate because all the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 @var{conditions} turned out @code{nil}. (Think about it; which one
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 did not?)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 For example, this expression tests whether @code{x} is either
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @code{nil} or the integer zero:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 (or (eq x nil) (eq x 0))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 Like the @code{and} construct, @code{or} can be written in terms of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 @code{cond}. For example:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 (or @var{arg1} @var{arg2} @var{arg3})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 @equiv{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 (cond (@var{arg1})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 (@var{arg2})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 (@var{arg3}))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 You could almost write @code{or} in terms of @code{if}, but not quite:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 (if @var{arg1} @var{arg1}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 (if @var{arg2} @var{arg2}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 @var{arg3}))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 This is not completely equivalent because it can evaluate @var{arg1} or
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @var{arg2} twice. By contrast, @code{(or @var{arg1} @var{arg2}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @var{arg3})} never evaluates any argument more than once.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 @node Iteration
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 @section Iteration
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @cindex iteration
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 @cindex recursion
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 Iteration means executing part of a program repetitively. For
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 example, you might want to repeat some computation once for each element
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 of a list, or once for each integer from 0 to @var{n}. You can do this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 in Emacs Lisp with the special form @code{while}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 @defspec while condition forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 @code{while} first evaluates @var{condition}. If the result is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 non-@code{nil}, it evaluates @var{forms} in textual order. Then it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 reevaluates @var{condition}, and if the result is non-@code{nil}, it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 evaluates @var{forms} again. This process repeats until @var{condition}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 evaluates to @code{nil}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 There is no limit on the number of iterations that may occur. The loop
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 will continue until either @var{condition} evaluates to @code{nil} or
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 until an error or @code{throw} jumps out of it (@pxref{Nonlocal Exits}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 The value of a @code{while} form is always @code{nil}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 (setq num 0)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @result{} 0
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 (while (< num 4)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 (princ (format "Iteration %d." num))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 (setq num (1+ num)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @print{} Iteration 0.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @print{} Iteration 1.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @print{} Iteration 2.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @print{} Iteration 3.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @result{} nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 To write a ``repeat...until'' loop, which will execute something on each
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 iteration and then do the end-test, put the body followed by the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 end-test in a @code{progn} as the first argument of @code{while}, as
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 shown here:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 (while (progn
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 (forward-line 1)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 (not (looking-at "^$"))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 This moves forward one line and continues moving by lines until it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 reaches an empty line. It is peculiar in that the @code{while} has no
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 body, just the end test (which also does the real work of moving point).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 The @code{dolist} and @code{dotimes} macros provide convenient ways to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 write two common kinds of loops.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @defmac dolist (var list [result]) body@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 This construct executes @var{body} once for each element of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @var{list}, binding the variable @var{var} locally to hold the current
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 element. Then it returns the value of evaluating @var{result}, or
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @code{nil} if @var{result} is omitted. For example, here is how you
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 could use @code{dolist} to define the @code{reverse} function:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 (defun reverse (list)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 (let (value)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 (dolist (elt list value)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 (setq value (cons elt value)))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 @end defmac
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @defmac dotimes (var count [result]) body@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 This construct executes @var{body} once for each integer from 0
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 (inclusive) to @var{count} (exclusive), binding the variable @var{var}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 to the integer for the current iteration. Then it returns the value
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 of evaluating @var{result}, or @code{nil} if @var{result} is omitted.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 Here is an example of using @code{dotimes} to do something 100 times:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 (dotimes (i 100)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 (insert "I will not obey absurd orders\n"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @end defmac
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @node Nonlocal Exits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @section Nonlocal Exits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @cindex nonlocal exits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 A @dfn{nonlocal exit} is a transfer of control from one point in a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 program to another remote point. Nonlocal exits can occur in Emacs Lisp
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 as a result of errors; you can also use them under explicit control.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 Nonlocal exits unbind all variable bindings made by the constructs being
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 exited.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 @menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 * Catch and Throw:: Nonlocal exits for the program's own purposes.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 * Examples of Catch:: Showing how such nonlocal exits can be written.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 * Errors:: How errors are signaled and handled.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 * Cleanups:: Arranging to run a cleanup form if an error happens.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @end menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 @node Catch and Throw
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 @subsection Explicit Nonlocal Exits: @code{catch} and @code{throw}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 Most control constructs affect only the flow of control within the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 construct itself. The function @code{throw} is the exception to this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 rule of normal program execution: it performs a nonlocal exit on
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 request. (There are other exceptions, but they are for error handling
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 only.) @code{throw} is used inside a @code{catch}, and jumps back to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 that @code{catch}. For example:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 (defun foo-outer ()
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 (catch 'foo
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 (foo-inner)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 (defun foo-inner ()
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 (if x
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 (throw 'foo t))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @dots{})
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 The @code{throw} form, if executed, transfers control straight back to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 the corresponding @code{catch}, which returns immediately. The code
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 following the @code{throw} is not executed. The second argument of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @code{throw} is used as the return value of the @code{catch}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 The function @code{throw} finds the matching @code{catch} based on the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 first argument: it searches for a @code{catch} whose first argument is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @code{eq} to the one specified in the @code{throw}. If there is more
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 than one applicable @code{catch}, the innermost one takes precedence.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 Thus, in the above example, the @code{throw} specifies @code{foo}, and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 the @code{catch} in @code{foo-outer} specifies the same symbol, so that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @code{catch} is the applicable one (assuming there is no other matching
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @code{catch} in between).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 Executing @code{throw} exits all Lisp constructs up to the matching
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @code{catch}, including function calls. When binding constructs such as
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @code{let} or function calls are exited in this way, the bindings are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 unbound, just as they are when these constructs exit normally
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 (@pxref{Local Variables}). Likewise, @code{throw} restores the buffer
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 and position saved by @code{save-excursion} (@pxref{Excursions}), and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 the narrowing status saved by @code{save-restriction} and the window
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 selection saved by @code{save-window-excursion} (@pxref{Window
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 Configurations}). It also runs any cleanups established with the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @code{unwind-protect} special form when it exits that form
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 (@pxref{Cleanups}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 The @code{throw} need not appear lexically within the @code{catch}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 that it jumps to. It can equally well be called from another function
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 called within the @code{catch}. As long as the @code{throw} takes place
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 chronologically after entry to the @code{catch}, and chronologically
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 before exit from it, it has access to that @code{catch}. This is why
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @code{throw} can be used in commands such as @code{exit-recursive-edit}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 that throw back to the editor command loop (@pxref{Recursive Editing}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 @cindex CL note---only @code{throw} in Emacs
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 @quotation
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @b{Common Lisp note:} Most other versions of Lisp, including Common Lisp,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 have several ways of transferring control nonsequentially: @code{return},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @code{return-from}, and @code{go}, for example. Emacs Lisp has only
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @code{throw}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @end quotation
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 @defspec catch tag body@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @cindex tag on run time stack
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 @code{catch} establishes a return point for the @code{throw} function.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 The return point is distinguished from other such return points by
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 @var{tag}, which may be any Lisp object except @code{nil}. The argument
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @var{tag} is evaluated normally before the return point is established.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 With the return point in effect, @code{catch} evaluates the forms of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @var{body} in textual order. If the forms execute normally (without
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 error or nonlocal exit) the value of the last body form is returned from
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 the @code{catch}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 If a @code{throw} is executed during the execution of @var{body},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 specifying the same value @var{tag}, the @code{catch} form exits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 immediately; the value it returns is whatever was specified as the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 second argument of @code{throw}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 @defun throw tag value
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 The purpose of @code{throw} is to return from a return point previously
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 established with @code{catch}. The argument @var{tag} is used to choose
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 among the various existing return points; it must be @code{eq} to the value
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 specified in the @code{catch}. If multiple return points match @var{tag},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 the innermost one is used.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 The argument @var{value} is used as the value to return from that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 @code{catch}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 @kindex no-catch
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 If no return point is in effect with tag @var{tag}, then a @code{no-catch}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 error is signaled with data @code{(@var{tag} @var{value})}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 @end defun
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 @node Examples of Catch
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 @subsection Examples of @code{catch} and @code{throw}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 One way to use @code{catch} and @code{throw} is to exit from a doubly
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 nested loop. (In most languages, this would be done with a ``go to.'')
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 Here we compute @code{(foo @var{i} @var{j})} for @var{i} and @var{j}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 varying from 0 to 9:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 (defun search-foo ()
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 (catch 'loop
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 (let ((i 0))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 (while (< i 10)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 (let ((j 0))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 (while (< j 10)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 (if (foo i j)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 (throw 'loop (list i j)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 (setq j (1+ j))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 (setq i (1+ i))))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 If @code{foo} ever returns non-@code{nil}, we stop immediately and return a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 list of @var{i} and @var{j}. If @code{foo} always returns @code{nil}, the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 @code{catch} returns normally, and the value is @code{nil}, since that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 is the result of the @code{while}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 Here are two tricky examples, slightly different, showing two
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 return points at once. First, two return points with the same tag,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @code{hack}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 (defun catch2 (tag)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 (catch tag
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 (throw 'hack 'yes)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 @result{} catch2
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 (catch 'hack
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 (print (catch2 'hack))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 'no)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 @print{} yes
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @result{} no
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 Since both return points have tags that match the @code{throw}, it goes to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 the inner one, the one established in @code{catch2}. Therefore,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 @code{catch2} returns normally with value @code{yes}, and this value is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 printed. Finally the second body form in the outer @code{catch}, which is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @code{'no}, is evaluated and returned from the outer @code{catch}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 Now let's change the argument given to @code{catch2}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 (catch 'hack
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 (print (catch2 'quux))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 'no)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @result{} yes
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 We still have two return points, but this time only the outer one has
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 the tag @code{hack}; the inner one has the tag @code{quux} instead.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 Therefore, @code{throw} makes the outer @code{catch} return the value
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @code{yes}. The function @code{print} is never called, and the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 body-form @code{'no} is never evaluated.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @node Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @subsection Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @cindex errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 When Emacs Lisp attempts to evaluate a form that, for some reason,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 cannot be evaluated, it @dfn{signals} an @dfn{error}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 When an error is signaled, Emacs's default reaction is to print an
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 error message and terminate execution of the current command. This is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 the right thing to do in most cases, such as if you type @kbd{C-f} at
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 the end of the buffer.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 In complicated programs, simple termination may not be what you want.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 For example, the program may have made temporary changes in data
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 structures, or created temporary buffers that should be deleted before
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 the program is finished. In such cases, you would use
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 @code{unwind-protect} to establish @dfn{cleanup expressions} to be
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 evaluated in case of error. (@xref{Cleanups}.) Occasionally, you may
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 wish the program to continue execution despite an error in a subroutine.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 In these cases, you would use @code{condition-case} to establish
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @dfn{error handlers} to recover control in case of error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 Resist the temptation to use error handling to transfer control from
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 one part of the program to another; use @code{catch} and @code{throw}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 instead. @xref{Catch and Throw}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 * Signaling Errors:: How to report an error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 * Processing of Errors:: What Emacs does when you report an error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 * Handling Errors:: How you can trap errors and continue execution.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 * Error Symbols:: How errors are classified for trapping them.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @end menu
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 @node Signaling Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 @subsubsection How to Signal an Error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @cindex signaling errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @dfn{Signaling} an error means beginning error processing. Error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 processing normally aborts all or part of the running program and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 returns to a point that is set up to handle the error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 (@pxref{Processing of Errors}). Here we describe how to signal an
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 Most errors are signaled ``automatically'' within Lisp primitives
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 which you call for other purposes, such as if you try to take the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 @sc{car} of an integer or move forward a character at the end of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 buffer. You can also signal errors explicitly with the functions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @code{error} and @code{signal}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 Quitting, which happens when the user types @kbd{C-g}, is not
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 considered an error, but it is handled almost like an error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 @xref{Quitting}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 Every error specifies an error message, one way or another. The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 message should state what is wrong (``File does not exist''), not how
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 things ought to be (``File must exist''). The convention in Emacs
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 Lisp is that error messages should start with a capital letter, but
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 should not end with any sort of punctuation.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 @defun error format-string &rest args
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 This function signals an error with an error message constructed by
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 applying @code{format} (@pxref{Formatting Strings}) to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @var{format-string} and @var{args}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 These examples show typical uses of @code{error}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 (error "That is an error -- try something else")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 @error{} That is an error -- try something else
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 (error "You have committed %d errors" 10)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @error{} You have committed 10 errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 @code{error} works by calling @code{signal} with two arguments: the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 error symbol @code{error}, and a list containing the string returned by
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 @code{format}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @strong{Warning:} If you want to use your own string as an error message
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 verbatim, don't just write @code{(error @var{string})}. If @var{string}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 contains @samp{%}, it will be interpreted as a format specifier, with
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 undesirable results. Instead, use @code{(error "%s" @var{string})}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 @end defun
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @defun signal error-symbol data
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @anchor{Definition of signal}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 This function signals an error named by @var{error-symbol}. The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 argument @var{data} is a list of additional Lisp objects relevant to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 the circumstances of the error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 The argument @var{error-symbol} must be an @dfn{error symbol}---a symbol
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 bearing a property @code{error-conditions} whose value is a list of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 condition names. This is how Emacs Lisp classifies different sorts of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 errors. @xref{Error Symbols}, for a description of error symbols,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 error conditions and condition names.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 If the error is not handled, the two arguments are used in printing
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 the error message. Normally, this error message is provided by the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @code{error-message} property of @var{error-symbol}. If @var{data} is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 non-@code{nil}, this is followed by a colon and a comma separated list
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 of the unevaluated elements of @var{data}. For @code{error}, the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 error message is the @sc{car} of @var{data} (that must be a string).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 Subcategories of @code{file-error} are handled specially.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 The number and significance of the objects in @var{data} depends on
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @var{error-symbol}. For example, with a @code{wrong-type-arg} error,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 there should be two objects in the list: a predicate that describes the type
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 that was expected, and the object that failed to fit that type.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 Both @var{error-symbol} and @var{data} are available to any error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 handlers that handle the error: @code{condition-case} binds a local
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 variable to a list of the form @code{(@var{error-symbol} .@:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @var{data})} (@pxref{Handling Errors}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 The function @code{signal} never returns (though in older Emacs versions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 it could sometimes return).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 (signal 'wrong-number-of-arguments '(x y))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 @error{} Wrong number of arguments: x, y
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 (signal 'no-such-error '("My unknown error condition"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @error{} peculiar error: "My unknown error condition"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @end defun
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @cindex CL note---no continuable errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @quotation
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 @b{Common Lisp note:} Emacs Lisp has nothing like the Common Lisp
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 concept of continuable errors.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 @end quotation
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 @node Processing of Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 @subsubsection How Emacs Processes Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 When an error is signaled, @code{signal} searches for an active
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 @dfn{handler} for the error. A handler is a sequence of Lisp
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 expressions designated to be executed if an error happens in part of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 Lisp program. If the error has an applicable handler, the handler is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 executed, and control resumes following the handler. The handler
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 executes in the environment of the @code{condition-case} that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 established it; all functions called within that @code{condition-case}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 have already been exited, and the handler cannot return to them.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 If there is no applicable handler for the error, it terminates the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 current command and returns control to the editor command loop. (The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 command loop has an implicit handler for all kinds of errors.) The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 command loop's handler uses the error symbol and associated data to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 print an error message. You can use the variable
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 @code{command-error-function} to control how this is done:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 @defvar command-error-function
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 This variable, if non-@code{nil}, specifies a function to use to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 handle errors that return control to the Emacs command loop. The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 function should take three arguments: @var{data}, a list of the same
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 form that @code{condition-case} would bind to its variable;
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @var{context}, a string describing the situation in which the error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 occurred, or (more often) @code{nil}; and @var{caller}, the Lisp
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 function which called the primitive that signaled the error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @end defvar
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @cindex @code{debug-on-error} use
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 An error that has no explicit handler may call the Lisp debugger. The
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 debugger is enabled if the variable @code{debug-on-error} (@pxref{Error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 Debugging}) is non-@code{nil}. Unlike error handlers, the debugger runs
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 in the environment of the error, so that you can examine values of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 variables precisely as they were at the time of the error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @node Handling Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @subsubsection Writing Code to Handle Errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @cindex error handler
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @cindex handling errors
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 The usual effect of signaling an error is to terminate the command
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 that is running and return immediately to the Emacs editor command loop.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 You can arrange to trap errors occurring in a part of your program by
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 establishing an error handler, with the special form
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 @code{condition-case}. A simple example looks like this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 (condition-case nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 (delete-file filename)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 (error nil))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 This deletes the file named @var{filename}, catching any error and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 returning @code{nil} if an error occurs.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 The @code{condition-case} construct is often used to trap errors that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 are predictable, such as failure to open a file in a call to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @code{insert-file-contents}. It is also used to trap errors that are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 totally unpredictable, such as when the program evaluates an expression
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 read from the user.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 The second argument of @code{condition-case} is called the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @dfn{protected form}. (In the example above, the protected form is a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 call to @code{delete-file}.) The error handlers go into effect when
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 this form begins execution and are deactivated when this form returns.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 They remain in effect for all the intervening time. In particular, they
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 are in effect during the execution of functions called by this form, in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 their subroutines, and so on. This is a good thing, since, strictly
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 speaking, errors can be signaled only by Lisp primitives (including
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @code{signal} and @code{error}) called by the protected form, not by the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 protected form itself.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 The arguments after the protected form are handlers. Each handler
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 lists one or more @dfn{condition names} (which are symbols) to specify
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 which errors it will handle. The error symbol specified when an error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 is signaled also defines a list of condition names. A handler applies
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 to an error if they have any condition names in common. In the example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 above, there is one handler, and it specifies one condition name,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @code{error}, which covers all errors.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 The search for an applicable handler checks all the established handlers
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 starting with the most recently established one. Thus, if two nested
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @code{condition-case} forms offer to handle the same error, the inner of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 the two gets to handle it.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 If an error is handled by some @code{condition-case} form, this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 ordinarily prevents the debugger from being run, even if
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @code{debug-on-error} says this error should invoke the debugger.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 If you want to be able to debug errors that are caught by a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 @code{condition-case}, set the variable @code{debug-on-signal} to a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 non-@code{nil} value. You can also specify that a particular handler
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 should let the debugger run first, by writing @code{debug} among the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 conditions, like this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 (condition-case nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 (delete-file filename)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 ((debug error) nil))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 The effect of @code{debug} here is only to prevent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @code{condition-case} from suppressing the call to the debugger. Any
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 given error will invoke the debugger only if @code{debug-on-error} and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 the other usual filtering mechanisms say it should. @xref{Error Debugging}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 Once Emacs decides that a certain handler handles the error, it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 returns control to that handler. To do so, Emacs unbinds all variable
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 bindings made by binding constructs that are being exited, and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 executes the cleanups of all @code{unwind-protect} forms that are
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 being exited. Once control arrives at the handler, the body of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 handler executes normally.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 After execution of the handler body, execution returns from the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 @code{condition-case} form. Because the protected form is exited
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 completely before execution of the handler, the handler cannot resume
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 execution at the point of the error, nor can it examine variable
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 bindings that were made within the protected form. All it can do is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 clean up and proceed.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 Error signaling and handling have some resemblance to @code{throw} and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @code{catch} (@pxref{Catch and Throw}), but they are entirely separate
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 facilities. An error cannot be caught by a @code{catch}, and a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 @code{throw} cannot be handled by an error handler (though using
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @code{throw} when there is no suitable @code{catch} signals an error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 that can be handled).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 @defspec condition-case var protected-form handlers@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 This special form establishes the error handlers @var{handlers} around
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 the execution of @var{protected-form}. If @var{protected-form} executes
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 without error, the value it returns becomes the value of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @code{condition-case} form; in this case, the @code{condition-case} has
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 no effect. The @code{condition-case} form makes a difference when an
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 error occurs during @var{protected-form}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 Each of the @var{handlers} is a list of the form @code{(@var{conditions}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @var{body}@dots{})}. Here @var{conditions} is an error condition name
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 to be handled, or a list of condition names (which can include @code{debug}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 to allow the debugger to run before the handler); @var{body} is one or more
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 Lisp expressions to be executed when this handler handles an error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 Here are examples of handlers:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 (error nil)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 (arith-error (message "Division by zero"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 ((arith-error file-error)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 (message
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 "Either division by zero or failure to open a file"))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 Each error that occurs has an @dfn{error symbol} that describes what
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 kind of error it is. The @code{error-conditions} property of this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 symbol is a list of condition names (@pxref{Error Symbols}). Emacs
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 searches all the active @code{condition-case} forms for a handler that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 specifies one or more of these condition names; the innermost matching
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @code{condition-case} handles the error. Within this
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 @code{condition-case}, the first applicable handler handles the error.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 After executing the body of the handler, the @code{condition-case}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 returns normally, using the value of the last form in the handler body
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 as the overall value.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @cindex error description
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 The argument @var{var} is a variable. @code{condition-case} does not
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 bind this variable when executing the @var{protected-form}, only when it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 handles an error. At that time, it binds @var{var} locally to an
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @dfn{error description}, which is a list giving the particulars of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 error. The error description has the form @code{(@var{error-symbol}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 . @var{data})}. The handler can refer to this list to decide what to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 do. For example, if the error is for failure opening a file, the file
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 name is the second element of @var{data}---the third element of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 error description.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 If @var{var} is @code{nil}, that means no variable is bound. Then the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 error symbol and associated data are not available to the handler.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 @defun error-message-string error-description
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 This function returns the error message string for a given error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 descriptor. It is useful if you want to handle an error by printing the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 usual error message for that error. @xref{Definition of signal}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @end defun
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 @cindex @code{arith-error} example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 Here is an example of using @code{condition-case} to handle the error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 that results from dividing by zero. The handler displays the error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 message (but without a beep), then returns a very large number.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 (defun safe-divide (dividend divisor)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 (condition-case err
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 ;; @r{Protected form.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 (/ dividend divisor)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 ;; @r{The handler.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 (arith-error ; @r{Condition.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 ;; @r{Display the usual message for this error.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 (message "%s" (error-message-string err))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 1000000)))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 @result{} safe-divide
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 (safe-divide 5 0)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @print{} Arithmetic error: (arith-error)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @result{} 1000000
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 The handler specifies condition name @code{arith-error} so that it will handle only division-by-zero errors. Other kinds of errors will not be handled, at least not by this @code{condition-case}. Thus,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 (safe-divide nil 3)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 @error{} Wrong type argument: number-or-marker-p, nil
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 Here is a @code{condition-case} that catches all kinds of errors,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 including those signaled with @code{error}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 (setq baz 34)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 @result{} 34
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 (condition-case err
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 (if (eq baz 35)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 t
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 ;; @r{This is a call to the function @code{error}.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 (error "Rats! The variable %s was %s, not 35" 'baz baz))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 ;; @r{This is the handler; it is not a form.}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 (error (princ (format "The error was: %s" err))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 2))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 @print{} The error was: (error "Rats! The variable baz was 34, not 35")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @result{} 2
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @node Error Symbols
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 @subsubsection Error Symbols and Condition Names
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @cindex error symbol
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 @cindex error name
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 @cindex condition name
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 @cindex user-defined error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @kindex error-conditions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 When you signal an error, you specify an @dfn{error symbol} to specify
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 the kind of error you have in mind. Each error has one and only one
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 error symbol to categorize it. This is the finest classification of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 errors defined by the Emacs Lisp language.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 These narrow classifications are grouped into a hierarchy of wider
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 classes called @dfn{error conditions}, identified by @dfn{condition
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 names}. The narrowest such classes belong to the error symbols
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 themselves: each error symbol is also a condition name. There are also
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 condition names for more extensive classes, up to the condition name
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 @code{error} which takes in all kinds of errors (but not @code{quit}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 Thus, each error has one or more condition names: @code{error}, the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 error symbol if that is distinct from @code{error}, and perhaps some
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 intermediate classifications.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 In order for a symbol to be an error symbol, it must have an
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 @code{error-conditions} property which gives a list of condition names.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 This list defines the conditions that this kind of error belongs to.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 (The error symbol itself, and the symbol @code{error}, should always be
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 members of this list.) Thus, the hierarchy of condition names is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 defined by the @code{error-conditions} properties of the error symbols.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 Because quitting is not considered an error, the value of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @code{error-conditions} property of @code{quit} is just @code{(quit)}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @cindex peculiar error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 In addition to the @code{error-conditions} list, the error symbol
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 should have an @code{error-message} property whose value is a string to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 be printed when that error is signaled but not handled. If the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 error symbol has no @code{error-message} property or if the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 @code{error-message} property exists, but is not a string, the error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 message @samp{peculiar error} is used. @xref{Definition of signal}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 Here is how we define a new error symbol, @code{new-error}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 (put 'new-error
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 'error-conditions
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 '(error my-own-errors new-error))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @result{} (error my-own-errors new-error)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 (put 'new-error 'error-message "A new error")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 @result{} "A new error"
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 This error has three condition names: @code{new-error}, the narrowest
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 classification; @code{my-own-errors}, which we imagine is a wider
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 classification; and @code{error}, which is the widest of all.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 The error string should start with a capital letter but it should
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 not end with a period. This is for consistency with the rest of Emacs.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 Naturally, Emacs will never signal @code{new-error} on its own; only
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 an explicit call to @code{signal} (@pxref{Definition of signal}) in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 your code can do this:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 (signal 'new-error '(x y))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @error{} A new error: x, y
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 This error can be handled through any of the three condition names.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 This example handles @code{new-error} and any other errors in the class
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 @code{my-own-errors}:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 @example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 (condition-case foo
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 (bar nil t)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 (my-own-errors nil))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @end example
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 The significant way that errors are classified is by their condition
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 names---the names used to match errors with handlers. An error symbol
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 serves only as a convenient way to specify the intended error message
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 and list of condition names. It would be cumbersome to give
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 @code{signal} a list of condition names rather than one error symbol.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 By contrast, using only error symbols without condition names would
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 seriously decrease the power of @code{condition-case}. Condition names
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 make it possible to categorize errors at various levels of generality
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 when you write an error handler. Using error symbols alone would
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 eliminate all but the narrowest level of classification.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @xref{Standard Errors}, for a list of all the standard error symbols
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 and their conditions.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @node Cleanups
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @subsection Cleaning Up from Nonlocal Exits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 The @code{unwind-protect} construct is essential whenever you
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 temporarily put a data structure in an inconsistent state; it permits
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 you to make the data consistent again in the event of an error or
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 throw. (Another more specific cleanup construct that is used only for
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 changes in buffer contents is the atomic change group; @ref{Atomic
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 Changes}.)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 @defspec unwind-protect body-form cleanup-forms@dots{}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 @cindex cleanup forms
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 @cindex protected forms
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @cindex error cleanup
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 @cindex unwinding
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @code{unwind-protect} executes @var{body-form} with a guarantee that
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 the @var{cleanup-forms} will be evaluated if control leaves
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 @var{body-form}, no matter how that happens. @var{body-form} may
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 complete normally, or execute a @code{throw} out of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @code{unwind-protect}, or cause an error; in all cases, the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @var{cleanup-forms} will be evaluated.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 If @var{body-form} finishes normally, @code{unwind-protect} returns the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 value of @var{body-form}, after it evaluates the @var{cleanup-forms}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 If @var{body-form} does not finish, @code{unwind-protect} does not
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 return any value in the normal sense.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 Only @var{body-form} is protected by the @code{unwind-protect}. If any
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 of the @var{cleanup-forms} themselves exits nonlocally (via a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 @code{throw} or an error), @code{unwind-protect} is @emph{not}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 guaranteed to evaluate the rest of them. If the failure of one of the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 @var{cleanup-forms} has the potential to cause trouble, then protect
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 it with another @code{unwind-protect} around that form.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 The number of currently active @code{unwind-protect} forms counts,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 together with the number of local variable bindings, against the limit
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 @code{max-specpdl-size} (@pxref{Definition of max-specpdl-size,, Local
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 Variables}).
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 @end defspec
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 For example, here we make an invisible buffer for temporary use, and
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 make sure to kill it before finishing:
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 (save-excursion
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 (let ((buffer (get-buffer-create " *temp*")))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 (set-buffer buffer)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 (unwind-protect
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 @var{body-form}
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 (kill-buffer buffer))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 @noindent
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 You might think that we could just as well write @code{(kill-buffer
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 (current-buffer))} and dispense with the variable @code{buffer}.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 However, the way shown above is safer, if @var{body-form} happens to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 get an error after switching to a different buffer! (Alternatively,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 you could write another @code{save-excursion} around @var{body-form},
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 to ensure that the temporary buffer becomes current again in time to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 kill it.)
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 Emacs includes a standard macro called @code{with-temp-buffer} which
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 expands into more or less the code shown above (@pxref{Definition of
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 with-temp-buffer,, Current Buffer}). Several of the macros defined in
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 this manual use @code{unwind-protect} in this way.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 @findex ftp-login
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 Here is an actual example derived from an FTP package. It creates a
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 process (@pxref{Processes}) to try to establish a connection to a remote
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 machine. As the function @code{ftp-login} is highly susceptible to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 numerous problems that the writer of the function cannot anticipate, it
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 is protected with a form that guarantees deletion of the process in the
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 event of failure. Otherwise, Emacs might fill up with useless
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 subprocesses.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 @smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 @group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 (let ((win nil))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 (unwind-protect
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 (progn
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 (setq process (ftp-setup-buffer host file))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 (if (setq win (ftp-login process host user password))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 (message "Logged in")
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 (error "Ftp login failed")))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 (or win (and process (delete-process process)))))
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 @end group
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 @end smallexample
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 This example has a small bug: if the user types @kbd{C-g} to
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 quit, and the quit happens immediately after the function
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 @code{ftp-setup-buffer} returns but before the variable @code{process} is
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 set, the process will not be killed. There is no easy way to fix this bug,
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 but at least it is very unlikely.
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 @ignore
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 arch-tag: 8abc30d4-4d3a-47f9-b908-e9e971c18c6d
80d720ce6dae Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 @end ignore