Minor edits in section Conditions and Errors
authorBert Burgemeister <trebbu@googlemail.com>
Wed, 22 Aug 2012 04:33:16 +0000 (22 06:33 +0200)
committerBert Burgemeister <trebbu@googlemail.com>
Wed, 22 Aug 2012 04:33:16 +0000 (22 06:33 +0200)
clqr-conditions-and-errors.tex

index 474a4b6..ac2303a 100644 (file)
@@ -15,7 +15,8 @@ For standardized condition types cf.\ Figure \ref{data-types} on
 page \pageref{data-types}.
 
 \begin{LIST}{1cm}
-  \IT{(\MC*{DEFINE-CONDITION} \VAR{foo} (\OPn{\VAR{parent-type}}\DF{\kwd{condition}})
+  \IT{(\MC*{DEFINE-CONDITION}
+    \VAR{foo} (\OPn{\VAR{parent-type}}\DF{\kwd{condition}})
     (\xorGOO{\VAR{slot}\\
       (\VAR{slot } 
       \orGOO{\Goos{\kwd{:reader} \VAR{reader}}\\
@@ -35,20 +36,21 @@ page \pageref{data-types}.
       (\kwd{:report } \xorGOO{\VAR{string}\\
         \VAR{report-function}}{\}})}{\}})}
   {
-  Define, as a subtype of \VAR{parent-type}s, condition type
-  \retval{\VAR{foo}}. In a new condition, a \VAR{slot}'s value defaults
-  to \VAR{form} unless set via \kwd{:}\VAR{initarg-name}; it is readable
-  via (\VAR{reader} \VAR{i}) or (\VAR{accessor} \VAR{i}), and
-  writable via (\VAR{writer} \VAR{value} \VAR{i}) or (\kwd{setf}
-  (\VAR{accessor} \VAR{i}) \VAR{value}). With
-  \kwd{:allocation :class}, \VAR{slot} is shared by all conditions of
-  type \VAR{foo}. A condition is reported by \VAR{string} or by
-  \VAR{report-function} of arguments condition and stream.
+    Define, as a subtype of \VAR{parent-type}s, condition type
+    \retval{\VAR{foo}}. In a new condition, a \VAR{slot}'s value
+    defaults to \VAR{form} unless set via \kwd{:}\VAR{initarg-name};
+    it is readable via (\VAR{reader} \VAR{i}) or (\VAR{accessor}
+    \VAR{i}), and writable via (\VAR{writer} \VAR{value} \VAR{i}) or
+    (\kwd{setf} (\VAR{accessor} \VAR{i}) \VAR{value}). With
+    \kwd{:allocation :class}, \VAR{slot} is shared by all conditions
+    of type \VAR{foo}. A condition is reported by \VAR{string} or by
+    \VAR{report-function} of arguments condition and stream.
   }
 
-  \IT{(\FU*{MAKE-CONDITION} \VAR{type} \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}})}
+  \IT{(\FU*{MAKE-CONDITION} 
+    \VAR{condition-type} \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}})}
   {
-  Return new \retval{condition of \VAR{type}}.
+  Return new \retval{instance of \VAR{condition-type}}.
   }
 
   \IT{(\xorGOO{%
@@ -58,30 +60,32 @@ page \pageref{data-types}.
     }{\}}
     \xorGOO{%
       \VAR{condition}\\
-      \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\ 
+      \VAR{condition-type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\ 
       \VAR{control}\text{ } \OPn{\VAR{arg}}%
     }{\}})}
   {
-  Unless handled, signal as \kwd{condition}, \kwd{warning} or \kwd{error},
-  respectively, \VAR{condition} or a new condition of \VAR{type} or,
-  with \FU{format} \VAR{control} and \VAR{arg}s (see page \pageref{section:Format}),
-  \kwd{simple-condition}, \kwd{simple-warning}, or \kwd{simple-error}, respectively.
-  From \FU{SIGNAL} and \FU{WARN}, return \retval{\NIL}.
+    Unless handled, signal as \kwd{condition}, \kwd{warning} or
+    \kwd{error}, respectively, \VAR{condition} or a new instance of
+    \VAR{condition-type} or, with \FU{format} \VAR{control} and
+    \VAR{arg}s (see page \pageref{section:Format}),
+    \kwd{simple-condition}, \kwd{simple-warning}, or
+    \kwd{simple-error}, respectively.  From \FU{SIGNAL} and \FU{WARN},
+    return \retval{\NIL}.
   }
 
   \IT{(\FU*{CERROR} \VAR{continue-control}
     \xorGOO{%
       \VAR{condition}\text{ }  \OPn{\VAR{continue-arg}}\\
-      \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
+      \VAR{condition-type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
       \VAR{control}\text{ } \OPn{\VAR{arg}}%
     }{\}})}
   {
-  Unless handled, signal as correctable \kwd{error} \VAR{condition} or
-  a new condition of \VAR{type} or, with \FU{format} \VAR{control} and
-  \VAR{arg}s (see page \pageref{section:Format}),
-  \kwd{simple-error}. In the debugger, use \FU{format} arguments
-  \VAR{continue-control} and \VAR{continue-arg}s to tag the continue
-  option. Return \retval{\NIL}.
+    Unless handled, signal as correctable \kwd{error} \VAR{condition}
+    or a new instance of \VAR{condition-type} or, with \FU{format}
+    \VAR{control} and \VAR{arg}s (see page \pageref{section:Format}),
+    \kwd{simple-error}. In the debugger, use \FU{format} arguments
+    \VAR{continue-control} and \VAR{continue-arg}s to tag the continue
+    option. Return \retval{\NIL}.
   }
 
   \IT{(\MC*{IGNORE-ERRORS} \PROGN{\VAR{form}})}
