ILogger.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QString>
 
// ICF includes
#include <istd/IInformationProvider.h>
 
 
namespace istd
{
 
 
class ILogger: virtual public IPolymorphic
{
public:
    virtual bool IsLogConsumed(
                const IInformationProvider::InformationCategory* categoryPtr = nullptr,
                const int* flagsPtr = nullptr) const;
 
    virtual bool SendLogMessage(
                IInformationProvider::InformationCategory category,
                int id,
                const QString& message,
                const QString& messageSource,
                int flags = 0) const;
 
protected:
    virtual void DecorateMessage(
                IInformationProvider::InformationCategory category,
                int id,
                int flags,
                QString& message,
                QString& messageSource) const;
};
 
 
// inline methods
 
inline bool ILogger::IsLogConsumed(
            const IInformationProvider::InformationCategory* /*categoryPtr*/,
            const int* /*flagsPtr*/) const
{
    return false;
}
 
 
inline bool ILogger::SendLogMessage(
            IInformationProvider::InformationCategory /*category*/,
            int /*id*/,
            const QString& /*message*/,
            const QString& /*messageSource*/,
            int /*flags*/) const
{
    return false;
}
 
 
// protected methods
 
inline void ILogger::DecorateMessage(
            IInformationProvider::InformationCategory /*category*/,
            int /*id*/,
            int /*flags*/,
            QString& /*message*/,
            QString& /*messageSource*/) const
{
}
 
 
} // namespace istd