haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/common/dialogs/wx_html_report_panel.cpp

314 lines
7.7 KiB
C++
Raw Normal View History

WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 CERN
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
* Copyright (C) 2015-2017 KiCad Developers, see change_log.txt for contributors.
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
* Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* 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/>.
*/
#include "wx_html_report_panel.h"
#include <wildcards_and_files_ext.h>
Replace BOOST_FOREACH with C++11 range based for.
2016-06-29 20:07:55 +00:00
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
WX_HTML_REPORT_PANEL::WX_HTML_REPORT_PANEL( wxWindow* parent,
wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style ) :
WX_HTML_REPORT_PANEL_BASE( parent, id, pos, size, style ),
m_reporter( this ),
m_severities( -1 ),
Added lazy rendering mode for HTML reporter widget (allows a faster report creation, when the report has many lines)
2015-07-24 15:47:48 +00:00
m_showAll( true ),
m_lazyUpdate( false )
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
{
syncCheckboxes();
Make WX_HTML_REPORT_PANEL use the default system background color.
2015-06-26 15:34:07 +00:00
m_htmlView->SetPage( addHeader( "" ) );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
}
WX_HTML_REPORT_PANEL::~WX_HTML_REPORT_PANEL()
{
}
Better sizing of wx_html_report_panel in dialog_netlist (fix bug #1522758)
2015-12-04 17:06:54 +00:00
void WX_HTML_REPORT_PANEL::MsgPanelSetMinSize( const wxSize& aMinSize )
{
m_htmlView->SetMinSize( aMinSize );
GetSizer()->SetSizeHints( this );
}
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
REPORTER& WX_HTML_REPORT_PANEL::Reporter()
{
return m_reporter;
}
void WX_HTML_REPORT_PANEL::Report( const wxString& aText, REPORTER::SEVERITY aSeverity )
{
REPORT_LINE line;
line.message = aText;
line.severity = aSeverity;
m_report.push_back( line );
Added lazy rendering mode for HTML reporter widget (allows a faster report creation, when the report has many lines)
2015-07-24 15:47:48 +00:00
m_html += generateHtml( line );
if( !m_lazyUpdate )
{
m_htmlView->AppendToPage( generateHtml( line ) );
scrollToBottom();
}
}
void WX_HTML_REPORT_PANEL::SetLazyUpdate( bool aLazyUpdate )
{
m_lazyUpdate = aLazyUpdate;
}
void WX_HTML_REPORT_PANEL::Flush()
{
Fixed style change in WX_HTML_REPORT_PANEL after a reported action.
2015-08-03 19:11:59 +00:00
m_htmlView->SetPage( addHeader( m_html ) );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
scrollToBottom();
}
void WX_HTML_REPORT_PANEL::scrollToBottom()
{
int x, y, xUnit, yUnit;
Added lazy rendering mode for HTML reporter widget (allows a faster report creation, when the report has many lines)
2015-07-24 15:47:48 +00:00
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
m_htmlView->GetVirtualSize( &x, &y );
m_htmlView->GetScrollPixelsPerUnit( &xUnit, &yUnit );
m_htmlView->Scroll( 0, y / yUnit );
}
void WX_HTML_REPORT_PANEL::refreshView()
{
wxString html;
Fix loop variable copy in for-range loop, use const reference instead
2017-09-24 18:11:58 +00:00
for( const REPORT_LINE& l : m_report )
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
{
html += generateHtml( l );
}
Make WX_HTML_REPORT_PANEL use the default system background color.
2015-06-26 15:34:07 +00:00
m_htmlView->SetPage( addHeader( html ) );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
scrollToBottom();
}
Make WX_HTML_REPORT_PANEL use the default system background color.
2015-06-26 15:34:07 +00:00
wxString WX_HTML_REPORT_PANEL::addHeader( const wxString& aBody )
{
wxColour bgcolor = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
Use the system text color in WX_HTML_REPORT_PANEL.
2015-06-29 08:43:09 +00:00
wxColour fgcolor = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOWTEXT );
wxString s = "<html><body bgcolor=\"" + bgcolor.GetAsString( wxC2S_HTML_SYNTAX ) +
"\" text=\"" + fgcolor.GetAsString( wxC2S_HTML_SYNTAX ) + "\">";
Make WX_HTML_REPORT_PANEL use the default system background color.
2015-06-26 15:34:07 +00:00
s += aBody;
s += "</body></html>";
return s;
}
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
wxString WX_HTML_REPORT_PANEL::generateHtml( const REPORT_LINE& aLine )
{
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
wxString retv;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
if( !m_showAll && ! ( m_severities & aLine.severity ) )
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
return retv;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
switch( aLine.severity )
{
case REPORTER::RPT_ERROR:
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
retv = "<font color=\"red\" size=2><b>" + _( "Error: " ) + "</b></font><font size=2>" +
aLine.message + "</font><br>";
break;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
case REPORTER::RPT_WARNING:
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
retv = "<font color=\"orange\" size=2><b>" + _( "Warning: " ) +
"</b></font><font size=2>" + aLine.message + "</font><br>";
break;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
case REPORTER::RPT_INFO:
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
retv = "<font color=\"dark gray\" size=2><b>" + _( "Info: " ) + "</b>" + aLine.message +
"</font><br>";
break;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
case REPORTER::RPT_ACTION:
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
retv = "<font color=\"dark green\" size=2>" + aLine.message + "</font><br>";
break;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
default:
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
retv = "<font size=2>" + aLine.message + "</font><br>";
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
}
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
return retv;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
}
wxString WX_HTML_REPORT_PANEL::generatePlainText( const REPORT_LINE& aLine )
{
switch( aLine.severity )
{
case REPORTER::RPT_ERROR:
return _( "Error: " ) + aLine.message + wxT( "\n" );
case REPORTER::RPT_WARNING:
return _( "Warning: " ) + aLine.message + wxT( "\n" );
case REPORTER::RPT_INFO:
return _( "Info: " ) + aLine.message + wxT( "\n" );
default:
return aLine.message + wxT( "\n" );
}
}
void WX_HTML_REPORT_PANEL::onCheckBoxShowAll( wxCommandEvent& event )
{
if ( event.IsChecked() )
m_showAll = true;
else
m_showAll = false;
syncCheckboxes();
refreshView();
}
void WX_HTML_REPORT_PANEL::syncCheckboxes()
{
Pcbnew: Fix some issues in dialog netlist: remove useless check box, avoid a message sometimes erroneously shown, use lazy mode to build the netlist report, store the netlist report options in user config.
2015-07-24 18:49:47 +00:00
m_checkBoxShowAll->SetValue( m_showAll );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
m_checkBoxShowWarnings->Enable( !m_showAll );
m_checkBoxShowWarnings->SetValue( m_severities & REPORTER::RPT_WARNING );
m_checkBoxShowErrors->Enable( !m_showAll );
m_checkBoxShowErrors->SetValue( m_severities & REPORTER::RPT_ERROR );
m_checkBoxShowInfos->Enable( !m_showAll );
m_checkBoxShowInfos->SetValue( m_severities & REPORTER::RPT_INFO );
m_checkBoxShowActions->Enable( !m_showAll );
m_checkBoxShowActions->SetValue( m_severities & REPORTER::RPT_ACTION );
}
void WX_HTML_REPORT_PANEL::onCheckBoxShowWarnings( wxCommandEvent& event )
{
if ( event.IsChecked() )
Pcbnew: Fix some issues in dialog netlist: remove useless check box, avoid a message sometimes erroneously shown, use lazy mode to build the netlist report, store the netlist report options in user config.
2015-07-24 18:49:47 +00:00
m_severities |= REPORTER::RPT_WARNING;
else
m_severities &= ~REPORTER::RPT_WARNING;
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
refreshView();
}
void WX_HTML_REPORT_PANEL::onCheckBoxShowErrors( wxCommandEvent& event )
{
if ( event.IsChecked() )
m_severities |= REPORTER::RPT_ERROR;
else
m_severities &= ~REPORTER::RPT_ERROR;
refreshView();
}
void WX_HTML_REPORT_PANEL::onCheckBoxShowInfos( wxCommandEvent& event )
{
if ( event.IsChecked() )
m_severities |= REPORTER::RPT_INFO;
else
m_severities &= ~REPORTER::RPT_INFO;
refreshView();
}
void WX_HTML_REPORT_PANEL::onCheckBoxShowActions( wxCommandEvent& event )
{
if ( event.IsChecked() )
m_severities |= REPORTER::RPT_ACTION;
else
m_severities &= ~REPORTER::RPT_ACTION;
refreshView();
}
void WX_HTML_REPORT_PANEL::onBtnSaveToFile( wxCommandEvent& event )
{
wxFileName fn( "./report.txt" );
GTK+ file dialog wildcard improvements. The GTK+ file dialog is case sensitive however it does support regular expressions. Most of the file dialog wildcards are lower case so only files with the lower case extensions will show up in the file dialog. This code adds a method to convert file extensions of any case to the appropriate (sch -> [sS][cC][hH]) regular expression on GTK+ builds so all file extension case combinations will show up in the file dialog. A note to developers: make sure to add a file extension when setting when setting the default file argument. If you do don't set an extension, the GTK+ file dialog will happily append the regular expression as the file extension which is surely not what you want. There are still a few known places (mostly gerbview) where there are some complex wildcard code that has not been converted. Fixes lp:1720542 https://bugs.launchpad.net/kicad/+bug/1720542
2017-11-12 00:31:38 +00:00
wxFileDialog dlg( this, _( "Save Report to File" ), fn.GetPath(), fn.GetFullName(),
TextFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
if( dlg.ShowModal() != wxID_OK )
return;
fn = dlg.GetPath();
if( fn.GetExt().IsEmpty() )
Minor HTML message panel improvements. Change action message color from "darkgreen" to "dark green" as the former does not exist on windows and results in debug log warnings. Change the information color from "grey" to "dark grey" for improved contrast with the white backgrounds. This may need to configurable on systems where the HTML window has a dark background color. Don't translate HTML formatting strings.
2017-11-28 18:13:44 +00:00
fn.SetExt( "txt" );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
wxFile f( fn.GetFullPath(), wxFile::write );
if( !f.IsOpened() )
{
wxString msg;
Fix quotes in UI messages This replaces all single and angle bracket quotes in UI messages with double quotes, for consistency. Sorry to all translators.
2017-12-15 11:37:46 +00:00
msg.Printf( _( "Cannot write report to file \"%s\"." ),
Add color selector in 3D viewer for silkscreen, solder mask and copper. Remove unused or duplicate icons.
2015-06-16 18:04:02 +00:00
fn.GetFullPath().GetData() );
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
wxMessageBox( msg, _( "File save error" ), wxOK | wxICON_ERROR, this );
return;
}
Fix loop variable copy in for-range loop, use const reference instead
2017-09-24 18:11:58 +00:00
for( const REPORT_LINE& l : m_report )
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
{
f.Write( generatePlainText( l ) );
}
f.Close();
}
void WX_HTML_REPORT_PANEL::Clear()
{
Added lazy rendering mode for HTML reporter widget (allows a faster report creation, when the report has many lines)
2015-07-24 15:47:48 +00:00
m_html.clear();
WX_HTML_REPORT_PANEL: a REPORTER widget on steroids.
2015-06-16 12:20:42 +00:00
m_report.clear();
}
Added lazy rendering mode for HTML reporter widget (allows a faster report creation, when the report has many lines)
2015-07-24 15:47:48 +00:00
void WX_HTML_REPORT_PANEL::SetLabel( const wxString& aLabel )
{
m_box->GetStaticBox()->SetLabel( aLabel );
}
Pcbnew: Fix some issues in dialog netlist: remove useless check box, avoid a message sometimes erroneously shown, use lazy mode to build the netlist report, store the netlist report options in user config.
2015-07-24 18:49:47 +00:00
void WX_HTML_REPORT_PANEL::SetVisibleSeverities( int aSeverities )
{
if( aSeverities < 0 )
m_showAll = true;
else
{
m_showAll = false;
m_severities = aSeverities;
}
syncCheckboxes();
}
int WX_HTML_REPORT_PANEL::GetVisibleSeverities()
{
return m_showAll ? m_severities | 0x80000000 : m_severities & ~0x80000000;
}