ArchiveUtils.h

#pragma once
 
#include <Foundation/IO/Archive/Archive.h>
#include <Foundation/Types/Delegate.h>
#include <Foundation/Types/UniquePtr.h>
 
class plStreamReader;
class plStreamWriter;
class plMemoryMappedFile;
class plArchiveTOC;
class plArchiveEntry;
class plRawMemoryStreamReader;
 
namespace plArchiveUtils
{
  using FileWriteProgressCallback = plDelegate<bool(plUInt64, plUInt64)>;
  constexpr plUInt32 ArchiveHeaderSize = 16;
  constexpr plUInt32 ArchiveTOCMetaMaxFooterSize = 14 + 12; //< note that it's the MAX size, i.e. toc meta can be smaller
 
  struct TOCMeta
  {
    plUInt32 m_uiTocSize = 0;
    plUInt64 m_uiExpectedTocHash = 0;
    plUInt32 m_uiTocOffsetFromArchiveEnd = 0;
  };
 
  PL_FOUNDATION_DLL plHybridArray<plString, 4, plStaticsAllocatorWrapper>& GetAcceptedArchiveFileExtensions();
 
  PL_FOUNDATION_DLL bool IsAcceptedArchiveFileExtensions(plStringView sExtension);
 
  PL_FOUNDATION_DLL plResult WriteHeader(plStreamWriter& inout_stream);
 
  PL_FOUNDATION_DLL plResult ReadHeader(plStreamReader& inout_stream, plUInt8& out_uiVersion);
 
  PL_FOUNDATION_DLL plResult AppendTOC(plStreamWriter& inout_stream, const plArchiveTOC& toc);
 
  PL_FOUNDATION_DLL plResult ExtractTOCMeta(plUInt64 uiArchiveEndingDataSize, const void* pArchiveEndingDataBuffer, TOCMeta& ref_tocMeta, plUInt8 uiArchiveVersion);
 
  PL_FOUNDATION_DLL plResult ExtractTOCMeta(const plMemoryMappedFile& memFile, TOCMeta& ref_tocMeta, plUInt8 uiArchiveVersion);
 
  PL_FOUNDATION_DLL plResult ExtractTOC(plUInt64 uiArchiveEndingDataSize, const void* pArchiveEndingDataBuffer, plArchiveTOC& ref_toc, plUInt8 uiArchiveVersion);
 
  PL_FOUNDATION_DLL plResult ExtractTOC(const plMemoryMappedFile& memFile, plArchiveTOC& ref_toc, plUInt8 uiArchiveVersion);
 
  PL_FOUNDATION_DLL plResult WriteEntry(plStreamWriter& inout_stream, plStringView sAbsSourcePath, plUInt32 uiPathStringOffset,
    plArchiveCompressionMode compression, plInt32 iCompressionLevel, plArchiveEntry& ref_tocEntry, plUInt64& inout_uiCurrentStreamPosition,
    FileWriteProgressCallback progress = FileWriteProgressCallback());
 
  PL_FOUNDATION_DLL plResult WriteEntryPreprocessed(plStreamWriter& inout_stream, plConstByteArrayPtr entryData, plUInt32 uiPathStringOffset,
    plArchiveCompressionMode compression, plUInt32 uiUncompressedEntryDataSize, plArchiveEntry& ref_tocEntry, plUInt64& inout_uiCurrentStreamPosition);
 
  PL_FOUNDATION_DLL plResult WriteEntryOptimal(plStreamWriter& inout_stream, plStringView sAbsSourcePath, plUInt32 uiPathStringOffset,
    plArchiveCompressionMode compression, plInt32 iCompressionLevel, plArchiveEntry& ref_tocEntry, plUInt64& inout_uiCurrentStreamPosition,
    FileWriteProgressCallback progress = FileWriteProgressCallback());
 
  PL_FOUNDATION_DLL void ConfigureRawMemoryStreamReader(
    const plArchiveEntry& entry, const void* pStartOfArchiveData, plRawMemoryStreamReader& ref_memReader);
 
  PL_FOUNDATION_DLL plUniquePtr<plStreamReader> CreateEntryReader(const plArchiveEntry& entry, const void* pStartOfArchiveData);
 
  PL_FOUNDATION_DLL plResult ReadZipHeader(plStreamReader& inout_stream, plUInt8& out_uiVersion);
  PL_FOUNDATION_DLL plResult ExtractZipTOC(const plMemoryMappedFile& memFile, plArchiveTOC& ref_toc);
 
 
} // namespace plArchiveUtils