error.h

Go to the documentation of this file.

#pragma once
 
#include <banjo/api.h>
#include <banjo/memory.h>

typedef enum {
    BJ_ERROR_NONE                = 0x00000000, 
    BJ_ERROR                     = 0x00000001, 
    BJ_ERROR_UNSUPPORTED         = 0x00000101, 
    BJ_ERROR_NOT_IMPLEMENTED     = 0x00000201, 
 
    BJ_ERROR_SYSTEM              = 0x00000002, 
    BJ_ERROR_FILE_NOT_FOUND      = 0x00000102, 
    BJ_ERROR_CANNOT_ALLOCATE     = 0x00000202, 
    BJ_ERROR_INITIALIZE          = 0x00000302, 
    BJ_ERROR_DISPOSE             = 0x00000302, 
 
    BJ_ERROR_IO                  = 0x00000003, 
    BJ_ERROR_CANNOT_READ_FILE    = 0x00000103, 
 
    BJ_ERROR_INVALID_DATA        = 0x00000004, 
    BJ_ERROR_INVALID_FORMAT      = 0x00000104, 
    BJ_ERROR_INCORRECT_VALUE     = 0x00000204, 
 
    BJ_ERROR_VIDEO = 0x00000005, 
    
    BJ_ERROR_AUDIO = 0x00000006, 
} bj_error_code;

#define bj_error_code_is_user (c) (((c >> 24) & 0xFF) > 0x00)

#define bj_error_code_kind(c) (c & 0x000000FF)

#define BJ_ERROR_MESSAGE_MAX_LEN 127

typedef struct {
    uint32_t         code;                                
    char        message[BJ_ERROR_MESSAGE_MAX_LEN+1]; 
} bj_error;

BANJO_EXPORT void bj_set_error(
    bj_error**  p_error,
    uint32_t         code,
    const char* message
);

BANJO_EXPORT bj_bool bj_error_check(
    const bj_error* p_error,
    uint32_t code
);

BANJO_EXPORT bj_bool bj_forward_error(
    bj_error*  p_source,
    bj_error** p_destination
);

BANJO_EXPORT void bj_clear_error(
    bj_error** p_error
);