ConfigContext.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 "CoreGlobals.h"
#include "CoreTypes.h"
#include "Misc/ConfigTypes.h"
// @todo mvoe types into ConfigTypes.h so we don't need to include the monster here
#include "Misc/ConfigCacheIni.h"
 
 
#ifndef CUSTOM_CONFIG
#define CUSTOM_CONFIG ""
#endif
 
#ifndef DISABLE_GENERATED_INI_WHEN_COOKED
#define DISABLE_GENERATED_INI_WHEN_COOKED 0
#endif
 
 
class FConfigCacheIni;
class FConfigFile;
class FConfigBranch;
 
class FConfigContext
{
public:
 
    static FConfigContext ReadIntoLocalFile(FConfigFile& DestConfigFile, const FString& Platform=FString())
    {
        return FConfigContext(nullptr, true, Platform, &DestConfigFile);
    }
 
    static FConfigContext ReadSingleIntoLocalFile(FConfigFile& DestConfigFile, const FString& Platform=FString())
    {
        return FConfigContext(nullptr, false, Platform, &DestConfigFile);
    }
 
    static FConfigContext ReadIntoGConfig()
    {
        return FConfigContext(GConfig, true, FString());
    }
 
    static FConfigContext ForceReloadIntoGConfig()
    {
        FConfigContext Context(GConfig, true, FString());
        Context.bForceReload = true;
        return Context;
    }
 
    static FConfigContext ReadSingleIntoGConfig()
    {
        return FConfigContext(GConfig, false, FString());
    }
 
    static FConfigContext ReadIntoConfigSystem(FConfigCacheIni* ConfigSystem, const FString& Platform)
    {
        return FConfigContext(ConfigSystem, true, Platform);
    }
 
    static FConfigContext ReadSingleIntoConfigSystem(FConfigCacheIni* ConfigSystem, const FString& Platform)
    {
        return FConfigContext(GConfig, false, Platform);
    }
 
    static FConfigContext ReadIntoPluginFile(FConfigFile& DestConfigFile, const FString& PluginRootDir, const TArray<FString>& ChildPluginsBaseDirs, const FString& Platform = FString())
    {
        FConfigContext Context(nullptr, true, Platform, &DestConfigFile);
        Context.bIsForPlugin = true;
        Context.PluginRootDir = PluginRootDir;
        Context.ChildPluginBaseDirs = ChildPluginsBaseDirs;
 
 
        // plugins are read in parallel, so we are reading into a file, but not touching GConfig, so bWriteDest would be false, but we
        // want to write them out as if we had been using GConfig
        // @todo: honestly, that's just to keep same behavior, but i am not sure it is correct behavior! actually why would reading in ever need to write out?
        Context.bWriteDestIni = true;
 
        return Context;
    }
 
    static FConfigContext ReadPluginIntoConfigSystem(FConfigCacheIni* ConfigSystem, FName PluginName, const FString& PluginRootDir, const TArray<FString>& ChildPluginsBaseDirs)
    {
        FConfigContext Context(ConfigSystem, true, FString());
        Context.bIsForPlugin = true;
        Context.PluginRootDir = PluginRootDir;
        Context.ChildPluginBaseDirs = ChildPluginsBaseDirs;
        Context.ConfigFileTag = PluginName;
 
        return Context;
    }
 
    static FConfigContext ReadPluginToModifyConfigSystem(FConfigCacheIni* ConfigSystem, DynamicLayerPriority Priority, FName PluginName, const FString& PluginRootDir, const TArray<FString>& ChildPluginsBaseDirs, FConfigModificationTracker* ChangeTracker=nullptr)
    {
        FConfigContext Context(ConfigSystem, true, FString());
        Context.bIsForPlugin = true;
        Context.bIsForPluginModification = true;
        Context.PluginRootDir = PluginRootDir;
        Context.ChildPluginBaseDirs = ChildPluginsBaseDirs;
        Context.ConfigFileTag = PluginName;
        Context.ChangeTracker = ChangeTracker;
        Context.PluginModificationPriority = Priority;
 
        return Context;
    }
 
    static FConfigContext ReadUpToBeforeFile(FConfigFile& DestConfigFile, const FString& Platform, const FString& StartSkippingAtFilename)
    {
        FConfigContext Context(nullptr, true, Platform, &DestConfigFile);
        Context.StartSkippingAtFilename = StartSkippingAtFilename;
        return Context;
    }
 
    static FConfigContext FixupBranchAfterBinaryConfig()
    {
        FConfigContext Context(GConfig, true, FString());
        Context.bIsFixingUpAfterBinaryConfig = true;
        Context.bForceReload = true;
        return Context;
    }
 
 
 
