FileStream.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Io/Stream.hpp"
#include "Arp/System/Commons/Io/FileMode.hpp"
#include "Arp/System/Commons/Io/FileAccess.hpp"
 
// forwards
namespace Arp { namespace System { namespace Ve
{
class IFileService;
}}}
 
namespace Arp { namespace System { namespace Commons { namespace Io
{
 
class FileStream : public Stream
{
public: // typedefs/usings
    using IFileService = Arp::System::Ve::IFileService;
 
public: // construction/destruction
 
    FileStream(const String& path, FileMode mode);
 
    FileStream(const String& path, FileMode mode, FileAccess access);
 
    FileStream(const String& path, FileMode mode, FileAccess access, bool sync);
 
    FileStream(const FileStream& arg) = delete;
 
    FileStream& operator=(const FileStream& arg) = delete;
 
    ~FileStream(void)override;
 
public: // setter/getter operations
    boolean CanRead(void) override;
 
    boolean CanWrite(void) override;
 
    boolean CanSeek(void) override;
 
    size_t GetLength(void) override;
 
    void SetLength(size_t length) override;
 
    size_t GetPosition(void) override;
 
    void SetPosition(size_t position) override;
 
 
public: // operations
    void Flush(void) override;
 
    size_t Seek(size_t offset, SeekOrigin origin) override;
 
    size_t Read(byte* pBuffer, size_t bufferSize, size_t offset, size_t count) override;
 
    void Write(const byte* pBuffer, size_t bufferSize, size_t offset, size_t count) override;
 
protected: // operations
    void InternalDispose(void) override;
 
private: // methods
    void InternalConstructor(const String& path, FileMode mode, FileAccess access);
    void InternalConstructor(const String& path, FileMode mode, FileAccess access, bool sync);
 
private: // fields
    // flags storing internal status bits
    boolean canRead = false;
    boolean canWrite = false;
    boolean canSeek = false;
    // containing path and filename including extension
    String pathName;
    // native FileStream object providing system dependent part of implementation
    IFileService* pFileService = nullptr;
};
 
// inline methods of class FileStream
 
inline FileStream::FileStream(const String& path, FileMode mode)
{
    this->InternalConstructor(path, mode, FileAccess::ReadWrite);
}
 
inline FileStream::FileStream(const String& path, FileMode mode, FileAccess access)
{
    this->InternalConstructor(path, mode, access);
}
 
inline FileStream::FileStream(const String& path, FileMode mode, FileAccess access, bool sync)
{
    this->InternalConstructor(path, mode, access, sync);
}
 
}}}} // end of namespace Arp::System::Commons::Io