ZipArchiveLib::CDeflateCompressor Class Reference

#include <DeflateCompressor.h>

Inheritance diagram for ZipArchiveLib::CDeflateCompressor:


Public Member Functions
bool	CanProcess (WORD uMethod)
	CDeflateCompressor (CZipStorage *pStorage)
void	Compress (const void *pBuffer, DWORD uSize)
DWORD	Decompress (void *pBuffer, DWORD uSize)
void	FinishCompression (bool bAfterException)
void	FinishDecompression (bool bAfterException)
COffsetsArray *	GetOffsetsArray () const
const CZipCompressor::COptions *	GetOptions () const
void	InitCompression (int iLevel, CZipFileHeader pFile, CZipCryptograph pCryptograph)
void	InitDecompression (CZipFileHeader pFile, CZipCryptograph pCryptograph)
Protected Member Functions
int	ConvertInternalError (int iErr) const
bool	IsCodeErrorOK (int iErr) const
void	UpdateOptions (const CZipCompressor::COptions *pOptions)
Classes
struct	COptions

Detailed Description

Compresses and decompresses data using the Zlib library.

Constructor & Destructor Documentation

ZipArchiveLib::CDeflateCompressor::CDeflateCompressor ( CZipStorage * pStorage )

Initializes a new instance of the CDeflateCompressor class.

Parameters:

pStorage

The current storage object.

Member Function Documentation

bool ZipArchiveLib::CDeflateCompressor::CanProcess ( WORD uMethod ) [inline, virtual]

Returns the value indicating, if the current CZipCompressor object supports the given compression method.

Parameters:

uMethod

The compression method. Can be one of the CompressionMethod values.

Returns:: true, if the compression method is supported; false otherwise.

Implements CZipCompressor.

void ZipArchiveLib::CDeflateCompressor::Compress	(	const void *	pBuffer,
		DWORD	uSize
	)			`[virtual]`

Compresses the given data.

Parameters:

	pBuffer	The buffer that holds the data to compress.
	uSize	The size of pBuffer.

See also:: InitCompression
FinishCompression

Implements CZipCompressor.

int ZipArchiveLib::CDeflateCompressor::ConvertInternalError ( int iErr ) const [inline, protected, virtual]

Converts internal error code of the compressor to the ZipArchive Library error code.

Parameters:

iErr

An internal error code.

Returns:: A ZipArchive Library error code.

Reimplemented from CZipCompressor.

DWORD ZipArchiveLib::CDeflateCompressor::Decompress	(	void *	pBuffer,
		DWORD	uSize
	)			`[virtual]`

Decompresses the given data.

Parameters:

	pBuffer	The buffer that receives the decompressed data.
	uSize	The size of pBuffer.

Returns:: The number of bytes decompressed and written to pBuffer.

Note:: This method should be called repeatedly until it returns 0.

See also:: InitDecompression
FinishDecompression

Implements CZipCompressor.

void ZipArchiveLib::CDeflateCompressor::FinishCompression ( bool bAfterException ) [virtual]

The method called at the end of the compression process.

Parameters:

bAfterException Set to true, if an exception occurred before or to false otherwise.

See also:: InitCompression
Compress

Reimplemented from CZipCompressor.

void ZipArchiveLib::CDeflateCompressor::FinishDecompression ( bool bAfterException ) [virtual]

The method called at the end of the decompression process.

Parameters:

bAfterException Set to true, if an exception occurred before or to false otherwise.

See also:: InitDecompression
Decompress

Reimplemented from CZipCompressor.

COffsetsArray* ZipArchiveLib::CDeflateCompressor::GetOffsetsArray ( ) const [inline]

Retrieves the offsets array that gives the location of the synchronization blocks. This method should be called just after compressing a file. The array pointer will be invalid with the next compression operation or when a file is decompressed with a method different than the deflate method or when an archive is closed. You can save the array to a buffer with the CZipCompressor::COffsetsArray::Save method.