Mercurial > sdl-ios-xcode
annotate include/SDL_rwops.h @ 4266:62849663f20a SDL-1.2
Removed duplicate memset() calls.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Tue, 29 Sep 2009 13:40:34 +0000 |
| parents | 4c4113c2162c |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 10 This library is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 4217 | 23 /** @file SDL_rwops.h |
| 24 * This file provides a general interface for SDL to read and write | |
| 25 * data sources. It can easily be extended to files, memory, etc. | |
| 26 */ | |
| 0 | 27 |
|
1402
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
28 #ifndef _SDL_rwops_h |
|
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
29 #define _SDL_rwops_h |
| 0 | 30 |
|
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
31 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
32 #include "SDL_error.h" |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
33 |
| 0 | 34 #include "begin_code.h" |
| 35 /* Set up for C function definitions, even when using C++ */ | |
| 36 #ifdef __cplusplus | |
| 37 extern "C" { | |
| 38 #endif | |
| 39 | |
| 4217 | 40 /** This is the read/write operation structure -- very basic */ |
| 0 | 41 |
| 42 typedef struct SDL_RWops { | |
| 4217 | 43 /** Seek to 'offset' relative to whence, one of stdio's whence values: |
| 44 * SEEK_SET, SEEK_CUR, SEEK_END | |
| 45 * Returns the final offset in the data source. | |
| 0 | 46 */ |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
47 int (SDLCALL *seek)(struct SDL_RWops *context, int offset, int whence); |
| 0 | 48 |
| 4217 | 49 /** Read up to 'maxnum' objects each of size 'size' from the data |
| 50 * source to the area pointed at by 'ptr'. | |
| 51 * Returns the number of objects read, or -1 if the read failed. | |
| 0 | 52 */ |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
53 int (SDLCALL *read)(struct SDL_RWops *context, void *ptr, int size, int maxnum); |
| 0 | 54 |
| 4217 | 55 /** Write exactly 'num' objects each of size 'objsize' from the area |
| 56 * pointed at by 'ptr' to data source. | |
| 57 * Returns 'num', or -1 if the write failed. | |
| 0 | 58 */ |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
59 int (SDLCALL *write)(struct SDL_RWops *context, const void *ptr, int size, int num); |
| 0 | 60 |
| 4217 | 61 /** Close and free an allocated SDL_FSops structure */ |
|
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
62 int (SDLCALL *close)(struct SDL_RWops *context); |
| 0 | 63 |
| 64 Uint32 type; | |
| 65 union { | |
|
4026
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
66 #if defined(__WIN32__) && !defined(__SYMBIAN32__) |
|
1449
d7d96c87b6a6
Did I mention I'm anal? :) Fixed spacing in SDL_rwops.h
Sam Lantinga <slouken@libsdl.org>
parents:
1447
diff
changeset
|
67 struct { |
|
4026
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
68 int append; |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
69 void *h; |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
70 struct { |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
71 void *data; |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
72 int size; |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
73 int left; |
|
255b0469ca83
Added read-ahead support for Win32 file IO
Sam Lantinga <slouken@libsdl.org>
parents:
1453
diff
changeset
|
74 } buffer; |
|
1449
d7d96c87b6a6
Did I mention I'm anal? :) Fixed spacing in SDL_rwops.h
Sam Lantinga <slouken@libsdl.org>
parents:
1447
diff
changeset
|
75 } win32io; |
|
1447
515df0086eb7
Prefer the raw Win32 API over stdio for file RWops
Sam Lantinga <slouken@libsdl.org>
parents:
1446
diff
changeset
|
76 #endif |
|
1446
47bf1767c4ca
Date: Mon, 27 Feb 2006 02:17:29 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
1402
diff
changeset
|
77 #ifdef HAVE_STDIO_H |
| 0 | 78 struct { |
| 79 int autoclose; | |
| 80 FILE *fp; | |
| 81 } stdio; | |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
82 #endif |
| 0 | 83 struct { |
| 84 Uint8 *base; | |
| 85 Uint8 *here; | |
| 86 Uint8 *stop; | |
| 87 } mem; | |
| 88 struct { | |
| 89 void *data1; | |
| 90 } unknown; | |
| 91 } hidden; | |
| 92 | |
| 93 } SDL_RWops; | |
| 94 | |
| 95 | |
| 4217 | 96 /** @name Functions to create SDL_RWops structures from various data sources */ |
| 97 /*@{*/ | |
| 0 | 98 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
99 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char *file, const char *mode); |
| 0 | 100 |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
101 #ifdef HAVE_STDIO_H |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
102 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFP(FILE *fp, int autoclose); |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
103 #endif |
| 0 | 104 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
105 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromMem(void *mem, int size); |
|
764
974c0fb74bf8
Added function to create RWops from const memory: SDL_RWFromConstMem()
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
106 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size); |
| 0 | 107 |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
108 extern DECLSPEC SDL_RWops * SDLCALL SDL_AllocRW(void); |
|
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
109 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area); |
| 0 | 110 |
| 4217 | 111 /*@}*/ |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
112 |
| 4217 | 113 /** @name Seek Reference Points */ |
| 114 /*@{*/ | |
| 115 #define RW_SEEK_SET 0 /**< Seek from the beginning of data */ | |
| 116 #define RW_SEEK_CUR 1 /**< Seek relative to current read point */ | |
| 117 #define RW_SEEK_END 2 /**< Seek relative to the end of data */ | |
| 118 /*@}*/ | |
| 119 | |
| 120 /** @name Macros to easily read and write from an SDL_RWops structure */ | |
| 121 /*@{*/ | |
| 0 | 122 #define SDL_RWseek(ctx, offset, whence) (ctx)->seek(ctx, offset, whence) |
|
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
123 #define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, RW_SEEK_CUR) |
| 0 | 124 #define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n) |
| 125 #define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n) | |
| 126 #define SDL_RWclose(ctx) (ctx)->close(ctx) | |
| 4217 | 127 /*@}*/ |
| 0 | 128 |
| 4217 | 129 /** @name Read an item of the specified endianness and return in native format */ |
| 130 /*@{*/ | |
|
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
131 extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops *src); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
132 extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops *src); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
133 extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops *src); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
134 extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops *src); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
135 extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops *src); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
136 extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops *src); |
| 4217 | 137 /*@}*/ |
|
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
138 |
| 4217 | 139 /** @name Write an item of native format to the specified endianness */ |
| 140 /*@{*/ | |
|
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
141 extern DECLSPEC int SDLCALL SDL_WriteLE16(SDL_RWops *dst, Uint16 value); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
142 extern DECLSPEC int SDLCALL SDL_WriteBE16(SDL_RWops *dst, Uint16 value); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
143 extern DECLSPEC int SDLCALL SDL_WriteLE32(SDL_RWops *dst, Uint32 value); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
144 extern DECLSPEC int SDLCALL SDL_WriteBE32(SDL_RWops *dst, Uint32 value); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
145 extern DECLSPEC int SDLCALL SDL_WriteLE64(SDL_RWops *dst, Uint64 value); |
|
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
146 extern DECLSPEC int SDLCALL SDL_WriteBE64(SDL_RWops *dst, Uint64 value); |
| 4217 | 147 /*@}*/ |
|
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
148 |
| 0 | 149 /* Ends C function definitions when using C++ */ |
| 150 #ifdef __cplusplus | |
| 151 } | |
| 152 #endif | |
| 153 #include "close_code.h" | |
| 154 | |
|
1402
d910939febfa
Use consistent identifiers for the various platforms we support.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
155 #endif /* _SDL_rwops_h */ |