src/SDL_error.c
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 1172 f69f4d25fb20
child 1330 450721ad5436
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@252
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
/* Simple error handling in SDL */
slouken@0
    24
slouken@0
    25
#include <stdio.h>
slouken@0
    26
#include <stdlib.h>
slouken@0
    27
#include <stdarg.h>
slouken@0
    28
#include <string.h>
slouken@0
    29
slouken@0
    30
#include "SDL_types.h"
slouken@0
    31
#include "SDL_getenv.h"
slouken@0
    32
#include "SDL_error.h"
slouken@0
    33
#include "SDL_error_c.h"
slouken@0
    34
#ifndef DISABLE_THREADS
slouken@0
    35
#include "SDL_thread_c.h"
slouken@0
    36
#endif
slouken@0
    37
slouken@0
    38
#ifdef DISABLE_THREADS
slouken@0
    39
/* The default (non-thread-safe) global error variable */
slouken@0
    40
static SDL_error SDL_global_error;
slouken@0
    41
slouken@0
    42
#define SDL_GetErrBuf()	(&SDL_global_error)
slouken@0
    43
#endif /* DISABLE_THREADS */
slouken@0
    44
slouken@1
    45
#ifdef __CYGWIN__
slouken@1
    46
#define DISABLE_STDIO
slouken@1
    47
#endif
slouken@1
    48
slouken@0
    49
#define SDL_ERRBUFIZE	1024
slouken@0
    50
slouken@0
    51
/* Private functions */
slouken@0
    52
slouken@0
    53
static void SDL_LookupString(const Uint8 *key, Uint16 *buf, int buflen)
slouken@0
    54
{
slouken@0
    55
	/* FIXME: Add code to lookup key in language string hash-table */
slouken@0
    56
slouken@0
    57
	/* Key not found in language string hash-table */
slouken@0
    58
	while ( *key && (--buflen > 0) ) {
slouken@0
    59
		*buf++ = *key++;
slouken@0
    60
	}
slouken@0
    61
	*buf = 0;	/* NULL terminate string */
slouken@0
    62
}
slouken@0
    63
slouken@0
    64
/* Public functions */
slouken@0
    65
slouken@0
    66
void SDL_SetError (const char *fmt, ...)
slouken@0
    67
{
slouken@0
    68
	va_list ap;
slouken@0
    69
	SDL_error *error;
slouken@0
    70
slouken@0
    71
	/* Copy in the key, mark error as valid */
slouken@0
    72
	error = SDL_GetErrBuf();
slouken@0
    73
	error->error = 1;
slouken@0
    74
	strncpy((char *)error->key, fmt, sizeof(error->key));
slouken@0
    75
	error->key[sizeof(error->key)-1] = '\0';
slouken@0
    76
slouken@0
    77
	va_start(ap, fmt);
slouken@0
    78
	error->argc = 0;
slouken@0
    79
	while ( *fmt ) {
slouken@0
    80
		if ( *fmt++ == '%' ) {
slouken@0
    81
			switch (*fmt++) {
slouken@0
    82
			    case 0:  /* Malformed format string.. */
slouken@0
    83
				--fmt;
slouken@0
    84
				break;
slouken@0
    85
#if 0	/* What is a character anyway?  (UNICODE issues) */
slouken@0
    86
			    case 'c':
slouken@0
    87
				error->args[error->argc++].value_c =
slouken@0
    88
						va_arg(ap, unsigned char);
slouken@0
    89
				break;
slouken@0
    90
#endif
slouken@0
    91
			    case 'd':
slouken@0
    92
				error->args[error->argc++].value_i =
slouken@0
    93
							va_arg(ap, int);
slouken@0
    94
				break;
slouken@0
    95
			    case 'f':
slouken@0
    96
				error->args[error->argc++].value_f =
slouken@0
    97
							va_arg(ap, double);
slouken@0
    98
				break;
slouken@0
    99
			    case 'p':
slouken@0
   100
				error->args[error->argc++].value_ptr =
slouken@0
   101
							va_arg(ap, void *);
slouken@0
   102
				break;
slouken@0
   103
			    case 's':
slouken@0
   104
				{
slouken@0
   105
				  int index = error->argc;
icculus@1172
   106
				  char *str = va_arg(ap, char *);
icculus@1172
   107
				  if (str == NULL)
icculus@1172
   108
				      str = "(null)";
icculus@1172
   109
				  strncpy((char *)error->args[index].buf, str, ERR_MAX_STRLEN);
slouken@0
   110
				  error->args[index].buf[ERR_MAX_STRLEN-1] = 0;
slouken@0
   111
				  error->argc++;
slouken@0
   112
				}
slouken@0
   113
				break;
slouken@0
   114
			    default:
slouken@0
   115
				break;
slouken@0
   116
			}
slouken@0
   117
			if ( error->argc >= ERR_MAX_ARGS ) {
slouken@0
   118
				break;
slouken@0
   119
			}
slouken@0
   120
		}
slouken@0
   121
	}
slouken@0
   122
	va_end(ap);
slouken@0
   123
slouken@1
   124
#ifndef DISABLE_STDIO
slouken@0
   125
	/* If we are in debug mode, print out an error message */
slouken@0
   126
#ifdef DEBUG_ERROR
slouken@0
   127
	fprintf(stderr, "SDL_SetError: %s\n", SDL_GetError());
slouken@0
   128
#else
slouken@0
   129
	if ( getenv("SDL_DEBUG") ) {
slouken@0
   130
		fprintf(stderr, "SDL_SetError: %s\n", SDL_GetError());
slouken@0
   131
	}
slouken@0
   132
#endif
slouken@1
   133
#endif /* !DISABLE_STDIO */
slouken@0
   134
}
slouken@0
   135
