1 % Copyright (C) 2008, 2009 Bert Burgemeister
3 % Permission is granted to copy, distribute and/or modify this
4 % document under the terms of the GNU Free Documentation License,
5 % Version 1.2 or any later version published by the Free Software
6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
7 % no Back-Cover Texts. For details see file COPYING.
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11 \section{Control Structure
}
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15 \subsection{Predicates
}
16 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
19 \IT{(
\FU*
{EQ
} \VAR{foo bar
})
}
21 \retval{\T} if
\VAR{foo
} and
\VAR{bar
} are identical.
24 \IT{(
\FU*
{EQL
} \VAR{foo bar
})
}
26 \retval{\T} if
\VAR{foo
} and
\VAR{bar
}
27 are identical, or the same
\kwd{character
}, or
\kwd{number
}s of the
31 \IT{(
\FU*
{EQUAL
} \VAR{foo bar
})
}
33 \retval{\T} if
\VAR{foo
} and
\VAR{bar
}
34 are
\FU{EQL
}, or are equivalent
\kwd{pathname
}s, or are
\kwd{cons
}es with
35 \FU{equal
} cars and cdrs, or are
\kwd{string
}s or
\kwd{bit-vector
}s with
36 \FU{eql
} elements below their fill pointers.
39 \IT{(
\FU*
{EQUALP
} \VAR{foo bar
})
}
41 \retval{\T} if
\VAR{foo
} and
\VAR{bar
} are identical; or are the
42 same
\kwd{character
} ignoring case; or are
\kwd{number
}s of the same
43 value ignoring type; or are equivalent
\kwd{pathname
}s; or are
44 \kwd{cons
}es or
\kwd{array
}s of the same shape with
\FU{equalp
}
45 elements; or are structures of the same type with
46 \kwd{equalp
} elements; or are
\kwd{hash-table
}s of the same size
47 with the same
\kwd{:test
} function, the same keys in terms of
48 \kwd{:test
} function, and
\kwd{equalp
} elements.
51 \IT{(
\FU*
{NOT
} \VAR{foo
})
}
53 \retval{\T} if
\VAR{foo
} is
\NIL,
\retval{\NIL} otherwise.
56 \IT{(
\FU*
{BOUNDP
} \VAR{symbol
})
}
58 \retval{\T} if
\VAR{symbol
} is a special variable.
61 \IT{(
\FU*
{CONSTANTP
} \VAR{foo
} \Op{\VAR{environment
}\DF{\NIL}})
}
63 \retval{\T} if
\VAR{foo
} is a constant form.
66 \IT{(
\FU*
{FUNCTIONP
} \VAR{foo
})
}
68 \retval{\T} if
\VAR{foo
} is of type
\kwd{function
}.
71 \IT{(
\FU*
{FBOUNDP
} \xorGOO{\VAR{foo
}\\
72 (
\kwd{setf
} \VAR{foo
})
}{\
}})
}
74 \retval{\T} if
\VAR{foo
} is a global function or macro.
81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 \subsection{Variables
}
83 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89 \MC*
{DEFPARAMETER
}}{\
}} \NEV{\VAR{foo
}} \VAR{form
}
90 \Op{\NEV{\VAR{doc
}}})
}
92 Assign value of
\VAR{form
} to global constant/dynamic variable
\retval{\VAR{foo
}}.
95 \IT{(
\MC*
{DEFVAR
} \NEV{\VAR{foo
}} \OP{\VAR{form
}
96 \Op{\NEV{\VAR{doc
}}}})
}
98 Unless bound already, assign value of
\VAR{form
} to dynamic variable
102 \IT{(
\xorGOO{\MC*
{SETF
}\\
103 \MC*
{PSETF
}}{\
}} \Goos{\VAR{place
}
106 Set
\VAR{place
}s to primary values of
\VAR{form
}s. Return
\retval{values
107 of last
\VAR{form
}}/
\retval{\NIL}; work sequentially/in parallel, respectively.
110 \IT{(
\xorGOO{\SO*
{SETQ
}\\
111 \MC*
{PSETQ
}}{\
}} \Goos{\VAR{symbol
}
114 Set
\VAR{symbol
}s to primary values of
\VAR{form
}s. Return
\retval{value
115 of last
\VAR{form
}}/
\retval{\NIL}; work sequentially/in parallel, respectively.
118 \IT{(
\FU*
{SET
} \DES{\VAR{symbol
}} \VAR{foo
})
}
120 Set
\VAR{symbol
}'s value cell to
\retval{\VAR{foo
}}. Deprecated.
123 \IT{(
\MC*
{MULTIPLE-VALUE-SETQ
} \VAR{vars
} \VAR{form
})
}
125 Set elements of
\VAR{vars
} to the values of
126 \VAR{form
}. Return
\retval{\VAR{form
}'s primary value
}.
129 \IT{(
\MC*
{SHIFTF
} \RP{\DES{\VAR{place
}}} \VAR{foo
})
}
131 Store value of
\VAR{foo
} in rightmost
\VAR{place
} shifting values of
132 \VAR{place
}s left, returning
\retval{first
\VAR{place
}}.
135 \IT{(
\MC*
{ROTATEF
} \OPn{\DES{\VAR{place
}}})
}
137 Rotate values of
\VAR{place
}s left, old first becoming new last
138 \VAR{place
}'s value. Return
\retval{\NIL}.
141 \IT{(
\FU*
{MAKUNBOUND
} \DES{\VAR{foo
}})
}
143 Delete special variable
\retval{\VAR{foo
}} if any.
146 \label{:property_lists
}
147 \IT{\arrGOO{(
\FU*
{GET
} \VAR{ symbol
} \VAR{ key
}
148 \OP{\VAR{default
}\DF{\NIL}})\\
149 (
\FU*
{GETF
} \VAR{ place
} \VAR{ key
}
150 \OP{\VAR{default
}\DF{\NIL}})
}{.
}}
152 \retval{First entry
\VAR{key
}} from property list stored in
153 \VAR{symbol
}/in
\VAR{place
}, respectively, or
\retval{\VAR{default
}} if
154 there is no
\VAR{key
}.
\kwd{setf
}able.
157 \IT{(
\FU*
{GET-PROPERTIES
} \VAR{property-list
} \VAR{keys
})
}
159 Return
\retval{key
} and
\retvalii{value
} of first entry from
\VAR{property-list
}
160 matching a key from
\VAR{keys
}, and
\retvaliii{tail of
161 \VAR{property-list
}} starting with that key. Return
\retval{\NIL},
162 \retvalii{\NIL}, and
\retvaliii{\NIL} if there was no matching key
163 in
\VAR{property-list
}.
166 \IT{\arrGOO{(
\FU*
{REMPROP
} \DES{\VAR{symbol
}} \VAR{ key
})\\
167 (
\MC*
{REMF
} \DES{\VAR{place
}} \VAR{ key
})
}{.
}}
169 Remove first entry
\VAR{key
} from property list stored in
170 \VAR{symbol
}/in
\VAR{place
}, respectively. Return
\retval{\T} if
\VAR{key
}
171 was there, or
\retval{\NIL} otherwise.
177 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
178 \subsection{Functions
}
179 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
180 \label{section:Functions
}
183 Below, ordinary lambda list (
\OPn{\VAR{ord-$
\lambda$
}}) has the form\\
184 % \VAR{var} referenced from DEFSTRUCT
186 \OP{\kwd{\&optional
} \xorGOO{%
188 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
190 \Op{\kwd{\&rest
} \VAR{var
}}
192 \OP{\kwd{\&key
} \xorGOO{%
196 (
\kwd{:
}\VAR{key
} \VAR{var
})
}{\
}}
197 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ }\Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
199 \Op{\kwd{\&allow-other-keys
}}}
201 \OP{\kwd{\&aux
} \xorGOO{%
203 (
\VAR{var
} \Op{\VAR{init
}\DF{\NIL}})
}{\
}^
{\!\!*
}}}).
205 \VAR{supplied-p
} is
\T\ if there is a corresponding
206 argument.
\VAR{init
} forms can refer to any
\VAR{init
} and
207 \VAR{supplied-p
} to their left.
211 \IT{(
\xorGOO{\MC*
{DEFUN
}\xorGOO{\VAR{foo
}\\
212 (
\kwd{setf
} \VAR{ foo
})
}{.
}\\
214 (
\VAR{\OPn{ord-$
\lambda$
}})
\OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
218 Define a function named
\retval{\VAR{foo
}} or
\retval{(
\kwd{setf
}
219 \VAR{foo
})
}, or an anonymous
\retval{function
}, respectively, which applies
220 \VAR{form
}s to
\VAR{ord-$
\lambda$
}s. For
\MC{defun
},
\VAR{form
}s are
221 enclosed in an implicit
\SO{block
} \VAR{foo
}.
224 \IT{(
\xorGOO{\SO*
{FLET
}\\
226 (
\OPn{(
\xorGOO{\VAR{foo
}\\
227 (
\kwd{setf
} \VAR{ foo
})
}{\
}}
228 (
\OPn{\VAR{ord-$
\lambda$
}})
229 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{local-decl
}}})
}
231 \PROGN{\VAR{local-form
}})
})
\OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
234 Evaluate
\VAR{form
}s with
235 locally defined functions
\VAR{foo
}. Globally defined functions of
236 the same name are shadowed. Each
\VAR{foo
} is also the name of an
237 implicit
\SO{block
} around its corresponding
\OPn{\VAR{local-form
}}.
238 Only for
\SO{LABELS
}, functions
\VAR{foo
} are visible inside
239 \VAR{local-forms
}. Return
\retval{values of
\VAR{form
}s
}.
242 \IT{(
\SO*
{FUNCTION
} \xorGOO{%
244 (
\MC{lambda
} \OPn{\VAR{form
}})
}{\
}})
}
246 Return lexically innermost
\retval{function
} named
\VAR{foo
} or a
247 lexical closure of the
\retval{\MC{lambda
} expression
}.
250 \IT{(
\FU*
{APPLY
} \xorGOO{\VAR{function
}\\
251 (
\kwd{setf
} \VAR{function
})
}{\
}} \RP{\VAR{arg
}})
}
253 Return
\retval{values of
\VAR{function
}} called on
254 \VAR{arg
}s. Last
\VAR{arg
} must be a list.
\kwd{setf
}able if
255 \VAR{function
} is one of
\FU{aref
},
\FU{bit
}, and
\FU{sbit
}.
258 \IT{(
\FU*
{FUNCALL
} \VAR{function
} \OPn{arg
})
}
260 Return
\retval{values of
\VAR{function
}} called with
\VAR{arg
}s.
263 \IT{(
\SO*
{MULTIPLE-VALUE-CALL
} \VAR{foo
} \OPn{\VAR{form
}})
}
265 \VAR{foo
} with all the values of each
\VAR{form
} as its arguments. Return
266 \retval{values returned by
\VAR{foo
}}.
269 \IT{(
\FU*
{VALUES-LIST
} \VAR{list
})
}
271 Return
\retval{elements of
\VAR{list
}}.
274 \IT{(
\FU*
{VALUES
} \OPn{\VAR{foo
}})
}
276 Return as multiple values the
\retval{primary values
} of the
277 \VAR{foo
}s.
\kwd{setf
}able.
280 \IT{(
\FU*
{MULTIPLE-VALUE-LIST
} \VAR{form
})
}
282 Return in a
\retval{list
} values of
\VAR{form
}.
285 \IT{(
\MC*
{NTH-VALUE
} \VAR{n
} \VAR{form
})
}
287 Zero-indexed
\retval{\VAR{n
}th return value
} of
\VAR{form
}.
290 \IT{(
\FU*
{COMPLEMENT
} \VAR{function
})
}
292 Return
\retval{new function
} with same arguments and same side effects
293 as
\VAR{function
}, but with complementary truth value.
296 \IT{(
\FU*
{CONSTANTLY
} \VAR{foo
})
}
298 Return
\retval{function
} of any number of arguments returning
\VAR{foo
}.
301 \IT{(
\FU*
{IDENTITY
} \VAR{foo
})
}
303 Return
\retval{\VAR{foo
}}.
306 \IT{(
\FU*
{FUNCTION-LAMBDA-EXPRESSION
} \VAR{function
})
}
308 If available, return
\retval{lambda expression
} of
\VAR{function
},
309 \retvalii{\NIL} if
\VAR{function
} was defined in an environment
310 without bindings, and
\retvaliii{name
} of
\VAR{function
}.
313 \IT{(
\FU*
{FDEFINITION
} \xorGOO{\VAR{foo
}\\
314 (
\kwd{setf
} \VAR{foo
})
}{\
}})
}
316 \retval{Definition
} of global function
\VAR{foo
}.
\kwd{setf
}able.
319 \IT{(
\FU*
{FMAKUNBOUND
} \VAR{foo
})
}
321 Remove global function or macro definition
\retval{\VAR{foo
}}.
324 \IT{\arrGOO{\CNS*
{CALL-ARGUMENTS-LIMIT
}\\
325 \CNS*
{LAMBDA-PARAMETERS-LIMIT
}}{.
}}
327 Upper bound of the number of function arguments or lambda list
328 parameters, respectively; $
\geq50$.
331 \IT{\CNS*
{MULTIPLE-VALUES-LIMIT
}}
333 Upper bound of the number of values a multiple value can have;
340 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
342 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
343 \label{section:Macros
}
346 Below, macro lambda list (
\OPn{\VAR{macro-$
\lambda$
}}) has the form of
349 (
\Op{\kwd{\&whole
} \VAR{var
}}
355 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}^
{\!\!*
}}
364 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}\text{ }
365 \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
375 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}}
384 (
\kwd{:
}\VAR{key
} \xorGOO{%
386 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}})
}{\
}}
387 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
389 \Op{\kwd{\&allow-other-keys
}}}
394 (
\VAR{var
} \Op{\VAR{init
}\DF{\NIL}})
}{\
}^
{\!\!*
}}}
407 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}^
{\!\!*
}}
416 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}\text{ }
417 \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
424 One toplevel
\Op{\VAR{E
}} may be replaced by
\kwd{\&environment
}
425 \VAR{var
}.
\VAR{supplied-p
} is
\T\ if there is a corresponding
426 argument.
\VAR{init
} forms can refer to any
\VAR{init
} and
427 \VAR{supplied-p
} to their left.
431 \IT{(
\xorGOO{\MC*
{DEFMACRO
}\\
432 \FU*
{DEFINE-COMPILER-MACRO
}}{\
}}
434 (
\kwd{setf
} \VAR{foo
})
}{\
}}
435 (
\OPn{\VAR{macro-$
\lambda$
}})
436 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \Op{\NEV{\VAR{doc
}}}
439 Define macro
\retval{\VAR{foo
}} which on evaluation as (
\VAR{foo
}
440 \VAR{tree
}) applies expanded
\VAR{form
}s to arguments from
441 \VAR{tree
}, which corresponds to
\VAR{tree
}-shaped
442 \VAR{macro-$
\lambda$
}s.
\VAR{form
}s are enclosed in an implicit
443 \SO{block
} \VAR{foo
}.
446 \IT{(
\MC*
{DEFINE-SYMBOL-MACRO
} \VAR{foo
} \VAR{form
})
}
448 Define symbol macro
\retval{\VAR{foo
}} which on evaluation evaluates
452 \IT{(
\SO*
{MACROLET
} (
\OPn{(
\VAR{foo
} (
\OPn{\VAR{macro-$
\lambda$
}})
453 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{local-decl
}}})
}
454 \Op{\NEV{\VAR{doc
}}} \PROGN{\VAR{macro-form
}})
})
\OPn{(
\kwd{declare
}
455 \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{form
}})
}
457 Evaluate
\retval{\VAR{form
}s
} with locally defined mutually
458 invisible macros
\VAR{foo
} which are enclosed in implicit
\SO{block
}s
462 \IT{(
\SO*
{SYMBOL-MACROLET
} (
\OPn{(
\VAR{foo
}
463 \VAR{expansion-form
})
})
\OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
466 Evaluate
\retval{\VAR{form
}s
} with locally defined symbol macros
470 \IT{(
\MC*
{DEFSETF
} \NEV{\VAR{function
}} \xorGOO{%
471 \NEV{\VAR{updater
}} \text{ } \Op{\NEV{\VAR{doc
}}}\\
472 (
\OPn{\VAR{setf-$
\lambda$
}})
\text{ } (
\OPn{\VAR{s-var
}})
\text{ }
473 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}\text{ }
474 \Op{\NEV{\VAR{doc
}}} \text{ } \PROGN{\VAR{form
}}}{\
}})
476 where defsetf lambda list (
\OPn{\VAR{setf-$
\lambda$
}}) has the form
479 \OP{\kwd{\&optional
} \xorGOO{%
481 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
483 \Op{\kwd{\&rest
} \VAR{var
}}
485 \OP{\kwd{\&key
} \xorGOO{%
489 (
\kwd{:
}\VAR{key
} \VAR{var
})
}{\
}}
490 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ }\Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
492 \Op{\kwd{\&allow-other-keys
}}}
494 \OP{\kwd{\&environment
} \VAR{var
}}%
498 Specify how to
\kwd{setf
} a place accessed by
499 \retval{\VAR{function
}}.
500 \EM{Short form:
} (
\kwd{setf
} (
\VAR{function
} \OPn{\VAR{arg
}})
\VAR{value-form
}) is
501 replaced by (
\VAR{updater
} \OPn{\VAR{arg
}} \VAR{value-form
}).
502 \EM{Long form:
} on invocation of (
\kwd{setf
} (
\VAR{function
}
503 \OPn{\VAR{arg
}})
\VAR{value-form
}),
\VAR{form
}s must expand
504 into code that sets the place accessed where
\VAR{setf-$
\lambda$
}
505 and
\OPn{\VAR{s-var
}} describe the arguments of
\VAR{function
} and
506 the value(s) to be stored, respectively; and that returns
507 the value(s) of
\OPn{\VAR{s-var
}}.
\VAR{form
}s are enclosed in an
508 implicit
\SO{block
} named
\VAR{function
}.
511 \IT{(
\MC*
{DEFINE-SETF-EXPANDER
} \VAR{function
}
512 (
\OPn{\VAR{macro-$
\lambda$
}})
513 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \Op{\NEV{\VAR{doc
}}}
516 Specify how to
\kwd{setf
} a place accessed by
517 \retval{\VAR{function
}}. On invocation of (
\kwd{setf
} (
\VAR{function
}
518 \OPn{\VAR{arg
}})
\VAR{value-form
}),
\OPn{\VAR{form
}} must expand
519 into code returning
\VAR{arg-vars
},
\VAR{args
},
\VAR{newval-vars
},
520 \VAR{set-form
}, and
\VAR{get-form
} as described with
521 \FU{GET-SETF-EXPANSION
} where the elements of macro
522 lambda list
\OPn{\VAR{macro-$
\lambda$
}} are bound to corresponding
523 \VAR{arg
}s.
\VAR{form
}s are enclosed in an implicit
\SO{block
} \VAR{function
}.
526 \IT{(
\FU*
{GET-SETF-EXPANSION
} \VAR{place
} \Op{\VAR{environment
}\DF{\NIL}})
}
528 Return lists of temporary variables
\retval{\VAR{arg-vars
}} and of
529 corresponding
\retvalii{\VAR{args
}} as given with
\VAR{place
},
530 list
\retvaliii{\VAR{\VAR{newval-vars
}}} with temporary variables
531 corresponding to the new values, and
\retvaln{4}{\VAR{set-form
}}
532 and
\retvaln{5}{\VAR{get-form
}} specifying in terms of
\VAR{arg-vars
}
533 and
\VAR{newval-vars
} how to
\kwd{setf
} and how to read
537 \IT{(
\MC*
{DEFINE-MODIFY-MACRO
} \VAR{foo
}
538 (
\OP{\kwd{\&optional
} \xorGOO{%
540 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ }
541 \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
542 \Op{\kwd{\&rest
} \VAR{var
}})
543 \VAR{function
} \Op{\NEV{\VAR{doc
}}})
}
545 Define macro
\retval{\VAR{foo
}} able to modify a place. On
546 invocation of (
\VAR{foo
} \VAR{place
} \OPn{\VAR{arg
}}), the value of
547 \VAR{function
} applied to
\VAR{place
} and
\VAR{arg
}s will be stored into
548 \VAR{place
} and returned.
551 \IT{\CNS*
{LAMBDA-LIST-KEYWORDS
}}
552 {List of macro lambda list keywords. These are at least:
556 \IT{\kwd*
{\&whole
} \VAR{var
}}
557 {Bind
\VAR{var
} to the entire macro call form.
}
559 \IT{\kwd*
{\&optional
} \OPn{\VAR{var
}}}
560 {Bind
\VAR{var
}s to corresponding arguments if any.
}
564 \kwd*
{\&body
}} \VAR{var
}}
565 {Bind
\VAR{var
} to a list of remaining arguments.
}
567 \IT{\kwd*
{\&key
} \OPn{\VAR{var
}}}
568 {Bind
\VAR{var
}s to corresponding keyword arguments.
}
570 \IT{\kwd*
{\&allow-other-keys
}}
572 Suppress keyword argument checking. Callers can do so using
573 \kwd*
{:allow-other-keys
}~
\T.
576 \IT{\kwd*
{\&environment
} \VAR{var
}}
577 {Bind
\VAR{var
} to the lexical compilation environment.
}
579 \IT{\kwd*
{\&aux
} \VAR{var
}}
580 {Bind
\VAR{var
}s as in
\SO{let
\A}.
}
586 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
587 \subsection{Control Flow
}
588 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
591 \IT{(
\SO*
{IF
} \VAR{test
} \VAR{then
} \Op{\VAR{else
}\DF{\NIL}})
}
593 Return values of
\retval{\VAR{then
}} if
\VAR{test
} returns
\T;
594 return values of
\retval{\VAR{else
}} otherwise.
597 \IT{(
\MC*
{COND
} \OPn{(
\VAR{test
} \PROGN{\VAR{then
}}\DF{\VAR{test
}})
})
}
599 Return the
\retval{values
} of the first
600 \OPn{\VAR{then
}} whose
\VAR{test
} returns
\T; return
601 \retval{\NIL} if all
\VAR{test
}s return
\NIL.
604 \IT{(
\xorGOO{\MC*
{WHEN
}\\
605 \MC*
{UNLESS
}}{\
}} \VAR{test
}
608 Evaluate
\VAR{foo
}s and return
\retval{their values
} if
\VAR{test
}
609 returns
\T\ or
\NIL, respectively. Return
\retval{\NIL} otherwise.
612 \IT{(
\MC*
{CASE
} \VAR{test
} \OPn{(
\NEV{\VAR{keys
}} \PROGN{\VAR{foo
}})
}
613 \OP{(
\xorGOO{\kwd*
{OTHERWISE
}\\
614 \T}{\
}} \PROGN{\VAR{bar
}})
\DF{\NIL}})
}
616 Return the
\retval{values
} of the first
\OPn{\VAR{foo
}} one of whose
\VAR{keys
} is
617 \kwd{eql
} \VAR{test
}.
618 Return
\retval{values of
\VAR{bar
}s
} if no element of
\VAR{keys
} matches.
621 \IT{(
\Goo{\MC*
{ECASE
}\XOR\MC*
{CCASE
}} \VAR{test
}
622 \OPn{(
\NEV{\VAR{keys
}} \PROGN{\VAR{foo
}})
})
}
624 Return the
\retval{values
} of the first
\OPn{\VAR{foo
}} one of whose
\VAR{keys
} is
\kwd{eql
}
625 \VAR{test
}. Signal non-correctable/correctable
\kwd{type-error
} and
626 return
\retval{\NIL} if no element of
\VAR{keys
} matches.
629 \IT{(
\MC*
{AND
} \OPn{\VAR{form
}}\DF{\T})
}
631 Evaluate
\VAR{form
}s from left to
632 right. Immediately return
\retval{\NIL} if one
\VAR{form
}'s value is
\NIL. Return
633 \retval{values of last
\VAR{form
}} otherwise.
636 \IT{(
\MC*
{OR
} \OPn{\VAR{form
}}\DF{\NIL})
}
638 Evaluate
\VAR{form
}s from left to
639 right. Immediately return
\retval{primary value
} of first
640 non-
\NIL-evaluating form, or
\retval{all values
} if last
\VAR{form
}
641 is reached. Return
\retval{\NIL} if no
\VAR{form
} returns
\T.
644 \IT{(
\SO*
{PROGN
} \OPn{\VAR{form
}}\DF{\NIL})
}
646 Evaluate
\VAR{form
}s sequentially. Return
647 \retval{values of last
\VAR{form
}}.
651 (
\SO*
{MULTIPLE-VALUE-PROG1
} \VAR{ form-r
} \OPn{\VAR{ form
}})\\
652 (
\MC*
{PROG1
} \VAR{ form-r
} \OPn{\VAR{ form
}})\\
653 (
\MC*
{PROG2
} \VAR{ form-a
} \VAR{ form-r
} \OPn{\VAR{ form
}})
}{.
}}
655 Evaluate forms in order. Return
\retval{values/
1st value
},
656 respectively, of
\VAR{form-r
}.
659 \IT{(
\xorGOO{\SO*
{LET
}\\
662 (
\VAR{name
}\Op{\VAR{value
}\DF{\NIL}})
}{\
}^
{\!\!*
}})
663 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
666 Evaluate
\VAR{form
}s with
\VAR{name
}s lexically bound (in parallel or
667 sequentially, respectively) to
\VAR{value
}s. Return
668 \retval{values of
\VAR{form
}s
}.
671 \IT{(
\xorGOO{\MC*
{PROG
}\\
675 (
\VAR{var
} \Op{\VAR{value
}\DF{\NIL}})
}{\
}^
{\!\!*
}})
676 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
677 \xorGOO{\NEV{\VAR{tag
}}\\
\VAR{form
}}{\
}^
{\!\!*
}})
}
679 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
}s locally bound (in
680 parallel or sequentially, respectively) to
\VAR{value
}s. Return
681 \retval{\NIL} or explicitly
\retval{\MC{return
}ed values
}.
682 Implicitly, the whole form is a
\SO{block
} named
\NIL.
685 \IT{(
\SO*
{PROGV
} \VAR{symbols
} \VAR{values
} \PROGN{\VAR{form
}})
}
687 Evaluate
\VAR{form
}s with locally established dynamic bindings of
688 \VAR{symbols
} to
\VAR{values
} or
\NIL. Return
\retval{values of
692 \IT{(
\SO*
{UNWIND-PROTECT
} \VAR{protected
} \OPn{\VAR{cleanup
}})
}
694 Evaluate
\VAR{protected
} and then, no matter how control leaves
695 \VAR{protected
},
\VAR{cleanup
}s. Return
\retval{values of
699 \IT{(
\MC*
{DESTRUCTURING-BIND
} \VAR{destruct-$
\lambda$
} \VAR{bar
} \OPn{(
\kwd{declare
}
700 \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{form
}})
}
702 Evaluate
\VAR{form
}s with variables from tree
\VAR{destruct-$
\lambda$
} bound to
703 corresponding elements of tree
\VAR{bar
}, and return
\retval{their
704 values
}.
\VAR{destruct-$
\lambda$
} resembles
\VAR{macro-$
\lambda$
}
705 (section
\ref{section:Macros
}), but without any
\kwd{\&environment
}
709 \IT{(
\MC*
{MULTIPLE-VALUE-BIND
} (
\OPn{\NEV{\VAR{var
}}})
\VAR{values-form
}
710 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{body-form
}})
}
713 \VAR{body-form
}s with
\VAR{var
}s lexically bound to the return values of
714 \VAR{values-form
}. Return
\retval{values of
\VAR{body-form
}s
}.
717 \IT{(
\SO*
{BLOCK
} \VAR{name
} \PROGN{\VAR{form
}})
}
719 Evaluate
\VAR{form
}s in a lexical environment, and
720 return
\retval{their values
} unless interrupted by
724 \IT{\arrGOO{(
\SO*
{RETURN-FROM
} \VAR{foo
} \Op{\VAR{result
}\DF{\NIL}})\\
725 (
\MC*
{RETURN
} \Op{\VAR{result
}\DF{\NIL}})
}{.
}}
727 Have nearest enclosing
\SO{block
} named
\VAR{foo
}/named
\NIL,
728 respectively, return with values of
\VAR{result
}.
731 \IT{(
\SO*
{TAGBODY
} \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
733 Evaluate
\VAR{form
}s in al lexical environment.
\VAR{tag
}s (symbols or integers) have lexical
734 scope and dynamic extent, and are targets for
\SO{GO
}. Return
738 \IT{(
\SO*
{GO
} \NEV{\VAR{tag
}})
}
740 Within the innermost enclosing
\SO{tagbody
}, jump to a tag
\kwd{eql
} \VAR{tag
}.
743 \IT{(
\SO*
{CATCH
} \VAR{tag
} \PROGN{\VAR{form
}})
}
745 Evaluate
\VAR{form
}s and return
\retval{their values
} unless
746 interrupted by
\SO{THROW
}.
749 \IT{(
\SO*
{THROW
} \VAR{tag
} \VAR{form
})
}
750 {Have the nearest dynamically
751 enclosing
\SO{CATCH
} with a tag
\FU{eq
} \VAR{tag
} return with the
752 values of
\VAR{form
}.
755 \IT{(
\FU*
{SLEEP
} \VAR{n
})
}
756 {Wait
\VAR{n
} seconds, return
\retval{\NIL}.
762 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
763 \subsection{Iteration
}
764 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
768 \IT{(
\xorGOO{\MC*
{DO
}\\
772 (
\VAR{var
} \OP{ \VAR{start
} \Op{\VAR{step
}}})
}{\
}^
{\!\!*
}})
773 (
\VAR{stop
} \PROGN{\VAR{result
}})
774 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
775 \xorGOO{\NEV{\VAR{tag
}}\\
\VAR{form
}}{\
}^
{\!\!*
}})
}
777 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
}s successively bound according
778 to the values of the corresponding
\VAR{start
} and
\VAR{step
}
779 forms.
\VAR{var
}s are bound in parallel/sequentially, respectively.
780 Stop iteration when
\VAR{stop
} is
\T. Return
\retval{values of
781 \OPn{\VAR{result
}}}. Implicitly, the whole form is a
\SO{block
}
785 \IT{(
\MC*
{DOTIMES
} (
\VAR{var
} \VAR{i
} \Op{\VAR{result
}\DF{\NIL}})
786 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
787 \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
789 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
} successively bound
790 to integers from
0 to $i -
1$. Upon evaluation of
791 \retval{\VAR{result
}},
\VAR{var
} is
\VAR{i
}. Implicitly, the whole
792 form is a
\SO{block
} named
\NIL.
795 \IT{(
\MC*
{DOLIST
}(
\VAR{var
} \VAR{list
} \Op{\VAR{result
}\DF{\NIL}})
796 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
797 \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
799 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
} successively bound
800 to the elements of
\VAR{list
}. Upon evaluation of
801 \retval{\VAR{result
}},
\VAR{var
} is
\NIL. Implicitly, the whole form
802 is a
\SO{block
} named
\NIL.
808 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
809 \subsection{Loop Facility
}
810 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
815 \IT{(
\MC*
{LOOP
} \OPn{\VAR{form
}})
}
817 Simple Loop. If
\VAR{form
}s do not contain any atomic Loop Facility
818 keywords, evaluate them forever in an implicit
\SO{block
} named
\NIL.
821 \IT{(
\MC*
{LOOP
} \OPn{\VAR{form
}})
}
823 Loop Facility. For Loop Facility keywords
824 see below and Figure
\ref{loop-overview
}.
829 \IT{\LKWD*
{named
} \VAR{n
}\DF{\NIL}}
831 Give
\MC{loop
}'s implicit
\SO{block
} a name.
834 \IT{\Goop{\LKWD*
{with
}
837 (
\OPn{\VAR{var-s
}})
}{\
}}
838 \Op{\VAR{d-type
}} \LKWD*
{=
} \VAR{foo
}} \Goos{\LKWD*
{and
}
841 (
\OPn{\VAR{var-p
}})
}{\
}}
842 \Op{\VAR{d-type
}} \LKWD*
{=
} \VAR{bar
}}
844 where destructuring type specifier
\VAR{d-type
} has the form
846 \GOO{\kwd{fixnum
}\XOR
853 (
\OPn{\VAR{type
}})
}{\
}}}}
856 Initialize (possibly trees of) local variables
\VAR{var-s
}
857 sequentially and
\VAR{var-p
} in parallel.
860 \IT{\Goo{\LKWD*
{initially
}\XOR\LKWD*
{finally
}} \RP{\VAR{form
}}}
862 Evaluate
\VAR{form
}s before begin, or after end, respectively, of iterations.
871 \text{\kwd{loop
}}\text{ }
873 \text{\LKWD{named
} \VAR{n
}\DF{\NIL}}
880 (
\OPn{\VAR{var
}})
}{\
}}
881 \Op{\VAR{d-type
}} \LKWD{=
} \VAR{foo
}}
885 (
\OPn{\VAR{var
}})
}{\
}}
886 \Op{\VAR{d-type
}} \LKWD{=
}
887 \VAR{bar
}}\
}^
{*
} \\ \\
[-
2.4ex
]
896 (
\OPn{\VAR{var
}})
}{\
}}}%
905 \text{\LKWD{upfrom
}}\\
909 \text{\VAR{start
}\DF{\LIT{0}}}
921 \text{\LKWD{from
} \VAR{start
}}
924 \text{\LKWD{downto
}}\\
929 \text{\LKWD{downfrom
} \VAR{start
}}\text{ }
933 \text{\LKWD{downto
}}\\
943 \text{\LKWD{by
} \VAR{step
}\DF{\LIT{1}}}
951 \text{\VAR{list
}}\text{ }
953 \text{\LKWD{by
} \VAR{function
}\DF{\kwd{\#'cdr
}}}
955 \text{\LKWD{=
} \VAR{foo
}}
957 \text{\LKWD{then
} \VAR{bar
}\DF{\VAR{foo
}}}
959 \text{\LKWD{across
} \VAR{vector
}}\\
973 \text{\LKWD{hash-key
}}\\
974 \text{\LKWD{hash-keys
}}
985 \text{\LKWD{using
} (
\LKWD{hash-value
} \VAR{v
})
}%
989 \text{\LKWD{hash-value
}}\\
990 \text{\LKWD{hash-values
}}
1001 \text{\LKWD{using
} (
\LKWD{hash-key
} \VAR{k
})
}%
1007 \text{\LKWD{symbol
\Op{s
}}}\\
1008 \text{\LKWD{present-symbol
\Op{s
}}}\\
1009 \text{\LKWD{external-symbol
\Op{s
}}}
1018 \right\
} \text{\VAR{package
}\DF{\V{\A package
\A}}}%
1023 \right\
}_
{\displaystyle{\mathbb{F
}_0
}}
1026 \text{\LKWD{and
} }\boxed{\mathbb{F
}_i\!
}
1031 \text{\LKWD{initially
}} \\
1032 \text{\LKWD{finally
}}
1035 \text{\VAR{form
}}^
{+
} \\
1038 \right\
}^
{\!\!
\displaystyle{*
}}
1042 \text{\LKWD{repeat
} \VAR{num
}}\\
1045 \text{\LKWD{while
}}\\
1046 \text{\LKWD{until
}}\\
1047 \text{\LKWD{always
}}\\
1048 \text{\LKWD{never
}}\\
1049 \text{\LKWD{thereis
}}
1062 \text{\VAR{form
}}^
{+
}\\
1063 \text{\LKWD{return
}}
1072 \text{\LKWD{collect
\Op{ing
}}}\\
1073 \text{\LKWD{append
\Op{ing
}}}\\
1074 \text{\LKWD{nconc
\Op{ing
}}}
1082 \right\
} \Op{\text{\LKWD{into
}\VAR{list
}}}\\
1085 \text{\LKWD{count
\Op{ing
}}}\\
1086 \text{\LKWD{sum
\Op{ming
}}}\\
1087 \text{\LKWD{maximize
}}\\
1088 \text{\LKWD{maximizing
}}\\
1089 \text{\LKWD{minimize
}}\\
1090 \text{\LKWD{minimizing
}}
1099 \Op{\text{\LKWD{into
}\VAR{num
}}}\text{ }
1100 \Op{\text{\VAR{type
}}}\\
1104 \text{\LKWD{when
}}\\
1105 \text{\LKWD{unless
}}
1109 \boxed{\mathbb{C
}_i\!
}\
{\text{\LKWD{and
}}\,
1110 \boxed{\mathbb{C
}_j\!
}\
}^
{*
}\Op{\text{\LKWD{else
}}\,
1111 \boxed{\mathbb{C
}_k\!
}\
{\text{\LKWD{and
}}\,
1112 \boxed{\mathbb{C
}_l\!
}\
}^
{*
}}
1113 \Op{\text{\LKWD{end
}}}\!\!\!\!\!\!
1115 \right._
{\!\!\!\!
\displaystyle{\mathbb{C
}_0
}}
1121 \text{\LKWD{initially
}} \\
1122 \text{\LKWD{finally
}}
1125 \text{\VAR{form
}}^
{+
}
1127 \right\
}^
{\displaystyle{\!\!*
}}
1133 \raisebox{0em
}[0em
][0em
]{\parbox[b
]{4cm
}{\caption{\protect\raggedright Loop Facility, Overview.
\label{loop-overview
}}}}
1136 \IT{\GOop{\Goo{\LKWD*
{for
}\XOR\LKWD*
{as
}}
1139 (
\OPn{\VAR{var-s
}})
}{\
}}
1144 (
\OPn{\VAR{var-p
}})
}{\
}}
1147 Begin of iteration control clauses. Initialize and step (possibly
1148 trees of) local variables
\VAR{var-s
} sequentially and
\VAR{var-p
}
1149 in parallel. Destructuring type specifier
\VAR{d-type
} as with
\LKWD{with
}.
1154 \IT{\Goo{\LKWD*
{upfrom
}\XOR\LKWD*
{from
}\XOR\LKWD*
{downfrom
}}
1157 Start stepping with
\VAR{start
}
1160 \IT{\Goo{\LKWD*
{upto
}\XOR\LKWD*
{downto
}\XOR\LKWD*
{to
}\XOR\LKWD*
{below
}\XOR\LKWD*
{above
}}
1163 Specify
\VAR{form
} as the end value for stepping.
1166 \IT{\Goo{\LKWD*
{in
}\XOR\LKWD*
{on
}} \VAR{list
}}
1168 Bind
\VAR{var
} to successive elements/tails, respectively, of
\VAR{list
}.
1171 \IT{\LKWD*
{by
} \Goo{\VAR{step
}\DF{\LIT{1}}\XOR\VAR{function
}\DF{\kwd{\#'cdr
}}}}
1173 Specify the (positive) decrement or increment or the
1174 \VAR{function
} of one argument returning the next part of the list.
1177 \IT{\LKWD*
{=
} \VAR{foo
} \Op{\LKWD*
{then
}
1178 \VAR{bar
}\DF{\VAR{foo
}}}}
1180 Bind
\VAR{var
} in the first iteration to
\VAR{foo
} and later to
\VAR{bar
}.
1183 \IT{\LKWD*
{across
} \VAR{vector
}}
1185 Bind
\VAR{var
} to successive elements of
\VAR{vector
}.
1188 \IT{\LKWD*
{being
} \Goo{\LKWD*
{the
}\XOR\LKWD*
{each
}}}
1190 Iterate over a hash table or a package.
1195 \IT{\Goo{\LKWD*
{hash-key
}\XOR\LKWD*
{hash-keys
}} \Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}} \VAR{hash-table
}
1196 \Op{\LKWD*
{using
} (
\LKWD*
{hash-value
} \VAR{value
})
}}
1198 Bind
\VAR{var
} successively to the keys of
\VAR{hash-table
}; bind
\VAR{value
} to corresponding values.
1201 \IT{\Goo{\LKWD*
{hash-value
}\XOR\LKWD*
{hash-values
}} \Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}} \VAR{hash-table
}
1202 \Op{\LKWD*
{using
} (
\LKWD*
{hash-key
} \VAR{key
})
}}
1204 Bind
\VAR{var
} successively to the values of
\VAR{hash-table
}; bind
\VAR{key
} to corresponding keys.
1207 \IT{\Goo{\LKWD*
{symbol
}\XOR\LKWD*
{symbols
}\XOR\LKWD*
{present-symbol
}\XOR\LKWD*
{present-symbols
}\XOR\LKWD*
{external-symbol
}\XOR\LKWD*
{external-symbols
}}
1208 \Op{\Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}}
1209 \VAR{package
}\DF{\V{\A package
\A}}}}
1211 Bind
\VAR{var
} successively to the accessible symbols, or the present
1212 symbols, or the external symbols respectively, of
1219 \IT{\Goo{\LKWD*
{do
}\XOR\LKWD*
{doing
}} \RP{\VAR{form
}}}
1221 Evaluate
\VAR{form
}s in every iteration.
1226 Value of
\VAR{test
} form of an enclosing
\LKWD{if
},
1227 \LKWD{when
}, or
\LKWD{unless
} clause.
1230 \IT{\LKWD*
{return
} \Goo{\VAR{form
}\XOR\LKWD*
{it
}}}
1232 Return immediately, skipping any
\LKWD{finally
} parts, with values of
\VAR{form
} or
\LKWD{it
}.
1235 \IT{\Goo{\LKWD*
{collect
}\XOR\LKWD*
{collecting
}}
1236 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
} \VAR{list
}}}
1238 Collect values of
\VAR{form
} or
\LKWD{it
} into
\VAR{list
}. If no
1239 \VAR{list
} is given, collect into an anonymous list which is
1240 returned after termination.
1243 \IT{\Goo{\LKWD*
{append
}\XOR\LKWD*
{appending
}\XOR\LKWD*
{nconc
}\XOR\LKWD*
{nconcing
}}
1244 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1247 Concatenate values of
\VAR{form
} or
\LKWD{it
}, which should be
1248 lists, into
\VAR{list
} by the means of
\FU{append
} or
\FU{nconc
},
1249 respectively. If no
\VAR{list
} is given, collect into an
1250 anonymous list which is returned after termination.
1253 \IT{\Goo{\LKWD*
{count
}\XOR\LKWD*
{counting
}}
1254 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1255 \VAR{n
}} \Op{\VAR{type
}}}
1257 Count the number of times the value of
\VAR{form
} or of
\LKWD{it
} is
\T.
1258 If no
\VAR{n
} is given, count into an anonymous variable
1259 which is returned after termination.
1262 \IT{\Goo{\LKWD*
{sum
}\XOR\LKWD*
{summing
}}
1263 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1264 \VAR{sum
}} \Op{\VAR{type
}}}
1266 Calculate the sum of the primary values of
\VAR{form
} or of
\LKWD{it
}.
1267 If no
\VAR{sum
} is given, sum into an anonymous variable
1268 which is returned after termination.
1271 \IT{\Goo{\LKWD*
{maximize
}\XOR\LKWD*
{maximizing
}\XOR
1272 \LKWD*
{minimize
}\XOR
1273 \LKWD*
{minimizing
}} \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1274 \VAR{max-min
}} \Op{\VAR{type
}}}
1276 Determine the maximum or minimum, respectively, of the primary values of
1277 \VAR{form
} or of
\LKWD{it
}.
1278 If no
\VAR{max-min
} is given, use an anonymous variable
1279 which is returned after termination.
1282 \IT{\Goo{\LKWD*
{if
}\XOR\LKWD*
{when
}\XOR\LKWD*
{unless
}} \VAR{ test
}
1283 \VAR{i-form
} \Goos{\LKWD*
{and
}
1284 \VAR{j-form
}} \Op{\LKWD*
{else
} \VAR{k-form
} \Goos{\LKWD*
{and
}
1285 \VAR{l-form
}}} \Op{\LKWD*
{end
}}}
1287 If
\VAR{test
} returns
\T,
\T, or
\NIL, respectively, evaluate
1288 \VAR{i-form
} and
\VAR{j-form
}s; otherwise, evaluate
\VAR{k-form
}
1289 and
\VAR{l-form
}s. Inside
\VAR{i-form
} and
\VAR{k-form
}, the value
1290 of
\VAR{test
} is accessible by
\LKWD*
{it
}.
1293 \IT{\LKWD*
{repeat
} \VAR{num
}}
1295 Terminate
\MC{loop
} after
\VAR{num
} iterations;
\VAR{num
} is evaluated once.
1298 \IT{\Goo{\LKWD*
{while
}\XOR\LKWD*
{until
}} \VAR{test
}}
1300 Continue iteration until
\VAR{test
} returns
\NIL\ or
\T, respectively.
1303 \IT{\Goo{\LKWD*
{always
}\XOR\LKWD*
{never
}} \VAR{test
}}
1305 Terminate
\MC{loop
} returning
\NIL\ and skipping any
1306 \LKWD{finally
} parts as soon as
\VAR{test
} is
\NIL\ or
\T,
1307 respectively. Otherwise continue
\MC{loop
} with its default return
1311 \IT{\LKWD*
{thereis
} \VAR{test
}}
1313 Terminate
\MC{loop
} when
\VAR{test
} is
\T\ and return value of
1314 \VAR{test
}, skipping any
\LKWD{finally
} parts. Otherwise continue
1315 \MC{loop
} with its default return value set to
\NIL.
1318 \IT{\LKWD*
{loop-finish
}}
1320 Terminate
\MC{loop
} immediately executing any
\LKWD{finally
}
1321 clauses and returning any accumulated results.
1331 %%% Local Variables:
1333 %%% TeX-master: "clqr"