The trivial-gray-streams Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The trivial-gray-streams Reference Manual

This is the trivial-gray-streams Reference Manual, version 2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 07:26:03 2022 GMT+0.

Table of Contents

Next: , Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

1 Introduction

trivial-gray-streams
====================

Gray streams is an interface proposed for inclusion with ANSI CL
by David N. Gray in Issue STREAM-DEFINITION-BY-USER
(http://www.nhplace.com/kent/CL/Issues/stream-definition-by-user.html).
The proposal did not make it into ANSI CL, but most popular
CL implementations implement this facility anyway.

This system provides an extremely thin compatibility layer for gray
streams.

How to use it
=============

Use the package TRIVIAL-GRAY-STREAMS to refer Gray stream
classes to inherit from, generic functions to implement.

Extensions
==========

The Gray proposal was made before the ANCI CL standard was finalized,
and was based on the Common Lisp The Language book.

The book does not have cl:file-position, cl:read-sequence, cl:write-sequence
functions. That's why (we think) the Gray proposal does not specify
their counterparts: stream-file-position, stream-read-sequence, stream-write-sequence.

trivial-gray-streams supports these functions:

Generic function STREAM-READ-SEQUENCE (stream sequence start end &key)
Generic function STREAM-WRITE-SEQUENCE (stream sequence start end &key)

    Notice that we use two required arguments and allow additional
    keyword arguments. Your methods on these function should have
    compliant lambda lists:
        (stream sequence start end &key)

Generic function STREAM-FILE-POSITION (stream) => file position
Generic function (SETF STREAM-FILE-POSITION) (position-spec stream) => successp

Next: , Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

2 Systems

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

Previous: , Up: Systems   [Contents][Index]

2.1 trivial-gray-streams

Compatibility layer for Gray Streams (see http://www.cliki.net/Gray%20streams).

Maintainer

Anton Vodonosov <avodonosov@yandex.ru>

Author

David Lichteblau

License

MIT

Version

2.0

Source

trivial-gray-streams.asd.

Child Components

Next: , Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

3 Files

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

Previous: , Up: Files   [Contents][Index]

3.1 Lisp

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 trivial-gray-streams/trivial-gray-streams.asd

Source

trivial-gray-streams.asd.

Parent Component

trivial-gray-streams (system).

ASDF Systems

trivial-gray-streams.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.2 trivial-gray-streams/package.lisp

Source

trivial-gray-streams.asd.

Parent Component

trivial-gray-streams (system).

Packages

Previous: , Up: Lisp   [Contents][Index]

3.1.3 trivial-gray-streams/streams.lisp

Dependency

package.lisp (file).

Source

trivial-gray-streams.asd.

Parent Component

trivial-gray-streams (system).

Public Interface
Internals

or-fallback (macro).

Next: , Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

Next: , Previous: , Up: Packages   [Contents][Index]

4.1 trivial-gray-streams

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

or-fallback (macro).

Previous: , Up: Packages   [Contents][Index]

4.2 impl-specific-gray

Source

package.lisp.

Use List

common-lisp.

Next: , Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

5 Definitions

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

Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Generic functions

Generic Function: stream-file-position (stream)
Package

trivial-gray-streams.

Source

streams.lisp.

Methods
Method: stream-file-position (stream)
Generic Function: (setf stream-file-position) (stream)
Package

trivial-gray-streams.

Source

streams.lisp.

Methods
Method: (setf stream-file-position) (stream)
Generic Function: stream-read-sequence (stream sequence start end &key &allow-other-keys)
Package

trivial-gray-streams.

Source

streams.lisp.

Methods
Method: stream-read-sequence ((stream fundamental-input-stream) seq start end &key)
Generic Function: stream-write-sequence (stream sequence start end &key &allow-other-keys)
Package

trivial-gray-streams.

Source

streams.lisp.

Methods
Method: stream-write-sequence ((stream fundamental-output-stream) seq start end &key)

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Standalone methods

Method: stream-file-position ((stream fundamental-stream) &optional position)
Package

sb-gray.

Source

streams.lisp.

Method: stream-line-length ((stream fundamental-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-sequence ((s fundamental-input-stream) seq &optional start end)
Package

sb-gray.

Source

streams.lisp.

Method: stream-terpri ((stream fundamental-output-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-write-sequence ((s fundamental-output-stream) seq &optional start end)
Package

sb-gray.

Source

streams.lisp.

Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Classes

Class: fundamental-binary-input-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Class: fundamental-binary-output-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Class: fundamental-binary-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Direct subclasses
Class: fundamental-character-input-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Class: fundamental-character-output-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Class: fundamental-character-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Direct subclasses
Class: fundamental-input-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Direct subclasses
Direct methods
Class: fundamental-output-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses
Direct subclasses
Direct methods
Class: fundamental-stream
Package

trivial-gray-streams.

Source

streams.lisp.

Direct superclasses

fundamental-stream.

Direct subclasses
Direct methods
Class: trivial-gray-stream-mixin
Package

trivial-gray-streams.

Source

streams.lisp.

Previous: , Up: Definitions   [Contents][Index]

5.2 Internals

Previous: , Up: Internals   [Contents][Index]

5.2.1 Macros

Macro: or-fallback (&body body)
Package

trivial-gray-streams.

Source

streams.lisp.

Previous: , Up: The trivial-gray-streams Reference Manual   [Contents][Index]

Appendix A Indexes

Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
G   M   O   S  
Index Entry  Section
(
(setf stream-file-position): Public generic functions
(setf stream-file-position): Public generic functions
G
Generic Function, (setf stream-file-position): Public generic functions
Generic Function, stream-file-position: Public generic functions
Generic Function, stream-read-sequence: Public generic functions
Generic Function, stream-write-sequence: Public generic functions
M
Macro, or-fallback: Private macros
Method, (setf stream-file-position): Public generic functions
Method, stream-file-position: Public generic functions
Method, stream-file-position: Public standalone methods
Method, stream-line-length: Public standalone methods
Method, stream-read-sequence: Public generic functions
Method, stream-read-sequence: Public standalone methods
Method, stream-terpri: Public standalone methods
Method, stream-write-sequence: Public generic functions
Method, stream-write-sequence: Public standalone methods
O
or-fallback: Private macros
S
stream-file-position: Public generic functions
stream-file-position: Public generic functions
stream-file-position: Public standalone methods
stream-line-length: Public standalone methods
stream-read-sequence: Public generic functions
stream-read-sequence: Public generic functions
stream-read-sequence: Public standalone methods
stream-terpri: Public standalone methods
stream-write-sequence: Public generic functions
stream-write-sequence: Public generic functions
stream-write-sequence: Public standalone methods
Jump to:   (  
G   M   O   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   I   P   S   T  
Index Entry  Section
C
Class, fundamental-binary-input-stream: Public classes
Class, fundamental-binary-output-stream: Public classes
Class, fundamental-binary-stream: Public classes
Class, fundamental-character-input-stream: Public classes
Class, fundamental-character-output-stream: Public classes
Class, fundamental-character-stream: Public classes
Class, fundamental-input-stream: Public classes
Class, fundamental-output-stream: Public classes
Class, fundamental-stream: Public classes
Class, trivial-gray-stream-mixin: Public classes
F
File, package.lisp: The trivial-gray-streams/package․lisp file
File, streams.lisp: The trivial-gray-streams/streams․lisp file
File, trivial-gray-streams.asd: The trivial-gray-streams/trivial-gray-streams․asd file
fundamental-binary-input-stream: Public classes
fundamental-binary-output-stream: Public classes
fundamental-binary-stream: Public classes
fundamental-character-input-stream: Public classes
fundamental-character-output-stream: Public classes
fundamental-character-stream: Public classes
fundamental-input-stream: Public classes
fundamental-output-stream: Public classes
fundamental-stream: Public classes
I
impl-specific-gray: The impl-specific-gray package
P
Package, impl-specific-gray: The impl-specific-gray package
Package, trivial-gray-streams: The trivial-gray-streams package
package.lisp: The trivial-gray-streams/package․lisp file
S
streams.lisp: The trivial-gray-streams/streams․lisp file
System, trivial-gray-streams: The trivial-gray-streams system
T
trivial-gray-stream-mixin: Public classes
trivial-gray-streams: The trivial-gray-streams system
trivial-gray-streams: The trivial-gray-streams package
trivial-gray-streams.asd: The trivial-gray-streams/trivial-gray-streams․asd file
Jump to:   C   F   I   P   S   T