slouken@0
   136
/* Print out an integer value to a UNICODE buffer */
slouken@0
   137
static int PrintInt(Uint16 *str, unsigned int maxlen, int value)
slouken@0
   138
{
slouken@0
   139
	char tmp[128];
slouken@0
   140
	int len, i;
slouken@0
   141
slouken@0
   142
	sprintf(tmp, "%d", value);
slouken@0
   143
	len = 0;
slouken@0
   144
	if ( strlen(tmp) < maxlen ) {
slouken@0
   145
		for ( i=0; tmp[i]; ++i ) {
slouken@0
   146
			*str++ = tmp[i];
slouken@0
   147
			++len;
slouken@0
   148
		}
slouken@0
   149
	}
slouken@0
   150
	return(len);
slouken@0
   151
}
slouken@0
   152
/* Print out a double value to a UNICODE buffer */
slouken@0
   153
static int PrintDouble(Uint16 *str, unsigned int maxlen, double value)
slouken@0
   154
{
slouken@0
   155
	char tmp[128];
slouken@0
   156
	int len, i;
slouken@0
   157
slouken@0
   158
	sprintf(tmp, "%f", value);
slouken@0
   159
	len = 0;
slouken@0
   160
	if ( strlen(tmp) < maxlen ) {
slouken@0
   161
		for ( i=0; tmp[i]; ++i ) {
slouken@0
   162
			*str++ = tmp[i];
slouken@0
   163
			++len;
slouken@0
   164
		}
slouken@0
   165
	}
slouken@0
   166
	return(len);
slouken@0
   167
}
slouken@0
   168
/* Print out a pointer value to a UNICODE buffer */
slouken@0
   169
static int PrintPointer(Uint16 *str, unsigned int maxlen, void *value)
slouken@0
   170
{
slouken@0
   171
	char tmp[128];
slouken@0
   172
	int len, i;
slouken@0
   173
slouken@0
   174
	sprintf(tmp, "%p", value);
slouken@0
   175
	len = 0;
slouken@0
   176
	if ( strlen(tmp) < maxlen ) {
slouken@0
   177
		for ( i=0; tmp[i]; ++i ) {
slouken@0
   178
			*str++ = tmp[i];
slouken@0
   179
			++len;
slouken@0
   180
		}
slouken@0
   181
	}
slouken@0
   182
	return(len);
slouken@0
   183
}
slouken@0
   184
slouken@0
   185
