CLoggerBase.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// ACF includes
#include <istd/ILogger.h>
#include <ilog/ILoggable.h>
 
 
namespace ilog
{
 
 
class IMessageConsumer;
 
 
class CLoggerBase:
                     virtual public ILoggable,
                     virtual protected istd::ILogger
{
public:
       CLoggerBase();
 
       // reimplemented (ilog::ILoggable)
       virtual void SetLogPtr(ilog::IMessageConsumer* logPtr) override;
       virtual ilog::IMessageConsumer* GetLogPtr() const override;
 
protected:
       bool SendInfoMessage(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendWarningMessage(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendErrorMessage(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendCriticalMessage(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendInfoMessageOnce(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendWarningMessageOnce(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendErrorMessageOnce(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendCriticalMessageOnce(
                            int id,
                            const QString& message,
                            const QString& messageSource = QString(),
                            int flags = 0) const;
 
       bool SendUserMessage(const istd::IInformationProvider* messagePtr) const;
 
       bool AllowMessageOnceAgain(int id);
 
       virtual void DecorateMessage(
                            istd::IInformationProvider::InformationCategory category,
                            int id,
                            int flags,
                            QString& message,
                            QString& messageSource) const override;
 
       // reimplemented (istd::ILogger)
       virtual bool IsLogConsumed(
                            const istd::IInformationProvider::InformationCategory* categoryPtr = NULL,
                            const int* flagsPtr = NULL) const override;
       virtual bool SendLogMessage(
                            istd::IInformationProvider::InformationCategory category,
                            int id,
                            const QString& message,
                            const QString& messageSource,
                            int flags = 0) const override;
 
protected:
       mutable QSet<int> m_onceMessageIds;
 
private:
       ilog::IMessageConsumer* m_logPtr;
};
 
 
} // namespace ilog