Mercurial > sdl-ios-xcode
annotate include/SDL_rwops.h @ 1363:dc623bb58c9a
Fixed building with cygwin
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Thu, 16 Feb 2006 20:17:43 +0000 |
parents | c71e05b4dc2e |
children | d910939febfa |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
930
diff
changeset
|
3 Copyright (C) 1997-2006 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 | |
23 /* This file provides a general interface for SDL to read and write | |
24 data sources. It can easily be extended to files, memory, etc. | |
25 */ | |
26 | |
27 #ifndef _SDL_RWops_h | |
28 #define _SDL_RWops_h | |
29 | |
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
30 #include "SDL_stdinc.h" |
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
31 #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
|
32 |
0 | 33 #include "begin_code.h" |
34 /* Set up for C function definitions, even when using C++ */ | |
35 #ifdef __cplusplus | |
36 extern "C" { | |
37 #endif | |
38 | |
39 /* This is the read/write operation structure -- very basic */ | |
40 | |
41 typedef struct SDL_RWops { | |
42 /* Seek to 'offset' relative to whence, one of stdio's whence values: | |
43 SEEK_SET, SEEK_CUR, SEEK_END | |
44 Returns the final offset in the data source. | |
45 */ | |
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
46 int (SDLCALL *seek)(struct SDL_RWops *context, int offset, int whence); |
0 | 47 |
48 /* Read up to 'num' objects each of size 'objsize' from the data | |
49 source to the area pointed at by 'ptr'. | |
50 Returns the number of objects read, or -1 if the read failed. | |
51 */ | |
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
52 int (SDLCALL *read)(struct SDL_RWops *context, void *ptr, int size, int maxnum); |
0 | 53 |
54 /* Write exactly 'num' objects each of size 'objsize' from the area | |
55 pointed at by 'ptr' to data source. | |
56 Returns 'num', or -1 if the write failed. | |
57 */ | |
930
02759105b989
Date: Fri, 20 Aug 2004 08:31:20 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
58 int (SDLCALL *write)(struct SDL_RWops *context, const void *ptr, int size, int num); |
0 | 59 |
60 /* 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
|
61 int (SDLCALL *close)(struct SDL_RWops *context); |
0 | 62 |
63 Uint32 type; | |
64 union { | |
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
|
65 #ifdef HAVE_STDIO_H |
0 | 66 struct { |
67 int autoclose; | |
68 FILE *fp; | |
69 } 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
|
70 #endif |
0 | 71 struct { |
72 Uint8 *base; | |
73 Uint8 *here; | |
74 Uint8 *stop; | |
75 } mem; | |
76 struct { | |
77 void *data1; | |
78 } unknown; | |
79 } hidden; | |
80 | |
81 } SDL_RWops; | |
82 | |
83 | |
84 /* Functions to create SDL_RWops structures from various data sources */ | |
85 | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
86 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char *file, const char *mode); |
0 | 87 |
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
|
88 #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
|
89 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
|
90 #endif |
0 | 91 |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
92 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
|
93 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size); |
0 | 94 |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
95 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
|
96 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area); |
0 | 97 |
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
|
98 #define RW_SEEK_SET 0 /* Seek from the beginning of data */ |
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
|
99 #define RW_SEEK_CUR 1 /* Seek relative to current read point */ |
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
|
100 #define RW_SEEK_END 2 /* Seek relative to the end of data */ |
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 |
0 | 102 /* Macros to easily read and write from an SDL_RWops structure */ |
103 #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
|
104 #define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, RW_SEEK_CUR) |
0 | 105 #define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n) |
106 #define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n) | |
107 #define SDL_RWclose(ctx) (ctx)->close(ctx) | |
108 | |
109 | |
1354
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
110 /* Read an item of the specified endianness and return in native format */ |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
111 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
|
112 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
|
113 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
|
114 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
|
115 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
|
116 extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops *src); |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
117 |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
118 /* Write an item of native format to the specified endianness */ |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 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
|
123 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
|
124 extern DECLSPEC int SDLCALL SDL_WriteBE64(SDL_RWops *dst, Uint64 value); |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
125 |
22f39393668a
Fixed build problem with SDL_string.c
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
126 |
0 | 127 /* Ends C function definitions when using C++ */ |
128 #ifdef __cplusplus | |
129 } | |
130 #endif | |
131 #include "close_code.h" | |
132 | |
133 #endif /* _SDL_RWops_h */ |