From 18dba52be0f96f91fdb41717ffaaec82783e0865 Mon Sep 17 00:00:00 2001 From: tailor Date: Fri, 13 Jun 2008 16:46:21 +0200 Subject: [PATCH] minor changes --- DATE.tex | 2 +- REVISION.tex | 2 +- clqr-compiler.tex | 74 ++++++------------- clqr-environment.tex | 13 +++- clqr-symbols-and-packages.tex | 147 +++++++++++++++++++++----------------- clqr-system-types-and-classes.tex | 37 ++++++---- 6 files changed, 139 insertions(+), 136 deletions(-) diff --git a/DATE.tex b/DATE.tex index 1b3c359..f54fb99 100644 --- a/DATE.tex +++ b/DATE.tex @@ -1 +1 @@ -2008-06-11 \ No newline at end of file +2008-06-13 \ No newline at end of file diff --git a/REVISION.tex b/REVISION.tex index 3cacc0b..da2d398 100644 --- a/REVISION.tex +++ b/REVISION.tex @@ -1 +1 @@ -12 \ No newline at end of file +14 \ No newline at end of file diff --git a/clqr-compiler.tex b/clqr-compiler.tex index b2eee81..ae9f281 100644 --- a/clqr-compiler.tex +++ b/clqr-compiler.tex @@ -32,6 +32,16 @@ \begin{LIST}{1cm} + \IT{(\kwd*{WITH-COMPILATION-UNIT} (\Op{\kwd{:override} + \VAR{bool}\DF{\NIL}}) \OPn{\VAR{form}})} + Return \retval{values of \VAR{form}s}. Warnings deferred by the + compiler until end of compilation are deferred until the end of + evaluation of \VAR{form}s. + + \IT{(\FU*{COMPILE} \VAR{name} \Op{\VAR{definition}})} + Return \retval{compiled function} \VAR{name}, \retvalii{\T} in case + of warnings, and \retvaliii{\T} in case of failure. + \IT{(\FU*{COMPILE-FILE} \VAR{path} \orGOO{\kwd{:output-file}\VAR{ out-path}\\ \kwd{:verbose} \VAR{ bool}\DF{\kwd{*compile-verbose*}}\\ @@ -67,20 +77,18 @@ \V*{*load-verbose*}}{\}}} Defaults used in \FU{load}. - \IT{(\SF*{EVAL-WHEN} (\orGOO{{\kwd{:compile-toplevel}}\\ \kwd{:load-toplevel}\\ - \kwd{:execute}}{\}}) \OPn{\VAR{form}})} Evaluate \VAR{form}s returning - \retval{value of last \VAR{form}} if \SF{EVAL-WHEN} is in the - top-level of a file being compiled, in the top-level of a compiled file being - loaded, or anywhere, resp. - \IT{(\SF*{EVAL-WHEN} (% \orGOO{\kwd{:compile-toplevel}\\ \kwd{:load-toplevel}\\ \kwd{:execute}}{\}}) \OPn{\VAR{form}})} - Evaluate \VAR{form}s returning - \retval{value of last \VAR{form}} if \SF{EVAL-WHEN} is in the - top-level of a file being compiled, in the top-level of a compiled file being - loaded, or anywhere, resp. + Evaluate \VAR{form}s returning \retval{value of last \VAR{form}} if + \SF{EVAL-WHEN} is in the top-level of a file being compiled, in the + top-level of a compiled file being loaded, or anywhere, resp. + + \IT{(\SF*{LOAD-TIME-VALUE} \VAR{form} + \Op{\VAR{read-only}\DF{\NIL}})} + Evaluate \VAR{form} at compile time and treat \retval{its value} as literal + at run time. \IT{(\SF*{QUOTE} \VAR{foo})\XOR \kwd{'}\VAR{foo}} Return \retval{unevaluated \VAR{foo}}. @@ -93,26 +101,12 @@ \Op{\VAR{package}\DF{\kwd{*package*}}}})} Intern fresh \retval{symbol} in package. - \IT{(\SF*{MACROEXPAND-1} \VAR{form})} - Return \retval{macro expansion of \VAR{form}} and \retval{\T} if - \VAR{form} is a macro form. + \IT{\arrGOO{(\SF*{MACROEXPAND-1} \VAR{form})\\ + (\SF*{MACROEXPAND} \VAR{form})}{\}}} + Return \retval{macro expansion}, once or entirely, resp., of \VAR{form} and + \retvalii{\T} if \VAR{form} is a macro form. Return \retval{\VAR{form}} and \retval{\NIL} otherwise. - \IT{(\kwd*{WITH-COMPILATION-UNIT} (\Op{\kwd{:override} - \VAR{bool}\DF{\NIL}}) \OPn{\VAR{form}})} - Return \retval{values of \VAR{form}s}. Warnings deferred by the - compiler until end of compilation are deferred until the end of - evaluation of \VAR{form}s. - - \IT{(\FU*{COMPILE} \VAR{name} \Op{\VAR{definition}})} - Return \retval{compiled function} \VAR{name}, \retvalii{\T} in case - of warnings, and \retvaliii{\T} in case of failure. - - \IT{(\SF*{LOAD-TIME-VALUE} \VAR{form} - \Op{\VAR{read-only}\DF{\NIL}})} - Evaluate \VAR{form} at compile time and treat \retval{its value} as literal - at run time. - \IT{(\SF*{TIME} \OPn{\VAR{form}})} Evaluate \VAR{form}s and print timing information on \V{*trace-output*}. Return \retval{values of \VAR{form}s}. @@ -127,15 +121,6 @@ \IT{\V*{*trace-output*}} Stream \kwd{trace}d function and \kwd{time} print their output on. - - \IT{(\FU*{SYMBOL-NAME} \VAR{ symbol})} - \retval{Name} of \VAR{symbol}. - - \IT{\arrGOO{(\FU*{SYMBOL-FUNCTION} \VAR{ symbol})\\ - (\FU*{SYMBOL-VALUE} \VAR{ symbol})\\ - (\FU*{SYMBOL-PLIST} \VAR{ symbol})}{\}}} - \retval{Function}, \retval{value}, or \retval{property list}, resp., of \VAR{symbol}. \kwd{setf}able. - \IT{(\kwd*{COMPILER-MACRO-FUNCTION} \VAR{name} \Op{\VAR{environment}})} \retval{Compiler macro function}. \kwd{setfable}. @@ -167,13 +152,6 @@ Make \retval{two forms} yielding something equvalent to \VAR{foo} but preserving only \VAR{slots}. - \IT{(\FU*{MAKE-SYMBOL} \VAR{name})} - Make fresh, uninterned \retval{symbol \VAR{name}}. - - \IT{(\FU*{COPY-SYMBOL} \VAR{symbol} \Op{\VAR{props}\DF{\NIL}})} - Return uninterned \retval{copy of \VAR{symbol}}. If \VAR{props} is - \T, the copy has the same value, function, and property list. - \IT{(\FU*{MAKUNBOUND} \VAR{symbol})} Make \retval{\VAR{symbol}} unbound. @@ -202,14 +180,6 @@ \IT{(\FU*{EVAL} \VAR{form})} Return \retval{values of \VAR{form}}. - \IT{\arrGOO{(\FU*{LISP-IMPLEMENTATION-TYPE})\\ - (\FU*{LISP-IMPLEMENTATION-VERSION})}{\}}} - \retval{Name} or \retval{version}, resp., of implementation. - - \IT{\arrGOO{(\FU*{SOFTWARE-TYPE})\\ - (\FU*{SOFTWARE-VERSION})}{\}}} - \retval{Name} or \retval{version}, resp., of host system. - \end{LIST} diff --git a/clqr-environment.tex b/clqr-environment.tex index a3cb697..ffddbaa 100644 --- a/clqr-environment.tex +++ b/clqr-environment.tex @@ -34,16 +34,25 @@ \IT{\V*{*features*}} List of implementation-dependent features. + \IT{(\FU*{ROOM} \Op{\Goo{\T\XOR\NIL\XOR\kwd{:default}}})} + Print information about internal storage management. + \IT{\arrGOO{(\FU*{SHORT-SITE-NAME})\\ (\FU*{LONG-SITE-NAME})}{\}}} \retval{String} representing physical location of computer. + \IT{\arrGOO{(\FU*{LISP-IMPLEMENTATION-TYPE})\\ + (\FU*{LISP-IMPLEMENTATION-VERSION})}{\}}} + \retval{Name} or \retval{version}, resp., of implementation. + + \IT{\arrGOO{(\FU*{SOFTWARE-TYPE})\\ + (\FU*{SOFTWARE-VERSION})}{\}}} + \retval{Name} or \retval{version}, resp., of host system. + \IT{\arrGOO{(\FU*{MACHINE-TYPE})\\ (\FU*{MACHINE-VERSION})\\ (\FU*{MACHINE-INSTANCE})}{\}}} \retval{Type}, \retval{version}, or \retval{name}, resp., of hardware. - \IT{(\FU*{ROOM} \Op{\Goo{\T\XOR\NIL\XOR\kwd{:default}}})} Print information about internal storage management. - \end{LIST} diff --git a/clqr-symbols-and-packages.tex b/clqr-symbols-and-packages.tex index 87db20d..0a072b1 100644 --- a/clqr-symbols-and-packages.tex +++ b/clqr-symbols-and-packages.tex @@ -24,19 +24,10 @@ Falsehood, the empty list, \V{*standard-input*}, \V{*standard-output*}, or the global environment. - \IT{\V*{*package*}} The current package. - - \IT{(\FU*{SYMBOL-PACKAGE '}\VAR{foo})} - Return the \retval{package \VAR{foo} came from}. - - \IT{(\GFU*{DOCUMENTATION} \kwd{'}\VAR{foo} - \Goo{\kwd{variable}\XOR\kwd{function}\XOR - \kwd*{compiler-macro}\XOR - \kwd{method-combination}\XOR - \T\XOR\kwd{structure} - \XOR\kwd{type}\XOR\kwd{setf}\XOR\T})} - Return \retval{documentation string} of \VAR{foo} of given - type. \kwd{setf}able. + \IT{(\FU*{MAKE-PACKAGE} \VAR{name} + \orGOO{\kwd{:nicknames }(\OPn{\VAR{nick}})\DF{\NIL}\\ + \kwd{:use }(\OPn{package})}{\}})} + Create \retval{package \VAR{name}}. \IT{(\kwd*{DEFPACKAGE}\VAR{ foo} \orGOO{\OPn{(\kwd{:use }\OPn{\VAR{bar}})}\\ @@ -52,6 +43,9 @@ exported by packages \VAR{bar} excluding \VAR{jnk}s and some symbols. \VAR{n}s from package \VAR{p}; exports \VAR{baz}es. + \IT{(\FU*{RENAME-PACKAGE} \VAR{package} \Op{(\OPn{nick})\DF{\NIL}})} + Rename \VAR{package}. Return \retval{renamed package}. + \IT{(\kwd*{IN-PACKAGE }\VAR{foo})} Make \retval{package \VAR{foo}} current. @@ -64,46 +58,22 @@ \Op{\VAR{package}}\DF{\kwd{*package*}})} Remove packages \VAR{foo} from use-list of \VAR{package}. - \IT{(\FU*{DELETE-PACKAGE} \VAR{package})} Delete \VAR{package}. Return - \retval{\T} if successful. - - \IT{(\FU*{FIND-PACKAGE} \Goo{\VAR{name}\XOR\VAR{package}})} Return - \retval{package object} with \VAR{name} (case-sensitive). - - \IT{(\FU*{LIST-ALL-PACKAGES})} \retval{List of registered packages}. - - \IT{(\FU*{MAKE-PACKAGE} \VAR{name} - \orGOO{\kwd{:nicknames }(\OPn{\VAR{nick}})\DF{\NIL}\\ - \kwd{:use }(\OPn{package})}{\}})} - Create \retval{package \VAR{name}}. - - \IT{(\xorGOO{% - \xorGOO{% - \FU*{DO-ALL-SYMBOLS}\\ - \FU*{DO-SYMBOLS}}{\}} - (\VAR{var} \OP{\VAR{package} \Op{\VAR{result}}})\\ - \FU*{DO-EXTERNAL-SYMBOLS} (\VAR{var} \Op{\VAR{result}})}{\}} - \OPn{(\kwd{declare} \OPn{\VAR{decl}})} - \orGOO{\OPn{tag}\\ - \OPn{form}}{\}})} - Evaluate \VAR{form}s with \VAR{var} successively bound to all - symbols from all registered packages, to all symbols from - \VAR{package}, or to all external symbols from \VAR{package}, resp. Return - \retval{value of \VAR{result}}. + \IT{(\FU*{DELETE-PACKAGE} \VAR{package})} + Delete \VAR{package}. Return \retval{\T} if successful. - \IT{(\FU*{EXPORT} \VAR{symbols} \Op{\VAR{package}\DF{\kwd{*package*}}})} - Make \VAR{symbols} external to \VAR{package}. Return \retval{\T}. + \IT{\V*{*package*}} The current package. - \IT{(\FU*{UNEXPORT} \VAR{symbols} \VAR{package})} - Revert \VAR{symbols} to internal status. Return \retval{\T}. + \IT{(\FU*{LIST-ALL-PACKAGES})} + \retval{List of registered packages}. - \IT{(\FU*{PACKAGE-NAME} \VAR{package})} \retval{Name of \VAR{package}}. + \IT{(\FU*{PACKAGE-NAME} \VAR{package})} + \retval{Name of \VAR{package}}. \IT{(\FU*{PACKAGE-NICKNAMES} \VAR{package})} \retval{List of nicknames} of \VAR{package}. - \IT{(\FU*{PACKAGE-SHADOWING-SYMBOLS} \VAR{package})} - \retval{List of shadowing symbols} of \VAR{package}. + \IT{(\FU*{FIND-PACKAGE} \Goo{\VAR{name}\XOR\VAR{package}})} + Return \retval{package object} with \VAR{name} (case-sensitive). \IT{(\FU*{PACKAGE-USE-LIST} \VAR{package})} \retval{List of other packeges} used by \VAR{package}. @@ -111,17 +81,19 @@ \IT{(\FU*{PACKAGE-USED-BY-LIST} \VAR{package})} \retval{List of other packages} using \VAR{package}. - \IT{(\FU*{RENAME-PACKAGE} \VAR{package} \Op{(\OPn{nick})\DF{\NIL}})} - Rename \VAR{package}. Return \retval{renamed package}. + \IT{(\FU*{MAKE-SYMBOL} \VAR{name})} + Make fresh, uninterned \retval{symbol \VAR{name}}. - \IT{(\SF*{WITH-PACKAGE-ITERATOR} (\VAR{name} \RP{\VAR{package}} - \Op{\kwd{:internal}\XOR\kwd{:external}\XOR\kwd{:inherited}}) - \OPn{(\kwd{declare} \OPn{\VAR{decl}})} \OPn{\VAR{form}})} - Return \retval{values of \VAR{form}s}. In the body, successive - invocations of (\VAR{name}) return: \T\ if a symbol is returned; - a symbol from a \VAR{package}; accessibility - (\kwd{:internal}, \kwd{:external}, or \kwd{:inherited}); and the - package the symbol belongs to. + \IT{(\FU*{COPY-SYMBOL} \VAR{symbol} \Op{\VAR{props}\DF{\NIL}})} + Return uninterned \retval{copy of \VAR{symbol}}. If \VAR{props} is + \T, the copy has the same value, function, and property list. + + \IT{(\FU*{FIND-ALL-SYMBOLS} \VAR{string})} + Return \retval{list of symbols} with name \VAR{string} from all + registered packages. + + \IT{(\FU*{SYMBOL-PACKAGE} \VAR{foo})} + Return the \retval{package \VAR{foo} came from}. \IT{(\xorGOO{\FU*{INTERN}\\ \FU*{FIND-SYMBOL}}{\} \VAR{name} \Op{\VAR{package}}})} @@ -130,10 +102,9 @@ \retvalii{\kwd{:internal}}, \retvalii{\kwd{:external}}, or \retvalii{\kwd{:inherited}}. - \IT{(\FU*{SHADOW} \RP{\VAR{symbol}} - \Op{\VAR{package}\DF{\kwd{*package*}}})} - Add \VAR{symbol}s to shadowed list of \VAR{package}. Return \retval{\T}. - + \IT{(\kwd*{UNINTERN} \VAR{symbol} \Op{\VAR{package}})} + Remove \VAR{symbol} from \VAR{package}, return \retval{\T} on success. + \IT{(\xorGOO{\FU*{IMPORT}\\ \FU*{SHADOWING-IMPORT}}{\}}\RP{\VAR{symbol}} \Op{\VAR{package}\DF{\kwd{*package*}}})} @@ -141,12 +112,58 @@ case of a name conflict, signal \kwd{package-error}, or shadow the old symbol, resp. - \IT{(\kwd*{UNINTERN} \VAR{symbol} \Op{\VAR{package}})} - Remove \VAR{symbol} from \VAR{package}, return \retval{\T} on success. + \IT{(\FU*{SHADOW} \RP{\VAR{symbol}} + \Op{\VAR{package}\DF{\kwd{*package*}}})} + Add \VAR{symbol}s to shadowed list of \VAR{package}. Return \retval{\T}. + + \IT{(\FU*{PACKAGE-SHADOWING-SYMBOLS} \VAR{package})} + \retval{List of shadowing symbols} of \VAR{package}. - \IT{(\FU*{FIND-ALL-SYMBOLS} \VAR{string})} - Return \retval{list of symbols} with name \VAR{string} from all - registered packages. + \IT{(\FU*{EXPORT} \VAR{symbols} \Op{\VAR{package}\DF{\kwd{*package*}}})} + Make \VAR{symbols} external to \VAR{package}. Return \retval{\T}. + + \IT{(\FU*{UNEXPORT} \VAR{symbols} \VAR{package})} + Revert \VAR{symbols} to internal status. Return \retval{\T}. + + \IT{(\GFU*{DOCUMENTATION} \kwd{'}\VAR{foo} + \Goo{\kwd{variable}\XOR\kwd{function}\XOR + \kwd*{compiler-macro}\XOR + \kwd{method-combination}\XOR + \T\XOR\kwd{structure} + \XOR\kwd{type}\XOR\kwd{setf}\XOR\T})} + Return \retval{documentation string} of \VAR{foo} of given + type. \kwd{setf}able. + + \IT{(\xorGOO{% + \xorGOO{% + \FU*{DO-ALL-SYMBOLS}\\ + \FU*{DO-SYMBOLS}}{\}} + (\VAR{var} \OP{\VAR{package} \Op{\VAR{result}}})\\ + \FU*{DO-EXTERNAL-SYMBOLS} (\VAR{var} \Op{\VAR{result}})}{\}} + \OPn{(\kwd{declare} \OPn{\VAR{decl}})} + \orGOO{\OPn{tag}\\ + \OPn{form}}{\}})} + Evaluate \VAR{form}s with \VAR{var} successively bound to all + symbols from all registered packages, to all symbols from + \VAR{package}, or to all external symbols from \VAR{package}, resp. Return + \retval{value of \VAR{result}}. + + \IT{(\SF*{WITH-PACKAGE-ITERATOR} (\VAR{name} \RP{\VAR{package}} + \Op{\kwd{:internal}\XOR\kwd{:external}\XOR\kwd{:inherited}}) + \OPn{(\kwd{declare} \OPn{\VAR{decl}})} \OPn{\VAR{form}})} + Return \retval{values of \VAR{form}s}. In the body, successive + invocations of (\VAR{name}) return: \T\ if a symbol is returned; + a symbol from a \VAR{package}; accessibility + (\kwd{:internal}, \kwd{:external}, or \kwd{:inherited}); and the + package the symbol belongs to. + + \IT{(\FU*{SYMBOL-NAME} \VAR{ symbol})} + \retval{Name} of \VAR{symbol}. + + \IT{\arrGOO{(\FU*{SYMBOL-FUNCTION} \VAR{ symbol})\\ + (\FU*{SYMBOL-VALUE} \VAR{ symbol})\\ + (\FU*{SYMBOL-PLIST} \VAR{ symbol})}{\}}} + \retval{Function}, \retval{value}, or \retval{property list}, resp., of \VAR{symbol}. \kwd{setf}able. \end{LIST} diff --git a/clqr-system-types-and-classes.tex b/clqr-system-types-and-classes.tex index b2cde36..5ffa203 100644 --- a/clqr-system-types-and-classes.tex +++ b/clqr-system-types-and-classes.tex @@ -114,13 +114,6 @@ \begin{LIST}{1cm} - \IT{(\kwd*{NIL})} - The empty type, subtype of every type. - - \IT{(\kwd*{T})} - Supertype of every type including \kwd{t}; or superclass of every - class except \kwd{t}. - \IT{(\FU*{TYPEP} \VAR{foo} \VAR{type} \Op{\VAR{environment}})} Return \retval{\T} if \VAR{foo} is of \VAR{type}. @@ -128,6 +121,10 @@ Return \retval{\T} if \VAR{type-a} is a recognizable subtype of \VAR{type-b}. + \IT{(\SF*{THE} \VAR{type} {form})} + Return \retval{values} of \VAR{form} which are specified to be of + \VAR{type}. + \IT{(\FU*{COERCE} \VAR{object} \VAR{type})} Coerce \VAR{object} into \VAR{type}. @@ -165,19 +162,29 @@ \OPn{\VAR{form}})} Define new type \retval{\VAR{name}}. - \IT{(\SF*{THE} \VAR{type} {form})} - Return \retval{values} of \VAR{form} which are specified to be of - \VAR{type}. + \IT{(\kwd*{T})} + Supertype of every type including \kwd{t}; or superclass of every + class except \kwd{t}. + + \IT{(\kwd*{NIL})} + The empty type, subtype of every type. + + \IT{(\kwd*{SATISFIES} \VAR{name})} + Type specifier for all objects satisfying predicate \VAR{name}. + + \IT{(\kwd*{MOD} \VAR{n})} + Type specifier for all integers $