170 lines
5.3 KiB
C++
170 lines
5.3 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_FILEINPUTSTREAM_HPP
|
|
#define SFML_FILEINPUTSTREAM_HPP
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Config.hpp>
|
|
#include <SFML/System/Export.hpp>
|
|
#include <SFML/System/InputStream.hpp>
|
|
#include <SFML/System/NonCopyable.hpp>
|
|
#include <cstdio>
|
|
#include <string>
|
|
|
|
#ifdef ANDROID
|
|
namespace sf
|
|
{
|
|
namespace priv
|
|
{
|
|
class SFML_SYSTEM_API ResourceStream;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
|
|
namespace sf
|
|
{
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Implementation of input stream based on a file
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
class SFML_SYSTEM_API FileInputStream : public InputStream, NonCopyable
|
|
{
|
|
public:
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Default constructor
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
FileInputStream();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Default destructor
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual ~FileInputStream();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Open the stream from a file path
|
|
///
|
|
/// \param filename Name of the file to open
|
|
///
|
|
/// \return True on success, false on error
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
bool open(const std::string& filename);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Read data from the stream
|
|
///
|
|
/// After reading, the stream's reading position must be
|
|
/// advanced by the amount of bytes read.
|
|
///
|
|
/// \param data Buffer where to copy the read data
|
|
/// \param size Desired number of bytes to read
|
|
///
|
|
/// \return The number of bytes actually read, or -1 on error
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual Int64 read(void* data, Int64 size);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Change the current reading position
|
|
///
|
|
/// \param position The position to seek to, from the beginning
|
|
///
|
|
/// \return The position actually sought to, or -1 on error
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual Int64 seek(Int64 position);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the current reading position in the stream
|
|
///
|
|
/// \return The current position, or -1 on error.
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual Int64 tell();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Return the size of the stream
|
|
///
|
|
/// \return The total number of bytes available in the stream, or -1 on error
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
virtual Int64 getSize();
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Member data
|
|
////////////////////////////////////////////////////////////
|
|
#ifdef ANDROID
|
|
priv::ResourceStream* m_file;
|
|
#else
|
|
std::FILE* m_file; ///< stdio file stream
|
|
#endif
|
|
};
|
|
|
|
} // namespace sf
|
|
|
|
|
|
#endif // SFML_FILEINPUTSTREAM_HPP
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \class FileInputStream
|
|
/// \ingroup system
|
|
///
|
|
/// This class is a specialization of InputStream that
|
|
/// reads from a file on disk.
|
|
///
|
|
/// It wraps a file in the common InputStream interface
|
|
/// and therefore allows to use generic classes or functions
|
|
/// that accept such a stream, with a file on disk as the data
|
|
/// source.
|
|
///
|
|
/// In addition to the virtual functions inherited from
|
|
/// InputStream, FileInputStream adds a function to
|
|
/// specify the file to open.
|
|
///
|
|
/// SFML resource classes can usually be loaded directly from
|
|
/// a filename, so this class shouldn't be useful to you unless
|
|
/// you create your own algorithms that operate on a InputStream.
|
|
///
|
|
/// Usage example:
|
|
/// \code
|
|
/// void process(InputStream& stream);
|
|
///
|
|
/// FileStream stream;
|
|
/// if (stream.open("some_file.dat"))
|
|
/// process(stream);
|
|
/// \endcode
|
|
///
|
|
/// InputStream, MemoryStream
|
|
///
|
|
////////////////////////////////////////////////////////////
|