/* This function has a bit more overhead than most error functions
slouken@0
   186
   so that it supports internationalization and thread-safe errors.
slouken@0
   187
*/
slouken@0
   188
Uint16 *SDL_GetErrorMsgUNICODE(Uint16 *errstr, unsigned int maxlen)
slouken@0
   189
{
slouken@0
   190
	SDL_error *error;
slouken@0
   191
slouken@0
   192
	/* Clear the error string */
slouken@0
   193
	*errstr = 0; --maxlen;
slouken@0
   194
slouken@0
   195
	/* Get the thread-safe error, and print it out */
slouken@0
   196
	error = SDL_GetErrBuf();
slouken@0
   197
	if ( error->error ) {
slouken@0
   198
		Uint16 translated[ERR_MAX_STRLEN], *fmt, *msg;
slouken@0
   199
		int len;
slouken@0
   200
		int argi;
slouken@0
   201
slouken@0
   202
		/* Print out the UNICODE error message */
slouken@0
   203
		SDL_LookupString(error->key, translated, sizeof(translated));
slouken@0
   204
		msg = errstr;
slouken@0
   205
		argi = 0;
slouken@0
   206
		for ( fmt=translated; *fmt && (maxlen > 0); ) {
slouken@0
   207
			if ( *fmt == '%' ) {
slouken@0
   208
				switch (fmt[1]) {
slouken@0
   209
				    case 'S':	/* Special SKIP operand */
slouken@0
   210
					argi += (fmt[2] - '0');
slouken@0
   211
					++fmt;
slouken@0
   212
					break;
slouken@0
   213
				    case '%':
slouken@0
   214
					*msg++ = '%';
slouken@0
   215
					maxlen -= 1;
slouken@0
   216
					break;
slouken@0
   217
#if 0	/* What is a character anyway?  (UNICODE issues) */
slouken@0
   218
				    case 'c':
slouken@0
   219
                                        *msg++ = (unsigned char)
slouken@0
   220
					         error->args[argi++].value_c;
slouken@0
   221
					maxlen -= 1;
slouken@0
   222
					break;
slouken@0
   223
#endif
slouken@0
   224
				    case 'd':
slouken@0
   225
					len = PrintInt(msg, maxlen,
slouken@0
   226
						error->args[argi++].value_i);
slouken@0
   227
					msg += len;
slouken@0
   228
					maxlen -= len;
slouken@0
   229
					break;
slouken@0
   230
				    case 'f':
slouken@0
   231
					len = PrintDouble(msg, maxlen,
slouken@0
   232
						error->args[argi++].value_f);
slouken@0
   233
					msg += len;
slouken@0
   234
					maxlen -= len;
slouken@0
   235
					break;
slouken@0
   236
				    case 'p':
slouken@0
   237
					len = PrintPointer(msg, maxlen,
slouken@0
   238
						error->args[argi++].value_ptr);
slouken@0
   239
					msg += len;
slouken@0
   240
					maxlen -= len;
slouken@0
   241
					break;
slouken@0
   242
				    case 's': /* UNICODE string */
slouken@0
   243
					{ Uint16 buf[ERR_MAX_STRLEN], *str;
slouken@0
   244
					  SDL_LookupString(error->args[argi++].buf, buf, sizeof(buf));
slouken@0
   245
					  str = buf;
slouken@0
   246
					  while ( *str && (maxlen > 0) ) {
slouken@0
   247
						*msg++ = *str++;
slouken@0
   248
						maxlen -= 1;
slouken@0
   249
					  }
slouken@0
   250
					}
slouken@0
   251
					break;
slouken@0
   252
				}
slouken@0
   253
				fmt += 2;
slouken@0
   254
			} else {
slouken@0
   255
				*msg++ = *fmt++;
slouken@0
   256
				maxlen -= 1;
slouken@0
   257
			}
slouken@0
   258
		}
slouken@0
   259
		*msg = 0;	/* NULL terminate the string */
slouken@0
   260
	}
slouken@0
   261
	return(errstr);
slouken@0
   262
}
slouken@0
   263
slouken@0
   264
