For work splitting error handling code into separate files for asserts vs. exceptions.
This commit is contained in:
David Williams
parent
a61d4556c1
commit
4887fc2701
@ -25,154 +25,7 @@ freely, subject to the following restrictions:
|
||||
#define __PolyVox_ErrorHandling_H__
|
||||
|
||||
#include "PolyVox/Impl/Assertions.h"
|
||||
#include "PolyVox/Impl/ExceptionsImpl.h"
|
||||
#include "PolyVox/Impl/Logging.h"
|
||||
|
||||
#include <cstdlib> // For std::exit
|
||||
#include <iostream> // For std::cerr
|
||||
#include <stdexcept>
|
||||
#include <sstream>
|
||||
#include <string.h> // Exception constuctors take strings.
|
||||
#include <csignal>
|
||||
|
||||
/*
|
||||
* Exceptions
|
||||
* ----------
|
||||
* ...
|
||||
*/
|
||||
#ifdef POLYVOX_THROW_ENABLED
|
||||
namespace PolyVox
|
||||
{
|
||||
template< typename ExceptionType, typename ... Args >
|
||||
void polyvox_throw(Args const& ... messageArgs)
|
||||
{
|
||||
std::string message = Impl::argListToString(messageArgs...);
|
||||
#ifdef POLYVOX_LOG_ERROR_ENABLED
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(message);
|
||||
#endif
|
||||
throw ExceptionType(message);
|
||||
}
|
||||
|
||||
template< typename ExceptionType, typename ... Args >
|
||||
void polyvox_throw_if(bool condition, Args const& ... messageArgs)
|
||||
{
|
||||
if(condition) { polyvox_throw<ExceptionType>(messageArgs...); }
|
||||
}
|
||||
}
|
||||
#define POLYVOX_THROW(type, ...) PolyVox::polyvox_throw<type>(__VA_ARGS__)
|
||||
#define POLYVOX_THROW_IF(condition, type, ...) PolyVox::polyvox_throw_if<type>(condition, __VA_ARGS__)
|
||||
#else
|
||||
namespace PolyVox
|
||||
{
|
||||
typedef void (*ThrowHandler)(std::exception& e, const char* file, int line);
|
||||
|
||||
inline void defaultThrowHandler(std::exception& e, const char* file, int line)
|
||||
{
|
||||
std::stringstream ss; \
|
||||
ss << "\n"; \
|
||||
ss << " PolyVox exception thrown!"; \
|
||||
ss << " ========================="; \
|
||||
ss << " PolyVox has tried to throw an exception but it was built without support"; \
|
||||
ss << " for exceptions. In this scenario PolyVox will call a 'throw handler'"; \
|
||||
ss << " and this message is being printed by the default throw handler."; \
|
||||
ss << "\n"; \
|
||||
ss << " If you don't want to enable exceptions then you should try to determine why"; \
|
||||
ss << " this exception was thrown and make sure it doesn't happen again. If it was"; \
|
||||
ss << " due to something like an invalid argument to a function then you should be"; \
|
||||
ss << " able to fix it quite easily by validating parameters as appropriate. More"; \
|
||||
ss << " complex exception scenarios (out of memory, etc) might be harder to fix and"; \
|
||||
ss << " you should replace this default handler with something which is more"; \
|
||||
ss << " meaningful to your users."; \
|
||||
ss << "\n"; \
|
||||
ss << " Exception details"; \
|
||||
ss << " -----------------"; \
|
||||
ss << " Line: " << line; \
|
||||
ss << " File: " << file; \
|
||||
ss << " Message: " << e.what(); \
|
||||
ss << "\n"; \
|
||||
PolyVox::Impl::getLoggerInstance()->logFatalMessage(ss.str()); \
|
||||
POLYVOX_HALT(); \
|
||||
}
|
||||
|
||||
inline ThrowHandler& getThrowHandlerInstance()
|
||||
{
|
||||
static ThrowHandler s_fThrowHandler = &defaultThrowHandler;
|
||||
return s_fThrowHandler;
|
||||
}
|
||||
|
||||
inline ThrowHandler getThrowHandler()
|
||||
{
|
||||
return getThrowHandlerInstance();
|
||||
}
|
||||
|
||||
inline void setThrowHandler(ThrowHandler fNewHandler)
|
||||
{
|
||||
getThrowHandlerInstance() = fNewHandler;
|
||||
}
|
||||
}
|
||||
|
||||
#define POLYVOX_THROW_IF(condition, type, message) \
|
||||
/* We use the do...while(0) construct in our macros (for reasons see here: http://stackoverflow.com/a/154138) \
|
||||
but Visual Studio gives unhelpful 'conditional expression is constant' warnings. The recommended solution \
|
||||
(http://stackoverflow.com/a/1946485) is to disable these warnings. */ \
|
||||
POLYVOX_MSC_WARNING_PUSH \
|
||||
POLYVOX_DISABLE_MSC_WARNING(4127) \
|
||||
do \
|
||||
{ \
|
||||
if ((condition)) \
|
||||
{ \
|
||||
std::stringstream ss; \
|
||||
ss << message; \
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(ss.str()); \
|
||||
type except = (type)(ss.str()); \
|
||||
getThrowHandler()((except), __FILE__, __LINE__); \
|
||||
} \
|
||||
} while(0) \
|
||||
POLYVOX_MSC_WARNING_POP
|
||||
|
||||
#define POLYVOX_THROW(type, message) \
|
||||
/* We use the do...while(0) construct in our macros (for reasons see here: http://stackoverflow.com/a/154138) \
|
||||
but Visual Studio gives unhelpful 'conditional expression is constant' warnings. The recommended solution \
|
||||
(http://stackoverflow.com/a/1946485) is to disable these warnings. */ \
|
||||
POLYVOX_MSC_WARNING_PUSH \
|
||||
POLYVOX_DISABLE_MSC_WARNING(4127) \
|
||||
do \
|
||||
{ \
|
||||
std::stringstream ss; \
|
||||
ss << message; \
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(ss.str()); \
|
||||
type except = (type)(ss.str()); \
|
||||
getThrowHandler()((except), __FILE__, __LINE__); \
|
||||
} while(0) \
|
||||
POLYVOX_MSC_WARNING_POP
|
||||
|
||||
#endif
|
||||
|
||||
namespace PolyVox
|
||||
{
|
||||
/// A general purpose exception to indicate that an operation cannot be peformed.
|
||||
class invalid_operation : public std::logic_error
|
||||
{
|
||||
public:
|
||||
explicit invalid_operation(const std::string& message)
|
||||
: logic_error(message.c_str()) {}
|
||||
|
||||
explicit invalid_operation(const char *message)
|
||||
: logic_error(message) {}
|
||||
};
|
||||
|
||||
/// Thrown to indicate that a function is deliberatly not implmented. For example, perhaps you called a function
|
||||
/// in a base class whereas you are supposed to use a derived class which implements the function, or perhaps the
|
||||
/// function is not defined for a particular template parameter. It may be that the function is required to
|
||||
/// compile sucessfully but it should not be called.
|
||||
class not_implemented : public std::logic_error
|
||||
{
|
||||
public:
|
||||
explicit not_implemented(const std::string& message)
|
||||
: logic_error(message.c_str()) {}
|
||||
|
||||
explicit not_implemented(const char *message)
|
||||
: logic_error(message) {}
|
||||
};
|
||||
}
|
||||
|
||||
#endif //__PolyVox_ErrorHandling_H__
|
||||
|
||||
177
include/PolyVox/Impl/ExceptionsImpl.h
Normal file
177
include/PolyVox/Impl/ExceptionsImpl.h
Normal file
@ -0,0 +1,177 @@
|
||||
/*******************************************************************************
|
||||
Copyright (c) 2005-2015 David Williams and Matthew Williams
|
||||
|
||||
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 __PolyVox_ExceptionsImpl_H__
|
||||
#define __PolyVox_ExceptionsImpl_H__
|
||||
|
||||
#include "PolyVox/Impl/Config.h"
|
||||
#include "PolyVox/Impl/Logging.h" // Exceptions can log when they are thrown.
|
||||
|
||||
#include <cstdlib> // For std::exit
|
||||
#include <iostream> // For std::cerr
|
||||
#include <stdexcept>
|
||||
#include <sstream>
|
||||
#include <string.h> // Exception constuctors take strings.
|
||||
#include <csignal>
|
||||
|
||||
#ifdef POLYVOX_THROW_ENABLED
|
||||
|
||||
namespace PolyVox
|
||||
{
|
||||
template< typename ExceptionType, typename ... Args >
|
||||
void polyvox_throw(Args const& ... messageArgs)
|
||||
{
|
||||
std::string message = Impl::argListToString(messageArgs...);
|
||||
#ifdef POLYVOX_LOG_ERROR_ENABLED
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(message);
|
||||
#endif
|
||||
throw ExceptionType(message);
|
||||
}
|
||||
|
||||
template< typename ExceptionType, typename ... Args >
|
||||
void polyvox_throw_if(bool condition, Args const& ... messageArgs)
|
||||
{
|
||||
if (condition) { polyvox_throw<ExceptionType>(messageArgs...); }
|
||||
}
|
||||
}
|
||||
|
||||
#define POLYVOX_THROW(type, ...) PolyVox::polyvox_throw<type>(__VA_ARGS__)
|
||||
#define POLYVOX_THROW_IF(condition, type, ...) PolyVox::polyvox_throw_if<type>(condition, __VA_ARGS__)
|
||||
|
||||
#else
|
||||
|
||||
namespace PolyVox
|
||||
{
|
||||
typedef void(*ThrowHandler)(std::exception& e, const char* file, int line);
|
||||
|
||||
inline void defaultThrowHandler(std::exception& e, const char* file, int line)
|
||||
{
|
||||
std::stringstream ss; \
|
||||
ss << "\n"; \
|
||||
ss << " PolyVox exception thrown!"; \
|
||||
ss << " ========================="; \
|
||||
ss << " PolyVox has tried to throw an exception but it was built without support"; \
|
||||
ss << " for exceptions. In this scenario PolyVox will call a 'throw handler'"; \
|
||||
ss << " and this message is being printed by the default throw handler."; \
|
||||
ss << "\n"; \
|
||||
ss << " If you don't want to enable exceptions then you should try to determine why"; \
|
||||
ss << " this exception was thrown and make sure it doesn't happen again. If it was"; \
|
||||
ss << " due to something like an invalid argument to a function then you should be"; \
|
||||
ss << " able to fix it quite easily by validating parameters as appropriate. More"; \
|
||||
ss << " complex exception scenarios (out of memory, etc) might be harder to fix and"; \
|
||||
ss << " you should replace this default handler with something which is more"; \
|
||||
ss << " meaningful to your users."; \
|
||||
ss << "\n"; \
|
||||
ss << " Exception details"; \
|
||||
ss << " -----------------"; \
|
||||
ss << " Line: " << line; \
|
||||
ss << " File: " << file; \
|
||||
ss << " Message: " << e.what(); \
|
||||
ss << "\n"; \
|
||||
PolyVox::Impl::getLoggerInstance()->logFatalMessage(ss.str()); \
|
||||
POLYVOX_HALT(); \
|
||||
}
|
||||
|
||||
inline ThrowHandler& getThrowHandlerInstance()
|
||||
{
|
||||
static ThrowHandler s_fThrowHandler = &defaultThrowHandler;
|
||||
return s_fThrowHandler;
|
||||
}
|
||||
|
||||
inline ThrowHandler getThrowHandler()
|
||||
{
|
||||
return getThrowHandlerInstance();
|
||||
}
|
||||
|
||||
inline void setThrowHandler(ThrowHandler fNewHandler)
|
||||
{
|
||||
getThrowHandlerInstance() = fNewHandler;
|
||||
}
|
||||
}
|
||||
|
||||
#define POLYVOX_THROW_IF(condition, type, message) \
|
||||
/* We use the do...while(0) construct in our macros (for reasons see here: http://stackoverflow.com/a/154138) \
|
||||
but Visual Studio gives unhelpful 'conditional expression is constant' warnings. The recommended solution \
|
||||
(http://stackoverflow.com/a/1946485) is to disable these warnings. */ \
|
||||
POLYVOX_MSC_WARNING_PUSH \
|
||||
POLYVOX_DISABLE_MSC_WARNING(4127) \
|
||||
do \
|
||||
{ \
|
||||
if ((condition)) \
|
||||
{ \
|
||||
std::stringstream ss; \
|
||||
ss << message; \
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(ss.str()); \
|
||||
type except = (type)(ss.str()); \
|
||||
getThrowHandler()((except), __FILE__, __LINE__); \
|
||||
} \
|
||||
} while(0) \
|
||||
POLYVOX_MSC_WARNING_POP
|
||||
|
||||
#define POLYVOX_THROW(type, message) \
|
||||
/* We use the do...while(0) construct in our macros (for reasons see here: http://stackoverflow.com/a/154138) \
|
||||
but Visual Studio gives unhelpful 'conditional expression is constant' warnings. The recommended solution \
|
||||
(http://stackoverflow.com/a/1946485) is to disable these warnings. */ \
|
||||
POLYVOX_MSC_WARNING_PUSH \
|
||||
POLYVOX_DISABLE_MSC_WARNING(4127) \
|
||||
do \
|
||||
{ \
|
||||
std::stringstream ss; \
|
||||
ss << message; \
|
||||
PolyVox::Impl::getLoggerInstance()->logErrorMessage(ss.str()); \
|
||||
type except = (type)(ss.str()); \
|
||||
getThrowHandler()((except), __FILE__, __LINE__); \
|
||||
} while(0) \
|
||||
POLYVOX_MSC_WARNING_POP
|
||||
|
||||
#endif
|
||||
|
||||
namespace PolyVox
|
||||
{
|
||||
/// A general purpose exception to indicate that an operation cannot be peformed.
|
||||
class invalid_operation : public std::logic_error
|
||||
{
|
||||
public:
|
||||
explicit invalid_operation(const std::string& message)
|
||||
: logic_error(message.c_str()) {}
|
||||
|
||||
explicit invalid_operation(const char *message)
|
||||
: logic_error(message) {}
|
||||
};
|
||||
|
||||
/// Thrown to indicate that a function is deliberatly not implmented. For example, perhaps you called a function
|
||||
/// in a base class whereas you are supposed to use a derived class which implements the function, or perhaps the
|
||||
/// function is not defined for a particular template parameter. It may be that the function is required to
|
||||
/// compile sucessfully but it should not be called.
|
||||
class not_implemented : public std::logic_error
|
||||
{
|
||||
public:
|
||||
explicit not_implemented(const std::string& message)
|
||||
: logic_error(message.c_str()) {}
|
||||
|
||||
explicit not_implemented(const char *message)
|
||||
: logic_error(message) {}
|
||||
};
|
||||
}
|
||||
|
||||
#endif //__PolyVox_ExceptionsImpl_H__
|
||||
Loading…
x
Reference in New Issue
Block a user