UniversalObjectLocatorStringParams.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/StringView.h"
#include "Misc/EnumClassFlags.h"
#include "Internationalization/Text.h"
 
namespace UE::UniversalObjectLocator
{
 
enum class EParseStringFlags : uint8
{
    None = 0,
 
    ErrorMessaging = 1 << 0,
};
ENUM_CLASS_FLAGS(EParseStringFlags)
 
 
struct FParseStringParams
{
    EParseStringFlags Flags = EParseStringFlags::None;
 
    bool NeedsErrorMessaging() const
    {
        return EnumHasAnyFlags(Flags, EParseStringFlags::ErrorMessaging);
    }
};
 
#define UE_UOL_PARSE_ERROR(InParams, ...) InParams.NeedsErrorMessaging() ? (__VA_ARGS__) : FText()
 
struct FParseStringResult
{
    FText ErrorMessage;
 
    int32 NumCharsParsed = 0;
 
    bool bSuccess = false;
 
    explicit operator bool() const
    {
        return bSuccess;
    }
 
    FParseStringResult& Success(int32 AdditionalNumCharsParsed = 0)
    {
        NumCharsParsed += AdditionalNumCharsParsed;
        bSuccess = true;
        return *this;
    }
 
    FParseStringResult& Failure(const FText& InFailureText)
    {
        if (!InFailureText.IsEmpty())
        {
            // Only overwrite the error message if it's supplied
            ErrorMessage = InFailureText;
        }
        bSuccess = false;
        return *this;
    }
 
    UNIVERSALOBJECTLOCATOR_API FStringView Progress(FStringView CurrentString, int32 NumToProgress);
};
 
} // namespace UE::UniversalObjectLocator