dialog_cleanup_tracks_and_vias.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 <dialog_cleanup_tracks_and_vias.h>
#include <board_commit.h>
#include <pcb_edit_frame.h>
#include <pcbnew_settings.h>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <tracks_cleaner.h>
#include <drc/drc_item.h>
#include <tools/zone_filler_tool.h>

DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS( PCB_EDIT_FRAME* aParentFrame ) :
 DIALOG_CLEANUP_TRACKS_AND_VIAS_BASE( aParentFrame ),
 m_parentFrame( aParentFrame ),
 m_firstRun( true )
{
 auto cfg = m_parentFrame->GetPcbNewSettings();

 m_cleanViasOpt->SetValue( cfg->m_Cleanup.cleanup_vias );
 m_mergeSegmOpt->SetValue( cfg->m_Cleanup.merge_segments );
 m_deleteUnconnectedOpt->SetValue( cfg->m_Cleanup.cleanup_unconnected );
 m_cleanShortCircuitOpt->SetValue( cfg->m_Cleanup.cleanup_short_circuits );
 m_deleteTracksInPadsOpt->SetValue( cfg->m_Cleanup.cleanup_tracks_in_pad );
 m_deleteDanglingViasOpt->SetValue( cfg->m_Cleanup.delete_dangling_vias );

 m_changesTreeModel = new RC_TREE_MODEL( m_parentFrame, m_changesDataView );
 m_changesDataView->AssociateModel( m_changesTreeModel );

 m_changesTreeModel->SetSeverities( RPT_SEVERITY_ACTION );

 // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
 // that requires us to correct the button labels here.
 m_sdbSizerOK->SetLabel( _( "Update PCB" ) );

 m_sdbSizerOK->SetDefault();
 m_sdbSizer->SetSizeHints( this );

 finishDialogSettings();
}


DIALOG_CLEANUP_TRACKS_AND_VIAS::~DIALOG_CLEANUP_TRACKS_AND_VIAS()
{
 auto cfg = m_parentFrame->GetPcbNewSettings();

 cfg->m_Cleanup.cleanup_vias = m_cleanViasOpt->GetValue();
 cfg->m_Cleanup.merge_segments = m_mergeSegmOpt->GetValue();
 cfg->m_Cleanup.cleanup_unconnected = m_deleteUnconnectedOpt->GetValue();
 cfg->m_Cleanup.cleanup_short_circuits = m_cleanShortCircuitOpt->GetValue();
 cfg->m_Cleanup.cleanup_tracks_in_pad = m_deleteTracksInPadsOpt->GetValue();
 cfg->m_Cleanup.delete_dangling_vias = m_deleteDanglingViasOpt->GetValue();

 m_changesTreeModel->DecRef();
}


void DIALOG_CLEANUP_TRACKS_AND_VIAS::OnCheckBox( wxCommandEvent& anEvent )
{
 doCleanup( true );
}


bool DIALOG_CLEANUP_TRACKS_AND_VIAS::TransferDataToWindow()
{
 doCleanup( true );

 return true;
}


bool DIALOG_CLEANUP_TRACKS_AND_VIAS::TransferDataFromWindow()
{
 doCleanup( false );

 return true;
}


void DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup( bool aDryRun )
{
 wxBusyCursor busy;
 BOARD_COMMIT commit( m_parentFrame );
 TRACKS_CLEANER cleaner( m_parentFrame->GetBoard(), commit );

 if( !aDryRun )
 {
 // Clear current selection list to avoid selection of deleted items
 m_parentFrame->GetToolManager()->RunAction( PCB_ACTIONS::selectionClear, true );

 // ... and to keep the treeModel from trying to refresh a deleted item
 m_changesTreeModel->SetProvider( nullptr );
 }

 m_items.clear();

 if( m_firstRun )
 {
 m_items.push_back( std::make_shared<CLEANUP_ITEM>( CLEANUP_CHECKING_ZONE_FILLS ) );
 RC_ITEMS_PROVIDER* provider = new VECTOR_CLEANUP_ITEMS_PROVIDER( &m_items );
 m_changesTreeModel->SetProvider( provider );

 m_parentFrame->GetToolManager()->GetTool<ZONE_FILLER_TOOL>()->CheckAllZones( this );
 wxSafeYield(); // Timeslice to close zone progress reporter

 m_changesTreeModel->SetProvider( nullptr );
 m_items.clear();
 m_firstRun = false;
 }

 // Old model has to be refreshed, GAL normally does not keep updating it
 m_parentFrame->Compile_Ratsnest( false );

 cleaner.CleanupBoard( aDryRun, &m_items, m_cleanShortCircuitOpt->GetValue(),
 m_cleanViasOpt->GetValue(),
 m_mergeSegmOpt->GetValue(),
 m_deleteUnconnectedOpt->GetValue(),
 m_deleteTracksInPadsOpt->GetValue(),
 m_deleteDanglingViasOpt->GetValue() );

 if( aDryRun )
 {
 RC_ITEMS_PROVIDER* provider = new VECTOR_CLEANUP_ITEMS_PROVIDER( &m_items );
 m_changesTreeModel->SetProvider( provider );
 }
 else if( !commit.Empty() )
 {
 // Clear undo and redo lists to avoid inconsistencies between lists
 commit.Push( _( "Board cleanup" ) );
 m_parentFrame->GetCanvas()->Refresh( true );
 }
}


void DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem( wxDataViewEvent& aEvent )
{
 const KIID& itemID = RC_TREE_MODEL::ToUUID( aEvent.GetItem() );
 BOARD_ITEM* item = m_parentFrame->GetBoard()->GetItem( itemID );
 WINDOW_THAWER thawer( m_parentFrame );

 m_parentFrame->FocusOnItem( item );
 m_parentFrame->GetCanvas()->Refresh();

 aEvent.Skip();
}


void DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem( wxMouseEvent& event )
{
 event.Skip();

 if( m_changesDataView->GetCurrentItem().IsOk() )
 {
 if( !IsModal() )
 Show( false );
 }
}