This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_rwops.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 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.
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
*/
24
25
26
* \file SDL_rwops.h
*
* This file provides a general interface for SDL to read and write
27
* data streams. It can easily be extended to files, memory, etc.
30
31
#ifndef _SDL_rwops_h
#define _SDL_rwops_h
33
#include "SDL_stdinc.h"
34
#include "SDL_error.h"
35
36
37
38
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
39
/* *INDENT-OFF* */
40
extern "C" {
41
/* *INDENT-ON* */
42
43
#endif
44
45
46
/**
* This is the read/write operation structure -- very basic.
*/
47
48
typedef struct SDL_RWops
{
49
50
51
52
/**
* Seek to \c offset relative to \c whence, one of stdio's whence values:
* RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
*
53
* \return the final offset in the data stream.
55
56
long (SDLCALL * seek) (struct SDL_RWops * context, long offset,
int whence);
58
/**
59
* Read up to \c maxnum objects each of size \c size from the data
60
* stream to the area pointed at by \c ptr.
61
62
*
* \return the number of objects read, or 0 at error or end of file.
64
65
66
67
size_t(SDLCALL * read) (struct SDL_RWops * context, void *ptr,
size_t size, size_t maxnum);
/**
68
* Write exactly \c num objects each of size \c size from the area
69
* pointed at by \c ptr to data stream.
70
71
*
* \return the number of objects written, or 0 at error or end of file.
73
74
size_t(SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
size_t size, size_t num);
76
77
78
79
/**
* Close and free an allocated SDL_RWops structure.
*
* \return 0 if successful or -1 on write error when flushing data.
81
82
83
84
85
int (SDLCALL * close) (struct SDL_RWops * context);
Uint32 type;
union
{
86
#ifdef __WIN32__
89
SDL_bool append;
91
92
93
struct
{
void *data;
94
95
size_t size;
size_t left;
99
100
101
#ifdef HAVE_STDIO_H
struct
{
102
SDL_bool autoclose;
103
104
FILE *fp;
} stdio;
106
107
108
109
110
111
112
113
114
115
116
struct
{
Uint8 *base;
Uint8 *here;
Uint8 *stop;
} mem;
struct
{
void *data1;
} unknown;
} hidden;
117
118
119
120
} SDL_RWops;
121
122
123
/**
* \name RWFrom functions
*
124
* Functions to create SDL_RWops structures from various data streams.
125
126
*/
/*@{*/
128
129
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFile(const char *file,
const char *mode);
131
#ifdef HAVE_STDIO_H
132
133
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(FILE * fp,
SDL_bool autoclose);
134
135
136
#else
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(void * fp,
SDL_bool autoclose);
139
140
141
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size);
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem,
int size);
143
144
145
/*@}*//*RWFrom functions*/
146
147
extern DECLSPEC SDL_RWops *SDLCALL SDL_AllocRW(void);
extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area);
149
150
151
#define RW_SEEK_SET 0 /**< Seek from the beginning of data */
#define RW_SEEK_CUR 1 /**< Seek relative to current read point */
#define RW_SEEK_END 2 /**< Seek relative to the end of data */
153
154
155
156
157
158
/**
* \name Read/write macros
*
* Macros to easily read and write from an SDL_RWops structure.
*/
/*@{*/
159
#define SDL_RWseek(ctx, offset, whence) (ctx)->seek(ctx, offset, whence)
160
#define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, RW_SEEK_CUR)
161
162
163
#define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n)
#define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n)
#define SDL_RWclose(ctx) (ctx)->close(ctx)
164
/*@}*//*Read/write macros*/
165
166
167
168
169
170
171
172
/**
* \name Read endian functions
*
* Read an item of the specified endianness and return in native format.
*/
/*@{*/
173
174
175
176
177
178
extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops * src);
extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops * src);
extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops * src);
extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops * src);
extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops * src);
extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops * src);
179
/*@}*//*Read endian functions*/
181
182
183
184
185
186
/**
* \name Write endian functions
*
* Write an item of native format to the specified endianness.
*/
/*@{*/
187
188
189
190
191
192
extern DECLSPEC size_t SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value);
extern DECLSPEC size_t SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value);
extern DECLSPEC size_t SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value);
extern DECLSPEC size_t SDLCALL SDL_WriteBE64(SDL_RWops * dst, Uint64 value);
193
/*@}*//*Write endian functions*/
196
197
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
198
/* *INDENT-OFF* */
199
}
200
/* *INDENT-ON* */
201
202
203
#endif
#include "close_code.h"
204
#endif /* _SDL_rwops_h */
205
206
/* vi: set ts=4 sw=4 expandtab: */