Paths.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "HAL/CriticalSection.h"
#include "Templates/UnrealTemplate.h"
 
#include <type_traits>
 
class FText;
 
namespace UE::Core::Private
{
    const TCHAR*   GetBindingType(const TCHAR* Ptr);
    const FString& GetBindingType(const FString& Str);
    const FStringView& GetBindingType(const FStringView& StringView);
 
    // This is used to force the arguments of FPaths::Combine to implicitly convert (if necessary)
    // to FString when calling CombineImpl(), allowing them to remain as temporaries on the stack
    // so that they stay allocated during the combining process.
    //
    // Pointer/view arguments are passed without causing FString temporaries to be created,
    // and FString arguments are referenced directly without creating extra copies.
    template <typename T>
    using TToStringType_T = decltype(GetBindingType(std::declval<T>()));
}
 
class FPaths
{
public:
 
    static CORE_API bool CanGetProjectDir();
 
    static CORE_API bool IsStaged();
    
    static CORE_API bool ShouldSaveToUserDir();
 
    static CORE_API FString LaunchDir();
     
    static CORE_API FString EngineDir();
 
    static CORE_API FString EngineUserDir();
 
    static CORE_API FString EngineVersionAgnosticUserDir();
 
    static CORE_API FString EngineContentDir();
 
    static CORE_API FString EngineConfigDir();
 
    static CORE_API FString EngineEditorSettingsDir();
 
    static CORE_API FString EngineIntermediateDir();
 
    static CORE_API FString EngineSavedDir();
 
    static CORE_API FString EnginePluginsDir();
 
    static CORE_API FString EngineDefaultLayoutDir();
 
    static CORE_API FString EngineProjectLayoutDir();
 
    static CORE_API FString EngineUserLayoutDir();
 
    static CORE_API FString EnterpriseDir();
 
    static CORE_API FString EnterprisePluginsDir();
 
    static CORE_API FString EnterpriseFeaturePackDir();
 
    UE_DEPRECATED(5.4, "Use EnginePlatformExtensionDir(Platform) instead - ProjectPlatformExtensionsDir did not handle programs properly, so for consistency this is being removed as well")
    static CORE_API FString EnginePlatformExtensionsDir();
 
    static FString EnginePlatformExtensionDir(const TCHAR* Platform)
    {
        return ConvertPath(FPaths::EngineDir(), EPathConversion::Engine_PlatformExtension, Platform);
    }
 
    UE_DEPRECATED(5.4, "Use ProjectPlatformExtensionDir(Platform) instead - this function does not handle Programs properly")
    static CORE_API FString ProjectPlatformExtensionsDir();
 
    static FString ProjectPlatformExtensionDir(const TCHAR* Platform)
    {
        return ConvertPath(FPaths::ProjectDir(), EPathConversion::Project_PlatformExtension, Platform);
    }
    
    enum class EPathConversion : uint8
    {
        // ExtraData is name of platform
        Engine_PlatformExtension,
        Engine_NotForLicensees,
        Engine_NoRedist,
        Engine_LimitedAccess,
 
        Project_First,
        Project_PlatformExtension = Project_First,
        Project_NotForLicensees,
        Project_NoRedist,
        Project_LimitedAccess
    };
    
    static CORE_API FString ConvertPath(const FString& Path, EPathConversion Method, const TCHAR* ExtraData=nullptr, const TCHAR* OverrideProjectDir=nullptr);
    
    static CORE_API TArray<FString> GetExtensionDirs(const FString& BaseDir, const FString& SubDir, bool bCheckValid);
 
    enum class EGetExtensionDirsFlags : uint8
    {
        None                        = 0,
        // Include the Base directory
        WithBase                    = (1 << 0),
        // Include Restricted extension directories
        WithRestricted              = (1 << 1),
        // Include Platform extension directories
        WithPlatforms               = (1 << 2),
        // Use FDataDrivePlatformInfo to determine valid platforms, otherwise just use what's present
        CheckPlatformsValid         = (1 << 3),
        Default                     = 0xFF
    };
    FRIEND_ENUM_CLASS_FLAGS(EGetExtensionDirsFlags);
 
    static CORE_API TArray<FString> GetExtensionDirs(
        const FString& BaseDir, 
        const FString& SubDir = FString(), 
        EGetExtensionDirsFlags Flags = EGetExtensionDirsFlags::Default);
 
