The cl-plumbing Reference Manual

This is the cl-plumbing Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:54:54 2022 GMT+0.

1 Introduction


* CL-Plumbing

This library adds a few stream manipulation facilities that I haven't been able
to figure out using CL's stream facilities.  These include:

=make-pipe=: Make a two way stream (though not of type two-way-stream) that
accepts data (via writing to it) and that data can then be read from it.  This
is similar to the piping mechanism in the shell.

=connect-streams=: Take an input stream and an output stream and feed all data
from the input stream to the output stream.  Again, similar to the way shell
pipes act, but this is for two existing streams and the other creates two new
streams (well, one new two way stream).

** Future work

Just now it occurred to me that it would be cool to have this provide a CL
(gray) stream interface for ZeroMQ.  Most of the work is already done, I
believe...

2 Systems

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

cl-plumbing

2.1 `cl-plumbing`

A few (at least seemingly) missing stream operations in Common Lisp.

Author

Zachary Smith <zachkostsmith@gmail.com>

License

LLGPL

Dependencies

iterate (system).
trivial-gray-streams (system).
bordeaux-threads (system).

Source

cl-plumbing.asd.

Child Components

package.lisp (file).
gray-streams-pipe.lisp (file).
cl-plumbing.lisp (file).

3 Files

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

Lisp

3.1.1 `cl-plumbing/cl-plumbing.asd`

Source: cl-plumbing.asd.
Parent Component: cl-plumbing (system).
ASDF Systems: cl-plumbing.

3.1.2 `cl-plumbing/package.lisp`

Source: cl-plumbing.asd.
Parent Component: cl-plumbing (system).
Packages: cl-plumbing.

3.1.3 `cl-plumbing/gray-streams-pipe.lisp`

Dependency

package.lisp (file).

Source

cl-plumbing.asd.

Parent Component

cl-plumbing (system).

Public Interface

close (method).
make-pipe (function).
stream-line-column (method).
stream-read-char (method).
stream-read-char-no-hang (method).
stream-read-line (method).
stream-read-sequence (method).
stream-unread-char (method).
stream-write-char (method).
stream-write-sequence (method).

Internals

*block-size* (special variable).
flush-in-to-out (function).
input-of (reader method).
(setf input-of) (writer method).
lock-of (reader method).
(setf lock-of) (writer method).
output-of (reader method).
(setf output-of) (writer method).
pipe (class).

3.1.4 `cl-plumbing/cl-plumbing.lisp`

Dependency

gray-streams-pipe.lisp (file).

Source

cl-plumbing.asd.

Parent Component

cl-plumbing (system).

Public Interface

*warn-on-foreground-connect-stream* (special variable).
connect-streams (function).

Internals

dump-stream (function).

4 Packages

Packages are listed by definition order.

cl-plumbing

4.1 `cl-plumbing`

Source

package.lisp.

Use List

common-lisp.
iterate.

Public Interface

*warn-on-foreground-connect-stream* (special variable).
connect-streams (function).
make-pipe (function).

Internals

*block-size* (special variable).
dump-stream (function).
flush-in-to-out (function).
input-of (generic reader).
(setf input-of) (generic writer).
lock-of (generic reader).
(setf lock-of) (generic writer).
output-of (generic reader).
(setf output-of) (generic writer).
pipe (class).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Special variables
Ordinary functions
Standalone methods

5.1.1 Special variables

Special Variable: *warn-on-foreground-connect-stream* ¶

Package: cl-plumbing.
Source: cl-plumbing.lisp.

5.1.2 Ordinary functions

Function: connect-streams (input output &key background fn) ¶

This reads from input and writes output until the end of input is found.

Package: cl-plumbing.
Source: cl-plumbing.lisp.

Function: make-pipe () ¶

This makes a stream where you can write your output, then read it out elsewhere.

Package: cl-plumbing.
Source: gray-streams-pipe.lisp.

5.1.3 Standalone methods

Method: close ((p pipe) &key abort) ¶

Source: gray-streams-pipe.lisp.

Method: stream-line-column ((p pipe)) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-read-char ((p pipe)) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-read-char-no-hang ((p pipe)) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-read-line ((p pipe)) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-read-sequence ((p pipe) seq start end &key &allow-other-keys) ¶

