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
|
/*
* Copyright (C) 2008-2012 The QXmpp developers
*
* Author:
* Manjeet Dahiya
* Jeremy Lainé
*
* Source:
* http://code.google.com/p/qxmpp
*
* This file is a part of QXmpp library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
*/
#ifndef QXMPPLOGGER_H
#define QXMPPLOGGER_H
#include <QObject>
#include "QXmppGlobal.h"
#ifdef QXMPP_LOGGABLE_TRACE
#define qxmpp_loggable_trace(x) QString("%1(0x%2) %3").arg(metaObject()->className(), QString::number(reinterpret_cast<qint64>(this), 16), x)
#else
#define qxmpp_loggable_trace(x) (x)
#endif
class QXmppLoggerPrivate;
/// \brief The QXmppLogger class represents a sink for logging messages.
///
/// \ingroup Core
class QXMPP_EXPORT QXmppLogger : public QObject
{
Q_OBJECT
Q_ENUMS(LoggingType)
Q_FLAGS(MessageType MessageTypes)
Q_PROPERTY(QString logFilePath READ logFilePath WRITE setLogFilePath)
Q_PROPERTY(LoggingType loggingType READ loggingType WRITE setLoggingType)
Q_PROPERTY(MessageTypes messageTypes READ messageTypes WRITE setMessageTypes)
public:
/// This enum describes how log message are handled.
enum LoggingType
{
NoLogging = 0, ///< Log messages are discarded
FileLogging = 1, ///< Log messages are written to a file
StdoutLogging = 2, ///< Log messages are written to the standard output
SignalLogging = 4, ///< Log messages are emitted as a signal
};
/// This enum describes a type of log message.
enum MessageType
{
NoMessage = 0, ///< No message type
DebugMessage = 1, ///< Debugging message
InformationMessage = 2, ///< Informational message
WarningMessage = 4, ///< Warning message
ReceivedMessage = 8, ///< Message received from server
SentMessage = 16, ///< Message sent to server
AnyMessage = 31, ///< Any message type
};
Q_DECLARE_FLAGS(MessageTypes, MessageType)
QXmppLogger(QObject *parent = 0);
~QXmppLogger();
static QXmppLogger* getLogger();
QXmppLogger::LoggingType loggingType();
void setLoggingType(QXmppLogger::LoggingType type);
QString logFilePath();
void setLogFilePath(const QString &path);
QXmppLogger::MessageTypes messageTypes();
void setMessageTypes(QXmppLogger::MessageTypes types);
public slots:
virtual void setGauge(const QString &gauge, double value);
virtual void updateCounter(const QString &counter, qint64 amount);
void log(QXmppLogger::MessageType type, const QString& text);
void reopen();
signals:
/// This signal is emitted whenever a log message is received.
void message(QXmppLogger::MessageType type, const QString &text);
private:
static QXmppLogger* m_logger;
QXmppLoggerPrivate *d;
};
/// \brief The QXmppLoggable class represents a source of logging messages.
///
/// \ingroup Core
class QXMPP_EXPORT QXmppLoggable : public QObject
{
Q_OBJECT
public:
QXmppLoggable(QObject *parent = 0);
protected:
/// \cond
virtual void childEvent(QChildEvent *event);
/// \endcond
/// Logs a debugging message.
///
/// \param message
void debug(const QString &message)
{
emit logMessage(QXmppLogger::DebugMessage, qxmpp_loggable_trace(message));
}
/// Logs an informational message.
///
/// \param message
void info(const QString &message)
{
emit logMessage(QXmppLogger::InformationMessage, qxmpp_loggable_trace(message));
}
/// Logs a warning message.
///
/// \param message
void warning(const QString &message)
{
emit logMessage(QXmppLogger::WarningMessage, qxmpp_loggable_trace(message));
}
/// Logs a received packet.
///
/// \param message
void logReceived(const QString &message)
{
emit logMessage(QXmppLogger::ReceivedMessage, qxmpp_loggable_trace(message));
}
/// Logs a sent packet.
///
/// \param message
void logSent(const QString &message)
{
emit logMessage(QXmppLogger::SentMessage, qxmpp_loggable_trace(message));
}
signals:
/// Sets the given \a gauge to \a value.
void setGauge(const QString &gauge, double value);
/// This signal is emitted to send logging messages.
void logMessage(QXmppLogger::MessageType type, const QString &msg);
/// Updates the given \a counter by \a amount.
void updateCounter(const QString &counter, qint64 amount = 1);
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QXmppLogger::MessageTypes)
#endif // QXMPPLOGGER_H
|
