Public Types | Public Member Functions | Protected Attributes | List of all members
Ogre::FileHandleDataStream Class Reference

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

#include <OgreDataStream.h>

Inheritance diagram for Ogre::FileHandleDataStream:
Inheritance graph
[legend]

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

Protected Attributes

uint16 mAccess
 What type of access is allowed (AccessMode)
 
FILEmFileHandle
 
String mName
 The name (e.g. resource name) that can be used to identify the source for this data (optional)
 
size_t mSize
 Size of the data in the stream (may be 0 if size cannot be determined)
 

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.

Definition at line 621 of file OgreDataStream.h.

Member Enumeration Documentation

◆ AccessMode

Enumerator
READ 
WRITE 

Definition at line 179 of file OgreDataStream.h.

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 ( )

Member Function Documentation

◆ close()

void Ogre::FileHandleDataStream::close ( void  )
virtual

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

◆ eof()

bool Ogre::FileHandleDataStream::eof ( void  ) const
virtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

◆ getAccessMode()

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

Gets the access mode of the stream.

Definition at line 202 of file OgreDataStream.h.

◆ getAsString()

virtual String Ogre::DataStream::getAsString ( void  )
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 ( void  )
inherited

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

Definition at line 200 of file OgreDataStream.h.

◆ isReadable()

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

Reports whether this stream is readable.

Definition at line 204 of file OgreDataStream.h.

◆ isWriteable()

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

Reports whether this stream is writeable.

Definition at line 206 of file OgreDataStream.h.

◆ operator delete() [1/3]

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ operator>>()

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

◆ read()

size_t Ogre::FileHandleDataStream::read ( void buf,
size_t  count 
)
virtual

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::MemoryDataStream, and Ogre::FileStreamDataStream.

◆ seek()

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

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

◆ size()

size_t Ogre::DataStream::size ( void  ) const
inherited

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

Definition at line 297 of file OgreDataStream.h.

◆ skip()

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

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 ( void  ) const
virtual

Returns the current byte offset from beginning.

Implements Ogre::DataStream.

◆ write()

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

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.

Member Data Documentation

◆ mAccess

uint16 Ogre::DataStream::mAccess
protectedinherited

What type of access is allowed (AccessMode)

Definition at line 190 of file OgreDataStream.h.

◆ mFileHandle

FILE* Ogre::FileHandleDataStream::mFileHandle
protected

Definition at line 624 of file OgreDataStream.h.

◆ mName

String Ogre::DataStream::mName
protectedinherited

The name (e.g. resource name) that can be used to identify the source for this data (optional)

Definition at line 186 of file OgreDataStream.h.

◆ mSize

size_t Ogre::DataStream::mSize
protectedinherited

Size of the data in the stream (may be 0 if size cannot be determined)

Definition at line 188 of file OgreDataStream.h.


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.