🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
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.

326 lines
12 KiB

  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
  4. This software is provided 'as-is', without any express or implied
  5. warranty. In no event will the authors be held liable for any damages
  6. arising from the use of this software.
  7. Permission is granted to anyone to use this software for any purpose,
  8. including commercial applications, and to alter it and redistribute it
  9. freely, subject to the following restrictions:
  10. 1. The origin of this software must not be misrepresented; you must not
  11. claim that you wrote the original software. If you use this software
  12. in a product, an acknowledgment in the product documentation would be
  13. appreciated but is not required.
  14. 2. Altered source versions must be plainly marked as such, and must not be
  15. misrepresented as being the original software.
  16. 3. This notice may not be removed or altered from any source distribution.
  17. */
  18. #ifndef SDL_assert_h_
  19. #define SDL_assert_h_
  20. #include "SDL_stdinc.h"
  21. #include "begin_code.h"
  22. /* Set up for C function definitions, even when using C++ */
  23. #ifdef __cplusplus
  24. extern "C" {
  25. #endif
  26. #ifndef SDL_ASSERT_LEVEL
  27. #ifdef SDL_DEFAULT_ASSERT_LEVEL
  28. #define SDL_ASSERT_LEVEL SDL_DEFAULT_ASSERT_LEVEL
  29. #elif defined(_DEBUG) || defined(DEBUG) || \
  30. (defined(__GNUC__) && !defined(__OPTIMIZE__))
  31. #define SDL_ASSERT_LEVEL 2
  32. #else
  33. #define SDL_ASSERT_LEVEL 1
  34. #endif
  35. #endif /* SDL_ASSERT_LEVEL */
  36. /*
  37. These are macros and not first class functions so that the debugger breaks
  38. on the assertion line and not in some random guts of SDL, and so each
  39. assert can have unique static variables associated with it.
  40. */
  41. #if defined(_MSC_VER)
  42. /* Don't include intrin.h here because it contains C++ code */
  43. extern void __cdecl __debugbreak(void);
  44. #define SDL_TriggerBreakpoint() __debugbreak()
  45. #elif _SDL_HAS_BUILTIN(__builtin_debugtrap)
  46. #define SDL_TriggerBreakpoint() __builtin_debugtrap()
  47. #elif ( (!defined(__NACL__)) && ((defined(__GNUC__) || defined(__clang__)) && (defined(__i386__) || defined(__x86_64__))) )
  48. #define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "int $3\n\t" )
  49. #elif ( defined(__APPLE__) && (defined(__arm64__) || defined(__aarch64__)) ) /* this might work on other ARM targets, but this is a known quantity... */
  50. #define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "brk #22\n\t" )
  51. #elif defined(__APPLE__) && defined(__arm__)
  52. #define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "bkpt #22\n\t" )
  53. #elif defined(__386__) && defined(__WATCOMC__)
  54. #define SDL_TriggerBreakpoint() { _asm { int 0x03 } }
  55. #elif defined(HAVE_SIGNAL_H) && !defined(__WATCOMC__)
  56. #include <signal.h>
  57. #define SDL_TriggerBreakpoint() raise(SIGTRAP)
  58. #else
  59. /* How do we trigger breakpoints on this platform? */
  60. #define SDL_TriggerBreakpoint()
  61. #endif
  62. #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 supports __func__ as a standard. */
  63. # define SDL_FUNCTION __func__
  64. #elif ((defined(__GNUC__) && (__GNUC__ >= 2)) || defined(_MSC_VER) || defined (__WATCOMC__))
  65. # define SDL_FUNCTION __FUNCTION__
  66. #else
  67. # define SDL_FUNCTION "???"
  68. #endif
  69. #define SDL_FILE __FILE__
  70. #define SDL_LINE __LINE__
  71. /*
  72. sizeof (x) makes the compiler still parse the expression even without
  73. assertions enabled, so the code is always checked at compile time, but
  74. doesn't actually generate code for it, so there are no side effects or
  75. expensive checks at run time, just the constant size of what x WOULD be,
  76. which presumably gets optimized out as unused.
  77. This also solves the problem of...
  78. int somevalue = blah();
  79. SDL_assert(somevalue == 1);
  80. ...which would cause compiles to complain that somevalue is unused if we
  81. disable assertions.
  82. */
  83. /* "while (0,0)" fools Microsoft's compiler's /W4 warning level into thinking
  84. this condition isn't constant. And looks like an owl's face! */
  85. #ifdef _MSC_VER /* stupid /W4 warnings. */
  86. #define SDL_NULL_WHILE_LOOP_CONDITION (0,0)
  87. #else
  88. #define SDL_NULL_WHILE_LOOP_CONDITION (0)
  89. #endif
  90. #define SDL_disabled_assert(condition) \
  91. do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION)
  92. typedef enum
  93. {
  94. SDL_ASSERTION_RETRY, /**< Retry the assert immediately. */
  95. SDL_ASSERTION_BREAK, /**< Make the debugger trigger a breakpoint. */
  96. SDL_ASSERTION_ABORT, /**< Terminate the program. */
  97. SDL_ASSERTION_IGNORE, /**< Ignore the assert. */
  98. SDL_ASSERTION_ALWAYS_IGNORE /**< Ignore the assert from now on. */
  99. } SDL_AssertState;
  100. typedef struct SDL_AssertData
  101. {
  102. int always_ignore;
  103. unsigned int trigger_count;
  104. const char *condition;
  105. const char *filename;
  106. int linenum;
  107. const char *function;
  108. const struct SDL_AssertData *next;
  109. } SDL_AssertData;
  110. #if (SDL_ASSERT_LEVEL > 0)
  111. /* Never call this directly. Use the SDL_assert* macros. */
  112. extern DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *,
  113. const char *,
  114. const char *, int)
  115. #if defined(__clang__)
  116. #if __has_feature(attribute_analyzer_noreturn)
  117. /* this tells Clang's static analysis that we're a custom assert function,
  118. and that the analyzer should assume the condition was always true past this
  119. SDL_assert test. */
  120. __attribute__((analyzer_noreturn))
  121. #endif
  122. #endif
  123. ;
  124. /* the do {} while(0) avoids dangling else problems:
  125. if (x) SDL_assert(y); else blah();
  126. ... without the do/while, the "else" could attach to this macro's "if".
  127. We try to handle just the minimum we need here in a macro...the loop,
  128. the static vars, and break points. The heavy lifting is handled in
  129. SDL_ReportAssertion(), in SDL_assert.c.
  130. */
  131. #define SDL_enabled_assert(condition) \
  132. do { \
  133. while ( !(condition) ) { \
  134. static struct SDL_AssertData sdl_assert_data = { \
  135. 0, 0, #condition, 0, 0, 0, 0 \
  136. }; \
  137. const SDL_AssertState sdl_assert_state = SDL_ReportAssertion(&sdl_assert_data, SDL_FUNCTION, SDL_FILE, SDL_LINE); \
  138. if (sdl_assert_state == SDL_ASSERTION_RETRY) { \
  139. continue; /* go again. */ \
  140. } else if (sdl_assert_state == SDL_ASSERTION_BREAK) { \
  141. SDL_TriggerBreakpoint(); \
  142. } \
  143. break; /* not retrying. */ \
  144. } \
  145. } while (SDL_NULL_WHILE_LOOP_CONDITION)
  146. #endif /* enabled assertions support code */
  147. /* Enable various levels of assertions. */
  148. #if SDL_ASSERT_LEVEL == 0 /* assertions disabled */
  149. # define SDL_assert(condition) SDL_disabled_assert(condition)
  150. # define SDL_assert_release(condition) SDL_disabled_assert(condition)
  151. # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
  152. #elif SDL_ASSERT_LEVEL == 1 /* release settings. */
  153. # define SDL_assert(condition) SDL_disabled_assert(condition)
  154. # define SDL_assert_release(condition) SDL_enabled_assert(condition)
  155. # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
  156. #elif SDL_ASSERT_LEVEL == 2 /* normal settings. */
  157. # define SDL_assert(condition) SDL_enabled_assert(condition)
  158. # define SDL_assert_release(condition) SDL_enabled_assert(condition)
  159. # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
  160. #elif SDL_ASSERT_LEVEL == 3 /* paranoid settings. */
  161. # define SDL_assert(condition) SDL_enabled_assert(condition)
  162. # define SDL_assert_release(condition) SDL_enabled_assert(condition)
  163. # define SDL_assert_paranoid(condition) SDL_enabled_assert(condition)
  164. #else
  165. # error Unknown assertion level.
  166. #endif
  167. /* this assertion is never disabled at any level. */
  168. #define SDL_assert_always(condition) SDL_enabled_assert(condition)
  169. /**
  170. * A callback that fires when an SDL assertion fails.
  171. *
  172. * \param data a pointer to the SDL_AssertData structure corresponding to the
  173. * current assertion
  174. * \param userdata what was passed as `userdata` to SDL_SetAssertionHandler()
  175. * \returns an SDL_AssertState value indicating how to handle the failure.
  176. */
  177. typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
  178. const SDL_AssertData* data, void* userdata);
  179. /**
  180. * Set an application-defined assertion handler.
  181. *
  182. * This function allows an application to show its own assertion UI and/or
  183. * force the response to an assertion failure. If the application doesn't
  184. * provide this, SDL will try to do the right thing, popping up a
  185. * system-specific GUI dialog, and probably minimizing any fullscreen windows.
  186. *
  187. * This callback may fire from any thread, but it runs wrapped in a mutex, so
  188. * it will only fire from one thread at a time.
  189. *
  190. * This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
  191. *
  192. * \param handler the SDL_AssertionHandler function to call when an assertion
  193. * fails or NULL for the default handler
  194. * \param userdata a pointer that is passed to `handler`
  195. *
  196. * \since This function is available since SDL 2.0.0.
  197. *
  198. * \sa SDL_GetAssertionHandler
  199. */
  200. extern DECLSPEC void SDLCALL SDL_SetAssertionHandler(
  201. SDL_AssertionHandler handler,
  202. void *userdata);
  203. /**
  204. * Get the default assertion handler.
  205. *
  206. * This returns the function pointer that is called by default when an
  207. * assertion is triggered. This is an internal function provided by SDL, that
  208. * is used for assertions when SDL_SetAssertionHandler() hasn't been used to
  209. * provide a different function.
  210. *
  211. * \returns the default SDL_AssertionHandler that is called when an assert
  212. * triggers.
  213. *
  214. * \since This function is available since SDL 2.0.2.
  215. *
  216. * \sa SDL_GetAssertionHandler
  217. */
  218. extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(void);
  219. /**
  220. * Get the current assertion handler.
  221. *
  222. * This returns the function pointer that is called when an assertion is
  223. * triggered. This is either the value last passed to
  224. * SDL_SetAssertionHandler(), or if no application-specified function is set,
  225. * is equivalent to calling SDL_GetDefaultAssertionHandler().
  226. *
  227. * The parameter `puserdata` is a pointer to a void*, which will store the
  228. * "userdata" pointer that was passed to SDL_SetAssertionHandler(). This value
  229. * will always be NULL for the default handler. If you don't care about this
  230. * data, it is safe to pass a NULL pointer to this function to ignore it.
  231. *
  232. * \param puserdata pointer which is filled with the "userdata" pointer that
  233. * was passed to SDL_SetAssertionHandler()
  234. * \returns the SDL_AssertionHandler that is called when an assert triggers.
  235. *
  236. * \since This function is available since SDL 2.0.2.
  237. *
  238. * \sa SDL_SetAssertionHandler
  239. */
  240. extern DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetAssertionHandler(void **puserdata);
  241. /**
  242. * Get a list of all assertion failures.
  243. *
  244. * This function gets all assertions triggered since the last call to
  245. * SDL_ResetAssertionReport(), or the start of the program.
  246. *
  247. * The proper way to examine this data looks something like this:
  248. *
  249. * ```c
  250. * const SDL_AssertData *item = SDL_GetAssertionReport();
  251. * while (item) {
  252. * printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\\n",
  253. * item->condition, item->function, item->filename,
  254. * item->linenum, item->trigger_count,
  255. * item->always_ignore ? "yes" : "no");
  256. * item = item->next;
  257. * }
  258. * ```
  259. *
  260. * \returns a list of all failed assertions or NULL if the list is empty. This
  261. * memory should not be modified or freed by the application.
  262. *
  263. * \since This function is available since SDL 2.0.0.
  264. *
  265. * \sa SDL_ResetAssertionReport
  266. */
  267. extern DECLSPEC const SDL_AssertData * SDLCALL SDL_GetAssertionReport(void);
  268. /**
  269. * Clear the list of all assertion failures.
  270. *
  271. * This function will clear the list of all assertions triggered up to that
  272. * point. Immediately following this call, SDL_GetAssertionReport will return
  273. * no items. In addition, any previously-triggered assertions will be reset to
  274. * a trigger_count of zero, and their always_ignore state will be false.
  275. *
  276. * \since This function is available since SDL 2.0.0.
  277. *
  278. * \sa SDL_GetAssertionReport
  279. */
  280. extern DECLSPEC void SDLCALL SDL_ResetAssertionReport(void);
  281. /* these had wrong naming conventions until 2.0.4. Please update your app! */
  282. #define SDL_assert_state SDL_AssertState
  283. #define SDL_assert_data SDL_AssertData
  284. /* Ends C function definitions when using C++ */
  285. #ifdef __cplusplus
  286. }
  287. #endif
  288. #include "close_code.h"
  289. #endif /* SDL_assert_h_ */
  290. /* vi: set ts=4 sw=4 expandtab: */