VersePath.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    VersePath.h: A type which holds a VersePath
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/PathViews.h"
#include "VersePathFwd.h"
 
class UE::Core::FVersePath
{
    friend bool operator==(const FVersePath& Lhs, const FVersePath& Rhs);
    friend bool operator!=(const FVersePath& Lhs, const FVersePath& Rhs);
 
    friend FArchive& operator<<(FArchive& Ar, FVersePath& VersePath);
 
public:
    [[nodiscard]] FVersePath() = default;
    [[nodiscard]] FVersePath(FVersePath&&) = default;
    [[nodiscard]] FVersePath(const FVersePath&) = default;
    FVersePath& operator=(FVersePath&&) = default;
    FVersePath& operator=(const FVersePath&) = default;
    ~FVersePath() = default;
 
    [[nodiscard]] const TCHAR* operator*() const
    {
        return *PathString;
    }
 
    [[nodiscard]] bool IsValid() const
    {
        return !PathString.IsEmpty();
    }
 
    [[nodiscard]] explicit operator bool() const
    {
        return !PathString.IsEmpty();
    }
 
    [[nodiscard]] int32 Compare(const FVersePath& Other) const
    {
        return PathString.Compare(Other.PathString, ESearchCase::CaseSensitive);
    }
 
    [[nodiscard]] CORE_API bool IsBaseOf(const FVersePath& Other, FStringView* OutLeafPath = nullptr) const;
 
    [[nodiscard]] const FString& ToString() const &
    {
        return PathString;
    }
 
    [[nodiscard]] FString ToString() &&
    {
        return MoveTemp(PathString);
    }
 
    [[nodiscard]] FStringView AsStringView() const
    {
        return PathString;
    }
 
    [[nodiscard]] FText AsText() const &
    {
        return FText::AsCultureInvariant(AsStringView());
    }
 
    [[nodiscard]] FText AsText() &&
    {
        return FText::AsCultureInvariant(MoveTemp(PathString));
    }
 
    [[nodiscard]] FString GetVerseDomain() const
    {
        return FString(FPathViews::GetMountPointNameFromPath(PathString));
    }
 
    [[nodiscard]] FStringView GetVerseDomainAsStringView() const
    {
        return FPathViews::GetMountPointNameFromPath(PathString);
    }
 
    [[nodiscard]] FString GetPathExceptVerseDomain() const
    {
        FStringView VerseDomain = GetVerseDomainAsStringView();
        return PathString.RightChop(VerseDomain.Len()+1);
    }
 
    CORE_API static bool TryMake(FVersePath& OutPath, const FString& Path, FText* OutErrorMessage = nullptr);
    CORE_API static bool TryMake(FVersePath& OutPath, FString&& Path, FText* OutErrorMessage = nullptr);
 
    [[nodiscard]] CORE_API static bool IsValidFullPath(const TCHAR* String, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidFullPath(const TCHAR* String, int32 Len, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidDomain(const TCHAR* String, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidDomain(const TCHAR* String, int32 Len, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidSubpath(const TCHAR* String, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidSubpath(const TCHAR* String, int32 Len, FText* OutErrorMessage = nullptr);
    [[nodiscard]] CORE_API static bool IsValidIdent(const TCHAR* String, FText* OutErrorMessage = nullptr, const FText* IdentTermReplacement = nullptr);
    [[nodiscard]] CORE_API static bool IsValidIdent(const TCHAR* String, int32 Len, FText* OutErrorMessage = nullptr, const FText* IdentTermReplacement = nullptr);
 
private:
    FString PathString;
};
 
[[nodiscard]] UE_FORCEINLINE_HINT bool UE::Core::operator==(const FVersePath& Lhs, const FVersePath& Rhs)
{
    return Lhs.PathString.Equals(Rhs.PathString, ESearchCase::CaseSensitive);
}
 
[[nodiscard]] UE_FORCEINLINE_HINT bool UE::Core::operator!=(const FVersePath& Lhs, const FVersePath& Rhs)
{
    return !(Lhs == Rhs);
}
 
UE_FORCEINLINE_HINT FArchive& UE::Core::operator<<(FArchive& Ar, FVersePath& VersePath)
{
    return Ar << VersePath.PathString;
}
 
[[nodiscard]] UE_FORCEINLINE_HINT uint32 UE::Core::GetTypeHash(const FVersePath& VersePath)
{
    return FCrc::StrCrc32<TCHAR>(*VersePath);
}