Security Scol plugin
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Gunzip Class Reference

GZIP Decompression (RFC 1952) More...

#include <gzip.h>

Inheritance diagram for Gunzip:
Inflator AutoSignaling< Filter > Filter BufferedTransformation NotCopyable Algorithm Waitable Clonable

Classes

class  CrcErr
 Exception thrown when a CRC error occurs. More...
 
class  HeaderErr
 Exception thrown when a header decoding error occurs. More...
 
class  LengthErr
 Exception thrown when a length error occurs. More...
 
class  TailErr
 Exception thrown when the tail is too short. More...
 

Public Types

typedef Inflator::Err Err
 

Public Member Functions

 Gunzip (BufferedTransformation *attachment=NULLPTR, bool repeat=false, int autoSignalPropagation=-1)
 Construct a Gunzip decompressor.
 
word32 GetFiletime () const
 
const std::string & GetFilename (bool throwOnEncodingError=false) const
 
const std::string & GetComment (bool throwOnEncodingError=false) const
 
- Public Member Functions inherited from Inflator
 Inflator (BufferedTransformation *attachment=NULLPTR, bool repeat=false, int autoSignalPropagation=-1)
 RFC 1951 Decompressor.
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation.
 
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing.
 
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation.
 
virtual unsigned int GetLog2WindowSize () const
 
- Public Member Functions inherited from AutoSignaling< Filter >
 AutoSignaling (int propagation=-1)
 Construct an AutoSignaling.
 
void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals.
 
int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value.
 
- Public Member Functions inherited from Filter
 Filter (BufferedTransformation *attachment=NULLPTR)
 Construct a Filter.
 
bool Attachable ()
 Determine if attachable.
 
BufferedTransformationAttachedTransformation ()
 Retrieve attached transformation.
 
const BufferedTransformationAttachedTransformation () const
 Retrieve attached transformation.
 
void Detach (BufferedTransformation *newAttachment=NULLPTR)
 Replace an attached transformation.
 
size_t TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer bytes from this object to another BufferedTransformation.
 
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.
 
void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 Initialize or reinitialize this object, with signal propagation.
 
bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output, with signal propagation.
 
bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 Marks the end of a series of messages, with signal propagation.
 
- Public Member Functions inherited from BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object.
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain.
 
size_t Put (byte inByte, bool blocking=true)
 Input a byte for processing.
 
