Defs.hpp 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. #ifndef DEFS_H
  2. #define DEFS_H
  3. namespace godot {
  4. enum class Error {
  5. OK,
  6. FAILED, ///< Generic fail error
  7. ERR_UNAVAILABLE, ///< What is requested is unsupported/unavailable
  8. ERR_UNCONFIGURED, ///< The object being used hasnt been properly set up yet
  9. ERR_UNAUTHORIZED, ///< Missing credentials for requested resource
  10. ERR_PARAMETER_RANGE_ERROR, ///< Parameter given out of range (5)
  11. ERR_OUT_OF_MEMORY, ///< Out of memory
  12. ERR_FILE_NOT_FOUND,
  13. ERR_FILE_BAD_DRIVE,
  14. ERR_FILE_BAD_PATH,
  15. ERR_FILE_NO_PERMISSION, // (10)
  16. ERR_FILE_ALREADY_IN_USE,
  17. ERR_FILE_CANT_OPEN,
  18. ERR_FILE_CANT_WRITE,
  19. ERR_FILE_CANT_READ,
  20. ERR_FILE_UNRECOGNIZED, // (15)
  21. ERR_FILE_CORRUPT,
  22. ERR_FILE_MISSING_DEPENDENCIES,
  23. ERR_FILE_EOF,
  24. ERR_CANT_OPEN, ///< Can't open a resource/socket/file
  25. ERR_CANT_CREATE, // (20)
  26. ERR_QUERY_FAILED,
  27. ERR_ALREADY_IN_USE,
  28. ERR_LOCKED, ///< resource is locked
  29. ERR_TIMEOUT,
  30. ERR_CANT_CONNECT, // (25)
  31. ERR_CANT_RESOLVE,
  32. ERR_CONNECTION_ERROR,
  33. ERR_CANT_AQUIRE_RESOURCE,
  34. ERR_CANT_FORK,
  35. ERR_INVALID_DATA, ///< Data passed is invalid (30)
  36. ERR_INVALID_PARAMETER, ///< Parameter passed is invalid
  37. ERR_ALREADY_EXISTS, ///< When adding, item already exists
  38. ERR_DOES_NOT_EXIST, ///< When retrieving/erasing, it item does not exist
  39. ERR_DATABASE_CANT_READ, ///< database is full
  40. ERR_DATABASE_CANT_WRITE, ///< database is full (35)
  41. ERR_COMPILATION_FAILED,
  42. ERR_METHOD_NOT_FOUND,
  43. ERR_LINK_FAILED,
  44. ERR_SCRIPT_FAILED,
  45. ERR_CYCLIC_LINK, // (40)
  46. ERR_INVALID_DECLARATION,
  47. ERR_DUPLICATE_SYMBOL,
  48. ERR_PARSE_ERROR,
  49. ERR_BUSY,
  50. ERR_SKIP, // (45)
  51. ERR_HELP, ///< user requested help!!
  52. ERR_BUG, ///< a bug in the software certainly happened, due to a double check failing or unexpected behavior.
  53. ERR_PRINTER_ON_FIRE, /// the parallel port printer is engulfed in flames
  54. };
  55. } // namespace godot
  56. #include <GodotGlobal.hpp>
  57. // alloca() is non-standard. When using MSVC, it's in malloc.h.
  58. #if defined(__linux__) || defined(__APPLE__)
  59. #include <alloca.h>
  60. #else
  61. #include <malloc.h>
  62. #endif
  63. typedef float real_t;
  64. // This epsilon should match the one used by Godot for consistency.
  65. // Using `f` when `real_t` is float.
  66. #define CMP_EPSILON 0.00001f
  67. #define CMP_EPSILON2 (CMP_EPSILON * CMP_EPSILON)
  68. #define Math_PI 3.1415926535897932384626433833
  69. #define Math_TAU 6.2831853071795864769252867666
  70. #define _PLANE_EQ_DOT_EPSILON 0.999
  71. #define _PLANE_EQ_D_EPSILON 0.0001
  72. #ifdef __GNUC__
  73. #define likely(x) __builtin_expect(!!(x), 1)
  74. #define unlikely(x) __builtin_expect(!!(x), 0)
  75. #else
  76. #define likely(x) x
  77. #define unlikely(x) x
  78. #endif
  79. // Don't use this directly; instead, use any of the CRASH_* macros
  80. #ifdef _MSC_VER
  81. #define GENERATE_TRAP \
  82. __debugbreak(); \
  83. /* Avoid warning about control paths */ \
  84. for (;;) { \
  85. }
  86. #else
  87. #define GENERATE_TRAP __builtin_trap();
  88. #endif
  89. // ERR/WARN macros
  90. #ifndef WARN_PRINT
  91. #define WARN_PRINT(msg) godot::Godot::print_warning(msg, __func__, __FILE__, __LINE__)
  92. #endif
  93. #ifndef WARN_PRINTS
  94. #define WARN_PRINTS(msg) WARN_PRINT((msg).utf8().get_data())
  95. #endif
  96. #ifndef ERR_PRINT
  97. #define ERR_PRINT(msg) godot::Godot::print_error(msg, __func__, __FILE__, __LINE__)
  98. #endif
  99. #ifndef ERR_PRINTS
  100. #define ERR_PRINTS(msg) ERR_PRINT((msg).utf8().get_data())
  101. #endif
  102. #ifndef FATAL_PRINT
  103. #define FATAL_PRINT(msg) ERR_PRINT(godot::String("FATAL: ") + (msg))
  104. #endif
  105. #ifndef ERR_MSG_INDEX
  106. #define ERR_MSG_INDEX(index, size) (godot::String("Index ") + #index + "=" + godot::String::num_int64(index) + " out of size (" + #size + "=" + godot::String::num_int64(size) + ")")
  107. #endif
  108. #ifndef ERR_MSG_NULL
  109. #define ERR_MSG_NULL(param) (godot::String("Parameter '") + #param + "' is null.")
  110. #endif
  111. #ifndef ERR_MSG_COND
  112. #define ERR_MSG_COND(cond) (godot::String("Condition '") + #cond + "' is true.")
  113. #endif
  114. #ifndef ERR_FAIL_INDEX
  115. #define ERR_FAIL_INDEX(index, size) \
  116. do { \
  117. if (unlikely((index) < 0 || (index) >= (size))) { \
  118. ERR_PRINT(ERR_MSG_INDEX(index, size)); \
  119. return; \
  120. } \
  121. } while (0)
  122. #endif
  123. #ifndef ERR_FAIL_INDEX_V
  124. #define ERR_FAIL_INDEX_V(index, size, ret) \
  125. do { \
  126. if (unlikely((index) < 0 || (index) >= (size))) { \
  127. ERR_PRINT(ERR_MSG_INDEX(index, size)); \
  128. return ret; \
  129. } \
  130. } while (0)
  131. #endif
  132. #ifndef ERR_FAIL_UNSIGNED_INDEX_V
  133. #define ERR_FAIL_UNSIGNED_INDEX_V(index, size, ret) \
  134. do { \
  135. if (unlikely((index) >= (size))) { \
  136. ERR_PRINT(ERR_MSG_INDEX(index, size)); \
  137. return ret; \
  138. } \
  139. } while (0)
  140. #endif
  141. #ifndef CRASH_BAD_INDEX
  142. #define CRASH_BAD_INDEX(index, size) \
  143. do { \
  144. if (unlikely((index) < 0 || (index) >= (size))) { \
  145. FATAL_PRINT(ERR_MSG_INDEX(index, size)); \
  146. GENERATE_TRAP; \
  147. } \
  148. } while (0)
  149. #endif
  150. #ifndef ERR_FAIL_NULL
  151. #define ERR_FAIL_NULL(param) \
  152. do { \
  153. if (unlikely(!param)) { \
  154. ERR_PRINT(ERR_MSG_NULL(param)); \
  155. return; \
  156. } \
  157. } while (0)
  158. #endif
  159. #ifndef ERR_FAIL_NULL_V
  160. #define ERR_FAIL_NULL_V(param, ret) \
  161. do { \
  162. if (unlikely(!param)) { \
  163. ERR_PRINT(ERR_MSG_NULL(param)); \
  164. return ret; \
  165. } \
  166. } while (0)
  167. #endif
  168. #ifndef ERR_FAIL_COND
  169. #define ERR_FAIL_COND(cond) \
  170. do { \
  171. if (unlikely(cond)) { \
  172. ERR_PRINT(ERR_MSG_COND(cond)); \
  173. return; \
  174. } \
  175. } while (0)
  176. #endif
  177. #ifndef CRASH_COND
  178. #define CRASH_COND(cond) \
  179. do { \
  180. if (unlikely(cond)) { \
  181. FATAL_PRINT(ERR_MSG_COND(cond)); \
  182. GENERATE_TRAP; \
  183. } \
  184. } while (0)
  185. #endif
  186. #ifndef ERR_FAIL_COND_V
  187. #define ERR_FAIL_COND_V(cond, ret) \
  188. do { \
  189. if (unlikely(cond)) { \
  190. ERR_PRINT(ERR_MSG_COND(cond)); \
  191. return ret; \
  192. } \
  193. } while (0)
  194. #endif
  195. #ifndef ERR_CONTINUE
  196. #define ERR_CONTINUE(cond) \
  197. { \
  198. if (unlikely(cond)) { \
  199. ERR_PRINT(ERR_MSG_COND(cond)); \
  200. continue; \
  201. } \
  202. }
  203. #endif
  204. #ifndef ERR_BREAK
  205. #define ERR_BREAK(cond) \
  206. { \
  207. if (unlikely(cond)) { \
  208. ERR_PRINT(ERR_MSG_COND(cond)); \
  209. break; \
  210. } \
  211. }
  212. #endif
  213. #ifndef ERR_FAIL
  214. #define ERR_FAIL() \
  215. do { \
  216. ERR_PRINT("Method/Function Failed."); \
  217. return; \
  218. } while (0)
  219. #endif
  220. #ifndef ERR_FAIL_V
  221. #define ERR_FAIL_V(ret) \
  222. do { \
  223. ERR_PRINT("Method/Function Failed."); \
  224. return ret; \
  225. } while (0)
  226. #endif
  227. #ifndef CRASH_NOW
  228. #define CRASH_NOW() \
  229. do { \
  230. FATAL_PRINT("Method/Function Failed."); \
  231. GENERATE_TRAP; \
  232. } while (0)
  233. #endif
  234. #endif // DEFS_H