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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/******************************************************************************
*
* package: Log4Qt
* file: patternformatter.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_PATTERNFORMATTER_H
#define LOG4QT_PATTERNFORMATTER_H
#include "../log4qtshared.h"
/******************************************************************************
* Dependencies
******************************************************************************/
#include <QtCore/QList>
#include <QtCore/QString>
/******************************************************************************
* Declarations
******************************************************************************/
namespace Log4Qt
{
class FormattingInfo;
class PatternConverter;
class LoggingEvent;
/*!
* \brief The class PatternFormatter formats a logging event based on a
* pattern string.
*
* The class PatternFormatter formats a LoggingEvent base on a pattern
* string. It is used by the patternLayout and TTCCLayout class to
* implement the formatting.
*
* On object construction the provided patterns tring is parsed. Based on
* the information found a chain of PatternConverter is created. Each
* PatternConverter handles a certain member of a LoggingEvent.
*
* \sa PatternLayout::format()
* \sa TTCCLayout::format()
*/
class LOG4QT_EXPORT PatternFormatter
{
public:
/*!
* Creates a PatternFormatter using a the specified \a rPattern.
*/
PatternFormatter(const QString &rPattern);
/*!
* Destroys the PatternFormatter and all PatternConverter.
*/
virtual ~PatternFormatter();
private:
PatternFormatter(const PatternFormatter &rOther); // Not implemented
PatternFormatter &operator=(const PatternFormatter &rOther); // Not implemented
public:
/*!
* Formats the given \a rLoggingEvent using the chain of
* PatternConverter created during construction from the specified
* pattern.
*/
QString format(const LoggingEvent &rLoggingEvent) const;
private:
/*!
* If the character \a rDigit is a digit the digit is added to the
* integer \a rValue and the function returns true. Otherwise the
* function returns false.
*
* The function adds the digit by multiplying the existing value
* with ten and adding the numerical value of the digit. If the
* maximum integer value would be exceeded by the operation
* \a rValue is set to INT_MAX.
*/
bool addDigit(const QChar &rDigit,
int &rValue);
/*!
* Creates a PatternConverter based on the specified conversion
* character \a rChar, the formatting information
* \a rFormattingInfo and the option \a rOption.
*
* The PatternConverter converter is appended to the list of
* PatternConverters.
*/
void createConverter(const QChar &rChar,
const FormattingInfo &rFormattingInfo,
const QString &rOption = QString());
/*!
* Creates a LiteralPatternConverter with the string literal
* \a rLiteral.
*
* The PatternConverter converter is appended to the list of
* PatternConverters.
*/
void createLiteralConverter(const QString &rLiteral);
/*!
* Parses the pattern string specified on construction and creates
* PatternConverter according to it.
*/
void parse();
/*!
* Parses an integer option from an option string. If the string is
* not a valid integer or the integer value is less then zero, zero
* is returned. Returns the end of line seperator for the operating
* system.
*/
int parseIntegerOption(const QString &rOption);
private:
const QString mIgnoreCharacters;
const QString mConversionCharacters;
const QString mOptionCharacters;
QString mPattern;
QList<PatternConverter *> mPatternConverters;
// Needs to be friend to access internal data
friend QDebug operator<<(QDebug, const PatternFormatter &rPatternFormatter);
};
/**************************************************************************
* Operators, Helper
**************************************************************************/
#ifndef QT_NO_DEBUG_STREAM
/*!
* \relates PatternFormatter
*
* Writes all object member variables to the given debug stream \a rDebug and
* returns the stream.
*
* <tt>
* %PatternFormatter(pattern:"%r [%t] %p %c %x - %m%n"
* converters:(
* DatePatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) format: "RELATIVE" ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: " [" ) ,
* BasicPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) type: "THREAD_CONVERTER" ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: "] " ) ,
* BasicPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) type: "LEVEL_CONVERTER" ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: " " ) ,
* LoggerPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) precision: 0 ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: " " ) ,
* BasicPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) type: "NDC_CONVERTER" ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: " - " ) ,
* BasicPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) type: "MESSAGE_CONVERTER" ) ,
* LiteralPatternConverter(FormattingInfo(min:"0" max:"INT_MAX" left:false) literal: "" ) ) )
* </tt>
* \sa QDebug
*/
QDebug operator<<(QDebug debug,
const PatternFormatter &rPatternFormatter);
#endif // QT_NO_DEBUG_STREAM
/**************************************************************************
* Inline
**************************************************************************/
} // namespace Log4Qt
Q_DECLARE_TYPEINFO(Log4Qt::PatternFormatter, Q_MOVABLE_TYPE);
#endif // LOG4QT_PATTERNFORMATTER_H
|
