Error.hpp

/*
** ETIB PROJECT, 2026
** evan
** File description:
** Error
*/
 
#pragma once
 
#include "evan/EvanPlatform.hpp"
 
namespace evan
{
    enum class Error {
        Ok = 0,
 
        // Recoverable — the consumer should react and keep running.
        Suboptimal,            // VK_SUBOPTIMAL_KHR: presentable, recreate soon
        SwapchainOutOfDate,    // VK_ERROR_OUT_OF_DATE_KHR: recreate swapchain
        NotReady,    // VK_NOT_READY / XR session not running / invalid
                     // time
        Unsupported,    // feature/capability unavailable on this build or
                        // device (e.g. AR on a desktop build)
 
        // Fatal — the consumer should stop cleanly.
        DeviceLost,     // VK_ERROR_DEVICE_LOST
        RuntimeLost,    // XR_ERROR_SESSION_LOST / XR_ERROR_INSTANCE_LOST /
                        // XR_SESSION_STATE_LOSS_PENDING
        OutOfMemory,    // VK_ERROR_OUT_OF_{HOST,DEVICE}_MEMORY
        RuntimeError    // anything else / GLFW errors
    };
 
    [[nodiscard]] constexpr bool isOk(Error error)
    {
        return error == Error::Ok;
    }
 
    [[nodiscard]] constexpr bool isFatal(Error error)
    {
        switch (error) {
            case Error::Ok:
            case Error::Suboptimal:
            case Error::SwapchainOutOfDate:
            case Error::NotReady:
            case Error::Unsupported:
                return false;
            case Error::DeviceLost:
            case Error::RuntimeLost:
            case Error::OutOfMemory:
            case Error::RuntimeError:
                return true;
        }
        return true;
    }
 
    [[nodiscard]] constexpr bool isRecoverable(Error error)
    {
        return !isOk(error) && !isFatal(error);
    }
 
    template<typename T> struct Result {
        Error code = Error::Ok;
        T value {};
    };
 
    [[nodiscard]] Error mapVkResult(VkResult result);
}    // namespace evan