PackageName.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    PackageName.h: Unreal package name utility functions.
=============================================================================*/
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "Containers/VersePathFwd.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "HAL/PlatformMath.h"
#include "Internationalization/Text.h"
#include "Logging/LogMacros.h"
#include "Misc/PackagePath.h"
#include "Templates/Function.h"
#include "UObject/NameTypes.h"
 
class FPackagePath;
class UPackage;
struct FFileStatData;
struct FGuid;
struct FTopLevelAssetPath;
namespace UE::AssetRegistry::Impl { struct FScanPathContext; }
 
DECLARE_LOG_CATEGORY_EXTERN(LogPackageName, Log, All);
 
class FPackageName
{
public:
    enum class EFlexNameType
    {
        Invalid,
        PackageName,
        LocalPath,
        ObjectPath,
    };
    enum class EErrorCode
    {
        PackageNameUnknown,
        PackageNameEmptyPath,
        PackageNamePathNotMounted,
        PackageNamePathIsMemoryOnly,
        PackageNameSpacesNotAllowed,
        PackageNameContainsInvalidCharacters,
        LongPackageNames_PathTooShort,
        LongPackageNames_PathWithNoStartingSlash,
        LongPackageNames_PathWithTrailingSlash,
        LongPackageNames_PathWithDoubleSlash,
    };
 
    enum class EConvertFlags
    {
        None = 0,
        AllowDots = 0x1
    };
 
    static COREUOBJECT_API FString FormatErrorAsString(FStringView InPath, EErrorCode ErrorCode);
 
    static COREUOBJECT_API FText FormatErrorAsText(FStringView InPath, EErrorCode ErrorCode);
 
    static COREUOBJECT_API FString ConvertToLongScriptPackageName(const TCHAR* InShortName);
 
    static COREUOBJECT_API FName GetModuleScriptPackageName(FName ModuleName);
    static COREUOBJECT_API FString GetModuleScriptPackageName(FStringView ModuleName);
    static COREUOBJECT_API bool TryConvertScriptPackageNameToModuleName(FStringView PackageName, FStringView& OutModuleName);
 
    static COREUOBJECT_API void RegisterShortPackageNamesForUObjectModules();
 
    static COREUOBJECT_API FName* FindScriptPackageName(FName InShortName);
 
    static COREUOBJECT_API bool TryConvertFilenameToLongPackageName(const FString& InFilename, FString& OutPackageName,
        FString* OutFailureReason = nullptr, const EConvertFlags Flags = EConvertFlags::None);
    static COREUOBJECT_API bool TryConvertFilenameToLongPackageName(FStringView InFilename,
        FStringBuilderBase& OutPackageName, FStringBuilderBase* OutFailureReason = nullptr,
        const EConvertFlags Flags = EConvertFlags::None);
 
    static COREUOBJECT_API FString FilenameToLongPackageName(const FString& InFilename);
 
    static COREUOBJECT_API bool TryConvertLongPackageNameToFilename(const FString& InLongPackageName, FString& OutFilename, const FString& InExtension = TEXT(""));
    static COREUOBJECT_API bool TryConvertLongPackageNameToFilename(FStringView InLongPackageName, FString& OutFilename, FStringView InExtension = {});
 
    static COREUOBJECT_API bool TryConvertToMountedPath(FStringView InPath, FString* OutLocalPathNoExtension, FString* OutPackageName, FString* OutObjectName, FString* OutSubObjectName, FString* OutExtension, EFlexNameType* OutFlexNameType = nullptr, EErrorCode* OutFailureReason = nullptr);
 
    static COREUOBJECT_API FString LongPackageNameToFilename(const FString& InLongPackageName, const FString& InExtension = TEXT(""));
 
    static COREUOBJECT_API FString GetLongPackagePath(const FString& InLongPackageName);
 
    static COREUOBJECT_API FString GetLongPackageAssetName(const FString& InLongPackageName);
 
