PackageWriterToSharedBuffer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "HAL/CriticalSection.h"
#include "Memory/SharedBuffer.h"
#include "Misc/AssertionMacros.h"
#include "Serialization/BasePackageWriter.h"
#include "Templates/UniquePtr.h"
 
class FPackageWriterRecords
{
public:
    struct FPackage;
 
    COREUOBJECT_API void BeginPackage(FPackage* Record, const IPackageWriter::FBeginPackageInfo& Info);
    COREUOBJECT_API void WritePackageData(const IPackageWriter::FPackageInfo& Info, FLargeMemoryWriter& ExportsArchive,
        const TArray<FFileRegion>& FileRegions);
    COREUOBJECT_API void WriteBulkData(const IPackageWriter::FBulkDataInfo& Info, const FIoBuffer& BulkData,
        const TArray<FFileRegion>& FileRegions);
    COREUOBJECT_API void WriteAdditionalFile(const IPackageWriter::FAdditionalFileInfo& Info,
        const FIoBuffer& FileData);
    COREUOBJECT_API void WriteLinkerAdditionalData(const IPackageWriter::FLinkerAdditionalDataInfo& Info,
        const FIoBuffer& Data, const TArray<FFileRegion>& FileRegions);
    COREUOBJECT_API void WritePackageTrailer(const IPackageWriter::FPackageTrailerInfo& Info, const FIoBuffer& Data);
 
    struct FWritePackage
    {
        IPackageWriter::FPackageInfo Info;
        FSharedBuffer Buffer;
        TArray<FFileRegion> Regions;
    };
    struct FBulkData
    {
        IPackageWriter::FBulkDataInfo Info;
        FSharedBuffer Buffer;
        TArray<FFileRegion> Regions;
    };
    struct FAdditionalFile
    {
        IPackageWriter::FAdditionalFileInfo Info;
        FSharedBuffer Buffer;
    };
    struct FLinkerAdditionalData
    {
        IPackageWriter::FLinkerAdditionalDataInfo Info;
        FSharedBuffer Buffer;
        TArray<FFileRegion> Regions;
    };
    struct FPackageTrailer
    {
        IPackageWriter::FPackageTrailerInfo Info;
        FSharedBuffer Buffer;
    };
    struct FPackage
    {
        virtual ~FPackage()
        {
        }
 
        IPackageWriter::FBeginPackageInfo Begin;
        TArray<FWritePackage> Packages;
        TArray<FBulkData> BulkDatas;
        TArray<FAdditionalFile> AdditionalFiles;
        TArray<FLinkerAdditionalData> LinkerAdditionalDatas;
        TArray<FPackageTrailer> PackageTrailers;
    };
 
    COREUOBJECT_API FPackage& FindRecordChecked(FName InPackageName) const;
    COREUOBJECT_API TUniquePtr<FPackage> FindAndRemoveRecordChecked(FName InPackageName);
    COREUOBJECT_API void ValidateCommit(FPackage& Record, const IPackageWriter::FCommitPackageInfo& Info) const;
    
private:
    mutable FRWLock MapLock;
    TMap<FName, TUniquePtr<FPackage>> Map;
};
 
template <typename BaseClass>
class TPackageWriterToSharedBuffer : public BaseClass
{
public:
    using FWritePackageRecord = FPackageWriterRecords::FWritePackage;
    using FBulkDataRecord = FPackageWriterRecords::FBulkData;
    using FAdditionalFileRecord = FPackageWriterRecords::FAdditionalFile;
    using FLinkerAdditionalDataRecord = FPackageWriterRecords::FLinkerAdditionalData;
    using FPackageTrailerRecord = FPackageWriterRecords::FPackageTrailer;
    using FPackageRecord = FPackageWriterRecords::FPackage;
 
    virtual void BeginPackage(const IPackageWriter::FBeginPackageInfo& Info) override
    {
        Records.BeginPackage(ConstructRecord(), Info);
    }
    virtual void WritePackageData(const IPackageWriter::FPackageInfo& Info, FLargeMemoryWriter& ExportsArchive,
        const TArray<FFileRegion>& FileRegions) override
    {
        Records.WritePackageData(Info, ExportsArchive, FileRegions);
    }
    virtual void WriteBulkData(const IPackageWriter::FBulkDataInfo& Info, const FIoBuffer& BulkData,
        const TArray<FFileRegion>& FileRegions) override
    {
        Records.WriteBulkData(Info, BulkData, FileRegions);
    }
    virtual void WriteAdditionalFile(const IPackageWriter::FAdditionalFileInfo& Info,
        const FIoBuffer& FileData) override
    {
        Records.WriteAdditionalFile(Info, FileData);
    }
    virtual void WriteLinkerAdditionalData(const IPackageWriter::FLinkerAdditionalDataInfo& Info,
        const FIoBuffer& Data, const TArray<FFileRegion>& FileRegions) override
    {
        Records.WriteLinkerAdditionalData(Info, Data, FileRegions);
    }
    virtual void WritePackageTrailer(const IPackageWriter::FPackageTrailerInfo& Info, const FIoBuffer& Data) override
    {
        Records.WritePackageTrailer(Info, Data);
    }
    virtual void CommitPackage(IPackageWriter::FCommitPackageInfo&& Info) override
    {
        TUniquePtr<FPackageRecord> Record = Records.FindAndRemoveRecordChecked(Info.PackageName);
        ValidateCommit(*Record, Info);
        CommitPackageInternal(MoveTemp(*Record), Info);
    }
 
protected:
    virtual void CommitPackageInternal(FPackageRecord&& Record,
        const IPackageWriter::FCommitPackageInfo& Info) = 0;
 
protected:
    virtual FPackageWriterRecords::FPackage* ConstructRecord()
    {
        return new FPackageWriterRecords::FPackage();
    }
 
    FPackageRecord& FindRecordChecked(FName InPackageName)
    {
        return Records.FindRecordChecked(InPackageName);
    }
    void ValidateCommit(FPackageRecord& Record, const IPackageWriter::FCommitPackageInfo& Info)
    {
        Records.ValidateCommit(Record, Info);
    }
 
    FPackageWriterRecords Records;
};
 
class FPackageWriterToRecord : public TPackageWriterToSharedBuffer<FBasePackageWriter>
{
public:
    FPackageWriterRecords::FPackage SavedRecord;
 
protected:
    virtual void CommitPackageInternal(FPackageWriterRecords::FPackage&& Record,
        const FCommitPackageInfo& Info) override
    {
        SavedRecord = MoveTemp(Record);
    }
};