etl/error_handler.h
John Wellbelove 632bc59f9c Modified the error system.
Remove ETL_ERROR and replaced with ETL_ASSERT.
ETL_ASSERT will eveluate to 'true' in all cases except for error logging.
This will allow 'if' statements that contain the macro to be optimised away for all cases except logging.
Added ETL_NO_CHECKS and ETL_LOG_ERRORS macro checks.

The options are now:-
ETL_NO_CHECKS         ETL_ASSERT does nothing. Evaluates to 'true'.
ETL_THROW_EXCEPTIONS) ETL_ASSERT throws an exception if the condition fails. Evaluates to 'true'.
ETL_LOG_ERRORS        ETL_ASSERT logs the error if the condition fails. Evaluates to the result of the condition.
If none of the above are defined:-
NDEBUG ETL_ASSERT does nothing. Evaluates to 'true'.
Otherwise:-
ETL_ASSERT asserts if the condition fails. Evaluates to 'true'.
2015-12-10 13:45:29 +00:00

111 lines
4.5 KiB
C++

///\file
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
Copyright(c) 2014 jwellbelove
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
#ifndef __ETL_ERROR_HANDLER__
#define __ETL_ERROR_HANDLER__
///\defgroup error_handler error_handler
/// Error handler for when throwing exceptions is not required.
///\ingroup utilities
#include <assert.h>
#include "exception.h"
#include "function.h"
namespace etl
{
//***************************************************************************
/// Error handler for when throwing exceptions is not required.
///\ingroup error_handler
//***************************************************************************
class error_handler
{
public:
//*************************************************************************
/// Callback class for free handler functions.
//*************************************************************************
struct free_function : public function<void, const exception&>
{
free_function(void (*p_function)(const exception&))
: function<void, const exception&>(p_function)
{
}
};
//*************************************************************************
/// Callback class for member handler functions.
//*************************************************************************
template <typename TObject>
struct member_function : public function<TObject, const exception&>
{
member_function(TObject& object, void(TObject::*p_function)(const exception&))
: function<TObject, const exception&>(object, p_function)
{
}
};
static void set_callback(ifunction<const exception&>& f);
static void error(const exception& e);
private:
static ifunction<const exception&>* p_ifunction;
};
//***************************************************************************
/// Asserts a coondition.
/// Versions of the macro that return a constant value of 'true' will allow the compiler to optimise away
/// any 'if' statements that it is contained within.
/// If ETL_NO_CHECKS is defined then no runtime checks are executed at all.
/// If ETL_THROW_EXCEPTIONS is defined then the error is thrown if the assert fails. The return value is always 'true'.
/// If ETL_LOG_ERRORS is defined then the error is logged if the assert fails. The return value is the value of the boolean test.
/// Otherwise 'assert' is called. The return value is always 'true'.
///\ingroup error_handler
//***************************************************************************
#if defined(ETL_NO_CHECKS)
#define ETL_ASSERT(b, e) (true) // Does nothing. Evaluates to 'true'.
#elif defined(ETL_THROW_EXCEPTIONS)
#define ETL_ASSERT(b, e) (((b) ? true : throw((e))), true) // Throws an exception if the condition fails. Evaluates to 'true'.
#elif defined (ETL_LOG_ERRORS)
#define ETL_ASSERT(b, e) (((b) ? true : etl::error_handler::error((e))), (b)) // Logs the error if the condition fails. Evaluates to the result of the condition.
#else
#if defined(NDEBUG)
#define ETL_ASSERT(b, e) (true) // Does nothing. Evaluates to 'true'.
#elif
#define ETL_ASSERT(b, e) ((assert((b))), true) // Asserts if the condition fails. Evaluates to 'true'.
#endif
#endif
}
#endif