You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
8c27714a84
The function is shared with the legacy cache store to allow callers of the legacy API to migrate to the value API using this conversion function without invalidating existing cache keys. #preflight 624c9ab68d1db441a913137e #rb Zousar.Shaker [CL 19630681 by Devin Doucette in ue5-main branch]
142 lines
4.1 KiB
C++
142 lines
4.1 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
#include "Containers/StringFwd.h"
|
|
#include "Containers/StringView.h"
|
|
#include "IO/IoHash.h"
|
|
#include "Templates/TypeHash.h"
|
|
|
|
#define UE_API DERIVEDDATACACHE_API
|
|
|
|
class FCbWriter;
|
|
|
|
namespace UE::DerivedData
|
|
{
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* An alphanumeric identifier that groups related cache records.
|
|
*
|
|
* A cache bucket name must be alphanumeric, non-empty, and contain fewer than 256 code units.
|
|
*/
|
|
class FCacheBucket
|
|
{
|
|
public:
|
|
/** Construct a null cache bucket. */
|
|
FCacheBucket() = default;
|
|
|
|
/** Create a cache bucket from a name. */
|
|
UE_API explicit FCacheBucket(FUtf8StringView Name);
|
|
UE_API explicit FCacheBucket(FWideStringView Name);
|
|
|
|
/** Whether this is null. */
|
|
inline bool IsNull() const { return !Name; }
|
|
/** Whether this is not null. */
|
|
inline bool IsValid() const { return !IsNull(); }
|
|
|
|
/** Reset this to null. */
|
|
inline void Reset() { *this = FCacheBucket(); }
|
|
|
|
inline bool operator==(FCacheBucket Other) const { return Name == Other.Name; }
|
|
inline bool operator!=(FCacheBucket Other) const { return Name != Other.Name; }
|
|
|
|
inline bool operator<(FCacheBucket Other) const
|
|
{
|
|
return Name != Other.Name && ToString().Compare(Other.ToString(), ESearchCase::IgnoreCase) < 0;
|
|
}
|
|
|
|
friend inline uint32 GetTypeHash(FCacheBucket Bucket)
|
|
{
|
|
return ::GetTypeHash(reinterpret_cast<UPTRINT>(Bucket.Name));
|
|
}
|
|
|
|
/** Get the name of the cache bucket as a string. */
|
|
inline FAnsiStringView ToString() const;
|
|
|
|
/** Get the name of the cache bucket as a null-terminated string. */
|
|
inline const ANSICHAR* ToCString() const { return Name; }
|
|
|
|
protected:
|
|
static constexpr int32 LengthOffset = -1;
|
|
|
|
/** Name stored as a null-terminated string preceded by one byte containing its length. */
|
|
const ANSICHAR* Name = nullptr;
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/** A key that uniquely identifies a cache record. */
|
|
struct FCacheKey
|
|
{
|
|
FCacheBucket Bucket;
|
|
FIoHash Hash;
|
|
|
|
/** A key with a null bucket and a zero hash. */
|
|
static const FCacheKey Empty;
|
|
};
|
|
|
|
inline const FCacheKey FCacheKey::Empty;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline FAnsiStringView FCacheBucket::ToString() const
|
|
{
|
|
return Name ? FAnsiStringView(Name, reinterpret_cast<const uint8*>(Name)[LengthOffset]) : FAnsiStringView();
|
|
}
|
|
|
|
template <typename CharType>
|
|
inline TStringBuilderBase<CharType>& operator<<(TStringBuilderBase<CharType>& Builder, const FCacheBucket& Bucket)
|
|
{
|
|
return Builder << Bucket.ToString();
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool operator==(const FCacheKey& A, const FCacheKey& B)
|
|
{
|
|
return A.Bucket == B.Bucket && A.Hash == B.Hash;
|
|
}
|
|
|
|
inline bool operator!=(const FCacheKey& A, const FCacheKey& B)
|
|
{
|
|
return A.Bucket != B.Bucket || A.Hash != B.Hash;
|
|
}
|
|
|
|
inline bool operator<(const FCacheKey& A, const FCacheKey& B)
|
|
{
|
|
const FCacheBucket& BucketA = A.Bucket;
|
|
const FCacheBucket& BucketB = B.Bucket;
|
|
return BucketA == BucketB ? A.Hash < B.Hash : BucketA < BucketB;
|
|
}
|
|
|
|
inline uint32 GetTypeHash(const FCacheKey& Key)
|
|
{
|
|
return HashCombine(GetTypeHash(Key.Bucket), GetTypeHash(Key.Hash));
|
|
}
|
|
|
|
template <typename CharType>
|
|
inline TStringBuilderBase<CharType>& operator<<(TStringBuilderBase<CharType>& Builder, const FCacheKey& Key)
|
|
{
|
|
return Builder << Key.Bucket << CharType('/') << Key.Hash;
|
|
}
|
|
|
|
UE_API FCbWriter& operator<<(FCbWriter& Writer, const FCacheKey& Key);
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
* Constructs a cache key from a legacy cache key.
|
|
*
|
|
* Legacy keys are typically of the form DATATYPENAME_VersionGuid_TypeSpecificSuffix.
|
|
*/
|
|
UE_API FCacheKey ConvertLegacyCacheKey(FStringView Key);
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
} // UE::DerivedData
|
|
|
|
#undef UE_API
|