error.h

Go to the documentation of this file.

#ifndef BJ_ERROR_H
#define BJ_ERROR_H
 
#include <banjo/api.h>

enum bj_error_code {
    BJ_ERROR_NONE            = 0x00000000,
 
    // Kind 0x01: General/Unspecified errors
    BJ_ERROR                 = 0x00000001,
    BJ_ERROR_UNSUPPORTED     = 0x00000101,
    BJ_ERROR_NOT_IMPLEMENTED = 0x00000201,
 
    // Kind 0x02: System/OS errors
    BJ_ERROR_SYSTEM          = 0x00000002,
    BJ_ERROR_FILE_NOT_FOUND  = 0x00000102,
    BJ_ERROR_CANNOT_ALLOCATE = 0x00000202,
    BJ_ERROR_INITIALIZE      = 0x00000302,
    BJ_ERROR_DISPOSE         = 0x00000402,
 
    // Kind 0x03: I/O errors
    BJ_ERROR_IO              = 0x00000003,
    BJ_ERROR_CANNOT_READ     = 0x00000103,
    BJ_ERROR_CANNOT_WRITE    = 0x00000203,
 
    // Kind 0x04: Data validation errors
    BJ_ERROR_INVALID_DATA    = 0x00000004,
    BJ_ERROR_INVALID_FORMAT  = 0x00000104,
    BJ_ERROR_INCORRECT_VALUE = 0x00000204,
 
    // Kind 0x05: Video subsystem errors
    BJ_ERROR_VIDEO           = 0x00000005,
 
    // Kind 0x06: Audio subsystem errors
    BJ_ERROR_AUDIO           = 0x00000006,
};

#define bj_error_code_kind(code) ((code) & 0x000000FFu)

#define bj_error_code_is_user(code) (((code) >> 24) & 0xFFu)

struct bj_error;

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

BANJO_EXPORT void bj_set_error_fmt(
    struct bj_error** error,
    uint32_t          code,
    const char*       format,
    ...
);

BANJO_EXPORT void bj_propagate_error(
    struct bj_error** dest,
    struct bj_error*  src
);

BANJO_EXPORT void bj_propagate_prefixed_error(
    struct bj_error** dest,
    struct bj_error*  src,
    const char*       format,
    ...
);

BANJO_EXPORT void bj_prefix_error(
    struct bj_error** error,
    const char*       prefix
);

BANJO_EXPORT void bj_prefix_error_fmt(
    struct bj_error** error,
    const char*       format,
    ...
);

BANJO_EXPORT struct bj_error* bj_copy_error(
    const struct bj_error* error
);

BANJO_EXPORT void bj_clear_error(
    struct bj_error** error
);

BANJO_EXPORT bj_bool bj_error_matches(
    const struct bj_error* error,
    uint32_t               code
);

BANJO_EXPORT bj_bool bj_error_matches_kind(
    const struct bj_error* error,
    uint32_t               kind
);

BANJO_EXPORT uint32_t bj_error_code(
    const struct bj_error* error
);

BANJO_EXPORT const char* bj_error_message(
    const struct bj_error* error
);
 
#endif