OGRE-Next  2.3
Object-Oriented Graphics Rendering Engine
Ogre::FileHandleDataStream Class Referencefinal

Common subclass of DataStream for handling data from C-style file handles. More...

#include <OgreDataStream.h>

+ Inheritance diagram for Ogre::FileHandleDataStream:

Public Types

enum  AccessMode { READ = 1 , WRITE = 2 }
 

Public Member Functions

 FileHandleDataStream (const String &name, FILE *handle, uint16 accessMode=READ)
 Create named stream from a C file handle. More...
 
 FileHandleDataStream (FILE *handle, uint16 accessMode=READ)
 Create stream from a C file handle. More...
 
 ~FileHandleDataStream () override
 
void close () override
 Close the stream; this makes further operations invalid. More...
 
bool eof () const override
 Returns true if the stream has reached the end. More...
 
uint16 getAccessMode () const
 Gets the access mode of the stream. More...
 
virtual String getAsString ()
 Returns a String containing the entire stream. More...
 
virtual String getLine (bool trimAfter=true)
 Returns a String containing the next line of data, optionally trimmed for whitespace. More...
 
const StringgetName ()
 Returns the name of the stream, if it has one. More...
 
virtual bool isReadable () const
 Reports whether this stream is readable. More...
 
virtual bool isWriteable () const
 Reports whether this stream is writeable. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
template<typename T >
DataStreamoperator>> (T &val)
 
size_t read (void *buf, size_t count) override
 Read the requisite number of bytes from the stream, stopping at the end of the file. More...
 
virtual size_t readLine (char *buf, size_t maxCount, const String &delim="\n")
 Get a single line from the stream. More...
 
void seek (size_t pos) override
 Repositions the read point to a specified byte. More...
 
size_t size () const
 Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. More...
 
void skip (long count) override
 Skip a defined number of bytes. More...
 
virtual size_t skipLine (const String &delim="\n")
 Skip a single line from the stream. More...
 
size_t tell () const override
 Returns the current byte offset from beginning. More...
 
size_t write (const void *buf, size_t count) override
 Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More...
 

Detailed Description

Common subclass of DataStream for handling data from C-style file handles.

Remarks
Use of this class is generally discouraged; if you want to wrap file access in a DataStream, you should definitely be using the C++ friendly FileStreamDataStream. However, since there are quite a few applications and libraries still wedded to the old FILE handle access, this stream wrapper provides some backwards compatibility.

Member Enumeration Documentation

◆ AccessMode

Enumerator
READ 
WRITE 

Constructor & Destructor Documentation

◆ FileHandleDataStream() [1/2]

Ogre::FileHandleDataStream::FileHandleDataStream ( FILE *  handle,
uint16  accessMode = READ 
)

Create stream from a C file handle.

◆ FileHandleDataStream() [2/2]

Ogre::FileHandleDataStream::FileHandleDataStream ( const String name,
FILE *  handle,
uint16  accessMode = READ 
)

Create named stream from a C file handle.

◆ ~FileHandleDataStream()

Ogre::FileHandleDataStream::~FileHandleDataStream ( )
override

Member Function Documentation

◆ close()

void Ogre::FileHandleDataStream::close ( )
overridevirtual

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

◆ eof()

bool Ogre::FileHandleDataStream::eof ( ) const
overridevirtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

◆ getAccessMode()

uint16 Ogre::DataStream::getAccessMode ( ) const
inlineinherited

Gets the access mode of the stream.

◆ getAsString()

virtual String Ogre::DataStream::getAsString ( )
virtualinherited

Returns a String containing the entire stream.

Remarks
This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.

◆ getLine()

virtual String Ogre::DataStream::getLine ( bool  trimAfter = true)
virtualinherited

Returns a String containing the next line of data, optionally trimmed for whitespace.

Remarks
This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required.
Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
trimAfterIf true, the line is trimmed for whitespace (as in String.trim(true,true))

◆ getName()

const String& Ogre::DataStream::getName ( )
inlineinherited

Returns the name of the stream, if it has one.

◆ isReadable()

virtual bool Ogre::DataStream::isReadable ( ) const
inlinevirtualinherited

Reports whether this stream is readable.

◆ isWriteable()

virtual bool Ogre::DataStream::isWriteable ( ) const
inlinevirtualinherited

Reports whether this stream is writeable.

◆ operator delete() [1/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

◆ operator delete() [2/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator new() [1/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

◆ operator new() [2/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

◆ operator>>()

template<typename T >
DataStream& Ogre::DataStream::operator>> ( T &  val)
inherited

◆ read()

size_t Ogre::FileHandleDataStream::read ( void *  buf,
size_t  count 
)
overridevirtual

Read the requisite number of bytes from the stream, stopping at the end of the file.

Parameters
bufReference to a buffer pointer
countNumber of bytes to read
Returns
The number of bytes read

Implements Ogre::DataStream.

◆ readLine()

virtual size_t Ogre::DataStream::readLine ( char *  buf,
size_t  maxCount,
const String delim = "\n" 
)
virtualinherited

Get a single line from the stream.

Remarks
The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character.
Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
bufReference to a buffer pointer
maxCountThe maximum length of data to be read, excluding the terminating character
delimThe delimiter to stop at
Returns
The number of bytes read, excluding the terminating character

Reimplemented in Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.

◆ seek()

void Ogre::FileHandleDataStream::seek ( size_t  pos)
overridevirtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

◆ size()

size_t Ogre::DataStream::size ( ) const
inlineinherited

Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.

◆ skip()

void Ogre::FileHandleDataStream::skip ( long  count)
overridevirtual

Skip a defined number of bytes.

This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.

Implements Ogre::DataStream.

◆ skipLine()

virtual size_t Ogre::DataStream::skipLine ( const String delim = "\n")
virtualinherited

Skip a single line from the stream.

Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
delimThe delimiter(s) to stop at
Returns
The number of bytes skipped

Reimplemented in Ogre::MemoryDataStream.

◆ tell()

size_t Ogre::FileHandleDataStream::tell ( ) const
overridevirtual

Returns the current byte offset from beginning.

Implements Ogre::DataStream.

◆ write()

size_t Ogre::FileHandleDataStream::write ( const void *  buf,
size_t  count 
)
overridevirtual

Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)

Parameters
bufPointer to a buffer containing the bytes to write
countNumber of bytes to write
Returns
The number of bytes written

Reimplemented from Ogre::DataStream.


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