SDL_rwops.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_rwops.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	SDL_RWops

Macros
#define	SDL_RWOPS_UNKNOWN   0U
#define	SDL_RWOPS_WINFILE   1U
#define	SDL_RWOPS_STDFILE   2U
#define	SDL_RWOPS_JNIFILE   3U
#define	SDL_RWOPS_MEMORY   4U
#define	SDL_RWOPS_MEMORY_RO   5U

Functions
Read endian functions
Read an item of the specified endianness and return in native format.
Uint8	SDL_ReadU8 (SDL_RWops *src)
Uint16	SDL_ReadLE16 (SDL_RWops *src)
Uint16	SDL_ReadBE16 (SDL_RWops *src)
Uint32	SDL_ReadLE32 (SDL_RWops *src)
Uint32	SDL_ReadBE32 (SDL_RWops *src)
Uint64	SDL_ReadLE64 (SDL_RWops *src)
Uint64	SDL_ReadBE64 (SDL_RWops *src)
Write endian functions
Write an item of native format to the specified endianness.
size_t	SDL_WriteU8 (SDL_RWops *dst, Uint8 value)
size_t	SDL_WriteLE16 (SDL_RWops *dst, Uint16 value)
size_t	SDL_WriteBE16 (SDL_RWops *dst, Uint16 value)
size_t	SDL_WriteLE32 (SDL_RWops *dst, Uint32 value)
size_t	SDL_WriteBE32 (SDL_RWops *dst, Uint32 value)
size_t	SDL_WriteLE64 (SDL_RWops *dst, Uint64 value)
size_t	SDL_WriteBE64 (SDL_RWops *dst, Uint64 value)

RWFrom functions
Functions to create SDL_RWops structures from various data streams.
#define	RW_SEEK_SET   0
#define	RW_SEEK_CUR   1
#define	RW_SEEK_END   2
SDL_RWops *	SDL_RWFromFile (const char *file, const char *mode)
SDL_RWops *	SDL_RWFromFP (FILE *fp, SDL_bool autoclose)
SDL_RWops *	SDL_RWFromMem (void *mem, int size)
SDL_RWops *	SDL_RWFromConstMem (const void *mem, int size)
SDL_RWops *	SDL_AllocRW (void)
void	SDL_FreeRW (SDL_RWops *area)
Sint64	SDL_RWsize (SDL_RWops *context)
Sint64	SDL_RWseek (SDL_RWops *context, Sint64 offset, int whence)
Sint64	SDL_RWtell (SDL_RWops *context)
size_t	SDL_RWread (SDL_RWops *context, void *ptr, size_t size, size_t maxnum)
size_t	SDL_RWwrite (SDL_RWops *context, const void *ptr, size_t size, size_t num)
int	SDL_RWclose (SDL_RWops *context)
void *	SDL_LoadFile_RW (SDL_RWops *src, size_t *datasize, int freesrc)
void *	SDL_LoadFile (const char *file, size_t *datasize)

Detailed Description

This file provides a general interface for SDL to read and write data streams. It can easily be extended to files, memory, etc.

Definition in file SDL_rwops.h.

Macro Definition Documentation

RW_SEEK_CUR

#define RW_SEEK_CUR   1

Seek relative to current read point

Definition at line 167 of file SDL_rwops.h.

RW_SEEK_END

#define RW_SEEK_END   2

Seek relative to the end of data

Definition at line 168 of file SDL_rwops.h.

RW_SEEK_SET

#define RW_SEEK_SET   0

Seek from the beginning of data

Definition at line 166 of file SDL_rwops.h.

SDL_RWOPS_JNIFILE

#define SDL_RWOPS_JNIFILE   3U

Android asset

Definition at line 45 of file SDL_rwops.h.

SDL_RWOPS_MEMORY

#define SDL_RWOPS_MEMORY   4U

Memory stream

Definition at line 46 of file SDL_rwops.h.

SDL_RWOPS_MEMORY_RO

#define SDL_RWOPS_MEMORY_RO   5U

Read-Only memory stream

Definition at line 47 of file SDL_rwops.h.

