JsonObject.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 "CoreMinimal.h"
#include "Dom/JsonValue.h"
#include "HAL/Platform.h"
#include "JsonGlobals.h"
#include "Logging/LogCategory.h"
#include "Logging/LogMacros.h"
#include "Serialization/JsonTypes.h"
#include "Templates/SharedPointer.h"
#include "Trace/Detail/Channel.h"
 
class FJsonObject
{
public:
 
    TMap<FString, TSharedPtr<FJsonValue>> Values;
 
    template<EJson JsonType>
    TSharedPtr<FJsonValue> GetField(FStringView FieldName) const
    {
        return GetField(FieldName, JsonType);
    }
 
    TSharedPtr<FJsonValue> GetField(FStringView FieldName, EJson JsonType) const
    {
        const TSharedPtr<FJsonValue>* Field = Values.FindByHash(GetTypeHash(FieldName), FieldName);
        if (Field != nullptr && Field->IsValid())
        {
            if (JsonType == EJson::None || (*Field)->Type == JsonType)
            {
                return (*Field);
            }
            else
            {
                UE_LOG(LogJson, Warning, TEXT("Field %.*s is of the wrong type."), FieldName.Len(), FieldName.GetData());
            }
        }
        else
        {
            UE_LOG(LogJson, Warning, TEXT("Field %.*s was not found."), FieldName.Len(), FieldName.GetData());
        }
 
        return MakeShared<FJsonValueNull>();
    }
 
    TSharedPtr<FJsonValue> TryGetField(FStringView FieldName) const
    {
        const TSharedPtr<FJsonValue>* Field = Values.FindByHash(GetTypeHash(FieldName), FieldName);
        return (Field != nullptr && Field->IsValid()) ? *Field : TSharedPtr<FJsonValue>();
    }
 
    bool HasField(FStringView FieldName) const
    {
        const TSharedPtr<FJsonValue>* Field = Values.FindByHash(GetTypeHash(FieldName), FieldName);
        if(Field && Field->IsValid())
        {
            return true;
        }
 
        return false;
    }
    
    template<EJson JsonType>
    bool HasTypedField(FStringView FieldName) const
    {
        return HasTypedField(FieldName, JsonType);
    }
 
    bool HasTypedField(FStringView FieldName, EJson JsonType) const
    {
        const TSharedPtr<FJsonValue>* Field = Values.FindByHash(GetTypeHash(FieldName), FieldName);
        if (Field && Field->IsValid() && ((*Field)->Type == JsonType))
        {
            return true;
        }
 
        return false;
    }
 
    JSON_API void SetField(FString&& FieldName, const TSharedPtr<FJsonValue>& Value);
    JSON_API void SetField(const FString& FieldName, const TSharedPtr<FJsonValue>& Value);
 
    JSON_API void RemoveField(FStringView FieldName);
 
    JSON_API double GetNumberField(FStringView FieldName) const;
 
    inline int32 GetIntegerField(FStringView FieldName) const
    {
        return (int32)GetNumberField(FieldName);
    }
 
    JSON_API bool TryGetNumberField(FStringView FieldName, float& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, double& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, int8& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, int16& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, int32& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, int64& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, uint8& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, uint16& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, uint32& OutNumber) const;
 
    JSON_API bool TryGetNumberField(FStringView FieldName, uint64& OutNumber) const;
 
    JSON_API void SetNumberField(FString&& FieldName, double Number);
    JSON_API void SetNumberField(const FString& FieldName, double Number);
 
    JSON_API FString GetStringField(FStringView FieldName) const;
 
    JSON_API FUtf8String GetUtf8StringField(FStringView FieldName) const;
 
    JSON_API bool TryGetStringField(FStringView FieldName, FString& OutString) const;
 
    JSON_API bool TryGetStringArrayField(FStringView FieldName, TArray<FString>& OutArray) const;
 
    template<typename TEnum>
    bool TryGetEnumArrayField(FStringView FieldName, TArray<TEnum>& OutArray) const
    {
        TArray<FString> Strings;
        if (!TryGetStringArrayField(FieldName, Strings))
        {
            return false;
        }
 
        OutArray.Empty();
        for (const FString& String : Strings)
        {
            TEnum Value;
            if (LexTryParseString(Value, *String))
            {
                OutArray.Add(Value);
            }
        }
        return true;
    }
 
    void SetStringField(FString&& FieldName, const ANSICHAR* StringValue)
    {
        SetStringField(MoveTemp(FieldName), FUtf8String(StringValue));
    }
    void SetStringField(const FString& FieldName, const ANSICHAR* StringValue)
    {
        SetStringField(FieldName, FUtf8String(StringValue));
    }
    void SetStringField(FString&& FieldName, const TCHAR* StringValue)
    {
        SetStringField(MoveTemp(FieldName), FString(StringValue));
    }
    void SetStringField(const FString& FieldName, const TCHAR* StringValue)
    {
        SetStringField(FieldName, FString(StringValue));
    }
    void SetStringField(FString&& FieldName, const UTF8CHAR* StringValue)
    {
        SetStringField(MoveTemp(FieldName), FUtf8String(StringValue));
    }
    void SetStringField(const FString& FieldName, const UTF8CHAR* StringValue)
    {
        SetStringField(FieldName, FUtf8String(StringValue));
    }
 
