SDL  2.0
SDL_assert.c File Reference
#include "./SDL_internal.h"
#include "SDL.h"
#include "SDL_atomic.h"
#include "SDL_messagebox.h"
#include "SDL_video.h"
#include "SDL_assert.h"
#include "SDL_assert_c.h"
#include "video/SDL_sysvideo.h"
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
+ Include dependency graph for SDL_assert.c:

Go to the source code of this file.

Macros

#define ENDLINE   "\n"
 

Functions

static SDL_assert_state SDL_PromptAssertion (const SDL_assert_data *data, void *userdata)
 
static void debug_print (const char *fmt,...)
 
static void SDL_AddAssertionToReport (SDL_assert_data *data)
 
static void SDL_GenerateAssertionReport (void)
 
static SDL_NORETURN void SDL_ExitProcess (int exitcode)
 
static SDL_NORETURN void SDL_AbortAssertion (void)
 
SDL_assert_state SDL_ReportAssertion (SDL_assert_data *data, const char *func, const char *file, int line)
 
void SDL_AssertionsQuit (void)
 
void SDL_SetAssertionHandler (SDL_AssertionHandler handler, void *userdata)
 Set an application-defined assertion handler. More...
 
const SDL_assert_dataSDL_GetAssertionReport (void)
 Get a list of all assertion failures. More...
 
void SDL_ResetAssertionReport (void)
 Reset the list of all assertion failures. More...
 
SDL_AssertionHandler SDL_GetDefaultAssertionHandler (void)
 Get the default assertion handler. More...
 
SDL_AssertionHandler SDL_GetAssertionHandler (void **userdata)
 Get the current assertion handler. More...
 

Variables

static SDL_assert_datatriggered_assertions = NULL
 
static SDL_mutexassertion_mutex = NULL
 
static SDL_AssertionHandler assertion_handler = SDL_PromptAssertion
 
static voidassertion_userdata = NULL
 

Macro Definition Documentation

◆ ENDLINE

#define ENDLINE   "\n"

Referenced by SDL_PromptAssertion().

Function Documentation

◆ debug_print()

static void debug_print ( const char *  fmt,
  ... 
)
static

Definition at line 74 of file SDL_assert.c.

References SDL_LOG_CATEGORY_ASSERT, SDL_LOG_PRIORITY_WARN, and SDL_LogMessageV.

Referenced by SDL_GenerateAssertionReport(), and SDL_PromptAssertion().

75 {
76  va_list ap;
77  va_start(ap, fmt);
79  va_end(ap);
80 }
#define SDL_LogMessageV

◆ SDL_AbortAssertion()

static SDL_NORETURN void SDL_AbortAssertion ( void  )
static

Definition at line 137 of file SDL_assert.c.

References SDL_assert_state, SDL_ExitProcess(), SDL_Quit, and SDLCALL.

Referenced by SDL_ReportAssertion().

138 {
139  SDL_Quit();
140  SDL_ExitProcess(42);
141 }
#define SDL_Quit
static SDL_NORETURN void SDL_ExitProcess(int exitcode)
Definition: SDL_assert.c:123

◆ SDL_AddAssertionToReport()

static void SDL_AddAssertionToReport ( SDL_assert_data data)
static

Definition at line 83 of file SDL_assert.c.

References triggered_assertions.

Referenced by SDL_ReportAssertion().

84 {
85  /* (data) is always a static struct defined with the assert macros, so
86  we don't have to worry about copying or allocating them. */
87  data->trigger_count++;
88  if (data->trigger_count == 1) { /* not yet added? */
89  data->next = triggered_assertions;
91  }
92 }
static SDL_assert_data * triggered_assertions
Definition: SDL_assert.c:59
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974

◆ SDL_AssertionsQuit()

void SDL_AssertionsQuit ( void  )

Definition at line 387 of file SDL_assert.c.

References NULL, SDL_DestroyMutex, and SDL_GenerateAssertionReport().

Referenced by SDL_Quit().

