extras/physfsrwops.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 11 Mar 2007 10:10:28 +0000
changeset 809 116b8fe30371
parent 767 db29bf06d171
child 1024 199e38498938
permissions -rw-r--r--
Renamed LICENSE to LICENSE.txt
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     1
/*
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     2
 * This code provides a glue layer between PhysicsFS and Simple Directmedia
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     3
 *  Layer's (SDL) RWops i/o abstraction.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     4
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     5
 * License: this code is public domain. I make no warranty that it is useful,
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     6
 *  correct, harmless, or environmentally safe.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     7
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     8
 * This particular file may be used however you like, including copying it
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     9
 *  verbatim into a closed-source project, exploiting it commercially, and
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    10
 *  removing any trace of my name from the source (although I hope you won't
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    11
 *  do that). I welcome enhancements and corrections to this file, but I do
576
5da65f8e9a50 Switched to zlib license.
Ryan C. Gordon <icculus@icculus.org>
parents: 132
diff changeset
    12
 *  not require you to send me patches if you make changes. This code has
5da65f8e9a50 Switched to zlib license.
Ryan C. Gordon <icculus@icculus.org>
parents: 132
diff changeset
    13
 *  NO WARRANTY.
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    14
 *
576
5da65f8e9a50 Switched to zlib license.
Ryan C. Gordon <icculus@icculus.org>
parents: 132
diff changeset
    15
 * Unless otherwise stated, the rest of PhysicsFS falls under the zlib license.
809
116b8fe30371 Renamed LICENSE to LICENSE.txt
Ryan C. Gordon <icculus@icculus.org>
parents: 767
diff changeset
    16
 *  Please see LICENSE.txt in the root of the source tree.
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    17
 *
576
5da65f8e9a50 Switched to zlib license.
Ryan C. Gordon <icculus@icculus.org>
parents: 132
diff changeset
    18
 * SDL falls under the LGPL license. You can get SDL at http://www.libsdl.org/
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    19
 *
767
db29bf06d171 Changed my email address.
Ryan C. Gordon <icculus@icculus.org>
parents: 654
diff changeset
    20
 *  This file was written by Ryan C. Gordon. (icculus@icculus.org).
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    21
 */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    22
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    23
#ifndef _INCLUDE_PHYSFSRWOPS_H_
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    24
#define _INCLUDE_PHYSFSRWOPS_H_
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    25
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    26
#include "physfs.h"
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    27
#include "SDL.h"
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    28
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    29
#ifdef __cplusplus
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    30
extern "C" {
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    31
#endif
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    32
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    33
/**
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    34
 * Open a platform-independent filename for reading, and make it accessible
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    35
 *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    36
 *  RWops is closed. PhysicsFS should be configured to your liking before
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    37
 *  opening files through this method.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    38
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    39
 *   @param filename File to open in platform-independent notation.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    40
 *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    41
 *           of the error can be gleaned from PHYSFS_getLastError().
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    42
 */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    43
__EXPORT__ SDL_RWops *PHYSFSRWOPS_openRead(const char *fname);
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    44
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    45
/**
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    46
 * Open a platform-independent filename for writing, and make it accessible
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    47
 *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    48
 *  RWops is closed. PhysicsFS should be configured to your liking before
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    49
 *  opening files through this method.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    50
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    51
 *   @param filename File to open in platform-independent notation.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    52
 *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    53
 *           of the error can be gleaned from PHYSFS_getLastError().
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    54
 */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    55
__EXPORT__ SDL_RWops *PHYSFSRWOPS_openWrite(const char *fname);
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    56
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    57
/**
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    58
 * Open a platform-independent filename for appending, and make it accessible
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    59
 *  via an SDL_RWops structure. The file will be closed in PhysicsFS when the
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    60
 *  RWops is closed. PhysicsFS should be configured to your liking before
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    61
 *  opening files through this method.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    62
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    63
 *   @param filename File to open in platform-independent notation.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    64
 *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    65
 *           of the error can be gleaned from PHYSFS_getLastError().
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    66
 */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    67
__EXPORT__ SDL_RWops *PHYSFSRWOPS_openAppend(const char *fname);
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    68
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    69
/**
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    70
 * Make a SDL_RWops from an existing PhysicsFS file handle. You should
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    71
 *  dispose of any references to the handle after successful creation of
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    72
 *  the RWops. The actual PhysicsFS handle will be destroyed when the
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    73
 *  RWops is closed.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    74
 *
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    75
 *   @param handle a valid PhysicsFS file handle.
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    76
 *  @return A valid SDL_RWops structure on success, NULL on error. Specifics
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    77
 *           of the error can be gleaned from PHYSFS_getLastError().
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    78
 */
654
c0ae01de361d Changed PHYSFS_file to PHYSFS_File to match rest of API's naming
Ryan C. Gordon <icculus@icculus.org>
parents: 576
diff changeset
    79
__EXPORT__ SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_File *handle);
123
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    80
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    81
#ifdef __cplusplus
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    82
}
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    83
#endif
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    84
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    85
#endif /* include-once blocker */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    86
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    87
/* end of physfsrwops.h ... */
53305c50c541 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    88