<?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>Codec/Zlib.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE ForeignFunctionInterface #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE EmptyDataDecls #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-4"></a><span class='hs-comment'>-- | This is a middle-level wrapper around the zlib C API. It allows you to</span>
<a name="line-5"></a><span class='hs-comment'>-- work fully with bytestrings and not touch the FFI at all, but is still</span>
<a name="line-6"></a><span class='hs-comment'>-- low-level enough to allow you to implement high-level abstractions such as</span>
<a name="line-7"></a><span class='hs-comment'>-- enumerators. Significantly, it does not use lazy IO.</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- You'll probably need to reference the docs a bit to understand the</span>
<a name="line-10"></a><span class='hs-comment'>-- WindowBits parameters below, but a basic rule of thumb is 15 is for zlib</span>
<a name="line-11"></a><span class='hs-comment'>-- compression, and 31 for gzip compression.</span>
<a name="line-12"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span>
<a name="line-13"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Inflate</span>
<a name="line-14"></a> <span class='hs-conid'>Inflate</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initInflate</span>
<a name="line-16"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>withInflateInput</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>finishInflate</span>
<a name="line-18"></a> <span class='hs-comment'>-- * Deflate</span>
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Deflate</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initDeflate</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>withDeflateInput</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>finishDeflate</span>
<a name="line-23"></a> <span class='hs-comment'>-- * Data types</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>WindowBits</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span><span class='hs-layout'>)</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultWindowBits</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZlibException</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-27"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span>
<a name="line-30"></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-31"></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-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Compression</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultWindowBits</span><span class='hs-layout'>)</span>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>S</span>
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-layout'>(</span><span class='hs-varid'>defaultChunkSize</span><span class='hs-layout'>)</span>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>when</span><span class='hs-layout'>)</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-conid'>Exception</span><span class='hs-layout'>,</span> <span class='hs-varid'>throwIO</span><span class='hs-layout'>)</span>
<a name="line-39"></a>
<a name="line-40"></a><a name="ZStreamStruct"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ZStreamStruct</span>
<a name="line-41"></a><a name="ZStream'"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>ZStreamStruct</span>
<a name="line-42"></a><a name="ZStreamPair"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ZStreamPair</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>ZStreamStruct</span><span class='hs-layout'>,</span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="Inflate"></a><span class='hs-comment'>-- | The state of an inflation (eg, decompression) process. All allocated</span>
<a name="line-45"></a><a name="Inflate"></a><span class='hs-comment'>-- memory is automatically reclaimed by the garbage collector.</span>
<a name="line-46"></a><a name="Inflate"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Inflate</span> <span class='hs-conid'>ZStreamPair</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="Deflate"></a><span class='hs-comment'>-- | The state of a deflation (eg, compression) process. All allocated memory</span>
<a name="line-49"></a><a name="Deflate"></a><span class='hs-comment'>-- is automatically reclaimed by the garbage collector.</span>
<a name="line-50"></a><a name="Deflate"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Deflate</span> <span class='hs-conid'>ZStreamPair</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="ZlibException"></a><span class='hs-comment'>-- | Exception that can be thrown from the FFI code. The parameter is the</span>
<a name="line-53"></a><a name="ZlibException"></a><span class='hs-comment'>-- numerical error code from the zlib library. Quoting the zlib.h file</span>
<a name="line-54"></a><a name="ZlibException"></a><span class='hs-comment'>-- directly:</span>
<a name="line-55"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_OK 0</span>
<a name="line-57"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-58"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_STREAM_END 1</span>
<a name="line-59"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_NEED_DICT 2</span>
<a name="line-61"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-62"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_ERRNO (-1)</span>
<a name="line-63"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-64"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_STREAM_ERROR (-2)</span>
<a name="line-65"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_DATA_ERROR (-3)</span>
<a name="line-67"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-68"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_MEM_ERROR (-4)</span>
<a name="line-69"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-70"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_BUF_ERROR (-5)</span>
<a name="line-71"></a><a name="ZlibException"></a><span class='hs-comment'>--</span>
<a name="line-72"></a><a name="ZlibException"></a><span class='hs-comment'>-- * #define Z_VERSION_ERROR (-6)</span>
<a name="line-73"></a><a name="ZlibException"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ZlibException</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ZlibException</span> <span class='hs-conid'>Int</span>
<a name="line-74"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-75"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Exception</span> <span class='hs-conid'>ZlibException</span>
<a name="line-76"></a>
<a name="line-77"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"create_z_stream_inflate"</span>
<a name="line-78"></a> <span class='hs-varid'>c_create_z_stream_inflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>ZStream'</span>
<a name="line-79"></a>
<a name="line-80"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"&free_z_stream_inflate"</span>
<a name="line-81"></a> <span class='hs-varid'>c_free_z_stream_inflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FunPtr</span> <span class='hs-layout'>(</span><span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="wbToInt"></a><span class='hs-definition'>wbToInt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span>
<a name="line-84"></a><span class='hs-definition'>wbToInt</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>i</span>
<a name="line-85"></a><span class='hs-definition'>wbToInt</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>15</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="initInflate"></a><span class='hs-comment'>-- | Initialize an inflation process with the given 'WindowBits'. You will need</span>
<a name="line-88"></a><span class='hs-comment'>-- to call 'withInflateInput' to feed compressed data to this and</span>
<a name="line-89"></a><span class='hs-comment'>-- 'finishInflate' to extract the final chunk of decompressed data.</span>
<a name="line-90"></a><span class='hs-definition'>initInflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Inflate</span>
<a name="line-91"></a><span class='hs-definition'>initInflate</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-92"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_create_z_stream_inflate</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wbToInt</span> <span class='hs-varid'>w</span>
<a name="line-93"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_inflate</span> <span class='hs-varid'>zstr</span>
<a name="line-94"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-95"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-96"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-97"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span>
<a name="line-98"></a>
<a name="line-99"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"create_z_stream_deflate"</span>
<a name="line-100"></a> <span class='hs-varid'>c_create_z_stream_deflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>ZStream'</span>
<a name="line-101"></a>
<a name="line-102"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"&free_z_stream_deflate"</span>
<a name="line-103"></a> <span class='hs-varid'>c_free_z_stream_deflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FunPtr</span> <span class='hs-layout'>(</span><span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-104"></a>
<a name="line-105"></a><a name="initDeflate"></a><span class='hs-comment'>-- | Initialize a deflation process with the given compression level and</span>
<a name="line-106"></a><span class='hs-comment'>-- 'WindowBits'. You will need to call 'withDeflateInput' to feed uncompressed</span>
<a name="line-107"></a><span class='hs-comment'>-- data to this and 'finishDeflate' to extract the final chunks of compressed</span>
<a name="line-108"></a><span class='hs-comment'>-- data.</span>
<a name="line-109"></a><span class='hs-definition'>initDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Compression level</span>
<a name="line-110"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Deflate</span>
<a name="line-111"></a><span class='hs-definition'>initDeflate</span> <span class='hs-varid'>level</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-112"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_create_z_stream_deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>level</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wbToInt</span> <span class='hs-varid'>w</span>
<a name="line-113"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_deflate</span> <span class='hs-varid'>zstr</span>
<a name="line-114"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-115"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-116"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-117"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span>
<a name="line-118"></a>
<a name="line-119"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"set_avail_in"</span>
<a name="line-120"></a> <span class='hs-varid'>c_set_avail_in</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CUInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-121"></a>
<a name="line-122"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"set_avail_out"</span>
<a name="line-123"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CUInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-124"></a>
<a name="line-125"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"get_avail_out"</span>
<a name="line-126"></a> <span class='hs-varid'>c_get_avail_out</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CUInt</span>
<a name="line-127"></a>
<a name="line-128"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"get_avail_in"</span>
<a name="line-129"></a> <span class='hs-varid'>c_get_avail_in</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CUInt</span>
<a name="line-130"></a>
<a name="line-131"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"call_inflate_noflush"</span>
<a name="line-132"></a> <span class='hs-varid'>c_call_inflate_noflush</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span>
<a name="line-133"></a>
<a name="line-134"></a><a name="withInflateInput"></a><span class='hs-comment'>-- | Feed the given 'S.ByteString' to the inflater. This function takes a</span>
<a name="line-135"></a><span class='hs-comment'>-- function argument which takes a \"popper\". A popper is an IO action that</span>
<a name="line-136"></a><span class='hs-comment'>-- will return the next bit of inflated data, returning 'Nothing' when there is</span>
<a name="line-137"></a><span class='hs-comment'>-- no more data to be popped.</span>
<a name="line-138"></a><span class='hs-comment'>--</span>
<a name="line-139"></a><span class='hs-comment'>-- Note that this function automatically buffers the output to</span>
<a name="line-140"></a><span class='hs-comment'>-- 'defaultChunkSize', and therefore you won't get any data from the popper</span>
<a name="line-141"></a><span class='hs-comment'>-- until that much decompressed data is available. After you have fed all of</span>
<a name="line-142"></a><span class='hs-comment'>-- the compressed data to this function, you can extract your final chunk of</span>
<a name="line-143"></a><span class='hs-comment'>-- decompressed data using 'finishInflate'.</span>
<a name="line-144"></a><span class='hs-definition'>withInflateInput</span>
<a name="line-145"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-146"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-147"></a><span class='hs-definition'>withInflateInput</span> <span class='hs-layout'>(</span><span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span>
<a name="line-148"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-149"></a> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-150"></a> <span class='hs-varid'>c_set_avail_in</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-151"></a> <span class='hs-varid'>f</span> <span class='hs-varop'>$</span> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>c_call_inflate_noflush</span> <span class='hs-conid'>False</span>
<a name="line-152"></a>
<a name="line-153"></a><a name="drain"></a><span class='hs-definition'>drain</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>CChar</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-154"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-155"></a><span class='hs-definition'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>func</span> <span class='hs-varid'>isFinish</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-156"></a> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_in</span> <span class='hs-varid'>zstr</span>
<a name="line-157"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>a</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>not</span> <span class='hs-varid'>isFinish</span>
<a name="line-158"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-159"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-160"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>func</span> <span class='hs-varid'>zstr</span>
<a name="line-161"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>res</span> <span class='hs-varop'><</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>res</span> <span class='hs-varop'>/=</span> <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>5</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-162"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>throwIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ZlibException</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>res</span>
<a name="line-163"></a> <span class='hs-varid'>avail</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_out</span> <span class='hs-varid'>zstr</span>
<a name="line-164"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultChunkSize</span> <span class='hs-comment'>-</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>avail</span>
<a name="line-165"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>toOutput</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>avail</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-varop'>||</span> <span class='hs-layout'>(</span><span class='hs-varid'>isFinish</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>size</span> <span class='hs-varop'>/=</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span>
<a name="line-166"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>toOutput</span>
<a name="line-167"></a> <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-168"></a> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>packCStringLen</span> <span class='hs-layout'>(</span><span class='hs-varid'>buff</span><span class='hs-layout'>,</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-169"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span>
<a name="line-170"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-171"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span>
<a name="line-172"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-173"></a>
<a name="line-174"></a><a name="finishInflate"></a><span class='hs-comment'>-- | As explained in 'withInflateInput', inflation buffers your decompressed</span>
<a name="line-175"></a><span class='hs-comment'>-- data. After you call 'withInflateInput' with your last chunk of compressed</span>
<a name="line-176"></a><span class='hs-comment'>-- data, you will likely have some data still sitting in the buffer. This</span>
<a name="line-177"></a><span class='hs-comment'>-- function will return it to you.</span>
<a name="line-178"></a><span class='hs-definition'>finishInflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-179"></a><span class='hs-definition'>finishInflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-180"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-181"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-182"></a> <span class='hs-varid'>avail</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_out</span> <span class='hs-varid'>zstr</span>
<a name="line-183"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultChunkSize</span> <span class='hs-comment'>-</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>avail</span>
<a name="line-184"></a> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>packCStringLen</span> <span class='hs-layout'>(</span><span class='hs-varid'>buff</span><span class='hs-layout'>,</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-185"></a>
<a name="line-186"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"call_deflate_noflush"</span>
<a name="line-187"></a> <span class='hs-varid'>c_call_deflate_noflush</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span>
<a name="line-188"></a>
<a name="line-189"></a><a name="withDeflateInput"></a><span class='hs-comment'>-- | Feed the given 'S.ByteString' to the deflater. This function takes a</span>
<a name="line-190"></a><span class='hs-comment'>-- function argument which takes a \"popper\". A popper is an IO action that</span>
<a name="line-191"></a><span class='hs-comment'>-- will return the next bit of deflated data, returning 'Nothing' when there is</span>
<a name="line-192"></a><span class='hs-comment'>-- no more data to be popped.</span>
<a name="line-193"></a><span class='hs-comment'>--</span>
<a name="line-194"></a><span class='hs-comment'>-- Note that this function automatically buffers the output to</span>
<a name="line-195"></a><span class='hs-comment'>-- 'defaultChunkSize', and therefore you won't get any data from the popper</span>
<a name="line-196"></a><span class='hs-comment'>-- until that much compressed data is available. After you have fed all of the</span>
<a name="line-197"></a><span class='hs-comment'>-- decompressed data to this function, you can extract your final chunks of</span>
<a name="line-198"></a><span class='hs-comment'>-- compressed data using 'finishDeflate'.</span>
<a name="line-199"></a><span class='hs-definition'>withDeflateInput</span>
<a name="line-200"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-201"></a><span class='hs-definition'>withDeflateInput</span> <span class='hs-layout'>(</span><span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span>
<a name="line-202"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-203"></a> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-204"></a> <span class='hs-varid'>c_set_avail_in</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-205"></a> <span class='hs-varid'>f</span> <span class='hs-varop'>$</span> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>c_call_deflate_noflush</span> <span class='hs-conid'>False</span>
<a name="line-206"></a>
<a name="line-207"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"call_deflate_finish"</span>
<a name="line-208"></a> <span class='hs-varid'>c_call_deflate_finish</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span>
<a name="line-209"></a>
<a name="line-210"></a><a name="finishDeflate"></a><span class='hs-comment'>-- | As explained in 'withDeflateInput', deflation buffers your compressed</span>
<a name="line-211"></a><span class='hs-comment'>-- data. After you call 'withDeflateInput' with your last chunk of decompressed</span>
<a name="line-212"></a><span class='hs-comment'>-- data, we need to flush the rest of the data waiting to be deflated. This</span>
<a name="line-213"></a><span class='hs-comment'>-- function takes a function parameter which accepts a \"popper\", just like</span>
<a name="line-214"></a><span class='hs-comment'>-- 'withDeflateInput'.</span>
<a name="line-215"></a><span class='hs-definition'>finishDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-216"></a><span class='hs-definition'>finishDeflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span>
<a name="line-217"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-218"></a> <span class='hs-varid'>f</span> <span class='hs-varop'>$</span> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>c_call_deflate_finish</span> <span class='hs-conid'>True</span>
</pre></body>
</html>