SDL_RWOPS_STDFILE

#define SDL_RWOPS_STDFILE   2U

Stdio file

Definition at line 44 of file SDL_rwops.h.

SDL_RWOPS_UNKNOWN

#define SDL_RWOPS_UNKNOWN   0U

Unknown stream type

Definition at line 42 of file SDL_rwops.h.

SDL_RWOPS_WINFILE

#define SDL_RWOPS_WINFILE   1U

Win32 file

Definition at line 43 of file SDL_rwops.h.

Function Documentation

SDL_AllocRW()

SDL_RWops* SDL_AllocRW

(

void

)

Definition at line 385 of file SDL_dynapi_procs.h.

References NULL, SDL_malloc, SDL_OutOfMemory, SDL_RWOPS_UNKNOWN, and SDL_RWops::type.

Referenced by SDL_RWFromConstMem(), SDL_RWFromFile(), and SDL_RWFromMem().

SDL_FreeRW()

void SDL_FreeRW

(

SDL_RWops *

area

)

Definition at line 715 of file SDL_rwops.c.

{
    SDL_free(area);
}

References SDL_free.

Referenced by mem_close(), and SDL_RWFromFile().

SDL_LoadFile()

void* SDL_LoadFile	(	const char *	file,
		size_t *	datasize
	)

Load an entire file.

The data is allocated with a zero byte at the end (null terminated)

If datasize is not NULL, it is filled with the size of the data read.

If freesrc is non-zero, the stream will be closed after being read.

The data should be freed with SDL_free().

Returns

the data, or NULL if there was an error.

Definition at line 774 of file SDL_rwops.c.

{
   return SDL_LoadFile_RW(SDL_RWFromFile(file, "rb"), datasize, 1);
}

References SDL_LoadFile_RW(), and SDL_RWFromFile().

SDL_LoadFile_RW()

void* SDL_LoadFile_RW	(	SDL_RWops *	src,
		size_t *	datasize,
		int	freesrc
	)

Load all the data from an SDL data stream.

The data is allocated with a zero byte at the end (null terminated)

If datasize is not NULL, it is filled with the size of the data read.

If freesrc is non-zero, the stream will be closed after being read.

The data should be freed with SDL_free().

Returns

the data, or NULL if there was an error.

Definition at line 722 of file SDL_rwops.c.

{
    const int FILE_CHUNK_SIZE = 1024;
    Sint64 size;
    size_t size_read, size_total;
    void *data = NULL, *newdata;
 
    if (!src) {
        SDL_InvalidParamError("src");
        return NULL;
    }
 
    size = SDL_RWsize(src);
    if (size < 0) {
        size = FILE_CHUNK_SIZE;
    }
    data = SDL_malloc((size_t)(size + 1));
 
    size_total = 0;
    for (;;) {
        if ((((Sint64)size_total) + FILE_CHUNK_SIZE) > size) {
            size = (size_total + FILE_CHUNK_SIZE);
            newdata = SDL_realloc(data, (size_t)(size + 1));
            if (!newdata) {
                SDL_free(data);
                data = NULL;
                SDL_OutOfMemory();
                goto done;
            }
            data = newdata;
        }
 
        size_read = SDL_RWread(src, (char *)data+size_total, 1, (size_t)(size-size_total));
        if (size_read == 0) {
            break;
        }
        size_total += size_read;
    }
 
    if (datasize) {
        *datasize = size_total;
    }
    ((char *)data)[size_total] = '\0';
 
done:
    if (freesrc && src) {
        SDL_RWclose(src);
    }
    return data;
}

References done, NULL, SDL_free, SDL_InvalidParamError, SDL_malloc, SDL_OutOfMemory, SDL_realloc, SDL_RWclose(), SDL_RWread(), and SDL_RWsize().

Referenced by SDL_LoadFile().

SDL_ReadBE16()

Uint16 SDL_ReadBE16

(

SDL_RWops *

src

)

Definition at line 836 of file SDL_rwops.c.

{
    Uint16 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapBE16(value);
}

References SDL_RWread(), and SDL_SwapBE16.

SDL_ReadBE32()