    static CORE_API FString RootDir();
 
#if WITH_EDITOR
    static CORE_API const TCHAR* GameFeatureRootPrefix();
#endif
 
    static CORE_API FString ProjectDir();
 
    static CORE_API FString ProjectUserDir();
 
    static CORE_API FString ProjectContentDir();
 
    static CORE_API FString ProjectConfigDir();
 
    static CORE_API const FString& ProjectSavedDir();
 
    static CORE_API FString ProjectIntermediateDir();
 
    static CORE_API FString ShaderWorkingDir();
 
    static CORE_API FString ProjectPluginsDir();
 
    static CORE_API FString ProjectModsDir();
 
    /*
    * Returns true if a writable directory for downloaded data that persists across play sessions is available
    */
    static CORE_API bool HasProjectPersistentDownloadDir();
 
    /*
    * Returns the writable directory for downloaded data that persists across play sessions.
    */
    static CORE_API FString ProjectPersistentDownloadDir();
 
    static CORE_API FString SourceConfigDir();
 
    static CORE_API FString GeneratedConfigDir();
 
    static CORE_API FString SandboxesDir();
 
    static CORE_API FString ProfilingDir();
 
    static CORE_API FString ScreenShotDir();
 
    static CORE_API FString BugItDir();
 
    static CORE_API FString VideoCaptureDir();
 
    static CORE_API FString AudioCaptureDir();
    
    static CORE_API FString ProjectLogDir();
 
    static CORE_API FString AutomationDir();
 
    static CORE_API FString AutomationTransientDir();
 
    static CORE_API FString AutomationReportsDir();
 
    static CORE_API FString AutomationLogDir();
 
    static CORE_API FString CloudDir();
 
    static CORE_API FString GameDevelopersDir();
 
    static CORE_API FStringView DevelopersFolderName();
 
    static CORE_API FString GameUserDeveloperFolderName();
 
    static CORE_API FString GameUserDeveloperDir();
 
    static CORE_API FString DiffDir();
 
    static CORE_API const TArray<FString>& GetEngineLocalizationPaths();
 
    static CORE_API const TArray<FString>& GetEditorLocalizationPaths();
 
    UE_DEPRECATED(5.5, "Cooked editor localization path no longer exist. Cooked editors now load game localization paths.")
    static TArray<FString> GetCookedEditorLocalizationPaths() { return TArray<FString>(); }
 
    static CORE_API const TArray<FString>& GetPropertyNameLocalizationPaths();
 
    static CORE_API const TArray<FString>& GetToolTipLocalizationPaths();
 
    static CORE_API const TArray<FString>& GetGameLocalizationPaths();
 
    static CORE_API FString GetPlatformLocalizationFolderName();
 
    static CORE_API const TArray<FString>& GetRestrictedFolderNames();
 
    static CORE_API bool IsRestrictedPath(const FString& InPath);
 
    static CORE_API FString GameAgnosticSavedDir();
 
    static CORE_API FString EngineSourceDir();
 
    static CORE_API FString GameSourceDir();
 
    static CORE_API FString FeaturePackDir();
 
    static CORE_API bool IsProjectFilePathSet();
    
    static CORE_API FString GetProjectFilePath();
 
    static CORE_API void SetProjectFilePath( const FString& NewGameProjectFilePath );
 
    static CORE_API FString GetExtension( const FString& InPath, bool bIncludeDot=false );
 
    // Returns the filename (with extension), minus any path information.
    static CORE_API FString GetCleanFilename(const FString& InPath);
    static CORE_API FString GetCleanFilenameUtf8(const FUtf8String& InPath);
 
    // Returns the filename (with extension), minus any path information.
    static CORE_API FString GetCleanFilename(FString&& InPath);
 
    // Returns the same thing as GetCleanFilename, but without the extension
    static CORE_API FString GetBaseFilename(const FString& InPath, bool bRemovePath=true );
 
    // Returns the same thing as GetCleanFilename, but without the extension
    static CORE_API FString GetBaseFilename(FString&& InPath, bool bRemovePath = true);
 
    // Returns the path in front of the filename
    static CORE_API FString GetPath(const FString& InPath);
 
    // Returns the path in front of the filename
    static CORE_API FString GetPath(FString&& InPath);
 