Uint8 *SDL_GetErrorMsg(Uint8 *errstr, unsigned int maxlen)
slouken@0
   265
{
slouken@0
   266
	Uint16 *errstr16;
slouken@0
   267
	unsigned int i;
slouken@0
   268
slouken@0
   269
	/* Allocate the UNICODE buffer */
slouken@0
   270
	errstr16 = (Uint16 *)malloc(maxlen * (sizeof *errstr16));
slouken@0
   271
	if ( ! errstr16 ) {
slouken@0
   272
		strncpy((char *)errstr, "Out of memory", maxlen);
slouken@0
   273
		errstr[maxlen-1] = '\0';
slouken@0
   274
		return(errstr);
slouken@0
   275
	}
slouken@0
   276
slouken@0
   277
	/* Get the error message */
slouken@0
   278
	SDL_GetErrorMsgUNICODE(errstr16, maxlen);
slouken@0
   279
slouken@0
   280
	/* Convert from UNICODE to Latin1 encoding */
slouken@0
   281
	for ( i=0; i<maxlen; ++i ) {
slouken@0
   282
		errstr[i] = (Uint8)errstr16[i];
slouken@0
   283
	}
slouken@0
   284
slouken@0
   285
	/* Free UNICODE buffer (if necessary) */
slouken@0
   286
	free(errstr16);
slouken@0
   287
slouken@0
   288
	return(errstr);
slouken@0
   289
}
slouken@0
   290
slouken@0
   291
/* Available for backwards compatibility */
slouken@0
   292
char *SDL_GetError (void)
slouken@0
   293
{
slouken@0
   294
	static char errmsg[SDL_ERRBUFIZE];
slouken@0
   295
slouken@0
   296
	return((char *)SDL_GetErrorMsg((unsigned char *)errmsg, SDL_ERRBUFIZE));
slouken@0
   297
}
slouken@0
   298
slouken@0
   299
void SDL_ClearError(void)
slouken@0
   300
{
slouken@0
   301
	SDL_error *error;
slouken@0
   302
slouken@0
   303
	error = SDL_GetErrBuf();
slouken@0
   304
	error->error = 0;
slouken@0
   305
}
slouken@0
   306
slouken@0
   307
/* Very common errors go here */
slouken@0
   308
void SDL_Error(SDL_errorcode code)
slouken@0
   309
{
slouken@0
   310
	switch (code) {
slouken@0
   311
		case SDL_ENOMEM:
slouken@0
   312
			SDL_SetError("Out of memory");
slouken@0
   313
			break;
slouken@0
   314
		case SDL_EFREAD:
slouken@0
   315
			SDL_SetError("Error reading from datastream");
slouken@0
   316
			break;
slouken@0
   317
		case SDL_EFWRITE:
slouken@0
   318
			SDL_SetError("Error writing to datastream");
slouken@0
   319
			break;
slouken@0
   320
		case SDL_EFSEEK:
slouken@0
   321
			SDL_SetError("Error seeking in datastream");
slouken@0
   322
			break;
slouken@0
   323
		default:
slouken@0
   324
			SDL_SetError("Unknown SDL error");
slouken@0
   325
			break;
slouken@0
   326
	}
slouken@0
   327
}
slouken@0
   328
slouken@0
   329
#ifdef TEST_ERROR
slouken@0
   330
int main(int argc, char *argv[])
slouken@0
   331
{
slouken@0
   332
	char buffer[BUFSIZ+1];
slouken@0
   333
slouken@0
   334
	SDL_SetError("Hi there!");
slouken@0
   335
	printf("Error 1: %s\n", SDL_GetError());
slouken@0
   336
	SDL_ClearError();
slouken@0
   337
	memset(buffer, '1', BUFSIZ);
slouken@0
   338
	buffer[BUFSIZ] = 0;
slouken@0
   339
	SDL_SetError("This is the error: %s (%f)", buffer, 1.0);
slouken@0
   340
	printf("Error 2: %s\n", SDL_GetError());
slouken@0
   341
	exit(0);
slouken@0
   342
}
slouken@0
   343
#endif