ChunkStream.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Containers/Deque.h>
#include <Foundation/IO/Stream.h>
 
class PL_FOUNDATION_DLL plChunkStreamWriter : public plStreamWriter
{
public:
  plChunkStreamWriter(plStreamWriter& inout_stream); // [tested]
 
  virtual plResult WriteBytes(const void* pWriteBuffer, plUInt64 uiBytesToWrite) override; // [tested]
 
  virtual void BeginStream(plUInt16 uiVersion); // [tested]
 
  virtual void EndStream(); // [tested]
 
  virtual void BeginChunk(plStringView sName, plUInt32 uiVersion); // [tested]
 
  virtual void EndChunk(); // [tested]
 
 
private:
  bool m_bWritingFile;
  bool m_bWritingChunk;
  plString m_sChunkName;
  plDeque<plUInt8> m_Storage;
  plStreamWriter& m_Stream;
};
 
 
class PL_FOUNDATION_DLL plChunkStreamReader : public plStreamReader
{
public:
  plChunkStreamReader(plStreamReader& inout_stream); // [tested]
 
  virtual plUInt64 ReadBytes(void* pReadBuffer, plUInt64 uiBytesToRead) override; // [tested]
 
  enum class EndChunkFileMode
  {
    SkipToEnd,                                                                   
    JustClose                                                                    
  };
 
  void SetEndChunkFileMode(EndChunkFileMode mode) { m_EndChunkFileMode = mode; } // [tested]
 
  virtual plUInt16 BeginStream(); // [tested]
 
  virtual void EndStream(); // [tested]
 
  struct ChunkInfo
  {
    ChunkInfo()
    {
      m_bValid = false;
      m_uiChunkVersion = 0;
      m_uiChunkBytes = 0;
      m_uiUnreadChunkBytes = 0;
    }
 
    bool m_bValid;                 
    plString m_sChunkName;         
    plUInt32 m_uiChunkVersion;     
    plUInt32 m_uiChunkBytes;       
    plUInt32 m_uiUnreadChunkBytes; 
  };
 
  const ChunkInfo& GetCurrentChunk() const { return m_ChunkInfo; } // [tested]
 
  void NextChunk(); // [tested]
 
private:
  void TryReadChunkHeader();
 
  EndChunkFileMode m_EndChunkFileMode;
  ChunkInfo m_ChunkInfo;
 
  plStreamReader& m_Stream;
};