sdl-ios-xcode: include/SDL_assert.h annotate

annotate include/SDL_assert.h @ 3696:47d923feedb0

Fixed bug #935 Patrice Mandin Hello, I originally added pth support for threads in SDL 1.2 because on the Atari platform we did not have any thread library. I think pth support could be removed from SDL 1.3 for two reasons: - Atari platform removed - pth does not provides real (preemptive) threads, because it is user space, and expect the application to call one of its function to give CPU to another thread. So it is not exactly useful for applications, that expect threads to run simultaneously.

author	Sam Lantinga <slouken@libsdl.org>
date	Sun, 24 Jan 2010 20:47:20 +0000
parents	62b6a5b99918
children	f7b03b6838cb

rev	line source
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 /*
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2 SDL - Simple DirectMedia Layer
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 Copyright (C) 1997-2009 Sam Lantinga
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 This library is free software; you can redistribute it and/or
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 License as published by the Free Software Foundation; either
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 Lesser General Public License for more details.
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16 License along with this library; if not, write to the Free Software
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	18
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19 Sam Lantinga
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 slouken@libsdl.org
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21 */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23 #ifndef _SDL_assert_h
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 #define _SDL_assert_h
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	26 #include "SDL_config.h"
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	27
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	28 #include "begin_code.h"
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	29 /* Set up for C function definitions, even when using C++ */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	30 #ifdef __cplusplus
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	31 /* INDENT-OFF */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	32 extern "C" {
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	33 /* INDENT-ON */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	34 #endif
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	35
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36 #ifndef SDL_ASSERT_LEVEL
3654 336f3df1578d Allow configure to override assertion settings, but by default this comes from the build optimization level. Sam Lantinga <slouken@libsdl.org> parents: 3653 diff changeset	37 #ifdef SDL_DEFAULT_ASSERT_LEVEL
336f3df1578d Allow configure to override assertion settings, but by default this comes from the build optimization level. Sam Lantinga <slouken@libsdl.org> parents: 3653 diff changeset	38 #define SDL_ASSERT_LEVEL SDL_DEFAULT_ASSERT_LEVEL
336f3df1578d Allow configure to override assertion settings, but by default this comes from the build optimization level. Sam Lantinga <slouken@libsdl.org> parents: 3653 diff changeset	39 #elif defined(_DEBUG) \|\| defined(DEBUG) \|\| \
336f3df1578d Allow configure to override assertion settings, but by default this comes from the build optimization level. Sam Lantinga <slouken@libsdl.org> parents: 3653 diff changeset	40 (defined(__GNUC__) && !defined(__OPTIMIZE__))
3653 1cd9f7117b98 Automatically figure out the appropriate assertion level Sam Lantinga <slouken@libsdl.org> parents: 3652 diff changeset	41 #define SDL_ASSERT_LEVEL 2
1cd9f7117b98 Automatically figure out the appropriate assertion level Sam Lantinga <slouken@libsdl.org> parents: 3652 diff changeset	42 #else
1cd9f7117b98 Automatically figure out the appropriate assertion level Sam Lantinga <slouken@libsdl.org> parents: 3652 diff changeset	43 #define SDL_ASSERT_LEVEL 1
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 #endif
3653 1cd9f7117b98 Automatically figure out the appropriate assertion level Sam Lantinga <slouken@libsdl.org> parents: 3652 diff changeset	45 #endif /* SDL_ASSERT_LEVEL */
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47 /*
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	48 These are macros and not first class functions so that the debugger breaks
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	49 on the assertion line and not in some random guts of SDL, and so each
3665 97114af2f8dc Fixed comment. Ryan C. Gordon <icculus@icculus.org> parents: 3655 diff changeset	50 assert can have unique static variables associated with it.
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	51 */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	52
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	53 #if (defined(_MSC_VER) && ((_M_IX86) \|\| (_M_X64)))
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	54 #define SDL_TriggerBreakpoint() __asm { int 3 }
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	55 #elif (defined(__GNUC__) && ((__i386__) \|\| (__x86_64__)))
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	56 #define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "int $3\n\t" )
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	57 #elif defined(HAVE_SIGNAL_H)
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	58 #include <signal.h>
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	59 #define SDL_TriggerBreakpoint() raise(SIGTRAP)
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	60 #else
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	61 /* How do we trigger breakpoints on this platform? */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	62 #define SDL_TriggerBreakpoint()
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	63 #endif
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	64
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	65 #if (__STDC_VERSION__ >= 199901L) /* C99 supports __func__ as a standard. */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	66 # define SDL_FUNCTION __func__
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	67 #elif ((__GNUC__ >= 2) \|\| defined(_MSC_VER))
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	68 # define SDL_FUNCTION __FUNCTION__
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	69 #else
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	70 # define SDL_FUNCTION "???"
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	71 #endif
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	72 #define SDL_FILE __FILE__
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	73 #define SDL_LINE __LINE__
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	74
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	75 /*
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	76 sizeof (x) makes the compiler still parse the expression even without
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77 assertions enabled, so the code is always checked at compile time, but
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78 doesn't actually generate code for it, so there are no side effects or
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 expensive checks at run time, just the constant size of what x WOULD be,
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 which presumably gets optimized out as unused.
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81 This also solves the problem of...
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 int somevalue = blah();
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84 SDL_assert(somevalue == 1);
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 ...which would cause compiles to complain that somevalue is unused if we
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87 disable assertions.
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88 */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	90 #define SDL_disabled_assert(condition) \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	91 do { (void) sizeof ((condition)); } while (0)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	92
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93 #if (SDL_ASSERT_LEVEL > 0)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	94
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95 typedef enum
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96 {
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97 SDL_ASSERTION_RETRY, /*< Retry the assert immediately. /
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98 SDL_ASSERTION_BREAK, /*< Make the debugger trigger a breakpoint. /
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 SDL_ASSERTION_ABORT, /*< Terminate the program. /
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 SDL_ASSERTION_IGNORE, /*< Ignore the assert. /
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 SDL_ASSERTION_ALWAYS_IGNORE, /*< Ignore the assert from now on. /
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102 } SDL_assert_state;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104 typedef struct SDL_assert_data
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105 {
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 int always_ignore;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 unsigned int trigger_count;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108 const char *condition;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 const char *filename;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110 int linenum;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111 const char *function;
3670 62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	112 const struct SDL_assert_data *next;
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 } SDL_assert_data;
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114
3668 6952d2b783e6 Friendly warning comment. Ryan C. Gordon <icculus@icculus.org> parents: 3666 diff changeset	115 /* Never call this directly. Use the SDL_assert* macros. */
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	116 extern DECLSPEC SDL_assert_state SDLCALL SDL_ReportAssertion(SDL_assert_data *,
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	117 const char *,
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	118 const char *, int);
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 /* the do {} while(0) avoids dangling else problems:
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 if (x) SDL_assert(y); else blah();
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 ... without the do/while, the "else" could attach to this macro's "if".
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 We try to handle just the minimum we need here in a macro...the loop,
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 the static vars, and break points. The heavy lifting is handled in
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 SDL_ReportAssertion(), in SDL_assert.c.
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 #define SDL_enabled_assert(condition) \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128 do { \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 while ( !(condition) ) { \
3649 1e74d7984d0b The config sets the default assertion level so people can override it for their own use in application code. Sam Lantinga <slouken@libsdl.org> parents: 3647 diff changeset	130 static struct SDL_assert_data assert_data = { \
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	131 0, 0, #condition, 0, 0, 0, 0 \
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	132 }; \
3649 1e74d7984d0b The config sets the default assertion level so people can override it for their own use in application code. Sam Lantinga <slouken@libsdl.org> parents: 3647 diff changeset	133 const SDL_assert_state state = SDL_ReportAssertion(&assert_data, \
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	134 SDL_FUNCTION, \
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	135 SDL_FILE, \
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	136 SDL_LINE); \
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 if (state == SDL_ASSERTION_RETRY) { \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	138 continue; /* go again. */ \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	139 } else if (state == SDL_ASSERTION_BREAK) { \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	140 SDL_TriggerBreakpoint(); \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	141 } \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	142 break; /* not retrying. */ \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	143 } \
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	144 } while (0)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	145
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	146 #endif /* enabled assertions support code */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	147
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	148 /* Enable various levels of assertions. */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	149 #if SDL_ASSERT_LEVEL == 0 /* assertions disabled */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	150 # define SDL_assert(condition) SDL_disabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	151 # define SDL_assert_release(condition) SDL_disabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	152 # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	153 #elif SDL_ASSERT_LEVEL == 1 /* release settings. */
3652 dbd6a29e4b77 Fixed release level assertions Sam Lantinga <slouken@libsdl.org> parents: 3650 diff changeset	154 # define SDL_assert(condition) SDL_disabled_assert(condition)
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	155 # define SDL_assert_release(condition) SDL_enabled_assert(condition)
3652 dbd6a29e4b77 Fixed release level assertions Sam Lantinga <slouken@libsdl.org> parents: 3650 diff changeset	156 # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157 #elif SDL_ASSERT_LEVEL == 2 /* normal settings. */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 # define SDL_assert(condition) SDL_enabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	159 # define SDL_assert_release(condition) SDL_enabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 # define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	161 #elif SDL_ASSERT_LEVEL == 3 /* paranoid settings. */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	162 # define SDL_assert(condition) SDL_enabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	163 # define SDL_assert_release(condition) SDL_enabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	164 # define SDL_assert_paranoid(condition) SDL_enabled_assert(condition)
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	165 #else
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	166 # error Unknown assertion level.
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	167 #endif
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	168
3670 62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	169
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	170 typedef SDL_assert_state (SDLCALL *SDL_AssertionHandler)(
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	171 const SDL_assert_data , void userdata);
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	172
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	173 /**
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	174 * \brief Set an application-defined assertion handler.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	175 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	176 * This allows an app to show its own assertion UI and/or force the
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	177 * response to an assertion failure. If the app doesn't provide this, SDL
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	178 * will try to do the right thing, popping up a system-specific GUI dialog,
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	179 * and probably minimizing any fullscreen windows.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	180 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	181 * This callback may fire from any thread, but it runs wrapped in a mutex, so
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	182 * it will only fire from one thread at a time.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	183 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	184 * Setting the callback to NULL restores SDL's original internal handler.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	185 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	186 * This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	187 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	188 * \return SDL_assert_state value of how to handle the assertion failure.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	189 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	190 * \param handler Callback function, called when an assertion fails.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	191 * \param userdata A pointer passed to the callback as-is.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	192 */
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	193 extern DECLSPEC void SDLCALL SDL_SetAssertionHandler(
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	194 SDL_AssertionHandler handler,
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	195 void *userdata);
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	196
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	197 /**
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	198 * \brief Get a list of all assertion failures.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	199 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	200 * Get all assertions triggered since last call to SDL_ResetAssertionReport(),
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	201 * or the start of the program.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	202 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	203 * The proper way to examine this data looks something like this:
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	204 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	205 * <code>
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	206 * const SDL_assert_data *item = SDL_GetAssertionReport();
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	207 * while (item->condition) {
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	208 * printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\n",
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	209 * item->condition, item->function, item->filename,
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	210 * item->linenum, item->trigger_count,
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	211 * item->always_ignore ? "yes" : "no");
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	212 * item = item->next;
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	213 * }
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	214 * </code>
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	215 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	216 * \return List of all assertions. This never returns NULL,
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	217 * even if there are no items.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	218 * \sa SDL_ResetAssertionReport
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	219 */
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	220 extern DECLSPEC const SDL_assert_data * SDLCALL SDL_GetAssertionReport(void);
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	221
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	222 /**
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	223 * \brief Reset the list of all assertion failures.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	224 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	225 * Reset list of all assertions triggered.
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	226 *
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	227 * \sa SDL_GetAssertionReport
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	228 */
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	229 extern DECLSPEC void SDLCALL SDL_ResetAssertionReport(void);
62b6a5b99918 Clean up assertion API for public use. Ryan C. Gordon <icculus@icculus.org> parents: 3668 diff changeset	230
3655 1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	231 /* Ends C function definitions when using C++ */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	232 #ifdef __cplusplus
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	233 /* INDENT-OFF */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	234 }
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	235 /* INDENT-ON */
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	236 #endif
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	237 #include "close_code.h"
1cc7f0143c12 Moved SDL_FUNCTION out so it's always available, and added SDL_FILE and SDL_LINE Sam Lantinga <slouken@libsdl.org> parents: 3654 diff changeset	238
3647 c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	239 #endif /* _SDL_assert_h */
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	240
c5925cd41955 First pass at Ryan's assertion code, minor tweaks to come. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	241 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_assert.h @ 3696:47d923feedb0