DataValidation.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Logging/TokenizedMessage.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
 
#include "DataValidation.generated.h"
 
struct FAssetData;
 
UENUM(BlueprintType)
enum class EDataValidationUsecase : uint8
{
    None = 0,
 
    Manual,
 
    Commandlet,
 
    Save,
 
    PreSubmit,
 
    Script,
};
 
class FDataValidationContext : public FNoncopyable
{
public:
    struct FIssue
    {
        FText Message;
        EMessageSeverity::Type Severity;
        TSharedPtr<FTokenizedMessage> TokenizedMessage;
 
        FIssue(TSharedRef<FTokenizedMessage> InTokenizedMessage)
            : Message()
            , Severity(InTokenizedMessage->GetSeverity())
            , TokenizedMessage(InTokenizedMessage)
        {}
        FIssue(const FText& InMessage, EMessageSeverity::Type InSeverity)
            : Message(InMessage)
            , Severity(InSeverity)
            , TokenizedMessage()
        {}
    };
    
    FDataValidationContext() = default;
    
    FDataValidationContext(
        bool InWasAssetLoadedForValidation,
        EDataValidationUsecase InUsecase,
        TConstArrayView<FAssetData> InAssociatedObjects)
        : AssociatedExternalObjects(InAssociatedObjects)
        , ValidationUsecase(InUsecase)
        , bWasAssetLoadedForValidation(InWasAssetLoadedForValidation)
    {}
 
    EDataValidationUsecase GetValidationUsecase() const
    {
        return ValidationUsecase;
    }
    
    TConstArrayView<FAssetData> GetAssociatedExternalObjects() const
    {
        return AssociatedExternalObjects;
    }
    
    // Returns whether the asset currently being validation was loaded specifically for the purposes of validation
    // Otherwise it was already loaded before validation started
    // Default valid is false so that validators can attempt to reload asset to verify on-disk state/load process 
    // if unsure.
    // If true, allows that duplicate work to be skipped in some context. 
    bool WasAssetLoadedForValidation() const
    {
        return bWasAssetLoadedForValidation;
    }
 
    void MarkAssetLoadedForValidation()
    {
        bWasAssetLoadedForValidation = true;
    }
 
    COREUOBJECT_API TSharedRef<FTokenizedMessage> AddMessage(const FAssetData& ForAsset, EMessageSeverity::Type InSeverity, FText InText = {});
    COREUOBJECT_API TSharedRef<FTokenizedMessage> AddMessage(EMessageSeverity::Type InSeverity, FText InText = {});
    COREUOBJECT_API void AddMessage(TSharedRef<FTokenizedMessage> Message);
    void AddWarning(const FText& Text) { Issues.Emplace(Text, EMessageSeverity::Warning); NumWarnings++; }
    void AddError(const FText& Text) { Issues.Emplace(Text, EMessageSeverity::Error); NumErrors++; }
 
    const TArray<FIssue>& GetIssues() const { return Issues; }
    uint32 GetNumWarnings() const { return NumWarnings; }
    uint32 GetNumErrors() const { return NumErrors; }
 
    COREUOBJECT_API void SplitIssues(TArray<FText>& Warnings, TArray<FText>& Errors, TArray<TSharedRef<FTokenizedMessage>>* Messages = nullptr) const;
    
private:
    TArray<FIssue> Issues;
    uint32 NumWarnings = 0;
    uint32 NumErrors = 0;
    
    TConstArrayView<FAssetData> AssociatedExternalObjects;
    EDataValidationUsecase ValidationUsecase = EDataValidationUsecase::None;
    bool bWasAssetLoadedForValidation = false;
};