reporter.cpp

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/>.
 */
 
#include <cwchar>
#include <mutex>
#include <macros.h>
#include <reporter.h>
#include <font/fontconfig.h>
#include <string_utils.h>
#include <widgets/kistatusbar.h>
#include <widgets/wx_infobar.h>
#include <wx/crt.h>
#include <wx/log.h>
#include <wx/msgout.h>
#include <wx/textctrl.h>
#include <wx/statusbr.h>
#include <wx/tokenzr.h>
#include <wx/weakref.h>
 
#ifdef __WXMSW__
#include <io.h>
#endif
 

static const wxChar traceReporter[] = wxT( "KICAD_REPORTER" );
 
static std::mutex g_logReporterMutex;
 
 
class STATUSBAR_WARNING_REPORTER_IMPL
{
public:
    STATUSBAR_WARNING_REPORTER_IMPL( KISTATUSBAR* aStatusBar, const wxString& aSource ) :
            m_statusBar( aStatusBar ),
            m_source( aSource )
    {
    }
 
    KISTATUSBAR* GetStatusBar() const
    {
        KISTATUSBAR* statusBar = m_statusBar.get();
 
        if( statusBar && !statusBar->IsBeingDeleted() )
            return statusBar;
 
        return nullptr;
    }
 
    wxWeakRef<KISTATUSBAR> m_statusBar;
    wxString               m_source;
};
 
 
REPORTER& REPORTER::Report( const char* aText, SEVERITY aSeverity )
{
    Report( From_UTF8( aText ) );
    return *this;
}
 
 
REPORTER& REPORTER::Report( const KI_ERROR& aError )
{
    return Report( aError.AsString(), aError.GetSeverity() );
}
 
 
REPORTER& WX_TEXT_CTRL_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    REPORTER::Report( aText, 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;
}
 
 
REPORTER& WX_STRING_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    REPORTER::Report( aText, aSeverity );
 
    m_string << aText << wxS( "\n" );
    return *this;
}
 
 
REPORTER& SYNC_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    std::lock_guard lock( m_mutex );
 
    m_reporter->Report( aText, aSeverity );
    return *this;
}
 
 
REPORTER& SYNC_REPORTER::ReportTail( const wxString& aText, SEVERITY aSeverity )
{
    std::lock_guard lock( m_mutex );
 
    m_reporter->ReportTail( aText, aSeverity );
    return *this;
}
 
 
REPORTER& SYNC_REPORTER::ReportHead( const wxString& aText, SEVERITY aSeverity )
{
    std::lock_guard lock( m_mutex );
 
    m_reporter->ReportHead( aText, aSeverity );
    return *this;
}
 
 
void SYNC_REPORTER::Clear()
{
    std::lock_guard lock( m_mutex );
 
    m_reporter->Clear();
}
 
 
void SYNC_REPORTER::Finalize()
{
    std::lock_guard lock( m_mutex );
 
    m_reporter->Finalize();
}
 
 
void SYNC_REPORTER::SetNullReporter()
{
    std::lock_guard lock( m_mutex );
 
    m_reporter = &NULL_REPORTER::GetInstance();
}
 
 
bool SYNC_REPORTER::HasMessage() const
{
    std::lock_guard lock( m_mutex );
 
    return m_reporter->HasMessage();
}
 
 
bool SYNC_REPORTER::HasMessageOfSeverity( int aSeverityMask ) const
{
    std::lock_guard lock( m_mutex );
 
    return m_reporter->HasMessageOfSeverity( aSeverityMask );
}
 
 
EDA_UNITS SYNC_REPORTER::GetUnits() const
{
    std::lock_guard lock( m_mutex );
 
    return m_reporter->GetUnits();
}
 
 
const wxString& WX_STRING_REPORTER::GetMessages() const
{
    return m_string;
}
 
 
void WX_STRING_REPORTER::Clear()
{
    REPORTER::Clear();
    m_string.clear();
}
 
 
REPORTER& NULL_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    return REPORTER::Report( aText, aSeverity );
}
 
 
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 )
{
    REPORTER::Report( aMsg, aSeverity );
 
    // Skip debug messages unless verbose mode is enabled
    if( aSeverity == RPT_SEVERITY_DEBUG && !m_verbose )
        return *this;
 
    FILE* target = stdout;
 
    if( aSeverity == RPT_SEVERITY_ERROR )
        target = stderr;
 
#ifdef __WXMSW__
    const int fd = _fileno( target );
 
    if( fd >= 0 && !_isatty( fd ) )
    {
        wxMessageOutputStderr( target, wxConvUTF8 ).Output( aMsg );
        return *this;
    }
#else
    // Tracing can orient the stream for byte output before the first report.
    if( std::fwide( target, 0 ) < 0 )
    {
        wxMessageOutputStderr( target ).Output( aMsg );
        return *this;
    }
#endif
 
    if( aMsg.EndsWith( wxS( "\n" ) ) )
        wxFprintf( target, aMsg );
    else
        wxFprintf( target, aMsg + wxS( "\n" ) );
 
    // Needed  after wxPrintf (or printf) to be sure the message is immediately printed
    // (i.e. not stored in some i/o buffer)
    fflush( target );
 
    return *this;
}
 
 
CLI_REPORTER& CLI_REPORTER::GetInstance()
{
    static CLI_REPORTER s_cliReporter;
 
    return s_cliReporter;
}
 
 
REPORTER& STDOUT_REPORTER::Report( const wxString& aMsg, SEVERITY aSeverity )
{
    REPORTER::Report( aMsg, 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 )
{
    REPORTER::Report( aMsg, aSeverity );
 
    // aMsg is finished content; pass it as a "%s" argument so a stray '%' in
    // reported data is not read as a format specifier (bogus varargs -> assert).
    switch( aSeverity )
    {
    case RPT_SEVERITY_ERROR:     wxLogError( wxS( "%s" ), aMsg );                break;
    case RPT_SEVERITY_WARNING:   wxLogWarning( wxS( "%s" ), aMsg );              break;
    case RPT_SEVERITY_UNDEFINED: wxLogMessage( wxS( "%s" ), aMsg );             break;
    case RPT_SEVERITY_INFO:      wxLogInfo( wxS( "%s" ), aMsg );                 break;
    case RPT_SEVERITY_ACTION:    wxLogInfo( wxS( "%s" ), aMsg );                 break;
    case RPT_SEVERITY_DEBUG:     wxLogTrace( traceReporter, wxS( "%s" ), aMsg ); break;
    case RPT_SEVERITY_EXCLUSION:                                                 break;
    case RPT_SEVERITY_IGNORE:                                                    break;
    }
 
    return *this;
}
 
 
REPORTER& WXLOG_REPORTER::GetInstance()
{
    static REPORTER* s_wxLogReporter = nullptr;
    std::lock_guard lock( g_logReporterMutex );
 
    if( !s_wxLogReporter )
        s_wxLogReporter = new WXLOG_REPORTER();
 
    return *s_wxLogReporter;
}
 
 
REPORTER& LOAD_INFO_REPORTER::Report( const wxString& aMsg, SEVERITY aSeverity )
{
    REPORTER::Report( aMsg, aSeverity );
 
    REPORTER* target = m_redirectTarget;
 
    if( !target )
        target = &WXLOG_REPORTER::GetInstance();
 
    target->Report( aMsg, aSeverity );
 
    return *this;
}
 
 
LOAD_INFO_REPORTER& LOAD_INFO_REPORTER::GetInstance()
{
    static LOAD_INFO_REPORTER s_loadInfoReporter;
    std::lock_guard lock( g_logReporterMutex );
 
    return s_loadInfoReporter;
}
 
 
void LOAD_INFO_REPORTER::SetRedirectTarget( REPORTER* aReporter )
{
    std::lock_guard lock( g_logReporterMutex );
    m_redirectTarget = aReporter;
}
 
 
REPORTER* LOAD_INFO_REPORTER::GetRedirectTarget() const
{
    std::lock_guard lock( g_logReporterMutex );
    return m_redirectTarget;
}
 
 
LOAD_INFO_REPORTER_SCOPE::LOAD_INFO_REPORTER_SCOPE( REPORTER* aReporter ) :
        m_reporter( LOAD_INFO_REPORTER::GetInstance() ),
        m_previousReporter( m_reporter.GetRedirectTarget() )
{
    m_reporter.SetRedirectTarget( aReporter );
}
 
 
LOAD_INFO_REPORTER_SCOPE::~LOAD_INFO_REPORTER_SCOPE()
{
    m_reporter.SetRedirectTarget( m_previousReporter );
}
 
 
FONTCONFIG_REPORTER_SCOPE::FONTCONFIG_REPORTER_SCOPE( REPORTER* aReporter ) :
        m_previousReporter( &fontconfig::FONTCONFIG::GetReporter() )
{
    fontconfig::FONTCONFIG::SetReporter( aReporter );
}
 
 
FONTCONFIG_REPORTER_SCOPE::~FONTCONFIG_REPORTER_SCOPE()
{
    fontconfig::FONTCONFIG::SetReporter( m_previousReporter );
}
 
 
REPORTER& REDIRECT_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    REPORTER::Report( aText, aSeverity );
 
    if( m_redirectTarget )
        m_redirectTarget->Report( aText, aSeverity );
 
    return *this;
}
 
 
REPORTER& STATUSBAR_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    REPORTER::Report( aText, aSeverity );
 
    if( m_statusBar )
    {
        wxStatusBar* statusBar = m_statusBar;
        int          position = m_position;
 
        if( wxIsMainThread() )
        {
            // The message will be ellipsized automatically
            statusBar->SetStatusText( aText, position );
        }
        else
        {
            statusBar->CallAfter(
                    [statusBar, position, aText]()
                    {
                        statusBar->SetStatusText( aText, position );
                    } );
        }
    }
 
    return *this;
}
 
 
STATUSBAR_WARNING_REPORTER::STATUSBAR_WARNING_REPORTER( KISTATUSBAR* aStatusBar,
                                                        const wxString& aSource ) :
        m_impl( std::make_shared<STATUSBAR_WARNING_REPORTER_IMPL>( aStatusBar, aSource ) )
{
}
 
 
STATUSBAR_WARNING_REPORTER::~STATUSBAR_WARNING_REPORTER() = default;
 
 
REPORTER& STATUSBAR_WARNING_REPORTER::Report( const wxString& aText, SEVERITY aSeverity )
{
    REPORTER::Report( aText, aSeverity );
 
    KISTATUSBAR* statusBar = m_impl ? m_impl->GetStatusBar() : nullptr;
 
    if( !statusBar || aText.IsEmpty() )
        return *this;
 
    std::vector<KI_ERROR> messages;
    wxStringTokenizer tokenizer( aText, wxS( "\n" ), wxTOKEN_STRTOK );
    SEVERITY severity = aSeverity == RPT_SEVERITY_UNDEFINED ? RPT_SEVERITY_WARNING : aSeverity;
 
    while( tokenizer.HasMoreTokens() )
    {
        KI_ERROR message;
        message.SetTitle( tokenizer.GetNextToken() );
        message.SetSeverity( severity );
        messages.emplace_back( std::move( message ) );
    }
 
    if( messages.empty() )
    {
        KI_ERROR message;
        message.SetTitle( aText );
        message.SetSeverity( severity );
        messages.emplace_back( std::move( message ) );
    }
 
    statusBar->AddWarningMessages( m_impl->m_source, messages );
    return *this;
}
 
 
REPORTER& STATUSBAR_WARNING_REPORTER::Report( const KI_ERROR& aError )
{
    REPORTER::Report( aError.AsString(), aError.GetSeverity() );
 
    if( KISTATUSBAR* statusBar = m_impl ? m_impl->GetStatusBar() : nullptr )
        statusBar->AddWarningMessages( m_impl->m_source, { aError } );
 
    return *this;
}