388 {
390 #ifndef SDL_THREADS_DISABLED
391  if (assertion_mutex != NULL) {
394  }
395 #endif
396 }
static void SDL_GenerateAssertionReport(void)
Definition: SDL_assert.c:95
#define NULL
Definition: begin_code.h:164
#define SDL_DestroyMutex
static SDL_mutex * assertion_mutex
Definition: SDL_assert.c:62

◆ SDL_ExitProcess()

static SDL_NORETURN void SDL_ExitProcess ( int  exitcode)
static

Definition at line 123 of file SDL_assert.c.

Referenced by SDL_AbortAssertion(), and SDL_ReportAssertion().

124 {
125 #ifdef __WIN32__
126  ExitProcess(exitcode);
127 #elif defined(__EMSCRIPTEN__)
128  emscripten_cancel_main_loop(); /* this should "kill" the app. */
129  emscripten_force_exit(exitcode); /* this should "kill" the app. */
130  exit(exitcode);
131 #else
132  _exit(exitcode);
133 #endif
134 }

◆ SDL_GenerateAssertionReport()

static void SDL_GenerateAssertionReport ( void  )
static

Definition at line 95 of file SDL_assert.c.

References assertion_handler, debug_print(), NULL, SDL_assert_data, SDL_PromptAssertion(), SDL_ResetAssertionReport(), and triggered_assertions.

Referenced by SDL_AssertionsQuit().

96 {
98 
99  /* only do this if the app hasn't assigned an assertion handler. */
100  if ((item != NULL) && (assertion_handler != SDL_PromptAssertion)) {
101  debug_print("\n\nSDL assertion report.\n");
102  debug_print("All SDL assertions between last init/quit:\n\n");
103 
104  while (item != NULL) {
105  debug_print(
106  "'%s'\n"
107  " * %s (%s:%d)\n"
108  " * triggered %u time%s.\n"
109  " * always ignore: %s.\n",
110  item->condition, item->function, item->filename,
111  item->linenum, item->trigger_count,
112  (item->trigger_count == 1) ? "" : "s",
113  item->always_ignore ? "yes" : "no");
114  item = item->next;
115  }
116  debug_print("\n");
117 
119  }
120 }
static SDL_AssertionHandler assertion_handler
Definition: SDL_assert.c:65
static SDL_assert_data * triggered_assertions
Definition: SDL_assert.c:59
void SDL_ResetAssertionReport(void)
Reset the list of all assertion failures.
Definition: SDL_assert.c:414
static SDL_assert_state SDL_PromptAssertion(const SDL_assert_data *data, void *userdata)
Definition: SDL_assert.c:145
static void debug_print(const char *fmt,...)
Definition: SDL_assert.c:74
#define NULL
Definition: begin_code.h:164
#define SDL_assert_data
Definition: SDL_assert.h:280

◆ SDL_GetAssertionHandler()

SDL_AssertionHandler SDL_GetAssertionHandler ( void **  puserdata)

Get the current assertion handler.

This returns the function pointer that is called when an assertion is triggered. This is either the value last passed to SDL_SetAssertionHandler(), or if no application-specified function is set, is equivalent to calling SDL_GetDefaultAssertionHandler().

Parameters
puserdataPointer to a void*, which will store the "userdata" pointer that was passed to SDL_SetAssertionHandler(). This value will always be NULL for the default handler. If you don't care about this data, it is safe to pass a NULL pointer to this function to ignore it.
Returns
The SDL_AssertionHandler that is called when an assert triggers.

Definition at line 433 of file SDL_assert.c.

References assertion_handler, assertion_userdata, and NULL.

434 {
435  if (userdata != NULL) {
436  *userdata = assertion_userdata;
437  }
438  return assertion_handler;
439 }
static SDL_AssertionHandler assertion_handler
Definition: SDL_assert.c:65
static void * assertion_userdata
Definition: SDL_assert.c:66
#define NULL
Definition: begin_code.h:164

◆ SDL_GetAssertionReport()

const SDL_assert_data* SDL_GetAssertionReport ( void  )

Get a list of all assertion failures.

Get all assertions triggered since last call to SDL_ResetAssertionReport(), or the start of the program.