Package: trivial-gray-streams.
Source: gray-streams-pipe.lisp.

Method: stream-unread-char ((p pipe) character) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-write-char ((p pipe) character) ¶

Package: sb-gray.
Source: gray-streams-pipe.lisp.

Method: stream-write-sequence ((p pipe) seq start end &key &allow-other-keys) ¶

Package: trivial-gray-streams.
Source: gray-streams-pipe.lisp.

5.2 Internals

Special variables
Ordinary functions
Generic functions
Classes

5.2.1 Special variables

Special Variable: *block-size* ¶

Package: cl-plumbing.
Source: gray-streams-pipe.lisp.

5.2.2 Ordinary functions

Function: dump-stream (input output &optional fn) ¶

Package: cl-plumbing.
Source: cl-plumbing.lisp.

Function: flush-in-to-out (pipe) ¶

Package: cl-plumbing.
Source: gray-streams-pipe.lisp.

5.2.3 Generic functions

Generic Reader: input-of (object) ¶

Package

cl-plumbing.

Methods

Reader Method: input-of ((pipe pipe)) ¶

automatically generated reader method

Source: gray-streams-pipe.lisp.
Target Slot: input.

Generic Writer: (setf input-of) (object) ¶

Package

cl-plumbing.

Methods

Writer Method: (setf input-of) ((pipe pipe)) ¶

automatically generated writer method

Source: gray-streams-pipe.lisp.
Target Slot: input.

Generic Reader: lock-of (object) ¶

Package

cl-plumbing.

Methods

Reader Method: lock-of ((pipe pipe)) ¶

automatically generated reader method

Source: gray-streams-pipe.lisp.
Target Slot: lock.

Generic Writer: (setf lock-of) (object) ¶

Package

cl-plumbing.

Methods

Writer Method: (setf lock-of) ((pipe pipe)) ¶

automatically generated writer method

Source: gray-streams-pipe.lisp.
Target Slot: lock.

Generic Reader: output-of (object) ¶

Package

cl-plumbing.

Methods

Reader Method: output-of ((pipe pipe)) ¶

automatically generated reader method

Source: gray-streams-pipe.lisp.
Target Slot: output.

Generic Writer: (setf output-of) (object) ¶

Package

cl-plumbing.

Methods

Writer Method: (setf output-of) ((pipe pipe)) ¶

automatically generated writer method

Source: gray-streams-pipe.lisp.
Target Slot: output.

5.2.4 Classes

Class: pipe ¶

Package

cl-plumbing.

Source

gray-streams-pipe.lisp.

Direct superclasses

fundamental-input-stream.
fundamental-output-stream.
trivial-gray-stream-mixin.

Direct methods

close.
(setf input-of).
input-of.
(setf lock-of).
lock-of.
(setf output-of).
output-of.
stream-line-column.
stream-read-char.
stream-read-char-no-hang.
stream-read-line.
stream-read-sequence.
stream-unread-char.
stream-write-char.
stream-write-sequence.

Direct slots

Slot: lock ¶

Initform: (bordeaux-threads:make-lock)
Readers: lock-of.
Writers: (setf lock-of).

Slot: input ¶

Initargs: :input
Readers: input-of.
Writers: (setf input-of).

Slot: output ¶

