Exception.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* 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 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees 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 OWNER 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 BLOCXX_EXCEPTION_HPP_INCLUDE_GUARD_
#define BLOCXX_EXCEPTION_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/AutoPtr.hpp"
#if defined(BLOCXX_NON_THREAD_SAFE_EXCEPTION_HANDLING)
#include "blocxx/CommonFwd.hpp" // for Mutex
#endif
#include <iosfwd>
#include <exception>
#include <new>

#include <cerrno>

namespace BLOCXX_NAMESPACE
{

class BLOCXX_COMMON_API Exception : public std::exception
{
protected:
   Exception(const char* file, int line, const char* msg) BLOCXX_DEPRECATED; // in 3.1.0
   Exception(const char* file, int line, const char* msg, int errorCode, const Exception* otherException = 0, int subClassId = UNKNOWN_SUBCLASS_ID);

   Exception(int subClassId, const char* file, int line, const char* msg, int errorCode,
      const Exception* otherException = 0) BLOCXX_DEPRECATED; // in 3.1.0 -
      // Had to change the order of the parameters so the subClassId could be
      // defaulted and the subclasses' signature could match the base class signature.

#ifdef BLOCXX_WIN32
   // Can't seem to catch exceptions by reference if copy CTOR is
   // protected on Windoz
public:
#endif
   Exception(const Exception& e);
   Exception& operator= (const Exception& rhs);
#ifdef BLOCXX_WIN32
protected:
#endif
   void swap(Exception& x);
   void setSubClassId(int subClassId);
   void setErrorCode(int errorCode);

public:
   virtual ~Exception() throw();

   static const int UNKNOWN_SUBCLASS_ID = -1;
   static const int UNKNOWN_ERROR_CODE = -1;

   virtual const char* type() const;
   virtual const char* getMessage() const;
   const char* getFile() const;
   int getLine() const;
   int getSubClassId() const;
   const Exception* getSubException() const;
   int getErrorCode() const;

   virtual const char* what() const throw();

   virtual Exception* clone() const;

   virtual void rethrow() const;

   char* dupString(const char* str);

private:
   char* m_file;
   int m_line;
   char* m_msg;
   int m_subClassId;
   const Exception* m_subException;
   int m_errorCode;

#if defined(BLOCXX_NON_THREAD_SAFE_EXCEPTION_HANDLING)
   static Mutex* m_mutex;
#endif

};


namespace ExceptionDetail
{

   // Reconciles GNU strerror_r and POSIX strerror_r.
   //
   BLOCXX_COMMON_API void portable_strerror_r(int errnum, char * buf, unsigned n);

   struct BLOCXX_COMMON_API FormatMsgImpl;

   class BLOCXX_COMMON_API FormatMsg
   {

#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

      AutoPtr<FormatMsgImpl> pImpl;

#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif

   public:
      FormatMsg(char const * msg, int errnum);
      ~FormatMsg();
      char const * get() const;
   private:
      FormatMsg(const FormatMsg&);
      FormatMsg& operator=(const FormatMsg&);
   };

   unsigned const BUFSZ = 1024;

   template <typename exType>
   struct Errno
   {
      static exType simple(char const * file, int line, int errnum)
      {
         char buf[BUFSZ];
         portable_strerror_r(errnum, buf, BUFSZ);
         return exType(file, line, buf, errnum);
      }

      template <typename Mtype>
      static exType format(char const * file, int line,
                           Mtype const & msg, int errnum)
      {
         return format(file, line, msg.c_str(), errnum);
      }

