author | Sam Lantinga <slouken@libsdl.org> |
Wed, 17 May 2006 06:09:27 +0000 | |
changeset 1847 | 845bcffc0dd8 |
parent 1824 | e25445333ccf |
child 1895 | c121d94672cb |
child 4159 | a1b03ba2fcd0 |
permissions | -rw-r--r-- |
0 | 1 |
/* |
2 |
SDL - Simple DirectMedia Layer |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
3 |
Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
|
5 |
This library is free software; you can redistribute it and/or |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
6 |
modify it under the terms of the GNU Lesser General Public |
0 | 7 |
License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
8 |
version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
|
10 |
This library is distributed in the hope that it will be useful, |
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
13 |
Lesser General Public License for more details. |
0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
15 |
You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
16 |
License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1172
diff
changeset
|
17 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
|
19 |
Sam Lantinga |
|
252
e8157fcb3114
Updated the source with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
1
diff
changeset
|
20 |
slouken@libsdl.org |
0 | 21 |
*/ |
1402
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1379
diff
changeset
|
22 |
#include "SDL_config.h" |
0 | 23 |
|
24 |
/* Simple error handling in SDL */ |
|
25 |
||
26 |
#include "SDL_error.h" |
|
27 |
#include "SDL_error_c.h" |
|
28 |
||
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
29 |
/* Routine to get the thread-specific error variable */ |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
30 |
#if SDL_THREADS_DISABLED |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
31 |
/* The SDL_arraysize(The ),default (non-thread-safe) global error variable */ |
0 | 32 |
static SDL_error SDL_global_error; |
33 |
#define SDL_GetErrBuf() (&SDL_global_error) |
|
1361
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
34 |
#else |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
35 |
extern SDL_error *SDL_GetErrBuf(void); |
19418e4422cb
New configure-based build system. Still work in progress, but much improved
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
36 |
#endif /* SDL_THREADS_DISABLED */ |
0 | 37 |
|
38 |
#define SDL_ERRBUFIZE 1024 |
|
39 |
||
40 |
/* Private functions */ |
|
41 |
||
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
42 |
static const char *SDL_LookupString(const char *key) |
0 | 43 |
{ |
44 |
/* FIXME: Add code to lookup key in language string hash-table */ |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
45 |
return key; |
0 | 46 |
} |
47 |
||
48 |
/* Public functions */ |
|
49 |
||
50 |
void SDL_SetError (const char *fmt, ...) |
|
51 |
{ |
|
52 |
va_list ap; |
|
53 |
SDL_error *error; |
|
54 |
||
55 |
/* Copy in the key, mark error as valid */ |
|
56 |
error = SDL_GetErrBuf(); |
|
57 |
error->error = 1; |
|
1379
c0a74f199ecf
Use only safe string functions
Sam Lantinga <slouken@libsdl.org>
parents:
1361
diff
changeset
|
58 |
SDL_strlcpy((char *)error->key, fmt, sizeof(error->key)); |
0 | 59 |
|
60 |
va_start(ap, fmt); |
|
61 |
error->argc = 0; |
|
62 |
while ( *fmt ) { |
|
63 |
if ( *fmt++ == '%' ) { |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
64 |
while ( *fmt == '.' || (*fmt >= '0' && *fmt <= '9') ) { |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
65 |
++fmt; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
66 |
} |
0 | 67 |
switch (*fmt++) { |
68 |
case 0: /* Malformed format string.. */ |
|
69 |
--fmt; |
|
70 |
break; |
|
71 |
case 'c': |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
72 |
case 'i': |
0 | 73 |
case 'd': |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
74 |
case 'u': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
75 |
case 'o': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
76 |
case 'x': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
77 |
case 'X': |
0 | 78 |
error->args[error->argc++].value_i = |
79 |
va_arg(ap, int); |
|
80 |
break; |
|
81 |
case 'f': |
|
82 |
error->args[error->argc++].value_f = |
|
83 |
va_arg(ap, double); |
|
84 |
break; |
|
85 |
case 'p': |
|
86 |
error->args[error->argc++].value_ptr = |
|
87 |
va_arg(ap, void *); |
|
88 |
break; |
|
89 |
case 's': |
|
90 |
{ |
|
1612
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
91 |
int i = error->argc; |
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
92 |
const char *str = va_arg(ap, const char *); |
1172
f69f4d25fb20
Don't crash if a NULL is passed for a "%s" parameter to SDL_SetError(),
Ryan C. Gordon <icculus@icculus.org>
parents:
769
diff
changeset
|
93 |
if (str == NULL) |
f69f4d25fb20
Don't crash if a NULL is passed for a "%s" parameter to SDL_SetError(),
Ryan C. Gordon <icculus@icculus.org>
parents:
769
diff
changeset
|
94 |
str = "(null)"; |
1612
97d0966f4bf7
Fixed some ultra-pedantic gcc warnings
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
95 |
SDL_strlcpy((char *)error->args[i].buf, str, ERR_MAX_STRLEN); |
0 | 96 |
error->argc++; |
97 |
} |
|
98 |
break; |
|
99 |
default: |
|
100 |
break; |
|
101 |
} |
|
102 |
if ( error->argc >= ERR_MAX_ARGS ) { |
|
103 |
break; |
|
104 |
} |
|
105 |
} |
|
106 |
} |
|
107 |
va_end(ap); |
|
108 |
||
109 |
/* If we are in debug mode, print out an error message */ |
|
110 |
#ifdef DEBUG_ERROR |
|
111 |
fprintf(stderr, "SDL_SetError: %s\n", SDL_GetError()); |
|
112 |
#endif |
|
113 |
} |
|
114 |
||
115 |
/* This function has a bit more overhead than most error functions |
|
116 |
so that it supports internationalization and thread-safe errors. |
|
117 |
*/ |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
118 |
char *SDL_GetErrorMsg(char *errstr, unsigned int maxlen) |
0 | 119 |
{ |
120 |
SDL_error *error; |
|
121 |
||
122 |
/* Clear the error string */ |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
123 |
*errstr = '\0'; --maxlen; |
0 | 124 |
|
125 |
/* Get the thread-safe error, and print it out */ |
|
126 |
error = SDL_GetErrBuf(); |
|
127 |
if ( error->error ) { |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
128 |
const char *fmt; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
129 |
char *msg = errstr; |
0 | 130 |
int len; |
131 |
int argi; |
|
132 |
||
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
133 |
fmt = SDL_LookupString(error->key); |
0 | 134 |
argi = 0; |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
135 |
while ( *fmt && (maxlen > 0) ) { |
0 | 136 |
if ( *fmt == '%' ) { |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
137 |
char tmp[32], *spot = tmp; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
138 |
*spot++ = *fmt++; |
1847
845bcffc0dd8
Updated RPM spec file with License keyword
Sam Lantinga <slouken@libsdl.org>
parents:
1824
diff
changeset
|
139 |
while ( (*fmt == '.' || (*fmt >= '0' && *fmt <= '9')) && spot < (tmp+SDL_arraysize(tmp)-2) ) { |
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
140 |
*spot++ = *fmt++; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
141 |
} |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
142 |
*spot++ = *fmt++; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
143 |
*spot++ = '\0'; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
144 |
switch (spot[-2]) { |
0 | 145 |
case '%': |
146 |
*msg++ = '%'; |
|
147 |
maxlen -= 1; |
|
148 |
break; |
|
149 |
case 'c': |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
150 |
case 'i': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
151 |
case 'd': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
152 |
case 'u': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
153 |
case 'o': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
154 |
case 'x': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
155 |
case 'X': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
156 |
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_i); |
0 | 157 |
msg += len; |
158 |
maxlen -= len; |
|
159 |
break; |
|
160 |
case 'f': |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
161 |
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_f); |
0 | 162 |
msg += len; |
163 |
maxlen -= len; |
|
164 |
break; |
|
165 |
case 'p': |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
166 |
len = SDL_snprintf(msg, maxlen, tmp, error->args[argi++].value_ptr); |
0 | 167 |
msg += len; |
168 |
maxlen -= len; |
|
169 |
break; |
|
1818
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
170 |
case 's': |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
171 |
len = SDL_snprintf(msg, maxlen, tmp, SDL_LookupString(error->args[argi++].buf)); |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
172 |
msg += len; |
7995cc87b777
Fixed some bugs in string handling
Sam Lantinga <slouken@libsdl.org>
parents:
1612
diff
changeset
|
173 |
maxlen -= len; |
0 | 174 |
break; |
175 |
} |
|
176 |
} else { |
|
177 |
*msg++ = *fmt++; |
|
178 |
maxlen -= 1; |
|
179 |
} |
|
180 |
} |
|
181 |
*msg = 0; /* NULL terminate the string */ |
|
182 |
} |
|
183 |
return(errstr); |
|
184 |
} |
|
185 |
||
186 |
/* Available for backwards compatibility */ |
|
187 |
char *SDL_GetError (void) |
|
188 |
{ |
|
189 |
static char errmsg[SDL_ERRBUFIZE]; |
|
190 |
||
1824
e25445333ccf
Fixed signed/unsigned issues
Sam Lantinga <slouken@libsdl.org>
parents:
1818
diff
changeset
|
191 |
return((char *)SDL_GetErrorMsg(errmsg, SDL_ERRBUFIZE)); |
0 | 192 |
} |
193 |
||
194 |
void SDL_ClearError(void) |
|
195 |
{ |
|
196 |
SDL_error *error; |
|
197 |
||
198 |
error = SDL_GetErrBuf(); |
|
199 |
error->error = 0; |
|
200 |
} |
|
201 |
||
202 |
/* Very common errors go here */ |
|
203 |
void SDL_Error(SDL_errorcode code) |
|
204 |
{ |
|
205 |
switch (code) { |
|
206 |
case SDL_ENOMEM: |
|
207 |
SDL_SetError("Out of memory"); |
|
208 |
break; |
|
209 |
case SDL_EFREAD: |
|
210 |
SDL_SetError("Error reading from datastream"); |
|
211 |
break; |
|
212 |
case SDL_EFWRITE: |
|
213 |
SDL_SetError("Error writing to datastream"); |
|
214 |
break; |
|
215 |
case SDL_EFSEEK: |
|
216 |
SDL_SetError("Error seeking in datastream"); |
|
217 |
break; |
|
218 |
default: |
|
219 |
SDL_SetError("Unknown SDL error"); |
|
220 |
break; |
|
221 |
} |
|
222 |
} |
|
223 |
||
224 |
#ifdef TEST_ERROR |
|
225 |
int main(int argc, char *argv[]) |
|
226 |
{ |
|
227 |
char buffer[BUFSIZ+1]; |
|
228 |
||
229 |
SDL_SetError("Hi there!"); |
|
230 |
printf("Error 1: %s\n", SDL_GetError()); |
|
231 |
SDL_ClearError(); |
|
1336
3692456e7b0f
Use SDL_ prefixed versions of C library functions.
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
232 |
SDL_memset(buffer, '1', BUFSIZ); |
0 | 233 |
buffer[BUFSIZ] = 0; |
234 |
SDL_SetError("This is the error: %s (%f)", buffer, 1.0); |
|
235 |
printf("Error 2: %s\n", SDL_GetError()); |
|
236 |
exit(0); |
|
237 |
} |
|
238 |
#endif |