This is the generators Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:16:17 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
generators
A common lisp package providing python style generators based on delimited continuations
BSD
0.1
cl-cont
(system).
alexandria
(system).
iterate
(system).
packages.lisp
(file).
generators.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
generators/generators.lisp
generators
(system).
force
(generic function).
generate-lisp-tree-nodes
(function).
generator
(reader method).
(setf generator)
(writer method).
generator
(class).
make-generator
(macro).
next
(generic function).
reset
(generic function).
stop-iteration
(condition).
%mv-gen
(function).
%stop-iteration
(function).
clause-for-a-leaf-of-lisp-tree-3
(macro).
clause-for-a-node-of-lisp-tree-2
(macro).
clause-for-in-generator-1
(macro).
continuation
(reader method).
(setf continuation)
(writer method).
final-exception
(reader method).
(setf final-exception)
(writer method).
final-value
(reader method).
(setf final-value)
(writer method).
finished?
(reader method).
(setf finished?)
(writer method).
handled?
(reader method).
(setf handled?)
(writer method).
name
(reader method).
(setf name)
(writer method).
only-one?
(function).
original-continuation
(reader method).
(setf original-continuation)
(writer method).
use-final-value?
(reader method).
(setf use-final-value?)
(writer method).
Packages are listed by definition order.
generators
common-lisp
.
iterate
.
force
(generic function).
generate-lisp-tree-nodes
(function).
generator
(generic reader).
(setf generator)
(generic writer).
generator
(class).
make-generator
(macro).
next
(generic function).
reset
(generic function).
stop-iteration
(condition).
%mv-gen
(function).
%stop-iteration
(function).
clause-for-a-leaf-of-lisp-tree-3
(macro).
clause-for-a-node-of-lisp-tree-2
(macro).
clause-for-in-generator-1
(macro).
continuation
(generic reader).
(setf continuation)
(generic writer).
final-exception
(generic reader).
(setf final-exception)
(generic writer).
final-value
(generic reader).
(setf final-value)
(generic writer).
finished?
(generic reader).
(setf finished?)
(generic writer).
handled?
(generic reader).
(setf handled?)
(generic writer).
name
(generic reader).
(setf name)
(generic writer).
only-one?
(function).
original-continuation
(generic reader).
(setf original-continuation)
(generic writer).
use-final-value?
(generic reader).
(setf use-final-value?)
(generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
returns a function that when called yields the next values. Inside of
body, you can yield any number of values that you wish by calling
(yield &rest args) which is scoped to the body
Do a depth first traversal of some set of trees yielding every node
Forces the generator to produce a list of its output
stop-iteration
)) ¶stop-iteration
)) ¶Returns the next value of this generator
Restarts the generator from its original continuation
A class that stores all the needed structure for a generator
The current continuation of the generator
:continuation
Should this generator, generate a sigil value when complete
if nil will raise the final-exception (defaults ’stop-iteration)
:use-final-value?
The value to generate if we are using a final-value instead of raising exceptions
:final-value
An exception to raise when we are done iterating (if not using final-value)
(quote generators:stop-iteration)
:final-exception
Has this generator generated all values?
:finished?
The starting point of this generator
:original-continuation
Generates a value from the generator, if the generator throws
stop iteration returns (values nil T),
turns off call/cc so that this works
stop-iteration
)) ¶stop-iteration
)) ¶Jump to: | %
(
C F G H M N O R U |
---|
Jump to: | %
(
C F G H M N O R U |
---|
Jump to: | C F G H N O S U |
---|
Jump to: | C F G H N O S U |
---|
Jump to: | C F G P S |
---|
Jump to: | C F G P S |
---|