This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_error.c
2
Simple DirectMedia Layer
3
Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
#include "SDL_config.h"
22
23
24
/* Simple error handling in SDL */
25
#include "SDL_log.h"
26
27
28
#include "SDL_error.h"
#include "SDL_error_c.h"
30
31
/* Routine to get the thread-specific error variable */
#if SDL_THREADS_DISABLED
32
/* The default (non-thread-safe) global error variable */
33
34
static SDL_error SDL_global_error;
#define SDL_GetErrBuf() (&SDL_global_error)
35
36
37
#else
extern SDL_error *SDL_GetErrBuf(void);
#endif /* SDL_THREADS_DISABLED */
38
39
40
41
42
#define SDL_ERRBUFIZE 1024
/* Private functions */
43
44
static const char *
SDL_LookupString(const char *key)
46
47
/* FIXME: Add code to lookup key in language string hash-table */
return key;
48
49
50
51
}
/* Public functions */
52
53
void
SDL_SetError(const char *fmt, ...)
55
56
57
va_list ap;
SDL_error *error;
58
59
60
/* Ignore call if invalid format pointer was passed */
if (fmt == NULL) return;
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* Copy in the key, mark error as valid */
error = SDL_GetErrBuf();
error->error = 1;
SDL_strlcpy((char *) error->key, fmt, sizeof(error->key));
va_start(ap, fmt);
error->argc = 0;
while (*fmt) {
if (*fmt++ == '%') {
while (*fmt == '.' || (*fmt >= '0' && *fmt <= '9')) {
++fmt;
}
switch (*fmt++) {
case 0: /* Malformed format string.. */
--fmt;
break;
case 'c':
case 'i':
case 'd':
case 'u':
case 'o':
case 'x':
case 'X':
error->args[error->argc++].value_i = va_arg(ap, int);
break;
case 'f':
error->args[error->argc++].value_f = va_arg(ap, double);
break;
case 'p':
error->args[error->argc++].value_ptr = va_arg(ap, void *);
break;
case 's':
{
int i = error->argc;
const char *str = va_arg(ap, const char *);
if (str == NULL)
str = "(null)";
SDL_strlcpy((char *) error->args[i].buf, str,
ERR_MAX_STRLEN);
error->argc++;
}
break;
default:
break;
}
if (error->argc >= ERR_MAX_ARGS) {
break;
}
}
}
va_end(ap);
/* If we are in debug mode, print out an error message */
114
SDL_LogError(SDL_LOG_CATEGORY_ERROR, "%s", SDL_GetError());
115
116
117
118
119
}
/* This function has a bit more overhead than most error functions
so that it supports internationalization and thread-safe errors.
*/
120
static char *
121
SDL_GetErrorMsg(char *errstr, unsigned int maxlen)
122
{
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
SDL_error *error;
/* Clear the error string */
*errstr = '\0';
--maxlen;
/* Get the thread-safe error, and print it out */
error = SDL_GetErrBuf();
if (error->error) {
const char *fmt;
char *msg = errstr;
int len;
int argi;
fmt = SDL_LookupString(error->key);
argi = 0;
while (*fmt && (maxlen > 0)) {
if (*fmt == '%') {
char tmp[32], *spot = tmp;
*spot++ = *fmt++;
while ((*fmt == '.' || (*fmt >= '0' && *fmt <= '9'))
&& spot < (tmp + SDL_arraysize(tmp) - 2)) {
*spot++ = *fmt++;
}
*spot++ = *fmt++;
*spot++ = '\0';
switch (spot[-2]) {
case '%':
*msg++ = '%';
maxlen -= 1;
break;
case 'c':
case 'i':
case 'd':
case 'u':
case 'o':
case 'x':
case 'X':
len =
SDL_snprintf(msg, maxlen, tmp,
error->args[argi++].value_i);
msg += len;
maxlen -= len;
break;
case 'f':
len =
SDL_snprintf(msg, maxlen, tmp,
error->args[argi++].value_f);
msg += len;
maxlen -= len;
break;
case 'p':
len =
SDL_snprintf(msg, maxlen, tmp,
error->args[argi++].value_ptr);
msg += len;
maxlen -= len;
break;
case 's':
len =
SDL_snprintf(msg, maxlen, tmp,
184
185
SDL_LookupString(error->args[argi++].
buf));
186
187
188
189
190
191
192
193
194
195
196
197
msg += len;
maxlen -= len;
break;
}
} else {
*msg++ = *fmt++;
maxlen -= 1;
}
}
*msg = 0; /* NULL terminate the string */
}
return (errstr);
198
199
200
}
/* Available for backwards compatibility */
202
SDL_GetError(void)
203
{
204
static char errmsg[SDL_ERRBUFIZE];
206
return SDL_GetErrorMsg(errmsg, SDL_ERRBUFIZE);
207
208
}
209
210
void
SDL_ClearError(void)
211
{
212
SDL_error *error;
214
215
error = SDL_GetErrBuf();
error->error = 0;
216
217
218
}
/* Very common errors go here */
219
220
void
SDL_Error(SDL_errorcode code)
221
{
222
223
224
225
226
227
228
229
230
231
232
233
234
switch (code) {
case SDL_ENOMEM:
SDL_SetError("Out of memory");
break;
case SDL_EFREAD:
SDL_SetError("Error reading from datastream");
break;
case SDL_EFWRITE:
SDL_SetError("Error writing to datastream");
break;
case SDL_EFSEEK:
SDL_SetError("Error seeking in datastream");
break;
235
236
237
case SDL_UNSUPPORTED:
SDL_SetError("That operation is not supported");
break;
238
239
240
241
default:
SDL_SetError("Unknown SDL error");
break;
}
242
243
244
}
#ifdef TEST_ERROR
245
246
int
main(int argc, char *argv[])
247
{
248
249
250
251
252
253
254
255
256
257
char buffer[BUFSIZ + 1];
SDL_SetError("Hi there!");
printf("Error 1: %s\n", SDL_GetError());
SDL_ClearError();
SDL_memset(buffer, '1', BUFSIZ);
buffer[BUFSIZ] = 0;
SDL_SetError("This is the error: %s (%f)", buffer, 1.0);
printf("Error 2: %s\n", SDL_GetError());
exit(0);
258
259
}
#endif
261
/* vi: set ts=4 sw=4 expandtab: */