ConfigAccessTracking.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*---------------------------------------------------------------------------------------------------------------------
    Access tracking for Config cache. When compiled in, adds extra data to FConfigFile structures so that we can report
    File,Section,Value names whenever an FConfigValue is read. The data about any accessed ConfigValue is reported to
    callbacks registered via UE::ConfigAccessTracking::AddConfigValueReadCallback.
---------------------------------------------------------------------------------------------------------------------*/
#pragma once
 
#include "HAL/Platform.h"
#include "UObject/NameTypes.h"
 
#define UE_WITH_CONFIG_TRACKING (WITH_EDITOR || 0)
 
#if UE_WITH_CONFIG_TRACKING
#include <atomic>
#include "Containers/StringView.h"
#include "Templates/Function.h"
#include "Templates/RefCounting.h"
 
class FConfigCacheIni;
class FConfigFile;
class FConfigSection;
struct FConfigValue;
#endif
 
#if WITH_EDITOR || UE_WITH_CONFIG_TRACKING
 
namespace UE::ConfigAccessTracking
{
 
enum class ELoadType : uint8
{
    ConfigSystem,
    LocalIniFile,
    LocalSingleIniFile,
    ExternalIniFile,
    ExternalSingleIniFile,
    Manual,
    SuppressReporting,
    Uninitialized,
};
 
} // namespace UE::ConfigAccessTracking
 
#endif // WITH_EDITOR || UE_WITH_CONFIG_TRACKING
 
#if UE_WITH_CONFIG_TRACKING
 
namespace UE::ConfigAccessTracking
{
 
struct FFile : public FRefCountBase
{
    CORE_API FFile(const FConfigFile* InConfigFile);
    CORE_API FName GetFilenameToLoad() const;
    CORE_API FName GetPlatformName();
    CORE_API void SetAsLoadTypeConfigSystem(FConfigCacheIni& ConfigSystem, FConfigFile& ConfigFile);
 
public:
    const FConfigFile* ConfigFile = nullptr;
    FName OverrideFilenameToLoad;
private:
    FName PlatformName = NAME_None;
    FStringView SavedConfigFilePlatformName;
    bool bSavedHasConfigFile : 1; // = false;
    bool bSavedConfigFileHasPlatformName : 1; // = false;
    bool bPlatformNameInitialized : 1; // = false;
    bool bOverridePlatformName : 1; // = false;
    bool bSavedOverridePlatformName : 1; // = false;
};
 
struct FSection : public FRefCountBase
{
    CORE_API FSection(FFile& InFileAccess, FStringView InSectionName);
 
    TRefCountPtr<FFile> FileAccess;
    FNameEntryId SectionName;
};
 
using FConfigValueReadCallbackFunc = TFunction<void(UE::ConfigAccessTracking::FSection* Section,
    FMinimalName ValueName, const FConfigValue& ConfigValue)>;
 
struct FConfigValueReadCallbackId
{
    int32 Id = -1;
    bool IsValid() { return Id != -1; }
};
 
CORE_API FConfigValueReadCallbackId AddConfigValueReadCallback(FConfigValueReadCallbackFunc Callback);
CORE_API void RemoveConfigValueReadCallback(FConfigValueReadCallbackId DelegateHandle);
 
struct FIgnoreScope
{
public:
    CORE_API FIgnoreScope();
    CORE_API ~FIgnoreScope();
 
private:
    bool bPreviousIgnoreReads = false;
};
 
namespace Private
{
 
extern CORE_API std::atomic<int32> ConfigValueReadCallbackQuantity;
 
CORE_API void OnConfigValueReadInternal(UE::ConfigAccessTracking::FSection* Section, FMinimalName ValueName,
    const FConfigValue& ConfigValue);
 
inline void OnConfigValueRead(UE::ConfigAccessTracking::FSection* Section, FMinimalName ValueName,
    const FConfigValue& ConfigValue)
{
    if (ConfigValueReadCallbackQuantity.load(std::memory_order_acquire) > 0)
    {
        OnConfigValueReadInternal(Section, ValueName, ConfigValue);
    }
}
 
} // namespace Private
 
} // namespace UE::ConfigAccessTracking
 
#else  // UE_WITH_CONFIG_TRACKING
 
namespace UE::ConfigAccessTracking
{
 
// Declare FSection even though it is undefined so that we can pass FSection* as an argument to FConfigSection and FConfigValue
// constructors rather than having to create separate constructors under #ifdef UE_WITH_CONFIG_TRACKING
struct FSection;
 
// Define FIgnoreScope even when !UE_WITH_CONFIG_TRACKING so we don't need to wrap its use in a macro.
struct FIgnoreScope
{
    FIgnoreScope(){}
    ~FIgnoreScope(){}
};
 
} // namespace UE::ConfigAccessTracking
 
#endif // else !UE_WITH_CONFIG_TRACKING