Skip to content

Latest commit

 

History

History
517 lines (441 loc) · 12.7 KB

SDL_rwops.c

File metadata and controls

517 lines (441 loc) · 12.7 KB
 
Apr 26, 2001
Apr 26, 2001
1
2
/*
SDL - Simple DirectMedia Layer
Feb 1, 2006
Feb 1, 2006
3
Copyright (C) 1997-2006 Sam Lantinga
Apr 26, 2001
Apr 26, 2001
4
5
This library is free software; you can redistribute it and/or
Feb 1, 2006
Feb 1, 2006
6
modify it under the terms of the GNU Lesser General Public
Apr 26, 2001
Apr 26, 2001
7
License as published by the Free Software Foundation; either
Feb 1, 2006
Feb 1, 2006
8
version 2.1 of the License, or (at your option) any later version.
Apr 26, 2001
Apr 26, 2001
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
Feb 1, 2006
Feb 1, 2006
13
Lesser General Public License for more details.
Apr 26, 2001
Apr 26, 2001
14
Feb 1, 2006
Feb 1, 2006
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
Apr 26, 2001
Apr 26, 2001
18
19
Sam Lantinga
Dec 14, 2001
Dec 14, 2001
20
slouken@libsdl.org
Apr 26, 2001
Apr 26, 2001
21
*/
Feb 21, 2006
Feb 21, 2006
22
#include "SDL_config.h"
Apr 26, 2001
Apr 26, 2001
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.
*/
Feb 9, 2006
Feb 9, 2006
28
#include "SDL_endian.h"
Feb 7, 2006
Feb 7, 2006
29
#include "SDL_rwops.h"
Feb 6, 2006
Feb 6, 2006
30
Feb 9, 2006
Feb 9, 2006
31
Feb 27, 2006
Feb 27, 2006
32
#ifdef __WIN32__
Apr 26, 2001
Apr 26, 2001
33
Feb 27, 2006
Feb 27, 2006
34
/* Functions to read/write Win32 API file pointers */
Apr 26, 2001
Apr 26, 2001
35
Feb 27, 2006
Feb 27, 2006
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
#define WINDOWS_LEAN_AND_MEAN
#include <windows.h>
static int win32_file_open(SDL_RWops *context, const char *filename, const char *mode) {
UINT old_error_mode;
HANDLE h;
DWORD r_right, w_right;
DWORD must_exist, truncate;
int a_mode;
if (!context || !filename || !mode)
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;
a_mode = ( SDL_strchr(mode,'a') != NULL );
w_right = ( a_mode || SDL_strchr(mode,'w') || truncate ) ? GENERIC_WRITE : 0;
if (!r_right && !w_right) /* inconsistent mode */
return -1; /* failed (invalid call)*/
/* Do not open a dialog box if failure */
old_error_mode = SetErrorMode(SEM_NOOPENFILEERRORBOX|SEM_FAILCRITICALERRORS);
h = CreateFile(filename, (w_right|r_right), (w_right)? 0 : FILE_SHARE_READ,
NULL, (must_exist|truncate), FILE_ATTRIBUTE_NORMAL,NULL);
/* restore old behaviour */
SetErrorMode(old_error_mode);
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 */
}
static int win32_file_seek(SDL_RWops *context, int offset, int whence) {
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 */
}
static int win32_file_read(SDL_RWops *context, void *ptr, int size, int maxnum) {
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;
}
static int win32_file_write(SDL_RWops *context, const void *ptr, int size, int num) {
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;
}
static int win32_file_close(SDL_RWops *context) {
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);
}
Feb 27, 2006
Feb 27, 2006
169
#endif /* __WIN32__ */
Feb 27, 2006
Feb 27, 2006
170
Feb 27, 2006
Feb 27, 2006
171
#ifdef HAVE_STDIO_H
Feb 27, 2006
Feb 27, 2006
172
Feb 27, 2006
Feb 27, 2006
173
/* Functions to read/write stdio file pointers */
Feb 27, 2006
Feb 27, 2006
174
Feb 27, 2006
Feb 27, 2006
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
static int stdio_seek(SDL_RWops *context, int offset, int whence)
{
if ( fseek(context->hidden.stdio.fp, offset, whence) == 0 ) {
return(ftell(context->hidden.stdio.fp));
} else {
SDL_Error(SDL_EFSEEK);
return(-1);
}
}
static int stdio_read(SDL_RWops *context, void *ptr, int size, int maxnum)
{
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);
}
static int stdio_write(SDL_RWops *context, const void *ptr, int size, int num)
{
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);
}
static int stdio_close(SDL_RWops *context)
{
if ( context ) {
if ( context->hidden.stdio.autoclose ) {
/* WARNING: Check the return value here! */
fclose(context->hidden.stdio.fp);
}
SDL_FreeRW(context);
}
return(0);
}
Feb 27, 2006
Feb 27, 2006
215
#endif /* !HAVE_STDIO_H */
Feb 6, 2006
Feb 6, 2006
216
Apr 26, 2001
Apr 26, 2001
217
218
219
220
221
222
223
/* Functions to read/write memory pointers */
static int mem_seek(SDL_RWops *context, int offset, int whence)
{
Uint8 *newpos;
switch (whence) {
Feb 6, 2006
Feb 6, 2006
224
case RW_SEEK_SET:
Apr 26, 2001
Apr 26, 2001
225
226
newpos = context->hidden.mem.base+offset;
break;
Feb 6, 2006
Feb 6, 2006
227
case RW_SEEK_CUR:
Apr 26, 2001
Apr 26, 2001
228
229
newpos = context->hidden.mem.here+offset;
break;
Feb 6, 2006
Feb 6, 2006
230
case RW_SEEK_END:
Apr 26, 2001
Apr 26, 2001
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
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);
}
static int mem_read(SDL_RWops *context, void *ptr, int size, int maxnum)
{
Jun 24, 2005
Jun 24, 2005
248
249
int total_bytes;
int mem_available;
Apr 26, 2001
Apr 26, 2001
250
Jun 24, 2005
Jun 24, 2005
251
252
253
total_bytes = (maxnum * size);
if ( (maxnum <= 0) || (size <= 0) || ((total_bytes / maxnum) != size) ) {
return 0;
Apr 26, 2001
Apr 26, 2001
254
}
Jun 24, 2005
Jun 24, 2005
255
256
257
258
259
260
mem_available = (context->hidden.mem.stop - context->hidden.mem.here);
if (total_bytes > mem_available) {
total_bytes = mem_available;
}
Feb 7, 2006
Feb 7, 2006
261
SDL_memcpy(ptr, context->hidden.mem.here, total_bytes);
Jun 24, 2005
Jun 24, 2005
262
263
264
context->hidden.mem.here += total_bytes;
return (total_bytes / size);
Apr 26, 2001
Apr 26, 2001
265
266
267
268
269
270
}
static int mem_write(SDL_RWops *context, const void *ptr, int size, int num)
{
if ( (context->hidden.mem.here + (num*size)) > context->hidden.mem.stop ) {
num = (context->hidden.mem.stop-context->hidden.mem.here)/size;
}
Feb 7, 2006
Feb 7, 2006
271
SDL_memcpy(context->hidden.mem.here, ptr, num*size);
Apr 26, 2001
Apr 26, 2001
272
273
274
context->hidden.mem.here += num*size;
return(num);
}
Jan 4, 2004
Jan 4, 2004
275
276
277
278
279
static int mem_writeconst(SDL_RWops *context, const void *ptr, int size, int num)
{
SDL_SetError("Can't write to read-only memory");
return(-1);
}
Apr 26, 2001
Apr 26, 2001
280
281
282
static int mem_close(SDL_RWops *context)
{
if ( context ) {
Dec 12, 2005
Dec 12, 2005
283
SDL_FreeRW(context);
Apr 26, 2001
Apr 26, 2001
284
285
286
287
}
return(0);
}
Feb 27, 2006
Feb 27, 2006
288
Apr 26, 2001
Apr 26, 2001
289
290
/* Functions to create SDL_RWops structures from various data sources */
Feb 21, 2006
Feb 21, 2006
291
#ifdef __MACOS__
Apr 26, 2001
Apr 26, 2001
292
293
294
295
296
297
/*
* translate unix-style slash-separated filename to mac-style colon-separated
* name; return malloced string
*/
static char *unix_to_mac(const char *file)
{
Feb 7, 2006
Feb 7, 2006
298
299
int flen = SDL_strlen(file);
char *path = SDL_malloc(flen + 2);
Apr 26, 2001
Apr 26, 2001
300
301
302
303
304
305
306
307
308
309
310
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) {
Feb 7, 2006
Feb 7, 2006
311
const char *end = SDL_strchr(src, '/');
Apr 26, 2001
Apr 26, 2001
312
313
314
315
316
317
318
319
320
321
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 {
Feb 7, 2006
Feb 7, 2006
322
SDL_memcpy(dst, src, len);
Apr 26, 2001
Apr 26, 2001
323
324
325
326
327
328
329
330
331
332
dst += len;
}
if(end < file + flen)
*dst++ = ':';
}
src = end + 1;
}
*dst++ = '\0';
return path;
}
Feb 21, 2006
Feb 21, 2006
333
#endif /* __MACOS__ */
Apr 26, 2001
Apr 26, 2001
334
335
336
SDL_RWops *SDL_RWFromFile(const char *file, const char *mode)
{
Feb 6, 2006
Feb 6, 2006
337
SDL_RWops *rwops = NULL;
Feb 27, 2006
Feb 27, 2006
338
339
340
341
342
343
344
345
346
347
348
349
350
351
#ifdef __WIN32__
rwops = SDL_AllocRW();
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
Apr 26, 2001
Apr 26, 2001
352
353
FILE *fp;
Feb 21, 2006
Feb 21, 2006
354
#ifdef __MACOS__
Apr 26, 2001
Apr 26, 2001
355
356
357
{
char *mpath = unix_to_mac(file);
fp = fopen(mpath, mode);
Feb 7, 2006
Feb 7, 2006
358
SDL_free(mpath);
Apr 26, 2001
Apr 26, 2001
359
360
361
362
363
364
365
366
367
}
#else
fp = fopen(file, mode);
#endif
if ( fp == NULL ) {
SDL_SetError("Couldn't open %s", file);
} else {
rwops = SDL_RWFromFP(fp, 1);
}
Feb 27, 2006
Feb 27, 2006
368
369
#else
SDL_SetError("SDL not compiled with stdio support");
Feb 27, 2006
Feb 27, 2006
370
#endif /* !HAVE_STDIO_H */
Feb 27, 2006
Feb 27, 2006
371
Apr 26, 2001
Apr 26, 2001
372
373
374
return(rwops);
}
Feb 6, 2006
Feb 6, 2006
375
#ifdef HAVE_STDIO_H
Apr 26, 2001
Apr 26, 2001
376
377
SDL_RWops *SDL_RWFromFP(FILE *fp, int autoclose)
{
Feb 6, 2006
Feb 6, 2006
378
SDL_RWops *rwops = NULL;
Apr 26, 2001
Apr 26, 2001
379
380
381
382
383
384
385
386
387
388
389
390
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);
}
Feb 6, 2006
Feb 6, 2006
391
#endif /* HAVE_STDIO_H */
Apr 26, 2001
Apr 26, 2001
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
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);
}
Jan 4, 2004
Jan 4, 2004
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
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);
}
Apr 26, 2001
Apr 26, 2001
427
428
429
430
SDL_RWops *SDL_AllocRW(void)
{
SDL_RWops *area;
Feb 7, 2006
Feb 7, 2006
431
area = (SDL_RWops *)SDL_malloc(sizeof *area);
Apr 26, 2001
Apr 26, 2001
432
433
434
435
436
437
438
439
if ( area == NULL ) {
SDL_OutOfMemory();
}
return(area);
}
void SDL_FreeRW(SDL_RWops *area)
{
Feb 7, 2006
Feb 7, 2006
440
SDL_free(area);
Apr 26, 2001
Apr 26, 2001
441
}
Feb 9, 2006
Feb 9, 2006
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
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
/* 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));
}