summaryrefslogtreecommitdiff
path: root/ext/Log4Qt/src/varia/debugappender.h
blob: 4df6c0265cd4b502f1980c86c89113fff578e0f8 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/******************************************************************************
 *
 * package:     Log4Qt
 * file:        debugappender.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 *
 * Copyright 2007 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_DEBUGAPPENDER_H
#define LOG4QT_DEBUGAPPENDER_H


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

#include "appenderskeleton.h"


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

namespace Log4Qt
{

	/*!
	 * \brief The class DebugAppender appends logging events to the platform
	 *        specific debug output.
	 *
	 * A DebugAppender appends to the Debugger on Windows and to stderr on all
	 * other systems.
	 *
	 * \note All the functions declared in this class are thread-safe.
	 *
	 * \note The ownership and lifetime of objects of this class are managed.
	 *       See \ref Ownership "Object ownership" for more details.
	 */
	class  LOG4QT_EXPORT DebugAppender : public AppenderSkeleton
	{
			Q_OBJECT

	public:
		/*!
		 * Creates a DebugAppender.
		 */
			DebugAppender(QObject *pParent = 0);

		/*!
		 * Creates a DebugAppender with the specified layout \a pLayout
		 */
			DebugAppender(Layout *pLayout,
										QObject *pParent = 0);

			// virtual ~DebugAppender(); // Use compiler default
	private:
			DebugAppender(const DebugAppender &rOther); // Not implemented
			DebugAppender &operator=(const DebugAppender &rOther); // Not implemented

	public:
		/*!
		 * The DebugAppended requires a layout. The function returns true.
		 *
		 * \sa setLayout()
		 */
			virtual bool requiresLayout() const;

	protected:
		/*!
		 * Appends the specified logging event \a rEvent to the debug output.
		 * The output is formatted using the appender's layout.
		 *
		 * The method is called by the AppenderSkeleton::doAppend() after it
		 * the entry conditions have been tested and it has been found that the
		 * logging event needs to be appended.
		 *
		 * \sa setLayout(), AppenderSkeleton::doAppend(), checkEntryConditions()
		 */
			virtual void append(const LoggingEvent &rEvent);

#ifndef QT_NO_DEBUG_STREAM
			/*!
			 * Writes all object member variables to the given debug stream \a rDebug
			 * and returns the stream.
			 *
			 * <tt>
			 * %DebugAppender(name:"DA" filter:0x3bee6b8 isactive:true isclosed:false
			 *                layout:"SL" referencecount:1 threshold:"NULL")
			 * </tt>
			 * \sa QDebug, operator<<(QDebug debug, const LogObject &rLogObject)
			 */
			virtual QDebug debug(QDebug &rDebug) const;
#endif // QT_NO_DEBUG_STREAM
	};


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


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

	inline DebugAppender::DebugAppender(QObject *pParent) :
			AppenderSkeleton(pParent)
	{}


} // namespace Log4Qt


// Q_DECLARE_TYPEINFO(Log4Qt::DebugAppender, Q_COMPLEX_TYPE); // Use default


#endif // LOG4QT_DEBUGAPPENDER_H