SDL  2.0
SDL_error.c File Reference
#include "./SDL_internal.h"
#include "SDL_log.h"
#include "SDL_error.h"
#include "SDL_error_c.h"
+ Include dependency graph for SDL_error.c:

Go to the source code of this file.

Macros

#define SDL_ERRBUFIZE   1024
 

Functions

SDL_errorSDL_GetErrBuf (void)
 
static const char * SDL_LookupString (const char *key)
 
int SDL_SetError (SDL_PRINTF_FORMAT_STRING const char *fmt,...)
 
static char * SDL_GetErrorMsg (char *errstr, int maxlen)
 
const char * SDL_GetError (void)
 
void SDL_ClearError (void)
 
int SDL_Error (SDL_errorcode code)
 

Macro Definition Documentation

◆ SDL_ERRBUFIZE

#define SDL_ERRBUFIZE   1024

Definition at line 39 of file SDL_error.c.

Referenced by SDL_GetError().

Function Documentation

◆ SDL_ClearError()

void SDL_ClearError ( void  )

Definition at line 237 of file SDL_error.c.

References SDL_error::error, and SDL_GetErrBuf().

Referenced by SDL_Error().

238 {
239  SDL_error *error;
240 
241  error = SDL_GetErrBuf();
242  error->error = 0;
243 }
SDL_error * SDL_GetErrBuf(void)
Definition: SDL_thread.c:206

◆ SDL_Error()

int SDL_Error ( SDL_errorcode  code)

Definition at line 247 of file SDL_error.c.

References main, SDL_ClearError(), SDL_EFREAD, SDL_EFSEEK, SDL_EFWRITE, SDL_ENOMEM, SDL_GetError(), SDL_memset, SDL_SetError(), and SDL_UNSUPPORTED.

248 {
249  switch (code) {
250  case SDL_ENOMEM:
251  return SDL_SetError("Out of memory");
252  case SDL_EFREAD:
253  return SDL_SetError("Error reading from datastream");
254  case SDL_EFWRITE:
255  return SDL_SetError("Error writing to datastream");
256  case SDL_EFSEEK:
257  return SDL_SetError("Error seeking in datastream");
258  case SDL_UNSUPPORTED:
259  return SDL_SetError("That operation is not supported");
260  default:
261  return SDL_SetError("Unknown SDL error");
262  }
263 }
int SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt,...)
Definition: SDL_error.c:53

◆ SDL_GetErrBuf()

SDL_error* SDL_GetErrBuf ( void  )

Definition at line 206 of file SDL_thread.c.

Referenced by SDL_ClearError(), SDL_GetErrorMsg(), and SDL_SetError().

207 {
208  static SDL_SpinLock tls_lock;
209  static SDL_bool tls_being_created;
210  static SDL_TLSID tls_errbuf;
211  static SDL_error SDL_global_errbuf;
212  const SDL_error *ALLOCATION_IN_PROGRESS = (SDL_error *)-1;
213  SDL_error *errbuf;
214 
215  /* tls_being_created is there simply to prevent recursion if SDL_TLSCreate() fails.
216  It also means it's possible for another thread to also use SDL_global_errbuf,
217  but that's very unlikely and hopefully won't cause issues.
218  */
219  if (!tls_errbuf && !tls_being_created) {
220  SDL_AtomicLock(&tls_lock);
221  if (!tls_errbuf) {
222  SDL_TLSID slot;
223  tls_being_created = SDL_TRUE;
224  slot = SDL_TLSCreate();
225  tls_being_created = SDL_FALSE;
227  tls_errbuf = slot;
228  }
229  SDL_AtomicUnlock(&tls_lock);
230  }
231  if (!tls_errbuf) {
232  return &SDL_global_errbuf;
233  }
234 
236  errbuf = (SDL_error *)SDL_TLSGet(tls_errbuf);
237  if (errbuf == ALLOCATION_IN_PROGRESS) {
238  return &SDL_global_errbuf;
239  }
240  if (!errbuf) {
241  /* Mark that we're in the middle of allocating our buffer */
242  SDL_TLSSet(tls_errbuf, ALLOCATION_IN_PROGRESS, NULL);
243  errbuf = (SDL_error *)SDL_malloc(sizeof(*errbuf));
244  if (!errbuf) {
245  SDL_TLSSet(tls_errbuf, NULL, NULL);
246  return &SDL_global_errbuf;
247  }
248  SDL_zerop(errbuf);
249  SDL_TLSSet(tls_errbuf, errbuf, SDL_free);
250  }
251  return errbuf;
252 }
int SDL_TLSSet(SDL_TLSID id, const void *value, void(*destructor)(void *))
Set the value associated with a thread local storage ID for the current thread.
Definition: SDL_thread.c:53
#define SDL_AtomicLock
#define SDL_MemoryBarrierRelease()
Definition: SDL_atomic.h:180
void * SDL_TLSGet(SDL_TLSID id)
Get the value associated with a thread local storage ID for the current thread.
Definition: SDL_thread.c:41
#define SDL_zerop(x)
Definition: SDL_stdinc.h:360
#define SDL_MemoryBarrierAcquire()
Definition: SDL_atomic.h:181
unsigned int SDL_TLSID
Definition: SDL_thread.h:52
#define SDL_AtomicUnlock
void SDL_free(void *mem)
#define NULL
Definition: begin_code.h:143
SDL_bool
Definition: SDL_stdinc.h:130
SDL_TLSID SDL_TLSCreate()
Create an identifier that is globally visible to all threads but refers to data that is thread-specif...
Definition: SDL_thread.c:34
#define SDL_malloc
int SDL_SpinLock
Definition: SDL_atomic.h:89

