This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_assert.c
487 lines (413 loc) · 13.9 KB
1
/*
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Simple DirectMedia Layer
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
22
*/
#include "SDL.h"
23
#include "SDL_atomic.h"
24
#include "SDL_assert.h"
25
#include "SDL_assert_c.h"
26
#include "video/SDL_sysvideo.h"
27
28
#ifdef __WIN32__
29
#include "core/windows/SDL_windows.h"
30
31
32
33
#ifndef WS_OVERLAPPEDWINDOW
#define WS_OVERLAPPEDWINDOW 0
#endif
34
35
36
#else /* fprintf, _exit(), etc. */
#include <stdio.h>
#include <stdlib.h>
37
#include <unistd.h>
38
39
#endif
40
41
42
43
44
static SDL_assert_state
SDL_PromptAssertion(const SDL_assert_data *data, void *userdata);
/*
* We keep all triggered assertions in a singly-linked list so we can
45
46
47
48
* generate a report later.
*/
static SDL_assert_data assertion_list_terminator = { 0, 0, 0, 0, 0, 0, 0 };
static SDL_assert_data *triggered_assertions = &assertion_list_terminator;
49
50
51
52
static SDL_mutex *assertion_mutex = NULL;
static SDL_AssertionHandler assertion_handler = SDL_PromptAssertion;
static void *assertion_userdata = NULL;
53
54
#ifdef __GNUC__
55
56
static void
debug_print(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
57
58
59
60
#endif
static void
debug_print(const char *fmt, ...)
61
{
62
#ifdef __WIN32__
63
64
65
66
/* Format into a buffer for OutputDebugStringA(). */
char buf[1024];
char *startptr;
char *ptr;
67
LPTSTR tstr;
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
int len;
va_list ap;
va_start(ap, fmt);
len = (int) SDL_vsnprintf(buf, sizeof (buf), fmt, ap);
va_end(ap);
/* Visual C's vsnprintf() may not null-terminate the buffer. */
if ((len >= sizeof (buf)) || (len < 0)) {
buf[sizeof (buf) - 1] = '\0';
}
/* Write it, sorting out the Unix newlines... */
startptr = buf;
for (ptr = startptr; *ptr; ptr++) {
if (*ptr == '\n') {
*ptr = '\0';
84
85
86
87
tstr = WIN_UTF8ToString(startptr);
OutputDebugString(tstr);
SDL_free(tstr);
OutputDebugString(TEXT("\r\n"));
88
89
90
91
92
93
startptr = ptr+1;
}
}
/* catch that last piece if it didn't have a newline... */
if (startptr != ptr) {
94
95
96
tstr = WIN_UTF8ToString(startptr);
OutputDebugString(tstr);
SDL_free(tstr);
97
98
99
100
101
}
#else
/* Unix has it easy. Just dump it to stderr. */
va_list ap;
va_start(ap, fmt);
102
vfprintf(stderr, fmt, ap);
103
104
105
106
107
108
va_end(ap);
fflush(stderr);
#endif
}
109
#ifdef __WIN32__
110
111
112
113
114
115
116
117
118
119
120
121
122
static SDL_assert_state SDL_Windows_AssertChoice = SDL_ASSERTION_ABORT;
static const SDL_assert_data *SDL_Windows_AssertData = NULL;
static LRESULT CALLBACK
SDL_Assertion_WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
{
switch (msg)
{
case WM_CREATE:
{
/* !!! FIXME: all this code stinks. */
const SDL_assert_data *data = SDL_Windows_AssertData;
char buf[1024];
123
LPTSTR tstr;
124
125
126
127
128
129
130
131
const int w = 100;
const int h = 25;
const int gap = 10;
int x = gap;
int y = 50;
int len;
int i;
static const struct {
132
LPCTSTR name;
133
134
SDL_assert_state state;
} buttons[] = {
135
136
137
138
139
{TEXT("Abort"), SDL_ASSERTION_ABORT },
{TEXT("Break"), SDL_ASSERTION_BREAK },
{TEXT("Retry"), SDL_ASSERTION_RETRY },
{TEXT("Ignore"), SDL_ASSERTION_IGNORE },
{TEXT("Always Ignore"), SDL_ASSERTION_ALWAYS_IGNORE },
140
141
142
143
144
145
146
147
148
149
150
};
len = (int) SDL_snprintf(buf, sizeof (buf),
"Assertion failure at %s (%s:%d), triggered %u time%s:\r\n '%s'",
data->function, data->filename, data->linenum,
data->trigger_count, (data->trigger_count == 1) ? "" : "s",
data->condition);
if ((len < 0) || (len >= sizeof (buf))) {
buf[sizeof (buf) - 1] = '\0';
}
151
152
tstr = WIN_UTF8ToString(buf);
CreateWindow(TEXT("STATIC"), tstr,
153
154
155
WS_VISIBLE | WS_CHILD | SS_LEFT,
x, y, 550, 100,
hwnd, (HMENU) 1, NULL, NULL);
156
SDL_free(tstr);
157
158
159
y += 110;
for (i = 0; i < (sizeof (buttons) / sizeof (buttons[0])); i++) {
160
CreateWindow(TEXT("BUTTON"), buttons[i].name,
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
WS_VISIBLE | WS_CHILD,
x, y, w, h,
hwnd, (HMENU) buttons[i].state, NULL, NULL);
x += w + gap;
}
break;
}
case WM_COMMAND:
SDL_Windows_AssertChoice = ((SDL_assert_state) (LOWORD(wParam)));
SDL_Windows_AssertData = NULL;
break;
case WM_DESTROY:
SDL_Windows_AssertData = NULL;
break;
}
return DefWindowProc(hwnd, msg, wParam, lParam);
}
static SDL_assert_state
SDL_PromptAssertion_windows(const SDL_assert_data *data)
{
HINSTANCE hInstance = 0; /* !!! FIXME? */
HWND hwnd;
MSG msg;
WNDCLASS wc = {0};
SDL_Windows_AssertChoice = SDL_ASSERTION_ABORT;
SDL_Windows_AssertData = data;
wc.lpszClassName = TEXT("SDL_assert");
wc.hInstance = hInstance ;
wc.hbrBackground = GetSysColorBrush(COLOR_3DFACE);
wc.lpfnWndProc = SDL_Assertion_WndProc;
wc.hCursor = LoadCursor(0, IDC_ARROW);
RegisterClass(&wc);
hwnd = CreateWindow(wc.lpszClassName, TEXT("SDL assertion failure"),
WS_OVERLAPPEDWINDOW | WS_VISIBLE,
150, 150, 570, 260, 0, 0, hInstance, 0);
while (GetMessage(&msg, NULL, 0, 0) && (SDL_Windows_AssertData != NULL)) {
TranslateMessage(&msg);
DispatchMessage(&msg);
}
DestroyWindow(hwnd);
UnregisterClass(wc.lpszClassName, hInstance);
return SDL_Windows_AssertChoice;
}
#endif
static void SDL_AddAssertionToReport(SDL_assert_data *data)
{
/* (data) is always a static struct defined with the assert macros, so
we don't have to worry about copying or allocating them. */
if (data->next == NULL) { /* not yet added? */
data->next = triggered_assertions;
triggered_assertions = data;
}
}
226
227
228
static void SDL_GenerateAssertionReport(void)
{
229
const SDL_assert_data *item;
230
231
232
233
234
235
236
237
/* only do this if the app hasn't assigned an assertion handler. */
if (assertion_handler != SDL_PromptAssertion)
return;
item = SDL_GetAssertionReport();
if (item->condition)
{
238
239
240
debug_print("\n\nSDL assertion report.\n");
debug_print("All SDL assertions between last init/quit:\n\n");
241
while (item->condition) {
242
243
244
245
246
247
248
249
250
251
252
253
254
debug_print(
"'%s'\n"
" * %s (%s:%d)\n"
" * triggered %u time%s.\n"
" * always ignore: %s.\n",
item->condition, item->function, item->filename,
item->linenum, item->trigger_count,
(item->trigger_count == 1) ? "" : "s",
item->always_ignore ? "yes" : "no");
item = item->next;
}
debug_print("\n");
255
SDL_ResetAssertionReport();
256
257
258
}
}
259
static void SDL_ExitProcess(int exitcode)
260
{
261
#ifdef __WIN32__
262
263
ExitProcess(42);
#else
264
_exit(42);
265
266
#endif
}
267
268
269
270
271
272
273
static void SDL_AbortAssertion(void)
{
SDL_Quit();
SDL_ExitProcess(42);
}
274
275
276
static SDL_assert_state
SDL_PromptAssertion(const SDL_assert_data *data, void *userdata)
277
278
{
const char *envr;
279
SDL_assert_state state = SDL_ASSERTION_ABORT;
280
SDL_Window *window;
281
282
283
(void) userdata; /* unused in default handler. */
284
285
286
287
288
289
290
291
debug_print("\n\n"
"Assertion failure at %s (%s:%d), triggered %u time%s:\n"
" '%s'\n"
"\n",
data->function, data->filename, data->linenum,
data->trigger_count, (data->trigger_count == 1) ? "" : "s",
data->condition);
292
/* let env. variable override, so unit tests won't block in a GUI. */
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
envr = SDL_getenv("SDL_ASSERT");
if (envr != NULL) {
if (SDL_strcmp(envr, "abort") == 0) {
return SDL_ASSERTION_ABORT;
} else if (SDL_strcmp(envr, "break") == 0) {
return SDL_ASSERTION_BREAK;
} else if (SDL_strcmp(envr, "retry") == 0) {
return SDL_ASSERTION_RETRY;
} else if (SDL_strcmp(envr, "ignore") == 0) {
return SDL_ASSERTION_IGNORE;
} else if (SDL_strcmp(envr, "always_ignore") == 0) {
return SDL_ASSERTION_ALWAYS_IGNORE;
} else {
return SDL_ASSERTION_ABORT; /* oh well. */
}
}
310
311
312
313
314
315
/* Leave fullscreen mode, if possible (scary!) */
window = SDL_GetFocusWindow();
if (window) {
if (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) {
SDL_MinimizeWindow(window);
} else {
316
/* !!! FIXME: ungrab the input if we're not fullscreen? */
317
318
319
320
321
/* No need to mess with the window */
window = 0;
}
}
322
323
/* platform-specific UI... */
324
#ifdef __WIN32__
325
state = SDL_PromptAssertion_windows(data);
326
327
#elif __MACOSX__
328
329
/* This has to be done in an Objective-C (*.m) file, so we call out. */
extern SDL_assert_state SDL_PromptAssertion_cocoa(const SDL_assert_data *);
330
state = SDL_PromptAssertion_cocoa(data);
331
332
#else
333
334
335
336
337
338
/* this is a little hacky. */
for ( ; ; ) {
char buf[32];
fprintf(stderr, "Abort/Break/Retry/Ignore/AlwaysIgnore? [abriA] : ");
fflush(stderr);
if (fgets(buf, sizeof (buf), stdin) == NULL) {
339
break;
340
341
342
}
if (SDL_strcmp(buf, "a") == 0) {
343
344
state = SDL_ASSERTION_ABORT;
break;
345
} else if (SDL_strcmp(envr, "b") == 0) {
346
347
state = SDL_ASSERTION_BREAK;
break;
348
} else if (SDL_strcmp(envr, "r") == 0) {
349
350
state = SDL_ASSERTION_RETRY;
break;
351
} else if (SDL_strcmp(envr, "i") == 0) {
352
353
state = SDL_ASSERTION_IGNORE;
break;
354
} else if (SDL_strcmp(envr, "A") == 0) {
355
356
state = SDL_ASSERTION_ALWAYS_IGNORE;
break;
357
358
359
360
}
}
#endif
361
362
363
364
365
366
/* Re-enter fullscreen mode */
if (window) {
SDL_RestoreWindow(window);
}
return state;
367
368
369
370
}
SDL_assert_state
371
372
SDL_ReportAssertion(SDL_assert_data *data, const char *func, const char *file,
int line)
373
{
374
static int assertion_running = 0;
375
static SDL_SpinLock spinlock = 0;
376
SDL_assert_state state = SDL_ASSERTION_IGNORE;
377
378
379
380
381
382
383
384
385
386
387
SDL_AtomicLock(&spinlock);
if (assertion_mutex == NULL) { /* never called SDL_Init()? */
assertion_mutex = SDL_CreateMutex();
if (assertion_mutex == NULL) {
SDL_AtomicUnlock(&spinlock);
return SDL_ASSERTION_IGNORE; /* oh well, I guess. */
}
}
SDL_AtomicUnlock(&spinlock);
388
389
390
391
392
393
394
if (SDL_LockMutex(assertion_mutex) < 0) {
return SDL_ASSERTION_IGNORE; /* oh well, I guess. */
}
/* doing this because Visual C is upset over assigning in the macro. */
if (data->trigger_count == 0) {
data->function = func;
395
396
data->filename = file;
data->linenum = line;
397
398
399
400
401
}
SDL_AddAssertionToReport(data);
data->trigger_count++;
402
403
404
405
406
407
408
409
410
411
assertion_running++;
if (assertion_running > 1) { /* assert during assert! Abort. */
if (assertion_running == 2) {
SDL_AbortAssertion();
} else if (assertion_running == 3) { /* Abort asserted! */
SDL_ExitProcess(42);
} else {
while (1) { /* do nothing but spin; what else can you do?! */ }
}
412
413
}
414
if (!data->always_ignore) {
415
state = assertion_handler(data, assertion_userdata);
416
}
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
switch (state)
{
case SDL_ASSERTION_ABORT:
SDL_AbortAssertion();
return SDL_ASSERTION_IGNORE; /* shouldn't return, but oh well. */
case SDL_ASSERTION_ALWAYS_IGNORE:
state = SDL_ASSERTION_IGNORE;
data->always_ignore = 1;
break;
case SDL_ASSERTION_IGNORE:
case SDL_ASSERTION_RETRY:
case SDL_ASSERTION_BREAK:
break; /* macro handles these. */
}
435
assertion_running--;
436
437
438
439
440
441
442
443
SDL_UnlockMutex(assertion_mutex);
return state;
}
int SDL_AssertionsInit(void)
{
444
/* this is a no-op at the moment. */
445
446
447
448
449
450
return 0;
}
void SDL_AssertionsQuit(void)
{
SDL_GenerateAssertionReport();
451
452
453
454
if (assertion_mutex != NULL) {
SDL_DestroyMutex(assertion_mutex);
assertion_mutex = NULL;
}
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
}
void SDL_SetAssertionHandler(SDL_AssertionHandler handler, void *userdata)
{
if (handler != NULL) {
assertion_handler = handler;
assertion_userdata = userdata;
} else {
assertion_handler = SDL_PromptAssertion;
assertion_userdata = NULL;
}
}
const SDL_assert_data *SDL_GetAssertionReport(void)
{
return triggered_assertions;
}
void SDL_ResetAssertionReport(void)
{
SDL_assert_data *item = triggered_assertions;
SDL_assert_data *next = NULL;
for (item = triggered_assertions; item->condition; item = next) {
next = (SDL_assert_data *) item->next;
item->always_ignore = SDL_FALSE;
item->trigger_count = 0;
item->next = NULL;
}
triggered_assertions = &assertion_list_terminator;
485
486
487
}
/* vi: set ts=4 sw=4 expandtab: */