    static COREUOBJECT_API void SplitFullObjectPath(const FString& InFullObjectPath, FString& OutClassName,
        FString& OutPackageName, FString& OutObjectName, FString& OutSubObjectName, bool bDetectClassName = true);
    static COREUOBJECT_API void SplitFullObjectPath(FStringView InFullObjectPath, FStringView& OutClassName,
        FStringView& OutPackageName, FStringView& OutObjectName, FStringView& OutSubObjectName, bool bDetectClassName=true);
 
    static COREUOBJECT_API void SplitFullObjectPath(const FString& InFullObjectPath, FString& OutClassName,
        FString& OutPackageName, FString& OutObjectName, TArray<FString>& OutSubobjectNames, bool bDetectClassName = true);
    static COREUOBJECT_API void SplitFullObjectPath(FStringView InFullObjectPath, FStringView& OutClassName,
        FStringView& OutPackageName, FStringView& OutObjectName, TArray<FStringView>& OutSubobjectNames, bool bDetectClassName = true);
 
    static COREUOBJECT_API bool IsValidLongPackageName(FStringView InLongPackageName, bool bIncludeReadOnlyRoots = false, EErrorCode* OutReason = nullptr);
    static COREUOBJECT_API bool IsValidLongPackageName(FStringView InLongPackageName, bool bIncludeReadOnlyRoots, FText* OutReason );
 
    static COREUOBJECT_API bool IsValidTextForLongPackageName(FStringView InLongPackageName, EErrorCode* OutReason = nullptr);
    static COREUOBJECT_API bool IsValidTextForLongPackageName(FStringView InLongPackageName, FText* OutReason);
 
 
    static COREUOBJECT_API bool IsValidObjectPath(FStringView InObjectPath, FText* OutReason = nullptr);
 
    static COREUOBJECT_API bool IsValidPath(FStringView InPath);
 
    static COREUOBJECT_API bool IsShortPackageName(const FString& PossiblyLongName);
    static COREUOBJECT_API bool IsShortPackageName(const FName PossiblyLongName);
    static COREUOBJECT_API bool IsShortPackageName(FStringView PossiblyLongName);
 
    static COREUOBJECT_API FString GetShortName(const UPackage* Package);
 
    static COREUOBJECT_API FString GetShortName(FStringView LongName);
    static COREUOBJECT_API FString GetShortName(const FName& LongName);
    static COREUOBJECT_API FString GetShortName(const TCHAR* LongName);
 
    static COREUOBJECT_API FName GetShortFName(FStringView LongName);
    static COREUOBJECT_API FName GetShortFName(const FName& LongName);
    static COREUOBJECT_API FName GetShortFName(const TCHAR* LongName);
 
    static COREUOBJECT_API bool TryConvertGameRelativePackagePathToLocalPath(FStringView RelativePackagePath, FString& OutLocalPath);
 
    static COREUOBJECT_API void RegisterMountPoint(const FString& RootPath, const FString& ContentPath);
 
    static COREUOBJECT_API void UnRegisterMountPoint(const FString& RootPath, const FString& ContentPath);
 
    static COREUOBJECT_API bool MountPointExists(FStringView RootPath);
    static COREUOBJECT_API bool MountPointExists(const FString& RootPath);
    static COREUOBJECT_API bool MountPointExists(const TCHAR* RootPath);
 
    static COREUOBJECT_API FName GetPackageMountPoint(FStringView InPackagePath, bool InWithoutSlashes = true);
    static COREUOBJECT_API FName GetPackageMountPoint(const FString& InPackagePath, bool InWithoutSlashes = true);
    static COREUOBJECT_API FName GetPackageMountPoint(const TCHAR* InPackagePath, bool InWithoutSlashes = true);
 
    static COREUOBJECT_API FString GetContentPathForPackageRoot(FStringView InPackageRoot);
 
