SDL_error.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 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
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
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
25
26
27
28
/* Simple error handling in SDL */
#include "SDL_error.h"
#include "SDL_error_c.h"
29
30
31
/* Routine to get the thread-specific error variable */
#if SDL_THREADS_DISABLED
/* The SDL_arraysize(The ),default (non-thread-safe) global error variable */
32
33
static SDL_error SDL_global_error;
#define SDL_GetErrBuf() (&SDL_global_error)
34
35
36
#else
extern SDL_error *SDL_GetErrBuf(void);
#endif /* SDL_THREADS_DISABLED */
37
38
39
40
41
#define SDL_ERRBUFIZE 1024
/* Private functions */
42
static const char *SDL_LookupString(const char *key)
43
44
{
/* FIXME: Add code to lookup key in language string hash-table */
45
return key;
46
47
48
49
50
51
52
53
54
55
56
57
}
/* Public functions */
void SDL_SetError (const char *fmt, ...)
{
va_list ap;
SDL_error *error;
/* Copy in the key, mark error as valid */
error = SDL_GetErrBuf();
error->error = 1;
58
SDL_strlcpy((char *)error->key, fmt, sizeof(error->key));
59
60
61
62
63
va_start(ap, fmt);
error->argc = 0;
while ( *fmt ) {
if ( *fmt++ == '%' ) {
64
65
66
while ( *fmt == '.' || (*fmt >= '0' && *fmt <= '9') ) {
++fmt;
}
67
68
69
70
71
switch (*fmt++) {
case 0: /* Malformed format string.. */
--fmt;
break;
case 'c':
72
case 'i':
73
case 'd':
74
75
76
77
case 'u':
case 'o':
case 'x':
case 'X':
78
79
80
81
82
83
84
85
86
87
88
89
90
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':
{
91
92
int i = error->argc;
const char *str = va_arg(ap, const char *);
93
94
if (str == NULL)
str = "(null)";
95
SDL_strlcpy((char *)error->args[i].buf, str, ERR_MAX_STRLEN);
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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 */
#ifdef DEBUG_ERROR
fprintf(stderr, "SDL_SetError: %s\n", SDL_GetError());
#endif
}
/* This function has a bit more overhead than most error functions
so that it supports internationalization and thread-safe errors.
*/
118
char *SDL_GetErrorMsg(char *errstr, unsigned int maxlen)
119
120
121
122
{
SDL_error *error;
/* Clear the error string */
123
*errstr = '\0'; --maxlen;
124
125
126
127
/* Get the thread-safe error, and print it out */
error = SDL_GetErrBuf();
if ( error->error ) {
128
129
const char *fmt;
char *msg = errstr;
130
131
132
int len;
int argi;
133
fmt = SDL_LookupString(error->key);
134
argi = 0;
135
while ( *fmt && (maxlen > 0) ) {
136
if ( *fmt == '%' ) {
137
138
char tmp[32], *spot = tmp;
*spot++ = *fmt++;
139
while ( (*fmt == '.' || (*fmt >= '0' && *fmt <= '9')) && spot < (tmp+SDL_arraysize(tmp)-2) ) {
140
141
142
143
144
*spot++ = *fmt++;
}
*spot++ = *fmt++;
*spot++ = '\0';
switch (spot[-2]) {
145
146
147
148
149
case '%':
*msg++ = '%';
maxlen -= 1;
break;
case 'c':
150
151
152
153
154
155
156
case 'i':
case 'd':
case 'u':
case 'o':
case 'x':
case 'X':
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_i);
157
158
159
160
msg += len;
maxlen -= len;
break;
case 'f':
161
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_f);
162
163
164
165
msg += len;
maxlen -= len;
break;
case 'p':
166
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_ptr);
167
168
169
msg += len;
maxlen -= len;
break;
170
171
172
173
case 's':
len = SDL_snprintf(msg, maxlen, tmp, SDL_LookupString(error->args[argi++].buf));
msg += len;
maxlen -= len;
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
break;
}
} else {
*msg++ = *fmt++;
maxlen -= 1;
}
}
*msg = 0; /* NULL terminate the string */
}
return(errstr);
}
/* Available for backwards compatibility */
char *SDL_GetError (void)
{
static char errmsg[SDL_ERRBUFIZE];
191
return((char *)SDL_GetErrorMsg(errmsg, SDL_ERRBUFIZE));
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
226
227
228
229
230
231
}
void SDL_ClearError(void)
{
SDL_error *error;
error = SDL_GetErrBuf();
error->error = 0;
}
/* Very common errors go here */
void SDL_Error(SDL_errorcode code)
{
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;
default:
SDL_SetError("Unknown SDL error");
break;
}
}
#ifdef TEST_ERROR
int main(int argc, char *argv[])
{
char buffer[BUFSIZ+1];
SDL_SetError("Hi there!");
printf("Error 1: %s\n", SDL_GetError());
SDL_ClearError();
232
SDL_memset(buffer, '1', BUFSIZ);
233
234
235
236
237
238
buffer[BUFSIZ] = 0;
SDL_SetError("This is the error: %s (%f)", buffer, 1.0);
printf("Error 2: %s\n", SDL_GetError());
exit(0);
}
#endif