TextLocalizationResource.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/SortedMap.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Internationalization/LocalizedTextSourceTypes.h"
#include "Internationalization/TextKey.h"
#include "Misc/Crc.h"
#include "Templates/SharedPointer.h"
 
class FArchive;
 
class FTextLocalizationMetaDataResource
{
public:
    FTextLocalizationMetaDataResource() = default;
 
    FTextLocalizationMetaDataResource(const FTextLocalizationMetaDataResource&) = default;
    FTextLocalizationMetaDataResource& operator=(const FTextLocalizationMetaDataResource&) = default;
 
    FTextLocalizationMetaDataResource(FTextLocalizationMetaDataResource&&) = default;
    FTextLocalizationMetaDataResource& operator=(FTextLocalizationMetaDataResource&&) = default;
 
    FString NativeCulture;
 
    FString NativeLocRes;
 
    TArray<FString> CompiledCultures;
 
    bool bIsUGC = false;
 
    CORE_API bool LoadFromFile(const FString& FilePath);
 
    CORE_API bool LoadFromArchive(FArchive& Archive, const FString& LocMetaID);
 
    CORE_API bool SaveToFile(const FString& FilePath);
 
    CORE_API bool SaveToArchive(FArchive& Archive, const FString& LocMetaID);
};
 
class FTextLocalizationResource
{
public:
    FTextLocalizationResource() = default;
 
    FTextLocalizationResource(const FTextLocalizationResource&) = default;
    FTextLocalizationResource& operator=(const FTextLocalizationResource&) = default;
 
    FTextLocalizationResource(FTextLocalizationResource&&) = default;
    FTextLocalizationResource& operator=(FTextLocalizationResource&&) = default;
 
    struct FEntry
    {
        FTextConstDisplayStringPtr LocalizedString;
        FTextKey LocResID;
        int32 LocalizationTargetPathId = INDEX_NONE;
        uint32 SourceStringHash = 0;
        int32 Priority = 0; // Smaller numbers are higher priority
    };
 
    typedef TMap<FTextId, FEntry> FEntriesTable;
    FEntriesTable Entries;
 
    static UE_FORCEINLINE_HINT uint32 HashString(const TCHAR* InStr, const uint32 InBaseHash = 0)
    {
        return FCrc::StrCrc32<TCHAR>(InStr, InBaseHash);
    }
 
    static UE_FORCEINLINE_HINT uint32 HashString(const FString& InStr, const uint32 InBaseHash = 0)
    {
        return FCrc::StrCrc32<TCHAR>(*InStr, InBaseHash);
    }
 
    CORE_API void AddEntry(const FTextKey& InNamespace, const FTextKey& InKey, const FString& InSourceString, const FString& InLocalizedString, const int32 InPriority, const FTextKey& InLocResID = FTextKey());
    CORE_API void AddEntry(const FTextKey& InNamespace, const FTextKey& InKey, const FString& InSourceString, const FTextConstDisplayStringRef& InLocalizedString, const int32 InPriority, const FTextKey& InLocResID = FTextKey());
    CORE_API void AddEntry(const FTextKey& InNamespace, const FTextKey& InKey, const uint32 InSourceStringHash, const FString& InLocalizedString, const int32 InPriority, const FTextKey& InLocResID = FTextKey());
    CORE_API void AddEntry(const FTextKey& InNamespace, const FTextKey& InKey, const uint32 InSourceStringHash, const FTextConstDisplayStringRef& InLocalizedString, const int32 InPriority, const FTextKey& InLocResID = FTextKey());
 
    CORE_API bool IsEmpty() const;
 
    CORE_API void LoadFromDirectory(const FString& DirectoryPath, const int32 Priority);
 
    CORE_API bool LoadFromFile(const FString& FilePath, const int32 Priority);
 
    CORE_API bool LoadFromArchive(FArchive& Archive, const FTextKey& LocResID, const int32 Priority);
 
    CORE_API bool SaveToFile(const FString& FilePath) const;
 
    CORE_API bool SaveToArchive(FArchive& Archive, const FTextKey& LocResID) const;
 
private:
    static CORE_API bool ShouldReplaceEntry(const FTextKey& Namespace, const FTextKey& Key, const FEntry& CurrentEntry, const FEntry& NewEntry);
};
 
namespace TextLocalizationResourceUtil
{
 
CORE_API FString GetNativeCultureName(const TArray<FString>& InLocalizationPaths);
 
CORE_API FString GetNativeCultureName(const ELocalizedTextSourceCategory InCategory);
 
CORE_API FString GetNativeProjectCultureName(const bool bSkipCache = false);
 
CORE_API void ClearNativeProjectCultureName();
 
CORE_API FString GetNativeEngineCultureName(const bool bSkipCache = false);
 
CORE_API void ClearNativeEngineCultureName();
 
#if WITH_EDITOR
CORE_API FString GetNativeEditorCultureName(const bool bSkipCache = false);
 
CORE_API void ClearNativeEditorCultureName();
#endif  // WITH_EDITOR
 
CORE_API TArray<FString> GetLocalizedCultureNames(const TArray<FString>& InLocalizationPaths);
 
CORE_API const TArray<FString>& GetDisabledLocalizationTargets();
 
CORE_API FString GetLocalizationTargetNameForChunkId(const FString& InLocalizationTargetName, const int32 InChunkId);
 
}