PackageReader.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/EnumClassFlags.h"
#include "Serialization/ArchiveUObject.h"
#include "UObject/ObjectResource.h"
#include "UObject/PackageFileSummary.h"
#include "UObject/SoftObjectPath.h"
 
struct FAssetData;
class FAssetPackageData;
class FLinkerTables;
class FPackageDependencyData;
namespace UE::AssetRegistry { enum class EExtraDependencyFlags : uint32; }
struct FGatherableTextData;
struct FObjectFullNameAndThumbnail;
 
class FPackageReader : public FArchiveUObject
{
public:
    ASSETREGISTRY_API FPackageReader();
    ASSETREGISTRY_API ~FPackageReader();
 
    // Note: Keep up to date with LexToString implementation
    enum class EOpenPackageResult : uint8
    {
        Success,
        NoLoader,
        MalformedTag,
        VersionTooOld,
        VersionTooNew,
        CustomVersionMissing,
        CustomVersionInvalid,
        Unversioned,
    };
 
    struct FObjectData
    {
        FSoftObjectPath ClassPath;
        bool bUsedInGame = true;
    };
 
    ASSETREGISTRY_API bool OpenPackageFile(FStringView PackageFilename, EOpenPackageResult* OutErrorCode = nullptr);
    ASSETREGISTRY_API bool OpenPackageFile(FStringView LongPackageName, FStringView PackageFilename,
        EOpenPackageResult* OutErrorCode = nullptr);
    ASSETREGISTRY_API bool OpenPackageFile(FArchive* Loader, FStringView LongPackageName = FStringView(), 
        EOpenPackageResult* OutErrorCode = nullptr);
    ASSETREGISTRY_API bool OpenPackageFile(TUniquePtr<FArchive> Loader, EOpenPackageResult* OutErrorCode = nullptr);
    ASSETREGISTRY_API bool OpenPackageFile(EOpenPackageResult& OutErrorCode);
 
    ASSETREGISTRY_API bool TryGetLongPackageName(FString& OutLongPackageName) const;
    ASSETREGISTRY_API FString GetLongPackageName() const;
 
    ASSETREGISTRY_API const FPackageFileSummary& GetPackageFileSummary() const;
    ASSETREGISTRY_API bool GetNames(TArray<FName>& OutNames);
    ASSETREGISTRY_API bool GetImports(TArray<FObjectImport>& OutImportMap);
    ASSETREGISTRY_API bool GetExports(TArray<FObjectExport>& OutExportMap);
    ASSETREGISTRY_API bool GetDependsMap(TArray<TArray<FPackageIndex>>& OutDependsMap);
    ASSETREGISTRY_API bool GetSoftPackageReferenceList(TArray<FName>& OutSoftPackageReferenceList);
    ASSETREGISTRY_API bool GetSoftObjectPaths(TArray<FSoftObjectPath>& OutSoftObjectPaths);
    ASSETREGISTRY_API bool ReadEditorOnlyFlags(TBitArray<>& OutImportUsedInGame, TBitArray<>& OutSoftPackageUsedInGame);
    ASSETREGISTRY_API bool GetGatherableTextData(TArray<FGatherableTextData>& OutText);
    ASSETREGISTRY_API bool GetThumbnails(TArray<FObjectFullNameAndThumbnail>& OutThumbnails);
 
    ASSETREGISTRY_API bool ReadAssetRegistryData(TArray<FAssetData*>& AssetDataList, bool& bOutIsCookedWithoutAssetData);
 
    ASSETREGISTRY_API bool ReadImportedClasses(TArray<FName>& OutClassNames);
 
    ASSETREGISTRY_API bool ReadLinkerObjects(TMap<FSoftObjectPath, FObjectData>& OutExports,
        TMap<FSoftObjectPath, FObjectData>& OutImports, TMap<FName, bool>& OutSoftPackageReferences);
 
    enum class EReadOptions
    {
        None = 0,
        PackageData = 1 << 0,
        Dependencies = 1 << 1,
        Default = PackageData | Dependencies,
    };
    ASSETREGISTRY_API bool ReadDependencyData(FPackageDependencyData& OutDependencyData, EReadOptions Options);
 
