Differential D12808 Diff 34386 kmymoney/mymoney/mymoneyexception.h

Changeset View

Standalone View

kmymoney/mymoney/mymoneyexception.h

Context not available.
2	mymoneyexception.h - description	2		mymoneyexception.h - description
3	-------------------	3		-------------------
4	begin : Sun Apr 28 2002	4		begin : Sun Apr 28 2002
5	copyright : (C) 2000-2002 by Michael Edwardes	5		copyright Thomas Baumgart <ipwizard@users.sourceforge.net>
6	email : mte@users.sourceforge.net	6		(C) 2017-2018 by Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
7	Javier Campos Morales <javi_c@users.sourceforge.net>
8	Felix Rodriguez <frodriguez@users.sourceforge.net>
9	John C <thetacoturtle@users.sourceforge.net>
10	Thomas Baumgart <ipwizard@users.sourceforge.net>
11	Kevin Tambascio <ktambascio@users.sourceforge.net>
12	(C) 2017 by Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
13	***************************************************************************/	7		***************************************************************************/
14		8
15	/***************************************************************************	9		/***************************************************************************
Context not available.
24	#ifndef MYMONEYEXCEPTION_H	18		#ifndef MYMONEYEXCEPTION_H
25	#define MYMONEYEXCEPTION_H	19		#define MYMONEYEXCEPTION_H
26		20
27	#include "kmm_mymoney_export.h"	21		#define KMM_STRINGIFY(x) #x
		22		#define KMM_TOSTRING(x) KMM_STRINGIFY(x)
28		23
29	// ----------------------------------------------------------------------------	24		#include <stdexcept>
30	// QT Includes
31
32	#include <qglobal.h>
33
34	class QString;
35		25
36	/**	26		/**
37	* @file	27		* @file
38	* @author Thomas Baumgart	28		* @author Thomas Baumgart
		29		* @author Łukasz Wojniłowicz
39	*/	30		*/
40		31
41	/**	32		/**
42	* This class describes an exception that is thrown by the engine	33		* @def The MYMONEYEXCEPTION(exceptionMessage) define
			christiandUnsubmitted Done Change this to `KMM_{TOSTRING,STRINGIFY}` or alike because the used names are quite common which can cause issues. christiand: Change this to `KMM_{TOSTRING,STRINGIFY}` or alike because the used names are quite common…
			wojnilowiczAuthorUnsubmitted Not Done Agreed. wojnilowicz: Agreed.
			christiandUnsubmitted Not Done You removed the useful documentation. It should be kept and adopted. christiand: You removed the useful documentation. It should be kept and adopted.
			wojnilowiczAuthorUnsubmitted Not Done I brought them back. wojnilowicz: I brought them back.
43	* in case of a failure.	34		* This is the preferred constructor to create a new exception
44	*/	35		* object. It automatically inserts the filename and the source
45		36		* code line into the object upon creation.
46	class MyMoneyExceptionPrivate;	37		*/
47	class KMM_MYMONEY_EXPORT MyMoneyException
48	{
49	public:
50
51	/**
52	* @def MYMONEYEXCEPTION(text)
53	* This is the preferred constructor to create a new exception
54	* object. It automatically inserts the filename and the source
55	* code line into the object upon creation.
56	*
57	* It is equivilant to MyMoneyException(text, __FILE__, __LINE__)
58	*/
59	#define MYMONEYEXCEPTION(what) MyMoneyException(what, __FILE__, __LINE__)
60
61	/**
62	* The constructor to create a new MyMoneyException object.
63	*
64	* @param msg reference to QString containing the message
65	* @param file reference to QString containing the name of the sourcefile where
66	* the exception was thrown
67	* @param line unsigned long containing the line number of the line where
68	* the exception was thrown in the file.
69	*
70	* An easier way to use this constructor is to use the macro
71	* MYMONEYEXCEPTION(text) instead. It automatically assigns the file
72	* and line parameter to the correct values.
73	*/
74	explicit MyMoneyException(const QString& msg,
75	const QString& file,
76	const unsigned long line);
77
78	MyMoneyException(const MyMoneyException & other);
79	MyMoneyException(MyMoneyException && other);
80	MyMoneyException & operator=(MyMoneyException other);
81	friend void swap(MyMoneyException& first, MyMoneyException& second);
82
83	~MyMoneyException();
84		38
85	/**	39		#define MYMONEYEXCEPTION(exceptionMessage) MyMoneyException(qPrintable(QString::fromLatin1("%1 %2:%3").arg(exceptionMessage, QString::fromLatin1(__FILE__), QString::number(__LINE__))))
86	* This method is used to return the message that was passed
87	* during the creation of the exception object.
88	*
89	* @return reference to QString containing the message
90	*/
91	QString what() const;
92		40
93	/**	41		/**
94	* This method is used to return the filename that was passed	42		* @def The MYMONEYEXCEPTION(what) define
95	* during the creation of the exception object.	43		* This is alternative constructor to create a new exception
96	*	44		* object. It avoids needless string conversion if the input string is const char*
97	* @return reference to QString containing the filename	45		*/
98	*/
99	QString file() const;
100
101	/**
102	* This method is used to return the linenumber that was passed
103	* during the creation of the exception object.
104	*
105	* @return long integer containing the line number
106	*/
107	unsigned long line() const;
108
109	private:
110	// #define MYMONEYEXCEPTION(what) requires non-const d_ptr
111	MyMoneyExceptionPrivate * d_ptr; // krazy:exclude=dpointer
112	Q_DECLARE_PRIVATE(MyMoneyException)
113	MyMoneyException();
114	};
115		46
116	inline void swap(MyMoneyException& first, MyMoneyException& second) // krazy:exclude=inline	47		#define MYMONEYEXCEPTION_CSTRING(exceptionMessage) MyMoneyException(exceptionMessage " " __FILE__ ":" KMM_TOSTRING(__LINE__))
117	{
118	using std::swap;
119	swap(first.d_ptr, second.d_ptr);
120	}
121		48
122	inline MyMoneyException::MyMoneyException(MyMoneyException && other) : MyMoneyException() // krazy:exclude=inline	49		/**
123	{	50		* The constructor to create a new MyMoneyException object.
124	swap(*this, other);	51		*
125	}	52		* @param exceptionMessage reference to const char * containing the message
		53		*
		54		* An easier way to use this constructor is to use the macro
		55		* MYMONEYEXCEPTION(text) instead. It automatically assigns the file
		56		* and line parameter to the correct values.
		57		*/
