macros.h

Go to the documentation of this file.

#ifndef _MACROS_H_
#define _MACROS_H_
 
#define CLAMP(a, l, u) ((a) < l ? l : ((a) > u ? u : (a)))
 
#define MIN(a, b) (((a) < (b)) ? (a) : (b))
 
#define MAX(a, b) (((a) > (b)) ? (a) : (b))
 
#define ABS(a) (((a) < (0)) ? -(a) : (a))
 
#ifdef __APPLE__
    /* Force a compilation error if condition is true, but also produce a
        result (of value 0 and type size_t), so the expression can be used
        e.g. in a structure initializer (or where-ever else comma expressions
        aren't permitted). */
    #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int : -!!(e); }))
 
    #define __must_be_array(a) BUILD_BUG_ON_ZERO(__builtin_types_compatible_p(typeof(a), typeof(&(a)[0])))
 
    #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
#else
    #define IS_ARRAY(arr) ((void*)&(arr) == &(arr)[0])
 
    #define STATIC_EXP(e) (0 * sizeof(struct { int ARRAY_SIZE_FAILED : (2 * (e)-1); }))
 
    #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + STATIC_EXP(IS_ARRAY(arr)))
#endif
 
#define POS_MODULO_ADD(a, b, d) ((a + (b % d) + d) % d)
 
#define RUN_TIMER_EVERY(timer, period, elapsed, timer_code) \
    do                                                      \
    {                                                       \
        timer += (elapsed);                                 \
        while (timer > (period))                            \
        {                                                   \
            timer -= (period);                              \
            {                                               \
                timer_code                                  \
            }                                               \
        }                                                   \
    } while (0)
#define RUN_TIMER_EVERY(timer, period, elapsed, timer_code) \ …
 
#define NUM_FRAME_TIMES 60
#define DRAW_FPS_COUNTER(font)                                                \
    do                                                                        \
    {                                                                         \
        static uint32_t frameTimesIdx               = 0;                      \
        static uint32_t frameTimes[NUM_FRAME_TIMES] = {0};                    \
                                                                              \
        int32_t startIdx  = (frameTimesIdx + 1) % NUM_FRAME_TIMES;            \
        uint32_t tElapsed = frameTimes[frameTimesIdx] - frameTimes[startIdx]; \
        if (0 != tElapsed)                                                    \
        {                                                                     \
            uint32_t fps = (1000000 * NUM_FRAME_TIMES) / tElapsed;            \
            char tmp[16];                                                     \
            snprintf(tmp, sizeof(tmp) - 1, "%" PRIu32, fps);                  \
            fillDisplayArea(34, 1, 51, 3 + font.height, c000);                \
            drawText(&font, c555, tmp, 35, 2);                                \
        }                                                                     \
        frameTimesIdx             = (frameTimesIdx + 1) % NUM_FRAME_TIMES;    \
        frameTimes[frameTimesIdx] = esp_timer_get_time();                     \
    } while (0)
#define DRAW_FPS_COUNTER(font)                                                \ …
 
#endif
 
#if defined(__XTENSA__)
// Memory tagging is not supported on real hardware
#define heap_caps_malloc_tag(s, c, t)     heap_caps_malloc(s, c)
#define heap_caps_calloc_tag(n, s, c, t)  heap_caps_calloc(n, s, c)
#define heap_caps_realloc_tag(p, s, c, t) heap_caps_realloc(p, s, c)
#define heap_caps_free_tag(p)             heap_caps_free(p)
#endif