src/file/SDL_rwops.c
author Sam Lantinga <slouken@libsdl.org>
Tue, 21 Feb 2006 08:46:50 +0000
changeset 1402 d910939febfa
parent 1358 c71e05b4dc2e
child 1446 47bf1767c4ca
permissions -rw-r--r--
Use consistent identifiers for the various platforms we support.
Make sure every source file includes SDL_config.h, so the proper system
headers are chosen.
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@1402
    22
#include "SDL_config.h"
slouken@0
    23
slouken@0
    24
/* This file provides a general interface for SDL to read and write
slouken@0
    25
   data sources.  It can easily be extended to files, memory, etc.
slouken@0
    26
*/
slouken@0
    27
slouken@1354
    28
#include "SDL_endian.h"
slouken@0
    29
#include "SDL_rwops.h"
slouken@1330
    30
slouken@1354
    31
slouken@1330
    32
#ifdef HAVE_STDIO_H
slouken@0
    33
slouken@0
    34
/* Functions to read/write stdio file pointers */
slouken@0
    35
slouken@0
    36
static int stdio_seek(SDL_RWops *context, int offset, int whence)
slouken@0
    37
{
slouken@0
    38
	if ( fseek(context->hidden.stdio.fp, offset, whence) == 0 ) {
slouken@0
    39
		return(ftell(context->hidden.stdio.fp));
slouken@0
    40
	} else {
slouken@0
    41
		SDL_Error(SDL_EFSEEK);
slouken@0
    42
		return(-1);
slouken@0
    43
	}
slouken@0
    44
}
slouken@0
    45
static int stdio_read(SDL_RWops *context, void *ptr, int size, int maxnum)
slouken@0
    46
{
slouken@0
    47
	size_t nread;
slouken@0
    48
slouken@0
    49
	nread = fread(ptr, size, maxnum, context->hidden.stdio.fp); 
slouken@0
    50
	if ( nread == 0 && ferror(context->hidden.stdio.fp) ) {
slouken@0
    51
		SDL_Error(SDL_EFREAD);
slouken@0
    52
	}
slouken@0
    53
	return(nread);
slouken@0
    54
}
slouken@0
    55
static int stdio_write(SDL_RWops *context, const void *ptr, int size, int num)
slouken@0
    56
{
slouken@0
    57
	size_t nwrote;
slouken@0
    58
slouken@0
    59
	nwrote = fwrite(ptr, size, num, context->hidden.stdio.fp);
slouken@0
    60
	if ( nwrote == 0 && ferror(context->hidden.stdio.fp) ) {
slouken@0
    61
		SDL_Error(SDL_EFWRITE);
slouken@0
    62
	}
slouken@0
    63
	return(nwrote);
slouken@0
    64
}
slouken@0
    65
static int stdio_close(SDL_RWops *context)
slouken@0
    66
{
slouken@0
    67
	if ( context ) {
slouken@0
    68
		if ( context->hidden.stdio.autoclose ) {
slouken@0
    69
			/* WARNING:  Check the return value here! */
slouken@0
    70
			fclose(context->hidden.stdio.fp);
slouken@0
    71
		}
icculus@1202
    72
		SDL_FreeRW(context);
slouken@0
    73
	}
slouken@0
    74
	return(0);
slouken@0
    75
}
slouken@0
    76
slouken@1330
    77
#endif /* HAVE_STDIO_H */
slouken@1330
    78
slouken@0
    79
/* Functions to read/write memory pointers */
slouken@0
    80
slouken@0
    81
static int mem_seek(SDL_RWops *context, int offset, int whence)
slouken@0
    82
{
slouken@0
    83
	Uint8 *newpos;
slouken@0
    84
slouken@0
    85
	switch (whence) {
slouken@1330
    86
		case RW_SEEK_SET:
slouken@0
    87
			newpos = context->hidden.mem.base+offset;
slouken@0
    88
			break;
slouken@1330
    89
		case RW_SEEK_CUR:
slouken@0
    90
			newpos = context->hidden.mem.here+offset;
slouken@0
    91
			break;
slouken@1330
    92
		case RW_SEEK_END:
slouken@0
    93
			newpos = context->hidden.mem.stop+offset;
slouken@0
    94
			break;
slouken@0
    95
		default:
slouken@0
    96
			SDL_SetError("Unknown value for 'whence'");
slouken@0
    97
			return(-1);
slouken@0
    98
	}
slouken@0
    99
	if ( newpos < context->hidden.mem.base ) {
slouken@0
   100
		newpos = context->hidden.mem.base;
slouken@0
   101
	}
slouken@0
   102
	if ( newpos > context->hidden.mem.stop ) {
slouken@0
   103
		newpos = context->hidden.mem.stop;
slouken@0
   104
	}
slouken@0
   105
	context->hidden.mem.here = newpos;
slouken@0
   106
	return(context->hidden.mem.here-context->hidden.mem.base);
slouken@0
   107
}
slouken@0
   108
