summaryrefslogtreecommitdiff
path: root/ext/Log4Qt/src/ndc.h
blob: 74585c74de51eca09fd14b9c93196c3c40c04784 (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
/******************************************************************************
 *
 * package:     Log4Qt
 * file:        ndc.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_NDC_H
#define LOG4QT_NDC_H


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

#include <QtCore/QString>
#include <QtCore/QStack>
#include <QtCore/QThreadStorage>
#include "log4qt.h"


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

namespace Log4Qt
{

	/*!
	 * \brief The class NDC implements a nested diagnostic context.
	 *
	 * The method remove() is not required. QThreadStorage cleans up on thread
	 * exit.
	 *
	 * \note All the functions declared in this class are thread-safe.
	 */
	class  LOG4QT_EXPORT NDC
	{
	private:
			NDC();
			NDC(const NDC &rOther); // Not implemented
			// virtual ~NDC(); // Use compiler default
			NDC &operator=(const NDC &rOther); // Not implemented

	public:
			static void clear();
			// JAVA: static QStack<QString> cloneStack();
			// JAVA: static QString get();
			static int depth();
			// JAVA: inherit(Stack stack)

			/*!
				 * Returns the NDC instance.
				 */
				static NDC *instance();

			static QString pop();
			static void push(const QString &rMessage);
			// JAVA: static void remove(); // Not required
			static void setMaxDepth(int maxDepth);
			static QString peek();

	private:
			QThreadStorage< QStack<QString> * > mStack;
	};


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

	#ifndef QT_NO_DEBUG_STREAM
	/*!
	 * \relates NDC
	 *
	 * Writes all object member variables to the given debug stream \a rDebug and
	 * returns the stream.
	 *
	 * <tt>
	 * %NDC(thread:"main" peek:"i = 3" depth:4)
	 * </tt>
	 * \sa QDebug
	 */
	QDebug operator<<(QDebug debug,
										const NDC &rNDC);
	#endif // QT_NO_DEBUG_STREAM


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

	inline NDC::NDC() :
			mStack()
	{}


} // namespace Log4Qt


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


#endif // LOG4QT_NDC_H