StringTableRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/SparseArray.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "HAL/CriticalSection.h"
#include "Internationalization/LocKeyFuncs.h"
#include "Internationalization/StringTableCoreFwd.h"
#include "Internationalization/Text.h"
#include "Internationalization/TextKey.h"
#include "Internationalization/TextLocalizationManager.h"
#include "Misc/TransactionallySafeCriticalSection.h"
#include "UObject/NameTypes.h"
 
class UStringTable;
template <typename FuncType> class TFunctionRef;
 
class FStringTableRegistry
{
public:
    static CORE_API FStringTableRegistry& Get();
 
    CORE_API void RegisterStringTable(const FName InTableId, FStringTableRef InTable);
 
    CORE_API bool UnregisterStringTable(const FName InTableId);
 
    CORE_API FStringTablePtr FindMutableStringTable(const FName InTableId) const;
 
    CORE_API FStringTableConstPtr FindStringTable(const FName InTableId) const;
 
    CORE_API UStringTable* FindStringTableAsset(const FName InTableId) const;
 
    CORE_API void EnumerateStringTables(const TFunctionRef<bool(const FName&, const FStringTableConstRef&)>& InEnumerator) const;
 
    UE_DEPRECATED(5.0, "FindTableIdAndKey is deprecated. Use FTextInspector::GetTableIdAndKey instead.")
    CORE_API bool FindTableIdAndKey(const FText& InText, FName& OutTableId, FString& OutKey) const;
 
    CORE_API void LogMissingStringTableEntry(const FName InTableId, const FTextKey& InKey);
 
    CORE_API void Internal_NewLocTable(const FName InTableId, const FTextKey& InNamespace);
 
    CORE_API void Internal_LocTableFromFile(const FName InTableId, const FTextKey& InNamespace, const FString& InFilePath, const FString& InRootPath);
 
    CORE_API void Internal_SetLocTableEntry(const FName InTableId, const FTextKey& InKey, const FString& InSourceString);
 
    CORE_API void Internal_SetLocTableEntryMetaData(const FName InTableId, const FTextKey& InKey, const FName InMetaDataId, const FString& InMetaData);
 
    CORE_API FText Internal_FindLocTableEntry(const FName InTableId, const FTextKey& InKey, const EStringTableLoadingPolicy InLoadingPolicy) const;
 
private:
    FStringTableRegistry();
    ~FStringTableRegistry();
 
    TMap<FName, FStringTablePtr> RegisteredStringTables;
 
    mutable FTransactionallySafeCriticalSection RegisteredStringTablesCS;
 
    typedef TSet<FTextKey> FLocKeySet;
    TMap<FName, FLocKeySet> LoggedMissingEntries;
 
    mutable FTransactionallySafeCriticalSection LoggedMissingEntriesCS;
 
#if WITH_EDITOR
    void OnDirectoryChanged(const TArray<struct FFileChangeData>& InFileChanges);
 
    TMap<FString, FName> CSVFilesToWatch;
 
    mutable FCriticalSection CSVFilesToWatchCS;
 
    FDelegateHandle EngineDirectoryWatcherHandle;
 
    FDelegateHandle GameDirectoryWatcherHandle;
#endif // WITH_EDITOR
};
 
#define LOC_DEFINE_REGION
 
#define LOCTABLE_NEW(ID, NAMESPACE) \
    FStringTableRegistry::Get().Internal_NewLocTable(TEXT(ID), TEXT(NAMESPACE))
 
#define LOCTABLE_FROMFILE_ENGINE(ID, NAMESPACE, FILEPATH) \
    FStringTableRegistry::Get().Internal_LocTableFromFile(TEXT(ID), TEXT(NAMESPACE), TEXT(FILEPATH), FPaths::EngineContentDir())
 
#define LOCTABLE_FROMFILE_GAME(ID, NAMESPACE, FILEPATH) \
    FStringTableRegistry::Get().Internal_LocTableFromFile(TEXT(ID), TEXT(NAMESPACE), TEXT(FILEPATH), FPaths::ProjectContentDir())
 
#define LOCTABLE_SETSTRING(ID, KEY, SRC) \
    FStringTableRegistry::Get().Internal_SetLocTableEntry(TEXT(ID), TEXT(KEY), TEXT(SRC))
 
#define LOCTABLE_SETMETA(ID, KEY, METAID, META) \
    FStringTableRegistry::Get().Internal_SetLocTableEntryMetaData(TEXT(ID), TEXT(KEY), TEXT(METAID), TEXT(META))
 
#define LOCTABLE(ID, KEY) \
    FStringTableRegistry::Get().Internal_FindLocTableEntry(TEXT(ID), TEXT(KEY), EStringTableLoadingPolicy::FindOrLoad)
 
#undef LOC_DEFINE_REGION