static int mem_read(SDL_RWops *context, void *ptr, int size, int maxnum)
slouken@0
   109
{
icculus@1078
   110
	int total_bytes;
icculus@1078
   111
	int mem_available;
slouken@0
   112
icculus@1078
   113
	total_bytes = (maxnum * size);
icculus@1078
   114
	if ( (maxnum <= 0) || (size <= 0) || ((total_bytes / maxnum) != size) ) {
icculus@1078
   115
		return 0;
slouken@0
   116
	}
icculus@1078
   117
icculus@1078
   118
	mem_available = (context->hidden.mem.stop - context->hidden.mem.here);
icculus@1078
   119
	if (total_bytes > mem_available) {
icculus@1078
   120
		total_bytes = mem_available;
icculus@1078
   121
	}
icculus@1078
   122
slouken@1336
   123
	SDL_memcpy(ptr, context->hidden.mem.here, total_bytes);
icculus@1078
   124
	context->hidden.mem.here += total_bytes;
icculus@1078
   125
icculus@1078
   126
	return (total_bytes / size);
slouken@0
   127
}
slouken@0
   128
static int mem_write(SDL_RWops *context, const void *ptr, int size, int num)
slouken@0
   129
{
slouken@0
   130
	if ( (context->hidden.mem.here + (num*size)) > context->hidden.mem.stop ) {
slouken@0
   131
		num = (context->hidden.mem.stop-context->hidden.mem.here)/size;
slouken@0
   132
	}
slouken@1336
   133
	SDL_memcpy(context->hidden.mem.here, ptr, num*size);
slouken@0
   134
	context->hidden.mem.here += num*size;
slouken@0
   135
	return(num);
slouken@0
   136
}
slouken@764
   137
static int mem_writeconst(SDL_RWops *context, const void *ptr, int size, int num)
slouken@764
   138
{
slouken@764
   139
	SDL_SetError("Can't write to read-only memory");
slouken@764
   140
	return(-1);
slouken@764
   141
}
slouken@0
   142
static int mem_close(SDL_RWops *context)
slouken@0
   143
{
slouken@0
   144
	if ( context ) {
icculus@1202
   145
		SDL_FreeRW(context);
slouken@0
   146
	}
slouken@0
   147
	return(0);
slouken@0
   148
}
slouken@0
   149
slouken@0
   150
/* Functions to create SDL_RWops structures from various data sources */
slouken@1402
   151
#ifdef __WIN32__
slouken@0
   152
/* Aggh.  You can't (apparently) open a file in an application and
slouken@0
   153
   read from it in a DLL.
slouken@0
   154
*/
slouken@0
   155
static int in_sdl = 0;
slouken@0
   156
#endif
slouken@0
   157
slouken@1402
   158
#ifdef __MACOS__
slouken@0
   159
/*
slouken@0
   160
 * translate unix-style slash-separated filename to mac-style colon-separated
slouken@0
   161
 * name; return malloced string
slouken@0
   162
 */
slouken@0
   163
static char *unix_to_mac(const char *file)
slouken@0
   164
{
slouken@1336
   165
	int flen = SDL_strlen(file);
slouken@1336
   166
	char *path = SDL_malloc(flen + 2);
slouken@0
   167
	const char *src = file;
slouken@0
   168
	char *dst = path;
slouken@0
   169
	if(*src == '/') {
slouken@0
   170
		/* really depends on filesystem layout, hope for the best */
slouken@0
   171
		src++;
slouken@0
   172
	} else {
slouken@0
   173
		/* Check if this is a MacOS path to begin with */
slouken@0
   174
		if(*src != ':')
slouken@0
   175
			*dst++ = ':';   /* relative paths begin with ':' */
slouken@0
   176
	}
slouken@0
   177
	while(src < file + flen) {
slouken@1336
   178
		const char *end = SDL_strchr(src, '/');
slouken@0
   179
		int len;
slouken@0
   180
		if(!end)
slouken@0
   181
			end = file + flen; /* last component */
slouken@0
   182
		len = end - src;
slouken@0
   183
		if(len == 0 || (len == 1 && src[0] == '.')) {
slouken@0
   184
			/* remove repeated slashes and . */
slouken@0
   185
		} else {
slouken@0
   186
			if(len == 2 && src[0] == '.' && src[1] == '.') {
slouken@0
   187
				/* replace .. with the empty string */
slouken@0
   188
			} else {
slouken@1336
   189
				SDL_memcpy(dst, src, len);
slouken@0
   190
				dst += len;
slouken@0
   191
			}
slouken@0
   192
			if(end < file + flen)
slouken@0
   193
				*dst++ = ':';
slouken@0
   194
		}
slouken@0
   195
		src = end + 1;
slouken@0
   196
	}
slouken@0
   197
	*dst++ = '\0';
slouken@0
   198
	return path;
slouken@0
   199
}
slouken@1402
   200