◆ SDL_GetError()

const char* SDL_GetError ( void  )

Definition at line 229 of file SDL_error.c.

References SDL_ERRBUFIZE, and SDL_GetErrorMsg().

Referenced by SDL_Error(), and SDL_SetError().

230 {
231  static char errmsg[SDL_ERRBUFIZE];
232 
233  return SDL_GetErrorMsg(errmsg, SDL_ERRBUFIZE);
234 }
#define SDL_ERRBUFIZE
Definition: SDL_error.c:39
static char * SDL_GetErrorMsg(char *errstr, int maxlen)
Definition: SDL_error.c:127

◆ SDL_GetErrorMsg()

static char* SDL_GetErrorMsg ( char *  errstr,
int  maxlen 
)
static

Definition at line 127 of file SDL_error.c.

References SDL_error::args, SDL_error::error, SDL_error::key, SDL_arraysize, SDL_GetErrBuf(), SDL_LookupString(), SDL_snprintf, SDL_error::value_f, SDL_error::value_i, and SDL_error::value_ptr.

Referenced by SDL_GetError().

128 {
129  SDL_error *error;
130 
131  /* Clear the error string */
132  *errstr = '\0';
133  --maxlen;
134 
135  /* Get the thread-safe error, and print it out */
136  error = SDL_GetErrBuf();
137  if (error->error) {
138  const char *fmt;
139  char *msg = errstr;
140  int len;
141  int argi;
142 
143  fmt = SDL_LookupString(error->key);
144  argi = 0;
145  while (*fmt && (maxlen > 0)) {
146  if (*fmt == '%') {
147  char tmp[32], *spot = tmp;
148  *spot++ = *fmt++;
149  while ((*fmt == '.' || (*fmt >= '0' && *fmt <= '9'))
150  && spot < (tmp + SDL_arraysize(tmp) - 2)) {
151  *spot++ = *fmt++;
152  }
153  *spot++ = *fmt++;
154  *spot++ = '\0';
155  switch (spot[-2]) {
156  case '%':
157  *msg++ = '%';
158  maxlen -= 1;
159  break;
160  case 'c':
161  case 'i':
162  case 'd':
163  case 'u':
164  case 'o':
165  case 'x':
166  case 'X':
167  len =
168  SDL_snprintf(msg, maxlen, tmp,
169  error->args[argi++].value_i);
170  if (len > 0) {
171  msg += len;
172  maxlen -= len;
173  }
174  break;
175 
176  case 'f':
177  len =
178  SDL_snprintf(msg, maxlen, tmp,
179  error->args[argi++].value_f);
180  if (len > 0) {
181  msg += len;
182  maxlen -= len;
183  }
184  break;
185 
186  case 'p':
187  len =
188  SDL_snprintf(msg, maxlen, tmp,
189  error->args[argi++].value_ptr);
190  if (len > 0) {
191  msg += len;
192  maxlen -= len;
193  }
194  break;
195 
196  case 's':
197  len =
198  SDL_snprintf(msg, maxlen, tmp,
199  SDL_LookupString(error->args[argi++].
200  buf));
201  if (len > 0) {
202  msg += len;
203  maxlen -= len;
204  }
205  break;
206 
207  }
208  } else {
209  *msg++ = *fmt++;
210  maxlen -= 1;
211  }
212  }
213 
214  /* slide back if we've overshot the end of our buffer. */
215  if (maxlen < 0) {
216  msg -= (-maxlen) + 1;
217  }
218 
219  *msg = 0; /* NULL terminate the string */
220  }
221  return (errstr);
222 }
double value_f
Definition: SDL_error_c.h:54
static const char * SDL_LookupString(const char *key)
Definition: SDL_error.c:44
SDL_error * SDL_GetErrBuf(void)
Definition: SDL_thread.c:206
GLenum GLsizei len
union SDL_error::@23 args[ERR_MAX_ARGS]
GLenum GLuint GLenum GLsizei const GLchar * buf
char key[ERR_MAX_STRLEN]
Definition: SDL_error_c.h:43
#define SDL_snprintf
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:90
void * value_ptr
Definition: SDL_error_c.h:49
int value_i
Definition: SDL_error_c.h:53

