#include "SDL_config.h"
#include "begin_code.h"
#include "close_code.h"

Classes
struct	SDL_AssertData

Macros
#define	SDL_ASSERT_LEVEL 1

#define	SDL_TriggerBreakpoint()

#define	SDL_FUNCTION "???"

#define	SDL_FILE __FILE__

#define	SDL_LINE __LINE__

#define	SDL_NULL_WHILE_LOOP_CONDITION (0)

#define	SDL_disabled_assert(condition) do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION)

#define	SDL_enabled_assert(condition)

#define	SDL_assert(condition) SDL_disabled_assert(condition)

#define	SDL_assert_release(condition) SDL_enabled_assert(condition)

#define	SDL_assert_paranoid(condition) SDL_disabled_assert(condition)

#define	SDL_assert_always(condition) SDL_enabled_assert(condition)

#define	SDL_assert_state SDL_AssertState

#define	SDL_assert_data SDL_AssertData

Typedefs
typedef struct SDL_AssertData	SDL_AssertData

typedef SDL_AssertState(SDLCALL *	SDL_AssertionHandler) (const SDL_AssertData data, void userdata)

Enumerations
enum	SDL_AssertState { SDL_ASSERTION_RETRY, SDL_ASSERTION_BREAK, SDL_ASSERTION_ABORT, SDL_ASSERTION_IGNORE, SDL_ASSERTION_ALWAYS_IGNORE }

Functions
DECLSPEC SDL_AssertState SDLCALL	SDL_ReportAssertion (SDL_AssertData , const char , const char *, int)

DECLSPEC void SDLCALL	SDL_SetAssertionHandler (SDL_AssertionHandler handler, void *userdata)
	Set an application-defined assertion handler. More...

DECLSPEC SDL_AssertionHandler SDLCALL	SDL_GetDefaultAssertionHandler (void)
	Get the default assertion handler. More...

DECLSPEC SDL_AssertionHandler SDLCALL	SDL_GetAssertionHandler (void **puserdata)
	Get the current assertion handler. More...

DECLSPEC const SDL_AssertData *SDLCALL	SDL_GetAssertionReport (void)
	Get a list of all assertion failures. More...

DECLSPEC void SDLCALL	SDL_ResetAssertionReport (void)
	Reset the list of all assertion failures. More...

Macro Definition Documentation

◆ SDL_assert

#define SDL_assert ( condition ) SDL_disabled_assert(condition)

Definition at line 169 of file SDL_assert.h.

◆ SDL_assert_always

#define SDL_assert_always ( condition ) SDL_enabled_assert(condition)

Definition at line 185 of file SDL_assert.h.

◆ SDL_assert_data

#define SDL_assert_data SDL_AssertData

Definition at line 280 of file SDL_assert.h.

◆ SDL_ASSERT_LEVEL

#define SDL_ASSERT_LEVEL 1

Definition at line 40 of file SDL_assert.h.

◆ SDL_assert_paranoid

#define SDL_assert_paranoid ( condition ) SDL_disabled_assert(condition)

Definition at line 171 of file SDL_assert.h.

◆ SDL_assert_release

#define SDL_assert_release ( condition ) SDL_enabled_assert(condition)

Definition at line 170 of file SDL_assert.h.

◆ SDL_assert_state

#define SDL_assert_state SDL_AssertState

Definition at line 279 of file SDL_assert.h.

◆ SDL_disabled_assert

#define SDL_disabled_assert ( condition ) do { (void) sizeof ((condition)); } while (SDL_NULL_WHILE_LOOP_CONDITION)

Definition at line 99 of file SDL_assert.h.

◆ SDL_enabled_assert

#define SDL_enabled_assert ( condition )

Value:

do { \
        while ( !(condition) ) { \
            static struct SDL_AssertData sdl_assert_data = { \
                0, 0, #condition, 0, 0, 0, 0 \
            }; \
            const SDL_AssertState sdl_assert_state = SDL_ReportAssertion(&sdl_assert_data, SDL_FUNCTION, SDL_FILE, SDL_LINE); \
            if (sdl_assert_state == SDL_ASSERTION_RETRY) { \
                continue; /* go again. */ \
            } else if (sdl_assert_state == SDL_ASSERTION_BREAK) { \
                SDL_TriggerBreakpoint(); \
            } \
            break; /* not retrying. */ \
        } \
    } while (SDL_NULL_WHILE_LOOP_CONDITION)

Definition at line 145 of file SDL_assert.h.

◆ SDL_FILE

#define SDL_FILE __FILE__

Definition at line 73 of file SDL_assert.h.

◆ SDL_FUNCTION

#define SDL_FUNCTION "???"

Definition at line 71 of file SDL_assert.h.

◆ SDL_LINE

#define SDL_LINE __LINE__

Definition at line 74 of file SDL_assert.h.

◆ SDL_NULL_WHILE_LOOP_CONDITION

#define SDL_NULL_WHILE_LOOP_CONDITION (0)

Definition at line 96 of file SDL_assert.h.

◆ SDL_TriggerBreakpoint

#define SDL_TriggerBreakpoint ( )

Definition at line 63 of file SDL_assert.h.

Typedef Documentation

◆ SDL_AssertData

typedef struct SDL_AssertData SDL_AssertData

◆ SDL_AssertionHandler

typedef SDL_AssertState(SDLCALL * SDL_AssertionHandler) (const SDL_AssertData *data, void *userdata)

Definition at line 188 of file SDL_assert.h.

Enumeration Type Documentation

◆ SDL_AssertState

enum SDL_AssertState

Enumerator
SDL_ASSERTION_RETRY	Retry the assert immediately.
SDL_ASSERTION_BREAK	Make the debugger trigger a breakpoint.
SDL_ASSERTION_ABORT	Terminate the program.
SDL_ASSERTION_IGNORE	Ignore the assert.
SDL_ASSERTION_ALWAYS_IGNORE	Ignore the assert from now on.

Definition at line 102 of file SDL_assert.h.

 {
     SDL_ASSERTION_RETRY,  
     SDL_ASSERTION_BREAK,  
     SDL_ASSERTION_ABORT,  
     SDL_ASSERTION_IGNORE,  
     SDL_ASSERTION_ALWAYS_IGNORE  
 } SDL_AssertState;

Function Documentation

◆ SDL_GetAssertionHandler()

DECLSPEC SDL_AssertionHandler SDLCALL 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

puserdata Pointer 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.

◆ SDL_GetAssertionReport()

DECLSPEC const SDL_AssertData* SDLCALL 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

◆ SDL_GetDefaultAssertionHandler()

DECLSPEC SDL_AssertionHandler SDLCALL 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.

◆ SDL_ReportAssertion()

DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion	(	SDL_AssertData *	,
		const char *	,
		const char *	,
		int
	)

◆ SDL_ResetAssertionReport()

DECLSPEC void SDLCALL SDL_ResetAssertionReport ( void )

Reset the list of all assertion failures.

Reset list of all assertions triggered.

See also: SDL_GetAssertionReport

◆ SDL_SetAssertionHandler()

DECLSPEC void SDLCALL 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.