    UE_DEPRECATED(5.0, "Deprecated. UPackage::Guid has not been used by the engine for a long time. Call DoesPackageExist without a Guid.")
    static bool DoesPackageExist(const FString& LongPackageName, const FGuid* Guid, FString* OutFilename, bool InAllowTextFormats = true)
    {
        return DoesPackageExist(LongPackageName, OutFilename, InAllowTextFormats);
    }
 
 
    static COREUOBJECT_API bool DoesPackageExist(const FString& LongPackageName, FString* OutFilename = nullptr, bool InAllowTextFormats = true);
 
    static COREUOBJECT_API bool DoesPackageExist(const FPackagePath& PackagePath, bool bMatchCaseOnDisk = false, FPackagePath* OutPackagePath = nullptr);
 
    static COREUOBJECT_API bool DoesPackageExist(const FPackagePath& PackagePath, FPackagePath* OutPackagePath);
 
    enum class EPackageLocationFilter : uint8
    {
        None = 0,
        IoDispatcher = 1,
        FileSystem = 2,
 
        MaxBit = FileSystem,
        ValidMask = (1 << MaxBit) - 1,
 
        // Any allows finding the PackageData if it exists anywhere at all, and won't need to check both. When using Any,
        // as soon as the package is found in Any location, DoesPackageExistEx will return true
        Any = 0xFF,
    };
 
    static COREUOBJECT_API EPackageLocationFilter DoesPackageExistEx(const FPackagePath& PackagePath, EPackageLocationFilter Filter, bool bMatchCaseOnDisk = false, FPackagePath* OutPackagePath = nullptr);
 
    static COREUOBJECT_API bool SearchForPackageOnDisk(const FString& PackageName, FString* OutLongPackageName = NULL, FString* OutFilename = NULL);
 
    static COREUOBJECT_API bool TryConvertShortPackagePathToLongInObjectPath(const FString& ObjectPath, FString& ConvertedObjectPath);
 
    static COREUOBJECT_API FString GetNormalizedObjectPath(const FString& ObjectPath);
 
    static COREUOBJECT_API FString GetDelegateResolvedPackagePath(const FString& InSourcePackagePath);
 
    static COREUOBJECT_API FString GetSourcePackagePath(const FString& InLocalizedPackagePath);
 
    static COREUOBJECT_API FString GetLocalizedPackagePath(const FString& InSourcePackagePath);
 
    static COREUOBJECT_API FString GetLocalizedPackagePath(const FString& InSourcePackagePath, const FString& InCultureName);
 
    UE_INTERNAL static COREUOBJECT_API UE::Core::FVersePath GetVersePath(const FTopLevelAssetPath& AssetPath);
 
    UE_INTERNAL static COREUOBJECT_API UE::Core::FVersePath LongPackagePathToVersePath(FStringView LongPackagePath);
 
    static COREUOBJECT_API const FString& GetAssetPackageExtension();
    static COREUOBJECT_API const FString& GetMapPackageExtension();
 
    static COREUOBJECT_API const FString& GetTextAssetPackageExtension();
 
    static COREUOBJECT_API const FString& GetTextMapPackageExtension();
 
    static COREUOBJECT_API bool IsTextPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsTextPackageExtension(EPackageExtension Extension);
 
    static COREUOBJECT_API bool IsTextAssetPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsTextMapPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsPackageExtension(EPackageExtension Extension);
 
    static COREUOBJECT_API bool IsAssetPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsMapPackageExtension(const TCHAR* Ext);
 
    static COREUOBJECT_API bool IsVerseExtension(const TCHAR* Ext);
 
    static inline bool IsPackageFilename(FStringView Filename)
    {
        FStringView AssetPackageExtension(LexToString(EPackageExtension::Asset));
        FStringView MapPackageExtension(LexToString(EPackageExtension::Map));
        return Filename.EndsWith(AssetPackageExtension) || Filename.EndsWith(MapPackageExtension);
    }
 
