Stream.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Commons/Io/SeekOrigin.hpp"
 
namespace Arp::Base::Commons::Io
{
 
// forwards
class NullStream;
 
class ARP_EXPORT Stream
{
public: // Impl forward declaration
    class Impl;
 
public: // construction
    Stream(bool canRead = false, bool canWrite = false, bool canSeek = false);
 
    // canonical construction/destruction/assignment
    Stream(const Stream& arg);
    Stream(Stream&& arg)noexcept;
    Stream& operator=(const Stream& arg);
    Stream& operator=(Stream&& arg)noexcept;
    virtual ~Stream(void);
 
public: // static operations
    static Stream&  GetEmpty(void);
 
public: // abstract setter/getter operations
    virtual bool    CanRead(void);
    virtual bool    CanWrite(void);
    virtual bool    CanSeek(void);
    virtual void    SetPosition(size_t value);
    virtual size_t  GetPosition(void);
 
public: // abstract operations
    virtual size_t  Seek(size_t offset, SeekOrigin origin) = 0;
    virtual size_t  Read(byte* pBuffer, size_t bufferSize, size_t bufferOffset, size_t count) = 0;
    virtual void    Write(const byte* pBuffer, size_t bufferSize, size_t bufferOffset, size_t count) = 0;
    virtual void    Flush(void) = 0;
 
public: // virtual operations
    virtual byte    ReadByte(void);
    virtual void    WriteByte(byte value);
    virtual void    WriteTo(Stream& other);
    virtual void    ReadFrom(Stream& other);
 
private: // internal operations
    Impl&           GetImpl(void);
    const Impl&     GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Base::Commons::Io