Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > ec5844e219498f2057da8f8f3070d4a1 > files > 292

ghc-MissingH-devel-1.1.0.3-2.fc14.i686.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/System/IO/Binary.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- arch-tag: I/O utilities, binary tools
<a name="line-2"></a>Copyright (C) 2004-2005 John Goerzen &lt;jgoerzen@complete.org&gt;
<a name="line-3"></a>
<a name="line-4"></a>This program is free software; you can redistribute it and/or modify
<a name="line-5"></a>it under the terms of the GNU General Public License as published by
<a name="line-6"></a>the Free Software Foundation; either version 2 of the License, or
<a name="line-7"></a>(at your option) any later version.
<a name="line-8"></a>
<a name="line-9"></a>This program is distributed in the hope that it will be useful,
<a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
<a name="line-12"></a>GNU General Public License for more details.
<a name="line-13"></a>
<a name="line-14"></a>You should have received a copy of the GNU General Public License
<a name="line-15"></a>along with this program; if not, write to the Free Software
<a name="line-16"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
<a name="line-17"></a>-}</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- |
<a name="line-20"></a>   Module     : System.IO.Binary
<a name="line-21"></a>   Copyright  : Copyright (C) 2004-2005 John Goerzen
<a name="line-22"></a>   License    : GNU GPL, version 2 or above
<a name="line-23"></a>
<a name="line-24"></a>   Maintainer : John Goerzen &lt;jgoerzen@complete.org&gt;
<a name="line-25"></a>   Stability  : provisional
<a name="line-26"></a>   Portability: portable to platforms supporting binary I\/O
<a name="line-27"></a>
<a name="line-28"></a>This module provides various helpful utilities for dealing with binary
<a name="line-29"></a>input and output.
<a name="line-30"></a>
<a name="line-31"></a>You can use this module to deal with binary blocks of data as either Strings
<a name="line-32"></a>or lists of Word8.  The BinaryConvertible class provides this abstraction.
<a name="line-33"></a>
<a name="line-34"></a>Wherever you see HVIO, you can transparently substite a regular Handle.
<a name="line-35"></a>This module can work with any HVIO object, however.  See
<a name="line-36"></a>"System.IO.HVIO" for more details.
<a name="line-37"></a>
<a name="line-38"></a>Versions of MissingH prior 0.11.6 lacked the 'BinaryConvertible' class
<a name="line-39"></a>and worked only with Strings and Handles.
<a name="line-40"></a>
<a name="line-41"></a>Important note: /binary functions are not supported in all Haskell
<a name="line-42"></a>implementations/.  Do not import or use this module unless you know you
<a name="line-43"></a>are using an implementation that supports them.  At this time, here
<a name="line-44"></a>is the support status:
<a name="line-45"></a>
<a name="line-46"></a> * GHC 6.2 and above: yes
<a name="line-47"></a>
<a name="line-48"></a> * GHC 6.x, earlier versions: unknown
<a name="line-49"></a>
<a name="line-50"></a> * GHC 5.x: no
<a name="line-51"></a>
<a name="line-52"></a> * nhc98: no
<a name="line-53"></a>
<a name="line-54"></a> * Hugs: partial (maybe complete; needs more testing)
<a name="line-55"></a>
<a name="line-56"></a>Non-binary functions may be found in "System.IO".
<a name="line-57"></a>
<a name="line-58"></a>See also: "System.IO.BlockIO"
<a name="line-59"></a>
<a name="line-60"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-61"></a>-}</span>
<a name="line-62"></a>
<a name="line-63"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Binary</span><span class='hs-layout'>(</span>
<a name="line-64"></a>                       <span class='hs-comment'>-- * Support for different types of blocks</span>
<a name="line-65"></a>                       <span class='hs-conid'>BinaryConvertible</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-66"></a>                       <span class='hs-comment'>-- * Entire File\/Handle Utilities</span>
<a name="line-67"></a>                       <span class='hs-comment'>-- ** Opened Handle Data Copying</span>
<a name="line-68"></a>                       <span class='hs-varid'>hBlockCopy</span><span class='hs-layout'>,</span> <span class='hs-varid'>blockCopy</span><span class='hs-layout'>,</span>
<a name="line-69"></a>                       <span class='hs-comment'>-- ** Disk File Data Copying</span>
<a name="line-70"></a>                       <span class='hs-varid'>copyFileBlocksToFile</span><span class='hs-layout'>,</span>
<a name="line-71"></a>                       <span class='hs-comment'>-- * Binary Single-Block I\/O</span>
<a name="line-72"></a>                       <span class='hs-varid'>hPutBufStr</span><span class='hs-layout'>,</span> <span class='hs-varid'>putBufStr</span><span class='hs-layout'>,</span> <span class='hs-varid'>hGetBufStr</span><span class='hs-layout'>,</span> <span class='hs-varid'>getBufStr</span><span class='hs-layout'>,</span>
<a name="line-73"></a>                       <span class='hs-varid'>hFullGetBufStr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fullGetBufStr</span><span class='hs-layout'>,</span>
<a name="line-74"></a>                       <span class='hs-comment'>-- * Binary Multi-Block I\/O</span>
<a name="line-75"></a>                       <span class='hs-varid'>hGetBlocks</span><span class='hs-layout'>,</span> <span class='hs-varid'>getBlocks</span><span class='hs-layout'>,</span> <span class='hs-varid'>hFullGetBlocks</span><span class='hs-layout'>,</span> <span class='hs-varid'>fullGetBlocks</span><span class='hs-layout'>,</span>
<a name="line-76"></a>                       <span class='hs-comment'>-- * Lazy Interaction</span>
<a name="line-77"></a>                       <span class='hs-varid'>readBinaryFile</span><span class='hs-layout'>,</span> <span class='hs-varid'>writeBinaryFile</span><span class='hs-layout'>,</span>
<a name="line-78"></a>                       <span class='hs-comment'>-- ** Binary Block-based</span>
<a name="line-79"></a>                       <span class='hs-varid'>hBlockInteract</span><span class='hs-layout'>,</span> <span class='hs-varid'>blockInteract</span><span class='hs-layout'>,</span>
<a name="line-80"></a>                       <span class='hs-varid'>hFullBlockInteract</span><span class='hs-layout'>,</span> <span class='hs-varid'>fullBlockInteract</span>
<a name="line-81"></a>                        <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-82"></a>
<a name="line-83"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span> <span class='hs-layout'>(</span><span class='hs-conid'>Word8</span><span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-84"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span> <span class='hs-layout'>(</span><span class='hs-varid'>peekCStringLen</span><span class='hs-layout'>,</span> <span class='hs-varid'>withCString</span><span class='hs-layout'>)</span>
<a name="line-85"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>CChar</span><span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-86"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>ForeignPtr</span>
<a name="line-87"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Marshal</span><span class='hs-varop'>.</span><span class='hs-conid'>Array</span> <span class='hs-layout'>(</span><span class='hs-varid'>peekArray</span><span class='hs-layout'>,</span> <span class='hs-varid'>withArray</span><span class='hs-layout'>)</span>
<a name="line-88"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Ptr</span>
<a name="line-89"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-90"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>HVFS</span>
<a name="line-91"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>HVIO</span>
<a name="line-92"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafeInterleaveIO</span><span class='hs-layout'>)</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="BinaryConvertible"></a><span class='hs-comment'>{- | Provides support for handling binary blocks with convenient
<a name="line-95"></a>types.
<a name="line-96"></a>
<a name="line-97"></a>This module provides implementations for Strings and for [Word8] (lists of
<a name="line-98"></a>Word8s). -}</span>
<a name="line-99"></a><a name="BinaryConvertible"></a><span class='hs-keyword'>class</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-100"></a>    <span class='hs-varid'>toBuf</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>c</span>
<a name="line-101"></a>    <span class='hs-varid'>fromBuf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Int</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-102"></a>
<a name="line-103"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-conid'>Char</span> <span class='hs-keyword'>where</span>
<a name="line-104"></a>    <span class='hs-varid'>toBuf</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withCString</span>
<a name="line-105"></a>    <span class='hs-varid'>fromBuf</span> <span class='hs-varid'>len</span> <span class='hs-varid'>func</span> <span class='hs-keyglyph'>=</span>
<a name="line-106"></a>        <span class='hs-keyword'>do</span> <span class='hs-varid'>fbuf</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>mallocForeignPtrArray</span> <span class='hs-layout'>(</span><span class='hs-varid'>len</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-107"></a>           <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuf</span> <span class='hs-varid'>handler</span>
<a name="line-108"></a>        <span class='hs-keyword'>where</span> <span class='hs-varid'>handler</span> <span class='hs-varid'>ptr</span> <span class='hs-keyglyph'>=</span>
<a name="line-109"></a>                  <span class='hs-keyword'>do</span> <span class='hs-varid'>bytesread</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>func</span> <span class='hs-varid'>ptr</span>
<a name="line-110"></a>                     <span class='hs-varid'>peekCStringLen</span> <span class='hs-layout'>(</span><span class='hs-varid'>ptr</span><span class='hs-layout'>,</span> <span class='hs-varid'>bytesread</span><span class='hs-layout'>)</span>
<a name="line-111"></a>
<a name="line-112"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-conid'>Word8</span> <span class='hs-keyword'>where</span>
<a name="line-113"></a>    <span class='hs-varid'>toBuf</span> <span class='hs-varid'>hslist</span> <span class='hs-varid'>func</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withArray</span> <span class='hs-varid'>hslist</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ptr</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>func</span> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-varid'>ptr</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-114"></a>    <span class='hs-varid'>fromBuf</span> <span class='hs-varid'>len</span> <span class='hs-varid'>func</span> <span class='hs-keyglyph'>=</span>
<a name="line-115"></a>        <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-varid'>fbuf</span><span class='hs-keyglyph'>::</span><span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>Word8</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>mallocForeignPtrArray</span> <span class='hs-layout'>(</span><span class='hs-varid'>len</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-116"></a>           <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuf</span> <span class='hs-varid'>handler</span>
<a name="line-117"></a>        <span class='hs-keyword'>where</span> <span class='hs-varid'>handler</span> <span class='hs-varid'>ptr</span> <span class='hs-keyglyph'>=</span>
<a name="line-118"></a>                  <span class='hs-keyword'>do</span> <span class='hs-varid'>bytesread</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>func</span> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-varid'>ptr</span><span class='hs-layout'>)</span>
<a name="line-119"></a>                     <span class='hs-varid'>peekArray</span> <span class='hs-varid'>bytesread</span> <span class='hs-varid'>ptr</span>
<a name="line-120"></a>
<a name="line-121"></a>
<a name="line-122"></a><span class='hs-comment'>--  **************************************************</span>
<a name="line-123"></a><span class='hs-comment'>--  Binary Files</span>
<a name="line-124"></a><span class='hs-comment'>--  **************************************************</span>
<a name="line-125"></a>
<a name="line-126"></a><a name="hPutBufStr"></a><span class='hs-comment'>{- | As a wrapper around the standard function 'System.IO.hPutBuf',
<a name="line-127"></a>this function takes a standard Haskell 'String' instead of the far less
<a name="line-128"></a>convenient @Ptr a@.  The entire contents of the string will be written
<a name="line-129"></a>as a binary buffer using 'hPutBuf'.  The length of the output will be
<a name="line-130"></a>the length of the passed String or list.
<a name="line-131"></a>
<a name="line-132"></a>If it helps, you can thing of this function as being of type
<a name="line-133"></a>@Handle -&gt; String -&gt; IO ()@ -}</span>
<a name="line-134"></a><span class='hs-definition'>hPutBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-135"></a><span class='hs-definition'>hPutBufStr</span> <span class='hs-varid'>f</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toBuf</span> <span class='hs-varid'>s</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>cs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>vPutBuf</span> <span class='hs-varid'>f</span> <span class='hs-varid'>cs</span> <span class='hs-layout'>(</span><span class='hs-varid'>length</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-136"></a>
<a name="line-137"></a><a name="putBufStr"></a><span class='hs-comment'>-- | An alias for 'hPutBufStr' 'stdout'</span>
<a name="line-138"></a><span class='hs-definition'>putBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-139"></a><span class='hs-definition'>putBufStr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hPutBufStr</span> <span class='hs-varid'>stdout</span>
<a name="line-140"></a>
<a name="line-141"></a><a name="hGetBufStr"></a><span class='hs-comment'>{- | Acts a wrapper around the standard function 'System.IO.hGetBuf',
<a name="line-142"></a>this function returns a standard Haskell String (or [Word8]) instead of
<a name="line-143"></a>modifying
<a name="line-144"></a>a 'Ptr a' buffer.  The length is the maximum length to read and the
<a name="line-145"></a>semantice are the same as with 'hGetBuf'; namely, the empty string
<a name="line-146"></a>is returned with EOF is reached, and any given read may read fewer
<a name="line-147"></a>bytes than the given length.
<a name="line-148"></a>
<a name="line-149"></a>(Actually, it's a wrapper around 'System.IO.HVIO.vGetBuf') -}</span>
<a name="line-150"></a><span class='hs-definition'>hGetBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-151"></a><span class='hs-definition'>hGetBufStr</span> <span class='hs-varid'>f</span> <span class='hs-varid'>count</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromBuf</span> <span class='hs-varid'>count</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>buf</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>vGetBuf</span> <span class='hs-varid'>f</span> <span class='hs-varid'>buf</span> <span class='hs-varid'>count</span><span class='hs-layout'>)</span>
<a name="line-152"></a>
<a name="line-153"></a><a name="getBufStr"></a><span class='hs-comment'>-- | An alias for 'hGetBufStr' 'stdin'</span>
<a name="line-154"></a><span class='hs-definition'>getBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-155"></a><span class='hs-definition'>getBufStr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hGetBufStr</span> <span class='hs-varid'>stdin</span>
<a name="line-156"></a>
<a name="line-157"></a><a name="hFullGetBufStr"></a><span class='hs-comment'>{- | Like 'hGetBufStr', but guarantees that it will only return fewer than
<a name="line-158"></a>the requested number of bytes when EOF is encountered. -}</span>
<a name="line-159"></a><span class='hs-definition'>hFullGetBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-160"></a><span class='hs-definition'>hFullGetBufStr</span> <span class='hs-keyword'>_</span> <span class='hs-num'>0</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-161"></a><span class='hs-definition'>hFullGetBufStr</span> <span class='hs-varid'>f</span> <span class='hs-varid'>count</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-162"></a>                         <span class='hs-varid'>thisstr</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>hGetBufStr</span> <span class='hs-varid'>f</span> <span class='hs-varid'>count</span>
<a name="line-163"></a>                         <span class='hs-keyword'>if</span> <span class='hs-varid'>thisstr</span> <span class='hs-varop'>==</span> <span class='hs-conid'>[]</span>
<a name="line-164"></a>                            <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-165"></a>                            <span class='hs-keyword'>else</span> <span class='hs-keyword'>do</span>
<a name="line-166"></a>                                 <span class='hs-varid'>remainder</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>hFullGetBufStr</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-varid'>count</span> <span class='hs-comment'>-</span> <span class='hs-layout'>(</span><span class='hs-varid'>length</span> <span class='hs-varid'>thisstr</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-167"></a>                                 <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>thisstr</span> <span class='hs-varop'>++</span> <span class='hs-varid'>remainder</span><span class='hs-layout'>)</span>
<a name="line-168"></a>
<a name="line-169"></a><a name="fullGetBufStr"></a><span class='hs-comment'>-- | An alias for 'hFullGetBufStr' 'stdin'</span>
<a name="line-170"></a><span class='hs-definition'>fullGetBufStr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span>
<a name="line-171"></a><span class='hs-definition'>fullGetBufStr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hFullGetBufStr</span> <span class='hs-varid'>stdin</span>
<a name="line-172"></a>
<a name="line-173"></a><a name="hPutBlocks"></a><span class='hs-comment'>{- | Writes the list of blocks to the given file handle -- a wrapper around
<a name="line-174"></a>'hPutBufStr'.
<a name="line-175"></a>
<a name="line-176"></a>Think of this function as:
<a name="line-177"></a>
<a name="line-178"></a>&gt;Handle -&gt; [String] -&gt; IO ()
<a name="line-179"></a>
<a name="line-180"></a>(You can use it that way) -}</span>
<a name="line-181"></a><span class='hs-definition'>hPutBlocks</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-182"></a><span class='hs-definition'>hPutBlocks</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-183"></a><span class='hs-definition'>hPutBlocks</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-184"></a>                      <span class='hs-varid'>hPutBufStr</span> <span class='hs-varid'>h</span> <span class='hs-varid'>x</span>
<a name="line-185"></a>                      <span class='hs-varid'>hPutBlocks</span> <span class='hs-varid'>h</span> <span class='hs-varid'>xs</span>
<a name="line-186"></a>
<a name="line-187"></a><span class='hs-comment'>{- | An alias for 'hPutBlocks' 'stdout'
<a name="line-188"></a>putBlocks :: (BinaryConvertible b) =&gt; [[b]] -&gt; IO ()
<a name="line-189"></a>putBlocks = hPutBlocks stdout -}</span>
<a name="line-190"></a>
<a name="line-191"></a><a name="hGetBlocks"></a><span class='hs-comment'>{- | Returns a lazily-evaluated list of all blocks in the input file,
<a name="line-192"></a>as read by 'hGetBufStr'.  There will be no 0-length block in this list.
<a name="line-193"></a>The list simply ends at EOF. -}</span>
<a name="line-194"></a><span class='hs-definition'>hGetBlocks</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-195"></a><span class='hs-definition'>hGetBlocks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hGetBlocksUtil</span> <span class='hs-varid'>hGetBufStr</span>
<a name="line-196"></a>
<a name="line-197"></a><a name="getBlocks"></a><span class='hs-comment'>-- | An alias for 'hGetBlocks' 'stdin'</span>
<a name="line-198"></a><span class='hs-definition'>getBlocks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-199"></a><span class='hs-definition'>getBlocks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hGetBlocks</span> <span class='hs-varid'>stdin</span>
<a name="line-200"></a>
<a name="line-201"></a><a name="hFullGetBlocks"></a><span class='hs-comment'>{- | Same as 'hGetBlocks', but using 'hFullGetBufStr' underneath. -}</span>
<a name="line-202"></a><span class='hs-definition'>hFullGetBlocks</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-203"></a><span class='hs-definition'>hFullGetBlocks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hGetBlocksUtil</span> <span class='hs-varid'>hFullGetBufStr</span>
<a name="line-204"></a>
<a name="line-205"></a><a name="fullGetBlocks"></a><span class='hs-comment'>-- | An alias for 'hFullGetBlocks' 'stdin'</span>
<a name="line-206"></a><span class='hs-definition'>fullGetBlocks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-207"></a><span class='hs-definition'>fullGetBlocks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hFullGetBlocks</span> <span class='hs-varid'>stdin</span>
<a name="line-208"></a>
<a name="line-209"></a><a name="hGetBlocksUtil"></a><span class='hs-definition'>hGetBlocksUtil</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-210"></a><span class='hs-definition'>hGetBlocksUtil</span> <span class='hs-varid'>readfunc</span> <span class='hs-varid'>h</span> <span class='hs-varid'>count</span> <span class='hs-keyglyph'>=</span>
<a name="line-211"></a>    <span class='hs-varid'>unsafeInterleaveIO</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-212"></a>                       <span class='hs-varid'>block</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>readfunc</span> <span class='hs-varid'>h</span> <span class='hs-varid'>count</span>
<a name="line-213"></a>                       <span class='hs-keyword'>if</span> <span class='hs-varid'>block</span> <span class='hs-varop'>==</span> <span class='hs-conid'>[]</span>
<a name="line-214"></a>                          <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-215"></a>                          <span class='hs-keyword'>else</span> <span class='hs-keyword'>do</span>
<a name="line-216"></a>                               <span class='hs-varid'>remainder</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>hGetBlocksUtil</span> <span class='hs-varid'>readfunc</span> <span class='hs-varid'>h</span> <span class='hs-varid'>count</span>
<a name="line-217"></a>                               <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>block</span> <span class='hs-conop'>:</span> <span class='hs-varid'>remainder</span><span class='hs-layout'>)</span>
<a name="line-218"></a>
<a name="line-219"></a><a name="hBlockInteract"></a><span class='hs-comment'>{- | Binary block-based interaction.  This is useful for scenarios that
<a name="line-220"></a>take binary blocks, manipulate them in some way, and then write them
<a name="line-221"></a>out.  Take a look at 'hBlockCopy' for an example.  The integer argument
<a name="line-222"></a>is the size of input binary blocks.  This function uses 'hGetBlocks'
<a name="line-223"></a>internally.
<a name="line-224"></a>-}</span>
<a name="line-225"></a><span class='hs-definition'>hBlockInteract</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>HVIO</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-226"></a>                  <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-227"></a><span class='hs-definition'>hBlockInteract</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hBlockInteractUtil</span> <span class='hs-varid'>hGetBlocks</span>
<a name="line-228"></a>
<a name="line-229"></a><a name="blockInteract"></a><span class='hs-comment'>-- | An alias for 'hBlockInteract' over 'stdin' and 'stdout'</span>
<a name="line-230"></a><span class='hs-definition'>blockInteract</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-231"></a><span class='hs-definition'>blockInteract</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hBlockInteract</span> <span class='hs-varid'>x</span> <span class='hs-varid'>stdin</span> <span class='hs-varid'>stdout</span>
<a name="line-232"></a>
<a name="line-233"></a><a name="hFullBlockInteract"></a><span class='hs-comment'>{- | Same as 'hBlockInteract', but uses 'hFullGetBlocks' instead of
<a name="line-234"></a>'hGetBlocks' internally. -}</span>
<a name="line-235"></a><span class='hs-definition'>hFullBlockInteract</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>HVIO</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-236"></a>                      <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-237"></a><span class='hs-definition'>hFullBlockInteract</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hBlockInteractUtil</span> <span class='hs-varid'>hFullGetBlocks</span>
<a name="line-238"></a>
<a name="line-239"></a><a name="fullBlockInteract"></a><span class='hs-comment'>-- | An alias for 'hFullBlockInteract' over 'stdin' and 'stdout'</span>
<a name="line-240"></a><span class='hs-definition'>fullBlockInteract</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-241"></a>                     <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-242"></a><span class='hs-definition'>fullBlockInteract</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hFullBlockInteract</span> <span class='hs-varid'>x</span> <span class='hs-varid'>stdin</span> <span class='hs-varid'>stdout</span>
<a name="line-243"></a>
<a name="line-244"></a><a name="hBlockInteractUtil"></a><span class='hs-definition'>hBlockInteractUtil</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>HVIO</span> <span class='hs-varid'>d</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>BinaryConvertible</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span>
<a name="line-245"></a>                      <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span>
<a name="line-246"></a>                      <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>b</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-247"></a><span class='hs-definition'>hBlockInteractUtil</span> <span class='hs-varid'>blockreader</span> <span class='hs-varid'>blocksize</span> <span class='hs-varid'>hin</span> <span class='hs-varid'>hout</span> <span class='hs-varid'>func</span> <span class='hs-keyglyph'>=</span>
<a name="line-248"></a>    <span class='hs-keyword'>do</span>
<a name="line-249"></a>    <span class='hs-varid'>blocks</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>blockreader</span> <span class='hs-varid'>hin</span> <span class='hs-varid'>blocksize</span>
<a name="line-250"></a>    <span class='hs-varid'>hPutBlocks</span> <span class='hs-varid'>hout</span> <span class='hs-layout'>(</span><span class='hs-varid'>func</span> <span class='hs-varid'>blocks</span><span class='hs-layout'>)</span>
<a name="line-251"></a>
<a name="line-252"></a><a name="hBlockCopy"></a><span class='hs-comment'>{- | Copies everything from the input handle to the output handle using binary
<a name="line-253"></a>blocks of the given size.  This was once the following
<a name="line-254"></a>beautiful implementation:
<a name="line-255"></a>
<a name="line-256"></a>&gt; hBlockCopy bs hin hout = hBlockInteract bs hin hout id
<a name="line-257"></a>
<a name="line-258"></a>('id' is the built-in Haskell function that just returns whatever is given
<a name="line-259"></a>to it)
<a name="line-260"></a>
<a name="line-261"></a>In more recent versions of MissingH, it uses a more optimized routine that
<a name="line-262"></a>avoids ever having to convert the binary buffer at all.
<a name="line-263"></a>-}</span>
<a name="line-264"></a><span class='hs-definition'>hBlockCopy</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVIO</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>HVIO</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-265"></a><span class='hs-definition'>hBlockCopy</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>hin</span> <span class='hs-varid'>hout</span> <span class='hs-keyglyph'>=</span>
<a name="line-266"></a>    <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-varid'>fbuf</span><span class='hs-keyglyph'>::</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>mallocForeignPtrArray</span> <span class='hs-layout'>(</span><span class='hs-varid'>bs</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-267"></a>       <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuf</span> <span class='hs-varid'>handler</span>
<a name="line-268"></a>    <span class='hs-keyword'>where</span> <span class='hs-varid'>handler</span> <span class='hs-varid'>ptr</span> <span class='hs-keyglyph'>=</span>
<a name="line-269"></a>              <span class='hs-keyword'>do</span> <span class='hs-varid'>bytesread</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>vGetBuf</span> <span class='hs-varid'>hin</span> <span class='hs-varid'>ptr</span> <span class='hs-varid'>bs</span>
<a name="line-270"></a>                 <span class='hs-keyword'>if</span> <span class='hs-varid'>bytesread</span> <span class='hs-varop'>&gt;</span> <span class='hs-num'>0</span>
<a name="line-271"></a>                    <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>vPutBuf</span> <span class='hs-varid'>hout</span> <span class='hs-varid'>ptr</span> <span class='hs-varid'>bytesread</span>
<a name="line-272"></a>                            <span class='hs-varid'>handler</span> <span class='hs-varid'>ptr</span>
<a name="line-273"></a>                    <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-274"></a>
<a name="line-275"></a><a name="blockCopy"></a><span class='hs-comment'>{- | Copies from 'stdin' to 'stdout' using binary blocks of the given size.
<a name="line-276"></a>An alias for 'hBlockCopy' over 'stdin' and 'stdout'
<a name="line-277"></a>-}</span>
<a name="line-278"></a><span class='hs-definition'>blockCopy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-279"></a><span class='hs-definition'>blockCopy</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hBlockCopy</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>stdin</span> <span class='hs-varid'>stdout</span>
<a name="line-280"></a>
<a name="line-281"></a><a name="copyFileBlocksToFile"></a><span class='hs-comment'>{- | Copies one filename to another in binary mode.
<a name="line-282"></a>
<a name="line-283"></a>Please note that the Unix permission bits on the output file cannot
<a name="line-284"></a>be set due to a limitation of the Haskell 'System.IO.openBinaryFile'
<a name="line-285"></a>function.  Therefore, you may need to adjust those bits after the copy
<a name="line-286"></a>yourself.
<a name="line-287"></a>
<a name="line-288"></a>This function is implemented using 'hBlockCopy' internally. -}</span>
<a name="line-289"></a><span class='hs-definition'>copyFileBlocksToFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-290"></a><span class='hs-definition'>copyFileBlocksToFile</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>infn</span> <span class='hs-varid'>outfn</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-291"></a>                                     <span class='hs-varid'>hin</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>openBinaryFile</span> <span class='hs-varid'>infn</span> <span class='hs-conid'>ReadMode</span>
<a name="line-292"></a>                                     <span class='hs-varid'>hout</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>openBinaryFile</span> <span class='hs-varid'>outfn</span> <span class='hs-conid'>WriteMode</span>
<a name="line-293"></a>                                     <span class='hs-varid'>hBlockCopy</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>hin</span> <span class='hs-varid'>hout</span>
<a name="line-294"></a>                                     <span class='hs-varid'>hClose</span> <span class='hs-varid'>hin</span>
<a name="line-295"></a>                                     <span class='hs-varid'>hClose</span> <span class='hs-varid'>hout</span>
<a name="line-296"></a>                                     <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-297"></a>
<a name="line-298"></a><a name="readBinaryFile"></a><span class='hs-comment'>{- | Like the built-in 'readFile', but opens the file in binary instead
<a name="line-299"></a>of text mode. -}</span>
<a name="line-300"></a><span class='hs-definition'>readBinaryFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-301"></a><span class='hs-definition'>readBinaryFile</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>vReadBinaryFile</span> <span class='hs-conid'>SystemFS</span>
<a name="line-302"></a>
<a name="line-303"></a><a name="vReadBinaryFile"></a><span class='hs-comment'>{- | Same as 'readBinaryFile', but works with HVFS objects. -}</span>
<a name="line-304"></a><span class='hs-definition'>vReadBinaryFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVFSOpenable</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-305"></a><span class='hs-definition'>vReadBinaryFile</span> <span class='hs-varid'>fs</span> <span class='hs-varid'>fp</span> <span class='hs-keyglyph'>=</span>
<a name="line-306"></a>    <span class='hs-varid'>vOpenBinaryFile</span> <span class='hs-varid'>fs</span> <span class='hs-varid'>fp</span> <span class='hs-conid'>ReadMode</span> <span class='hs-varop'>&gt;&gt;=</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>HVFSOpenEncap</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>vGetContents</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span>
<a name="line-307"></a>
<a name="line-308"></a><a name="writeBinaryFile"></a><span class='hs-comment'>{- | Like the built-in 'writeFile', but opens the file in binary instead
<a name="line-309"></a>of text mode. -}</span>
<a name="line-310"></a><span class='hs-definition'>writeBinaryFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-311"></a><span class='hs-definition'>writeBinaryFile</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>vWriteBinaryFile</span> <span class='hs-conid'>SystemFS</span>
<a name="line-312"></a>
<a name="line-313"></a><a name="vWriteBinaryFile"></a><span class='hs-comment'>{- | Like 'writeBinaryFile', but works on HVFS objects. -}</span>
<a name="line-314"></a><span class='hs-definition'>vWriteBinaryFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>HVFSOpenable</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=&gt;</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-315"></a><span class='hs-definition'>vWriteBinaryFile</span> <span class='hs-varid'>fs</span> <span class='hs-varid'>name</span> <span class='hs-varid'>str</span> <span class='hs-keyglyph'>=</span>
<a name="line-316"></a>    <span class='hs-keyword'>do</span> <span class='hs-varid'>h</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>vOpenBinaryFile</span> <span class='hs-varid'>fs</span> <span class='hs-varid'>name</span> <span class='hs-conid'>WriteMode</span>
<a name="line-317"></a>       <span class='hs-keyword'>case</span> <span class='hs-varid'>h</span> <span class='hs-keyword'>of</span>
<a name="line-318"></a>              <span class='hs-conid'>HVFSOpenEncap</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>vPutStr</span> <span class='hs-varid'>x</span> <span class='hs-varid'>str</span>
<a name="line-319"></a>                                    <span class='hs-varid'>vClose</span> <span class='hs-varid'>x</span>
</pre></body>
</html>