falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 Activity
Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6625 Commits
16 Branches
14GB
Tree: 933c3c6812
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '933c3c6812'
${ noResults }
Carla/source/includes/CarlaDefines.h

333 lines
13KB
Raw Blame History 

  1. /*

  2.  * Carla common defines

  3.  * Copyright (C) 2011-2023 Filipe Coelho <falktx@falktx.com>

  4.  *

  5.  * This program is free software; you can redistribute it and/or

  6.  * modify it under the terms of the GNU General Public License as

  7.  * published by the Free Software Foundation; either version 2 of

  8.  * the License, or any later version.

  9.  *

  10.  * This program is distributed in the hope that it will be useful,

  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

  13.  * GNU General Public License for more details.

  14.  *

  15.  * For a full copy of the GNU General Public License see the doc/GPL.txt file.

  16.  */

  17. 

  18. #ifndef CARLA_DEFINES_H_INCLUDED

  19. #define CARLA_DEFINES_H_INCLUDED

  20. 

  21. /* Compatibility with non-clang compilers */

  22. #ifndef __has_feature

  23. # define __has_feature(x) 0

  24. #endif

  25. #ifndef __has_extension

  26. # define __has_extension __has_feature

  27. #endif

  28. 

  29. /* Set Version */

  30. #define CARLA_VERSION_HEX    0x020591

  31. #define CARLA_VERSION_STRING "2.6.0-alpha1"

  32. #define CARLA_VERSION_STRMIN "2.6"

  33. 

  34. /* Check OS */

  35. #if defined(WIN64) || defined(_WIN64) || defined(__WIN64__) || defined(_M_ARM64)

  36. # define CARLA_OS_WIN64

  37. #elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(_M_ARM)

  38. # define CARLA_OS_WIN32

  39. #elif defined(__APPLE__)

  40. # define CARLA_OS_MAC

  41. #elif defined(__HAIKU__)

  42. # define CARLA_OS_HAIKU

  43. #elif defined(__linux__) || defined(__linux)

  44. # define CARLA_OS_LINUX

  45. #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)

  46. # define CARLA_OS_BSD

  47. #elif defined(__GNU__)

  48. # define CARLA_OS_GNU_HURD

  49. #elif defined(__EMSCRIPTEN__)

  50. # define CARLA_OS_WASM

  51. #else

  52. # warning Unsupported platform!

  53. #endif

  54. 

  55. #if defined(CARLA_OS_WIN32) || defined(CARLA_OS_WIN64)

  56. # define CARLA_OS_WIN

  57. #elif defined(CARLA_OS_BSD) || defined(CARLA_OS_GNU_HURD) || defined(CARLA_OS_LINUX) || defined(CARLA_OS_MAC)

  58. # define CARLA_OS_UNIX

  59. #endif

  60. 

  61. #if defined(__LP64__) || defined(_LP64) || defined(__arm64__) || defined(__aarch64__) || defined(CARLA_OS_WIN64)

  62. # define CARLA_OS_64BIT

  63. #endif

  64. 

  65. /* Check for C++11 support */

  66. #if defined(HAVE_CPP11_SUPPORT)

  67. # if HAVE_CPP11_SUPPORT

  68. #   define CARLA_PROPER_CPP11_SUPPORT

  69. # endif

  70. #elif defined(__cplusplus)

  71. # if __cplusplus >= 201103L || (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 405 && defined(__GXX_EXPERIMENTAL_CXX0X__)) || __has_extension(cxx_noexcept)

  72. #  define CARLA_PROPER_CPP11_SUPPORT

  73. #  if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) < 407 && ! defined(__clang__)) || (defined(__clang__) && ! __has_extension(cxx_override_control))

  74. #   define override /* gcc4.7+ only */

  75. #   define final    /* gcc4.7+ only */

  76. #  endif

  77. # endif

  78. #endif

  79. 

  80. #if defined(__cplusplus) && ! defined(CARLA_PROPER_CPP11_SUPPORT)

  81. # define constexpr

  82. # define noexcept throw()

  83. # define override

  84. # define final

  85. # define nullptr NULL

  86. #endif

  87. 

  88. /* Common includes */

  89. #ifdef __cplusplus

  90. # include <cstddef>

  91. #else

  92. # include <stdbool.h>

  93. # include <stddef.h>

  94. # define constexpr /* note: constexpr is coming to C soon, but no compilers support it yet */

  95. #endif

  96. 

  97. /* Define various string format types */

  98. #if defined(CARLA_OS_WIN64)

  99. # define P_INT64   "%lli"

  100. # define P_UINT64  "%llu"

  101. # define P_INTPTR  "%lli"

  102. # define P_UINTPTR "%llx"

  103. # define P_SIZE    "%llu"

  104. # define P_SSIZE   "%lli"

  105. #elif defined(CARLA_OS_WIN32)

  106. # define P_INT64   "%lli"

  107. # define P_UINT64  "%llu"

  108. # define P_INTPTR  "%i"

  109. # define P_UINTPTR "%x"

  110. # define P_SIZE    "%u"

  111. # define P_SSIZE   "%i"

  112. #elif defined(CARLA_OS_WASM)

  113. # define P_INT64   "%lli"

  114. # define P_UINT64  "%llu"

  115. # define P_INTPTR  "%li"

  116. # define P_UINTPTR "%lx"

  117. # define P_SIZE    "%lu"

  118. # define P_SSIZE   "%li"

  119. #elif defined(CARLA_OS_MAC)

  120. # define P_INT64   "%lli"

  121. # define P_UINT64  "%llu"

  122. # define P_INTPTR  "%li"

  123. # define P_UINTPTR "%lx"

  124. # define P_SIZE    "%lu"

  125. # define P_SSIZE   "%li"

  126. #elif (defined(__WORDSIZE)     && __WORDSIZE     == 64) || \

  127.       (defined(__SIZE_WIDTH__) && __SIZE_WIDTH__ == 64) || \

  128.       (defined(CARLA_OS_HAIKU) && defined(CARLA_OS_64BIT))

  129. # define P_INT64   "%li"

  130. # define P_UINT64  "%lu"

  131. # define P_INTPTR  "%li"

  132. # define P_UINTPTR "%lx"

  133. # define P_SIZE    "%lu"

  134. # define P_SSIZE   "%li"

  135. #else

  136. # define P_INT64   "%lli"

  137. # define P_UINT64  "%llu"

  138. # define P_INTPTR  "%i"

  139. # define P_UINTPTR "%x"

  140. # define P_SIZE    "%u"

  141. # define P_SSIZE   "%i"

  142. #endif

  143. 

  144. /* Define BINARY_NATIVE */

  145. #if defined(CARLA_OS_WIN)

  146. # ifdef CARLA_OS_WIN64

  147. #  define BINARY_NATIVE BINARY_WIN64

  148. # else

  149. #  define BINARY_NATIVE BINARY_WIN32

  150. # endif

  151. #else

  152. # ifdef CARLA_OS_64BIT

  153. #  define BINARY_NATIVE BINARY_POSIX64

  154. # else

  155. #  define BINARY_NATIVE BINARY_POSIX32

  156. # endif

  157. #endif

  158. 

  159. /* Define unlikely */

  160. #ifdef __GNUC__

  161. # define unlikely(x) __builtin_expect(x,0)

  162. #else

  163. # define unlikely(x) x

  164. #endif

  165. 

  166. /* Define CARLA_ASSERT* */

  167. #if defined(CARLA_NO_ASSERTS)

  168. # define CARLA_ASSERT(cond)

  169. # define CARLA_ASSERT_INT(cond, value)

  170. # define CARLA_ASSERT_INT2(cond, v1, v2)

  171. #elif defined(NDEBUG)

  172. # define CARLA_ASSERT      CARLA_SAFE_ASSERT

  173. # define CARLA_ASSERT_INT  CARLA_SAFE_ASSERT_INT

  174. # define CARLA_ASSERT_INT2 CARLA_SAFE_ASSERT_INT2

  175. #else

  176. # define CARLA_ASSERT(cond)              assert(cond)

  177. # define CARLA_ASSERT_INT(cond, value)   assert(cond)

  178. # define CARLA_ASSERT_INT2(cond, v1, v2) assert(cond)

  179. #endif

  180. 

  181. /* Define CARLA_SAFE_ASSERT* */

  182. #define CARLA_SAFE_ASSERT(cond)               if (unlikely(!(cond))) carla_safe_assert      (#cond, __FILE__, __LINE__);

  183. #define CARLA_SAFE_ASSERT_INT(cond, value)    if (unlikely(!(cond))) carla_safe_assert_int  (#cond, __FILE__, __LINE__, static_cast<int>(value));

  184. #define CARLA_SAFE_ASSERT_INT2(cond, v1, v2)  if (unlikely(!(cond))) carla_safe_assert_int2 (#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2));

  185. #define CARLA_SAFE_ASSERT_UINT(cond, value)   if (unlikely(!(cond))) carla_safe_assert_uint (#cond, __FILE__, __LINE__, static_cast<uint>(value));

  186. #define CARLA_SAFE_ASSERT_UINT2(cond, v1, v2) if (unlikely(!(cond))) carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2));

  187. 

  188. #define CARLA_SAFE_ASSERT_BREAK(cond)         if (unlikely(!(cond))) { carla_safe_assert(#cond, __FILE__, __LINE__); break; }

  189. #define CARLA_SAFE_ASSERT_CONTINUE(cond)      if (unlikely(!(cond))) { carla_safe_assert(#cond, __FILE__, __LINE__); continue; }

  190. #define CARLA_SAFE_ASSERT_RETURN(cond, ret)   if (unlikely(!(cond))) { carla_safe_assert(#cond, __FILE__, __LINE__); return ret; }

  191. 

  192. #define CARLA_CUSTOM_SAFE_ASSERT(msg, cond)             if (unlikely(!(cond))) carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__);

  193. #define CARLA_CUSTOM_SAFE_ASSERT_BREAK(msg, cond)       if (unlikely(!(cond))) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); break; }

  194. #define CARLA_CUSTOM_SAFE_ASSERT_CONTINUE(msg, cond)    if (unlikely(!(cond))) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); continue; }

  195. #define CARLA_CUSTOM_SAFE_ASSERT_RETURN(msg, cond, ret) if (unlikely(!(cond))) { carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); return ret; }

  196. 

  197. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_BREAK(msg, cond)       if (unlikely(!(cond))) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } break; }

  198. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_CONTINUE(msg, cond)    if (unlikely(!(cond))) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } continue; }

  199. #define CARLA_CUSTOM_SAFE_ASSERT_ONCE_RETURN(msg, cond, ret) if (unlikely(!(cond))) { static bool _p; if (!_p) { _p = true; carla_custom_safe_assert(msg, #cond, __FILE__, __LINE__); } return ret; }

  200. 

  201. #define CARLA_SAFE_ASSERT_INT_BREAK(cond, value)       if (unlikely(!(cond))) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value)); break; }

  202. #define CARLA_SAFE_ASSERT_INT_CONTINUE(cond, value)    if (unlikely(!(cond))) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value)); continue; }

  203. #define CARLA_SAFE_ASSERT_INT_RETURN(cond, value, ret) if (unlikely(!(cond))) { carla_safe_assert_int(#cond, __FILE__, __LINE__, static_cast<int>(value)); return ret; }

  204. 

  205. #define CARLA_SAFE_ASSERT_INT2_BREAK(cond, v1, v2)        if (unlikely(!(cond))) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); break; }

  206. #define CARLA_SAFE_ASSERT_INT2_CONTINUE(cond, v1, v2)     if (unlikely(!(cond))) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); continue; }

  207. #define CARLA_SAFE_ASSERT_INT2_RETURN(cond, v1, v2, ret)  if (unlikely(!(cond))) { carla_safe_assert_int2(#cond, __FILE__, __LINE__, static_cast<int>(v1), static_cast<int>(v2)); return ret; }

  208. 

  209. #define CARLA_SAFE_ASSERT_UINT_BREAK(cond, value)       if (unlikely(!(cond))) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value); break; }

  210. #define CARLA_SAFE_ASSERT_UINT_CONTINUE(cond, value)    if (unlikely(!(cond))) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value)); continue; }

  211. #define CARLA_SAFE_ASSERT_UINT_RETURN(cond, value, ret) if (unlikely(!(cond))) { carla_safe_assert_uint(#cond, __FILE__, __LINE__, static_cast<uint>(value)); return ret; }

  212. 

  213. #define CARLA_SAFE_ASSERT_UINT2_BREAK(cond, v1, v2)       if (unlikely(!(cond))) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); break; }

  214. #define CARLA_SAFE_ASSERT_UINT2_CONTINUE(cond, v1, v2)    if (unlikely(!(cond))) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); continue; }

  215. #define CARLA_SAFE_ASSERT_UINT2_RETURN(cond, v1, v2, ret) if (unlikely(!(cond))) { carla_safe_assert_uint2(#cond, __FILE__, __LINE__, static_cast<uint>(v1), static_cast<uint>(v2)); return ret; }

  216. 

  217. #if defined(__GNUC__) && defined(CARLA_PROPER_CPP11_SUPPORT) && ! defined(__clang__)

  218. # define CARLA_CATCH_UNWIND catch (abi::__forced_unwind&) { throw; }

  219. # if __GNUC__ >= 6

  220. #  pragma GCC diagnostic push

  221. #  pragma GCC diagnostic ignored "-Wterminate"

  222. # endif

  223. #else

  224. # define CARLA_CATCH_UNWIND

  225. #endif

  226. 

  227. /* Define CARLA_SAFE_EXCEPTION */

  228. #define CARLA_SAFE_EXCEPTION(msg)             CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); }

  229. #define CARLA_SAFE_EXCEPTION_BREAK(msg)       CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); break; }

  230. #define CARLA_SAFE_EXCEPTION_CONTINUE(msg)    CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); continue; }

  231. #define CARLA_SAFE_EXCEPTION_RETURN(msg, ret) CARLA_CATCH_UNWIND catch(...) { carla_safe_exception(msg, __FILE__, __LINE__); return ret; }

  232. 

  233. /* Define CARLA_DECLARE_NON_COPYABLE */

  234. #ifdef CARLA_PROPER_CPP11_SUPPORT

  235. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \

  236. private:                                         \

  237.     ClassName(ClassName&) = delete;              \

  238.     ClassName(const ClassName&) = delete;        \

  239.     ClassName& operator=(ClassName&) = delete;   \

  240.     ClassName& operator=(const ClassName&) = delete;

  241. #else

  242. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \

  243. private:                                         \

  244.     ClassName(ClassName&);                       \

  245.     ClassName(const ClassName&);                 \

  246.     ClassName& operator=(ClassName&);            \

  247.     ClassName& operator=(const ClassName&);

  248. #endif

  249. 

  250. /* Define CARLA_PREVENT_HEAP_ALLOCATION */

  251. #ifdef CARLA_PROPER_CPP11_SUPPORT

  252. # define CARLA_PREVENT_HEAP_ALLOCATION \

  253. private:                               \

  254.     static void* operator new(std::size_t) = delete; \

  255.     static void operator delete(void*) = delete;

  256. #else

  257. # define CARLA_PREVENT_HEAP_ALLOCATION \

  258. private:                               \

  259.     static void* operator new(std::size_t); \

  260.     static void operator delete(void*);

  261. #endif

  262. 

  263. /* Define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION */

  264. #ifdef CARLA_PROPER_CPP11_SUPPORT

  265. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION  \

  266. private:                                        \

  267.     static void* operator new(std::size_t) = delete;

  268. #else

  269. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION  \

  270. private:                                        \

  271.     static void* operator new(std::size_t);

  272. #endif

  273. 

  274. /* CARLA_VISIBLE_SYMBOL */

  275. #if defined(CARLA_OS_WIN) && ! defined(__WINE__)

  276. # ifdef BUILDING_CARLA

  277. #  define CARLA_VISIBLE_SYMBOL __declspec (dllexport)

  278. # else

  279. #  define CARLA_VISIBLE_SYMBOL __declspec (dllimport)

  280. # endif

  281. #else

  282. # define CARLA_VISIBLE_SYMBOL __attribute__ ((visibility("default")))

  283. #endif

  284. 

  285. /* Define CARLA_API */

  286. #if defined(BUILD_BRIDGE) || defined(STATIC_PLUGIN_TARGET)

  287. # define CARLA_API

  288. #else

  289. # define CARLA_API CARLA_VISIBLE_SYMBOL

  290. #endif

  291. 

  292. /* Define CARLA_EXTERN_C */

  293. #ifdef __cplusplus

  294. # define CARLA_EXTERN_C extern "C"

  295. #else

  296. # define CARLA_EXTERN_C

  297. #endif

  298. 

  299. /* Define CARLA_*_EXPORT */

  300. #ifdef BUILD_BRIDGE

  301. # define CARLA_API_EXPORT CARLA_EXTERN_C

  302. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C

  303. #else

  304. # define CARLA_API_EXPORT CARLA_EXTERN_C CARLA_API

  305. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C CARLA_VISIBLE_SYMBOL

  306. #endif

  307. 

  308. /* Define CARLA_OS_SEP */

  309. #ifdef CARLA_OS_WIN

  310. # define CARLA_OS_SEP       '\\'

  311. # define CARLA_OS_SEP_STR   "\\"

  312. # define CARLA_OS_SPLIT     ';'

  313. # define CARLA_OS_SPLIT_STR ";"

  314. #else

  315. # define CARLA_OS_SEP       '/'

  316. # define CARLA_OS_SEP_STR   "/"

  317. # define CARLA_OS_SPLIT     ':'

  318. # define CARLA_OS_SPLIT_STR ":"

  319. #endif

  320. 

  321. /* Useful typedefs */

  322. typedef unsigned char uchar;

  323. typedef unsigned short int ushort;

  324. typedef unsigned int uint;

  325. typedef unsigned long int ulong;

  326. typedef unsigned long long int ulonglong;

  327. #ifdef _MSC_VER

  328. # include <basetsd.h>

  329. typedef SSIZE_T ssize_t;

  330. #endif

  331. 

  332. #endif /* CARLA_DEFINES_H_INCLUDED */