ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

#include <stdiostream.h>

Inheritance diagram for StdioStream:
Collaboration diagram for StdioStream:

List of all members.

Public Member Functions

 StdioStream (void *handle)
 ~StdioStream () override
bool err () const override
void clearErr () override
bool eos () const override
uint32 write (const void *dataPtr, uint32 dataSize) override
bool flush () override
int32 pos () const override
int32 size () const override
bool seek (int32 offs, int whence=SEEK_SET) override
uint32 read (void *dataPtr, uint32 dataSize) override
bool setBufferSize (uint32 bufferSize)
 Configure buffered IO.

Static Public Member Functions

static StdioStreammakeFromPath (const Common::String &path, bool writeMode)
 Given a path, invokes fopen on that path and wrap the result in a StdioStream instance.

Protected Attributes

void * _handle
 File handle to the actual file.

Detailed Description

Definition at line 31 of file stdiostream.h.


Constructor & Destructor Documentation

StdioStream::StdioStream ( void *  handle  ) 

Definition at line 30 of file stdiostream.cpp.

StdioStream::~StdioStream (  )  [override]

Definition at line 34 of file stdiostream.cpp.


Member Function Documentation

void StdioStream::clearErr (  )  [override]

Definition at line 42 of file stdiostream.cpp.

bool StdioStream::eos (  )  const [override]

Definition at line 46 of file stdiostream.cpp.

bool StdioStream::err (  )  const [override]

Definition at line 38 of file stdiostream.cpp.

bool StdioStream::flush (  )  [override]

Definition at line 83 of file stdiostream.cpp.

StdioStream * StdioStream::makeFromPath ( const Common::String path,
bool  writeMode 
) [static]

Given a path, invokes fopen on that path and wrap the result in a StdioStream instance.

Reimplemented in PosixIoStream.

Definition at line 87 of file stdiostream.cpp.

int32 StdioStream::pos (  )  const [override]

Definition at line 50 of file stdiostream.cpp.

uint32 StdioStream::read ( void *  dataPtr,
uint32  dataSize 
) [override]

Definition at line 67 of file stdiostream.cpp.

bool StdioStream::seek ( int32  offs,
int  whence = SEEK_SET 
) [override]

Definition at line 63 of file stdiostream.cpp.

bool StdioStream::setBufferSize ( uint32  bufferSize  ) 

Configure buffered IO.

Must be called immediately after opening the file. A buffer size of 0 disables buffering.

Parameters:
bufferSize the size of the Stdio read / write buffer
Returns:
success or failure

Definition at line 71 of file stdiostream.cpp.

int32 StdioStream::size (  )  const [override]

Reimplemented in PosixIoStream.

Definition at line 54 of file stdiostream.cpp.

uint32 StdioStream::write ( const void *  dataPtr,
uint32  dataSize 
) [override]

Definition at line 79 of file stdiostream.cpp.


Member Data Documentation

void* StdioStream::_handle [protected]

File handle to the actual file.

Definition at line 34 of file stdiostream.h.


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


Generated on Sat May 23 2020 05:01:53 for ResidualVM by doxygen 1.7.1
curved edge   curved edge