    static COREUOBJECT_API const TCHAR* GetGeneratedPackageSubPath();
 
    static COREUOBJECT_API bool IsUnderGeneratedPackageSubPath(FStringView FileOrLongPackagePath);
 
    static COREUOBJECT_API bool FindPackagesInDirectory(TArray<FString>& OutPackages, const FString& RootDir);
 
    static COREUOBJECT_API bool FindPackagesInDirectories(TArray<FString>& OutPackages, const TArrayView<const FString>& RootDirs);
 
    typedef TFunctionRef<bool(const TCHAR*)> FPackageNameVisitor;
    typedef TFunctionRef<bool(const TCHAR*, const FFileStatData&)> FPackageNameStatVisitor;
    static COREUOBJECT_API void IteratePackagesInDirectory(const FString& RootDir, const FPackageNameVisitor& Visitor);
    static COREUOBJECT_API void IteratePackagesInDirectory(const FString& RootDir, const FPackageNameStatVisitor& Visitor);
 
    DECLARE_MULTICAST_DELEGATE_TwoParams( FOnContentPathMountedEvent, const FString& /* Asset path */, const FString& /* ContentPath */ );
    static FOnContentPathMountedEvent& OnContentPathMounted()
    {
        return OnContentPathMountedEvent;
    }
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FOnContentPathDismountedEvent, const FString& /* Asset path */, const FString& /* ContentPath */ );
    static FOnContentPathDismountedEvent& OnContentPathDismounted()
    {
        return OnContentPathDismountedEvent;
    }
 
    static COREUOBJECT_API void QueryRootContentPaths( TArray<FString>& OutRootContentPaths, bool bIncludeReadOnlyRoots = false, bool bWithoutLeadingSlashes = false, bool bWithoutTrailingSlashes = false);
    
    static COREUOBJECT_API TArray<FString> QueryMountPointLocalAbsPaths();
 
    static COREUOBJECT_API void OnCoreUObjectInitialized();
 
    static COREUOBJECT_API bool ParseExportTextPath(FWideStringView InExportTextPath, FWideStringView* OutClassName, FWideStringView* OutObjectPath);
    static COREUOBJECT_API bool ParseExportTextPath(FAnsiStringView InExportTextPath, FAnsiStringView* OutClassName, FAnsiStringView* OutObjectPath);
    static COREUOBJECT_API bool ParseExportTextPath(const FString& InExportTextPath, FString* OutClassName, FString* OutObjectPath);    
    static COREUOBJECT_API bool ParseExportTextPath(const TCHAR* InExportTextPath, FStringView* OutClassName, FStringView* OutObjectPath);
 
 
    static COREUOBJECT_API FWideStringView  ExportTextPathToObjectPath(FWideStringView InExportTextPath);
    static COREUOBJECT_API FAnsiStringView  ExportTextPathToObjectPath(FAnsiStringView InExportTextPath);
    static COREUOBJECT_API FString          ExportTextPathToObjectPath(const FString& InExportTextPath);
    static COREUOBJECT_API FString          ExportTextPathToObjectPath(const TCHAR* InExportTextPath);
 
    enum class EPathFormatFlags : uint32
    {
        None = 0x0,
        MountPointLeadingSlash = 0x1,
        MountPointTrailingSlash = 0x2,
        MountPointSlashes = MountPointLeadingSlash | MountPointTrailingSlash,
        MountPointNoSlashes = None,
    };
 
    static COREUOBJECT_API void SplitPackageName(FStringView InPackageName, FStringView* OutPackageRoot,
        FStringView* OutPackagePath, FStringView* OutPackageLeafName,
        EPathFormatFlags Flags = EPathFormatFlags::MountPointSlashes);
    static COREUOBJECT_API void SplitPackageName(const FString& InLongPackageName, FString* OutPackageRoot,
        FString* OutPackagePath, FString* OutPackageLeafName,
        EPathFormatFlags Flags = EPathFormatFlags::MountPointSlashes);
 
    static COREUOBJECT_API bool SplitLongPackageName(const FString& InLongPackageName, FString& OutPackageRoot,
        FString& OutPackagePath, FString& OutPackageLeafName, const bool bStripRootLeadingSlash = false);
 
    static COREUOBJECT_API FStringView SplitPackageNameRoot(FStringView InPackageName, FStringView* OutRelativePath,
        EPathFormatFlags Flags = EPathFormatFlags::MountPointNoSlashes);
    static COREUOBJECT_API FString SplitPackageNameRoot(FName InPackageName, FString* OutRelativePath,
        EPathFormatFlags Flags = EPathFormatFlags::MountPointNoSlashes);
    
    static COREUOBJECT_API FWideStringView ObjectPathToPackageName(FWideStringView InObjectPath);
    static COREUOBJECT_API FAnsiStringView ObjectPathToPackageName(FAnsiStringView InObjectPath);
    static COREUOBJECT_API FString ObjectPathToPackageName(const FString& InObjectPath);
 
    static COREUOBJECT_API FWideStringView ObjectPathToPathWithinPackage(FWideStringView InObjectPath);
    static COREUOBJECT_API FAnsiStringView ObjectPathToPathWithinPackage(FAnsiStringView InObjectPath);
    static COREUOBJECT_API FString ObjectPathToPathWithinPackage(const FString& InObjectPath);
 
    static COREUOBJECT_API FWideStringView ObjectPathToOuterPath(FWideStringView InObjectPath);
    static COREUOBJECT_API FAnsiStringView ObjectPathToOuterPath(FAnsiStringView InObjectPath);
    static COREUOBJECT_API FString ObjectPathToOuterPath(const FString& InObjectPath);
 
    static COREUOBJECT_API FWideStringView ObjectPathToSubObjectPath(FWideStringView InObjectPath);
    static COREUOBJECT_API FAnsiStringView ObjectPathToSubObjectPath(FAnsiStringView InObjectPath);
    static COREUOBJECT_API FString ObjectPathToSubObjectPath(const FString& InObjectPath);
 
    static COREUOBJECT_API FWideStringView ObjectPathToObjectName(FWideStringView InObjectPath);
    static COREUOBJECT_API FAnsiStringView ObjectPathToObjectName(FAnsiStringView InObjectPath);
    static COREUOBJECT_API FString ObjectPathToObjectName(const FString& InObjectPath);
 
    static COREUOBJECT_API void ObjectPathSplitFirstName(FWideStringView Text,
        FWideStringView& OutFirst, FWideStringView& OutRemainder);
    static COREUOBJECT_API void ObjectPathSplitFirstName(FAnsiStringView Text,
        FAnsiStringView& OutFirst, FAnsiStringView& OutRemainder);
 
    static COREUOBJECT_API void ObjectPathAppend(FStringBuilderBase& ObjectPath, FStringView NextName);
    static COREUOBJECT_API FString ObjectPathCombine(FStringView ObjectPath, FStringView NextName);
 
    static COREUOBJECT_API bool IsVersePackage(FStringView InPackageName);
 
    static COREUOBJECT_API bool IsScriptPackage(FStringView InPackageName);
 
    static COREUOBJECT_API bool IsMemoryPackage(FStringView InPackageName);
 
    static COREUOBJECT_API bool IsTempPackage(FStringView InPackageName);
 
    static COREUOBJECT_API bool IsInEngineTransientPackages(FStringView InPackageName);
 
    static COREUOBJECT_API bool IsLocalizedPackage(FStringView InPackageName);
 
    static COREUOBJECT_API bool DoesPackageNameContainInvalidCharacters(FStringView InLongPackageName, FText* OutReason);
    static COREUOBJECT_API bool DoesPackageNameContainInvalidCharacters(FStringView InLongPackageName, EErrorCode* OutReason = nullptr);
    
    static COREUOBJECT_API bool FindPackageFileWithoutExtension(const FString& InPackageFilename, FString& OutFilename);
 
    UE_DEPRECATED(5.0, "Specifying AllowTextFormats is no longer supported. Text format is instead specified as a field on the result struct from IPackageResourceManager->OpenReadPackage.")
    static COREUOBJECT_API bool FindPackageFileWithoutExtension(const FString& InPackageFilename, FString& OutFilename, bool InAllowTextFormats);
 
    static COREUOBJECT_API bool FixPackageNameCase(FString& LongPackageName, FStringView Extension);
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FDoesPackageExistOverride, FName);
    static FDoesPackageExistOverride& DoesPackageExistOverride()
    {
        return DoesPackageExistOverrideDelegate;
    }
 
    static COREUOBJECT_API bool TryGetMountPointForPath(FStringView InFilePathOrPackageName, FStringBuilderBase& OutMountPointPackageName, FStringBuilderBase& OutMountPointFilePath, FStringBuilderBase& OutRelPath,
        EFlexNameType* OutFlexNameType = nullptr, EErrorCode* OutFailureReason = nullptr);
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FGetExplanationForUnavailablePackageDelegate, const FName& /*Unavailable Package*/, FStringBuilderBase& /*InOutExplanation*/);
 
    static COREUOBJECT_API FGetExplanationForUnavailablePackageDelegate& GetExplanationForUnavailablePackageDelegate();
 
     static COREUOBJECT_API void GetExplanationForUnavailablePackage(const FName& UnavailablePackageName, FStringBuilderBase& InOutExplanation);
 
