349 lines
11 KiB
C++
349 lines
11 KiB
C++
/**
|
|
* @file pcbnew/netlist.cpp
|
|
*/
|
|
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 1992-2013 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 1992-2016 KiCad Developers, see change_log.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 <functional>
|
|
using namespace std::placeholders;
|
|
|
|
#include <fctsys.h>
|
|
#include <pgm_base.h>
|
|
#include <class_drawpanel.h>
|
|
#include <class_draw_panel_gal.h>
|
|
#include <confirm.h>
|
|
#include <dialog_helpers.h>
|
|
#include <wxPcbStruct.h>
|
|
#include <pcb_netlist.h>
|
|
#include <netlist_reader.h>
|
|
#include <reporter.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <fpid.h>
|
|
#include <fp_lib_table.h>
|
|
|
|
#include <class_board.h>
|
|
#include <class_module.h>
|
|
#include <ratsnest_data.h>
|
|
#include <pcbnew.h>
|
|
#include <io_mgr.h>
|
|
|
|
#include <tool/tool_manager.h>
|
|
#include <tools/common_actions.h>
|
|
|
|
|
|
void PCB_EDIT_FRAME::ReadPcbNetlist( const wxString& aNetlistFileName,
|
|
const wxString& aCmpFileName,
|
|
REPORTER* aReporter,
|
|
bool aChangeFootprints,
|
|
bool aDeleteUnconnectedTracks,
|
|
bool aDeleteExtraFootprints,
|
|
bool aSelectByTimeStamp,
|
|
bool aDeleteSinglePadNets,
|
|
bool aIsDryRun )
|
|
{
|
|
wxString msg;
|
|
NETLIST netlist;
|
|
KIGFX::VIEW* view = GetGalCanvas()->GetView();
|
|
BOARD* board = GetBoard();
|
|
std::vector<MODULE*> newFootprints;
|
|
// keep trace of the initial baord area, if we want to place new footprints
|
|
// outside the existinag board
|
|
EDA_RECT bbox = board->ComputeBoundingBox( false );
|
|
|
|
netlist.SetIsDryRun( aIsDryRun );
|
|
netlist.SetFindByTimeStamp( aSelectByTimeStamp );
|
|
netlist.SetDeleteExtraFootprints( aDeleteExtraFootprints );
|
|
netlist.SetReplaceFootprints( aChangeFootprints );
|
|
|
|
try
|
|
{
|
|
std::unique_ptr<NETLIST_READER> netlistReader( NETLIST_READER::GetNetlistReader(
|
|
&netlist, aNetlistFileName, aCmpFileName ) );
|
|
|
|
if( !netlistReader.get() )
|
|
{
|
|
msg.Printf( _( "Cannot open netlist file \"%s\"." ), GetChars( aNetlistFileName ) );
|
|
wxMessageBox( msg, _( "Netlist Load Error." ), wxOK | wxICON_ERROR, this );
|
|
return;
|
|
}
|
|
|
|
SetLastNetListRead( aNetlistFileName );
|
|
netlistReader->LoadNetlist();
|
|
LoadFootprints( netlist, aReporter );
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
msg.Printf( _( "Error loading netlist.\n%s" ), ioe.What().GetData() );
|
|
wxMessageBox( msg, _( "Netlist Load Error" ), wxOK | wxICON_ERROR );
|
|
return;
|
|
}
|
|
|
|
// Clear undo and redo lists to avoid inconsistencies between lists
|
|
if( !netlist.IsDryRun() )
|
|
GetScreen()->ClearUndoRedoList();
|
|
|
|
if( !netlist.IsDryRun() )
|
|
{
|
|
// Remove old modules
|
|
for( MODULE* module = board->m_Modules; module; module = module->Next() )
|
|
{
|
|
module->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
|
|
view->Remove( module );
|
|
}
|
|
}
|
|
|
|
// Clear selection, just in case a selected item has to be removed
|
|
m_toolManager->RunAction( COMMON_ACTIONS::selectionClear, true );
|
|
|
|
netlist.SortByReference();
|
|
board->ReplaceNetlist( netlist, aDeleteSinglePadNets, &newFootprints, aReporter );
|
|
|
|
// If it was a dry run, nothing has changed so we're done.
|
|
if( netlist.IsDryRun() )
|
|
return;
|
|
|
|
if( IsGalCanvasActive() )
|
|
{
|
|
SpreadFootprints( &newFootprints, false, false, GetCrossHairPosition() );
|
|
|
|
if( !newFootprints.empty() )
|
|
{
|
|
for( MODULE* footprint : newFootprints )
|
|
{
|
|
m_toolManager->RunAction( COMMON_ACTIONS::selectItem, true, footprint );
|
|
}
|
|
m_toolManager->InvokeTool( "pcbnew.InteractiveEdit" );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
wxPoint placementAreaPosition;
|
|
|
|
// Place area to the left side of the board.
|
|
// if the board is empty, the bbox position is (0,0)
|
|
placementAreaPosition.x = bbox.GetEnd().x + Millimeter2iu( 10 );
|
|
placementAreaPosition.y = bbox.GetOrigin().y;
|
|
|
|
SpreadFootprints( &newFootprints, false, false, placementAreaPosition );
|
|
}
|
|
|
|
OnModify();
|
|
|
|
SetCurItem( NULL );
|
|
|
|
// Reload modules
|
|
for( MODULE* module = board->m_Modules; module; module = module->Next() )
|
|
{
|
|
module->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1 ) );
|
|
view->Add( module );
|
|
module->ViewUpdate();
|
|
}
|
|
|
|
if( aDeleteUnconnectedTracks && board->m_Track )
|
|
{
|
|
// Remove erroneous tracks. This should probably pushed down to the #BOARD object.
|
|
RemoveMisConnectedTracks();
|
|
}
|
|
|
|
// Rebuild the board connectivity:
|
|
Compile_Ratsnest( NULL, true );
|
|
board->GetRatsnest()->ProcessBoard();
|
|
|
|
SetMsgPanel( board );
|
|
m_canvas->Refresh();
|
|
}
|
|
|
|
|
|
MODULE* PCB_EDIT_FRAME::ListAndSelectModuleName()
|
|
{
|
|
if( GetBoard()->m_Modules == NULL )
|
|
{
|
|
DisplayError( this, _( "No footprints" ) );
|
|
return 0;
|
|
}
|
|
|
|
wxArrayString listnames;
|
|
|
|
MODULE* module;
|
|
|
|
for( module = GetBoard()->m_Modules; module; module = module->Next() )
|
|
listnames.Add( module->GetReference() );
|
|
|
|
wxArrayString headers;
|
|
headers.Add( wxT( "Module" ) );
|
|
std::vector<wxArrayString> itemsToDisplay;
|
|
|
|
// Conversion from wxArrayString to vector of ArrayString
|
|
for( unsigned i = 0; i < listnames.GetCount(); i++ )
|
|
{
|
|
wxArrayString item;
|
|
item.Add( listnames[i] );
|
|
itemsToDisplay.push_back( item );
|
|
}
|
|
|
|
EDA_LIST_DIALOG dlg( this, _( "Components" ), headers, itemsToDisplay, wxEmptyString );
|
|
|
|
if( dlg.ShowModal() != wxID_OK )
|
|
return NULL;
|
|
|
|
wxString ref = dlg.GetTextSelection();
|
|
|
|
for( module = GetBoard()->m_Modules; module; module = module->Next() )
|
|
{
|
|
if( module->GetReference() == ref )
|
|
break;
|
|
}
|
|
|
|
return module;
|
|
}
|
|
|
|
|
|
#define ALLOW_PARTIAL_FPID 1
|
|
|
|
void PCB_EDIT_FRAME::LoadFootprints( NETLIST& aNetlist, REPORTER* aReporter )
|
|
throw( IO_ERROR, PARSE_ERROR )
|
|
{
|
|
wxString msg;
|
|
FPID lastFPID;
|
|
COMPONENT* component;
|
|
MODULE* module = 0;
|
|
MODULE* fpOnBoard;
|
|
|
|
if( aNetlist.IsEmpty() || Prj().PcbFootprintLibs()->IsEmpty() )
|
|
return;
|
|
|
|
aNetlist.SortByFPID();
|
|
|
|
for( unsigned ii = 0; ii < aNetlist.GetCount(); ii++ )
|
|
{
|
|
component = aNetlist.GetComponent( ii );
|
|
|
|
#if ALLOW_PARTIAL_FPID
|
|
// The FPID is ok as long as there is a footprint portion coming
|
|
// from eeschema.
|
|
if( !component->GetFPID().GetFootprintName().size() )
|
|
#else
|
|
if( component->GetFPID().empty() )
|
|
#endif
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "No footprint defined for component '%s'.\n" ),
|
|
GetChars( component->GetReference() ) );
|
|
aReporter->Report( msg, REPORTER::RPT_ERROR );
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
// Check if component footprint is already on BOARD and only load the footprint from
|
|
// the library if it's needed. Nickname can be blank.
|
|
if( aNetlist.IsFindByTimeStamp() )
|
|
fpOnBoard = m_Pcb->FindModule( aNetlist.GetComponent( ii )->GetTimeStamp(), true );
|
|
else
|
|
fpOnBoard = m_Pcb->FindModule( aNetlist.GetComponent( ii )->GetReference() );
|
|
|
|
bool footprintMisMatch = fpOnBoard &&
|
|
fpOnBoard->GetFPID() != component->GetFPID();
|
|
|
|
if( footprintMisMatch && !aNetlist.GetReplaceFootprints() )
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "* Warning: component '%s': board footprint '%s', netlist footprint '%s'\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( fpOnBoard->GetFPID().Format() ),
|
|
GetChars( component->GetFPID().Format() ) );
|
|
aReporter->Report( msg );
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if( !aNetlist.GetReplaceFootprints() )
|
|
footprintMisMatch = false;
|
|
|
|
bool loadFootprint = (fpOnBoard == NULL) || footprintMisMatch;
|
|
|
|
if( loadFootprint && (component->GetFPID() != lastFPID) )
|
|
{
|
|
module = NULL;
|
|
|
|
#if ALLOW_PARTIAL_FPID
|
|
// The FPID is ok as long as there is a footprint portion coming
|
|
// the library if it's needed. Nickname can be blank.
|
|
if( !component->GetFPID().GetFootprintName().size() )
|
|
#else
|
|
if( !component->GetFPID().IsValid() )
|
|
#endif
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "Component '%s' footprint ID '%s' is not "
|
|
"valid.\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( component->GetFPID().Format() ) );
|
|
aReporter->Report( msg, REPORTER::RPT_ERROR );
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
// loadFootprint() can find a footprint with an empty nickname in fpid.
|
|
module = PCB_BASE_FRAME::loadFootprint( component->GetFPID() );
|
|
|
|
if( module )
|
|
{
|
|
lastFPID = component->GetFPID();
|
|
}
|
|
else
|
|
{
|
|
if( aReporter )
|
|
{
|
|
msg.Printf( _( "Component '%s' footprint '%s' was not found in "
|
|
"any libraries in the footprint library table.\n" ),
|
|
GetChars( component->GetReference() ),
|
|
GetChars( component->GetFPID().GetFootprintName() ) );
|
|
aReporter->Report( msg, REPORTER::RPT_ERROR );
|
|
}
|
|
|
|
continue;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Footprint already loaded from a library, duplicate it (faster)
|
|
if( module == NULL )
|
|
continue; // Module does not exist in any library.
|
|
|
|
module = new MODULE( *module );
|
|
}
|
|
|
|
if( loadFootprint && module != NULL )
|
|
component->SetModule( module );
|
|
}
|
|
}
|