include/SDL_rwops.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 930 02759105b989
child 1330 450721ad5436
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@251
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
/* This file provides a general interface for SDL to read and write
slouken@0
    24
   data sources.  It can easily be extended to files, memory, etc.
slouken@0
    25
*/
slouken@0
    26
slouken@0
    27
#ifndef _SDL_RWops_h
slouken@0
    28
#define _SDL_RWops_h
slouken@0
    29
slouken@0
    30
#include <stdio.h>
slouken@0
    31
slouken@0
    32
#include "SDL_types.h"
slouken@0
    33
slouken@0
    34
#include "begin_code.h"
slouken@0
    35
/* Set up for C function definitions, even when using C++ */
slouken@0
    36
#ifdef __cplusplus
slouken@0
    37
extern "C" {
slouken@0
    38
#endif
slouken@0
    39
slouken@0
    40
/* This is the read/write operation structure -- very basic */
slouken@0
    41
slouken@0
    42
typedef struct SDL_RWops {
slouken@0
    43
	/* Seek to 'offset' relative to whence, one of stdio's whence values:
slouken@0
    44
		SEEK_SET, SEEK_CUR, SEEK_END
slouken@0
    45
	   Returns the final offset in the data source.
slouken@0
    46
	 */
slouken@930
    47
	int (SDLCALL *seek)(struct SDL_RWops *context, int offset, int whence);
slouken@0
    48
slouken@0
    49
	/* Read up to 'num' objects each of size 'objsize' from the data
slouken@0
    50
	   source to the area pointed at by 'ptr'.
slouken@0
    51
	   Returns the number of objects read, or -1 if the read failed.
slouken@0
    52
	 */
slouken@930
    53
	int (SDLCALL *read)(struct SDL_RWops *context, void *ptr, int size, int maxnum);
slouken@0
    54
slouken@0
    55
	/* Write exactly 'num' objects each of size 'objsize' from the area
slouken@0
    56
	   pointed at by 'ptr' to data source.
slouken@0
    57
	   Returns 'num', or -1 if the write failed.
slouken@0
    58
	 */
slouken@930
    59
	int (SDLCALL *write)(struct SDL_RWops *context, const void *ptr, int size, int num);
slouken@0
    60
slouken@0
    61
	/* Close and free an allocated SDL_FSops structure */
slouken@930
    62
	int (SDLCALL *close)(struct SDL_RWops *context);
slouken@0
    63
slouken@0
    64
	Uint32 type;
slouken@0
    65
	union {
slouken@0
    66
	    struct {
slouken@0
    67
		int autoclose;
slouken@0
    68
	 	FILE *fp;
slouken@0
    69
	    } stdio;
slouken@0
    70
	    struct {
slouken@0
    71
		Uint8 *base;
slouken@0
    72
	 	Uint8 *here;
slouken@0
    73
		Uint8 *stop;
slouken@0
    74
	    } mem;
slouken@0
    75
	    struct {
slouken@0
    76
		void *data1;
slouken@0
    77
	    } unknown;
slouken@0
    78
	} hidden;
slouken@0
    79
slouken@0
    80
} SDL_RWops;
slouken@0
    81
slouken@0
    82
slouken@0
    83
/* Functions to create SDL_RWops structures from various data sources */
slouken@0
    84
slouken@337
    85
extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char *file, const char *mode);
slouken@0
    86
slouken@337
    87
extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFP(FILE *fp, int autoclose);
slouken@0
    88
slouken@337
    89
extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromMem(void *mem, int size);
slouken@764
    90
extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size);
slouken@0
    91
slouken@337
    92
extern DECLSPEC SDL_RWops * SDLCALL SDL_AllocRW(void);
slouken@337
    93
extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area);
slouken@0
    94
slouken@0
    95
/* Macros to easily read and write from an SDL_RWops structure */
slouken@0
    96
#define SDL_RWseek(ctx, offset, whence)	(ctx)->seek(ctx, offset, whence)
slouken@0
    97
#define SDL_RWtell(ctx)			(ctx)->seek(ctx, 0, SEEK_CUR)
slouken@0
    98
#define SDL_RWread(ctx, ptr, size, n)	(ctx)->read(ctx, ptr, size, n)
slouken@0
    99
#define SDL_RWwrite(ctx, ptr, size, n)	(ctx)->write(ctx, ptr, size, n)
slouken@0
   100
#define SDL_RWclose(ctx)		(ctx)->close(ctx)
slouken@0
   101
slouken@0
   102
slouken@0
   103
/* Ends C function definitions when using C++ */
slouken@0
   104
#ifdef __cplusplus
slouken@0
   105
}
slouken@0
   106
#endif
slouken@0
   107
#include "close_code.h"
slouken@0
   108
slouken@0
   109
#endif /* _SDL_RWops_h */