refs #338 Added class CLogSubscriber, a helper for subscribing to log messages matching a certain pattern, with the ability to change the pattern at runtime.

This commit is contained in:
Mathew Sutcliffe
2014-10-24 17:21:48 +01:00
parent 0f888b8d89
commit 7a133bde11
4 changed files with 89 additions and 2 deletions

View File

@@ -132,4 +132,46 @@ namespace BlackMisc
m_patternHandlers.erase(newEnd, m_patternHandlers.end());
}
void CLogSubscriber::changeSubscription(const CLogPattern &pattern)
{
Q_ASSERT(CLogHandler::instance()->thread() == QThread::currentThread());
unsubscribe();
m_handler = CLogHandler::instance()->handlerForPattern(pattern);
if (! m_inheritFallThrough)
{
m_handler->enableConsoleOutput(m_enableFallThrough);
}
connect(m_handler, &CLogPatternHandler::messageLogged, this, &CLogSubscriber::ps_logMessage);
}
void CLogSubscriber::unsubscribe()
{
Q_ASSERT(CLogHandler::instance()->thread() == QThread::currentThread());
if (m_handler)
{
m_handler->disconnect(this);
}
}
void CLogSubscriber::inheritConsoleOutput()
{
Q_ASSERT(CLogHandler::instance()->thread() == QThread::currentThread());
m_inheritFallThrough = true;
if (m_handler)
{
m_handler->inheritConsoleOutput();
}
}
void CLogSubscriber::enableConsoleOutput(bool enable)
{
Q_ASSERT(CLogHandler::instance()->thread() == QThread::currentThread());
m_inheritFallThrough = false;
m_enableFallThrough = enable;
if (m_handler)
{
m_handler->enableConsoleOutput(enable);
}
}
}

View File

@@ -16,6 +16,7 @@
#include "statusmessage.h"
#include <QObject>
#include <QMap>
#include <QPointer>
namespace BlackMisc
{
@@ -166,6 +167,48 @@ namespace BlackMisc
return ! isSignalConnected(signal);
}
};
/*!
* A helper class for subscribing to log messages matching a particular pattern, with the ability to
* change the pattern at runtime.
*/
class CLogSubscriber : public QObject
{
Q_OBJECT
public:
//! Construct a subscriber which forwards messages to the given slot of parent.
template <typename T, typename F>
CLogSubscriber(T *parent, F slot) : QObject(parent)
{
Q_ASSERT(CLogHandler::instance()->thread() == QThread::currentThread());
QObject::connect(this, &CLogSubscriber::ps_messageLogged, parent, slot);
}
//! Change the pattern which you want to subscribe to.
void changeSubscription(const CLogPattern &pattern);
//! Unsubscribe from all messages.
void unsubscribe();
//! \copydoc CLogPatternHandler::enableConsoleOutput
void enableConsoleOutput(bool enable);
//! \copydoc CLogPatternHandler::inheritConsoleOutput
void inheritConsoleOutput();
signals:
//! \private
void ps_messageLogged(const CStatusMessage &message);
private slots:
void ps_logMessage(const CStatusMessage &message) { emit ps_messageLogged(message); }
private:
QPointer<CLogPatternHandler> m_handler;
bool m_inheritFallThrough = true;
bool m_enableFallThrough = true;
};
}
#endif