CompilationResult.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
 
/**
 * Enumerates possible results of a compilation operation.
 *
 * This enum has to be compatible with the one defined in the
 * Engine\Source\Programs\UnrealBuildTool\System\ExternalExecution.cs file
 * to keep communication between UHT, UBT and Editor compiling processes valid.
 */
namespace ECompilationResult
{
    enum Type
    {
        /** Compilation succeeded */
        Succeeded = 0,
        /** Build was canceled, this is used on the engine side only */
        Canceled = 1,
        /** All targets were up to date, used only with -canskiplink */
        UpToDate = 2,
        /** The process has most likely crashed. This is what UE returns in case of an assert */
        CrashOrAssert = 3,
        /** Compilation failed because generated code changed which was not supported */
        FailedDueToHeaderChange = 4,
        /** Compilation failed due to the engine modules needing to be rebuilt */
        FailedDueToEngineChange = 5,
        /** Compilation failed due to compilation errors */
        OtherCompilationError = 6,
        /** Compilation failed due to live coding limit reached */
        LiveCodingLimitError = 7,
        /** Compilation is not supported in the current build */
        Unsupported,
        /** Unknown error */
        Unknown
    };
 
    /**
    * Converts ECompilationResult enum to string.
    */
    static FORCEINLINE const TCHAR* ToString(ECompilationResult::Type Result)
    {
        switch (Result)
        {
        case ECompilationResult::UpToDate:
            return TEXT("UpToDate");
        case ECompilationResult::Canceled:
            return TEXT("Canceled");
        case ECompilationResult::Succeeded:
            return TEXT("Succeeded");
        case ECompilationResult::FailedDueToHeaderChange:
            return TEXT("FailedDueToHeaderChange");
        case ECompilationResult::OtherCompilationError:
            return TEXT("OtherCompilationError");
        case ECompilationResult::CrashOrAssert:
            return TEXT("CrashOrAssert");
        case ECompilationResult::LiveCodingLimitError:
            return TEXT("LiveCodingLimitError");
        case ECompilationResult::Unsupported:
            return TEXT("Unsupported");
        };
        return TEXT("Unknown");
    }
 
    /**
    * Returns false if the provided Result is either UpToDate or Succeeded.
    */
    static FORCEINLINE bool Failed(ECompilationResult::Type Result)
    {
        return !(Result == ECompilationResult::Succeeded || Result == ECompilationResult::UpToDate);
    }
}