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