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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/******************************************************************************
*
* package: Log4Qt
* file: patternlayout.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_PATTERNLAYOUT_H
#define LOG4QT_PATTERNLAYOUT_H
/******************************************************************************
* Dependencies
******************************************************************************/
#include "layout.h"
/******************************************************************************
* Declarations
******************************************************************************/
namespace Log4Qt
{
class PatternFormatter;
/*!
* \brief The class PatternLayout outputs a logging event based on a
* pattern string.
\li c{section_count} : logger name with optional parameter section_count. Section count from end of logger name, sections delimiter is "::";
\li d{format_string} : date with optional parameters in "{}"-brackets which used by QDateTime::toString();
\li m : message
\li p : level name
\li r : relative date/time to start application
\li t : thread name
\li x : ndc name
\li X : mdc name
*
* \note The ownership and lifetime of objects of this class are managed.
* See \ref Ownership "Object ownership" for more details.
*/
class LOG4QT_EXPORT PatternLayout : public Layout
{
Q_OBJECT
/*!
* The property holds the conversion pattern used by the appender.
*
* The default is "%m%n".
*
* \sa conversionPattern(), setConversionPattern()
*/
Q_PROPERTY(QString conversionPattern READ conversionPattern WRITE setConversionPattern)
public:
/*!
* The enum ConversionPattern defines constants for pattern strings.
*
* \sa setConversionPattern(ConversionPattern);
*/
enum ConversionPattern
{
/*! The default conversion pattern string is "%m,%n". */
DEFAULT_CONVERSION_PATTERN,
/*!
* The ttcc conversion pattern string is
* "%r [%t] %p %c %x - %m%n".
*/
TTCC_CONVERSION_PATTERN
};
Q_ENUMS(ConversionPattern)
PatternLayout(QObject *pParent = 0);
PatternLayout(const QString &rPattern,
QObject *pParent = 0);
/*!
* Creates a PatternLayout with the conversion pattern value specified
* by the \a conversionPattern constant.
*/
PatternLayout(ConversionPattern conversionPattern,
QObject *pParent = 0);
virtual ~PatternLayout();
private:
PatternLayout(const PatternLayout &rOther); // Not implemented
PatternLayout &operator=(const PatternLayout &rOther); // Not implemented
public:
QString conversionPattern() const;
void setConversionPattern(const QString &rPattern);
/*!
* Sets the conversion pattern to the value specified by the
* \a conversionPattern constant.
*/
void setConversionPattern(ConversionPattern conversionPattern);
virtual QString format(const LoggingEvent &rEvent);
protected:
#ifndef QT_NO_DEBUG_STREAM
/*!
* Writes all object member variables to the given debug stream
* \a rDebug and returns the stream.
*
* <tt>
* %PatternLayout(name:"PL" pattern:"%r [%t] %p %c %x - %m%n"
* "referencecount:3")
* </tt>
* \sa QDebug, operator<<(QDebug debug, const LogObject &rLogObject)
*/
virtual QDebug debug(QDebug &rDebug) const;
#endif // QT_NO_DEBUG_STREAM
private:
void updatePatternFormatter();
private:
QString mPattern;
PatternFormatter *mpPatternFormatter;
};
/**************************************************************************
* Operators, Helper
**************************************************************************/
/**************************************************************************
* Inline
**************************************************************************/
inline QString PatternLayout::conversionPattern() const
{ return PatternLayout::mPattern; }
inline void PatternLayout::setConversionPattern(const QString &rPattern)
{ mPattern = rPattern;
updatePatternFormatter(); }
} // namespace Log4Qt
// Q_DECLARE_TYPEINFO(Log4Qt::PatternLayout, Q_COMPLEX_TYPE); // Use default
#endif // LOG4QT_PATTERNLAYOUT_H
|
