wx_html_report_panel.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * Author: Tomasz Wlostowski <[email protected]>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <reporter.h>
#include <vector>
 
#include "wx_html_report_panel_base.h"
 
class WX_HTML_REPORT_PANEL;

class KICOMMON_API 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;
    bool HasMessageOfSeverity( int aSeverityMask ) const override;
 
private:
    WX_HTML_REPORT_PANEL* m_panel;
};

class KICOMMON_API WX_HTML_REPORT_PANEL : public WX_HTML_REPORT_PANEL_BASE
{
public:
    WX_HTML_REPORT_PANEL( wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxSize( 500, 300 ), long style = wxTAB_TRAVERSAL );
 
    ~WX_HTML_REPORT_PANEL();

    void MsgPanelSetMinSize( const wxSize& aMinSize );

    REPORTER& Reporter();

    void Report( const wxString& aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation = REPORTER::LOC_BODY );

    void Clear();

    int Count( int severityMask );

    void SetLabel( const wxString& aLabel ) override;

    void SetLazyUpdate( bool aLazyUpdate ) { m_lazyUpdate = aLazyUpdate; }

    void Flush( bool aSort = false );

    int GetVisibleSeverities() const;

    void SetFileName( const wxString& aReportFileName ) { m_reportFileName = aReportFileName; }

    wxString& GetFileName( void ) { return m_reportFileName; }
 
private:
    struct REPORT_LINE
    {
        SEVERITY severity;
        wxString message;
    };
 
    typedef std::vector<REPORT_LINE> REPORT_LINES;
 
    wxString generateHtml( const REPORT_LINE& aLine );
    wxString generatePlainText( const REPORT_LINE& aLine );
    void updateBadges();
 
    void scrollToBottom();
 
    void onRightClick( wxMouseEvent& event ) override;
    void onMenuEvent( wxMenuEvent& event );
    void onCheckBox( wxCommandEvent& event ) override;
 
    void onBtnSaveToFile( wxCommandEvent& event ) override;
 
    void onThemeChanged( wxSysColourChangedEvent &aEvent );
 
private:
    WX_HTML_PANEL_REPORTER m_reporter;
 
    REPORT_LINES     m_report;          
    REPORT_LINES     m_reportTail;      
    REPORT_LINES     m_reportHead;      
 
    bool             m_lazyUpdate;
 
    wxString         m_reportFileName;  
};