// $Id$
//
-// Copyright (C) 2006
+// Copyright (C) 2006
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+/** \file
+ \brief Exception public header */
+
#ifndef HH_Exception_
#define HH_Exception_ 1
// Custom includes
#include <exception>
#include <string>
+#include <boost/preprocessor/repeat.hpp>
+#include <boost/preprocessor/cat.hpp>
//#include "Exception.mpp"
///////////////////////////////hh.p////////////////////////////////////////
-namespace satcom {
-namespace lib {
+/** \defgroup exception System exceptions
+
+ The senf::SystemException class and it's derived class template senf::ErrnoException are used to
+ signal generic system failures based on \c errno codes.
+
+ senf::SystemException is a generic \c errno based exception which carries an error number and
+ origin information. senf::ErrnoException is a derived class specialized for a specific error
+ code. This simplifies managing error conditions:
+
+ \code
+ try {
+ something.open(path);
+ // ...
+ }
+ catch (senf::ErrnoException<ENOFILE> & e) {
+ // Create new file
+ }
+ catch (senf::SystemException & e) {
+ // Catch all other system exceptions
+ std::cerr << "Error accessing '" << path << "': " << e.what() << std::endl;
+ }
+ \endcode
+
+ This exception is normally thrown using the senf::throwErrno() helper:
+
+ \code
+ if ((fd = ::open(path.c_str(), O_RDWR)) < 0)
+ senf::throwErrno("::open()");
+ \endcode
+
+ The senf::throwErrno() helper will throw the correct exception class based on some \c errno
+ value.
+ */
+
+namespace senf {
- struct SystemException : public std::exception
+ /** \brief Exception handling standard UNIX errors (errno)
+
+ This exception is thrown to signal generic \c errno failures. In addition to the \c errno
+ number (the code()), this class manages optional origin information. This parameter should
+ be provided to further describe, in what context the exception was created.
+
+ This exception should not be used directly. Instead the derived class ErrnoException should
+ be thrown via one of the senf::throwErrno() helpers.
+
+ \see ErrnoException
+ \ingroup exception
+ */
+ class SystemException : public std::exception
{
- explicit SystemException(int err_) : where(0), err(err_) { init(); }
- SystemException(char const * where_, int err_) : where(where_), err(err_) { init(); }
+ public:
+ SystemException(); ///< SystemException without error location infor
+ /**< The error code is taken from the current value of the
+ global \c errno variable */
+
+ explicit SystemException(int code); ///< SystemException without error location info
+ /**< \param[in] code error number (the \c errno value) */
+
+ explicit SystemException(char const * where); ///< SystemException with error location info
+ /**< The error code is taken from the current value of the
+ global \c errno variable
+ \param[in] where description of error origin */
+
+ SystemException(char const * where, int code); ///< SystemException with error location info
+ /**< \param[in] where description of error origin
+ \param[in] code error number (the \c errno value) */
+
+ virtual char const * what() const throw(); ///< Return verbose error description
- virtual char const * what() const throw();
+ char const * where() const; ///< Error origin
+ int code() const; ///< Error code (\c errno number)
+ char const * description() const; ///< Error description (strerror() value)
- char const * where;
- int err;
+ 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);
+ ///< \c true, if code() is one of \a c0 ... \a c9
+
+ virtual ~SystemException() throw();
- virtual ~SystemException() throw() {}
private:
void init();
- std::string buffer_;
+
+ char const * const where_;
+ int const code_; // This must be const to make the derived ErrnoException
+ // class a valid derived class.
+ std::string buffer_;
+ };
+
+ /** \brief Error specific system exception
+
+ This template restricts the generic SystemException to a specific, compile-time constant
+ error number \p Code. This allows a specific \c errno number to be cached explicitly.
+
+ This exception is normally thrown via one of the senf::throwErrno() helpers. These helpers
+ take the numeric \c errno value (either from the \c errno variable or from their
+ argument) and will throw the corresponding ErrnoException:
+ \code
+ if ((fd = ::open(filename, O_RDWR)) < 0)
+ senf::throwErrno("open()");
+ \endcode
+ \ingroup exception
+ */
+ template <int Code>
+ class ErrnoException : public SystemException
+ {
+ public:
+ static int const fixed_code = Code;
+
+ ErrnoException(); ///< ErrnoException without error location information
+ explicit ErrnoException(char const * where);
+ ///< ErrnoException with error location information
};
+
-}}
+ /** \brief Throw ErrnoException based on current \c errno value
+ \ingroup exception
+ */
+ void throwErrno();
+
+ /** \brief Throw ErrnoException based on current \c errno value (with location info)
+ \ingroup exception
+ */
+ void throwErrno(char const * where);
+
+ /** \brief Throw ErrnoException based on given \c errno value
+ \ingroup exception
+ */
+ void throwErrno(int code);
+
+ /** \brief Throw ErrnoException based on given \c errno value (with location info)
+ \ingroup exception
+ */
+ void throwErrno(char const * where, int code);
+
+ enum NoThrow_t { nothrow };
+
+}
///////////////////////////////hh.e////////////////////////////////////////
-//#include "Exception.cci"
+#include "Exception.cci"
//#include "Exception.ct"
-//#include "Exception.cti"
+#include "Exception.cti"
#endif
\f
// Local Variables:
// mode: c++
-// c-file-style: "satcom"
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
// End:
projects / senf.git / blobdiff