mirror of https://github.com/libAthena/athena.git
54 lines
1.7 KiB
C++
54 lines
1.7 KiB
C++
// This file is part of libAthena.
|
|
//
|
|
// libAthena 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 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// libAthena 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 libAthena. If not, see <http://www.gnu.org/licenses/>
|
|
|
|
#ifndef __IOEXCEPTION_HPP__
|
|
#define __IOEXCEPTION_HPP__
|
|
|
|
#include "Exception.hpp"
|
|
|
|
|
|
namespace Athena
|
|
{
|
|
namespace error
|
|
{
|
|
/*! \class IOException
|
|
* \brief An excpeption thrown on inappropriate IO calls.
|
|
*
|
|
* This should only be thrown when the library tries to write to a buffer
|
|
* e.g when the position is greater than the position and the stream
|
|
* is not set to autoresize.<br />
|
|
* <br />
|
|
* It is <b>NOT</b> appropriate to use <b>throw new</b> so avoid doing so,
|
|
* keeping things on the stack as much as possible is very important for speed.
|
|
*/
|
|
class IOException : public Exception
|
|
{
|
|
public:
|
|
/*! \brief The constructor for an IOException
|
|
* \param message The error message to throw
|
|
*/
|
|
inline IOException(const std::string& message, const std::string& file, const std::string& function, const int line) :
|
|
Exception(message, file, function, line)
|
|
{}
|
|
};
|
|
|
|
} // error
|
|
} // Athena
|
|
|
|
#define THROW_IO_EXCEPTION(msg) \
|
|
do { throw Athena::error::IOException("IOException: " msg, __FILE__, __PRETTY_FUNCTION__, __LINE__); } while(0)
|
|
|
|
#endif
|