reporter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef _REPORTER_H_
#define _REPORTER_H_
 
#include <memory>
#include <map>
#include <mutex>
 
#include <eda_units.h>
#include <ki_error.h>
#include <widgets/report_severity.h>
#include <kicommon.h>

 
class wxString;
class wxStatusBar;
class wxTextCtrl;
class WX_HTML_REPORT_PANEL;
class WX_INFOBAR;
class KISTATUSBAR;
class STATUSBAR_WARNING_REPORTER_IMPL;
 

 
class KICOMMON_API REPORTER
{
public:
    REPORTER() :
            m_reportedSeverityMask( 0 )
    { }
 
    virtual ~REPORTER()
    { }

    enum LOCATION {
        LOC_HEAD = 0,
        LOC_BODY,
        LOC_TAIL
    };

 
    virtual REPORTER& Report( const wxString& aText,
                              SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
    {
        m_reportedSeverityMask |= aSeverity;
        return *this;
    }

    virtual REPORTER& Report( const KI_ERROR& aError );

    virtual REPORTER& ReportTail( const wxString& aText,
                                  SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
    {
        return Report( aText, aSeverity );
    }

    virtual REPORTER& ReportHead( const wxString& aText,
                                  SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
    {
        return Report( aText, aSeverity );
    }
 
    REPORTER& Report( const char* aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED );
 
    REPORTER& operator <<( const wxString& aText ) { return Report( aText ); }

    virtual bool HasMessage() const
    {
        return m_reportedSeverityMask != 0;
    }

    virtual bool HasMessageOfSeverity( int aSeverityMask ) const
    {
        return ( m_reportedSeverityMask & aSeverityMask ) != 0;
    }
 
    virtual EDA_UNITS GetUnits() const
    {
        return EDA_UNITS::MM;
    }
 
    virtual void Clear()
    {
        m_reportedSeverityMask = 0;
    }
 
    virtual void Finalize() {};
 
private:
    int m_reportedSeverityMask;
};
 

class KICOMMON_API SYNC_REPORTER : public REPORTER
{
public:
    SYNC_REPORTER( REPORTER& aReporter ) :
            m_reporter( &aReporter )
    { }
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    REPORTER& ReportTail( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    REPORTER& ReportHead( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    bool HasMessage() const override;
 
    bool HasMessageOfSeverity( int aSeverityMask ) const override;
 
    EDA_UNITS GetUnits() const override;
 
    void Clear() override;
 
    void Finalize() override;
 
    void SetNullReporter();
 
protected:
    REPORTER*          m_reporter;
    mutable std::mutex m_mutex;
};
 

class KICOMMON_API WX_TEXT_CTRL_REPORTER : public REPORTER
{
public:
    WX_TEXT_CTRL_REPORTER( wxTextCtrl* aTextCtrl ) :
        REPORTER(),
        m_textCtrl( aTextCtrl )
    {
    }
 
    virtual ~WX_TEXT_CTRL_REPORTER()
    {
    }
 
    REPORTER& Report( const wxString& aText,
                      SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
private:
    wxTextCtrl* m_textCtrl;
};
 

class KICOMMON_API WX_STRING_REPORTER : public REPORTER
{
public:
    WX_STRING_REPORTER() :
            REPORTER()
    { }
 
    virtual ~WX_STRING_REPORTER()
    { }
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    const wxString& GetMessages() const;
    void            Clear() override;
 
private:
    wxString m_string;
};
 

class KICOMMON_API NULL_REPORTER : public REPORTER
{
public:
    NULL_REPORTER()
    { }
 
    virtual ~NULL_REPORTER()
    { }
 
    static REPORTER& GetInstance();
 
    REPORTER& Report( const wxString& aText,
                      SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
};
 

class KICOMMON_API CLI_REPORTER : public REPORTER
{
public:
    CLI_REPORTER() :
            m_verbose( false )
    { }
 
    virtual ~CLI_REPORTER()
    { }
 
    static CLI_REPORTER& GetInstance();

    void SetVerbose( bool aVerbose ) { m_verbose = aVerbose; }
 
    bool GetVerbose() const { return m_verbose; }
 
    REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
private:
    bool m_verbose;
};
 

class KICOMMON_API STDOUT_REPORTER : public REPORTER
{
public:
    STDOUT_REPORTER()
    { }
 
    virtual ~STDOUT_REPORTER()
    { }
 
    static REPORTER& GetInstance();
 
    REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
};
 
 
class KICOMMON_API WXLOG_REPORTER : public REPORTER
{
public:
    WXLOG_REPORTER()
    { }
 
    virtual ~WXLOG_REPORTER()
    { }
 
    static REPORTER& GetInstance();
 
    REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
};
 
 
class KICOMMON_API LOAD_INFO_REPORTER : public REPORTER
{
public:
    LOAD_INFO_REPORTER()
    { }
 
    virtual ~LOAD_INFO_REPORTER()
    { }
 
    static LOAD_INFO_REPORTER& GetInstance();
 
    REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    void SetRedirectTarget( REPORTER* aReporter );
    REPORTER* GetRedirectTarget() const;
 
private:
    REPORTER* m_redirectTarget = nullptr;
};
 
 
class KICOMMON_API LOAD_INFO_REPORTER_SCOPE
{
public:
    explicit LOAD_INFO_REPORTER_SCOPE( REPORTER* aReporter );
    ~LOAD_INFO_REPORTER_SCOPE();
 
private:
    LOAD_INFO_REPORTER& m_reporter;
    REPORTER*           m_previousReporter;
};
 

class KICOMMON_API FONTCONFIG_REPORTER_SCOPE
{
public:
    explicit FONTCONFIG_REPORTER_SCOPE( REPORTER* aReporter );
    ~FONTCONFIG_REPORTER_SCOPE();
 
private:
    REPORTER* m_previousReporter;
};
 
 
class KICOMMON_API REDIRECT_REPORTER : public REPORTER
{
public:
    REDIRECT_REPORTER( REPORTER* aRedirectTarget ) : m_redirectTarget( aRedirectTarget ) {}
 
    REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
    REPORTER* m_redirectTarget;
};
 

class KICOMMON_API STATUSBAR_REPORTER : public REPORTER
{
public:
    STATUSBAR_REPORTER( wxStatusBar* aStatusBar, int aPosition = 0 )
            : REPORTER(),
              m_statusBar( aStatusBar ),
              m_position( aPosition )
    { }
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
 
private:
    wxStatusBar* m_statusBar;
    int          m_position;
};
 
 
class KICOMMON_API STATUSBAR_WARNING_REPORTER : public REPORTER
{
public:
    STATUSBAR_WARNING_REPORTER( KISTATUSBAR* aStatusBar, const wxString& aSource );
    ~STATUSBAR_WARNING_REPORTER() override;
 
    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;
    REPORTER& Report( const KI_ERROR& aError ) override;
 
private:
    std::shared_ptr<STATUSBAR_WARNING_REPORTER_IMPL> m_impl;
};
 
#endif     // _REPORTER_H_