Uint32 SDL_ReadBE32

(

SDL_RWops *

src

)

Definition at line 854 of file SDL_rwops.c.

{
    Uint32 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapBE32(value);
}

References SDL_RWread(), and SDL_SwapBE32.

SDL_ReadBE64()

Uint64 SDL_ReadBE64

(

SDL_RWops *

src

)

Definition at line 872 of file SDL_rwops.c.

{
    Uint64 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapBE64(value);
}

References SDL_RWread(), and SDL_SwapBE64.

SDL_ReadLE16()

Uint16 SDL_ReadLE16

(

SDL_RWops *

src

)

Definition at line 827 of file SDL_rwops.c.

{
    Uint16 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapLE16(value);
}

References SDL_RWread(), and SDL_SwapLE16.

SDL_ReadLE32()

Uint32 SDL_ReadLE32

(

SDL_RWops *

src

)

Definition at line 845 of file SDL_rwops.c.

{
    Uint32 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapLE32(value);
}

References SDL_RWread(), and SDL_SwapLE32.

SDL_ReadLE64()

Uint64 SDL_ReadLE64

(

SDL_RWops *

src

)

Definition at line 863 of file SDL_rwops.c.

{
    Uint64 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return SDL_SwapLE64(value);
}

References SDL_RWread(), and SDL_SwapLE64.

SDL_ReadU8()

Uint8 SDL_ReadU8

(

SDL_RWops *

src

)

Definition at line 818 of file SDL_rwops.c.

{
    Uint8 value = 0;
 
    SDL_RWread(src, &value, sizeof (value), 1);
    return value;
}

References SDL_RWread().

SDL_RWclose()

int SDL_RWclose

(

SDL_RWops *

context

)

Close and free an allocated SDL_RWops structure.

Returns

0 if successful or -1 on write error when flushing data.

Definition at line 810 of file SDL_rwops.c.

{
    return context->close(context);
}

References context.

Referenced by SDL_LoadFile_RW().

SDL_RWFromConstMem()

SDL_RWops* SDL_RWFromConstMem	(	const void *	mem,
		int	size
	)

Definition at line 673 of file SDL_rwops.c.

{
    SDL_RWops *rwops = NULL;
    if (!mem) {
      SDL_InvalidParamError("mem");
      return rwops;
    }
    if (!size) {
      SDL_InvalidParamError("size");
      return rwops;
    }
 
    rwops = SDL_AllocRW();
    if (rwops != NULL) {
        rwops->size = mem_size;
        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;
        rwops->type = SDL_RWOPS_MEMORY_RO;
    }
    return rwops;
}

References SDL_RWops::close, SDL_RWops::hidden, SDL_RWops::mem, mem_close(), mem_read(), mem_seek(), mem_size(), mem_writeconst(), NULL, SDL_RWops::read, SDL_AllocRW(), SDL_InvalidParamError, SDL_RWOPS_MEMORY_RO, SDL_RWops::seek, SDL_RWops::size, SDL_RWops::type, and SDL_RWops::write.

SDL_RWFromFile()

SDL_RWops* SDL_RWFromFile	(	const char *	file,
		const char *	mode
	)

Definition at line 529 of file SDL_rwops.c.