size_t Put (const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing.
 
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
size_t PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 
virtual byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller.
 
virtual bool CanModifyInput () const
 Determines whether input can be modified by the callee.
 
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee.
 
bool MessageEnd (int propagation=-1, bool blocking=true)
 Signals the end of messages to the object.
 
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.
 
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee.
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects.
 
virtual bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation.
 
virtual lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual bool AnyRetrievable () const
 Determines whether bytes are ready for retrieval.
 
virtual size_t Get (byte &outByte)
 Retrieve a 8-bit byte.
 
virtual size_t Get (byte *outString, size_t getMax)
 Retrieve a block of bytes.
 
virtual size_t Peek (byte &outByte) const
 Peek a 8-bit byte.
 
virtual size_t Peek (byte *outString, size_t peekMax) const
 Peek a block of bytes.
 
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 16-bit word.
 
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 32-bit word.
 
size_t GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 64-bit word.
 
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 16-bit word.
 
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 32-bit word.
 
size_t PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 64-bit word.
 
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
 
virtual lword Skip (lword skipMax=LWORD_MAX)
 Discard skipMax bytes from the output buffer.
 
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object to another BufferedTransformation.
 
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.
 
virtual lword TotalBytesRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object.
 
virtual bool AnyMessages () const
 Determines if any messages are available for retrieval.
 
virtual bool GetNextMessage ()
 Start retrieving the next message.
 
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 Skip a number of meessages.
 
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
 Transfer messages from this object to another BufferedTransformation.
 
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.
 
virtual void SkipAll ()
 Skip all messages in the series.
 
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
 Transfer all bytes from this object to another BufferedTransformation.
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation.
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series.
 
virtual unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series.
 
virtual unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series.
 
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.
 
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer all bytes from this object to another BufferedTransformation.
 
size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
 Input a byte for processing on a channel.
 
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.
 
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.
 
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.
 
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.
 
size_t ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 64-bit word for processing on a channel.
 
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Signal the end of a message.
 
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.
 
virtual byteChannelCreatePutSpace (const std::string &channel, size_t &size)
 Request space which can be written into by the caller.
 
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.
 
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.
 
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output on a channel.
 
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Marks the end of a series of messages on a channel.
 
virtual void SetRetrievalChannel (const std::string &channel)
 Sets the default retrieval channel.
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms.
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm.
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object.
 

Protected Types

enum  { MAGIC1 =0x1f , MAGIC2 =0x8b , DEFLATED =8 }
 
enum  FLAG_MASKS {
  CONTINUED =2 , EXTRA_FIELDS =4 , FILENAME =8 , COMMENTS =16 ,
  ENCRYPTED =32
}
 

Protected Member Functions

unsigned int MaxPrestreamHeaderSize () const
 
void ProcessPrestreamHeader ()
 
void ProcessDecompressedData (const byte *string, size_t length)
 
unsigned int MaxPoststreamTailSize () const
 
void ProcessPoststreamTail ()
 
- Protected Member Functions inherited from Filter
virtual BufferedTransformationNewDefaultAttachment () 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.
 
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.
 
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Signals the end of messages to the object.
 
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.
 
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.
 

Protected Attributes

word32 m_length
 
CRC32 m_crc
 
word32 m_filetime
 
std::string m_filename
 
std::string m_comment
 
- Protected Attributes inherited from Inflator
ByteQueue m_inQueue
 
- Protected Attributes inherited from Filter
size_t m_inputPosition
 
int m_continueAt
 

Additional Inherited Members

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

Detailed Description

GZIP Decompression (RFC 1952)

Definition at line 80 of file gzip.h.

Member Typedef Documentation

◆ Err

Definition at line 83 of file gzip.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
MAGIC1 

First header magic value.

MAGIC2 

Second header magic value.

DEFLATED 

Deflated flag.

Definition at line 116 of file gzip.h.

◆ FLAG_MASKS

enum Gunzip::FLAG_MASKS
protected

Definition at line 125 of file gzip.h.

Constructor & Destructor Documentation

◆ Gunzip()

Gunzip::Gunzip ( BufferedTransformation attachment = NULLPTR,
bool  repeat = false,
int  autoSignalPropagation = -1 
)

Construct a Gunzip decompressor.

Parameters
attachmentan attached transformation
repeatdecompress multiple compressed streams in series
autoSignalPropagation0 to turn off MessageEnd signal

Definition at line 105 of file gzip.cpp.

Member Function Documentation

◆ GetComment()

const std::string & Gunzip::GetComment ( bool  throwOnEncodingError = false) const
Returns
the comment of the stream as set in the header.
Parameters
throwOnEncodingErrorif throwOnEncodingError is true, then the comment is checked to ensure it is ISO/IEC 8859-1 encoded. If the comment does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown. If throwOnEncodingError is false then the comment is not checked.

Definition at line 180 of file gzip.cpp.

◆ GetFilename()

const std::string & Gunzip::GetFilename ( bool  throwOnEncodingError = false) const
Returns
the filename of the stream as set in the header. The application is responsible for setting it on the decompressed file.
Parameters
throwOnEncodingErrorif throwOnEncodingError is true, then the filename is checked to ensure it is ISO/IEC 8859-1 encoded. If the filename does not adhere to ISO/IEC 8859-1, then a InvalidDataFormat is thrown. If throwOnEncodingError is false then the filename is not checked.

Definition at line 194 of file gzip.cpp.

◆ GetFiletime()

word32 Gunzip::GetFiletime ( ) const
inline
Returns
the filetime of the stream as set in the header. The application is responsible for setting it on the decompressed file.

Definition at line 101 of file gzip.h.

◆ MaxPoststreamTailSize()

unsigned int Gunzip::MaxPoststreamTailSize ( ) const
inlineprotectedvirtual

Reimplemented from Inflator.

Definition at line 131 of file gzip.h.

◆ MaxPrestreamHeaderSize()

unsigned int Gunzip::MaxPrestreamHeaderSize ( ) const
inlineprotectedvirtual

Reimplemented from Inflator.

Definition at line 128 of file gzip.h.

◆ ProcessDecompressedData()

void Gunzip::ProcessDecompressedData ( const byte string,
size_t  length 
)
protectedvirtual

Reimplemented from Inflator.

Definition at line 158 of file gzip.cpp.

◆ ProcessPoststreamTail()

void Gunzip::ProcessPoststreamTail ( )
protectedvirtual

Reimplemented from Inflator.

Definition at line 165 of file gzip.cpp.

◆ ProcessPrestreamHeader()

void Gunzip::ProcessPrestreamHeader ( )
protectedvirtual

Reimplemented from Inflator.

Definition at line 110 of file gzip.cpp.

Member Data Documentation

◆ m_comment

std::string Gunzip::m_comment
protected

Definition at line 139 of file gzip.h.

◆ m_crc

CRC32 Gunzip::m_crc
protected

Definition at line 135 of file gzip.h.

◆ m_filename

std::string Gunzip::m_filename
protected

Definition at line 138 of file gzip.h.

◆ m_filetime

word32 Gunzip::m_filetime
protected

Definition at line 137 of file gzip.h.

◆ m_length

word32 Gunzip::m_length
protected

Definition at line 134 of file gzip.h.


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