Permalink
Browse files

format directive tildes lowered and included into the index; logic fu…

…nctions corrected; minor additions and corrections
  • Loading branch information...
1 parent c25cff2 commit 6b2316e48f2127171ca261aff53060067f2178f9 @trebb committed Sep 6, 2008
Showing with 198 additions and 164 deletions.
  1. +2 −0 TODO
  2. +2 −1 clqr-clos.tex
  3. +8 −1 clqr-compiler.tex
  4. +95 −90 clqr-conditions-and-errors.tex
  5. +9 −9 clqr-environment.tex
  6. +6 −6 clqr-hash-tables.tex
  7. +27 −27 clqr-input-output.tex
  8. +14 −12 clqr-numbers.tex
  9. +1 −1 clqr-types-and-classes.tex
  10. +34 −17 clqr.tex
View
2 TODO
@@ -4,6 +4,8 @@
+* lower stars, mainly in variable names
+
* FINAL TESTS
- multiple return values mentioned and usage of the three \retvals
View
@@ -357,7 +357,8 @@ \subsection{Classes}
(\OPn{\VAR{ord-$\lambda$}})
(\GOOs{\VAR{name} \xorGOO{%
\GOOp{\VAR{list}\XOR\kwd{*}}\\
- \VAR{predicate}}{\}} \orGOO{%
+ \VAR{predicate}}{\}}
+ \orGOO{%
\kwd{:description} \VAR{ control}\\
\kwd{:order }
\xorGOO{\kwd{:most-specific-first}\\
View
@@ -231,7 +231,7 @@ \subsection{Compilation}
\IT{(\MC*{UNTRACE} \OPn{\VAR{function}})}
{
- Stop \VAR{function}s, or each currently traced function from being
+ Stop \VAR{function}s, or each currently traced function, from being
traced.
}
@@ -246,6 +246,13 @@ \subsection{Compilation}
\VAR{form}}.
}
+ \IT{(\FU*{BREAK} \Op{\VAR{control} \OPn{\VAR{arg}}})}
+ {
+ Jump directly into debugger; return \retval{\NIL}.
+ See p.\ \pageref{section:Format}, \FU{format}, for \VAR{control}
+ and \VAR{arg}s.
+ }
+
\IT{(\MC*{TIME} \OPn{\VAR{form}})}
{
Evaluate \VAR{form}s and print timing information to
@@ -11,69 +11,15 @@
\section{Conditions and Errors}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\begin{figure}[hbt]
- \begin{center}
- \boxGOO{%
- \T\index{T}%
- \boxGOO{%
- \kwd*{CONDITION}\\
- \boxGOO{%
- \kwd*{WARNING}
- \boxGOO{%
- \kwd*{STYLE-WARNING}\\
- \kwd*{SIMPLE-CONDITION}\footnotemark[2]
- \boxGOO{%
- \kwd*{SIMPLE-WARNING}}}\boxGOOcr
- \kwd*{SERIOUS-CONDITION}\\
- \boxGOO{%
- \kwd*{ERROR}\\
- \boxGOO{%
- \kwd*{CELL-ERROR}
- \boxGOO{%
- \kwd*{UNBOUND-VARIABLE},\>
- \kwd*{UNBOUND-SLOT},\\
- \kwd*{UNDEFINED-FUNCTION}}\boxGOOcr
- \kwd*{STREAM-ERROR}
- \boxGOO{%
- \kwd*{END-OF-FILE}\\
- \kwd*{PARSE-ERROR}\footnotemark[2]
- \boxGOO{\kwd*{READER-ERROR}}}\boxGOOcr
- \kwd*{ARITHMETIC-ERROR}\\
- \boxGOO{%
- \kwd*{DIVISION-BY-ZERO},\>
- \kwd*{FLOATING-POINT-INEXACT},\\
- \kwd*{FLOATING-POINT-INVALID-OPERATION},\\
- \kwd*{FLOATING-POINT-OVERFLOW},\>
- \kwd*{FLOATING-POINT-UNDERFLOW}}\boxGOOcr
- \kwd*{TYPE-ERROR}
- \boxGOO{%
- \kwd*{SIMPLE-CONDITION}\footnotemark[2]
- \boxGOO{%
- \kwd*{SIMPLE-TYPE-ERROR}}}\boxGOOcr
- \kwd*{SIMPLE-CONDITION}\footnotemark[2]
- \boxGOO{%
- \kwd*{SIMPLE-ERROR}}\boxGOOcr
- \kwd*{PARSE-ERROR},\>
- \kwd*{PROGRAM-ERROR},\>
- \kwd*{CONTROL-ERROR},\\
- \kwd*{PACKAGE-ERROR},\>
- \kwd*{FILE-ERROR},\>
- \kwd*{PRINT-NOT-READABLE}}\boxGOOcr
- \kwd*{STORAGE-CONDITION}}\boxGOOcr
- \kwd*{SIMPLE-CONDITION}}}}\\
- \end{center}\vspace{-1em}
- {\footnotesize\footnotemark[2]For supertypes of this
- type look for the instance without a \footnotemark[2].}
- \caption{Condition Types.}%
-\end{figure}
-
\begin{LIST}{1cm}
\IT{(\MC*{DEFINE-CONDITION} \VAR{foo} (\OPn{\VAR{parent-type}}\DF{\kwd{condition}})
(\xorGOO{\VAR{slot}\\
(\VAR{slot}
- \orGOO{\Goos{\kwd{:reader} \VAR{reader-function}}\\
- \Goos{\kwd{:writer} \VAR{writer-function}} \\
- \Goos{\kwd{:accessor} \VAR{reader-function}} \\
+ \orGOO{\Goos{\kwd{:reader} \VAR{reader}}\\
+ \Goos{\kwd{:writer} \xorGOO{%
+ \VAR{writer}\\
+ (\kwd{setf } \VAR{writer})}{\}}}\\
+ \Goos{\kwd{:accessor} \VAR{reader}} \\
\kwd{:allocation } \xorGOO{\kwd{:instance}\\
\kwd{:class}}{\}}\DF{\kwd{:instance}}\\
\Goos{\kwd{:initarg} \kwd{:}\VAR{initarg-name}}\\
@@ -84,36 +30,37 @@ \section{Conditions and Errors}
\orGOO{(\kwd{:default-initargs } \Goos{\VAR{name} \VAR{value}})\\
({\kwd{:documentation} \VAR{ condition-doc}})\\
(\kwd{:report} \xorGOO{\VAR{string}\\
- \VAR{report-function}}{\}})}{\}})}
+ \VAR{report-function}}{\}})}{\}})}
{
Define, as a subtype of \VAR{parent-type}s, condition type
\retval{\VAR{foo}}. In new conditions, a \VAR{slot}'s value defaults
- to \VAR{form} unless set by \kwd{:}\VAR{initarg-name} and is
- accessible by \VAR{reader-function} and \VAR{writer-function}. With
+ to \VAR{form} unless set by \kwd{:}\VAR{initarg-name}, and is
+ accessible by function \VAR{reader} and by generic function \VAR{writer}. 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} \OPn{\VAR{initarg-plist}})}
+ \IT{(\FU*{MAKE-CONDITION} \VAR{type} \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}})}
{
Return \retval{new condition of \VAR{type}}.
}
- \IT{(\FU*{UNWIND-PROTECT} \VAR{protected} \OPn{\VAR{cleanup}})}
+ \IT{(\SO*{UNWIND-PROTECT} \VAR{protected} \OPn{\VAR{cleanup}})}
{
Evaluate \VAR{protected} and then, no matter how control leaves
\VAR{protected}, \VAR{cleanup}s. Return \retval{values of
\VAR{protected}}.
}
- \IT{(\xorGOO{\FU*{SIGNAL}\\
+ \IT{(\xorGOO{%
+ \FU*{SIGNAL}\\
\FU*{WARN}\\
\FU*{ERROR}%
}{\}}
\xorGOO{%
\VAR{condition}\\
- \VAR{type}\text{ } \OPn{\VAR{initarg}}\\
+ \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
\VAR{control}\text{ } \OPn{\VAR{arg}}%
}{\}})}
{
@@ -127,7 +74,7 @@ \section{Conditions and Errors}
\IT{(\FU*{CERROR} \VAR{continue-control}
\xorGOO{%
\VAR{condition}\text{ } \OPn{\VAR{continue-arg}}\\
- \VAR{type}\text{ } \OPn{\VAR{initarg}}\\
+ \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
\VAR{control}\text{ } \OPn{\VAR{arg}}%
}{\}})}
{
@@ -150,18 +97,18 @@ \section{Conditions and Errors}
Invoke debugger with \VAR{condition}.
}
- \IT{(\FU*{BREAK} \Op{\VAR{control} \OPn{\VAR{arg}}})}
- {
- Jump into debugger; return \retval{\NIL}.
- See p.\ \pageref{section:Format}, \FU{format}, for \VAR{control}
- and \VAR{arg}s.
- }
-
- \IT{(\MC*{ASSERT} \VAR{test} \OP{(\OPn{\VAR{place}}) \Op{\VAR{datum}
- \OPn{\VAR{arg}}}})}
+ \IT{(\MC*{ASSERT} \VAR{test} \OP{(\OPn{\VAR{place}})
+ \Op{%
+ \xorGOO{%
+ \VAR{condition}\text{ } \OPn{\VAR{continue-arg}}\\
+ \VAR{type}\text{ } \Goos{\kwd{:}\VAR{initarg-name} \VAR{value}}\\
+ \VAR{control}\text{ } \OPn{\VAR{arg}}}{\}}}})}
{
- Signal correctable error denoted by \VAR{datum} and \VAR{arg}s if
- \VAR{test}, which may depend on \VAR{place}s, returns \NIL. Return
+ 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
+ p.\ \pageref{section:Format}), \kwd{error}. When using the
+ debugger's continue option, \VAR{place}s can be altered. Return
\retval{\NIL}.
}
@@ -181,10 +128,11 @@ \section{Conditions and Errors}
}
\IT{(\MC*{HANDLER-BIND} (\OPn{(\VAR{condition-type}
- \VAR{handler})}) \OPn{\VAR{form}})}
+ \VAR{handler-function})}) \OPn{\VAR{form}})}
{
Evaluate \VAR{form}s with \VAR{condition-type}s dynamically bound to
- their respective \VAR{handler}. Return \retval{values of \VAR{form}s}.
+ their respective \VAR{handler-function}s of argument
+ condition. Return \retval{values of \VAR{form}s}.
}
\IT{(\MC*{WITH-SIMPLE-RESTART} (\VAR{restart} \VAR{control}
@@ -197,22 +145,15 @@ \section{Conditions and Errors}
and \retvalii{\T}.
}
- \IT{(\MC*{WITH-CONDITION-RESTARTS} \VAR{condition-form}
- \VAR{restarts-form} \OPn{\VAR{form}})}
- {
- Evaluate \VAR{form}s with restarts yielded from \VAR{restarts-form}
- dynamically associated with condition yielded from
- \VAR{condition-form}. Return values of \VAR{form}s.
- }
-
- \IT{(\MC*{RESTART-CASE} \VAR{test} \OPn{(\VAR{name} (\OPn{\VAR{ord-$\lambda$}})
+ \IT{(\MC*{RESTART-CASE} \VAR{test} \OPn{(\VAR{foo} %FIXME:AUGMENT
+ (\OPn{\VAR{ord-$\lambda$}})
\orGOO{\kwd{:interactive}
\VAR{ form}\\
\kwd{:report} \VAR{ form}\\
\kwd{:test} \VAR{ form}}{\}} \OPn{(\kwd{declare} \OPn{\NEV{\VAR{decl}}})}
\OPn{form})})}
{
- Evaluate \VAR{test} with new restarts \VAR{name}. Return
+ Evaluate \VAR{test} with new restarts \VAR{foo}. Return
\retval{values of \VAR{test}} or, if any of the restarts is invoked,
return \retval{values of its last \VAR{form}}.
For (\OPn{\VAR{ord-$\lambda$}}) see p.\ \pageref{section:Functions}.
@@ -264,6 +205,70 @@ \section{Conditions and Errors}
or return \retval{\NIL} for the rest.
}
+ \IT{(\MC*{WITH-CONDITION-RESTARTS} \VAR{condition-form}
+ \VAR{restarts-form} \OPn{\VAR{form}})}
+ {
+ Evaluate \VAR{form}s with restarts yielded from \VAR{restarts-form}
+ dynamically associated with conditions yielded from
+ \VAR{condition-form}. Return values of \VAR{form}s.
+ }
+
+\begin{figure}
+ \begin{center}
+ \boxGOO{%
+ \T\index{T}%
+ \boxGOO{%
+ \kwd*{CONDITION}\\
+ \boxGOO{%
+ \kwd*{WARNING}
+ \boxGOO{%
+ \kwd*{STYLE-WARNING}\\
+ \kwd*{SIMPLE-CONDITION}\footnotemark[2]
+ \boxGOO{%
+ \kwd*{SIMPLE-WARNING}}}\boxGOOcr
+ \kwd*{SERIOUS-CONDITION}\\
+ \boxGOO{%
+ \kwd*{ERROR}\\
+ \boxGOO{%
+ \kwd*{CELL-ERROR}
+ \boxGOO{%
+ \kwd*{UNBOUND-VARIABLE},\>
+ \kwd*{UNBOUND-SLOT},\\
+ \kwd*{UNDEFINED-FUNCTION}}\boxGOOcr
+ \kwd*{STREAM-ERROR}
+ \boxGOO{%
+ \kwd*{END-OF-FILE}\\
+ \kwd*{PARSE-ERROR}\footnotemark[2]
+ \boxGOO{\kwd*{READER-ERROR}}}\boxGOOcr
+ \kwd*{ARITHMETIC-ERROR}\\
+ \boxGOO{%
+ \kwd*{DIVISION-BY-ZERO},\>
+ \kwd*{FLOATING-POINT-INEXACT},\\
+ \kwd*{FLOATING-POINT-INVALID-OPERATION},\\
+ \kwd*{FLOATING-POINT-OVERFLOW},\>
+ \kwd*{FLOATING-POINT-UNDERFLOW}}\boxGOOcr
+ \kwd*{TYPE-ERROR}
+ \boxGOO{%
+ \kwd*{SIMPLE-CONDITION}\footnotemark[2]
+ \boxGOO{%
+ \kwd*{SIMPLE-TYPE-ERROR}}}\boxGOOcr
+ \kwd*{SIMPLE-CONDITION}\footnotemark[2]
+ \boxGOO{%
+ \kwd*{SIMPLE-ERROR}}\boxGOOcr
+ \kwd*{PARSE-ERROR},\>
+ \kwd*{PROGRAM-ERROR},\>
+ \kwd*{CONTROL-ERROR},\\
+ \kwd*{PACKAGE-ERROR},\>
+ \kwd*{FILE-ERROR},\>
+ \kwd*{PRINT-NOT-READABLE}}\boxGOOcr
+ \kwd*{STORAGE-CONDITION}}\boxGOOcr
+ \kwd*{SIMPLE-CONDITION}}}}\\
+ \end{center}\vspace{-1em}
+ {\footnotesize\footnotemark[2]For supertypes of this
+ type look for the instance without a \footnotemark[2].}
+ \caption{Condition Types.}%
+\end{figure}
+
\IT{\arrGOO{(\FU*{ARITHMETIC-ERROR-OPERATION} \VAR{ condition})\\
(\FU*{ARITHMETIC-ERROR-OPERANDS} \VAR{ condition})}{.}}
{
View
@@ -24,23 +24,23 @@ \section{Environment}
Number of clock ticks per second.
}
+ \IT{\arrGOO{(\FU*{ENCODE-UNIVERSAL-TIME} \VAR{ sec} \VAR{ min}
+ \VAR{ hour} \VAR{ day} \VAR{ month} \VAR{ year }
+ \Op{\VAR{zone}\DF{curr}})\\
+ (\FU*{GET-UNIVERSAL-TIME})}{.}}
+ {
+ \retval{Seconds from 1900-01-01, 00:00}.
+ }
+
\IT{\arrGOO{(\FU*{DECODE-UNIVERSAL-TIME} \VAR{ universal-time }
- \Op{\VAR{time-zone}})\\
+ \Op{\VAR{time-zone}\DF{current}})\\
(\FU*{GET-DECODED-TIME})}{.}}
{
Return \retval{second}, \retvalii{minute}, \retvaliii{hour},
\retvaln{4}{date}, \retvaln{5}{month}, \retvaln{6}{year}, \retvaln{7}{day},
\retvaln{8}{daylight-p}, and \retvaln{9}{zone}.
}
- \IT{\arrGOO{(\FU*{ENCODE-UNIVERSAL-TIME} \VAR{ sec} \VAR{ min}
- \VAR{ hour} \VAR{ day} \VAR{ month} \VAR{ year }
- \Op{\VAR{zone}})\\
- (\FU*{GET-UNIVERSAL-TIME})}{.}}
- {
- \retval{Seconds from 1900-01-01, 00:00}.
- }
-
\IT{(\FU*{ROOM} \Op{\Goo{\NIL\XOR\kwd{:default}\XOR\T}})}
{
Print information about internal storage management.
View
@@ -24,7 +24,7 @@ \section{Hash Tables}
\IT{(\FU*{MAKE-HASH-TABLE}
\orGOO{\kwd{:test}\Goo{\FU{eq}\XOR \FU{eql}\XOR
- \FU{equal}}\DF{\FU{eql}}\\
+ \FU{equal}}\DF{\kwd{eql}}\\
\kwd{:size} \VAR{ int}\\
\kwd{:rehash-size} \VAR{ int}\\
\kwd{:rehash-threshold} \VAR{ int}}{\}})}
@@ -37,7 +37,7 @@ \section{Hash Tables}
\retval{Test function} used in \VAR{hash-table}.
}
- \IT{(\FU*{GETHASH} \VAR{key} \VAR{hash-table} \Op{\VAR{default}})}
+ \IT{(\FU*{GETHASH} \VAR{key} \VAR{hash-table} \Op{\VAR{default}\DF{\NIL}})}
{
Return \retval{object} with \VAR{key} if any or \retval{\VAR{default}}
otherwise; and \retvalii{\T} if found, \retvalii{\NIL}
@@ -62,15 +62,15 @@ \section{Hash Tables}
\IT{(\FU*{MAPHASH} \VAR{function} \VAR{hash-table})}
{
- Iterate over \VAR{hash-table} calling \VAR{function} on \VAR{key}
- and \VAR{value}. Return \retval{\NIL}.
+ Iterate over \VAR{hash-table} calling \VAR{function} on key
+ and value. Return \retval{\NIL}.
}
- \IT{(\MC*{WITH-HASH-TABLE-ITERATOR} (\VAR{name} \VAR{hash-table})
+ \IT{(\MC*{WITH-HASH-TABLE-ITERATOR} (\VAR{foo} \VAR{hash-table})
\OPn{(\kwd{declare} \OPn{\NEV{\VAR{decl}}})} \OPn{\VAR{form}})}
{
Return \retval{values of \VAR{form}s}. In \VAR{form}s,
- invocations of (\VAR{name}) return: \T\ if an entry is returned;
+ invocations of (\VAR{foo}) return: \T\ if an entry is returned;
its key; its value.
}
Oops, something went wrong.

0 comments on commit 6b2316e

Please sign in to comment.