Fabcoin Core  0.16.2
P2P Digital Currency
Classes | Public Member Functions | Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Inflator Class Reference

DEFLATE decompressor (RFC 1951) More...

#include <zinflate.h>

Inheritance diagram for Inflator:
[legend]
Collaboration diagram for Inflator:
[legend]

Classes

class  BadBlockErr
 
class  Err
 
class  UnexpectedEndErr
 

Public Member Functions

 Inflator (BufferedTransformation *attachment=NULL, bool repeat=false, int autoSignalPropagation=-1)
 RFC 1951 Decompressor. 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...
 
virtual unsigned int GetLog2WindowSize () const
 
- Public Member Functions inherited from AutoSignaling< Filter >
 AutoSignaling (int propagation=-1)
 Construct an AutoSignaling. More...
 
void SetAutoSignalPropagation (int propagation)
 
int GetAutoSignalPropagation () const
 
- 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...
 
BufferedTransformationAttachedTransformation ()
 Retrieve attached transformation. More...
 
const BufferedTransformationAttachedTransformation () 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...
 
BufferedTransformationRef ()
 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 byteCreatePutSpace (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 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 byteChannelCreatePutSpace (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 ClonableClone () 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 Attributes

ByteQueue m_inQueue
 
- Protected Attributes inherited from Filter
size_t m_inputPosition
 
int m_continueAt
 

Private Types

enum  State {
  PRE_STREAM, WAIT_HEADER, DECODING_BODY, POST_STREAM,
  AFTER_END
}
 
enum  NextDecode { LITERAL, LENGTH_BITS, DISTANCE, DISTANCE_BITS }
 

Private Member Functions

virtual unsigned int MaxPrestreamHeaderSize () const
 
virtual void ProcessPrestreamHeader ()
 
virtual void ProcessDecompressedData (const byte *string, size_t length)
 
virtual unsigned int MaxPoststreamTailSize () const
 
virtual void ProcessPoststreamTail ()
 
void ProcessInput (bool flush)
 
void DecodeHeader ()
 
bool DecodeBody ()
 
void FlushOutput ()
 
void OutputByte (byte b)
 
void OutputString (const byte *string, size_t length)
 
void OutputPast (unsigned int length, unsigned int distance)
 
const HuffmanDecoderGetLiteralDecoder () const
 
const HuffmanDecoderGetDistanceDecoder () const
 

Static Private Member Functions

static const HuffmanDecoderFixedLiteralDecoder ()
 
static const HuffmanDecoderFixedDistanceDecoder ()
 

Private Attributes

State m_state
 
bool m_repeat
 
bool m_eof
 
bool m_wrappedAround
 
byte m_blockType
 
word16 m_storedLen
 
NextDecode m_nextDecode
 
unsigned int m_literal
 
unsigned int m_distance
 
HuffmanDecoder m_dynamicLiteralDecoder
 
HuffmanDecoder m_dynamicDistanceDecoder
 
LowFirstBitReader m_reader
 
SecByteBlock m_window
 
size_t m_current
 
size_t m_lastFlush
 

Additional Inherited Members

- Static Public Attributes inherited from BufferedTransformation
static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 
- 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. 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...
 
- Static Protected Member Functions inherited from BufferedTransformation
static int DecrementPropagation (int propagation)
 Decrements the propagation count while clamping at 0. More...
 

Detailed Description

DEFLATE decompressor (RFC 1951)

Since
Crypto++ 1.0

Definition at line 92 of file zinflate.h.

Member Enumeration Documentation

enum Inflator::NextDecode
private
Enumerator
LITERAL 
LENGTH_BITS 
DISTANCE 
DISTANCE_BITS 

Definition at line 146 of file zinflate.h.

enum Inflator::State
private
Enumerator
PRE_STREAM 
WAIT_HEADER 
DECODING_BODY 
POST_STREAM 
AFTER_END 

Definition at line 141 of file zinflate.h.

Constructor & Destructor Documentation

Inflator::Inflator ( BufferedTransformation attachment = NULL,
bool  repeat = false,
int  autoSignalPropagation = -1 
)

RFC 1951 Decompressor.

Parameters
attachmentthe filter's attached transformation
repeatdecompress multiple compressed streams in series
autoSignalPropagation0 to turn off MessageEnd signal

Definition at line 223 of file zinflate.cpp.

Here is the call graph for this function:

Member Function Documentation

bool Inflator::DecodeBody ( )
private

Definition at line 475 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Inflator::DecodeHeader ( )
private

Definition at line 373 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static const HuffmanDecoder* Inflator::FixedDistanceDecoder ( )
staticprivate
static const HuffmanDecoder* Inflator::FixedLiteralDecoder ( )
staticprivate
void Inflator::FlushOutput ( )
private

Definition at line 590 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

const HuffmanDecoder & Inflator::GetDistanceDecoder ( ) const
private

Definition at line 632 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

const HuffmanDecoder & Inflator::GetLiteralDecoder ( ) const
private

Definition at line 627 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual unsigned int Inflator::GetLog2WindowSize ( ) const
inlinevirtual

Reimplemented in ZlibDecompressor.

Definition at line 114 of file zinflate.h.

Here is the caller graph for this function:

bool Inflator::IsolatedFlush ( bool  hardFlush,
bool  blocking 
)
virtual

Flushes data buffered by this object, without signal propagation.

Parameters
hardFlushindicates whether all data should be flushed
blockingspecifies whether the object should block when processing input
Note
hardFlush must be used with care

Implements BufferedTransformation.

Definition at line 316 of file zinflate.cpp.

Here is the call graph for this function:

void Inflator::IsolatedInitialize ( const NameValuePairs parameters)
virtual

Initialize or reinitialize this object, without signal propagation.

Parameters
parametersa set of NameValuePairs to initialize this object
Exceptions
NotImplemented

IsolatedInitialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constructors providing all possible combintations of configurable parameters.

IsolatedInitialize() does not call Initialize() on attached transformations. If initialization should be propagated, then use the Initialize() function.

If a derived class does not override IsolatedInitialize(), then the base class throws NotImplemented.

Reimplemented from BufferedTransformation.

Definition at line 232 of file zinflate.cpp.

Here is the call graph for this function:

virtual unsigned int Inflator::MaxPoststreamTailSize ( ) const
inlineprivatevirtual

Reimplemented in Gunzip, and ZlibDecompressor.

Definition at line 124 of file zinflate.h.

Here is the caller graph for this function:

virtual unsigned int Inflator::MaxPrestreamHeaderSize ( ) const
inlineprivatevirtual

Reimplemented in Gunzip, and ZlibDecompressor.

Definition at line 120 of file zinflate.h.

Here is the caller graph for this function:

void Inflator::OutputByte ( byte  b)
private

Definition at line 240 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Inflator::OutputPast ( unsigned int  length,
unsigned int  distance 
)
private

Definition at line 271 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Inflator::OutputString ( const byte string,
size_t  length 
)
private

Definition at line 252 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void Inflator::ProcessDecompressedData ( const byte string,
size_t  length 
)
inlineprivatevirtual

Reimplemented in Gunzip, and ZlibDecompressor.

Definition at line 122 of file zinflate.h.

Here is the caller graph for this function:

void Inflator::ProcessInput ( bool  flush)
private

Definition at line 328 of file zinflate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void Inflator::ProcessPoststreamTail ( )
inlineprivatevirtual

Reimplemented in Gunzip, and ZlibDecompressor.

Definition at line 125 of file zinflate.h.

Here is the caller graph for this function:

virtual void Inflator::ProcessPrestreamHeader ( )
inlineprivatevirtual

Reimplemented in Gunzip, and ZlibDecompressor.

Definition at line 121 of file zinflate.h.

Here is the caller graph for this function:

size_t Inflator::Put2 ( const byte inString,
size_t  length,
int  messageEnd,
bool  blocking 
)
virtual

Input multiple bytes for processing.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
messageEndmeans how many filters to signal MessageEnd() to, including this one
blockingspecifies whether the object should block when processing input

Derived classes must implement Put2().

Implements BufferedTransformation.

Definition at line 300 of file zinflate.cpp.

Here is the call graph for this function:

Member Data Documentation

byte Inflator::m_blockType
private

Definition at line 144 of file zinflate.h.

size_t Inflator::m_current
private

Definition at line 152 of file zinflate.h.

unsigned int Inflator::m_distance
private

Definition at line 148 of file zinflate.h.

HuffmanDecoder Inflator::m_dynamicDistanceDecoder
private

Definition at line 149 of file zinflate.h.

HuffmanDecoder Inflator::m_dynamicLiteralDecoder
private

Definition at line 149 of file zinflate.h.

bool Inflator::m_eof
private

Definition at line 143 of file zinflate.h.

ByteQueue Inflator::m_inQueue
protected

Definition at line 117 of file zinflate.h.

size_t Inflator::m_lastFlush
private

Definition at line 152 of file zinflate.h.

unsigned int Inflator::m_literal
private

Definition at line 148 of file zinflate.h.

NextDecode Inflator::m_nextDecode
private

Definition at line 147 of file zinflate.h.

LowFirstBitReader Inflator::m_reader
private

Definition at line 150 of file zinflate.h.

bool Inflator::m_repeat
private

Definition at line 143 of file zinflate.h.

State Inflator::m_state
private

Definition at line 142 of file zinflate.h.

word16 Inflator::m_storedLen
private

Definition at line 145 of file zinflate.h.

SecByteBlock Inflator::m_window
private

Definition at line 151 of file zinflate.h.

bool Inflator::m_wrappedAround
private

Definition at line 143 of file zinflate.h.


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