    static CORE_API void EnsureRequiredGlobalPathsHaveBeenInitialized();
    
    static CORE_API void VisualizeHierarchy(FOutputDevice& Ar, const TCHAR* IniName, const TCHAR* OverridePlatform, const TCHAR* OverrideProjectOrProgramDataDir, const TCHAR* OverridePluginDir=nullptr, const TArray<FString>* ChildPluginBaseDirs=nullptr);
    
    void CORE_API VisualizeHierarchy(FOutputDevice& Ar, const TCHAR* IniName);
 
    CORE_API bool Load(const TCHAR* IniName);
 
    CORE_API bool Load(const TCHAR* IniName, FString& OutFilename);
 
 
    // because the hierarchy can jump between platforms, we cache off some directories per chained-platform
    struct FPerPlatformDirs
    {
        FString PlatformExtensionEngineDir;
        FString PlatformExtensionProjectDir;
        FString PlatformExtensionPluginDir;
    };
    CORE_API const FPerPlatformDirs& GetPerPlatformDirs(const FString& PlatformName);
 
    CORE_API ~FConfigContext();
 
 
    // @todo make these private and friend the FCOnfigCacheIni and FConfigFile once everything is a member function!!!!
    FConfigCacheIni* ConfigSystem;
 
    FConfigFile* ExistingFile = nullptr;
    FConfigBranch* Branch = nullptr;
    FConfigBranch* TemporaryBranch = nullptr;
    
    FString DestIniFilename;
    FString Platform;
    FString SavePlatform;
    FString GeneratedConfigDir;
    FString BaseIniName;
    FString StartSkippingAtFilename;
 
    FString EngineConfigDir;
    FString EngineRootDir;
    FString ProjectConfigDir;
    FString ProjectRootDir;
    FString PluginRootDir;
    TArray<FString> ChildPluginBaseDirs;
    FConfigModificationTracker* ChangeTracker = nullptr;
    
    FName ConfigFileTag;
    
    // useful strings that are used alot when walking the hierarchy
    FString ProjectLimitedAccessDir;
    FString ProjectNotForLicenseesDir;
    FString ProjectNoRedistDir;
    TMap<FString, FPerPlatformDirs> PerPlatformDirs;
 
    // allow a custom set of layers
    TArray<FConfigLayer> OverrideLayers;
    
    bool bUseHierarchyCache = false;
    bool bAllowGeneratedIniWhenCooked = false;
    bool bForceReload = false;
    bool bAllowRemoteConfig = false;
    bool bIsHierarchicalConfig;
    bool bWriteDestIni = false;
    bool bDefaultEngineRequired = false;
    bool bIsForPlugin = false;
    bool bIsForPluginModification = false;
    // GameFeaturePlugins have WindowsFooGame.ini, not WindowsGame.ini
    bool bIncludeTagNameInBranchName = false;
    bool bIsMakingBinaryConfig = false;
    bool bIsFixingUpAfterBinaryConfig = false;
 
    DynamicLayerPriority PluginModificationPriority;
 
    // if this is non-null, it contains a set of pre-scanned ini files to use to find files, instead of looking on disk
    const TSet<FString>* IniCacheSet = nullptr;
    const TSet<FString>* StagedGlobalConfigCache = nullptr;
    const TSet<FString>* StagedPluginConfigCache = nullptr;
    
    TFunction<void(const TArray<FDynamicLayerInfo>&)> HandleLayersFunction = nullptr;
 
protected:
 
    bool bDoNotResetConfigFile = false;
    bool bCacheOnNextLoad = true;
 
    CORE_API FConfigContext(FConfigCacheIni* InConfigSystem, bool InIsHierarchicalConfig, const FString& InPlatform, FConfigFile* DestConfigFile=nullptr);
 
private:
 
    FConfigContext& ResetBaseIni(const TCHAR* InBaseIniName);
    void CachePaths();
 
    bool PrepareForLoad(bool& bPerformLoad);
    bool PerformLoad();
    bool PerformSingleFileLoad();
 
    void AddStaticLayersToHierarchy(TArray<FString>* GatheredLayerFilenames=nullptr, bool bIsForLogging=false);
    bool LoadIniFileHierarchy();
    bool GenerateDestIniFile();
 
    FString PerformFinalExpansions(const FString& InString, const FString& Platform);
 
    void LogVariables(const TCHAR* InBaseIniName, const FString& Platform);
};
 
bool DoesConfigFileExistWrapper(const TCHAR* IniFile, const TSet<FString>* IniCacheSet=nullptr, const TSet<FString>* PrimaryConfigFileCache = nullptr, const TSet<FString>* SecondaryConfigFileCache = nullptr);