aboutsummaryrefslogtreecommitdiff
path: root/src/exceptionbase.h
blob: fd78089e66d5013bbc5e86c59872c6b22f73aeee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
#ifndef EXCEPTION_BASE_H
#define EXCEPTION_BASE_H

#include <string>
#include <exception>
#include <stdarg.h>

namespace Bu
{
	/**
	 * A generalized Exception base class.  This is nice for making general and
	 * flexible child classes that can create new error code classes.
	 *
	 * In order to create your own exception class use these two lines.
	 * 
	 * in your header:  subExceptionDecl( NewClassName );
	 * 
	 * in your source:  subExcpetienDef( NewClassName );
	 */
	class ExceptionBase : public std::exception
	{
	public:
		/**
		 * Construct an exception with an error code of zero, but with a
		 * description.  The use of this is not reccomended most of the time,
		 * it's generally best to include an error code with the exception so
		 * your program can handle the exception in a better way.
		 * @param sFormat The format of the text.  See printf for more info.
		 */
		ExceptionBase( const char *sFormat, ... ) throw();
		
		/**
		 * 
		 * @param nCode 
		 * @param sFormat
		 */
		ExceptionBase( int nCode, const char *sFormat, ... ) throw();
		
		/**
		 * 
		 * @param nCode 
		 * @return 
		 */
		ExceptionBase( int nCode=0 ) throw();
		
		/**
		 * 
		 * @return 
		 */
		virtual ~ExceptionBase() throw();

		/**
		 * 
		 * @return 
		 */
		virtual const char *what() const throw();
		
		/**
		 * 
		 * @return 
		 */
		int getErrorCode();
		
		/**
		 * 
		 * @param lpFormat 
		 * @param vargs 
		 */
		void setWhat( const char *lpFormat, va_list &vargs );

		/**
		 *
		 * @param lpText
		 */
		void setWhat( const char *lpText );

	private:
		int nErrorCode;	/**< The code for the error that occured. */
		char *sWhat;	/**< The text string telling people what went wrong. */
	};
}

#define subExceptionDecl( name )											\
class name : public ExceptionBase											\
{																			\
	public:																	\
		name( const char *sFormat, ... ) throw ();							\
		name( int nCode, const char *sFormat, ... ) throw();				\
		name( int nCode=0 ) throw ();										\
};

#define subExceptionDef( name )												\
name::name( const char *lpFormat, ... ) throw() :							\
	ExceptionBase( 0 )														\
{																			\
	va_list ap;																\
	va_start( ap, lpFormat );												\
	setWhat( lpFormat, ap );												\
	va_end( ap );															\
}																			\
name::name( int nCode, const char *lpFormat, ... ) throw() :				\
	ExceptionBase( nCode )													\
{																			\
	va_list ap;																\
	va_start( ap, lpFormat );												\
	setWhat( lpFormat, ap );												\
	va_end( ap );															\
}																			\
name::name( int nCode ) throw() :											\
	ExceptionBase( nCode )													\
{																			\
}

#endif