IpException.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13
//
// This file contains a base class for all exceptions and a set of macros to help with exceptions.
 
#ifndef __IPEXCEPTION_HPP__
#define __IPEXCEPTION_HPP__
 
#include "IpUtils.hpp"
#include "IpJournalist.hpp"
 
/* for the exception classes, __attribute__((__visibility__("default"))) needs to be used
 * also by libraries that link against an Ipopt shared library on macOS/clang,
 * since otherwise the exceptions cannot be recognized by a catch() in the user code
 * (https://stackoverflow.com/questions/11913151/catching-derived-exceptions-types-fails-on-clang-macos-x)
 */
#if defined(__GNUC__) && __GNUC__ >= 4
#define IPOPTEXCEPTION_EXPORT __attribute__((__visibility__("default")))
#else
#define IPOPTEXCEPTION_EXPORT IPOPTLIB_EXPORT
#endif
 
namespace Ipopt
{

class IPOPTEXCEPTION_EXPORT IpoptException
{
public:

   IpoptException(
      const std::string& msg,
      const std::string& file_name,
      Index              line_number,
      const std::string& type = "IpoptException"
   )
      : msg_(msg),
        file_name_(file_name),
        line_number_(line_number),
        type_(type)
   { }

   IpoptException(
      const IpoptException& copy
   )
      : msg_(copy.msg_),
        file_name_(copy.file_name_),
        line_number_(copy.line_number_),
        type_(copy.type_)
   { }

   virtual ~IpoptException()
   { }


   void ReportException(
      const Journalist& jnlst,
      EJournalLevel     level = J_ERROR
   ) const
   {
      jnlst.Printf(level, J_MAIN,
                   "Exception of type: %s in file \"%s\" at line %" IPOPT_INDEX_FORMAT ":\n Exception message: %s\n", type_.c_str(), file_name_.c_str(), line_number_, msg_.c_str());
   }
 
   const std::string& Message() const
   {
      return msg_;
   }
 
private:

   IpoptException();

   void operator=(
      const IpoptException&
   );
 
   std::string msg_;
   std::string file_name_;
   Index       line_number_;
   std::string type_;
};
 
} // namespace Ipopt
 
#define THROW_EXCEPTION(__except_type, __msg) \
  throw __except_type( (__msg), (__FILE__), (__LINE__) );
 
#define ASSERT_EXCEPTION(__condition, __except_type, __msg) \
  if (! (__condition) ) { \
    std::string newmsg = #__condition; \
    newmsg += " evaluated false: "; \
    newmsg += __msg; \
    throw __except_type( (newmsg), (__FILE__), (__LINE__) ); \
  }
 
#define DECLARE_STD_EXCEPTION(__except_type) \
    class IPOPTEXCEPTION_EXPORT  __except_type : public Ipopt::IpoptException \
    { \
    public: \
      __except_type(const std::string& msg, const std::string& fname, Ipopt::Index line) \
      : Ipopt::IpoptException(msg,fname,line, #__except_type) {} \
      __except_type(const __except_type& copy) \
      : Ipopt::IpoptException(copy) {} \
    private: \
       __except_type(); \
       void operator=(const __except_type&); \
    }
 
#endif