exceptions.h

Go to the documentation of this file.

/*
 * Copyright (C) <2012-2024> <EDF-DTG> <FRANCE>
 * This file is part of Code_TYMPAN (R).
 * Code_TYMPAN (R) 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.
 * Code_TYMPAN (R) 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 Code_TYMPAN (R). If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TY_EXCEPTIONS
#define TY_EXCEPTIONS
 
#include <string>
#include <sstream>
#include <cassert>
#include <exception>
#include <deque>
 
#include <boost/exception/all.hpp>
#include <boost/current_function.hpp>
#include <boost/throw_exception.hpp>
#include <boost/config.hpp>
 
// Beware : Stuff::operator<< must be defined in the same namespace as Stuff
 
// For GTest related pretty-printing please see :
// http://code.google.com/p/googletest/wiki/AdvancedGuide#Teaching_Google_Test_How_to_Print_Your_Values
 
// For boost::exception diagnostic please see:
// http://www.boost.org/doc/libs/1_54_0/libs/exception/doc/diagnostic_information.html
 
template <typename T> std::string tympan_to_string(const T& o)
{
    using namespace std;
    stringstream ss;
    ss << o;
    return ss.str();
}
 
namespace tympan
{
 
// We use the boost::exception to add information to exception classes.
// Cf. http://www.boost.org/doc/libs/1_54_0/libs/exception/doc/tutorial_transporting_data.html
 
struct exception : /* virtual std::exception,*/ virtual boost::exception
{
};
 
struct logic_error : /*virtual*/ std::logic_error, virtual tympan::exception
{
    logic_error() : std::logic_error("Code_TYMPAN internal logic error"){};
    logic_error(const std::string& desc) : std::logic_error(desc){};
};
 
struct invalid_data : /*virtual*/ std::runtime_error, virtual tympan::exception
{
    invalid_data() : std::runtime_error("Code_TYMPAN invalid data encountered"){};
    invalid_data(const std::string& desc) : std::runtime_error(desc){};
};
 
/* NB : the commented-out virtual inheritance in logic_error and invalid_data is
 * important : otherwise the classe derived from those would need to call the
 * std::logic_error or std::runtime_error constructor.
 * The point is std::logic_error and std::runtime_error inherits *non*-virtualy
 * from std::exception, so that the inheritance of tympan::exception from
 * has std::exception to be removed even if semantically it would be relevant.
 */
 
} // namespace tympan
 
#define tympan_source_loc                                                                                    \
    ::boost::throw_function(BOOST_CURRENT_FUNCTION)                                                          \
        << ::boost::throw_file(__FILE__) << ::boost::throw_line((int)__LINE__)
 
#endif // TY_EXCEPTIONS