private:
 
    static COREUOBJECT_API void InternalFilenameToLongPackageName(FStringView InFilename, FStringBuilderBase& OutPackageName);
 
    static COREUOBJECT_API bool TryConvertToMountedPathComponents(FStringView InPath, FStringBuilderBase& OutMountPointPackageName, FStringBuilderBase& OutMountPointFilePath, FStringBuilderBase& OutRelPath,
        FStringBuilderBase& OutObjectName, EPackageExtension& OutExtension, FStringBuilderBase& OutCustomExtension, EFlexNameType* OutFlexNameType = nullptr, EErrorCode* OutFailureReason = nullptr);
 
    static COREUOBJECT_API bool TryConvertToMountedPackagePath(const FString& InPath, FPackagePath& OutPackagePath, EErrorCode& OutFailureReason);
 
    static COREUOBJECT_API FOnContentPathMountedEvent OnContentPathMountedEvent;
 
    static COREUOBJECT_API FOnContentPathDismountedEvent OnContentPathDismountedEvent;
 
    static COREUOBJECT_API FDoesPackageExistOverride DoesPackageExistOverrideDelegate;
 
    friend class FPackagePath;
 
    // Internal helper not meant for public use. These versions of DoesPackageExist do not use the AssetRegistry; any code that might be holding an AssetRegistry lock should call these functions instead
    friend class FAssetRegistryConsoleCommands;
    friend class UAssetRegistryImpl;
    friend struct ::UE::AssetRegistry::Impl::FScanPathContext;
    static COREUOBJECT_API EPackageLocationFilter InternalDoesPackageExistEx(const FPackagePath& PackagePath, EPackageLocationFilter Filterconst, bool bMatchCaseOnDisk = false, FPackagePath* OutPackagePath = nullptr);
    static COREUOBJECT_API EPackageLocationFilter InternalDoesPackageExistEx(const FString& LongPackageName, EPackageLocationFilter Filterconst, bool bMatchCaseOnDisk = false, FPackagePath* OutPackagePath = nullptr);
};
 
ENUM_CLASS_FLAGS(FPackageName::EConvertFlags);
ENUM_CLASS_FLAGS(FPackageName::EPathFormatFlags);