mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 10:13:19 +02:00
725082786e
This is mainly to remove the annotation nag dialogs in favour of the HTML links. But it also allows you to see more than a few messages, and implements a progress reporter architecture if the ERC checks ever get slow enough to benefit from it.
753 lines
23 KiB
C++
753 lines
23 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 1992-2020 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 <gestfich.h>
|
|
#include <pgm_base.h>
|
|
#include <sch_screen.h>
|
|
#include <sch_edit_frame.h>
|
|
#include <schematic.h>
|
|
#include <project.h>
|
|
#include <kiface_i.h>
|
|
#include <bitmaps.h>
|
|
#include <reporter.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <sch_view.h>
|
|
#include <sch_marker.h>
|
|
#include <connection_graph.h>
|
|
#include <tools/ee_actions.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <dialog_erc.h>
|
|
#include <erc.h>
|
|
#include <id.h>
|
|
#include <confirm.h>
|
|
#include <widgets/infobar.h>
|
|
#include <dialogs/wx_html_report_box.h>
|
|
#include <wx/ffile.h>
|
|
#include <wx/hyperlink.h>
|
|
#include <erc_item.h>
|
|
#include <eeschema_settings.h>
|
|
#include <kicad_string.h>
|
|
#include <kiplatform/ui.h>
|
|
|
|
DIALOG_ERC::DIALOG_ERC( SCH_EDIT_FRAME* parent ) :
|
|
DIALOG_ERC_BASE( parent, ID_DIALOG_ERC ), // parent looks for this ID explicitly
|
|
PROGRESS_REPORTER( 1 ),
|
|
m_parent( parent ),
|
|
m_running( false ),
|
|
m_ercRun( false ),
|
|
m_severities( RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING )
|
|
{
|
|
EESCHEMA_SETTINGS* settings = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
|
|
m_severities = settings->m_Appearance.erc_severities;
|
|
|
|
m_messages->SetImmediateMode();
|
|
|
|
m_markerProvider = new SHEETLIST_ERC_ITEMS_PROVIDER( &m_parent->Schematic() );
|
|
m_markerTreeModel = new RC_TREE_MODEL( parent, m_markerDataView );
|
|
m_markerDataView->AssociateModel( m_markerTreeModel );
|
|
|
|
m_markerTreeModel->SetSeverities( m_severities );
|
|
m_markerTreeModel->SetProvider( m_markerProvider );
|
|
syncCheckboxes();
|
|
updateDisplayedCounts();
|
|
|
|
// We use a sdbSizer to get platform-dependent ordering of the action buttons, but
|
|
// that requires us to correct the button labels here.
|
|
m_sdbSizer1OK->SetLabel( _( "Run ERC" ) );
|
|
m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
|
|
m_sdbSizer1->Layout();
|
|
|
|
m_sdbSizer1OK->SetDefault();
|
|
|
|
if( m_parent->CheckAnnotate( NULL_REPORTER::GetInstance(), false ) )
|
|
{
|
|
wxHyperlinkCtrl* button = new wxHyperlinkCtrl( m_infoBar, wxID_ANY,
|
|
_("Show Annotation dialog"),
|
|
wxEmptyString );
|
|
|
|
button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
|
|
[&]( wxHyperlinkEvent& aEvent )
|
|
{
|
|
wxHtmlLinkEvent htmlEvent( aEvent.GetId(),
|
|
wxHtmlLinkInfo( aEvent.GetURL() ) );
|
|
OnLinkClicked( htmlEvent );
|
|
} ) );
|
|
|
|
m_infoBar->RemoveAllButtons();
|
|
m_infoBar->AddButton( button );
|
|
m_infoBar->ShowMessage( _( "Annotation not complete. ERC cannot be run." ) );
|
|
}
|
|
|
|
// Now all widgets have the size fixed, call FinishDialogSettings
|
|
FinishDialogSettings();
|
|
}
|
|
|
|
|
|
DIALOG_ERC::~DIALOG_ERC()
|
|
{
|
|
EESCHEMA_SETTINGS* settings = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
|
|
wxASSERT( settings );
|
|
|
|
if( settings )
|
|
settings->m_Appearance.erc_severities = m_severities;
|
|
|
|
m_markerTreeModel->DecRef();
|
|
}
|
|
|
|
|
|
// PROGRESS_REPORTER calls
|
|
|
|
bool DIALOG_ERC::updateUI()
|
|
{
|
|
// If ERC checks ever get slow enough we'll want a progress indicator...
|
|
//
|
|
// double cur = (double) m_progress.load() / m_maxProgress;
|
|
// cur = std::max( 0.0, std::min( cur, 1.0 ) );
|
|
//
|
|
// m_gauge->SetValue( KiROUND( cur * 1000.0 ) );
|
|
// wxSafeYield( this );
|
|
|
|
return !m_cancelled;
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::AdvancePhase( const wxString& aMessage )
|
|
{
|
|
PROGRESS_REPORTER::AdvancePhase( aMessage );
|
|
SetCurrentProgress( 0.0 );
|
|
|
|
m_messages->Report( aMessage );
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::Report( const wxString& aMessage )
|
|
{
|
|
m_messages->Report( aMessage );
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::updateDisplayedCounts()
|
|
{
|
|
int numErrors = 0;
|
|
int numWarnings = 0;
|
|
int numExcluded = 0;
|
|
|
|
if( m_markerProvider )
|
|
{
|
|
numErrors += m_markerProvider->GetCount( RPT_SEVERITY_ERROR );
|
|
numWarnings += m_markerProvider->GetCount( RPT_SEVERITY_WARNING );
|
|
numExcluded += m_markerProvider->GetCount( RPT_SEVERITY_EXCLUSION );
|
|
}
|
|
|
|
if( !m_ercRun )
|
|
{
|
|
numErrors = -1;
|
|
numWarnings = -1;
|
|
}
|
|
|
|
m_errorsBadge->SetBitmap( MakeBadge( RPT_SEVERITY_ERROR, numErrors, m_errorsBadge ) );
|
|
m_warningsBadge->SetBitmap( MakeBadge( RPT_SEVERITY_WARNING, numWarnings, m_warningsBadge ) );
|
|
m_exclusionsBadge->SetBitmap( MakeBadge( RPT_SEVERITY_EXCLUSION, numExcluded, m_exclusionsBadge ) );
|
|
}
|
|
|
|
|
|
/* Delete the old ERC markers, over the whole hierarchy
|
|
*/
|
|
void DIALOG_ERC::OnEraseDrcMarkersClick( wxCommandEvent& event )
|
|
{
|
|
bool includeExclusions = false;
|
|
int numExcluded = 0;
|
|
|
|
if( m_markerProvider )
|
|
numExcluded += m_markerProvider->GetCount( RPT_SEVERITY_EXCLUSION );
|
|
|
|
if( numExcluded > 0 )
|
|
{
|
|
wxMessageDialog dlg( this, _( "Delete exclusions too?" ), _( "Delete All Markers" ),
|
|
wxYES_NO | wxCANCEL | wxCENTER | wxICON_QUESTION );
|
|
dlg.SetYesNoLabels( _( "Errors and Warnings Only" ) , _( "Errors, Warnings and Exclusions" ) );
|
|
|
|
int ret = dlg.ShowModal();
|
|
|
|
if( ret == wxID_CANCEL )
|
|
return;
|
|
else if( ret == wxID_NO )
|
|
includeExclusions = true;
|
|
}
|
|
|
|
deleteAllMarkers( includeExclusions );
|
|
|
|
m_ercRun = false;
|
|
updateDisplayedCounts();
|
|
m_parent->GetCanvas()->Refresh();
|
|
}
|
|
|
|
|
|
// This is a modeless dialog so we have to handle these ourselves.
|
|
void DIALOG_ERC::OnCancelClick( wxCommandEvent& aEvent )
|
|
{
|
|
if( m_running )
|
|
{
|
|
m_cancelled = true;
|
|
return;
|
|
}
|
|
|
|
m_parent->FocusOnItem( nullptr );
|
|
|
|
Close();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnCloseErcDialog( wxCloseEvent& event )
|
|
{
|
|
m_parent->FocusOnItem( nullptr );
|
|
|
|
Destroy();
|
|
}
|
|
|
|
|
|
static int RPT_SEVERITY_ALL = RPT_SEVERITY_WARNING | RPT_SEVERITY_ERROR | RPT_SEVERITY_EXCLUSION;
|
|
|
|
|
|
void DIALOG_ERC::syncCheckboxes()
|
|
{
|
|
m_showAll->SetValue( m_severities == RPT_SEVERITY_ALL );
|
|
m_showErrors->SetValue( m_severities & RPT_SEVERITY_ERROR );
|
|
m_showWarnings->SetValue( m_severities & RPT_SEVERITY_WARNING );
|
|
m_showExclusions->SetValue( m_severities & RPT_SEVERITY_EXCLUSION );
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnLinkClicked( wxHtmlLinkEvent& event )
|
|
{
|
|
wxCommandEvent dummy;
|
|
m_parent->OnAnnotate( dummy );
|
|
|
|
// We don't actually get notified when the annotation error is resolved, but we can assume
|
|
// that the user will take corrective action. If they don't, we can just show the infobar
|
|
// again.
|
|
m_infoBar->Hide();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnRunERCClick( wxCommandEvent& event )
|
|
{
|
|
wxBusyCursor busy;
|
|
|
|
SCHEMATIC* sch = &m_parent->Schematic();
|
|
|
|
// Build the whole sheet list in hierarchy (sheet, not screen)
|
|
sch->GetSheets().AnnotatePowerSymbols();
|
|
|
|
if( m_parent->CheckAnnotate( NULL_REPORTER::GetInstance(), false ) )
|
|
{
|
|
m_notebook->ChangeSelection( 0 ); // Display the "Tests Running..." tab
|
|
|
|
m_messages->Clear();
|
|
m_messages->Report( _( "Annotation not complete. ERC cannot be run. " )
|
|
+ wxT( "<a href='annotate'>" )
|
|
+ _( "Show Annotation dialog." )
|
|
+ wxT( "</a>" ) );
|
|
|
|
m_messages->Flush();
|
|
m_infoBar->Hide(); // No need for duplicated error messages
|
|
return;
|
|
}
|
|
|
|
m_infoBar->Hide();
|
|
|
|
deleteAllMarkers( true );
|
|
|
|
m_notebook->ChangeSelection( 0 ); // Display the "Tests Running..." tab
|
|
m_messages->Clear();
|
|
wxYield(); // Allow time slice to refresh Messages
|
|
|
|
m_running = true;
|
|
m_sdbSizer1Cancel->SetLabel( _( "Cancel" ) );
|
|
m_sdbSizer1OK->Enable( false );
|
|
m_buttondelmarkers->Enable( false );
|
|
m_saveReport->Enable( false );
|
|
|
|
testErc();
|
|
|
|
if( m_cancelled )
|
|
m_messages->Report( _( "-------- ERC cancelled by user.<br><br>" ) );
|
|
else
|
|
m_messages->Report( _( "Done.<br><br>" ) );
|
|
|
|
Raise();
|
|
wxYield(); // Allow time slice to refresh Messages
|
|
|
|
m_running = false;
|
|
m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
|
|
m_sdbSizer1OK->Enable( true );
|
|
m_buttondelmarkers->Enable( true );
|
|
m_saveReport->Enable( true );
|
|
|
|
if( !m_cancelled )
|
|
{
|
|
wxMilliSleep( 500 );
|
|
m_notebook->ChangeSelection( 1 );
|
|
KIPLATFORM::UI::ForceFocus( m_markerDataView );
|
|
}
|
|
|
|
m_ercRun = true;
|
|
updateDisplayedCounts();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::redrawDrawPanel()
|
|
{
|
|
WINDOW_THAWER thawer( m_parent );
|
|
|
|
m_parent->GetCanvas()->Refresh();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::testErc()
|
|
{
|
|
wxFileName fn;
|
|
|
|
SCHEMATIC* sch = &m_parent->Schematic();
|
|
|
|
// Build the whole sheet list in hierarchy (sheet, not screen)
|
|
sch->GetSheets().AnnotatePowerSymbols();
|
|
|
|
if( m_parent->CheckAnnotate( NULL_REPORTER::GetInstance(), false ) )
|
|
{
|
|
Report( _( "Annotation not complete. ERC cannot be run. " )
|
|
+ wxT( "<a href='annotate'>" )
|
|
+ _( "Show Annotation dialog." )
|
|
+ wxT( "</a>" ) );
|
|
|
|
m_infoBar->Hide(); // No need for duplicated error messages
|
|
return;
|
|
}
|
|
|
|
m_infoBar->Hide();
|
|
|
|
SCH_SCREENS screens( sch->Root() );
|
|
ERC_SETTINGS& settings = sch->ErcSettings();
|
|
ERC_TESTER tester( sch );
|
|
|
|
// Test duplicate sheet names inside a given sheet. While one can have multiple references
|
|
// to the same file, each must have a unique name.
|
|
if( settings.IsTestEnabled( ERCE_DUPLICATE_SHEET_NAME ) )
|
|
{
|
|
AdvancePhase( _( "Checking sheet names..." ) );
|
|
tester.TestDuplicateSheetNames( true );
|
|
}
|
|
|
|
if( settings.IsTestEnabled( ERCE_BUS_ALIAS_CONFLICT ) )
|
|
{
|
|
AdvancePhase( _( "Checking bus conflicts..." ) );
|
|
tester.TestConflictingBusAliases();
|
|
}
|
|
|
|
// The connection graph has a whole set of ERC checks it can run
|
|
AdvancePhase( _( "Checking conflicts..." ) );
|
|
m_parent->RecalculateConnections( NO_CLEANUP );
|
|
sch->ConnectionGraph()->RunERC();
|
|
|
|
// Test is all units of each multiunit component have the same footprint assigned.
|
|
if( settings.IsTestEnabled( ERCE_DIFFERENT_UNIT_FP ) )
|
|
{
|
|
AdvancePhase( _( "Checking footprints..." ) );
|
|
tester.TestMultiunitFootprints();
|
|
}
|
|
|
|
AdvancePhase( _( "Checking pins..." ) );
|
|
|
|
if( settings.IsTestEnabled( ERCE_DIFFERENT_UNIT_NET ) )
|
|
tester.TestMultUnitPinConflicts();
|
|
|
|
// Test pins on each net against the pin connection table
|
|
if( settings.IsTestEnabled( ERCE_PIN_TO_PIN_ERROR ) )
|
|
tester.TestPinToPin();
|
|
|
|
// Test similar labels (i;e. labels which are identical when
|
|
// using case insensitive comparisons)
|
|
if( settings.IsTestEnabled( ERCE_SIMILAR_LABELS ) )
|
|
{
|
|
AdvancePhase( _( "Checking labels..." ) );
|
|
tester.TestSimilarLabels();
|
|
}
|
|
|
|
if( settings.IsTestEnabled( ERCE_UNRESOLVED_VARIABLE ) )
|
|
{
|
|
AdvancePhase( _( "Checking for unresolved variables..." ) );
|
|
tester.TestTextVars( m_parent->GetCanvas()->GetView()->GetWorksheet() );
|
|
}
|
|
|
|
if( settings.IsTestEnabled( ERCE_NOCONNECT_CONNECTED ) )
|
|
{
|
|
AdvancePhase( _( "Checking no connect pins for connections..." ) );
|
|
tester.TestNoConnectPins();
|
|
}
|
|
|
|
if( settings.IsTestEnabled( ERCE_LIB_SYMBOL_ISSUES ) )
|
|
{
|
|
AdvancePhase( _( "Checking for library symbol issues..." ) );
|
|
tester.TestLibSymbolIssues();
|
|
}
|
|
|
|
// Display diags:
|
|
m_markerTreeModel->SetProvider( m_markerProvider );
|
|
|
|
// Display new markers from the current screen:
|
|
KIGFX::VIEW* view = m_parent->GetCanvas()->GetView();
|
|
|
|
for( auto item : m_parent->GetScreen()->Items().OfType( SCH_MARKER_T ) )
|
|
view->Add( item );
|
|
|
|
m_parent->GetCanvas()->Refresh();
|
|
|
|
// Display message
|
|
Report( _( "Done.<br><br>" ) );
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnERCItemSelected( wxDataViewEvent& aEvent )
|
|
{
|
|
const KIID& itemID = RC_TREE_MODEL::ToUUID( aEvent.GetItem() );
|
|
SCH_SHEET_PATH sheet;
|
|
SCH_ITEM* item = m_parent->Schematic().GetSheets().GetItem( itemID, &sheet );
|
|
|
|
if( item && item->GetClass() != wxT( "DELETED_SHEET_ITEM" ) )
|
|
{
|
|
WINDOW_THAWER thawer( m_parent );
|
|
|
|
if( !sheet.empty() && sheet != m_parent->GetCurrentSheet() )
|
|
{
|
|
m_parent->GetToolManager()->RunAction( ACTIONS::cancelInteractive, true );
|
|
m_parent->GetToolManager()->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
m_parent->SetCurrentSheet( sheet );
|
|
m_parent->DisplayCurrentSheet();
|
|
m_parent->RedrawScreen( (wxPoint) m_parent->GetScreen()->m_ScrollCenter, false );
|
|
}
|
|
|
|
m_parent->FocusOnItem( item );
|
|
redrawDrawPanel();
|
|
}
|
|
|
|
aEvent.Skip();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnERCItemDClick( wxDataViewEvent& aEvent )
|
|
{
|
|
if( aEvent.GetItem().IsOk() )
|
|
{
|
|
// turn control over to m_parent, hide this DIALOG_ERC window,
|
|
// no destruction so we can preserve listbox cursor
|
|
if( !IsModal() )
|
|
Show( false );
|
|
}
|
|
|
|
aEvent.Skip();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnERCItemRClick( wxDataViewEvent& aEvent )
|
|
{
|
|
RC_TREE_NODE* node = RC_TREE_MODEL::ToNode( aEvent.GetItem() );
|
|
|
|
if( !node )
|
|
return;
|
|
|
|
ERC_SETTINGS& settings = m_parent->Schematic().ErcSettings();
|
|
|
|
std::shared_ptr<RC_ITEM> rcItem = node->m_RcItem;
|
|
wxString listName;
|
|
wxMenu menu;
|
|
wxString msg;
|
|
|
|
switch( settings.GetSeverity( rcItem->GetErrorCode() ) )
|
|
{
|
|
case RPT_SEVERITY_ERROR: listName = _( "errors" ); break;
|
|
case RPT_SEVERITY_WARNING: listName = _( "warnings" ); break;
|
|
default: listName = _( "appropriate" ); break;
|
|
}
|
|
|
|
if( rcItem->GetParent()->IsExcluded() )
|
|
{
|
|
menu.Append( 1, _( "Remove exclusion for this violation" ),
|
|
wxString::Format( _( "It will be placed back in the %s list" ), listName ) );
|
|
}
|
|
else
|
|
{
|
|
menu.Append( 2, _( "Exclude this violation" ),
|
|
wxString::Format( _( "It will be excluded from the %s list" ), listName ) );
|
|
}
|
|
|
|
menu.AppendSeparator();
|
|
|
|
if( rcItem->GetErrorCode() == ERCE_PIN_TO_PIN_WARNING
|
|
|| rcItem->GetErrorCode() == ERCE_PIN_TO_PIN_ERROR )
|
|
{
|
|
// Pin to pin severities edited through pin conflict map
|
|
}
|
|
else if( settings.GetSeverity( rcItem->GetErrorCode() ) == RPT_SEVERITY_WARNING )
|
|
{
|
|
menu.Append( 4, wxString::Format( _( "Change severity to Error for all '%s' violations" ),
|
|
rcItem->GetErrorText() ),
|
|
_( "Violation severities can also be edited in the Board Setup... dialog" ) );
|
|
}
|
|
else
|
|
{
|
|
menu.Append( 5, wxString::Format( _( "Change severity to Warning for all '%s' violations" ),
|
|
rcItem->GetErrorText() ),
|
|
_( "Violation severities can also be edited in the Board Setup... dialog" ) );
|
|
}
|
|
|
|
menu.Append( 6, wxString::Format( _( "Ignore all '%s' violations" ), rcItem->GetErrorText() ),
|
|
_( "Violations will not be checked or reported" ) );
|
|
|
|
menu.AppendSeparator();
|
|
|
|
if( rcItem->GetErrorCode() == ERCE_PIN_TO_PIN_WARNING
|
|
|| rcItem->GetErrorCode() == ERCE_PIN_TO_PIN_ERROR )
|
|
{
|
|
menu.Append( 7, _( "Edit pin-to-pin conflict map..." ) );
|
|
}
|
|
else
|
|
{
|
|
menu.Append( 8, _( "Edit violation severities..." ),
|
|
_( "Open the Schematic Setup... dialog" ) );
|
|
}
|
|
|
|
switch( GetPopupMenuSelectionFromUser( menu ) )
|
|
{
|
|
case 1:
|
|
node->m_RcItem->GetParent()->SetExcluded( false );
|
|
|
|
// Update view
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->ValueChanged( node );
|
|
updateDisplayedCounts();
|
|
break;
|
|
|
|
case 2:
|
|
node->m_RcItem->GetParent()->SetExcluded( true );
|
|
|
|
// Update view
|
|
if( m_severities & RPT_SEVERITY_EXCLUSION )
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->ValueChanged( node );
|
|
else
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->DeleteCurrentItem( false );
|
|
|
|
updateDisplayedCounts();
|
|
break;
|
|
|
|
case 4:
|
|
settings.SetSeverity( rcItem->GetErrorCode(), RPT_SEVERITY_ERROR );
|
|
|
|
// Rebuild model and view
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->SetProvider( m_markerProvider );
|
|
updateDisplayedCounts();
|
|
break;
|
|
|
|
case 5:
|
|
settings.SetSeverity( rcItem->GetErrorCode(), RPT_SEVERITY_WARNING );
|
|
|
|
// Rebuild model and view
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->SetProvider( m_markerProvider );
|
|
updateDisplayedCounts();
|
|
break;
|
|
|
|
case 6:
|
|
{
|
|
settings.SetSeverity( rcItem->GetErrorCode(), RPT_SEVERITY_IGNORE );
|
|
|
|
if( rcItem->GetErrorCode() == ERCE_PIN_TO_PIN_ERROR )
|
|
settings.SetSeverity( ERCE_PIN_TO_PIN_WARNING, RPT_SEVERITY_IGNORE );
|
|
|
|
SCH_SCREENS ScreenList( m_parent->Schematic().Root() );
|
|
ScreenList.DeleteMarkers( MARKER_BASE::MARKER_ERC, rcItem->GetErrorCode() );
|
|
|
|
// Rebuild model and view
|
|
static_cast<RC_TREE_MODEL*>( aEvent.GetModel() )->SetProvider( m_markerProvider );
|
|
updateDisplayedCounts();
|
|
}
|
|
break;
|
|
|
|
case 7:
|
|
m_parent->ShowSchematicSetupDialog( _( "Pin Conflicts Map" ) );
|
|
break;
|
|
|
|
case 8:
|
|
m_parent->ShowSchematicSetupDialog( _( "Violation Severity" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnSeverity( wxCommandEvent& aEvent )
|
|
{
|
|
int flag = 0;
|
|
|
|
if( aEvent.GetEventObject() == m_showAll )
|
|
flag = RPT_SEVERITY_ALL;
|
|
else if( aEvent.GetEventObject() == m_showErrors )
|
|
flag = RPT_SEVERITY_ERROR;
|
|
else if( aEvent.GetEventObject() == m_showWarnings )
|
|
flag = RPT_SEVERITY_WARNING;
|
|
else if( aEvent.GetEventObject() == m_showExclusions )
|
|
flag = RPT_SEVERITY_EXCLUSION;
|
|
|
|
if( aEvent.IsChecked() )
|
|
m_severities |= flag;
|
|
else if( aEvent.GetEventObject() == m_showAll )
|
|
m_severities = RPT_SEVERITY_ERROR;
|
|
else
|
|
m_severities &= ~flag;
|
|
|
|
syncCheckboxes();
|
|
|
|
// Set the provider's severity levels through the TreeModel so that the old tree
|
|
// can be torn down before the severity changes.
|
|
//
|
|
// It's not clear this is required, but we've had a lot of issues with wxDataView
|
|
// being cranky on various platforms.
|
|
|
|
m_markerTreeModel->SetSeverities( m_severities );
|
|
|
|
updateDisplayedCounts();
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::deleteAllMarkers( bool aIncludeExclusions )
|
|
{
|
|
// Clear current selection list to avoid selection of deleted items
|
|
m_parent->GetToolManager()->RunAction( EE_ACTIONS::clearSelection, true );
|
|
|
|
m_markerTreeModel->DeleteItems( false, aIncludeExclusions, true );
|
|
}
|
|
|
|
|
|
void DIALOG_ERC::OnSaveReport( wxCommandEvent& aEvent )
|
|
{
|
|
wxFileName fn( "./ERC." + ReportFileExtension );
|
|
|
|
wxFileDialog dlg( this, _( "Save Report to File" ), fn.GetPath(), fn.GetFullName(),
|
|
ReportFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
|
|
|
|
if( dlg.ShowModal() != wxID_OK )
|
|
return;
|
|
|
|
fn = dlg.GetPath();
|
|
|
|
if( fn.GetExt().IsEmpty() )
|
|
fn.SetExt( ReportFileExtension );
|
|
|
|
if( !fn.IsAbsolute() )
|
|
{
|
|
wxString prj_path = Prj().GetProjectPath();
|
|
fn.MakeAbsolute( prj_path );
|
|
}
|
|
|
|
if( writeReport( fn.GetFullPath() ) )
|
|
{
|
|
m_messages->Report( wxString::Format( _( "Report file '%s' created\n" ),
|
|
fn.GetFullPath() ) );
|
|
}
|
|
else
|
|
{
|
|
DisplayError( this, wxString::Format( _( "Unable to create report file '%s'" ),
|
|
fn.GetFullPath() ) );
|
|
}
|
|
}
|
|
|
|
|
|
bool DIALOG_ERC::writeReport( const wxString& aFullFileName )
|
|
{
|
|
wxFFile file( aFullFileName, wxT( "wt" ) );
|
|
|
|
if( !file.IsOpened() )
|
|
return false;
|
|
|
|
wxString msg = wxString::Format( _( "ERC report (%s, Encoding UTF8)\n" ), DateAndTime() );
|
|
|
|
std::map<KIID, EDA_ITEM*> itemMap;
|
|
|
|
int err_count = 0;
|
|
int warn_count = 0;
|
|
int total_count = 0;
|
|
SCH_SHEET_LIST sheetList = m_parent->Schematic().GetSheets();
|
|
|
|
sheetList.FillItemMap( itemMap );
|
|
|
|
ERC_SETTINGS& settings = m_parent->Schematic().ErcSettings();
|
|
|
|
for( unsigned i = 0; i < sheetList.size(); i++ )
|
|
{
|
|
msg << wxString::Format( _( "\n***** Sheet %s\n" ), sheetList[i].PathHumanReadable() );
|
|
|
|
for( SCH_ITEM* aItem : sheetList[i].LastScreen()->Items().OfType( SCH_MARKER_T ) )
|
|
{
|
|
const SCH_MARKER* marker = static_cast<const SCH_MARKER*>( aItem );
|
|
RC_ITEM* item = marker->GetRCItem().get();
|
|
SEVERITY severity = (SEVERITY)settings.GetSeverity( item->GetErrorCode() );
|
|
|
|
if( marker->GetMarkerType() != MARKER_BASE::MARKER_ERC )
|
|
continue;
|
|
|
|
total_count++;
|
|
|
|
switch( severity )
|
|
{
|
|
case RPT_SEVERITY_ERROR: err_count++; break;
|
|
case RPT_SEVERITY_WARNING: warn_count++; break;
|
|
default: break;
|
|
}
|
|
|
|
msg << marker->GetRCItem()->ShowReport( GetUserUnits(), severity, itemMap );
|
|
}
|
|
}
|
|
|
|
msg << wxString::Format( _( "\n ** ERC messages: %d Errors %d Warnings %d\n" ),
|
|
total_count, err_count, warn_count );
|
|
|
|
// Currently: write report using UTF8 (as usual in Kicad).
|
|
// TODO: see if we can use the current encoding page (mainly for Windows users),
|
|
// Or other format (HTML?)
|
|
file.Write( msg );
|
|
|
|
// wxFFile dtor will close the file.
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
wxDialog* InvokeDialogERC( SCH_EDIT_FRAME* aCaller )
|
|
{
|
|
// This is a modeless dialog, so new it rather than instantiating on stack.
|
|
DIALOG_ERC* dlg = new DIALOG_ERC( aCaller );
|
|
|
|
dlg->Show( true );
|
|
|
|
return dlg; // wxDialog is information hiding about DIALOG_ERC.
|
|
}
|