    // Returns the leaf in the path
    static CORE_API FString GetPathLeaf(const FString& InPath);
 
    // Returns the leaf in the path
    static CORE_API FString GetPathLeaf(FString&& InPath);
 
    static CORE_API FString ChangeExtension(const FString& InPath, const FString& InNewExtension);
 
    static CORE_API FString SetExtension(const FString& InPath, const FString& InNewExtension);
 
    static CORE_API bool FileExists(const FString& InPath);
 
    static CORE_API bool DirectoryExists(const FString& InPath);
 
    static CORE_API bool IsDrive(const FString& InPath);
 
    static CORE_API bool IsRelative(const FString& InPath);
 
    static CORE_API void NormalizeFilename(FString& InPath);
 
    static CORE_API FString FindCorrectCase(const FString& Path);
 
    static CORE_API bool IsSamePath(const FString& PathA, const FString& PathB);
 
    static CORE_API bool IsUnderDirectory(const FString& InPath, const FString& InDirectory);
 
    static CORE_API void NormalizeDirectoryName(FString& InPath);
 
    static CORE_API bool CollapseRelativeDirectories(FString& InPath, bool bCollapseAllPossible = false);
 
    static CORE_API void RemoveDuplicateSlashes(FString& InPath);
 
    static CORE_API FString RemoveDuplicateSlashes(const FString& InPath);
 
    static CORE_API FString CreateStandardFilename(const FString& InPath);
 
    static CORE_API void MakeStandardFilename(FString& InPath);
 
    static CORE_API void MakePlatformFilename(FString& InPath);
 
    static CORE_API bool MakePathRelativeTo( FString& InPath, const TCHAR* InRelativeTo );
 
    static CORE_API FString ConvertRelativePathToFull(const FString& InPath);
 
    static CORE_API FString ConvertRelativePathToFull(FString&& InPath);
 
    static CORE_API FString ConvertRelativePathToFull(const FString& BasePath, const FString& InPath);
 
    static CORE_API FString ConvertRelativePathToFull(const FString& BasePath, FString&& InPath);
 
    static CORE_API FString ConvertRelativePathToFull(FString&& BasePath, const FString& InPath);
 
    static CORE_API FString ConvertRelativePathToFull(FString&& BasePath, FString&& InPath);
 
    static CORE_API FString ConvertToSandboxPath( const FString& InPath, const TCHAR* InSandboxName );
 
    static CORE_API FString ConvertFromSandboxPath( const FString& InPath, const TCHAR* InSandboxName );
 
    static CORE_API FString CreateTempFilename( const TCHAR* Path, const TCHAR* Prefix = TEXT(""), const TCHAR* Extension = TEXT(".tmp") );
 
    static CORE_API FString GetInvalidFileSystemChars();
 
    static CORE_API FString MakeValidFileName(const FString& InString, const TCHAR InReplacementChar = TEXT('\0'));
 
    static CORE_API bool ValidatePath( const FString& InPath, FText* OutReason = nullptr );
 
    static CORE_API void Split( const FString& InPath, FString& PathPart, FString& FilenamePart, FString& ExtensionPart );
 
    static CORE_API const FString& GetRelativePathToRoot();
 
    template <typename... PathTypes>
    UE_FORCEINLINE_HINT static FString Combine(PathTypes&&... InPaths)
    {
        return CombineImpl<PathTypes...>(Forward<PathTypes>(InPaths)...);
    }
 
    static CORE_API void TearDown();
 
protected:
 
    static CORE_API FString CombineInternal(const FStringView* Paths, int32 NumPaths);
    static void PlatformIndependentNormalizePath(FString& Path, bool bRemoveDuplicateSlashes,
        int32& OutFirstColonIndex, int32& OutFirstSlashIndex);
 
private:
    struct FStaticData;
 
    template <typename... PathTypes>
    inline static FString CombineImpl(UE::Core::Private::TToStringType_T<std::decay_t<PathTypes>>... InPaths)
    {
        const FStringView Paths[] = { FStringView(InPaths)... };
        return CombineInternal(Paths, UE_ARRAY_COUNT(Paths));
    }
 
    static CORE_API const FString& CustomUserDirArgument();
 
    static CORE_API const FString& CustomShaderDirArgument();
};
 
ENUM_CLASS_FLAGS(FPaths::EGetExtensionDirsFlags);