Skip to content

Latest commit

 

History

History
323 lines (286 loc) · 7.4 KB

SDL_error.c

File metadata and controls

323 lines (286 loc) · 7.4 KB
 
Apr 26, 2001
Apr 26, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Feb 1, 2006
Feb 1, 2006
3
Copyright (C) 1997-2006 Sam Lantinga
Apr 26, 2001
Apr 26, 2001
4
5
This library is free software; you can redistribute it and/or
Feb 1, 2006
Feb 1, 2006
6
modify it under the terms of the GNU Lesser General Public
Apr 26, 2001
Apr 26, 2001
7
License as published by the Free Software Foundation; either
Feb 1, 2006
Feb 1, 2006
8
version 2.1 of the License, or (at your option) any later version.
Apr 26, 2001
Apr 26, 2001
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
Feb 1, 2006
Feb 1, 2006
13
Lesser General Public License for more details.
Apr 26, 2001
Apr 26, 2001
14
Feb 1, 2006
Feb 1, 2006
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
Apr 26, 2001
Apr 26, 2001
18
19
Sam Lantinga
Dec 14, 2001
Dec 14, 2001
20
slouken@libsdl.org
Apr 26, 2001
Apr 26, 2001
21
*/
Feb 21, 2006
Feb 21, 2006
22
#include "SDL_config.h"
Apr 26, 2001
Apr 26, 2001
23
24
25
26
27
28
/* Simple error handling in SDL */
#include "SDL_error.h"
#include "SDL_error_c.h"
Feb 16, 2006
Feb 16, 2006
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 */
Apr 26, 2001
Apr 26, 2001
32
33
static SDL_error SDL_global_error;
#define SDL_GetErrBuf() (&SDL_global_error)
Feb 16, 2006
Feb 16, 2006
34
35
36
#else
extern SDL_error *SDL_GetErrBuf(void);
#endif /* SDL_THREADS_DISABLED */
Apr 26, 2001
Apr 26, 2001
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#define SDL_ERRBUFIZE 1024
/* Private functions */
static void SDL_LookupString(const Uint8 *key, Uint16 *buf, int buflen)
{
/* FIXME: Add code to lookup key in language string hash-table */
/* Key not found in language string hash-table */
while ( *key && (--buflen > 0) ) {
*buf++ = *key++;
}
*buf = 0; /* NULL terminate string */
}
/* 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;
Feb 19, 2006
Feb 19, 2006
63
SDL_strlcpy((char *)error->key, fmt, sizeof(error->key));
Apr 26, 2001
Apr 26, 2001
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
va_start(ap, fmt);
error->argc = 0;
while ( *fmt ) {
if ( *fmt++ == '%' ) {
switch (*fmt++) {
case 0: /* Malformed format string.. */
--fmt;
break;
#if 0 /* What is a character anyway? (UNICODE issues) */
case 'c':
error->args[error->argc++].value_c =
va_arg(ap, unsigned char);
break;
#endif
case 'd':
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':
{
Mar 24, 2006
Mar 24, 2006
93
94
int i = error->argc;
const char *str = va_arg(ap, const char *);
Nov 17, 2005
Nov 17, 2005
95
96
if (str == NULL)
str = "(null)";
Mar 24, 2006
Mar 24, 2006
97
SDL_strlcpy((char *)error->args[i].buf, str, ERR_MAX_STRLEN);
Apr 26, 2001
Apr 26, 2001
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
}
/* Print out an integer value to a UNICODE buffer */
static int PrintInt(Uint16 *str, unsigned int maxlen, int value)
{
char tmp[128];
int len, i;
Feb 7, 2006
Feb 7, 2006
123
SDL_snprintf(tmp, SDL_arraysize(tmp), "%d", value);
Apr 26, 2001
Apr 26, 2001
124
len = 0;
Feb 7, 2006
Feb 7, 2006
125
if ( SDL_strlen(tmp) < maxlen ) {
Apr 26, 2001
Apr 26, 2001
126
127
128
129
130
131
132
133
134
135
136
137
138
for ( i=0; tmp[i]; ++i ) {
*str++ = tmp[i];
++len;
}
}
return(len);
}
/* Print out a double value to a UNICODE buffer */
static int PrintDouble(Uint16 *str, unsigned int maxlen, double value)
{
char tmp[128];
int len, i;
Feb 7, 2006
Feb 7, 2006
139
SDL_snprintf(tmp, SDL_arraysize(tmp), "%f", value);
Apr 26, 2001
Apr 26, 2001
140
len = 0;
Feb 7, 2006
Feb 7, 2006
141
if ( SDL_strlen(tmp) < maxlen ) {
Apr 26, 2001
Apr 26, 2001
142
143
144
145
146
147
148
149
150
151
152
153
154
for ( i=0; tmp[i]; ++i ) {
*str++ = tmp[i];
++len;
}
}
return(len);
}
/* Print out a pointer value to a UNICODE buffer */
static int PrintPointer(Uint16 *str, unsigned int maxlen, void *value)
{
char tmp[128];
int len, i;
Feb 7, 2006
Feb 7, 2006
155
SDL_snprintf(tmp, SDL_arraysize(tmp), "%p", value);
Apr 26, 2001
Apr 26, 2001
156
len = 0;
Feb 7, 2006
Feb 7, 2006
157
if ( SDL_strlen(tmp) < maxlen ) {
Apr 26, 2001
Apr 26, 2001
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
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
for ( i=0; tmp[i]; ++i ) {
*str++ = tmp[i];
++len;
}
}
return(len);
}
/* This function has a bit more overhead than most error functions
so that it supports internationalization and thread-safe errors.
*/
Uint16 *SDL_GetErrorMsgUNICODE(Uint16 *errstr, unsigned int maxlen)
{
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 ) {
Uint16 translated[ERR_MAX_STRLEN], *fmt, *msg;
int len;
int argi;
/* Print out the UNICODE error message */
SDL_LookupString(error->key, translated, sizeof(translated));
msg = errstr;
argi = 0;
for ( fmt=translated; *fmt && (maxlen > 0); ) {
if ( *fmt == '%' ) {
switch (fmt[1]) {
case 'S': /* Special SKIP operand */
argi += (fmt[2] - '0');
++fmt;
break;
case '%':
*msg++ = '%';
maxlen -= 1;
break;
#if 0 /* What is a character anyway? (UNICODE issues) */
case 'c':
*msg++ = (unsigned char)
error->args[argi++].value_c;
maxlen -= 1;
break;
#endif
case 'd':
len = PrintInt(msg, maxlen,
error->args[argi++].value_i);
msg += len;
maxlen -= len;
break;
case 'f':
len = PrintDouble(msg, maxlen,
error->args[argi++].value_f);
msg += len;
maxlen -= len;
break;
case 'p':
len = PrintPointer(msg, maxlen,
error->args[argi++].value_ptr);
msg += len;
maxlen -= len;
break;
case 's': /* UNICODE string */
{ Uint16 buf[ERR_MAX_STRLEN], *str;
SDL_LookupString(error->args[argi++].buf, buf, sizeof(buf));
str = buf;
while ( *str && (maxlen > 0) ) {
*msg++ = *str++;
maxlen -= 1;
}
}
break;
}
fmt += 2;
} else {
*msg++ = *fmt++;
maxlen -= 1;
}
}
*msg = 0; /* NULL terminate the string */
}
return(errstr);
}
Uint8 *SDL_GetErrorMsg(Uint8 *errstr, unsigned int maxlen)
{
Uint16 *errstr16;
unsigned int i;
/* Allocate the UNICODE buffer */
Feb 7, 2006
Feb 7, 2006
251
errstr16 = (Uint16 *)SDL_malloc(maxlen * (sizeof *errstr16));
Apr 26, 2001
Apr 26, 2001
252
if ( ! errstr16 ) {
Feb 19, 2006
Feb 19, 2006
253
SDL_strlcpy((char *)errstr, "Out of memory", maxlen);
Apr 26, 2001
Apr 26, 2001
254
255
256
257
258
259
260
261
262
263
264
265
return(errstr);
}
/* Get the error message */
SDL_GetErrorMsgUNICODE(errstr16, maxlen);
/* Convert from UNICODE to Latin1 encoding */
for ( i=0; i<maxlen; ++i ) {
errstr[i] = (Uint8)errstr16[i];
}
/* Free UNICODE buffer (if necessary) */
Feb 7, 2006
Feb 7, 2006
266
SDL_free(errstr16);
Apr 26, 2001
Apr 26, 2001
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
return(errstr);
}
/* Available for backwards compatibility */
char *SDL_GetError (void)
{
static char errmsg[SDL_ERRBUFIZE];
return((char *)SDL_GetErrorMsg((unsigned char *)errmsg, SDL_ERRBUFIZE));
}
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();
Feb 7, 2006
Feb 7, 2006
317
SDL_memset(buffer, '1', BUFSIZ);
Apr 26, 2001
Apr 26, 2001
318
319
320
321
322
323
buffer[BUFSIZ] = 0;
SDL_SetError("This is the error: %s (%f)", buffer, 1.0);
printf("Error 2: %s\n", SDL_GetError());
exit(0);
}
#endif