sunterlib/s48/binary-parse
Anthony Carrico b6af6f686f Use install lib version 1.2.0. 2005-07-08 02:12:13 +00:00
..
AUTHORS
BLURB
NEWS Adjust version number in NEWS 2004-03-27 08:01:43 +00:00
README Add loading instructions 2004-03-27 07:44:22 +00:00
binary-parse.scm
packages.scm Moved package and interface definition to packages.scm. Generate load scripts. 2004-03-14 22:59:57 +00:00
pkg-def.scm Use install lib version 1.2.0. 2005-07-08 02:12:13 +00:00

README

[This file and the accompanying source code were derived from
 Oleg's code for Gambit available from

     http://okmij.org/ftp/Scheme/index.html#binio

]

The structure BINARY-PARSE provides a procedure to read bits from a
byte-stream.

================================================================================

After installation, use the switch

-lel binary-parse/load.scm

to load this library.

================================================================================

(make-bit-reader byte-reader) -> bit-reader

Given a BYTE-READER (a thunk), construct and return a function

      (bit-reader N) -> integer

that reads N bits from a byte-stream represented by the BYTE-READER.

The BYTE-READER is a function that takes no arguments and returns
the current byte as an exact integer [0-255]. The byte reader
should return #f on EOF.
The bit reader returns N bits as an exact unsigned integer, 
0 -... (no limit). N must be a positive integer, otherwise the bit reader
returns #f. There is no upper limit on N -- other than the size of the
input stream itself and the amount of (virtual) memory an OS is willing
to give to your process. If you want to read 1M of _bits_, go ahead.

It is assumed that the bit order is the most-significant bit first.