#endif /* __MACOS__ */
slouken@0
   201
slouken@0
   202
SDL_RWops *SDL_RWFromFile(const char *file, const char *mode)
slouken@0
   203
{
slouken@1330
   204
	SDL_RWops *rwops = NULL;
slouken@1330
   205
#ifdef HAVE_STDIO_H
slouken@0
   206
	FILE *fp;
slouken@0
   207
slouken@1402
   208
#ifdef __MACOS__
slouken@0
   209
	{
slouken@0
   210
		char *mpath = unix_to_mac(file);
slouken@0
   211
		fp = fopen(mpath, mode);
slouken@1336
   212
		SDL_free(mpath);
slouken@0
   213
	}
slouken@0
   214
#else
slouken@0
   215
	fp = fopen(file, mode);
slouken@0
   216
#endif
slouken@0
   217
	if ( fp == NULL ) {
slouken@0
   218
		SDL_SetError("Couldn't open %s", file);
slouken@0
   219
	} else {
slouken@1402
   220
#ifdef __WIN32__
slouken@0
   221
		in_sdl = 1;
slouken@0
   222
		rwops = SDL_RWFromFP(fp, 1);
slouken@0
   223
		in_sdl = 0;
slouken@0
   224
#else
slouken@0
   225
		rwops = SDL_RWFromFP(fp, 1);
slouken@0
   226
#endif
slouken@0
   227
	}
slouken@1330
   228
#endif /* HAVE_STDIO_H */
slouken@0
   229
	return(rwops);
slouken@0
   230
}
slouken@0
   231
slouken@1330
   232
#ifdef HAVE_STDIO_H
slouken@0
   233
SDL_RWops *SDL_RWFromFP(FILE *fp, int autoclose)
slouken@0
   234
{
slouken@1330
   235
	SDL_RWops *rwops = NULL;
slouken@0
   236
slouken@1402
   237
#ifdef __WIN32__
slouken@0
   238
	if ( ! in_sdl ) {
slouken@1269
   239
		/* It's when SDL and the app are compiled with different C runtimes */
slouken@543
   240
		SDL_SetError("You can't pass a FILE pointer to a DLL (?)");
slouken@0
   241
		/*return(NULL);*/
slouken@0
   242
	}
slouken@0
   243
#endif
slouken@0
   244
	rwops = SDL_AllocRW();
slouken@0
   245
	if ( rwops != NULL ) {
slouken@0
   246
		rwops->seek = stdio_seek;
slouken@0
   247
		rwops->read = stdio_read;
slouken@0
   248
		rwops->write = stdio_write;
slouken@0
   249
		rwops->close = stdio_close;
slouken@0
   250
		rwops->hidden.stdio.fp = fp;
slouken@0
   251
		rwops->hidden.stdio.autoclose = autoclose;
slouken@0
   252
	}
slouken@0
   253
	return(rwops);
slouken@0
   254
}
slouken@1330
   255
#endif /* HAVE_STDIO_H */
slouken@0
   256
slouken@0
   257
SDL_RWops *SDL_RWFromMem(void *mem, int size)
slouken@0
   258
{
slouken@0
   259
	SDL_RWops *rwops;
slouken@0
   260
slouken@0
   261
	rwops = SDL_AllocRW();
slouken@0
   262
	if ( rwops != NULL ) {
slouken@0
   263
		rwops->seek = mem_seek;
slouken@0
   264
		rwops->read = mem_read;
slouken@0
   265
		rwops->write = mem_write;
slouken@0
   266
		rwops->close = mem_close;
slouken@0
   267
		rwops->hidden.mem.base = (Uint8 *)mem;
slouken@0
   268
		rwops->hidden.mem.here = rwops->hidden.mem.base;
slouken@0
   269
		rwops->hidden.mem.stop = rwops->hidden.mem.base+size;
slouken@0
   270
	}
slouken@0
   271
	return(rwops);
slouken@0
   272
}
slouken@0
   273
slouken@764
   274
SDL_RWops *SDL_RWFromConstMem(const void *mem, int size)
slouken@764
   275
{
slouken@764
   276
	SDL_RWops *rwops;
slouken@764
   277
slouken@764
   278
	rwops = SDL_AllocRW();
slouken@764
   279
	if ( rwops != NULL ) {
slouken@764
   280
		rwops->seek = mem_seek;
slouken@764
   281
		rwops->read = mem_read;
slouken@764
   282
		rwops->write = mem_writeconst;
slouken@764
   283
		rwops->close = mem_close;
slouken@764
   284
		rwops->hidden.mem.base = (Uint8 *)mem;
slouken@764
   285
		rwops->hidden.mem.here = rwops->hidden.mem.base;
slouken@764
   286
		rwops->hidden.mem.stop = rwops->hidden.mem.base+size;
slouken@764
   287
	}
slouken@764
   288
	return(rwops);
slouken@764
   289
}
slouken@764
   290
