include/SDL_rwops.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 10 Jul 2006 21:04:37 +0000
changeset 1895 c121d94672cb
parent 1453 2eb75f8a32ca
child 2159 dd4753e47ed4
permissions -rw-r--r--
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
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@1895
    23
/**
slouken@1895
    24
 * \file SDL_rwops.h
slouken@1895
    25
 *
slouken@1895
    26
 * This file provides a general interface for SDL to read and write
slouken@1895
    27
 * data sources.  It can easily be extended to files, memory, etc.
slouken@1895
    28
 */
slouken@0
    29
slouken@1402
    30
#ifndef _SDL_rwops_h
slouken@1402
    31
#define _SDL_rwops_h
slouken@0
    32
slouken@1354
    33
#include "SDL_stdinc.h"
slouken@1358
    34
#include "SDL_error.h"
slouken@1330
    35
slouken@0
    36
#include "begin_code.h"
slouken@0
    37
/* Set up for C function definitions, even when using C++ */
slouken@0
    38
#ifdef __cplusplus
slouken@1895
    39
/* *INDENT-OFF* */
slouken@0
    40
extern "C" {
slouken@1895
    41
/* *INDENT-ON* */
slouken@0
    42
#endif
slouken@0
    43
slouken@0
    44
/* This is the read/write operation structure -- very basic */
slouken@0
    45
slouken@1895
    46
typedef struct SDL_RWops
slouken@1895
    47
{
slouken@1895
    48
    /* Seek to 'offset' relative to whence, one of stdio's whence values:
slouken@1895
    49
       SEEK_SET, SEEK_CUR, SEEK_END
slouken@1895
    50
       Returns the final offset in the data source.
slouken@1895
    51
     */
slouken@1895
    52
    int (SDLCALL * seek) (struct SDL_RWops * context, int offset, int whence);
slouken@0
    53
slouken@1895
    54
    /* Read up to 'num' objects each of size 'objsize' from the data
slouken@1895
    55
       source to the area pointed at by 'ptr'.
slouken@1895
    56
       Returns the number of objects read, or -1 if the read failed.
slouken@1895
    57
     */
slouken@1895
    58
    int (SDLCALL * read) (struct SDL_RWops * context, void *ptr, int size,
slouken@1895
    59
                          int maxnum);
slouken@0
    60
slouken@1895
    61
    /* Write exactly 'num' objects each of size 'objsize' from the area
slouken@1895
    62
       pointed at by 'ptr' to data source.
slouken@1895
    63
       Returns 'num', or -1 if the write failed.
slouken@1895
    64
     */
slouken@1895
    65
    int (SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
slouken@1895
    66
                           int size, int num);
slouken@0
    67
slouken@1895
    68
    /* Close and free an allocated SDL_FSops structure */
slouken@1895
    69
    int (SDLCALL * close) (struct SDL_RWops * context);
slouken@0
    70
slouken@1895
    71
    Uint32 type;
slouken@1895
    72
    union
slouken@1895
    73
    {
slouken@1447
    74
#ifdef __WIN32__
slouken@1895
    75
        struct
slouken@1895
    76
        {
slouken@1895
    77
            int append;
slouken@1895
    78
            void *h;
slouken@1895
    79
        } win32io;
slouken@1447
    80
#endif
slouken@1895
    81
#ifdef HAVE_STDIO_H
slouken@1895
    82
        struct
slouken@1895
    83
        {
slouken@1895
    84
            int autoclose;
slouken@1895
    85
            FILE *fp;
slouken@1895
    86
        } stdio;
slouken@1330
    87
#endif
slouken@1895
    88
        struct
slouken@1895
    89
        {
slouken@1895
    90
            Uint8 *base;
slouken@1895
    91
            Uint8 *here;
slouken@1895
    92
            Uint8 *stop;
slouken@1895
    93
        } mem;
slouken@1895
    94
        struct
slouken@1895
    95
        {
slouken@1895
    96
            void *data1;
slouken@1895
    97
        } unknown;
slouken@1895
    98
    } hidden;
slouken@0
    99
slouken@0
   100
} SDL_RWops;
slouken@0
   101
slouken@0
   102
slouken@0
   103
/* Functions to create SDL_RWops structures from various data sources */
slouken@0
   104
slouken@1895
   105
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFile(const char *file,
slouken@1895
   106
                                                  const char *mode);
slouken@0
   107
slouken@1330
   108
#ifdef HAVE_STDIO_H
slouken@1895
   109
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(FILE * fp, int autoclose);
slouken@1330
   110
#endif
slouken@0
   111
slouken@1895
   112
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size);
slouken@1895
   113
extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem,
slouken@1895
   114
                                                      int size);
slouken@0
   115
slouken@1895
   116
extern DECLSPEC SDL_RWops *SDLCALL SDL_AllocRW(void);
slouken@1895
   117
extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area);
slouken@0
   118
slouken@1895
   119
#define RW_SEEK_SET	0       /* Seek from the beginning of data */
slouken@1895
   120
#define RW_SEEK_CUR	1       /* Seek relative to current read point */
slouken@1895
   121
#define RW_SEEK_END	2       /* Seek relative to the end of data */
slouken@1330
   122
slouken@0
   123
/* Macros to easily read and write from an SDL_RWops structure */
slouken@0
   124
#define SDL_RWseek(ctx, offset, whence)	(ctx)->seek(ctx, offset, whence)
slouken@1330
   125
#define SDL_RWtell(ctx)			(ctx)->seek(ctx, 0, RW_SEEK_CUR)
slouken@0
   126
#define SDL_RWread(ctx, ptr, size, n)	(ctx)->read(ctx, ptr, size, n)
slouken@0
   127
#define SDL_RWwrite(ctx, ptr, size, n)	(ctx)->write(ctx, ptr, size, n)
slouken@0
   128
#define SDL_RWclose(ctx)		(ctx)->close(ctx)
slouken@0
   129
slouken@0
   130
slouken@1354
   131
/* Read an item of the specified endianness and return in native format */
slouken@1895
   132
extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops * src);
slouken@1895
   133
extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops * src);
slouken@1895
   134
extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops * src);
slouken@1895
   135
extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops * src);
slouken@1895
   136
extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops * src);
slouken@1895
   137
extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops * src);
slouken@1354
   138
slouken@1354
   139
/* Write an item of native format to the specified endianness */
slouken@1895
   140
extern DECLSPEC int SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value);
slouken@1895
   141
extern DECLSPEC int SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value);
slouken@1895
   142
extern DECLSPEC int SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value);
slouken@1895
   143
extern DECLSPEC int SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value);
slouken@1895
   144
extern DECLSPEC int SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value);
slouken@1895
   145
extern DECLSPEC int SDLCALL SDL_WriteBE64(SDL_RWops * dst, Uint64 value);
slouken@1354
   146
slouken@1354
   147
slouken@0
   148
/* Ends C function definitions when using C++ */
slouken@0
   149
#ifdef __cplusplus
slouken@1895
   150
/* *INDENT-OFF* */
slouken@0
   151
}
slouken@1895
   152
/* *INDENT-ON* */
slouken@0
   153
#endif
slouken@0
   154
#include "close_code.h"
slouken@0
   155
slouken@1402
   156
#endif /* _SDL_rwops_h */
slouken@1895
   157
slouken@1895
   158
/* vi: set ts=4 sw=4 expandtab: */