LibreOffice Module oox (master)  1
Public Member Functions | Private Member Functions | List of all members
oox::SequenceInputStream Class Referencefinal

Wraps a StreamDataSequence and provides convenient access functions. More...

#include <binaryinputstream.hxx>

Inheritance diagram for oox::SequenceInputStream:
[legend]
Collaboration diagram for oox::SequenceInputStream:
[legend]

Public Member Functions

 SequenceInputStream (const StreamDataSequence &rData)
 Constructs the wrapper object for the passed data sequence. More...
 
virtual sal_Int32 readData (StreamDataSequence &orData, sal_Int32 nBytes, size_t nAtomSize=1) override
 Reads nBytes bytes to the passed sequence. More...
 
virtual sal_Int32 readMemory (void *opMem, sal_Int32 nBytes, size_t nAtomSize=1) override
 Reads nBytes bytes to the (existing) buffer opMem. More...
 
virtual void skip (sal_Int32 nBytes, size_t nAtomSize=1) override
 Seeks the stream forward by the passed number of bytes. More...
 
- Public Member Functions inherited from oox::SequenceSeekableStream
virtual sal_Int64 size () const override
 Returns the size of the wrapped data sequence. More...
 
virtual sal_Int64 tell () const override
 Returns the current stream position. More...
 
virtual void seek (sal_Int64 nPos) override
 Seeks the stream to the passed position. More...
 
virtual void close () override
 Releases the reference to the data sequence. More...
 
- Public Member Functions inherited from oox::BinaryStreamBase
virtual ~BinaryStreamBase ()
 
bool isSeekable () const
 Returns true, if the implementation supports the seek() operation. More...
 
bool isEof () const
 Returns true, if the stream position is invalid (EOF). More...
 
sal_Int64 getRemaining () const
 Returns the size of the remaining data available in the stream, if stream supports size() and tell(), otherwise -1. More...
 
void seekToStart ()
 Seeks the stream to the beginning, if stream is seekable. More...
 
void alignToBlock (sal_Int32 nBlockSize, sal_Int64 nAnchorPos)
 Seeks the stream forward to a position that is a multiple of the passed block size, if stream is seekable. More...
 
- Public Member Functions inherited from oox::BinaryInputStream
template<typename Type >
Type readValue ()
 Reads a value from the stream and converts it to platform byte order. More...
 
sal_Int8 readInt8 ()
 
sal_uInt8 readuInt8 ()
 
sal_Int16 readInt16 ()
 
sal_uInt16 readuInt16 ()
 
sal_Int32 readInt32 ()
 
sal_uInt32 readuInt32 ()
 
sal_Int64 readInt64 ()
 
float readFloat ()
 
double readDouble ()
 
unsigned char readuChar ()
 
template<typename Type >
sal_Int32 readArray (Type *opnArray, sal_Int32 nElemCount)
 Reads a (preallocated!) C array of values from the stream. More...
 
template<typename Type >
sal_Int32 readArray (::std::vector< Type > &orVector, sal_Int32 nElemCount)
 Reads a vector of values from the stream. More...
 
OUString readNulUnicodeArray ()
 Reads a NUL-terminated Unicode character array and returns the string. More...
 
OString readCharArray (sal_Int32 nChars)
 Reads a byte character array and returns the string. More...
 
OUString readCharArrayUC (sal_Int32 nChars, rtl_TextEncoding eTextEnc)
 Reads a byte character array and returns a Unicode string. More...
 
OUString readUnicodeArray (sal_Int32 nChars)
 Reads a Unicode character array and returns the string. More...
 
OUString readCompressedUnicodeArray (sal_Int32 nChars, bool bCompressed)
 Reads a Unicode character array (may be compressed) and returns the string. More...
 
void copyToStream (BinaryOutputStream &rOutStrm)
 Copies bytes from the current position to the passed output stream. More...
 

Private Member Functions

sal_Int32 getMaxBytes (sal_Int32 nBytes) const
 Returns the number of bytes available in the sequence for the passed byte count. More...
 

Additional Inherited Members

- Protected Member Functions inherited from oox::SequenceSeekableStream
 SequenceSeekableStream (const StreamDataSequence &rData)
 
- Protected Member Functions inherited from oox::BinaryStreamBase
 BinaryStreamBase (bool bSeekable)
 
- Protected Member Functions inherited from oox::BinaryInputStream
 BinaryInputStream ()
 This dummy default c'tor will never call the c'tor of the virtual base class BinaryStreamBase as this class cannot be instantiated directly. More...
 
- Protected Attributes inherited from oox::SequenceSeekableStream
const StreamDataSequencempData
 Wrapped data sequence. More...
 
sal_Int32 mnPos
 Current position in the sequence. More...
 
- Protected Attributes inherited from oox::BinaryStreamBase
bool mbEof
 End of stream flag. More...
 

Detailed Description

Wraps a StreamDataSequence and provides convenient access functions.

The binary data in the stream is assumed to be in little-endian format.

Definition at line 284 of file binaryinputstream.hxx.

Constructor & Destructor Documentation

oox::SequenceInputStream::SequenceInputStream ( const StreamDataSequence rData)
explicit

Constructs the wrapper object for the passed data sequence.

Attention:
The passed data sequence MUST live at least as long as this stream
wrapper. The data sequence MUST NOT be changed from outside as long
as this stream wrapper is used to read from it.

Definition at line 201 of file binaryinputstream.cxx.

Member Function Documentation

sal_Int32 oox::SequenceInputStream::getMaxBytes ( sal_Int32  nBytes) const
inlineprivate

Returns the number of bytes available in the sequence for the passed byte count.

Definition at line 310 of file binaryinputstream.hxx.

Referenced by readData(), readMemory(), and skip().

sal_Int32 oox::SequenceInputStream::readData ( StreamDataSequence orData,
sal_Int32  nBytes,
size_t  nAtomSize = 1 
)
overridevirtual

Reads nBytes bytes to the passed sequence.

Returns
Number of bytes really read.

Implements oox::BinaryInputStream.

Definition at line 207 of file binaryinputstream.cxx.

References getMaxBytes(), oox::BinaryStreamBase::mbEof, oox::SequenceSeekableStream::mnPos, and oox::SequenceSeekableStream::mpData.

sal_Int32 oox::SequenceInputStream::readMemory ( void opMem,
sal_Int32  nBytes,
size_t  nAtomSize = 1 
)
overridevirtual

Reads nBytes bytes to the (existing) buffer opMem.

Returns
Number of bytes really read.

Implements oox::BinaryInputStream.

Definition at line 222 of file binaryinputstream.cxx.

References getMaxBytes(), oox::BinaryStreamBase::mbEof, oox::SequenceSeekableStream::mnPos, and oox::SequenceSeekableStream::mpData.

void oox::SequenceInputStream::skip ( sal_Int32  nBytes,
size_t  nAtomSize = 1 
)
overridevirtual

Seeks the stream forward by the passed number of bytes.

This works for non-seekable streams too.

Implements oox::BinaryInputStream.

Definition at line 236 of file binaryinputstream.cxx.

References getMaxBytes(), oox::BinaryStreamBase::mbEof, and oox::SequenceSeekableStream::mnPos.


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