Exception.hpp

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2024, University of Oxford.
All rights reserved.
 
University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.
 
This file is part of Chaste.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
 
#ifndef _EXCEPTION_HPP_
#define _EXCEPTION_HPP_
 
#include <string>
#include <sstream>
#include <cfloat>  // For DBL_MAX
#include <climits> // For UINT_MAX & INT_MAX, necessary in gcc-4.3
#include <cstdlib> // Necessary in gcc-4.3 and later which don't include stdlib by default
#include <exception>
 
const unsigned UNSIGNED_UNSET = UINT_MAX;
const int INT_UNSET = INT_MAX;
const double DOUBLE_UNSET = DBL_MAX;
 
class Exception : public std::runtime_error
{
public:
    Exception(const std::string& rMessage, const std::string& rFilename, unsigned lineNumber);
 
    virtual ~Exception() = default;
 
    std::string GetMessage() const;
 
    std::string GetShortMessage() const;
 
    std::string CheckShortMessage(const std::string& rExpected) const;
 
    std::string CheckShortMessageContains(const std::string& rExpected) const;
 
    static void Terminate(const std::string& rMessage, const std::string& rFilename, unsigned lineNumber);
 
    virtual const char* what() const noexcept override;
 
protected:
    void SetMessage(const std::string& rMessage,
                    const std::string& rFilename, unsigned lineNumber);
 
private:
    std::string mMessage; 
    std::string mShortMessage; 
};
 
#define EXCEPTION(message)                           \
    do {                                             \
        std::stringstream msg_stream;                \
        msg_stream << message;                       \
        throw Exception(msg_stream.str(), __FILE__, __LINE__); \
    } while (false)
 
#include <boost/preprocessor/stringize.hpp>
 
#define EXCEPT_IF_NOT(test) \
    if (!(test)) EXCEPTION("Assertion tripped: " BOOST_PP_STRINGIZE(test))
 
#define EXCEPT_IF(test) \
    if (test) EXCEPTION("Assertion tripped: " BOOST_PP_STRINGIZE(test))
 
 
#define TERMINATE(message)                           \
    do {                                             \
        std::stringstream msg_stream;                \
        msg_stream << message;                       \
        Exception::Terminate(msg_stream.str(), __FILE__, __LINE__); \
    } while (false)
 
#define NEVER_REACHED  TERMINATE("Should have been impossible to reach this line of code"); exit(EXIT_FAILURE)
 
#ifdef NDEBUG
#define UNUSED_OPT(var) var=var
#else
#define UNUSED_OPT(var)
#endif
 
#define ABORT_IF_THROWS(block)          \
    try {                               \
        block;                          \
    } catch (const Exception& e) {      \
        TERMINATE(e.GetMessage());      \
    } catch (const std::exception &e) { \
        TERMINATE(e.what());            \
    } catch (...) {                     \
        TERMINATE("Unexpected exception thrown."); \
    }
 
 
// The macros below are deprecated.  In most cases, FileFinder routines should be used
// in preference to system() calls.
 
#define EXPECT0(cmd, arg) {      \
    std::string _arg(arg);       \
    int retcode = cmd(_arg.c_str()); \
    if (retcode != 0) {              \
        EXCEPTION("Error executing command: " #cmd "(" + _arg + ")"); \
    } }
 
 
#define ABORT_IF_NON0_WITH_MSG(retcode, msg)     \
    if (retcode != 0) {                          \
        TERMINATE(msg);                          \
    }
 
#define ABORT_IF_NON0(cmd, arg) { \
    std::string _arg(arg);        \
    int ret = cmd(_arg.c_str());  \
    ABORT_IF_NON0_WITH_MSG(ret, "Error executing command: " #cmd "(" + _arg + ")") \
    }
 
#define EXPECT_NON0(cmd, arg) {   \
    std::string _arg = (arg);     \
    int ret = cmd(_arg.c_str());  \
    if (ret == 0) {               \
        EXCEPTION("Command: " #cmd "(" + _arg + ") succeeded and it shouldn't have"); \
    } }
 
#define IGNORE_RET(cmd, arg) {   \
    std::string _arg = (arg);    \
    int ret = cmd(_arg.c_str()); \
    ret = ret;                   \
    }
 
#endif // _EXCEPTION_HPP_