1/*
2 Copyright (c) 2009 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_EXCEPTION_H
21#define AKONADI_EXCEPTION_H
22
23#include "akonadi_export.h"
24
25#include <QtCore/QByteArray>
26#include <exception>
27
28class QString;
29
30namespace Akonadi {
31
32/**
33 Base class for exceptions used by the Akonadi library.
34*/
35class AKONADI_EXPORT Exception : public std::exception //krazy:exclude=dpointer
36{
37public:
38 /**
39 Creates a new exception with the error message @p what.
40 */
41 Exception(const char *what) throw();
42
43 /**
44 Creates a new exception with the error message @p what.
45 */
46 Exception(const QByteArray &what) throw();
47
48 /**
49 Creates a new exception with the error message @p what.
50 */
51 Exception(const QString &what) throw();
52
53 /**
54 Copy constructor.
55 */
56 Exception(const Exception &other) throw();
57
58 /**
59 Destructor.
60 */
61 virtual ~Exception() throw();
62
63 /**
64 Returns the error message associated with this exception.
65 */
66 const char *what() const throw();
67
68 /**
69 Returns the type of this exception.
70 */
71 virtual QByteArray type() const throw(); // ### Akonadi 2: return const char *
72
73private:
74 class Private;
75 Private *d;
76};
77
78#define AKONADI_EXCEPTION_MAKE_TRIVIAL_INSTANCE( classname ) \
79class AKONADI_EXPORT classname : public Akonadi::Exception \
80{ \
81 public: \
82 classname ( const char *what ) throw() : Akonadi::Exception( what ) {} \
83 classname ( const QByteArray &what ) throw() : Akonadi::Exception( what ) {} \
84 classname ( const QString &what ) throw() : Akonadi::Exception( what ) {} \
85 ~classname() throw(); \
86 QByteArray type() const throw(); \
87}
88
89AKONADI_EXCEPTION_MAKE_TRIVIAL_INSTANCE( PayloadException );
90
91#undef AKONADI_EXCEPTION_MAKE_TRIVIAL_INSTANCE
92
93}
94
95#endif
96