/
SDL_rwops.c
613 lines (531 loc) · 16.2 KB
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.
14
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"
30
31
32
#if defined(__WIN32__) && !defined(__SYMBIAN32__)
33
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*/
38
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
47
#define READAHEAD_BUFFER_SIZE 1024
48
static int SDLCALL win32_file_open(SDL_RWops *context, const char *filename, const char *mode)
49
50
{
#ifndef _WIN32_WCE
51
UINT old_error_mode;
52
#endif
53
54
55
56
57
HANDLE h;
DWORD r_right, w_right;
DWORD must_exist, truncate;
int a_mode;
58
if (!context)
59
60
61
return -1;
context->hidden.win32io.h = INVALID_HANDLE_VALUE; /* mark this as unusable */
62
context->hidden.win32io.buffer.data = NULL;
63
64
65
context->hidden.win32io.buffer.size = 0;
context->hidden.win32io.buffer.left = 0;
66
67
68
69
70
71
72
73
74
75
/* "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;
76
77
a_mode = ( SDL_strchr(mode,'a') != NULL ) ? OPEN_ALWAYS : 0;
w_right = ( a_mode || SDL_strchr(mode,'+') || truncate ) ? GENERIC_WRITE : 0;
78
79
80
if (!r_right && !w_right) /* inconsistent mode */
return -1; /* failed (invalid call)*/
81
82
83
84
85
86
87
context->hidden.win32io.buffer.data = (char *)SDL_malloc(READAHEAD_BUFFER_SIZE);
if (!context->hidden.win32io.buffer.data) {
SDL_OutOfMemory();
return -1;
}
88
89
90
91
92
93
94
95
#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);
96
97
SDL_free(context->hidden.win32io.buffer.data);
context->hidden.win32io.buffer.data = NULL;
98
99
100
101
102
103
104
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
105
/* Do not open a dialog box if failure */
106
107
old_error_mode = SetErrorMode(SEM_NOOPENFILEERRORBOX|SEM_FAILCRITICALERRORS);
108
h = CreateFile(filename, (w_right|r_right), (w_right)? 0 : FILE_SHARE_READ,
109
NULL, (must_exist|truncate|a_mode), FILE_ATTRIBUTE_NORMAL,NULL);
110
111
112
/* restore old behaviour */
SetErrorMode(old_error_mode);
113
#endif /* _WIN32_WCE */
114
115
116
if (h==INVALID_HANDLE_VALUE) {
SDL_SetError("Couldn't open %s",filename);
117
118
SDL_free(context->hidden.win32io.buffer.data);
context->hidden.win32io.buffer.data = NULL;
119
120
121
122
return -2; /* failed (CreateFile) */
}
context->hidden.win32io.h = h;
context->hidden.win32io.append = a_mode;
123
124
125
return 0; /* ok */
}
126
static int SDLCALL win32_file_seek(SDL_RWops *context, int offset, int whence)
127
{
128
129
130
131
132
133
134
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;
}
135
136
137
138
139
140
141
/* FIXME: We may be able to satisfy the seek within buffered data */
if (whence == RW_SEEK_CUR && context->hidden.win32io.buffer.left) {
offset -= context->hidden.win32io.buffer.left;
}
context->hidden.win32io.buffer.left = 0;
142
143
144
145
146
147
148
149
150
151
152
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;
}
153
154
155
156
157
158
159
160
161
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 */
}
162
static int SDLCALL win32_file_read(SDL_RWops *context, void *ptr, int size, int maxnum)
163
{
164
165
166
167
int total_need;
int total_read = 0;
int read_ahead;
DWORD byte_read;
168
169
total_need = size*maxnum;
170
171
if (!context || context->hidden.win32io.h == INVALID_HANDLE_VALUE || total_need<=0 || !size)
172
return 0;
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
if (context->hidden.win32io.buffer.left > 0) {
void *data = (char *)context->hidden.win32io.buffer.data +
context->hidden.win32io.buffer.size -
context->hidden.win32io.buffer.left;
read_ahead = SDL_min(total_need, context->hidden.win32io.buffer.left);
SDL_memcpy(ptr, data, read_ahead);
context->hidden.win32io.buffer.left -= read_ahead;
if (read_ahead == total_need) {
return maxnum;
}
ptr = (char *)ptr + read_ahead;
total_need -= read_ahead;
total_read += read_ahead;
}
if (total_need < READAHEAD_BUFFER_SIZE) {
if (!ReadFile(context->hidden.win32io.h,context->hidden.win32io.buffer.data,READAHEAD_BUFFER_SIZE,&byte_read,NULL)) {
SDL_Error(SDL_EFREAD);
return 0;
}
195
read_ahead = SDL_min(total_need, (int)byte_read);
196
197
198
199
200
201
202
203
204
205
206
207
SDL_memcpy(ptr, context->hidden.win32io.buffer.data, read_ahead);
context->hidden.win32io.buffer.size = byte_read;
context->hidden.win32io.buffer.left = byte_read-read_ahead;
total_read += read_ahead;
} else {
if (!ReadFile(context->hidden.win32io.h,ptr,total_need,&byte_read,NULL)) {
SDL_Error(SDL_EFREAD);
return 0;
}
total_read += byte_read;
}
return (total_read/size);
208
}
209
static int SDLCALL win32_file_write(SDL_RWops *context, const void *ptr, int size, int num)
210
{
211
212
213
214
215
216
217
218
219
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;
220
221
222
223
224
if (context->hidden.win32io.buffer.left) {
SetFilePointer(context->hidden.win32io.h,-context->hidden.win32io.buffer.left,NULL,FILE_CURRENT);
context->hidden.win32io.buffer.left = 0;
}
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/* 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;
}
241
static int SDLCALL win32_file_close(SDL_RWops *context)
242
{
243
244
245
246
247
248
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 */
}
249
250
251
252
if (context->hidden.win32io.buffer.data) {
SDL_free(context->hidden.win32io.buffer.data);
context->hidden.win32io.buffer.data = NULL;
}
253
254
255
256
SDL_FreeRW(context);
}
return(0);
}
257
#endif /* __WIN32__ */
258
259
#ifdef HAVE_STDIO_H
260
261
/* Functions to read/write stdio file pointers */
262
263
static int SDLCALL stdio_seek(SDL_RWops *context, int offset, int whence)
264
265
266
267
268
269
270
271
{
if ( fseek(context->hidden.stdio.fp, offset, whence) == 0 ) {
return(ftell(context->hidden.stdio.fp));
} else {
SDL_Error(SDL_EFSEEK);
return(-1);
}
}
272
static int SDLCALL stdio_read(SDL_RWops *context, void *ptr, int size, int maxnum)
273
274
275
276
277
278
279
280
281
{
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);
}
282
static int SDLCALL stdio_write(SDL_RWops *context, const void *ptr, int size, int num)
283
284
285
286
287
288
289
290
291
{
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);
}
292
static int SDLCALL stdio_close(SDL_RWops *context)
293
294
295
296
297
298
299
300
301
302
{
if ( context ) {
if ( context->hidden.stdio.autoclose ) {
/* WARNING: Check the return value here! */
fclose(context->hidden.stdio.fp);
}
SDL_FreeRW(context);
}
return(0);
}
303
#endif /* !HAVE_STDIO_H */
304
305
306
/* Functions to read/write memory pointers */
307
static int SDLCALL mem_seek(SDL_RWops *context, int offset, int whence)
308
309
310
311
{
Uint8 *newpos;
switch (whence) {
312
case RW_SEEK_SET:
313
314
newpos = context->hidden.mem.base+offset;
break;
315
case RW_SEEK_CUR:
316
317
newpos = context->hidden.mem.here+offset;
break;
318
case RW_SEEK_END:
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
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);
}
334
static int SDLCALL mem_read(SDL_RWops *context, void *ptr, int size, int maxnum)
335
{
336
337
size_t total_bytes;
size_t mem_available;
338
339
total_bytes = (maxnum * size);
340
if ( (maxnum <= 0) || (size <= 0) || ((total_bytes / maxnum) != (size_t) size) ) {
341
return 0;
342
}
343
344
345
346
347
348
mem_available = (context->hidden.mem.stop - context->hidden.mem.here);
if (total_bytes > mem_available) {
total_bytes = mem_available;
}
349
SDL_memcpy(ptr, context->hidden.mem.here, total_bytes);
350
351
352
context->hidden.mem.here += total_bytes;
return (total_bytes / size);
353
}
354
static int SDLCALL mem_write(SDL_RWops *context, const void *ptr, int size, int num)
355
356
357
358
{
if ( (context->hidden.mem.here + (num*size)) > context->hidden.mem.stop ) {
num = (context->hidden.mem.stop-context->hidden.mem.here)/size;
}
359
SDL_memcpy(context->hidden.mem.here, ptr, num*size);
360
361
362
context->hidden.mem.here += num*size;
return(num);
}
363
static int SDLCALL mem_writeconst(SDL_RWops *context, const void *ptr, int size, int num)
364
365
366
367
{
SDL_SetError("Can't write to read-only memory");
return(-1);
}
368
static int SDLCALL mem_close(SDL_RWops *context)
369
370
{
if ( context ) {
371
SDL_FreeRW(context);
372
373
374
375
}
return(0);
}
376
377
378
/* Functions to create SDL_RWops structures from various data sources */
379
#ifdef __MACOS__
380
381
382
383
384
385
/*
* translate unix-style slash-separated filename to mac-style colon-separated
* name; return malloced string
*/
static char *unix_to_mac(const char *file)
{
386
387
int flen = SDL_strlen(file);
char *path = SDL_malloc(flen + 2);
388
389
390
391
392
393
394
395
396
397
398
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) {
399
const char *end = SDL_strchr(src, '/');
400
401
402
403
404
405
406
407
408
409
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 {
410
SDL_memcpy(dst, src, len);
411
412
413
414
415
416
417
418
419
420
dst += len;
}
if(end < file + flen)
*dst++ = ':';
}
src = end + 1;
}
*dst++ = '\0';
return path;
}
421
#endif /* __MACOS__ */
422
423
424
SDL_RWops *SDL_RWFromFile(const char *file, const char *mode)
{
425
SDL_RWops *rwops = NULL;
426
427
428
#ifdef HAVE_STDIO_H
FILE *fp = NULL;
#endif
429
430
431
432
433
if ( !file || !*file || !mode || !*mode ) {
SDL_SetError("SDL_RWFromFile(): No file or no mode specified");
return NULL;
}
434
#if defined(__WIN32__) && !defined(__SYMBIAN32__)
435
rwops = SDL_AllocRW();
436
437
if (!rwops)
return NULL; /* SDL_SetError already setup by SDL_AllocRW() */
438
439
440
441
442
443
444
445
446
447
448
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
449
450
#ifdef __MACOS__
451
452
453
{
char *mpath = unix_to_mac(file);
fp = fopen(mpath, mode);
454
SDL_free(mpath);
455
456
457
458
459
460
461
462
463
}
#else
fp = fopen(file, mode);
#endif
if ( fp == NULL ) {
SDL_SetError("Couldn't open %s", file);
} else {
rwops = SDL_RWFromFP(fp, 1);
}
464
465
#else
SDL_SetError("SDL not compiled with stdio support");
466
#endif /* !HAVE_STDIO_H */
467
468
469
470
return(rwops);
}
471
#ifdef HAVE_STDIO_H
472
473
SDL_RWops *SDL_RWFromFP(FILE *fp, int autoclose)
{
474
SDL_RWops *rwops = NULL;
475
476
477
478
479
480
481
482
483
484
485
486
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);
}
487
#endif /* HAVE_STDIO_H */
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
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);
}
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
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);
}
523
524
525
526
SDL_RWops *SDL_AllocRW(void)
{
SDL_RWops *area;
527
area = (SDL_RWops *)SDL_malloc(sizeof *area);
528
529
530
531
532
533
534
535
if ( area == NULL ) {
SDL_OutOfMemory();
}
return(area);
}
void SDL_FreeRW(SDL_RWops *area)
{
536
SDL_free(area);
537
}
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
/* 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));
}