X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FException.hh;h=42e1326fbca957754412da8b56985c5f48eb9953;hb=412024ed31a4ab4eaea7a4165a434f8efebee325;hp=7d56245b964cb12b4e60f6722451a9340193e2e0;hpb=f37ed4b85a6949cbe72ccb2d2ac098aebed57eaa;p=senf.git diff --git a/Utils/Exception.hh b/Utils/Exception.hh index 7d56245..42e1326 100644 --- a/Utils/Exception.hh +++ b/Utils/Exception.hh @@ -23,8 +23,8 @@ /** \file \brief Exception public header */ -#ifndef HH_Exception_ -#define HH_Exception_ 1 +#ifndef HH_SENF_Utils_Exception_ +#define HH_SENF_Utils_Exception_ 1 // Custom includes #include @@ -34,6 +34,7 @@ #include #include #include +#include //#include "Exception.mpp" ///////////////////////////////hh.p//////////////////////////////////////// @@ -41,7 +42,8 @@ /** \defgroup exception Exception classes All exceptions in %senf are derived from senf::Exception. This class adds the possibility to - extend the exception description while it is processed: + extend the exception description while it is processed. The functionality is provided by a mixin + class senf::ExceptionMixin: \code try { @@ -49,7 +51,7 @@ // Some code which might raise an arbitrary senf exception } - catch (senf::Exception & e) { + catch (senf::ExceptionMixin & e) { e << "\handling user " << user; throw; } @@ -63,8 +65,8 @@ try { // ... } - catch (senf::Exception & e) { - e << boost::format("\ncall id 0x%04x@%s") % id % address; + catch (senf::ExceptionMixin & e) { + e << boost::format("\n" "call id 0x%04x@%s") % id % address; } \endcode @@ -78,34 +80,146 @@ struct FooException : public senf::Exception { FooException() : senf::Exception("Foo hit the fan") {} }; \endcode + + If SENF is compiled in debug mode (SENF_DEBUG is defined), the exception message will + automatically include a stack backtrace. For this to work, you need to add the + -rdynamic option to all link commands. This feature depends on gcc and + the GNU-libc. + + To apply these features (extensibility, backtrace) to a non-senf exception, the non-senf + exception can be wrapped and re-thrown. + \code + void foo() { + try { + // ... code that might throw std::bad_cast or somelib::FooException + } + SENF_WRAP_EXC(std::bad_cast) + SENF_WRAP_EXC(somelib::FooException) + } + \endcode + The re-thrown exception can then be caught as std::bad_cast or as senf::ExceptionMixin + as needed. It is safe, to wrap an exception twice (the macro will detect this case). + \code + bar() { + try { + try { + foo(); + } + catch (senf::ExceptionMixin & ex) { + ex << "\n" "add this info"; + } + } + catch (std::bad_cast const & ex) { + std::cerr << ex.what() << std::endl; + } + \endcode + The final error output will include + \li a backtrace if compiled in debug mode + \li the original error message from the std::bad_cast exception + \li the additional error message "add this info" + + \todo Link against libcwd to add file-name/line-number information to the backtrace and remove + the dependency on -rdynamic + \todo Or better, use addr2line to obtain that information when showing the backtrace when + catched within Daemon (addr2line -fsiCe argv[0]) + \todo Add signal handlers for the bad signals which writes a backtrace to stderr and + terminates. This should probably write out a raw backtrace without de-mangling or + line-numbers since we don't want to mess with dynamic memory when the heap might be + corrupted ... Another handler for e.g. SIGUSR2 is nice to show a debug backtrace on demand */ namespace senf { - /** \brief Generic exception base-class + /** \brief Generic extensible exception mixin - Exception is a generic exception base-class which allows the exception to be later extended + ExceptionMixin is a generic exception mixin which allows the exception to be later extended by catching and re-throwing it (See example in \ref exception). \ingroup exception */ - class Exception - : public std::exception + class ExceptionMixin { public: - /////////////////////////////////////////////////////////////////////////// - ///\name Structors and default members - ///@{ + std::string const & message() const; + + void append(std::string text); ///< Extend exception description + /**< Adds \a text to the description text. */ + protected: + explicit ExceptionMixin(std::string const & description = ""); + ///< Initialize exception with string + /**< \a description is the initial error description + string. This should probably be a string constant + describing the exception for most derived + exceptions. */ + + private: +#ifdef SENF_DEBUG + void addBacktrace(); +#endif + std::string message_; + }; + + /** \brief Extensible exception base-class + + This base-class is an exception which already includes the ExceptionMixin. All SENF + exceptions are derived from this class. Other user-exception may be defined by deriving from + this class too. + + \see \ref exception + + \ingroup exception + */ + class Exception + : public ExceptionMixin, public std::exception + { + public: virtual ~Exception() throw(); - ///@} - /////////////////////////////////////////////////////////////////////////// + virtual char const * what() const throw(); + + protected: + explicit Exception(std::string const & description = ""); + }; + + /** \brief Wrapper for standard non-senf exceptions + + This class wraps an exception of type \a BaseException and adds functionality from + senf::ExceptionMixin. + + \ingroup exception + */ + template + class WrapException + : public ExceptionMixin, public BaseException + { + public: + typedef BaseException Base; + + WrapException(BaseException const & base); + virtual ~WrapException() throw(); virtual char const * what() const throw(); + }; + + /** \brief Wrap a non-senf exception - template - Exception & operator<<(Arg const & arg); ///< Extend exception description + This macro allows to wrap a non-senf exception adding functionality from ExceptionMixin + using the WrapException template. For an example, see \ref exception. + + \ingroup exception + */ +# define SENF_WRAP_EXC(Ex) \ + catch (Ex const & base) { \ + if (dynamic_cast(&base)) \ + throw; \ + else \ + throw senf::WrapException(base); \ + } + + template + typename boost::enable_if< boost::is_convertible, Exc & >::type + operator<<(Exc const & exc, Arg const & arg); ///< Extend exception description /**< Adds \a arg converted to string to the end of the exception description string. This operator allows to use Exception instances like streams. The conversion is @@ -113,17 +227,16 @@ namespace senf { therefor identical to a streaming operation. \see \ref exception */ - protected: - Exception(std::string const & description = ""); ///< Initialize exception with string - /**< \a description is the initial error description - string. This should probably be a string constant - describing the exception for most derived - exceptions. */ - - private: - std::string message_; - }; +# ifdef SENF_DEBUG +# define _SENF_EXC_DEBUG_ARGS ,char const * file=0,int line=0 +# define _SENF_EXC_DEBUG_ARGS_ND ,char const *file,int line +# define _SENF_EXC_DEBUG_ARGS_P ,file,line +# else +# define _SENF_EXC_DEBUG_ARGS +# define _SENF_EXC_DEBUG_ARGS_ND +# define _SENF_EXC_DEBUG_ARGS_P +# endif /** \brief Exception handling standard UNIX errors (errno) @@ -143,6 +256,18 @@ namespace senf { throw senf::SystemException(); \endcode + From within SENF (and only there because it depends on the \c SENF_DEBUG symbol), + SystemException should be thrown using wrapper macros which add additional information to + the exception description: + \code + // Standard usage: Take \c errno from environment + SENF_THROW_SYSTEM_EXCEPTION() + << " while opening configuration file: " << filename; + + // You may however explicitly specify the errno value + throw senf::SystemException("::open()", ENOFILE SENF_EXC_DEBUGINFO) + \endcode + \ingroup exception */ class SystemException : public Exception @@ -152,9 +277,9 @@ namespace senf { ///\name Structors and default members ///@{ - explicit SystemException(std::string const & where = ""); - explicit SystemException(int code); - SystemException(std::string const & where, int code); + explicit SystemException(std::string const & descr = "" _SENF_EXC_DEBUG_ARGS); + explicit SystemException(int code _SENF_EXC_DEBUG_ARGS); + SystemException(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS); virtual ~SystemException() throw(); @@ -162,7 +287,7 @@ namespace senf { /////////////////////////////////////////////////////////////////////////// int errorNumber() const; ///< Error code (\c errno number) - char const * description() const; ///< Error description (\c strerror() value) + char const * errorString() const; ///< Error string (\c strerror() value) bool anyOf(int c0, int c1=0, int c2=0, int c3=0, int c4=0, int c5=0, int c6=0, int c7=0, int c8=0, int c9=0); @@ -171,11 +296,20 @@ namespace senf { private: - void init(std::string const & where, int code); + void init(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS_ND); int code_; + std::string what_; }; +# ifdef SENF_DEBUG +# define SENF_EXC_DEBUGINFO ,__FILE__,__LINE__ +# else +# define SENF_EXC_DEBUGINFO +# endif + +# define SENF_THROW_SYSTEM_EXCEPTION(desc) throw senf::SystemException(desc SENF_EXC_DEBUGINFO) + } ///////////////////////////////hh.e//////////////////////////////////////// @@ -194,3 +328,4 @@ namespace senf { // compile-command: "scons -u test" // comment-column: 40 // End: +