ZipArchiveLib::CDeflateCompressor Class Reference

#include <DeflateCompressor.h>

Inheritance diagram for ZipArchiveLib::CDeflateCompressor:

Inheritance graph
[legend]

List of all members.

Classes

struct  COptions

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)
const CZipCompressor::COptionsGetOptions () 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)


Detailed Description

Compresses and decompresses data using the Zlib library.

Definition at line 39 of file DeflateCompressor.h.


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 whether the current CZipCompressor object supports the given compression method.

Parameters:
uMethod The compression method. It can be one of the CompressionMethod values.
Returns:
true, if the compression method is supported; false otherwise.

Implements CZipCompressor.

Definition at line 84 of file DeflateCompressor.h.

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 an 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.

Definition at line 110 of file DeflateCompressor.h.

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.

const CZipCompressor::COptions* ZipArchiveLib::CDeflateCompressor::GetOptions (  )  const [inline, virtual]

Returns the current options of the compressor.

Returns:
The current options for the compressor.
See also:
Compressing Data

CZipArchive::SetCompressionOptions

UpdateOptions

Reimplemented from CZipCompressor.

Definition at line 96 of file DeflateCompressor.h.

void ZipArchiveLib::CDeflateCompressor::InitCompression ( int  iLevel,
CZipFileHeader pFile,
CZipCryptograph pCryptograph 
) [virtual]

The method called when a new file is opened for compression.

Parameters:
iLevel The compression level.
pFile The file being compressed.
pCryptograph The current CZipCryptograph. It can be NULL, if no encryption is used.
See also:
Compress

FinishCompression

Reimplemented from CZipCompressor.

void ZipArchiveLib::CDeflateCompressor::InitDecompression ( CZipFileHeader pFile,
CZipCryptograph pCryptograph 
) [virtual]

The method called when a new file is opened for extraction.

Parameters:
pFile The file being extracted.
pCryptograph The current CZipCryptograph. It can be NULL, if no decryption is used.
See also:
Decompress

FinishDecompression

Reimplemented from ZipArchiveLib::CBaseLibCompressor.

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

Checks whether iErr value is an error code.

Parameters:
iErr The code to check.
Returns:
true, if iErr is an error code; false otherwise.

Implements ZipArchiveLib::CBaseLibCompressor.

Definition at line 135 of file DeflateCompressor.h.

void ZipArchiveLib::CDeflateCompressor::UpdateOptions ( const CZipCompressor::COptions pOptions  )  [inline, protected, virtual]

Updates the current options with the new options.

Parameters:
pOptions The new options to apply.

Reimplemented from CZipCompressor.

Definition at line 105 of file DeflateCompressor.h.


The documentation for this class was generated from the following file:

The ZipArchive Library Copyright © 2000 - 2009 Artpol Software - Tadeusz Dracz. Generated at Fri Apr 24 16:46:40 2009.