Utils/Exception.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Exception public header */
  25
  26 #ifndef HH_SENF_Utils_Exception_
  27 #define HH_SENF_Utils_Exception_ 1
  28
  29 // Custom includes
  30 #include <exception>
  31 #include <string>
  32 #include <iostream>
  33 #include <sstream>
  34 #include <boost/preprocessor/repeat.hpp>
  35 #include <boost/preprocessor/cat.hpp>
  36 #include <boost/utility.hpp>
  37 #include <boost/type_traits/is_convertible.hpp>
  38
  39 //#include "Exception.mpp"
  40 ///////////////////////////////hh.p////////////////////////////////////////
  41
  42 /** \defgroup exception Exception classes
  43
  44     All exceptions in %senf are derived from senf::Exception. This class adds the possibility to
  45     extend the exception description while it is processed. The functionality is provided by a mixin
  46     class senf::ExceptionMixin:
  47
  48     \code
  49     try {
  50
  51         // Some code which might raise an arbitrary senf exception
  52
  53     }
  54     catch (senf::ExceptionMixin & e) {
  55         e << "\handling user " << user;
  56         throw;
  57     }
  58     \endcode
  59
  60     This will add the user information to any %senf exception thrown. The Exception is however not a
  61     stream. If you need to do more extensive formating, either use an intermediate string-stream or
  62     use <a href="http://www.boost.org/libs/format/doc/format.html">Boost.Format</a>:
  63
  64     \code
  65     try {
  66         // ...
  67     }
  68     catch (senf::ExceptionMixin & e) {
  69         e << boost::format("\n" "call id 0x%04x@%s") % id % address;
  70     }
  71     \endcode
  72
  73     senf::SystemException is thrown for all operating system errors (failures which result in the
  74     operating system setting the errno value). It is also derived from senf::Exception and can
  75     therefore be extended as well.
  76
  77     Defining your own exception classes derived from senf::Exception is very simple:
  78
  79     \code
  80     struct FooException : public senf::Exception
  81     { FooException() : senf::Exception("Foo hit the fan") {} };
  82     \endcode
  83
  84     If SENF is compiled in debug mode (SENF_DEBUG is defined), the exception message will
  85     automatically include a stack backtrace. For this to work, you need to add the
  86     <tt>-rdynamic</tt> option to all link commands. This feature depends on <tt>gcc</tt> and
  87     the GNU-libc.
  88
  89     To apply these features (extensibility, backtrace) to a non-senf exception, the non-senf
  90     exception can be wrapped and re-thrown.
  91     \code
  92     void foo() {
  93         try {
  94             // ... code that might throw std::bad_cast or somelib::FooException
  95         }
  96         SENF_WRAP_EXC(std::bad_cast)
  97         SENF_WRAP_EXC(somelib::FooException)
  98     }
  99     \endcode
 100     The re-thrown exception can then be caught as <tt>std::bad_cast</tt> or as senf::ExceptionMixin
 101     as needed. It is safe, to wrap an exception twice (the macro will detect this case).
 102     \code
 103     bar() {
 104     try {
 105         try {
 106             foo();
 107         }
 108         catch (senf::ExceptionMixin & ex) {
 109             ex << "\n" "add this info";
 110         }
 111     }
 112     catch (std::bad_cast const & ex) {
 113         std::cerr << ex.what() << std::endl;
 114     }
 115     \endcode
 116     The final error output will include
 117     \li a backtrace if compiled in debug mode
 118     \li the original error message from the <tt>std::bad_cast</tt> exception
 119     \li the additional error message "add this info"
 120
 121     \todo Link against libcwd to add file-name/line-number information to the backtrace and remove
 122         the dependency on -rdynamic
 123     \todo Or better, use addr2line to obtain that information when showing the backtrace when
 124         catched within Daemon (<tt>addr2line -fsiCe argv[0]</tt>)
 125     \todo Add signal handlers for the bad signals which writes a backtrace to stderr and
 126         terminates. This should probably write out a raw backtrace without de-mangling or
 127         line-numbers since we don't want to mess with dynamic memory when the heap might be
 128         corrupted ... Another handler for e.g. SIGUSR2 is nice to show a debug backtrace on demand
 129  */
 130
 131 namespace senf {
 132
 133     /** \brief Generic extensible exception mixin
 134
 135         ExceptionMixin is a generic exception mixin which allows the exception to be later extended
 136         by catching and re-throwing it (See example in \ref exception).
 137
 138         \ingroup exception
 139       */
 140     class ExceptionMixin
 141     {
 142     public:
 143         std::string const & message() const;
 144
 145         void append(std::string text); ///< Extend exception description
 146                                         /**< Adds \a text to the description text. */
 147
 148     protected:
 149         explicit ExceptionMixin(std::string const & description = "");
 150                                         ///< Initialize exception with string
 151                                         /**< \a description is the initial error description
 152                                              string. This should probably be a string constant
 153                                              describing the exception for most derived
 154                                              exceptions. */
 155
 156     private:
 157 #ifdef SENF_DEBUG
 158         void addBacktrace();
 159 #endif
 160         std::string message_;
 161     };
 162
 163     /** \brief Extensible exception base-class
 164
 165         This base-class is an exception which already includes the ExceptionMixin. All SENF
 166         exceptions are derived from this class. Other user-exception may be defined by deriving from
 167         this class too.
 168
 169         \see \ref exception
 170
 171         \ingroup exception
 172      */
 173     class Exception
 174         : public ExceptionMixin, public std::exception
 175     {
 176     public:
 177         virtual ~Exception() throw();
 178
 179         virtual char const * what() const throw();
 180
 181     protected:
 182         explicit Exception(std::string const & description = "");
 183     };
 184
 185     /** \brief Wrapper for standard non-senf exceptions
 186
 187         This class wraps an exception of type \a BaseException and adds functionality from
 188         senf::ExceptionMixin.
 189
 190         \ingroup exception
 191      */
 192     template <class BaseException>
 193     class WrapException
 194         : public ExceptionMixin, public BaseException
 195     {
 196     public:
 197         typedef BaseException Base;
 198
 199         WrapException(BaseException const & base);
 200         virtual ~WrapException() throw();
 201
 202         virtual char const * what() const throw();
 203     };
 204
 205     /** \brief Wrap a non-senf exception
 206
 207         This macro allows to wrap a non-senf exception adding functionality from ExceptionMixin
 208         using the WrapException template. For an example, see \ref exception.
 209
 210         \ingroup exception
 211      */
 212 #   define SENF_WRAP_EXC(Ex)                                                                      \
 213         catch (Ex const & base) {                                                                 \
 214             if (dynamic_cast<senf::ExceptionMixin const *>(&base))                                \
 215                 throw;                                                                            \
 216             else                                                                                  \
 217                 throw senf::WrapException<Ex>(base);                                              \
 218         }
 219
 220     template <class Exc, class Arg>
 221     typename boost::enable_if< boost::is_convertible<Exc*,ExceptionMixin*>, Exc & >::type
 222     operator<<(Exc const & exc, Arg const & arg); ///< Extend exception description
 223                                         /**< Adds \a arg converted to string to the end of the
 224                                              exception description string. This operator allows to
 225                                              use Exception instances like streams. The conversion is
 226                                              performed using <code>boost::lexical_cast</code> and is
 227                                              therefor identical to a streaming operation.
 228                                              \see \ref exception */
 229
 230
 231 #   ifdef SENF_DEBUG
 232 #       define _SENF_EXC_DEBUG_ARGS ,char const * file=0,int line=0
 233 #       define _SENF_EXC_DEBUG_ARGS_ND ,char const *file,int line
 234 #       define _SENF_EXC_DEBUG_ARGS_P ,file,line
 235 #   else
 236 #       define _SENF_EXC_DEBUG_ARGS
 237 #       define _SENF_EXC_DEBUG_ARGS_ND
 238 #       define _SENF_EXC_DEBUG_ARGS_P
 239 #   endif
 240
 241     /** \brief Exception handling standard UNIX errors (errno)
 242
 243         This exception is thrown to signal generic \c errno failures. Normally the \c errno value is
 244         automatically taken from the \c errno variable but it may also be specified explicitly:
 245
 246         \code
 247         // Standard usage: Take \c errno from environment
 248         throw senf::SystemException("::open()")
 249             << " while opening configuration file: " << filename;
 250
 251         // You may however explicitly specify the errno value
 252         throw senf::SystemException("::open()", ENOFILE)
 253
 254         // Or leave the location information empty
 255         throw senf::SystemException(ENOFILE);
 256         throw senf::SystemException();
 257         \endcode
 258
 259         From within SENF (<em>and only there because it depends on the \c SENF_DEBUG symbol</em>),
 260         SystemException should be thrown using wrapper macros which add additional information to
 261         the exception description:
 262         \code
 263         // Standard usage: Take \c errno from environment
 264         SENF_THROW_SYSTEM_EXCEPTION()
 265             << " while opening configuration file: " << filename;
 266
 267         // You may however explicitly specify the errno value
 268         throw senf::SystemException("::open()", ENOFILE SENF_EXC_DEBUGINFO)
 269         \endcode
 270
 271         \ingroup exception
 272      */
 273     class SystemException : public Exception
 274     {
 275     public:
 276         ///////////////////////////////////////////////////////////////////////////
 277         ///\name Structors and default members
 278         ///@{
 279
 280         explicit SystemException(std::string const & descr = "" _SENF_EXC_DEBUG_ARGS);
 281         explicit SystemException(int code _SENF_EXC_DEBUG_ARGS);
 282         SystemException(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS);
 283
 284         virtual ~SystemException() throw();
 285
 286         ///@}
 287         ///////////////////////////////////////////////////////////////////////////
 288
 289         int errorNumber() const;        ///< Error code (\c errno number)
 290         char const * errorString() const; ///< Error string (\c strerror() value)
 291
 292         bool anyOf(int c0, int c1=0, int c2=0, int c3=0, int c4=0, int c5=0,
 293                    int c6=0, int c7=0, int c8=0, int c9=0);
 294                                         ///< \c true, if errorNumber() is one of \a c0 ... \a c9
 295
 296
 297
 298     private:
 299         void init(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS_ND);
 300
 301         int code_;
 302         std::string what_;
 303     };
 304
 305 #   ifdef SENF_DEBUG
 306 #       define SENF_EXC_DEBUGINFO ,__FILE__,__LINE__
 307 #   else
 308 #       define SENF_EXC_DEBUGINFO
 309 #   endif
 310
 311 #   define SENF_THROW_SYSTEM_EXCEPTION(desc) throw senf::SystemException(desc SENF_EXC_DEBUGINFO)
 312
 313 }
 314
 315 ///////////////////////////////hh.e////////////////////////////////////////
 316 #include "Exception.cci"
 317 //#include "Exception.ct"
 318 #include "Exception.cti"
 319 #endif
 320
 321 \f
 322 // Local Variables:
 323 // mode: c++
 324 // fill-column: 100
 325 // c-file-style: "senf"
 326 // indent-tabs-mode: nil
 327 // ispell-local-dictionary: "american"
 328 // compile-command: "scons -u test"
 329 // comment-column: 40
 330 // End:
 331