@@ -99,15 +103,17 @@ page \pageref{data-types}.
       \Op{%
         \xorGOO{%
           \VAR{condition}\text{ }  \OPn{\VAR{continue-arg}}\\
-          \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
+          \VAR{condition-type}\text{ } 
+          \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
           \VAR{control}\text{ } \OPn{\VAR{arg}}}{\}}}})}
   {
     If \VAR{test}, which may depend on \VAR{place}s, returns \NIL,
-    signal as correctable \kwd{error} \VAR{condition} or a new condition
-    of \VAR{type} or, with \FU{format} \VAR{control} and \VAR{arg}s (see
-    page \pageref{section:Format}), \kwd{error}. When using the
-    debugger's continue option, \VAR{place}s can be altered before
-    re-evaluation of \VAR{test}. Return \retval{\NIL}. 
+    signal as correctable \kwd{error} \VAR{condition} or a new
+    instance of \VAR{condition-type} or, with \FU{format}
+    \VAR{control} and \VAR{arg}s (see page \pageref{section:Format}),
+    \kwd{error}. When using the debugger's continue option,
+    \VAR{place}s can be altered before re-evaluation of
+    \VAR{test}. Return \retval{\NIL}.
   }
 
   \IT{(\MC*{HANDLER-CASE} \VAR{foo} 
@@ -141,11 +147,11 @@ page \pageref{data-types}.
       \NIL}{\}} \VAR{control}
     \OPn{\VAR{arg}}) \PROGN{\VAR{form}})}
   {
-    Return \retval{values of \VAR{form}s} unless \VAR{restart} is called
-    during their evaluation. In this case, describe restart using
-    \FU{format} \VAR{control} and \VAR{arg}s (see
-    page \pageref{section:Format}) and return \retval{\NIL}
-    and \retvalii{\T}.
+    Return \retval{values of \VAR{form}s} unless \VAR{restart} is
+    called during their evaluation. In this case, describe
+    \VAR{restart} using \FU{format} \VAR{control} and \VAR{arg}s (see
+    page \pageref{section:Format}) and return \retval{\NIL} and
+    \retvalii{\T}.
   }
 
   \IT{(\MC*{RESTART-CASE} \VAR{form}
@@ -189,19 +195,20 @@ page \pageref{data-types}.
   \IT{\arrGOO{(\FU*{INVOKE-RESTART} \VAR{ restart} \OPn{\VAR{ arg}})\\
       (\FU*{INVOKE-RESTART-INTERACTIVELY} \VAR{ restart})}{.}}
   {
-  Call function associated with \VAR{restart} with arguments given or
-  prompted for, respectively. If \VAR{restart} function returns,
-  return \retval{its values}.
+    Call function associated with \VAR{restart} with arguments given
+    or prompted for, respectively. If \VAR{restart} function returns,
+    return \retval{its values}.
   }
 
-  \IT{(\xorGOO{\FU*{COMPUTE-RESTARTS}\\
-      \FU*{FIND-RESTART} \VAR{ name}}{\}} \Op{\VAR{condition}})}
+  \IT{(\xorGOO{%
+      \FU*{FIND-RESTART}\\
+      \FU*{COMPUTE-RESTARTS} \VAR{ name}}{\}} \Op{\VAR{condition}})}
   {
-  Return list of \retval{all restarts}, or innermost \retval{restart}
-  \VAR{name}, respectively, out of those either associated
-  with \VAR{condition} or un-associated at all; or, without
-  \VAR{condition}, out of all restarts. Return \retval{\NIL} if search
-  is unsuccessful.
+    Return innermost \retval{restart} \VAR{name}, or a \retval{list of
+      all restarts}, respectively, out of those either associated with
+    \VAR{condition} or un-associated at all; or, without
+    \VAR{condition}, out of all restarts. Return \retval{\NIL} if
+    search is unsuccessful.
   }
 
   \IT{(\FU*{RESTART-NAME} \VAR{restart})}