    // Farchive implementation to redirect requests to the Loader
    ASSETREGISTRY_API virtual void Serialize( void* V, int64 Length ) override;
    ASSETREGISTRY_API virtual bool Precache( int64 PrecacheOffset, int64 PrecacheSize ) override;
    ASSETREGISTRY_API virtual void Seek( int64 InPos ) override;
    ASSETREGISTRY_API virtual int64 Tell() override;
    ASSETREGISTRY_API virtual int64 TotalSize() override;
    ASSETREGISTRY_API virtual FArchive& operator<<( FName& Name ) override;
    virtual FString GetArchiveName() const override
    {
        return PackageFilename;
    }
 
private:
    bool ReadAssetDataFromThumbnailCache(TArray<FAssetData*>& AssetDataList);
    bool ReadAssetRegistryDataFromCookedPackage(TArray<FAssetData*>& AssetDataList, bool& bOutIsCookedWithoutAssetData);
    bool StartSerializeSection(int64 Offset);
 
    bool SerializeNameMap();
    bool SerializeImportMap();
    bool SerializeExportMap();
    bool SerializeDependsMap();
    bool SerializeImportedClasses(const TArray<FObjectImport>& InImportMap, TArray<FName>& OutClassNames);
    bool SerializeSoftPackageReferenceList();
    bool SerializeSoftObjectPathMap();
    bool SerializeGatherableTextDataMap();
    bool SerializeThumbnailMap();
    bool SerializeEditorOnlyFlags(TBitArray<>& OutImportUsedInGame, TBitArray<>& OutSoftPackageUsedInGame);
    bool SerializeSearchableNamesMap(FLinkerTables& OutSearchableNames);
    bool SerializeAssetRegistryDependencyData(TBitArray<>& OutImportUsedInGame, TBitArray<>& OutSoftPackageUsedInGame,
        TArray<TPair<FName, UE::AssetRegistry::EExtraDependencyFlags>>& OutExtraPackageDependencies);
    bool SerializePackageTrailer(FAssetPackageData& PackageData);
 
    void ApplyRelocationToImportMapAndSoftPackageReferenceList(FStringView LoadedPackageName,
        TArray<FName>& InOutSoftPackageReferenceList, 
        TArray<TPair<FName, UE::AssetRegistry::EExtraDependencyFlags>>& InOutExtraPackageDependencies);
    static void ConvertLinkerTableToPaths(FName PackageName, TArray<FObjectExport>& ExportMap,
        TArray<FObjectImport>& ImportMap, TArray<FSoftObjectPath>& OutExports, TArray<FSoftObjectPath>& OutImports);
 
    uint32 GetPackageFlags() const;
 
    FString LongPackageName;
    FString PackageFilename;
    /*
     * Loader is the interface used to read the bytes from the package's repository. All interpretation of the bytes is
     * done by serializing into *this, which is also an FArchive.
     */
    FArchive* Loader = nullptr;
    FPackageFileSummary PackageFileSummary;
    TArray<FName> NameMap;
    TArray<FObjectImport> ImportMap;
    TArray<FObjectExport> ExportMap;
    TArray<TArray<FPackageIndex>> DependsMap;
    TArray<FName> SoftPackageReferenceList;
    TArray<FSoftObjectPath> SoftObjectPathMap;
    TArray<FGatherableTextData> GatherableTextDataMap;
    TArray<FObjectFullNameAndThumbnail> ThumbnailMap;
    int64 PackageFileSize = 0;
    int64 AssetRegistryDependencyDataOffset = INDEX_NONE;
    // Defined as uint32 to avoid including AssetData.h in this header
    uint32 AssetRegistryVersion = static_cast<uint32>(~0);
    bool bLoaderOwner = false;
};
ENUM_CLASS_FLAGS(FPackageReader::EReadOptions);
 
ASSETREGISTRY_API const TCHAR* LexToString(FPackageReader::EOpenPackageResult Result);