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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/******************************************************************************
*
* package:
* file: appenderskeleton.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 _APPENDERSKELETON_H
#define _APPENDERSKELETON_H
/******************************************************************************
* Dependencies
******************************************************************************/
#include "appender.h"
#include "log4qtshared.h"
#include <QtCore/QMutex>
#include "helpers/logobjectptr.h"
/******************************************************************************
* Declarations
******************************************************************************/
namespace Log4Qt
{
class Filter;
class Layout;
class Logger;
class LoggingEvent;
/*!
* \brief The class AppenderSkeleton implements general Appender functionality.
*
* \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 AppenderSkeleton : public Appender
{
Q_OBJECT
/*!
* The property holds if the Appender has been activated.
*
* \sa isActive()
*/
Q_PROPERTY(bool isActive READ isActive)
/*!
* The property holds if the Appender has been closed.
*
* \sa isClosed()
*/
Q_PROPERTY(bool isClosed READ isClosed)
/*!
* The property holds the threshold level used by the Appender.
*
* \sa threshold(), setThreshold()
*/
Q_PROPERTY(Log4Qt::Level threshold READ threshold WRITE setThreshold)
public:
AppenderSkeleton(QObject *pParent = 0);
protected:
AppenderSkeleton(const bool isActive,
QObject *pParent = 0);
public:
// virtual ~AppenderSkeleton(); Use compiler default
private:
AppenderSkeleton(const AppenderSkeleton &rOther); // Not implemented
AppenderSkeleton &operator=(const AppenderSkeleton &rOther); // Not implemented
public:
// JAVA: ErrorHandler* errorHandler();
virtual Filter *filter() const;
virtual Layout *layout() const;
bool isActive() const;
bool isClosed() const;
virtual QString name() const;
Level threshold() const;
// JAVA: void setErrorHandler(ErrorHandler *pErrorHandler);
virtual void setLayout(Layout *pLayout);
virtual void setName(const QString &rName);
void setThreshold(Level level);
virtual void activateOptions();
virtual void addFilter(Filter *pFilter);
virtual void clearFilters();
virtual void close();
/*!
* Performs checks and delegates the actuall appending to the subclass
* specific append() function.
*
* \sa append(), checkEntryConditions(), isAsSevereAsThreshold(), Filter
*/
virtual void doAppend(const LoggingEvent &rEvent);
// JAVA: void finalize();
Filter* firstFilter() const;
bool isAsSevereAsThreshold(Level level) const;
protected:
virtual void append(const LoggingEvent &rEvent) = 0;
void customEvent(QEvent* event);
/*!
* Tests if all entry conditions for using append() in this class are
* met.
*
* If a conditions is not met, an error is logged and the function
* returns false.
*
* The checked conditions are:
* - That the appender has been activated (APPENDER_NOT_ACTIVATED_ERROR)
* - That the appender was not closed (APPENDER_CLOSED_ERROR)
* - That the appender has a layout set, if it requires one
* (logging_error(APPENDER_USE_MISSING_LAYOUT_ERROR)
*
* The function is called as part of the checkEntryConditions() chain
* started by doAppend(). The doAppend() function calls the subclass
* specific checkEntryConditions() function. The function checks the
* class specific conditions and calls checkEntryConditions() of
* it's parent class. The last function called is
* AppenderSkeleton::checkEntryConditions().
*
* \sa doAppend()
*/
virtual bool checkEntryConditions() const;
protected:
mutable QMutex mObjectGuard;
private:
bool mAppendRecursionGuard;
volatile bool mIsActive;
volatile bool mIsClosed;
LogObjectPtr<Layout> mpLayout;
Level mThreshold;
LogObjectPtr<Filter> mpHeadFilter;
LogObjectPtr<Filter> mpTailFilter;
};
/**************************************************************************
* Operators, Helper
**************************************************************************/
/**************************************************************************
* Inline
**************************************************************************/
inline Filter *AppenderSkeleton::filter() const
{ QMutexLocker locker(&mObjectGuard);
return mpHeadFilter; }
inline Layout *AppenderSkeleton::layout() const
{ QMutexLocker locker(&mObjectGuard);
return mpLayout; }
inline QString AppenderSkeleton::name() const
{ QMutexLocker locker(&mObjectGuard);
return objectName(); }
inline Level AppenderSkeleton::threshold() const
{ // QMutexLocker locker(&mObjectGuard); // Level is threadsafe
return mThreshold; }
inline void AppenderSkeleton::setLayout(Layout *pLayout)
{ QMutexLocker locker(&mObjectGuard);
mpLayout = pLayout; }
inline void AppenderSkeleton::setName(const QString &rName)
{ QMutexLocker locker(&mObjectGuard);
setObjectName(rName); }
inline void AppenderSkeleton::setThreshold(Level level)
{ // QMutexLocker locker(&mObjectGuard); // Level is threadsafe
mThreshold = level; }
inline bool AppenderSkeleton::isActive() const
{ // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
return mIsActive; }
inline bool AppenderSkeleton::isClosed() const
{ // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
return mIsClosed; }
inline Filter *AppenderSkeleton::firstFilter() const
{ QMutexLocker locker(&mObjectGuard);
return filter(); }
inline bool AppenderSkeleton::isAsSevereAsThreshold(Level level) const
{ // QMutexLocker locker(&mObjectGuard); // Level is threadsafe
return (mThreshold <= level); }
} // namespace Log4Qt
// Q_DECLARE_TYPEINFO(::AppenderSkeleton, Q_COMPLEX_TYPE); // Use default
#endif // _APPENDERSKELETON_H
|
