util.h

Go to the documentation of this file.

 
#ifndef UTIL_H
#define UTIL_H
 
#include <stdint.h>
#ifdef MGBA_LOGGING
#include "mgba_logger.h"
#endif
 
#define GBAL_ATTRIBUTE(attr) __attribute__((attr))
 
#define GBAL_UNUSED GBAL_ATTRIBUTE(unused)
 
#define GBAL_FALLTHROUGH GBAL_ATTRIBUTE(fallthrough)
 
#define UNDEFINED -1
 
#define MAX_BASE36 0x81BF0FFF
 
#define SIGN(x) ((x > 0) - (x < 0))
 
#define NUM_ELEM_IN_ARR(arr) (sizeof(arr) / sizeof((arr)[0]))
 
#define INT_MAX_DIGITS    11 // strlen(str(INT_MAX)) = strlen("-2147483647")
#define UINT_MAX_DIGITS   10 // strlen(str(UINT32_MAX)) = strlen("4294967295")
#define UINT8_MAX_DIGITS  3  // strlen(str(UINT8_MAX)) = strlen("255")
#define BASE36_MAX_DIGITS 6  // strlen("ZZZZZZ")
 
#define ONE_K 1000
#define ONE_M 1000000
#define ONE_B 1000000000
 
#define ONE_K_ZEROS 3
#define ONE_M_ZEROS 6
#define ONE_B_ZEROS 9
 
// The suffix replaces everything past the third digit, e.g. "999K" -> "1M"
// so it needs at least this number of chars to be able to display any suffixed number
#define SUFFIXED_NUM_MIN_REQ_CHARS 4
 
#ifdef MGBA_LOGGING
#define LOG_ERROR(...) MGBA_FUNC_ERROR(__VA_ARGS__)
#else
// TODO: Add a define to conditionally compile print error to console and add it to the tests?
#define LOG_ERROR(...) ((void)(0))
#endif
 
#define GBAL_CUST_MSG_RETURN_IF_ASSERT_FAILS(expression, ret_val, message, ...) \
    do                                                                          \
    {                                                                           \
        if (!(expression))                                                      \
        {                                                                       \
            LOG_ERROR(message __VA_OPT__(, ) __VA_ARGS__);                      \
            return ret_val;                                                     \
        }                                                                       \
    } while (0)
 
#define GBAL_RETURN_IF_ASSERT_FAILS(expression, ret_val) \
    GBAL_CUST_MSG_RETURN_IF_ASSERT_FAILS(expression, ret_val, "Assert failed: %s", #expression)
 
#define GBAL_CUST_MSG_RETURN_IF_NULL(param, ret_val, message, ...) \
    GBAL_CUST_MSG_RETURN_IF_ASSERT_FAILS(                          \
        (param) != NULL,                                           \
        ret_val,                                                   \
        message __VA_OPT__(, ) __VA_ARGS__                         \
    )
 
#define GBAL_RETURN_IF_NULL(param, ret_val) \
    GBAL_CUST_MSG_RETURN_IF_NULL(param, ret_val, "Unexpected %s == NULL", #param)
 
#define RET_NONE
 
uint32_t u32_protected_add(uint32_t a, uint32_t b);
 
uint16_t u16_protected_add(uint16_t a, uint16_t b);
 
uint32_t u32_protected_mult(uint32_t a, uint32_t b);
 
uint16_t u16_protected_mult(uint16_t a, uint16_t b);
 
void truncate_uint_to_suffixed_str(
    uint32_t num,
    int num_req_chars,
    char out_str_buff[UINT_MAX_DIGITS + 1]
);
 
static inline int u32_get_digits(uint32_t n)
{
    if (n < 10)
        return 1;
    if (n < 100)
        return 2;
    if (n < 1000)
        return 3;
    if (n < 10000)
        return 4;
    if (n < 100000)
        return 5;
    if (n < 1000000)
        return 6;
    if (n < 10000000)
        return 7;
    if (n < 100000000)
        return 8;
    if (n < 1000000000)
        return 9;
    return 10;
}
 
uint32_t base36_to_u32(const char b36_str[]);
 
void u32_to_base36(uint32_t n, char b36_str[]);
 
#endif // UTIL_H