path: root/src/fs/virtfsrwops.h

/*
 *  The ManaPlus Client
 *  Copyright (C) 2013-2017  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * This code provides a glue layer between PhysicsFS and Simple Directmedia
 *  Layer's (SDL) RWops i/o abstraction.
 *
 * License: this code is public domain. I make no warranty that it is useful,
 *  correct, harmless, or environmentally safe.
 *
 * This particular file may be used however you like, including copying it
 *  verbatim into a closed-source project, exploiting it commercially, and
 *  removing any trace of my name from the source (although I hope you won't
 *  do that). I welcome enhancements and corrections to this file, but I do
 *  not require you to send me patches if you make changes. This code has
 *  NO WARRANTY.
 *
 * Unless otherwise stated, the rest of PhysicsFS falls under the zlib license.
 *  Please see LICENSE.txt in the root of the source tree.
 *
 * SDL falls under the LGPL license. You can get SDL at http://www.libsdl.org/
 *
 *  This file was written by Ryan C. Gordon. (icculus@icculus.org).
 *
 *  Copyright (C) 2012-2017  The ManaPlus Developers
 */

#ifndef UTILS_PHYSFSRWOPS_H
#define UTILS_PHYSFSRWOPS_H

#include "localconsts.h"

#include <string>
#include <SDL_rwops.h>

struct VirtFile;

namespace VirtFs
{
#ifdef DEBUG_VIRTFS
    SDL_RWops *RWopsOpenRead(const std::string &restrict fname,
                             const char *restrict const file,
                             const unsigned line);
    void reportLeaks();
#else  // DEBUG_VIRTFS
    SDL_RWops *RWopsOpenRead(const std::string &restrict fname);
#endif  // DEBUG_VIRTFS

    SDL_RWops *RWopsOpenWrite(const std::string &restrict fname) A_WARN_UNUSED;
    SDL_RWops *RWopsOpenAppend(const std::string &restrict fname)
                               A_WARN_UNUSED;
    SDL_RWops *MakeRWops(VirtFile *const handle) A_WARN_UNUSED;
#ifdef DUMP_LEAKED_RESOURCES
    void reportRWops();
#endif  // DUMP_LEAKED_RESOURCES
}  // namespace VirtFs

#endif  // UTILS_PHYSFSRWOPS_H