slouken@0
   291
SDL_RWops *SDL_AllocRW(void)
slouken@0
   292
{
slouken@0
   293
	SDL_RWops *area;
slouken@0
   294
slouken@1336
   295
	area = (SDL_RWops *)SDL_malloc(sizeof *area);
slouken@0
   296
	if ( area == NULL ) {
slouken@0
   297
		SDL_OutOfMemory();
slouken@0
   298
	}
slouken@0
   299
	return(area);
slouken@0
   300
}
slouken@0
   301
slouken@0
   302
void SDL_FreeRW(SDL_RWops *area)
slouken@0
   303
{
slouken@1336
   304
	SDL_free(area);
slouken@0
   305
}
slouken@1354
   306
slouken@1354
   307
/* Functions for dynamically reading and writing endian-specific values */
slouken@1354
   308
slouken@1354
   309
Uint16 SDL_ReadLE16 (SDL_RWops *src)
slouken@1354
   310
{
slouken@1354
   311
	Uint16 value;
slouken@1354
   312
slouken@1354
   313
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   314
	return(SDL_SwapLE16(value));
slouken@1354
   315
}
slouken@1354
   316
Uint16 SDL_ReadBE16 (SDL_RWops *src)
slouken@1354
   317
{
slouken@1354
   318
	Uint16 value;
slouken@1354
   319
slouken@1354
   320
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   321
	return(SDL_SwapBE16(value));
slouken@1354
   322
}
slouken@1354
   323
Uint32 SDL_ReadLE32 (SDL_RWops *src)
slouken@1354
   324
{
slouken@1354
   325
	Uint32 value;
slouken@1354
   326
slouken@1354
   327
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   328
	return(SDL_SwapLE32(value));
slouken@1354
   329
}
slouken@1354
   330
Uint32 SDL_ReadBE32 (SDL_RWops *src)
slouken@1354
   331
{
slouken@1354
   332
	Uint32 value;
slouken@1354
   333
slouken@1354
   334
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   335
	return(SDL_SwapBE32(value));
slouken@1354
   336
}
slouken@1354
   337
Uint64 SDL_ReadLE64 (SDL_RWops *src)
slouken@1354
   338
{
slouken@1354
   339
	Uint64 value;
slouken@1354
   340
slouken@1354
   341
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   342
	return(SDL_SwapLE64(value));
slouken@1354
   343
}
slouken@1354
   344
Uint64 SDL_ReadBE64 (SDL_RWops *src)
slouken@1354
   345
{
slouken@1354
   346
	Uint64 value;
slouken@1354
   347
slouken@1354
   348
	SDL_RWread(src, &value, (sizeof value), 1);
slouken@1354
   349
	return(SDL_SwapBE64(value));
slouken@1354
   350
}
slouken@1354
   351
slouken@1354
   352
int SDL_WriteLE16 (SDL_RWops *dst, Uint16 value)
slouken@1354
   353
{
slouken@1354
   354
	value = SDL_SwapLE16(value);
slouken@1354
   355
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   356
}
slouken@1354
   357
int SDL_WriteBE16 (SDL_RWops *dst, Uint16 value)
slouken@1354
   358
{
slouken@1354
   359
	value = SDL_SwapBE16(value);
slouken@1354
   360
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   361
}
slouken@1354
   362
int SDL_WriteLE32 (SDL_RWops *dst, Uint32 value)
slouken@1354
   363
{
slouken@1354
   364
	value = SDL_SwapLE32(value);
slouken@1354
   365
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   366
}
slouken@1354
   367
int SDL_WriteBE32 (SDL_RWops *dst, Uint32 value)
slouken@1354
   368
{
slouken@1354
   369
	value = SDL_SwapBE32(value);
slouken@1354
   370
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   371
}
slouken@1354
   372
int SDL_WriteLE64 (SDL_RWops *dst, Uint64 value)
slouken@1354
   373
{
slouken@1354
   374
	value = SDL_SwapLE64(value);
slouken@1354
   375
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   376
}
slouken@1354
   377
int SDL_WriteBE64 (SDL_RWops *dst, Uint64 value)
slouken@1354
   378
{
slouken@1354
   379
	value = SDL_SwapBE64(value);
slouken@1354
   380
	return(SDL_RWwrite(dst, &value, (sizeof value), 1));
slouken@1354
   381
}