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 (C) 2013-2021 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef _REPORTER_H_
#define _REPORTER_H_

#include <memory>

#include <eda_units.h>
#include <widgets/report_severity.h>

class wxString;
class wxStatusBar;
class wxTextCtrl;
class WX_HTML_REPORT_PANEL;
class WX_INFOBAR;


class REPORTER
{
public:
 enum LOCATION {
 LOC_HEAD = 0,
 LOC_BODY,
 LOC_TAIL
 };

 virtual REPORTER& Report( const wxString& aText,
 SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) = 0;

 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 = 0;

 virtual EDA_UNITS GetUnits() const
 {
 return EDA_UNITS::MILLIMETRES;
 }

 virtual ~REPORTER()
 {
 }
};


class 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;

 bool HasMessage() const override;

private:
 wxTextCtrl* m_textCtrl;
};


class WX_STRING_REPORTER : public REPORTER
{
public:
 WX_STRING_REPORTER( wxString* aString ) :
 REPORTER(),
 m_string( aString )
 {
 }

 virtual ~WX_STRING_REPORTER()
 {
 }

 REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;

 bool HasMessage() const override;

private:
 wxString* m_string;
};


class WX_HTML_PANEL_REPORTER : public REPORTER
{
public:
 WX_HTML_PANEL_REPORTER( WX_HTML_REPORT_PANEL* aPanel ) :
 REPORTER(),
 m_panel( aPanel )
 {
 }

 virtual ~WX_HTML_PANEL_REPORTER()
 {
 }

 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;

private:
 WX_HTML_REPORT_PANEL* m_panel;
};


class NULL_REPORTER : public REPORTER
{
public:
 NULL_REPORTER()
 {
 }

 virtual ~NULL_REPORTER()
 {
 }

 static REPORTER& GetInstance();

 REPORTER& Report( const wxString& aText,
 SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;

 bool HasMessage() const override { return false; }
};


class STDOUT_REPORTER : public REPORTER
{
public:
 STDOUT_REPORTER()
 {
 }

 virtual ~STDOUT_REPORTER()
 {
 }

 static REPORTER& GetInstance();

 REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;

 bool HasMessage() const override { return false; }
};


class WXLOG_REPORTER : public REPORTER
{
public:
 WXLOG_REPORTER()
 {
 }

 virtual ~WXLOG_REPORTER()
 {
 }

 static REPORTER& GetInstance();

 REPORTER& Report( const wxString& aMsg, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;

 bool HasMessage() const override { return false; }
};


class 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;

 bool HasMessage() const override;

private:
 wxStatusBar* m_statusBar;
 int m_position;
};


class INFOBAR_REPORTER : public REPORTER
{
public:
 INFOBAR_REPORTER( WX_INFOBAR* aInfoBar )
 : REPORTER(),
 m_messageSet( false ),
 m_infoBar( aInfoBar ),
 m_severity( RPT_SEVERITY_UNDEFINED )
 {
 }

 virtual ~INFOBAR_REPORTER();

 REPORTER& Report( const wxString& aText,
 SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override;

 bool HasMessage() const override;

 void Finalize();

private:
 bool m_messageSet;
 WX_INFOBAR* m_infoBar;
 std::unique_ptr<wxString> m_message;
 SEVERITY m_severity;
};

#endif // _REPORTER_H_