Initargs: :output
Readers: output-of.
Writers: (setf output-of).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( C D F G I L M O S

	Index Entry	Section

(
	`(setf input-of)`:	Private generic functions
	`(setf input-of)`:	Private generic functions
	`(setf lock-of)`:	Private generic functions
	`(setf lock-of)`:	Private generic functions
	`(setf output-of)`:	Private generic functions
	`(setf output-of)`:	Private generic functions

C
	`close`:	Public standalone methods
	`connect-streams`:	Public ordinary functions

D
	`dump-stream`:	Private ordinary functions

F
	`flush-in-to-out`:	Private ordinary functions
	`Function, connect-streams`:	Public ordinary functions
	`Function, dump-stream`:	Private ordinary functions
	`Function, flush-in-to-out`:	Private ordinary functions
	`Function, make-pipe`:	Public ordinary functions

G
	`Generic Function, (setf input-of)`:	Private generic functions
	`Generic Function, (setf lock-of)`:	Private generic functions
	`Generic Function, (setf output-of)`:	Private generic functions
	`Generic Function, input-of`:	Private generic functions
	`Generic Function, lock-of`:	Private generic functions
	`Generic Function, output-of`:	Private generic functions

I
	`input-of`:	Private generic functions
	`input-of`:	Private generic functions

L
	`lock-of`:	Private generic functions
	`lock-of`:	Private generic functions

M
	`make-pipe`:	Public ordinary functions
	`Method, (setf input-of)`:	Private generic functions
	`Method, (setf lock-of)`:	Private generic functions
	`Method, (setf output-of)`:	Private generic functions
	`Method, close`:	Public standalone methods
	`Method, input-of`:	Private generic functions
	`Method, lock-of`:	Private generic functions
	`Method, output-of`:	Private generic functions
	`Method, stream-line-column`:	Public standalone methods
	`Method, stream-read-char`:	Public standalone methods
	`Method, stream-read-char-no-hang`:	Public standalone methods
	`Method, stream-read-line`:	Public standalone methods
	`Method, stream-read-sequence`:	Public standalone methods
	`Method, stream-unread-char`:	Public standalone methods
	`Method, stream-write-char`:	Public standalone methods
	`Method, stream-write-sequence`:	Public standalone methods

O
	`output-of`:	Private generic functions
	`output-of`:	Private generic functions

S
	`stream-line-column`:	Public standalone methods
	`stream-read-char`:	Public standalone methods
	`stream-read-char-no-hang`:	Public standalone methods
	`stream-read-line`:	Public standalone methods
	`stream-read-sequence`:	Public standalone methods
	`stream-unread-char`:	Public standalone methods
	`stream-write-char`:	Public standalone methods
	`stream-write-sequence`:	Public standalone methods

Jump to:	( C D F G I L M O S

A.3 Variables

Jump to:	* I L O S

	Index Entry	Section

*
	`block-size`:	Private special variables
	`warn-on-foreground-connect-stream`:	Public special variables

I
	`input`:	Private classes

L
	`lock`:	Private classes

O
	`output`:	Private classes

S
	`Slot, input`:	Private classes
	`Slot, lock`:	Private classes
	`Slot, output`:	Private classes
	`Special Variable, block-size`:	Private special variables
	`Special Variable, warn-on-foreground-connect-stream`:	Public special variables

Jump to:	* I L O S

A.4 Data types

Jump to:	C F G P S

	Index Entry	Section

C
	`cl-plumbing`:	The cl-plumbing system
	`cl-plumbing`:	The cl-plumbing package
	`cl-plumbing.asd`:	The cl-plumbing/cl-plumbing․asd file
	`cl-plumbing.lisp`:	The cl-plumbing/cl-plumbing․lisp file
	`Class, pipe`:	Private classes

F
	`File, cl-plumbing.asd`:	The cl-plumbing/cl-plumbing․asd file
	`File, cl-plumbing.lisp`:	The cl-plumbing/cl-plumbing․lisp file
	`File, gray-streams-pipe.lisp`:	The cl-plumbing/gray-streams-pipe․lisp file
	`File, package.lisp`:	The cl-plumbing/package․lisp file

G
	`gray-streams-pipe.lisp`:	The cl-plumbing/gray-streams-pipe․lisp file

P
	`Package, cl-plumbing`:	The cl-plumbing package
	`package.lisp`:	The cl-plumbing/package․lisp file
	`pipe`:	Private classes

S
	`System, cl-plumbing`:	The cl-plumbing system

Jump to:	C F G P S

The cl-plumbing Reference Manual

The cl-plumbing Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-plumbing

3 Files

3.1 Lisp

3.1.1 cl-plumbing/cl-plumbing.asd

3.1.2 cl-plumbing/package.lisp

3.1.3 cl-plumbing/gray-streams-pipe.lisp

3.1.4 cl-plumbing/cl-plumbing.lisp

4 Packages

4.1 cl-plumbing

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Ordinary functions

5.1.3 Standalone methods

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-plumbing`

3.1.1 `cl-plumbing/cl-plumbing.asd`

3.1.2 `cl-plumbing/package.lisp`

3.1.3 `cl-plumbing/gray-streams-pipe.lisp`

3.1.4 `cl-plumbing/cl-plumbing.lisp`

4.1 `cl-plumbing`