◆ SDL_LookupString()

static const char* SDL_LookupString ( const char *  key)
static

Definition at line 44 of file SDL_error.c.

Referenced by SDL_GetErrorMsg().

45 {
46  /* FIXME: Add code to lookup key in language string hash-table */
47  return key;
48 }

◆ SDL_SetError()

int SDL_SetError ( SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Definition at line 53 of file SDL_error.c.

References SDL_error::argc, SDL_error::args, SDL_error::buf, ERR_MAX_ARGS, ERR_MAX_STRLEN, SDL_error::error, i, SDL_error::key, NULL, SDL_GetErrBuf(), SDL_GetError(), SDL_LOG_CATEGORY_ERROR, SDL_LogDebug, SDL_strlcpy, SDL_error::value_f, SDL_error::value_i, and SDL_error::value_ptr.

Referenced by SDL_Error().

54 {
55  va_list ap;
56  SDL_error *error;
57 
58  /* Ignore call if invalid format pointer was passed */
59  if (fmt == NULL) return -1;
60 
61  /* Copy in the key, mark error as valid */
62  error = SDL_GetErrBuf();
63  error->error = 1;
64  SDL_strlcpy((char *) error->key, fmt, sizeof(error->key));
65 
66  va_start(ap, fmt);
67  error->argc = 0;
68  while (*fmt) {
69  if (*fmt++ == '%') {
70  while (*fmt == '.' || (*fmt >= '0' && *fmt <= '9')) {
71  ++fmt;
72  }
73  switch (*fmt++) {
74  case 0: /* Malformed format string.. */
75  --fmt;
76  break;
77  case 'c':
78  case 'i':
79  case 'd':
80  case 'u':
81  case 'o':
82  case 'x':
83  case 'X':
84  error->args[error->argc++].value_i = va_arg(ap, int);
85  break;
86  case 'f':
87  error->args[error->argc++].value_f = va_arg(ap, double);
88  break;
89  case 'p':
90  error->args[error->argc++].value_ptr = va_arg(ap, void *);
91  break;
92  case 's':
93  {
94  int i = error->argc;
95  const char *str = va_arg(ap, const char *);
96  if (str == NULL)
97  str = "(null)";
98  SDL_strlcpy((char *) error->args[i].buf, str,
100  error->argc++;
101  }
102  break;
103  default:
104  break;
105  }
106  if (error->argc >= ERR_MAX_ARGS) {
107  break;
108  }
109  }
110  }
111  va_end(ap);
112 
113  /* If we are in debug mode, print out an error message */
115 
116  return -1;
117 }
#define SDL_strlcpy
double value_f
Definition: SDL_error_c.h:54
SDL_error * SDL_GetErrBuf(void)
Definition: SDL_thread.c:206
#define ERR_MAX_STRLEN
Definition: SDL_error_c.h:30
const char * SDL_GetError(void)
Definition: SDL_error.c:229
#define SDL_LogDebug
union SDL_error::@23 args[ERR_MAX_ARGS]
#define ERR_MAX_ARGS
Definition: SDL_error_c.h:31
char key[ERR_MAX_STRLEN]
Definition: SDL_error_c.h:43
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
#define NULL
Definition: begin_code.h:143
char buf[ERR_MAX_STRLEN]
Definition: SDL_error_c.h:55
void * value_ptr
Definition: SDL_error_c.h:49
int value_i
Definition: SDL_error_c.h:53