    JSON_API void SetStringField(FString&& FieldName, FString&& StringValue);
    JSON_API void SetStringField(FString&& FieldName, const FString& StringValue);
    JSON_API void SetStringField(const FString& FieldName, FString&& StringValue);
    JSON_API void SetStringField(const FString& FieldName, const FString& StringValue);
    JSON_API void SetStringField(FString&& FieldName, FUtf8String&& StringValue);
    JSON_API void SetStringField(FString&& FieldName, const FUtf8String& StringValue);
    JSON_API void SetStringField(const FString& FieldName, FUtf8String&& StringValue);
    JSON_API void SetStringField(const FString& FieldName, const FUtf8String& StringValue);
 
    JSON_API bool GetBoolField(FStringView FieldName) const;
 
    JSON_API bool TryGetBoolField(FStringView FieldName, bool& OutBool) const;
 
    JSON_API void SetBoolField(FString&& FieldName, bool InValue);
    JSON_API void SetBoolField(const FString& FieldName, bool InValue);
 
    JSON_API const TArray<TSharedPtr<FJsonValue>>& GetArrayField(FStringView FieldName) const;
 
    JSON_API bool TryGetArrayField(FStringView FieldName, const TArray<TSharedPtr<FJsonValue>>*& OutArray) const;
 
    JSON_API void SetArrayField(FString&& FieldName, TArray<TSharedPtr<FJsonValue>>&& Array);
    JSON_API void SetArrayField(FString&& FieldName, const TArray<TSharedPtr<FJsonValue>>& Array);
    JSON_API void SetArrayField(const FString& FieldName, TArray<TSharedPtr<FJsonValue>>&& Array);
    JSON_API void SetArrayField(const FString& FieldName, const TArray<TSharedPtr<FJsonValue>>& Array);
 
    JSON_API const TSharedPtr<FJsonObject>& GetObjectField(FStringView FieldName) const;
 
    JSON_API bool TryGetObjectField(FStringView FieldName, const TSharedPtr<FJsonObject>*& OutObject) const;
 
    JSON_API void SetObjectField(FString&& FieldName, const TSharedPtr<FJsonObject>& JsonObject);
    JSON_API void SetObjectField(const FString& FieldName, const TSharedPtr<FJsonObject>& JsonObject);
 
    SIZE_T GetMemoryFootprint() const { return sizeof(*this) + GetAllocatedSize(); }
private:
    JSON_API SIZE_T GetAllocatedSize() const;
 
public:
    static JSON_API void Duplicate(const TSharedPtr<const FJsonObject>& Source, const TSharedPtr<FJsonObject>& Dest);
    static JSON_API void Duplicate(const TSharedPtr<FJsonObject>& Source, TSharedPtr<FJsonObject>& Dest);
 
#if !PLATFORM_TCHAR_IS_UTF8CHAR
 
    template <EJson JsonType>
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    TSharedPtr<FJsonValue> GetField(FAnsiStringView FieldName) const
    {
        return GetField<JsonType>(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    TSharedPtr<FJsonValue> TryGetField(FAnsiStringView FieldName) const
    {
        return TryGetField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to HasField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool HasField(FAnsiStringView FieldName) const
    {
        return HasField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    template <EJson JsonType>
    UE_DEPRECATED(5.4, "Passing an ANSI string to HasTypedField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool HasTypedField(FAnsiStringView FieldName) const
    {
        return HasTypedField<JsonType>(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to RemoveField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    void RemoveField(FAnsiStringView FieldName)
    {
        return RemoveField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    double GetNumberField(FAnsiStringView FieldName) const
    {
        return GetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetIntegerField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    int32 GetIntegerField(FAnsiStringView FieldName) const
    {
        return GetIntegerField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, float& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, double& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, int8& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, int16& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, int32& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, int64& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, uint8& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, uint16& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, uint32& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetNumberField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetNumberField(FAnsiStringView FieldName, uint64& OutNumber) const
    {
        return TryGetNumberField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutNumber);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetStringField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    FString GetStringField(FAnsiStringView FieldName) const
    {
        return GetStringField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetStringField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetStringField(FAnsiStringView FieldName, FString& OutString) const
    {
        return TryGetStringField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutString);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetStringArrayField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetStringArrayField(FAnsiStringView FieldName, TArray<FString>& OutArray) const
    {
        return TryGetStringArrayField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutArray);
    }
 
    template <typename TEnum>
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetEnumArrayField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetEnumArrayField(FAnsiStringView FieldName, TArray<TEnum>& OutArray) const
    {
        return TryGetEnumArrayField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutArray);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetBoolField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool GetBoolField(FAnsiStringView FieldName) const
    {
        return GetBoolField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetBoolField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetBoolField(FAnsiStringView FieldName, bool& OutBool) const
    {
        return TryGetBoolField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutBool);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetArrayField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    const TArray<TSharedPtr<FJsonValue>>& GetArrayField(FAnsiStringView FieldName) const
    {
        return GetArrayField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetArrayField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetArrayField(FAnsiStringView FieldName, const TArray<TSharedPtr<FJsonValue>>*& OutArray) const
    {
        return TryGetArrayField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutArray);
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to GetObjectField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    const TSharedPtr<FJsonObject>& GetObjectField(FAnsiStringView FieldName) const
    {
        return GetObjectField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()));
    }
 
    UE_DEPRECATED(5.4, "Passing an ANSI string to TryGetObjectField has been deprecated outside of UTF-8 mode. Please use the overload that takes a TCHAR string.")
    bool TryGetObjectField(FAnsiStringView FieldName, const TSharedPtr<FJsonObject>*& OutObject) const
    {
        return TryGetObjectField(StringCast<TCHAR>(FieldName.GetData(), FieldName.Len()), OutObject);
    }
 
#endif // !PLATFORM_TCHAR_IS_UTF8CHAR
 
};