falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 43 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.
6979 Commits
17 Branches
940MB
Tree: fd8928a4bb
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'fd8928a4bb'
${ noResults }
Carla/source/includes/CarlaDefines.h

338 lines
14KB
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(__CYGWIN__)

  42. # define CARLA_OS_CYGWIN

  43. #elif defined(__HAIKU__)

  44. # define CARLA_OS_HAIKU

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

  46. # define CARLA_OS_LINUX

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

  48. # define CARLA_OS_BSD

  49. #elif defined(__GNU__)

  50. # define CARLA_OS_GNU_HURD

  51. #elif defined(__EMSCRIPTEN__)

  52. # define CARLA_OS_WASM

  53. #else

  54. # warning Unsupported platform!

  55. #endif

  56. 

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

  58. # define CARLA_OS_WIN

  59. #elif defined(CARLA_OS_BSD) || defined(CARLA_OS_GNU_HURD) || defined(CARLA_OS_LINUX) || defined(CARLA_OS_MAC) || defined(CARLA_OS_CYGWIN)

  60. # define CARLA_OS_UNIX

  61. #endif

  62. 

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

  64. # define CARLA_OS_64BIT

  65. #endif

  66. 

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

  68. #if defined(HAVE_CPP11_SUPPORT)

  69. # if HAVE_CPP11_SUPPORT

  70. #   define CARLA_PROPER_CPP11_SUPPORT

  71. # endif

  72. #elif defined(__cplusplus)

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

  74. #  define CARLA_PROPER_CPP11_SUPPORT

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

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

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

  78. #  endif

  79. # endif

  80. #endif

  81. 

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

  83. # define constexpr

  84. # define noexcept throw()

  85. # define override

  86. # define final

  87. # define nullptr NULL

  88. #endif

  89. 

  90. /* Common includes */

  91. #ifdef __cplusplus

  92. # include <cstddef>

  93. #else

  94. # include <stdbool.h>

  95. # include <stddef.h>

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

  97. #endif

  98. 

  99. /* Define various string format types */

  100. #if defined(CARLA_OS_WIN64)

  101. # define P_INT64   "%lli"

  102. # define P_UINT64  "%llu"

  103. # define P_INTPTR  "%lli"

  104. # define P_UINTPTR "%llx"

  105. # define P_SIZE    "%llu"

  106. # define P_SSIZE   "%lli"

  107. #elif defined(CARLA_OS_WIN32)

  108. # define P_INT64   "%lli"

  109. # define P_UINT64  "%llu"

  110. # define P_INTPTR  "%i"

  111. # define P_UINTPTR "%x"

  112. # define P_SIZE    "%u"

  113. # define P_SSIZE   "%i"

  114. #elif defined(CARLA_OS_WASM)

  115. # define P_INT64   "%lli"

  116. # define P_UINT64  "%llu"

  117. # define P_INTPTR  "%li"

  118. # define P_UINTPTR "%lx"

  119. # define P_SIZE    "%lu"

  120. # define P_SSIZE   "%li"

  121. #elif defined(CARLA_OS_MAC)

  122. # define P_INT64   "%lli"

  123. # define P_UINT64  "%llu"

  124. # define P_INTPTR  "%li"

  125. # define P_UINTPTR "%lx"

  126. # define P_SIZE    "%lu"

  127. # define P_SSIZE   "%li"

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

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

  130.       (defined(CARLA_OS_HAIKU) && defined(CARLA_OS_64BIT))

  131. # define P_INT64   "%li"

  132. # define P_UINT64  "%lu"

  133. # define P_INTPTR  "%li"

  134. # define P_UINTPTR "%lx"

  135. # define P_SIZE    "%lu"

  136. # define P_SSIZE   "%li"

  137. #else

  138. # define P_INT64   "%lli"

  139. # define P_UINT64  "%llu"

  140. # define P_INTPTR  "%i"

  141. # define P_UINTPTR "%x"

  142. # define P_SIZE    "%u"

  143. # define P_SSIZE   "%i"

  144. #endif

  145. 

  146. /* Define BINARY_NATIVE */

  147. #if defined(CARLA_OS_WIN)

  148. # ifdef CARLA_OS_WIN64

  149. #  define BINARY_NATIVE BINARY_WIN64

  150. # else

  151. #  define BINARY_NATIVE BINARY_WIN32

  152. # endif

  153. #else

  154. # ifdef CARLA_OS_64BIT

  155. #  define BINARY_NATIVE BINARY_POSIX64

  156. # else

  157. #  define BINARY_NATIVE BINARY_POSIX32

  158. # endif

  159. #endif

  160. 

  161. /* Define unlikely */

  162. #ifdef __GNUC__

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

  164. #else

  165. # define unlikely(x) x

  166. #endif

  167. 

  168. /* Define CARLA_ASSERT* */

  169. #if defined(CARLA_NO_ASSERTS)

  170. # define CARLA_ASSERT(cond)

  171. # define CARLA_ASSERT_INT(cond, value)

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

  173. #elif defined(NDEBUG)

  174. # define CARLA_ASSERT      CARLA_SAFE_ASSERT

  175. # define CARLA_ASSERT_INT  CARLA_SAFE_ASSERT_INT

  176. # define CARLA_ASSERT_INT2 CARLA_SAFE_ASSERT_INT2

  177. #else

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

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

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

  181. #endif

  182. 

  183. /* Define CARLA_SAFE_ASSERT* */

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

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

  186. #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));

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

  188. #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));

  189. 

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

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

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

  193. 

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

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

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

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

  198. 

  199. #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; }

  200. #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; }

  201. #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; }

  202. 

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

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

  205. #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; }

  206. 

  207. #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; }

  208. #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; }

  209. #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; }

  210. 

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

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

  213. #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; }

  214. 

  215. #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; }

  216. #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; }

  217. #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; }

  218. 

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

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

  221. # if __GNUC__ >= 6

  222. #  pragma GCC diagnostic push

  223. #  pragma GCC diagnostic ignored "-Wterminate"

  224. # endif

  225. #else

  226. # define CARLA_CATCH_UNWIND

  227. #endif

  228. 

  229. /* Define CARLA_SAFE_EXCEPTION */

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

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

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

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

  234. 

  235. /* Define CARLA_DECLARE_NON_COPYABLE */

  236. #ifdef CARLA_PROPER_CPP11_SUPPORT

  237. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \

  238. private:                                         \

  239.     ClassName(ClassName&) = delete;              \

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

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

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

  243. #else

  244. # define CARLA_DECLARE_NON_COPYABLE(ClassName) \

  245. private:                                         \

  246.     ClassName(ClassName&);                       \

  247.     ClassName(const ClassName&);                 \

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

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

  250. #endif

  251. 

  252. /* Define CARLA_PREVENT_HEAP_ALLOCATION */

  253. #ifdef CARLA_PROPER_CPP11_SUPPORT

  254. # define CARLA_PREVENT_HEAP_ALLOCATION \

  255. private:                               \

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

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

  258. #else

  259. # define CARLA_PREVENT_HEAP_ALLOCATION \

  260. private:                               \

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

  262.     static void operator delete(void*);

  263. #endif

  264. 

  265. /* Define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION */

  266. #ifdef CARLA_PROPER_CPP11_SUPPORT

  267. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION  \

  268. private:                                        \

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

  270. #else

  271. # define CARLA_PREVENT_VIRTUAL_HEAP_ALLOCATION  \

  272. private:                                        \

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

  274. #endif

  275. 

  276. /* CARLA_VISIBLE_SYMBOL */

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

  278. # ifdef BUILDING_CARLA

  279. #  define CARLA_VISIBLE_SYMBOL __declspec (dllexport)

  280. # else

  281. #  define CARLA_VISIBLE_SYMBOL __declspec (dllimport)

  282. # endif

  283. #else

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

  285. #endif

  286. 

  287. /* Define CARLA_API */

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

  289. # define CARLA_API

  290. #else

  291. # define CARLA_API CARLA_VISIBLE_SYMBOL

  292. #endif

  293. 

  294. /* Define CARLA_EXTERN_C */

  295. #ifdef __cplusplus

  296. # define CARLA_EXTERN_C extern "C"

  297. #else

  298. # define CARLA_EXTERN_C

  299. #endif

  300. 

  301. /* Define CARLA_*_EXPORT */

  302. #if defined(BUILD_BRIDGE)

  303. # define CARLA_API_EXPORT CARLA_EXTERN_C

  304. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C

  305. #elif defined(CARLA_OS_WASM)

  306. # define CARLA_API_EXPORT CARLA_EXTERN_C CARLA_API

  307. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C __attribute__ ((used))

  308. #else

  309. # define CARLA_API_EXPORT CARLA_EXTERN_C CARLA_API

  310. # define CARLA_PLUGIN_EXPORT CARLA_EXTERN_C CARLA_VISIBLE_SYMBOL

  311. #endif

  312. 

  313. /* Define CARLA_OS_SEP */

  314. #ifdef CARLA_OS_WIN

  315. # define CARLA_OS_SEP       '\\'

  316. # define CARLA_OS_SEP_STR   "\\"

  317. # define CARLA_OS_SPLIT     ';'

  318. # define CARLA_OS_SPLIT_STR ";"

  319. #else

  320. # define CARLA_OS_SEP       '/'

  321. # define CARLA_OS_SEP_STR   "/"

  322. # define CARLA_OS_SPLIT     ':'

  323. # define CARLA_OS_SPLIT_STR ":"

  324. #endif

  325. 

  326. /* Useful typedefs */

  327. typedef unsigned char uchar;

  328. typedef unsigned short int ushort;

  329. typedef unsigned int uint;

  330. typedef unsigned long int ulong;

  331. typedef unsigned long long int ulonglong;

  332. #ifdef _MSC_VER

  333. # include <basetsd.h>

  334. typedef SSIZE_T ssize_t;

  335. #endif

  336. 

  337. #endif /* CARLA_DEFINES_H_INCLUDED */