GZIP Compression (RFC 1952) More...

#include <gzip.h>

Inheritance diagram for Gzip:

Collaboration diagram for Gzip:

Public Member Functions
	Gzip (BufferedTransformation *attachment=NULL, unsigned int deflateLevel=DEFAULT_DEFLATE_LEVEL, unsigned int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true)
	Construct a Gzip compressor. More...

	Gzip (const NameValuePairs &parameters, BufferedTransformation *attachment=NULL)
	Construct a Gzip compressor. More...

Public Member Functions inherited from Deflator
	Deflator (BufferedTransformation *attachment=NULL, int deflateLevel=DEFAULT_DEFLATE_LEVEL, int log2WindowSize=DEFAULT_LOG2_WINDOW_SIZE, bool detectUncompressible=true)
	Construct a Deflator compressor. More...

	Deflator (const NameValuePairs &parameters, BufferedTransformation *attachment=NULL)
	Construct a Deflator compressor. More...

void	SetDeflateLevel (int deflateLevel)
	Sets the deflation level. More...

int	GetDeflateLevel () const
	Retrieves the deflation level. More...

int	GetLog2WindowSize () const
	Retrieves the window size. More...

void	IsolatedInitialize (const NameValuePairs &parameters)
	Initialize or reinitialize this object, without signal propagation. More...

size_t	Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing. More...

bool	IsolatedFlush (bool hardFlush, bool blocking)
	Flushes data buffered by this object, without signal propagation. More...

Public Member Functions inherited from LowFirstBitWriter
	LowFirstBitWriter (BufferedTransformation *attachment)
	Construct a LowFirstBitWriter. More...

void	PutBits (unsigned long value, unsigned int length)

void	FlushBitBuffer ()

void	ClearBitBuffer ()

void	StartCounting ()

unsigned long	FinishCounting ()

Public Member Functions inherited from Filter
virtual	~Filter ()

size_t	TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer bytes from this object to another BufferedTransformation. More...

size_t	CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
	Copy bytes from this object to another BufferedTransformation. More...

void	Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
	Initialize or reinitialize this object, with signal propagation. More...

