JsonPointer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Dom/JsonValue.h"
#include "HAL/Platform.h"
#include "Templates/SharedPointer.h"
 
class FJsonObject;
class FJsonValue;
 
namespace UE::Json
{
    class FJsonPointer
    {
    public:
        FJsonPointer() = default;
        JSON_API FJsonPointer(FStringView Path);
        JSON_API FJsonPointer(const FJsonPointer& Other);
        JSON_API FJsonPointer(FJsonPointer&& Other) noexcept;
 
        JSON_API bool TryGet(const TSharedPtr<FJsonObject>& RootObject, TSharedPtr<FJsonValue>& OutValue) const;
 
        JSON_API bool TryGet(const TSharedPtr<FJsonValue>& RootValue, TSharedPtr<FJsonValue>& OutValue) const;
 
        JSON_API bool TryGet(const TArray<TSharedPtr<FJsonValue>>& RootValues, TSharedPtr<FJsonValue>& OutValue) const;
 
        inline bool IsValid() const
        {
            return Length() > 0;
        }
 
        inline int32 Length() const
        {
            return PathParts.Num();
        }
 
        JSON_API void Append(FStringView Part);
 
        JSON_API void SetArrayIndex(int32 Index);
 
        JSON_API FJsonPointer GetSubPath(int32 NumParts) const;
 
        JSON_API FString ToString() const;
 
        inline const FString& operator[](int32 Idx) const
        {
            return PathParts[Idx];
        }
 
        inline const TArray<FString>& GetAll() const
        {
            return PathParts;
        }
 
        static JSON_API FString EscapePart(const FString& Part);
        
        static JSON_API FString UnescapePart(const FString& Part);
 
    private:
        JSON_API bool ParsePath(const FString& InPath);
 
    private:
        TArray<FString> PathParts;
    };
}