This is the org.tfeb.star Reference Manual, version 6.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 13:04:13 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
org.tfeb.starŠtar: an iteration construct
Tim Bradshaw
MIT
6.1.0
org.tfeb.conduit-packages/define-package (system).
org.tfeb.hax.utilities (system).
org.tfeb.hax.types (system).
org.tfeb.hax.process-declarations (system).
org.tfeb.hax.let-values (system).
org.tfeb.dsm (system).
org.tfeb.hax.collecting (system).
org.tfeb.hax.iterate (system).
pkg.lisp (file).
common.lisp (file).
star.lisp (file).
iterators.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
org.tfeb.star/org.tfeb.star.asdorg.tfeb.star/pkg.lisporg.tfeb.star/common.lisporg.tfeb.star/star.lisporg.tfeb.star/iterators.lisporg.tfeb.star/common.lisppkg.lisp (file).
org.tfeb.star (system).
catastrophe (function).
catastrophe (condition).
reporting-star-notes (macro).
star-error (function).
star-error (condition).
star-note (function).
star-note (condition).
star-syntax-error (function).
star-syntax-error (condition).
star-syntax-error-form (reader method).
org.tfeb.star/star.lispcommon.lisp (file).
org.tfeb.star (system).
*builtin-iterator-optimizer-table* (special variable).
*enable-iterator-optimizers* (special variable).
*iterator-optimizers* (special variable).
*obey-iterator-optimizer-types* (special variable).
*star-bootstrap* (special variable).
anonymous-variable-p (function).
define-iterator-optimizer (macro).
find-iterator-optimizer (function).
for (macro).
for* (macro).
get-iterator-optimizer (function).
(setf get-iterator-optimizer) (function).
make-iterator-optimizer-table (function).
map-iterator-optimizer-table (function).
remove-iterator-optimizer (function).
call/compiling-iterator-optimizers (function).
clause (structure).
clause-interesting-varnames (reader).
(setf clause-interesting-varnames) (writer).
clause-p (function).
clause-unique-iterator (reader).
(setf clause-unique-iterator) (writer).
clause-vars (reader).
(setf clause-vars) (writer).
clauses->bindings (function).
compile-bindings (function).
compiling-iterator-optimizers (macro).
copy-clause (function).
copy-itable-entry (function).
copy-let-binding (function).
copy-multiple-value-binding (function).
copy-unique-iterator (function).
copy-var (function).
declarations-for-variables (function).
expand-for (function).
ie-cursor-form (reader).
(setf ie-cursor-form) (writer).
ie-types (reader).
(setf ie-types) (writer).
ie-valid-form (reader).
(setf ie-valid-form) (writer).
itable-entry (structure).
itable-entry-p (function).
iterator-optimizers (function).
let-binding (structure).
let-binding-clauses (reader).
(setf let-binding-clauses) (writer).
let-binding-p (function).
make-clause (function).
make-itable-entry (function).
make-let-binding (function).
make-multiple-value-binding (function).
make-var (function).
multiple-value-binding (structure).
multiple-value-binding-clause (reader).
(setf multiple-value-binding-clause) (writer).
multiple-value-binding-p (function).
parse-clause-description (function).
parse-clause-descriptions (function).
unique-iterator (function).
unique-iterator (structure).
unique-iterator-iterator (reader).
(setf unique-iterator-iterator) (writer).
unique-iterator-p (function).
var (structure).
var-anonymous-p (reader).
(setf var-anonymous-p) (writer).
var-declarations (reader).
(setf var-declarations) (writer).
var-ignorable-p (reader).
(setf var-ignorable-p) (writer).
var-ignore-p (reader).
(setf var-ignore-p) (writer).
var-name (reader).
(setf var-name) (writer).
var-p (function).
var-special-p (reader).
(setf var-special-p) (writer).
var-type (reader).
(setf var-type) (writer).
with-blocks (macro).
org.tfeb.star/iterators.lispstar.lisp (file).
org.tfeb.star (system).
always (function).
cyclically (macro).
cyclically-calling (function).
in-hash-table (function).
in-iterators (macro).
in-list (function).
in-naturals (function).
in-package-symbols (function).
in-parallel-iterators (macro).
in-row-major-array (function).
in-sequence (generic function).
in-vector (function).
literal (function).
on-list (function).
sequentially (macro).
sequentially* (macro).
sequentially-calling (function).
sequentially-calling* (function).
stepping (macro).
stepping* (macro).
stepping-values (macro).
expand-stepping (function).
in-delayed-iterators (function).
in-delayed-parallel-iterators (function).
optimize-stepping (function).
Packages are listed by definition order.
org.tfeb.star/pkgorg.tfeb.star/iterator-optimizer-protocolorg.tfeb.star/commonorg.tfeb.*org.tfeb.star/implorg.tfeb.star/iteratorsorg.tfeb.star/utilitiesorg.tfeb.starorg.tfeb.star/iterator-optimizer-protocolŠtar iterator optimizer protocol
org.tfeb.star/iop
*enable-iterator-optimizers* (special variable).
*iterator-optimizers* (special variable).
*obey-iterator-optimizer-types* (special variable).
define-iterator-optimizer (macro).
find-iterator-optimizer (function).
get-iterator-optimizer (function).
(setf get-iterator-optimizer) (function).
make-iterator-optimizer-table (function).
map-iterator-optimizer-table (function).
remove-iterator-optimizer (function).
org.tfeb.star/commoncommon-lisp.
org.tfeb.hax.utilities.
org.tfeb.star/utilities.
*builtin-iterator-optimizer-table* (special variable).
*star-bootstrap* (special variable).
catastrophe (function).
catastrophe (condition).
form (slot).
org.tfeb.star/implcommon-lisp.
org.tfeb.dsm.
org.tfeb.hax.collecting.
org.tfeb.hax.iterate.
org.tfeb.hax.let-values.
org.tfeb.hax.process-declarations.
org.tfeb.hax.utilities.
org.tfeb.star/common.
org.tfeb.star/iterator-optimizer-protocol.
org.tfeb.star/utilities.
call/compiling-iterator-optimizers (function).
clause (structure).
clause-interesting-varnames (reader).
(setf clause-interesting-varnames) (writer).
clause-p (function).
clause-unique-iterator (reader).
(setf clause-unique-iterator) (writer).
clause-vars (reader).
(setf clause-vars) (writer).
clauses->bindings (function).
compile-bindings (function).
compiling-iterator-optimizers (macro).
copy-clause (function).
copy-itable-entry (function).
copy-let-binding (function).
copy-multiple-value-binding (function).
copy-unique-iterator (function).
copy-var (function).
declarations-for-variables (function).
expand-for (function).
ie-cursor-form (reader).
(setf ie-cursor-form) (writer).
ie-types (reader).
(setf ie-types) (writer).
ie-valid-form (reader).
(setf ie-valid-form) (writer).
itable-entry (structure).
itable-entry-p (function).
iterator-optimizers (function).
let-binding (structure).
let-binding-clauses (reader).
(setf let-binding-clauses) (writer).
let-binding-p (function).
make-clause (function).
make-itable-entry (function).
make-let-binding (function).
make-multiple-value-binding (function).
make-var (function).
multiple-value-binding (structure).
multiple-value-binding-clause (reader).
(setf multiple-value-binding-clause) (writer).
multiple-value-binding-p (function).
parse-clause-description (function).
parse-clause-descriptions (function).
unique-iterator (function).
unique-iterator (structure).
unique-iterator-iterator (reader).
(setf unique-iterator-iterator) (writer).
unique-iterator-p (function).
var (structure).
var-anonymous-p (reader).
(setf var-anonymous-p) (writer).
var-declarations (reader).
(setf var-declarations) (writer).
var-ignorable-p (reader).
(setf var-ignorable-p) (writer).
var-ignore-p (reader).
(setf var-ignore-p) (writer).
var-name (reader).
(setf var-name) (writer).
var-p (function).
var-special-p (reader).
(setf var-special-p) (writer).
var-type (reader).
(setf var-type) (writer).
with-blocks (macro).
org.tfeb.star/iteratorsŠtar predefined iterators
common-lisp.
org.tfeb.dsm.
org.tfeb.hax.collecting.
org.tfeb.hax.iterate.
org.tfeb.hax.let-values.
org.tfeb.hax.types.
org.tfeb.hax.utilities.
org.tfeb.star/common.
org.tfeb.star/impl.
org.tfeb.star/iterator-optimizer-protocol.
org.tfeb.star/utilities.
always (function).
cyclically (macro).
cyclically-calling (function).
in-hash-table (function).
in-iterators (macro).
in-list (function).
in-naturals (function).
in-package-symbols (function).
in-parallel-iterators (macro).
in-row-major-array (function).
in-sequence (generic function).
in-vector (function).
on-list (function).
sequentially (macro).
sequentially* (macro).
sequentially-calling (function).
sequentially-calling* (function).
stepping (macro).
stepping* (macro).
stepping-values (macro).
expand-stepping (function).
in-delayed-iterators (function).
in-delayed-parallel-iterators (function).
optimize-stepping (function).
org.tfeb.star/utilitiesUtilities for Štar
anonymous-variable-p (function).
literal (function).
reporting-star-notes (macro).
star-error (function).
star-error (condition).
star-note (function).
star-note (condition).
star-syntax-error (function).
star-syntax-error (condition).
star-syntax-error-form (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If true, iterator optimizers will be called at macroexpansion time
The stack of iterator optimizer tables
If true, type information from iterator optimizers will be interpolated
Iterator which cyclically evaluates forms
Optimizable.
Define an iterator optimizer for Štar
See the manual
Iteration construct
See the manual.
Nested iteration construct
See the manual.
Iterato which evaluates its iterator arguments in sequence
Optimizable.
Iterator which returns multiple values from its component iterators
Optimizable.
Report any Štar notes to TO
Iterator which sequentually evaluates forms
Optimizable.
Iterator which sequentially evaluates forms, sticking on the last one
Optimizable.
Iterator which can step multiple variables in parallel
See the manual. Optimizable.
Iterator which can step multiple variables in series
See the manual. Optimizable.
Iterator which steps multiple values
See the manual. Optimizable.
Iterator which returns its arguments always
Optimizable.
Iterator which cycles round functions
Optimizable.
Find an iterator optimizer in the stack
Returns the optimizer, and the tail of the stack where it was found, or NIL and NIL.
Return an optimizer with name NAME in TABLE.
Second value is NIL if it is not present.
This is an accessor.
Iterate the keys and values of a hash-table
Optimizable.
Iterate over a list
BY is the step, which defaults to #’CDR.
Optimizable.
Iterate over natural numbers, starting from 0
There are four cases:
- (in-naturals) will iterate up from 0 indefinitely;
- (in-naturals bound &optional fixnum) will iterate below bound,
warranting that all the values are fixnums if FIXNUM is true
- the third case has keyword arguments INITIALLY for the initial value,
BOUND for the bound, INCLUSIVE says whether the bound is inclusive
or exclusive, and FIXNUM warrants that all the values are fixnums.
INITIALLY & BOUND need not be integers: INITIALLY is rounded, and FLOOR
is used for BOUND. Both should be a fixnums if FIXNUM is given).
Optimizable.
Iterate the symbols of a package or packages
This iterates two values: symbol and package
WHEN allows you to select symbols, it should be either one of the symbols :INTERNAL, :EXTERNAL or :INHERITED or a list of zero or more of these symbols. The default is a list of all three. If the implementation supports other statuses for symbols, they can appear here.
Iterate over elements and rot-major indices of an array in row-major orderq
BY is the step, defaulting to 1. SIMPLE says the array is simple,
ELEMENT-TYPE gives the element type. RANK is the rank (default *).
SIMPLE-ARRAY is a compatibility alias for SIMPLE.
Optimizable
Iterate over the elements and indices of a vector
SIMPLE-VECTOR says the vector is a SIMPLE-VECTOR. ELEMENT-TYPE is the
element type, defaulting to T if SIMPLE-VECTOR is true, * otherwise.
SIMPLE-ARRAY says is it a simple *array*, which is a different thing
than a SIMPLE-VECTOR: a SIMPLE-VECTOR is a one-dumensional
SIMPLE-ARRAY with ELEMENT-TYPE T.
SIMPLE is a compatibility alias for SIMPLE-VECTOR.
Optimizable.
Return the literal value of a form in ENVIRONMENT and T or the form and NIL
If FORM is a literal, or if it macroexpands to a literal in
ENVIRONMENT, return its value and T, otherwise return the form itself
and NIL. So (literal ’(quote fixnum)) -> FIXNUM and T, but (literal
’fixnum) -> FIXNUM and NIL.
If the third argument is true, then if FORM is a symbol for which
CONSTANTP returns true in ENVIRONMENT and which is bound, then its
value and T is returned. This is not generally safe.
See the documentation for how this differs from CONSTANTP, and why
CONSTANTP does not do what you want.
This should be safe but could think some things are not literals which are (which is safe). This is useful for optimizers
Make an iterator optimizer table
These are probably just hash-tables, but this means you don’t have to assume they are, and they can be suitably weak where implementations support that
Map FUNCTION over TABLE.
FUNCTION takes two arguments, the optimizer name and the optimizer. It is allowed to call REMOVE-ITERATOR-OPTIMIZER on the optimizer, but not on any other one.
Iterate over tails of a list
BY gets the next tail, defailt #’CDR.
Optimizable.
Remove an optimizer named NAME from TABLE
It is not an error if it is not present.
Iterator which sequenstially calls functions
Optimizable.
Iterator which sequentially calls functions, sticking on the last one
Optimizable.
Iterator for sequences
Not optimizable. You can define methods on this for non-CL-defined sequence types.
star-syntax-error)) ¶form.
simple-error.
Condition type for Štar’s errors
simple-error.
Condition type for Štar compilation notes
simple-condition.
program-error.
star-error.
(quote nil)
:form
This slot is read-only.
vars.
structure-object.
(org.tfeb.star/common:catastrophe "no vars")
(quote nil)
(org.tfeb.star/common:catastrophe "no iterator")
structure-object.
(quote nil)
structure-object.
(org.tfeb.star/common:catastrophe "need a clause")
structure-object.
structure-object.
(org.tfeb.star/common:catastrophe "no name for unique iterator")
common-lisp.
t
(quote nil)
| Jump to: | (
A C D E F G I L M O P R S U V W |
|---|
| Jump to: | (
A C D E F G I L M O P R S U V W |
|---|
| Jump to: | *
A C D F I N S T U V |
|---|
| Jump to: | *
A C D F I N S T U V |
|---|
| Jump to: | C F I L M O P S U V |
|---|
| Jump to: | C F I L M O P S U V |
|---|