The proper way to examine this data looks something like this:

const SDL_AssertData *item = SDL_GetAssertionReport(); while (item) { printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\\n", item->condition, item->function, item->filename, item->linenum, item->trigger_count, item->always_ignore ? "yes" : "no"); item = item->next; }

Returns
List of all assertions.
See also
SDL_ResetAssertionReport

Definition at line 409 of file SDL_assert.c.

References triggered_assertions.

410 {
411  return triggered_assertions;
412 }
static SDL_assert_data * triggered_assertions
Definition: SDL_assert.c:59

◆ SDL_GetDefaultAssertionHandler()

SDL_AssertionHandler SDL_GetDefaultAssertionHandler ( void  )

Get the default assertion handler.

This returns the function pointer that is called by default when an assertion is triggered. This is an internal function provided by SDL, that is used for assertions when SDL_SetAssertionHandler() hasn't been used to provide a different function.

Returns
The default SDL_AssertionHandler that is called when an assert triggers.

Definition at line 428 of file SDL_assert.c.

References SDL_PromptAssertion().

429 {
430  return SDL_PromptAssertion;
431 }
static SDL_assert_state SDL_PromptAssertion(const SDL_assert_data *data, void *userdata)
Definition: SDL_assert.c:145

◆ SDL_PromptAssertion()

static SDL_assert_state SDL_PromptAssertion ( const SDL_assert_data data,
void userdata 
)
static

Definition at line 145 of file SDL_assert.c.

References SDL_MessageBoxData::buttons, debug_print(), ENDLINE, SDL_MessageBoxData::flags, free, SDL_MessageBoxData::message, NULL, SDL_MessageBoxData::numbuttons, SDL_arraysize, SDL_assert_state, SDL_ASSERTION_ABORT, SDL_ASSERTION_ALWAYS_IGNORE, SDL_ASSERTION_BREAK, SDL_ASSERTION_IGNORE, SDL_ASSERTION_RETRY, SDL_FALSE, SDL_getenv, SDL_GetFocusWindow(), SDL_GetWindowFlags, SDL_MAX_LOG_MESSAGE, SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, SDL_MESSAGEBOX_WARNING, SDL_MinimizeWindow, SDL_RestoreWindow, SDL_ShowMessageBox, SDL_snprintf, SDL_stack_alloc, SDL_stack_free, SDL_strcmp, SDL_strncmp, SDL_TRUE, SDL_WINDOW_FULLSCREEN, SDL_zero, state, SDL_MessageBoxData::title, void, and SDL_MessageBoxData::window.

Referenced by SDL_GenerateAssertionReport(), SDL_GetDefaultAssertionHandler(), and SDL_SetAssertionHandler().

146 {
147 #ifdef __WIN32__
148  #define ENDLINE "\r\n"
149 #else
150  #define ENDLINE "\n"
151 #endif
152 
153  const char *envr;
156  SDL_MessageBoxData messagebox;
157  SDL_MessageBoxButtonData buttons[] = {
158  { 0, SDL_ASSERTION_RETRY, "Retry" },
159  { 0, SDL_ASSERTION_BREAK, "Break" },
160  { 0, SDL_ASSERTION_ABORT, "Abort" },
162  SDL_ASSERTION_IGNORE, "Ignore" },
164  SDL_ASSERTION_ALWAYS_IGNORE, "Always Ignore" }
165  };
166  char *message;
167  int selected;
168 
169  (void) userdata; /* unused in default handler. */
170 
171  message = SDL_stack_alloc(char, SDL_MAX_LOG_MESSAGE);
172  if (!message) {
173  /* Uh oh, we're in real trouble now... */
174  return SDL_ASSERTION_ABORT;
175  }
177  "Assertion failure at %s (%s:%d), triggered %u %s:" ENDLINE
178  " '%s'",
179  data->function, data->filename, data->linenum,
180  data->trigger_count, (data->trigger_count == 1) ? "time" : "times",
181  data->condition);
182 
183  debug_print("\n\n%s\n\n", message);
184 
185  /* let env. variable override, so unit tests won't block in a GUI. */
186  envr = SDL_getenv("SDL_ASSERT");
187  if (envr != NULL) {
188  SDL_stack_free(message);
189 
190  if (SDL_strcmp(envr, "abort") == 0) {
191  return SDL_ASSERTION_ABORT;
192  } else if (SDL_strcmp(envr, "break") == 0) {
193  return SDL_ASSERTION_BREAK;
194  } else if (SDL_strcmp(envr, "retry") == 0) {
195  return SDL_ASSERTION_RETRY;
196  } else if (SDL_strcmp(envr, "ignore") == 0) {
197  return SDL_ASSERTION_IGNORE;
198  } else if (SDL_strcmp(envr, "always_ignore") == 0) {
200  } else {
201  return SDL_ASSERTION_ABORT; /* oh well. */
202  }
203  }
204 
205  /* Leave fullscreen mode, if possible (scary!) */
206  window = SDL_GetFocusWindow();
207  if (window) {
209  SDL_MinimizeWindow(window);
210  } else {
211  /* !!! FIXME: ungrab the input if we're not fullscreen? */
212  /* No need to mess with the window */
213  window = NULL;
214  }
215  }
216 
217  /* Show a messagebox if we can, otherwise fall back to stdio */
218  SDL_zero(messagebox);
219  messagebox.flags = SDL_MESSAGEBOX_WARNING;
220  messagebox.window = window;
221  messagebox.title = "Assertion Failed";
222  messagebox.message = message;
223  messagebox.numbuttons = SDL_arraysize(buttons);
224  messagebox.buttons = buttons;
225 
226  if (SDL_ShowMessageBox(&messagebox, &selected) == 0) {
227  if (selected == -1) {
228  state = SDL_ASSERTION_IGNORE;
229  } else {
230  state = (SDL_assert_state)selected;
231  }
232  }
233 
234  else
235  {
236 #if defined(__EMSCRIPTEN__)
237  /* This is nasty, but we can't block on a custom UI. */
238  for ( ; ; ) {
239  SDL_bool okay = SDL_TRUE;
240  char *buf = (char *) EM_ASM_INT({
241  var str =
242  Pointer_stringify($0) + '\n\n' +
243  'Abort/Retry/Ignore/AlwaysIgnore? [ariA] :';
244  var reply = window.prompt(str, "i");
245  if (reply === null) {
246  reply = "i";
247  }
248  return allocate(intArrayFromString(reply), 'i8', ALLOC_NORMAL);
249  }, message);
250 
251  if (SDL_strcmp(buf, "a") == 0) {
252  state = SDL_ASSERTION_ABORT;
253  /* (currently) no break functionality on Emscripten
254  } else if (SDL_strcmp(buf, "b") == 0) {
255  state = SDL_ASSERTION_BREAK; */
256  } else if (SDL_strcmp(buf, "r") == 0) {
257  state = SDL_ASSERTION_RETRY;
258  } else if (SDL_strcmp(buf, "i") == 0) {
259  state = SDL_ASSERTION_IGNORE;
260  } else if (SDL_strcmp(buf, "A") == 0) {
262  } else {
263  okay = SDL_FALSE;
264  }
265  free(buf);
266 
267  if (okay) {
268  break;
269  }
270  }
271 #elif defined(HAVE_STDIO_H)
272  /* this is a little hacky. */
273  for ( ; ; ) {
274  char buf[32];
275  fprintf(stderr, "Abort/Break/Retry/Ignore/AlwaysIgnore? [abriA] : ");
276  fflush(stderr);
277  if (fgets(buf, sizeof (buf), stdin) == NULL) {
278  break;
279  }
280 
281  if (SDL_strncmp(buf, "a", 1) == 0) {
282  state = SDL_ASSERTION_ABORT;
283  break;
284  } else if (SDL_strncmp(buf, "b", 1) == 0) {
285  state = SDL_ASSERTION_BREAK;
286  break;
287  } else if (SDL_strncmp(buf, "r", 1) == 0) {
288  state = SDL_ASSERTION_RETRY;
289  break;
290  } else if (SDL_strncmp(buf, "i", 1) == 0) {
291  state = SDL_ASSERTION_IGNORE;
292  break;
293  } else if (SDL_strncmp(buf, "A", 1) == 0) {
295  break;
296  }
297  }
298 #endif /* HAVE_STDIO_H */
299  }
300 
301  /* Re-enter fullscreen mode */
302  if (window) {
303  SDL_RestoreWindow(window);
304  }
305 
306  SDL_stack_free(message);
307 
308  return state;
309 }
const char * message
#define SDL_MAX_LOG_MESSAGE
The maximum size of a log message.
Definition: SDL_log.h:54
const char * title
SDL_Window * window
GLuint GLsizei const GLchar * message
struct xkb_state * state
SDL_EventEntry * free
Definition: SDL_events.c:84
#define SDL_GetWindowFlags
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
#define SDL_MinimizeWindow
#define SDL_strncmp
static void debug_print(const char *fmt,...)
Definition: SDL_assert.c:74
Individual button data.
#define SDL_stack_alloc(type, count)
Definition: SDL_stdinc.h:354
SDL_Window * SDL_GetFocusWindow(void)
Definition: SDL_video.c:2594
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
GLenum GLuint GLenum GLsizei const GLchar * buf
const SDL_MessageBoxButtonData * buttons
MessageBox structure containing title, text, window, etc.
#define SDL_RestoreWindow
#define SDL_getenv
#define SDL_ShowMessageBox
#define NULL
Definition: begin_code.h:164
SDL_bool
Definition: SDL_stdinc.h:139
#define SDL_assert_state
Definition: SDL_assert.h:279
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
The type used to identify a window.
Definition: SDL_sysvideo.h:73
#define SDL_snprintf
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:93
#define SDL_strcmp
#define SDL_stack_free(data)
Definition: SDL_stdinc.h:355
#define ENDLINE

