CStreamLogCompBase.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.
********************************************************************************/
 
#ifndef ilog_CStreamLogCompBase_included
#define ilog_CStreamLogCompBase_included
 
 
// ICF includes
#include <ilog/CLogCompBase.h>
 
 
namespace ilog
{
 
 
class CStreamLogCompBase: public CLogCompBase
{
public:
    typedef ilog::CLogCompBase BaseClass;
 
    I_BEGIN_BASE_COMPONENT(CStreamLogCompBase);
        I_ASSIGN(m_minPriorityAttrPtr, "MinCategory", "Minimal category of message to print it out:\n *1-Information\n *2-Warning\n *3-Error\n *4-Critical", true, 0);
        I_ASSIGN(m_isDotEnabledAttrPtr, "ShowDots", "If it's true, dot will be shown for each ignored message", true, false);
        I_ASSIGN(m_useCategoryAttrPtr, "UseCategory", "Use error category for the messsages (e.g warning or error)", true, true);
        I_ASSIGN(m_useCodeAttrPtr, "UseCode", "Use error code for the messsages", true, true);
        I_ASSIGN(m_useTimeStampAttrPtr, "UseTimeStamp", "Use time stamp for the messsages", true, false);
        I_ASSIGN(m_timeFormatAttrPtr, "TimeFormat", "Format used for timestamp output", false, "dd.MM hh:mm:ss:zzz");
    I_END_COMPONENT;
 
    CStreamLogCompBase();
 
    istd::IInformationProvider::InformationCategory GetWorseCategory() const;
 
    // reimplemented (ilog::IMessageConsumer)
    bool IsMessageSupported(
            int messageCategory = -1,
            int messageId = -1,
            const QByteArray* senderIdPtr = nullptr) const override;
 
protected:
    virtual void WriteMessageToStream(const istd::IInformationProvider& message);
 
    virtual QString GenerateMessageText(const istd::IInformationProvider& message) const;
 
    // abstract methods
 
    virtual void WriteText(const QString& text, istd::IInformationProvider::InformationCategory category) = 0;
 
    // reimplemented (ilog::CLogCompBase)
    void WriteMessageToLog(const MessagePtr& messagePtr) override;
 
    // reimplemented (icomp::CComponentBase)
    void OnComponentDestroyed() override;
 
private:
    I_ATTR(int, m_minPriorityAttrPtr);
    I_ATTR(bool, m_isDotEnabledAttrPtr);
    I_ATTR(bool, m_useCategoryAttrPtr);
    I_ATTR(bool, m_useCodeAttrPtr);
    I_ATTR(bool, m_useTimeStampAttrPtr);
    I_ATTR(QByteArray, m_timeFormatAttrPtr);
 
    bool m_isLastDotShown;
    istd::IInformationProvider::InformationCategory m_lastDotCategory;
    istd::IInformationProvider::InformationCategory m_worseCategory;
};
 
 
} // namespace ilog
 
 
#endif // !ilog_CStreamLogCompBase_included