/trivial-gray-streams

Portability library for CL gray streams.
  1. Common Lisp 100.0%
Common Lisp

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 0483ade Aug 15, 2014 @avodonosov avodonosov fix typo in a comment
Permalink
Failed to load latest commit information.
test tests: workaround LispWorks bug https://bugs.launchpad.net/common-lis… Feb 10, 2014
COPYING Added myself to COPYING and some metainfo to trivial-gray-streams.asd Mar 16, 2013
Makefile Initial revision Nov 9, 2005
README Improve README Aug 9, 2014
build.xcvb Deprecate trivial-gray-stream-mixin and instead define and export ful… Mar 10, 2013
package.lisp Don't import STREAM-FILE-POSITION. Mar 21, 2014
streams.lisp fix typo in a comment Aug 15, 2014
trivial-gray-streams-test.asd test suite: separate package.lisp file Mar 11, 2013
trivial-gray-streams.asd Added myself to COPYING and some metainfo to trivial-gray-streams.asd Mar 16, 2013

README 

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