◆ SDL_ReportAssertion()

SDL_assert_state SDL_ReportAssertion ( SDL_assert_data data,
const char *  func,
const char *  file,
int  line 
)

Definition at line 313 of file SDL_assert.c.

References assertion_handler, assertion_userdata, NULL, SDL_AbortAssertion(), SDL_AddAssertionToReport(), SDL_assert_state, SDL_ASSERTION_ABORT, SDL_ASSERTION_ALWAYS_IGNORE, SDL_ASSERTION_BREAK, SDL_ASSERTION_IGNORE, SDL_ASSERTION_RETRY, SDL_AtomicLock, SDL_AtomicUnlock, SDL_CreateMutex, SDL_ExitProcess(), SDL_LockMutex, SDL_UnlockMutex, and state.

315 {
317  static int assertion_running = 0;
318 
319 #ifndef SDL_THREADS_DISABLED
320  static SDL_SpinLock spinlock = 0;
321  SDL_AtomicLock(&spinlock);
322  if (assertion_mutex == NULL) { /* never called SDL_Init()? */
324  if (assertion_mutex == NULL) {
325  SDL_AtomicUnlock(&spinlock);
326  return SDL_ASSERTION_IGNORE; /* oh well, I guess. */
327  }
328  }
329  SDL_AtomicUnlock(&spinlock);
330 
331  if (SDL_LockMutex(assertion_mutex) < 0) {
332  return SDL_ASSERTION_IGNORE; /* oh well, I guess. */
333  }
334 #endif
335 
336  /* doing this because Visual C is upset over assigning in the macro. */
337  if (data->trigger_count == 0) {
338  data->function = func;
339  data->filename = file;
340  data->linenum = line;
341  }
342 
344 
345  assertion_running++;
346  if (assertion_running > 1) { /* assert during assert! Abort. */
347  if (assertion_running == 2) {
349  } else if (assertion_running == 3) { /* Abort asserted! */
350  SDL_ExitProcess(42);
351  } else {
352  while (1) { /* do nothing but spin; what else can you do?! */ }
353  }
354  }
355 
356  if (!data->always_ignore) {
358  }
359 
360  switch (state)
361  {
362  case SDL_ASSERTION_ABORT:
364  return SDL_ASSERTION_IGNORE; /* shouldn't return, but oh well. */
365 
367  state = SDL_ASSERTION_IGNORE;
368  data->always_ignore = 1;
369  break;
370 
372  case SDL_ASSERTION_RETRY:
373  case SDL_ASSERTION_BREAK:
374  break; /* macro handles these. */
375  }
376 
377  assertion_running--;
378 
379 #ifndef SDL_THREADS_DISABLED
381 #endif
382 
383  return state;
384 }
static SDL_AssertionHandler assertion_handler
Definition: SDL_assert.c:65
#define SDL_LockMutex
#define SDL_AtomicLock
#define SDL_CreateMutex
struct xkb_state * state
static void * assertion_userdata
Definition: SDL_assert.c:66
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
#define SDL_AtomicUnlock
static void SDL_AddAssertionToReport(SDL_assert_data *data)
Definition: SDL_assert.c:83
static SDL_NORETURN void SDL_AbortAssertion(void)
Definition: SDL_assert.c:137
#define NULL
Definition: begin_code.h:164
static SDL_NORETURN void SDL_ExitProcess(int exitcode)
Definition: SDL_assert.c:123
#define SDL_assert_state
Definition: SDL_assert.h:279
GLenum func
static SDL_mutex * assertion_mutex
Definition: SDL_assert.c:62
#define SDL_UnlockMutex
int SDL_SpinLock
Definition: SDL_atomic.h:89