bool	Flush (bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output, with signal propagation. More...

bool	MessageSeriesEnd (int propagation=-1, bool blocking=true)
	Marks the end of a series of messages, with signal propagation. More...

	Filter (BufferedTransformation *attachment=NULL)
	Construct a Filter. More...

bool	Attachable ()
	Determine if attachable. More...

BufferedTransformation *	AttachedTransformation ()
	Retrieve attached transformation. More...

const BufferedTransformation *	AttachedTransformation () const
	Retrieve attached transformation. More...

void	Detach (BufferedTransformation *newAttachment=NULL)
	Replace an attached transformation. More...

Public Member Functions inherited from BufferedTransformation
virtual	~BufferedTransformation ()

	BufferedTransformation ()
	Construct a BufferedTransformation. More...

BufferedTransformation &	Ref ()
	Provides a reference to this object. More...

size_t	Put (byte inByte, bool blocking=true)
	Input a byte for processing. More...

size_t	Put (const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing. More...

size_t	PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing. More...

size_t	PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing. More...

virtual byte *	CreatePutSpace (size_t &size)
	Request space which can be written into by the caller. More...

virtual bool	CanModifyInput () const
	Determines whether input can be modified by the callee. More...

size_t	PutModifiable (byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee. More...

bool	MessageEnd (int propagation=-1, bool blocking=true)
	Signals the end of messages to the object. More...

size_t	PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

virtual size_t	PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee. More...

unsigned int	GetMaxWaitObjectCount () const
	Retrieves the maximum number of waitable objects. More...

void	GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
	Retrieves waitable objects. More...

virtual bool	IsolatedMessageSeriesEnd (bool blocking)
	Marks the end of a series of messages, without signal propagation. More...

virtual void	SetAutoSignalPropagation (int propagation)
	Set propagation of automatically generated and transferred signals. More...

virtual int	GetAutoSignalPropagation () const
	Retrieve automatic signal propagation value. More...

virtual lword	MaxRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual bool	AnyRetrievable () const
	Determines whether bytes are ready for retrieval. More...

virtual size_t	Get (byte &outByte)
	Retrieve a 8-bit byte. More...

virtual size_t	Get (byte *outString, size_t getMax)
	Retrieve a block of bytes. More...

virtual size_t	Peek (byte &outByte) const
	Peek a 8-bit byte. More...

virtual size_t	Peek (byte *outString, size_t peekMax) const
	Peek a block of bytes. More...

size_t	GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 16-bit word. More...

size_t	GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 32-bit word. More...

size_t	PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 16-bit word. More...

size_t	PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 32-bit word. More...

lword	TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
	move transferMax bytes of the buffered output to target as input More...

virtual lword	Skip (lword skipMax=LWORD_MAX)
	Discard skipMax bytes from the output buffer. More...

lword	CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	copy copyMax bytes of the buffered output to target as input More...

lword	CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy bytes from this object using an index to another BufferedTransformation. More...

virtual lword	TotalBytesRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual unsigned int	NumberOfMessages () const
	Provides the number of meesages processed by this object. More...

virtual bool	AnyMessages () const
	Determines if any messages are available for retrieval. More...

virtual bool	GetNextMessage ()
	Start retrieving the next message. More...

virtual unsigned int	SkipMessages (unsigned int count=UINT_MAX)
	Skip a number of meessages. More...

unsigned int	TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
	Transfer messages from this object to another BufferedTransformation. More...

unsigned int	CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual void	SkipAll ()
	Skip all messages in the series. More...

void	TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
	Transfer all bytes from this object to another BufferedTransformation. More...

void	CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual bool	GetNextMessageSeries ()
	Retrieve the next message in a series. More...

virtual unsigned int	NumberOfMessagesInThisSeries () const
	Provides the number of messages in a series. More...

virtual unsigned int	NumberOfMessageSeries () const
	Provides the number of messages in a series. More...

size_t	TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer messages from this object to another BufferedTransformation. More...

size_t	TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer all bytes from this object to another BufferedTransformation. More...

size_t	ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
	Input a byte for processing on a channel. More...

size_t	ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing on a channel. More...

size_t	ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee on a channel. More...

size_t	ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing on a channel. More...

size_t	ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing on a channel. More...

bool	ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Signal the end of a message. More...

size_t	ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

virtual byte *	ChannelCreatePutSpace (const std::string &channel, size_t &size)
	Request space which can be written into by the caller. More...

virtual size_t	ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing on a channel. More...

virtual size_t	ChannelPutModifiable2 (const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee on a channel. More...

virtual bool	ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output on a channel. More...

virtual bool	ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Marks the end of a series of messages on a channel. More...

virtual void	SetRetrievalChannel (const std::string &channel)
	Sets the default retrieval channel. More...

virtual void	Attach (BufferedTransformation *newAttachment)
	Add newAttachment to the end of attachment chain. More...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Public Member Functions inherited from Waitable
virtual	~Waitable ()

bool	Wait (unsigned long milliseconds, CallStack const &callStack)
	Wait on this object. More...

Public Member Functions inherited from NotCopyable
	NotCopyable ()

Protected Types
enum	{ MAGIC1 =0x1f, MAGIC2 =0x8b, DEFLATED =8, FAST =4, SLOW =2 }

Protected Types inherited from Deflator
enum	{ STORED = 0, STATIC = 1, DYNAMIC = 2 }

enum	{ MIN_MATCH = 3, MAX_MATCH = 258 }

Protected Member Functions
void	WritePrestreamHeader ()

void	ProcessUncompressedData (const byte *string, size_t length)

void	WritePoststreamTail ()

Protected Member Functions inherited from Deflator
void	InitializeStaticEncoders ()

void	Reset (bool forceReset=false)

unsigned int	FillWindow (const byte *str, size_t length)

unsigned int	ComputeHash (const byte *str) const

unsigned int	LongestMatch (unsigned int &bestMatch) const

void	InsertString (unsigned int start)

void	ProcessBuffer ()

void	LiteralByte (byte b)

void	MatchFound (unsigned int distance, unsigned int length)

void	EncodeBlock (bool eof, unsigned int blockType)

void	EndBlock (bool eof)

Protected Member Functions inherited from Filter
virtual BufferedTransformation *	NewDefaultAttachment () const

void	Insert (Filter *nextFilter)

virtual bool	ShouldPropagateMessageEnd () const

virtual bool	ShouldPropagateMessageSeriesEnd () const

void	PropagateInitialize (const NameValuePairs &parameters, int propagation)

size_t	Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Forward processed data on to attached transformation. More...

size_t	OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Output multiple bytes that may be modified by callee. More...

bool	OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Signals the end of messages to the object. More...

bool	OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Flush buffered input and/or output, with signal propagation. More...

bool	OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Marks the end of a series of messages, with signal propagation. More...

Protected Attributes
word32	m_totalLen

CRC32	m_crc

Protected Attributes inherited from Deflator
int	m_deflateLevel

int	m_log2WindowSize

int	m_compressibleDeflateLevel

unsigned int	m_detectSkip

unsigned int	m_detectCount

unsigned int	DSIZE

unsigned int	DMASK

unsigned int	HSIZE

unsigned int	HMASK

unsigned int	GOOD_MATCH

unsigned int	MAX_LAZYLENGTH

unsigned int	MAX_CHAIN_LENGTH

bool	m_headerWritten

bool	m_matchAvailable

unsigned int	m_dictionaryEnd

unsigned int	m_stringStart

unsigned int	m_lookahead

unsigned int	m_minLookahead

unsigned int	m_previousMatch

unsigned int	m_previousLength

HuffmanEncoder	m_staticLiteralEncoder

HuffmanEncoder	m_staticDistanceEncoder

HuffmanEncoder	m_dynamicLiteralEncoder

HuffmanEncoder	m_dynamicDistanceEncoder

SecByteBlock	m_byteBuffer

SecBlock< word16 >	m_head

SecBlock< word16 >	m_prev

FixedSizeSecBlock< unsigned int, 286 >	m_literalCounts

FixedSizeSecBlock< unsigned int, 30 >	m_distanceCounts

SecBlock< EncodedMatch >	m_matchBuffer

unsigned int	m_matchBufferEnd

unsigned int	m_blockStart

unsigned int	m_blockLength

Protected Attributes inherited from LowFirstBitWriter
bool	m_counting

unsigned long	m_bitCount

unsigned long	m_buffer

unsigned int	m_bitsBuffered

unsigned int	m_bytesBuffered

FixedSizeSecBlock< byte, 256 >	m_outputBuffer

Protected Attributes inherited from Filter
size_t	m_inputPosition

int	m_continueAt

Additional Inherited Members
Public Types inherited from Deflator
enum	{ MIN_DEFLATE_LEVEL = 0, DEFAULT_DEFLATE_LEVEL = 6, MAX_DEFLATE_LEVEL = 9 }
	Deflate level as enumerated values. More...

enum	{ MIN_LOG2_WINDOW_SIZE = 9, DEFAULT_LOG2_WINDOW_SIZE = 15, MAX_LOG2_WINDOW_SIZE = 15 }
	Windows size as enumerated values. More...

Static Public Attributes inherited from BufferedTransformation
static const std::string &	NULL_CHANNEL = DEFAULT_CHANNEL

Static Protected Member Functions inherited from BufferedTransformation
static int	DecrementPropagation (int propagation)
	Decrements the propagation count while clamping at 0. More...

Detailed Description

GZIP Compression (RFC 1952)

Definition at line 18 of file gzip.h.

Member Enumeration Documentation

anonymous enum

protected

Enumerator
MAGIC1
MAGIC2
DEFLATED
FAST
SLOW

Definition at line 39 of file gzip.h.

Constructor & Destructor Documentation

Gzip::Gzip	(	BufferedTransformation *	attachment = `NULL`,
		unsigned int	deflateLevel = `DEFAULT_DEFLATE_LEVEL`,
		unsigned int	log2WindowSize = `DEFAULT_LOG2_WINDOW_SIZE`,
		bool	detectUncompressible = `true`
	)

inline

Construct a Gzip compressor.

Parameters

attachment	an attached transformation
deflateLevel	the deflate level
log2WindowSize	the window size
detectUncompressible	flag to detect if data is compressible

detectUncompressible makes it faster to process uncompressible files, but if a file has both compressible and uncompressible parts, it may fail to compress some of the compressible parts.

Definition at line 29 of file gzip.h.

Gzip::Gzip	(	const NameValuePairs &	parameters,
		BufferedTransformation *	attachment = `NULL`
	)

inline

Construct a Gzip compressor.

Parameters

parameters	a set of NameValuePairs to initialize this object
attachment	an attached transformation

Possible parameter names: Log2WindowSize, DeflateLevel, DetectUncompressible

Definition at line 35 of file gzip.h.

Member Function Documentation

void Gzip::ProcessUncompressedData	(	const byte *	string,
		size_t	length
	)

protectedvirtual

Reimplemented from Deflator.

Definition at line 23 of file gzip.cpp.

Here is the call graph for this function:

void Gzip::WritePoststreamTail ( )

protectedvirtual

Reimplemented from Deflator.

Definition at line 29 of file gzip.cpp.

Here is the call graph for this function:

void Gzip::WritePrestreamHeader ( )

protectedvirtual

Reimplemented from Deflator.

Definition at line 8 of file gzip.cpp.

Here is the call graph for this function:

Member Data Documentation

CRC32 Gzip::m_crc

protected

Definition at line 47 of file gzip.h.

word32 Gzip::m_totalLen

protected

Definition at line 46 of file gzip.h.

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

src/cryptopp/gzip.h
src/cryptopp/gzip.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation