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