PackagePath.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "Containers/ContainersFwd.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Internationalization/Text.h"
#include "Templates/UniquePtr.h"
#include "UObject/NameTypes.h"
 
#ifndef UE_SUPPORT_FULL_PACKAGEPATH
    #define UE_SUPPORT_FULL_PACKAGEPATH WITH_EDITOR
#endif
 
class FArchive;
 
enum class EPackageSegment : uint8;
 
enum class EPackageExtension : uint8
{
    // Header Segments
    Unspecified=0,
    Asset,
    Map,
    TextAsset,
    TextMap,
    Custom,
    EmptyString,
                    
    // Other Segments
 
    Exports,
    BulkDataDefault,
    BulkDataOptional,
    BulkDataMemoryMapped,
    PayloadSidecar,
    Count,
};
inline constexpr int EPackageExtensionCount = static_cast<int>(EPackageExtension::PayloadSidecar) + 1;
COREUOBJECT_API const TCHAR* LexToString(EPackageExtension PackageExtension);
 
 
class FPackagePath
{
public:
    // Public API
 
    constexpr FPackagePath() = default;
 
    // Copy/Move constructors/assignment
 
    COREUOBJECT_API FPackagePath(const FPackagePath& Other);
    FPackagePath(FPackagePath&& Other) = default;
    COREUOBJECT_API FPackagePath& operator=(const FPackagePath& Other);
    FPackagePath& operator=(FPackagePath&& Other) = default;
 
    COREUOBJECT_API void Empty();
 
    COREUOBJECT_API static bool TryFromMountedName(FStringView InPackageNameOrHeaderFilePath, FPackagePath& OutPackagePath);
 
    COREUOBJECT_API static bool TryFromPackageName(FStringView InPackageName, FPackagePath& OutPackagePath);
    COREUOBJECT_API static bool TryFromPackageName(FName InPackageName, FPackagePath& OutPackagePath);
    COREUOBJECT_API static bool TryFromPackageName(const TCHAR* InPackageName, FPackagePath& OutPackagePath);
 
    COREUOBJECT_API static FPackagePath FromPackageNameChecked(FStringView InPackageName);
    COREUOBJECT_API static FPackagePath FromPackageNameChecked(FName InPackageName);
    COREUOBJECT_API static FPackagePath FromPackageNameChecked(const TCHAR* InPackageName);
 
    COREUOBJECT_API static FPackagePath FromPackageNameUnchecked(FName InPackageName);
 
    COREUOBJECT_API static FPackagePath FromLocalPath(FStringView InFilename);
 
    COREUOBJECT_API static FPackagePath FromMountedComponents(FStringView PackageNameRoot, FStringView FilePathRoot, FStringView RelPath,
        EPackageExtension InExtension, FStringView InCustomExtension = FStringView());
 
    COREUOBJECT_API static bool TryMatchCase(const FPackagePath& SourcePackagePath, FStringView FilePathToMatch,
        FPackagePath& OutPackagePath);
 
    // Comparsion operators. An FPackagePath is == another FPackagePath if they are known describe the same path;
    // the comparison is case insensitive, and if one PackagePath is a not-yet-mounted
    // PackageName and the other is a not-yet-mounted LocalPath, they are attempted to be mounted and will be equal
    // if they correspond to the same relative path under the same mount point
 
    COREUOBJECT_API bool operator==(const FPackagePath& Other) const;
    COREUOBJECT_API bool operator!=(const FPackagePath& Other) const;
 
    friend COREUOBJECT_API FArchive& operator<<(FArchive& Ar, FPackagePath& PackagePath);
 
    COREUOBJECT_API bool IsEmpty() const;
 
    COREUOBJECT_API bool IsMountedPath() const;
 
    COREUOBJECT_API bool HasPackageName() const;
 
    COREUOBJECT_API bool HasLocalPath() const;
 
    COREUOBJECT_API FString GetPackageName() const;
 
    COREUOBJECT_API void AppendPackageName(FStringBuilderBase& Builder) const;
 
    COREUOBJECT_API FName GetPackageFName() const;
 
    COREUOBJECT_API FString GetLocalFullPath() const;
 
    COREUOBJECT_API void AppendLocalFullPath(FStringBuilderBase& Builder) const;
 
    COREUOBJECT_API FString GetLocalBaseFilenameWithPath() const;
 
    COREUOBJECT_API void AppendLocalBaseFilenameWithPath(FStringBuilderBase& Builder) const;
 
    COREUOBJECT_API EPackageExtension GetHeaderExtension() const;
 
    COREUOBJECT_API FString GetDebugName() const;
 
    COREUOBJECT_API FText GetDebugNameText() const;
 
    COREUOBJECT_API FString GetDebugNameWithExtension() const;
 
    COREUOBJECT_API FString GetPackageNameOrFallback() const;
 
    COREUOBJECT_API void SetHeaderExtension(EPackageExtension Extension, FStringView CustomExtension = FStringView()) const;
 
    COREUOBJECT_API FStringView GetCustomExtension() const;
 
    COREUOBJECT_API static EPackageExtension ParseExtension(FStringView Filename, int32* OutExtensionStart = nullptr);
 
    COREUOBJECT_API static const TCHAR* GetOptionalSegmentExtensionModifier();
 
    COREUOBJECT_API static const TCHAR* GetExternalActorsFolderName();
 
    COREUOBJECT_API static const TCHAR* GetExternalObjectsFolderName();
 
public:
    // Internal API used by low-level PackageResourceManager users
 
    COREUOBJECT_API EPackageExtension GetExtension(EPackageSegment PackageSegment, FStringView& OutCustomExtension) const;
 
    COREUOBJECT_API FStringView GetExtensionString(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API TConstArrayView<EPackageExtension> GetPossibleExtensions(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API FString GetLocalFullPath(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API void AppendLocalFullPath(FStringBuilderBase& Builder, EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API FString GetDebugName(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API FText GetDebugNameText(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API FString GetDebugNameWithExtension(EPackageSegment PackageSegment) const;
 
    COREUOBJECT_API static FPackagePath FromLocalPath(FStringView InFilename, EPackageSegment& OutPackageSegment);
 
private:
    // Accessors for the StringData stored in this PackagePath; the various strings are packed together
    // into a single allocation
    FStringView GetPackageNameRoot() const;
    FStringView GetFilePathRoot() const;
    FStringView GetPathData() const;
    // GetCustomExtension is also an accessor, but unlike the others is publically readable
    void SetStringData(FStringView PathData, FStringView PackageNameRoot, FStringView FilePathRoot,
        FStringView CustomExtension) const;
    int32 GetStringDataLen() const;
 
    bool TryConvertToMounted() const;
 
    enum class EPackageIdType : uint8
    {
        Empty,
        MountedPath,
        PackageOnlyPath,
        LocalOnlyPath,
    };
 
#if UE_SUPPORT_FULL_PACKAGEPATH
    mutable TUniquePtr<TCHAR[]> StringData = nullptr;
    mutable uint16 PathDataLen = 0;
    mutable uint16 PackageNameRootLen = 0;
    mutable uint16 FilePathRootLen = 0;
    mutable uint16 ExtensionLen = 0;
    mutable EPackageIdType IdType = EPackageIdType::Empty;
    mutable EPackageExtension HeaderExtension = EPackageExtension::Unspecified;
#else
    FName PackageName;
    mutable EPackageExtension HeaderExtension = EPackageExtension::Unspecified;
#endif //UE_SUPPORT_FULL_PACKAGEPATH
};