summaryrefslogtreecommitdiffabout
authorMichael Krelin <hacker@klever.net>2006-12-12 12:59:26 (UTC)
committer Michael Krelin <hacker@klever.net>2006-12-12 12:59:26 (UTC)
commit4c22006b8012bafccf955c0d077971e67107ac35 (patch) (side-by-side diff)
tree0a2c5748204a701576b8951e7658066e8e1c9c2b
parent08868f34ee339540ca392bb19e9c537d6e769464 (diff)
downloadkonforka-4c22006b8012bafccf955c0d077971e67107ac35.zip
konforka-4c22006b8012bafccf955c0d077971e67107ac35.tar.gz
konforka-4c22006b8012bafccf955c0d077971e67107ac35.tar.bz2
a few exception-handling convenience definitions
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--include/konforka/exception.h31
1 files changed, 31 insertions, 0 deletions
diff --git a/include/konforka/exception.h b/include/konforka/exception.h
index 5e0bf96..dbfe27c 100644
--- a/include/konforka/exception.h
+++ b/include/konforka/exception.h
@@ -1,124 +1,155 @@
#ifndef __KONFORKA_EXCEPTION_H
#define __KONFORKA_EXCEPTION_H
#include <exception>
#include <string>
#include <list>
/**
* @file
* @brief exception-related stuff.
*
* Basic exception-related declarations and definitions.
*/
/**
* @def CODEPOINT
* the convenience definition of the parameters passed to the
* konforka::code_point constructor.
*/
#define CODEPOINT __FILE__,__PRETTY_FUNCTION__,__LINE__
/**
* @def NOCODEPOINT
* the convenience definition for the codepoint denoting no particular point in
* code.
*/
#define NOCODEPOINT "no information"
/**
+ * @def KONFORKA_RETHROW
+ * the convenience definition for seeing the exception and rethrowing it further.
+ */
+#define KONFORKA_RETHROW catch(konforka::exception& e) { e.see(CODEPOINT); throw; }
+
+/**
+ * @def KONFORKA_E_ARGS
+ * the convenience definition for naming codepoint parameters
+ */
+#define KONFORKA_E_PARS const string& fi,const string& fu,int l,const string& w
+
+/**
+ * @def KONFORKA_E_CONS
+ * the convenience definition for passing parameters to constructor
+ */
+#define KONFORKA_E_CONS fi,fu,l,w
+
+/**
+ * @def KONFORKA_E_SUBCLASS
+ * the convenience definition for subclassing konforka exceptions
+ * @param base base class
+ * @param derived derived class
+ */
+#define KONFORKA_E_SUBCLASS(derived,base) \
+ class derived : public base { \
+ public: \
+ explicit derived(KONFORKA_E_PARS) \
+ : base(KONFORKA_E_CONS) { } \
+ }
+
+/**
* @brief The main konforka namespace.
*/
namespace konforka {
using std::string;
using std::list;
/**
* @brief Pinpoint the code context.
*
* Class, holding the point in code, for instance, where the exception
* occured.
*/
class code_point {
public:
/**
* The string describing the point in code.
*/
string where;
/**
* The file (as provided by __FILE__) if available.
*/
string file;
/**
* The function name (as provided by __PRETTY_FUNCTION__) if
* available.
*/
string function;
/**
* The line number (as provided by __LINE__) if available.
*/
int line;
/**
* Constructs the object, using only textual description of the
* point in code (no file, function, line information).
* @param w the description of the point in code.
*/
code_point(const string& w);
/**
* Constructs the object, specifying the exact position in code.
* @param fi source file name.
* @param fu function name.
* @param l the line number.
*/
code_point(const string& fi,const string& fu,int l);
/**
* Extract the information on the point in code.
* @return the reference to the character string.
* @see where
*/
const char *c_str() const throw();
/**
* Build the textual description from the broken down information on
* the point in code.
* @see where
* @see file
* @see function
* @see line
*/
void make_where();
};
/**
* @brief The basic exception class.
*/
class exception : public std::exception {
public:
/**
* The string, containing the description of exception.
*/
string _what;
/**
* Reference to the point in code where the exception has occured.
*/
code_point _where;
/**
* In case the exception has been rethrown a number of times, here
* we can trace where was it seen (a kind of backtrace).
*/
list<code_point> _seen;
/**
* The simple constructor, only providing textual information on the
* exception nature and the point in code where the exception has
* occured.
* @param whe the point in code.
* @param wha the description of exception.
*/
exception(const string& whe, const string& wha);
/**
* The constructor, storing elaborate information on where the
* exception has occured.
* @param fi source file name.
* @param fu function name.