added an exception class for my ULE decoder

[senf.git] / Utils / Exception.hh

diff --git a/Utils/Exception.hh b/Utils/Exception.hh
index 6c3e8b1..37f18d3 100644 (file)
--- a/Utils/Exception.hh
+++ b/Utils/Exception.hh
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2006 
+// Copyright (C) 2006
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
@@ -20,29 +20,63 @@
 // 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 "Exception.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
-namespace satcom {
-namespace lib {
+namespace senf {
+
+    /** \brief Exception handling standard UNIX errors (errno)
+
+        This exception is thrown to signal generic errno failures.
+
+        \todo make where and err accessors and make the member vars private
+
+        \idea Add a template class derived from SystemException which
+        takes the error number as a numeric argument. This allows
+        catching specific errno conditions: ErrnoException<EPIPE> etc.
 
-    struct SystemException : public std::exception
+        \idea Add a generic error thrower which takes the origin
+        string and errno value as an argument and will throw a
+        corresponding template class instance. This would just be a
+        big switch statement containing all possible errno values,
+        probably created using some macro metaprogramming.
+     */
+    class SystemException : public std::exception
     {
-        SystemException(int err_) : err(err_) {};
-        virtual char const * what() const throw();
-        int err;
+    public:
+        explicit SystemException(int err); ///< SystemException without error lokus info
+                                        /**< \param[in] err error number (the errno value) */
+        SystemException(char const * where, int err); ///< SystemException with error location info
+                                        /**< \param[in] where description of error origin
+                                             \param[in] err error number (the errno value) */
+
+        virtual char const * what() const throw(); ///< Return verbose error description
+
+        char const * where; ///< Error origin
+        int err; ///< Error number
+
+        virtual ~SystemException() throw();
+    private:
+        void init();
+        std::string buffer_;
     };
-    
-}}
+
+    enum NoThrow_t { nothrow };
+
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
-//#include "Exception.cci"
+#include "Exception.cci"
 //#include "Exception.ct"
 //#include "Exception.cti"
 #endif
@@ -50,5 +84,10 @@ namespace lib {
 \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: