ossimByteStreamBuffer Class Reference

#include <ossimByteStreamBuffer.h>

Inheritance diagram for ossimByteStreamBuffer:

Public Member Functions
	ossimByteStreamBuffer ()
	ossimByteStreamBuffer (char_type *buf, ossim_int64 bufSize, bool shared=true)
	ossimByteStreamBuffer (const ossimByteStreamBuffer &src)
virtual	~ossimByteStreamBuffer ()
virtual std::streambuf *	setbuf (char_type *s, std::streamsize n)
void	clear ()
std::streambuf *	setBuf (char *buf, std::streamsize bufSize, bool shared)
virtual int	overflow (int c=EOF)
char_type *	buffer ()
	Returns a pointer to the buffer. More...
const char_type *	buffer () const
char_type *	takeBuffer ()
	The buffer is no longer managed by this stream buffer and is removed. More...
ossim_uint64	bufferSize () const

Protected Member Functions
virtual int_type	pbackfail (int_type __c=traits_type::eof())
virtual pos_type	seekoff (off_type offset, std::ios_base::seekdir dir, std::ios_base::openmode __mode=std::ios_base::in|std::ios_base::out)
virtual pos_type	seekpos (pos_type pos, std::ios_base::openmode __mode=std::ios_base::in|std::ios_base::out)
virtual std::streamsize	xsgetn (char_type *__s, std::streamsize __n)
virtual std::streamsize	xsputn (const char_type *__s, std::streamsize __n)
void	deleteBuffer ()
void	extendBuffer (ossim_uint64 bytes)

Protected Attributes
char_type *	m_buffer
ossim_int64	m_bufferSize
bool	m_sharedBuffer

Detailed Description

Definition at line 23 of file ossimByteStreamBuffer.h.

Constructor & Destructor Documentation

ossimByteStreamBuffer() [1/3]

ossimByteStreamBuffer::ossimByteStreamBuffer

(

)

Definition at line 4 of file ossimByteStreamBuffer.cpp.

References m_buffer, m_bufferSize, m_sharedBuffer, and setBuf().

   :m_buffer(0),
    m_bufferSize(0),
    m_sharedBuffer(false)
{
   setBuf(m_buffer, m_bufferSize, m_sharedBuffer);
}

ossimByteStreamBuffer() [2/3]

ossimByteStreamBuffer::ossimByteStreamBuffer	(	char_type *	buf,
		ossim_int64	bufSize,
		bool	shared = true
	)

Definition at line 12 of file ossimByteStreamBuffer.cpp.

References setBuf().

   :m_buffer(0),
    m_bufferSize(0),
    m_sharedBuffer(false)    
{
   setBuf(buf, bufSize, shared);
}

ossimByteStreamBuffer() [3/3]

ossimByteStreamBuffer::ossimByteStreamBuffer

(

const ossimByteStreamBuffer &

src

)

Definition at line 22 of file ossimByteStreamBuffer.cpp.

References m_buffer, m_bufferSize, m_sharedBuffer, and setBuf().

   :m_buffer(0),
    m_bufferSize(0),
    m_sharedBuffer(false)    
{
   setBuf(src.m_buffer, src.m_bufferSize, src.m_sharedBuffer);
   
   if(src.m_buffer&&src.m_bufferSize)
   {
      // now align pointers to the same offset locations
      //
      ossim_int64 goff = src.gptr()-src.eback();
      ossim_int64 poff = src.pptr()-src.pbase();
      setg(m_buffer, m_buffer+goff, m_buffer+m_bufferSize);
      setp(m_buffer, m_buffer+m_bufferSize);
      pbump(poff);
   }
}

~ossimByteStreamBuffer()

ossimByteStreamBuffer::~ossimByteStreamBuffer ( )

virtual

Definition at line 41 of file ossimByteStreamBuffer.cpp.

References deleteBuffer().

{
   deleteBuffer();
}

Member Function Documentation

buffer() [1/2]

ossimByteStreamBuffer::char_type * ossimByteStreamBuffer::buffer

(

)

Returns a pointer to the buffer.

Definition at line 96 of file ossimByteStreamBuffer.cpp.

References m_buffer.

{return m_buffer;}

buffer() [2/2]

const ossimByteStreamBuffer::char_type * ossimByteStreamBuffer::buffer

(

)

const

Definition at line 97 of file ossimByteStreamBuffer.cpp.

References m_buffer.

{return m_buffer;}

bufferSize()

ossim_uint64 ossimByteStreamBuffer::bufferSize

(

)

const

Definition at line 113 of file ossimByteStreamBuffer.cpp.

References m_bufferSize.

{return m_bufferSize;}

clear()

void ossimByteStreamBuffer::clear

(

)

Definition at line 50 of file ossimByteStreamBuffer.cpp.

References setbuf().

{
   setbuf(0,0);
}

deleteBuffer()

void ossimByteStreamBuffer::deleteBuffer ( )

protected

Definition at line 314 of file ossimByteStreamBuffer.cpp.

References m_buffer, m_bufferSize, and m_sharedBuffer.

Referenced by setBuf(), and ~ossimByteStreamBuffer().

{
   if(!m_sharedBuffer&&m_buffer)
   {
      delete [] m_buffer;
   }
   m_buffer = 0;
   m_bufferSize=0;
}

extendBuffer()

void ossimByteStreamBuffer::extendBuffer ( ossim_uint64  bytes )

protected

Definition at line 323 of file ossimByteStreamBuffer.cpp.

References m_buffer, and m_bufferSize.

Referenced by overflow(), seekpos(), and xsputn().

{
   // ossim_uint32 oldSize = m_bufferSize;
   char* inBegin = eback();
   char* inCur   = gptr();
   ossim_uint64 pbumpOffset = pptr()-pbase();
    
   ossim_int64 relativeInCur = inCur-inBegin;
    
    
   if(!m_buffer)
   {
      if(bytes>0)
      {
         m_buffer = new char[m_bufferSize + bytes];
      }
   }
   else 
   {
      if(bytes>0)
      {
         char* newBuf = new char[m_bufferSize + bytes];
         std::memcpy(newBuf, m_buffer, m_bufferSize);
         delete [] m_buffer;
         m_buffer = newBuf;
      }
   }
   m_bufferSize += bytes;
    
   setp(m_buffer, m_buffer+m_bufferSize);
   setg(m_buffer, m_buffer+relativeInCur, m_buffer + m_bufferSize);
   pbump(pbumpOffset); // reallign to the current location
}

overflow()

int ossimByteStreamBuffer::overflow ( int  c = EOF )

virtual

Definition at line 79 of file ossimByteStreamBuffer.cpp.

References extendBuffer(), m_buffer, m_bufferSize, and m_sharedBuffer.

{
   if(m_sharedBuffer)
   {
      return EOF;
   }
   else
   {            
      ossim_uint32 oldSize = m_bufferSize;
      extendBuffer(1);
      pbump(1);
      m_buffer[oldSize] = (char_type)c;
   }
    
   return c;
}

pbackfail()

ossimByteStreamBuffer::int_type ossimByteStreamBuffer::pbackfail ( int_type  __c = traits_type::eof() )

protectedvirtual

Definition at line 116 of file ossimByteStreamBuffer.cpp.

References m_buffer, and m_bufferSize.

{
   int_type result = __c;
   ossim_int64 delta = gptr()-eback();
   if(delta!=0)
   {
      setg(m_buffer, m_buffer+(delta-1), m_buffer+m_bufferSize);
      if(__c != traits_type::eof())
      {
         *gptr() = static_cast<char_type>(__c);
      }
   }
   else
   {
      result = traits_type::eof();
   }
   return result;
}

seekoff()

ossimByteStreamBuffer::pos_type ossimByteStreamBuffer::seekoff ( off_type  offset, std::ios_base::seekdir  dir, std::ios_base::openmode  __mode = std::ios_base::in | std::ios_base::out  )

protectedvirtual

Definition at line 134 of file ossimByteStreamBuffer.cpp.

References m_bufferSize.

{ 
   pos_type result = pos_type(off_type(-1));
   if((__mode & std::ios_base::in)&&
      (__mode & std::ios_base::out))
   {
      // we currently will not support both input and output stream at the same time
      //
      return result;
   }
   switch(dir)
   {
      case std::ios_base::beg:
      {
         // if we are determing an absolute position from the beginning then 
         // just make sure the offset is within range of the current buffer size
         //
         if((offset < m_bufferSize)&&
            (offset >=0))
         {
            result = pos_type(offset);
         }
         if(__mode  & std::ios_base::in)
         {
            gbump(offset - (gptr() - eback()));
         }
         else if(__mode & std::ios_base::out)
         {
            pbump(offset - (pptr() - pbase()));
         }
         break;
      }
      case std::ios_base::cur:
      {
         // if we are determing an absolute position from the current pointer then 
         // add the offset as a relative displacment
         //
         pos_type newPosition = result;
         ossim_int64 delta = 0;
         if(__mode & std::ios_base::in)
         {
            delta = gptr()-eback();
         }
         else if(__mode & std::ios_base::out)
         {
            delta = pptr()-pbase();
         }
         newPosition = pos_type(delta + offset);
         if((newPosition >= 0)&&(newPosition < m_bufferSize))
         {
            result = newPosition;
            if(__mode  & std::ios_base::in)
            {
               gbump(offset);
            }
            else if(__mode & std::ios_base::out)
            {
               pbump(offset);
            }
         }
         break;
      }
      case std::ios_base::end:
      {
         pos_type newPosition = result;
         ossim_int64 delta = 0;
         if(__mode & std::ios_base::in)
         {
            delta = egptr()-eback();
         }
         else if(__mode & std::ios_base::out)
         {
            delta = epptr()-pbase();
         }
         newPosition = pos_type(delta + offset);
         if((newPosition >= 0)&&(newPosition < m_bufferSize))
         {
            result = newPosition;
            if(__mode  & std::ios_base::in)
            {
               gbump(offset - (gptr() - eback()));
            }
            else if(__mode & std::ios_base::out)
            {
               pbump(offset - (epptr() - pptr()));
            }
         }
         break;
      }
      default:
      {
         break;
      }
   }
   return result; 
} 

seekpos()

ossimByteStreamBuffer::pos_type ossimByteStreamBuffer::seekpos ( pos_type  pos, std::ios_base::openmode  __mode = std::ios_base::in | std::ios_base::out  )

protectedvirtual

Definition at line 232 of file ossimByteStreamBuffer.cpp.

References extendBuffer(), m_buffer, m_bufferSize, and m_sharedBuffer.

{
   pos_type result = pos_type(off_type(-1));
    
   if(__mode & std::ios_base::in)
   {
      if(pos >= 0)
      {
         if(pos < m_bufferSize)
         {
            setg(m_buffer, m_buffer + pos, m_buffer + m_bufferSize);
            result = pos;
         }
      }
   }
   else if(__mode & std::ios_base::out)
   {
      if(pos >=0)
      {
         setp(m_buffer, m_buffer+m_bufferSize);
         if(pos < m_bufferSize)
         {
            pbump(pos);
            result = pos;
         }
         else if(!m_sharedBuffer)
         {
            ossim_int64 delta = ossim_int64(pos) - m_bufferSize;
            if(delta > 0)
            {
               extendBuffer(delta+1);
               pbump(pos);
               result = pos;
            }
         }
      }
   }
    
   return result;
}

setbuf()

std::streambuf * ossimByteStreamBuffer::setbuf ( char_type *  s, std::streamsize  n  )

virtual

Definition at line 45 of file ossimByteStreamBuffer.cpp.

References n, and setBuf().

Referenced by clear().

{
   return setBuf(s, n, false);
}

setBuf()

std::streambuf * ossimByteStreamBuffer::setBuf	(	char *	buf,
		std::streamsize	bufSize,
		bool	shared
	)

Definition at line 55 of file ossimByteStreamBuffer.cpp.

References deleteBuffer(), m_buffer, m_bufferSize, and m_sharedBuffer.

Referenced by ossimByteStreamBuffer(), and setbuf().

{
   
   deleteBuffer();
   setp(0,0);
   setg(0,0,0);
   char_type* tempBuf = buf;
   if(!shared&&bufSize&&buf)
   {
      tempBuf = new char_type[bufSize];
      memcpy(tempBuf, buf, bufSize);
   }
   m_buffer = tempBuf;
   m_sharedBuffer = shared;
   m_bufferSize = bufSize;
   setp(m_buffer, m_buffer+bufSize);
   if(m_buffer)
   {
      setg(m_buffer, m_buffer, m_buffer+bufSize);
   }
    
   return this;
}

takeBuffer()

ossimByteStreamBuffer::char_type * ossimByteStreamBuffer::takeBuffer

(

)

The buffer is no longer managed by this stream buffer and is removed.

Definition at line 102 of file ossimByteStreamBuffer.cpp.

References m_buffer, and m_bufferSize.

{
   char_type* result = m_buffer;
   setp(0,0);
   setg(0,0,0);
   m_bufferSize = 0;
   m_buffer     = 0;
    
   return result;
}

xsgetn()

std::streamsize ossimByteStreamBuffer::xsgetn ( char_type *  __s, std::streamsize  __n  )

protectedvirtual

Definition at line 273 of file ossimByteStreamBuffer.cpp.

{
   ossim_uint64 bytesLeftToRead = egptr()-gptr();
   ossim_uint64 bytesToRead = __n;
    
   if(bytesToRead > bytesLeftToRead)
   {
      bytesToRead = bytesLeftToRead;
   }
   if(bytesToRead)
   {
      std::memcpy(__s, gptr(), bytesToRead);
      gbump(bytesToRead); // bump the current get pointer
   }
   return std::streamsize(bytesToRead);
}

xsputn()

std::streamsize ossimByteStreamBuffer::xsputn ( const char_type *  __s, std::streamsize  __n  )

protectedvirtual

Definition at line 290 of file ossimByteStreamBuffer.cpp.

References extendBuffer(), and m_sharedBuffer.

{
   ossim_int64 bytesLeftToWrite = epptr()-pptr();
   ossim_int64 bytesToWrite = __n;
   if(__n > bytesLeftToWrite)
   {
      if(!m_sharedBuffer)
      {
         extendBuffer(__n-bytesLeftToWrite);
      }
      else
      {
         bytesToWrite = bytesLeftToWrite;
      }
   }
   if(bytesToWrite)
   {
      std::memcpy(pptr(), __s, bytesToWrite);
      pbump(bytesToWrite);
   }
    
   return bytesToWrite;
}

Member Data Documentation

m_buffer

char_type* ossimByteStreamBuffer::m_buffer

protected

Definition at line 61 of file ossimByteStreamBuffer.h.

Referenced by buffer(), deleteBuffer(), extendBuffer(), ossimByteStreamBuffer(), overflow(), pbackfail(), seekpos(), setBuf(), and takeBuffer().

m_bufferSize

ossim_int64 ossimByteStreamBuffer::m_bufferSize

protected

Definition at line 62 of file ossimByteStreamBuffer.h.

Referenced by bufferSize(), deleteBuffer(), extendBuffer(), ossimByteStreamBuffer(), overflow(), pbackfail(), seekoff(), seekpos(), setBuf(), and takeBuffer().

m_sharedBuffer

bool ossimByteStreamBuffer::m_sharedBuffer

protected

Definition at line 63 of file ossimByteStreamBuffer.h.

Referenced by deleteBuffer(), ossimByteStreamBuffer(), overflow(), seekpos(), setBuf(), and xsputn().

---

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

• ossimByteStreamBuffer.h
• ossimByteStreamBuffer.cpp