You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
530 lines
16 KiB
530 lines
16 KiB
/*
|
|
* 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) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 1992-2018 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 <fctsys.h>
|
|
#include <class_drawpanel.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <macros.h>
|
|
#include <board_commit.h>
|
|
#include <bitmaps.h>
|
|
#include <class_board.h>
|
|
#include <class_module.h>
|
|
#include <project.h>
|
|
#include <wx_html_report_panel.h>
|
|
#include <kiway.h>
|
|
|
|
#include <dialog_exchange_footprints.h>
|
|
|
|
|
|
#define ID_MATCH_FP_ALL 4200
|
|
#define ID_MATCH_FP_REF 4201
|
|
#define ID_MATCH_FP_VAL 4202
|
|
#define ID_MATCH_FP_ID 4203
|
|
|
|
int DIALOG_EXCHANGE_FOOTPRINTS::m_matchModeForUpdate = ID_MATCH_FP_ALL;
|
|
int DIALOG_EXCHANGE_FOOTPRINTS::m_matchModeForExchange = ID_MATCH_FP_REF;
|
|
int DIALOG_EXCHANGE_FOOTPRINTS::m_matchModeForUpdateSelected = ID_MATCH_FP_REF;
|
|
int DIALOG_EXCHANGE_FOOTPRINTS::m_matchModeForExchangeSelected = ID_MATCH_FP_REF;
|
|
|
|
|
|
DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS( PCB_EDIT_FRAME* aParent, MODULE* aModule,
|
|
bool updateMode ) :
|
|
DIALOG_EXCHANGE_FOOTPRINTS_BASE( aParent ),
|
|
m_commit( aParent ),
|
|
m_parent( aParent ),
|
|
m_currentModule( aModule ),
|
|
m_updateMode( updateMode )
|
|
{
|
|
wxString title = updateMode ? _( "Update Footprints from Library" ) : _( "Change Footprints" );
|
|
wxString verb = updateMode ? _( "Update" ) : _( "Change" );
|
|
wxString label;
|
|
|
|
SetTitle( title );
|
|
|
|
if( m_updateMode )
|
|
{
|
|
label.Printf( m_matchAll->GetLabel(), verb );
|
|
m_matchAll->SetLabel( label );
|
|
m_changeSizer->Show( false );
|
|
}
|
|
else
|
|
{
|
|
m_upperSizer->FindItem( m_matchAll )->Show( false );
|
|
|
|
if( m_currentModule )
|
|
{
|
|
m_newID->AppendText( FROM_UTF8( m_currentModule->GetFPID().Format().c_str() ) );
|
|
SetInitialFocus( m_newID );
|
|
}
|
|
else
|
|
SetInitialFocus( m_specifiedRef );
|
|
|
|
m_newIDBrowseButton->SetBitmap( KiBitmap( small_library_xpm ) );
|
|
}
|
|
|
|
if( m_currentModule )
|
|
{
|
|
m_upperSizer->FindItem( m_matchSpecifiedRef )->Show( false );
|
|
m_upperSizer->FindItem( m_specifiedRef )->Show( false );
|
|
|
|
label.Printf( m_matchCurrentRef->GetLabel(), verb, m_currentModule->GetReference() );
|
|
m_matchCurrentRef->SetLabel( label );
|
|
|
|
m_upperSizer->FindItem( m_matchSpecifiedValue )->Show( false );
|
|
m_upperSizer->FindItem( m_specifiedValue )->Show( false );
|
|
|
|
label.Printf( m_matchCurrentValue->GetLabel(), verb, m_currentModule->GetValue() );
|
|
m_matchCurrentValue->SetLabel( label );
|
|
}
|
|
else
|
|
{
|
|
m_upperSizer->FindItem( m_matchCurrentRef )->Show( false );
|
|
|
|
label.Printf( m_matchSpecifiedRef->GetLabel(), verb );
|
|
m_matchSpecifiedRef->SetLabel( label );
|
|
|
|
m_upperSizer->FindItem( m_matchCurrentValue )->Show( false );
|
|
|
|
label.Printf( m_matchSpecifiedValue->GetLabel(), verb );
|
|
m_matchSpecifiedValue->SetLabel( label );
|
|
}
|
|
|
|
label.Printf( m_matchSpecifiedID->GetLabel(), verb );
|
|
m_matchSpecifiedID->SetLabel( label );
|
|
|
|
if( m_currentModule )
|
|
m_specifiedID->AppendText( FROM_UTF8( m_currentModule->GetFPID().Format().c_str() ) );
|
|
m_specifiedIDBrowseButton->SetBitmap( KiBitmap( small_library_xpm ) );
|
|
|
|
m_upperSizer->SetEmptyCellSize( wxSize( 0, 0 ) );
|
|
m_upperSizer->RecalcSizes();
|
|
|
|
// initialize match-mode
|
|
wxCommandEvent event;
|
|
switch( getMatchMode() )
|
|
{
|
|
case ID_MATCH_FP_ALL:
|
|
if( m_currentModule )
|
|
OnMatchRefClicked( event );
|
|
else
|
|
OnMatchAllClicked( event );
|
|
break;
|
|
case ID_MATCH_FP_REF:
|
|
OnMatchRefClicked( event );
|
|
break;
|
|
case ID_MATCH_FP_VAL:
|
|
OnMatchValueClicked( event );
|
|
break;
|
|
case ID_MATCH_FP_ID:
|
|
OnMatchIDClicked( event );
|
|
}
|
|
|
|
// DIALOG_SHIM needs a unique hash_key because classname is not sufficient
|
|
// because the update and change versions of this dialog have different controls.
|
|
m_hash_key = TO_UTF8( GetTitle() );
|
|
|
|
// Ensure m_closeButton (with id = wxID_CANCEL) has the right label
|
|
// (to fix automatic renaming of button label )
|
|
m_sdbSizerCancel->SetLabel( _( "Close" ) );
|
|
|
|
m_sdbSizerApply->SetDefault();
|
|
|
|
// Now all widgets have the size fixed, call FinishDialogSettings
|
|
FinishDialogSettings();
|
|
}
|
|
|
|
|
|
int DIALOG_EXCHANGE_FOOTPRINTS::getMatchMode()
|
|
{
|
|
if( m_updateMode )
|
|
return( m_currentModule ? m_matchModeForUpdateSelected : m_matchModeForUpdate );
|
|
else
|
|
return( m_currentModule ? m_matchModeForExchangeSelected : m_matchModeForExchange );
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::setMatchMode( int aMatchMode )
|
|
{
|
|
if( m_updateMode )
|
|
{
|
|
if( m_currentModule )
|
|
m_matchModeForUpdateSelected = aMatchMode;
|
|
else
|
|
m_matchModeForUpdate = aMatchMode;
|
|
}
|
|
else
|
|
{
|
|
if( m_currentModule )
|
|
m_matchModeForExchangeSelected = aMatchMode;
|
|
else
|
|
m_matchModeForExchange = aMatchMode;
|
|
}
|
|
}
|
|
|
|
|
|
bool DIALOG_EXCHANGE_FOOTPRINTS::isMatch( MODULE* aModule )
|
|
{
|
|
LIB_ID specifiedID;
|
|
|
|
switch( getMatchMode() )
|
|
{
|
|
case ID_MATCH_FP_ALL:
|
|
return true;
|
|
case ID_MATCH_FP_REF:
|
|
// currentModule case goes through processCurrentModule, so we only have
|
|
// to handle specifiedRef case
|
|
return aModule->GetReference() == m_specifiedRef->GetValue();
|
|
case ID_MATCH_FP_VAL:
|
|
// currentValue must also check FPID so we don't get accidental matches that
|
|
// the user didn't intend
|
|
if( m_currentModule )
|
|
return aModule->GetValue() == m_currentModule->GetValue() && aModule->GetFPID() == m_currentModule->GetFPID();
|
|
else
|
|
return aModule->GetValue() == m_specifiedValue->GetValue();
|
|
case ID_MATCH_FP_ID:
|
|
specifiedID.Parse( m_specifiedID->GetValue(), LIB_ID::ID_PCB );
|
|
return aModule->GetFPID() == specifiedID;
|
|
}
|
|
return false; // just to quiet compiler warnings....
|
|
}
|
|
|
|
|
|
wxRadioButton* DIALOG_EXCHANGE_FOOTPRINTS::getRadioButtonForMode()
|
|
{
|
|
switch( getMatchMode() )
|
|
{
|
|
case ID_MATCH_FP_ALL:
|
|
return( m_matchAll );
|
|
case ID_MATCH_FP_REF:
|
|
return( m_matchCurrentRef->IsShown() ? m_matchCurrentRef : m_matchSpecifiedRef );
|
|
case ID_MATCH_FP_VAL:
|
|
return( m_matchCurrentValue->IsShown() ? m_matchCurrentValue : m_matchSpecifiedValue );
|
|
case ID_MATCH_FP_ID:
|
|
return( m_matchSpecifiedID );
|
|
default:
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::updateMatchModeRadioButtons( wxUpdateUIEvent& )
|
|
{
|
|
wxRadioButton* rb_button = getRadioButtonForMode();
|
|
|
|
wxRadioButton* rb_butt_list[] =
|
|
{
|
|
m_matchCurrentRef, m_matchSpecifiedRef,
|
|
m_matchCurrentValue, m_matchCurrentValue,
|
|
m_matchSpecifiedValue, m_matchSpecifiedValue,
|
|
m_matchSpecifiedID, m_matchSpecifiedID,
|
|
nullptr // end of list
|
|
};
|
|
|
|
// Ensure the button state is ok. Only one button can be checked
|
|
// Change button state only if its state is incorrect, otherwise
|
|
// we have issues depending on the platform.
|
|
for( int ii = 0; rb_butt_list[ii]; ++ii )
|
|
{
|
|
bool state = rb_butt_list[ii] == rb_button;
|
|
|
|
if( rb_butt_list[ii]->GetValue() != state )
|
|
rb_butt_list[ii]->SetValue( state );
|
|
}
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked( wxCommandEvent& event )
|
|
{
|
|
setMatchMode( ID_MATCH_FP_ALL );
|
|
m_matchAll->SetFocus();
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked( wxCommandEvent& event )
|
|
{
|
|
setMatchMode( ID_MATCH_FP_REF );
|
|
|
|
if( m_specifiedRef->IsShown() && event.GetEventObject() != m_specifiedRef )
|
|
m_specifiedRef->SetFocus();
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked( wxCommandEvent& event )
|
|
{
|
|
setMatchMode( ID_MATCH_FP_VAL );
|
|
|
|
if( m_specifiedValue->IsShown() && event.GetEventObject() != m_specifiedValue )
|
|
m_specifiedValue->SetFocus();
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked( wxCommandEvent& event )
|
|
{
|
|
setMatchMode( ID_MATCH_FP_ID );
|
|
|
|
if( m_specifiedID->IsShown() && event.GetEventObject() != m_specifiedID )
|
|
m_specifiedID->SetFocus();
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked( wxCommandEvent& event )
|
|
{
|
|
bool result = false;
|
|
wxBusyCursor dummy;
|
|
|
|
m_MessageWindow->Clear();
|
|
m_MessageWindow->Flush( true );
|
|
|
|
if( getMatchMode() == ID_MATCH_FP_REF && m_currentModule )
|
|
result = processCurrentModule();
|
|
else
|
|
result = processMatchingModules();
|
|
|
|
if( result )
|
|
{
|
|
if( m_parent->GetBoard()->IsElementVisible( LAYER_RATSNEST ) )
|
|
m_parent->Compile_Ratsnest( NULL, true );
|
|
|
|
m_parent->GetCanvas()->Refresh();
|
|
}
|
|
|
|
m_commit.Push( wxT( "Changed footprint" ) );
|
|
}
|
|
|
|
|
|
bool DIALOG_EXCHANGE_FOOTPRINTS::processCurrentModule()
|
|
{
|
|
LIB_ID newFPID;
|
|
|
|
if( m_updateMode )
|
|
newFPID = m_currentModule->GetFPID();
|
|
else
|
|
{
|
|
wxString newFPIDStr = m_newID->GetValue();
|
|
|
|
if( newFPIDStr.IsEmpty() )
|
|
return false;
|
|
|
|
newFPID.Parse( newFPIDStr, LIB_ID::ID_PCB, true );
|
|
}
|
|
|
|
return processModule( m_currentModule, newFPID );
|
|
}
|
|
|
|
|
|
bool DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules()
|
|
{
|
|
MODULE* Module;
|
|
MODULE* PtBack;
|
|
bool change = false;
|
|
LIB_ID newFPID;
|
|
wxString value;
|
|
|
|
if( !m_parent->GetBoard()->m_Modules )
|
|
return false;
|
|
|
|
if( !m_updateMode )
|
|
{
|
|
newFPID.Parse( m_newID->GetValue(), LIB_ID::ID_PCB );
|
|
|
|
if( !newFPID.IsValid() )
|
|
return false;
|
|
}
|
|
|
|
/* The change is done from the last module because processModule() modifies the last item
|
|
* in the list.
|
|
* Note: for the first module in chain (the last here), Module->Back() points to the board
|
|
* or is NULL.
|
|
*/
|
|
Module = m_parent->GetBoard()->m_Modules.GetLast();
|
|
|
|
for( ; Module && Module->Type() == PCB_MODULE_T; Module = PtBack )
|
|
{
|
|
PtBack = Module->Back();
|
|
|
|
if( !isMatch( Module ) )
|
|
continue;
|
|
|
|
if( m_updateMode )
|
|
{
|
|
if( processModule( Module, Module->GetFPID()) )
|
|
change = true;
|
|
}
|
|
else
|
|
{
|
|
if( processModule( Module, newFPID ) )
|
|
change = true;
|
|
}
|
|
}
|
|
|
|
return change;
|
|
}
|
|
|
|
|
|
bool DIALOG_EXCHANGE_FOOTPRINTS::processModule( MODULE* aModule, const LIB_ID& aNewFPID )
|
|
{
|
|
LIB_ID oldFPID = aModule->GetFPID();
|
|
REPORTER& reporter = m_MessageWindow->Reporter();
|
|
wxString msg;
|
|
|
|
// Load new module.
|
|
msg.Printf( _( "%s footprint \"%s\" (from \"%s\") to \"%s\"" ),
|
|
m_updateMode ? _( "Update" ) : _( "Change" ),
|
|
aModule->GetReference(),
|
|
oldFPID.Format().c_str(),
|
|
aNewFPID.Format().c_str() );
|
|
|
|
MODULE* newModule = m_parent->LoadFootprint( aNewFPID );
|
|
|
|
if( !newModule )
|
|
{
|
|
msg << ": " << _( "*** footprint not found ***" );
|
|
reporter.Report( msg, REPORTER::RPT_ERROR );
|
|
return false;
|
|
}
|
|
|
|
m_parent->Exchange_Module( aModule, newModule, m_commit,
|
|
m_removeExtraBox->GetValue(),
|
|
m_resetTextItemLayers->GetValue(),
|
|
m_resetTextItemEffects->GetValue() );
|
|
|
|
if( aModule == m_currentModule )
|
|
m_currentModule = newModule;
|
|
|
|
if( aModule == m_parent->GetCurItem() )
|
|
m_parent->SetCurItem( newModule );
|
|
|
|
msg += ": OK";
|
|
reporter.Report( msg, REPORTER::RPT_ACTION );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void processTextItem( const TEXTE_MODULE& aSrc, TEXTE_MODULE& aDest,
|
|
bool resetText, bool resetTextLayers, bool resetTextEffects )
|
|
{
|
|
if( !resetText )
|
|
aDest.SetText( aSrc.GetText() );
|
|
|
|
if( !resetTextLayers )
|
|
{
|
|
aDest.SetLayer( aSrc.GetLayer() );
|
|
aDest.SetVisible( aSrc.IsVisible() );
|
|
}
|
|
|
|
if( !resetTextEffects )
|
|
aDest.SetEffects( aSrc );
|
|
}
|
|
|
|
|
|
TEXTE_MODULE* getMatchingTextItem( TEXTE_MODULE* aRefItem, MODULE* aModule )
|
|
{
|
|
for( auto iItem = aModule->GraphicalItemsList().GetFirst(); iItem; iItem = iItem->Next() )
|
|
{
|
|
TEXTE_MODULE* candidate = dyn_cast<TEXTE_MODULE*>( iItem );
|
|
if( candidate && candidate->GetText() == aRefItem->GetText() )
|
|
return candidate;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
void PCB_EDIT_FRAME::Exchange_Module( MODULE* aSrc, MODULE* aDest, BOARD_COMMIT& aCommit,
|
|
bool deleteExtraTexts,
|
|
bool resetTextLayers, bool resetTextEffects )
|
|
{
|
|
aDest->SetParent( GetBoard() );
|
|
|
|
/* place module without ratsnest refresh: this will be made later
|
|
* when all modules are on board */
|
|
PlaceModule( aDest, nullptr, false );
|
|
|
|
// Copy full placement and pad net names (when possible)
|
|
// but not local settings like clearances (use library values)
|
|
aSrc->CopyNetlistSettings( aDest, false );
|
|
|
|
// Copy reference
|
|
processTextItem( aSrc->Reference(), aDest->Reference(),
|
|
// never reset reference text
|
|
false,
|
|
resetTextLayers, resetTextEffects );
|
|
|
|
// Copy value
|
|
processTextItem( aSrc->Value(), aDest->Value(),
|
|
// reset value text only when it is a proxy for the footprint ID
|
|
// (cf replacing value "MountingHole-2.5mm" with "MountingHole-4.0mm")
|
|
aSrc->GetValue() == aSrc->GetFPID().GetLibItemName(),
|
|
resetTextLayers, resetTextEffects );
|
|
|
|
// Copy fields in accordance with the reset* flags
|
|
for( BOARD_ITEM* item = aSrc->GraphicalItemsList().GetFirst(); item; item = item->Next() )
|
|
{
|
|
TEXTE_MODULE* srcItem = dyn_cast<TEXTE_MODULE*>( item );
|
|
|
|
if( srcItem )
|
|
{
|
|
TEXTE_MODULE* destItem = getMatchingTextItem( srcItem, aDest );
|
|
|
|
if( destItem )
|
|
processTextItem( *srcItem, *destItem, false, resetTextLayers, resetTextEffects );
|
|
else if( !deleteExtraTexts )
|
|
aDest->GraphicalItemsList().Append( new TEXTE_MODULE( *srcItem ) );
|
|
}
|
|
}
|
|
|
|
// Updating other parameters
|
|
aDest->SetTimeStamp( aSrc->GetTimeStamp() );
|
|
aDest->SetPath( aSrc->GetPath() );
|
|
|
|
aCommit.Remove( aSrc );
|
|
aCommit.Add( aDest );
|
|
|
|
// @todo LEGACY should be unnecessary
|
|
GetBoard()->m_Status_Pcb = 0;
|
|
aDest->ClearFlags();
|
|
}
|
|
|
|
|
|
void DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint( wxCommandEvent& event )
|
|
{
|
|
wxString newname;
|
|
|
|
KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_MODULE_VIEWER_MODAL, true );
|
|
|
|
if( frame->ShowModal( &newname, this ) )
|
|
{
|
|
if( event.GetEventObject() == m_newIDBrowseButton )
|
|
m_newID->SetValue( newname );
|
|
else
|
|
m_specifiedID->SetValue( newname );
|
|
}
|
|
|
|
frame->Destroy();
|
|
}
|
|
|
|
|