The trivial-gray-streams Reference Manual

Table of Contents

The trivial-gray-streams Reference Manual

This is the trivial-gray-streams Reference Manual, version 2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:29:06 2020 GMT+0.

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

2 Systems

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

2.1 trivial-gray-streams

Maintainer

Anton Vodonosov <avodonosov@yandex.ru>

Author

David Lichteblau

License

MIT

Description

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

Version

2.0

Source

trivial-gray-streams.asd (file)

Components

• package.lisp (file)
• streams.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 trivial-gray-streams.asd

Location

trivial-gray-streams.asd

Systems

trivial-gray-streams (system)

3.1.2 trivial-gray-streams/package.lisp

Parent

trivial-gray-streams (system)

Location

package.lisp

Packages

• impl-specific-gray
• trivial-gray-streams

3.1.3 trivial-gray-streams/streams.lisp

Dependency

package.lisp (file)

Parent

trivial-gray-streams (system)

Location

streams.lisp

Exported Definitions

• fundamental-binary-input-stream (class)
• fundamental-binary-output-stream (class)
• fundamental-binary-stream (class)
• fundamental-character-input-stream (class)
• fundamental-character-output-stream (class)
• fundamental-character-stream (class)
• fundamental-input-stream (class)
• fundamental-output-stream (class)
• fundamental-stream (class)
• stream-file-position (generic function)
• stream-file-position (method)
• (setf stream-file-position) (method)
• (setf stream-file-position) (generic function)
• stream-read-sequence (generic function)
• stream-read-sequence (method)
• stream-write-sequence (generic function)
• stream-write-sequence (method)
• trivial-gray-stream-mixin (class)

Internal Definitions

or-fallback (macro)

4 Packages

Packages are listed by definition order.

4.1 impl-specific-gray

Source

package.lisp (file)

Use List

common-lisp

4.2 trivial-gray-streams

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• fundamental-binary-input-stream (class)
• fundamental-binary-output-stream (class)
• fundamental-binary-stream (class)
• fundamental-character-input-stream (class)
• fundamental-character-output-stream (class)
• fundamental-character-stream (class)
• fundamental-input-stream (class)
• fundamental-output-stream (class)
• fundamental-stream (class)
• stream-file-position (generic function)
• stream-file-position (method)
• (setf stream-file-position) (method)
• (setf stream-file-position) (generic function)
• stream-read-sequence (generic function)
• stream-read-sequence (method)
• stream-write-sequence (generic function)
• stream-write-sequence (method)
• trivial-gray-stream-mixin (class)

Internal Definitions

or-fallback (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Generic functions

Generic Function: stream-file-position STREAM

Generic Function: (setf stream-file-position) NEWVAL STREAM

Package

trivial-gray-streams

Source

streams.lisp (file)

Methods

Method: stream-file-position STREAM

Method: (setf stream-file-position) NEWVAL STREAM

Generic Function: stream-read-sequence STREAM SEQUENCE START END &key &allow-other-keys

Package

trivial-gray-streams

Source

streams.lisp (file)

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 (file)

Methods

Method: stream-write-sequence (STREAM fundamental-output-stream) SEQ START END &key

5.1.2 Classes

Class: fundamental-binary-input-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-binary-input-stream (class)
• fundamental-binary-stream (class)
• fundamental-input-stream (class)

Class: fundamental-binary-output-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-binary-output-stream (class)
• fundamental-binary-stream (class)
• fundamental-output-stream (class)

Class: fundamental-binary-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-binary-stream (class)
• fundamental-stream (class)

Direct subclasses

• fundamental-binary-input-stream (class)
• fundamental-binary-output-stream (class)

Class: fundamental-character-input-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-character-input-stream (class)
• fundamental-character-stream (class)
• fundamental-input-stream (class)

Class: fundamental-character-output-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-character-output-stream (class)
• fundamental-character-stream (class)
• fundamental-output-stream (class)

Class: fundamental-character-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-character-stream (class)
• fundamental-stream (class)

Direct subclasses

• fundamental-character-input-stream (class)
• fundamental-character-output-stream (class)

Class: fundamental-input-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-input-stream (class)
• fundamental-stream (class)

Direct subclasses

• fundamental-character-input-stream (class)
• fundamental-binary-input-stream (class)

Direct methods

• stream-read-sequence (method)
• stream-read-sequence (method)

Class: fundamental-output-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

• fundamental-output-stream (class)
• fundamental-stream (class)

Direct subclasses

• fundamental-character-output-stream (class)
• fundamental-binary-output-stream (class)

Direct methods

• stream-write-sequence (method)
• stream-terpri (method)
• stream-write-sequence (method)

Class: fundamental-stream ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

fundamental-stream (class)

Direct subclasses

• fundamental-input-stream (class)
• fundamental-output-stream (class)
• fundamental-character-stream (class)
• fundamental-binary-stream (class)

Direct methods

• stream-line-length (method)
• stream-file-position (method)

Class: trivial-gray-stream-mixin ()

Package

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

standard-object (class)

5.2 Internal definitions

5.2.1 Macros

Macro: or-fallback &body BODY

Package

trivial-gray-streams

Source

streams.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types