294 lines
7.7 KiB
C++
294 lines
7.7 KiB
C++
/**
|
|
* @file reporter.cpp
|
|
*/
|
|
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 2013-2021, 2024 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
|
|
*/
|
|
|
|
#include <macros.h>
|
|
#include <reporter.h>
|
|
#include <string_utils.h>
|
|
#include <widgets/wx_infobar.h>
|
|
#include <widgets/wx_html_report_panel.h>
|
|
#include <wx/crt.h>
|
|
#include <wx/log.h>
|
|
#include <wx/textctrl.h>
|
|
#include <wx/statusbr.h>
|
|
|
|
|
|
/**
|
|
* Flag to enable reporter debugging output.
|
|
*
|
|
* @ingroup trace_env_vars
|
|
*/
|
|
static const wxChar traceReporter[] = wxT( "KICAD_REPORTER" );
|
|
|
|
|
|
REPORTER& REPORTER::Report( const char* aText, SEVERITY aSeverity )
|
|
{
|
|
Report( From_UTF8( aText ) );
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& WX_TEXT_CTRL_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
wxCHECK_MSG( m_textCtrl != nullptr, *this,
|
|
wxT( "No wxTextCtrl object defined in WX_TEXT_CTRL_REPORTER." ) );
|
|
|
|
m_textCtrl->AppendText( aText + wxS( "\n" ) );
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool WX_TEXT_CTRL_REPORTER::HasMessage() const
|
|
{
|
|
return !m_textCtrl->IsEmpty();
|
|
}
|
|
|
|
|
|
REPORTER& WX_STRING_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
wxCHECK_MSG( m_string != nullptr, *this,
|
|
wxT( "No wxString object defined in WX_STRING_REPORTER." ) );
|
|
|
|
*m_string << aText << wxS( "\n" );
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool WX_STRING_REPORTER::HasMessage() const
|
|
{
|
|
return !m_string->IsEmpty();
|
|
}
|
|
|
|
|
|
REPORTER& WX_HTML_PANEL_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
wxCHECK_MSG( m_panel != nullptr, *this,
|
|
wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
|
|
|
|
m_panel->Report( aText, aSeverity );
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& WX_HTML_PANEL_REPORTER::ReportTail( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
wxCHECK_MSG( m_panel != nullptr, *this,
|
|
wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
|
|
|
|
m_panel->Report( aText, aSeverity, LOC_TAIL );
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& WX_HTML_PANEL_REPORTER::ReportHead( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
wxCHECK_MSG( m_panel != nullptr, *this,
|
|
wxT( "No WX_HTML_REPORT_PANEL object defined in WX_HTML_PANEL_REPORTER." ) );
|
|
|
|
m_panel->Report( aText, aSeverity, LOC_HEAD );
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool WX_HTML_PANEL_REPORTER::HasMessage() const
|
|
{
|
|
return m_panel->Count( RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING ) > 0;
|
|
}
|
|
|
|
|
|
REPORTER& NULL_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& NULL_REPORTER::GetInstance()
|
|
{
|
|
static REPORTER* s_nullReporter = nullptr;
|
|
|
|
if( !s_nullReporter )
|
|
s_nullReporter = new NULL_REPORTER();
|
|
|
|
return *s_nullReporter;
|
|
}
|
|
|
|
|
|
REPORTER& CLI_REPORTER::Report( const wxString& aMsg, SEVERITY aSeverity )
|
|
{
|
|
FILE* target = stdout;
|
|
|
|
if( aSeverity == RPT_SEVERITY_ERROR )
|
|
target = stderr;
|
|
|
|
if( aMsg.EndsWith( wxS( "\n" ) ) )
|
|
wxFprintf( target, aMsg );
|
|
else
|
|
wxFprintf( target, aMsg + wxS( "\n" ) );
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& CLI_REPORTER::GetInstance()
|
|
{
|
|
static CLI_REPORTER s_cliReporter;
|
|
|
|
return s_cliReporter;
|
|
}
|
|
|
|
|
|
REPORTER& STDOUT_REPORTER::Report( const wxString& aMsg, SEVERITY aSeverity )
|
|
{
|
|
switch( aSeverity )
|
|
{
|
|
case RPT_SEVERITY_UNDEFINED: std::cout << "SEVERITY_UNDEFINED: "; break;
|
|
case RPT_SEVERITY_INFO: std::cout << "SEVERITY_INFO: "; break;
|
|
case RPT_SEVERITY_WARNING: std::cout << "SEVERITY_WARNING: "; break;
|
|
case RPT_SEVERITY_ERROR: std::cout << "SEVERITY_ERROR: "; break;
|
|
case RPT_SEVERITY_ACTION: std::cout << "SEVERITY_ACTION: "; break;
|
|
case RPT_SEVERITY_DEBUG: std::cout << "SEVERITY_DEBUG: "; break;
|
|
case RPT_SEVERITY_EXCLUSION:
|
|
case RPT_SEVERITY_IGNORE: break;
|
|
}
|
|
|
|
std::cout << aMsg << std::endl;
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& STDOUT_REPORTER::GetInstance()
|
|
{
|
|
static REPORTER* s_stdoutReporter = nullptr;
|
|
|
|
if( !s_stdoutReporter )
|
|
s_stdoutReporter = new STDOUT_REPORTER();
|
|
|
|
return *s_stdoutReporter;
|
|
}
|
|
|
|
|
|
REPORTER& WXLOG_REPORTER::Report( const wxString& aMsg, SEVERITY aSeverity )
|
|
{
|
|
switch( aSeverity )
|
|
{
|
|
case RPT_SEVERITY_ERROR: wxLogError( aMsg ); break;
|
|
case RPT_SEVERITY_WARNING: wxLogWarning( aMsg ); break;
|
|
case RPT_SEVERITY_UNDEFINED: wxLogMessage( aMsg ); break;
|
|
case RPT_SEVERITY_INFO: wxLogInfo( aMsg ); break;
|
|
case RPT_SEVERITY_ACTION: wxLogInfo( aMsg ); break;
|
|
case RPT_SEVERITY_DEBUG: wxLogTrace( traceReporter, aMsg ); break;
|
|
case RPT_SEVERITY_EXCLUSION: break;
|
|
case RPT_SEVERITY_IGNORE: break;
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
REPORTER& WXLOG_REPORTER::GetInstance()
|
|
{
|
|
static REPORTER* s_wxLogReporter = nullptr;
|
|
|
|
if( !s_wxLogReporter )
|
|
s_wxLogReporter = new WXLOG_REPORTER();
|
|
|
|
return *s_wxLogReporter;
|
|
}
|
|
|
|
|
|
REPORTER& STATUSBAR_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
if( m_statusBar )
|
|
m_statusBar->SetStatusText( aText, m_position );
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool STATUSBAR_REPORTER::HasMessage() const
|
|
{
|
|
if( m_statusBar )
|
|
return !m_statusBar->GetStatusText( m_position ).IsEmpty();
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
INFOBAR_REPORTER::~INFOBAR_REPORTER()
|
|
{
|
|
}
|
|
|
|
|
|
REPORTER& INFOBAR_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
|
|
{
|
|
m_message.reset( new wxString( aText ) );
|
|
m_severity = aSeverity;
|
|
m_messageSet = true;
|
|
|
|
return *this;
|
|
}
|
|
|
|
|
|
bool INFOBAR_REPORTER::HasMessage() const
|
|
{
|
|
return m_message && !m_message->IsEmpty();
|
|
}
|
|
|
|
|
|
void INFOBAR_REPORTER::Finalize()
|
|
{
|
|
// Don't do anything if no message was ever given
|
|
if( !m_infoBar || !m_messageSet )
|
|
return;
|
|
|
|
// Short circuit if the message is empty and it is already hidden
|
|
if( !HasMessage() && !m_infoBar->IsShownOnScreen() )
|
|
return;
|
|
|
|
int icon = wxICON_NONE;
|
|
|
|
switch( m_severity )
|
|
{
|
|
case RPT_SEVERITY_UNDEFINED: icon = wxICON_INFORMATION; break;
|
|
case RPT_SEVERITY_INFO: icon = wxICON_INFORMATION; break;
|
|
case RPT_SEVERITY_EXCLUSION: icon = wxICON_WARNING; break;
|
|
case RPT_SEVERITY_ACTION: icon = wxICON_WARNING; break;
|
|
case RPT_SEVERITY_WARNING: icon = wxICON_WARNING; break;
|
|
case RPT_SEVERITY_ERROR: icon = wxICON_ERROR; break;
|
|
case RPT_SEVERITY_IGNORE: icon = wxICON_INFORMATION; break;
|
|
case RPT_SEVERITY_DEBUG: icon = wxICON_INFORMATION; break;
|
|
}
|
|
|
|
if( m_message->EndsWith( wxS( "\n" ) ) )
|
|
*m_message = m_message->Left( m_message->Length() - 1 );
|
|
|
|
if( HasMessage() )
|
|
m_infoBar->QueueShowMessage( *m_message, icon );
|
|
else
|
|
m_infoBar->QueueDismiss();
|
|
}
|