include/SDL_assert.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 13 Jan 2010 07:52:53 +0000
changeset 3653 1cd9f7117b98
parent 3652 dbd6a29e4b77
child 3654 336f3df1578d
permissions -rw-r--r--
Automatically figure out the appropriate assertion level
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 #include "SDL_config.h"
    23 
    24 #ifndef _SDL_assert_h
    25 #define _SDL_assert_h
    26 
    27 #ifndef SDL_ASSERT_LEVEL
    28 #if defined(_DEBUG) || defined(DEBUG) || \
    29     (defined(__GNUC__) && !defined(__OPTIMIZE__))
    30 #define SDL_ASSERT_LEVEL 2
    31 #else
    32 #define SDL_ASSERT_LEVEL 1
    33 #endif
    34 #endif /* SDL_ASSERT_LEVEL */
    35 
    36 /*
    37 sizeof (x) makes the compiler still parse the expression even without
    38 assertions enabled, so the code is always checked at compile time, but
    39 doesn't actually generate code for it, so there are no side effects or
    40 expensive checks at run time, just the constant size of what x WOULD be,
    41 which presumably gets optimized out as unused.
    42 This also solves the problem of...
    43 
    44     int somevalue = blah();
    45     SDL_assert(somevalue == 1);
    46 
    47 ...which would cause compiles to complain that somevalue is unused if we
    48 disable assertions.
    49 */
    50 
    51 #define SDL_disabled_assert(condition) \
    52     do { (void) sizeof ((condition)); } while (0)
    53 
    54 #if (SDL_ASSERT_LEVEL > 0)
    55 
    56 /*
    57 These are macros and not first class functions so that the debugger breaks
    58 on the assertion line and not in some random guts of SDL, and so each
    59 macro can have unique static variables associated with it.
    60 */
    61 
    62 #if (defined(_MSC_VER) && ((_M_IX86) || (_M_X64)))
    63     #define SDL_TriggerBreakpoint() __asm { int 3 }
    64 #elif (defined(__GNUC__) && ((__i386__) || (__x86_64__)))
    65     #define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "int $3\n\t" )
    66 #elif defined(HAVE_SIGNAL_H)
    67     #include <signal.h>
    68     #define SDL_TriggerBreakpoint() raise(SIGTRAP)
    69 #else
    70     #error Please define your platform or set SDL_ASSERT_LEVEL to 0.
    71 #endif
    72 
    73 #if (__STDC_VERSION__ >= 199901L) /* C99 supports __func__ as a standard. */
    74 #   define SDL_FUNCTION __func__
    75 #elif ((__GNUC__ >= 2) || defined(_MSC_VER))
    76 #   define SDL_FUNCTION __FUNCTION__
    77 #else
    78 #   define SDL_FUNCTION "???"
    79 #endif
    80 
    81 typedef enum
    82 {
    83     SDL_ASSERTION_RETRY,  /**< Retry the assert immediately. */
    84     SDL_ASSERTION_BREAK,  /**< Make the debugger trigger a breakpoint. */
    85     SDL_ASSERTION_ABORT,  /**< Terminate the program. */
    86     SDL_ASSERTION_IGNORE,  /**< Ignore the assert. */
    87     SDL_ASSERTION_ALWAYS_IGNORE,  /**< Ignore the assert from now on. */
    88 } SDL_assert_state;
    89 
    90 typedef struct SDL_assert_data
    91 {
    92     int always_ignore;
    93     unsigned int trigger_count;
    94     const char *condition;
    95     const char *filename;
    96     int linenum;
    97     const char *function;
    98     struct SDL_assert_data *next;
    99 } SDL_assert_data;
   100 
   101 SDL_assert_state SDL_ReportAssertion(SDL_assert_data *, const char *, int);
   102 
   103 /* the do {} while(0) avoids dangling else problems:
   104     if (x) SDL_assert(y); else blah();
   105        ... without the do/while, the "else" could attach to this macro's "if".
   106    We try to handle just the minimum we need here in a macro...the loop,
   107    the static vars, and break points. The heavy lifting is handled in
   108    SDL_ReportAssertion(), in SDL_assert.c.
   109 */
   110 #define SDL_enabled_assert(condition) \
   111     do { \
   112         while ( !(condition) ) { \
   113             static struct SDL_assert_data assert_data = { \
   114                 0, 0, #condition, __FILE__, 0, 0, 0 \
   115             }; \
   116             const SDL_assert_state state = SDL_ReportAssertion(&assert_data, \
   117                                                                SDL_FUNCTION, \
   118                                                                __LINE__); \
   119             if (state == SDL_ASSERTION_RETRY) { \
   120                 continue; /* go again. */ \
   121             } else if (state == SDL_ASSERTION_BREAK) { \
   122                 SDL_TriggerBreakpoint(); \
   123             } \
   124             break; /* not retrying. */ \
   125         } \
   126     } while (0)
   127 
   128 #endif  /* enabled assertions support code */
   129 
   130 /* Enable various levels of assertions. */
   131 #if SDL_ASSERT_LEVEL == 0   /* assertions disabled */
   132 #   define SDL_assert(condition) SDL_disabled_assert(condition)
   133 #   define SDL_assert_release(condition) SDL_disabled_assert(condition)
   134 #   define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
   135 #elif SDL_ASSERT_LEVEL == 1  /* release settings. */
   136 #   define SDL_assert(condition) SDL_disabled_assert(condition)
   137 #   define SDL_assert_release(condition) SDL_enabled_assert(condition)
   138 #   define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
   139 #elif SDL_ASSERT_LEVEL == 2  /* normal settings. */
   140 #   define SDL_assert(condition) SDL_enabled_assert(condition)
   141 #   define SDL_assert_release(condition) SDL_enabled_assert(condition)
   142 #   define SDL_assert_paranoid(condition) SDL_disabled_assert(condition)
   143 #elif SDL_ASSERT_LEVEL == 3  /* paranoid settings. */
   144 #   define SDL_assert(condition) SDL_enabled_assert(condition)
   145 #   define SDL_assert_release(condition) SDL_enabled_assert(condition)
   146 #   define SDL_assert_paranoid(condition) SDL_enabled_assert(condition)
   147 #else
   148 #   error Unknown assertion level. Please fix your SDL_config.h.
   149 #endif
   150 
   151 #endif /* _SDL_assert_h */
   152 
   153 /* vi: set ts=4 sw=4 expandtab: */