4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Exception public header */
27 #define HH_Exception_ 1
34 #include <boost/preprocessor/repeat.hpp>
35 #include <boost/preprocessor/cat.hpp>
36 #include <boost/utility.hpp>
38 //#include "Exception.mpp"
39 ///////////////////////////////hh.p////////////////////////////////////////
41 /** \defgroup exception Exception classes
43 All exceptions in %senf are derived from senf::Exception. This class adds the possibility to
44 extend the exception description while it is processed:
49 // Some code which might raise an arbitrary senf exception
52 catch (senf::Exception & e) {
53 e << "\handling user " << user;
58 This will add the user information to any %senf exception thrown. The Exception is however not a
59 stream. If you need to do more extensive formating, either use an intermediate string-stream or
60 use <a href="http://www.boost.org/libs/format/doc/format.html">Boost.Format</a>:
66 catch (senf::Exception & e) {
67 e << boost::format("\ncall id 0x%04x@%s") % id % address;
71 senf::SystemException is thrown for all operating system errors (failures which result in the
72 operating system setting the errno value). It is also derived from senf::Exception and can
73 therefore be extended as well.
75 Defining your own exception classes derived from senf::Exception is very simple:
78 struct FooException : public senf::Exception
79 { FooException() : senf::Exception("Foo hit the fan") {} };
85 /** \brief Generic exception base-class
87 Exception is a generic exception base-class which allows the exception to be later extended
88 by catching and re-throwing it (See example in \ref exception).
93 : public std::exception
96 ///////////////////////////////////////////////////////////////////////////
97 ///\name Structors and default members
100 virtual ~Exception() throw();
103 ///////////////////////////////////////////////////////////////////////////
105 virtual char const * what() const throw();
108 Exception & operator<<(Arg const & arg); ///< Extend exception description
109 /**< Adds \a arg converted to string to the end of the
110 exception description string. This operator allows to
111 use Exception instances like streams. The conversion is
112 performed using <code>boost::lexical_cast</code> and is
113 therefor identical to a streaming operation.
114 \see \ref exception */
117 Exception(std::string const & description = ""); ///< Initialize exception with string
118 /**< \a description is the initial error description
119 string. This should probably be a string constant
120 describing the exception for most derived
124 std::string message_;
128 # define _SENF_EXC_DEBUG_ARGS ,char const * file=0,int line=0
129 # define _SENF_EXC_DEBUG_ARGS_ND ,char const *file,int line
130 # define _SENF_EXC_DEBUG_ARGS_P ,file,line
132 # define _SENF_EXC_DEBUG_ARGS
133 # define _SENF_EXC_DEBUG_ARGS_ND
134 # define _SENF_EXC_DEBUG_ARGS_P
137 /** \brief Exception handling standard UNIX errors (errno)
139 This exception is thrown to signal generic \c errno failures. Normally the \c errno value is
140 automatically taken from the \c errno variable but it may also be specified explicitly:
143 // Standard usage: Take \c errno from environment
144 throw senf::SystemException("::open()")
145 << " while opening configuration file: " << filename;
147 // You may however explicitly specify the errno value
148 throw senf::SystemException("::open()", ENOFILE)
150 // Or leave the location information empty
151 throw senf::SystemException(ENOFILE);
152 throw senf::SystemException();
155 From within SENF (<em>and only there because it depends on the \c SENF_DEBUG symbol</em>),
156 SystemException should be thrown using wrapper macros which add additional information to
157 the exception description:
159 // Standard usage: Take \c errno from environment
160 SENF_THROW_SYSTEM_EXCEPTION()
161 << " while opening configuration file: " << filename;
163 // You may however explicitly specify the errno value
164 throw senf::SystemException("::open()", ENOFILE SENF_EXC_DEBUGINFO)
169 class SystemException : public Exception
172 ///////////////////////////////////////////////////////////////////////////
173 ///\name Structors and default members
176 explicit SystemException(std::string const & descr = "" _SENF_EXC_DEBUG_ARGS);
177 explicit SystemException(int code _SENF_EXC_DEBUG_ARGS);
178 SystemException(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS);
180 virtual ~SystemException() throw();
183 ///////////////////////////////////////////////////////////////////////////
185 int errorNumber() const; ///< Error code (\c errno number)
186 char const * errorString() const; ///< Error string (\c strerror() value)
188 bool anyOf(int c0, int c1=0, int c2=0, int c3=0, int c4=0, int c5=0,
189 int c6=0, int c7=0, int c8=0, int c9=0);
190 ///< \c true, if errorNumber() is one of \a c0 ... \a c9
195 void init(std::string const & descr, int code _SENF_EXC_DEBUG_ARGS_ND);
202 # define SENF_EXC_DEBUGINFO ,__FILE__,__LINE__
204 # define SENF_EXC_DEBUGINFO
207 # define SENF_THROW_SYSTEM_EXCEPTION(desc) throw SystemException(desc SENF_EXC_DEBUGINFO)
211 ///////////////////////////////hh.e////////////////////////////////////////
212 #include "Exception.cci"
213 //#include "Exception.ct"
214 #include "Exception.cti"
221 // c-file-style: "senf"
222 // indent-tabs-mode: nil
223 // ispell-local-dictionary: "american"
224 // compile-command: "scons -u test"
225 // comment-column: 40