{
    SDL_RWops *rwops = NULL;
    if (!file || !*file || !mode || !*mode) {
        SDL_SetError("SDL_RWFromFile(): No file or no mode specified");
        return NULL;
    }
#if defined(__ANDROID__)
#ifdef HAVE_STDIO_H
    /* Try to open the file on the filesystem first */
    if (*file == '/') {
        FILE *fp = fopen(file, mode);
        if (fp) {
            return SDL_RWFromFP(fp, 1);
        }
    } else {
        /* Try opening it from internal storage if it's a relative path */
        char *path;
        FILE *fp;
 
        /* !!! FIXME: why not just "char path[PATH_MAX];" ? */
        path = SDL_stack_alloc(char, PATH_MAX);
        if (path) {
            SDL_snprintf(path, PATH_MAX, "%s/%s",
                         SDL_AndroidGetInternalStoragePath(), file);
            fp = fopen(path, mode);
            SDL_stack_free(path);
            if (fp) {
                return SDL_RWFromFP(fp, 1);
            }
        }
    }
#endif /* HAVE_STDIO_H */
 
    /* Try to open the file from the asset system */
    rwops = SDL_AllocRW();
    if (!rwops)
        return NULL;            /* SDL_SetError already setup by SDL_AllocRW() */
    if (Android_JNI_FileOpen(rwops, file, mode) < 0) {
        SDL_FreeRW(rwops);
        return NULL;
    }
    rwops->size = Android_JNI_FileSize;
    rwops->seek = Android_JNI_FileSeek;
    rwops->read = Android_JNI_FileRead;
    rwops->write = Android_JNI_FileWrite;
    rwops->close = Android_JNI_FileClose;
    rwops->type = SDL_RWOPS_JNIFILE;
 
#elif defined(__WIN32__)
    rwops = SDL_AllocRW();
    if (!rwops)
        return NULL;            /* SDL_SetError already setup by SDL_AllocRW() */
    if (windows_file_open(rwops, file, mode) < 0) {
        SDL_FreeRW(rwops);
        return NULL;
    }
    rwops->size = windows_file_size;
    rwops->seek = windows_file_seek;
    rwops->read = windows_file_read;
    rwops->write = windows_file_write;
    rwops->close = windows_file_close;
    rwops->type = SDL_RWOPS_WINFILE;
 
#elif HAVE_STDIO_H
    {
        #ifdef __APPLE__
        FILE *fp = SDL_OpenFPFromBundleOrFallback(file, mode);
        #elif __WINRT__
        FILE *fp = NULL;
        fopen_s(&fp, file, mode);
        #else
        FILE *fp = fopen(file, mode);
        #endif
        if (fp == NULL) {
            SDL_SetError("Couldn't open %s", file);
        } else {
            rwops = SDL_RWFromFP(fp, SDL_TRUE);
        }
    }
#else
    SDL_SetError("SDL not compiled with stdio support");
#endif /* !HAVE_STDIO_H */
 
    return rwops;
}

References Android_JNI_FileClose(), Android_JNI_FileOpen(), Android_JNI_FileRead(), Android_JNI_FileSeek(), Android_JNI_FileSize(), Android_JNI_FileWrite(), SDL_RWops::close, NULL, SDL_RWops::read, SDL_AllocRW(), SDL_AndroidGetInternalStoragePath, SDL_FreeRW(), SDL_RWFromFP(), SDL_RWOPS_JNIFILE, SDL_RWOPS_WINFILE, SDL_SetError, SDL_snprintf, SDL_stack_alloc, SDL_stack_free, SDL_TRUE, SDL_RWops::seek, SDL_RWops::size, SDL_RWops::type, and SDL_RWops::write.

Referenced by SDL_LoadFile().

SDL_RWFromFP()

SDL_RWops* SDL_RWFromFP	(	FILE *	fp,
		SDL_bool	autoclose
	)

SDL_RWFromMem()

SDL_RWops* SDL_RWFromMem	(	void *	mem,
		int	size
	)

Definition at line 645 of file SDL_rwops.c.

{
    SDL_RWops *rwops = NULL;
    if (!mem) {
      SDL_InvalidParamError("mem");
      return rwops;
    }
    if (!size) {
      SDL_InvalidParamError("size");
      return rwops;
    }
 
    rwops = SDL_AllocRW();
    if (rwops != NULL) {
        rwops->size = mem_size;
        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;
        rwops->type = SDL_RWOPS_MEMORY;
    }
    return rwops;
}

References SDL_RWops::close, SDL_RWops::hidden, SDL_RWops::mem, mem_close(), mem_read(), mem_seek(), mem_size(), mem_write(), NULL, SDL_RWops::read, SDL_AllocRW(), SDL_InvalidParamError, SDL_RWOPS_MEMORY, SDL_RWops::seek, SDL_RWops::size, SDL_RWops::type, and SDL_RWops::write.

SDL_RWread()

size_t SDL_RWread	(	SDL_RWops *	context,
		void *	ptr,
		size_t	size,
		size_t	maxnum
	)

Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.

Returns

the number of objects read, or 0 at error or end of file.

Definition at line 798 of file SDL_rwops.c.

{
    return context->read(context, ptr, size, maxnum);
}

References context, and ptr.

Referenced by SDL_LoadFile_RW(), SDL_ReadBE16(), SDL_ReadBE32(), SDL_ReadBE64(), SDL_ReadLE16(), SDL_ReadLE32(), SDL_ReadLE64(), and SDL_ReadU8().

SDL_RWseek()

Sint64 SDL_RWseek	(	SDL_RWops *	context,
		Sint64	offset,
		int	whence
	)

Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END

Returns

the final offset in the data stream, or -1 on error.

Definition at line 786 of file SDL_rwops.c.

{
    return context->seek(context, offset, whence);
}

References context.

SDL_RWsize()

Sint64 SDL_RWsize

(

SDL_RWops *

context

)

Return the size of the file in this rwops, or -1 if unknown

Definition at line 780 of file SDL_rwops.c.

{
    return context->size(context);
}

References context.

Referenced by SDL_LoadFile_RW().

SDL_RWtell()

Sint64 SDL_RWtell

(

SDL_RWops *

context

)

Return the current offset in the data stream, or -1 on error.

Definition at line 792 of file SDL_rwops.c.

{
    return context->seek(context, 0, RW_SEEK_CUR);
}

References context, and RW_SEEK_CUR.

SDL_RWwrite()

size_t SDL_RWwrite	(	SDL_RWops *	context,
		const void *	ptr,
		size_t	size,
		size_t	num
	)

Write exactly num objects each of size size from the area pointed at by ptr to data stream.

Returns

the number of objects written, or 0 at error or end of file.

Definition at line 804 of file SDL_rwops.c.

{
    return context->write(context, ptr, size, num);
}

References context, and ptr.

Referenced by SDL_WriteBE16(), SDL_WriteBE32(), SDL_WriteBE64(), SDL_WriteLE16(), SDL_WriteLE32(), SDL_WriteLE64(), and SDL_WriteU8().

SDL_WriteBE16()

size_t SDL_WriteBE16	(	SDL_RWops *	dst,
		Uint16	value
	)

Definition at line 894 of file SDL_rwops.c.

{
    const Uint16 swapped = SDL_SwapBE16(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapBE16.

SDL_WriteBE32()

size_t SDL_WriteBE32	(	SDL_RWops *	dst,
		Uint32	value
	)

Definition at line 908 of file SDL_rwops.c.

{
    const Uint32 swapped = SDL_SwapBE32(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapBE32.

SDL_WriteBE64()

size_t SDL_WriteBE64	(	SDL_RWops *	dst,
		Uint64	value
	)

Definition at line 922 of file SDL_rwops.c.

{
    const Uint64 swapped = SDL_SwapBE64(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapBE64.

SDL_WriteLE16()

size_t SDL_WriteLE16	(	SDL_RWops *	dst,
		Uint16	value
	)

Definition at line 887 of file SDL_rwops.c.

{
    const Uint16 swapped = SDL_SwapLE16(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapLE16.

SDL_WriteLE32()

size_t SDL_WriteLE32	(	SDL_RWops *	dst,
		Uint32	value
	)

Definition at line 901 of file SDL_rwops.c.

{
    const Uint32 swapped = SDL_SwapLE32(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapLE32.

SDL_WriteLE64()

size_t SDL_WriteLE64	(	SDL_RWops *	dst,
		Uint64	value
	)

Definition at line 915 of file SDL_rwops.c.

{
    const Uint64 swapped = SDL_SwapLE64(value);
    return SDL_RWwrite(dst, &swapped, sizeof (swapped), 1);
}

References SDL_RWwrite(), and SDL_SwapLE64.

SDL_WriteU8()

size_t SDL_WriteU8	(	SDL_RWops *	dst,
		Uint8	value
	)

Definition at line 881 of file SDL_rwops.c.

{
    return SDL_RWwrite(dst, &value, sizeof (value), 1);
}

References SDL_RWwrite().