The trivial-gray-streams Reference Manual

Table of Contents

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 2.3 "Robert April" on Tue Jan 09 15:55:00 2018 GMT+0.


Next: , Previous: , Up: Top   [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: Top   [Contents][Index]

2 Systems

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


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

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

Next: , Previous: , Up: Top   [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 files   [Contents][Index]

3.1.1 trivial-gray-streams.asd

Location

trivial-gray-streams.asd

Systems

trivial-gray-streams (system)


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

3.1.2 trivial-gray-streams/package.lisp

Parent

trivial-gray-streams (system)

Location

package.lisp

Packages

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

3.1.3 trivial-gray-streams/streams.lisp

Dependency

package.lisp (file)

Parent

trivial-gray-streams (system)

Location

streams.lisp

Exported Definitions
Internal Definitions

or-fallback (macro)


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

4 Packages

Packages are listed by definition order.


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

4.1 trivial-gray-streams

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

or-fallback (macro)


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

4.2 impl-specific-gray

Source

package.lisp (file)

Use List

common-lisp


Next: , Previous: , Up: Top   [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 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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

Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: fundamental-binary-input-stream ()
Package

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses
Class: fundamental-binary-stream ()
Package

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses
Class: fundamental-character-stream ()
Package

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

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

trivial-gray-streams

Source

streams.lisp (file)

Direct superclasses

fundamental-stream (class)

Direct subclasses
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)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: or-fallback &body BODY
Package

trivial-gray-streams

Source

streams.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-gray-streams.asd: The trivial-gray-streams<dot>asd file
File, Lisp, trivial-gray-streams/package.lisp: The trivial-gray-streams/package<dot>lisp file
File, Lisp, trivial-gray-streams/streams.lisp: The trivial-gray-streams/streams<dot>lisp file

L
Lisp File, trivial-gray-streams.asd: The trivial-gray-streams<dot>asd file
Lisp File, trivial-gray-streams/package.lisp: The trivial-gray-streams/package<dot>lisp file
Lisp File, trivial-gray-streams/streams.lisp: The trivial-gray-streams/streams<dot>lisp file

T
trivial-gray-streams.asd: The trivial-gray-streams<dot>asd file
trivial-gray-streams/package.lisp: The trivial-gray-streams/package<dot>lisp file
trivial-gray-streams/streams.lisp: The trivial-gray-streams/streams<dot>lisp file

Jump to:   F   L   T  

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

A.2 Functions

Jump to:   (  
G   M   O   S  
Index Entry  Section

(
(setf stream-file-position): Exported generic functions
(setf stream-file-position): Exported generic functions

G
Generic Function, (setf stream-file-position): Exported generic functions
Generic Function, stream-file-position: Exported generic functions
Generic Function, stream-read-sequence: Exported generic functions
Generic Function, stream-write-sequence: Exported generic functions

M
Macro, or-fallback: Internal macros
Method, (setf stream-file-position): Exported generic functions
Method, stream-file-position: Exported generic functions
Method, stream-read-sequence: Exported generic functions
Method, stream-write-sequence: Exported generic functions

O
or-fallback: Internal macros

S
stream-file-position: Exported generic functions
stream-file-position: Exported generic functions
stream-read-sequence: Exported generic functions
stream-read-sequence: Exported generic functions
stream-write-sequence: Exported generic functions
stream-write-sequence: Exported generic functions

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: Exported classes
Class, fundamental-binary-output-stream: Exported classes
Class, fundamental-binary-stream: Exported classes
Class, fundamental-character-input-stream: Exported classes
Class, fundamental-character-output-stream: Exported classes
Class, fundamental-character-stream: Exported classes
Class, fundamental-input-stream: Exported classes
Class, fundamental-output-stream: Exported classes
Class, fundamental-stream: Exported classes
Class, trivial-gray-stream-mixin: Exported classes

F
fundamental-binary-input-stream: Exported classes
fundamental-binary-output-stream: Exported classes
fundamental-binary-stream: Exported classes
fundamental-character-input-stream: Exported classes
fundamental-character-output-stream: Exported classes
fundamental-character-stream: Exported classes
fundamental-input-stream: Exported classes
fundamental-output-stream: Exported classes
fundamental-stream: Exported 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

S
System, trivial-gray-streams: The trivial-gray-streams system

T
trivial-gray-stream-mixin: Exported classes
trivial-gray-streams: The trivial-gray-streams system
trivial-gray-streams: The trivial-gray-streams package

Jump to:   C   F   I   P   S   T