◆ SDL_ResetAssertionReport()

void SDL_ResetAssertionReport ( void  )

Reset the list of all assertion failures.

Reset list of all assertions triggered.

See also
SDL_GetAssertionReport

Definition at line 414 of file SDL_assert.c.

References NULL, SDL_assert_data, SDL_FALSE, and triggered_assertions.

Referenced by SDL_GenerateAssertionReport().

415 {
416  SDL_assert_data *next = NULL;
417  SDL_assert_data *item;
418  for (item = triggered_assertions; item != NULL; item = next) {
419  next = (SDL_assert_data *) item->next;
420  item->always_ignore = SDL_FALSE;
421  item->trigger_count = 0;
422  item->next = NULL;
423  }
424 
426 }
static SDL_assert_data * triggered_assertions
Definition: SDL_assert.c:59
#define NULL
Definition: begin_code.h:164
#define SDL_assert_data
Definition: SDL_assert.h:280

◆ SDL_SetAssertionHandler()

void SDL_SetAssertionHandler ( SDL_AssertionHandler  handler,
void userdata 
)

Set an application-defined assertion handler.

This allows an app to show its own assertion UI and/or force the response to an assertion failure. If the app doesn't provide this, SDL will try to do the right thing, popping up a system-specific GUI dialog, and probably minimizing any fullscreen windows.

