GHOST: add GHOST_utildefines

Add macros from BLI_utildefines, mainly to avoid that avoid repetition
(ELEM, UNPACK*, CLAMP* & ARRAY_SIZE).

Also add macros LIKELY/UNLIKELY as there are quiet a lot of checks
for unlikely situations for GHOST/Wayland (not having a keyboard,
or mouse for e.g.).

3 files changed, 248 insertions, 0 deletions

diff --git a/intern/ghost/CMakeLists.txt b/intern/ghost/CMakeLists.txt
index 0203c5ecf5d..edf13b6eff0 100644
--- a/intern/ghost/CMakeLists.txt
+++ b/intern/ghost/CMakeLists.txt
@@ -65,6 +65,8 @@ set(SRC
   intern/GHOST_Util.h
   intern/GHOST_Window.h
   intern/GHOST_WindowManager.h
+  intern/GHOST_utildefines.h
+  intern/GHOST_utildefines_variadic.h
 )
 
 set(LIB
diff --git a/intern/ghost/intern/GHOST_utildefines.h b/intern/ghost/intern/GHOST_utildefines.h
new file mode 100644
index 00000000000..f0ae6e12d3e
--- /dev/null
+++ b/intern/ghost/intern/GHOST_utildefines.h
@@ -0,0 +1,210 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+/** \file
+ * \ingroup GHOST
+ *
+ * Utility defines (avoid depending on `BLI_utildefines.h`).
+ */
+
+#pragma once
+
+#include "GHOST_utildefines_variadic.h"
+
+/* -------------------------------------------------------------------- */
+/** \name Branch Prediction Macros
+ * \{ */
+
+/* hints for branch prediction, only use in code that runs a _lot_ where */
+#ifdef __GNUC__
+#  define LIKELY(x) __builtin_expect(!!(x), 1)
+#  define UNLIKELY(x) __builtin_expect(!!(x), 0)
+#else
+#  define LIKELY(x) (x)
+#  define UNLIKELY(x) (x)
+#endif
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Array Unpacking Macros
+ * \{ */
+
+/* unpack vector for args */
+#define UNPACK2(a) ((a)[0]), ((a)[1])
+#define UNPACK3(a) UNPACK2(a), ((a)[2])
+#define UNPACK4(a) UNPACK3(a), ((a)[3])
+/* pre may be '&', '*' or func, post may be '->member' */
+#define UNPACK2_EX(pre, a, post) (pre((a)[0]) post), (pre((a)[1]) post)
+#define UNPACK3_EX(pre, a, post) UNPACK2_EX(pre, a, post), (pre((a)[2]) post)
+#define UNPACK4_EX(pre, a, post) UNPACK3_EX(pre, a, post), (pre((a)[3]) post)
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Array Macros
+ * \{ */
+
+/* Assuming a static array. */
+#if defined(__GNUC__) && !defined(__cplusplus) && !defined(__clang__) && !defined(__INTEL_COMPILER)
+#  define ARRAY_SIZE(arr) \
+    ((sizeof(struct { int isnt_array : ((const void *)&(arr) == &(arr)[0]); }) * 0) + \
+     (sizeof(arr) / sizeof(*(arr))))
+#else
+#  define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(*(arr)))
+#endif
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Equal to Any Element (ELEM) Macro
+ * \{ */
+
+/* Manual line breaks for readability. */
+/* clang-format off */
+
+/* ELEM#(v, ...): is the first arg equal any others? */
+/* internal helpers. */
+#define _VA_ELEM2(v, a) ((v) == (a))
+#define _VA_ELEM3(v, a, b) \
+  (_VA_ELEM2(v, a) || _VA_ELEM2(v, b))
+#define _VA_ELEM4(v, a, b, c) \
+  (_VA_ELEM3(v, a, b) || _VA_ELEM2(v, c))
+#define _VA_ELEM5(v, a, b, c, d) \
+  (_VA_ELEM4(v, a, b, c) || _VA_ELEM2(v, d))
+#define _VA_ELEM6(v, a, b, c, d, e) \
+  (_VA_ELEM5(v, a, b, c, d) || _VA_ELEM2(v, e))
+#define _VA_ELEM7(v, a, b, c, d, e, f) \
+  (_VA_ELEM6(v, a, b, c, d, e) || _VA_ELEM2(v, f))
+#define _VA_ELEM8(v, a, b, c, d, e, f, g) \
+  (_VA_ELEM7(v, a, b, c, d, e, f) || _VA_ELEM2(v, g))
+#define _VA_ELEM9(v, a, b, c, d, e, f, g, h) \
+  (_VA_ELEM8(v, a, b, c, d, e, f, g) || _VA_ELEM2(v, h))
+#define _VA_ELEM10(v, a, b, c, d, e, f, g, h, i) \
+  (_VA_ELEM9(v, a, b, c, d, e, f, g, h) || _VA_ELEM2(v, i))
+#define _VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) \
+  (_VA_ELEM10(v, a, b, c, d, e, f, g, h, i) || _VA_ELEM2(v, j))
+#define _VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) \
+  (_VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) || _VA_ELEM2(v, k))
+#define _VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) \
+  (_VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) || _VA_ELEM2(v, l))
+#define _VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) \
+  (_VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) || _VA_ELEM2(v, m))
+#define _VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) \
+  (_VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) || _VA_ELEM2(v, n))
+#define _VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) \
+  (_VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) || _VA_ELEM2(v, o))
+#define _VA_ELEM17(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
+  (_VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) || _VA_ELEM2(v, p))
+/* clang-format on */
+
+/* reusable ELEM macro */
+#define ELEM(...) VA_NARGS_CALL_OVERLOAD(_VA_ELEM, __VA_ARGS__)
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Clamp Macros
+ * \{ */
+
+#define CLAMPIS(a, b, c) ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
+
+#define CLAMP(a, b, c) \
+  { \
+    if ((a) < (b)) { \
+      (a) = (b); \
+    } \
+    else if ((a) > (c)) { \
+      (a) = (c); \
+    } \
+  } \
+  (void)0
+
+#define CLAMP_MAX(a, c) \
+  { \
+    if ((a) > (c)) { \
+      (a) = (c); \
+    } \
+  } \
+  (void)0
+
+#define CLAMP_MIN(a, b) \
+  { \
+    if ((a) < (b)) { \
+      (a) = (b); \
+    } \
+  } \
+  (void)0
+
+#define CLAMP2(vec, b, c) \
+  { \
+    CLAMP((vec)[0], b, c); \
+    CLAMP((vec)[1], b, c); \
+  } \
+  (void)0
+
+#define CLAMP2_MIN(vec, b) \
+  { \
+    CLAMP_MIN((vec)[0], b); \
+    CLAMP_MIN((vec)[1], b); \
+  } \
+  (void)0
+
+#define CLAMP2_MAX(vec, b) \
+  { \
+    CLAMP_MAX((vec)[0], b); \
+    CLAMP_MAX((vec)[1], b); \
+  } \
+  (void)0
+
+#define CLAMP3(vec, b, c) \
+  { \
+    CLAMP((vec)[0], b, c); \
+    CLAMP((vec)[1], b, c); \
+    CLAMP((vec)[2], b, c); \
+  } \
+  (void)0
+
+#define CLAMP3_MIN(vec, b) \
+  { \
+    CLAMP_MIN((vec)[0], b); \
+    CLAMP_MIN((vec)[1], b); \
+    CLAMP_MIN((vec)[2], b); \
+  } \
+  (void)0
+
+#define CLAMP3_MAX(vec, b) \
+  { \
+    CLAMP_MAX((vec)[0], b); \
+    CLAMP_MAX((vec)[1], b); \
+    CLAMP_MAX((vec)[2], b); \
+  } \
+  (void)0
+
+#define CLAMP4(vec, b, c) \
+  { \
+    CLAMP((vec)[0], b, c); \
+    CLAMP((vec)[1], b, c); \
+    CLAMP((vec)[2], b, c); \
+    CLAMP((vec)[3], b, c); \
+  } \
+  (void)0
+
+#define CLAMP4_MIN(vec, b) \
+  { \
+    CLAMP_MIN((vec)[0], b); \
+    CLAMP_MIN((vec)[1], b); \
+    CLAMP_MIN((vec)[2], b); \
+    CLAMP_MIN((vec)[3], b); \
+  } \
+  (void)0
+
+#define CLAMP4_MAX(vec, b) \
+  { \
+    CLAMP_MAX((vec)[0], b); \
+    CLAMP_MAX((vec)[1], b); \
+    CLAMP_MAX((vec)[2], b); \
+    CLAMP_MAX((vec)[3], b); \
+  } \
+  (void)0
+
+/** \} */
diff --git a/intern/ghost/intern/GHOST_utildefines_variadic.h b/intern/ghost/intern/GHOST_utildefines_variadic.h
new file mode 100644
index 00000000000..4ee306a27b2
--- /dev/null
+++ b/intern/ghost/intern/GHOST_utildefines_variadic.h
@@ -0,0 +1,36 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+/** \file
+ * \ingroup bli
+ */
+
+/* NOTE: copied from `BLI_utildefines_variadic.h` which would be a bad-level include. */
+
+/* Over wrapped args. */
+/* clang-format off */
+
+/* --- internal helpers --- */
+#define _VA_NARGS_GLUE(x, y) x y
+#define _VA_NARGS_RETURN_COUNT(\
+  _1_, _2_, _3_, _4_, _5_, _6_, _7_, _8_, _9_, _10_, _11_, _12_, _13_, _14_, _15_, _16_, \
+  _17_, _18_, _19_, _20_, _21_, _22_, _23_, _24_, _25_, _26_, _27_, _28_, _29_, _30_, _31_, _32_, \
+  _33_, _34_, _35_, _36_, _37_, _38_, _39_, _40_, _41_, _42_, _43_, _44_, _45_, _46_, _47_, _48_, \
+  _49_, _50_, _51_, _52_, _53_, _54_, _55_, _56_, _57_, _58_, _59_, _60_, _61_, _62_, _63_, _64_, \
+  count, ...) count
+#define _VA_NARGS_EXPAND(args) _VA_NARGS_RETURN_COUNT args
+#define _VA_NARGS_OVERLOAD_MACRO2(name, count) name##count
+#define _VA_NARGS_OVERLOAD_MACRO1(name, count) _VA_NARGS_OVERLOAD_MACRO2(name, count)
+#define _VA_NARGS_OVERLOAD_MACRO(name,  count) _VA_NARGS_OVERLOAD_MACRO1(name, count)
+/* --- expose for re-use --- */
+/* 64 args max */
+#define VA_NARGS_COUNT(...) _VA_NARGS_EXPAND((__VA_ARGS__, \
+  64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
+  48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
+  32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
+  16, 15, 14, 13, 12, 11, 10,  9,  8,  7,  6,  5,  4,  3,  2, 1, 0))
+#define VA_NARGS_CALL_OVERLOAD(name, ...) \
+  _VA_NARGS_GLUE(_VA_NARGS_OVERLOAD_MACRO(name, VA_NARGS_COUNT(__VA_ARGS__)), (__VA_ARGS__))
+
+/* clang-format on */