src/SDL_assert.c
author Ryan C. Gordon <icculus@icculus.org>
Sun, 16 Dec 2012 14:46:16 -0500
changeset 6759 b74da0b33530
parent 6621 25504f9ab078
child 6885 700f1b25f77f
child 8377 3a7e8110201e
permissions -rw-r--r--
SDL_assertion messages use "\n" instead of "\r\n" on non-Windows platforms.
slouken@3647
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6138
     3
  Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
slouken@3647
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@3647
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@3647
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@3647
    20
*/
slouken@6217
    21
#include "SDL_config.h"
slouken@3647
    22
slouken@3651
    23
#include "SDL.h"
slouken@5006
    24
#include "SDL_atomic.h"
slouken@6621
    25
#include "SDL_messagebox.h"
slouken@6621
    26
#include "SDL_video.h"
slouken@3647
    27
#include "SDL_assert.h"
slouken@4472
    28
#include "SDL_assert_c.h"
slouken@3671
    29
#include "video/SDL_sysvideo.h"
slouken@3647
    30
slouken@5086
    31
#ifdef __WIN32__
slouken@5090
    32
#include "core/windows/SDL_windows.h"
slouken@5086
    33
slouken@5086
    34
#ifndef WS_OVERLAPPEDWINDOW
slouken@5086
    35
#define WS_OVERLAPPEDWINDOW 0
slouken@5086
    36
#endif
slouken@3647
    37
#else  /* fprintf, _exit(), etc. */
slouken@3647
    38
#include <stdio.h>
slouken@3647
    39
#include <stdlib.h>
icculus@3648
    40
#include <unistd.h>
slouken@3647
    41
#endif
slouken@3647
    42
icculus@3670
    43
static SDL_assert_state
icculus@3670
    44
SDL_PromptAssertion(const SDL_assert_data *data, void *userdata);
icculus@3670
    45
icculus@3670
    46
/*
icculus@3670
    47
 * We keep all triggered assertions in a singly-linked list so we can
slouken@3647
    48
 *  generate a report later.
slouken@3647
    49
 */
icculus@5541
    50
static SDL_assert_data *triggered_assertions = NULL;
icculus@3670
    51
icculus@3670
    52
static SDL_mutex *assertion_mutex = NULL;
icculus@3670
    53
static SDL_AssertionHandler assertion_handler = SDL_PromptAssertion;
icculus@3670
    54
static void *assertion_userdata = NULL;
slouken@3647
    55
icculus@3648
    56
#ifdef __GNUC__
icculus@3661
    57
static void
icculus@3661
    58
