src/stream/ZStream.h

/*  @(#) $Id: ZStream.h,v 1.32 2006/07/23 21:58:20 agreen Exp $ */

/* ------------------------------------------------------------
Copyright (c) 2000 Andrew Green and Learning in Motion, Inc.
http://www.zoolib.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------ */

#ifndef __ZStream__
#define __ZStream__ 1
#include "zconfig.h"

#include "ZTypes.h"
#include <stdexcept> // For std::range_error
#include <string>

class ZStreamR;
class ZStreamW;

void sCopyReadToWrite(const ZStreamR& iStreamR, const ZStreamW& iStreamW, uint64 iCount,
                                                uint64* oCountRead, uint64* oCountWritten);

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamR


class ZStreamR
        {
protected:      //@{
        ZStreamR() {}
        ~ZStreamR() {}
        ZStreamR(const ZStreamR&) {}
        ZStreamR& operator=(const ZStreamR&) { return *this; }

public:
        class ExEndOfStream;
        static void sThrowEndOfStream();
        //@{
        void Read(void* iDest, size_t iCount) const;
        void Read(void* iDest, size_t iCount, size_t* oCountRead) const;

        //@{
        void CopyAllTo(const ZStreamW& iStreamW) const;
        void CopyAllTo(const ZStreamW& iStreamW, uint64* oCountRead, uint64* oCountWritten) const;

        void CopyTo(const ZStreamW& iStreamW, uint64 iCount) const;
        void CopyTo(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten) const;

        //@{
        void Skip(uint64 iCount) const;
        void Skip(uint64 iCount, uint64* oCountSkipped) const;
        void SkipAll() const;
        void SkipAll(uint64* oCountSkipped) const;

        //@{
        int8 ReadInt8() const;
        int16 ReadInt16() const;
        int32 ReadInt32() const;
        int64 ReadInt64() const;
        float ReadFloat() const;
        double ReadDouble() const;

        int16 ReadInt16LE() const;
        int32 ReadInt32LE() const;
        int64 ReadInt64LE() const;
        float ReadFloatLE() const;
        double ReadDoubleLE() const;

        bool ReadBool() const;

        uint8 ReadUInt8() const { return uint8(this->ReadInt8()); }
        uint16 ReadUInt16() const { return uint16(this->ReadInt16()); }
        uint32 ReadUInt32() const { return uint32(this->ReadInt32()); }
        uint64 ReadUInt64() const { return uint64(this->ReadInt64()); }

        uint16 ReadUInt16LE() const { return uint16(this->ReadInt16LE()); }
        uint32 ReadUInt32LE() const { return uint32(this->ReadInt32LE()); }
        uint64 ReadUInt64LE() const { return uint64(this->ReadInt64LE()); }

        //@{
        bool ReadByte(uint8& oResult) const;
        bool ReadChar(char& oResult) const;

        //@{
        std::string ReadString(size_t iSize) const;
        bool ReadString(size_t iSize, std::string& oString) const;

        //@{
        size_t CountReadable() const;

        //@{
        virtual void Imp_Read(void* iDest, size_t iCount, size_t* oCountRead) = 0;

        //@{
        virtual size_t Imp_CountReadable();

        virtual void Imp_CopyToDispatch(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyTo(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_Skip(uint64 iCount, uint64* oCountSkipped);

protected:
        static uint64 sDiffPosR(uint64 iSize, uint64 iPos)
                { return iSize > iPos ? iSize - iPos : 0; }

        static size_t sClampedR(uint64 iCount)
                {
                if (sizeof(size_t) < sizeof(uint64))
                        return size_t(std::min(iCount, uint64(size_t(-1))));
                else
                        return iCount;
                }
        };

inline void ZStreamR::Read(void* iDest, size_t iCount, size_t* oCountRead) const
        { const_cast<ZStreamR*>(this)->Imp_Read(iDest, iCount, oCountRead); }

inline void ZStreamR::Skip(uint64 iCount, uint64* oCountSkipped) const
        { const_cast<ZStreamR*>(this)->Imp_Skip(iCount, oCountSkipped); }

inline void ZStreamR::SkipAll() const
        { this->SkipAll(nil); }

inline size_t ZStreamR::CountReadable() const
        { return const_cast<ZStreamR*>(this)->Imp_CountReadable(); }

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamR::ExEndOfStream

class ZStreamR::ExEndOfStream : public std::range_error
        {
public:
        ExEndOfStream();
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamU


class ZStreamU : public ZStreamR
        {
public:
        void Unread() const;

        virtual void Imp_Unread() = 0;
        };

inline void ZStreamU::Unread() const
        { const_cast<ZStreamU*>(this)->Imp_Unread(); }

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamRPos


class ZStreamRPos : public ZStreamU
        {
public:
        ZStreamRPos();
        //@{
        virtual size_t Imp_CountReadable();
        virtual void Imp_Skip(uint64 iCount, uint64* oCountSkipped);

        //@{
        virtual void Imp_Unread();

        //@{
        uint64 GetPosition() const;
        void SetPosition(uint64 iPosition) const;

        uint64 GetSize() const;

        //@{
        virtual uint64 Imp_GetPosition() = 0;
        virtual void Imp_SetPosition(uint64 iPosition) = 0;

        virtual uint64 Imp_GetSize() = 0;
        };

inline uint64 ZStreamRPos::GetPosition() const
        { return const_cast<ZStreamRPos*>(this)->Imp_GetPosition(); }

inline void ZStreamRPos::SetPosition(uint64 iPosition) const
        { const_cast<ZStreamRPos*>(this)->Imp_SetPosition(iPosition); }

inline uint64 ZStreamRPos::GetSize() const
        { return const_cast<ZStreamRPos*>(this)->Imp_GetSize(); }

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamW


class ZStreamW
        {
protected:      //@{
        ZStreamW() {}
        ~ZStreamW() {}
        ZStreamW(const ZStreamW&) {}
        ZStreamW& operator=(const ZStreamW&) { return *this; }

public:
        class ExEndOfStream;
        static void sThrowEndOfStream();
        //@{
        void Write(const void* iSource, size_t iCount) const;
        void Write(const void* iSource, size_t iCount, size_t* oCountWritten) const;

        //@{
        void CopyAllFrom(const ZStreamR& iStreamR) const;
        void CopyAllFrom(const ZStreamR& iStreamR, uint64* oCountRead, uint64* oCountWritten) const;

        void CopyFrom(const ZStreamR& iStreamR, uint64 iCount) const;
        void CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten) const;

        //@{
        void WriteInt8(int8 iVal) const;
        void WriteInt16(int16 iVal) const;
        void WriteInt32(int32 iVal) const;
        void WriteInt64(int64 iVal) const;
        void WriteFloat(float iVal) const;
        void WriteDouble(double iVal) const;

        void WriteInt16LE(int16 iVal) const;
        void WriteInt32LE(int32 iVal) const;
        void WriteInt64LE(int64 iVal) const;
        void WriteFloatLE(float iVal) const;
        void WriteDoubleLE(double iVal) const;

        void WriteBool(bool iVal) const;

        void WriteUInt8(uint8 iVal) const { this->WriteInt8(int8(iVal)); }
        void WriteUInt16(uint16 iVal) const { this->WriteInt16(int16(iVal)); }
        void WriteUInt32(uint32 iVal) const { this->WriteInt32(int32(iVal)); }
        void WriteUInt64(uint64 iVal) const { this->WriteInt64(int64(iVal)); }

        void WriteUInt16LE(uint16 iVal) const { this->WriteInt16LE(int16(iVal)); }
        void WriteUInt32LE(uint32 iVal) const { this->WriteInt32LE(int32(iVal)); }
        void WriteUInt64LE(uint64 iVal) const { this->WriteInt64LE(int64(iVal)); }

        void WriteString(const char* iString) const;
        void WriteString(const std::string& iString) const;

        size_t Writef(const char* iString, ...) const;

        //@{
        bool WriteByte(uint8 iVal) const;

        //@{
        void Flush() const;

        //@{
        virtual void Imp_Write(const void* iSource, size_t iCount, size_t* oCountWritten) = 0;

        //@{
        virtual void Imp_CopyFromDispatch(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_Flush();

protected:
        static uint64 sDiffPosW(uint64 iSize, uint64 iPos)
                { return iSize > iPos ? iSize - iPos : 0; }
        static size_t sClampedW(uint64 iCount)
                {
                if (sizeof(size_t) < sizeof(uint64))
                        return size_t(std::min(iCount, uint64(size_t(-1))));
                else
                        return iCount;
                }
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamW::ExEndOfStream

class ZStreamW::ExEndOfStream : public std::range_error
        {
public:
        ExEndOfStream();
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamWPos


class ZStreamWPos : public ZStreamW
        {
public:
        class ExBadSize;
        static void sThrowBadSize();
        //@{
        uint64 GetPosition() const;
        void SetPosition(uint64 iPosition) const;

        uint64 GetSize() const;
        void SetSize(uint64 iSize) const;

        void Truncate() const;

        //@{
        virtual uint64 Imp_GetPosition() = 0;
        virtual void Imp_SetPosition(uint64 iPosition) = 0;

        virtual uint64 Imp_GetSize() = 0;
        virtual void Imp_SetSize(uint64 iSize) = 0;

        //@{
        virtual void Imp_Truncate();
        };

inline uint64 ZStreamWPos::GetPosition() const
        { return const_cast<ZStreamWPos*>(this)->Imp_GetPosition(); }

inline void ZStreamWPos::SetPosition(uint64 iPosition) const
        { const_cast<ZStreamWPos*>(this)->Imp_SetPosition(iPosition); }

inline uint64 ZStreamWPos::GetSize() const
        { return const_cast<ZStreamWPos*>(this)->Imp_GetSize(); }

inline void ZStreamWPos::SetSize(uint64 iSize) const
        { return const_cast<ZStreamWPos*>(this)->Imp_SetSize(iSize); }

inline void ZStreamWPos::Truncate() const
        { return const_cast<ZStreamWPos*>(this)->Imp_Truncate(); }

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamWPos::ExBadSize

class ZStreamWPos::ExBadSize : public std::range_error
        {
public:
        ExBadSize();
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamRWPos


class ZStreamRWPos : public ZStreamRPos, public ZStreamWPos
        {
protected:      //@{
        ZStreamRWPos() {}
        ~ZStreamRWPos() {}
        ZStreamRWPos(const ZStreamRWPos&) {}
        ZStreamRWPos& operator=(const ZStreamRWPos&) { return *this; }

public: //@{
        uint64 GetPosition() const;
        void SetPosition(uint64 iPosition) const;

        uint64 GetSize() const;

        virtual uint64 Imp_GetPosition() = 0;
        virtual void Imp_SetPosition(uint64 iPosition) = 0;

        virtual uint64 Imp_GetSize() = 0;

        //@{
        virtual void Imp_SetSize(uint64 iSize) = 0;
        };

inline uint64 ZStreamRWPos::GetPosition() const
        { return const_cast<ZStreamRWPos*>(this)->Imp_GetPosition(); }

inline void ZStreamRWPos::SetPosition(uint64 iPosition) const
        { const_cast<ZStreamRWPos*>(this)->Imp_SetPosition(iPosition); }

inline uint64 ZStreamRWPos::GetSize() const
        { return const_cast<ZStreamRWPos*>(this)->Imp_GetSize(); }

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamU_Unreader


class ZStreamU_Unreader : public ZStreamU
        {
public:
        ZStreamU_Unreader(const ZStreamR& iStreamSource);

// From ZStreamR
        virtual void Imp_Read(void* iDest, size_t iCount, size_t* oCountRead);

// From ZStreamU
        virtual void Imp_Unread();

private:
        const ZStreamR& fStreamSource;
        enum { eStateFresh, eStateNormal, eStateUnread, eStateHitEnd } fState;
        char fChar;
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamR_Null


class ZStreamR_Null : public ZStreamR
        {
public:
        ZStreamR_Null();
        ~ZStreamR_Null();

// From ZStreamR
        virtual void Imp_Read(void* iDest, size_t iCount, size_t* oCountRead);

        virtual void Imp_CopyToDispatch(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyTo(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_Skip(uint64 iCount, uint64* oCountSkipped);
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamRPos_Null


class ZStreamRPos_Null : public ZStreamRPos
        {
public:
        ZStreamRPos_Null();
        ~ZStreamRPos_Null();

// From ZStreamR via ZStreamRPos
        virtual void Imp_Read(void* iDest, size_t iCount, size_t* oCountRead);

        virtual void Imp_CopyToDispatch(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyTo(const ZStreamW& iStreamW, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_Skip(uint64 iCount, uint64* oCountSkipped);

// From ZStreamRPos
        virtual uint64 Imp_GetPosition();
        virtual void Imp_SetPosition(uint64 iPosition);

        virtual uint64 Imp_GetSize();

private:
        uint64 fPosition;
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamW_Null


class ZStreamW_Null : public ZStreamW
        {
public:
        ZStreamW_Null();
        ~ZStreamW_Null();

// From ZStreamW
        virtual void Imp_Write(const void* iSource, size_t iCount, size_t* oCountWritten);

        virtual void Imp_CopyFromDispatch(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

// Our protocol
        void Internal_CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStreamWPos_Null


class ZStreamWPos_Null : public ZStreamWPos
        {
public:
        ZStreamWPos_Null();
        ~ZStreamWPos_Null();

// From ZStreamW
        virtual void Imp_Write(const void* iSource, size_t iCount, size_t* oCountWritten);

        virtual void Imp_CopyFromDispatch(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

        virtual void Imp_CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

// From ZStreamWPos
        virtual uint64 Imp_GetPosition();
        virtual void Imp_SetPosition(uint64 iPosition);

        virtual uint64 Imp_GetSize();
        virtual void Imp_SetSize(uint64 iSize);

// Our protocol
        void Internal_CopyFrom(const ZStreamR& iStreamR, uint64 iCount,
                uint64* oCountRead, uint64* oCountWritten);

private:
        uint64 fPosition;
        uint64 fSize;
        };

#endif // __ZStream__

---