AnalyticsConversion.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
template <typename T>
inline decltype(auto) AnalyticsConversionToString(const T& Value)
{
    return LexToString(Value);
}
inline FString AnalyticsConversionToString(FString&& Value)
{
    return MoveTemp(Value);
}
inline FString AnalyticsConversionToString(const FString& Value)
{
    return Value;
}
 
inline FString AnalyticsConversionToString(FStringView Value)
{
    return FString(Value);
}
 
#define ANALYTICS_MAX_FLOAT_VALUE_BEFORE_EXPONENTIAL_NOTATION (1.0e+15F)
 
inline FString AnalyticsConversionToString(float Value)
{
    if (FPlatformMath::IsFinite(Value))
    {
        if (Value > ANALYTICS_MAX_FLOAT_VALUE_BEFORE_EXPONENTIAL_NOTATION || Value < -ANALYTICS_MAX_FLOAT_VALUE_BEFORE_EXPONENTIAL_NOTATION)
        {
            return FString::Printf(TEXT("%.9e"), Value);
        }
        else
        {
            return LexToSanitizedString(Value);
        }
    }
    else
    {
        // This function exists to convert numbers to Json-compatible strings for analytics. Json doesn't support INF or NAN so we will just send null
        return "null";
    }
}
inline FString AnalyticsConversionToString(double Value)
{
    if (FPlatformMath::IsFinite(Value))
    {
        if (Value > ANALYTICS_MAX_FLOAT_VALUE_BEFORE_EXPONENTIAL_NOTATION || Value < -ANALYTICS_MAX_FLOAT_VALUE_BEFORE_EXPONENTIAL_NOTATION)
        {
            return FString::Printf(TEXT("%.9e"), Value);
        }
        else
        {
            return LexToSanitizedString(Value);
        }
    }
    else
    {
        // This function exists to convert numbers to Json-compatible strings for analytics. Json doesn't support INF or NAN so we will just send null
        return "null";
    }
}
 
template <typename T, typename AllocatorType>
FString AnalyticsConversionToString(const TArray<T, AllocatorType>& ValueArray)
{
    FString Result;
    // Serialize the array into "value1,value2,..." format
    for (const T& Value : ValueArray)
    {
        Result += AnalyticsConversionToString(Value);
        Result += TEXT(",");
    }
    // Remove the trailing comma (LeftChop will ensure an empty container won't crash here).
    Result.LeftChopInline(1, EAllowShrinking::No);
    return Result;
}
 
template <typename T>
FString AnalyticsConversionToString(const TArrayView<T>& ValueArray)
{
    FString Result;
    // Serialize the array into "value1,value2,..." format
    for (const T& Value : ValueArray)
    {
        Result += AnalyticsConversionToString(Value);
        Result += TEXT(",");
    }
    // Remove the trailing comma (LeftChop will ensure an empty container won't crash here).
    Result.LeftChopInline(1, EAllowShrinking::No);
    return Result;
}
 
template<typename KeyType, typename ValueType, typename Allocator, typename KeyFuncs>
FString AnalyticsConversionToString(const TMap<KeyType, ValueType, Allocator, KeyFuncs>& ValueMap)
{
    FString Result;
    // Serialize the map into "key:value,..." format
    for (auto& KVP : ValueMap)
    {
        Result += AnalyticsConversionToString(KVP.Key);
        Result += TEXT(":");
        Result += AnalyticsConversionToString(KVP.Value);
        Result += TEXT(",");
    }
    // Remove the trailing comma (LeftChop will ensure an empty container won't crash here).
    Result.LeftChopInline(1, EAllowShrinking::No);
    return Result;
}
 
namespace AnalyticsConversion
{
    template <typename T>
    inline decltype(auto) ToString(T&& Value)
    {
        return AnalyticsConversionToString(Forward<T>(Value));
    }
}