The cl-generator Reference Manual

This is the cl-generator Reference Manual, version 1.3.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:14:35 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-generator

cl-generator, a generator implementation for common lisp

Author

Muromi Ukari

Home Page

https://github.com/ukari/cl-generator

License

MIT

Version

1.3.1

Dependency

cl-cont (system).

Source

cl-generator.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-generator/base

Source

cl-generator.asd.

Parent Component

cl-generator (system).

Child Components

3.2 cl-generator/util

Dependency

base (module).

Source

cl-generator.asd.

Parent Component

cl-generator (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-generator/cl-generator.asd

Source

cl-generator.asd.

Parent Component

cl-generator (system).

ASDF Systems

cl-generator.


4.1.2 cl-generator/base/package.lisp

Source

cl-generator.asd.

Parent Component

base (module).

Packages

cl-generator.


4.1.3 cl-generator/base/cl-generator.lisp

Dependency

package.lisp (file).

Source

cl-generator.asd.

Parent Component

base (module).

Public Interface
Internals

4.1.4 cl-generator/util/package.lisp

Source

cl-generator.asd.

Parent Component

util (module).

Packages

cl-generator-util.


4.1.5 cl-generator/util/util.lisp

Dependency

package.lisp (file).

Source

cl-generator.asd.

Parent Component

util (module).

Public Interface

for (macro).


5 Packages

Packages are listed by definition order.


5.1 cl-generator

Source

package.lisp.

Nickname

generator

Use List

common-lisp.

Public Interface
Internals

5.2 cl-generator-util

Source

package.lisp.

Nickname

generator-util

Use List

common-lisp.

Public Interface

for (macro).


6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Macros

Macro: defmacro* (name args &body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: defmethod* (name args &body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: defun* (name args &body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: for (expr &body body)
Package

cl-generator-util.

Source

util.lisp.

Macro: lambda* (args &body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: with-yield (&body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: yield (&optional expr)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: yield* (expr)
Package

cl-generator.

Source

cl-generator.lisp.


6.1.2 Ordinary functions

Reader: iter-cur (instance)
Writer: (setf iter-cur) (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Target Slot

cur.

Reader: iter-next (instance)
Writer: (setf iter-next) (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Target Slot

next.

Function: iter-p (object)
Package

cl-generator.

Source

cl-generator.lisp.


6.1.3 Structures

Structure: iter
Package

cl-generator.

Source

cl-generator.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: cur
Type

function

Readers

iter-cur.

Writers

(setf iter-cur).

Slot: next
Type

(or null function)

Readers

iter-next.

Writers

(setf iter-next).


6.2 Internals


6.2.1 Macros

Macro: enable-yield (&body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: gen-pass (expr cont)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: isolate-cont (&body body)
Package

cl-generator.

Source

cl-generator.lisp.

Macro: local-macros (&body body)
Package

cl-generator.

Source

cl-generator.lisp.


6.2.2 Ordinary functions

Function: copy-iter (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Function: copy-pass (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Function: make-iter (&key cur next)
Package

cl-generator.

Source

cl-generator.lisp.

Function: make-pass (&key cont results)
Package

cl-generator.

Source

cl-generator.lisp.

Reader: pass-cont (instance)
Writer: (setf pass-cont) (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Target Slot

cont.

Function: pass-p (object)
Package

cl-generator.

Source

cl-generator.lisp.

Reader: pass-results (instance)
Writer: (setf pass-results) (instance)
Package

cl-generator.

Source

cl-generator.lisp.

Target Slot

results.


6.2.3 Generic functions

Generic Function: gen-next (iter cont)
Package

cl-generator.

Methods
Method: gen-next ((iter iter) (end null))
Source

cl-generator.lisp.

Method: gen-next ((iter iter) (pass pass))
Source

cl-generator.lisp.

Method: gen-next ((iter iter) (cont function))
Source

cl-generator.lisp.

Generic Function: iter-id (end)
Package

cl-generator.

Methods
Method: iter-id ((cont function))
Source

cl-generator.lisp.

Method: iter-id ((end null))
Source

cl-generator.lisp.

Generic Function: iter-next-proxy (iter next cont)
Package

cl-generator.

Methods
Method: iter-next-proxy ((iter iter) (next function) (cont function))
Source

cl-generator.lisp.

Generic Function: pass-next (pass)
Package

cl-generator.

Methods
Method: pass-next ((pass pass))
Source

cl-generator.lisp.

Method: pass-next ((pass null))
Source

cl-generator.lisp.

Generic Function: proxy (inner cont)
Package

cl-generator.

Methods
Method: proxy ((inner iter) (cont function))
Source

cl-generator.lisp.


6.2.4 Structures

Structure: pass
Package

cl-generator.

Source

cl-generator.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: cont
Type

(or null function)

Readers

pass-cont.

Writers

(setf pass-cont).

Slot: results
Type

list

Readers

pass-results.

Writers

(setf pass-results).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   E   F   G   I   L   M   P   W   Y  
Index Entry  Section

(
(setf iter-cur): Public ordinary functions
(setf iter-next): Public ordinary functions
(setf pass-cont): Private ordinary functions
(setf pass-results): Private ordinary functions

C
copy-iter: Private ordinary functions
copy-pass: Private ordinary functions

D
defmacro*: Public macros
defmethod*: Public macros
defun*: Public macros

E
enable-yield: Private macros

F
for: Public macros
Function, (setf iter-cur): Public ordinary functions
Function, (setf iter-next): Public ordinary functions
Function, (setf pass-cont): Private ordinary functions
Function, (setf pass-results): Private ordinary functions
Function, copy-iter: Private ordinary functions
Function, copy-pass: Private ordinary functions
Function, iter-cur: Public ordinary functions
Function, iter-next: Public ordinary functions
Function, iter-p: Public ordinary functions
Function, make-iter: Private ordinary functions
Function, make-pass: Private ordinary functions
Function, pass-cont: Private ordinary functions
Function, pass-p: Private ordinary functions
Function, pass-results: Private ordinary functions

G
gen-next: Private generic functions
gen-next: Private generic functions
gen-next: Private generic functions
gen-next: Private generic functions
gen-pass: Private macros
Generic Function, gen-next: Private generic functions
Generic Function, iter-id: Private generic functions
Generic Function, iter-next-proxy: Private generic functions
Generic Function, pass-next: Private generic functions
Generic Function, proxy: Private generic functions

I
isolate-cont: Private macros
iter-cur: Public ordinary functions
iter-id: Private generic functions
iter-id: Private generic functions
iter-id: Private generic functions
iter-next: Public ordinary functions
iter-next-proxy: Private generic functions
iter-next-proxy: Private generic functions
iter-p: Public ordinary functions

L
lambda*: Public macros
local-macros: Private macros

M
Macro, defmacro*: Public macros
Macro, defmethod*: Public macros
Macro, defun*: Public macros
Macro, enable-yield: Private macros
Macro, for: Public macros
Macro, gen-pass: Private macros
Macro, isolate-cont: Private macros
Macro, lambda*: Public macros
Macro, local-macros: Private macros
Macro, with-yield: Public macros
Macro, yield: Public macros
Macro, yield*: Public macros
make-iter: Private ordinary functions
make-pass: Private ordinary functions
Method, gen-next: Private generic functions
Method, gen-next: Private generic functions
Method, gen-next: Private generic functions
Method, iter-id: Private generic functions
Method, iter-id: Private generic functions
Method, iter-next-proxy: Private generic functions
Method, pass-next: Private generic functions
Method, pass-next: Private generic functions
Method, proxy: Private generic functions

P
pass-cont: Private ordinary functions
pass-next: Private generic functions
pass-next: Private generic functions
pass-next: Private generic functions
pass-p: Private ordinary functions
pass-results: Private ordinary functions
proxy: Private generic functions
proxy: Private generic functions

W
with-yield: Public macros

Y
yield: Public macros
yield*: Public macros


A.3 Variables