SDL_rwops.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
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
13
Lesser General Public License for more details.
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
18
19
Sam Lantinga
20
slouken@libsdl.org
21
*/
22
#include "SDL_config.h"
23
24
25
26
27
/* This file provides a general interface for SDL to read and write
data sources. It can easily be extended to files, memory, etc.
*/
28
#include "SDL_endian.h"
29
#include "SDL_rwops.h"
32
#if defined(__WIN32__)
34
/* Functions to read/write Win32 API file pointers */
35
36
37
/* Will not use it on WinCE because stdio is buffered, it means
faster, and all stdio functions anyway are embedded in coredll.dll -
the main wince dll*/
39
40
41
#define WINDOWS_LEAN_AND_MEAN
#include <windows.h>
42
43
44
45
#ifndef INVALID_SET_FILE_POINTER
#define INVALID_SET_FILE_POINTER 0xFFFFFFFF
#endif
46
static int SDLCALL win32_file_open(SDL_RWops *context, const char *filename, const char *mode)
47
48
{
#ifndef _WIN32_WCE
49
UINT old_error_mode;
51
52
53
54
55
HANDLE h;
DWORD r_right, w_right;
DWORD must_exist, truncate;
int a_mode;
56
if (!context)
57
58
59
60
61
62
63
64
65
66
67
68
69
70
return -1;
context->hidden.win32io.h = INVALID_HANDLE_VALUE; /* mark this as unusable */
/* "r" = reading, file must exist */
/* "w" = writing, truncate existing, file may not exist */
/* "r+"= reading or writing, file must exist */
/* "a" = writing, append file may not exist */
/* "a+"= append + read, file may not exist */
/* "w+" = read, write, truncate. file may not exist */
must_exist = ( SDL_strchr(mode,'r') != NULL ) ? OPEN_EXISTING : 0;
truncate = ( SDL_strchr(mode,'w') != NULL ) ? CREATE_ALWAYS : 0;
r_right = ( SDL_strchr(mode,'+') != NULL || must_exist ) ? GENERIC_READ : 0;
71
72
a_mode = ( SDL_strchr(mode,'a') != NULL ) ? OPEN_ALWAYS : 0;
w_right = ( a_mode || SDL_strchr(mode,'+') || truncate ) ? GENERIC_WRITE : 0;
73
74
75
if (!r_right && !w_right) /* inconsistent mode */
return -1; /* failed (invalid call)*/
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
#ifdef _WIN32_WCE
{
size_t size = SDL_strlen(filename)+1;
wchar_t *filenameW = SDL_stack_alloc(wchar_t, size);
if ( MultiByteToWideChar(CP_UTF8, 0, filename, -1, filenameW, size) == 0 ) {
SDL_SetError("Unable to convert filename to Unicode");
SDL_stack_free(filenameW);
return -1;
}
h = CreateFile(filenameW, (w_right|r_right), (w_right)? 0 : FILE_SHARE_READ,
NULL, (must_exist|truncate|a_mode), FILE_ATTRIBUTE_NORMAL,NULL);
SDL_stack_free(filenameW);
}
#else
92
/* Do not open a dialog box if failure */
93
94
old_error_mode = SetErrorMode(SEM_NOOPENFILEERRORBOX|SEM_FAILCRITICALERRORS);
95
h = CreateFile(filename, (w_right|r_right), (w_right)? 0 : FILE_SHARE_READ,
96
NULL, (must_exist|truncate|a_mode), FILE_ATTRIBUTE_NORMAL,NULL);
98
99
/* restore old behaviour */
SetErrorMode(old_error_mode);
100
#endif /* _WIN32_WCE */
101
102
103
104
105
106
107
108
109
110
if (h==INVALID_HANDLE_VALUE) {
SDL_SetError("Couldn't open %s",filename);
return -2; /* failed (CreateFile) */
}
context->hidden.win32io.h = h;
context->hidden.win32io.append = a_mode;
return 0; /* ok */
}
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
DWORD win32whence;
int file_pos;
if (!context || context->hidden.win32io.h == INVALID_HANDLE_VALUE) {
SDL_SetError("win32_file_seek: invalid context/file not opened");
return -1;
}
switch (whence) {
case RW_SEEK_SET:
win32whence = FILE_BEGIN; break;
case RW_SEEK_CUR:
win32whence = FILE_CURRENT; break;
case RW_SEEK_END:
win32whence = FILE_END; break;
default:
SDL_SetError("win32_file_seek: Unknown value for 'whence'");
return -1;
}
file_pos = SetFilePointer(context->hidden.win32io.h,offset,NULL,win32whence);
if ( file_pos != INVALID_SET_FILE_POINTER )
return file_pos; /* success */
SDL_Error(SDL_EFSEEK);
return -1; /* error */
}
141
static int SDLCALL win32_file_read(SDL_RWops *context, void *ptr, int size, int maxnum)
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
int total_bytes;
DWORD byte_read,nread;
total_bytes = size*maxnum;
if (!context || context->hidden.win32io.h == INVALID_HANDLE_VALUE || total_bytes<=0 || !size)
return 0;
if (!ReadFile(context->hidden.win32io.h,ptr,total_bytes,&byte_read,NULL)) {
SDL_Error(SDL_EFREAD);
return 0;
}
nread = byte_read/size;
return nread;
}
159
static int SDLCALL win32_file_write(SDL_RWops *context, const void *ptr, int size, int num)
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
int total_bytes;
DWORD byte_written,nwritten;
total_bytes = size*num;
if (!context || context->hidden.win32io.h==INVALID_HANDLE_VALUE || total_bytes<=0 || !size)
return 0;
/* if in append mode, we must go to the EOF before write */
if (context->hidden.win32io.append) {
if ( SetFilePointer(context->hidden.win32io.h,0L,NULL,FILE_END) == INVALID_SET_FILE_POINTER ) {
SDL_Error(SDL_EFWRITE);
return 0;
}
}
if (!WriteFile(context->hidden.win32io.h,ptr,total_bytes,&byte_written,NULL)) {
SDL_Error(SDL_EFWRITE);
return 0;
}
nwritten = byte_written/size;
return nwritten;
}
188
189
190
191
192
193
194
195
196
197
if ( context ) {
if (context->hidden.win32io.h != INVALID_HANDLE_VALUE) {
CloseHandle(context->hidden.win32io.h);
context->hidden.win32io.h = INVALID_HANDLE_VALUE; /* to be sure */
}
SDL_FreeRW(context);
}
return(0);
}
198
#endif /* __WIN32__ */
200
#ifdef HAVE_STDIO_H
202
/* Functions to read/write stdio file pointers */
205
206
207
208
209
210
211
212
{
if ( fseek(context->hidden.stdio.fp, offset, whence) == 0 ) {
return(ftell(context->hidden.stdio.fp));
} else {
SDL_Error(SDL_EFSEEK);
return(-1);
}
}
214
215
216
217
218
219
220
221
222
{
size_t nread;
nread = fread(ptr, size, maxnum, context->hidden.stdio.fp);
if ( nread == 0 && ferror(context->hidden.stdio.fp) ) {
SDL_Error(SDL_EFREAD);
}
return(nread);
}
223
static int SDLCALL stdio_write(SDL_RWops *context, const void *ptr, int size, int num)
224
225
226
227
228
229
230
231
232
{
size_t nwrote;
nwrote = fwrite(ptr, size, num, context->hidden.stdio.fp);
if ( nwrote == 0 && ferror(context->hidden.stdio.fp) ) {
SDL_Error(SDL_EFWRITE);
}
return(nwrote);
}
234
235
236
237
238
239
240
241
242
243
{
if ( context ) {
if ( context->hidden.stdio.autoclose ) {
/* WARNING: Check the return value here! */
fclose(context->hidden.stdio.fp);
}
SDL_FreeRW(context);
}
return(0);
}
244
#endif /* !HAVE_STDIO_H */
246
247
/* Functions to read/write memory pointers */
249
250
251
252
{
Uint8 *newpos;
switch (whence) {
253
case RW_SEEK_SET:
254
255
newpos = context->hidden.mem.base+offset;
break;
256
case RW_SEEK_CUR:
257
258
newpos = context->hidden.mem.here+offset;
break;
259
case RW_SEEK_END:
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
newpos = context->hidden.mem.stop+offset;
break;
default:
SDL_SetError("Unknown value for 'whence'");
return(-1);
}
if ( newpos < context->hidden.mem.base ) {
newpos = context->hidden.mem.base;
}
if ( newpos > context->hidden.mem.stop ) {
newpos = context->hidden.mem.stop;
}
context->hidden.mem.here = newpos;
return(context->hidden.mem.here-context->hidden.mem.base);
}
276
{
277
278
size_t total_bytes;
size_t mem_available;
280
total_bytes = (maxnum * size);
281
if ( (maxnum <= 0) || (size <= 0) || ((total_bytes / maxnum) != (size_t) size) ) {
282
return 0;
283
}
284
285
286
287
288
289
mem_available = (context->hidden.mem.stop - context->hidden.mem.here);
if (total_bytes > mem_available) {
total_bytes = mem_available;
}
290
SDL_memcpy(ptr, context->hidden.mem.here, total_bytes);
291
292
293
context->hidden.mem.here += total_bytes;
return (total_bytes / size);
294
}
295
static int SDLCALL mem_write(SDL_RWops *context, const void *ptr, int size, int num)
296
297
298
299
{
if ( (context->hidden.mem.here + (num*size)) > context->hidden.mem.stop ) {
num = (context->hidden.mem.stop-context->hidden.mem.here)/size;
}
300
SDL_memcpy(context->hidden.mem.here, ptr, num*size);
301
302
303
context->hidden.mem.here += num*size;
return(num);
}
304
static int SDLCALL mem_writeconst(SDL_RWops *context, const void *ptr, int size, int num)
305
306
307
308
{
SDL_SetError("Can't write to read-only memory");
return(-1);
}
310
311
{
if ( context ) {
312
SDL_FreeRW(context);
313
314
315
316
}
return(0);
}
318
319
/* Functions to create SDL_RWops structures from various data sources */
320
#ifdef __MACOS__
321
322
323
324
325
326
/*
* translate unix-style slash-separated filename to mac-style colon-separated
* name; return malloced string
*/
static char *unix_to_mac(const char *file)
{
327
328
int flen = SDL_strlen(file);
char *path = SDL_malloc(flen + 2);
329
330
331
332
333
334
335
336
337
338
339
const char *src = file;
char *dst = path;
if(*src == '/') {
/* really depends on filesystem layout, hope for the best */
src++;
} else {
/* Check if this is a MacOS path to begin with */
if(*src != ':')
*dst++ = ':'; /* relative paths begin with ':' */
}
while(src < file + flen) {
340
const char *end = SDL_strchr(src, '/');
341
342
343
344
345
346
347
348
349
350
int len;
if(!end)
end = file + flen; /* last component */
len = end - src;
if(len == 0 || (len == 1 && src[0] == '.')) {
/* remove repeated slashes and . */
} else {
if(len == 2 && src[0] == '.' && src[1] == '.') {
/* replace .. with the empty string */
} else {
351
SDL_memcpy(dst, src, len);
352
353
354
355
356
357
358
359
360
361
dst += len;
}
if(end < file + flen)
*dst++ = ':';
}
src = end + 1;
}
*dst++ = '\0';
return path;
}
362
#endif /* __MACOS__ */
363
364
365
SDL_RWops *SDL_RWFromFile(const char *file, const char *mode)
{
366
SDL_RWops *rwops = NULL;
367
368
369
#ifdef HAVE_STDIO_H
FILE *fp = NULL;
#endif
370
371
372
373
374
if ( !file || !*file || !mode || !*mode ) {
SDL_SetError("SDL_RWFromFile(): No file or no mode specified");
return NULL;
}
375
#if defined(__WIN32__)
376
rwops = SDL_AllocRW();
377
378
if (!rwops)
return NULL; /* SDL_SetError already setup by SDL_AllocRW() */
379
380
381
382
383
384
385
386
387
388
389
rwops->hidden.win32io.h = INVALID_HANDLE_VALUE;
if (win32_file_open(rwops,file,mode)) {
SDL_FreeRW(rwops);
return NULL;
}
rwops->seek = win32_file_seek;
rwops->read = win32_file_read;
rwops->write = win32_file_write;
rwops->close = win32_file_close;
#elif HAVE_STDIO_H
391
#ifdef __MACOS__
392
393
394
{
char *mpath = unix_to_mac(file);
fp = fopen(mpath, mode);
395
SDL_free(mpath);
396
397
398
399
400
401
402
403
404
}
#else
fp = fopen(file, mode);
#endif
if ( fp == NULL ) {
SDL_SetError("Couldn't open %s", file);
} else {
rwops = SDL_RWFromFP(fp, 1);
}
405
406
#else
SDL_SetError("SDL not compiled with stdio support");
407
#endif /* !HAVE_STDIO_H */
409
410
411
return(rwops);
}
412
#ifdef HAVE_STDIO_H
413
414
SDL_RWops *SDL_RWFromFP(FILE *fp, int autoclose)
{
415
SDL_RWops *rwops = NULL;
416
417
418
419
420
421
422
423
424
425
426
427
rwops = SDL_AllocRW();
if ( rwops != NULL ) {
rwops->seek = stdio_seek;
rwops->read = stdio_read;
rwops->write = stdio_write;
rwops->close = stdio_close;
rwops->hidden.stdio.fp = fp;
rwops->hidden.stdio.autoclose = autoclose;
}
return(rwops);
}
428
#endif /* HAVE_STDIO_H */
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
SDL_RWops *SDL_RWFromMem(void *mem, int size)
{
SDL_RWops *rwops;
rwops = SDL_AllocRW();
if ( rwops != NULL ) {
rwops->seek = mem_seek;
rwops->read = mem_read;
rwops->write = mem_write;
rwops->close = mem_close;
rwops->hidden.mem.base = (Uint8 *)mem;
rwops->hidden.mem.here = rwops->hidden.mem.base;
rwops->hidden.mem.stop = rwops->hidden.mem.base+size;
}
return(rwops);
}
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
SDL_RWops *SDL_RWFromConstMem(const void *mem, int size)
{
SDL_RWops *rwops;
rwops = SDL_AllocRW();
if ( rwops != NULL ) {
rwops->seek = mem_seek;
rwops->read = mem_read;
rwops->write = mem_writeconst;
rwops->close = mem_close;
rwops->hidden.mem.base = (Uint8 *)mem;
rwops->hidden.mem.here = rwops->hidden.mem.base;
rwops->hidden.mem.stop = rwops->hidden.mem.base+size;
}
return(rwops);
}
464
465
466
467
SDL_RWops *SDL_AllocRW(void)
{
SDL_RWops *area;
468
area = (SDL_RWops *)SDL_malloc(sizeof *area);
469
470
471
472
473
474
475
476
if ( area == NULL ) {
SDL_OutOfMemory();
}
return(area);
}
void SDL_FreeRW(SDL_RWops *area)
{
477
SDL_free(area);
478
}
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
/* Functions for dynamically reading and writing endian-specific values */
Uint16 SDL_ReadLE16 (SDL_RWops *src)
{
Uint16 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapLE16(value));
}
Uint16 SDL_ReadBE16 (SDL_RWops *src)
{
Uint16 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapBE16(value));
}
Uint32 SDL_ReadLE32 (SDL_RWops *src)
{
Uint32 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapLE32(value));
}
Uint32 SDL_ReadBE32 (SDL_RWops *src)
{
Uint32 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapBE32(value));
}
Uint64 SDL_ReadLE64 (SDL_RWops *src)
{
Uint64 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapLE64(value));
}
Uint64 SDL_ReadBE64 (SDL_RWops *src)
{
Uint64 value;
SDL_RWread(src, &value, (sizeof value), 1);
return(SDL_SwapBE64(value));
}
int SDL_WriteLE16 (SDL_RWops *dst, Uint16 value)
{
value = SDL_SwapLE16(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}
int SDL_WriteBE16 (SDL_RWops *dst, Uint16 value)
{
value = SDL_SwapBE16(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}
int SDL_WriteLE32 (SDL_RWops *dst, Uint32 value)
{
value = SDL_SwapLE32(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}
int SDL_WriteBE32 (SDL_RWops *dst, Uint32 value)
{
value = SDL_SwapBE32(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}
int SDL_WriteLE64 (SDL_RWops *dst, Uint64 value)
{
value = SDL_SwapLE64(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}
int SDL_WriteBE64 (SDL_RWops *dst, Uint64 value)
{
value = SDL_SwapBE64(value);
return(SDL_RWwrite(dst, &value, (sizeof value), 1));
}