      static exType format(char const * file, int line,
                           char const * msg, int errnum)
      {
         FormatMsg fm(msg, errnum);
         return exType(file, line, fm.get(), errnum);
      }
   }; // struct Errno

} // namespace ExceptionDetail

BLOCXX_COMMON_API std::ostream& operator<< (std::ostream& os, const Exception& e);

#define BLOCXX_THROW(exType, msg) throw exType(__FILE__, __LINE__, (msg))

#define BLOCXX_THROWL(exType, line, msg) throw exType(__FILE__, (line), (msg))

#define BLOCXX_THROW_SUBEX(exType, msg, subex) \
throw exType(__FILE__, __LINE__, (msg), \
             ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, &(subex))

#define BLOCXX_THROW_ERR(exType, msg, err) \
throw exType(__FILE__, __LINE__, (msg), (err))

#define BLOCXX_THROW_ERRNO(exType) BLOCXX_THROW_ERRNO1(exType, errno)

#define BLOCXX_THROW_ERRNO1(exType, errnum) \
throw ::BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >::simple(__FILE__, __LINE__, (errnum))

#define BLOCXX_THROW_ERRNO_MSG(exType, msg) \
BLOCXX_THROW_ERRNO_MSG1(exType, (msg), errno)

#define BLOCXX_THROW_ERRNO_MSG1(exType, msg, errnum) \
throw ::BLOCXX_NAMESPACE::ExceptionDetail::Errno< exType >:: \
      format(__FILE__, __LINE__, (msg), (errnum))

#define BLOCXX_THROW_ERR_SUBEX(exType, msg, err, subex) \
throw exType(__FILE__, __LINE__, (msg), (err), &(subex))

#define BLOCXX_DECLARE_EXCEPTION2(NAME, BASE) \
class NAME##Exception : public BASE \
{ \
public: \
   NAME##Exception(const char* file, int line, const char* msg, int errorCode = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, const Exception* otherException = 0, int subClassId = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID); \
   virtual ~NAME##Exception() throw(); \
   virtual const char* type() const; \
   virtual NAME##Exception* clone() const; \
   virtual void rethrow() const; \
};

#define BLOCXX_DECLARE_APIEXCEPTION2(NAME, BASE, LINKAGE_SPEC) \
class LINKAGE_SPEC NAME##Exception : public BASE \
{ \
public: \
   NAME##Exception(const char* file, int line, const char* msg, int errorCode = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_ERROR_CODE, const Exception* otherException = 0, int subClassId = ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID); \
   virtual ~NAME##Exception() throw(); \
   virtual const char* type() const; \
   virtual NAME##Exception* clone() const; \
   virtual void rethrow() const; \
};




#define BLOCXX_DECLARE_EXCEPTION(NAME) BLOCXX_DECLARE_EXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception)

#define BLOCXX_DECLARE_APIEXCEPTION(NAME, LINKAGE_SPEC) BLOCXX_DECLARE_APIEXCEPTION2(NAME, ::BLOCXX_NAMESPACE::Exception, LINKAGE_SPEC)

#define BLOCXX_DEFINE_EXCEPTION2(NAME, BASE) \
NAME##Exception::NAME##Exception(const char* file, int line, const char* msg, int errorCode, const ::BLOCXX_NAMESPACE::Exception* otherException, int subClassId) \
   : BASE(file, line, msg, errorCode, otherException, subClassId) {} \
NAME##Exception::~NAME##Exception() throw() { } \
NAME##Exception* NAME##Exception::clone() const { return new(std::nothrow) NAME##Exception(*this); } \
const char* NAME##Exception::type() const { return #NAME "Exception"; }\
void NAME##Exception::rethrow() const { throw *this; }

#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, BASE, SUB_CLASS_ID) \
NAME##Exception::NAME##Exception(const char* file, int line, const char* msg, int errorCode, const ::BLOCXX_NAMESPACE::Exception* otherException, int subClassId) \
   : BASE(file, line, msg, errorCode, otherException, subClassId == ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID ? (SUB_CLASS_ID) : subClassId) {} \
NAME##Exception::~NAME##Exception() throw() { } \
NAME##Exception* NAME##Exception::clone() const { return new(std::nothrow) NAME##Exception(*this); } \
const char* NAME##Exception::type() const { return #NAME "Exception"; } \
void NAME##Exception::rethrow() const { throw *this; }

#define BLOCXX_DEFINE_EXCEPTION(NAME) BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::Exception::UNKNOWN_SUBCLASS_ID)

#define BLOCXX_DEFINE_EXCEPTION_WITH_ID(NAME) BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, ::BLOCXX_NAMESPACE::Exception, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)

#define BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID(NAME, BASE) BLOCXX_DEFINE_EXCEPTION_WITH_BASE_AND_ID_AUX(NAME, BASE, ::BLOCXX_NAMESPACE::ExceptionIds::NAME##ExceptionId)

} // end namespace BLOCXX_NAMESPACE

#endif