Botan::Bzip_Decompression Class Reference

#include <bzip2.h>

Inheritance diagram for Botan::Bzip_Decompression:

Public Member Functions
virtual bool	attachable ()
	Bzip_Decompression (bool=false)
void	end_msg ()
std::string	name () const
void	start_msg ()
void	write (const byte input[], size_t length)
	~Bzip_Decompression ()

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

Bzip Decompression Filter

Definition at line 43 of file bzip2.h.

Constructor & Destructor Documentation

Bzip_Decompression()

Botan::Bzip_Decompression::Bzip_Decompression

(

bool

s = false

)

Definition at line 184 of file bzip2.cpp.

                                             :
   small_mem(s), buffer(DEFAULT_BUFFERSIZE)
   {
   no_writes = true;
   bz = 0;
   }

~Bzip_Decompression()

Botan::Bzip_Decompression::~Bzip_Decompression ( )

inline

Definition at line 53 of file bzip2.h.

{ clear(); }

Member Function Documentation

attachable()

virtual bool Botan::Filter::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

{ return true; }

end_msg()

void Botan::Bzip_Decompression::end_msg ( )

virtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 255 of file bzip2.cpp.

   {
   if(no_writes) return;
   bz->stream.next_in = 0;
   bz->stream.avail_in = 0;
 
   int rc = BZ_OK;
   while(rc != BZ_STREAM_END)
      {
      bz->stream.next_out = reinterpret_cast<char*>(buffer.begin());
      bz->stream.avail_out = buffer.size();
      rc = BZ2_bzDecompress(&(bz->stream));
 
      if(rc != BZ_OK && rc != BZ_STREAM_END)
         {
         clear();
         throw Decoding_Error("Bzip_Decompression: Error finalizing");
         }
 
      send(buffer, buffer.size() - bz->stream.avail_out);
      }
 
   clear();
   }

References Botan::Decoding_Error::Decoding_Error(), and Botan::Filter::send().

name()

std::string Botan::Bzip_Decompression::name ( ) const

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 46 of file bzip2.h.

{ return "Bzip_Decompression"; }

send() [1/4]

void Botan::Filter::send ( byte in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), send(), Botan::Base64_Decoder::write(), Botan::Bzip_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Chain::write(), Botan::Fork::write(), Botan::Hex_Decoder::write(), Botan::StreamCipher_Filter::write(), Botan::Zlib_Compression::write(), and Botan::Zlib_Decompression::write().

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

References send().

start_msg()

void Botan::Bzip_Decompression::start_msg ( )

virtual

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented from Botan::Filter.

Definition at line 241 of file bzip2.cpp.

   {
   clear();
   bz = new Bzip_Stream;
 
   if(BZ2_bzDecompressInit(&(bz->stream), 0, small_mem) != BZ_OK)
      throw Memory_Exhaustion();
 
   no_writes = true;
   }

Referenced by write().

write()

void Botan::Bzip_Decompression::write ( const byte input[], size_t length )

virtual

Write a portion of a message to this filter.

Parameters

input	the input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 194 of file bzip2.cpp.

   {
   if(length) no_writes = false;
 
   char* input = reinterpret_cast<char*>(const_cast<byte*>(input_arr));
 
   bz->stream.next_in = input;
   bz->stream.avail_in = length;
 
   while(bz->stream.avail_in != 0)
      {
      bz->stream.next_out = reinterpret_cast<char*>(buffer.begin());
      bz->stream.avail_out = buffer.size();
 
      int rc = BZ2_bzDecompress(&(bz->stream));
 
      if(rc != BZ_OK && rc != BZ_STREAM_END)
         {
         clear();
 
         if(rc == BZ_DATA_ERROR)
            throw Decoding_Error("Bzip_Decompression: Data integrity error");
         else if(rc == BZ_DATA_ERROR_MAGIC)
            throw Decoding_Error("Bzip_Decompression: Invalid input");
         else if(rc == BZ_MEM_ERROR)
            throw Memory_Exhaustion();
         else
            throw std::runtime_error("Bzip2 decompression: Unknown error");
         }
 
      send(buffer, buffer.size() - bz->stream.avail_out);
 
      if(rc == BZ_STREAM_END)
         {
         size_t read_from_block = length - bz->stream.avail_in;
         start_msg();
         bz->stream.next_in = input + read_from_block;
         bz->stream.avail_in = length - read_from_block;
         input += read_from_block;
         length -= read_from_block;
         }
      }
   }

References Botan::Decoding_Error::Decoding_Error(), Botan::Filter::send(), and start_msg().

---

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

• src/filters/bzip2/bzip2.h
• src/filters/bzip2/bzip2.cpp