The Cheat SheetCommon Lisp Quick Reference (sinhFu a) (coshFu a) (tanhFu a) ⊲ sinha, cosha, or...
Transcript of The Cheat SheetCommon Lisp Quick Reference (sinhFu a) (coshFu a) (tanhFu a) ⊲ sinha, cosha, or...
-
Common Lisp Quick Reference
(Fusinh a)
(Fucosh a)
(Futanh a)
⊲ sinh a, cosh a, or tanh a, respectively.
(Fuasinh a)
(Fuacosh a)
(Fuatanh a)
⊲ asinh a, acosh a, or atanh a, respectively.
(Fucis a) ⊲ Return ei a = cos a + i sina.
(Fuconjugate a) ⊲ Return complex conjugate of a.
(Fumax num+)
(Fumin num+)
⊲ Greatest or least, respectively, of nums.
(
8>><>>:
{ Furound Fufround}{ Fufloor Fuffloor}{ Fuceiling Fufceiling}{ Futruncate Fuftruncate}
9>>=>>;
n [d 1 ])
⊲ Return as integer or float, respectively, n/d rounded, orrounded towards −∞, +∞, or 0, respectively; and
2remain-
der.
(
FumodFurem
ffn d)
⊲ Same asFufloor or
Futruncate, respectively, but return remain-
der only.
(Furandom limit [state var
∗random-state∗ ])⊲ Return non-negative random number less than limit , andof the same type.
(Fumake-random-state
ˆ{state NIL T}NIL
˜)
⊲ Copy of random-state object state or of the current randomstate; or a randomly initialized fresh random state.
var∗random-state∗ ⊲ Current random state.
(Fufloat-sign num-a [num-b 1 ]) ⊲ num-b with num-a’s sign.
(Fusignum n)
⊲ Number of magnitude 1 representing sign or phase of n .
(Funumerator rational)
(Fudenominator rational)
⊲ Numerator or denominator, respectively, of rational ’scanonical form.
(Furealpart number)
(Fuimagpart number)
⊲ Real part or imaginary part, respectively, of number .
(Fucomplex real [imag 0 ]) ⊲ Make a complex number.
(Fuphase number) ⊲ Angle of number ’s polar representation.
(Fuabs n) ⊲ Return |n|.
(Furational real)
(Furationalize real)
⊲ Convert real to rational. Assume complete/limited accu-racy for real .
(Fufloat real [prototype 0.0F0 ])
⊲ Convert real into float with type of prototype .
4
Quick Reference
clCommon
lispBert Burgemeister
-
Common Lisp Quick Reference
Contents
1 Numbers 3
1.1 Predicates . . . . 31.2 Numeric Functns . 31.3 Logic Functions . 51.4 Integer Functions . 51.5 Implementation-
Dependent . . . . 6
2 Characters 6
3 Strings 7
4 Conses 8
4.1 Predicates . . . . 84.2 Lists . . . . . . 94.3 Association Lists . 104.4 Trees . . . . . . 104.5 Sets . . . . . . 11
5 Arrays 11
5.1 Predicates . . . . 115.2 Array Functions . 115.3 Vector Functions . 12
6 Sequences 12
6.1 Seq. Predicates . . 126.2 Seq. Functions . . 13
7 Hash Tables 15
8 Structures 15
9 Control Structure 16
9.1 Predicates . . . . 169.2 Variables . . . . 169.3 Functions . . . . 179.4 Macros . . . . . 18
9.5 Control Flow . . . 209.6 Iteration . . . . 219.7 Loop Facility . . . 22
10 CLOS 24
10.1 Classes . . . . . 2410.2 Generic Functns . 2610.3 Method Combi-
nation Types . . . 27
11 Conditions and Errors 28
12 Types and Classes 30
13 Input/Output 32
13.1 Predicates . . . . 3213.2 Reader . . . . . 3313.3 Character Syntax . 3413.4 Printer . . . . . 3513.5 Format . . . . . 3713.6 Streams . . . . . 4013.7 Paths and Files . . 41
14 Packages and Symbols 43
14.1 Predicates . . . . 4314.2 Packages . . . . 4314.3 Symbols . . . . . 4414.4 Std Packages . . 45
15 Compiler 45
15.1 Predicates . . . . 4515.2 Compilation . . . 4515.3 REPL & Debug . 4615.4 Declarations . . . 47
16 External Environment 48
Typographic Conventionsname;
Funame;
Mname;
sOname;
gFname;
var∗name∗;
coname
⊲ Symbol defined in Common Lisp; esp. function, macro, spe-cial operator, generic function, variable, constant.
them ⊲ Placeholder for actual code.
me ⊲ Literal text.
[foo bar ] ⊲ Either one foo or nothing; defaults to bar.
foo∗; {foo}∗ ⊲ Zero or more foos.
foo+; {foo}+ ⊲ One or more foos.
foos ⊲ English plural denotes a list argument.
{foo bar baz};
8<:foo
bar
baz
⊲ Either foo, or bar , or baz .
8<:
˛̨˛̨˛̨foo
bar
baz
⊲ Anything from none to each of foo, bar , and baz .
cfoo ⊲ Argument foo is not evaluated.gbar ⊲ Argument bar is possibly modified.
fooP∗ ⊲ foo∗ is evaluated as in
sOprogn; see p. 20.
foo;2bar ;
n
baz ⊲ Primary, secondary, and nth return value.
T; NIL ⊲ t, or truth in general; and nil or ().
2
Common Lisp Quick Reference
1 Numbers
1.1 Predicates
(Fu= number+)
(Fu/= number+)
⊲ T if all numbers, or none, respectively, are equal in value.
(Fu> number+)
(Fu
>= number+)(Fu< number+)
(Fu
0, respectively.
(Fuevenp integer)
(Fuoddp integer)
⊲ T if integer is even or odd, respectively.
(Funumberp foo)
(Furealp foo)
(Furationalp foo)
(Fufloatp foo)
(Fuintegerp foo)
(Fucomplexp foo)
(Furandom-state-p foo)
⊲ T if foo is of indicated type.
1.2 Numeric Functions
(Fu+ a 0
∗)(Fu∗ a 1
∗)⊲ Return
Pa or
Qa, respectively.
(Fu– a b∗)
(Fu/ a b∗)
⊲ Return a−P
b or a/Q
b, respectively. Without any bs,return −a or 1/a, respectively.
(Fu1+ a)
(Fu1– a)
⊲ Return a + 1 or a− 1, respectively.
(
MincfMdecf
ffp̃lace [delta 1 ])
⊲ Increment or decrement the value of place by delta. Returnnew value.
(Fuexp p)
(Fuexpt b p)
⊲ Return ep or bp, respectively.
(Fulog a [b]) ⊲ Return logb a or, without b, ln a.
(Fusqrt n)
(Fuisqrt n)
⊲√
n in complex or natural numbers, respectively.
(Fulcm integer∗ 1 )
(Fugcd integer∗)
⊲ Least common multiple or greatest common denominator,respectively, of integers. (gcd) returns 0.
copi ⊲ long-float approximation of π, Ludolph’s number.
(Fusin a)
(Fucos a)
(Futan a)
⊲ sin a, cos a, or tan a, respectively. (a in radians.)
(Fuasin a)
(Fuacos a)
⊲ arcsin a or arccos a, respectively, in radians.
(Fuatan a [b 1 ]) ⊲ arctan
ab
in radians.
3
-
Common Lisp Quick Reference
(
8>>>><>>>>:
Fustring{/= -not-equal}Fustring{> -greaterp}Fustring{>= -not-lessp}Fustring{< -lessp}Fustring{>>>=>>>>;
foo bar
8>><>>:
˛̨˛̨˛̨˛̨
:start1 start-foo 0:start2 start-bar 0:end1 end-foo NIL:end2 end-bar NIL
9>>=>>;
)
⊲ If foo is lexicographically not equal, greater, not less,less, or not greater, respectively, then return position offirst mismatching character in foo. Otherwise return NIL.Obey/ignore, respectively, case.
(Fumake-string size
̨̨˛̨:initial-element char:element-type type character
ff)
⊲ Return string of length size.
(Fustring x)
(
8<:
Fustring-capitalizeFustring-upcaseFustring-downcase
9=; x
̨̨˛̨:start start 0:end end NIL
ff)
⊲ Convert x (symbol, string, or character) into a string, astring with capitalized words, an all-uppercase string, or anall-lowercase string, respectively.
(
8<:
Funstring-capitalizeFunstring-upcaseFunstring-downcase
9=; s̃tring
̨̨˛̨:start start 0:end end NIL
ff)
⊲ Convert string into a string with capitalized words, anall-uppercase string, or an all-lowercase string, respectively.
(
8<:
Fustring-trimFustring-left-trimFustring-right-trim
9=; char-bag string)
⊲ Return string with all characters in sequence char-bag re-moved from both ends, from the beginning, or from the end,respectively.
(Fuchar string i)
(Fuschar string i)
⊲ Return zero-indexed ith character of string ignor-ing/obeying, respectively, fill pointer. setfable.
(Fuparse-integer string
8>><>>:
˛̨˛̨˛̨˛̨
:start start 0:end end NIL:radix int 10:junk-allowed bool NIL
9>>=>>;
)
⊲ Return integer parsed from string and2index of parse end.
4 Conses
4.1 Predicates
(Fuconsp foo)
(Fulistp foo)
⊲ Return T if foo is of indicated type.
(Fuendp list)
(Funull foo)
⊲ Return T if list/foo is NIL.
(Fuatom foo) ⊲ Return T if foo is not a cons.
(Futailp foo list) ⊲ Return T if foo is a tail of list .
(Fumember foo list
8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Return tail of list starting with its first element matchingfoo. Return NIL if there is no such element.
(
Fumember-ifFumember-if-not
fftest list [:key function ])
⊲ Return tail of list starting with its first element satisfyingtest . Return NIL if there is no such element.
8
Common Lisp Quick Reference
1.3 Logic Functions
Negative integers are used in two’s complement representation.
(Fuboole operation int-a int-b)
⊲ Return value of bitwise logical operation . operations are
coboole-1 ⊲ int-a.coboole-2 ⊲ int-b.coboole-c1 ⊲ ¬int-a.coboole-c2 ⊲ ¬int-b.coboole-set ⊲ All bits set.coboole-clr ⊲ All bits zero.coboole-eqv ⊲ int-a ≡ int-b.coboole-and ⊲ int-a ∧ int-b.coboole-andc1 ⊲ ¬int-a ∧ int-b.coboole-andc2 ⊲ int-a ∧ ¬int-b.coboole-nand ⊲ ¬(int-a ∧ int-b).coboole-ior ⊲ int-a ∨ int-b.coboole-orc1 ⊲ ¬int-a ∨ int-b.coboole-orc2 ⊲ int-a ∨ ¬int-b.coboole-xor ⊲ ¬(int-a ≡ int-b).coboole-nor ⊲ ¬(int-a ∨ int-b).
(Fulognot integer) ⊲ ¬integer .
(Fulogeqv integer∗)
(Fulogand integer∗)
⊲ Return value of exclusive-nored or anded integer s, respec-tively. Without any integer , return −1.
(Fulogandc1 int-a int-b) ⊲ ¬int-a ∧ int-b.
(Fulogandc2 int-a int-b) ⊲ int-a ∧ ¬int-b.
(Fulognand int-a int-b) ⊲ ¬(int-a ∧ int-b).
(Fulogxor integer∗)
(Fulogior integer∗)
⊲ Return value of exclusive-ored or ored integer s, respec-tively. Without any integer , return 0.
(Fulogorc1 int-a int-b) ⊲ ¬int-a ∨ int-b.
(Fulogorc2 int-a int-b) ⊲ int-a ∨ ¬int-b.
(Fulognor int-a int-b) ⊲ ¬(int-a ∨ int-b).
(Fulogbitp i integer)
⊲ T if zero-indexed ith bit of integer is set.
(Fulogtest int-a int-b)
⊲ Return T if there is any bit set in int-a which is set in int-bas well.
(Fulogcount int)
⊲ Number of 1 bits in int ≥ 0, number of 0 bits in int < 0.
1.4 Integer Functions
(Fuinteger-length integer)
⊲ Number of bits necessary to represent integer .
(Fuldb-test byte-spec integer)
⊲ Return T if any bit specified by byte-spec in integer is set.
(Fuash integer count)
⊲ Return copy of integer arithmetically shifted left by countadding zeros at the right, or, for count < 0, shifted rightdiscarding bits.
5
-
Common Lisp Quick Reference
(Fuldb byte-spec integer)
⊲ Extract byte denoted by byte-spec from integer. setfable.
(
Fudeposit-fieldFudpb
ffint-a byte-spec int-b)
⊲ Return int-b with bits denoted by byte-spec replaced bycorresponding bits of int-a, or by the low (
Fubyte-size byte-spec)
bits of int-a, respectively.
(Fumask-field byte-spec integer)
⊲ Return copy of integer with all bits unset but those denotedby byte-spec. setfable.
(Fubyte size position)
⊲ Byte specifier for a byte of size bits starting at a weight of2position .
(Fubyte-size byte-spec)
(Fubyte-position byte-spec)
⊲ Size or position, respectively, of byte-spec.
1.5 Implementation-Dependentcoshort-floatcosingle-floatcodouble-floatcolong-float
9>>=>>;
-
epsilonnegative-epsilon
⊲ Smallest possible number making a difference when addedor subtracted, respectively.
coleast-negativecoleast-negative-normalizedcoleast-positivecoleast-positive-normalized
9>>=>>;
-
8>><>>:
short-floatsingle-floatdouble-floatlong-float
⊲ Available numbers closest to −0 or +0, respectively.
comost-negativecomost-positive
ff-
8>>><>>>:
short-floatsingle-floatdouble-floatlong-floatfixnum
⊲ Available numbers closest to −∞ or +∞, respectively.
(Fudecode-float n)
(Fuinteger-decode-float n)
⊲ Return significand,2exponent, and
3sign of float n.
(Fuscale-float n [i ]) ⊲ With n’s radix b, return nbi.
(Fufloat-radix n)
(Fufloat-digits n)
(Fufloat-precision n)
⊲ Radix, number of digits in that radix, or precision in thatradix, respectively, of float n.
(Fuupgraded-complex-part-type foo [environment NIL ])
⊲ Type of most specialized complex number able to hold partsof type foo.
2 Characters
The standard-char type comprises a-z, A-Z, 0-9, Newline, Space, and!?$"’‘.:,;*+-/|\~ ^#%@&()[]{}.
(Fucharacterp foo)
(Fustandard-char-p char)
⊲ T if argument is of indicated type.
(Fugraphic-char-p character)
(Fualpha-char-p character)
(Fualphanumericp character)
⊲ T if character is visible, alphabetic, or alphanumeric, re-spectively.
6
Common Lisp Quick Reference
(Fuupper-case-p character)
(Fulower-case-p character)
(Fuboth-case-p character)
⊲ Return T if character is uppercase, lowercase, or able to bein another case, respectively.
(Fudigit-char-p character [radix 10 ])
⊲ Return its weight if character is a digit, or NIL otherwise.
(Fuchar= character+)
(Fuchar/= character+)
⊲ Return T if all characters, or none, respectively, are equal.
(Fuchar-equal character+)
(Fuchar-not-equal character+)
⊲ Return T if all characters, or none, respectively, are equalignoring case.
(Fuchar> character+)
(Fuchar>= character+)
(Fuchar< character+)
(Fuchar><>>:
˛̨˛̨˛̨˛̨
:start1 start-foo 0:start2 start-bar 0:end1 end-foo NIL:end2 end-bar NIL
9>>=>>;
)
⊲ Return T if subsequences of foo and bar are equal.Obey/ignore, respectively, case.
7
-
Common Lisp Quick Reference
(
8>>>>>>>>>>>>><>>>>>>>>>>>>>:
Fubit-eqvFubit-andFubit-andc1Fubit-andc2Fubit-nandFubit-iorFubit-orc1Fubit-orc2Fubit-xorFubit-nor
9>>>>>>>>>>>>>=>>>>>>>>>>>>>;
˜bit-array-a bit-array-b [ ˜result-bit-array NIL ])
⊲ Return result of bitwise logical operations (cf. operations ofFuboole, p. 5) on bit-array-a and bit-array-b. If result-bit-arrayis T, put result in bit-array-a; if it is NIL, make a new arrayfor result.
coarray-rank-limit ⊲ Upper bound of array rank; ≥ 8.coarray-dimension-limit
⊲ Upper bound of an array dimension; ≥ 1024.coarray-total-size-limit ⊲ Upper bound of array size; ≥ 1024.
5.3 Vector Functions
Vectors can as well be manipulated by sequence functions; see sec-tion 6.
(Fuvector foo∗) ⊲ Return fresh simple vector of foo s.
(Fusvref vector i) ⊲ Return element i of simple vector . setfable.
(Fuvector-push foo ṽector)
⊲ Return NIL if vector ’s fill pointer equals size of vector . Oth-erwise replace element of vector pointed to by fill pointer withfoo; then increment fill pointer.
(Fuvector-push-extend foo ṽector [num ])
⊲ Replace element of vector pointed to by fill pointer withfoo, then increment fill pointer. Extend vector ’s size by ≥num if necessary.
(Fuvector-pop ṽector)
⊲ Return element of vector its fillpointer points to after decre-mentation.
(Fufill-pointer vector) ⊲ Fill pointer of vector . setfable.
6 Sequences
6.1 Sequence Predicates
(
FueveryFunotevery
fftest sequence+)
⊲ Return NIL or T, respectively, as soon as test on any set ofcorresponding elements of sequences returns NIL.
(
FusomeFunotany
fftest sequence+)
⊲ Return value of test or NIL, respectively, as soon as test onany set of corresponding elements of sequences returns non-NIL.
(Fumismatch sequence-a sequence-b
8>>>>>>>>>><>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start1 start-a 0:start2 start-b 0:end1 end-a NIL:end2 end-b NIL:key function
9>>>>>>>>>>=>>>>>>>>>>;
)
⊲ Return position in sequence-a where sequence-a andsequence-b begin to mismatch. Return NIL if they matchentirely.
12
Common Lisp Quick Reference
(Fusubsetp list-a list-b
8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Return T if list-a is a subset of list-b.
4.2 Lists
(Fucons foo bar) ⊲ Return new cons (foo . bar ).
(Fulist foo∗) ⊲ Return list of foos.
(Fulist∗ foo+)
⊲ Return list of foos with last foo becoming cdr of last cons.Return foo if only one foo given.
(Fumake-list num [:initial-element foo NIL ])
⊲ New list with num elements set to foo.
(Fulist-length list) ⊲ Length of list ; NIL for circular list .
(Fucar list) ⊲ Car of list or NIL if list is NIL. setfable.
(Fucdr list)
(Furest list)
⊲ Cdr of list or NIL if list is NIL. setfable.
(Funthcdr n list) ⊲ Return tail of list after calling
Fucdr n times.
({ Fufirst Fusecond Futhird Fufourth Fufifth Fusixth . . . Funinth Futenth} list)⊲ Return nth element of list if any, or NIL otherwise. setfable.
(Funth n list) ⊲ Zero-indexed nth element of list . setfable.
(FucX r list)
⊲ With X being one to four as and ds representingFucars and
Fucdrs, e.g. (
Fucadr bar) is equivalent to (
Fucar (
Fucdr bar)). setfable.
(Fulast list [num 1 ]) ⊲ Return list of last num conses of list .
(
Fubutlast listFunbutlast flist
ff[num 1 ]) ⊲ list excluding last num conses.
(
FurplacaFurplacd
ffgcons object)
⊲ Replace car, or cdr, respectively, of cons with object .
(Fuldiff list foo)
⊲ If foo is a tail of list , return preceding part of list . Other-wise return list .
(Fuadjoin foo list
8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Return list if foo is already member of list . If not, return(
Fucons foo list ).
(Mpop p̃lace) ⊲ Set place to (
Fucdr place), return (
Fucar place).
(Mpush foo p̃lace) ⊲ Set place to (
Fucons foo place ).
(Mpushnew foo p̃lace
8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Set place to (Fuadjoin foo place ).
(Fuappend [list∗ foo])
(Funconc [ flist∗ foo])
⊲ Return concatenated list. foo can be of any type.
(Furevappend list foo)
(Funreconc flist foo)
⊲ Return concatenated list after reversing order in list .
9
-
Common Lisp Quick Reference
(
FumapcarFumaplist
fffunction list+)
⊲ Return list of return values of function successively invokedwith corresponding arguments, either cars or cdrs, respec-tively, from each list .
(
FumapcanFumapcon
fffunction list+)
⊲ Return list of concatenated return values of function suc-cessively invoked with corresponding arguments, either carsor cdrs, respectively, from each list . function should return alist.
(
FumapcFumapl
fffunction list+)
⊲ Return first list after successively applying function to cor-responding arguments, either cars or cdrs, respectively, fromeach list . function should have some side effects.
(Fucopy-list list) ⊲ Return copy of list with shared elements.
4.3 Association Lists
(Fupairlis keys values [alist NIL ])
⊲ Prepend to alist an association list made from lists keysand values.
(Fuacons key value alist)
⊲ Return alist with a (key . value) pair added.
(
FuassocFurassoc
fffoo alist
8<:
˛̨˛̨˛̨
:test test #’eql:test-not test
:key function
9=;)
(
Fuassoc-if[-not]Furassoc-if[-not]
fftest alist [:key function])
⊲ First cons whose car, or cdr, respectively, satisfies test.
(Fucopy-alist alist) ⊲ Return copy of alist .
4.4 Trees
(Futree-equal foo bar
:test test #’eql:test-not test
ff)
⊲ Return T if trees foo and bar have same shape and leavessatisfying test.
(
Fusubst new old treeFunsubst new old gtree
ff 8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Make copy of tree with each subtree or leaf matching oldreplaced by new .
(
Fusubst-if[-not] new test treeFunsubst-if[-not] new test gtree
ff[:key function])
⊲ Make copy of tree with each subtree or leaf satisfying testreplaced by new .
(
Fusublis association-list treeFunsublis association-list gtree
ff 8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Make copy of tree with each subtree or leaf matching a keyin association-list replaced by that key’s value.
(Fucopy-tree tree) ⊲ Copy of tree with same shape and leaves.
10
Common Lisp Quick Reference
4.5 Sets
(
8>>>>>>>>><>>>>>>>>>:
FuintersectionFuset-differenceFuunionFuset-exclusive-or
9>>=>>;
a b
FunintersectionFunset-difference
ffea b
FununionFunset-exclusive-or
ffea eb
9>>>>>>>>>=>>>>>>>>>;
8<:
˛̨˛̨˛̨
:test function #’eql:test-not function
:key function
9=;)
⊲ Return a ∩ b, a \ b, a ∪ b, or a△ b, respectively, of lists aand b.
5 Arrays
5.1 Predicates
(Fuarrayp foo)
(Fuvectorp foo)
(Fusimple-vector-p foo)
(Fubit-vector-p foo)
(Fusimple-bit-vector-p foo)
⊲ T if foo is of indicated type.
(Fuadjustable-array-p array)
(Fuarray-has-fill-pointer-p array)
⊲ T if array is adjustable/has a fill pointer, respectively.
(Fuarray-in-bounds-p array [subscripts])
⊲ Return T if subscripts are in array ’s bounds.
5.2 Array Functions
(
Fumake-array dimension-sizes
ˆ:adjustable bool NIL
˜Fuadjust-array ãrray dimension-sizes
ff
8>>>><>>>>:
˛̨˛̨˛̨˛̨˛̨
:element-type type T:fill-pointer {num bool}NIL8<:
:initial-element obj:initial-contents sequence:displaced-to array NIL [:displaced-index-offset i 0 ]
9>>>>=>>>>;
)
⊲ Return fresh, or readjust, respectively, vector or array.
(Fuaref array
ˆsubscripts
˜)
⊲ Return array element pointed to by subscripts. setfable.
(Furow-major-aref array i)
⊲ Return ith element of array in row-major order. setfable.
(Fuarray-row-major-index array [subscripts])
⊲ Index in row-major order of the element denoted bysubscripts.
(Fuarray-dimensions array)
⊲ List containing the lengths of array ’s dimensions.
(Fuarray-dimension array i)
⊲ Length of ith dimension of array .
(Fuarray-total-size array) ⊲ Number of elements in array .
(Fuarray-rank array) ⊲ Number of dimensions of array .
(Fuarray-displacement array) ⊲ Target array and
2offset.
(Fubit bit-array [subscripts])
(Fusbit simple-bit-array [subscripts])
⊲ Return element of bit-array or of simple-bit-array. setf-able.
(Fubit-not ˜bit-array [ ˜result-bit-array NIL ])
⊲ Return result of bitwise negation of bit-array. Ifresult-bit-array is T, put result in bit-array ; if it is NIL, makea new array for result.
11
-
Common Lisp Quick Reference
[ddoc]
8><>:
slot
(slot [init
(̨̨˛̨˛:type ̂slot-type
:read-only dbool
)])
9>=>;
∗
)
⊲ Define structure foo together with functions MAKE-foo,COPY-foo and foo-P; and setfable accessors foo-slot . In-stances are of class foo or, if defstruct option :type is given,of the specified type. They can be created by (MAKE-foo{:slot value}∗) or, if ord-λ (see p. 17) is given, by (makerarg∗ {:key value}∗). In the latter case, args and :keyscorrespond to the positional and keyword parameters de-fined in ord-λ whose vars in turn correspond to slots.:print-object/:print-function generate a
gFprint-object method
for an instance bar of foo calling (o-printer bar stream) or(f-printer bar stream print-level), respectively. If :type with-out :named is given, no foo-P is created.
(Fucopy-structure structure)
⊲ Return copy of structure with shared slot values.
9 Control Structure
9.1 Predicates
(Fueq foo bar) ⊲ T if foo and bar are identical.
(Fueql foo bar)
⊲ T if foo and bar are identical, or the same character, ornumbers of the same type and value.
(Fuequal foo bar)
⊲ T if foo and bar areFueql, or are equivalent pathnames, or are
conses withFuequal cars and cdrs, or are strings or bit-vectors
withFueql elements below their fill pointers.
(Fuequalp foo bar)
⊲ T if foo and bar are identical; or are the same characterignoring case; or are numbers of the same value ignoring type;or are equivalent pathnames; or are conses or arrays of thesame shape with
Fuequalp elements; or are structures of the
same type withFuequalp elements; or are hash-tables of the
same size with the same :test function, the same keys in termsof :test function, and
Fuequalp elements.
(Funot foo) ⊲ T if foo is NIL; NIL otherwise.
(Fuboundp symbol) ⊲ T if symbol is a special variable.
(Fuconstantp foo [environment NIL ])
⊲ T if foo is a constant form.
(Fufunctionp foo) ⊲ T if foo is of type function.
(Fufboundp
foo
(setf foo)
ff) ⊲ T if foo is a global function or macro.
9.2 Variables
(
MdefconstantMdefparameter
ffcfoo form [ddoc])
⊲ Assign value of form to global constant/dynamic variablefoo.
(Mdefvar cfoo
ˆform [ddoc]
˜)
⊲ Unless bound already, assign value of form to dynamic vari-able foo.
(
MsetfMpsetf
ff{place form}∗)
⊲ Set places to primary values of forms. Return values oflast form/NIL; work sequentially/in parallel, respectively.
16
Common Lisp Quick Reference
6.2 Sequence Functions
(Fumake-sequence sequence-type size [:initial-element foo])
⊲ Make sequence of sequence-type with size elements.
(Fuconcatenate type sequence∗)
⊲ Return concatenated sequence of type.
(Fumerge type ˜sequence-a ˜sequence-b test [:key function NIL ])
⊲ Return interleaved sequence of type. Merged sequence willbe sorted if both sequence-a and sequence-b are sorted.
(Fufill ˜sequence foo
̨̨˛̨:start start 0:end end NIL
ff)
⊲ Return sequence after setting elements between start andend to foo.
(Fulength sequence)
⊲ Return length of sequence (being value of fill pointer ifapplicable).
(Fucount foo sequence
8>>>>>><>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start start 0:end end NIL:key function
9>>>>>>=>>>>>>;
)
⊲ Return number of elements in sequence which match foo.
(
Fucount-ifFucount-if-not
fftest sequence
8>><>>:
˛̨˛̨˛̨˛̨
:from-end bool NIL:start start 0:end end NIL:key function
9>>=>>;
)
⊲ Return number of elements in sequence which satisfy test.
(Fuelt sequence index)
⊲ Return element of sequence pointed to by zero-indexedindex . setfable.
(Fusubseq sequence start [end NIL ])
⊲ Return subsequence of sequence between start and end.setfable.
(
FusortFustable-sort
ff˜sequence test [:key function ])
⊲ Return sequence sorted. Order of elements consideredequal is not guaranteed/retained, respectively.
(Fureverse sequence)
(Funreverse ˜sequence)
⊲ Return sequence in reverse order.
(
FufindFuposition
fffoo sequence
8>>>>>><>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not test
:start start 0:end end NIL:key function
9>>>>>>=>>>>>>;
)
⊲ Return first element in sequence which matches foo, or itsposition relative to the begin of sequence, respectively.
(
8>><>>:
Fufind-ifFufind-if-notFuposition-ifFuposition-if-not
9>>=>>;
test sequence
8>><>>:
˛̨˛̨˛̨˛̨
:from-end bool NIL:start start 0:end end NIL:key function
9>>=>>;
)
⊲ Return first element in sequence which satisfies test, or itsposition relative to the begin of sequence, respectively.
(Fusearch sequence-a sequence-b
8>>>>>>>>>><>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start1 start-a 0:start2 start-b 0:end1 end-a NIL:end2 end-b NIL:key function
9>>>>>>>>>>=>>>>>>>>>>;
)
13
-
Common Lisp Quick Reference
⊲ Search sequence-b for a subsequence matching sequence-a.Return position in sequence-b, or NIL.
(
Furemove foo sequenceFudelete foo ˜sequence
ff
8>>>>>>>><>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start start 0:end end NIL:key function:count count NIL
9>>>>>>>>=>>>>>>>>;
)
⊲ Make copy of sequence without elements matching foo.
(
8>><>>:
Furemove-ifFuremove-if-not
fftest sequence
Fudelete-ifFudelete-if-not
fftest ˜sequence
9>>=>>;
8>>><>>>:
˛̨˛̨˛̨˛̨˛
:from-end bool NIL:start start 0:end end NIL:key function:count count NIL
9>>>=>>>;
)
⊲ Make copy of sequence with all (or count) elements satis-fying test removed.
(
Furemove-duplicates sequenceFudelete-duplicates ˜sequence
ff
8>>>>>><>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start start 0:end end NIL:key function
9>>>>>>=>>>>>>;
)
⊲ Make copy of sequence without duplicates.
(
Fusubstitute new old sequenceFunsubstitute new old ˜sequence
ff
8>>>>>>>><>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨
:from-end bool NIL:test function #’eql:test-not function
:start start 0:end end NIL:key function:count count NIL
9>>>>>>>>=>>>>>>>>;
)
⊲ Make copy of sequence with all (or count) olds replaced bynew .
(
8>><>>:
Fusubstitute-ifFusubstitute-if-not
ffnew test sequence
Funsubstitute-ifFunsubstitute-if-not
ffnew test ˜sequence
9>>=>>;
8>>><>>>:
˛̨˛̨˛̨˛̨˛
:from-end bool NIL:start start 0:end end NIL:key function:count count NIL
9>>>=>>>;
)
⊲ Make copy of sequence with all (or count) elements satis-fying test replaced by new .
(Fureplace ˜sequence-a sequence-b
8>><>>:
˛̨˛̨˛̨˛̨
:start1 start-a 0:start2 start-b 0:end1 end-a NIL:end2 end-b NIL
9>>=>>;
)
⊲ Replace elements of sequence-a with elements ofsequence-b.
(Fumap type function sequence+)
⊲ Apply function successively to corresponding elements ofthe sequences. Return values as a sequence of type. If type isNIL, return NIL.
(Fumap-into ˜result-sequence function sequence∗)
⊲ Store into result-sequence successively values of functionapplied to corresponding elements of the sequences.
(Fureduce function sequence
8>>><>>>:
˛̨˛̨˛̨˛̨˛
:initial-value foo NIL:from-end bool NIL:start start 0:end end NIL:key function
9>>>=>>>;
)
⊲ Starting with the first two elements of sequence, applyfunction successively to its last return value together withthe next element of sequence. Return last value of function.
(Fucopy-seq sequence)
⊲ Copy of sequence with shared elements.
14
Common Lisp Quick Reference
7 Hash Tables
Key-value storage similar to hash tables can as well be achieved usingassociation lists and property lists; see pages 10 and 17.
(Fuhash-table-p foo) ⊲ Return T if foo is of type hash-table.
(Fumake-hash-table
8>><>>:
˛̨˛̨˛̨˛̨
:test {Fueq Fueql Fuequal Fuequalp}#’eql:size int:rehash-size num:rehash-threshold num
9>>=>>;
)
⊲ Make a hash table.
(Fugethash key hash-table [default NIL ])
⊲ Return object with key if any or default otherwise; and2T
if found,2NIL otherwise. setfable.
(Fuhash-table-count hash-table)
⊲ Number of entries in hash-table .
(Furemhash key ˜hash-table)
⊲ Remove from hash-table entry with key and return T if itexisted. Return NIL otherwise.
(Fuclrhash ˜hash-table) ⊲ Empty hash-table .
(Fumaphash function hash-table)
⊲ Iterate over hash-table calling function on key and value.Return NIL.
(Mwith-hash-table-iterator (foo hash-table) (declare ddecl∗)∗ formP∗)
⊲ Return values of forms. In forms, invocations of (foo) re-turn: T if an entry is returned; its key; its value.
(Fuhash-table-test hash-table)
⊲ Test function used in hash-table .
(Fuhash-table-size hash-table)
(Fuhash-table-rehash-size hash-table)
(Fuhash-table-rehash-threshold hash-table)
⊲ Current size, rehash-size, or rehash-threshold, respectively,as used in
Fumake-hash-table.
(Fusxhash foo)
⊲ Hash code unique for any argumentFuequal foo.
8 Structures
(Mdefstruct8
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>:
foo
(foo
8>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛
(:conc-name
(:conc-name [ ̂slot-prefix foo- ])(:constructor
(:constructorˆm̂aker MAKE-foo [(ôrd-λ
∗)]˜)
)∗
(:copier
(:copier [ĉopier COPY-foo ])
(:include ŝtruct
8><>:
dslot
(dslot [init(̨̨
˛̨˛:type ŝl-type
:read-only bb
)])
9>=>;
∗
)
8>>>>><>>>>>:
(:type
8<:
listvector
(vector dtype)
9=;)
̨̨˛̨:named(:initial-offset bn)
((:print-object [ ̂o-printer ])
(:print-function [ ̂f-printer ]):predicate(:predicate [ ̂p-name foo-P ])
9>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>=>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
)
9>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>=>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
15
-
Common Lisp Quick Reference
colambda-list-keywords
⊲ List of macro lambda list keywords. These are at least:
&whole var⊲ Bind var to the entire macro call form.
&optional var∗
⊲ Bind vars to corresponding arguments if any.
{&rest &body} var⊲ Bind var to a list of remaining arguments.
&key var∗
⊲ Bind vars to corresponding keyword arguments.
&allow-other-keys⊲ Suppress keyword argument checking. Callers can doso using :allow-other-keys T.
&environment var⊲ Bind var to the lexical compilation environment.
&aux var∗ ⊲ Bind vars as insOlet∗.
9.5 Control Flow
(sOif test then [else NIL ])
⊲ Return values of then if test returns T; return values of elseotherwise.
(Mcond (test then
P∗test )
∗)⊲ Return the values of the first then∗ whose test returns T;return NIL if all tests return NIL.
(
MwhenMunless
fftest foo
P∗)
⊲ Evaluate foos and return their values if test returns T orNIL, respectively. Return NIL otherwise.
(Mcase test (
((dkey∗)dkey
)foo
P∗)∗ˆ(
otherwiseT
ffbar
P∗)NIL˜)
⊲ Return the values of the first foo∗ one of whose keys is eqltest . Return values of bar s if there is no matching key.
(
MecaseMccase
fftest (
((dkey∗)dkey
)foo
P∗)∗)
⊲ Return the values of the first foo∗ one of whose keys is eqltest . Signal non-correctable/correctable type-error and returnNIL if there is no matching key.
(Mand form∗ T )
⊲ Evaluate forms from left to right. Immediately return NILif one form’s value is NIL. Return values of last form other-wise.
(Mor form∗ NIL )
⊲ Evaluate forms from left to right. Immediately returnprimary value of first non-NIL-evaluating form, or all valuesif last form is reached. Return NIL if no form returns T.
(sOprogn form∗ NIL )
⊲ Evaluate forms sequentially. Return values of last form .
(sOmultiple-value-prog1 form-r form∗)
(Mprog1 form-r form∗)
(Mprog2 form-a form-r form∗)
⊲ Evaluate forms in order. Return values/primary value, re-spectively, of form-r .
(
sOletsOlet∗
ff(
̨̨˛̨name(name [value NIL ])
ff∗) (declare ddecl∗)∗ formP∗)
⊲ Evaluate forms with names lexically bound (in parallel orsequentially, respectively) to values. Return values of forms.
20
Common Lisp Quick Reference
(
sOsetqMpsetq
ff{symbol form}∗)
⊲ Set symbols to primary values of forms. Return value oflast form/NIL; work sequentially/in parallel, respectively.
(Fuset s̃ymbol foo) ⊲ Set symbol ’s value cell to foo. Deprecated.
(Mmultiple-value-setq vars form)
⊲ Set elements of vars to the values of form. Return form ’sprimary value.
(Mshiftf p̃lace+ foo)
⊲ Store value of foo in rightmost place shifting values ofplaces left, returning first place .
(Mrotatef p̃lace∗)
⊲ Rotate values of places left, old first becoming new lastplace ’s value. Return NIL.
(Fumakunbound ffoo) ⊲ Delete special variable foo if any.
(Fuget symbol key
ˆdefault NIL
˜)
(Fugetf place key
ˆdefault NIL
˜)
⊲ First entry key from property list stored in symbol/in place ,respectively, or default if there is no key. setfable.
(Fuget-properties property-list keys)
⊲ Return key and2value of first entry from property-list
matching a key from keys, and3tail of property-list starting
with that key. Return NIL,2NIL, and
3NIL if there was no
matching key in property-list .
(Furemprop s̃ymbol key)
(Mremf p̃lace key)
⊲ Remove first entry key from property list stored insymbol/in place , respectively. Return T if key was there, orNIL otherwise.
9.3 Functions
Below, ordinary lambda list (ord-λ∗) has the form
(var∗ˆ&optional
var
(varˆinit NIL [supplied-p]
˜)
ff∗˜[&rest var ]
ˆ&key
8<:var
(
var
(:key var)
ff ˆinit NIL [supplied-p]
˜)
9=;
∗
[&allow-other-keys]˜
ˆ&aux
var
(var [init NIL ])
ff∗˜).
supplied-p is T if there is a corresponding argument. init forms canrefer to any init and supplied-p to their left.
(
8<:
Mdefun
foo (ord-λ∗)(setf foo) (new-value ord-λ∗)
Mlambda (ord-λ∗)
9=; (declare
ddecl∗)∗ [ddoc]
formP∗)
⊲ Define a function named foo or (setf foo), or an anonymousfunction, respectively, which applies forms to ord-λs. ForMdefun, forms are enclosed in an implicit
sOblock named foo.
(
sOfletsOlabels
ff((
foo (ord-λ∗)(setf foo) (new-value ord-λ∗)
ff(declare ̂local-decl∗)∗
[ddoc] local-formP∗)∗) (declare ddecl∗)∗ formP∗)⊲ Evaluate forms with locally defined functions foo. Globallydefined functions of the same name are shadowed. Each foois also the name of an implicit
sOblock around its corresponding
local-form∗. Only forsOlabels, functions foo are visible inside
local-forms . Return values of forms.
17
-
Common Lisp Quick Reference
(sOfunction
foo
(Mlambda form∗)
ff)
⊲ Return lexically innermost function named foo or a lexicalclosure of the
Mlambda expression.
(Fuapply
function
(setf function)
ffarg∗ args)
⊲ Values of function called with args and the list elements ofargs. setfable if function is one of
Fuaref,
Fubit, and
Fusbit.
(Fufuncall function arg∗) ⊲ Values of function called with args.
(sOmultiple-value-call function form∗)
⊲ Call function with all the values of each form as its argu-ments. Return values returned by function .
(Fuvalues-list list) ⊲ Return elements of list .
(Fuvalues foo∗)
⊲ Return as multiple values the primary values of the foos.setfable.
(Fumultiple-value-list form) ⊲ List of the values of form .
(Mnth-value n form)
⊲ Zero-indexed nth return value of form.
(Fucomplement function)
⊲ Return new function with same arguments and same sideeffects as function, but with complementary truth value.
(Fuconstantly foo)
⊲ Function of any number of arguments returning foo.
(Fuidentity foo) ⊲ Return foo.
(Fufunction-lambda-expression function)
⊲ If available, return lambda expression of function,2NIL if
function was defined in an environment without bindings,and
3name of function.
(Fufdefinition
foo
(setf foo)
ff)
⊲ Definition of global function foo. setfable.
(Fufmakunbound foo)
⊲ Remove global function or macro definition foo.
cocall-arguments-limitcolambda-parameters-limit
⊲ Upper bound of the number of function arguments orlambda list parameters, respectively; ≥ 50.
comultiple-values-limit
⊲ Upper bound of the number of values a multiple value canhave; ≥ 20.
9.4 Macros
Below, macro lambda list (macro-λ∗) has the form of either
([&whole var ] [E ]
var
(macro-λ∗)
ff∗[E ]
[&optional
8<:var
(
var
(macro-λ∗)
ff ˆinit NIL [supplied-p]
˜)
9=;
∗
] [E ]
[
&rest&body
ff rest-var
(macro-λ∗)
ff] [E ]
ˆ&key
8>><>>:
var
(
8<:
var
(:key
var
(macro-λ∗)
ff)
9=;
ˆinit NIL [supplied-p]
˜)
9>>=>>;
∗
[E ]
[&allow-other-keys]˜
[&aux
var
(var [init NIL ])
ff∗] [E ])
or
18
Common Lisp Quick Reference
([&whole var ] [E ]
var
(macro-λ∗)
ff∗[E ] [&optional
8<:var
(
var
(macro-λ∗)
ff ˆinit NIL [supplied-p]
˜)
9=;
∗
] [E ] . rest-var).
One toplevel [E ] may be replaced by &environment var . supplied-pis T if there is a corresponding argument. init forms can refer to anyinit and supplied-p to their left.
(
MdefmacroFudefine-compiler-macro
ff foo
(setf foo)
ff(macro-λ∗) (declare ddecl∗)∗
[ddoc] formP∗)⊲ Define macro foo which on evaluation as (foo tree) appliesexpanded forms to arguments from tree, which correspondsto tree-shaped macro-λs. forms are enclosed in an implicitsOblock named foo.
(Mdefine-symbol-macro foo form)
⊲ Define symbol macro foo which on evaluation evaluates ex-panded form.
(sOmacrolet ((foo (macro-λ∗) (declare ̂local-decl∗)∗ [ddoc]
macro-formP∗)∗) (declare ddecl∗)∗ formP∗)
⊲ Evaluate forms with locally defined mutually invisiblemacros foo which are enclosed in implicit
sOblocks of the same
name.
(sOsymbol-macrolet ((foo expansion-form)∗) (declare ddecl∗)∗ formP∗)
⊲ Evaluate forms with locally defined symbol macros foo.
(Mdefsetf ̂function
(ûpdater [ddoc](setf-λ∗) (s-var∗) (declare ddecl∗)∗ [ddoc] formP∗
))
where defsetf lambda list (setf-λ∗) has the form
(var∗ˆ&optional
var
(varˆinit NIL [supplied-p]
˜)
ff∗˜
[&rest var ]ˆ&key
8<:var
(
var
(:key var)
ff ˆinit NIL [supplied-p]
˜)
9=;
∗
[&allow-other-keys]˜ ˆ
&environment var˜)
⊲ Specify how to setf a place accessed by function .Short form: (setf (function arg∗) value-form) is replaced by(updater arg∗ value-form); the latter must return value-form.Long form: on invocation of (setf (function arg∗) value-form),forms must expand into code that sets the place accessedwhere setf-λ and s-var∗ describe the arguments of functionand the value(s) to be stored, respectively; and that returnsthe value(s) of s-var∗. forms are enclosed in an implicit
sOblock
named function .
(Mdefine-setf-expander function (macro-λ∗) (declare ddecl∗)∗ [ddoc]
formP∗)
⊲ Specify how to setf a place accessed by function . On in-vocation of (setf (function arg∗) value-form), form∗ mustexpand into code returning arg-vars, args, newval-vars,set-form, and get-form as described with
Fuget-setf-expansion
where the elements of macro lambda list macro-λ∗ are boundto corresponding args. forms are enclosed in an implicit
sOblock
named function .
(Fuget-setf-expansion place [environment NIL ])
⊲ Return lists of temporary variables arg-vars and of cor-responding
2args as given with place , list
3newval-vars with
temporary variables corresponding to the new values, and
4set-form and
5get-form specifying in terms of arg-vars and
newval-vars how to setf and how to read place .
(Mdefine-modify-macro foo (
ˆ&optional
var
(varˆinit NIL [supplied-p]
˜)
ff∗˜[&rest var ]) function [ddoc])
⊲ Define macro foo able to modify a place. On invocation of(foo place arg∗), the value of function applied to place andargs will be stored into place and returned.
19
-
Common Lisp Quick Reference
{collect collecting} {form it} [into list ]⊲ Collect values of form or it into list . If no list is given,collect into an anonymous list which is returned after ter-mination.
{append appending nconc nconcing} {form it} [into list ]⊲ Concatenate values of form or it, which should be lists,into list by the means of
Fuappend or
Funconc, respectively.
If no list is given, collect into an anonymous list which isreturned after termination.
{count counting} {form it} [into n] [type]⊲ Count the number of times the value of form or of itis T. If no n is given, count into an anonymous variablewhich is returned after termination.
{sum summing} {form it} [into sum ] [type]⊲ Calculate the sum of the primary values of form or ofit. If no sum is given, sum into an anonymous variablewhich is returned after termination.
{maximize maximizing minimize minimizing} {form it} [intomax-min ] [type]⊲ Determine the maximum or minimum, respectively, ofthe primary values of form or of it. If no max-min isgiven, use an anonymous variable which is returned aftertermination.
{initially finally} form+⊲ Evaluate forms before begin, or after end, respectively,of iterations.
repeat num⊲ Terminate
Mloop after num iterations; num is evaluated
once.
{while until} test⊲ Continue iteration until test returns NIL or T, respec-tively.
{always never} test⊲ Terminate
Mloop returning NIL and skipping any finally
parts as soon as test is NIL or T, respectively. Otherwisecontinue
Mloop with its default return value set to T.
thereis test⊲ Terminate
Mloop when test is T and return value of test ,
skipping any finally parts. Otherwise continueMloop with
its default return value set to NIL.(
Mloop-finish)
⊲ TerminateMloop immediately executing any finally
clauses and returning any accumulated results.
10 CLOS
10.1 Classes
(Fuslot-exists-p foo bar) ⊲ T if foo has a slot bar .
(Fuslot-boundp instance slot) ⊲ T if slot in instance is bound.
(Mdefclass foo (superclass∗ standard-object )
(
8>>>>>>>>>>>>>>><>>>>>>>>>>>>>>>:
slot
(slot
8>>>>>>>>>>>>><>>>>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛
{:reader reader}∗
{:writerwriter
(setf writer)
ff}∗
{:accessor accessor}∗
:allocation
:instance:class
ff:instance
{:initarg :initarg-name}∗:initform form:type type:documentation slot-doc
9>>>>>>>>>>>>>=>>>>>>>>>>>>>;
)
9>>>>>>>>>>>>>>>=>>>>>>>>>>>>>>>;
∗
)
8<:
˛̨˛̨˛̨(:default-initargs {name value}∗)(:documentation class-doc)(:metaclass name standard-class )
9=;)
24
Common Lisp Quick Reference
(
MprogMprog∗
ff(
̨̨˛̨name(name [value NIL ])
ff∗) (declare ddecl∗)∗
ctagform
ff∗)
⊲ EvaluatesOtagbody-like body with names lexically bound (in
parallel or sequentially, respectively) to values. Return NILor explicitly
Mreturned values. Implicitly, the whole form is a
sOblock named NIL.
(sOprogv symbols values form
P∗)⊲ Evaluate forms with locally established dynamic bindingsof symbols to values or NIL. Return values of forms.
(sOunwind-protect protected cleanup∗)
⊲ Evaluate protected and then, no matter how control leavesprotected , cleanups. Return values of protected .
(Mdestructuring-bind destruct-λ bar (declare ddecl∗)∗ formP∗)
⊲ Evaluate forms with variables from tree destruct-λ boundto corresponding elements of tree bar , and return their values.destruct-λ resembles macro-λ (section 9.4), but without any&environment clause.
(Mmultiple-value-bind (dvar∗) values-form (declare ddecl∗)∗
body-formP∗)
⊲ Evaluate body-forms with vars lexically bound to the re-turn values of values-form . Return values of body-form s.
(sOblock name form
P∗)⊲ Evaluate forms in a lexical environment, and return theirvalues unless interrupted by
sOreturn-from.
(sOreturn-from foo [result NIL ])
(Mreturn [result NIL ])
⊲ Have nearest enclosingsOblock named foo/named NIL, re-
spectively, return with values of result .
(sOtagbody {ctag form}∗)
⊲ Evaluate forms in a lexical environment. tags (symbolsor integers) have lexical scope and dynamic extent, and aretargets for
sOgo. Return NIL.
(sOgo ctag)
⊲ Within the innermost possible enclosingsOtagbody, jump to
a tag eql tag .
(sOcatch tag form
P∗)⊲ Evaluate forms and return their values unless interruptedby
sOthrow.
(sOthrow tag form)
⊲ Have the nearest dynamically enclosingsOcatch with a tag
Fueq tag return with the values of form.
(Fusleep n) ⊲ Wait n seconds, return NIL.
9.6 Iteration
(
MdoMdo∗
ff(
var
(varˆstart [step]
˜)
ff∗) (stop result
P∗) (declare ddecl∗)∗ctagform
ff∗)
⊲ EvaluatesOtagbody-like body with vars successively bound
according to the values of the corresponding start and stepforms. vars are bound in parallel/sequentially, respectively.Stop iteration when stop is T. Return values of result∗. Im-plicitly, the whole form is a
sOblock named NIL.
(Mdotimes (var i [result NIL ]) (declare ddecl∗)∗ {ctag form}∗)
⊲ EvaluatesOtagbody-like body with var successively bound to
integers from 0 to i − 1. Upon evaluation of result , var is i .Implicitly, the whole form is a
sOblock named NIL.
(Mdolist (var list [result NIL ]) (declare ddecl∗)∗ {ctag form}∗)
⊲ EvaluatesOtagbody-like body with var successively bound
to the elements of list . Upon evaluation of result , var is NIL.Implicitly, the whole form is a
sOblock named NIL.
21
-
Common Lisp Quick Reference
9.7 Loop Facility
(Mloop form∗)
⊲ Simple Loop. If forms do not contain any atomic LoopFacility keywords, evaluate them forever in an implicit
sOblock
named NIL.
(Mloop clause∗)
⊲ Loop Facility. For Loop Facility keywords see below andFigure 1.
named n NIL ⊲ GiveMloop’s implicit
sOblock a name.
{withvar-s
(var-s∗)
ff[d-type] = foo}+
{andvar-p
(var-p∗)
ff[d-type] = bar}∗
where destructuring type specifier d-type has the formnfixnum float T NIL
˘of-type
type
(type∗)
ff¯o
⊲ Initialize (possibly trees of) local variables var-s se-quentially and var-p in parallel.
˘{for as}
var-s
(var-s∗)
ff[d-type]
+̄ ˘and
var-p
(var-p∗)
ff[d-type]
∗̄
⊲ Begin of iteration control clauses. Initialize and step(possibly trees of) local variables var-s sequentially andvar-p in parallel. Destructuring type specifier d-type aswith with.
{upfrom from downfrom} start⊲ Start stepping with start
{upto downto to below above} form⊲ Specify form as the end value for stepping.
{in on} list⊲ Bind var to successive elements/tails, respectively,of list .
by {step 1 function #’cdr}⊲ Specify the (positive) decrement or increment orthe function of one argument returning the next partof the list.
= foo [then bar foo ]
⊲ Bind var initially to foo and later to bar .across vector
⊲ Bind var to successive elements of vector .being {the each}
⊲ Iterate over a hash table or a package.
{hash-key hash-keys} {of in} hash-table [using(hash-value value)]⊲ Bind var successively to the keys of hash-table ;bind value to corresponding values.
{hash-value hash-values} {of in} hash-table [using(hash-key key)]⊲ Bind var successively to the values ofhash-table ; bind key to corresponding keys.
{symbol symbols present-symbol present-symbolsexternal-symbol external-symbols} [{of in}package var
∗package∗ ]
⊲ Bind var successively to the accessible symbols,or the present symbols, or the external symbolsrespectively, of package .
{do doing} form+⊲ Evaluate forms in every iteration.
{if when unless} test i-clause {and j-clause}∗ [else k-clause{and l-clause}∗] [end]⊲ If test returns T, T, or NIL, respectively, evaluatei-clause and j-clauses; otherwise, evaluate k-clause andl-clauses.
it ⊲ Inside i-clause or k-clause: value of test .
return {form it}⊲ Return immediately, skipping any finally parts, withvalues of form or it.
22
Common Lisp Quick Reference
(loop
[nam
ed
nNIL]8 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > :
with
var
(var∗)ff
[d-type]=
foo{a
nd
var
(var∗)ff
[d-type]=
bar}∗
for
as
ff v
ar
(var∗)ff
[d-type]8 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > :
ˆupfrom
from
ffst
art
0
˜ˆ8 < :
upto
to belo
w
9 = ;fo
rm˜
from
start
dow
nto
above
fffo
rm
dow
nfrom
start
ˆ8 < :dow
nto
to above
9 = ;fo
rm˜
9 > > > > > > > > > = > > > > > > > > > ;
[by
step1]
in on
fflist
[by
function
#’c
dr]
=fo
o[then
bar
foo]
acr
oss
vec
tor
bein
g
th
eeach
ff
8 > > > > > > > < > > > > > > > :
hash
-key[
s]
of
in
ffhash
[using
(hash
-valu
ev)]
hash
-valu
e[s
]of
in
ffhash
[using
(hash
-key
k)]
sym
bol[s]
pre
sent-
sym
bol[s]
ext
ern
al-sy
mbol[s]
9 = ;ˆ
of
in
ffpackage
var
∗pack
age∗
˜9 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > = > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > ;F0
n and
Fi
o ∗
T1
9 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > = > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > ;∗8 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > :
do[ing]fo
rm+
if when
unle
ss
9 = ;te
stC
i{a
nd
Cj}∗
[else
Ck{a
nd
Cl}∗
][end]
retu
rn
fo
rm
itco
llect
[ing]
append[ing]
nco
nc[
ing]
9 = ;
fo
rm
it
ff[into
list
]
count[in
g]
sum
[min
g]
maxi
miz
em
axi
miz
ing
min
imiz
em
inim
izin
g
9 > > > > > = > > > > > ;
fo
rm
it
ff[into
num
][type]
C0
initia
lly
finally
fffo
rm+
repeatnum
while
until
alw
ays
neve
rth
ere
is
9 > > > = > > > ;te
st
T2
9 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > = > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > ;∗
)
Figure 1: Loop Facility,Overview.
23
-
Common Lisp Quick Reference
⊲ Long Form. Define new method-combination c-type. A callto a generic function using c-type will be equivalent to a callto the forms returned by body∗ with ord-λ∗ bound to c-arg∗
(cf.Mdefgeneric), with symbol bound to the generic function,
with method-combination-λ∗ bound to the arguments of thegeneric function, and with groups bound to lists of meth-ods. An applicable method becomes a member of the left-most group whose predicate or qualifiers match. Methodscan be called via
Mcall-method. Lambda lists (ord-λ∗) and
(method-combination-λ∗) according to ord-λ on p. 17, thelatter enhanced by an optional &whole argument.
(Mcall-method
(m̂ethod
(Mmake-method f̂orm)
)ˆ(
(̂next-method
(Mmake-method f̂orm)
)∗)˜)
⊲ From within an effective method form, call method withthe arguments of the generic function and with informationabout its next-methods; return its values.
11 Conditions and Errors
For standardized condition types cf. Figure 2 on page 31.
(Mdefine-condition foo (parent-type∗ condition )
(
8>>>>>>>>>>>>>>><>>>>>>>>>>>>>>>:
slot
(slot
8>>>>>>>>>>>>><>>>>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛
{:reader reader}∗
{:writerwriter
(setf writer)
ff}∗
{:accessor accessor}∗
:allocation
:instance:class
ff:instance
{:initarg :initarg-name}∗:initform form:type type:documentation slot-doc
9>>>>>>>>>>>>>=>>>>>>>>>>>>>;
)
9>>>>>>>>>>>>>>>=>>>>>>>>>>>>>>>;
∗
)
8>><>>:
˛̨˛̨˛̨˛̨
(:default-initargs {name value}∗)(:documentation condition-doc)
(:report
string
report-function
ff)
9>>=>>;
)
⊲ Define, as a subtype of parent-types, condition type foo.In a new condition, a slot ’s value defaults to form unless setvia :initarg-name; it is readable via (reader i) or (accessor i),and writeable via (writer i value) or (setf (accessor i) value).With :allocation :class, slot is shared by all conditions of typefoo. A condition is reported by string or by report-functionof arguments condition and stream.
(Fumake-condition type {:initarg-name value}∗)
⊲ Return new condition of type .
(
8<:
FusignalFuwarnFuerror
9=;
8<:condition
type {:initarg-name value}∗control arg∗
9=;)
⊲ Unless handled, signal as condition, warning or error,respectively, condition or a new condition of type or,with
Fuformat control and args (see p. 37), simple-condition,
simple-warning, or simple-error, respectively. FromFusignal and
Fuwarn, return NIL.
(Fucerror continue-control
8<:condition continue-arg∗
type {:initarg-name value}∗control arg∗
9=;)
⊲ Unless handled, signal as correctable error condition or anew condition of type or, with
Fuformat control and args (see
p. 37), simple-error. In the debugger, useFuformat arguments
continue-control and continue-args to tag the continue op-tion. Return NIL.
(Mignore-errors form
P∗)⊲ Return values of forms or, in case of errors, NIL and the
2condition.
28
Common Lisp Quick Reference
⊲ Define, as a subclass of superclasses, class foo . In a newinstance i , a slot ’s value defaults to form unless set via:initarg-name ; it is readable via (reader i) or (accessor i),and writeable via (writer i value) or (setf (accessor i) value).With :allocation :class, slot is shared by all instances of classfoo.
(Fufind-class symbol
ˆerrorp T [environment ]
˜)
⊲ Return class named symbol . setfable.
(gFmake-instance class {:initarg value}∗ other-keyarg∗)
⊲ Make new instance of class .
(gFreinitialize-instance instance {:initarg value}∗ other-keyarg∗)
⊲ Change local slots of instance according to initargs.
(Fuslot-value foo slot) ⊲ Return value of slot in foo . setfable.
(Fuslot-makunbound instance slot)
⊲ Make slot in instance unbound.
(
Mwith-slots ({dslot (dvar dslot)}∗)Mwith-accessors ((dvar ̂accessor)∗)
ffinstance (declare ddecl∗)∗
formP∗)
⊲ Return values of forms after evaluating them in a lexicalenvironment with slots of instance visible as setfable slots orvars/with accessor s of instance visible as setfable vars.
(gFclass-name class)
((setfgFclass-name) new-name class)
⊲ Get/set name of class .
(Fuclass-of foo) ⊲ Class foo is a direct instance of.
(gFchange-class ˜instance new-class {:initarg value}∗ other-keyarg∗)
⊲ Change class of instance to new-class.
(gFmake-instances-obsolete class) ⊲ Update instances of class.
(
gFinitialize-instance (instance)gFupdate-instance-for-different-class previous current
ff
{:initarg value}∗ other-keyarg∗)⊲ Its primary method sets slots on behalf of
gFmake-instance/of
gFchange-class by means of
gFshared-initialize.
(gFupdate-instance-for-redefined-class instances added-slots
discarded-slots property-list {:initarg value}∗ other-keyarg∗)⊲ Its primary method sets slots on behalf ofgFmake-instances-obsolete by means of
gFshared-initialize.
(gFallocate-instance class {:initarg value}∗ other-keyarg∗)
⊲ Return uninitialized instance of class. Called bygFmake-instance.
(gFshared-initialize instance
slots
T
ff{:initarg value}∗ other-keyarg∗)
⊲ Fill instance’s slots using initargs and :initform forms.
(gFslot-missing class object slot
8>><>>:
setfslot-boundpslot-makunboundslot-value
9>>=>>;
[value])
⊲ Called in case of attempted access to missing slot . Its pri-mary method signals error.
(gFslot-unbound class instance slot)
⊲ Called byFuslot-value in case of unbound slot . Its primary
method signals unbound-slot.
25
-
Common Lisp Quick Reference
10.2 Generic Functions
(Funext-method-p) ⊲ T if enclosing method has a next method.
(Mdefgeneric
foo
(setf foo)
ff(required-var∗
ˆ&optional
var
(var)
ff∗˜ ˆ&rest
var˜ ˆ
&key
var
(var (:key var))
ff∗[&allow-other-keys]
˜)
8>>>>>>>><>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨
(:argument-precedence-order required-var+)(declare (optimize arg∗)+)
(:documentation ŝtring)(:generic-function-class class standard-generic-function )
(:method-class class standard-method )(:method-combination c-type standard c-arg
∗)(:method defmethod-args)∗
9>>>>>>>>=>>>>>>>>;
)
⊲ Define generic function foo. defmethod-args resemble thoseof
Mdefmethod. For c-type see section 10.3.
(Fuensure-generic-function
foo
(setf foo)
ff
8>>>>>>>>><>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛
:argument-precedence-order required-var+
:declare (optimize arg∗)+
:documentation string:generic-function-class class:method-class class:method-combination c-type c-arg∗
:lambda-list lambda-list:environment environment
9>>>>>>>>>=>>>>>>>>>;
)
⊲ Define or modify generic function foo.:generic-function-class and :lambda-list have to be com-patible with a pre-existing generic function or with existingmethods, respectively. Changes to :method-class do notpropagate to existing methods. For c-type see section 10.3.
(Mdefmethod
foo
(setf foo)
ff[
8>><>>:
:before:after:aroundqualifier∗
9>>=>>;
primary method ]
(
8<:
var
(spec-var
class
(eql bar)
ff)
9=;
∗ˆ&optional
var
(varˆinit [supplied-p]
˜)
ff∗˜[&rest var ]
ˆ&key
8<:var
(
var
(:key var)
ffˆinit [supplied-p]
˜)
9=;
∗
[&allow-other-keys]˜
ˆ&aux
var
(var [init ])
ff∗˜)
(̨̨˛̨˛(declare ddecl∗)∗ddoc
)form
P∗)
⊲ Define new method for generic function foo. spec-vars spe-cialize to either being of class or being eql bar , respectively.On invocation, vars and spec-vars of the new method act likeparameters of a function with body form∗. forms are en-closed in an implicit
sOblock foo. Applicable qualifiers depend
on the method-combination type; see section 10.3.
(
gFadd-methodgFremove-method
ffgeneric-function method)
⊲ Add (if necessary) or remove (if any) method to/fromgeneric-function.
(gFfind-method generic-function qualifiers specializers [error T ])
⊲ Return suitable method, or signal error.
(gFcompute-applicable-methods generic-function args)
⊲ List of methods suitable for args, most specific first.
(Fucall-next-method arg∗ current args )
⊲ From within a method, call next method with args; returnits values.
(gFno-applicable-method generic-function arg∗)
⊲ Called on invocation of generic-function on args if there isno applicable method. Default method signals error.
26
Common Lisp Quick Reference
(
Fuinvalid-method-error methodFumethod-combination-error
ffcontrol arg∗)
⊲ Signal error on applicable method with invalid qualifiers,or on method combination. For control and args see format,p. 37.
(gFno-next-method generic-function method arg∗)
⊲ Called on invocation of call-next-method when there is nonext method. Default method signals error.
(gFfunction-keywords method)
⊲ Return list of keyword parameters of method and2T if other
keys are allowed.
(gFmethod-qualifiers method) ⊲ List of qualifiers of method .
10.3 Method Combination Types
standard⊲ Evaluate most specific :around method supplying the val-ues of the generic function. From within this method,Fucall-next-method can call less specific :around methods if thereare any. If not, or if there are no :around methods at all, callall :before methods, most specific first, and the most spe-cific primary method which supplies the values of the callingFucall-next-method if any, or of the generic function; and whichcan call less specific primary methods via
Fucall-next-method.
After its return, call all :after methods, least specific first.
and or append list nconc progn max min +⊲ Simple built-in method-combination types; have thesame usage as the c-types defined by the short form ofMdefine-method-combination.
(Mdefine-method-combination c-type8
<:
˛̨˛̨˛̨:documentation ŝtring:identity-with-one-argument bool NIL:operator operator c-type
9=;)
⊲ Short Form. Define new method-combination c-type. Ina generic function using c-type, evaluate most specific:around method supplying the values of the generic func-tion. From within this method,
Fucall-next-method can
call less specific :around methods if there are any. Ifnot, or if there are no :around methods at all, re-turn from the calling call-next-method or from thegeneric function, respectively, the values of (operator(primary-method gen-arg∗)∗), gen-arg∗ being the argumentsof the generic function. The primary-methods are orderedˆ:most-specific-first
:most-specific-last
ff:most-specific-first
˜(specified as c-arg in
Mdefgeneric). Using c-type as the qualifier in
Mdefmethod makes
the method primary.
(Mdefine-method-combination c-type (ord-λ∗) ((group8
<:
∗
(qualifier∗ˆ∗
˜)
predicate
9=;
8>><>>:
˛̨˛̨˛̨˛̨
:description control
:order
:most-specific-first:most-specific-last
ff:most-specific-first
:required bool
9>>=>>;
)∗)
8>><>>:
˛̨˛̨˛̨˛̨
(:arguments method-combination-λ∗)(:generic-function symbol)
(declare ddecl∗)∗ddoc
9>>=>>;
bodyP∗)
27
-
Common Lisp Quick Reference
(
MctypecaseMetypecase
fffoo ( dtype formP∗)∗)
⊲ Return values of the form s whose type is foo of. Sig-nal correctable/non-correctable error, respectively if no typematches.
(Futype-of foo) ⊲ Type of foo .
(Mcheck-type place type [string
{a an} type])
⊲ Signal correctable type-error if place is not of type. ReturnNIL.
(Fustream-element-type stream) ⊲ Return type of stream objects.
(Fuarray-element-type array) ⊲ Element type array can hold.
(Fuupgraded-array-element-type type [environment NIL ])
⊲ Element type of most specialized array capable of holdingelements of type.
(Mdeftype foo (macro-λ∗) (declare ddecl∗)∗ [ddoc] formP∗)
⊲ Define type foo which when referenced as (foo carg∗) ap-plies expanded forms to args returning the new type. For(macro-λ∗) see p. 18 but with default value of ∗ instead ofNIL. forms are enclosed in an implicit
sOblock named foo.
(eql foo)(member foo∗)
⊲ Specifier for a type comprising foo or foos.
(satisfies predicate)⊲ Type specifier for all objects satisfying predicate .
(mod n) ⊲ Type specifier for all non-negative integers < n.
(not type) ⊲ Complement of type.
(and type∗ T ) ⊲ Type specifier for intersection of types.
(or type∗ NIL ) ⊲ Type specifier for union of types.
(values type∗ˆ&optional type∗ [&rest other-args]
˜)
⊲ Type specifier for multiple values.
∗ ⊲ As a type argument (cf. Figure 2): no restriction.
13 Input/Output
13.1 Predicates
(Fustreamp foo)
(Fupathnamep foo)
(Fureadtablep foo)
⊲ T if foo is of indicated type.
(Fuinput-stream-p stream)
(Fuoutput-stream-p stream)
(Fuinteractive-stream-p stream)
(Fuopen-stream-p stream)
⊲ Return T if stream is for input, for output, interactive, oropen, respectively.
(Fupathname-match-p path wildcard )
⊲ T if path matches wildcard .
(Fuwild-pathname-p path
ˆ{:host :device :directory :name :type :version
NIL}˜)
⊲ Return T if indicated component in path is wildcard. (NILindicates any component.)
32
Common Lisp Quick Reference
(Fuinvoke-debugger condition)
⊲ Invoke debugger with condition .
(Massert test
ˆ(place∗) [
8<:condition continue-arg∗
type {:initarg-name value}∗control arg∗
9=;]
˜)
⊲ If test , which may depend on places, returns NIL, signalas correctable error condition or a new condition of type or,with
Fuformat control and args (see p. 37), error. When using
the debugger’s continue option, places can be altered beforere-evaluation of test. Return NIL.
(Mhandler-case foo (type ([var ]) (declare ddecl∗)∗ condition-formP∗)∗
[(:no-error (ord-λ∗) (declare ddecl∗)∗ formP∗)])⊲ If, on evaluation of foo, a condition of type is signalled,evaluate matching condition-forms with var bound to thecondition, and return their values. Without a condition, bindord-λs to values of foo and return values of forms or, withouta :no-error clause, return values of foo . See p. 17 for (ord-λ∗).
(Mhandler-bind ((condition-type handler-function)∗) form
P∗)⊲ Return values of forms after evaluating them withcondition-types dynamically bound to their respectivehandler-functions of argument condition.
(Mwith-simple-restart (
restart
NIL
ffcontrol arg∗) form
P∗)
⊲ Return values of forms unless restart is called during theirevaluation. In this case, describe restart using
Fuformat control
and args (see p. 37) and return NIL and2T.
(Mrestart-case form (foo (ord-λ∗)
8>><>>:
˛̨˛̨˛̨˛̨
:interactive arg-function
:report
report-function
string "foo":test test-function T
9>>=>>;
(declare ddecl∗)∗ restart-formP∗)∗)⊲ Evaluate form with dynamically established restarts foo.Return values of form or, if by (
Fuinvoke-restart foo arg∗) one
restart foo is called, use string or report-function (of a stream)to print a description of restart foo and return the values ofits restart-forms. arg-function supplies appropriate args iffoo is called by
Fuinvoke-restart-interactively. If (test-function
condition) returns T, foo is made visible under condition .arg∗ matches (ord-λ∗); see p. 17 for the latter.
(Mrestart-bind ((
r̂estart
NIL
ffrestart-function
8<:
˛̨˛̨˛̨:interactive-function function:report-function function:test-function function
9=;)
∗) formP∗)
⊲ Return values of forms evaluated with restarts dynamicallybound to restart-functions.
(Fuinvoke-restart restart arg∗)
(Fuinvoke-restart-interactively restart)
⊲ Call function associated with restart with arguments givenor prompted for, respectively. If restart function returns, re-turn its values.
(
Fucompute-restartsFufind-restart name
ff[condition ])
⊲ Return list of all restarts, or innermost restart name , re-spectively, out of those either associated with condition orun-associated at all; or, without condition , out of all restarts.Return NIL if search is unsuccessful.
(Furestart-name restart) ⊲ Name of restart .
29
-
Common Lisp Quick Reference
(
8>>><>>>:
FuabortFumuffle-warningFucontinueFustore-value valueFuuse-value value
9>>>=>>>;
[condition NIL ])
⊲ Transfer control to innermost applicable restart with samename (i.e. abort, . . . , continue . . . ) out of those either as-sociated with condition or un-associated at all; or, withoutcondition , out of all restarts. If no restart is found, signalcontrol-error for
Fuabort and
Fumuffle-warning, or return NIL for
the rest.
(Mwith-condition-restarts condition restarts form
P∗)⊲ Evaluate forms with restarts dynamically associated withcondition . Return values of forms.
(Fuarithmetic-error-operation condition)
(Fuarithmetic-error-operands condition)
⊲ List of function or of its operands respectively, used in theoperation which caused condition .
(Fucell-error-name condition)
⊲ Name of cell which caused condition .
(Fuunbound-slot-instance condition)
⊲ Instance with unbound slot which caused condition .
(Fuprint-not-readable-object condition)
⊲ The object not readably printable under condition .
(Fupackage-error-package condition)
(Fufile-error-pathname condition)
(Fustream-error-stream condition)
⊲ Package, path, or stream, respectively, which caused thecondition of indicated type.
(Futype-error-datum condition)
(Futype-error-expected-type condition)
⊲ Object which caused condition of type type-error, or itsexpected type, respectively.
(Fusimple-condition-format-control condition)
(Fusimple-condition-format-arguments condition)
⊲ ReturnFuformat control or list of
Fuformat arguments, respec-
tively, of condition .
var∗break-on-signals∗NIL
⊲ Condition type debugger is to be invoked on.
var∗debugger-hook∗NIL
⊲ Function of condition and function itself. Called beforedebugger.
12 Types and Classes
For any class, there is always a corresponding type of the samename.
(Futypep foo type [environment NIL ]) ⊲ T if foo is of type.
(Fusubtypep type-a type-b [environment ])
⊲ Return T if type-a is a recognizable subtype of type-b, and
2NIL if the relationship could not be determined.
(sOthe dtype form) ⊲ Declare values of form to be of type.
(Fucoerce object type) ⊲ Coerce object into type.
(Mtypecase foo ( dtype a-formP∗)∗
ˆ(
otherwiseT
ffb-form NIL
P∗)˜)
⊲ Return values of the a-forms whose type is foo of. Returnvalues of b-forms if no type matches.
30
Common Lisp Quick Reference
Tato
m
readta
ble
pack
age
sym
bol
keyw
ord
boole
an
rest
art
random
-sta
te
hash
-table
stru
cture
-obje
ct
standar
d-o
bje
ct
null
class
built-
in-c
lass
standar
d-c
lass
stru
cture
-cla
ss
meth
od
standar
d-m
eth
od
meth
od-c
om
bin
ation
chara
cter
funct
ion
ˆ arg
-types
[valu
e-types]˜
com
piled-funct
ion
generic-
funct
ion
standar
d-g
eneric-
funct
ion
path
nam
e
logic
al-path
nam
enum
ber
com
ple
x[type
∗]
real
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
float
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
short
-float
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
single
-float
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
double
-float
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
long-fl
oat
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
rational
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
inte
ger
ˆ lower-
lim
it∗
[upper-
lim
it∗]˜
ratio
signed-b
yte
[size
∗]
fixn
um
big
num
unsigned-b
yte
[size
∗]
bit
list
sequence
cons
ˆ car-
type
∗[cdr-
type
∗]˜
arra
yˆ t
ype
∗[rank
∗(d
imension∗)]
˜
sim
ple
-arr
ayˆ t
ype
∗[rank
∗(d
imension∗)]
˜
vect
or
ˆ type
∗[size
∗]˜
string
[size
∗]
sim
ple
-str
ing
[size
∗]
base
-str
ing
[size
∗]
sim
ple
-base
-str
ing
[size
∗]
sim
ple
-vect
or
[size
∗]
bit-v
ect
or
[size
∗]
sim
ple
-bit-v
ect
or
[size
∗]
stre
am
file
-str
eam
two-w
ay-s
tream
synonym
-str
eam
string-s
tream
bro
adca
st-s
tream
conca
tenate
d-s
tream
ech
o-s
tream
ext
ended-c
har
base
-char
standar
d-c
har
conditio
n
serious-
conditio
nst
ora
ge-c
onditio
n
sim
ple
-typ
e-e
rror
type-e
rror
err
or pro
gra
m-e
rror
contr
ol-err
or
pack
age-e
rror
print-
not-
readable
stre
am
-err
or
par
se-e
rror
cell-e
rror
file
-err
or
arithm
etic-
err
or
sim
ple
-conditio
n
war
nin
g
styl
e-w
arnin
g
sim
ple
-err
or
sim
ple
-war
nin
g
end-o
f-file
reader-
err
or
unbound-v
ariable
undefined-funct
ion
unbound-s
lot
div
isio
n-b
y-ze
ro
floating-p
oin
t-in
exa
ct
floating-p
oin
t-ove
rflow
floating-p
oin
t-underfl
ow
floating-p
oin
t-in
valid-o
pera
tion
Figure 2: Precedence Order of System Classes ( ), Classes ( ),Types ( ), and Condition Types ( ).
31
-
Common Lisp Quick Reference
(
FuwriteFuwrite-to-string
fffoo
8>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>:
˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛̨˛