debug_print(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
icculus@3648
    59
#endif
icculus@3648
    60
icculus@3648
    61
static void
icculus@3648
    62
debug_print(const char *fmt, ...)
slouken@3647
    63
{
slouken@3647
    64
    va_list ap;
slouken@3647
    65
    va_start(ap, fmt);
slouken@6621
    66
    SDL_LogMessageV(SDL_LOG_CATEGORY_ASSERT, SDL_LOG_PRIORITY_WARN, fmt, ap);
slouken@3647
    67
    va_end(ap);
slouken@3647
    68
}
slouken@3647
    69
slouken@3647
    70
slouken@3647
    71
static void SDL_AddAssertionToReport(SDL_assert_data *data)
slouken@3647
    72
{
slouken@3647
    73
    /* (data) is always a static struct defined with the assert macros, so
slouken@3647
    74
       we don't have to worry about copying or allocating them. */
icculus@5541
    75
    data->trigger_count++;
icculus@5541
    76
    if (data->trigger_count == 1) {  /* not yet added? */
slouken@3647
    77
        data->next = triggered_assertions;
slouken@3647
    78
        triggered_assertions = data;
slouken@3647
    79
    }
slouken@3647
    80
}
slouken@3647
    81
icculus@3670
    82
slouken@3647
    83
static void SDL_GenerateAssertionReport(void)
slouken@3647
    84
{
icculus@5541
    85
    const SDL_assert_data *item = triggered_assertions;
icculus@3670
    86
icculus@3670
    87
    /* only do this if the app hasn't assigned an assertion handler. */
icculus@5541
    88
    if ((item != NULL) && (assertion_handler != SDL_PromptAssertion)) {
slouken@3647
    89
        debug_print("\n\nSDL assertion report.\n");
slouken@3647
    90
        debug_print("All SDL assertions between last init/quit:\n\n");
slouken@3647
    91
icculus@5541
    92
        while (item != NULL) {
slouken@3647
    93
            debug_print(
slouken@3647
    94
                "'%s'\n"
slouken@3647
    95
                "    * %s (%s:%d)\n"
slouken@3647
    96
                "    * triggered %u time%s.\n"
slouken@3647
    97
                "    * always ignore: %s.\n",
slouken@3647
    98
                item->condition, item->function, item->filename,
slouken@3647
    99
                item->linenum, item->trigger_count,
slouken@3647
   100
                (item->trigger_count == 1) ? "" : "s",
slouken@3647
   101
                item->always_ignore ? "yes" : "no");
slouken@3647
   102
            item = item->next;
slouken@3647
   103
        }
slouken@3647
   104
        debug_print("\n");
slouken@3647
   105
icculus@3670
   106
        SDL_ResetAssertionReport();
slouken@3647
   107
    }
slouken@3647
   108
}
slouken@3647
   109
icculus@3661
   110
static void SDL_ExitProcess(int exitcode)
slouken@3647
   111
{
slouken@5086
   112
#ifdef __WIN32__
icculus@6305
   113
    ExitProcess(exitcode);
slouken@3656
   114
#else
icculus@6305
   115
    _exit(exitcode);
slouken@3647
   116
#endif
slouken@3647
   117
}
icculus@3661
   118
icculus@3661
   119
static void SDL_AbortAssertion(void)
icculus@3661
   120
{
icculus@3661
   121
    SDL_Quit();
icculus@3661
   122
    SDL_ExitProcess(42);
icculus@3661
   123
}
icculus@3661
   124
slouken@3647
   125
icculus@3670
   126
static SDL_assert_state
icculus@3670
   127
SDL_PromptAssertion(const SDL_assert_data *data, void *userdata)
slouken@3647
   128
{
icculus@6759
   129
#ifdef __WIN32__
icculus@6759
   130
    #define ENDLINE "\r\n"
icculus@6759
   131
#else
icculus@6759
   132
    #define ENDLINE "\n"
icculus@6759
   133
#endif
icculus@6759
   134
slouken@3647
   135
    const char *envr;
slouken@3657
   136
    SDL_assert_state state = SDL_ASSERTION_ABORT;
slouken@3685
   137
    SDL_Window *window;
slouken@6621
   138
    SDL_MessageBoxData messagebox;
slouken@6621
   139
    SDL_MessageBoxButtonData buttons[] = {
slouken@6621
   140
        {   0,  SDL_ASSERTION_RETRY,            "Retry" },
slouken@6621
   141
        {   0,  SDL_ASSERTION_BREAK,            "Break" },
slouken@6621
   142
        {   0,  SDL_ASSERTION_ABORT,            "Abort" },
slouken@6621
   143
        {   SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT,
slouken@6621
   144
                SDL_ASSERTION_IGNORE,           "Ignore" },
slouken@6621
   145
        {   SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT,
slouken@6621
   146
                SDL_ASSERTION_ALWAYS_IGNORE,    "Always Ignore" }
slouken@6621
   147
    };
slouken@6621
   148
    char *message;
slouken@6621
   149
    int selected;
slouken@3647
   150
icculus@3670
   151
    (void) userdata;  /* unused in default handler. */
icculus@3670
   152
slouken@6621
   153
    message = SDL_stack_alloc(char, SDL_MAX_LOG_MESSAGE);
slouken@6621
   154
    if (!message) {
slouken@6621
   155
        /* Uh oh, we're in real trouble now... */
slouken@6621
   156
        return SDL_ASSERTION_ABORT;
slouken@6621
   157
    }
slouken@6621
   158
    SDL_snprintf(message, SDL_MAX_LOG_MESSAGE,
icculus@6759
   159
                 "Assertion failure at %s (%s:%d), triggered %u %s:" ENDLINE
icculus@6759
   160
                    "  '%s'",
slouken@6621
   161
                 data->function, data->filename, data->linenum,
slouken@6621
   162
                 data->trigger_count, (data->trigger_count == 1) ? "time" : "times",
slouken@6621
   163
                 data->condition);
slouken@6621
   164
slouken@6621
   165
    debug_print("\n\n%s\n\n", message);
slouken@3647
   166
slouken@3655
   167
    /* let env. variable override, so unit tests won't block in a GUI. */
slouken@3647
   168
    envr = SDL_getenv("SDL_ASSERT");
slouken@3647
   169
    if (envr != NULL) {
slouken@6621
   170
        SDL_stack_free(message);
slouken@6621
   171
slouken@3647
   172
        if (SDL_strcmp(envr, "abort") == 0) {
slouken@3647
   173
            return SDL_ASSERTION_ABORT;
slouken@3647
   174
        } else if (SDL_strcmp(envr, "break") == 0) {
slouken@3647
   175
            return SDL_ASSERTION_BREAK;
slouken@3647
   176
        } else if (SDL_strcmp(envr, "retry") == 0) {
slouken@3647
   177
            return SDL_ASSERTION_RETRY;
slouken@3647
   178
        } else if (SDL_strcmp(envr, "ignore") == 0) {
slouken@3647
   179
            return SDL_ASSERTION_IGNORE;
slouken@3647
   180
        } else if (SDL_strcmp(envr, "always_ignore") == 0) {
slouken@3647
   181
            return SDL_ASSERTION_ALWAYS_IGNORE;
slouken@3647
   182
        } else {
slouken@3647
   183
            return SDL_ASSERTION_ABORT;  /* oh well. */
slouken@3647
   184
        }
slouken@3647
   185
    }
slouken@3647
   186
slouken@3657
   187
    /* Leave fullscreen mode, if possible (scary!) */
slouken@3657
   188
    window = SDL_GetFocusWindow();
slouken@3657
   189
    if (window) {
slouken@3657
   190
        if (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) {
slouken@3657
   191
            SDL_MinimizeWindow(window);
slouken@3657
   192
        } else {
icculus@3670
   193
            /* !!! FIXME: ungrab the input if we're not fullscreen? */
slouken@3657
   194
            /* No need to mess with the window */
slouken@6621
   195
            window = NULL;
slouken@3657
   196
        }
slouken@3657
   197
    }
slouken@3657
   198
slouken@6621
   199
    /* Show a messagebox if we can, otherwise fall back to stdio */
slouken@6621
   200
    SDL_zero(messagebox);
slouken@6621
   201
    messagebox.flags = SDL_MESSAGEBOX_WARNING;
slouken@6621
   202
    messagebox.window = window;
slouken@6621
   203
    messagebox.title = "Assertion Failed";
slouken@6621
   204
    messagebox.message = message;
slouken@6621
   205
    messagebox.numbuttons = SDL_arraysize(buttons);
slouken@6621
   206
    messagebox.buttons = buttons;
slouken@3647
   207
slouken@6621
   208
    if (SDL_ShowMessageBox(&messagebox, &selected) == 0) {
slouken@6621
   209
        if (selected == -1) {
slouken@3657
   210
            state = SDL_ASSERTION_IGNORE;
slouken@6621
   211
        } else {
slouken@6621
   212
            state = (SDL_assert_state)selected;
slouken@3647
   213
        }
slouken@3647
   214
    }
slouken@6621
   215
#ifdef HAVE_STDIO_H
slouken@6621
   216
    else
slouken@6621
   217
    {
slouken@6621
   218
        /* this is a little hacky. */
slouken@6621
   219
        for ( ; ; ) {
slouken@6621
   220
            char buf[32];
slouken@6621
   221
            fprintf(stderr, "Abort/Break/Retry/Ignore/AlwaysIgnore? [abriA] : ");
slouken@6621
   222
            fflush(stderr);
slouken@6621
   223
            if (fgets(buf, sizeof (buf), stdin) == NULL) {
slouken@6621
   224
                break;
slouken@6621
   225
            }
slouken@6621
   226
slouken@6621
   227
            if (SDL_strcmp(buf, "a") == 0) {
slouken@6621
   228
                state = SDL_ASSERTION_ABORT;
slouken@6621
   229
                break;
slouken@6621
   230
            } else if (SDL_strcmp(buf, "b") == 0) {
slouken@6621
   231
                state = SDL_ASSERTION_BREAK;
slouken@6621
   232
                break;
slouken@6621
   233
            } else if (SDL_strcmp(buf, "r") == 0) {
slouken@6621
   234
                state = SDL_ASSERTION_RETRY;
slouken@6621
   235
                break;
slouken@6621
   236
            } else if (SDL_strcmp(buf, "i") == 0) {
slouken@6621
   237
                state = SDL_ASSERTION_IGNORE;
slouken@6621
   238
                break;
slouken@6621
   239
            } else if (SDL_strcmp(buf, "A") == 0) {
slouken@6621
   240
                state = SDL_ASSERTION_ALWAYS_IGNORE;
slouken@6621
   241
                break;
slouken@6621
   242
            }
slouken@6621
   243
        }
slouken@6621
   244
    }
slouken@6621
   245
#endif /* HAVE_STDIO_H */
slouken@3647
   246
slouken@3657
   247
    /* Re-enter fullscreen mode */
slouken@3657
   248
    if (window) {
slouken@3657
   249
        SDL_RestoreWindow(window);
slouken@3657
   250
    }
slouken@3657
   251
slouken@6621
   252
    SDL_stack_free(message);
slouken@6621
   253
slouken@3657
   254
    return state;
slouken@3647
   255
}
slouken@3647
   256
slouken@3647
   257
slouken@3647
   258
SDL_assert_state
slouken@3655
   259
SDL_ReportAssertion(SDL_assert_data *data, const char *func, const char *file,
slouken@3655
   260
                    int line)
slouken@3647
   261
{
icculus@3661
   262
    static int assertion_running = 0;
icculus@3662
   263
    static SDL_SpinLock spinlock = 0;
icculus@3661
   264
    SDL_assert_state state = SDL_ASSERTION_IGNORE;
slouken@3647
   265
icculus@3662
   266
    SDL_AtomicLock(&spinlock);
icculus@3662
   267
    if (assertion_mutex == NULL) { /* never called SDL_Init()? */
icculus@3662
   268
        assertion_mutex = SDL_CreateMutex();
icculus@3662
   269
        if (assertion_mutex == NULL) {
icculus@3662
   270
            SDL_AtomicUnlock(&spinlock);
icculus@3662
   271
            return SDL_ASSERTION_IGNORE;   /* oh well, I guess. */
icculus@3662
   272
        }
icculus@3662
   273
    }
icculus@3662
   274
    SDL_AtomicUnlock(&spinlock);
icculus@3662
   275
slouken@3647
   276
    if (SDL_LockMutex(assertion_mutex) < 0) {
slouken@3647
   277
        return SDL_ASSERTION_IGNORE;   /* oh well, I guess. */
slouken@3647
   278
    }
slouken@3647
   279
slouken@3647
   280
    /* doing this because Visual C is upset over assigning in the macro. */
slouken@3647
   281
    if (data->trigger_count == 0) {
slouken@3647
   282
        data->function = func;
slouken@3655
   283
        data->filename = file;
slouken@3655
   284
        data->linenum = line;
slouken@3647
   285
    }
slouken@3647
   286
slouken@3647
   287
    SDL_AddAssertionToReport(data);
slouken@3647
   288
icculus@3661
   289
    assertion_running++;
icculus@3661
   290
    if (assertion_running > 1) {   /* assert during assert! Abort. */
icculus@3661
   291
        if (assertion_running == 2) {
icculus@3661
   292
            SDL_AbortAssertion();
icculus@3661
   293
        } else if (assertion_running == 3) {  /* Abort asserted! */
icculus@3661
   294
            SDL_ExitProcess(42);
icculus@3661
   295
        } else {
icculus@3661
   296
            while (1) { /* do nothing but spin; what else can you do?! */ }
icculus@3661
   297
        }
slouken@3647
   298
    }
slouken@3647
   299
icculus@3661
   300
    if (!data->always_ignore) {
icculus@3670
   301
        state = assertion_handler(data, assertion_userdata);
icculus@3661
   302
    }
slouken@3647
   303
slouken@3647
   304
    switch (state)
slouken@3647
   305
    {
slouken@3647
   306
        case SDL_ASSERTION_ABORT:
slouken@3647
   307
            SDL_AbortAssertion();
slouken@3647
   308
            return SDL_ASSERTION_IGNORE;  /* shouldn't return, but oh well. */
slouken@3647
   309
slouken@3647
   310
        case SDL_ASSERTION_ALWAYS_IGNORE:
slouken@3647
   311
            state = SDL_ASSERTION_IGNORE;
slouken@3647
   312
            data->always_ignore = 1;
slouken@3647
   313
            break;
slouken@3647
   314
slouken@3647
   315
        case SDL_ASSERTION_IGNORE:
slouken@3647
   316
        case SDL_ASSERTION_RETRY:
slouken@3647
   317
        case SDL_ASSERTION_BREAK:
slouken@3647
   318
            break;  /* macro handles these. */
slouken@3647
   319
    }
slouken@3647
   320
icculus@3661
   321
    assertion_running--;
slouken@3647
   322
    SDL_UnlockMutex(assertion_mutex);
slouken@3647
   323
slouken@3647
   324
    return state;
slouken@3647
   325
}
slouken@3647
   326
slouken@3647
   327
slouken@3647
   328
int SDL_AssertionsInit(void)
slouken@3647
   329
{
icculus@3664
   330
    /* this is a no-op at the moment. */
slouken@3647
   331
    return 0;
slouken@3647
   332
}
slouken@3647
   333
slouken@3647
   334
void SDL_AssertionsQuit(void)
slouken@3647
   335
{
slouken@3647
   336
    SDL_GenerateAssertionReport();
icculus@3664
   337
    if (assertion_mutex != NULL) {
icculus@3664
   338
        SDL_DestroyMutex(assertion_mutex);
icculus@3664
   339
        assertion_mutex = NULL;
icculus@3664
   340
    }
icculus@3670
   341
}
icculus@3670
   342
icculus@3670
   343
void SDL_SetAssertionHandler(SDL_AssertionHandler handler, void *userdata)
icculus@3670
   344
{
icculus@3670
   345
    if (handler != NULL) {
icculus@3670
   346
        assertion_handler = handler;
icculus@3670
   347
        assertion_userdata = userdata;
icculus@3670
   348
    } else {
icculus@3670
   349
        assertion_handler = SDL_PromptAssertion;
icculus@3670
   350
        assertion_userdata = NULL;
icculus@3670
   351
    }
icculus@3670
   352
}
icculus@3670
   353
icculus@3670
   354
const SDL_assert_data *SDL_GetAssertionReport(void)
icculus@3670
   355
{
icculus@3670
   356
    return triggered_assertions;
icculus@3670
   357
}
icculus@3670
   358
icculus@3670
   359
void SDL_ResetAssertionReport(void)
icculus@3670
   360
{
icculus@3670
   361
    SDL_assert_data *next = NULL;
icculus@5541
   362
    SDL_assert_data *item;
icculus@5541
   363
    for (item = triggered_assertions; item != NULL; item = next) {
icculus@3670
   364
        next = (SDL_assert_data *) item->next;
icculus@3670
   365
        item->always_ignore = SDL_FALSE;
icculus@3670
   366
        item->trigger_count = 0;
icculus@3670
   367
        item->next = NULL;
icculus@3670
   368
    }
icculus@3670
   369
icculus@5541
   370
    triggered_assertions = NULL;
slouken@3647
   371
}
slouken@3647
   372
slouken@3647
   373
/* vi: set ts=4 sw=4 expandtab: */