Differential D19612 Diff 60758 src/bugzillaintegration/libbugzilla/exceptions.h

Changeset View

Standalone View

src/bugzillaintegration/libbugzilla/exceptions.h

This file was added.

		1		/*
		2		Copyright 2019 Harald Sitter <sitter@kde.org>
		3
		4		This library is free software; you can redistribute it and/or
		5		modify it under the terms of the GNU Lesser General Public
		6		License as published by the Free Software Foundation; either
		7		version 2.1 of the License, or (at your option) version 3, or any
		8		later version accepted by the membership of KDE e.V. (or its
		9		successor approved by the membership of KDE e.V.), which shall
		10		act as a proxy defined in Section 6 of version 3 of the license.
		11
		12		This library is distributed in the hope that it will be useful,
		13		but WITHOUT ANY WARRANTY; without even the implied warranty of
		14		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
		15		Lesser General Public License for more details.
		16
		17		You should have received a copy of the GNU Lesser General Public
		18		License along with this library. If not, see <http://www.gnu.org/licenses/>.
		19		*/
		20
		21		#ifndef EXCEPTIONS_H
		22		#define EXCEPTIONS_H
		23
		24		#include <QException>
		25
		26		class QJsonDocument;
		27		class QJsonObject;
		28
		29		namespace KIO {
		30		class TransferJob;
		31		}
		32
		33		namespace Bugzilla {
		34
		35		class APIJob;
		36
		37		/**
		38		* Root class for exceptions. Simply a QException which has the what backed
		39		* by a QString.
		40		*/
		41		class Exception : public QException
		42		{
		43		public:
		44		using QException::QException;
		45		virtual ~Exception();
		46
		47		virtual QString whatString() const = 0;
		48		virtual const char *what() const noexcept override;
		49
		50		private:
		51		char *m_what = nullptr;
		52		};
		53
		54		/**
		55		* Generic runtime exception.
		56		*/
		57		class RuntimeException : public Exception
		58		{
		59		public:
		60		RuntimeException(const QString &reason);
		61		virtual RuntimeException clone() const override { return new RuntimeException(this); }
		62		virtual QString whatString() const override;
		63
		64		private:
		65		QString m_reason;
		66		};
		67
		68		/**
		69		* Translates an API error into an excpetion for easy handling.
		70		* Specifically when the API sends an error object in the body attempting to
		71		* access the JSON blob through one of the convenience accessors
		72		* (e.g. job.object()) will instead raise an exception.
		73		*/
		74		class APIException : public Exception
		75		{
		76		public:
		77		APIException(const QJsonDocument &document);
		78		APIException(const QJsonObject &object);
		79		APIException(const APIException &other);
		80
		81		virtual void raise() const override { throw *this; }
		82		virtual APIException clone() const override { return new APIException(this); }
		83		virtual QString whatString() const override;
		84
		85		bool isError() const { return m_isError; }
		86
		87		static void maybeThrow(const QJsonDocument &document);
		88
		89		private:
		90		bool m_isError = false;
		91		QString m_message;
		92		int m_code = -1;
		93		};
		94
		95		/**
		96		* Translates an KJob/APIJob error into an excpetion for easy handling.
		97		*/
		98		class ProtocolException : public Exception
		99		{
		100		public:
		101		ProtocolException(const APIJob *job);
		102		ProtocolException(const ProtocolException &other);
		103
		104		virtual void raise() const override { throw *this; }
		105		virtual ProtocolException clone() const override { return new ProtocolException(this); }
		106		virtual QString whatString() const override;
		107
		108		static void maybeThrow(const APIJob *job);
		109
		110		private:
		111		const APIJob *m_job = nullptr;
		112		};
		113
		114		} // namespace Bugzilla
		115
		116		#endif // EXCEPTIONS_H