PackageLocalizationCache.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/UnrealString.h"
#include "HAL/CriticalSection.h"
#include "Internationalization/IPackageLocalizationCache.h"
#include "Templates/SharedPointer.h"
#include "Templates/Tuple.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/TopLevelAssetPath.h"
 
class FPackageLocalizationCache;
 
COREUOBJECT_API DECLARE_LOG_CATEGORY_EXTERN(LogPackageLocalizationCache, Log, All);
 
class FPackageLocalizationCultureCache
{
public:
    COREUOBJECT_API FPackageLocalizationCultureCache(FPackageLocalizationCache* InOwnerCache, const FString& InCultureName);
 
    COREUOBJECT_API void ConditionalUpdateCache();
 
    COREUOBJECT_API void AddRootSourcePath(const FString& InRootPath);
 
    COREUOBJECT_API void RemoveRootSourcePath(const FString& InRootPath);
 
    COREUOBJECT_API bool AddPackage(const FString& InPackageName);
 
    COREUOBJECT_API bool RemovePackage(const FString& InPackageName);
 
    COREUOBJECT_API void Empty();
 
    COREUOBJECT_API FName FindLocalizedPackageName(const FName InSourcePackageName);
 
private:
    void ConditionalUpdateCache_NoLock();
 
private:
    mutable FCriticalSection LocalizedPackagesCS;
 
    FPackageLocalizationCache* OwnerCache;
 
    TArray<FString> PrioritizedCultureNames;
 
    TArray<FString> PrioritizedCultureNamesAndVerseIdentifiers;
 
    TArray<FString> PendingSourceRootPathsToSearch;
 
    TMap<FString, TArray<FString>> SourcePathsToLocalizedPaths;
 
    TMap<FName, TArray<FName>> SourcePackagesToLocalizedPackages;
};
 
class FPackageLocalizationCache : public IPackageLocalizationCache
{
    friend class FPackageLocalizationCultureCache;
 
public:
    COREUOBJECT_API FPackageLocalizationCache();
    COREUOBJECT_API virtual ~FPackageLocalizationCache();
 
    //~ IPackageLocalizationCache interface
    COREUOBJECT_API virtual void InvalidateRootSourcePath(const FString& InRootPath) override;
    COREUOBJECT_API virtual void ConditionalUpdateCache() override;
    COREUOBJECT_API virtual FName FindLocalizedPackageName(const FName InSourcePackageName) override;
    COREUOBJECT_API virtual FName FindLocalizedPackageNameForCulture(const FName InSourcePackageName, const FString& InCultureName) override;
 
protected:
    virtual void FindLocalizedPackages(const TMap<FString, TArray<FString>>& NewSourceToLocalizedPaths, TMap<FName, TArray<FName>>& InOutSourcePackagesToLocalizedPackages) = 0;
 
    virtual void FindAssetGroupPackages(const FName InAssetGroupName, const FTopLevelAssetPath& InAssetClassName) = 0;
 
    COREUOBJECT_API TSharedPtr<FPackageLocalizationCultureCache> FindOrAddCacheForCulture_NoLock(const FString& InCultureName);
 
    COREUOBJECT_API void ConditionalUpdatePackageNameToAssetGroupCache_NoLock();
 
    COREUOBJECT_API void HandleContentPathMounted(const FString& InAssetPath, const FString& InFilesystemPath);
 
    COREUOBJECT_API void HandleContentPathDismounted(const FString& InAssetPath, const FString& InFilesystemPath);
 
    COREUOBJECT_API void HandleCultureChanged();
 
protected:
    mutable FCriticalSection LocalizedCachesCS;
 
    TSharedPtr<FPackageLocalizationCultureCache> CurrentCultureCache;
 
    TArray<TTuple<FString, TSharedPtr<FPackageLocalizationCultureCache>>> AllCultureCaches;
 
    TArray<TTuple<FTopLevelAssetPath, FName>> AssetClassesToAssetGroups;
 
    TMap<FName, FName> PackageNameToAssetGroup;
    bool bPackageNameToAssetGroupDirty;
};