CPGFMemoryStream Class Reference

Memory stream class. More...

#include <PGFstream.h>

Inheritance diagram for CPGFMemoryStream:

Collaboration diagram for CPGFMemoryStream:

Public Member Functions
	CPGFMemoryStream (size_t size) THROW_
	CPGFMemoryStream (UINT8 *pBuffer, size_t size) THROW_
void	Reinitialize (UINT8 *pBuffer, size_t size) THROW_
virtual void	Write (int *count, void *buffer) THROW_
virtual void	Read (int *count, void *buffer)
virtual void	SetPos (short posMode, INT64 posOff) THROW_
virtual UINT64	GetPos () const
virtual bool	IsValid () const
size_t	GetSize () const
const UINT8 *	GetBuffer () const
UINT8 *	GetBuffer ()
UINT64	GetEOS () const
void	SetEOS (UINT64 length)
Public Member Functions inherited from CPGFStream
	CPGFStream ()
	Standard constructor.
virtual	~CPGFStream ()
	Standard destructor.

Protected Attributes
UINT8 *	m_buffer
UINT8 *	m_pos
	buffer start address and current buffer address
UINT8 *	m_eos
	end of stream (first address beyond written area)
size_t	m_size
	buffer size
bool	m_allocated
	indicates a new allocated buffer

Detailed Description

Memory stream class.

A PGF stream subclass for internal memory.

Author

C. Stamm

Constructor & Destructor Documentation

CPGFMemoryStream::CPGFMemoryStream

(

size_t

size

)

Constructor

Parameters

size	Size of new allocated memory buffer

Allocate memory block of given size

Parameters

size	Memory size

CPGFMemoryStream::CPGFMemoryStream	(	UINT8 *	pBuffer,
		size_t	size
	)

Constructor. Use already allocated memory of given size

Parameters

pBuffer	Memory location
size	Memory size

Use already allocated memory of given size

Parameters

pBuffer	Memory location
size	Memory size

Member Function Documentation

const UINT8* CPGFMemoryStream::GetBuffer ( ) const

inline

Returns

Memory buffer

UINT8* CPGFMemoryStream::GetBuffer ( )

inline

Returns

Memory buffer

UINT64 CPGFMemoryStream::GetEOS ( ) const

inline

Returns

relative position of end of stream (= stream length)

virtual UINT64 CPGFMemoryStream::GetPos ( ) const

inlinevirtual

Get current stream position.

Returns

Current stream position

Implements CPGFStream.

size_t CPGFMemoryStream::GetSize ( ) const

inline

Returns

Memory size

virtual bool CPGFMemoryStream::IsValid ( ) const

inlinevirtual

Check stream validity.

Returns

True if stream and current position is valid

Implements CPGFStream.

void CPGFMemoryStream::Read ( int *  count, void *  buffer  )

virtual

Read some bytes from this stream and stores them into a buffer.

Parameters

count	A pointer to a value containing the number of bytes should be read. After this call it contains the number of read bytes.
buffer	A memory buffer

Implements CPGFStream.

void CPGFMemoryStream::Reinitialize	(	UINT8 *	pBuffer,
		size_t	size
	)

Use already allocated memory of given size

Parameters

pBuffer	Memory location
size	Memory size

void CPGFMemoryStream::SetEOS ( UINT64  length )

inline

Parameters

length

Stream length (= relative position of end of stream)

void CPGFMemoryStream::SetPos ( short  posMode, INT64  posOff  )

virtual

Set stream position either absolute or relative.

Parameters

posMode	A position mode (FSFromStart, FSFromCurrent, FSFromEnd)
posOff	A new stream position (absolute positioning) or a position offset (relative positioning)

Implements CPGFStream.

void CPGFMemoryStream::Write ( int *  count, void *  buffer  )

virtual

Write some bytes out of a buffer into this stream.

Parameters

count	A pointer to a value containing the number of bytes should be written. After this call it contains the number of written bytes.
buffer	A memory buffer

Implements CPGFStream.

---

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

• /Users/ale/src/Scribus/scribus/third_party/pgf/PGFstream.h
• /Users/ale/src/Scribus/scribus/third_party/pgf/PGFstream.cpp