RemoteConfigIni.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 "CoreTypes.h"
#include "HAL/CriticalSection.h"
#include "Misc/DateTime.h"
#include "Stats/Stats.h"
 
class FConfigFile;
template<typename TTask> class FAsyncTask;
 
struct FRemoteConfigAsyncIOInfo
{
    FRemoteConfigAsyncIOInfo() { }
    FRemoteConfigAsyncIOInfo(const TCHAR* InDefaultIniFile);
 
    FString Buffer;
 
    FDateTime TimeStamp;
 
    double StartReadTime;
 
    double StartWriteTime;
 
    bool bReadIOFailed;
 
    bool bWasProcessed;
 
    TCHAR DefaultIniFile[1024];
};
 
 
class FRemoteConfigAsyncWorker
{
public:
 
    FRemoteConfigAsyncWorker(const TCHAR* InFilename, FRemoteConfigAsyncIOInfo& InIOInfo, FString* InContents, bool bInIsRead);
 
    void DoWork();
 
    bool IsReadSuccess() const;
 
    FRemoteConfigAsyncIOInfo& GetIOInfo();
 
    UE_FORCEINLINE_HINT TStatId GetStatId() const
    {
        RETURN_QUICK_DECLARE_CYCLE_STAT(FRemoteConfigAsyncWorker, STATGROUP_ThreadPoolAsyncTasks);
    }
 
    bool CanAbandon();
 
    void Abandon();
 
private:
 
    TCHAR Filename[1024];
 
    FRemoteConfigAsyncIOInfo IOInfo;
 
    FString Contents;
 
    bool bIsRead;
};
 
 
class FRemoteConfigAsyncCachedWriteTask
{
public:
    FRemoteConfigAsyncCachedWriteTask(const TCHAR* InFileName, FString* InContents)
    {
        Filename = InFileName;
        Contents = *InContents;
    }
 
    FString Filename;
    FString Contents;
};
 
 
class FRemoteConfigAsyncTaskManager
{
public:
 
    CORE_API static FRemoteConfigAsyncTaskManager* Get();
 
    CORE_API void Tick();
 
    bool StartTask(const TCHAR* InFilename, const TCHAR* RemotePath, FRemoteConfigAsyncIOInfo& InIOInfo, FString* InContents, bool bInIsRead);
 
    bool IsFinished(const TCHAR* InFilename);
 
    bool AreAllTasksFinished(bool bDoRemoval);
 
    bool GetReadData(const TCHAR* InFilename, FRemoteConfigAsyncIOInfo& OutIOInfo);
 
private:
 
    bool FindCachedWriteTask(const TCHAR* InFilename, bool bCompareContents, const TCHAR* InContents);
 
    TMap<FString, FAsyncTask<FRemoteConfigAsyncWorker>* > PendingTasks;
 
    TArray<FRemoteConfigAsyncCachedWriteTask> CachedWriteTasks;
 
    FCriticalSection SynchronizationObject;
};
 
 
class FRemoteConfig
{
public:
 
    FRemoteConfig();
 
    static FRemoteConfig* Get();
 
    bool IsRemoteFile(const TCHAR* Filename);
 
    bool ShouldReadRemoteFile(const TCHAR* Filename);
 
    FRemoteConfigAsyncIOInfo* FindConfig(const TCHAR* Filename);
 
    bool IsFinished(const TCHAR* InFilename);
 
    bool Read(const TCHAR* GeneratedIniFile, const TCHAR* DefaultIniFile);
 
    bool Write(const TCHAR* Filename, FString& Contents);
 
    void FinishRead(const TCHAR* Filename);
 
    CORE_API static void Flush();
 
    /* Replaces chars used by the ini parser with "special chars". */
    CORE_API static FString ReplaceIniCharWithSpecialChar(const FString& Str);
 
    /* Replaces "special chars" that have been inserted to avoid problems with the ini parser with equivalent regular chars. */
    CORE_API static FString ReplaceIniSpecialCharWithChar(const FString& Str);
    
private:
 
    FString GenerateRemotePath(const TCHAR* Filename);
 
    TMap<FString, FRemoteConfigAsyncIOInfo> ConfigBuffers;
 
    float Timeout;
 
    bool bIsEnabled;
 
    bool bHasCachedFilenames;
 
    TArray<FString> CachedFileNames;
};
 
 
bool IsUsingLocalIniFile(const TCHAR* FilenameToLoad, const TCHAR* IniFileName);
 
void ProcessIniContents(const TCHAR* FilenameToLoad, const TCHAR* IniFileName, FConfigFile* Config, bool bDoEmptyConfig, bool bDoCombine);
 
FDateTime GetIniTimeStamp(const TCHAR* FilenameToLoad, const TCHAR* IniFileName);
 
void MakeLocalCopy(const TCHAR* Filename);