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