Analytics.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnalyticsBuildType.h"
#include "AnalyticsProviderConfigurationDelegate.h"
#include "Containers/UnrealString.h"
#include "CoreGlobals.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Logging/LogMacros.h"
#include "Misc/ConfigCacheIni.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
 
ANALYTICS_API DECLARE_LOG_CATEGORY_EXTERN(LogAnalytics, Display, All);
 
class IAnalyticsProvider;
class IAnalyticsTracer;
 
class FAnalytics : public IModuleInterface
{
    //--------------------------------------------------------------------------
    // Module functionality
    //--------------------------------------------------------------------------
public:
    FAnalytics();
    virtual ~FAnalytics();
 
    static inline FAnalytics& Get()
    {
        return FModuleManager::LoadModuleChecked< FAnalytics >( "Analytics" );
    }
 
    static inline bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded( "Analytics" );
    }
 
    //--------------------------------------------------------------------------
    // Provider Factory functions.
    //--------------------------------------------------------------------------
public:
    virtual TSharedPtr<IAnalyticsProvider> CreateAnalyticsProvider(const FName& ProviderModuleName, const FAnalyticsProviderConfigurationDelegate& GetConfigValue);
 
    virtual TSharedPtr<IAnalyticsTracer> CreateAnalyticsTracer();
    virtual TSharedPtr<IAnalyticsProvider> GetDefaultConfiguredProvider()
    {
        FAnalytics::ConfigFromIni AnalyticsConfig;                     // configure using the default INI sections.
        return FAnalytics::Get().CreateAnalyticsProvider(              // call the factory function
            FAnalytics::ConfigFromIni::GetDefaultProviderModuleName(), // use the default config to find the provider name
            FAnalyticsProviderConfigurationDelegate::CreateRaw(        // bind to the delegate using default INI sections
                &AnalyticsConfig,                                      // use default INI config sections
                &FAnalytics::ConfigFromIni::GetValue));                
    }
 
    //--------------------------------------------------------------------------
    // Configuration helper classes and methods
    //--------------------------------------------------------------------------
public:
    struct ConfigFromIni
    {
        ConfigFromIni()
            :IniName(GEngineIni)
        {
            SetSectionNameByBuildType(GetAnalyticsBuildType());
        }
 
        explicit ConfigFromIni(EAnalyticsBuildType InBuildType)
            :IniName(GEngineIni)
        {
            SetSectionNameByBuildType(InBuildType);
        }
 
        ConfigFromIni(const FString& InIniName, const FString& InSectionName)
            :IniName(InIniName)
            ,SectionName(InSectionName) 
        {
        }
 
        ConfigFromIni(const FString& InIniName, const FString& SectionNameDevelopment, const FString& SectionNameDebug, const FString& SectionNameTest, const FString& SectionNameRelease)
            :IniName(InIniName)
        {
            EAnalyticsBuildType BuildType = GetAnalyticsBuildType();
            SectionName = BuildType == EAnalyticsBuildType::Release
                ? SectionNameRelease
                : BuildType == EAnalyticsBuildType::Debug
                    ? SectionNameDebug
                    : BuildType == EAnalyticsBuildType::Test
                        ? SectionNameTest
                        : SectionNameDevelopment;
        }
 
        FString GetValue(const FString& KeyName, bool bIsRequired) const
        {
            return FAnalytics::Get().GetConfigValueFromIni(IniName, SectionName, KeyName, bIsRequired);
        }
 
        static FName GetDefaultProviderModuleName()
        {
            FString ProviderModuleName;
            GConfig->GetString(TEXT("Analytics"), TEXT("ProviderModuleName"), ProviderModuleName, GEngineIni);
            return FName(*ProviderModuleName);
        }
 
        void SetSectionNameByBuildType(EAnalyticsBuildType InBuildType)
        {
            SectionName = InBuildType == EAnalyticsBuildType::Release
                ? TEXT("Analytics") 
                : InBuildType == EAnalyticsBuildType::Debug
                    ? TEXT("AnalyticsDebug") 
                    : InBuildType == EAnalyticsBuildType::Test
                        ? TEXT("AnalyticsTest") 
                        : TEXT("AnalyticsDevelopment");
        }
 
        FString IniName;
        FString SectionName;
    };
 
    virtual FString GetConfigValueFromIni(const FString& IniName, const FString& SectionName, const FString& KeyName, bool bIsRequired);
 
    virtual void WriteConfigValueToIni(const FString& IniName, const FString& SectionName, const FString& KeyName, const FString& Value);
 
private:
    virtual void StartupModule() override;
    virtual void ShutdownModule() override;
};