summaryrefslogtreecommitdiff
path: root/ext/Log4Qt/src/helpers/classlogger.h
blob: cc7bca67fa02b393d11ef8f5eb59d82592491191 (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
115
116
117
/******************************************************************************
 *
 * package:     Log4Qt
 * file:        classlogger.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 *
 * changes:		Sep 2008, Martin Heinrich:
 * 				- Replaced usage of q_atomic_test_and_set_ptr with
 * 				  QAtomicPointer
 *
 *
 * Copyright 2007 - 2008 Martin Heinrich
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

#ifndef LOG4QT_CLASSLOGGER_H
#define LOG4QT_CLASSLOGGER_H

#include "../log4qtshared.h"


/******************************************************************************
 * Dependencies
 ******************************************************************************/

#include <QtCore/QObject>
#if QT_VERSION >= QT_VERSION_CHECK(4, 4, 0)
#	include <QtCore/QAtomicPointer>
#	ifndef Q_ATOMIC_POINTER_TEST_AND_SET_IS_ALWAYS_NATIVE
#		warning "QAtomicPointer test and set is not native. The class Log4Qt::ClassLogger is not thread-safe."
#	endif
#endif


/******************************************************************************
 * Declarations
 ******************************************************************************/

namespace Log4Qt
{
	class Logger;

	/*!
	 * \brief The class ClassLogger provides logging for a QObject derived
	 *        class.
	 *
	 * The class ClassLogger provides a logger for a specified QObject derived
	 * object. It is used by \ref LOG4QT_DECLARE_QCLASS_LOGGER to implement the
	 * member functions provided by the macro.
	 *
	 * \note All the functions declared in this class are thread-safe.
	 *
	 * \sa LOG4QT_DECLARE_QCLASS_LOGGER
	 */
	class LOG4QT_EXPORT ClassLogger
	{
	public:
			/*!
			 * Creates a ClassLogger object.
			 */
			ClassLogger();
			// ~ClassLogger(); // Use compiler default
			// ClassLogger(const ClassLogger &rOther); // Use compiler default
			// ClassLogger &operator=(const ClassLogger &rOther); // Use compiler default

			/*!
			 * Returns a pointer to a Logger named after the class of the object
			 * \a pObject.
			 *
			 * On the first invocation the Logger is requested by a call to
			 * LogManager::logger(const char *pName). The pointer is stored to be
			 * returned on subsequent invocations.
			 *
			 * \sa LogManager::logger(const char *pName)
			 */
			Logger *logger(const QObject *pObject);

	private:
#if QT_VERSION < QT_VERSION_CHECK(4, 4, 0)
			volatile Logger *mpLogger;
#else
			mutable QAtomicPointer<Logger> mpLogger;
#endif
	};


	/******************************************************************************
	 * Operators, Helper
	 ******************************************************************************/


	/**************************************************************************
	 * Inline
	 **************************************************************************/


} // namespace Log4Qt


// Q_DECLARE_TYPEinfo(Log4Qt::ClassLogger, Q_COMPLEX_TYPE); // Use default


#endif // LOG4QT_CLASSLOGGER_H