This callback may fire from any thread, but it runs wrapped in a mutex, so it will only fire from one thread at a time.

Setting the callback to NULL restores SDL's original internal handler.

This callback is NOT reset to SDL's internal handler upon SDL_Quit()!

Return SDL_AssertState value of how to handle the assertion failure.

Parameters
handlerCallback function, called when an assertion fails.
userdataA pointer passed to the callback as-is.

Definition at line 398 of file SDL_assert.c.

References assertion_handler, assertion_userdata, NULL, and SDL_PromptAssertion().

399 {
400  if (handler != NULL) {
401  assertion_handler = handler;
402  assertion_userdata = userdata;
403  } else {
406  }
407 }
static SDL_AssertionHandler assertion_handler
Definition: SDL_assert.c:65
static void * assertion_userdata
Definition: SDL_assert.c:66
static SDL_assert_state SDL_PromptAssertion(const SDL_assert_data *data, void *userdata)
Definition: SDL_assert.c:145
#define NULL
Definition: begin_code.h:164

Variable Documentation

◆ assertion_handler

◆ assertion_mutex

SDL_mutex* assertion_mutex = NULL
static

Definition at line 62 of file SDL_assert.c.

◆ assertion_userdata

void* assertion_userdata = NULL
static

◆ triggered_assertions