PathViews.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/StringFwd.h"
#include "CoreTypes.h"
 
class FName;
class FString;
template <typename CharType> class TStringBuilderBase;
template <typename FuncType> class TFunctionRef;
 
class FPathViews
{
public:
    static CORE_API FStringView GetCleanFilename(const FStringView& InPath);
 
    static CORE_API FStringView GetBaseFilename(const FStringView& InPath);
 
    static CORE_API FStringView GetBaseFilenameWithPath(const FStringView& InPath);
 
    UE_DEPRECATED(4.25, "FPathViews::GetBaseFilename(InPath, bRemovePath) has been superseded by "
        "FPathViews::GetBaseFilename(InPath) and FPathViews::GetBaseFilenameWithPath(InPath).")
    static CORE_API FStringView GetBaseFilename(const FStringView& InPath, bool bRemovePath);
 
    static CORE_API FStringView GetPath(const FStringView& InPath);
 
    static CORE_API FStringView GetExtension(const FStringView& InPath, bool bIncludeDot=false);
 
    static CORE_API FStringView GetPathLeaf(const FStringView& InPath);
 
    static CORE_API bool IsPathLeaf(FStringView InPath);
 
    static CORE_API bool IsDriveSpecifierWithoutRoot(FStringView InPath);
 
    static CORE_API void IterateComponents(FStringView InPath, TFunctionRef<void(FStringView)> ComponentVisitor);
 
    static CORE_API void IterateAncestors(FStringView InPath, TFunctionRef<bool(FStringView)> AncestorVisitor);
 
    static CORE_API void Split(const FStringView& InPath, FStringView& OutPath, FStringView& OutName, FStringView& OutExt);
 
    template <typename CharType, typename... ArgTypes>
    static void Append(TStringBuilderBase<CharType>& Builder, ArgTypes&&... Args)
    {
        const auto AddSeparator = [&Builder]() -> TStringBuilderBase<CharType>&
        {
            if (!(Builder.Len() == 0 || Builder.LastChar() == '/' || Builder.LastChar() == '\\'))
            {
                Builder.AppendChar('/');
            }
            return Builder;
        };
        ((AddSeparator() << Args), ...);
    }
 
    static CORE_API FString ChangeExtension(const FStringView& InPath, const FStringView& InNewExtension);
    
    static CORE_API FString SetExtension(const FStringView& InPath, const FStringView& InNewExtension);
 
    static CORE_API bool IsSeparator(TCHAR c);
 
    static CORE_API bool Equals(FStringView A, FStringView B);
 
    static CORE_API bool Less(FStringView A, FStringView B);
 
    static CORE_API bool TryMakeChildPathRelativeTo(FStringView Child, FStringView Parent, FStringView& OutRelPath);
 
    static CORE_API bool IsParentPathOf(FStringView Parent, FStringView Child);
 
    static CORE_API bool IsRelativePath(FStringView InPath);
 
    static CORE_API bool HasRedundantTerminatingSeparator(FStringView A);
 
    static CORE_API void ToAbsolutePath(FStringView InPath, FStringBuilderBase& OutPath);
    
    static CORE_API void ToAbsolutePath(FStringView BasePath, FStringView InPath, FStringBuilderBase& OutPath);
    
    static CORE_API void ToAbsolutePathInline(FStringBuilderBase& InOutPath);
    
    static CORE_API void ToAbsolutePathInline(FStringView BasePath, FStringBuilderBase& InOutPath);
 
    static CORE_API void NormalizeFilename(FStringBuilderBase& InOutPath);
 
    static CORE_API void NormalizeDirectoryName(FStringBuilderBase& InOutPath);
 
    static CORE_API bool CollapseRelativeDirectories(FStringBuilderBase& InOutPath, bool bCollapseAllPossible = false);
 
    static CORE_API void RemoveDuplicateSlashes(FStringBuilderBase& InOutPath);
 
    static CORE_API void SplitFirstComponent(FStringView InPath, FStringView& OutFirstComponent, FStringView& OutRemainder);
 
    static CORE_API void SplitVolumeSpecifier(FStringView InPath, FStringView& OutVolumeSpecifier, FStringView& OutRemainder);
 
    static CORE_API void AppendPath(FStringBuilderBase& InOutPath, FStringView AppendPath);
 
    static CORE_API FStringView GetMountPointNameFromPath(const FStringView InPath, bool* bOutHadClassesPrefix = nullptr, bool bInWithoutSlashes = true);
};