126		58
127	inline MyMoneyException & MyMoneyException::operator=(MyMoneyException other) // krazy:exclude=inline	59		class MyMoneyException : public std::runtime_error
128	{	60		{
129	swap(*this, other);	61		public:
130	return *this;	62		explicit MyMoneyException(const char *exceptionMessage) : std::runtime_error(exceptionMessage) {}
131	}	63		};
			christiandUnsubmitted Not Done You can make this obsolete by using an overloaded function. The marco calls the function and the overloading handles the `QString` or `char` correctly. christiand:* You can make this obsolete by using an overloaded function. The marco calls the function and…
			wojnilowiczAuthorUnsubmitted Not Done AFAIK, I cannot overload #define. Adding own class makes it more complicated because you've got two constructors and additional code to compile, which doesn't give use more usability, which adds QString include to every compilation unit and which inlines the code in every compilation unit. wojnilowicz: AFAIK, I cannot overload #define. Adding own class makes it more complicated because you've got…
			christiandUnsubmitted Not Done What about something like: #define MYMONEYEXCEPTION(what) makeMyMoneyExecption(what, __FILE__ ":" KMM_TOSTRING(__LINE__)) inline std::runtime_error makeMyMoneyException(QString what, char* location) { return std::runtime_error(qPrintable(what + QLatin1String(location)); } inline std::runtime_error makeMyMoneyException(char* what, char* location) { return /* concatenate via QString or std::string /; } I would not look at time advantages too much, because they are for sure extremely low and this code is not called often. christiand:* What about something like: ``` #define MYMONEYEXCEPTION(what) makeMyMoneyExecption(what…
			wojnilowiczAuthorUnsubmitted Not Done That's another little doing functions. I think it's not good for simplification. I agree, that time advantages at runtime are of low priority but time advantages at build time are of high priority to me. These functions would be inlined very often = increased build time (and probably size). wojnilowicz: That's another little doing functions. I think it's not good for simplification. I agree, that…
132		64
133	#endif	65		#endif
Context not available.